[AArch64] PR target/65491: Classify V1TF vectors as AAPCS64 short vectors rather...
[official-gcc.git] / gcc / doc / invoke.texi
bloba4515376c00e3b96b9b7c123fd0e10f4dbd7f1ff
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,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}}
862 @emph{Nvidia PTX Options}
863 @gccoptlist{-m32 -m64 -mmainkernel}
865 @emph{PDP-11 Options}
866 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
867 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
868 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
869 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
870 -mbranch-expensive  -mbranch-cheap @gol
871 -munix-asm  -mdec-asm}
873 @emph{picoChip Options}
874 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
875 -msymbol-as-address -mno-inefficient-warnings}
877 @emph{PowerPC Options}
878 See RS/6000 and PowerPC Options.
880 @emph{RL78 Options}
881 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
882 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
883 -m64bit-doubles -m32bit-doubles}
885 @emph{RS/6000 and PowerPC Options}
886 @gccoptlist{-mcpu=@var{cpu-type} @gol
887 -mtune=@var{cpu-type} @gol
888 -mcmodel=@var{code-model} @gol
889 -mpowerpc64 @gol
890 -maltivec  -mno-altivec @gol
891 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
892 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
893 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
894 -mfprnd  -mno-fprnd @gol
895 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
896 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
897 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
898 -malign-power  -malign-natural @gol
899 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
900 -msingle-float -mdouble-float -msimple-fpu @gol
901 -mstring  -mno-string  -mupdate  -mno-update @gol
902 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
903 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
904 -mstrict-align  -mno-strict-align  -mrelocatable @gol
905 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
906 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
907 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
908 -mprioritize-restricted-insns=@var{priority} @gol
909 -msched-costly-dep=@var{dependence_type} @gol
910 -minsert-sched-nops=@var{scheme} @gol
911 -mcall-sysv  -mcall-netbsd @gol
912 -maix-struct-return  -msvr4-struct-return @gol
913 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
914 -mblock-move-inline-limit=@var{num} @gol
915 -misel -mno-isel @gol
916 -misel=yes  -misel=no @gol
917 -mspe -mno-spe @gol
918 -mspe=yes  -mspe=no @gol
919 -mpaired @gol
920 -mgen-cell-microcode -mwarn-cell-microcode @gol
921 -mvrsave -mno-vrsave @gol
922 -mmulhw -mno-mulhw @gol
923 -mdlmzb -mno-dlmzb @gol
924 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
925 -mprototype  -mno-prototype @gol
926 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
927 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
928 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
929 -mno-recip-precision @gol
930 -mveclibabi=@var{type} -mfriz -mno-friz @gol
931 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
932 -msave-toc-indirect -mno-save-toc-indirect @gol
933 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
934 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
935 -mquad-memory -mno-quad-memory @gol
936 -mquad-memory-atomic -mno-quad-memory-atomic @gol
937 -mcompat-align-parm -mno-compat-align-parm @gol
938 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
939 -mupper-regs -mno-upper-regs}
941 @emph{RX Options}
942 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
943 -mcpu=@gol
944 -mbig-endian-data -mlittle-endian-data @gol
945 -msmall-data @gol
946 -msim  -mno-sim@gol
947 -mas100-syntax -mno-as100-syntax@gol
948 -mrelax@gol
949 -mmax-constant-size=@gol
950 -mint-register=@gol
951 -mpid@gol
952 -mallow-string-insns -mno-allow-string-insns@gol
953 -mno-warn-multiple-fast-interrupts@gol
954 -msave-acc-in-interrupts}
956 @emph{S/390 and zSeries Options}
957 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
958 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
959 -mlong-double-64 -mlong-double-128 @gol
960 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
961 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
962 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
963 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
964 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
965 -mhotpatch=@var{halfwords},@var{halfwords}}
967 @emph{Score Options}
968 @gccoptlist{-meb -mel @gol
969 -mnhwloop @gol
970 -muls @gol
971 -mmac @gol
972 -mscore5 -mscore5u -mscore7 -mscore7d}
974 @emph{SH Options}
975 @gccoptlist{-m1  -m2  -m2e @gol
976 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
977 -m3  -m3e @gol
978 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
979 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
980 -m5-64media  -m5-64media-nofpu @gol
981 -m5-32media  -m5-32media-nofpu @gol
982 -m5-compact  -m5-compact-nofpu @gol
983 -mb  -ml  -mdalign  -mrelax @gol
984 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
985 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
986 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
987 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
988 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
989 -maccumulate-outgoing-args -minvalid-symbols @gol
990 -matomic-model=@var{atomic-model} @gol
991 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
992 -mcbranch-force-delay-slot @gol
993 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
994 -mpretend-cmove -mtas}
996 @emph{Solaris 2 Options}
997 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
998 -pthreads -pthread}
1000 @emph{SPARC Options}
1001 @gccoptlist{-mcpu=@var{cpu-type} @gol
1002 -mtune=@var{cpu-type} @gol
1003 -mcmodel=@var{code-model} @gol
1004 -mmemory-model=@var{mem-model} @gol
1005 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1006 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1007 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1008 -mhard-quad-float  -msoft-quad-float @gol
1009 -mstack-bias  -mno-stack-bias @gol
1010 -munaligned-doubles  -mno-unaligned-doubles @gol
1011 -muser-mode  -mno-user-mode @gol
1012 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1013 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1014 -mcbcond -mno-cbcond @gol
1015 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1016 -mfix-at697f -mfix-ut699}
1018 @emph{SPU Options}
1019 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1020 -msafe-dma -munsafe-dma @gol
1021 -mbranch-hints @gol
1022 -msmall-mem -mlarge-mem -mstdmain @gol
1023 -mfixed-range=@var{register-range} @gol
1024 -mea32 -mea64 @gol
1025 -maddress-space-conversion -mno-address-space-conversion @gol
1026 -mcache-size=@var{cache-size} @gol
1027 -matomic-updates -mno-atomic-updates}
1029 @emph{System V Options}
1030 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1032 @emph{TILE-Gx Options}
1033 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1034 -mcmodel=@var{code-model}}
1036 @emph{TILEPro Options}
1037 @gccoptlist{-mcpu=@var{cpu} -m32}
1039 @emph{V850 Options}
1040 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1041 -mprolog-function  -mno-prolog-function  -mspace @gol
1042 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1043 -mapp-regs  -mno-app-regs @gol
1044 -mdisable-callt  -mno-disable-callt @gol
1045 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1046 -mv850e -mv850 -mv850e3v5 @gol
1047 -mloop @gol
1048 -mrelax @gol
1049 -mlong-jumps @gol
1050 -msoft-float @gol
1051 -mhard-float @gol
1052 -mgcc-abi @gol
1053 -mrh850-abi @gol
1054 -mbig-switch}
1056 @emph{VAX Options}
1057 @gccoptlist{-mg  -mgnu  -munix}
1059 @emph{Visium Options}
1060 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1061 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1063 @emph{VMS Options}
1064 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1065 -mpointer-size=@var{size}}
1067 @emph{VxWorks Options}
1068 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1069 -Xbind-lazy  -Xbind-now}
1071 @emph{x86 Options}
1072 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1073 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1074 -mfpmath=@var{unit} @gol
1075 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1076 -mno-fp-ret-in-387  -msoft-float @gol
1077 -mno-wide-multiply  -mrtd  -malign-double @gol
1078 -mpreferred-stack-boundary=@var{num} @gol
1079 -mincoming-stack-boundary=@var{num} @gol
1080 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1081 -mrecip -mrecip=@var{opt} @gol
1082 -mvzeroupper -mprefer-avx128 @gol
1083 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1084 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
1085 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
1086 -mclflushopt -mxsavec -mxsaves @gol
1087 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1088 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mthreads @gol
1089 -mno-align-stringops  -minline-all-stringops @gol
1090 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1091 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1092 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1093 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1094 -mregparm=@var{num}  -msseregparm @gol
1095 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1096 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1097 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1098 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1099 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
1100 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1101 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1102 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
1104 @emph{x86 Windows Options}
1105 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1106 -mnop-fun-dllimport -mthread @gol
1107 -municode -mwin32 -mwindows -fno-set-stack-executable}
1109 @emph{Xstormy16 Options}
1110 @gccoptlist{-msim}
1112 @emph{Xtensa Options}
1113 @gccoptlist{-mconst16 -mno-const16 @gol
1114 -mfused-madd  -mno-fused-madd @gol
1115 -mforce-no-pic @gol
1116 -mserialize-volatile  -mno-serialize-volatile @gol
1117 -mtext-section-literals  -mno-text-section-literals @gol
1118 -mtarget-align  -mno-target-align @gol
1119 -mlongcalls  -mno-longcalls}
1121 @emph{zSeries Options}
1122 See S/390 and zSeries Options.
1124 @item Code Generation Options
1125 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1126 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1127 -ffixed-@var{reg}  -fexceptions @gol
1128 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1129 -fasynchronous-unwind-tables @gol
1130 -fno-gnu-unique @gol
1131 -finhibit-size-directive  -finstrument-functions @gol
1132 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1133 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1134 -fno-common  -fno-ident @gol
1135 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
1136 -fno-jump-tables @gol
1137 -frecord-gcc-switches @gol
1138 -freg-struct-return  -fshort-enums @gol
1139 -fshort-double  -fshort-wchar @gol
1140 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1141 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1142 -fno-stack-limit -fsplit-stack @gol
1143 -fleading-underscore  -ftls-model=@var{model} @gol
1144 -fstack-reuse=@var{reuse_level} @gol
1145 -ftrapv  -fwrapv  -fbounds-check @gol
1146 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
1147 -fstrict-volatile-bitfields -fsync-libcalls}
1148 @end table
1151 @node Overall Options
1152 @section Options Controlling the Kind of Output
1154 Compilation can involve up to four stages: preprocessing, compilation
1155 proper, assembly and linking, always in that order.  GCC is capable of
1156 preprocessing and compiling several files either into several
1157 assembler input files, or into one assembler input file; then each
1158 assembler input file produces an object file, and linking combines all
1159 the object files (those newly compiled, and those specified as input)
1160 into an executable file.
1162 @cindex file name suffix
1163 For any given input file, the file name suffix determines what kind of
1164 compilation is done:
1166 @table @gcctabopt
1167 @item @var{file}.c
1168 C source code that must be preprocessed.
1170 @item @var{file}.i
1171 C source code that should not be preprocessed.
1173 @item @var{file}.ii
1174 C++ source code that should not be preprocessed.
1176 @item @var{file}.m
1177 Objective-C source code.  Note that you must link with the @file{libobjc}
1178 library to make an Objective-C program work.
1180 @item @var{file}.mi
1181 Objective-C source code that should not be preprocessed.
1183 @item @var{file}.mm
1184 @itemx @var{file}.M
1185 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1186 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1187 to a literal capital M@.
1189 @item @var{file}.mii
1190 Objective-C++ source code that should not be preprocessed.
1192 @item @var{file}.h
1193 C, C++, Objective-C or Objective-C++ header file to be turned into a
1194 precompiled header (default), or C, C++ header file to be turned into an
1195 Ada spec (via the @option{-fdump-ada-spec} switch).
1197 @item @var{file}.cc
1198 @itemx @var{file}.cp
1199 @itemx @var{file}.cxx
1200 @itemx @var{file}.cpp
1201 @itemx @var{file}.CPP
1202 @itemx @var{file}.c++
1203 @itemx @var{file}.C
1204 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1205 the last two letters must both be literally @samp{x}.  Likewise,
1206 @samp{.C} refers to a literal capital C@.
1208 @item @var{file}.mm
1209 @itemx @var{file}.M
1210 Objective-C++ source code that must be preprocessed.
1212 @item @var{file}.mii
1213 Objective-C++ source code that should not be preprocessed.
1215 @item @var{file}.hh
1216 @itemx @var{file}.H
1217 @itemx @var{file}.hp
1218 @itemx @var{file}.hxx
1219 @itemx @var{file}.hpp
1220 @itemx @var{file}.HPP
1221 @itemx @var{file}.h++
1222 @itemx @var{file}.tcc
1223 C++ header file to be turned into a precompiled header or Ada spec.
1225 @item @var{file}.f
1226 @itemx @var{file}.for
1227 @itemx @var{file}.ftn
1228 Fixed form Fortran source code that should not be preprocessed.
1230 @item @var{file}.F
1231 @itemx @var{file}.FOR
1232 @itemx @var{file}.fpp
1233 @itemx @var{file}.FPP
1234 @itemx @var{file}.FTN
1235 Fixed form Fortran source code that must be preprocessed (with the traditional
1236 preprocessor).
1238 @item @var{file}.f90
1239 @itemx @var{file}.f95
1240 @itemx @var{file}.f03
1241 @itemx @var{file}.f08
1242 Free form Fortran source code that should not be preprocessed.
1244 @item @var{file}.F90
1245 @itemx @var{file}.F95
1246 @itemx @var{file}.F03
1247 @itemx @var{file}.F08
1248 Free form Fortran source code that must be preprocessed (with the
1249 traditional preprocessor).
1251 @item @var{file}.go
1252 Go source code.
1254 @c FIXME: Descriptions of Java file types.
1255 @c @var{file}.java
1256 @c @var{file}.class
1257 @c @var{file}.zip
1258 @c @var{file}.jar
1260 @item @var{file}.ads
1261 Ada source code file that contains a library unit declaration (a
1262 declaration of a package, subprogram, or generic, or a generic
1263 instantiation), or a library unit renaming declaration (a package,
1264 generic, or subprogram renaming declaration).  Such files are also
1265 called @dfn{specs}.
1267 @item @var{file}.adb
1268 Ada source code file containing a library unit body (a subprogram or
1269 package body).  Such files are also called @dfn{bodies}.
1271 @c GCC also knows about some suffixes for languages not yet included:
1272 @c Pascal:
1273 @c @var{file}.p
1274 @c @var{file}.pas
1275 @c Ratfor:
1276 @c @var{file}.r
1278 @item @var{file}.s
1279 Assembler code.
1281 @item @var{file}.S
1282 @itemx @var{file}.sx
1283 Assembler code that must be preprocessed.
1285 @item @var{other}
1286 An object file to be fed straight into linking.
1287 Any file name with no recognized suffix is treated this way.
1288 @end table
1290 @opindex x
1291 You can specify the input language explicitly with the @option{-x} option:
1293 @table @gcctabopt
1294 @item -x @var{language}
1295 Specify explicitly the @var{language} for the following input files
1296 (rather than letting the compiler choose a default based on the file
1297 name suffix).  This option applies to all following input files until
1298 the next @option{-x} option.  Possible values for @var{language} are:
1299 @smallexample
1300 c  c-header  cpp-output
1301 c++  c++-header  c++-cpp-output
1302 objective-c  objective-c-header  objective-c-cpp-output
1303 objective-c++ objective-c++-header objective-c++-cpp-output
1304 assembler  assembler-with-cpp
1306 f77  f77-cpp-input f95  f95-cpp-input
1308 java
1309 @end smallexample
1311 @item -x none
1312 Turn off any specification of a language, so that subsequent files are
1313 handled according to their file name suffixes (as they are if @option{-x}
1314 has not been used at all).
1316 @item -pass-exit-codes
1317 @opindex pass-exit-codes
1318 Normally the @command{gcc} program exits with the code of 1 if any
1319 phase of the compiler returns a non-success return code.  If you specify
1320 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1321 the numerically highest error produced by any phase returning an error
1322 indication.  The C, C++, and Fortran front ends return 4 if an internal
1323 compiler error is encountered.
1324 @end table
1326 If you only want some of the stages of compilation, you can use
1327 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1328 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1329 @command{gcc} is to stop.  Note that some combinations (for example,
1330 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1332 @table @gcctabopt
1333 @item -c
1334 @opindex c
1335 Compile or assemble the source files, but do not link.  The linking
1336 stage simply is not done.  The ultimate output is in the form of an
1337 object file for each source file.
1339 By default, the object file name for a source file is made by replacing
1340 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1342 Unrecognized input files, not requiring compilation or assembly, are
1343 ignored.
1345 @item -S
1346 @opindex S
1347 Stop after the stage of compilation proper; do not assemble.  The output
1348 is in the form of an assembler code file for each non-assembler input
1349 file specified.
1351 By default, the assembler file name for a source file is made by
1352 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1354 Input files that don't require compilation are ignored.
1356 @item -E
1357 @opindex E
1358 Stop after the preprocessing stage; do not run the compiler proper.  The
1359 output is in the form of preprocessed source code, which is sent to the
1360 standard output.
1362 Input files that don't require preprocessing are ignored.
1364 @cindex output file option
1365 @item -o @var{file}
1366 @opindex o
1367 Place output in file @var{file}.  This applies to whatever
1368 sort of output is being produced, whether it be an executable file,
1369 an object file, an assembler file or preprocessed C code.
1371 If @option{-o} is not specified, the default is to put an executable
1372 file in @file{a.out}, the object file for
1373 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1374 assembler file in @file{@var{source}.s}, a precompiled header file in
1375 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1376 standard output.
1378 @item -v
1379 @opindex v
1380 Print (on standard error output) the commands executed to run the stages
1381 of compilation.  Also print the version number of the compiler driver
1382 program and of the preprocessor and the compiler proper.
1384 @item -###
1385 @opindex ###
1386 Like @option{-v} except the commands are not executed and arguments
1387 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1388 This is useful for shell scripts to capture the driver-generated command lines.
1390 @item -pipe
1391 @opindex pipe
1392 Use pipes rather than temporary files for communication between the
1393 various stages of compilation.  This fails to work on some systems where
1394 the assembler is unable to read from a pipe; but the GNU assembler has
1395 no trouble.
1397 @item --help
1398 @opindex help
1399 Print (on the standard output) a description of the command-line options
1400 understood by @command{gcc}.  If the @option{-v} option is also specified
1401 then @option{--help} is also passed on to the various processes
1402 invoked by @command{gcc}, so that they can display the command-line options
1403 they accept.  If the @option{-Wextra} option has also been specified
1404 (prior to the @option{--help} option), then command-line options that
1405 have no documentation associated with them are also displayed.
1407 @item --target-help
1408 @opindex target-help
1409 Print (on the standard output) a description of target-specific command-line
1410 options for each tool.  For some targets extra target-specific
1411 information may also be printed.
1413 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1414 Print (on the standard output) a description of the command-line
1415 options understood by the compiler that fit into all specified classes
1416 and qualifiers.  These are the supported classes:
1418 @table @asis
1419 @item @samp{optimizers}
1420 Display all of the optimization options supported by the
1421 compiler.
1423 @item @samp{warnings}
1424 Display all of the options controlling warning messages
1425 produced by the compiler.
1427 @item @samp{target}
1428 Display target-specific options.  Unlike the
1429 @option{--target-help} option however, target-specific options of the
1430 linker and assembler are not displayed.  This is because those
1431 tools do not currently support the extended @option{--help=} syntax.
1433 @item @samp{params}
1434 Display the values recognized by the @option{--param}
1435 option.
1437 @item @var{language}
1438 Display the options supported for @var{language}, where
1439 @var{language} is the name of one of the languages supported in this
1440 version of GCC@.
1442 @item @samp{common}
1443 Display the options that are common to all languages.
1444 @end table
1446 These are the supported qualifiers:
1448 @table @asis
1449 @item @samp{undocumented}
1450 Display only those options that are undocumented.
1452 @item @samp{joined}
1453 Display options taking an argument that appears after an equal
1454 sign in the same continuous piece of text, such as:
1455 @samp{--help=target}.
1457 @item @samp{separate}
1458 Display options taking an argument that appears as a separate word
1459 following the original option, such as: @samp{-o output-file}.
1460 @end table
1462 Thus for example to display all the undocumented target-specific
1463 switches supported by the compiler, use:
1465 @smallexample
1466 --help=target,undocumented
1467 @end smallexample
1469 The sense of a qualifier can be inverted by prefixing it with the
1470 @samp{^} character, so for example to display all binary warning
1471 options (i.e., ones that are either on or off and that do not take an
1472 argument) that have a description, use:
1474 @smallexample
1475 --help=warnings,^joined,^undocumented
1476 @end smallexample
1478 The argument to @option{--help=} should not consist solely of inverted
1479 qualifiers.
1481 Combining several classes is possible, although this usually
1482 restricts the output so much that there is nothing to display.  One
1483 case where it does work, however, is when one of the classes is
1484 @var{target}.  For example, to display all the target-specific
1485 optimization options, use:
1487 @smallexample
1488 --help=target,optimizers
1489 @end smallexample
1491 The @option{--help=} option can be repeated on the command line.  Each
1492 successive use displays its requested class of options, skipping
1493 those that have already been displayed.
1495 If the @option{-Q} option appears on the command line before the
1496 @option{--help=} option, then the descriptive text displayed by
1497 @option{--help=} is changed.  Instead of describing the displayed
1498 options, an indication is given as to whether the option is enabled,
1499 disabled or set to a specific value (assuming that the compiler
1500 knows this at the point where the @option{--help=} option is used).
1502 Here is a truncated example from the ARM port of @command{gcc}:
1504 @smallexample
1505   % gcc -Q -mabi=2 --help=target -c
1506   The following options are target specific:
1507   -mabi=                                2
1508   -mabort-on-noreturn                   [disabled]
1509   -mapcs                                [disabled]
1510 @end smallexample
1512 The output is sensitive to the effects of previous command-line
1513 options, so for example it is possible to find out which optimizations
1514 are enabled at @option{-O2} by using:
1516 @smallexample
1517 -Q -O2 --help=optimizers
1518 @end smallexample
1520 Alternatively you can discover which binary optimizations are enabled
1521 by @option{-O3} by using:
1523 @smallexample
1524 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1525 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1526 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1527 @end smallexample
1529 @item -no-canonical-prefixes
1530 @opindex no-canonical-prefixes
1531 Do not expand any symbolic links, resolve references to @samp{/../}
1532 or @samp{/./}, or make the path absolute when generating a relative
1533 prefix.
1535 @item --version
1536 @opindex version
1537 Display the version number and copyrights of the invoked GCC@.
1539 @item -wrapper
1540 @opindex wrapper
1541 Invoke all subcommands under a wrapper program.  The name of the
1542 wrapper program and its parameters are passed as a comma separated
1543 list.
1545 @smallexample
1546 gcc -c t.c -wrapper gdb,--args
1547 @end smallexample
1549 @noindent
1550 This invokes all subprograms of @command{gcc} under
1551 @samp{gdb --args}, thus the invocation of @command{cc1} is
1552 @samp{gdb --args cc1 @dots{}}.
1554 @item -fplugin=@var{name}.so
1555 @opindex fplugin
1556 Load the plugin code in file @var{name}.so, assumed to be a
1557 shared object to be dlopen'd by the compiler.  The base name of
1558 the shared object file is used to identify the plugin for the
1559 purposes of argument parsing (See
1560 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1561 Each plugin should define the callback functions specified in the
1562 Plugins API.
1564 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1565 @opindex fplugin-arg
1566 Define an argument called @var{key} with a value of @var{value}
1567 for the plugin called @var{name}.
1569 @item -fdump-ada-spec@r{[}-slim@r{]}
1570 @opindex fdump-ada-spec
1571 For C and C++ source and include files, generate corresponding Ada specs.
1572 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1573 GNAT User's Guide}, which provides detailed documentation on this feature.
1575 @item -fada-spec-parent=@var{unit}
1576 @opindex fada-spec-parent
1577 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1578 Ada specs as child units of parent @var{unit}.
1580 @item -fdump-go-spec=@var{file}
1581 @opindex fdump-go-spec
1582 For input files in any language, generate corresponding Go
1583 declarations in @var{file}.  This generates Go @code{const},
1584 @code{type}, @code{var}, and @code{func} declarations which may be a
1585 useful way to start writing a Go interface to code written in some
1586 other language.
1588 @include @value{srcdir}/../libiberty/at-file.texi
1589 @end table
1591 @node Invoking G++
1592 @section Compiling C++ Programs
1594 @cindex suffixes for C++ source
1595 @cindex C++ source file suffixes
1596 C++ source files conventionally use one of the suffixes @samp{.C},
1597 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1598 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1599 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1600 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1601 files with these names and compiles them as C++ programs even if you
1602 call the compiler the same way as for compiling C programs (usually
1603 with the name @command{gcc}).
1605 @findex g++
1606 @findex c++
1607 However, the use of @command{gcc} does not add the C++ library.
1608 @command{g++} is a program that calls GCC and automatically specifies linking
1609 against the C++ library.  It treats @samp{.c},
1610 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1611 files unless @option{-x} is used.  This program is also useful when
1612 precompiling a C header file with a @samp{.h} extension for use in C++
1613 compilations.  On many systems, @command{g++} is also installed with
1614 the name @command{c++}.
1616 @cindex invoking @command{g++}
1617 When you compile C++ programs, you may specify many of the same
1618 command-line options that you use for compiling programs in any
1619 language; or command-line options meaningful for C and related
1620 languages; or options that are meaningful only for C++ programs.
1621 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1622 explanations of options for languages related to C@.
1623 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1624 explanations of options that are meaningful only for C++ programs.
1626 @node C Dialect Options
1627 @section Options Controlling C Dialect
1628 @cindex dialect options
1629 @cindex language dialect options
1630 @cindex options, dialect
1632 The following options control the dialect of C (or languages derived
1633 from C, such as C++, Objective-C and Objective-C++) that the compiler
1634 accepts:
1636 @table @gcctabopt
1637 @cindex ANSI support
1638 @cindex ISO support
1639 @item -ansi
1640 @opindex ansi
1641 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1642 equivalent to @option{-std=c++98}.
1644 This turns off certain features of GCC that are incompatible with ISO
1645 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1646 such as the @code{asm} and @code{typeof} keywords, and
1647 predefined macros such as @code{unix} and @code{vax} that identify the
1648 type of system you are using.  It also enables the undesirable and
1649 rarely used ISO trigraph feature.  For the C compiler,
1650 it disables recognition of C++ style @samp{//} comments as well as
1651 the @code{inline} keyword.
1653 The alternate keywords @code{__asm__}, @code{__extension__},
1654 @code{__inline__} and @code{__typeof__} continue to work despite
1655 @option{-ansi}.  You would not want to use them in an ISO C program, of
1656 course, but it is useful to put them in header files that might be included
1657 in compilations done with @option{-ansi}.  Alternate predefined macros
1658 such as @code{__unix__} and @code{__vax__} are also available, with or
1659 without @option{-ansi}.
1661 The @option{-ansi} option does not cause non-ISO programs to be
1662 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1663 addition to @option{-ansi}.  @xref{Warning Options}.
1665 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1666 option is used.  Some header files may notice this macro and refrain
1667 from declaring certain functions or defining certain macros that the
1668 ISO standard doesn't call for; this is to avoid interfering with any
1669 programs that might use these names for other things.
1671 Functions that are normally built in but do not have semantics
1672 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1673 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1674 built-in functions provided by GCC}, for details of the functions
1675 affected.
1677 @item -std=
1678 @opindex std
1679 Determine the language standard. @xref{Standards,,Language Standards
1680 Supported by GCC}, for details of these standard versions.  This option
1681 is currently only supported when compiling C or C++.
1683 The compiler can accept several base standards, such as @samp{c90} or
1684 @samp{c++98}, and GNU dialects of those standards, such as
1685 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1686 compiler accepts all programs following that standard plus those
1687 using GNU extensions that do not contradict it.  For example,
1688 @option{-std=c90} turns off certain features of GCC that are
1689 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1690 keywords, but not other GNU extensions that do not have a meaning in
1691 ISO C90, such as omitting the middle term of a @code{?:}
1692 expression. On the other hand, when a GNU dialect of a standard is
1693 specified, all features supported by the compiler are enabled, even when
1694 those features change the meaning of the base standard.  As a result, some
1695 strict-conforming programs may be rejected.  The particular standard
1696 is used by @option{-Wpedantic} to identify which features are GNU
1697 extensions given that version of the standard. For example
1698 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1699 comments, while @option{-std=gnu99 -Wpedantic} does not.
1701 A value for this option must be provided; possible values are
1703 @table @samp
1704 @item c90
1705 @itemx c89
1706 @itemx iso9899:1990
1707 Support all ISO C90 programs (certain GNU extensions that conflict
1708 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1710 @item iso9899:199409
1711 ISO C90 as modified in amendment 1.
1713 @item c99
1714 @itemx c9x
1715 @itemx iso9899:1999
1716 @itemx iso9899:199x
1717 ISO C99.  This standard is substantially completely supported, modulo
1718 bugs and floating-point issues
1719 (mainly but not entirely relating to optional C99 features from
1720 Annexes F and G).  See
1721 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1722 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1724 @item c11
1725 @itemx c1x
1726 @itemx iso9899:2011
1727 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1728 substantially completely supported, modulo bugs, floating-point issues
1729 (mainly but not entirely relating to optional C11 features from
1730 Annexes F and G) and the optional Annexes K (Bounds-checking
1731 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1733 @item gnu90
1734 @itemx gnu89
1735 GNU dialect of ISO C90 (including some C99 features).
1737 @item gnu99
1738 @itemx gnu9x
1739 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1741 @item gnu11
1742 @itemx gnu1x
1743 GNU dialect of ISO C11.  This is the default for C code.
1744 The name @samp{gnu1x} is deprecated.
1746 @item c++98
1747 @itemx c++03
1748 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1749 additional defect reports. Same as @option{-ansi} for C++ code.
1751 @item gnu++98
1752 @itemx gnu++03
1753 GNU dialect of @option{-std=c++98}.  This is the default for
1754 C++ code.
1756 @item c++11
1757 @itemx c++0x
1758 The 2011 ISO C++ standard plus amendments.
1759 The name @samp{c++0x} is deprecated.
1761 @item gnu++11
1762 @itemx gnu++0x
1763 GNU dialect of @option{-std=c++11}.
1764 The name @samp{gnu++0x} is deprecated.
1766 @item c++14
1767 @itemx c++1y
1768 The 2014 ISO C++ standard plus amendments.
1769 The name @samp{c++1y} is deprecated.
1771 @item gnu++14
1772 @itemx gnu++1y
1773 GNU dialect of @option{-std=c++14}.
1774 The name @samp{gnu++1y} is deprecated.
1776 @item c++1z
1777 The next revision of the ISO C++ standard, tentatively planned for
1778 2017.  Support is highly experimental, and will almost certainly
1779 change in incompatible ways in future releases.
1781 @item gnu++1z
1782 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1783 and will almost certainly change in incompatible ways in future
1784 releases.
1785 @end table
1787 @item -fgnu89-inline
1788 @opindex fgnu89-inline
1789 The option @option{-fgnu89-inline} tells GCC to use the traditional
1790 GNU semantics for @code{inline} functions when in C99 mode.
1791 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1792 Using this option is roughly equivalent to adding the
1793 @code{gnu_inline} function attribute to all inline functions
1794 (@pxref{Function Attributes}).
1796 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1797 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1798 specifies the default behavior).
1799 This option is not supported in @option{-std=c90} or
1800 @option{-std=gnu90} mode.
1802 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1803 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1804 in effect for @code{inline} functions.  @xref{Common Predefined
1805 Macros,,,cpp,The C Preprocessor}.
1807 @item -aux-info @var{filename}
1808 @opindex aux-info
1809 Output to the given filename prototyped declarations for all functions
1810 declared and/or defined in a translation unit, including those in header
1811 files.  This option is silently ignored in any language other than C@.
1813 Besides declarations, the file indicates, in comments, the origin of
1814 each declaration (source file and line), whether the declaration was
1815 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1816 @samp{O} for old, respectively, in the first character after the line
1817 number and the colon), and whether it came from a declaration or a
1818 definition (@samp{C} or @samp{F}, respectively, in the following
1819 character).  In the case of function definitions, a K&R-style list of
1820 arguments followed by their declarations is also provided, inside
1821 comments, after the declaration.
1823 @item -fallow-parameterless-variadic-functions
1824 @opindex fallow-parameterless-variadic-functions
1825 Accept variadic functions without named parameters.
1827 Although it is possible to define such a function, this is not very
1828 useful as it is not possible to read the arguments.  This is only
1829 supported for C as this construct is allowed by C++.
1831 @item -fno-asm
1832 @opindex fno-asm
1833 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1834 keyword, so that code can use these words as identifiers.  You can use
1835 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1836 instead.  @option{-ansi} implies @option{-fno-asm}.
1838 In C++, this switch only affects the @code{typeof} keyword, since
1839 @code{asm} and @code{inline} are standard keywords.  You may want to
1840 use the @option{-fno-gnu-keywords} flag instead, which has the same
1841 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1842 switch only affects the @code{asm} and @code{typeof} keywords, since
1843 @code{inline} is a standard keyword in ISO C99.
1845 @item -fno-builtin
1846 @itemx -fno-builtin-@var{function}
1847 @opindex fno-builtin
1848 @cindex built-in functions
1849 Don't recognize built-in functions that do not begin with
1850 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1851 functions provided by GCC}, for details of the functions affected,
1852 including those which are not built-in functions when @option{-ansi} or
1853 @option{-std} options for strict ISO C conformance are used because they
1854 do not have an ISO standard meaning.
1856 GCC normally generates special code to handle certain built-in functions
1857 more efficiently; for instance, calls to @code{alloca} may become single
1858 instructions which adjust the stack directly, and calls to @code{memcpy}
1859 may become inline copy loops.  The resulting code is often both smaller
1860 and faster, but since the function calls no longer appear as such, you
1861 cannot set a breakpoint on those calls, nor can you change the behavior
1862 of the functions by linking with a different library.  In addition,
1863 when a function is recognized as a built-in function, GCC may use
1864 information about that function to warn about problems with calls to
1865 that function, or to generate more efficient code, even if the
1866 resulting code still contains calls to that function.  For example,
1867 warnings are given with @option{-Wformat} for bad calls to
1868 @code{printf} when @code{printf} is built in and @code{strlen} is
1869 known not to modify global memory.
1871 With the @option{-fno-builtin-@var{function}} option
1872 only the built-in function @var{function} is
1873 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1874 function is named that is not built-in in this version of GCC, this
1875 option is ignored.  There is no corresponding
1876 @option{-fbuiltin-@var{function}} option; if you wish to enable
1877 built-in functions selectively when using @option{-fno-builtin} or
1878 @option{-ffreestanding}, you may define macros such as:
1880 @smallexample
1881 #define abs(n)          __builtin_abs ((n))
1882 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1883 @end smallexample
1885 @item -fhosted
1886 @opindex fhosted
1887 @cindex hosted environment
1889 Assert that compilation targets a hosted environment.  This implies
1890 @option{-fbuiltin}.  A hosted environment is one in which the
1891 entire standard library is available, and in which @code{main} has a return
1892 type of @code{int}.  Examples are nearly everything except a kernel.
1893 This is equivalent to @option{-fno-freestanding}.
1895 @item -ffreestanding
1896 @opindex ffreestanding
1897 @cindex hosted environment
1899 Assert that compilation targets a freestanding environment.  This
1900 implies @option{-fno-builtin}.  A freestanding environment
1901 is one in which the standard library may not exist, and program startup may
1902 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1903 This is equivalent to @option{-fno-hosted}.
1905 @xref{Standards,,Language Standards Supported by GCC}, for details of
1906 freestanding and hosted environments.
1908 @item -fopenacc
1909 @opindex fopenacc
1910 @cindex OpenACC accelerator programming
1911 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1912 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1913 compiler generates accelerated code according to the OpenACC Application
1914 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1915 implies @option{-pthread}, and thus is only supported on targets that
1916 have support for @option{-pthread}.
1918 Note that this is an experimental feature, incomplete, and subject to
1919 change in future versions of GCC.  See
1920 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
1922 @item -fopenmp
1923 @opindex fopenmp
1924 @cindex OpenMP parallel
1925 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1926 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1927 compiler generates parallel code according to the OpenMP Application
1928 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1929 implies @option{-pthread}, and thus is only supported on targets that
1930 have support for @option{-pthread}. @option{-fopenmp} implies
1931 @option{-fopenmp-simd}.
1933 @item -fopenmp-simd
1934 @opindex fopenmp-simd
1935 @cindex OpenMP SIMD
1936 @cindex SIMD
1937 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1938 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1939 are ignored.
1941 @item -fcilkplus
1942 @opindex fcilkplus
1943 @cindex Enable Cilk Plus
1944 Enable the usage of Cilk Plus language extension features for C/C++.
1945 When the option @option{-fcilkplus} is specified, enable the usage of
1946 the Cilk Plus Language extension features for C/C++.  The present
1947 implementation follows ABI version 1.2.  This is an experimental
1948 feature that is only partially complete, and whose interface may
1949 change in future versions of GCC as the official specification
1950 changes.  Currently, all features but @code{_Cilk_for} have been
1951 implemented.
1953 @item -fgnu-tm
1954 @opindex fgnu-tm
1955 When the option @option{-fgnu-tm} is specified, the compiler
1956 generates code for the Linux variant of Intel's current Transactional
1957 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1958 an experimental feature whose interface may change in future versions
1959 of GCC, as the official specification changes.  Please note that not
1960 all architectures are supported for this feature.
1962 For more information on GCC's support for transactional memory,
1963 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1964 Transactional Memory Library}.
1966 Note that the transactional memory feature is not supported with
1967 non-call exceptions (@option{-fnon-call-exceptions}).
1969 @item -fms-extensions
1970 @opindex fms-extensions
1971 Accept some non-standard constructs used in Microsoft header files.
1973 In C++ code, this allows member names in structures to be similar
1974 to previous types declarations.
1976 @smallexample
1977 typedef int UOW;
1978 struct ABC @{
1979   UOW UOW;
1981 @end smallexample
1983 Some cases of unnamed fields in structures and unions are only
1984 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1985 fields within structs/unions}, for details.
1987 Note that this option is off for all targets but x86 
1988 targets using ms-abi.
1990 @item -fplan9-extensions
1991 @opindex fplan9-extensions
1992 Accept some non-standard constructs used in Plan 9 code.
1994 This enables @option{-fms-extensions}, permits passing pointers to
1995 structures with anonymous fields to functions that expect pointers to
1996 elements of the type of the field, and permits referring to anonymous
1997 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1998 struct/union fields within structs/unions}, for details.  This is only
1999 supported for C, not C++.
2001 @item -trigraphs
2002 @opindex trigraphs
2003 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2004 options for strict ISO C conformance) implies @option{-trigraphs}.
2006 @cindex traditional C language
2007 @cindex C language, traditional
2008 @item -traditional
2009 @itemx -traditional-cpp
2010 @opindex traditional-cpp
2011 @opindex traditional
2012 Formerly, these options caused GCC to attempt to emulate a pre-standard
2013 C compiler.  They are now only supported with the @option{-E} switch.
2014 The preprocessor continues to support a pre-standard mode.  See the GNU
2015 CPP manual for details.
2017 @item -fcond-mismatch
2018 @opindex fcond-mismatch
2019 Allow conditional expressions with mismatched types in the second and
2020 third arguments.  The value of such an expression is void.  This option
2021 is not supported for C++.
2023 @item -flax-vector-conversions
2024 @opindex flax-vector-conversions
2025 Allow implicit conversions between vectors with differing numbers of
2026 elements and/or incompatible element types.  This option should not be
2027 used for new code.
2029 @item -funsigned-char
2030 @opindex funsigned-char
2031 Let the type @code{char} be unsigned, like @code{unsigned char}.
2033 Each kind of machine has a default for what @code{char} should
2034 be.  It is either like @code{unsigned char} by default or like
2035 @code{signed char} by default.
2037 Ideally, a portable program should always use @code{signed char} or
2038 @code{unsigned char} when it depends on the signedness of an object.
2039 But many programs have been written to use plain @code{char} and
2040 expect it to be signed, or expect it to be unsigned, depending on the
2041 machines they were written for.  This option, and its inverse, let you
2042 make such a program work with the opposite default.
2044 The type @code{char} is always a distinct type from each of
2045 @code{signed char} or @code{unsigned char}, even though its behavior
2046 is always just like one of those two.
2048 @item -fsigned-char
2049 @opindex fsigned-char
2050 Let the type @code{char} be signed, like @code{signed char}.
2052 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2053 the negative form of @option{-funsigned-char}.  Likewise, the option
2054 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2056 @item -fsigned-bitfields
2057 @itemx -funsigned-bitfields
2058 @itemx -fno-signed-bitfields
2059 @itemx -fno-unsigned-bitfields
2060 @opindex fsigned-bitfields
2061 @opindex funsigned-bitfields
2062 @opindex fno-signed-bitfields
2063 @opindex fno-unsigned-bitfields
2064 These options control whether a bit-field is signed or unsigned, when the
2065 declaration does not use either @code{signed} or @code{unsigned}.  By
2066 default, such a bit-field is signed, because this is consistent: the
2067 basic integer types such as @code{int} are signed types.
2068 @end table
2070 @node C++ Dialect Options
2071 @section Options Controlling C++ Dialect
2073 @cindex compiler options, C++
2074 @cindex C++ options, command-line
2075 @cindex options, C++
2076 This section describes the command-line options that are only meaningful
2077 for C++ programs.  You can also use most of the GNU compiler options
2078 regardless of what language your program is in.  For example, you
2079 might compile a file @file{firstClass.C} like this:
2081 @smallexample
2082 g++ -g -frepo -O -c firstClass.C
2083 @end smallexample
2085 @noindent
2086 In this example, only @option{-frepo} is an option meant
2087 only for C++ programs; you can use the other options with any
2088 language supported by GCC@.
2090 Here is a list of options that are @emph{only} for compiling C++ programs:
2092 @table @gcctabopt
2094 @item -fabi-version=@var{n}
2095 @opindex fabi-version
2096 Use version @var{n} of the C++ ABI@.  The default is version 0.
2098 Version 0 refers to the version conforming most closely to
2099 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2100 will change in different versions of G++ as ABI bugs are fixed.
2102 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2104 Version 2 is the version of the C++ ABI that first appeared in G++
2105 3.4, and was the default through G++ 4.9.
2107 Version 3 corrects an error in mangling a constant address as a
2108 template argument.
2110 Version 4, which first appeared in G++ 4.5, implements a standard
2111 mangling for vector types.
2113 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2114 attribute const/volatile on function pointer types, decltype of a
2115 plain decl, and use of a function parameter in the declaration of
2116 another parameter.
2118 Version 6, which first appeared in G++ 4.7, corrects the promotion
2119 behavior of C++11 scoped enums and the mangling of template argument
2120 packs, const/static_cast, prefix ++ and --, and a class scope function
2121 used as a template argument.
2123 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2124 builtin type and corrects the mangling of lambdas in default argument
2125 scope.
2127 Version 8, which first appeared in G++ 4.9, corrects the substitution
2128 behavior of function types with function-cv-qualifiers.
2130 See also @option{-Wabi}.
2132 @item -fabi-compat-version=@var{n}
2133 @opindex fabi-compat-version
2134 On targets that support strong aliases, G++
2135 works around mangling changes by creating an alias with the correct
2136 mangled name when defining a symbol with an incorrect mangled name.
2137 This switch specifies which ABI version to use for the alias.
2139 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2140 another ABI version is explicitly selected, this defaults to 0.
2142 The compatibility version is also set by @option{-Wabi=@var{n}}.
2144 @item -fno-access-control
2145 @opindex fno-access-control
2146 Turn off all access checking.  This switch is mainly useful for working
2147 around bugs in the access control code.
2149 @item -fcheck-new
2150 @opindex fcheck-new
2151 Check that the pointer returned by @code{operator new} is non-null
2152 before attempting to modify the storage allocated.  This check is
2153 normally unnecessary because the C++ standard specifies that
2154 @code{operator new} only returns @code{0} if it is declared
2155 @code{throw()}, in which case the compiler always checks the
2156 return value even without this option.  In all other cases, when
2157 @code{operator new} has a non-empty exception specification, memory
2158 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2159 @samp{new (nothrow)}.
2161 @item -fconstexpr-depth=@var{n}
2162 @opindex fconstexpr-depth
2163 Set the maximum nested evaluation depth for C++11 constexpr functions
2164 to @var{n}.  A limit is needed to detect endless recursion during
2165 constant expression evaluation.  The minimum specified by the standard
2166 is 512.
2168 @item -fdeduce-init-list
2169 @opindex fdeduce-init-list
2170 Enable deduction of a template type parameter as
2171 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2173 @smallexample
2174 template <class T> auto forward(T t) -> decltype (realfn (t))
2176   return realfn (t);
2179 void f()
2181   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2183 @end smallexample
2185 This deduction was implemented as a possible extension to the
2186 originally proposed semantics for the C++11 standard, but was not part
2187 of the final standard, so it is disabled by default.  This option is
2188 deprecated, and may be removed in a future version of G++.
2190 @item -ffriend-injection
2191 @opindex ffriend-injection
2192 Inject friend functions into the enclosing namespace, so that they are
2193 visible outside the scope of the class in which they are declared.
2194 Friend functions were documented to work this way in the old Annotated
2195 C++ Reference Manual.  
2196 However, in ISO C++ a friend function that is not declared
2197 in an enclosing scope can only be found using argument dependent
2198 lookup.  GCC defaults to the standard behavior.
2200 This option is for compatibility, and may be removed in a future
2201 release of G++.
2203 @item -fno-elide-constructors
2204 @opindex fno-elide-constructors
2205 The C++ standard allows an implementation to omit creating a temporary
2206 that is only used to initialize another object of the same type.
2207 Specifying this option disables that optimization, and forces G++ to
2208 call the copy constructor in all cases.
2210 @item -fno-enforce-eh-specs
2211 @opindex fno-enforce-eh-specs
2212 Don't generate code to check for violation of exception specifications
2213 at run time.  This option violates the C++ standard, but may be useful
2214 for reducing code size in production builds, much like defining
2215 @code{NDEBUG}.  This does not give user code permission to throw
2216 exceptions in violation of the exception specifications; the compiler
2217 still optimizes based on the specifications, so throwing an
2218 unexpected exception results in undefined behavior at run time.
2220 @item -fextern-tls-init
2221 @itemx -fno-extern-tls-init
2222 @opindex fextern-tls-init
2223 @opindex fno-extern-tls-init
2224 The C++11 and OpenMP standards allow @code{thread_local} and
2225 @code{threadprivate} variables to have dynamic (runtime)
2226 initialization.  To support this, any use of such a variable goes
2227 through a wrapper function that performs any necessary initialization.
2228 When the use and definition of the variable are in the same
2229 translation unit, this overhead can be optimized away, but when the
2230 use is in a different translation unit there is significant overhead
2231 even if the variable doesn't actually need dynamic initialization.  If
2232 the programmer can be sure that no use of the variable in a
2233 non-defining TU needs to trigger dynamic initialization (either
2234 because the variable is statically initialized, or a use of the
2235 variable in the defining TU will be executed before any uses in
2236 another TU), they can avoid this overhead with the
2237 @option{-fno-extern-tls-init} option.
2239 On targets that support symbol aliases, the default is
2240 @option{-fextern-tls-init}.  On targets that do not support symbol
2241 aliases, the default is @option{-fno-extern-tls-init}.
2243 @item -ffor-scope
2244 @itemx -fno-for-scope
2245 @opindex ffor-scope
2246 @opindex fno-for-scope
2247 If @option{-ffor-scope} is specified, the scope of variables declared in
2248 a @i{for-init-statement} is limited to the @code{for} loop itself,
2249 as specified by the C++ standard.
2250 If @option{-fno-for-scope} is specified, the scope of variables declared in
2251 a @i{for-init-statement} extends to the end of the enclosing scope,
2252 as was the case in old versions of G++, and other (traditional)
2253 implementations of C++.
2255 If neither flag is given, the default is to follow the standard,
2256 but to allow and give a warning for old-style code that would
2257 otherwise be invalid, or have different behavior.
2259 @item -fno-gnu-keywords
2260 @opindex fno-gnu-keywords
2261 Do not recognize @code{typeof} as a keyword, so that code can use this
2262 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2263 @option{-ansi} implies @option{-fno-gnu-keywords}.
2265 @item -fno-implicit-templates
2266 @opindex fno-implicit-templates
2267 Never emit code for non-inline templates that are instantiated
2268 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2269 @xref{Template Instantiation}, for more information.
2271 @item -fno-implicit-inline-templates
2272 @opindex fno-implicit-inline-templates
2273 Don't emit code for implicit instantiations of inline templates, either.
2274 The default is to handle inlines differently so that compiles with and
2275 without optimization need the same set of explicit instantiations.
2277 @item -fno-implement-inlines
2278 @opindex fno-implement-inlines
2279 To save space, do not emit out-of-line copies of inline functions
2280 controlled by @code{#pragma implementation}.  This causes linker
2281 errors if these functions are not inlined everywhere they are called.
2283 @item -fms-extensions
2284 @opindex fms-extensions
2285 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2286 int and getting a pointer to member function via non-standard syntax.
2288 @item -fno-nonansi-builtins
2289 @opindex fno-nonansi-builtins
2290 Disable built-in declarations of functions that are not mandated by
2291 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2292 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2294 @item -fnothrow-opt
2295 @opindex fnothrow-opt
2296 Treat a @code{throw()} exception specification as if it were a
2297 @code{noexcept} specification to reduce or eliminate the text size
2298 overhead relative to a function with no exception specification.  If
2299 the function has local variables of types with non-trivial
2300 destructors, the exception specification actually makes the
2301 function smaller because the EH cleanups for those variables can be
2302 optimized away.  The semantic effect is that an exception thrown out of
2303 a function with such an exception specification results in a call
2304 to @code{terminate} rather than @code{unexpected}.
2306 @item -fno-operator-names
2307 @opindex fno-operator-names
2308 Do not treat the operator name keywords @code{and}, @code{bitand},
2309 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2310 synonyms as keywords.
2312 @item -fno-optional-diags
2313 @opindex fno-optional-diags
2314 Disable diagnostics that the standard says a compiler does not need to
2315 issue.  Currently, the only such diagnostic issued by G++ is the one for
2316 a name having multiple meanings within a class.
2318 @item -fpermissive
2319 @opindex fpermissive
2320 Downgrade some diagnostics about nonconformant code from errors to
2321 warnings.  Thus, using @option{-fpermissive} allows some
2322 nonconforming code to compile.
2324 @item -fno-pretty-templates
2325 @opindex fno-pretty-templates
2326 When an error message refers to a specialization of a function
2327 template, the compiler normally prints the signature of the
2328 template followed by the template arguments and any typedefs or
2329 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2330 rather than @code{void f(int)}) so that it's clear which template is
2331 involved.  When an error message refers to a specialization of a class
2332 template, the compiler omits any template arguments that match
2333 the default template arguments for that template.  If either of these
2334 behaviors make it harder to understand the error message rather than
2335 easier, you can use @option{-fno-pretty-templates} to disable them.
2337 @item -frepo
2338 @opindex frepo
2339 Enable automatic template instantiation at link time.  This option also
2340 implies @option{-fno-implicit-templates}.  @xref{Template
2341 Instantiation}, for more information.
2343 @item -fno-rtti
2344 @opindex fno-rtti
2345 Disable generation of information about every class with virtual
2346 functions for use by the C++ run-time type identification features
2347 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2348 of the language, you can save some space by using this flag.  Note that
2349 exception handling uses the same information, but G++ generates it as
2350 needed. The @code{dynamic_cast} operator can still be used for casts that
2351 do not require run-time type information, i.e.@: casts to @code{void *} or to
2352 unambiguous base classes.
2354 @item -fsized-deallocation
2355 @opindex fsized-deallocation
2356 Enable the built-in global declarations
2357 @smallexample
2358 void operator delete (void *, std::size_t) noexcept;
2359 void operator delete[] (void *, std::size_t) noexcept;
2360 @end smallexample
2361 as introduced in C++14.  This is useful for user-defined replacement
2362 deallocation functions that, for example, use the size of the object
2363 to make deallocation faster.  Enabled by default under
2364 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2365 warns about places that might want to add a definition.
2367 @item -fstats
2368 @opindex fstats
2369 Emit statistics about front-end processing at the end of the compilation.
2370 This information is generally only useful to the G++ development team.
2372 @item -fstrict-enums
2373 @opindex fstrict-enums
2374 Allow the compiler to optimize using the assumption that a value of
2375 enumerated type can only be one of the values of the enumeration (as
2376 defined in the C++ standard; basically, a value that can be
2377 represented in the minimum number of bits needed to represent all the
2378 enumerators).  This assumption may not be valid if the program uses a
2379 cast to convert an arbitrary integer value to the enumerated type.
2381 @item -ftemplate-backtrace-limit=@var{n}
2382 @opindex ftemplate-backtrace-limit
2383 Set the maximum number of template instantiation notes for a single
2384 warning or error to @var{n}.  The default value is 10.
2386 @item -ftemplate-depth=@var{n}
2387 @opindex ftemplate-depth
2388 Set the maximum instantiation depth for template classes to @var{n}.
2389 A limit on the template instantiation depth is needed to detect
2390 endless recursions during template class instantiation.  ANSI/ISO C++
2391 conforming programs must not rely on a maximum depth greater than 17
2392 (changed to 1024 in C++11).  The default value is 900, as the compiler
2393 can run out of stack space before hitting 1024 in some situations.
2395 @item -fno-threadsafe-statics
2396 @opindex fno-threadsafe-statics
2397 Do not emit the extra code to use the routines specified in the C++
2398 ABI for thread-safe initialization of local statics.  You can use this
2399 option to reduce code size slightly in code that doesn't need to be
2400 thread-safe.
2402 @item -fuse-cxa-atexit
2403 @opindex fuse-cxa-atexit
2404 Register destructors for objects with static storage duration with the
2405 @code{__cxa_atexit} function rather than the @code{atexit} function.
2406 This option is required for fully standards-compliant handling of static
2407 destructors, but only works if your C library supports
2408 @code{__cxa_atexit}.
2410 @item -fno-use-cxa-get-exception-ptr
2411 @opindex fno-use-cxa-get-exception-ptr
2412 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2413 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2414 if the runtime routine is not available.
2416 @item -fvisibility-inlines-hidden
2417 @opindex fvisibility-inlines-hidden
2418 This switch declares that the user does not attempt to compare
2419 pointers to inline functions or methods where the addresses of the two functions
2420 are taken in different shared objects.
2422 The effect of this is that GCC may, effectively, mark inline methods with
2423 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2424 appear in the export table of a DSO and do not require a PLT indirection
2425 when used within the DSO@.  Enabling this option can have a dramatic effect
2426 on load and link times of a DSO as it massively reduces the size of the
2427 dynamic export table when the library makes heavy use of templates.
2429 The behavior of this switch is not quite the same as marking the
2430 methods as hidden directly, because it does not affect static variables
2431 local to the function or cause the compiler to deduce that
2432 the function is defined in only one shared object.
2434 You may mark a method as having a visibility explicitly to negate the
2435 effect of the switch for that method.  For example, if you do want to
2436 compare pointers to a particular inline method, you might mark it as
2437 having default visibility.  Marking the enclosing class with explicit
2438 visibility has no effect.
2440 Explicitly instantiated inline methods are unaffected by this option
2441 as their linkage might otherwise cross a shared library boundary.
2442 @xref{Template Instantiation}.
2444 @item -fvisibility-ms-compat
2445 @opindex fvisibility-ms-compat
2446 This flag attempts to use visibility settings to make GCC's C++
2447 linkage model compatible with that of Microsoft Visual Studio.
2449 The flag makes these changes to GCC's linkage model:
2451 @enumerate
2452 @item
2453 It sets the default visibility to @code{hidden}, like
2454 @option{-fvisibility=hidden}.
2456 @item
2457 Types, but not their members, are not hidden by default.
2459 @item
2460 The One Definition Rule is relaxed for types without explicit
2461 visibility specifications that are defined in more than one
2462 shared object: those declarations are permitted if they are
2463 permitted when this option is not used.
2464 @end enumerate
2466 In new code it is better to use @option{-fvisibility=hidden} and
2467 export those classes that are intended to be externally visible.
2468 Unfortunately it is possible for code to rely, perhaps accidentally,
2469 on the Visual Studio behavior.
2471 Among the consequences of these changes are that static data members
2472 of the same type with the same name but defined in different shared
2473 objects are different, so changing one does not change the other;
2474 and that pointers to function members defined in different shared
2475 objects may not compare equal.  When this flag is given, it is a
2476 violation of the ODR to define types with the same name differently.
2478 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
2479 @opindex fvtable-verify
2480 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2481 feature that verifies at run time, for every virtual call, that
2482 the vtable pointer through which the call is made is valid for the type of
2483 the object, and has not been corrupted or overwritten.  If an invalid vtable
2484 pointer is detected at run time, an error is reported and execution of the
2485 program is immediately halted.
2487 This option causes run-time data structures to be built at program startup,
2488 which are used for verifying the vtable pointers.  
2489 The options @samp{std} and @samp{preinit}
2490 control the timing of when these data structures are built.  In both cases the
2491 data structures are built before execution reaches @code{main}.  Using
2492 @option{-fvtable-verify=std} causes the data structures to be built after
2493 shared libraries have been loaded and initialized.
2494 @option{-fvtable-verify=preinit} causes them to be built before shared
2495 libraries have been loaded and initialized.
2497 If this option appears multiple times in the command line with different
2498 values specified, @samp{none} takes highest priority over both @samp{std} and
2499 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
2501 @item -fvtv-debug
2502 @opindex fvtv-debug
2503 When used in conjunction with @option{-fvtable-verify=std} or 
2504 @option{-fvtable-verify=preinit}, causes debug versions of the 
2505 runtime functions for the vtable verification feature to be called.  
2506 This flag also causes the compiler to log information about which 
2507 vtable pointers it finds for each class.
2508 This information is written to a file named @file{vtv_set_ptr_data.log} 
2509 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
2510 if that is defined or the current working directory otherwise.
2512 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
2513 file, be sure to delete any existing one.
2515 @item -fvtv-counts
2516 @opindex fvtv-counts
2517 This is a debugging flag.  When used in conjunction with
2518 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2519 causes the compiler to keep track of the total number of virtual calls
2520 it encounters and the number of verifications it inserts.  It also
2521 counts the number of calls to certain run-time library functions
2522 that it inserts and logs this information for each compilation unit.
2523 The compiler writes this information to a file named
2524 @file{vtv_count_data.log} in the directory named by the environment
2525 variable @env{VTV_LOGS_DIR} if that is defined or the current working
2526 directory otherwise.  It also counts the size of the vtable pointer sets
2527 for each class, and writes this information to @file{vtv_class_set_sizes.log}
2528 in the same directory.
2530 Note:  This feature @emph{appends} data to the log files.  To get fresh log
2531 files, be sure to delete any existing ones.
2533 @item -fno-weak
2534 @opindex fno-weak
2535 Do not use weak symbol support, even if it is provided by the linker.
2536 By default, G++ uses weak symbols if they are available.  This
2537 option exists only for testing, and should not be used by end-users;
2538 it results in inferior code and has no benefits.  This option may
2539 be removed in a future release of G++.
2541 @item -nostdinc++
2542 @opindex nostdinc++
2543 Do not search for header files in the standard directories specific to
2544 C++, but do still search the other standard directories.  (This option
2545 is used when building the C++ library.)
2546 @end table
2548 In addition, these optimization, warning, and code generation options
2549 have meanings only for C++ programs:
2551 @table @gcctabopt
2552 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2553 @opindex Wabi
2554 @opindex Wno-abi
2555 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2556 G++ to warn when it generates code that is probably not compatible with the
2557 vendor-neutral C++ ABI@.  Since G++ now defaults to
2558 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2559 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2560 or an older compatibility version is selected (with
2561 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2563 Although an effort has been made to warn about
2564 all such cases, there are probably some cases that are not warned about,
2565 even though G++ is generating incompatible code.  There may also be
2566 cases where warnings are emitted even though the code that is generated
2567 is compatible.
2569 You should rewrite your code to avoid these warnings if you are
2570 concerned about the fact that code generated by G++ may not be binary
2571 compatible with code generated by other compilers.
2573 @option{-Wabi} can also be used with an explicit version number to
2574 warn about compatibility with a particular @option{-fabi-version}
2575 level, e.g. @option{-Wabi=2} to warn about changes relative to
2576 @option{-fabi-version=2}.  Specifying a version number also sets
2577 @option{-fabi-compat-version=@var{n}}.
2579 The known incompatibilities in @option{-fabi-version=2} (which was the
2580 default from GCC 3.4 to 4.9) include:
2582 @itemize @bullet
2584 @item
2585 A template with a non-type template parameter of reference type was
2586 mangled incorrectly:
2587 @smallexample
2588 extern int N;
2589 template <int &> struct S @{@};
2590 void n (S<N>) @{2@}
2591 @end smallexample
2593 This was fixed in @option{-fabi-version=3}.
2595 @item
2596 SIMD vector types declared using @code{__attribute ((vector_size))} were
2597 mangled in a non-standard way that does not allow for overloading of
2598 functions taking vectors of different sizes.
2600 The mangling was changed in @option{-fabi-version=4}.
2602 @item
2603 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2604 qualifiers, and @code{decltype} of a plain declaration was folded away.
2606 These mangling issues were fixed in @option{-fabi-version=5}.
2608 @item
2609 Scoped enumerators passed as arguments to a variadic function are
2610 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2611 On most targets this does not actually affect the parameter passing
2612 ABI, as there is no way to pass an argument smaller than @code{int}.
2614 Also, the ABI changed the mangling of template argument packs,
2615 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2616 a class scope function used as a template argument.
2618 These issues were corrected in @option{-fabi-version=6}.
2620 @item
2621 Lambdas in default argument scope were mangled incorrectly, and the
2622 ABI changed the mangling of @code{nullptr_t}.
2624 These issues were corrected in @option{-fabi-version=7}.
2626 @item
2627 When mangling a function type with function-cv-qualifiers, the
2628 un-qualified function type was incorrectly treated as a substitution
2629 candidate.
2631 This was fixed in @option{-fabi-version=8}.
2632 @end itemize
2634 It also warns about psABI-related changes.  The known psABI changes at this
2635 point include:
2637 @itemize @bullet
2639 @item
2640 For SysV/x86-64, unions with @code{long double} members are 
2641 passed in memory as specified in psABI.  For example:
2643 @smallexample
2644 union U @{
2645   long double ld;
2646   int i;
2648 @end smallexample
2650 @noindent
2651 @code{union U} is always passed in memory.
2653 @end itemize
2655 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2656 @opindex Wabi-tag
2657 @opindex -Wabi-tag
2658 Warn when a type with an ABI tag is used in a context that does not
2659 have that ABI tag.  See @ref{C++ Attributes} for more information
2660 about ABI tags.
2662 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2663 @opindex Wctor-dtor-privacy
2664 @opindex Wno-ctor-dtor-privacy
2665 Warn when a class seems unusable because all the constructors or
2666 destructors in that class are private, and it has neither friends nor
2667 public static member functions.  Also warn if there are no non-private
2668 methods, and there's at least one private member function that isn't
2669 a constructor or destructor.
2671 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2672 @opindex Wdelete-non-virtual-dtor
2673 @opindex Wno-delete-non-virtual-dtor
2674 Warn when @code{delete} is used to destroy an instance of a class that
2675 has virtual functions and non-virtual destructor. It is unsafe to delete
2676 an instance of a derived class through a pointer to a base class if the
2677 base class does not have a virtual destructor.  This warning is enabled
2678 by @option{-Wall}.
2680 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2681 @opindex Wliteral-suffix
2682 @opindex Wno-literal-suffix
2683 Warn when a string or character literal is followed by a ud-suffix which does
2684 not begin with an underscore.  As a conforming extension, GCC treats such
2685 suffixes as separate preprocessing tokens in order to maintain backwards
2686 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2687 For example:
2689 @smallexample
2690 #define __STDC_FORMAT_MACROS
2691 #include <inttypes.h>
2692 #include <stdio.h>
2694 int main() @{
2695   int64_t i64 = 123;
2696   printf("My int64: %" PRId64"\n", i64);
2698 @end smallexample
2700 In this case, @code{PRId64} is treated as a separate preprocessing token.
2702 This warning is enabled by default.
2704 @item -Wlto-type-mismatch
2705 @opindex Wlto-type-mismatch
2706 @opindex Wno-lto-type-mistmach
2708 During the link-time optimization warn about type mismatches in between
2709 global declarations from different compilation units.
2710 Requires @option{-flto} to be enabled.  Enabled by default.
2712 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2713 @opindex Wnarrowing
2714 @opindex Wno-narrowing
2715 Warn when a narrowing conversion prohibited by C++11 occurs within
2716 @samp{@{ @}}, e.g.
2718 @smallexample
2719 int i = @{ 2.2 @}; // error: narrowing from double to int
2720 @end smallexample
2722 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2724 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2725 required by the standard.  Note that this does not affect the meaning
2726 of well-formed code; narrowing conversions are still considered
2727 ill-formed in SFINAE context.
2729 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2730 @opindex Wnoexcept
2731 @opindex Wno-noexcept
2732 Warn when a noexcept-expression evaluates to false because of a call
2733 to a function that does not have a non-throwing exception
2734 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2735 the compiler to never throw an exception.
2737 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2738 @opindex Wnon-virtual-dtor
2739 @opindex Wno-non-virtual-dtor
2740 Warn when a class has virtual functions and an accessible non-virtual
2741 destructor itself or in an accessible polymorphic base class, in which
2742 case it is possible but unsafe to delete an instance of a derived
2743 class through a pointer to the class itself or base class.  This
2744 warning is automatically enabled if @option{-Weffc++} is specified.
2746 @item -Wreorder @r{(C++ and Objective-C++ only)}
2747 @opindex Wreorder
2748 @opindex Wno-reorder
2749 @cindex reordering, warning
2750 @cindex warning for reordering of member initializers
2751 Warn when the order of member initializers given in the code does not
2752 match the order in which they must be executed.  For instance:
2754 @smallexample
2755 struct A @{
2756   int i;
2757   int j;
2758   A(): j (0), i (1) @{ @}
2760 @end smallexample
2762 @noindent
2763 The compiler rearranges the member initializers for @code{i}
2764 and @code{j} to match the declaration order of the members, emitting
2765 a warning to that effect.  This warning is enabled by @option{-Wall}.
2767 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2768 @opindex fext-numeric-literals
2769 @opindex fno-ext-numeric-literals
2770 Accept imaginary, fixed-point, or machine-defined
2771 literal number suffixes as GNU extensions.
2772 When this option is turned off these suffixes are treated
2773 as C++11 user-defined literal numeric suffixes.
2774 This is on by default for all pre-C++11 dialects and all GNU dialects:
2775 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2776 @option{-std=gnu++14}.
2777 This option is off by default
2778 for ISO C++11 onwards (@option{-std=c++11}, ...).
2779 @end table
2781 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2783 @table @gcctabopt
2784 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2785 @opindex Weffc++
2786 @opindex Wno-effc++
2787 Warn about violations of the following style guidelines from Scott Meyers'
2788 @cite{Effective C++} series of books:
2790 @itemize @bullet
2791 @item
2792 Define a copy constructor and an assignment operator for classes
2793 with dynamically-allocated memory.
2795 @item
2796 Prefer initialization to assignment in constructors.
2798 @item
2799 Have @code{operator=} return a reference to @code{*this}.
2801 @item
2802 Don't try to return a reference when you must return an object.
2804 @item
2805 Distinguish between prefix and postfix forms of increment and
2806 decrement operators.
2808 @item
2809 Never overload @code{&&}, @code{||}, or @code{,}.
2811 @end itemize
2813 This option also enables @option{-Wnon-virtual-dtor}, which is also
2814 one of the effective C++ recommendations.  However, the check is
2815 extended to warn about the lack of virtual destructor in accessible
2816 non-polymorphic bases classes too.
2818 When selecting this option, be aware that the standard library
2819 headers do not obey all of these guidelines; use @samp{grep -v}
2820 to filter out those warnings.
2822 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2823 @opindex Wstrict-null-sentinel
2824 @opindex Wno-strict-null-sentinel
2825 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2826 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2827 to @code{__null}.  Although it is a null pointer constant rather than a
2828 null pointer, it is guaranteed to be of the same size as a pointer.
2829 But this use is not portable across different compilers.
2831 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2832 @opindex Wno-non-template-friend
2833 @opindex Wnon-template-friend
2834 Disable warnings when non-templatized friend functions are declared
2835 within a template.  Since the advent of explicit template specification
2836 support in G++, if the name of the friend is an unqualified-id (i.e.,
2837 @samp{friend foo(int)}), the C++ language specification demands that the
2838 friend declare or define an ordinary, nontemplate function.  (Section
2839 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2840 could be interpreted as a particular specialization of a templatized
2841 function.  Because this non-conforming behavior is no longer the default
2842 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2843 check existing code for potential trouble spots and is on by default.
2844 This new compiler behavior can be turned off with
2845 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2846 but disables the helpful warning.
2848 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2849 @opindex Wold-style-cast
2850 @opindex Wno-old-style-cast
2851 Warn if an old-style (C-style) cast to a non-void type is used within
2852 a C++ program.  The new-style casts (@code{dynamic_cast},
2853 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2854 less vulnerable to unintended effects and much easier to search for.
2856 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2857 @opindex Woverloaded-virtual
2858 @opindex Wno-overloaded-virtual
2859 @cindex overloaded virtual function, warning
2860 @cindex warning for overloaded virtual function
2861 Warn when a function declaration hides virtual functions from a
2862 base class.  For example, in:
2864 @smallexample
2865 struct A @{
2866   virtual void f();
2869 struct B: public A @{
2870   void f(int);
2872 @end smallexample
2874 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2875 like:
2877 @smallexample
2878 B* b;
2879 b->f();
2880 @end smallexample
2882 @noindent
2883 fails to compile.
2885 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2886 @opindex Wno-pmf-conversions
2887 @opindex Wpmf-conversions
2888 Disable the diagnostic for converting a bound pointer to member function
2889 to a plain pointer.
2891 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2892 @opindex Wsign-promo
2893 @opindex Wno-sign-promo
2894 Warn when overload resolution chooses a promotion from unsigned or
2895 enumerated type to a signed type, over a conversion to an unsigned type of
2896 the same size.  Previous versions of G++ tried to preserve
2897 unsignedness, but the standard mandates the current behavior.
2899 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
2900 @opindex Wterminate
2901 @opindex Wno-terminate
2902 Disable the warning about a throw-expression that will immediately
2903 result in a call to @code{terminate}.
2904 @end table
2906 @node Objective-C and Objective-C++ Dialect Options
2907 @section Options Controlling Objective-C and Objective-C++ Dialects
2909 @cindex compiler options, Objective-C and Objective-C++
2910 @cindex Objective-C and Objective-C++ options, command-line
2911 @cindex options, Objective-C and Objective-C++
2912 (NOTE: This manual does not describe the Objective-C and Objective-C++
2913 languages themselves.  @xref{Standards,,Language Standards
2914 Supported by GCC}, for references.)
2916 This section describes the command-line options that are only meaningful
2917 for Objective-C and Objective-C++ programs.  You can also use most of
2918 the language-independent GNU compiler options.
2919 For example, you might compile a file @file{some_class.m} like this:
2921 @smallexample
2922 gcc -g -fgnu-runtime -O -c some_class.m
2923 @end smallexample
2925 @noindent
2926 In this example, @option{-fgnu-runtime} is an option meant only for
2927 Objective-C and Objective-C++ programs; you can use the other options with
2928 any language supported by GCC@.
2930 Note that since Objective-C is an extension of the C language, Objective-C
2931 compilations may also use options specific to the C front-end (e.g.,
2932 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2933 C++-specific options (e.g., @option{-Wabi}).
2935 Here is a list of options that are @emph{only} for compiling Objective-C
2936 and Objective-C++ programs:
2938 @table @gcctabopt
2939 @item -fconstant-string-class=@var{class-name}
2940 @opindex fconstant-string-class
2941 Use @var{class-name} as the name of the class to instantiate for each
2942 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2943 class name is @code{NXConstantString} if the GNU runtime is being used, and
2944 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2945 @option{-fconstant-cfstrings} option, if also present, overrides the
2946 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2947 to be laid out as constant CoreFoundation strings.
2949 @item -fgnu-runtime
2950 @opindex fgnu-runtime
2951 Generate object code compatible with the standard GNU Objective-C
2952 runtime.  This is the default for most types of systems.
2954 @item -fnext-runtime
2955 @opindex fnext-runtime
2956 Generate output compatible with the NeXT runtime.  This is the default
2957 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2958 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2959 used.
2961 @item -fno-nil-receivers
2962 @opindex fno-nil-receivers
2963 Assume that all Objective-C message dispatches (@code{[receiver
2964 message:arg]}) in this translation unit ensure that the receiver is
2965 not @code{nil}.  This allows for more efficient entry points in the
2966 runtime to be used.  This option is only available in conjunction with
2967 the NeXT runtime and ABI version 0 or 1.
2969 @item -fobjc-abi-version=@var{n}
2970 @opindex fobjc-abi-version
2971 Use version @var{n} of the Objective-C ABI for the selected runtime.
2972 This option is currently supported only for the NeXT runtime.  In that
2973 case, Version 0 is the traditional (32-bit) ABI without support for
2974 properties and other Objective-C 2.0 additions.  Version 1 is the
2975 traditional (32-bit) ABI with support for properties and other
2976 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2977 nothing is specified, the default is Version 0 on 32-bit target
2978 machines, and Version 2 on 64-bit target machines.
2980 @item -fobjc-call-cxx-cdtors
2981 @opindex fobjc-call-cxx-cdtors
2982 For each Objective-C class, check if any of its instance variables is a
2983 C++ object with a non-trivial default constructor.  If so, synthesize a
2984 special @code{- (id) .cxx_construct} instance method which runs
2985 non-trivial default constructors on any such instance variables, in order,
2986 and then return @code{self}.  Similarly, check if any instance variable
2987 is a C++ object with a non-trivial destructor, and if so, synthesize a
2988 special @code{- (void) .cxx_destruct} method which runs
2989 all such default destructors, in reverse order.
2991 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2992 methods thusly generated only operate on instance variables
2993 declared in the current Objective-C class, and not those inherited
2994 from superclasses.  It is the responsibility of the Objective-C
2995 runtime to invoke all such methods in an object's inheritance
2996 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2997 by the runtime immediately after a new object instance is allocated;
2998 the @code{- (void) .cxx_destruct} methods are invoked immediately
2999 before the runtime deallocates an object instance.
3001 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3002 support for invoking the @code{- (id) .cxx_construct} and
3003 @code{- (void) .cxx_destruct} methods.
3005 @item -fobjc-direct-dispatch
3006 @opindex fobjc-direct-dispatch
3007 Allow fast jumps to the message dispatcher.  On Darwin this is
3008 accomplished via the comm page.
3010 @item -fobjc-exceptions
3011 @opindex fobjc-exceptions
3012 Enable syntactic support for structured exception handling in
3013 Objective-C, similar to what is offered by C++ and Java.  This option
3014 is required to use the Objective-C keywords @code{@@try},
3015 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3016 @code{@@synchronized}.  This option is available with both the GNU
3017 runtime and the NeXT runtime (but not available in conjunction with
3018 the NeXT runtime on Mac OS X 10.2 and earlier).
3020 @item -fobjc-gc
3021 @opindex fobjc-gc
3022 Enable garbage collection (GC) in Objective-C and Objective-C++
3023 programs.  This option is only available with the NeXT runtime; the
3024 GNU runtime has a different garbage collection implementation that
3025 does not require special compiler flags.
3027 @item -fobjc-nilcheck
3028 @opindex fobjc-nilcheck
3029 For the NeXT runtime with version 2 of the ABI, check for a nil
3030 receiver in method invocations before doing the actual method call.
3031 This is the default and can be disabled using
3032 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3033 checked for nil in this way no matter what this flag is set to.
3034 Currently this flag does nothing when the GNU runtime, or an older
3035 version of the NeXT runtime ABI, is used.
3037 @item -fobjc-std=objc1
3038 @opindex fobjc-std
3039 Conform to the language syntax of Objective-C 1.0, the language
3040 recognized by GCC 4.0.  This only affects the Objective-C additions to
3041 the C/C++ language; it does not affect conformance to C/C++ standards,
3042 which is controlled by the separate C/C++ dialect option flags.  When
3043 this option is used with the Objective-C or Objective-C++ compiler,
3044 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3045 This is useful if you need to make sure that your Objective-C code can
3046 be compiled with older versions of GCC@.
3048 @item -freplace-objc-classes
3049 @opindex freplace-objc-classes
3050 Emit a special marker instructing @command{ld(1)} not to statically link in
3051 the resulting object file, and allow @command{dyld(1)} to load it in at
3052 run time instead.  This is used in conjunction with the Fix-and-Continue
3053 debugging mode, where the object file in question may be recompiled and
3054 dynamically reloaded in the course of program execution, without the need
3055 to restart the program itself.  Currently, Fix-and-Continue functionality
3056 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3057 and later.
3059 @item -fzero-link
3060 @opindex fzero-link
3061 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3062 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3063 compile time) with static class references that get initialized at load time,
3064 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3065 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3066 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3067 for individual class implementations to be modified during program execution.
3068 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3069 regardless of command-line options.
3071 @item -fno-local-ivars
3072 @opindex fno-local-ivars
3073 @opindex flocal-ivars
3074 By default instance variables in Objective-C can be accessed as if
3075 they were local variables from within the methods of the class they're
3076 declared in.  This can lead to shadowing between instance variables
3077 and other variables declared either locally inside a class method or
3078 globally with the same name.  Specifying the @option{-fno-local-ivars}
3079 flag disables this behavior thus avoiding variable shadowing issues.
3081 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3082 @opindex fivar-visibility
3083 Set the default instance variable visibility to the specified option
3084 so that instance variables declared outside the scope of any access
3085 modifier directives default to the specified visibility.
3087 @item -gen-decls
3088 @opindex gen-decls
3089 Dump interface declarations for all classes seen in the source file to a
3090 file named @file{@var{sourcename}.decl}.
3092 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3093 @opindex Wassign-intercept
3094 @opindex Wno-assign-intercept
3095 Warn whenever an Objective-C assignment is being intercepted by the
3096 garbage collector.
3098 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3099 @opindex Wno-protocol
3100 @opindex Wprotocol
3101 If a class is declared to implement a protocol, a warning is issued for
3102 every method in the protocol that is not implemented by the class.  The
3103 default behavior is to issue a warning for every method not explicitly
3104 implemented in the class, even if a method implementation is inherited
3105 from the superclass.  If you use the @option{-Wno-protocol} option, then
3106 methods inherited from the superclass are considered to be implemented,
3107 and no warning is issued for them.
3109 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3110 @opindex Wselector
3111 @opindex Wno-selector
3112 Warn if multiple methods of different types for the same selector are
3113 found during compilation.  The check is performed on the list of methods
3114 in the final stage of compilation.  Additionally, a check is performed
3115 for each selector appearing in a @code{@@selector(@dots{})}
3116 expression, and a corresponding method for that selector has been found
3117 during compilation.  Because these checks scan the method table only at
3118 the end of compilation, these warnings are not produced if the final
3119 stage of compilation is not reached, for example because an error is
3120 found during compilation, or because the @option{-fsyntax-only} option is
3121 being used.
3123 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3124 @opindex Wstrict-selector-match
3125 @opindex Wno-strict-selector-match
3126 Warn if multiple methods with differing argument and/or return types are
3127 found for a given selector when attempting to send a message using this
3128 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3129 is off (which is the default behavior), the compiler omits such warnings
3130 if any differences found are confined to types that share the same size
3131 and alignment.
3133 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3134 @opindex Wundeclared-selector
3135 @opindex Wno-undeclared-selector
3136 Warn if a @code{@@selector(@dots{})} expression referring to an
3137 undeclared selector is found.  A selector is considered undeclared if no
3138 method with that name has been declared before the
3139 @code{@@selector(@dots{})} expression, either explicitly in an
3140 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3141 an @code{@@implementation} section.  This option always performs its
3142 checks as soon as a @code{@@selector(@dots{})} expression is found,
3143 while @option{-Wselector} only performs its checks in the final stage of
3144 compilation.  This also enforces the coding style convention
3145 that methods and selectors must be declared before being used.
3147 @item -print-objc-runtime-info
3148 @opindex print-objc-runtime-info
3149 Generate C header describing the largest structure that is passed by
3150 value, if any.
3152 @end table
3154 @node Language Independent Options
3155 @section Options to Control Diagnostic Messages Formatting
3156 @cindex options to control diagnostics formatting
3157 @cindex diagnostic messages
3158 @cindex message formatting
3160 Traditionally, diagnostic messages have been formatted irrespective of
3161 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3162 options described below
3163 to control the formatting algorithm for diagnostic messages, 
3164 e.g.@: how many characters per line, how often source location
3165 information should be reported.  Note that some language front ends may not
3166 honor these options.
3168 @table @gcctabopt
3169 @item -fmessage-length=@var{n}
3170 @opindex fmessage-length
3171 Try to format error messages so that they fit on lines of about
3172 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3173 done; each error message appears on a single line.  This is the
3174 default for all front ends.
3176 @item -fdiagnostics-show-location=once
3177 @opindex fdiagnostics-show-location
3178 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3179 reporter to emit source location information @emph{once}; that is, in
3180 case the message is too long to fit on a single physical line and has to
3181 be wrapped, the source location won't be emitted (as prefix) again,
3182 over and over, in subsequent continuation lines.  This is the default
3183 behavior.
3185 @item -fdiagnostics-show-location=every-line
3186 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3187 messages reporter to emit the same source location information (as
3188 prefix) for physical lines that result from the process of breaking
3189 a message which is too long to fit on a single line.
3191 @item -fdiagnostics-color[=@var{WHEN}]
3192 @itemx -fno-diagnostics-color
3193 @opindex fdiagnostics-color
3194 @cindex highlight, color, colour
3195 @vindex GCC_COLORS @r{environment variable}
3196 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3197 or @samp{auto}.  The default depends on how the compiler has been configured,
3198 it can be any of the above @var{WHEN} options or also @samp{never}
3199 if @env{GCC_COLORS} environment variable isn't present in the environment,
3200 and @samp{auto} otherwise.
3201 @samp{auto} means to use color only when the standard error is a terminal.
3202 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3203 aliases for @option{-fdiagnostics-color=always} and
3204 @option{-fdiagnostics-color=never}, respectively.
3206 The colors are defined by the environment variable @env{GCC_COLORS}.
3207 Its value is a colon-separated list of capabilities and Select Graphic
3208 Rendition (SGR) substrings. SGR commands are interpreted by the
3209 terminal or terminal emulator.  (See the section in the documentation
3210 of your text terminal for permitted values and their meanings as
3211 character attributes.)  These substring values are integers in decimal
3212 representation and can be concatenated with semicolons.
3213 Common values to concatenate include
3214 @samp{1} for bold,
3215 @samp{4} for underline,
3216 @samp{5} for blink,
3217 @samp{7} for inverse,
3218 @samp{39} for default foreground color,
3219 @samp{30} to @samp{37} for foreground colors,
3220 @samp{90} to @samp{97} for 16-color mode foreground colors,
3221 @samp{38;5;0} to @samp{38;5;255}
3222 for 88-color and 256-color modes foreground colors,
3223 @samp{49} for default background color,
3224 @samp{40} to @samp{47} for background colors,
3225 @samp{100} to @samp{107} for 16-color mode background colors,
3226 and @samp{48;5;0} to @samp{48;5;255}
3227 for 88-color and 256-color modes background colors.
3229 The default @env{GCC_COLORS} is
3230 @smallexample
3231 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3232 @end smallexample
3233 @noindent
3234 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3235 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3236 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3237 string disables colors.
3238 Supported capabilities are as follows.
3240 @table @code
3241 @item error=
3242 @vindex error GCC_COLORS @r{capability}
3243 SGR substring for error: markers.
3245 @item warning=
3246 @vindex warning GCC_COLORS @r{capability}
3247 SGR substring for warning: markers.
3249 @item note=
3250 @vindex note GCC_COLORS @r{capability}
3251 SGR substring for note: markers.
3253 @item caret=
3254 @vindex caret GCC_COLORS @r{capability}
3255 SGR substring for caret line.
3257 @item locus=
3258 @vindex locus GCC_COLORS @r{capability}
3259 SGR substring for location information, @samp{file:line} or
3260 @samp{file:line:column} etc.
3262 @item quote=
3263 @vindex quote GCC_COLORS @r{capability}
3264 SGR substring for information printed within quotes.
3265 @end table
3267 @item -fno-diagnostics-show-option
3268 @opindex fno-diagnostics-show-option
3269 @opindex fdiagnostics-show-option
3270 By default, each diagnostic emitted includes text indicating the
3271 command-line option that directly controls the diagnostic (if such an
3272 option is known to the diagnostic machinery).  Specifying the
3273 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3275 @item -fno-diagnostics-show-caret
3276 @opindex fno-diagnostics-show-caret
3277 @opindex fdiagnostics-show-caret
3278 By default, each diagnostic emitted includes the original source line
3279 and a caret '^' indicating the column.  This option suppresses this
3280 information.  The source line is truncated to @var{n} characters, if
3281 the @option{-fmessage-length=n} option is given.  When the output is done
3282 to the terminal, the width is limited to the width given by the
3283 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3285 @end table
3287 @node Warning Options
3288 @section Options to Request or Suppress Warnings
3289 @cindex options to control warnings
3290 @cindex warning messages
3291 @cindex messages, warning
3292 @cindex suppressing warnings
3294 Warnings are diagnostic messages that report constructions that
3295 are not inherently erroneous but that are risky or suggest there
3296 may have been an error.
3298 The following language-independent options do not enable specific
3299 warnings but control the kinds of diagnostics produced by GCC@.
3301 @table @gcctabopt
3302 @cindex syntax checking
3303 @item -fsyntax-only
3304 @opindex fsyntax-only
3305 Check the code for syntax errors, but don't do anything beyond that.
3307 @item -fmax-errors=@var{n}
3308 @opindex fmax-errors
3309 Limits the maximum number of error messages to @var{n}, at which point
3310 GCC bails out rather than attempting to continue processing the source
3311 code.  If @var{n} is 0 (the default), there is no limit on the number
3312 of error messages produced.  If @option{-Wfatal-errors} is also
3313 specified, then @option{-Wfatal-errors} takes precedence over this
3314 option.
3316 @item -w
3317 @opindex w
3318 Inhibit all warning messages.
3320 @item -Werror
3321 @opindex Werror
3322 @opindex Wno-error
3323 Make all warnings into errors.
3325 @item -Werror=
3326 @opindex Werror=
3327 @opindex Wno-error=
3328 Make the specified warning into an error.  The specifier for a warning
3329 is appended; for example @option{-Werror=switch} turns the warnings
3330 controlled by @option{-Wswitch} into errors.  This switch takes a
3331 negative form, to be used to negate @option{-Werror} for specific
3332 warnings; for example @option{-Wno-error=switch} makes
3333 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3334 is in effect.
3336 The warning message for each controllable warning includes the
3337 option that controls the warning.  That option can then be used with
3338 @option{-Werror=} and @option{-Wno-error=} as described above.
3339 (Printing of the option in the warning message can be disabled using the
3340 @option{-fno-diagnostics-show-option} flag.)
3342 Note that specifying @option{-Werror=}@var{foo} automatically implies
3343 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3344 imply anything.
3346 @item -Wfatal-errors
3347 @opindex Wfatal-errors
3348 @opindex Wno-fatal-errors
3349 This option causes the compiler to abort compilation on the first error
3350 occurred rather than trying to keep going and printing further error
3351 messages.
3353 @end table
3355 You can request many specific warnings with options beginning with
3356 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3357 implicit declarations.  Each of these specific warning options also
3358 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3359 example, @option{-Wno-implicit}.  This manual lists only one of the
3360 two forms, whichever is not the default.  For further
3361 language-specific options also refer to @ref{C++ Dialect Options} and
3362 @ref{Objective-C and Objective-C++ Dialect Options}.
3364 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3365 options, such as @option{-Wunused}, which may turn on further options,
3366 such as @option{-Wunused-value}. The combined effect of positive and
3367 negative forms is that more specific options have priority over less
3368 specific ones, independently of their position in the command-line. For
3369 options of the same specificity, the last one takes effect. Options
3370 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3371 as if they appeared at the end of the command-line.
3373 When an unrecognized warning option is requested (e.g.,
3374 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3375 that the option is not recognized.  However, if the @option{-Wno-} form
3376 is used, the behavior is slightly different: no diagnostic is
3377 produced for @option{-Wno-unknown-warning} unless other diagnostics
3378 are being produced.  This allows the use of new @option{-Wno-} options
3379 with old compilers, but if something goes wrong, the compiler
3380 warns that an unrecognized option is present.
3382 @table @gcctabopt
3383 @item -Wpedantic
3384 @itemx -pedantic
3385 @opindex pedantic
3386 @opindex Wpedantic
3387 Issue all the warnings demanded by strict ISO C and ISO C++;
3388 reject all programs that use forbidden extensions, and some other
3389 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3390 version of the ISO C standard specified by any @option{-std} option used.
3392 Valid ISO C and ISO C++ programs should compile properly with or without
3393 this option (though a rare few require @option{-ansi} or a
3394 @option{-std} option specifying the required version of ISO C)@.  However,
3395 without this option, certain GNU extensions and traditional C and C++
3396 features are supported as well.  With this option, they are rejected.
3398 @option{-Wpedantic} does not cause warning messages for use of the
3399 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3400 warnings are also disabled in the expression that follows
3401 @code{__extension__}.  However, only system header files should use
3402 these escape routes; application programs should avoid them.
3403 @xref{Alternate Keywords}.
3405 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3406 C conformance.  They soon find that it does not do quite what they want:
3407 it finds some non-ISO practices, but not all---only those for which
3408 ISO C @emph{requires} a diagnostic, and some others for which
3409 diagnostics have been added.
3411 A feature to report any failure to conform to ISO C might be useful in
3412 some instances, but would require considerable additional work and would
3413 be quite different from @option{-Wpedantic}.  We don't have plans to
3414 support such a feature in the near future.
3416 Where the standard specified with @option{-std} represents a GNU
3417 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3418 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3419 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3420 where they are required by the base standard.  (It does not make sense
3421 for such warnings to be given only for features not in the specified GNU
3422 C dialect, since by definition the GNU dialects of C include all
3423 features the compiler supports with the given option, and there would be
3424 nothing to warn about.)
3426 @item -pedantic-errors
3427 @opindex pedantic-errors
3428 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3429 requires a diagnostic, in some cases where there is undefined behavior
3430 at compile-time and in some other cases that do not prevent compilation
3431 of programs that are valid according to the standard. This is not
3432 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3433 by this option and not enabled by the latter and vice versa.
3435 @item -Wall
3436 @opindex Wall
3437 @opindex Wno-all
3438 This enables all the warnings about constructions that some users
3439 consider questionable, and that are easy to avoid (or modify to
3440 prevent the warning), even in conjunction with macros.  This also
3441 enables some language-specific warnings described in @ref{C++ Dialect
3442 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3444 @option{-Wall} turns on the following warning flags:
3446 @gccoptlist{-Waddress   @gol
3447 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3448 -Wc++11-compat  -Wc++14-compat@gol
3449 -Wchar-subscripts  @gol
3450 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3451 -Wimplicit-int @r{(C and Objective-C only)} @gol
3452 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3453 -Wcomment  @gol
3454 -Wformat   @gol
3455 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3456 -Wmaybe-uninitialized @gol
3457 -Wmissing-braces @r{(only for C/ObjC)} @gol
3458 -Wnonnull  @gol
3459 -Wopenmp-simd @gol
3460 -Wparentheses  @gol
3461 -Wpointer-sign  @gol
3462 -Wreorder   @gol
3463 -Wreturn-type  @gol
3464 -Wsequence-point  @gol
3465 -Wsign-compare @r{(only in C++)}  @gol
3466 -Wstrict-aliasing  @gol
3467 -Wstrict-overflow=1  @gol
3468 -Wswitch  @gol
3469 -Wtrigraphs  @gol
3470 -Wuninitialized  @gol
3471 -Wunknown-pragmas  @gol
3472 -Wunused-function  @gol
3473 -Wunused-label     @gol
3474 -Wunused-value     @gol
3475 -Wunused-variable  @gol
3476 -Wvolatile-register-var @gol
3479 Note that some warning flags are not implied by @option{-Wall}.  Some of
3480 them warn about constructions that users generally do not consider
3481 questionable, but which occasionally you might wish to check for;
3482 others warn about constructions that are necessary or hard to avoid in
3483 some cases, and there is no simple way to modify the code to suppress
3484 the warning. Some of them are enabled by @option{-Wextra} but many of
3485 them must be enabled individually.
3487 @item -Wextra
3488 @opindex W
3489 @opindex Wextra
3490 @opindex Wno-extra
3491 This enables some extra warning flags that are not enabled by
3492 @option{-Wall}. (This option used to be called @option{-W}.  The older
3493 name is still supported, but the newer name is more descriptive.)
3495 @gccoptlist{-Wclobbered  @gol
3496 -Wempty-body  @gol
3497 -Wignored-qualifiers @gol
3498 -Wmissing-field-initializers  @gol
3499 -Wmissing-parameter-type @r{(C only)}  @gol
3500 -Wold-style-declaration @r{(C only)}  @gol
3501 -Woverride-init  @gol
3502 -Wsign-compare  @gol
3503 -Wtype-limits  @gol
3504 -Wuninitialized  @gol
3505 -Wshift-negative-value  @gol
3506 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3507 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3510 The option @option{-Wextra} also prints warning messages for the
3511 following cases:
3513 @itemize @bullet
3515 @item
3516 A pointer is compared against integer zero with @code{<}, @code{<=},
3517 @code{>}, or @code{>=}.
3519 @item
3520 (C++ only) An enumerator and a non-enumerator both appear in a
3521 conditional expression.
3523 @item
3524 (C++ only) Ambiguous virtual bases.
3526 @item
3527 (C++ only) Subscripting an array that has been declared @code{register}.
3529 @item
3530 (C++ only) Taking the address of a variable that has been declared
3531 @code{register}.
3533 @item
3534 (C++ only) A base class is not initialized in a derived class's copy
3535 constructor.
3537 @end itemize
3539 @item -Wchar-subscripts
3540 @opindex Wchar-subscripts
3541 @opindex Wno-char-subscripts
3542 Warn if an array subscript has type @code{char}.  This is a common cause
3543 of error, as programmers often forget that this type is signed on some
3544 machines.
3545 This warning is enabled by @option{-Wall}.
3547 @item -Wcomment
3548 @opindex Wcomment
3549 @opindex Wno-comment
3550 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3551 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3552 This warning is enabled by @option{-Wall}.
3554 @item -Wno-coverage-mismatch
3555 @opindex Wno-coverage-mismatch
3556 Warn if feedback profiles do not match when using the
3557 @option{-fprofile-use} option.
3558 If a source file is changed between compiling with @option{-fprofile-gen} and
3559 with @option{-fprofile-use}, the files with the profile feedback can fail
3560 to match the source file and GCC cannot use the profile feedback
3561 information.  By default, this warning is enabled and is treated as an
3562 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3563 warning or @option{-Wno-error=coverage-mismatch} can be used to
3564 disable the error.  Disabling the error for this warning can result in
3565 poorly optimized code and is useful only in the
3566 case of very minor changes such as bug fixes to an existing code-base.
3567 Completely disabling the warning is not recommended.
3569 @item -Wno-cpp
3570 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3572 Suppress warning messages emitted by @code{#warning} directives.
3574 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3575 @opindex Wdouble-promotion
3576 @opindex Wno-double-promotion
3577 Give a warning when a value of type @code{float} is implicitly
3578 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3579 floating-point unit implement @code{float} in hardware, but emulate
3580 @code{double} in software.  On such a machine, doing computations
3581 using @code{double} values is much more expensive because of the
3582 overhead required for software emulation.
3584 It is easy to accidentally do computations with @code{double} because
3585 floating-point literals are implicitly of type @code{double}.  For
3586 example, in:
3587 @smallexample
3588 @group
3589 float area(float radius)
3591    return 3.14159 * radius * radius;
3593 @end group
3594 @end smallexample
3595 the compiler performs the entire computation with @code{double}
3596 because the floating-point literal is a @code{double}.
3598 @item -Wformat
3599 @itemx -Wformat=@var{n}
3600 @opindex Wformat
3601 @opindex Wno-format
3602 @opindex ffreestanding
3603 @opindex fno-builtin
3604 @opindex Wformat=
3605 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3606 the arguments supplied have types appropriate to the format string
3607 specified, and that the conversions specified in the format string make
3608 sense.  This includes standard functions, and others specified by format
3609 attributes (@pxref{Function Attributes}), in the @code{printf},
3610 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3611 not in the C standard) families (or other target-specific families).
3612 Which functions are checked without format attributes having been
3613 specified depends on the standard version selected, and such checks of
3614 functions without the attribute specified are disabled by
3615 @option{-ffreestanding} or @option{-fno-builtin}.
3617 The formats are checked against the format features supported by GNU
3618 libc version 2.2.  These include all ISO C90 and C99 features, as well
3619 as features from the Single Unix Specification and some BSD and GNU
3620 extensions.  Other library implementations may not support all these
3621 features; GCC does not support warning about features that go beyond a
3622 particular library's limitations.  However, if @option{-Wpedantic} is used
3623 with @option{-Wformat}, warnings are given about format features not
3624 in the selected standard version (but not for @code{strfmon} formats,
3625 since those are not in any version of the C standard).  @xref{C Dialect
3626 Options,,Options Controlling C Dialect}.
3628 @table @gcctabopt
3629 @item -Wformat=1
3630 @itemx -Wformat
3631 @opindex Wformat
3632 @opindex Wformat=1
3633 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3634 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3635 @option{-Wformat} also checks for null format arguments for several
3636 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3637 aspects of this level of format checking can be disabled by the
3638 options: @option{-Wno-format-contains-nul},
3639 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3640 @option{-Wformat} is enabled by @option{-Wall}.
3642 @item -Wno-format-contains-nul
3643 @opindex Wno-format-contains-nul
3644 @opindex Wformat-contains-nul
3645 If @option{-Wformat} is specified, do not warn about format strings that
3646 contain NUL bytes.
3648 @item -Wno-format-extra-args
3649 @opindex Wno-format-extra-args
3650 @opindex Wformat-extra-args
3651 If @option{-Wformat} is specified, do not warn about excess arguments to a
3652 @code{printf} or @code{scanf} format function.  The C standard specifies
3653 that such arguments are ignored.
3655 Where the unused arguments lie between used arguments that are
3656 specified with @samp{$} operand number specifications, normally
3657 warnings are still given, since the implementation could not know what
3658 type to pass to @code{va_arg} to skip the unused arguments.  However,
3659 in the case of @code{scanf} formats, this option suppresses the
3660 warning if the unused arguments are all pointers, since the Single
3661 Unix Specification says that such unused arguments are allowed.
3663 @item -Wno-format-zero-length
3664 @opindex Wno-format-zero-length
3665 @opindex Wformat-zero-length
3666 If @option{-Wformat} is specified, do not warn about zero-length formats.
3667 The C standard specifies that zero-length formats are allowed.
3670 @item -Wformat=2
3671 @opindex Wformat=2
3672 Enable @option{-Wformat} plus additional format checks.  Currently
3673 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3674 -Wformat-y2k}.
3676 @item -Wformat-nonliteral
3677 @opindex Wformat-nonliteral
3678 @opindex Wno-format-nonliteral
3679 If @option{-Wformat} is specified, also warn if the format string is not a
3680 string literal and so cannot be checked, unless the format function
3681 takes its format arguments as a @code{va_list}.
3683 @item -Wformat-security
3684 @opindex Wformat-security
3685 @opindex Wno-format-security
3686 If @option{-Wformat} is specified, also warn about uses of format
3687 functions that represent possible security problems.  At present, this
3688 warns about calls to @code{printf} and @code{scanf} functions where the
3689 format string is not a string literal and there are no format arguments,
3690 as in @code{printf (foo);}.  This may be a security hole if the format
3691 string came from untrusted input and contains @samp{%n}.  (This is
3692 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3693 in future warnings may be added to @option{-Wformat-security} that are not
3694 included in @option{-Wformat-nonliteral}.)
3696 @item -Wformat-signedness
3697 @opindex Wformat-signedness
3698 @opindex Wno-format-signedness
3699 If @option{-Wformat} is specified, also warn if the format string
3700 requires an unsigned argument and the argument is signed and vice versa.
3702 @item -Wformat-y2k
3703 @opindex Wformat-y2k
3704 @opindex Wno-format-y2k
3705 If @option{-Wformat} is specified, also warn about @code{strftime}
3706 formats that may yield only a two-digit year.
3707 @end table
3709 @item -Wnonnull
3710 @opindex Wnonnull
3711 @opindex Wno-nonnull
3712 Warn about passing a null pointer for arguments marked as
3713 requiring a non-null value by the @code{nonnull} function attribute.
3715 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3716 can be disabled with the @option{-Wno-nonnull} option.
3718 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3719 @opindex Winit-self
3720 @opindex Wno-init-self
3721 Warn about uninitialized variables that are initialized with themselves.
3722 Note this option can only be used with the @option{-Wuninitialized} option.
3724 For example, GCC warns about @code{i} being uninitialized in the
3725 following snippet only when @option{-Winit-self} has been specified:
3726 @smallexample
3727 @group
3728 int f()
3730   int i = i;
3731   return i;
3733 @end group
3734 @end smallexample
3736 This warning is enabled by @option{-Wall} in C++.
3738 @item -Wimplicit-int @r{(C and Objective-C only)}
3739 @opindex Wimplicit-int
3740 @opindex Wno-implicit-int
3741 Warn when a declaration does not specify a type.
3742 This warning is enabled by @option{-Wall}.
3744 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3745 @opindex Wimplicit-function-declaration
3746 @opindex Wno-implicit-function-declaration
3747 Give a warning whenever a function is used before being declared. In
3748 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3749 enabled by default and it is made into an error by
3750 @option{-pedantic-errors}. This warning is also enabled by
3751 @option{-Wall}.
3753 @item -Wimplicit @r{(C and Objective-C only)}
3754 @opindex Wimplicit
3755 @opindex Wno-implicit
3756 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3757 This warning is enabled by @option{-Wall}.
3759 @item -Wignored-qualifiers @r{(C and C++ only)}
3760 @opindex Wignored-qualifiers
3761 @opindex Wno-ignored-qualifiers
3762 Warn if the return type of a function has a type qualifier
3763 such as @code{const}.  For ISO C such a type qualifier has no effect,
3764 since the value returned by a function is not an lvalue.
3765 For C++, the warning is only emitted for scalar types or @code{void}.
3766 ISO C prohibits qualified @code{void} return types on function
3767 definitions, so such return types always receive a warning
3768 even without this option.
3770 This warning is also enabled by @option{-Wextra}.
3772 @item -Wmain
3773 @opindex Wmain
3774 @opindex Wno-main
3775 Warn if the type of @code{main} is suspicious.  @code{main} should be
3776 a function with external linkage, returning int, taking either zero
3777 arguments, two, or three arguments of appropriate types.  This warning
3778 is enabled by default in C++ and is enabled by either @option{-Wall}
3779 or @option{-Wpedantic}.
3781 @item -Wmisleading-indentation @r{(C and C++ only)}
3782 @opindex Wmisleading-indentation
3783 @opindex Wno-misleading-indentation
3784 Warn when the indentation of the code does not reflect the block structure.
3785 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
3786 @code{for} clauses with a guarded statement that does not use braces,
3787 followed by an unguarded statement with the same indentation.
3789 This warning is disabled by default.
3791 In the following example, the call to ``bar'' is misleadingly indented as
3792 if it were guarded by the ``if'' conditional.
3794 @smallexample
3795   if (some_condition ())
3796     foo ();
3797     bar ();  /* Gotcha: this is not guarded by the "if".  */
3798 @end smallexample
3800 In the case of mixed tabs and spaces, the warning uses the
3801 @option{-ftabstop=} option to determine if the statements line up
3802 (defaulting to 8).
3804 The warning is not issued for code involving multiline preprocessor logic
3805 such as the following example.
3807 @smallexample
3808   if (flagA)
3809     foo (0);
3810 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
3811   if (flagB)
3812 #endif
3813     foo (1);
3814 @end smallexample
3816 The warning is not issued after a @code{#line} directive, since this
3817 typically indicates autogenerated code, and no assumptions can be made
3818 about the layout of the file that the directive references.
3820 @item -Wmissing-braces
3821 @opindex Wmissing-braces
3822 @opindex Wno-missing-braces
3823 Warn if an aggregate or union initializer is not fully bracketed.  In
3824 the following example, the initializer for @code{a} is not fully
3825 bracketed, but that for @code{b} is fully bracketed.  This warning is
3826 enabled by @option{-Wall} in C.
3828 @smallexample
3829 int a[2][2] = @{ 0, 1, 2, 3 @};
3830 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3831 @end smallexample
3833 This warning is enabled by @option{-Wall}.
3835 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3836 @opindex Wmissing-include-dirs
3837 @opindex Wno-missing-include-dirs
3838 Warn if a user-supplied include directory does not exist.
3840 @item -Wparentheses
3841 @opindex Wparentheses
3842 @opindex Wno-parentheses
3843 Warn if parentheses are omitted in certain contexts, such
3844 as when there is an assignment in a context where a truth value
3845 is expected, or when operators are nested whose precedence people
3846 often get confused about.
3848 Also warn if a comparison like @code{x<=y<=z} appears; this is
3849 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3850 interpretation from that of ordinary mathematical notation.
3852 Also warn about constructions where there may be confusion to which
3853 @code{if} statement an @code{else} branch belongs.  Here is an example of
3854 such a case:
3856 @smallexample
3857 @group
3859   if (a)
3860     if (b)
3861       foo ();
3862   else
3863     bar ();
3865 @end group
3866 @end smallexample
3868 In C/C++, every @code{else} branch belongs to the innermost possible
3869 @code{if} statement, which in this example is @code{if (b)}.  This is
3870 often not what the programmer expected, as illustrated in the above
3871 example by indentation the programmer chose.  When there is the
3872 potential for this confusion, GCC issues a warning when this flag
3873 is specified.  To eliminate the warning, add explicit braces around
3874 the innermost @code{if} statement so there is no way the @code{else}
3875 can belong to the enclosing @code{if}.  The resulting code
3876 looks like this:
3878 @smallexample
3879 @group
3881   if (a)
3882     @{
3883       if (b)
3884         foo ();
3885       else
3886         bar ();
3887     @}
3889 @end group
3890 @end smallexample
3892 Also warn for dangerous uses of the GNU extension to
3893 @code{?:} with omitted middle operand. When the condition
3894 in the @code{?}: operator is a boolean expression, the omitted value is
3895 always 1.  Often programmers expect it to be a value computed
3896 inside the conditional expression instead.
3898 This warning is enabled by @option{-Wall}.
3900 @item -Wsequence-point
3901 @opindex Wsequence-point
3902 @opindex Wno-sequence-point
3903 Warn about code that may have undefined semantics because of violations
3904 of sequence point rules in the C and C++ standards.
3906 The C and C++ standards define the order in which expressions in a C/C++
3907 program are evaluated in terms of @dfn{sequence points}, which represent
3908 a partial ordering between the execution of parts of the program: those
3909 executed before the sequence point, and those executed after it.  These
3910 occur after the evaluation of a full expression (one which is not part
3911 of a larger expression), after the evaluation of the first operand of a
3912 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3913 function is called (but after the evaluation of its arguments and the
3914 expression denoting the called function), and in certain other places.
3915 Other than as expressed by the sequence point rules, the order of
3916 evaluation of subexpressions of an expression is not specified.  All
3917 these rules describe only a partial order rather than a total order,
3918 since, for example, if two functions are called within one expression
3919 with no sequence point between them, the order in which the functions
3920 are called is not specified.  However, the standards committee have
3921 ruled that function calls do not overlap.
3923 It is not specified when between sequence points modifications to the
3924 values of objects take effect.  Programs whose behavior depends on this
3925 have undefined behavior; the C and C++ standards specify that ``Between
3926 the previous and next sequence point an object shall have its stored
3927 value modified at most once by the evaluation of an expression.
3928 Furthermore, the prior value shall be read only to determine the value
3929 to be stored.''.  If a program breaks these rules, the results on any
3930 particular implementation are entirely unpredictable.
3932 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3933 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3934 diagnosed by this option, and it may give an occasional false positive
3935 result, but in general it has been found fairly effective at detecting
3936 this sort of problem in programs.
3938 The standard is worded confusingly, therefore there is some debate
3939 over the precise meaning of the sequence point rules in subtle cases.
3940 Links to discussions of the problem, including proposed formal
3941 definitions, may be found on the GCC readings page, at
3942 @uref{http://gcc.gnu.org/@/readings.html}.
3944 This warning is enabled by @option{-Wall} for C and C++.
3946 @item -Wno-return-local-addr
3947 @opindex Wno-return-local-addr
3948 @opindex Wreturn-local-addr
3949 Do not warn about returning a pointer (or in C++, a reference) to a
3950 variable that goes out of scope after the function returns.
3952 @item -Wreturn-type
3953 @opindex Wreturn-type
3954 @opindex Wno-return-type
3955 Warn whenever a function is defined with a return type that defaults
3956 to @code{int}.  Also warn about any @code{return} statement with no
3957 return value in a function whose return type is not @code{void}
3958 (falling off the end of the function body is considered returning
3959 without a value), and about a @code{return} statement with an
3960 expression in a function whose return type is @code{void}.
3962 For C++, a function without return type always produces a diagnostic
3963 message, even when @option{-Wno-return-type} is specified.  The only
3964 exceptions are @code{main} and functions defined in system headers.
3966 This warning is enabled by @option{-Wall}.
3968 @item -Wshift-count-negative
3969 @opindex Wshift-count-negative
3970 @opindex Wno-shift-count-negative
3971 Warn if shift count is negative. This warning is enabled by default.
3973 @item -Wshift-count-overflow
3974 @opindex Wshift-count-overflow
3975 @opindex Wno-shift-count-overflow
3976 Warn if shift count >= width of type. This warning is enabled by default.
3978 @item -Wshift-negative-value
3979 @opindex Wshift-negative-value
3980 @opindex Wno-shift-negative-value
3981 Warn if left shifting a negative value.  This warning is enabled by
3982 @option{-Wextra} in C99 and C++11 modes (and newer).
3984 @item -Wswitch
3985 @opindex Wswitch
3986 @opindex Wno-switch
3987 Warn whenever a @code{switch} statement has an index of enumerated type
3988 and lacks a @code{case} for one or more of the named codes of that
3989 enumeration.  (The presence of a @code{default} label prevents this
3990 warning.)  @code{case} labels outside the enumeration range also
3991 provoke warnings when this option is used (even if there is a
3992 @code{default} label).
3993 This warning is enabled by @option{-Wall}.
3995 @item -Wswitch-default
3996 @opindex Wswitch-default
3997 @opindex Wno-switch-default
3998 Warn whenever a @code{switch} statement does not have a @code{default}
3999 case.
4001 @item -Wswitch-enum
4002 @opindex Wswitch-enum
4003 @opindex Wno-switch-enum
4004 Warn whenever a @code{switch} statement has an index of enumerated type
4005 and lacks a @code{case} for one or more of the named codes of that
4006 enumeration.  @code{case} labels outside the enumeration range also
4007 provoke warnings when this option is used.  The only difference
4008 between @option{-Wswitch} and this option is that this option gives a
4009 warning about an omitted enumeration code even if there is a
4010 @code{default} label.
4012 @item -Wswitch-bool
4013 @opindex Wswitch-bool
4014 @opindex Wno-switch-bool
4015 Warn whenever a @code{switch} statement has an index of boolean type.
4016 It is possible to suppress this warning by casting the controlling
4017 expression to a type other than @code{bool}.  For example:
4018 @smallexample
4019 @group
4020 switch ((int) (a == 4))
4021   @{
4022   @dots{}
4023   @}
4024 @end group
4025 @end smallexample
4026 This warning is enabled by default for C and C++ programs.
4028 @item -Wsync-nand @r{(C and C++ only)}
4029 @opindex Wsync-nand
4030 @opindex Wno-sync-nand
4031 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4032 built-in functions are used.  These functions changed semantics in GCC 4.4.
4034 @item -Wtrigraphs
4035 @opindex Wtrigraphs
4036 @opindex Wno-trigraphs
4037 Warn if any trigraphs are encountered that might change the meaning of
4038 the program (trigraphs within comments are not warned about).
4039 This warning is enabled by @option{-Wall}.
4041 @item -Wunused-but-set-parameter
4042 @opindex Wunused-but-set-parameter
4043 @opindex Wno-unused-but-set-parameter
4044 Warn whenever a function parameter is assigned to, but otherwise unused
4045 (aside from its declaration).
4047 To suppress this warning use the @code{unused} attribute
4048 (@pxref{Variable Attributes}).
4050 This warning is also enabled by @option{-Wunused} together with
4051 @option{-Wextra}.
4053 @item -Wunused-but-set-variable
4054 @opindex Wunused-but-set-variable
4055 @opindex Wno-unused-but-set-variable
4056 Warn whenever a local variable is assigned to, but otherwise unused
4057 (aside from its declaration).
4058 This warning is enabled by @option{-Wall}.
4060 To suppress this warning use the @code{unused} attribute
4061 (@pxref{Variable Attributes}).
4063 This warning is also enabled by @option{-Wunused}, which is enabled
4064 by @option{-Wall}.
4066 @item -Wunused-function
4067 @opindex Wunused-function
4068 @opindex Wno-unused-function
4069 Warn whenever a static function is declared but not defined or a
4070 non-inline static function is unused.
4071 This warning is enabled by @option{-Wall}.
4073 @item -Wunused-label
4074 @opindex Wunused-label
4075 @opindex Wno-unused-label
4076 Warn whenever a label is declared but not used.
4077 This warning is enabled by @option{-Wall}.
4079 To suppress this warning use the @code{unused} attribute
4080 (@pxref{Variable Attributes}).
4082 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4083 @opindex Wunused-local-typedefs
4084 Warn when a typedef locally defined in a function is not used.
4085 This warning is enabled by @option{-Wall}.
4087 @item -Wunused-parameter
4088 @opindex Wunused-parameter
4089 @opindex Wno-unused-parameter
4090 Warn whenever a function parameter is unused aside from its declaration.
4092 To suppress this warning use the @code{unused} attribute
4093 (@pxref{Variable Attributes}).
4095 @item -Wno-unused-result
4096 @opindex Wunused-result
4097 @opindex Wno-unused-result
4098 Do not warn if a caller of a function marked with attribute
4099 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4100 its return value. The default is @option{-Wunused-result}.
4102 @item -Wunused-variable
4103 @opindex Wunused-variable
4104 @opindex Wno-unused-variable
4105 Warn whenever a local variable or non-constant static variable is unused
4106 aside from its declaration.
4107 This warning is enabled by @option{-Wall}.
4109 To suppress this warning use the @code{unused} attribute
4110 (@pxref{Variable Attributes}).
4112 @item -Wunused-value
4113 @opindex Wunused-value
4114 @opindex Wno-unused-value
4115 Warn whenever a statement computes a result that is explicitly not
4116 used. To suppress this warning cast the unused expression to
4117 @code{void}. This includes an expression-statement or the left-hand
4118 side of a comma expression that contains no side effects. For example,
4119 an expression such as @code{x[i,j]} causes a warning, while
4120 @code{x[(void)i,j]} does not.
4122 This warning is enabled by @option{-Wall}.
4124 @item -Wunused
4125 @opindex Wunused
4126 @opindex Wno-unused
4127 All the above @option{-Wunused} options combined.
4129 In order to get a warning about an unused function parameter, you must
4130 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4131 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4133 @item -Wuninitialized
4134 @opindex Wuninitialized
4135 @opindex Wno-uninitialized
4136 Warn if an automatic variable is used without first being initialized
4137 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4138 warn if a non-static reference or non-static @code{const} member
4139 appears in a class without constructors.
4141 If you want to warn about code that uses the uninitialized value of the
4142 variable in its own initializer, use the @option{-Winit-self} option.
4144 These warnings occur for individual uninitialized or clobbered
4145 elements of structure, union or array variables as well as for
4146 variables that are uninitialized or clobbered as a whole.  They do
4147 not occur for variables or elements declared @code{volatile}.  Because
4148 these warnings depend on optimization, the exact variables or elements
4149 for which there are warnings depends on the precise optimization
4150 options and version of GCC used.
4152 Note that there may be no warning about a variable that is used only
4153 to compute a value that itself is never used, because such
4154 computations may be deleted by data flow analysis before the warnings
4155 are printed.
4157 @item -Wmaybe-uninitialized
4158 @opindex Wmaybe-uninitialized
4159 @opindex Wno-maybe-uninitialized
4160 For an automatic variable, if there exists a path from the function
4161 entry to a use of the variable that is initialized, but there exist
4162 some other paths for which the variable is not initialized, the compiler
4163 emits a warning if it cannot prove the uninitialized paths are not
4164 executed at run time. These warnings are made optional because GCC is
4165 not smart enough to see all the reasons why the code might be correct
4166 in spite of appearing to have an error.  Here is one example of how
4167 this can happen:
4169 @smallexample
4170 @group
4172   int x;
4173   switch (y)
4174     @{
4175     case 1: x = 1;
4176       break;
4177     case 2: x = 4;
4178       break;
4179     case 3: x = 5;
4180     @}
4181   foo (x);
4183 @end group
4184 @end smallexample
4186 @noindent
4187 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4188 always initialized, but GCC doesn't know this. To suppress the
4189 warning, you need to provide a default case with assert(0) or
4190 similar code.
4192 @cindex @code{longjmp} warnings
4193 This option also warns when a non-volatile automatic variable might be
4194 changed by a call to @code{longjmp}.  These warnings as well are possible
4195 only in optimizing compilation.
4197 The compiler sees only the calls to @code{setjmp}.  It cannot know
4198 where @code{longjmp} will be called; in fact, a signal handler could
4199 call it at any point in the code.  As a result, you may get a warning
4200 even when there is in fact no problem because @code{longjmp} cannot
4201 in fact be called at the place that would cause a problem.
4203 Some spurious warnings can be avoided if you declare all the functions
4204 you use that never return as @code{noreturn}.  @xref{Function
4205 Attributes}.
4207 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4209 @item -Wunknown-pragmas
4210 @opindex Wunknown-pragmas
4211 @opindex Wno-unknown-pragmas
4212 @cindex warning for unknown pragmas
4213 @cindex unknown pragmas, warning
4214 @cindex pragmas, warning of unknown
4215 Warn when a @code{#pragma} directive is encountered that is not understood by 
4216 GCC@.  If this command-line option is used, warnings are even issued
4217 for unknown pragmas in system header files.  This is not the case if
4218 the warnings are only enabled by the @option{-Wall} command-line option.
4220 @item -Wno-pragmas
4221 @opindex Wno-pragmas
4222 @opindex Wpragmas
4223 Do not warn about misuses of pragmas, such as incorrect parameters,
4224 invalid syntax, or conflicts between pragmas.  See also
4225 @option{-Wunknown-pragmas}.
4227 @item -Wstrict-aliasing
4228 @opindex Wstrict-aliasing
4229 @opindex Wno-strict-aliasing
4230 This option is only active when @option{-fstrict-aliasing} is active.
4231 It warns about code that might break the strict aliasing rules that the
4232 compiler is using for optimization.  The warning does not catch all
4233 cases, but does attempt to catch the more common pitfalls.  It is
4234 included in @option{-Wall}.
4235 It is equivalent to @option{-Wstrict-aliasing=3}
4237 @item -Wstrict-aliasing=n
4238 @opindex Wstrict-aliasing=n
4239 This option is only active when @option{-fstrict-aliasing} is active.
4240 It warns about code that might break the strict aliasing rules that the
4241 compiler is using for optimization.
4242 Higher levels correspond to higher accuracy (fewer false positives).
4243 Higher levels also correspond to more effort, similar to the way @option{-O} 
4244 works.
4245 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4247 Level 1: Most aggressive, quick, least accurate.
4248 Possibly useful when higher levels
4249 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4250 false negatives.  However, it has many false positives.
4251 Warns for all pointer conversions between possibly incompatible types,
4252 even if never dereferenced.  Runs in the front end only.
4254 Level 2: Aggressive, quick, not too precise.
4255 May still have many false positives (not as many as level 1 though),
4256 and few false negatives (but possibly more than level 1).
4257 Unlike level 1, it only warns when an address is taken.  Warns about
4258 incomplete types.  Runs in the front end only.
4260 Level 3 (default for @option{-Wstrict-aliasing}):
4261 Should have very few false positives and few false
4262 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4263 Takes care of the common pun+dereference pattern in the front end:
4264 @code{*(int*)&some_float}.
4265 If optimization is enabled, it also runs in the back end, where it deals
4266 with multiple statement cases using flow-sensitive points-to information.
4267 Only warns when the converted pointer is dereferenced.
4268 Does not warn about incomplete types.
4270 @item -Wstrict-overflow
4271 @itemx -Wstrict-overflow=@var{n}
4272 @opindex Wstrict-overflow
4273 @opindex Wno-strict-overflow
4274 This option is only active when @option{-fstrict-overflow} is active.
4275 It warns about cases where the compiler optimizes based on the
4276 assumption that signed overflow does not occur.  Note that it does not
4277 warn about all cases where the code might overflow: it only warns
4278 about cases where the compiler implements some optimization.  Thus
4279 this warning depends on the optimization level.
4281 An optimization that assumes that signed overflow does not occur is
4282 perfectly safe if the values of the variables involved are such that
4283 overflow never does, in fact, occur.  Therefore this warning can
4284 easily give a false positive: a warning about code that is not
4285 actually a problem.  To help focus on important issues, several
4286 warning levels are defined.  No warnings are issued for the use of
4287 undefined signed overflow when estimating how many iterations a loop
4288 requires, in particular when determining whether a loop will be
4289 executed at all.
4291 @table @gcctabopt
4292 @item -Wstrict-overflow=1
4293 Warn about cases that are both questionable and easy to avoid.  For
4294 example,  with @option{-fstrict-overflow}, the compiler simplifies
4295 @code{x + 1 > x} to @code{1}.  This level of
4296 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4297 are not, and must be explicitly requested.
4299 @item -Wstrict-overflow=2
4300 Also warn about other cases where a comparison is simplified to a
4301 constant.  For example: @code{abs (x) >= 0}.  This can only be
4302 simplified when @option{-fstrict-overflow} is in effect, because
4303 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4304 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4305 @option{-Wstrict-overflow=2}.
4307 @item -Wstrict-overflow=3
4308 Also warn about other cases where a comparison is simplified.  For
4309 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4311 @item -Wstrict-overflow=4
4312 Also warn about other simplifications not covered by the above cases.
4313 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4315 @item -Wstrict-overflow=5
4316 Also warn about cases where the compiler reduces the magnitude of a
4317 constant involved in a comparison.  For example: @code{x + 2 > y} is
4318 simplified to @code{x + 1 >= y}.  This is reported only at the
4319 highest warning level because this simplification applies to many
4320 comparisons, so this warning level gives a very large number of
4321 false positives.
4322 @end table
4324 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4325 @opindex Wsuggest-attribute=
4326 @opindex Wno-suggest-attribute=
4327 Warn for cases where adding an attribute may be beneficial. The
4328 attributes currently supported are listed below.
4330 @table @gcctabopt
4331 @item -Wsuggest-attribute=pure
4332 @itemx -Wsuggest-attribute=const
4333 @itemx -Wsuggest-attribute=noreturn
4334 @opindex Wsuggest-attribute=pure
4335 @opindex Wno-suggest-attribute=pure
4336 @opindex Wsuggest-attribute=const
4337 @opindex Wno-suggest-attribute=const
4338 @opindex Wsuggest-attribute=noreturn
4339 @opindex Wno-suggest-attribute=noreturn
4341 Warn about functions that might be candidates for attributes
4342 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4343 functions visible in other compilation units or (in the case of @code{pure} and
4344 @code{const}) if it cannot prove that the function returns normally. A function
4345 returns normally if it doesn't contain an infinite loop or return abnormally
4346 by throwing, calling @code{abort} or trapping.  This analysis requires option
4347 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4348 higher.  Higher optimization levels improve the accuracy of the analysis.
4350 @item -Wsuggest-attribute=format
4351 @itemx -Wmissing-format-attribute
4352 @opindex Wsuggest-attribute=format
4353 @opindex Wmissing-format-attribute
4354 @opindex Wno-suggest-attribute=format
4355 @opindex Wno-missing-format-attribute
4356 @opindex Wformat
4357 @opindex Wno-format
4359 Warn about function pointers that might be candidates for @code{format}
4360 attributes.  Note these are only possible candidates, not absolute ones.
4361 GCC guesses that function pointers with @code{format} attributes that
4362 are used in assignment, initialization, parameter passing or return
4363 statements should have a corresponding @code{format} attribute in the
4364 resulting type.  I.e.@: the left-hand side of the assignment or
4365 initialization, the type of the parameter variable, or the return type
4366 of the containing function respectively should also have a @code{format}
4367 attribute to avoid the warning.
4369 GCC also warns about function definitions that might be
4370 candidates for @code{format} attributes.  Again, these are only
4371 possible candidates.  GCC guesses that @code{format} attributes
4372 might be appropriate for any function that calls a function like
4373 @code{vprintf} or @code{vscanf}, but this might not always be the
4374 case, and some functions for which @code{format} attributes are
4375 appropriate may not be detected.
4376 @end table
4378 @item -Wsuggest-final-types
4379 @opindex Wno-suggest-final-types
4380 @opindex Wsuggest-final-types
4381 Warn about types with virtual methods where code quality would be improved
4382 if the type were declared with the C++11 @code{final} specifier, 
4383 or, if possible,
4384 declared in an anonymous namespace. This allows GCC to more aggressively
4385 devirtualize the polymorphic calls. This warning is more effective with link
4386 time optimization, where the information about the class hierarchy graph is
4387 more complete.
4389 @item -Wsuggest-final-methods
4390 @opindex Wno-suggest-final-methods
4391 @opindex Wsuggest-final-methods
4392 Warn about virtual methods where code quality would be improved if the method
4393 were declared with the C++11 @code{final} specifier, 
4394 or, if possible, its type were
4395 declared in an anonymous namespace or with the @code{final} specifier.
4396 This warning is
4397 more effective with link time optimization, where the information about the
4398 class hierarchy graph is more complete. It is recommended to first consider
4399 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4400 annotations.
4402 @item -Wsuggest-override
4403 Warn about overriding virtual functions that are not marked with the override
4404 keyword.
4406 @item -Warray-bounds
4407 @itemx -Warray-bounds=@var{n}
4408 @opindex Wno-array-bounds
4409 @opindex Warray-bounds
4410 This option is only active when @option{-ftree-vrp} is active
4411 (default for @option{-O2} and above). It warns about subscripts to arrays
4412 that are always out of bounds. This warning is enabled by @option{-Wall}.
4414 @table @gcctabopt
4415 @item -Warray-bounds=1
4416 This is the warning level of @option{-Warray-bounds} and is enabled
4417 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4419 @item -Warray-bounds=2
4420 This warning level also warns about out of bounds access for
4421 arrays at the end of a struct and for arrays accessed through
4422 pointers. This warning level may give a larger number of
4423 false positives and is deactivated by default.
4424 @end table
4426 @item -Wbool-compare
4427 @opindex Wno-bool-compare
4428 @opindex Wbool-compare
4429 Warn about boolean expression compared with an integer value different from
4430 @code{true}/@code{false}.  For instance, the following comparison is
4431 always false:
4432 @smallexample
4433 int n = 5;
4434 @dots{}
4435 if ((n > 1) == 2) @{ @dots{} @}
4436 @end smallexample
4437 This warning is enabled by @option{-Wall}.
4439 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4440 @opindex Wno-discarded-qualifiers
4441 @opindex Wdiscarded-qualifiers
4442 Do not warn if type qualifiers on pointers are being discarded.
4443 Typically, the compiler warns if a @code{const char *} variable is
4444 passed to a function that takes a @code{char *} parameter.  This option
4445 can be used to suppress such a warning.
4447 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4448 @opindex Wno-discarded-array-qualifiers
4449 @opindex Wdiscarded-array-qualifiers
4450 Do not warn if type qualifiers on arrays which are pointer targets
4451 are being discarded. Typically, the compiler warns if a
4452 @code{const int (*)[]} variable is passed to a function that
4453 takes a @code{int (*)[]} parameter.  This option can be used to
4454 suppress such a warning.
4456 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4457 @opindex Wno-incompatible-pointer-types
4458 @opindex Wincompatible-pointer-types
4459 Do not warn when there is a conversion between pointers that have incompatible
4460 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4461 which warns for pointer argument passing or assignment with different
4462 signedness.
4464 @item -Wno-int-conversion @r{(C and Objective-C only)}
4465 @opindex Wno-int-conversion
4466 @opindex Wint-conversion
4467 Do not warn about incompatible integer to pointer and pointer to integer
4468 conversions.  This warning is about implicit conversions; for explicit
4469 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4470 @option{-Wno-pointer-to-int-cast} may be used.
4472 @item -Wno-div-by-zero
4473 @opindex Wno-div-by-zero
4474 @opindex Wdiv-by-zero
4475 Do not warn about compile-time integer division by zero.  Floating-point
4476 division by zero is not warned about, as it can be a legitimate way of
4477 obtaining infinities and NaNs.
4479 @item -Wsystem-headers
4480 @opindex Wsystem-headers
4481 @opindex Wno-system-headers
4482 @cindex warnings from system headers
4483 @cindex system headers, warnings from
4484 Print warning messages for constructs found in system header files.
4485 Warnings from system headers are normally suppressed, on the assumption
4486 that they usually do not indicate real problems and would only make the
4487 compiler output harder to read.  Using this command-line option tells
4488 GCC to emit warnings from system headers as if they occurred in user
4489 code.  However, note that using @option{-Wall} in conjunction with this
4490 option does @emph{not} warn about unknown pragmas in system
4491 headers---for that, @option{-Wunknown-pragmas} must also be used.
4493 @item -Wtrampolines
4494 @opindex Wtrampolines
4495 @opindex Wno-trampolines
4496 Warn about trampolines generated for pointers to nested functions.
4497 A trampoline is a small piece of data or code that is created at run
4498 time on the stack when the address of a nested function is taken, and is
4499 used to call the nested function indirectly.  For some targets, it is
4500 made up of data only and thus requires no special treatment.  But, for
4501 most targets, it is made up of code and thus requires the stack to be
4502 made executable in order for the program to work properly.
4504 @item -Wfloat-equal
4505 @opindex Wfloat-equal
4506 @opindex Wno-float-equal
4507 Warn if floating-point values are used in equality comparisons.
4509 The idea behind this is that sometimes it is convenient (for the
4510 programmer) to consider floating-point values as approximations to
4511 infinitely precise real numbers.  If you are doing this, then you need
4512 to compute (by analyzing the code, or in some other way) the maximum or
4513 likely maximum error that the computation introduces, and allow for it
4514 when performing comparisons (and when producing output, but that's a
4515 different problem).  In particular, instead of testing for equality, you
4516 should check to see whether the two values have ranges that overlap; and
4517 this is done with the relational operators, so equality comparisons are
4518 probably mistaken.
4520 @item -Wtraditional @r{(C and Objective-C only)}
4521 @opindex Wtraditional
4522 @opindex Wno-traditional
4523 Warn about certain constructs that behave differently in traditional and
4524 ISO C@.  Also warn about ISO C constructs that have no traditional C
4525 equivalent, and/or problematic constructs that should be avoided.
4527 @itemize @bullet
4528 @item
4529 Macro parameters that appear within string literals in the macro body.
4530 In traditional C macro replacement takes place within string literals,
4531 but in ISO C it does not.
4533 @item
4534 In traditional C, some preprocessor directives did not exist.
4535 Traditional preprocessors only considered a line to be a directive
4536 if the @samp{#} appeared in column 1 on the line.  Therefore
4537 @option{-Wtraditional} warns about directives that traditional C
4538 understands but ignores because the @samp{#} does not appear as the
4539 first character on the line.  It also suggests you hide directives like
4540 @code{#pragma} not understood by traditional C by indenting them.  Some
4541 traditional implementations do not recognize @code{#elif}, so this option
4542 suggests avoiding it altogether.
4544 @item
4545 A function-like macro that appears without arguments.
4547 @item
4548 The unary plus operator.
4550 @item
4551 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4552 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4553 constants.)  Note, these suffixes appear in macros defined in the system
4554 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4555 Use of these macros in user code might normally lead to spurious
4556 warnings, however GCC's integrated preprocessor has enough context to
4557 avoid warning in these cases.
4559 @item
4560 A function declared external in one block and then used after the end of
4561 the block.
4563 @item
4564 A @code{switch} statement has an operand of type @code{long}.
4566 @item
4567 A non-@code{static} function declaration follows a @code{static} one.
4568 This construct is not accepted by some traditional C compilers.
4570 @item
4571 The ISO type of an integer constant has a different width or
4572 signedness from its traditional type.  This warning is only issued if
4573 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4574 typically represent bit patterns, are not warned about.
4576 @item
4577 Usage of ISO string concatenation is detected.
4579 @item
4580 Initialization of automatic aggregates.
4582 @item
4583 Identifier conflicts with labels.  Traditional C lacks a separate
4584 namespace for labels.
4586 @item
4587 Initialization of unions.  If the initializer is zero, the warning is
4588 omitted.  This is done under the assumption that the zero initializer in
4589 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4590 initializer warnings and relies on default initialization to zero in the
4591 traditional C case.
4593 @item
4594 Conversions by prototypes between fixed/floating-point values and vice
4595 versa.  The absence of these prototypes when compiling with traditional
4596 C causes serious problems.  This is a subset of the possible
4597 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4599 @item
4600 Use of ISO C style function definitions.  This warning intentionally is
4601 @emph{not} issued for prototype declarations or variadic functions
4602 because these ISO C features appear in your code when using
4603 libiberty's traditional C compatibility macros, @code{PARAMS} and
4604 @code{VPARAMS}.  This warning is also bypassed for nested functions
4605 because that feature is already a GCC extension and thus not relevant to
4606 traditional C compatibility.
4607 @end itemize
4609 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4610 @opindex Wtraditional-conversion
4611 @opindex Wno-traditional-conversion
4612 Warn if a prototype causes a type conversion that is different from what
4613 would happen to the same argument in the absence of a prototype.  This
4614 includes conversions of fixed point to floating and vice versa, and
4615 conversions changing the width or signedness of a fixed-point argument
4616 except when the same as the default promotion.
4618 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4619 @opindex Wdeclaration-after-statement
4620 @opindex Wno-declaration-after-statement
4621 Warn when a declaration is found after a statement in a block.  This
4622 construct, known from C++, was introduced with ISO C99 and is by default
4623 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4625 @item -Wundef
4626 @opindex Wundef
4627 @opindex Wno-undef
4628 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4630 @item -Wno-endif-labels
4631 @opindex Wno-endif-labels
4632 @opindex Wendif-labels
4633 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4635 @item -Wshadow
4636 @opindex Wshadow
4637 @opindex Wno-shadow
4638 Warn whenever a local variable or type declaration shadows another
4639 variable, parameter, type, class member (in C++), or instance variable
4640 (in Objective-C) or whenever a built-in function is shadowed. Note
4641 that in C++, the compiler warns if a local variable shadows an
4642 explicit typedef, but not if it shadows a struct/class/enum.
4644 @item -Wno-shadow-ivar @r{(Objective-C only)}
4645 @opindex Wno-shadow-ivar
4646 @opindex Wshadow-ivar
4647 Do not warn whenever a local variable shadows an instance variable in an
4648 Objective-C method.
4650 @item -Wlarger-than=@var{len}
4651 @opindex Wlarger-than=@var{len}
4652 @opindex Wlarger-than-@var{len}
4653 Warn whenever an object of larger than @var{len} bytes is defined.
4655 @item -Wframe-larger-than=@var{len}
4656 @opindex Wframe-larger-than
4657 Warn if the size of a function frame is larger than @var{len} bytes.
4658 The computation done to determine the stack frame size is approximate
4659 and not conservative.
4660 The actual requirements may be somewhat greater than @var{len}
4661 even if you do not get a warning.  In addition, any space allocated
4662 via @code{alloca}, variable-length arrays, or related constructs
4663 is not included by the compiler when determining
4664 whether or not to issue a warning.
4666 @item -Wno-free-nonheap-object
4667 @opindex Wno-free-nonheap-object
4668 @opindex Wfree-nonheap-object
4669 Do not warn when attempting to free an object that was not allocated
4670 on the heap.
4672 @item -Wstack-usage=@var{len}
4673 @opindex Wstack-usage
4674 Warn if the stack usage of a function might be larger than @var{len} bytes.
4675 The computation done to determine the stack usage is conservative.
4676 Any space allocated via @code{alloca}, variable-length arrays, or related
4677 constructs is included by the compiler when determining whether or not to
4678 issue a warning.
4680 The message is in keeping with the output of @option{-fstack-usage}.
4682 @itemize
4683 @item
4684 If the stack usage is fully static but exceeds the specified amount, it's:
4686 @smallexample
4687   warning: stack usage is 1120 bytes
4688 @end smallexample
4689 @item
4690 If the stack usage is (partly) dynamic but bounded, it's:
4692 @smallexample
4693   warning: stack usage might be 1648 bytes
4694 @end smallexample
4695 @item
4696 If the stack usage is (partly) dynamic and not bounded, it's:
4698 @smallexample
4699   warning: stack usage might be unbounded
4700 @end smallexample
4701 @end itemize
4703 @item -Wunsafe-loop-optimizations
4704 @opindex Wunsafe-loop-optimizations
4705 @opindex Wno-unsafe-loop-optimizations
4706 Warn if the loop cannot be optimized because the compiler cannot
4707 assume anything on the bounds of the loop indices.  With
4708 @option{-funsafe-loop-optimizations} warn if the compiler makes
4709 such assumptions.
4711 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4712 @opindex Wno-pedantic-ms-format
4713 @opindex Wpedantic-ms-format
4714 When used in combination with @option{-Wformat}
4715 and @option{-pedantic} without GNU extensions, this option
4716 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4717 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4718 which depend on the MS runtime.
4720 @item -Wpointer-arith
4721 @opindex Wpointer-arith
4722 @opindex Wno-pointer-arith
4723 Warn about anything that depends on the ``size of'' a function type or
4724 of @code{void}.  GNU C assigns these types a size of 1, for
4725 convenience in calculations with @code{void *} pointers and pointers
4726 to functions.  In C++, warn also when an arithmetic operation involves
4727 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4729 @item -Wtype-limits
4730 @opindex Wtype-limits
4731 @opindex Wno-type-limits
4732 Warn if a comparison is always true or always false due to the limited
4733 range of the data type, but do not warn for constant expressions.  For
4734 example, warn if an unsigned variable is compared against zero with
4735 @code{<} or @code{>=}.  This warning is also enabled by
4736 @option{-Wextra}.
4738 @item -Wbad-function-cast @r{(C and Objective-C only)}
4739 @opindex Wbad-function-cast
4740 @opindex Wno-bad-function-cast
4741 Warn when a function call is cast to a non-matching type.
4742 For example, warn if a call to a function returning an integer type 
4743 is cast to a pointer type.
4745 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4746 @opindex Wc90-c99-compat
4747 @opindex Wno-c90-c99-compat
4748 Warn about features not present in ISO C90, but present in ISO C99.
4749 For instance, warn about use of variable length arrays, @code{long long}
4750 type, @code{bool} type, compound literals, designated initializers, and so
4751 on.  This option is independent of the standards mode.  Warnings are disabled
4752 in the expression that follows @code{__extension__}.
4754 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4755 @opindex Wc99-c11-compat
4756 @opindex Wno-c99-c11-compat
4757 Warn about features not present in ISO C99, but present in ISO C11.
4758 For instance, warn about use of anonymous structures and unions,
4759 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4760 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4761 and so on.  This option is independent of the standards mode.  Warnings are
4762 disabled in the expression that follows @code{__extension__}.
4764 @item -Wc++-compat @r{(C and Objective-C only)}
4765 @opindex Wc++-compat
4766 Warn about ISO C constructs that are outside of the common subset of
4767 ISO C and ISO C++, e.g.@: request for implicit conversion from
4768 @code{void *} to a pointer to non-@code{void} type.
4770 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4771 @opindex Wc++11-compat
4772 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4773 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4774 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4775 enabled by @option{-Wall}.
4777 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4778 @opindex Wc++14-compat
4779 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4780 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4782 @item -Wcast-qual
4783 @opindex Wcast-qual
4784 @opindex Wno-cast-qual
4785 Warn whenever a pointer is cast so as to remove a type qualifier from
4786 the target type.  For example, warn if a @code{const char *} is cast
4787 to an ordinary @code{char *}.
4789 Also warn when making a cast that introduces a type qualifier in an
4790 unsafe way.  For example, casting @code{char **} to @code{const char **}
4791 is unsafe, as in this example:
4793 @smallexample
4794   /* p is char ** value.  */
4795   const char **q = (const char **) p;
4796   /* Assignment of readonly string to const char * is OK.  */
4797   *q = "string";
4798   /* Now char** pointer points to read-only memory.  */
4799   **p = 'b';
4800 @end smallexample
4802 @item -Wcast-align
4803 @opindex Wcast-align
4804 @opindex Wno-cast-align
4805 Warn whenever a pointer is cast such that the required alignment of the
4806 target is increased.  For example, warn if a @code{char *} is cast to
4807 an @code{int *} on machines where integers can only be accessed at
4808 two- or four-byte boundaries.
4810 @item -Wwrite-strings
4811 @opindex Wwrite-strings
4812 @opindex Wno-write-strings
4813 When compiling C, give string constants the type @code{const
4814 char[@var{length}]} so that copying the address of one into a
4815 non-@code{const} @code{char *} pointer produces a warning.  These
4816 warnings help you find at compile time code that can try to write
4817 into a string constant, but only if you have been very careful about
4818 using @code{const} in declarations and prototypes.  Otherwise, it is
4819 just a nuisance. This is why we did not make @option{-Wall} request
4820 these warnings.
4822 When compiling C++, warn about the deprecated conversion from string
4823 literals to @code{char *}.  This warning is enabled by default for C++
4824 programs.
4826 @item -Wclobbered
4827 @opindex Wclobbered
4828 @opindex Wno-clobbered
4829 Warn for variables that might be changed by @code{longjmp} or
4830 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
4832 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4833 @opindex Wconditionally-supported
4834 @opindex Wno-conditionally-supported
4835 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4837 @item -Wconversion
4838 @opindex Wconversion
4839 @opindex Wno-conversion
4840 Warn for implicit conversions that may alter a value. This includes
4841 conversions between real and integer, like @code{abs (x)} when
4842 @code{x} is @code{double}; conversions between signed and unsigned,
4843 like @code{unsigned ui = -1}; and conversions to smaller types, like
4844 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4845 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4846 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4847 conversions between signed and unsigned integers can be disabled by
4848 using @option{-Wno-sign-conversion}.
4850 For C++, also warn for confusing overload resolution for user-defined
4851 conversions; and conversions that never use a type conversion
4852 operator: conversions to @code{void}, the same type, a base class or a
4853 reference to them. Warnings about conversions between signed and
4854 unsigned integers are disabled by default in C++ unless
4855 @option{-Wsign-conversion} is explicitly enabled.
4857 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4858 @opindex Wconversion-null
4859 @opindex Wno-conversion-null
4860 Do not warn for conversions between @code{NULL} and non-pointer
4861 types. @option{-Wconversion-null} is enabled by default.
4863 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4864 @opindex Wzero-as-null-pointer-constant
4865 @opindex Wno-zero-as-null-pointer-constant
4866 Warn when a literal '0' is used as null pointer constant.  This can
4867 be useful to facilitate the conversion to @code{nullptr} in C++11.
4869 @item -Wdate-time
4870 @opindex Wdate-time
4871 @opindex Wno-date-time
4872 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4873 are encountered as they might prevent bit-wise-identical reproducible
4874 compilations.
4876 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4877 @opindex Wdelete-incomplete
4878 @opindex Wno-delete-incomplete
4879 Warn when deleting a pointer to incomplete type, which may cause
4880 undefined behavior at runtime.  This warning is enabled by default.
4882 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4883 @opindex Wuseless-cast
4884 @opindex Wno-useless-cast
4885 Warn when an expression is casted to its own type.
4887 @item -Wempty-body
4888 @opindex Wempty-body
4889 @opindex Wno-empty-body
4890 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
4891 while} statement.  This warning is also enabled by @option{-Wextra}.
4893 @item -Wenum-compare
4894 @opindex Wenum-compare
4895 @opindex Wno-enum-compare
4896 Warn about a comparison between values of different enumerated types.
4897 In C++ enumeral mismatches in conditional expressions are also
4898 diagnosed and the warning is enabled by default.  In C this warning is 
4899 enabled by @option{-Wall}.
4901 @item -Wjump-misses-init @r{(C, Objective-C only)}
4902 @opindex Wjump-misses-init
4903 @opindex Wno-jump-misses-init
4904 Warn if a @code{goto} statement or a @code{switch} statement jumps
4905 forward across the initialization of a variable, or jumps backward to a
4906 label after the variable has been initialized.  This only warns about
4907 variables that are initialized when they are declared.  This warning is
4908 only supported for C and Objective-C; in C++ this sort of branch is an
4909 error in any case.
4911 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4912 can be disabled with the @option{-Wno-jump-misses-init} option.
4914 @item -Wsign-compare
4915 @opindex Wsign-compare
4916 @opindex Wno-sign-compare
4917 @cindex warning for comparison of signed and unsigned values
4918 @cindex comparison of signed and unsigned values, warning
4919 @cindex signed and unsigned values, comparison warning
4920 Warn when a comparison between signed and unsigned values could produce
4921 an incorrect result when the signed value is converted to unsigned.
4922 This warning is also enabled by @option{-Wextra}; to get the other warnings
4923 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4925 @item -Wsign-conversion
4926 @opindex Wsign-conversion
4927 @opindex Wno-sign-conversion
4928 Warn for implicit conversions that may change the sign of an integer
4929 value, like assigning a signed integer expression to an unsigned
4930 integer variable. An explicit cast silences the warning. In C, this
4931 option is enabled also by @option{-Wconversion}.
4933 @item -Wfloat-conversion
4934 @opindex Wfloat-conversion
4935 @opindex Wno-float-conversion
4936 Warn for implicit conversions that reduce the precision of a real value.
4937 This includes conversions from real to integer, and from higher precision
4938 real to lower precision real values.  This option is also enabled by
4939 @option{-Wconversion}.
4941 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4942 @opindex Wsized-deallocation
4943 @opindex Wno-sized-deallocation
4944 Warn about a definition of an unsized deallocation function
4945 @smallexample
4946 void operator delete (void *) noexcept;
4947 void operator delete[] (void *) noexcept;
4948 @end smallexample
4949 without a definition of the corresponding sized deallocation function
4950 @smallexample
4951 void operator delete (void *, std::size_t) noexcept;
4952 void operator delete[] (void *, std::size_t) noexcept;
4953 @end smallexample
4954 or vice versa.  Enabled by @option{-Wextra} along with
4955 @option{-fsized-deallocation}.
4957 @item -Wsizeof-pointer-memaccess
4958 @opindex Wsizeof-pointer-memaccess
4959 @opindex Wno-sizeof-pointer-memaccess
4960 Warn for suspicious length parameters to certain string and memory built-in
4961 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4962 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4963 but a pointer, and suggests a possible fix, or about
4964 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4965 @option{-Wall}.
4967 @item -Wsizeof-array-argument
4968 @opindex Wsizeof-array-argument
4969 @opindex Wno-sizeof-array-argument
4970 Warn when the @code{sizeof} operator is applied to a parameter that is
4971 declared as an array in a function definition.  This warning is enabled by
4972 default for C and C++ programs.
4974 @item -Wmemset-transposed-args
4975 @opindex Wmemset-transposed-args
4976 @opindex Wno-memset-transposed-args
4977 Warn for suspicious calls to the @code{memset} built-in function, if the
4978 second argument is not zero and the third argument is zero.  This warns e.g.@
4979 about @code{memset (buf, sizeof buf, 0)} where most probably
4980 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4981 is only emitted if the third argument is literal zero.  If it is some
4982 expression that is folded to zero, a cast of zero to some type, etc., 
4983 it is far less likely that the user has mistakenly exchanged the arguments 
4984 and no warning is emitted.  This warning is enabled by @option{-Wall}.
4986 @item -Waddress
4987 @opindex Waddress
4988 @opindex Wno-address
4989 Warn about suspicious uses of memory addresses. These include using
4990 the address of a function in a conditional expression, such as
4991 @code{void func(void); if (func)}, and comparisons against the memory
4992 address of a string literal, such as @code{if (x == "abc")}.  Such
4993 uses typically indicate a programmer error: the address of a function
4994 always evaluates to true, so their use in a conditional usually
4995 indicate that the programmer forgot the parentheses in a function
4996 call; and comparisons against string literals result in unspecified
4997 behavior and are not portable in C, so they usually indicate that the
4998 programmer intended to use @code{strcmp}.  This warning is enabled by
4999 @option{-Wall}.
5001 @item -Wlogical-op
5002 @opindex Wlogical-op
5003 @opindex Wno-logical-op
5004 Warn about suspicious uses of logical operators in expressions.
5005 This includes using logical operators in contexts where a
5006 bit-wise operator is likely to be expected.  Also warns when
5007 the operands of a logical operator are the same:
5008 @smallexample
5009 extern int a;
5010 if (a < 0 && a < 0) @{ @dots{} @}
5011 @end smallexample
5013 @item -Wlogical-not-parentheses
5014 @opindex Wlogical-not-parentheses
5015 @opindex Wno-logical-not-parentheses
5016 Warn about logical not used on the left hand side operand of a comparison.
5017 This option does not warn if the RHS operand is of a boolean type.  Its
5018 purpose is to detect suspicious code like the following:
5019 @smallexample
5020 int a;
5021 @dots{}
5022 if (!a > 1) @{ @dots{} @}
5023 @end smallexample
5025 It is possible to suppress the warning by wrapping the LHS into
5026 parentheses:
5027 @smallexample
5028 if ((!a) > 1) @{ @dots{} @}
5029 @end smallexample
5031 This warning is enabled by @option{-Wall}.
5033 @item -Waggregate-return
5034 @opindex Waggregate-return
5035 @opindex Wno-aggregate-return
5036 Warn if any functions that return structures or unions are defined or
5037 called.  (In languages where you can return an array, this also elicits
5038 a warning.)
5040 @item -Wno-aggressive-loop-optimizations
5041 @opindex Wno-aggressive-loop-optimizations
5042 @opindex Waggressive-loop-optimizations
5043 Warn if in a loop with constant number of iterations the compiler detects
5044 undefined behavior in some statement during one or more of the iterations.
5046 @item -Wno-attributes
5047 @opindex Wno-attributes
5048 @opindex Wattributes
5049 Do not warn if an unexpected @code{__attribute__} is used, such as
5050 unrecognized attributes, function attributes applied to variables,
5051 etc.  This does not stop errors for incorrect use of supported
5052 attributes.
5054 @item -Wno-builtin-macro-redefined
5055 @opindex Wno-builtin-macro-redefined
5056 @opindex Wbuiltin-macro-redefined
5057 Do not warn if certain built-in macros are redefined.  This suppresses
5058 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5059 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5061 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5062 @opindex Wstrict-prototypes
5063 @opindex Wno-strict-prototypes
5064 Warn if a function is declared or defined without specifying the
5065 argument types.  (An old-style function definition is permitted without
5066 a warning if preceded by a declaration that specifies the argument
5067 types.)
5069 @item -Wold-style-declaration @r{(C and Objective-C only)}
5070 @opindex Wold-style-declaration
5071 @opindex Wno-old-style-declaration
5072 Warn for obsolescent usages, according to the C Standard, in a
5073 declaration. For example, warn if storage-class specifiers like
5074 @code{static} are not the first things in a declaration.  This warning
5075 is also enabled by @option{-Wextra}.
5077 @item -Wold-style-definition @r{(C and Objective-C only)}
5078 @opindex Wold-style-definition
5079 @opindex Wno-old-style-definition
5080 Warn if an old-style function definition is used.  A warning is given
5081 even if there is a previous prototype.
5083 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5084 @opindex Wmissing-parameter-type
5085 @opindex Wno-missing-parameter-type
5086 A function parameter is declared without a type specifier in K&R-style
5087 functions:
5089 @smallexample
5090 void foo(bar) @{ @}
5091 @end smallexample
5093 This warning is also enabled by @option{-Wextra}.
5095 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5096 @opindex Wmissing-prototypes
5097 @opindex Wno-missing-prototypes
5098 Warn if a global function is defined without a previous prototype
5099 declaration.  This warning is issued even if the definition itself
5100 provides a prototype.  Use this option to detect global functions
5101 that do not have a matching prototype declaration in a header file.
5102 This option is not valid for C++ because all function declarations
5103 provide prototypes and a non-matching declaration declares an
5104 overload rather than conflict with an earlier declaration.
5105 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5107 @item -Wmissing-declarations
5108 @opindex Wmissing-declarations
5109 @opindex Wno-missing-declarations
5110 Warn if a global function is defined without a previous declaration.
5111 Do so even if the definition itself provides a prototype.
5112 Use this option to detect global functions that are not declared in
5113 header files.  In C, no warnings are issued for functions with previous
5114 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5115 missing prototypes.  In C++, no warnings are issued for function templates,
5116 or for inline functions, or for functions in anonymous namespaces.
5118 @item -Wmissing-field-initializers
5119 @opindex Wmissing-field-initializers
5120 @opindex Wno-missing-field-initializers
5121 @opindex W
5122 @opindex Wextra
5123 @opindex Wno-extra
5124 Warn if a structure's initializer has some fields missing.  For
5125 example, the following code causes such a warning, because
5126 @code{x.h} is implicitly zero:
5128 @smallexample
5129 struct s @{ int f, g, h; @};
5130 struct s x = @{ 3, 4 @};
5131 @end smallexample
5133 This option does not warn about designated initializers, so the following
5134 modification does not trigger a warning:
5136 @smallexample
5137 struct s @{ int f, g, h; @};
5138 struct s x = @{ .f = 3, .g = 4 @};
5139 @end smallexample
5141 In C++ this option does not warn either about the empty @{ @}
5142 initializer, for example:
5144 @smallexample
5145 struct s @{ int f, g, h; @};
5146 s x = @{ @};
5147 @end smallexample
5149 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5150 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5152 @item -Wno-multichar
5153 @opindex Wno-multichar
5154 @opindex Wmultichar
5155 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5156 Usually they indicate a typo in the user's code, as they have
5157 implementation-defined values, and should not be used in portable code.
5159 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5160 @opindex Wnormalized=
5161 @opindex Wnormalized
5162 @opindex Wno-normalized
5163 @cindex NFC
5164 @cindex NFKC
5165 @cindex character set, input normalization
5166 In ISO C and ISO C++, two identifiers are different if they are
5167 different sequences of characters.  However, sometimes when characters
5168 outside the basic ASCII character set are used, you can have two
5169 different character sequences that look the same.  To avoid confusion,
5170 the ISO 10646 standard sets out some @dfn{normalization rules} which
5171 when applied ensure that two sequences that look the same are turned into
5172 the same sequence.  GCC can warn you if you are using identifiers that
5173 have not been normalized; this option controls that warning.
5175 There are four levels of warning supported by GCC@.  The default is
5176 @option{-Wnormalized=nfc}, which warns about any identifier that is
5177 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5178 recommended form for most uses.  It is equivalent to
5179 @option{-Wnormalized}.
5181 Unfortunately, there are some characters allowed in identifiers by
5182 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5183 identifiers.  That is, there's no way to use these symbols in portable
5184 ISO C or C++ and have all your identifiers in NFC@.
5185 @option{-Wnormalized=id} suppresses the warning for these characters.
5186 It is hoped that future versions of the standards involved will correct
5187 this, which is why this option is not the default.
5189 You can switch the warning off for all characters by writing
5190 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5191 only do this if you are using some other normalization scheme (like
5192 ``D''), because otherwise you can easily create bugs that are
5193 literally impossible to see.
5195 Some characters in ISO 10646 have distinct meanings but look identical
5196 in some fonts or display methodologies, especially once formatting has
5197 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5198 LETTER N'', displays just like a regular @code{n} that has been
5199 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5200 normalization scheme to convert all these into a standard form as
5201 well, and GCC warns if your code is not in NFKC if you use
5202 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5203 about every identifier that contains the letter O because it might be
5204 confused with the digit 0, and so is not the default, but may be
5205 useful as a local coding convention if the programming environment 
5206 cannot be fixed to display these characters distinctly.
5208 @item -Wno-deprecated
5209 @opindex Wno-deprecated
5210 @opindex Wdeprecated
5211 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5213 @item -Wno-deprecated-declarations
5214 @opindex Wno-deprecated-declarations
5215 @opindex Wdeprecated-declarations
5216 Do not warn about uses of functions (@pxref{Function Attributes}),
5217 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5218 Attributes}) marked as deprecated by using the @code{deprecated}
5219 attribute.
5221 @item -Wno-overflow
5222 @opindex Wno-overflow
5223 @opindex Woverflow
5224 Do not warn about compile-time overflow in constant expressions.
5226 @item -Wno-odr
5227 @opindex Wno-odr
5228 @opindex Wodr
5229 Warn about One Definition Rule violations during link-time optimization.
5230 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5232 @item -Wopenmp-simd
5233 @opindex Wopenm-simd
5234 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5235 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5236 option can be used to relax the cost model.
5238 @item -Woverride-init @r{(C and Objective-C only)}
5239 @opindex Woverride-init
5240 @opindex Wno-override-init
5241 @opindex W
5242 @opindex Wextra
5243 @opindex Wno-extra
5244 Warn if an initialized field without side effects is overridden when
5245 using designated initializers (@pxref{Designated Inits, , Designated
5246 Initializers}).
5248 This warning is included in @option{-Wextra}.  To get other
5249 @option{-Wextra} warnings without this one, use @option{-Wextra
5250 -Wno-override-init}.
5252 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
5253 @opindex Woverride-init-side-effects
5254 @opindex Wno-override-init-side-effects
5255 Warn if an initialized field with side effects is overridden when
5256 using designated initializers (@pxref{Designated Inits, , Designated
5257 Initializers}).  This warning is enabled by default.
5259 @item -Wpacked
5260 @opindex Wpacked
5261 @opindex Wno-packed
5262 Warn if a structure is given the packed attribute, but the packed
5263 attribute has no effect on the layout or size of the structure.
5264 Such structures may be mis-aligned for little benefit.  For
5265 instance, in this code, the variable @code{f.x} in @code{struct bar}
5266 is misaligned even though @code{struct bar} does not itself
5267 have the packed attribute:
5269 @smallexample
5270 @group
5271 struct foo @{
5272   int x;
5273   char a, b, c, d;
5274 @} __attribute__((packed));
5275 struct bar @{
5276   char z;
5277   struct foo f;
5279 @end group
5280 @end smallexample
5282 @item -Wpacked-bitfield-compat
5283 @opindex Wpacked-bitfield-compat
5284 @opindex Wno-packed-bitfield-compat
5285 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5286 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5287 the change can lead to differences in the structure layout.  GCC
5288 informs you when the offset of such a field has changed in GCC 4.4.
5289 For example there is no longer a 4-bit padding between field @code{a}
5290 and @code{b} in this structure:
5292 @smallexample
5293 struct foo
5295   char a:4;
5296   char b:8;
5297 @} __attribute__ ((packed));
5298 @end smallexample
5300 This warning is enabled by default.  Use
5301 @option{-Wno-packed-bitfield-compat} to disable this warning.
5303 @item -Wpadded
5304 @opindex Wpadded
5305 @opindex Wno-padded
5306 Warn if padding is included in a structure, either to align an element
5307 of the structure or to align the whole structure.  Sometimes when this
5308 happens it is possible to rearrange the fields of the structure to
5309 reduce the padding and so make the structure smaller.
5311 @item -Wredundant-decls
5312 @opindex Wredundant-decls
5313 @opindex Wno-redundant-decls
5314 Warn if anything is declared more than once in the same scope, even in
5315 cases where multiple declaration is valid and changes nothing.
5317 @item -Wnested-externs @r{(C and Objective-C only)}
5318 @opindex Wnested-externs
5319 @opindex Wno-nested-externs
5320 Warn if an @code{extern} declaration is encountered within a function.
5322 @item -Wno-inherited-variadic-ctor
5323 @opindex Winherited-variadic-ctor
5324 @opindex Wno-inherited-variadic-ctor
5325 Suppress warnings about use of C++11 inheriting constructors when the
5326 base class inherited from has a C variadic constructor; the warning is
5327 on by default because the ellipsis is not inherited.
5329 @item -Winline
5330 @opindex Winline
5331 @opindex Wno-inline
5332 Warn if a function that is declared as inline cannot be inlined.
5333 Even with this option, the compiler does not warn about failures to
5334 inline functions declared in system headers.
5336 The compiler uses a variety of heuristics to determine whether or not
5337 to inline a function.  For example, the compiler takes into account
5338 the size of the function being inlined and the amount of inlining
5339 that has already been done in the current function.  Therefore,
5340 seemingly insignificant changes in the source program can cause the
5341 warnings produced by @option{-Winline} to appear or disappear.
5343 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5344 @opindex Wno-invalid-offsetof
5345 @opindex Winvalid-offsetof
5346 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5347 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5348 to a non-standard-layout type is undefined.  In existing C++ implementations,
5349 however, @code{offsetof} typically gives meaningful results.
5350 This flag is for users who are aware that they are
5351 writing nonportable code and who have deliberately chosen to ignore the
5352 warning about it.
5354 The restrictions on @code{offsetof} may be relaxed in a future version
5355 of the C++ standard.
5357 @item -Wno-int-to-pointer-cast
5358 @opindex Wno-int-to-pointer-cast
5359 @opindex Wint-to-pointer-cast
5360 Suppress warnings from casts to pointer type of an integer of a
5361 different size. In C++, casting to a pointer type of smaller size is
5362 an error. @option{Wint-to-pointer-cast} is enabled by default.
5365 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5366 @opindex Wno-pointer-to-int-cast
5367 @opindex Wpointer-to-int-cast
5368 Suppress warnings from casts from a pointer to an integer type of a
5369 different size.
5371 @item -Winvalid-pch
5372 @opindex Winvalid-pch
5373 @opindex Wno-invalid-pch
5374 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5375 the search path but can't be used.
5377 @item -Wlong-long
5378 @opindex Wlong-long
5379 @opindex Wno-long-long
5380 Warn if @code{long long} type is used.  This is enabled by either
5381 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5382 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5384 @item -Wvariadic-macros
5385 @opindex Wvariadic-macros
5386 @opindex Wno-variadic-macros
5387 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5388 alternate syntax is used in ISO C99 mode.  This is enabled by either
5389 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5390 messages, use @option{-Wno-variadic-macros}.
5392 @item -Wvarargs
5393 @opindex Wvarargs
5394 @opindex Wno-varargs
5395 Warn upon questionable usage of the macros used to handle variable
5396 arguments like @code{va_start}.  This is default.  To inhibit the
5397 warning messages, use @option{-Wno-varargs}.
5399 @item -Wvector-operation-performance
5400 @opindex Wvector-operation-performance
5401 @opindex Wno-vector-operation-performance
5402 Warn if vector operation is not implemented via SIMD capabilities of the
5403 architecture.  Mainly useful for the performance tuning.
5404 Vector operation can be implemented @code{piecewise}, which means that the
5405 scalar operation is performed on every vector element; 
5406 @code{in parallel}, which means that the vector operation is implemented
5407 using scalars of wider type, which normally is more performance efficient;
5408 and @code{as a single scalar}, which means that vector fits into a
5409 scalar type.
5411 @item -Wno-virtual-move-assign
5412 @opindex Wvirtual-move-assign
5413 @opindex Wno-virtual-move-assign
5414 Suppress warnings about inheriting from a virtual base with a
5415 non-trivial C++11 move assignment operator.  This is dangerous because
5416 if the virtual base is reachable along more than one path, it is
5417 moved multiple times, which can mean both objects end up in the
5418 moved-from state.  If the move assignment operator is written to avoid
5419 moving from a moved-from object, this warning can be disabled.
5421 @item -Wvla
5422 @opindex Wvla
5423 @opindex Wno-vla
5424 Warn if variable length array is used in the code.
5425 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5426 the variable length array.
5428 @item -Wvolatile-register-var
5429 @opindex Wvolatile-register-var
5430 @opindex Wno-volatile-register-var
5431 Warn if a register variable is declared volatile.  The volatile
5432 modifier does not inhibit all optimizations that may eliminate reads
5433 and/or writes to register variables.  This warning is enabled by
5434 @option{-Wall}.
5436 @item -Wdisabled-optimization
5437 @opindex Wdisabled-optimization
5438 @opindex Wno-disabled-optimization
5439 Warn if a requested optimization pass is disabled.  This warning does
5440 not generally indicate that there is anything wrong with your code; it
5441 merely indicates that GCC's optimizers are unable to handle the code
5442 effectively.  Often, the problem is that your code is too big or too
5443 complex; GCC refuses to optimize programs when the optimization
5444 itself is likely to take inordinate amounts of time.
5446 @item -Wpointer-sign @r{(C and Objective-C only)}
5447 @opindex Wpointer-sign
5448 @opindex Wno-pointer-sign
5449 Warn for pointer argument passing or assignment with different signedness.
5450 This option is only supported for C and Objective-C@.  It is implied by
5451 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5452 @option{-Wno-pointer-sign}.
5454 @item -Wstack-protector
5455 @opindex Wstack-protector
5456 @opindex Wno-stack-protector
5457 This option is only active when @option{-fstack-protector} is active.  It
5458 warns about functions that are not protected against stack smashing.
5460 @item -Woverlength-strings
5461 @opindex Woverlength-strings
5462 @opindex Wno-overlength-strings
5463 Warn about string constants that are longer than the ``minimum
5464 maximum'' length specified in the C standard.  Modern compilers
5465 generally allow string constants that are much longer than the
5466 standard's minimum limit, but very portable programs should avoid
5467 using longer strings.
5469 The limit applies @emph{after} string constant concatenation, and does
5470 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5471 C99, it was raised to 4095.  C++98 does not specify a normative
5472 minimum maximum, so we do not diagnose overlength strings in C++@.
5474 This option is implied by @option{-Wpedantic}, and can be disabled with
5475 @option{-Wno-overlength-strings}.
5477 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5478 @opindex Wunsuffixed-float-constants
5480 Issue a warning for any floating constant that does not have
5481 a suffix.  When used together with @option{-Wsystem-headers} it
5482 warns about such constants in system header files.  This can be useful
5483 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5484 from the decimal floating-point extension to C99.
5486 @item -Wno-designated-init @r{(C and Objective-C only)}
5487 Suppress warnings when a positional initializer is used to initialize
5488 a structure that has been marked with the @code{designated_init}
5489 attribute.
5491 @end table
5493 @node Debugging Options
5494 @section Options for Debugging Your Program or GCC
5495 @cindex options, debugging
5496 @cindex debugging information options
5498 GCC has various special options that are used for debugging
5499 either your program or GCC:
5501 @table @gcctabopt
5502 @item -g
5503 @opindex g
5504 Produce debugging information in the operating system's native format
5505 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5506 information.
5508 On most systems that use stabs format, @option{-g} enables use of extra
5509 debugging information that only GDB can use; this extra information
5510 makes debugging work better in GDB but probably makes other debuggers
5511 crash or
5512 refuse to read the program.  If you want to control for certain whether
5513 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5514 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5516 GCC allows you to use @option{-g} with
5517 @option{-O}.  The shortcuts taken by optimized code may occasionally
5518 produce surprising results: some variables you declared may not exist
5519 at all; flow of control may briefly move where you did not expect it;
5520 some statements may not be executed because they compute constant
5521 results or their values are already at hand; some statements may
5522 execute in different places because they have been moved out of loops.
5524 Nevertheless it proves possible to debug optimized output.  This makes
5525 it reasonable to use the optimizer for programs that might have bugs.
5527 The following options are useful when GCC is generated with the
5528 capability for more than one debugging format.
5530 @item -gsplit-dwarf
5531 @opindex gsplit-dwarf
5532 Separate as much dwarf debugging information as possible into a
5533 separate output file with the extension .dwo.  This option allows
5534 the build system to avoid linking files with debug information.  To
5535 be useful, this option requires a debugger capable of reading .dwo
5536 files.
5538 @item -ggdb
5539 @opindex ggdb
5540 Produce debugging information for use by GDB@.  This means to use the
5541 most expressive format available (DWARF 2, stabs, or the native format
5542 if neither of those are supported), including GDB extensions if at all
5543 possible.
5545 @item -gpubnames
5546 @opindex gpubnames
5547 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5549 @item -ggnu-pubnames
5550 @opindex ggnu-pubnames
5551 Generate .debug_pubnames and .debug_pubtypes sections in a format
5552 suitable for conversion into a GDB@ index.  This option is only useful
5553 with a linker that can produce GDB@ index version 7.
5555 @item -gstabs
5556 @opindex gstabs
5557 Produce debugging information in stabs format (if that is supported),
5558 without GDB extensions.  This is the format used by DBX on most BSD
5559 systems.  On MIPS, Alpha and System V Release 4 systems this option
5560 produces stabs debugging output that is not understood by DBX or SDB@.
5561 On System V Release 4 systems this option requires the GNU assembler.
5563 @item -feliminate-unused-debug-symbols
5564 @opindex feliminate-unused-debug-symbols
5565 Produce debugging information in stabs format (if that is supported),
5566 for only symbols that are actually used.
5568 @item -femit-class-debug-always
5569 @opindex femit-class-debug-always
5570 Instead of emitting debugging information for a C++ class in only one
5571 object file, emit it in all object files using the class.  This option
5572 should be used only with debuggers that are unable to handle the way GCC
5573 normally emits debugging information for classes because using this
5574 option increases the size of debugging information by as much as a
5575 factor of two.
5577 @item -fdebug-types-section
5578 @opindex fdebug-types-section
5579 @opindex fno-debug-types-section
5580 When using DWARF Version 4 or higher, type DIEs can be put into
5581 their own @code{.debug_types} section instead of making them part of the
5582 @code{.debug_info} section.  It is more efficient to put them in a separate
5583 comdat sections since the linker can then remove duplicates.
5584 But not all DWARF consumers support @code{.debug_types} sections yet
5585 and on some objects @code{.debug_types} produces larger instead of smaller
5586 debugging information.
5588 @item -gstabs+
5589 @opindex gstabs+
5590 Produce debugging information in stabs format (if that is supported),
5591 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5592 use of these extensions is likely to make other debuggers crash or
5593 refuse to read the program.
5595 @item -gcoff
5596 @opindex gcoff
5597 Produce debugging information in COFF format (if that is supported).
5598 This is the format used by SDB on most System V systems prior to
5599 System V Release 4.
5601 @item -gxcoff
5602 @opindex gxcoff
5603 Produce debugging information in XCOFF format (if that is supported).
5604 This is the format used by the DBX debugger on IBM RS/6000 systems.
5606 @item -gxcoff+
5607 @opindex gxcoff+
5608 Produce debugging information in XCOFF format (if that is supported),
5609 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5610 use of these extensions is likely to make other debuggers crash or
5611 refuse to read the program, and may cause assemblers other than the GNU
5612 assembler (GAS) to fail with an error.
5614 @item -gdwarf-@var{version}
5615 @opindex gdwarf-@var{version}
5616 Produce debugging information in DWARF format (if that is supported).
5617 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5618 for most targets is 4.  DWARF Version 5 is only experimental.
5620 Note that with DWARF Version 2, some ports require and always
5621 use some non-conflicting DWARF 3 extensions in the unwind tables.
5623 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5624 for maximum benefit.
5626 @item -grecord-gcc-switches
5627 @opindex grecord-gcc-switches
5628 This switch causes the command-line options used to invoke the
5629 compiler that may affect code generation to be appended to the
5630 DW_AT_producer attribute in DWARF debugging information.  The options
5631 are concatenated with spaces separating them from each other and from
5632 the compiler version.  See also @option{-frecord-gcc-switches} for another
5633 way of storing compiler options into the object file.  This is the default.
5635 @item -gno-record-gcc-switches
5636 @opindex gno-record-gcc-switches
5637 Disallow appending command-line options to the DW_AT_producer attribute
5638 in DWARF debugging information.
5640 @item -gstrict-dwarf
5641 @opindex gstrict-dwarf
5642 Disallow using extensions of later DWARF standard version than selected
5643 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5644 DWARF extensions from later standard versions is allowed.
5646 @item -gno-strict-dwarf
5647 @opindex gno-strict-dwarf
5648 Allow using extensions of later DWARF standard version than selected with
5649 @option{-gdwarf-@var{version}}.
5651 @item -gz@r{[}=@var{type}@r{]}
5652 @opindex gz
5653 Produce compressed debug sections in DWARF format, if that is supported.
5654 If @var{type} is not given, the default type depends on the capabilities
5655 of the assembler and linker used.  @var{type} may be one of
5656 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
5657 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
5658 compression in traditional GNU format).  If the linker doesn't support
5659 writing compressed debug sections, the option is rejected.  Otherwise,
5660 if the assembler does not support them, @option{-gz} is silently ignored
5661 when producing object files.
5663 @item -gvms
5664 @opindex gvms
5665 Produce debugging information in Alpha/VMS debug format (if that is
5666 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5668 @item -g@var{level}
5669 @itemx -ggdb@var{level}
5670 @itemx -gstabs@var{level}
5671 @itemx -gcoff@var{level}
5672 @itemx -gxcoff@var{level}
5673 @itemx -gvms@var{level}
5674 Request debugging information and also use @var{level} to specify how
5675 much information.  The default level is 2.
5677 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5678 @option{-g}.
5680 Level 1 produces minimal information, enough for making backtraces in
5681 parts of the program that you don't plan to debug.  This includes
5682 descriptions of functions and external variables, and line number
5683 tables, but no information about local variables.
5685 Level 3 includes extra information, such as all the macro definitions
5686 present in the program.  Some debuggers support macro expansion when
5687 you use @option{-g3}.
5689 @option{-gdwarf-2} does not accept a concatenated debug level, because
5690 GCC used to support an option @option{-gdwarf} that meant to generate
5691 debug information in version 1 of the DWARF format (which is very
5692 different from version 2), and it would have been too confusing.  That
5693 debug format is long obsolete, but the option cannot be changed now.
5694 Instead use an additional @option{-g@var{level}} option to change the
5695 debug level for DWARF.
5697 @item -gtoggle
5698 @opindex gtoggle
5699 Turn off generation of debug info, if leaving out this option
5700 generates it, or turn it on at level 2 otherwise.  The position of this
5701 argument in the command line does not matter; it takes effect after all
5702 other options are processed, and it does so only once, no matter how
5703 many times it is given.  This is mainly intended to be used with
5704 @option{-fcompare-debug}.
5706 @item -fsanitize=address
5707 @opindex fsanitize=address
5708 Enable AddressSanitizer, a fast memory error detector.
5709 Memory access instructions are instrumented to detect
5710 out-of-bounds and use-after-free bugs.
5711 See @uref{http://code.google.com/p/address-sanitizer/} for
5712 more details.  The run-time behavior can be influenced using the
5713 @env{ASAN_OPTIONS} environment variable; see
5714 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5715 a list of supported options.
5717 @item -fsanitize=kernel-address
5718 @opindex fsanitize=kernel-address
5719 Enable AddressSanitizer for Linux kernel.
5720 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5722 @item -fsanitize=thread
5723 @opindex fsanitize=thread
5724 Enable ThreadSanitizer, a fast data race detector.
5725 Memory access instructions are instrumented to detect
5726 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5727 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5728 environment variable; see
5729 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5730 supported options.
5732 @item -fsanitize=leak
5733 @opindex fsanitize=leak
5734 Enable LeakSanitizer, a memory leak detector.
5735 This option only matters for linking of executables and if neither
5736 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5737 case the executable is linked against a library that overrides @code{malloc}
5738 and other allocator functions.  See
5739 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5740 details.  The run-time behavior can be influenced using the
5741 @env{LSAN_OPTIONS} environment variable.
5743 @item -fsanitize=undefined
5744 @opindex fsanitize=undefined
5745 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5746 Various computations are instrumented to detect undefined behavior
5747 at runtime.  Current suboptions are:
5749 @table @gcctabopt
5751 @item -fsanitize=shift
5752 @opindex fsanitize=shift
5753 This option enables checking that the result of a shift operation is
5754 not undefined.  Note that what exactly is considered undefined differs
5755 slightly between C and C++, as well as between ISO C90 and C99, etc.
5757 @item -fsanitize=integer-divide-by-zero
5758 @opindex fsanitize=integer-divide-by-zero
5759 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5761 @item -fsanitize=unreachable
5762 @opindex fsanitize=unreachable
5763 With this option, the compiler turns the @code{__builtin_unreachable}
5764 call into a diagnostics message call instead.  When reaching the
5765 @code{__builtin_unreachable} call, the behavior is undefined.
5767 @item -fsanitize=vla-bound
5768 @opindex fsanitize=vla-bound
5769 This option instructs the compiler to check that the size of a variable
5770 length array is positive.
5772 @item -fsanitize=null
5773 @opindex fsanitize=null
5774 This option enables pointer checking.  Particularly, the application
5775 built with this option turned on will issue an error message when it
5776 tries to dereference a NULL pointer, or if a reference (possibly an
5777 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5778 on an object pointed by a NULL pointer.
5780 @item -fsanitize=return
5781 @opindex fsanitize=return
5782 This option enables return statement checking.  Programs
5783 built with this option turned on will issue an error message
5784 when the end of a non-void function is reached without actually
5785 returning a value.  This option works in C++ only.
5787 @item -fsanitize=signed-integer-overflow
5788 @opindex fsanitize=signed-integer-overflow
5789 This option enables signed integer overflow checking.  We check that
5790 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5791 does not overflow in the signed arithmetics.  Note, integer promotion
5792 rules must be taken into account.  That is, the following is not an
5793 overflow:
5794 @smallexample
5795 signed char a = SCHAR_MAX;
5796 a++;
5797 @end smallexample
5799 @item -fsanitize=bounds
5800 @opindex fsanitize=bounds
5801 This option enables instrumentation of array bounds.  Various out of bounds
5802 accesses are detected.  Flexible array members, flexible array member-like
5803 arrays, and initializers of variables with static storage are not instrumented.
5805 @item -fsanitize=bounds-strict
5806 @opindex fsanitize=bounds-strict
5807 This option enables strict instrumentation of array bounds.  Most out of bounds
5808 accesses are detected, including flexible array members and flexible array
5809 member-like arrays.  Initializers of variables with static storage are not
5810 instrumented.
5812 @item -fsanitize=alignment
5813 @opindex fsanitize=alignment
5815 This option enables checking of alignment of pointers when they are
5816 dereferenced, or when a reference is bound to insufficiently aligned target,
5817 or when a method or constructor is invoked on insufficiently aligned object.
5819 @item -fsanitize=object-size
5820 @opindex fsanitize=object-size
5821 This option enables instrumentation of memory references using the
5822 @code{__builtin_object_size} function.  Various out of bounds pointer
5823 accesses are detected.
5825 @item -fsanitize=float-divide-by-zero
5826 @opindex fsanitize=float-divide-by-zero
5827 Detect floating-point division by zero.  Unlike other similar options,
5828 @option{-fsanitize=float-divide-by-zero} is not enabled by
5829 @option{-fsanitize=undefined}, since floating-point division by zero can
5830 be a legitimate way of obtaining infinities and NaNs.
5832 @item -fsanitize=float-cast-overflow
5833 @opindex fsanitize=float-cast-overflow
5834 This option enables floating-point type to integer conversion checking.
5835 We check that the result of the conversion does not overflow.
5836 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
5837 not enabled by @option{-fsanitize=undefined}.
5838 This option does not work well with @code{FE_INVALID} exceptions enabled.
5840 @item -fsanitize=nonnull-attribute
5841 @opindex fsanitize=nonnull-attribute
5843 This option enables instrumentation of calls, checking whether null values
5844 are not passed to arguments marked as requiring a non-null value by the
5845 @code{nonnull} function attribute.
5847 @item -fsanitize=returns-nonnull-attribute
5848 @opindex fsanitize=returns-nonnull-attribute
5850 This option enables instrumentation of return statements in functions
5851 marked with @code{returns_nonnull} function attribute, to detect returning
5852 of null values from such functions.
5854 @item -fsanitize=bool
5855 @opindex fsanitize=bool
5857 This option enables instrumentation of loads from bool.  If a value other
5858 than 0/1 is loaded, a run-time error is issued.
5860 @item -fsanitize=enum
5861 @opindex fsanitize=enum
5863 This option enables instrumentation of loads from an enum type.  If
5864 a value outside the range of values for the enum type is loaded,
5865 a run-time error is issued.
5867 @item -fsanitize=vptr
5868 @opindex fsanitize=vptr
5870 This option enables instrumentation of C++ member function calls, member
5871 accesses and some conversions between pointers to base and derived classes,
5872 to verify the referenced object has the correct dynamic type.
5874 @end table
5876 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5877 @option{-fsanitize=undefined} gives a diagnostic message.
5878 This currently works only for the C family of languages.
5880 @item -fno-sanitize=all
5881 @opindex fno-sanitize=all
5883 This option disables all previously enabled sanitizers.
5884 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
5885 together.
5887 @item -fasan-shadow-offset=@var{number}
5888 @opindex fasan-shadow-offset
5889 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5890 It is useful for experimenting with different shadow memory layouts in
5891 Kernel AddressSanitizer.
5893 @item -fsanitize-sections=@var{s1,s2,...}
5894 @opindex fsanitize-sections
5895 Sanitize global variables in selected user-defined sections.  @var{si} may
5896 contain wildcards.
5898 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5899 @opindex fsanitize-recover
5900 @opindex fno-sanitize-recover
5901 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5902 mentioned in comma-separated list of @var{opts}.  Enabling this option
5903 for a sanitizer component causes it to attempt to continue
5904 running the program as if no error happened.  This means multiple
5905 runtime errors can be reported in a single program run, and the exit
5906 code of the program may indicate success even when errors
5907 have been reported.  The @option{-fno-sanitize-recover=} option
5908 can be used to alter
5909 this behavior: only the first detected error is reported
5910 and program then exits with a non-zero exit code.
5912 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5913 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5914 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5915 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5916 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
5917 accepted, the former enables recovery for all sanitizers that support it,
5918 the latter disables recovery for all sanitizers that support it.
5920 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5921 @smallexample
5922 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5923 @end smallexample
5924 @noindent
5925 Similarly @option{-fno-sanitize-recover} is equivalent to
5926 @smallexample
5927 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5928 @end smallexample
5930 @item -fsanitize-undefined-trap-on-error
5931 @opindex fsanitize-undefined-trap-on-error
5932 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
5933 report undefined behavior using @code{__builtin_trap} rather than
5934 a @code{libubsan} library routine.  The advantage of this is that the
5935 @code{libubsan} library is not needed and is not linked in, so this
5936 is usable even in freestanding environments.
5938 @item -fcheck-pointer-bounds
5939 @opindex fcheck-pointer-bounds
5940 @opindex fno-check-pointer-bounds
5941 @cindex Pointer Bounds Checker options
5942 Enable Pointer Bounds Checker instrumentation.  Each memory reference
5943 is instrumented with checks of the pointer used for memory access against
5944 bounds associated with that pointer.  
5946 Currently there
5947 is only an implementation for Intel MPX available, thus x86 target
5948 and @option{-mmpx} are required to enable this feature.  
5949 MPX-based instrumentation requires
5950 a runtime library to enable MPX in hardware and handle bounds
5951 violation signals.  By default when @option{-fcheck-pointer-bounds}
5952 and @option{-mmpx} options are used to link a program, the GCC driver
5953 links against the @file{libmpx} runtime library and @file{libmpxwrappers}
5954 library.  It also passes '-z bndplt' to a linker in case it supports this
5955 option (which is checked on libmpx configuration).  Note that old versions
5956 of linker may ignore option.  Gold linker doesn't support '-z bndplt'
5957 option.  With no '-z bndplt' support in linker all calls to dynamic libraries
5958 lose passed bounds reducing overall protection level.  It's highly
5959 recommended to use linker with '-z bndplt' support.  In case such linker
5960 is not available it is adviced to always use @option{-static-libmpxwrappers}
5961 for better protection level or use @option{-static} to completely avoid
5962 external calls to dynamic libraries.  MPX-based instrumentation
5963 may be used for debugging and also may be included in production code
5964 to increase program security.  Depending on usage, you may
5965 have different requirements for the runtime library.  The current version
5966 of the MPX runtime library is more oriented for use as a debugging
5967 tool.  MPX runtime library usage implies @option{-lpthread}.  See
5968 also @option{-static-libmpx}.  The runtime library  behavior can be
5969 influenced using various @env{CHKP_RT_*} environment variables.  See
5970 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
5971 for more details.
5973 Generated instrumentation may be controlled by various
5974 @option{-fchkp-*} options and by the @code{bnd_variable_size}
5975 structure field attribute (@pxref{Type Attributes}) and
5976 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
5977 (@pxref{Function Attributes}).  GCC also provides a number of built-in
5978 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
5979 Bounds Checker builtins}, for more information.
5981 @item -fchkp-check-incomplete-type
5982 @opindex fchkp-check-incomplete-type
5983 @opindex fno-chkp-check-incomplete-type
5984 Generate pointer bounds checks for variables with incomplete type.
5985 Enabled by default.
5987 @item -fchkp-narrow-bounds
5988 @opindex fchkp-narrow-bounds
5989 @opindex fno-chkp-narrow-bounds
5990 Controls bounds used by Pointer Bounds Checker for pointers to object
5991 fields.  If narrowing is enabled then field bounds are used.  Otherwise
5992 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
5993 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
5995 @item -fchkp-first-field-has-own-bounds
5996 @opindex fchkp-first-field-has-own-bounds
5997 @opindex fno-chkp-first-field-has-own-bounds
5998 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
5999 first field in the structure.  By default a pointer to the first field has
6000 the same bounds as a pointer to the whole structure.
6002 @item -fchkp-narrow-to-innermost-array
6003 @opindex fchkp-narrow-to-innermost-array
6004 @opindex fno-chkp-narrow-to-innermost-array
6005 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
6006 case of nested static array access.  By default this option is disabled and
6007 bounds of the outermost array are used.
6009 @item -fchkp-optimize
6010 @opindex fchkp-optimize
6011 @opindex fno-chkp-optimize
6012 Enables Pointer Bounds Checker optimizations.  Enabled by default at
6013 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
6015 @item -fchkp-use-fast-string-functions
6016 @opindex fchkp-use-fast-string-functions
6017 @opindex fno-chkp-use-fast-string-functions
6018 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
6019 by Pointer Bounds Checker.  Disabled by default.
6021 @item -fchkp-use-nochk-string-functions
6022 @opindex fchkp-use-nochk-string-functions
6023 @opindex fno-chkp-use-nochk-string-functions
6024 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
6025 by Pointer Bounds Checker.  Disabled by default.
6027 @item -fchkp-use-static-bounds
6028 @opindex fchkp-use-static-bounds
6029 @opindex fno-chkp-use-static-bounds
6030 Allow Pointer Bounds Checker to generate static bounds holding
6031 bounds of static variables.  Enabled by default.
6033 @item -fchkp-use-static-const-bounds
6034 @opindex fchkp-use-static-const-bounds
6035 @opindex fno-chkp-use-static-const-bounds
6036 Use statically-initialized bounds for constant bounds instead of
6037 generating them each time they are required.  By default enabled when
6038 @option{-fchkp-use-static-bounds} is enabled.
6040 @item -fchkp-treat-zero-dynamic-size-as-infinite
6041 @opindex fchkp-treat-zero-dynamic-size-as-infinite
6042 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
6043 With this option, objects with incomplete type whose
6044 dynamically-obtained size is zero are treated as having infinite size
6045 instead by Pointer Bounds
6046 Checker.  This option may be helpful if a program is linked with a library
6047 missing size information for some symbols.  Disabled by default.
6049 @item -fchkp-check-read
6050 @opindex fchkp-check-read
6051 @opindex fno-chkp-check-read
6052 Instructs Pointer Bounds Checker to generate checks for all read
6053 accesses to memory.  Enabled by default.
6055 @item -fchkp-check-write
6056 @opindex fchkp-check-write
6057 @opindex fno-chkp-check-write
6058 Instructs Pointer Bounds Checker to generate checks for all write
6059 accesses to memory.  Enabled by default.
6061 @item -fchkp-store-bounds
6062 @opindex fchkp-store-bounds
6063 @opindex fno-chkp-store-bounds
6064 Instructs Pointer Bounds Checker to generate bounds stores for
6065 pointer writes.  Enabled by default.
6067 @item -fchkp-instrument-calls
6068 @opindex fchkp-instrument-calls
6069 @opindex fno-chkp-instrument-calls
6070 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
6071 Enabled by default.
6073 @item -fchkp-instrument-marked-only
6074 @opindex fchkp-instrument-marked-only
6075 @opindex fno-chkp-instrument-marked-only
6076 Instructs Pointer Bounds Checker to instrument only functions
6077 marked with the @code{bnd_instrument} attribute
6078 (@pxref{Function Attributes}).  Disabled by default.
6080 @item -fchkp-use-wrappers
6081 @opindex fchkp-use-wrappers
6082 @opindex fno-chkp-use-wrappers
6083 Allows Pointer Bounds Checker to replace calls to built-in functions
6084 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
6085 is used to link a program, the GCC driver automatically links
6086 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
6087 Enabled by default.
6089 @item -fdump-final-insns@r{[}=@var{file}@r{]}
6090 @opindex fdump-final-insns
6091 Dump the final internal representation (RTL) to @var{file}.  If the
6092 optional argument is omitted (or if @var{file} is @code{.}), the name
6093 of the dump file is determined by appending @code{.gkd} to the
6094 compilation output file name.
6096 @item -fcompare-debug@r{[}=@var{opts}@r{]}
6097 @opindex fcompare-debug
6098 @opindex fno-compare-debug
6099 If no error occurs during compilation, run the compiler a second time,
6100 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
6101 passed to the second compilation.  Dump the final internal
6102 representation in both compilations, and print an error if they differ.
6104 If the equal sign is omitted, the default @option{-gtoggle} is used.
6106 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
6107 and nonzero, implicitly enables @option{-fcompare-debug}.  If
6108 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
6109 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
6110 is used.
6112 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
6113 is equivalent to @option{-fno-compare-debug}, which disables the dumping
6114 of the final representation and the second compilation, preventing even
6115 @env{GCC_COMPARE_DEBUG} from taking effect.
6117 To verify full coverage during @option{-fcompare-debug} testing, set
6118 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
6119 which GCC rejects as an invalid option in any actual compilation
6120 (rather than preprocessing, assembly or linking).  To get just a
6121 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
6122 not overridden} will do.
6124 @item -fcompare-debug-second
6125 @opindex fcompare-debug-second
6126 This option is implicitly passed to the compiler for the second
6127 compilation requested by @option{-fcompare-debug}, along with options to
6128 silence warnings, and omitting other options that would cause
6129 side-effect compiler outputs to files or to the standard output.  Dump
6130 files and preserved temporary files are renamed so as to contain the
6131 @code{.gk} additional extension during the second compilation, to avoid
6132 overwriting those generated by the first.
6134 When this option is passed to the compiler driver, it causes the
6135 @emph{first} compilation to be skipped, which makes it useful for little
6136 other than debugging the compiler proper.
6138 @item -feliminate-dwarf2-dups
6139 @opindex feliminate-dwarf2-dups
6140 Compress DWARF 2 debugging information by eliminating duplicated
6141 information about each symbol.  This option only makes sense when
6142 generating DWARF 2 debugging information with @option{-gdwarf-2}.
6144 @item -femit-struct-debug-baseonly
6145 @opindex femit-struct-debug-baseonly
6146 Emit debug information for struct-like types
6147 only when the base name of the compilation source file
6148 matches the base name of file in which the struct is defined.
6150 This option substantially reduces the size of debugging information,
6151 but at significant potential loss in type information to the debugger.
6152 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6153 See @option{-femit-struct-debug-detailed} for more detailed control.
6155 This option works only with DWARF 2.
6157 @item -femit-struct-debug-reduced
6158 @opindex femit-struct-debug-reduced
6159 Emit debug information for struct-like types
6160 only when the base name of the compilation source file
6161 matches the base name of file in which the type is defined,
6162 unless the struct is a template or defined in a system header.
6164 This option significantly reduces the size of debugging information,
6165 with some potential loss in type information to the debugger.
6166 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6167 See @option{-femit-struct-debug-detailed} for more detailed control.
6169 This option works only with DWARF 2.
6171 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6172 @opindex femit-struct-debug-detailed
6173 Specify the struct-like types
6174 for which the compiler generates debug information.
6175 The intent is to reduce duplicate struct debug information
6176 between different object files within the same program.
6178 This option is a detailed version of
6179 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6180 which serves for most needs.
6182 A specification has the syntax@*
6183 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6185 The optional first word limits the specification to
6186 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6187 A struct type is used directly when it is the type of a variable, member.
6188 Indirect uses arise through pointers to structs.
6189 That is, when use of an incomplete struct is valid, the use is indirect.
6190 An example is
6191 @samp{struct one direct; struct two * indirect;}.
6193 The optional second word limits the specification to
6194 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6195 Generic structs are a bit complicated to explain.
6196 For C++, these are non-explicit specializations of template classes,
6197 or non-template classes within the above.
6198 Other programming languages have generics,
6199 but @option{-femit-struct-debug-detailed} does not yet implement them.
6201 The third word specifies the source files for those
6202 structs for which the compiler should emit debug information.
6203 The values @samp{none} and @samp{any} have the normal meaning.
6204 The value @samp{base} means that
6205 the base of name of the file in which the type declaration appears
6206 must match the base of the name of the main compilation file.
6207 In practice, this means that when compiling @file{foo.c}, debug information
6208 is generated for types declared in that file and @file{foo.h},
6209 but not other header files.
6210 The value @samp{sys} means those types satisfying @samp{base}
6211 or declared in system or compiler headers.
6213 You may need to experiment to determine the best settings for your application.
6215 The default is @option{-femit-struct-debug-detailed=all}.
6217 This option works only with DWARF 2.
6219 @item -fno-merge-debug-strings
6220 @opindex fmerge-debug-strings
6221 @opindex fno-merge-debug-strings
6222 Direct the linker to not merge together strings in the debugging
6223 information that are identical in different object files.  Merging is
6224 not supported by all assemblers or linkers.  Merging decreases the size
6225 of the debug information in the output file at the cost of increasing
6226 link processing time.  Merging is enabled by default.
6228 @item -fdebug-prefix-map=@var{old}=@var{new}
6229 @opindex fdebug-prefix-map
6230 When compiling files in directory @file{@var{old}}, record debugging
6231 information describing them as in @file{@var{new}} instead.
6233 @item -fno-dwarf2-cfi-asm
6234 @opindex fdwarf2-cfi-asm
6235 @opindex fno-dwarf2-cfi-asm
6236 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
6237 instead of using GAS @code{.cfi_*} directives.
6239 @cindex @command{prof}
6240 @item -p
6241 @opindex p
6242 Generate extra code to write profile information suitable for the
6243 analysis program @command{prof}.  You must use this option when compiling
6244 the source files you want data about, and you must also use it when
6245 linking.
6247 @cindex @command{gprof}
6248 @item -pg
6249 @opindex pg
6250 Generate extra code to write profile information suitable for the
6251 analysis program @command{gprof}.  You must use this option when compiling
6252 the source files you want data about, and you must also use it when
6253 linking.
6255 @item -Q
6256 @opindex Q
6257 Makes the compiler print out each function name as it is compiled, and
6258 print some statistics about each pass when it finishes.
6260 @item -ftime-report
6261 @opindex ftime-report
6262 Makes the compiler print some statistics about the time consumed by each
6263 pass when it finishes.
6265 @item -fmem-report
6266 @opindex fmem-report
6267 Makes the compiler print some statistics about permanent memory
6268 allocation when it finishes.
6270 @item -fmem-report-wpa
6271 @opindex fmem-report-wpa
6272 Makes the compiler print some statistics about permanent memory
6273 allocation for the WPA phase only.
6275 @item -fpre-ipa-mem-report
6276 @opindex fpre-ipa-mem-report
6277 @item -fpost-ipa-mem-report
6278 @opindex fpost-ipa-mem-report
6279 Makes the compiler print some statistics about permanent memory
6280 allocation before or after interprocedural optimization.
6282 @item -fprofile-report
6283 @opindex fprofile-report
6284 Makes the compiler print some statistics about consistency of the
6285 (estimated) profile and effect of individual passes.
6287 @item -fstack-usage
6288 @opindex fstack-usage
6289 Makes the compiler output stack usage information for the program, on a
6290 per-function basis.  The filename for the dump is made by appending
6291 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
6292 the output file, if explicitly specified and it is not an executable,
6293 otherwise it is the basename of the source file.  An entry is made up
6294 of three fields:
6296 @itemize
6297 @item
6298 The name of the function.
6299 @item
6300 A number of bytes.
6301 @item
6302 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
6303 @end itemize
6305 The qualifier @code{static} means that the function manipulates the stack
6306 statically: a fixed number of bytes are allocated for the frame on function
6307 entry and released on function exit; no stack adjustments are otherwise made
6308 in the function.  The second field is this fixed number of bytes.
6310 The qualifier @code{dynamic} means that the function manipulates the stack
6311 dynamically: in addition to the static allocation described above, stack
6312 adjustments are made in the body of the function, for example to push/pop
6313 arguments around function calls.  If the qualifier @code{bounded} is also
6314 present, the amount of these adjustments is bounded at compile time and
6315 the second field is an upper bound of the total amount of stack used by
6316 the function.  If it is not present, the amount of these adjustments is
6317 not bounded at compile time and the second field only represents the
6318 bounded part.
6320 @item -fprofile-arcs
6321 @opindex fprofile-arcs
6322 Add code so that program flow @dfn{arcs} are instrumented.  During
6323 execution the program records how many times each branch and call is
6324 executed and how many times it is taken or returns.  When the compiled
6325 program exits it saves this data to a file called
6326 @file{@var{auxname}.gcda} for each source file.  The data may be used for
6327 profile-directed optimizations (@option{-fbranch-probabilities}), or for
6328 test coverage analysis (@option{-ftest-coverage}).  Each object file's
6329 @var{auxname} is generated from the name of the output file, if
6330 explicitly specified and it is not the final executable, otherwise it is
6331 the basename of the source file.  In both cases any suffix is removed
6332 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
6333 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
6334 @xref{Cross-profiling}.
6336 @cindex @command{gcov}
6337 @item --coverage
6338 @opindex coverage
6340 This option is used to compile and link code instrumented for coverage
6341 analysis.  The option is a synonym for @option{-fprofile-arcs}
6342 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6343 linking).  See the documentation for those options for more details.
6345 @itemize
6347 @item
6348 Compile the source files with @option{-fprofile-arcs} plus optimization
6349 and code generation options.  For test coverage analysis, use the
6350 additional @option{-ftest-coverage} option.  You do not need to profile
6351 every source file in a program.
6353 @item
6354 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6355 (the latter implies the former).
6357 @item
6358 Run the program on a representative workload to generate the arc profile
6359 information.  This may be repeated any number of times.  You can run
6360 concurrent instances of your program, and provided that the file system
6361 supports locking, the data files will be correctly updated.  Also
6362 @code{fork} calls are detected and correctly handled (double counting
6363 will not happen).
6365 @item
6366 For profile-directed optimizations, compile the source files again with
6367 the same optimization and code generation options plus
6368 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6369 Control Optimization}).
6371 @item
6372 For test coverage analysis, use @command{gcov} to produce human readable
6373 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6374 @command{gcov} documentation for further information.
6376 @end itemize
6378 With @option{-fprofile-arcs}, for each function of your program GCC
6379 creates a program flow graph, then finds a spanning tree for the graph.
6380 Only arcs that are not on the spanning tree have to be instrumented: the
6381 compiler adds code to count the number of times that these arcs are
6382 executed.  When an arc is the only exit or only entrance to a block, the
6383 instrumentation code can be added to the block; otherwise, a new basic
6384 block must be created to hold the instrumentation code.
6386 @need 2000
6387 @item -ftest-coverage
6388 @opindex ftest-coverage
6389 Produce a notes file that the @command{gcov} code-coverage utility
6390 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6391 show program coverage.  Each source file's note file is called
6392 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6393 above for a description of @var{auxname} and instructions on how to
6394 generate test coverage data.  Coverage data matches the source files
6395 more closely if you do not optimize.
6397 @item -fdbg-cnt-list
6398 @opindex fdbg-cnt-list
6399 Print the name and the counter upper bound for all debug counters.
6402 @item -fdbg-cnt=@var{counter-value-list}
6403 @opindex fdbg-cnt
6404 Set the internal debug counter upper bound.  @var{counter-value-list}
6405 is a comma-separated list of @var{name}:@var{value} pairs
6406 which sets the upper bound of each debug counter @var{name} to @var{value}.
6407 All debug counters have the initial upper bound of @code{UINT_MAX};
6408 thus @code{dbg_cnt} returns true always unless the upper bound
6409 is set by this option.
6410 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6411 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6413 @item -fenable-@var{kind}-@var{pass}
6414 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6415 @opindex fdisable-
6416 @opindex fenable-
6418 This is a set of options that are used to explicitly disable/enable
6419 optimization passes.  These options are intended for use for debugging GCC.
6420 Compiler users should use regular options for enabling/disabling
6421 passes instead.
6423 @table @gcctabopt
6425 @item -fdisable-ipa-@var{pass}
6426 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6427 statically invoked in the compiler multiple times, the pass name should be
6428 appended with a sequential number starting from 1.
6430 @item -fdisable-rtl-@var{pass}
6431 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6432 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6433 statically invoked in the compiler multiple times, the pass name should be
6434 appended with a sequential number starting from 1.  @var{range-list} is a 
6435 comma-separated list of function ranges or assembler names.  Each range is a number
6436 pair separated by a colon.  The range is inclusive in both ends.  If the range
6437 is trivial, the number pair can be simplified as a single number.  If the
6438 function's call graph node's @var{uid} falls within one of the specified ranges,
6439 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6440 function header of a dump file, and the pass names can be dumped by using
6441 option @option{-fdump-passes}.
6443 @item -fdisable-tree-@var{pass}
6444 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6445 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6446 option arguments.
6448 @item -fenable-ipa-@var{pass}
6449 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6450 statically invoked in the compiler multiple times, the pass name should be
6451 appended with a sequential number starting from 1.
6453 @item -fenable-rtl-@var{pass}
6454 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6455 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6456 description and examples.
6458 @item -fenable-tree-@var{pass}
6459 @itemx -fenable-tree-@var{pass}=@var{range-list}
6460 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6461 of option arguments.
6463 @end table
6465 Here are some examples showing uses of these options.
6467 @smallexample
6469 # disable ccp1 for all functions
6470    -fdisable-tree-ccp1
6471 # disable complete unroll for function whose cgraph node uid is 1
6472    -fenable-tree-cunroll=1
6473 # disable gcse2 for functions at the following ranges [1,1],
6474 # [300,400], and [400,1000]
6475 # disable gcse2 for functions foo and foo2
6476    -fdisable-rtl-gcse2=foo,foo2
6477 # disable early inlining
6478    -fdisable-tree-einline
6479 # disable ipa inlining
6480    -fdisable-ipa-inline
6481 # enable tree full unroll
6482    -fenable-tree-unroll
6484 @end smallexample
6486 @item -d@var{letters}
6487 @itemx -fdump-rtl-@var{pass}
6488 @itemx -fdump-rtl-@var{pass}=@var{filename}
6489 @opindex d
6490 @opindex fdump-rtl-@var{pass}
6491 Says to make debugging dumps during compilation at times specified by
6492 @var{letters}.  This is used for debugging the RTL-based passes of the
6493 compiler.  The file names for most of the dumps are made by appending
6494 a pass number and a word to the @var{dumpname}, and the files are
6495 created in the directory of the output file. In case of
6496 @option{=@var{filename}} option, the dump is output on the given file
6497 instead of the pass numbered dump files. Note that the pass number is
6498 computed statically as passes get registered into the pass manager.
6499 Thus the numbering is not related to the dynamic order of execution of
6500 passes.  In particular, a pass installed by a plugin could have a
6501 number over 200 even if it executed quite early.  @var{dumpname} is
6502 generated from the name of the output file, if explicitly specified
6503 and it is not an executable, otherwise it is the basename of the
6504 source file. These switches may have different effects when
6505 @option{-E} is used for preprocessing.
6507 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6508 @option{-d} option @var{letters}.  Here are the possible
6509 letters for use in @var{pass} and @var{letters}, and their meanings:
6511 @table @gcctabopt
6513 @item -fdump-rtl-alignments
6514 @opindex fdump-rtl-alignments
6515 Dump after branch alignments have been computed.
6517 @item -fdump-rtl-asmcons
6518 @opindex fdump-rtl-asmcons
6519 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6521 @item -fdump-rtl-auto_inc_dec
6522 @opindex fdump-rtl-auto_inc_dec
6523 Dump after auto-inc-dec discovery.  This pass is only run on
6524 architectures that have auto inc or auto dec instructions.
6526 @item -fdump-rtl-barriers
6527 @opindex fdump-rtl-barriers
6528 Dump after cleaning up the barrier instructions.
6530 @item -fdump-rtl-bbpart
6531 @opindex fdump-rtl-bbpart
6532 Dump after partitioning hot and cold basic blocks.
6534 @item -fdump-rtl-bbro
6535 @opindex fdump-rtl-bbro
6536 Dump after block reordering.
6538 @item -fdump-rtl-btl1
6539 @itemx -fdump-rtl-btl2
6540 @opindex fdump-rtl-btl2
6541 @opindex fdump-rtl-btl2
6542 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6543 after the two branch
6544 target load optimization passes.
6546 @item -fdump-rtl-bypass
6547 @opindex fdump-rtl-bypass
6548 Dump after jump bypassing and control flow optimizations.
6550 @item -fdump-rtl-combine
6551 @opindex fdump-rtl-combine
6552 Dump after the RTL instruction combination pass.
6554 @item -fdump-rtl-compgotos
6555 @opindex fdump-rtl-compgotos
6556 Dump after duplicating the computed gotos.
6558 @item -fdump-rtl-ce1
6559 @itemx -fdump-rtl-ce2
6560 @itemx -fdump-rtl-ce3
6561 @opindex fdump-rtl-ce1
6562 @opindex fdump-rtl-ce2
6563 @opindex fdump-rtl-ce3
6564 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6565 @option{-fdump-rtl-ce3} enable dumping after the three
6566 if conversion passes.
6568 @item -fdump-rtl-cprop_hardreg
6569 @opindex fdump-rtl-cprop_hardreg
6570 Dump after hard register copy propagation.
6572 @item -fdump-rtl-csa
6573 @opindex fdump-rtl-csa
6574 Dump after combining stack adjustments.
6576 @item -fdump-rtl-cse1
6577 @itemx -fdump-rtl-cse2
6578 @opindex fdump-rtl-cse1
6579 @opindex fdump-rtl-cse2
6580 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6581 the two common subexpression elimination passes.
6583 @item -fdump-rtl-dce
6584 @opindex fdump-rtl-dce
6585 Dump after the standalone dead code elimination passes.
6587 @item -fdump-rtl-dbr
6588 @opindex fdump-rtl-dbr
6589 Dump after delayed branch scheduling.
6591 @item -fdump-rtl-dce1
6592 @itemx -fdump-rtl-dce2
6593 @opindex fdump-rtl-dce1
6594 @opindex fdump-rtl-dce2
6595 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6596 the two dead store elimination passes.
6598 @item -fdump-rtl-eh
6599 @opindex fdump-rtl-eh
6600 Dump after finalization of EH handling code.
6602 @item -fdump-rtl-eh_ranges
6603 @opindex fdump-rtl-eh_ranges
6604 Dump after conversion of EH handling range regions.
6606 @item -fdump-rtl-expand
6607 @opindex fdump-rtl-expand
6608 Dump after RTL generation.
6610 @item -fdump-rtl-fwprop1
6611 @itemx -fdump-rtl-fwprop2
6612 @opindex fdump-rtl-fwprop1
6613 @opindex fdump-rtl-fwprop2
6614 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6615 dumping after the two forward propagation passes.
6617 @item -fdump-rtl-gcse1
6618 @itemx -fdump-rtl-gcse2
6619 @opindex fdump-rtl-gcse1
6620 @opindex fdump-rtl-gcse2
6621 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6622 after global common subexpression elimination.
6624 @item -fdump-rtl-init-regs
6625 @opindex fdump-rtl-init-regs
6626 Dump after the initialization of the registers.
6628 @item -fdump-rtl-initvals
6629 @opindex fdump-rtl-initvals
6630 Dump after the computation of the initial value sets.
6632 @item -fdump-rtl-into_cfglayout
6633 @opindex fdump-rtl-into_cfglayout
6634 Dump after converting to cfglayout mode.
6636 @item -fdump-rtl-ira
6637 @opindex fdump-rtl-ira
6638 Dump after iterated register allocation.
6640 @item -fdump-rtl-jump
6641 @opindex fdump-rtl-jump
6642 Dump after the second jump optimization.
6644 @item -fdump-rtl-loop2
6645 @opindex fdump-rtl-loop2
6646 @option{-fdump-rtl-loop2} enables dumping after the rtl
6647 loop optimization passes.
6649 @item -fdump-rtl-mach
6650 @opindex fdump-rtl-mach
6651 Dump after performing the machine dependent reorganization pass, if that
6652 pass exists.
6654 @item -fdump-rtl-mode_sw
6655 @opindex fdump-rtl-mode_sw
6656 Dump after removing redundant mode switches.
6658 @item -fdump-rtl-rnreg
6659 @opindex fdump-rtl-rnreg
6660 Dump after register renumbering.
6662 @item -fdump-rtl-outof_cfglayout
6663 @opindex fdump-rtl-outof_cfglayout
6664 Dump after converting from cfglayout mode.
6666 @item -fdump-rtl-peephole2
6667 @opindex fdump-rtl-peephole2
6668 Dump after the peephole pass.
6670 @item -fdump-rtl-postreload
6671 @opindex fdump-rtl-postreload
6672 Dump after post-reload optimizations.
6674 @item -fdump-rtl-pro_and_epilogue
6675 @opindex fdump-rtl-pro_and_epilogue
6676 Dump after generating the function prologues and epilogues.
6678 @item -fdump-rtl-sched1
6679 @itemx -fdump-rtl-sched2
6680 @opindex fdump-rtl-sched1
6681 @opindex fdump-rtl-sched2
6682 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6683 after the basic block scheduling passes.
6685 @item -fdump-rtl-ree
6686 @opindex fdump-rtl-ree
6687 Dump after sign/zero extension elimination.
6689 @item -fdump-rtl-seqabstr
6690 @opindex fdump-rtl-seqabstr
6691 Dump after common sequence discovery.
6693 @item -fdump-rtl-shorten
6694 @opindex fdump-rtl-shorten
6695 Dump after shortening branches.
6697 @item -fdump-rtl-sibling
6698 @opindex fdump-rtl-sibling
6699 Dump after sibling call optimizations.
6701 @item -fdump-rtl-split1
6702 @itemx -fdump-rtl-split2
6703 @itemx -fdump-rtl-split3
6704 @itemx -fdump-rtl-split4
6705 @itemx -fdump-rtl-split5
6706 @opindex fdump-rtl-split1
6707 @opindex fdump-rtl-split2
6708 @opindex fdump-rtl-split3
6709 @opindex fdump-rtl-split4
6710 @opindex fdump-rtl-split5
6711 These options enable dumping after five rounds of
6712 instruction splitting.
6714 @item -fdump-rtl-sms
6715 @opindex fdump-rtl-sms
6716 Dump after modulo scheduling.  This pass is only run on some
6717 architectures.
6719 @item -fdump-rtl-stack
6720 @opindex fdump-rtl-stack
6721 Dump after conversion from GCC's ``flat register file'' registers to the
6722 x87's stack-like registers.  This pass is only run on x86 variants.
6724 @item -fdump-rtl-subreg1
6725 @itemx -fdump-rtl-subreg2
6726 @opindex fdump-rtl-subreg1
6727 @opindex fdump-rtl-subreg2
6728 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6729 the two subreg expansion passes.
6731 @item -fdump-rtl-unshare
6732 @opindex fdump-rtl-unshare
6733 Dump after all rtl has been unshared.
6735 @item -fdump-rtl-vartrack
6736 @opindex fdump-rtl-vartrack
6737 Dump after variable tracking.
6739 @item -fdump-rtl-vregs
6740 @opindex fdump-rtl-vregs
6741 Dump after converting virtual registers to hard registers.
6743 @item -fdump-rtl-web
6744 @opindex fdump-rtl-web
6745 Dump after live range splitting.
6747 @item -fdump-rtl-regclass
6748 @itemx -fdump-rtl-subregs_of_mode_init
6749 @itemx -fdump-rtl-subregs_of_mode_finish
6750 @itemx -fdump-rtl-dfinit
6751 @itemx -fdump-rtl-dfinish
6752 @opindex fdump-rtl-regclass
6753 @opindex fdump-rtl-subregs_of_mode_init
6754 @opindex fdump-rtl-subregs_of_mode_finish
6755 @opindex fdump-rtl-dfinit
6756 @opindex fdump-rtl-dfinish
6757 These dumps are defined but always produce empty files.
6759 @item -da
6760 @itemx -fdump-rtl-all
6761 @opindex da
6762 @opindex fdump-rtl-all
6763 Produce all the dumps listed above.
6765 @item -dA
6766 @opindex dA
6767 Annotate the assembler output with miscellaneous debugging information.
6769 @item -dD
6770 @opindex dD
6771 Dump all macro definitions, at the end of preprocessing, in addition to
6772 normal output.
6774 @item -dH
6775 @opindex dH
6776 Produce a core dump whenever an error occurs.
6778 @item -dp
6779 @opindex dp
6780 Annotate the assembler output with a comment indicating which
6781 pattern and alternative is used.  The length of each instruction is
6782 also printed.
6784 @item -dP
6785 @opindex dP
6786 Dump the RTL in the assembler output as a comment before each instruction.
6787 Also turns on @option{-dp} annotation.
6789 @item -dx
6790 @opindex dx
6791 Just generate RTL for a function instead of compiling it.  Usually used
6792 with @option{-fdump-rtl-expand}.
6793 @end table
6795 @item -fdump-noaddr
6796 @opindex fdump-noaddr
6797 When doing debugging dumps, suppress address output.  This makes it more
6798 feasible to use diff on debugging dumps for compiler invocations with
6799 different compiler binaries and/or different
6800 text / bss / data / heap / stack / dso start locations.
6802 @item -freport-bug
6803 @opindex freport-bug
6804 Collect and dump debug information into temporary file if ICE in C/C++
6805 compiler occured.
6807 @item -fdump-unnumbered
6808 @opindex fdump-unnumbered
6809 When doing debugging dumps, suppress instruction numbers and address output.
6810 This makes it more feasible to use diff on debugging dumps for compiler
6811 invocations with different options, in particular with and without
6812 @option{-g}.
6814 @item -fdump-unnumbered-links
6815 @opindex fdump-unnumbered-links
6816 When doing debugging dumps (see @option{-d} option above), suppress
6817 instruction numbers for the links to the previous and next instructions
6818 in a sequence.
6820 @item -fdump-translation-unit @r{(C++ only)}
6821 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6822 @opindex fdump-translation-unit
6823 Dump a representation of the tree structure for the entire translation
6824 unit to a file.  The file name is made by appending @file{.tu} to the
6825 source file name, and the file is created in the same directory as the
6826 output file.  If the @samp{-@var{options}} form is used, @var{options}
6827 controls the details of the dump as described for the
6828 @option{-fdump-tree} options.
6830 @item -fdump-class-hierarchy @r{(C++ only)}
6831 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6832 @opindex fdump-class-hierarchy
6833 Dump a representation of each class's hierarchy and virtual function
6834 table layout to a file.  The file name is made by appending
6835 @file{.class} to the source file name, and the file is created in the
6836 same directory as the output file.  If the @samp{-@var{options}} form
6837 is used, @var{options} controls the details of the dump as described
6838 for the @option{-fdump-tree} options.
6840 @item -fdump-ipa-@var{switch}
6841 @opindex fdump-ipa
6842 Control the dumping at various stages of inter-procedural analysis
6843 language tree to a file.  The file name is generated by appending a
6844 switch specific suffix to the source file name, and the file is created
6845 in the same directory as the output file.  The following dumps are
6846 possible:
6848 @table @samp
6849 @item all
6850 Enables all inter-procedural analysis dumps.
6852 @item cgraph
6853 Dumps information about call-graph optimization, unused function removal,
6854 and inlining decisions.
6856 @item inline
6857 Dump after function inlining.
6859 @end table
6861 @item -fdump-passes
6862 @opindex fdump-passes
6863 Dump the list of optimization passes that are turned on and off by
6864 the current command-line options.
6866 @item -fdump-statistics-@var{option}
6867 @opindex fdump-statistics
6868 Enable and control dumping of pass statistics in a separate file.  The
6869 file name is generated by appending a suffix ending in
6870 @samp{.statistics} to the source file name, and the file is created in
6871 the same directory as the output file.  If the @samp{-@var{option}}
6872 form is used, @samp{-stats} causes counters to be summed over the
6873 whole compilation unit while @samp{-details} dumps every event as
6874 the passes generate them.  The default with no option is to sum
6875 counters for each function compiled.
6877 @item -fdump-tree-@var{switch}
6878 @itemx -fdump-tree-@var{switch}-@var{options}
6879 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6880 @opindex fdump-tree
6881 Control the dumping at various stages of processing the intermediate
6882 language tree to a file.  The file name is generated by appending a
6883 switch-specific suffix to the source file name, and the file is
6884 created in the same directory as the output file. In case of
6885 @option{=@var{filename}} option, the dump is output on the given file
6886 instead of the auto named dump files.  If the @samp{-@var{options}}
6887 form is used, @var{options} is a list of @samp{-} separated options
6888 which control the details of the dump.  Not all options are applicable
6889 to all dumps; those that are not meaningful are ignored.  The
6890 following options are available
6892 @table @samp
6893 @item address
6894 Print the address of each node.  Usually this is not meaningful as it
6895 changes according to the environment and source file.  Its primary use
6896 is for tying up a dump file with a debug environment.
6897 @item asmname
6898 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6899 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6900 use working backward from mangled names in the assembly file.
6901 @item slim
6902 When dumping front-end intermediate representations, inhibit dumping
6903 of members of a scope or body of a function merely because that scope
6904 has been reached.  Only dump such items when they are directly reachable
6905 by some other path.
6907 When dumping pretty-printed trees, this option inhibits dumping the
6908 bodies of control structures.
6910 When dumping RTL, print the RTL in slim (condensed) form instead of
6911 the default LISP-like representation.
6912 @item raw
6913 Print a raw representation of the tree.  By default, trees are
6914 pretty-printed into a C-like representation.
6915 @item details
6916 Enable more detailed dumps (not honored by every dump option). Also
6917 include information from the optimization passes.
6918 @item stats
6919 Enable dumping various statistics about the pass (not honored by every dump
6920 option).
6921 @item blocks
6922 Enable showing basic block boundaries (disabled in raw dumps).
6923 @item graph
6924 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6925 dump a representation of the control flow graph suitable for viewing with
6926 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6927 the file is pretty-printed as a subgraph, so that GraphViz can render them
6928 all in a single plot.
6930 This option currently only works for RTL dumps, and the RTL is always
6931 dumped in slim form.
6932 @item vops
6933 Enable showing virtual operands for every statement.
6934 @item lineno
6935 Enable showing line numbers for statements.
6936 @item uid
6937 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6938 @item verbose
6939 Enable showing the tree dump for each statement.
6940 @item eh
6941 Enable showing the EH region number holding each statement.
6942 @item scev
6943 Enable showing scalar evolution analysis details.
6944 @item optimized
6945 Enable showing optimization information (only available in certain
6946 passes).
6947 @item missed
6948 Enable showing missed optimization information (only available in certain
6949 passes).
6950 @item note
6951 Enable other detailed optimization information (only available in
6952 certain passes).
6953 @item =@var{filename}
6954 Instead of an auto named dump file, output into the given file
6955 name. The file names @file{stdout} and @file{stderr} are treated
6956 specially and are considered already open standard streams. For
6957 example,
6959 @smallexample
6960 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6961      -fdump-tree-pre=stderr file.c
6962 @end smallexample
6964 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6965 output on to @file{stderr}. If two conflicting dump filenames are
6966 given for the same pass, then the latter option overrides the earlier
6967 one.
6969 @item all
6970 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6971 and @option{lineno}.
6973 @item optall
6974 Turn on all optimization options, i.e., @option{optimized},
6975 @option{missed}, and @option{note}.
6976 @end table
6978 The following tree dumps are possible:
6979 @table @samp
6981 @item original
6982 @opindex fdump-tree-original
6983 Dump before any tree based optimization, to @file{@var{file}.original}.
6985 @item optimized
6986 @opindex fdump-tree-optimized
6987 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6989 @item gimple
6990 @opindex fdump-tree-gimple
6991 Dump each function before and after the gimplification pass to a file.  The
6992 file name is made by appending @file{.gimple} to the source file name.
6994 @item cfg
6995 @opindex fdump-tree-cfg
6996 Dump the control flow graph of each function to a file.  The file name is
6997 made by appending @file{.cfg} to the source file name.
6999 @item ch
7000 @opindex fdump-tree-ch
7001 Dump each function after copying loop headers.  The file name is made by
7002 appending @file{.ch} to the source file name.
7004 @item ssa
7005 @opindex fdump-tree-ssa
7006 Dump SSA related information to a file.  The file name is made by appending
7007 @file{.ssa} to the source file name.
7009 @item alias
7010 @opindex fdump-tree-alias
7011 Dump aliasing information for each function.  The file name is made by
7012 appending @file{.alias} to the source file name.
7014 @item ccp
7015 @opindex fdump-tree-ccp
7016 Dump each function after CCP@.  The file name is made by appending
7017 @file{.ccp} to the source file name.
7019 @item storeccp
7020 @opindex fdump-tree-storeccp
7021 Dump each function after STORE-CCP@.  The file name is made by appending
7022 @file{.storeccp} to the source file name.
7024 @item pre
7025 @opindex fdump-tree-pre
7026 Dump trees after partial redundancy elimination.  The file name is made
7027 by appending @file{.pre} to the source file name.
7029 @item fre
7030 @opindex fdump-tree-fre
7031 Dump trees after full redundancy elimination.  The file name is made
7032 by appending @file{.fre} to the source file name.
7034 @item copyprop
7035 @opindex fdump-tree-copyprop
7036 Dump trees after copy propagation.  The file name is made
7037 by appending @file{.copyprop} to the source file name.
7039 @item store_copyprop
7040 @opindex fdump-tree-store_copyprop
7041 Dump trees after store copy-propagation.  The file name is made
7042 by appending @file{.store_copyprop} to the source file name.
7044 @item dce
7045 @opindex fdump-tree-dce
7046 Dump each function after dead code elimination.  The file name is made by
7047 appending @file{.dce} to the source file name.
7049 @item sra
7050 @opindex fdump-tree-sra
7051 Dump each function after performing scalar replacement of aggregates.  The
7052 file name is made by appending @file{.sra} to the source file name.
7054 @item sink
7055 @opindex fdump-tree-sink
7056 Dump each function after performing code sinking.  The file name is made
7057 by appending @file{.sink} to the source file name.
7059 @item dom
7060 @opindex fdump-tree-dom
7061 Dump each function after applying dominator tree optimizations.  The file
7062 name is made by appending @file{.dom} to the source file name.
7064 @item dse
7065 @opindex fdump-tree-dse
7066 Dump each function after applying dead store elimination.  The file
7067 name is made by appending @file{.dse} to the source file name.
7069 @item phiopt
7070 @opindex fdump-tree-phiopt
7071 Dump each function after optimizing PHI nodes into straightline code.  The file
7072 name is made by appending @file{.phiopt} to the source file name.
7074 @item forwprop
7075 @opindex fdump-tree-forwprop
7076 Dump each function after forward propagating single use variables.  The file
7077 name is made by appending @file{.forwprop} to the source file name.
7079 @item copyrename
7080 @opindex fdump-tree-copyrename
7081 Dump each function after applying the copy rename optimization.  The file
7082 name is made by appending @file{.copyrename} to the source file name.
7084 @item nrv
7085 @opindex fdump-tree-nrv
7086 Dump each function after applying the named return value optimization on
7087 generic trees.  The file name is made by appending @file{.nrv} to the source
7088 file name.
7090 @item vect
7091 @opindex fdump-tree-vect
7092 Dump each function after applying vectorization of loops.  The file name is
7093 made by appending @file{.vect} to the source file name.
7095 @item slp
7096 @opindex fdump-tree-slp
7097 Dump each function after applying vectorization of basic blocks.  The file name
7098 is made by appending @file{.slp} to the source file name.
7100 @item vrp
7101 @opindex fdump-tree-vrp
7102 Dump each function after Value Range Propagation (VRP).  The file name
7103 is made by appending @file{.vrp} to the source file name.
7105 @item all
7106 @opindex fdump-tree-all
7107 Enable all the available tree dumps with the flags provided in this option.
7108 @end table
7110 @item -fopt-info
7111 @itemx -fopt-info-@var{options}
7112 @itemx -fopt-info-@var{options}=@var{filename}
7113 @opindex fopt-info
7114 Controls optimization dumps from various optimization passes. If the
7115 @samp{-@var{options}} form is used, @var{options} is a list of
7116 @samp{-} separated option keywords to select the dump details and
7117 optimizations.  
7119 The @var{options} can be divided into two groups: options describing the
7120 verbosity of the dump, and options describing which optimizations
7121 should be included. The options from both the groups can be freely
7122 mixed as they are non-overlapping. However, in case of any conflicts,
7123 the later options override the earlier options on the command
7124 line. 
7126 The following options control the dump verbosity:
7128 @table @samp
7129 @item optimized
7130 Print information when an optimization is successfully applied. It is
7131 up to a pass to decide which information is relevant. For example, the
7132 vectorizer passes print the source location of loops which are
7133 successfully vectorized.
7134 @item missed
7135 Print information about missed optimizations. Individual passes
7136 control which information to include in the output. 
7137 @item note
7138 Print verbose information about optimizations, such as certain
7139 transformations, more detailed messages about decisions etc.
7140 @item all
7141 Print detailed optimization information. This includes
7142 @samp{optimized}, @samp{missed}, and @samp{note}.
7143 @end table
7145 One or more of the following option keywords can be used to describe a
7146 group of optimizations:
7148 @table @samp
7149 @item ipa
7150 Enable dumps from all interprocedural optimizations.
7151 @item loop
7152 Enable dumps from all loop optimizations.
7153 @item inline
7154 Enable dumps from all inlining optimizations.
7155 @item vec
7156 Enable dumps from all vectorization optimizations.
7157 @item optall
7158 Enable dumps from all optimizations. This is a superset of
7159 the optimization groups listed above.
7160 @end table
7162 If @var{options} is
7163 omitted, it defaults to @samp{optimized-optall}, which means to dump all
7164 info about successful optimizations from all the passes.  
7166 If the @var{filename} is provided, then the dumps from all the
7167 applicable optimizations are concatenated into the @var{filename}.
7168 Otherwise the dump is output onto @file{stderr}. Though multiple
7169 @option{-fopt-info} options are accepted, only one of them can include
7170 a @var{filename}. If other filenames are provided then all but the
7171 first such option are ignored.
7173 Note that the output @var{filename} is overwritten
7174 in case of multiple translation units. If a combined output from
7175 multiple translation units is desired, @file{stderr} should be used
7176 instead.
7178 In the following example, the optimization info is output to
7179 @file{stderr}:
7181 @smallexample
7182 gcc -O3 -fopt-info
7183 @end smallexample
7185 This example:
7186 @smallexample
7187 gcc -O3 -fopt-info-missed=missed.all
7188 @end smallexample
7190 @noindent
7191 outputs missed optimization report from all the passes into
7192 @file{missed.all}, and this one:
7194 @smallexample
7195 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
7196 @end smallexample
7198 @noindent
7199 prints information about missed optimization opportunities from
7200 vectorization passes on @file{stderr}.  
7201 Note that @option{-fopt-info-vec-missed} is equivalent to 
7202 @option{-fopt-info-missed-vec}.
7204 As another example,
7205 @smallexample
7206 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
7207 @end smallexample
7209 @noindent
7210 outputs information about missed optimizations as well as
7211 optimized locations from all the inlining passes into
7212 @file{inline.txt}.
7214 Finally, consider:
7216 @smallexample
7217 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
7218 @end smallexample
7220 @noindent
7221 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
7222 in conflict since only one output file is allowed. In this case, only
7223 the first option takes effect and the subsequent options are
7224 ignored. Thus only @file{vec.miss} is produced which contains
7225 dumps from the vectorizer about missed opportunities.
7227 @item -frandom-seed=@var{number}
7228 @opindex frandom-seed
7229 This option provides a seed that GCC uses in place of
7230 random numbers in generating certain symbol names
7231 that have to be different in every compiled file.  It is also used to
7232 place unique stamps in coverage data files and the object files that
7233 produce them.  You can use the @option{-frandom-seed} option to produce
7234 reproducibly identical object files.
7236 The @var{number} should be different for every file you compile.
7238 @item -fsched-verbose=@var{n}
7239 @opindex fsched-verbose
7240 On targets that use instruction scheduling, this option controls the
7241 amount of debugging output the scheduler prints.  This information is
7242 written to standard error, unless @option{-fdump-rtl-sched1} or
7243 @option{-fdump-rtl-sched2} is specified, in which case it is output
7244 to the usual dump listing file, @file{.sched1} or @file{.sched2}
7245 respectively.  However for @var{n} greater than nine, the output is
7246 always printed to standard error.
7248 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
7249 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
7250 For @var{n} greater than one, it also output basic block probabilities,
7251 detailed ready list information and unit/insn info.  For @var{n} greater
7252 than two, it includes RTL at abort point, control-flow and regions info.
7253 And for @var{n} over four, @option{-fsched-verbose} also includes
7254 dependence info.
7256 @item -save-temps
7257 @itemx -save-temps=cwd
7258 @opindex save-temps
7259 Store the usual ``temporary'' intermediate files permanently; place them
7260 in the current directory and name them based on the source file.  Thus,
7261 compiling @file{foo.c} with @option{-c -save-temps} produces files
7262 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
7263 preprocessed @file{foo.i} output file even though the compiler now
7264 normally uses an integrated preprocessor.
7266 When used in combination with the @option{-x} command-line option,
7267 @option{-save-temps} is sensible enough to avoid over writing an
7268 input source file with the same extension as an intermediate file.
7269 The corresponding intermediate file may be obtained by renaming the
7270 source file before using @option{-save-temps}.
7272 If you invoke GCC in parallel, compiling several different source
7273 files that share a common base name in different subdirectories or the
7274 same source file compiled for multiple output destinations, it is
7275 likely that the different parallel compilers will interfere with each
7276 other, and overwrite the temporary files.  For instance:
7278 @smallexample
7279 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
7280 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
7281 @end smallexample
7283 may result in @file{foo.i} and @file{foo.o} being written to
7284 simultaneously by both compilers.
7286 @item -save-temps=obj
7287 @opindex save-temps=obj
7288 Store the usual ``temporary'' intermediate files permanently.  If the
7289 @option{-o} option is used, the temporary files are based on the
7290 object file.  If the @option{-o} option is not used, the
7291 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
7293 For example:
7295 @smallexample
7296 gcc -save-temps=obj -c foo.c
7297 gcc -save-temps=obj -c bar.c -o dir/xbar.o
7298 gcc -save-temps=obj foobar.c -o dir2/yfoobar
7299 @end smallexample
7301 @noindent
7302 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
7303 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
7304 @file{dir2/yfoobar.o}.
7306 @item -time@r{[}=@var{file}@r{]}
7307 @opindex time
7308 Report the CPU time taken by each subprocess in the compilation
7309 sequence.  For C source files, this is the compiler proper and assembler
7310 (plus the linker if linking is done).
7312 Without the specification of an output file, the output looks like this:
7314 @smallexample
7315 # cc1 0.12 0.01
7316 # as 0.00 0.01
7317 @end smallexample
7319 The first number on each line is the ``user time'', that is time spent
7320 executing the program itself.  The second number is ``system time'',
7321 time spent executing operating system routines on behalf of the program.
7322 Both numbers are in seconds.
7324 With the specification of an output file, the output is appended to the
7325 named file, and it looks like this:
7327 @smallexample
7328 0.12 0.01 cc1 @var{options}
7329 0.00 0.01 as @var{options}
7330 @end smallexample
7332 The ``user time'' and the ``system time'' are moved before the program
7333 name, and the options passed to the program are displayed, so that one
7334 can later tell what file was being compiled, and with which options.
7336 @item -fvar-tracking
7337 @opindex fvar-tracking
7338 Run variable tracking pass.  It computes where variables are stored at each
7339 position in code.  Better debugging information is then generated
7340 (if the debugging information format supports this information).
7342 It is enabled by default when compiling with optimization (@option{-Os},
7343 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7344 the debug info format supports it.
7346 @item -fvar-tracking-assignments
7347 @opindex fvar-tracking-assignments
7348 @opindex fno-var-tracking-assignments
7349 Annotate assignments to user variables early in the compilation and
7350 attempt to carry the annotations over throughout the compilation all the
7351 way to the end, in an attempt to improve debug information while
7352 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7354 It can be enabled even if var-tracking is disabled, in which case
7355 annotations are created and maintained, but discarded at the end.
7356 By default, this flag is enabled together with @option{-fvar-tracking},
7357 except when selective scheduling is enabled.
7359 @item -fvar-tracking-assignments-toggle
7360 @opindex fvar-tracking-assignments-toggle
7361 @opindex fno-var-tracking-assignments-toggle
7362 Toggle @option{-fvar-tracking-assignments}, in the same way that
7363 @option{-gtoggle} toggles @option{-g}.
7365 @item -print-file-name=@var{library}
7366 @opindex print-file-name
7367 Print the full absolute name of the library file @var{library} that
7368 would be used when linking---and don't do anything else.  With this
7369 option, GCC does not compile or link anything; it just prints the
7370 file name.
7372 @item -print-multi-directory
7373 @opindex print-multi-directory
7374 Print the directory name corresponding to the multilib selected by any
7375 other switches present in the command line.  This directory is supposed
7376 to exist in @env{GCC_EXEC_PREFIX}.
7378 @item -print-multi-lib
7379 @opindex print-multi-lib
7380 Print the mapping from multilib directory names to compiler switches
7381 that enable them.  The directory name is separated from the switches by
7382 @samp{;}, and each switch starts with an @samp{@@} instead of the
7383 @samp{-}, without spaces between multiple switches.  This is supposed to
7384 ease shell processing.
7386 @item -print-multi-os-directory
7387 @opindex print-multi-os-directory
7388 Print the path to OS libraries for the selected
7389 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7390 present in the @file{lib} subdirectory and no multilibs are used, this is
7391 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7392 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7393 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7394 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7396 @item -print-multiarch
7397 @opindex print-multiarch
7398 Print the path to OS libraries for the selected multiarch,
7399 relative to some @file{lib} subdirectory.
7401 @item -print-prog-name=@var{program}
7402 @opindex print-prog-name
7403 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
7405 @item -print-libgcc-file-name
7406 @opindex print-libgcc-file-name
7407 Same as @option{-print-file-name=libgcc.a}.
7409 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7410 but you do want to link with @file{libgcc.a}.  You can do:
7412 @smallexample
7413 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7414 @end smallexample
7416 @item -print-search-dirs
7417 @opindex print-search-dirs
7418 Print the name of the configured installation directory and a list of
7419 program and library directories @command{gcc} searches---and don't do anything else.
7421 This is useful when @command{gcc} prints the error message
7422 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7423 To resolve this you either need to put @file{cpp0} and the other compiler
7424 components where @command{gcc} expects to find them, or you can set the environment
7425 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7426 Don't forget the trailing @samp{/}.
7427 @xref{Environment Variables}.
7429 @item -print-sysroot
7430 @opindex print-sysroot
7431 Print the target sysroot directory that is used during
7432 compilation.  This is the target sysroot specified either at configure
7433 time or using the @option{--sysroot} option, possibly with an extra
7434 suffix that depends on compilation options.  If no target sysroot is
7435 specified, the option prints nothing.
7437 @item -print-sysroot-headers-suffix
7438 @opindex print-sysroot-headers-suffix
7439 Print the suffix added to the target sysroot when searching for
7440 headers, or give an error if the compiler is not configured with such
7441 a suffix---and don't do anything else.
7443 @item -dumpmachine
7444 @opindex dumpmachine
7445 Print the compiler's target machine (for example,
7446 @samp{i686-pc-linux-gnu})---and don't do anything else.
7448 @item -dumpversion
7449 @opindex dumpversion
7450 Print the compiler version (for example, @code{3.0})---and don't do
7451 anything else.
7453 @item -dumpspecs
7454 @opindex dumpspecs
7455 Print the compiler's built-in specs---and don't do anything else.  (This
7456 is used when GCC itself is being built.)  @xref{Spec Files}.
7458 @item -fno-eliminate-unused-debug-types
7459 @opindex feliminate-unused-debug-types
7460 @opindex fno-eliminate-unused-debug-types
7461 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7462 output for types that are nowhere used in the source file being compiled.
7463 Sometimes it is useful to have GCC emit debugging
7464 information for all types declared in a compilation
7465 unit, regardless of whether or not they are actually used
7466 in that compilation unit, for example 
7467 if, in the debugger, you want to cast a value to a type that is
7468 not actually used in your program (but is declared).  More often,
7469 however, this results in a significant amount of wasted space.
7470 @end table
7472 @node Optimize Options
7473 @section Options That Control Optimization
7474 @cindex optimize options
7475 @cindex options, optimization
7477 These options control various sorts of optimizations.
7479 Without any optimization option, the compiler's goal is to reduce the
7480 cost of compilation and to make debugging produce the expected
7481 results.  Statements are independent: if you stop the program with a
7482 breakpoint between statements, you can then assign a new value to any
7483 variable or change the program counter to any other statement in the
7484 function and get exactly the results you expect from the source
7485 code.
7487 Turning on optimization flags makes the compiler attempt to improve
7488 the performance and/or code size at the expense of compilation time
7489 and possibly the ability to debug the program.
7491 The compiler performs optimization based on the knowledge it has of the
7492 program.  Compiling multiple files at once to a single output file mode allows
7493 the compiler to use information gained from all of the files when compiling
7494 each of them.
7496 Not all optimizations are controlled directly by a flag.  Only
7497 optimizations that have a flag are listed in this section.
7499 Most optimizations are only enabled if an @option{-O} level is set on
7500 the command line.  Otherwise they are disabled, even if individual
7501 optimization flags are specified.
7503 Depending on the target and how GCC was configured, a slightly different
7504 set of optimizations may be enabled at each @option{-O} level than
7505 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7506 to find out the exact set of optimizations that are enabled at each level.
7507 @xref{Overall Options}, for examples.
7509 @table @gcctabopt
7510 @item -O
7511 @itemx -O1
7512 @opindex O
7513 @opindex O1
7514 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7515 more memory for a large function.
7517 With @option{-O}, the compiler tries to reduce code size and execution
7518 time, without performing any optimizations that take a great deal of
7519 compilation time.
7521 @option{-O} turns on the following optimization flags:
7522 @gccoptlist{
7523 -fauto-inc-dec @gol
7524 -fbranch-count-reg @gol
7525 -fcombine-stack-adjustments @gol
7526 -fcompare-elim @gol
7527 -fcprop-registers @gol
7528 -fdce @gol
7529 -fdefer-pop @gol
7530 -fdelayed-branch @gol
7531 -fdse @gol
7532 -fforward-propagate @gol
7533 -fguess-branch-probability @gol
7534 -fif-conversion2 @gol
7535 -fif-conversion @gol
7536 -finline-functions-called-once @gol
7537 -fipa-pure-const @gol
7538 -fipa-profile @gol
7539 -fipa-reference @gol
7540 -fmerge-constants @gol
7541 -fmove-loop-invariants @gol
7542 -fshrink-wrap @gol
7543 -fsplit-wide-types @gol
7544 -ftree-bit-ccp @gol
7545 -ftree-ccp @gol
7546 -fssa-phiopt @gol
7547 -ftree-ch @gol
7548 -ftree-copy-prop @gol
7549 -ftree-copyrename @gol
7550 -ftree-dce @gol
7551 -ftree-dominator-opts @gol
7552 -ftree-dse @gol
7553 -ftree-forwprop @gol
7554 -ftree-fre @gol
7555 -ftree-phiprop @gol
7556 -ftree-sink @gol
7557 -ftree-slsr @gol
7558 -ftree-sra @gol
7559 -ftree-pta @gol
7560 -ftree-ter @gol
7561 -funit-at-a-time}
7563 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7564 where doing so does not interfere with debugging.
7566 @item -O2
7567 @opindex O2
7568 Optimize even more.  GCC performs nearly all supported optimizations
7569 that do not involve a space-speed tradeoff.
7570 As compared to @option{-O}, this option increases both compilation time
7571 and the performance of the generated code.
7573 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7574 also turns on the following optimization flags:
7575 @gccoptlist{-fthread-jumps @gol
7576 -falign-functions  -falign-jumps @gol
7577 -falign-loops  -falign-labels @gol
7578 -fcaller-saves @gol
7579 -fcrossjumping @gol
7580 -fcse-follow-jumps  -fcse-skip-blocks @gol
7581 -fdelete-null-pointer-checks @gol
7582 -fdevirtualize -fdevirtualize-speculatively @gol
7583 -fexpensive-optimizations @gol
7584 -fgcse  -fgcse-lm  @gol
7585 -fhoist-adjacent-loads @gol
7586 -finline-small-functions @gol
7587 -findirect-inlining @gol
7588 -fipa-cp @gol
7589 -fipa-cp-alignment @gol
7590 -fipa-sra @gol
7591 -fipa-icf @gol
7592 -fisolate-erroneous-paths-dereference @gol
7593 -flra-remat @gol
7594 -foptimize-sibling-calls @gol
7595 -foptimize-strlen @gol
7596 -fpartial-inlining @gol
7597 -fpeephole2 @gol
7598 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7599 -frerun-cse-after-loop  @gol
7600 -fsched-interblock  -fsched-spec @gol
7601 -fschedule-insns  -fschedule-insns2 @gol
7602 -fstrict-aliasing -fstrict-overflow @gol
7603 -ftree-builtin-call-dce @gol
7604 -ftree-switch-conversion -ftree-tail-merge @gol
7605 -ftree-pre @gol
7606 -ftree-vrp @gol
7607 -fipa-ra}
7609 Please note the warning under @option{-fgcse} about
7610 invoking @option{-O2} on programs that use computed gotos.
7612 @item -O3
7613 @opindex O3
7614 Optimize yet more.  @option{-O3} turns on all optimizations specified
7615 by @option{-O2} and also turns on the @option{-finline-functions},
7616 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7617 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7618 @option{-ftree-loop-distribute-patterns},
7619 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7620 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7622 @item -O0
7623 @opindex O0
7624 Reduce compilation time and make debugging produce the expected
7625 results.  This is the default.
7627 @item -Os
7628 @opindex Os
7629 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7630 do not typically increase code size.  It also performs further
7631 optimizations designed to reduce code size.
7633 @option{-Os} disables the following optimization flags:
7634 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7635 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7636 -fprefetch-loop-arrays}
7638 @item -Ofast
7639 @opindex Ofast
7640 Disregard strict standards compliance.  @option{-Ofast} enables all
7641 @option{-O3} optimizations.  It also enables optimizations that are not
7642 valid for all standard-compliant programs.
7643 It turns on @option{-ffast-math} and the Fortran-specific
7644 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7646 @item -Og
7647 @opindex Og
7648 Optimize debugging experience.  @option{-Og} enables optimizations
7649 that do not interfere with debugging. It should be the optimization
7650 level of choice for the standard edit-compile-debug cycle, offering
7651 a reasonable level of optimization while maintaining fast compilation
7652 and a good debugging experience.
7654 If you use multiple @option{-O} options, with or without level numbers,
7655 the last such option is the one that is effective.
7656 @end table
7658 Options of the form @option{-f@var{flag}} specify machine-independent
7659 flags.  Most flags have both positive and negative forms; the negative
7660 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7661 below, only one of the forms is listed---the one you typically 
7662 use.  You can figure out the other form by either removing @samp{no-}
7663 or adding it.
7665 The following options control specific optimizations.  They are either
7666 activated by @option{-O} options or are related to ones that are.  You
7667 can use the following flags in the rare cases when ``fine-tuning'' of
7668 optimizations to be performed is desired.
7670 @table @gcctabopt
7671 @item -fno-defer-pop
7672 @opindex fno-defer-pop
7673 Always pop the arguments to each function call as soon as that function
7674 returns.  For machines that must pop arguments after a function call,
7675 the compiler normally lets arguments accumulate on the stack for several
7676 function calls and pops them all at once.
7678 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7680 @item -fforward-propagate
7681 @opindex fforward-propagate
7682 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7683 instructions and checks if the result can be simplified.  If loop unrolling
7684 is active, two passes are performed and the second is scheduled after
7685 loop unrolling.
7687 This option is enabled by default at optimization levels @option{-O},
7688 @option{-O2}, @option{-O3}, @option{-Os}.
7690 @item -ffp-contract=@var{style}
7691 @opindex ffp-contract
7692 @option{-ffp-contract=off} disables floating-point expression contraction.
7693 @option{-ffp-contract=fast} enables floating-point expression contraction
7694 such as forming of fused multiply-add operations if the target has
7695 native support for them.
7696 @option{-ffp-contract=on} enables floating-point expression contraction
7697 if allowed by the language standard.  This is currently not implemented
7698 and treated equal to @option{-ffp-contract=off}.
7700 The default is @option{-ffp-contract=fast}.
7702 @item -fomit-frame-pointer
7703 @opindex fomit-frame-pointer
7704 Don't keep the frame pointer in a register for functions that
7705 don't need one.  This avoids the instructions to save, set up and
7706 restore frame pointers; it also makes an extra register available
7707 in many functions.  @strong{It also makes debugging impossible on
7708 some machines.}
7710 On some machines, such as the VAX, this flag has no effect, because
7711 the standard calling sequence automatically handles the frame pointer
7712 and nothing is saved by pretending it doesn't exist.  The
7713 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7714 whether a target machine supports this flag.  @xref{Registers,,Register
7715 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7717 The default setting (when not optimizing for
7718 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7719 @option{-fomit-frame-pointer}.  You can configure GCC with the
7720 @option{--enable-frame-pointer} configure option to change the default.
7722 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7724 @item -foptimize-sibling-calls
7725 @opindex foptimize-sibling-calls
7726 Optimize sibling and tail recursive calls.
7728 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7730 @item -foptimize-strlen
7731 @opindex foptimize-strlen
7732 Optimize various standard C string functions (e.g. @code{strlen},
7733 @code{strchr} or @code{strcpy}) and
7734 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7736 Enabled at levels @option{-O2}, @option{-O3}.
7738 @item -fno-inline
7739 @opindex fno-inline
7740 Do not expand any functions inline apart from those marked with
7741 the @code{always_inline} attribute.  This is the default when not
7742 optimizing.
7744 Single functions can be exempted from inlining by marking them
7745 with the @code{noinline} attribute.
7747 @item -finline-small-functions
7748 @opindex finline-small-functions
7749 Integrate functions into their callers when their body is smaller than expected
7750 function call code (so overall size of program gets smaller).  The compiler
7751 heuristically decides which functions are simple enough to be worth integrating
7752 in this way.  This inlining applies to all functions, even those not declared
7753 inline.
7755 Enabled at level @option{-O2}.
7757 @item -findirect-inlining
7758 @opindex findirect-inlining
7759 Inline also indirect calls that are discovered to be known at compile
7760 time thanks to previous inlining.  This option has any effect only
7761 when inlining itself is turned on by the @option{-finline-functions}
7762 or @option{-finline-small-functions} options.
7764 Enabled at level @option{-O2}.
7766 @item -finline-functions
7767 @opindex finline-functions
7768 Consider all functions for inlining, even if they are not declared inline.
7769 The compiler heuristically decides which functions are worth integrating
7770 in this way.
7772 If all calls to a given function are integrated, and the function is
7773 declared @code{static}, then the function is normally not output as
7774 assembler code in its own right.
7776 Enabled at level @option{-O3}.
7778 @item -finline-functions-called-once
7779 @opindex finline-functions-called-once
7780 Consider all @code{static} functions called once for inlining into their
7781 caller even if they are not marked @code{inline}.  If a call to a given
7782 function is integrated, then the function is not output as assembler code
7783 in its own right.
7785 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7787 @item -fearly-inlining
7788 @opindex fearly-inlining
7789 Inline functions marked by @code{always_inline} and functions whose body seems
7790 smaller than the function call overhead early before doing
7791 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7792 makes profiling significantly cheaper and usually inlining faster on programs
7793 having large chains of nested wrapper functions.
7795 Enabled by default.
7797 @item -fipa-sra
7798 @opindex fipa-sra
7799 Perform interprocedural scalar replacement of aggregates, removal of
7800 unused parameters and replacement of parameters passed by reference
7801 by parameters passed by value.
7803 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7805 @item -finline-limit=@var{n}
7806 @opindex finline-limit
7807 By default, GCC limits the size of functions that can be inlined.  This flag
7808 allows coarse control of this limit.  @var{n} is the size of functions that
7809 can be inlined in number of pseudo instructions.
7811 Inlining is actually controlled by a number of parameters, which may be
7812 specified individually by using @option{--param @var{name}=@var{value}}.
7813 The @option{-finline-limit=@var{n}} option sets some of these parameters
7814 as follows:
7816 @table @gcctabopt
7817 @item max-inline-insns-single
7818 is set to @var{n}/2.
7819 @item max-inline-insns-auto
7820 is set to @var{n}/2.
7821 @end table
7823 See below for a documentation of the individual
7824 parameters controlling inlining and for the defaults of these parameters.
7826 @emph{Note:} there may be no value to @option{-finline-limit} that results
7827 in default behavior.
7829 @emph{Note:} pseudo instruction represents, in this particular context, an
7830 abstract measurement of function's size.  In no way does it represent a count
7831 of assembly instructions and as such its exact meaning might change from one
7832 release to an another.
7834 @item -fno-keep-inline-dllexport
7835 @opindex fno-keep-inline-dllexport
7836 This is a more fine-grained version of @option{-fkeep-inline-functions},
7837 which applies only to functions that are declared using the @code{dllexport}
7838 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7839 Functions}.)
7841 @item -fkeep-inline-functions
7842 @opindex fkeep-inline-functions
7843 In C, emit @code{static} functions that are declared @code{inline}
7844 into the object file, even if the function has been inlined into all
7845 of its callers.  This switch does not affect functions using the
7846 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7847 inline functions into the object file.
7849 @item -fkeep-static-consts
7850 @opindex fkeep-static-consts
7851 Emit variables declared @code{static const} when optimization isn't turned
7852 on, even if the variables aren't referenced.
7854 GCC enables this option by default.  If you want to force the compiler to
7855 check if a variable is referenced, regardless of whether or not
7856 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7858 @item -fmerge-constants
7859 @opindex fmerge-constants
7860 Attempt to merge identical constants (string constants and floating-point
7861 constants) across compilation units.
7863 This option is the default for optimized compilation if the assembler and
7864 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7865 behavior.
7867 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7869 @item -fmerge-all-constants
7870 @opindex fmerge-all-constants
7871 Attempt to merge identical constants and identical variables.
7873 This option implies @option{-fmerge-constants}.  In addition to
7874 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7875 arrays or initialized constant variables with integral or floating-point
7876 types.  Languages like C or C++ require each variable, including multiple
7877 instances of the same variable in recursive calls, to have distinct locations,
7878 so using this option results in non-conforming
7879 behavior.
7881 @item -fmodulo-sched
7882 @opindex fmodulo-sched
7883 Perform swing modulo scheduling immediately before the first scheduling
7884 pass.  This pass looks at innermost loops and reorders their
7885 instructions by overlapping different iterations.
7887 @item -fmodulo-sched-allow-regmoves
7888 @opindex fmodulo-sched-allow-regmoves
7889 Perform more aggressive SMS-based modulo scheduling with register moves
7890 allowed.  By setting this flag certain anti-dependences edges are
7891 deleted, which triggers the generation of reg-moves based on the
7892 life-range analysis.  This option is effective only with
7893 @option{-fmodulo-sched} enabled.
7895 @item -fno-branch-count-reg
7896 @opindex fno-branch-count-reg
7897 Do not use ``decrement and branch'' instructions on a count register,
7898 but instead generate a sequence of instructions that decrement a
7899 register, compare it against zero, then branch based upon the result.
7900 This option is only meaningful on architectures that support such
7901 instructions, which include x86, PowerPC, IA-64 and S/390.
7903 Enabled by default at @option{-O1} and higher.
7905 The default is @option{-fbranch-count-reg}.
7907 @item -fno-function-cse
7908 @opindex fno-function-cse
7909 Do not put function addresses in registers; make each instruction that
7910 calls a constant function contain the function's address explicitly.
7912 This option results in less efficient code, but some strange hacks
7913 that alter the assembler output may be confused by the optimizations
7914 performed when this option is not used.
7916 The default is @option{-ffunction-cse}
7918 @item -fno-zero-initialized-in-bss
7919 @opindex fno-zero-initialized-in-bss
7920 If the target supports a BSS section, GCC by default puts variables that
7921 are initialized to zero into BSS@.  This can save space in the resulting
7922 code.
7924 This option turns off this behavior because some programs explicitly
7925 rely on variables going to the data section---e.g., so that the
7926 resulting executable can find the beginning of that section and/or make
7927 assumptions based on that.
7929 The default is @option{-fzero-initialized-in-bss}.
7931 @item -fthread-jumps
7932 @opindex fthread-jumps
7933 Perform optimizations that check to see if a jump branches to a
7934 location where another comparison subsumed by the first is found.  If
7935 so, the first branch is redirected to either the destination of the
7936 second branch or a point immediately following it, depending on whether
7937 the condition is known to be true or false.
7939 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7941 @item -fsplit-wide-types
7942 @opindex fsplit-wide-types
7943 When using a type that occupies multiple registers, such as @code{long
7944 long} on a 32-bit system, split the registers apart and allocate them
7945 independently.  This normally generates better code for those types,
7946 but may make debugging more difficult.
7948 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7949 @option{-Os}.
7951 @item -fcse-follow-jumps
7952 @opindex fcse-follow-jumps
7953 In common subexpression elimination (CSE), scan through jump instructions
7954 when the target of the jump is not reached by any other path.  For
7955 example, when CSE encounters an @code{if} statement with an
7956 @code{else} clause, CSE follows the jump when the condition
7957 tested is false.
7959 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7961 @item -fcse-skip-blocks
7962 @opindex fcse-skip-blocks
7963 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7964 follow jumps that conditionally skip over blocks.  When CSE
7965 encounters a simple @code{if} statement with no else clause,
7966 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7967 body of the @code{if}.
7969 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7971 @item -frerun-cse-after-loop
7972 @opindex frerun-cse-after-loop
7973 Re-run common subexpression elimination after loop optimizations are
7974 performed.
7976 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7978 @item -fgcse
7979 @opindex fgcse
7980 Perform a global common subexpression elimination pass.
7981 This pass also performs global constant and copy propagation.
7983 @emph{Note:} When compiling a program using computed gotos, a GCC
7984 extension, you may get better run-time performance if you disable
7985 the global common subexpression elimination pass by adding
7986 @option{-fno-gcse} to the command line.
7988 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7990 @item -fgcse-lm
7991 @opindex fgcse-lm
7992 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7993 attempts to move loads that are only killed by stores into themselves.  This
7994 allows a loop containing a load/store sequence to be changed to a load outside
7995 the loop, and a copy/store within the loop.
7997 Enabled by default when @option{-fgcse} is enabled.
7999 @item -fgcse-sm
8000 @opindex fgcse-sm
8001 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8002 global common subexpression elimination.  This pass attempts to move
8003 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8004 loops containing a load/store sequence can be changed to a load before
8005 the loop and a store after the loop.
8007 Not enabled at any optimization level.
8009 @item -fgcse-las
8010 @opindex fgcse-las
8011 When @option{-fgcse-las} is enabled, the global common subexpression
8012 elimination pass eliminates redundant loads that come after stores to the
8013 same memory location (both partial and full redundancies).
8015 Not enabled at any optimization level.
8017 @item -fgcse-after-reload
8018 @opindex fgcse-after-reload
8019 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8020 pass is performed after reload.  The purpose of this pass is to clean up
8021 redundant spilling.
8023 @item -faggressive-loop-optimizations
8024 @opindex faggressive-loop-optimizations
8025 This option tells the loop optimizer to use language constraints to
8026 derive bounds for the number of iterations of a loop.  This assumes that
8027 loop code does not invoke undefined behavior by for example causing signed
8028 integer overflows or out-of-bound array accesses.  The bounds for the
8029 number of iterations of a loop are used to guide loop unrolling and peeling
8030 and loop exit test optimizations.
8031 This option is enabled by default.
8033 @item -funsafe-loop-optimizations
8034 @opindex funsafe-loop-optimizations
8035 This option tells the loop optimizer to assume that loop indices do not
8036 overflow, and that loops with nontrivial exit condition are not
8037 infinite.  This enables a wider range of loop optimizations even if
8038 the loop optimizer itself cannot prove that these assumptions are valid.
8039 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
8040 if it finds this kind of loop.
8042 @item -fcrossjumping
8043 @opindex fcrossjumping
8044 Perform cross-jumping transformation.
8045 This transformation unifies equivalent code and saves code size.  The
8046 resulting code may or may not perform better than without cross-jumping.
8048 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8050 @item -fauto-inc-dec
8051 @opindex fauto-inc-dec
8052 Combine increments or decrements of addresses with memory accesses.
8053 This pass is always skipped on architectures that do not have
8054 instructions to support this.  Enabled by default at @option{-O} and
8055 higher on architectures that support this.
8057 @item -fdce
8058 @opindex fdce
8059 Perform dead code elimination (DCE) on RTL@.
8060 Enabled by default at @option{-O} and higher.
8062 @item -fdse
8063 @opindex fdse
8064 Perform dead store elimination (DSE) on RTL@.
8065 Enabled by default at @option{-O} and higher.
8067 @item -fif-conversion
8068 @opindex fif-conversion
8069 Attempt to transform conditional jumps into branch-less equivalents.  This
8070 includes use of conditional moves, min, max, set flags and abs instructions, and
8071 some tricks doable by standard arithmetics.  The use of conditional execution
8072 on chips where it is available is controlled by @option{-fif-conversion2}.
8074 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8076 @item -fif-conversion2
8077 @opindex fif-conversion2
8078 Use conditional execution (where available) to transform conditional jumps into
8079 branch-less equivalents.
8081 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8083 @item -fdeclone-ctor-dtor
8084 @opindex fdeclone-ctor-dtor
8085 The C++ ABI requires multiple entry points for constructors and
8086 destructors: one for a base subobject, one for a complete object, and
8087 one for a virtual destructor that calls operator delete afterwards.
8088 For a hierarchy with virtual bases, the base and complete variants are
8089 clones, which means two copies of the function.  With this option, the
8090 base and complete variants are changed to be thunks that call a common
8091 implementation.
8093 Enabled by @option{-Os}.
8095 @item -fdelete-null-pointer-checks
8096 @opindex fdelete-null-pointer-checks
8097 Assume that programs cannot safely dereference null pointers, and that
8098 no code or data element resides at address zero.
8099 This option enables simple constant
8100 folding optimizations at all optimization levels.  In addition, other
8101 optimization passes in GCC use this flag to control global dataflow
8102 analyses that eliminate useless checks for null pointers; these assume
8103 that a memory access to address zero always results in a trap, so
8104 that if a pointer is checked after it has already been dereferenced,
8105 it cannot be null.
8107 Note however that in some environments this assumption is not true.
8108 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8109 for programs that depend on that behavior.
8111 This option is enabled by default on most targets.  On Nios II ELF, it
8112 defaults to off.  On AVR and CR16, this option is completely disabled.  
8114 Passes that use the dataflow information
8115 are enabled independently at different optimization levels.
8117 @item -fdevirtualize
8118 @opindex fdevirtualize
8119 Attempt to convert calls to virtual functions to direct calls.  This
8120 is done both within a procedure and interprocedurally as part of
8121 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8122 propagation (@option{-fipa-cp}).
8123 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8125 @item -fdevirtualize-speculatively
8126 @opindex fdevirtualize-speculatively
8127 Attempt to convert calls to virtual functions to speculative direct calls.
8128 Based on the analysis of the type inheritance graph, determine for a given call
8129 the set of likely targets. If the set is small, preferably of size 1, change
8130 the call into a conditional deciding between direct and indirect calls.  The
8131 speculative calls enable more optimizations, such as inlining.  When they seem
8132 useless after further optimization, they are converted back into original form.
8134 @item -fdevirtualize-at-ltrans
8135 @opindex fdevirtualize-at-ltrans
8136 Stream extra information needed for aggressive devirtualization when running
8137 the link-time optimizer in local transformation mode.  
8138 This option enables more devirtualization but
8139 significantly increases the size of streamed data. For this reason it is
8140 disabled by default.
8142 @item -fexpensive-optimizations
8143 @opindex fexpensive-optimizations
8144 Perform a number of minor optimizations that are relatively expensive.
8146 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8148 @item -free
8149 @opindex free
8150 Attempt to remove redundant extension instructions.  This is especially
8151 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8152 registers after writing to their lower 32-bit half.
8154 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8155 @option{-O3}, @option{-Os}.
8157 @item -fno-lifetime-dse
8158 @opindex fno-lifetime-dse
8159 In C++ the value of an object is only affected by changes within its
8160 lifetime: when the constructor begins, the object has an indeterminate
8161 value, and any changes during the lifetime of the object are dead when
8162 the object is destroyed.  Normally dead store elimination will take
8163 advantage of this; if your code relies on the value of the object
8164 storage persisting beyond the lifetime of the object, you can use this
8165 flag to disable this optimization.
8167 @item -flive-range-shrinkage
8168 @opindex flive-range-shrinkage
8169 Attempt to decrease register pressure through register live range
8170 shrinkage.  This is helpful for fast processors with small or moderate
8171 size register sets.
8173 @item -fira-algorithm=@var{algorithm}
8174 @opindex fira-algorithm
8175 Use the specified coloring algorithm for the integrated register
8176 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8177 specifies Chow's priority coloring, or @samp{CB}, which specifies
8178 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8179 for all architectures, but for those targets that do support it, it is
8180 the default because it generates better code.
8182 @item -fira-region=@var{region}
8183 @opindex fira-region
8184 Use specified regions for the integrated register allocator.  The
8185 @var{region} argument should be one of the following:
8187 @table @samp
8189 @item all
8190 Use all loops as register allocation regions.
8191 This can give the best results for machines with a small and/or
8192 irregular register set.
8194 @item mixed
8195 Use all loops except for loops with small register pressure 
8196 as the regions.  This value usually gives
8197 the best results in most cases and for most architectures,
8198 and is enabled by default when compiling with optimization for speed
8199 (@option{-O}, @option{-O2}, @dots{}).
8201 @item one
8202 Use all functions as a single region.  
8203 This typically results in the smallest code size, and is enabled by default for
8204 @option{-Os} or @option{-O0}.
8206 @end table
8208 @item -fira-hoist-pressure
8209 @opindex fira-hoist-pressure
8210 Use IRA to evaluate register pressure in the code hoisting pass for
8211 decisions to hoist expressions.  This option usually results in smaller
8212 code, but it can slow the compiler down.
8214 This option is enabled at level @option{-Os} for all targets.
8216 @item -fira-loop-pressure
8217 @opindex fira-loop-pressure
8218 Use IRA to evaluate register pressure in loops for decisions to move
8219 loop invariants.  This option usually results in generation
8220 of faster and smaller code on machines with large register files (>= 32
8221 registers), but it can slow the compiler down.
8223 This option is enabled at level @option{-O3} for some targets.
8225 @item -fno-ira-share-save-slots
8226 @opindex fno-ira-share-save-slots
8227 Disable sharing of stack slots used for saving call-used hard
8228 registers living through a call.  Each hard register gets a
8229 separate stack slot, and as a result function stack frames are
8230 larger.
8232 @item -fno-ira-share-spill-slots
8233 @opindex fno-ira-share-spill-slots
8234 Disable sharing of stack slots allocated for pseudo-registers.  Each
8235 pseudo-register that does not get a hard register gets a separate
8236 stack slot, and as a result function stack frames are larger.
8238 @item -fira-verbose=@var{n}
8239 @opindex fira-verbose
8240 Control the verbosity of the dump file for the integrated register allocator.
8241 The default value is 5.  If the value @var{n} is greater or equal to 10,
8242 the dump output is sent to stderr using the same format as @var{n} minus 10.
8244 @item -flra-remat
8245 @opindex flra-remat
8246 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8247 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8248 values if it is profitable.
8250 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8252 @item -fdelayed-branch
8253 @opindex fdelayed-branch
8254 If supported for the target machine, attempt to reorder instructions
8255 to exploit instruction slots available after delayed branch
8256 instructions.
8258 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8260 @item -fschedule-insns
8261 @opindex fschedule-insns
8262 If supported for the target machine, attempt to reorder instructions to
8263 eliminate execution stalls due to required data being unavailable.  This
8264 helps machines that have slow floating point or memory load instructions
8265 by allowing other instructions to be issued until the result of the load
8266 or floating-point instruction is required.
8268 Enabled at levels @option{-O2}, @option{-O3}.
8270 @item -fschedule-insns2
8271 @opindex fschedule-insns2
8272 Similar to @option{-fschedule-insns}, but requests an additional pass of
8273 instruction scheduling after register allocation has been done.  This is
8274 especially useful on machines with a relatively small number of
8275 registers and where memory load instructions take more than one cycle.
8277 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8279 @item -fno-sched-interblock
8280 @opindex fno-sched-interblock
8281 Don't schedule instructions across basic blocks.  This is normally
8282 enabled by default when scheduling before register allocation, i.e.@:
8283 with @option{-fschedule-insns} or at @option{-O2} or higher.
8285 @item -fno-sched-spec
8286 @opindex fno-sched-spec
8287 Don't allow speculative motion of non-load instructions.  This is normally
8288 enabled by default when scheduling before register allocation, i.e.@:
8289 with @option{-fschedule-insns} or at @option{-O2} or higher.
8291 @item -fsched-pressure
8292 @opindex fsched-pressure
8293 Enable register pressure sensitive insn scheduling before register
8294 allocation.  This only makes sense when scheduling before register
8295 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8296 @option{-O2} or higher.  Usage of this option can improve the
8297 generated code and decrease its size by preventing register pressure
8298 increase above the number of available hard registers and subsequent
8299 spills in register allocation.
8301 @item -fsched-spec-load
8302 @opindex fsched-spec-load
8303 Allow speculative motion of some load instructions.  This only makes
8304 sense when scheduling before register allocation, i.e.@: with
8305 @option{-fschedule-insns} or at @option{-O2} or higher.
8307 @item -fsched-spec-load-dangerous
8308 @opindex fsched-spec-load-dangerous
8309 Allow speculative motion of more load instructions.  This only makes
8310 sense when scheduling before register allocation, i.e.@: with
8311 @option{-fschedule-insns} or at @option{-O2} or higher.
8313 @item -fsched-stalled-insns
8314 @itemx -fsched-stalled-insns=@var{n}
8315 @opindex fsched-stalled-insns
8316 Define how many insns (if any) can be moved prematurely from the queue
8317 of stalled insns into the ready list during the second scheduling pass.
8318 @option{-fno-sched-stalled-insns} means that no insns are moved
8319 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8320 on how many queued insns can be moved prematurely.
8321 @option{-fsched-stalled-insns} without a value is equivalent to
8322 @option{-fsched-stalled-insns=1}.
8324 @item -fsched-stalled-insns-dep
8325 @itemx -fsched-stalled-insns-dep=@var{n}
8326 @opindex fsched-stalled-insns-dep
8327 Define how many insn groups (cycles) are examined for a dependency
8328 on a stalled insn that is a candidate for premature removal from the queue
8329 of stalled insns.  This has an effect only during the second scheduling pass,
8330 and only if @option{-fsched-stalled-insns} is used.
8331 @option{-fno-sched-stalled-insns-dep} is equivalent to
8332 @option{-fsched-stalled-insns-dep=0}.
8333 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8334 @option{-fsched-stalled-insns-dep=1}.
8336 @item -fsched2-use-superblocks
8337 @opindex fsched2-use-superblocks
8338 When scheduling after register allocation, use superblock scheduling.
8339 This allows motion across basic block boundaries,
8340 resulting in faster schedules.  This option is experimental, as not all machine
8341 descriptions used by GCC model the CPU closely enough to avoid unreliable
8342 results from the algorithm.
8344 This only makes sense when scheduling after register allocation, i.e.@: with
8345 @option{-fschedule-insns2} or at @option{-O2} or higher.
8347 @item -fsched-group-heuristic
8348 @opindex fsched-group-heuristic
8349 Enable the group heuristic in the scheduler.  This heuristic favors
8350 the instruction that belongs to a schedule group.  This is enabled
8351 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8352 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8354 @item -fsched-critical-path-heuristic
8355 @opindex fsched-critical-path-heuristic
8356 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8357 instructions on the critical path.  This is enabled by default when
8358 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8359 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8361 @item -fsched-spec-insn-heuristic
8362 @opindex fsched-spec-insn-heuristic
8363 Enable the speculative instruction heuristic in the scheduler.  This
8364 heuristic favors speculative instructions with greater dependency weakness.
8365 This is enabled by default when scheduling is enabled, i.e.@:
8366 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8367 or at @option{-O2} or higher.
8369 @item -fsched-rank-heuristic
8370 @opindex fsched-rank-heuristic
8371 Enable the rank heuristic in the scheduler.  This heuristic favors
8372 the instruction belonging to a basic block with greater size or frequency.
8373 This is enabled by default when scheduling is enabled, i.e.@:
8374 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8375 at @option{-O2} or higher.
8377 @item -fsched-last-insn-heuristic
8378 @opindex fsched-last-insn-heuristic
8379 Enable the last-instruction heuristic in the scheduler.  This heuristic
8380 favors the instruction that is less dependent on the last instruction
8381 scheduled.  This is enabled by default when scheduling is enabled,
8382 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8383 at @option{-O2} or higher.
8385 @item -fsched-dep-count-heuristic
8386 @opindex fsched-dep-count-heuristic
8387 Enable the dependent-count heuristic in the scheduler.  This heuristic
8388 favors the instruction that has more instructions depending on it.
8389 This is enabled by default when scheduling is enabled, i.e.@:
8390 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8391 at @option{-O2} or higher.
8393 @item -freschedule-modulo-scheduled-loops
8394 @opindex freschedule-modulo-scheduled-loops
8395 Modulo scheduling is performed before traditional scheduling.  If a loop
8396 is modulo scheduled, later scheduling passes may change its schedule.  
8397 Use this option to control that behavior.
8399 @item -fselective-scheduling
8400 @opindex fselective-scheduling
8401 Schedule instructions using selective scheduling algorithm.  Selective
8402 scheduling runs instead of the first scheduler pass.
8404 @item -fselective-scheduling2
8405 @opindex fselective-scheduling2
8406 Schedule instructions using selective scheduling algorithm.  Selective
8407 scheduling runs instead of the second scheduler pass.
8409 @item -fsel-sched-pipelining
8410 @opindex fsel-sched-pipelining
8411 Enable software pipelining of innermost loops during selective scheduling.
8412 This option has no effect unless one of @option{-fselective-scheduling} or
8413 @option{-fselective-scheduling2} is turned on.
8415 @item -fsel-sched-pipelining-outer-loops
8416 @opindex fsel-sched-pipelining-outer-loops
8417 When pipelining loops during selective scheduling, also pipeline outer loops.
8418 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8420 @item -fsemantic-interposition
8421 @opindex fsemantic-interposition
8422 Some object formats, like ELF, allow interposing of symbols by the 
8423 dynamic linker.
8424 This means that for symbols exported from the DSO, the compiler cannot perform
8425 interprocedural propagation, inlining and other optimizations in anticipation
8426 that the function or variable in question may change. While this feature is
8427 useful, for example, to rewrite memory allocation functions by a debugging
8428 implementation, it is expensive in the terms of code quality.
8429 With @option{-fno-semantic-interposition} the compiler assumes that 
8430 if interposition happens for functions the overwriting function will have 
8431 precisely the same semantics (and side effects). 
8432 Similarly if interposition happens
8433 for variables, the constructor of the variable will be the same. The flag
8434 has no effect for functions explicitly declared inline 
8435 (where it is never allowed for interposition to change semantics) 
8436 and for symbols explicitly declared weak.
8438 @item -fshrink-wrap
8439 @opindex fshrink-wrap
8440 Emit function prologues only before parts of the function that need it,
8441 rather than at the top of the function.  This flag is enabled by default at
8442 @option{-O} and higher.
8444 @item -fcaller-saves
8445 @opindex fcaller-saves
8446 Enable allocation of values to registers that are clobbered by
8447 function calls, by emitting extra instructions to save and restore the
8448 registers around such calls.  Such allocation is done only when it
8449 seems to result in better code.
8451 This option is always enabled by default on certain machines, usually
8452 those which have no call-preserved registers to use instead.
8454 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8456 @item -fcombine-stack-adjustments
8457 @opindex fcombine-stack-adjustments
8458 Tracks stack adjustments (pushes and pops) and stack memory references
8459 and then tries to find ways to combine them.
8461 Enabled by default at @option{-O1} and higher.
8463 @item -fipa-ra
8464 @opindex fipa-ra
8465 Use caller save registers for allocation if those registers are not used by
8466 any called function.  In that case it is not necessary to save and restore
8467 them around calls.  This is only possible if called functions are part of
8468 same compilation unit as current function and they are compiled before it.
8470 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8472 @item -fconserve-stack
8473 @opindex fconserve-stack
8474 Attempt to minimize stack usage.  The compiler attempts to use less
8475 stack space, even if that makes the program slower.  This option
8476 implies setting the @option{large-stack-frame} parameter to 100
8477 and the @option{large-stack-frame-growth} parameter to 400.
8479 @item -ftree-reassoc
8480 @opindex ftree-reassoc
8481 Perform reassociation on trees.  This flag is enabled by default
8482 at @option{-O} and higher.
8484 @item -ftree-pre
8485 @opindex ftree-pre
8486 Perform partial redundancy elimination (PRE) on trees.  This flag is
8487 enabled by default at @option{-O2} and @option{-O3}.
8489 @item -ftree-partial-pre
8490 @opindex ftree-partial-pre
8491 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8492 enabled by default at @option{-O3}.
8494 @item -ftree-forwprop
8495 @opindex ftree-forwprop
8496 Perform forward propagation on trees.  This flag is enabled by default
8497 at @option{-O} and higher.
8499 @item -ftree-fre
8500 @opindex ftree-fre
8501 Perform full redundancy elimination (FRE) on trees.  The difference
8502 between FRE and PRE is that FRE only considers expressions
8503 that are computed on all paths leading to the redundant computation.
8504 This analysis is faster than PRE, though it exposes fewer redundancies.
8505 This flag is enabled by default at @option{-O} and higher.
8507 @item -ftree-phiprop
8508 @opindex ftree-phiprop
8509 Perform hoisting of loads from conditional pointers on trees.  This
8510 pass is enabled by default at @option{-O} and higher.
8512 @item -fhoist-adjacent-loads
8513 @opindex fhoist-adjacent-loads
8514 Speculatively hoist loads from both branches of an if-then-else if the
8515 loads are from adjacent locations in the same structure and the target
8516 architecture has a conditional move instruction.  This flag is enabled
8517 by default at @option{-O2} and higher.
8519 @item -ftree-copy-prop
8520 @opindex ftree-copy-prop
8521 Perform copy propagation on trees.  This pass eliminates unnecessary
8522 copy operations.  This flag is enabled by default at @option{-O} and
8523 higher.
8525 @item -fipa-pure-const
8526 @opindex fipa-pure-const
8527 Discover which functions are pure or constant.
8528 Enabled by default at @option{-O} and higher.
8530 @item -fipa-reference
8531 @opindex fipa-reference
8532 Discover which static variables do not escape the
8533 compilation unit.
8534 Enabled by default at @option{-O} and higher.
8536 @item -fipa-pta
8537 @opindex fipa-pta
8538 Perform interprocedural pointer analysis and interprocedural modification
8539 and reference analysis.  This option can cause excessive memory and
8540 compile-time usage on large compilation units.  It is not enabled by
8541 default at any optimization level.
8543 @item -fipa-profile
8544 @opindex fipa-profile
8545 Perform interprocedural profile propagation.  The functions called only from
8546 cold functions are marked as cold. Also functions executed once (such as
8547 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8548 functions and loop less parts of functions executed once are then optimized for
8549 size.
8550 Enabled by default at @option{-O} and higher.
8552 @item -fipa-cp
8553 @opindex fipa-cp
8554 Perform interprocedural constant propagation.
8555 This optimization analyzes the program to determine when values passed
8556 to functions are constants and then optimizes accordingly.
8557 This optimization can substantially increase performance
8558 if the application has constants passed to functions.
8559 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8561 @item -fipa-cp-clone
8562 @opindex fipa-cp-clone
8563 Perform function cloning to make interprocedural constant propagation stronger.
8564 When enabled, interprocedural constant propagation performs function cloning
8565 when externally visible function can be called with constant arguments.
8566 Because this optimization can create multiple copies of functions,
8567 it may significantly increase code size
8568 (see @option{--param ipcp-unit-growth=@var{value}}).
8569 This flag is enabled by default at @option{-O3}.
8571 @item -fipa-cp-alignment
8572 @opindex -fipa-cp-alignment
8573 When enabled, this optimization propagates alignment of function
8574 parameters to support better vectorization and string operations.
8576 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8577 requires that @option{-fipa-cp} is enabled.
8579 @item -fipa-icf
8580 @opindex fipa-icf
8581 Perform Identical Code Folding for functions and read-only variables.
8582 The optimization reduces code size and may disturb unwind stacks by replacing
8583 a function by equivalent one with a different name. The optimization works
8584 more effectively with link time optimization enabled.
8586 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8587 works on different levels and thus the optimizations are not same - there are
8588 equivalences that are found only by GCC and equivalences found only by Gold.
8590 This flag is enabled by default at @option{-O2} and @option{-Os}.
8592 @item -fisolate-erroneous-paths-dereference
8593 @opindex fisolate-erroneous-paths-dereference
8594 Detect paths that trigger erroneous or undefined behavior due to
8595 dereferencing a null pointer.  Isolate those paths from the main control
8596 flow and turn the statement with erroneous or undefined behavior into a trap.
8597 This flag is enabled by default at @option{-O2} and higher and depends on
8598 @option{-fdelete-null-pointer-checks} also being enabled.
8600 @item -fisolate-erroneous-paths-attribute
8601 @opindex fisolate-erroneous-paths-attribute
8602 Detect paths that trigger erroneous or undefined behavior due a null value
8603 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8604 attribute.  Isolate those paths from the main control flow and turn the
8605 statement with erroneous or undefined behavior into a trap.  This is not
8606 currently enabled, but may be enabled by @option{-O2} in the future.
8608 @item -ftree-sink
8609 @opindex ftree-sink
8610 Perform forward store motion  on trees.  This flag is
8611 enabled by default at @option{-O} and higher.
8613 @item -ftree-bit-ccp
8614 @opindex ftree-bit-ccp
8615 Perform sparse conditional bit constant propagation on trees and propagate
8616 pointer alignment information.
8617 This pass only operates on local scalar variables and is enabled by default
8618 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8620 @item -ftree-ccp
8621 @opindex ftree-ccp
8622 Perform sparse conditional constant propagation (CCP) on trees.  This
8623 pass only operates on local scalar variables and is enabled by default
8624 at @option{-O} and higher.
8626 @item -fssa-phiopt
8627 @opindex fssa-phiopt
8628 Perform pattern matching on SSA PHI nodes to optimize conditional
8629 code.  This pass is enabled by default at @option{-O} and higher.
8631 @item -ftree-switch-conversion
8632 @opindex ftree-switch-conversion
8633 Perform conversion of simple initializations in a switch to
8634 initializations from a scalar array.  This flag is enabled by default
8635 at @option{-O2} and higher.
8637 @item -ftree-tail-merge
8638 @opindex ftree-tail-merge
8639 Look for identical code sequences.  When found, replace one with a jump to the
8640 other.  This optimization is known as tail merging or cross jumping.  This flag
8641 is enabled by default at @option{-O2} and higher.  The compilation time
8642 in this pass can
8643 be limited using @option{max-tail-merge-comparisons} parameter and
8644 @option{max-tail-merge-iterations} parameter.
8646 @item -ftree-dce
8647 @opindex ftree-dce
8648 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8649 default at @option{-O} and higher.
8651 @item -ftree-builtin-call-dce
8652 @opindex ftree-builtin-call-dce
8653 Perform conditional dead code elimination (DCE) for calls to built-in functions
8654 that may set @code{errno} but are otherwise side-effect free.  This flag is
8655 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8656 specified.
8658 @item -ftree-dominator-opts
8659 @opindex ftree-dominator-opts
8660 Perform a variety of simple scalar cleanups (constant/copy
8661 propagation, redundancy elimination, range propagation and expression
8662 simplification) based on a dominator tree traversal.  This also
8663 performs jump threading (to reduce jumps to jumps). This flag is
8664 enabled by default at @option{-O} and higher.
8666 @item -ftree-dse
8667 @opindex ftree-dse
8668 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8669 a memory location that is later overwritten by another store without
8670 any intervening loads.  In this case the earlier store can be deleted.  This
8671 flag is enabled by default at @option{-O} and higher.
8673 @item -ftree-ch
8674 @opindex ftree-ch
8675 Perform loop header copying on trees.  This is beneficial since it increases
8676 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8677 is enabled by default at @option{-O} and higher.  It is not enabled
8678 for @option{-Os}, since it usually increases code size.
8680 @item -ftree-loop-optimize
8681 @opindex ftree-loop-optimize
8682 Perform loop optimizations on trees.  This flag is enabled by default
8683 at @option{-O} and higher.
8685 @item -ftree-loop-linear
8686 @opindex ftree-loop-linear
8687 Perform loop interchange transformations on tree.  Same as
8688 @option{-floop-interchange}.  To use this code transformation, GCC has
8689 to be configured with @option{--with-isl} to enable the Graphite loop
8690 transformation infrastructure.
8692 @item -floop-interchange
8693 @opindex floop-interchange
8694 Perform loop interchange transformations on loops.  Interchanging two
8695 nested loops switches the inner and outer loops.  For example, given a
8696 loop like:
8697 @smallexample
8698 DO J = 1, M
8699   DO I = 1, N
8700     A(J, I) = A(J, I) * C
8701   ENDDO
8702 ENDDO
8703 @end smallexample
8704 @noindent
8705 loop interchange transforms the loop as if it were written:
8706 @smallexample
8707 DO I = 1, N
8708   DO J = 1, M
8709     A(J, I) = A(J, I) * C
8710   ENDDO
8711 ENDDO
8712 @end smallexample
8713 which can be beneficial when @code{N} is larger than the caches,
8714 because in Fortran, the elements of an array are stored in memory
8715 contiguously by column, and the original loop iterates over rows,
8716 potentially creating at each access a cache miss.  This optimization
8717 applies to all the languages supported by GCC and is not limited to
8718 Fortran.  To use this code transformation, GCC has to be configured
8719 with @option{--with-isl} to enable the Graphite loop transformation
8720 infrastructure.
8722 @item -floop-strip-mine
8723 @opindex floop-strip-mine
8724 Perform loop strip mining transformations on loops.  Strip mining
8725 splits a loop into two nested loops.  The outer loop has strides
8726 equal to the strip size and the inner loop has strides of the
8727 original loop within a strip.  The strip length can be changed
8728 using the @option{loop-block-tile-size} parameter.  For example,
8729 given a loop like:
8730 @smallexample
8731 DO I = 1, N
8732   A(I) = A(I) + C
8733 ENDDO
8734 @end smallexample
8735 @noindent
8736 loop strip mining transforms the loop as if it were written:
8737 @smallexample
8738 DO II = 1, N, 51
8739   DO I = II, min (II + 50, N)
8740     A(I) = A(I) + C
8741   ENDDO
8742 ENDDO
8743 @end smallexample
8744 This optimization applies to all the languages supported by GCC and is
8745 not limited to Fortran.  To use this code transformation, GCC has to
8746 be configured with @option{--with-isl} to enable the Graphite loop
8747 transformation infrastructure.
8749 @item -floop-block
8750 @opindex floop-block
8751 Perform loop blocking transformations on loops.  Blocking strip mines
8752 each loop in the loop nest such that the memory accesses of the
8753 element loops fit inside caches.  The strip length can be changed
8754 using the @option{loop-block-tile-size} parameter.  For example, given
8755 a loop like:
8756 @smallexample
8757 DO I = 1, N
8758   DO J = 1, M
8759     A(J, I) = B(I) + C(J)
8760   ENDDO
8761 ENDDO
8762 @end smallexample
8763 @noindent
8764 loop blocking transforms the loop as if it were written:
8765 @smallexample
8766 DO II = 1, N, 51
8767   DO JJ = 1, M, 51
8768     DO I = II, min (II + 50, N)
8769       DO J = JJ, min (JJ + 50, M)
8770         A(J, I) = B(I) + C(J)
8771       ENDDO
8772     ENDDO
8773   ENDDO
8774 ENDDO
8775 @end smallexample
8776 which can be beneficial when @code{M} is larger than the caches,
8777 because the innermost loop iterates over a smaller amount of data
8778 which can be kept in the caches.  This optimization applies to all the
8779 languages supported by GCC and is not limited to Fortran.  To use this
8780 code transformation, GCC has to be configured with @option{--with-isl}
8781 to enable the Graphite loop transformation infrastructure.
8783 @item -fgraphite-identity
8784 @opindex fgraphite-identity
8785 Enable the identity transformation for graphite.  For every SCoP we generate
8786 the polyhedral representation and transform it back to gimple.  Using
8787 @option{-fgraphite-identity} we can check the costs or benefits of the
8788 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8789 are also performed by the code generator ISL, like index splitting and
8790 dead code elimination in loops.
8792 @item -floop-nest-optimize
8793 @opindex floop-nest-optimize
8794 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8795 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8796 structure optimized for data-locality and parallelism.  This option
8797 is experimental.
8799 @item -floop-unroll-and-jam
8800 @opindex floop-unroll-and-jam
8801 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8802 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8803 The unrolled dimension (counting from the most inner one) can be changed 
8804 using the @option{loop-unroll-jam-depth} parameter.                 .
8806 @item -floop-parallelize-all
8807 @opindex floop-parallelize-all
8808 Use the Graphite data dependence analysis to identify loops that can
8809 be parallelized.  Parallelize all the loops that can be analyzed to
8810 not contain loop carried dependences without checking that it is
8811 profitable to parallelize the loops.
8813 @item -fcheck-data-deps
8814 @opindex fcheck-data-deps
8815 Compare the results of several data dependence analyzers.  This option
8816 is used for debugging the data dependence analyzers.
8818 @item -ftree-loop-if-convert
8819 @opindex ftree-loop-if-convert
8820 Attempt to transform conditional jumps in the innermost loops to
8821 branch-less equivalents.  The intent is to remove control-flow from
8822 the innermost loops in order to improve the ability of the
8823 vectorization pass to handle these loops.  This is enabled by default
8824 if vectorization is enabled.
8826 @item -ftree-loop-if-convert-stores
8827 @opindex ftree-loop-if-convert-stores
8828 Attempt to also if-convert conditional jumps containing memory writes.
8829 This transformation can be unsafe for multi-threaded programs as it
8830 transforms conditional memory writes into unconditional memory writes.
8831 For example,
8832 @smallexample
8833 for (i = 0; i < N; i++)
8834   if (cond)
8835     A[i] = expr;
8836 @end smallexample
8837 is transformed to
8838 @smallexample
8839 for (i = 0; i < N; i++)
8840   A[i] = cond ? expr : A[i];
8841 @end smallexample
8842 potentially producing data races.
8844 @item -ftree-loop-distribution
8845 @opindex ftree-loop-distribution
8846 Perform loop distribution.  This flag can improve cache performance on
8847 big loop bodies and allow further loop optimizations, like
8848 parallelization or vectorization, to take place.  For example, the loop
8849 @smallexample
8850 DO I = 1, N
8851   A(I) = B(I) + C
8852   D(I) = E(I) * F
8853 ENDDO
8854 @end smallexample
8855 is transformed to
8856 @smallexample
8857 DO I = 1, N
8858    A(I) = B(I) + C
8859 ENDDO
8860 DO I = 1, N
8861    D(I) = E(I) * F
8862 ENDDO
8863 @end smallexample
8865 @item -ftree-loop-distribute-patterns
8866 @opindex ftree-loop-distribute-patterns
8867 Perform loop distribution of patterns that can be code generated with
8868 calls to a library.  This flag is enabled by default at @option{-O3}.
8870 This pass distributes the initialization loops and generates a call to
8871 memset zero.  For example, the loop
8872 @smallexample
8873 DO I = 1, N
8874   A(I) = 0
8875   B(I) = A(I) + I
8876 ENDDO
8877 @end smallexample
8878 is transformed to
8879 @smallexample
8880 DO I = 1, N
8881    A(I) = 0
8882 ENDDO
8883 DO I = 1, N
8884    B(I) = A(I) + I
8885 ENDDO
8886 @end smallexample
8887 and the initialization loop is transformed into a call to memset zero.
8889 @item -ftree-loop-im
8890 @opindex ftree-loop-im
8891 Perform loop invariant motion on trees.  This pass moves only invariants that
8892 are hard to handle at RTL level (function calls, operations that expand to
8893 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8894 operands of conditions that are invariant out of the loop, so that we can use
8895 just trivial invariantness analysis in loop unswitching.  The pass also includes
8896 store motion.
8898 @item -ftree-loop-ivcanon
8899 @opindex ftree-loop-ivcanon
8900 Create a canonical counter for number of iterations in loops for which
8901 determining number of iterations requires complicated analysis.  Later
8902 optimizations then may determine the number easily.  Useful especially
8903 in connection with unrolling.
8905 @item -fivopts
8906 @opindex fivopts
8907 Perform induction variable optimizations (strength reduction, induction
8908 variable merging and induction variable elimination) on trees.
8910 @item -ftree-parallelize-loops=n
8911 @opindex ftree-parallelize-loops
8912 Parallelize loops, i.e., split their iteration space to run in n threads.
8913 This is only possible for loops whose iterations are independent
8914 and can be arbitrarily reordered.  The optimization is only
8915 profitable on multiprocessor machines, for loops that are CPU-intensive,
8916 rather than constrained e.g.@: by memory bandwidth.  This option
8917 implies @option{-pthread}, and thus is only supported on targets
8918 that have support for @option{-pthread}.
8920 @item -ftree-pta
8921 @opindex ftree-pta
8922 Perform function-local points-to analysis on trees.  This flag is
8923 enabled by default at @option{-O} and higher.
8925 @item -ftree-sra
8926 @opindex ftree-sra
8927 Perform scalar replacement of aggregates.  This pass replaces structure
8928 references with scalars to prevent committing structures to memory too
8929 early.  This flag is enabled by default at @option{-O} and higher.
8931 @item -ftree-copyrename
8932 @opindex ftree-copyrename
8933 Perform copy renaming on trees.  This pass attempts to rename compiler
8934 temporaries to other variables at copy locations, usually resulting in
8935 variable names which more closely resemble the original variables.  This flag
8936 is enabled by default at @option{-O} and higher.
8938 @item -ftree-coalesce-inlined-vars
8939 @opindex ftree-coalesce-inlined-vars
8940 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8941 combine small user-defined variables too, but only if they are inlined
8942 from other functions.  It is a more limited form of
8943 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8944 inlined variables, but it keeps variables of the inlined-into
8945 function apart from each other, such that they are more likely to
8946 contain the expected values in a debugging session.
8948 @item -ftree-coalesce-vars
8949 @opindex ftree-coalesce-vars
8950 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8951 combine small user-defined variables too, instead of just compiler
8952 temporaries.  This may severely limit the ability to debug an optimized
8953 program compiled with @option{-fno-var-tracking-assignments}.  In the
8954 negated form, this flag prevents SSA coalescing of user variables,
8955 including inlined ones.  This option is enabled by default.
8957 @item -ftree-ter
8958 @opindex ftree-ter
8959 Perform temporary expression replacement during the SSA->normal phase.  Single
8960 use/single def temporaries are replaced at their use location with their
8961 defining expression.  This results in non-GIMPLE code, but gives the expanders
8962 much more complex trees to work on resulting in better RTL generation.  This is
8963 enabled by default at @option{-O} and higher.
8965 @item -ftree-slsr
8966 @opindex ftree-slsr
8967 Perform straight-line strength reduction on trees.  This recognizes related
8968 expressions involving multiplications and replaces them by less expensive
8969 calculations when possible.  This is enabled by default at @option{-O} and
8970 higher.
8972 @item -ftree-vectorize
8973 @opindex ftree-vectorize
8974 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8975 and @option{-ftree-slp-vectorize} if not explicitly specified.
8977 @item -ftree-loop-vectorize
8978 @opindex ftree-loop-vectorize
8979 Perform loop vectorization on trees. This flag is enabled by default at
8980 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8982 @item -ftree-slp-vectorize
8983 @opindex ftree-slp-vectorize
8984 Perform basic block vectorization on trees. This flag is enabled by default at
8985 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8987 @item -fvect-cost-model=@var{model}
8988 @opindex fvect-cost-model
8989 Alter the cost model used for vectorization.  The @var{model} argument
8990 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8991 With the @samp{unlimited} model the vectorized code-path is assumed
8992 to be profitable while with the @samp{dynamic} model a runtime check
8993 guards the vectorized code-path to enable it only for iteration
8994 counts that will likely execute faster than when executing the original
8995 scalar loop.  The @samp{cheap} model disables vectorization of
8996 loops where doing so would be cost prohibitive for example due to
8997 required runtime checks for data dependence or alignment but otherwise
8998 is equal to the @samp{dynamic} model.
8999 The default cost model depends on other optimization flags and is
9000 either @samp{dynamic} or @samp{cheap}.
9002 @item -fsimd-cost-model=@var{model}
9003 @opindex fsimd-cost-model
9004 Alter the cost model used for vectorization of loops marked with the OpenMP
9005 or Cilk Plus simd directive.  The @var{model} argument should be one of
9006 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
9007 have the same meaning as described in @option{-fvect-cost-model} and by
9008 default a cost model defined with @option{-fvect-cost-model} is used.
9010 @item -ftree-vrp
9011 @opindex ftree-vrp
9012 Perform Value Range Propagation on trees.  This is similar to the
9013 constant propagation pass, but instead of values, ranges of values are
9014 propagated.  This allows the optimizers to remove unnecessary range
9015 checks like array bound checks and null pointer checks.  This is
9016 enabled by default at @option{-O2} and higher.  Null pointer check
9017 elimination is only done if @option{-fdelete-null-pointer-checks} is
9018 enabled.
9020 @item -fsplit-ivs-in-unroller
9021 @opindex fsplit-ivs-in-unroller
9022 Enables expression of values of induction variables in later iterations
9023 of the unrolled loop using the value in the first iteration.  This breaks
9024 long dependency chains, thus improving efficiency of the scheduling passes.
9026 A combination of @option{-fweb} and CSE is often sufficient to obtain the
9027 same effect.  However, that is not reliable in cases where the loop body
9028 is more complicated than a single basic block.  It also does not work at all
9029 on some architectures due to restrictions in the CSE pass.
9031 This optimization is enabled by default.
9033 @item -fvariable-expansion-in-unroller
9034 @opindex fvariable-expansion-in-unroller
9035 With this option, the compiler creates multiple copies of some
9036 local variables when unrolling a loop, which can result in superior code.
9038 @item -fpartial-inlining
9039 @opindex fpartial-inlining
9040 Inline parts of functions.  This option has any effect only
9041 when inlining itself is turned on by the @option{-finline-functions}
9042 or @option{-finline-small-functions} options.
9044 Enabled at level @option{-O2}.
9046 @item -fpredictive-commoning
9047 @opindex fpredictive-commoning
9048 Perform predictive commoning optimization, i.e., reusing computations
9049 (especially memory loads and stores) performed in previous
9050 iterations of loops.
9052 This option is enabled at level @option{-O3}.
9054 @item -fprefetch-loop-arrays
9055 @opindex fprefetch-loop-arrays
9056 If supported by the target machine, generate instructions to prefetch
9057 memory to improve the performance of loops that access large arrays.
9059 This option may generate better or worse code; results are highly
9060 dependent on the structure of loops within the source code.
9062 Disabled at level @option{-Os}.
9064 @item -fno-peephole
9065 @itemx -fno-peephole2
9066 @opindex fno-peephole
9067 @opindex fno-peephole2
9068 Disable any machine-specific peephole optimizations.  The difference
9069 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9070 are implemented in the compiler; some targets use one, some use the
9071 other, a few use both.
9073 @option{-fpeephole} is enabled by default.
9074 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9076 @item -fno-guess-branch-probability
9077 @opindex fno-guess-branch-probability
9078 Do not guess branch probabilities using heuristics.
9080 GCC uses heuristics to guess branch probabilities if they are
9081 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9082 heuristics are based on the control flow graph.  If some branch probabilities
9083 are specified by @code{__builtin_expect}, then the heuristics are
9084 used to guess branch probabilities for the rest of the control flow graph,
9085 taking the @code{__builtin_expect} info into account.  The interactions
9086 between the heuristics and @code{__builtin_expect} can be complex, and in
9087 some cases, it may be useful to disable the heuristics so that the effects
9088 of @code{__builtin_expect} are easier to understand.
9090 The default is @option{-fguess-branch-probability} at levels
9091 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9093 @item -freorder-blocks
9094 @opindex freorder-blocks
9095 Reorder basic blocks in the compiled function in order to reduce number of
9096 taken branches and improve code locality.
9098 Enabled at levels @option{-O2}, @option{-O3}.
9100 @item -freorder-blocks-and-partition
9101 @opindex freorder-blocks-and-partition
9102 In addition to reordering basic blocks in the compiled function, in order
9103 to reduce number of taken branches, partitions hot and cold basic blocks
9104 into separate sections of the assembly and .o files, to improve
9105 paging and cache locality performance.
9107 This optimization is automatically turned off in the presence of
9108 exception handling, for linkonce sections, for functions with a user-defined
9109 section attribute and on any architecture that does not support named
9110 sections.
9112 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9114 @item -freorder-functions
9115 @opindex freorder-functions
9116 Reorder functions in the object file in order to
9117 improve code locality.  This is implemented by using special
9118 subsections @code{.text.hot} for most frequently executed functions and
9119 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9120 the linker so object file format must support named sections and linker must
9121 place them in a reasonable way.
9123 Also profile feedback must be available to make this option effective.  See
9124 @option{-fprofile-arcs} for details.
9126 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9128 @item -fstrict-aliasing
9129 @opindex fstrict-aliasing
9130 Allow the compiler to assume the strictest aliasing rules applicable to
9131 the language being compiled.  For C (and C++), this activates
9132 optimizations based on the type of expressions.  In particular, an
9133 object of one type is assumed never to reside at the same address as an
9134 object of a different type, unless the types are almost the same.  For
9135 example, an @code{unsigned int} can alias an @code{int}, but not a
9136 @code{void*} or a @code{double}.  A character type may alias any other
9137 type.
9139 @anchor{Type-punning}Pay special attention to code like this:
9140 @smallexample
9141 union a_union @{
9142   int i;
9143   double d;
9146 int f() @{
9147   union a_union t;
9148   t.d = 3.0;
9149   return t.i;
9151 @end smallexample
9152 The practice of reading from a different union member than the one most
9153 recently written to (called ``type-punning'') is common.  Even with
9154 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9155 is accessed through the union type.  So, the code above works as
9156 expected.  @xref{Structures unions enumerations and bit-fields
9157 implementation}.  However, this code might not:
9158 @smallexample
9159 int f() @{
9160   union a_union t;
9161   int* ip;
9162   t.d = 3.0;
9163   ip = &t.i;
9164   return *ip;
9166 @end smallexample
9168 Similarly, access by taking the address, casting the resulting pointer
9169 and dereferencing the result has undefined behavior, even if the cast
9170 uses a union type, e.g.:
9171 @smallexample
9172 int f() @{
9173   double d = 3.0;
9174   return ((union a_union *) &d)->i;
9176 @end smallexample
9178 The @option{-fstrict-aliasing} option is enabled at levels
9179 @option{-O2}, @option{-O3}, @option{-Os}.
9181 @item -fstrict-overflow
9182 @opindex fstrict-overflow
9183 Allow the compiler to assume strict signed overflow rules, depending
9184 on the language being compiled.  For C (and C++) this means that
9185 overflow when doing arithmetic with signed numbers is undefined, which
9186 means that the compiler may assume that it does not happen.  This
9187 permits various optimizations.  For example, the compiler assumes
9188 that an expression like @code{i + 10 > i} is always true for
9189 signed @code{i}.  This assumption is only valid if signed overflow is
9190 undefined, as the expression is false if @code{i + 10} overflows when
9191 using twos complement arithmetic.  When this option is in effect any
9192 attempt to determine whether an operation on signed numbers 
9193 overflows must be written carefully to not actually involve overflow.
9195 This option also allows the compiler to assume strict pointer
9196 semantics: given a pointer to an object, if adding an offset to that
9197 pointer does not produce a pointer to the same object, the addition is
9198 undefined.  This permits the compiler to conclude that @code{p + u >
9199 p} is always true for a pointer @code{p} and unsigned integer
9200 @code{u}.  This assumption is only valid because pointer wraparound is
9201 undefined, as the expression is false if @code{p + u} overflows using
9202 twos complement arithmetic.
9204 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
9205 that integer signed overflow is fully defined: it wraps.  When
9206 @option{-fwrapv} is used, there is no difference between
9207 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
9208 integers.  With @option{-fwrapv} certain types of overflow are
9209 permitted.  For example, if the compiler gets an overflow when doing
9210 arithmetic on constants, the overflowed value can still be used with
9211 @option{-fwrapv}, but not otherwise.
9213 The @option{-fstrict-overflow} option is enabled at levels
9214 @option{-O2}, @option{-O3}, @option{-Os}.
9216 @item -falign-functions
9217 @itemx -falign-functions=@var{n}
9218 @opindex falign-functions
9219 Align the start of functions to the next power-of-two greater than
9220 @var{n}, skipping up to @var{n} bytes.  For instance,
9221 @option{-falign-functions=32} aligns functions to the next 32-byte
9222 boundary, but @option{-falign-functions=24} aligns to the next
9223 32-byte boundary only if this can be done by skipping 23 bytes or less.
9225 @option{-fno-align-functions} and @option{-falign-functions=1} are
9226 equivalent and mean that functions are not aligned.
9228 Some assemblers only support this flag when @var{n} is a power of two;
9229 in that case, it is rounded up.
9231 If @var{n} is not specified or is zero, use a machine-dependent default.
9233 Enabled at levels @option{-O2}, @option{-O3}.
9235 @item -falign-labels
9236 @itemx -falign-labels=@var{n}
9237 @opindex falign-labels
9238 Align all branch targets to a power-of-two boundary, skipping up to
9239 @var{n} bytes like @option{-falign-functions}.  This option can easily
9240 make code slower, because it must insert dummy operations for when the
9241 branch target is reached in the usual flow of the code.
9243 @option{-fno-align-labels} and @option{-falign-labels=1} are
9244 equivalent and mean that labels are not aligned.
9246 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9247 are greater than this value, then their values are used instead.
9249 If @var{n} is not specified or is zero, use a machine-dependent default
9250 which is very likely to be @samp{1}, meaning no alignment.
9252 Enabled at levels @option{-O2}, @option{-O3}.
9254 @item -falign-loops
9255 @itemx -falign-loops=@var{n}
9256 @opindex falign-loops
9257 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9258 like @option{-falign-functions}.  If the loops are
9259 executed many times, this makes up for any execution of the dummy
9260 operations.
9262 @option{-fno-align-loops} and @option{-falign-loops=1} are
9263 equivalent and mean that loops are not aligned.
9265 If @var{n} is not specified or is zero, use a machine-dependent default.
9267 Enabled at levels @option{-O2}, @option{-O3}.
9269 @item -falign-jumps
9270 @itemx -falign-jumps=@var{n}
9271 @opindex falign-jumps
9272 Align branch targets to a power-of-two boundary, for branch targets
9273 where the targets can only be reached by jumping, skipping up to @var{n}
9274 bytes like @option{-falign-functions}.  In this case, no dummy operations
9275 need be executed.
9277 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9278 equivalent and mean that loops are not aligned.
9280 If @var{n} is not specified or is zero, use a machine-dependent default.
9282 Enabled at levels @option{-O2}, @option{-O3}.
9284 @item -funit-at-a-time
9285 @opindex funit-at-a-time
9286 This option is left for compatibility reasons. @option{-funit-at-a-time}
9287 has no effect, while @option{-fno-unit-at-a-time} implies
9288 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9290 Enabled by default.
9292 @item -fno-toplevel-reorder
9293 @opindex fno-toplevel-reorder
9294 Do not reorder top-level functions, variables, and @code{asm}
9295 statements.  Output them in the same order that they appear in the
9296 input file.  When this option is used, unreferenced static variables
9297 are not removed.  This option is intended to support existing code
9298 that relies on a particular ordering.  For new code, it is better to
9299 use attributes when possible.
9301 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9302 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9303 targets.
9305 @item -fweb
9306 @opindex fweb
9307 Constructs webs as commonly used for register allocation purposes and assign
9308 each web individual pseudo register.  This allows the register allocation pass
9309 to operate on pseudos directly, but also strengthens several other optimization
9310 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9311 however, make debugging impossible, since variables no longer stay in a
9312 ``home register''.
9314 Enabled by default with @option{-funroll-loops}.
9316 @item -fwhole-program
9317 @opindex fwhole-program
9318 Assume that the current compilation unit represents the whole program being
9319 compiled.  All public functions and variables with the exception of @code{main}
9320 and those merged by attribute @code{externally_visible} become static functions
9321 and in effect are optimized more aggressively by interprocedural optimizers.
9323 This option should not be used in combination with @option{-flto}.
9324 Instead relying on a linker plugin should provide safer and more precise
9325 information.
9327 @item -flto[=@var{n}]
9328 @opindex flto
9329 This option runs the standard link-time optimizer.  When invoked
9330 with source code, it generates GIMPLE (one of GCC's internal
9331 representations) and writes it to special ELF sections in the object
9332 file.  When the object files are linked together, all the function
9333 bodies are read from these ELF sections and instantiated as if they
9334 had been part of the same translation unit.
9336 To use the link-time optimizer, @option{-flto} and optimization
9337 options should be specified at compile time and during the final link.
9338 For example:
9340 @smallexample
9341 gcc -c -O2 -flto foo.c
9342 gcc -c -O2 -flto bar.c
9343 gcc -o myprog -flto -O2 foo.o bar.o
9344 @end smallexample
9346 The first two invocations to GCC save a bytecode representation
9347 of GIMPLE into special ELF sections inside @file{foo.o} and
9348 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9349 @file{foo.o} and @file{bar.o}, merges the two files into a single
9350 internal image, and compiles the result as usual.  Since both
9351 @file{foo.o} and @file{bar.o} are merged into a single image, this
9352 causes all the interprocedural analyses and optimizations in GCC to
9353 work across the two files as if they were a single one.  This means,
9354 for example, that the inliner is able to inline functions in
9355 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9357 Another (simpler) way to enable link-time optimization is:
9359 @smallexample
9360 gcc -o myprog -flto -O2 foo.c bar.c
9361 @end smallexample
9363 The above generates bytecode for @file{foo.c} and @file{bar.c},
9364 merges them together into a single GIMPLE representation and optimizes
9365 them as usual to produce @file{myprog}.
9367 The only important thing to keep in mind is that to enable link-time
9368 optimizations you need to use the GCC driver to perform the link-step.
9369 GCC then automatically performs link-time optimization if any of the
9370 objects involved were compiled with the @option{-flto} command-line option.  
9371 You generally
9372 should specify the optimization options to be used for link-time
9373 optimization though GCC tries to be clever at guessing an
9374 optimization level to use from the options used at compile-time
9375 if you fail to specify one at link-time.  You can always override
9376 the automatic decision to do link-time optimization at link-time
9377 by passing @option{-fno-lto} to the link command.
9379 To make whole program optimization effective, it is necessary to make
9380 certain whole program assumptions.  The compiler needs to know
9381 what functions and variables can be accessed by libraries and runtime
9382 outside of the link-time optimized unit.  When supported by the linker,
9383 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9384 to the compiler about used and externally visible symbols.  When
9385 the linker plugin is not available, @option{-fwhole-program} should be
9386 used to allow the compiler to make these assumptions, which leads
9387 to more aggressive optimization decisions.
9389 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9390 compiled with @option{-flto}, the generated object file is larger than
9391 a regular object file because it contains GIMPLE bytecodes and the usual
9392 final code (see @option{-ffat-lto-objects}.  This means that
9393 object files with LTO information can be linked as normal object
9394 files; if @option{-fno-lto} is passed to the linker, no
9395 interprocedural optimizations are applied.  Note that when
9396 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9397 but you cannot perform a regular, non-LTO link on them.
9399 Additionally, the optimization flags used to compile individual files
9400 are not necessarily related to those used at link time.  For instance,
9402 @smallexample
9403 gcc -c -O0 -ffat-lto-objects -flto foo.c
9404 gcc -c -O0 -ffat-lto-objects -flto bar.c
9405 gcc -o myprog -O3 foo.o bar.o
9406 @end smallexample
9408 This produces individual object files with unoptimized assembler
9409 code, but the resulting binary @file{myprog} is optimized at
9410 @option{-O3}.  If, instead, the final binary is generated with
9411 @option{-fno-lto}, then @file{myprog} is not optimized.
9413 When producing the final binary, GCC only
9414 applies link-time optimizations to those files that contain bytecode.
9415 Therefore, you can mix and match object files and libraries with
9416 GIMPLE bytecodes and final object code.  GCC automatically selects
9417 which files to optimize in LTO mode and which files to link without
9418 further processing.
9420 There are some code generation flags preserved by GCC when
9421 generating bytecodes, as they need to be used during the final link
9422 stage.  Generally options specified at link-time override those
9423 specified at compile-time.
9425 If you do not specify an optimization level option @option{-O} at
9426 link-time then GCC computes one based on the optimization levels
9427 used when compiling the object files.  The highest optimization
9428 level wins here.
9430 Currently, the following options and their setting are take from
9431 the first object file that explicitely specified it: 
9432 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9433 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9434 and all the @option{-m} target flags.
9436 Certain ABI changing flags are required to match in all compilation-units
9437 and trying to override this at link-time with a conflicting value
9438 is ignored.  This includes options such as @option{-freg-struct-return}
9439 and @option{-fpcc-struct-return}. 
9441 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9442 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9443 are passed through to the link stage and merged conservatively for
9444 conflicting translation units.  Specifically
9445 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9446 precedence and for example @option{-ffp-contract=off} takes precedence
9447 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9449 It is recommended that you compile all the files participating in the
9450 same link with the same options and also specify those options at
9451 link time.
9453 If LTO encounters objects with C linkage declared with incompatible
9454 types in separate translation units to be linked together (undefined
9455 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9456 issued.  The behavior is still undefined at run time.  Similar
9457 diagnostics may be raised for other languages.
9459 Another feature of LTO is that it is possible to apply interprocedural
9460 optimizations on files written in different languages:
9462 @smallexample
9463 gcc -c -flto foo.c
9464 g++ -c -flto bar.cc
9465 gfortran -c -flto baz.f90
9466 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9467 @end smallexample
9469 Notice that the final link is done with @command{g++} to get the C++
9470 runtime libraries and @option{-lgfortran} is added to get the Fortran
9471 runtime libraries.  In general, when mixing languages in LTO mode, you
9472 should use the same link command options as when mixing languages in a
9473 regular (non-LTO) compilation.
9475 If object files containing GIMPLE bytecode are stored in a library archive, say
9476 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9477 are using a linker with plugin support.  To create static libraries suitable
9478 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9479 and @command{ranlib}; 
9480 to show the symbols of object files with GIMPLE bytecode, use
9481 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9482 and @command{nm} have been compiled with plugin support.  At link time, use the the
9483 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9484 the LTO optimization process:
9486 @smallexample
9487 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9488 @end smallexample
9490 With the linker plugin enabled, the linker extracts the needed
9491 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9492 to make them part of the aggregated GIMPLE image to be optimized.
9494 If you are not using a linker with plugin support and/or do not
9495 enable the linker plugin, then the objects inside @file{libfoo.a}
9496 are extracted and linked as usual, but they do not participate
9497 in the LTO optimization process.  In order to make a static library suitable
9498 for both LTO optimization and usual linkage, compile its object files with
9499 @option{-flto} @option{-ffat-lto-objects}.
9501 Link-time optimizations do not require the presence of the whole program to
9502 operate.  If the program does not require any symbols to be exported, it is
9503 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9504 the interprocedural optimizers to use more aggressive assumptions which may
9505 lead to improved optimization opportunities.
9506 Use of @option{-fwhole-program} is not needed when linker plugin is
9507 active (see @option{-fuse-linker-plugin}).
9509 The current implementation of LTO makes no
9510 attempt to generate bytecode that is portable between different
9511 types of hosts.  The bytecode files are versioned and there is a
9512 strict version check, so bytecode files generated in one version of
9513 GCC do not work with an older or newer version of GCC.
9515 Link-time optimization does not work well with generation of debugging
9516 information.  Combining @option{-flto} with
9517 @option{-g} is currently experimental and expected to produce unexpected
9518 results.
9520 If you specify the optional @var{n}, the optimization and code
9521 generation done at link time is executed in parallel using @var{n}
9522 parallel jobs by utilizing an installed @command{make} program.  The
9523 environment variable @env{MAKE} may be used to override the program
9524 used.  The default value for @var{n} is 1.
9526 You can also specify @option{-flto=jobserver} to use GNU make's
9527 job server mode to determine the number of parallel jobs. This
9528 is useful when the Makefile calling GCC is already executing in parallel.
9529 You must prepend a @samp{+} to the command recipe in the parent Makefile
9530 for this to work.  This option likely only works if @env{MAKE} is
9531 GNU make.
9533 @item -flto-partition=@var{alg}
9534 @opindex flto-partition
9535 Specify the partitioning algorithm used by the link-time optimizer.
9536 The value is either @samp{1to1} to specify a partitioning mirroring
9537 the original source files or @samp{balanced} to specify partitioning
9538 into equally sized chunks (whenever possible) or @samp{max} to create
9539 new partition for every symbol where possible.  Specifying @samp{none}
9540 as an algorithm disables partitioning and streaming completely. 
9541 The default value is @samp{balanced}. While @samp{1to1} can be used
9542 as an workaround for various code ordering issues, the @samp{max}
9543 partitioning is intended for internal testing only.
9544 The value @samp{one} specifies that exactly one partition should be
9545 used while the value @samp{none} bypasses partitioning and executes
9546 the link-time optimization step directly from the WPA phase.
9548 @item -flto-odr-type-merging
9549 @opindex flto-odr-type-merging
9550 Enable streaming of mangled types names of C++ types and their unification
9551 at linktime.  This increases size of LTO object files, but enable
9552 diagnostics about One Definition Rule violations.
9554 @item -flto-compression-level=@var{n}
9555 @opindex flto-compression-level
9556 This option specifies the level of compression used for intermediate
9557 language written to LTO object files, and is only meaningful in
9558 conjunction with LTO mode (@option{-flto}).  Valid
9559 values are 0 (no compression) to 9 (maximum compression).  Values
9560 outside this range are clamped to either 0 or 9.  If the option is not
9561 given, a default balanced compression setting is used.
9563 @item -flto-report
9564 @opindex flto-report
9565 Prints a report with internal details on the workings of the link-time
9566 optimizer.  The contents of this report vary from version to version.
9567 It is meant to be useful to GCC developers when processing object
9568 files in LTO mode (via @option{-flto}).
9570 Disabled by default.
9572 @item -flto-report-wpa
9573 @opindex flto-report-wpa
9574 Like @option{-flto-report}, but only print for the WPA phase of Link
9575 Time Optimization.
9577 @item -fuse-linker-plugin
9578 @opindex fuse-linker-plugin
9579 Enables the use of a linker plugin during link-time optimization.  This
9580 option relies on plugin support in the linker, which is available in gold
9581 or in GNU ld 2.21 or newer.
9583 This option enables the extraction of object files with GIMPLE bytecode out
9584 of library archives. This improves the quality of optimization by exposing
9585 more code to the link-time optimizer.  This information specifies what
9586 symbols can be accessed externally (by non-LTO object or during dynamic
9587 linking).  Resulting code quality improvements on binaries (and shared
9588 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9589 See @option{-flto} for a description of the effect of this flag and how to
9590 use it.
9592 This option is enabled by default when LTO support in GCC is enabled
9593 and GCC was configured for use with
9594 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9596 @item -ffat-lto-objects
9597 @opindex ffat-lto-objects
9598 Fat LTO objects are object files that contain both the intermediate language
9599 and the object code. This makes them usable for both LTO linking and normal
9600 linking. This option is effective only when compiling with @option{-flto}
9601 and is ignored at link time.
9603 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9604 requires the complete toolchain to be aware of LTO. It requires a linker with
9605 linker plugin support for basic functionality.  Additionally,
9606 @command{nm}, @command{ar} and @command{ranlib}
9607 need to support linker plugins to allow a full-featured build environment
9608 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9609 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9610 to these tools. With non fat LTO makefiles need to be modified to use them.
9612 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9613 support.
9615 @item -fcompare-elim
9616 @opindex fcompare-elim
9617 After register allocation and post-register allocation instruction splitting,
9618 identify arithmetic instructions that compute processor flags similar to a
9619 comparison operation based on that arithmetic.  If possible, eliminate the
9620 explicit comparison operation.
9622 This pass only applies to certain targets that cannot explicitly represent
9623 the comparison operation before register allocation is complete.
9625 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9627 @item -fcprop-registers
9628 @opindex fcprop-registers
9629 After register allocation and post-register allocation instruction splitting,
9630 perform a copy-propagation pass to try to reduce scheduling dependencies
9631 and occasionally eliminate the copy.
9633 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9635 @item -fprofile-correction
9636 @opindex fprofile-correction
9637 Profiles collected using an instrumented binary for multi-threaded programs may
9638 be inconsistent due to missed counter updates. When this option is specified,
9639 GCC uses heuristics to correct or smooth out such inconsistencies. By
9640 default, GCC emits an error message when an inconsistent profile is detected.
9642 @item -fprofile-dir=@var{path}
9643 @opindex fprofile-dir
9645 Set the directory to search for the profile data files in to @var{path}.
9646 This option affects only the profile data generated by
9647 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9648 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9649 and its related options.  Both absolute and relative paths can be used.
9650 By default, GCC uses the current directory as @var{path}, thus the
9651 profile data file appears in the same directory as the object file.
9653 @item -fprofile-generate
9654 @itemx -fprofile-generate=@var{path}
9655 @opindex fprofile-generate
9657 Enable options usually used for instrumenting application to produce
9658 profile useful for later recompilation with profile feedback based
9659 optimization.  You must use @option{-fprofile-generate} both when
9660 compiling and when linking your program.
9662 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9664 If @var{path} is specified, GCC looks at the @var{path} to find
9665 the profile feedback data files. See @option{-fprofile-dir}.
9667 @item -fprofile-use
9668 @itemx -fprofile-use=@var{path}
9669 @opindex fprofile-use
9670 Enable profile feedback-directed optimizations, 
9671 and the following optimizations
9672 which are generally profitable only with profile feedback available:
9673 @option{-fbranch-probabilities}, @option{-fvpt},
9674 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9675 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9677 By default, GCC emits an error message if the feedback profiles do not
9678 match the source code.  This error can be turned into a warning by using
9679 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9680 code.
9682 If @var{path} is specified, GCC looks at the @var{path} to find
9683 the profile feedback data files. See @option{-fprofile-dir}.
9685 @item -fauto-profile
9686 @itemx -fauto-profile=@var{path}
9687 @opindex fauto-profile
9688 Enable sampling-based feedback-directed optimizations, 
9689 and the following optimizations
9690 which are generally profitable only with profile feedback available:
9691 @option{-fbranch-probabilities}, @option{-fvpt},
9692 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9693 @option{-ftree-vectorize},
9694 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9695 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9696 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9698 @var{path} is the name of a file containing AutoFDO profile information.
9699 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9701 Producing an AutoFDO profile data file requires running your program
9702 with the @command{perf} utility on a supported GNU/Linux target system.
9703 For more information, see @uref{https://perf.wiki.kernel.org/}.
9705 E.g.
9706 @smallexample
9707 perf record -e br_inst_retired:near_taken -b -o perf.data \
9708     -- your_program
9709 @end smallexample
9711 Then use the @command{create_gcov} tool to convert the raw profile data
9712 to a format that can be used by GCC.@  You must also supply the 
9713 unstripped binary for your program to this tool.  
9714 See @uref{https://github.com/google/autofdo}.
9716 E.g.
9717 @smallexample
9718 create_gcov --binary=your_program.unstripped --profile=perf.data \
9719     --gcov=profile.afdo
9720 @end smallexample
9721 @end table
9723 The following options control compiler behavior regarding floating-point 
9724 arithmetic.  These options trade off between speed and
9725 correctness.  All must be specifically enabled.
9727 @table @gcctabopt
9728 @item -ffloat-store
9729 @opindex ffloat-store
9730 Do not store floating-point variables in registers, and inhibit other
9731 options that might change whether a floating-point value is taken from a
9732 register or memory.
9734 @cindex floating-point precision
9735 This option prevents undesirable excess precision on machines such as
9736 the 68000 where the floating registers (of the 68881) keep more
9737 precision than a @code{double} is supposed to have.  Similarly for the
9738 x86 architecture.  For most programs, the excess precision does only
9739 good, but a few programs rely on the precise definition of IEEE floating
9740 point.  Use @option{-ffloat-store} for such programs, after modifying
9741 them to store all pertinent intermediate computations into variables.
9743 @item -fexcess-precision=@var{style}
9744 @opindex fexcess-precision
9745 This option allows further control over excess precision on machines
9746 where floating-point registers have more precision than the IEEE
9747 @code{float} and @code{double} types and the processor does not
9748 support operations rounding to those types.  By default,
9749 @option{-fexcess-precision=fast} is in effect; this means that
9750 operations are carried out in the precision of the registers and that
9751 it is unpredictable when rounding to the types specified in the source
9752 code takes place.  When compiling C, if
9753 @option{-fexcess-precision=standard} is specified then excess
9754 precision follows the rules specified in ISO C99; in particular,
9755 both casts and assignments cause values to be rounded to their
9756 semantic types (whereas @option{-ffloat-store} only affects
9757 assignments).  This option is enabled by default for C if a strict
9758 conformance option such as @option{-std=c99} is used.
9760 @opindex mfpmath
9761 @option{-fexcess-precision=standard} is not implemented for languages
9762 other than C, and has no effect if
9763 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9764 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9765 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9766 semantics apply without excess precision, and in the latter, rounding
9767 is unpredictable.
9769 @item -ffast-math
9770 @opindex ffast-math
9771 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9772 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9773 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9775 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9777 This option is not turned on by any @option{-O} option besides
9778 @option{-Ofast} since it can result in incorrect output for programs
9779 that depend on an exact implementation of IEEE or ISO rules/specifications
9780 for math functions. It may, however, yield faster code for programs
9781 that do not require the guarantees of these specifications.
9783 @item -fno-math-errno
9784 @opindex fno-math-errno
9785 Do not set @code{errno} after calling math functions that are executed
9786 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9787 IEEE exceptions for math error handling may want to use this flag
9788 for speed while maintaining IEEE arithmetic compatibility.
9790 This option is not turned on by any @option{-O} option since
9791 it can result in incorrect output for programs that depend on
9792 an exact implementation of IEEE or ISO rules/specifications for
9793 math functions. It may, however, yield faster code for programs
9794 that do not require the guarantees of these specifications.
9796 The default is @option{-fmath-errno}.
9798 On Darwin systems, the math library never sets @code{errno}.  There is
9799 therefore no reason for the compiler to consider the possibility that
9800 it might, and @option{-fno-math-errno} is the default.
9802 @item -funsafe-math-optimizations
9803 @opindex funsafe-math-optimizations
9805 Allow optimizations for floating-point arithmetic that (a) assume
9806 that arguments and results are valid and (b) may violate IEEE or
9807 ANSI standards.  When used at link-time, it may include libraries
9808 or startup files that change the default FPU control word or other
9809 similar optimizations.
9811 This option is not turned on by any @option{-O} option since
9812 it can result in incorrect output for programs that depend on
9813 an exact implementation of IEEE or ISO rules/specifications for
9814 math functions. It may, however, yield faster code for programs
9815 that do not require the guarantees of these specifications.
9816 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9817 @option{-fassociative-math} and @option{-freciprocal-math}.
9819 The default is @option{-fno-unsafe-math-optimizations}.
9821 @item -fassociative-math
9822 @opindex fassociative-math
9824 Allow re-association of operands in series of floating-point operations.
9825 This violates the ISO C and C++ language standard by possibly changing
9826 computation result.  NOTE: re-ordering may change the sign of zero as
9827 well as ignore NaNs and inhibit or create underflow or overflow (and
9828 thus cannot be used on code that relies on rounding behavior like
9829 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9830 and thus may not be used when ordered comparisons are required.
9831 This option requires that both @option{-fno-signed-zeros} and
9832 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9833 much sense with @option{-frounding-math}. For Fortran the option
9834 is automatically enabled when both @option{-fno-signed-zeros} and
9835 @option{-fno-trapping-math} are in effect.
9837 The default is @option{-fno-associative-math}.
9839 @item -freciprocal-math
9840 @opindex freciprocal-math
9842 Allow the reciprocal of a value to be used instead of dividing by
9843 the value if this enables optimizations.  For example @code{x / y}
9844 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9845 is subject to common subexpression elimination.  Note that this loses
9846 precision and increases the number of flops operating on the value.
9848 The default is @option{-fno-reciprocal-math}.
9850 @item -ffinite-math-only
9851 @opindex ffinite-math-only
9852 Allow optimizations for floating-point arithmetic that assume
9853 that arguments and results are not NaNs or +-Infs.
9855 This option is not turned on by any @option{-O} option since
9856 it can result in incorrect output for programs that depend on
9857 an exact implementation of IEEE or ISO rules/specifications for
9858 math functions. It may, however, yield faster code for programs
9859 that do not require the guarantees of these specifications.
9861 The default is @option{-fno-finite-math-only}.
9863 @item -fno-signed-zeros
9864 @opindex fno-signed-zeros
9865 Allow optimizations for floating-point arithmetic that ignore the
9866 signedness of zero.  IEEE arithmetic specifies the behavior of
9867 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9868 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9869 This option implies that the sign of a zero result isn't significant.
9871 The default is @option{-fsigned-zeros}.
9873 @item -fno-trapping-math
9874 @opindex fno-trapping-math
9875 Compile code assuming that floating-point operations cannot generate
9876 user-visible traps.  These traps include division by zero, overflow,
9877 underflow, inexact result and invalid operation.  This option requires
9878 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9879 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9881 This option should never be turned on by any @option{-O} option since
9882 it can result in incorrect output for programs that depend on
9883 an exact implementation of IEEE or ISO rules/specifications for
9884 math functions.
9886 The default is @option{-ftrapping-math}.
9888 @item -frounding-math
9889 @opindex frounding-math
9890 Disable transformations and optimizations that assume default floating-point
9891 rounding behavior.  This is round-to-zero for all floating point
9892 to integer conversions, and round-to-nearest for all other arithmetic
9893 truncations.  This option should be specified for programs that change
9894 the FP rounding mode dynamically, or that may be executed with a
9895 non-default rounding mode.  This option disables constant folding of
9896 floating-point expressions at compile time (which may be affected by
9897 rounding mode) and arithmetic transformations that are unsafe in the
9898 presence of sign-dependent rounding modes.
9900 The default is @option{-fno-rounding-math}.
9902 This option is experimental and does not currently guarantee to
9903 disable all GCC optimizations that are affected by rounding mode.
9904 Future versions of GCC may provide finer control of this setting
9905 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9906 will be used to specify the default state for @code{FENV_ACCESS}.
9908 @item -fsignaling-nans
9909 @opindex fsignaling-nans
9910 Compile code assuming that IEEE signaling NaNs may generate user-visible
9911 traps during floating-point operations.  Setting this option disables
9912 optimizations that may change the number of exceptions visible with
9913 signaling NaNs.  This option implies @option{-ftrapping-math}.
9915 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9916 be defined.
9918 The default is @option{-fno-signaling-nans}.
9920 This option is experimental and does not currently guarantee to
9921 disable all GCC optimizations that affect signaling NaN behavior.
9923 @item -fsingle-precision-constant
9924 @opindex fsingle-precision-constant
9925 Treat floating-point constants as single precision instead of
9926 implicitly converting them to double-precision constants.
9928 @item -fcx-limited-range
9929 @opindex fcx-limited-range
9930 When enabled, this option states that a range reduction step is not
9931 needed when performing complex division.  Also, there is no checking
9932 whether the result of a complex multiplication or division is @code{NaN
9933 + I*NaN}, with an attempt to rescue the situation in that case.  The
9934 default is @option{-fno-cx-limited-range}, but is enabled by
9935 @option{-ffast-math}.
9937 This option controls the default setting of the ISO C99
9938 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9939 all languages.
9941 @item -fcx-fortran-rules
9942 @opindex fcx-fortran-rules
9943 Complex multiplication and division follow Fortran rules.  Range
9944 reduction is done as part of complex division, but there is no checking
9945 whether the result of a complex multiplication or division is @code{NaN
9946 + I*NaN}, with an attempt to rescue the situation in that case.
9948 The default is @option{-fno-cx-fortran-rules}.
9950 @end table
9952 The following options control optimizations that may improve
9953 performance, but are not enabled by any @option{-O} options.  This
9954 section includes experimental options that may produce broken code.
9956 @table @gcctabopt
9957 @item -fbranch-probabilities
9958 @opindex fbranch-probabilities
9959 After running a program compiled with @option{-fprofile-arcs}
9960 (@pxref{Debugging Options,, Options for Debugging Your Program or
9961 @command{gcc}}), you can compile it a second time using
9962 @option{-fbranch-probabilities}, to improve optimizations based on
9963 the number of times each branch was taken.  When a program
9964 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9965 counts to a file called @file{@var{sourcename}.gcda} for each source
9966 file.  The information in this data file is very dependent on the
9967 structure of the generated code, so you must use the same source code
9968 and the same optimization options for both compilations.
9970 With @option{-fbranch-probabilities}, GCC puts a
9971 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9972 These can be used to improve optimization.  Currently, they are only
9973 used in one place: in @file{reorg.c}, instead of guessing which path a
9974 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9975 exactly determine which path is taken more often.
9977 @item -fprofile-values
9978 @opindex fprofile-values
9979 If combined with @option{-fprofile-arcs}, it adds code so that some
9980 data about values of expressions in the program is gathered.
9982 With @option{-fbranch-probabilities}, it reads back the data gathered
9983 from profiling values of expressions for usage in optimizations.
9985 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9987 @item -fprofile-reorder-functions
9988 @opindex fprofile-reorder-functions
9989 Function reordering based on profile instrumentation collects
9990 first time of execution of a function and orders these functions
9991 in ascending order.
9993 Enabled with @option{-fprofile-use}.
9995 @item -fvpt
9996 @opindex fvpt
9997 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9998 to add code to gather information about values of expressions.
10000 With @option{-fbranch-probabilities}, it reads back the data gathered
10001 and actually performs the optimizations based on them.
10002 Currently the optimizations include specialization of division operations
10003 using the knowledge about the value of the denominator.
10005 @item -frename-registers
10006 @opindex frename-registers
10007 Attempt to avoid false dependencies in scheduled code by making use
10008 of registers left over after register allocation.  This optimization
10009 most benefits processors with lots of registers.  Depending on the
10010 debug information format adopted by the target, however, it can
10011 make debugging impossible, since variables no longer stay in
10012 a ``home register''.
10014 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
10016 @item -fschedule-fusion
10017 @opindex fschedule-fusion
10018 Performs a target dependent pass over the instruction stream to schedule
10019 instructions of same type together because target machine can execute them
10020 more efficiently if they are adjacent to each other in the instruction flow.
10022 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10024 @item -ftracer
10025 @opindex ftracer
10026 Perform tail duplication to enlarge superblock size.  This transformation
10027 simplifies the control flow of the function allowing other optimizations to do
10028 a better job.
10030 Enabled with @option{-fprofile-use}.
10032 @item -funroll-loops
10033 @opindex funroll-loops
10034 Unroll loops whose number of iterations can be determined at compile time or
10035 upon entry to the loop.  @option{-funroll-loops} implies
10036 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10037 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10038 a small constant number of iterations).  This option makes code larger, and may
10039 or may not make it run faster.
10041 Enabled with @option{-fprofile-use}.
10043 @item -funroll-all-loops
10044 @opindex funroll-all-loops
10045 Unroll all loops, even if their number of iterations is uncertain when
10046 the loop is entered.  This usually makes programs run more slowly.
10047 @option{-funroll-all-loops} implies the same options as
10048 @option{-funroll-loops}.
10050 @item -fpeel-loops
10051 @opindex fpeel-loops
10052 Peels loops for which there is enough information that they do not
10053 roll much (from profile feedback).  It also turns on complete loop peeling
10054 (i.e.@: complete removal of loops with small constant number of iterations).
10056 Enabled with @option{-fprofile-use}.
10058 @item -fmove-loop-invariants
10059 @opindex fmove-loop-invariants
10060 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10061 at level @option{-O1}
10063 @item -funswitch-loops
10064 @opindex funswitch-loops
10065 Move branches with loop invariant conditions out of the loop, with duplicates
10066 of the loop on both branches (modified according to result of the condition).
10068 @item -ffunction-sections
10069 @itemx -fdata-sections
10070 @opindex ffunction-sections
10071 @opindex fdata-sections
10072 Place each function or data item into its own section in the output
10073 file if the target supports arbitrary sections.  The name of the
10074 function or the name of the data item determines the section's name
10075 in the output file.
10077 Use these options on systems where the linker can perform optimizations
10078 to improve locality of reference in the instruction space.  Most systems
10079 using the ELF object format and SPARC processors running Solaris 2 have
10080 linkers with such optimizations.  AIX may have these optimizations in
10081 the future.
10083 Only use these options when there are significant benefits from doing
10084 so.  When you specify these options, the assembler and linker
10085 create larger object and executable files and are also slower.
10086 You cannot use @command{gprof} on all systems if you
10087 specify this option, and you may have problems with debugging if
10088 you specify both this option and @option{-g}.
10090 @item -fbranch-target-load-optimize
10091 @opindex fbranch-target-load-optimize
10092 Perform branch target register load optimization before prologue / epilogue
10093 threading.
10094 The use of target registers can typically be exposed only during reload,
10095 thus hoisting loads out of loops and doing inter-block scheduling needs
10096 a separate optimization pass.
10098 @item -fbranch-target-load-optimize2
10099 @opindex fbranch-target-load-optimize2
10100 Perform branch target register load optimization after prologue / epilogue
10101 threading.
10103 @item -fbtr-bb-exclusive
10104 @opindex fbtr-bb-exclusive
10105 When performing branch target register load optimization, don't reuse
10106 branch target registers within any basic block.
10108 @item -fstack-protector
10109 @opindex fstack-protector
10110 Emit extra code to check for buffer overflows, such as stack smashing
10111 attacks.  This is done by adding a guard variable to functions with
10112 vulnerable objects.  This includes functions that call @code{alloca}, and
10113 functions with buffers larger than 8 bytes.  The guards are initialized
10114 when a function is entered and then checked when the function exits.
10115 If a guard check fails, an error message is printed and the program exits.
10117 @item -fstack-protector-all
10118 @opindex fstack-protector-all
10119 Like @option{-fstack-protector} except that all functions are protected.
10121 @item -fstack-protector-strong
10122 @opindex fstack-protector-strong
10123 Like @option{-fstack-protector} but includes additional functions to
10124 be protected --- those that have local array definitions, or have
10125 references to local frame addresses.
10127 @item -fstack-protector-explicit
10128 @opindex fstack-protector-explicit
10129 Like @option{-fstack-protector} but only protects those functions which
10130 have the @code{stack_protect} attribute
10132 @item -fstdarg-opt
10133 @opindex fstdarg-opt
10134 Optimize the prologue of variadic argument functions with respect to usage of
10135 those arguments.
10137 @item -fsection-anchors
10138 @opindex fsection-anchors
10139 Try to reduce the number of symbolic address calculations by using
10140 shared ``anchor'' symbols to address nearby objects.  This transformation
10141 can help to reduce the number of GOT entries and GOT accesses on some
10142 targets.
10144 For example, the implementation of the following function @code{foo}:
10146 @smallexample
10147 static int a, b, c;
10148 int foo (void) @{ return a + b + c; @}
10149 @end smallexample
10151 @noindent
10152 usually calculates the addresses of all three variables, but if you
10153 compile it with @option{-fsection-anchors}, it accesses the variables
10154 from a common anchor point instead.  The effect is similar to the
10155 following pseudocode (which isn't valid C):
10157 @smallexample
10158 int foo (void)
10160   register int *xr = &x;
10161   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10163 @end smallexample
10165 Not all targets support this option.
10167 @item --param @var{name}=@var{value}
10168 @opindex param
10169 In some places, GCC uses various constants to control the amount of
10170 optimization that is done.  For example, GCC does not inline functions
10171 that contain more than a certain number of instructions.  You can
10172 control some of these constants on the command line using the
10173 @option{--param} option.
10175 The names of specific parameters, and the meaning of the values, are
10176 tied to the internals of the compiler, and are subject to change
10177 without notice in future releases.
10179 In each case, the @var{value} is an integer.  The allowable choices for
10180 @var{name} are:
10182 @table @gcctabopt
10183 @item predictable-branch-outcome
10184 When branch is predicted to be taken with probability lower than this threshold
10185 (in percent), then it is considered well predictable. The default is 10.
10187 @item max-crossjump-edges
10188 The maximum number of incoming edges to consider for cross-jumping.
10189 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10190 the number of edges incoming to each block.  Increasing values mean
10191 more aggressive optimization, making the compilation time increase with
10192 probably small improvement in executable size.
10194 @item min-crossjump-insns
10195 The minimum number of instructions that must be matched at the end
10196 of two blocks before cross-jumping is performed on them.  This
10197 value is ignored in the case where all instructions in the block being
10198 cross-jumped from are matched.  The default value is 5.
10200 @item max-grow-copy-bb-insns
10201 The maximum code size expansion factor when copying basic blocks
10202 instead of jumping.  The expansion is relative to a jump instruction.
10203 The default value is 8.
10205 @item max-goto-duplication-insns
10206 The maximum number of instructions to duplicate to a block that jumps
10207 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10208 passes, GCC factors computed gotos early in the compilation process,
10209 and unfactors them as late as possible.  Only computed jumps at the
10210 end of a basic blocks with no more than max-goto-duplication-insns are
10211 unfactored.  The default value is 8.
10213 @item max-delay-slot-insn-search
10214 The maximum number of instructions to consider when looking for an
10215 instruction to fill a delay slot.  If more than this arbitrary number of
10216 instructions are searched, the time savings from filling the delay slot
10217 are minimal, so stop searching.  Increasing values mean more
10218 aggressive optimization, making the compilation time increase with probably
10219 small improvement in execution time.
10221 @item max-delay-slot-live-search
10222 When trying to fill delay slots, the maximum number of instructions to
10223 consider when searching for a block with valid live register
10224 information.  Increasing this arbitrarily chosen value means more
10225 aggressive optimization, increasing the compilation time.  This parameter
10226 should be removed when the delay slot code is rewritten to maintain the
10227 control-flow graph.
10229 @item max-gcse-memory
10230 The approximate maximum amount of memory that can be allocated in
10231 order to perform the global common subexpression elimination
10232 optimization.  If more memory than specified is required, the
10233 optimization is not done.
10235 @item max-gcse-insertion-ratio
10236 If the ratio of expression insertions to deletions is larger than this value
10237 for any expression, then RTL PRE inserts or removes the expression and thus
10238 leaves partially redundant computations in the instruction stream.  The default value is 20.
10240 @item max-pending-list-length
10241 The maximum number of pending dependencies scheduling allows
10242 before flushing the current state and starting over.  Large functions
10243 with few branches or calls can create excessively large lists which
10244 needlessly consume memory and resources.
10246 @item max-modulo-backtrack-attempts
10247 The maximum number of backtrack attempts the scheduler should make
10248 when modulo scheduling a loop.  Larger values can exponentially increase
10249 compilation time.
10251 @item max-inline-insns-single
10252 Several parameters control the tree inliner used in GCC@.
10253 This number sets the maximum number of instructions (counted in GCC's
10254 internal representation) in a single function that the tree inliner
10255 considers for inlining.  This only affects functions declared
10256 inline and methods implemented in a class declaration (C++).
10257 The default value is 400.
10259 @item max-inline-insns-auto
10260 When you use @option{-finline-functions} (included in @option{-O3}),
10261 a lot of functions that would otherwise not be considered for inlining
10262 by the compiler are investigated.  To those functions, a different
10263 (more restrictive) limit compared to functions declared inline can
10264 be applied.
10265 The default value is 40.
10267 @item inline-min-speedup
10268 When estimated performance improvement of caller + callee runtime exceeds this
10269 threshold (in precent), the function can be inlined regardless the limit on
10270 @option{--param max-inline-insns-single} and @option{--param
10271 max-inline-insns-auto}.
10273 @item large-function-insns
10274 The limit specifying really large functions.  For functions larger than this
10275 limit after inlining, inlining is constrained by
10276 @option{--param large-function-growth}.  This parameter is useful primarily
10277 to avoid extreme compilation time caused by non-linear algorithms used by the
10278 back end.
10279 The default value is 2700.
10281 @item large-function-growth
10282 Specifies maximal growth of large function caused by inlining in percents.
10283 The default value is 100 which limits large function growth to 2.0 times
10284 the original size.
10286 @item large-unit-insns
10287 The limit specifying large translation unit.  Growth caused by inlining of
10288 units larger than this limit is limited by @option{--param inline-unit-growth}.
10289 For small units this might be too tight.
10290 For example, consider a unit consisting of function A
10291 that is inline and B that just calls A three times.  If B is small relative to
10292 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10293 large units consisting of small inlineable functions, however, the overall unit
10294 growth limit is needed to avoid exponential explosion of code size.  Thus for
10295 smaller units, the size is increased to @option{--param large-unit-insns}
10296 before applying @option{--param inline-unit-growth}.  The default is 10000.
10298 @item inline-unit-growth
10299 Specifies maximal overall growth of the compilation unit caused by inlining.
10300 The default value is 20 which limits unit growth to 1.2 times the original
10301 size. Cold functions (either marked cold via an attribute or by profile
10302 feedback) are not accounted into the unit size.
10304 @item ipcp-unit-growth
10305 Specifies maximal overall growth of the compilation unit caused by
10306 interprocedural constant propagation.  The default value is 10 which limits
10307 unit growth to 1.1 times the original size.
10309 @item large-stack-frame
10310 The limit specifying large stack frames.  While inlining the algorithm is trying
10311 to not grow past this limit too much.  The default value is 256 bytes.
10313 @item large-stack-frame-growth
10314 Specifies maximal growth of large stack frames caused by inlining in percents.
10315 The default value is 1000 which limits large stack frame growth to 11 times
10316 the original size.
10318 @item max-inline-insns-recursive
10319 @itemx max-inline-insns-recursive-auto
10320 Specifies the maximum number of instructions an out-of-line copy of a
10321 self-recursive inline
10322 function can grow into by performing recursive inlining.
10324 @option{--param max-inline-insns-recursive} applies to functions
10325 declared inline.
10326 For functions not declared inline, recursive inlining
10327 happens only when @option{-finline-functions} (included in @option{-O3}) is
10328 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10329 default value is 450.
10331 @item max-inline-recursive-depth
10332 @itemx max-inline-recursive-depth-auto
10333 Specifies the maximum recursion depth used for recursive inlining.
10335 @option{--param max-inline-recursive-depth} applies to functions
10336 declared inline.  For functions not declared inline, recursive inlining
10337 happens only when @option{-finline-functions} (included in @option{-O3}) is
10338 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10339 default value is 8.
10341 @item min-inline-recursive-probability
10342 Recursive inlining is profitable only for function having deep recursion
10343 in average and can hurt for function having little recursion depth by
10344 increasing the prologue size or complexity of function body to other
10345 optimizers.
10347 When profile feedback is available (see @option{-fprofile-generate}) the actual
10348 recursion depth can be guessed from probability that function recurses via a
10349 given call expression.  This parameter limits inlining only to call expressions
10350 whose probability exceeds the given threshold (in percents).
10351 The default value is 10.
10353 @item early-inlining-insns
10354 Specify growth that the early inliner can make.  In effect it increases
10355 the amount of inlining for code having a large abstraction penalty.
10356 The default value is 14.
10358 @item max-early-inliner-iterations
10359 Limit of iterations of the early inliner.  This basically bounds
10360 the number of nested indirect calls the early inliner can resolve.
10361 Deeper chains are still handled by late inlining.
10363 @item comdat-sharing-probability
10364 Probability (in percent) that C++ inline function with comdat visibility
10365 are shared across multiple compilation units.  The default value is 20.
10367 @item profile-func-internal-id
10368 A parameter to control whether to use function internal id in profile
10369 database lookup. If the value is 0, the compiler uses an id that
10370 is based on function assembler name and filename, which makes old profile
10371 data more tolerant to source changes such as function reordering etc.
10372 The default value is 0.
10374 @item min-vect-loop-bound
10375 The minimum number of iterations under which loops are not vectorized
10376 when @option{-ftree-vectorize} is used.  The number of iterations after
10377 vectorization needs to be greater than the value specified by this option
10378 to allow vectorization.  The default value is 0.
10380 @item gcse-cost-distance-ratio
10381 Scaling factor in calculation of maximum distance an expression
10382 can be moved by GCSE optimizations.  This is currently supported only in the
10383 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10384 is with simple expressions, i.e., the expressions that have cost
10385 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10386 hoisting of simple expressions.  The default value is 10.
10388 @item gcse-unrestricted-cost
10389 Cost, roughly measured as the cost of a single typical machine
10390 instruction, at which GCSE optimizations do not constrain
10391 the distance an expression can travel.  This is currently
10392 supported only in the code hoisting pass.  The lesser the cost,
10393 the more aggressive code hoisting is.  Specifying 0 
10394 allows all expressions to travel unrestricted distances.
10395 The default value is 3.
10397 @item max-hoist-depth
10398 The depth of search in the dominator tree for expressions to hoist.
10399 This is used to avoid quadratic behavior in hoisting algorithm.
10400 The value of 0 does not limit on the search, but may slow down compilation
10401 of huge functions.  The default value is 30.
10403 @item max-tail-merge-comparisons
10404 The maximum amount of similar bbs to compare a bb with.  This is used to
10405 avoid quadratic behavior in tree tail merging.  The default value is 10.
10407 @item max-tail-merge-iterations
10408 The maximum amount of iterations of the pass over the function.  This is used to
10409 limit compilation time in tree tail merging.  The default value is 2.
10411 @item max-unrolled-insns
10412 The maximum number of instructions that a loop may have to be unrolled.
10413 If a loop is unrolled, this parameter also determines how many times
10414 the loop code is unrolled.
10416 @item max-average-unrolled-insns
10417 The maximum number of instructions biased by probabilities of their execution
10418 that a loop may have to be unrolled.  If a loop is unrolled,
10419 this parameter also determines how many times the loop code is unrolled.
10421 @item max-unroll-times
10422 The maximum number of unrollings of a single loop.
10424 @item max-peeled-insns
10425 The maximum number of instructions that a loop may have to be peeled.
10426 If a loop is peeled, this parameter also determines how many times
10427 the loop code is peeled.
10429 @item max-peel-times
10430 The maximum number of peelings of a single loop.
10432 @item max-peel-branches
10433 The maximum number of branches on the hot path through the peeled sequence.
10435 @item max-completely-peeled-insns
10436 The maximum number of insns of a completely peeled loop.
10438 @item max-completely-peel-times
10439 The maximum number of iterations of a loop to be suitable for complete peeling.
10441 @item max-completely-peel-loop-nest-depth
10442 The maximum depth of a loop nest suitable for complete peeling.
10444 @item max-unswitch-insns
10445 The maximum number of insns of an unswitched loop.
10447 @item max-unswitch-level
10448 The maximum number of branches unswitched in a single loop.
10450 @item lim-expensive
10451 The minimum cost of an expensive expression in the loop invariant motion.
10453 @item iv-consider-all-candidates-bound
10454 Bound on number of candidates for induction variables, below which
10455 all candidates are considered for each use in induction variable
10456 optimizations.  If there are more candidates than this,
10457 only the most relevant ones are considered to avoid quadratic time complexity.
10459 @item iv-max-considered-uses
10460 The induction variable optimizations give up on loops that contain more
10461 induction variable uses.
10463 @item iv-always-prune-cand-set-bound
10464 If the number of candidates in the set is smaller than this value,
10465 always try to remove unnecessary ivs from the set
10466 when adding a new one.
10468 @item scev-max-expr-size
10469 Bound on size of expressions used in the scalar evolutions analyzer.
10470 Large expressions slow the analyzer.
10472 @item scev-max-expr-complexity
10473 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10474 Complex expressions slow the analyzer.
10476 @item omega-max-vars
10477 The maximum number of variables in an Omega constraint system.
10478 The default value is 128.
10480 @item omega-max-geqs
10481 The maximum number of inequalities in an Omega constraint system.
10482 The default value is 256.
10484 @item omega-max-eqs
10485 The maximum number of equalities in an Omega constraint system.
10486 The default value is 128.
10488 @item omega-max-wild-cards
10489 The maximum number of wildcard variables that the Omega solver is
10490 able to insert.  The default value is 18.
10492 @item omega-hash-table-size
10493 The size of the hash table in the Omega solver.  The default value is
10494 550.
10496 @item omega-max-keys
10497 The maximal number of keys used by the Omega solver.  The default
10498 value is 500.
10500 @item omega-eliminate-redundant-constraints
10501 When set to 1, use expensive methods to eliminate all redundant
10502 constraints.  The default value is 0.
10504 @item vect-max-version-for-alignment-checks
10505 The maximum number of run-time checks that can be performed when
10506 doing loop versioning for alignment in the vectorizer.
10508 @item vect-max-version-for-alias-checks
10509 The maximum number of run-time checks that can be performed when
10510 doing loop versioning for alias in the vectorizer.
10512 @item vect-max-peeling-for-alignment
10513 The maximum number of loop peels to enhance access alignment
10514 for vectorizer. Value -1 means 'no limit'.
10516 @item max-iterations-to-track
10517 The maximum number of iterations of a loop the brute-force algorithm
10518 for analysis of the number of iterations of the loop tries to evaluate.
10520 @item hot-bb-count-ws-permille
10521 A basic block profile count is considered hot if it contributes to 
10522 the given permillage (i.e. 0...1000) of the entire profiled execution.
10524 @item hot-bb-frequency-fraction
10525 Select fraction of the entry block frequency of executions of basic block in
10526 function given basic block needs to have to be considered hot.
10528 @item max-predicted-iterations
10529 The maximum number of loop iterations we predict statically.  This is useful
10530 in cases where a function contains a single loop with known bound and
10531 another loop with unknown bound.
10532 The known number of iterations is predicted correctly, while
10533 the unknown number of iterations average to roughly 10.  This means that the
10534 loop without bounds appears artificially cold relative to the other one.
10536 @item builtin-expect-probability
10537 Control the probability of the expression having the specified value. This
10538 parameter takes a percentage (i.e. 0 ... 100) as input.
10539 The default probability of 90 is obtained empirically.
10541 @item align-threshold
10543 Select fraction of the maximal frequency of executions of a basic block in
10544 a function to align the basic block.
10546 @item align-loop-iterations
10548 A loop expected to iterate at least the selected number of iterations is
10549 aligned.
10551 @item tracer-dynamic-coverage
10552 @itemx tracer-dynamic-coverage-feedback
10554 This value is used to limit superblock formation once the given percentage of
10555 executed instructions is covered.  This limits unnecessary code size
10556 expansion.
10558 The @option{tracer-dynamic-coverage-feedback} parameter
10559 is used only when profile
10560 feedback is available.  The real profiles (as opposed to statically estimated
10561 ones) are much less balanced allowing the threshold to be larger value.
10563 @item tracer-max-code-growth
10564 Stop tail duplication once code growth has reached given percentage.  This is
10565 a rather artificial limit, as most of the duplicates are eliminated later in
10566 cross jumping, so it may be set to much higher values than is the desired code
10567 growth.
10569 @item tracer-min-branch-ratio
10571 Stop reverse growth when the reverse probability of best edge is less than this
10572 threshold (in percent).
10574 @item tracer-min-branch-ratio
10575 @itemx tracer-min-branch-ratio-feedback
10577 Stop forward growth if the best edge has probability lower than this
10578 threshold.
10580 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10581 compilation for profile feedback and one for compilation without.  The value
10582 for compilation with profile feedback needs to be more conservative (higher) in
10583 order to make tracer effective.
10585 @item max-cse-path-length
10587 The maximum number of basic blocks on path that CSE considers.
10588 The default is 10.
10590 @item max-cse-insns
10591 The maximum number of instructions CSE processes before flushing.
10592 The default is 1000.
10594 @item ggc-min-expand
10596 GCC uses a garbage collector to manage its own memory allocation.  This
10597 parameter specifies the minimum percentage by which the garbage
10598 collector's heap should be allowed to expand between collections.
10599 Tuning this may improve compilation speed; it has no effect on code
10600 generation.
10602 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10603 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10604 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10605 GCC is not able to calculate RAM on a particular platform, the lower
10606 bound of 30% is used.  Setting this parameter and
10607 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10608 every opportunity.  This is extremely slow, but can be useful for
10609 debugging.
10611 @item ggc-min-heapsize
10613 Minimum size of the garbage collector's heap before it begins bothering
10614 to collect garbage.  The first collection occurs after the heap expands
10615 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10616 tuning this may improve compilation speed, and has no effect on code
10617 generation.
10619 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10620 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10621 with a lower bound of 4096 (four megabytes) and an upper bound of
10622 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10623 particular platform, the lower bound is used.  Setting this parameter
10624 very large effectively disables garbage collection.  Setting this
10625 parameter and @option{ggc-min-expand} to zero causes a full collection
10626 to occur at every opportunity.
10628 @item max-reload-search-insns
10629 The maximum number of instruction reload should look backward for equivalent
10630 register.  Increasing values mean more aggressive optimization, making the
10631 compilation time increase with probably slightly better performance.
10632 The default value is 100.
10634 @item max-cselib-memory-locations
10635 The maximum number of memory locations cselib should take into account.
10636 Increasing values mean more aggressive optimization, making the compilation time
10637 increase with probably slightly better performance.  The default value is 500.
10639 @item reorder-blocks-duplicate
10640 @itemx reorder-blocks-duplicate-feedback
10642 Used by the basic block reordering pass to decide whether to use unconditional
10643 branch or duplicate the code on its destination.  Code is duplicated when its
10644 estimated size is smaller than this value multiplied by the estimated size of
10645 unconditional jump in the hot spots of the program.
10647 The @option{reorder-block-duplicate-feedback} parameter
10648 is used only when profile
10649 feedback is available.  It may be set to higher values than
10650 @option{reorder-block-duplicate} since information about the hot spots is more
10651 accurate.
10653 @item max-sched-ready-insns
10654 The maximum number of instructions ready to be issued the scheduler should
10655 consider at any given time during the first scheduling pass.  Increasing
10656 values mean more thorough searches, making the compilation time increase
10657 with probably little benefit.  The default value is 100.
10659 @item max-sched-region-blocks
10660 The maximum number of blocks in a region to be considered for
10661 interblock scheduling.  The default value is 10.
10663 @item max-pipeline-region-blocks
10664 The maximum number of blocks in a region to be considered for
10665 pipelining in the selective scheduler.  The default value is 15.
10667 @item max-sched-region-insns
10668 The maximum number of insns in a region to be considered for
10669 interblock scheduling.  The default value is 100.
10671 @item max-pipeline-region-insns
10672 The maximum number of insns in a region to be considered for
10673 pipelining in the selective scheduler.  The default value is 200.
10675 @item min-spec-prob
10676 The minimum probability (in percents) of reaching a source block
10677 for interblock speculative scheduling.  The default value is 40.
10679 @item max-sched-extend-regions-iters
10680 The maximum number of iterations through CFG to extend regions.
10681 A value of 0 (the default) disables region extensions.
10683 @item max-sched-insn-conflict-delay
10684 The maximum conflict delay for an insn to be considered for speculative motion.
10685 The default value is 3.
10687 @item sched-spec-prob-cutoff
10688 The minimal probability of speculation success (in percents), so that
10689 speculative insns are scheduled.
10690 The default value is 40.
10692 @item sched-spec-state-edge-prob-cutoff
10693 The minimum probability an edge must have for the scheduler to save its
10694 state across it.
10695 The default value is 10.
10697 @item sched-mem-true-dep-cost
10698 Minimal distance (in CPU cycles) between store and load targeting same
10699 memory locations.  The default value is 1.
10701 @item selsched-max-lookahead
10702 The maximum size of the lookahead window of selective scheduling.  It is a
10703 depth of search for available instructions.
10704 The default value is 50.
10706 @item selsched-max-sched-times
10707 The maximum number of times that an instruction is scheduled during
10708 selective scheduling.  This is the limit on the number of iterations
10709 through which the instruction may be pipelined.  The default value is 2.
10711 @item selsched-max-insns-to-rename
10712 The maximum number of best instructions in the ready list that are considered
10713 for renaming in the selective scheduler.  The default value is 2.
10715 @item sms-min-sc
10716 The minimum value of stage count that swing modulo scheduler
10717 generates.  The default value is 2.
10719 @item max-last-value-rtl
10720 The maximum size measured as number of RTLs that can be recorded in an expression
10721 in combiner for a pseudo register as last known value of that register.  The default
10722 is 10000.
10724 @item max-combine-insns
10725 The maximum number of instructions the RTL combiner tries to combine.
10726 The default value is 2 at @option{-Og} and 4 otherwise.
10728 @item integer-share-limit
10729 Small integer constants can use a shared data structure, reducing the
10730 compiler's memory usage and increasing its speed.  This sets the maximum
10731 value of a shared integer constant.  The default value is 256.
10733 @item ssp-buffer-size
10734 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10735 protection when @option{-fstack-protection} is used.
10737 @item min-size-for-stack-sharing
10738 The minimum size of variables taking part in stack slot sharing when not
10739 optimizing. The default value is 32.
10741 @item max-jump-thread-duplication-stmts
10742 Maximum number of statements allowed in a block that needs to be
10743 duplicated when threading jumps.
10745 @item max-fields-for-field-sensitive
10746 Maximum number of fields in a structure treated in
10747 a field sensitive manner during pointer analysis.  The default is zero
10748 for @option{-O0} and @option{-O1},
10749 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10751 @item prefetch-latency
10752 Estimate on average number of instructions that are executed before
10753 prefetch finishes.  The distance prefetched ahead is proportional
10754 to this constant.  Increasing this number may also lead to less
10755 streams being prefetched (see @option{simultaneous-prefetches}).
10757 @item simultaneous-prefetches
10758 Maximum number of prefetches that can run at the same time.
10760 @item l1-cache-line-size
10761 The size of cache line in L1 cache, in bytes.
10763 @item l1-cache-size
10764 The size of L1 cache, in kilobytes.
10766 @item l2-cache-size
10767 The size of L2 cache, in kilobytes.
10769 @item min-insn-to-prefetch-ratio
10770 The minimum ratio between the number of instructions and the
10771 number of prefetches to enable prefetching in a loop.
10773 @item prefetch-min-insn-to-mem-ratio
10774 The minimum ratio between the number of instructions and the
10775 number of memory references to enable prefetching in a loop.
10777 @item use-canonical-types
10778 Whether the compiler should use the ``canonical'' type system.  By
10779 default, this should always be 1, which uses a more efficient internal
10780 mechanism for comparing types in C++ and Objective-C++.  However, if
10781 bugs in the canonical type system are causing compilation failures,
10782 set this value to 0 to disable canonical types.
10784 @item switch-conversion-max-branch-ratio
10785 Switch initialization conversion refuses to create arrays that are
10786 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10787 branches in the switch.
10789 @item max-partial-antic-length
10790 Maximum length of the partial antic set computed during the tree
10791 partial redundancy elimination optimization (@option{-ftree-pre}) when
10792 optimizing at @option{-O3} and above.  For some sorts of source code
10793 the enhanced partial redundancy elimination optimization can run away,
10794 consuming all of the memory available on the host machine.  This
10795 parameter sets a limit on the length of the sets that are computed,
10796 which prevents the runaway behavior.  Setting a value of 0 for
10797 this parameter allows an unlimited set length.
10799 @item sccvn-max-scc-size
10800 Maximum size of a strongly connected component (SCC) during SCCVN
10801 processing.  If this limit is hit, SCCVN processing for the whole
10802 function is not done and optimizations depending on it are
10803 disabled.  The default maximum SCC size is 10000.
10805 @item sccvn-max-alias-queries-per-access
10806 Maximum number of alias-oracle queries we perform when looking for
10807 redundancies for loads and stores.  If this limit is hit the search
10808 is aborted and the load or store is not considered redundant.  The
10809 number of queries is algorithmically limited to the number of
10810 stores on all paths from the load to the function entry.
10811 The default maxmimum number of queries is 1000.
10813 @item ira-max-loops-num
10814 IRA uses regional register allocation by default.  If a function
10815 contains more loops than the number given by this parameter, only at most
10816 the given number of the most frequently-executed loops form regions
10817 for regional register allocation.  The default value of the
10818 parameter is 100.
10820 @item ira-max-conflict-table-size 
10821 Although IRA uses a sophisticated algorithm to compress the conflict
10822 table, the table can still require excessive amounts of memory for
10823 huge functions.  If the conflict table for a function could be more
10824 than the size in MB given by this parameter, the register allocator
10825 instead uses a faster, simpler, and lower-quality
10826 algorithm that does not require building a pseudo-register conflict table.  
10827 The default value of the parameter is 2000.
10829 @item ira-loop-reserved-regs
10830 IRA can be used to evaluate more accurate register pressure in loops
10831 for decisions to move loop invariants (see @option{-O3}).  The number
10832 of available registers reserved for some other purposes is given
10833 by this parameter.  The default value of the parameter is 2, which is
10834 the minimal number of registers needed by typical instructions.
10835 This value is the best found from numerous experiments.
10837 @item lra-inheritance-ebb-probability-cutoff
10838 LRA tries to reuse values reloaded in registers in subsequent insns.
10839 This optimization is called inheritance.  EBB is used as a region to
10840 do this optimization.  The parameter defines a minimal fall-through
10841 edge probability in percentage used to add BB to inheritance EBB in
10842 LRA.  The default value of the parameter is 40.  The value was chosen
10843 from numerous runs of SPEC2000 on x86-64.
10845 @item loop-invariant-max-bbs-in-loop
10846 Loop invariant motion can be very expensive, both in compilation time and
10847 in amount of needed compile-time memory, with very large loops.  Loops
10848 with more basic blocks than this parameter won't have loop invariant
10849 motion optimization performed on them.  The default value of the
10850 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10852 @item loop-max-datarefs-for-datadeps
10853 Building data dapendencies is expensive for very large loops.  This
10854 parameter limits the number of data references in loops that are
10855 considered for data dependence analysis.  These large loops are no
10856 handled by the optimizations using loop data dependencies.
10857 The default value is 1000.
10859 @item max-vartrack-size
10860 Sets a maximum number of hash table slots to use during variable
10861 tracking dataflow analysis of any function.  If this limit is exceeded
10862 with variable tracking at assignments enabled, analysis for that
10863 function is retried without it, after removing all debug insns from
10864 the function.  If the limit is exceeded even without debug insns, var
10865 tracking analysis is completely disabled for the function.  Setting
10866 the parameter to zero makes it unlimited.
10868 @item max-vartrack-expr-depth
10869 Sets a maximum number of recursion levels when attempting to map
10870 variable names or debug temporaries to value expressions.  This trades
10871 compilation time for more complete debug information.  If this is set too
10872 low, value expressions that are available and could be represented in
10873 debug information may end up not being used; setting this higher may
10874 enable the compiler to find more complex debug expressions, but compile
10875 time and memory use may grow.  The default is 12.
10877 @item min-nondebug-insn-uid
10878 Use uids starting at this parameter for nondebug insns.  The range below
10879 the parameter is reserved exclusively for debug insns created by
10880 @option{-fvar-tracking-assignments}, but debug insns may get
10881 (non-overlapping) uids above it if the reserved range is exhausted.
10883 @item ipa-sra-ptr-growth-factor
10884 IPA-SRA replaces a pointer to an aggregate with one or more new
10885 parameters only when their cumulative size is less or equal to
10886 @option{ipa-sra-ptr-growth-factor} times the size of the original
10887 pointer parameter.
10889 @item sra-max-scalarization-size-Ospeed
10890 @item sra-max-scalarization-size-Osize
10891 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10892 replace scalar parts of aggregates with uses of independent scalar
10893 variables.  These parameters control the maximum size, in storage units,
10894 of aggregate which is considered for replacement when compiling for
10895 speed
10896 (@option{sra-max-scalarization-size-Ospeed}) or size
10897 (@option{sra-max-scalarization-size-Osize}) respectively.
10899 @item tm-max-aggregate-size
10900 When making copies of thread-local variables in a transaction, this
10901 parameter specifies the size in bytes after which variables are
10902 saved with the logging functions as opposed to save/restore code
10903 sequence pairs.  This option only applies when using
10904 @option{-fgnu-tm}.
10906 @item graphite-max-nb-scop-params
10907 To avoid exponential effects in the Graphite loop transforms, the
10908 number of parameters in a Static Control Part (SCoP) is bounded.  The
10909 default value is 10 parameters.  A variable whose value is unknown at
10910 compilation time and defined outside a SCoP is a parameter of the SCoP.
10912 @item graphite-max-bbs-per-function
10913 To avoid exponential effects in the detection of SCoPs, the size of
10914 the functions analyzed by Graphite is bounded.  The default value is
10915 100 basic blocks.
10917 @item loop-block-tile-size
10918 Loop blocking or strip mining transforms, enabled with
10919 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10920 loop in the loop nest by a given number of iterations.  The strip
10921 length can be changed using the @option{loop-block-tile-size}
10922 parameter.  The default value is 51 iterations.
10924 @item loop-unroll-jam-size
10925 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10926 default value is 4.
10928 @item loop-unroll-jam-depth
10929 Specify the dimension to be unrolled (counting from the most inner loop)
10930 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10932 @item ipa-cp-value-list-size
10933 IPA-CP attempts to track all possible values and types passed to a function's
10934 parameter in order to propagate them and perform devirtualization.
10935 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10936 stores per one formal parameter of a function.
10938 @item ipa-cp-eval-threshold
10939 IPA-CP calculates its own score of cloning profitability heuristics
10940 and performs those cloning opportunities with scores that exceed
10941 @option{ipa-cp-eval-threshold}.
10943 @item ipa-cp-recursion-penalty
10944 Percentage penalty the recursive functions will receive when they
10945 are evaluated for cloning.
10947 @item ipa-cp-single-call-penalty
10948 Percentage penalty functions containg a single call to another
10949 function will receive when they are evaluated for cloning.
10952 @item ipa-max-agg-items
10953 IPA-CP is also capable to propagate a number of scalar values passed
10954 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10955 number of such values per one parameter.
10957 @item ipa-cp-loop-hint-bonus
10958 When IPA-CP determines that a cloning candidate would make the number
10959 of iterations of a loop known, it adds a bonus of
10960 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10961 the candidate.
10963 @item ipa-cp-array-index-hint-bonus
10964 When IPA-CP determines that a cloning candidate would make the index of
10965 an array access known, it adds a bonus of
10966 @option{ipa-cp-array-index-hint-bonus} to the profitability
10967 score of the candidate.
10969 @item ipa-max-aa-steps
10970 During its analysis of function bodies, IPA-CP employs alias analysis
10971 in order to track values pointed to by function parameters.  In order
10972 not spend too much time analyzing huge functions, it gives up and
10973 consider all memory clobbered after examining
10974 @option{ipa-max-aa-steps} statements modifying memory.
10976 @item lto-partitions
10977 Specify desired number of partitions produced during WHOPR compilation.
10978 The number of partitions should exceed the number of CPUs used for compilation.
10979 The default value is 32.
10981 @item lto-minpartition
10982 Size of minimal partition for WHOPR (in estimated instructions).
10983 This prevents expenses of splitting very small programs into too many
10984 partitions.
10986 @item cxx-max-namespaces-for-diagnostic-help
10987 The maximum number of namespaces to consult for suggestions when C++
10988 name lookup fails for an identifier.  The default is 1000.
10990 @item sink-frequency-threshold
10991 The maximum relative execution frequency (in percents) of the target block
10992 relative to a statement's original block to allow statement sinking of a
10993 statement.  Larger numbers result in more aggressive statement sinking.
10994 The default value is 75.  A small positive adjustment is applied for
10995 statements with memory operands as those are even more profitable so sink.
10997 @item max-stores-to-sink
10998 The maximum number of conditional stores paires that can be sunk.  Set to 0
10999 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11000 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
11002 @item allow-store-data-races
11003 Allow optimizers to introduce new data races on stores.
11004 Set to 1 to allow, otherwise to 0.  This option is enabled by default
11005 at optimization level @option{-Ofast}.
11007 @item case-values-threshold
11008 The smallest number of different values for which it is best to use a
11009 jump-table instead of a tree of conditional branches.  If the value is
11010 0, use the default for the machine.  The default is 0.
11012 @item tree-reassoc-width
11013 Set the maximum number of instructions executed in parallel in
11014 reassociated tree. This parameter overrides target dependent
11015 heuristics used by default if has non zero value.
11017 @item sched-pressure-algorithm
11018 Choose between the two available implementations of
11019 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11020 and is the more likely to prevent instructions from being reordered.
11021 Algorithm 2 was designed to be a compromise between the relatively
11022 conservative approach taken by algorithm 1 and the rather aggressive
11023 approach taken by the default scheduler.  It relies more heavily on
11024 having a regular register file and accurate register pressure classes.
11025 See @file{haifa-sched.c} in the GCC sources for more details.
11027 The default choice depends on the target.
11029 @item max-slsr-cand-scan
11030 Set the maximum number of existing candidates that are considered when
11031 seeking a basis for a new straight-line strength reduction candidate.
11033 @item asan-globals
11034 Enable buffer overflow detection for global objects.  This kind
11035 of protection is enabled by default if you are using
11036 @option{-fsanitize=address} option.
11037 To disable global objects protection use @option{--param asan-globals=0}.
11039 @item asan-stack
11040 Enable buffer overflow detection for stack objects.  This kind of
11041 protection is enabled by default when using@option{-fsanitize=address}.
11042 To disable stack protection use @option{--param asan-stack=0} option.
11044 @item asan-instrument-reads
11045 Enable buffer overflow detection for memory reads.  This kind of
11046 protection is enabled by default when using @option{-fsanitize=address}.
11047 To disable memory reads protection use
11048 @option{--param asan-instrument-reads=0}.
11050 @item asan-instrument-writes
11051 Enable buffer overflow detection for memory writes.  This kind of
11052 protection is enabled by default when using @option{-fsanitize=address}.
11053 To disable memory writes protection use
11054 @option{--param asan-instrument-writes=0} option.
11056 @item asan-memintrin
11057 Enable detection for built-in functions.  This kind of protection
11058 is enabled by default when using @option{-fsanitize=address}.
11059 To disable built-in functions protection use
11060 @option{--param asan-memintrin=0}.
11062 @item asan-use-after-return
11063 Enable detection of use-after-return.  This kind of protection
11064 is enabled by default when using @option{-fsanitize=address} option.
11065 To disable use-after-return detection use 
11066 @option{--param asan-use-after-return=0}.
11068 @item asan-instrumentation-with-call-threshold
11069 If number of memory accesses in function being instrumented
11070 is greater or equal to this number, use callbacks instead of inline checks.
11071 E.g. to disable inline code use
11072 @option{--param asan-instrumentation-with-call-threshold=0}.
11074 @item chkp-max-ctor-size
11075 Static constructors generated by Pointer Bounds Checker may become very
11076 large and significantly increase compile time at optimization level
11077 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
11078 in a single generated constructor.  Default value is 5000.
11080 @item max-fsm-thread-path-insns
11081 Maximum number of instructions to copy when duplicating blocks on a
11082 finite state automaton jump thread path.  The default is 100.
11084 @item max-fsm-thread-length
11085 Maximum number of basic blocks on a finite state automaton jump thread
11086 path.  The default is 10.
11088 @item max-fsm-thread-paths
11089 Maximum number of new jump thread paths to create for a finite state
11090 automaton.  The default is 50.
11092 @end table
11093 @end table
11095 @node Preprocessor Options
11096 @section Options Controlling the Preprocessor
11097 @cindex preprocessor options
11098 @cindex options, preprocessor
11100 These options control the C preprocessor, which is run on each C source
11101 file before actual compilation.
11103 If you use the @option{-E} option, nothing is done except preprocessing.
11104 Some of these options make sense only together with @option{-E} because
11105 they cause the preprocessor output to be unsuitable for actual
11106 compilation.
11108 @table @gcctabopt
11109 @item -Wp,@var{option}
11110 @opindex Wp
11111 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11112 and pass @var{option} directly through to the preprocessor.  If
11113 @var{option} contains commas, it is split into multiple options at the
11114 commas.  However, many options are modified, translated or interpreted
11115 by the compiler driver before being passed to the preprocessor, and
11116 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11117 interface is undocumented and subject to change, so whenever possible
11118 you should avoid using @option{-Wp} and let the driver handle the
11119 options instead.
11121 @item -Xpreprocessor @var{option}
11122 @opindex Xpreprocessor
11123 Pass @var{option} as an option to the preprocessor.  You can use this to
11124 supply system-specific preprocessor options that GCC does not 
11125 recognize.
11127 If you want to pass an option that takes an argument, you must use
11128 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11130 @item -no-integrated-cpp
11131 @opindex no-integrated-cpp
11132 Perform preprocessing as a separate pass before compilation.
11133 By default, GCC performs preprocessing as an integrated part of
11134 input tokenization and parsing.
11135 If this option is provided, the appropriate language front end
11136 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11137 and Objective-C, respectively) is instead invoked twice,
11138 once for preprocessing only and once for actual compilation
11139 of the preprocessed input.
11140 This option may be useful in conjunction with the @option{-B} or
11141 @option{-wrapper} options to specify an alternate preprocessor or
11142 perform additional processing of the program source between
11143 normal preprocessing and compilation.
11144 @end table
11146 @include cppopts.texi
11148 @node Assembler Options
11149 @section Passing Options to the Assembler
11151 @c prevent bad page break with this line
11152 You can pass options to the assembler.
11154 @table @gcctabopt
11155 @item -Wa,@var{option}
11156 @opindex Wa
11157 Pass @var{option} as an option to the assembler.  If @var{option}
11158 contains commas, it is split into multiple options at the commas.
11160 @item -Xassembler @var{option}
11161 @opindex Xassembler
11162 Pass @var{option} as an option to the assembler.  You can use this to
11163 supply system-specific assembler options that GCC does not
11164 recognize.
11166 If you want to pass an option that takes an argument, you must use
11167 @option{-Xassembler} twice, once for the option and once for the argument.
11169 @end table
11171 @node Link Options
11172 @section Options for Linking
11173 @cindex link options
11174 @cindex options, linking
11176 These options come into play when the compiler links object files into
11177 an executable output file.  They are meaningless if the compiler is
11178 not doing a link step.
11180 @table @gcctabopt
11181 @cindex file names
11182 @item @var{object-file-name}
11183 A file name that does not end in a special recognized suffix is
11184 considered to name an object file or library.  (Object files are
11185 distinguished from libraries by the linker according to the file
11186 contents.)  If linking is done, these object files are used as input
11187 to the linker.
11189 @item -c
11190 @itemx -S
11191 @itemx -E
11192 @opindex c
11193 @opindex S
11194 @opindex E
11195 If any of these options is used, then the linker is not run, and
11196 object file names should not be used as arguments.  @xref{Overall
11197 Options}.
11199 @item -fuse-ld=bfd
11200 @opindex fuse-ld=bfd
11201 Use the @command{bfd} linker instead of the default linker.
11203 @item -fuse-ld=gold
11204 @opindex fuse-ld=gold
11205 Use the @command{gold} linker instead of the default linker.
11207 @cindex Libraries
11208 @item -l@var{library}
11209 @itemx -l @var{library}
11210 @opindex l
11211 Search the library named @var{library} when linking.  (The second
11212 alternative with the library as a separate argument is only for
11213 POSIX compliance and is not recommended.)
11215 It makes a difference where in the command you write this option; the
11216 linker searches and processes libraries and object files in the order they
11217 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11218 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11219 to functions in @samp{z}, those functions may not be loaded.
11221 The linker searches a standard list of directories for the library,
11222 which is actually a file named @file{lib@var{library}.a}.  The linker
11223 then uses this file as if it had been specified precisely by name.
11225 The directories searched include several standard system directories
11226 plus any that you specify with @option{-L}.
11228 Normally the files found this way are library files---archive files
11229 whose members are object files.  The linker handles an archive file by
11230 scanning through it for members which define symbols that have so far
11231 been referenced but not defined.  But if the file that is found is an
11232 ordinary object file, it is linked in the usual fashion.  The only
11233 difference between using an @option{-l} option and specifying a file name
11234 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11235 and searches several directories.
11237 @item -lobjc
11238 @opindex lobjc
11239 You need this special case of the @option{-l} option in order to
11240 link an Objective-C or Objective-C++ program.
11242 @item -nostartfiles
11243 @opindex nostartfiles
11244 Do not use the standard system startup files when linking.
11245 The standard system libraries are used normally, unless @option{-nostdlib}
11246 or @option{-nodefaultlibs} is used.
11248 @item -nodefaultlibs
11249 @opindex nodefaultlibs
11250 Do not use the standard system libraries when linking.
11251 Only the libraries you specify are passed to the linker, and options
11252 specifying linkage of the system libraries, such as @option{-static-libgcc}
11253 or @option{-shared-libgcc}, are ignored.  
11254 The standard startup files are used normally, unless @option{-nostartfiles}
11255 is used.  
11257 The compiler may generate calls to @code{memcmp},
11258 @code{memset}, @code{memcpy} and @code{memmove}.
11259 These entries are usually resolved by entries in
11260 libc.  These entry points should be supplied through some other
11261 mechanism when this option is specified.
11263 @item -nostdlib
11264 @opindex nostdlib
11265 Do not use the standard system startup files or libraries when linking.
11266 No startup files and only the libraries you specify are passed to
11267 the linker, and options specifying linkage of the system libraries, such as
11268 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11270 The compiler may generate calls to @code{memcmp}, @code{memset},
11271 @code{memcpy} and @code{memmove}.
11272 These entries are usually resolved by entries in
11273 libc.  These entry points should be supplied through some other
11274 mechanism when this option is specified.
11276 @cindex @option{-lgcc}, use with @option{-nostdlib}
11277 @cindex @option{-nostdlib} and unresolved references
11278 @cindex unresolved references and @option{-nostdlib}
11279 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11280 @cindex @option{-nodefaultlibs} and unresolved references
11281 @cindex unresolved references and @option{-nodefaultlibs}
11282 One of the standard libraries bypassed by @option{-nostdlib} and
11283 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11284 which GCC uses to overcome shortcomings of particular machines, or special
11285 needs for some languages.
11286 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11287 Collection (GCC) Internals},
11288 for more discussion of @file{libgcc.a}.)
11289 In most cases, you need @file{libgcc.a} even when you want to avoid
11290 other standard libraries.  In other words, when you specify @option{-nostdlib}
11291 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11292 This ensures that you have no unresolved references to internal GCC
11293 library subroutines.
11294 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11295 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11296 GNU Compiler Collection (GCC) Internals}.)
11298 @item -pie
11299 @opindex pie
11300 Produce a position independent executable on targets that support it.
11301 For predictable results, you must also specify the same set of options
11302 used for compilation (@option{-fpie}, @option{-fPIE},
11303 or model suboptions) when you specify this linker option.
11305 @item -rdynamic
11306 @opindex rdynamic
11307 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11308 that support it. This instructs the linker to add all symbols, not
11309 only used ones, to the dynamic symbol table. This option is needed
11310 for some uses of @code{dlopen} or to allow obtaining backtraces
11311 from within a program.
11313 @item -s
11314 @opindex s
11315 Remove all symbol table and relocation information from the executable.
11317 @item -static
11318 @opindex static
11319 On systems that support dynamic linking, this prevents linking with the shared
11320 libraries.  On other systems, this option has no effect.
11322 @item -shared
11323 @opindex shared
11324 Produce a shared object which can then be linked with other objects to
11325 form an executable.  Not all systems support this option.  For predictable
11326 results, you must also specify the same set of options used for compilation
11327 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11328 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11329 needs to build supplementary stub code for constructors to work.  On
11330 multi-libbed systems, @samp{gcc -shared} must select the correct support
11331 libraries to link against.  Failing to supply the correct flags may lead
11332 to subtle defects.  Supplying them in cases where they are not necessary
11333 is innocuous.}
11335 @item -shared-libgcc
11336 @itemx -static-libgcc
11337 @opindex shared-libgcc
11338 @opindex static-libgcc
11339 On systems that provide @file{libgcc} as a shared library, these options
11340 force the use of either the shared or static version, respectively.
11341 If no shared version of @file{libgcc} was built when the compiler was
11342 configured, these options have no effect.
11344 There are several situations in which an application should use the
11345 shared @file{libgcc} instead of the static version.  The most common
11346 of these is when the application wishes to throw and catch exceptions
11347 across different shared libraries.  In that case, each of the libraries
11348 as well as the application itself should use the shared @file{libgcc}.
11350 Therefore, the G++ and GCJ drivers automatically add
11351 @option{-shared-libgcc} whenever you build a shared library or a main
11352 executable, because C++ and Java programs typically use exceptions, so
11353 this is the right thing to do.
11355 If, instead, you use the GCC driver to create shared libraries, you may
11356 find that they are not always linked with the shared @file{libgcc}.
11357 If GCC finds, at its configuration time, that you have a non-GNU linker
11358 or a GNU linker that does not support option @option{--eh-frame-hdr},
11359 it links the shared version of @file{libgcc} into shared libraries
11360 by default.  Otherwise, it takes advantage of the linker and optimizes
11361 away the linking with the shared version of @file{libgcc}, linking with
11362 the static version of libgcc by default.  This allows exceptions to
11363 propagate through such shared libraries, without incurring relocation
11364 costs at library load time.
11366 However, if a library or main executable is supposed to throw or catch
11367 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11368 for the languages used in the program, or using the option
11369 @option{-shared-libgcc}, such that it is linked with the shared
11370 @file{libgcc}.
11372 @item -static-libasan
11373 @opindex static-libasan
11374 When the @option{-fsanitize=address} option is used to link a program,
11375 the GCC driver automatically links against @option{libasan}.  If
11376 @file{libasan} is available as a shared library, and the @option{-static}
11377 option is not used, then this links against the shared version of
11378 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11379 driver to link @file{libasan} statically, without necessarily linking
11380 other libraries statically.
11382 @item -static-libtsan
11383 @opindex static-libtsan
11384 When the @option{-fsanitize=thread} option is used to link a program,
11385 the GCC driver automatically links against @option{libtsan}.  If
11386 @file{libtsan} is available as a shared library, and the @option{-static}
11387 option is not used, then this links against the shared version of
11388 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11389 driver to link @file{libtsan} statically, without necessarily linking
11390 other libraries statically.
11392 @item -static-liblsan
11393 @opindex static-liblsan
11394 When the @option{-fsanitize=leak} option is used to link a program,
11395 the GCC driver automatically links against @option{liblsan}.  If
11396 @file{liblsan} is available as a shared library, and the @option{-static}
11397 option is not used, then this links against the shared version of
11398 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11399 driver to link @file{liblsan} statically, without necessarily linking
11400 other libraries statically.
11402 @item -static-libubsan
11403 @opindex static-libubsan
11404 When the @option{-fsanitize=undefined} option is used to link a program,
11405 the GCC driver automatically links against @option{libubsan}.  If
11406 @file{libubsan} is available as a shared library, and the @option{-static}
11407 option is not used, then this links against the shared version of
11408 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11409 driver to link @file{libubsan} statically, without necessarily linking
11410 other libraries statically.
11412 @item -static-libmpx
11413 @opindex static-libmpx
11414 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11415 used to link a program, the GCC driver automatically links against
11416 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11417 and the @option{-static} option is not used, then this links against
11418 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11419 option directs the GCC driver to link @file{libmpx} statically,
11420 without necessarily linking other libraries statically.
11422 @item -static-libmpxwrappers
11423 @opindex static-libmpxwrappers
11424 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11425 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11426 GCC driver automatically links against @file{libmpxwrappers}.  If
11427 @file{libmpxwrappers} is available as a shared library, and the
11428 @option{-static} option is not used, then this links against the shared
11429 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11430 option directs the GCC driver to link @file{libmpxwrappers} statically,
11431 without necessarily linking other libraries statically.
11433 @item -static-libstdc++
11434 @opindex static-libstdc++
11435 When the @command{g++} program is used to link a C++ program, it
11436 normally automatically links against @option{libstdc++}.  If
11437 @file{libstdc++} is available as a shared library, and the
11438 @option{-static} option is not used, then this links against the
11439 shared version of @file{libstdc++}.  That is normally fine.  However, it
11440 is sometimes useful to freeze the version of @file{libstdc++} used by
11441 the program without going all the way to a fully static link.  The
11442 @option{-static-libstdc++} option directs the @command{g++} driver to
11443 link @file{libstdc++} statically, without necessarily linking other
11444 libraries statically.
11446 @item -symbolic
11447 @opindex symbolic
11448 Bind references to global symbols when building a shared object.  Warn
11449 about any unresolved references (unless overridden by the link editor
11450 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11451 this option.
11453 @item -T @var{script}
11454 @opindex T
11455 @cindex linker script
11456 Use @var{script} as the linker script.  This option is supported by most
11457 systems using the GNU linker.  On some targets, such as bare-board
11458 targets without an operating system, the @option{-T} option may be required
11459 when linking to avoid references to undefined symbols.
11461 @item -Xlinker @var{option}
11462 @opindex Xlinker
11463 Pass @var{option} as an option to the linker.  You can use this to
11464 supply system-specific linker options that GCC does not recognize.
11466 If you want to pass an option that takes a separate argument, you must use
11467 @option{-Xlinker} twice, once for the option and once for the argument.
11468 For example, to pass @option{-assert definitions}, you must write
11469 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11470 @option{-Xlinker "-assert definitions"}, because this passes the entire
11471 string as a single argument, which is not what the linker expects.
11473 When using the GNU linker, it is usually more convenient to pass
11474 arguments to linker options using the @option{@var{option}=@var{value}}
11475 syntax than as separate arguments.  For example, you can specify
11476 @option{-Xlinker -Map=output.map} rather than
11477 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11478 this syntax for command-line options.
11480 @item -Wl,@var{option}
11481 @opindex Wl
11482 Pass @var{option} as an option to the linker.  If @var{option} contains
11483 commas, it is split into multiple options at the commas.  You can use this
11484 syntax to pass an argument to the option.
11485 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11486 linker.  When using the GNU linker, you can also get the same effect with
11487 @option{-Wl,-Map=output.map}.
11489 @item -u @var{symbol}
11490 @opindex u
11491 Pretend the symbol @var{symbol} is undefined, to force linking of
11492 library modules to define it.  You can use @option{-u} multiple times with
11493 different symbols to force loading of additional library modules.
11495 @item -z @var{keyword}
11496 @opindex z
11497 @option{-z} is passed directly on to the linker along with the keyword
11498 @var{keyword}. See the section in the documentation of your linker for
11499 permitted values and their meanings.
11500 @end table
11502 @node Directory Options
11503 @section Options for Directory Search
11504 @cindex directory options
11505 @cindex options, directory search
11506 @cindex search path
11508 These options specify directories to search for header files, for
11509 libraries and for parts of the compiler:
11511 @table @gcctabopt
11512 @item -I@var{dir}
11513 @opindex I
11514 Add the directory @var{dir} to the head of the list of directories to be
11515 searched for header files.  This can be used to override a system header
11516 file, substituting your own version, since these directories are
11517 searched before the system header file directories.  However, you should
11518 not use this option to add directories that contain vendor-supplied
11519 system header files (use @option{-isystem} for that).  If you use more than
11520 one @option{-I} option, the directories are scanned in left-to-right
11521 order; the standard system directories come after.
11523 If a standard system include directory, or a directory specified with
11524 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11525 option is ignored.  The directory is still searched but as a
11526 system directory at its normal position in the system include chain.
11527 This is to ensure that GCC's procedure to fix buggy system headers and
11528 the ordering for the @code{include_next} directive are not inadvertently changed.
11529 If you really need to change the search order for system directories,
11530 use the @option{-nostdinc} and/or @option{-isystem} options.
11532 @item -iplugindir=@var{dir}
11533 @opindex iplugindir=
11534 Set the directory to search for plugins that are passed
11535 by @option{-fplugin=@var{name}} instead of
11536 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11537 to be used by the user, but only passed by the driver.
11539 @item -iquote@var{dir}
11540 @opindex iquote
11541 Add the directory @var{dir} to the head of the list of directories to
11542 be searched for header files only for the case of @code{#include
11543 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11544 otherwise just like @option{-I}.
11546 @item -L@var{dir}
11547 @opindex L
11548 Add directory @var{dir} to the list of directories to be searched
11549 for @option{-l}.
11551 @item -B@var{prefix}
11552 @opindex B
11553 This option specifies where to find the executables, libraries,
11554 include files, and data files of the compiler itself.
11556 The compiler driver program runs one or more of the subprograms
11557 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11558 @var{prefix} as a prefix for each program it tries to run, both with and
11559 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11561 For each subprogram to be run, the compiler driver first tries the
11562 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11563 is not specified, the driver tries two standard prefixes, 
11564 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11565 those results in a file name that is found, the unmodified program
11566 name is searched for using the directories specified in your
11567 @env{PATH} environment variable.
11569 The compiler checks to see if the path provided by @option{-B}
11570 refers to a directory, and if necessary it adds a directory
11571 separator character at the end of the path.
11573 @option{-B} prefixes that effectively specify directory names also apply
11574 to libraries in the linker, because the compiler translates these
11575 options into @option{-L} options for the linker.  They also apply to
11576 include files in the preprocessor, because the compiler translates these
11577 options into @option{-isystem} options for the preprocessor.  In this case,
11578 the compiler appends @samp{include} to the prefix.
11580 The runtime support file @file{libgcc.a} can also be searched for using
11581 the @option{-B} prefix, if needed.  If it is not found there, the two
11582 standard prefixes above are tried, and that is all.  The file is left
11583 out of the link if it is not found by those means.
11585 Another way to specify a prefix much like the @option{-B} prefix is to use
11586 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11587 Variables}.
11589 As a special kludge, if the path provided by @option{-B} is
11590 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11591 9, then it is replaced by @file{[dir/]include}.  This is to help
11592 with boot-strapping the compiler.
11594 @item -specs=@var{file}
11595 @opindex specs
11596 Process @var{file} after the compiler reads in the standard @file{specs}
11597 file, in order to override the defaults which the @command{gcc} driver
11598 program uses when determining what switches to pass to @command{cc1},
11599 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11600 @option{-specs=@var{file}} can be specified on the command line, and they
11601 are processed in order, from left to right.
11603 @item --sysroot=@var{dir}
11604 @opindex sysroot
11605 Use @var{dir} as the logical root directory for headers and libraries.
11606 For example, if the compiler normally searches for headers in
11607 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11608 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11610 If you use both this option and the @option{-isysroot} option, then
11611 the @option{--sysroot} option applies to libraries, but the
11612 @option{-isysroot} option applies to header files.
11614 The GNU linker (beginning with version 2.16) has the necessary support
11615 for this option.  If your linker does not support this option, the
11616 header file aspect of @option{--sysroot} still works, but the
11617 library aspect does not.
11619 @item --no-sysroot-suffix
11620 @opindex no-sysroot-suffix
11621 For some targets, a suffix is added to the root directory specified
11622 with @option{--sysroot}, depending on the other options used, so that
11623 headers may for example be found in
11624 @file{@var{dir}/@var{suffix}/usr/include} instead of
11625 @file{@var{dir}/usr/include}.  This option disables the addition of
11626 such a suffix.
11628 @item -I-
11629 @opindex I-
11630 This option has been deprecated.  Please use @option{-iquote} instead for
11631 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11632 option.
11633 Any directories you specify with @option{-I} options before the @option{-I-}
11634 option are searched only for the case of @code{#include "@var{file}"};
11635 they are not searched for @code{#include <@var{file}>}.
11637 If additional directories are specified with @option{-I} options after
11638 the @option{-I-} option, these directories are searched for all @code{#include}
11639 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11640 this way.)
11642 In addition, the @option{-I-} option inhibits the use of the current
11643 directory (where the current input file came from) as the first search
11644 directory for @code{#include "@var{file}"}.  There is no way to
11645 override this effect of @option{-I-}.  With @option{-I.} you can specify
11646 searching the directory that is current when the compiler is
11647 invoked.  That is not exactly the same as what the preprocessor does
11648 by default, but it is often satisfactory.
11650 @option{-I-} does not inhibit the use of the standard system directories
11651 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11652 independent.
11653 @end table
11655 @c man end
11657 @node Spec Files
11658 @section Specifying Subprocesses and the Switches to Pass to Them
11659 @cindex Spec Files
11661 @command{gcc} is a driver program.  It performs its job by invoking a
11662 sequence of other programs to do the work of compiling, assembling and
11663 linking.  GCC interprets its command-line parameters and uses these to
11664 deduce which programs it should invoke, and which command-line options
11665 it ought to place on their command lines.  This behavior is controlled
11666 by @dfn{spec strings}.  In most cases there is one spec string for each
11667 program that GCC can invoke, but a few programs have multiple spec
11668 strings to control their behavior.  The spec strings built into GCC can
11669 be overridden by using the @option{-specs=} command-line switch to specify
11670 a spec file.
11672 @dfn{Spec files} are plaintext files that are used to construct spec
11673 strings.  They consist of a sequence of directives separated by blank
11674 lines.  The type of directive is determined by the first non-whitespace
11675 character on the line, which can be one of the following:
11677 @table @code
11678 @item %@var{command}
11679 Issues a @var{command} to the spec file processor.  The commands that can
11680 appear here are:
11682 @table @code
11683 @item %include <@var{file}>
11684 @cindex @code{%include}
11685 Search for @var{file} and insert its text at the current point in the
11686 specs file.
11688 @item %include_noerr <@var{file}>
11689 @cindex @code{%include_noerr}
11690 Just like @samp{%include}, but do not generate an error message if the include
11691 file cannot be found.
11693 @item %rename @var{old_name} @var{new_name}
11694 @cindex @code{%rename}
11695 Rename the spec string @var{old_name} to @var{new_name}.
11697 @end table
11699 @item *[@var{spec_name}]:
11700 This tells the compiler to create, override or delete the named spec
11701 string.  All lines after this directive up to the next directive or
11702 blank line are considered to be the text for the spec string.  If this
11703 results in an empty string then the spec is deleted.  (Or, if the
11704 spec did not exist, then nothing happens.)  Otherwise, if the spec
11705 does not currently exist a new spec is created.  If the spec does
11706 exist then its contents are overridden by the text of this
11707 directive, unless the first character of that text is the @samp{+}
11708 character, in which case the text is appended to the spec.
11710 @item [@var{suffix}]:
11711 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11712 and up to the next directive or blank line are considered to make up the
11713 spec string for the indicated suffix.  When the compiler encounters an
11714 input file with the named suffix, it processes the spec string in
11715 order to work out how to compile that file.  For example:
11717 @smallexample
11718 .ZZ:
11719 z-compile -input %i
11720 @end smallexample
11722 This says that any input file whose name ends in @samp{.ZZ} should be
11723 passed to the program @samp{z-compile}, which should be invoked with the
11724 command-line switch @option{-input} and with the result of performing the
11725 @samp{%i} substitution.  (See below.)
11727 As an alternative to providing a spec string, the text following a
11728 suffix directive can be one of the following:
11730 @table @code
11731 @item @@@var{language}
11732 This says that the suffix is an alias for a known @var{language}.  This is
11733 similar to using the @option{-x} command-line switch to GCC to specify a
11734 language explicitly.  For example:
11736 @smallexample
11737 .ZZ:
11738 @@c++
11739 @end smallexample
11741 Says that .ZZ files are, in fact, C++ source files.
11743 @item #@var{name}
11744 This causes an error messages saying:
11746 @smallexample
11747 @var{name} compiler not installed on this system.
11748 @end smallexample
11749 @end table
11751 GCC already has an extensive list of suffixes built into it.
11752 This directive adds an entry to the end of the list of suffixes, but
11753 since the list is searched from the end backwards, it is effectively
11754 possible to override earlier entries using this technique.
11756 @end table
11758 GCC has the following spec strings built into it.  Spec files can
11759 override these strings or create their own.  Note that individual
11760 targets can also add their own spec strings to this list.
11762 @smallexample
11763 asm          Options to pass to the assembler
11764 asm_final    Options to pass to the assembler post-processor
11765 cpp          Options to pass to the C preprocessor
11766 cc1          Options to pass to the C compiler
11767 cc1plus      Options to pass to the C++ compiler
11768 endfile      Object files to include at the end of the link
11769 link         Options to pass to the linker
11770 lib          Libraries to include on the command line to the linker
11771 libgcc       Decides which GCC support library to pass to the linker
11772 linker       Sets the name of the linker
11773 predefines   Defines to be passed to the C preprocessor
11774 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11775              by default
11776 startfile    Object files to include at the start of the link
11777 @end smallexample
11779 Here is a small example of a spec file:
11781 @smallexample
11782 %rename lib                 old_lib
11784 *lib:
11785 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11786 @end smallexample
11788 This example renames the spec called @samp{lib} to @samp{old_lib} and
11789 then overrides the previous definition of @samp{lib} with a new one.
11790 The new definition adds in some extra command-line options before
11791 including the text of the old definition.
11793 @dfn{Spec strings} are a list of command-line options to be passed to their
11794 corresponding program.  In addition, the spec strings can contain
11795 @samp{%}-prefixed sequences to substitute variable text or to
11796 conditionally insert text into the command line.  Using these constructs
11797 it is possible to generate quite complex command lines.
11799 Here is a table of all defined @samp{%}-sequences for spec
11800 strings.  Note that spaces are not generated automatically around the
11801 results of expanding these sequences.  Therefore you can concatenate them
11802 together or combine them with constant text in a single argument.
11804 @table @code
11805 @item %%
11806 Substitute one @samp{%} into the program name or argument.
11808 @item %i
11809 Substitute the name of the input file being processed.
11811 @item %b
11812 Substitute the basename of the input file being processed.
11813 This is the substring up to (and not including) the last period
11814 and not including the directory.
11816 @item %B
11817 This is the same as @samp{%b}, but include the file suffix (text after
11818 the last period).
11820 @item %d
11821 Marks the argument containing or following the @samp{%d} as a
11822 temporary file name, so that that file is deleted if GCC exits
11823 successfully.  Unlike @samp{%g}, this contributes no text to the
11824 argument.
11826 @item %g@var{suffix}
11827 Substitute a file name that has suffix @var{suffix} and is chosen
11828 once per compilation, and mark the argument in the same way as
11829 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11830 name is now chosen in a way that is hard to predict even when previously
11831 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11832 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11833 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11834 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11835 was simply substituted with a file name chosen once per compilation,
11836 without regard to any appended suffix (which was therefore treated
11837 just like ordinary text), making such attacks more likely to succeed.
11839 @item %u@var{suffix}
11840 Like @samp{%g}, but generates a new temporary file name
11841 each time it appears instead of once per compilation.
11843 @item %U@var{suffix}
11844 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11845 new one if there is no such last file name.  In the absence of any
11846 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11847 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11848 involves the generation of two distinct file names, one
11849 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11850 simply substituted with a file name chosen for the previous @samp{%u},
11851 without regard to any appended suffix.
11853 @item %j@var{suffix}
11854 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11855 writable, and if @option{-save-temps} is not used; 
11856 otherwise, substitute the name
11857 of a temporary file, just like @samp{%u}.  This temporary file is not
11858 meant for communication between processes, but rather as a junk
11859 disposal mechanism.
11861 @item %|@var{suffix}
11862 @itemx %m@var{suffix}
11863 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11864 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11865 all.  These are the two most common ways to instruct a program that it
11866 should read from standard input or write to standard output.  If you
11867 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11868 construct: see for example @file{f/lang-specs.h}.
11870 @item %.@var{SUFFIX}
11871 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11872 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11873 terminated by the next space or %.
11875 @item %w
11876 Marks the argument containing or following the @samp{%w} as the
11877 designated output file of this compilation.  This puts the argument
11878 into the sequence of arguments that @samp{%o} substitutes.
11880 @item %o
11881 Substitutes the names of all the output files, with spaces
11882 automatically placed around them.  You should write spaces
11883 around the @samp{%o} as well or the results are undefined.
11884 @samp{%o} is for use in the specs for running the linker.
11885 Input files whose names have no recognized suffix are not compiled
11886 at all, but they are included among the output files, so they are
11887 linked.
11889 @item %O
11890 Substitutes the suffix for object files.  Note that this is
11891 handled specially when it immediately follows @samp{%g, %u, or %U},
11892 because of the need for those to form complete file names.  The
11893 handling is such that @samp{%O} is treated exactly as if it had already
11894 been substituted, except that @samp{%g, %u, and %U} do not currently
11895 support additional @var{suffix} characters following @samp{%O} as they do
11896 following, for example, @samp{.o}.
11898 @item %p
11899 Substitutes the standard macro predefinitions for the
11900 current target machine.  Use this when running @command{cpp}.
11902 @item %P
11903 Like @samp{%p}, but puts @samp{__} before and after the name of each
11904 predefined macro, except for macros that start with @samp{__} or with
11905 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11908 @item %I
11909 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11910 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11911 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11912 and @option{-imultilib} as necessary.
11914 @item %s
11915 Current argument is the name of a library or startup file of some sort.
11916 Search for that file in a standard list of directories and substitute
11917 the full name found.  The current working directory is included in the
11918 list of directories scanned.
11920 @item %T
11921 Current argument is the name of a linker script.  Search for that file
11922 in the current list of directories to scan for libraries. If the file
11923 is located insert a @option{--script} option into the command line
11924 followed by the full path name found.  If the file is not found then
11925 generate an error message.  Note: the current working directory is not
11926 searched.
11928 @item %e@var{str}
11929 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11930 Use this when inconsistent options are detected.
11932 @item %(@var{name})
11933 Substitute the contents of spec string @var{name} at this point.
11935 @item %x@{@var{option}@}
11936 Accumulate an option for @samp{%X}.
11938 @item %X
11939 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11940 spec string.
11942 @item %Y
11943 Output the accumulated assembler options specified by @option{-Wa}.
11945 @item %Z
11946 Output the accumulated preprocessor options specified by @option{-Wp}.
11948 @item %a
11949 Process the @code{asm} spec.  This is used to compute the
11950 switches to be passed to the assembler.
11952 @item %A
11953 Process the @code{asm_final} spec.  This is a spec string for
11954 passing switches to an assembler post-processor, if such a program is
11955 needed.
11957 @item %l
11958 Process the @code{link} spec.  This is the spec for computing the
11959 command line passed to the linker.  Typically it makes use of the
11960 @samp{%L %G %S %D and %E} sequences.
11962 @item %D
11963 Dump out a @option{-L} option for each directory that GCC believes might
11964 contain startup files.  If the target supports multilibs then the
11965 current multilib directory is prepended to each of these paths.
11967 @item %L
11968 Process the @code{lib} spec.  This is a spec string for deciding which
11969 libraries are included on the command line to the linker.
11971 @item %G
11972 Process the @code{libgcc} spec.  This is a spec string for deciding
11973 which GCC support library is included on the command line to the linker.
11975 @item %S
11976 Process the @code{startfile} spec.  This is a spec for deciding which
11977 object files are the first ones passed to the linker.  Typically
11978 this might be a file named @file{crt0.o}.
11980 @item %E
11981 Process the @code{endfile} spec.  This is a spec string that specifies
11982 the last object files that are passed to the linker.
11984 @item %C
11985 Process the @code{cpp} spec.  This is used to construct the arguments
11986 to be passed to the C preprocessor.
11988 @item %1
11989 Process the @code{cc1} spec.  This is used to construct the options to be
11990 passed to the actual C compiler (@command{cc1}).
11992 @item %2
11993 Process the @code{cc1plus} spec.  This is used to construct the options to be
11994 passed to the actual C++ compiler (@command{cc1plus}).
11996 @item %*
11997 Substitute the variable part of a matched option.  See below.
11998 Note that each comma in the substituted string is replaced by
11999 a single space.
12001 @item %<@code{S}
12002 Remove all occurrences of @code{-S} from the command line.  Note---this
12003 command is position dependent.  @samp{%} commands in the spec string
12004 before this one see @code{-S}, @samp{%} commands in the spec string
12005 after this one do not.
12007 @item %:@var{function}(@var{args})
12008 Call the named function @var{function}, passing it @var{args}.
12009 @var{args} is first processed as a nested spec string, then split
12010 into an argument vector in the usual fashion.  The function returns
12011 a string which is processed as if it had appeared literally as part
12012 of the current spec.
12014 The following built-in spec functions are provided:
12016 @table @code
12017 @item @code{getenv}
12018 The @code{getenv} spec function takes two arguments: an environment
12019 variable name and a string.  If the environment variable is not
12020 defined, a fatal error is issued.  Otherwise, the return value is the
12021 value of the environment variable concatenated with the string.  For
12022 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
12024 @smallexample
12025 %:getenv(TOPDIR /include)
12026 @end smallexample
12028 expands to @file{/path/to/top/include}.
12030 @item @code{if-exists}
12031 The @code{if-exists} spec function takes one argument, an absolute
12032 pathname to a file.  If the file exists, @code{if-exists} returns the
12033 pathname.  Here is a small example of its usage:
12035 @smallexample
12036 *startfile:
12037 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
12038 @end smallexample
12040 @item @code{if-exists-else}
12041 The @code{if-exists-else} spec function is similar to the @code{if-exists}
12042 spec function, except that it takes two arguments.  The first argument is
12043 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
12044 returns the pathname.  If it does not exist, it returns the second argument.
12045 This way, @code{if-exists-else} can be used to select one file or another,
12046 based on the existence of the first.  Here is a small example of its usage:
12048 @smallexample
12049 *startfile:
12050 crt0%O%s %:if-exists(crti%O%s) \
12051 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
12052 @end smallexample
12054 @item @code{replace-outfile}
12055 The @code{replace-outfile} spec function takes two arguments.  It looks for the
12056 first argument in the outfiles array and replaces it with the second argument.  Here
12057 is a small example of its usage:
12059 @smallexample
12060 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
12061 @end smallexample
12063 @item @code{remove-outfile}
12064 The @code{remove-outfile} spec function takes one argument.  It looks for the
12065 first argument in the outfiles array and removes it.  Here is a small example
12066 its usage:
12068 @smallexample
12069 %:remove-outfile(-lm)
12070 @end smallexample
12072 @item @code{pass-through-libs}
12073 The @code{pass-through-libs} spec function takes any number of arguments.  It
12074 finds any @option{-l} options and any non-options ending in @file{.a} (which it
12075 assumes are the names of linker input library archive files) and returns a
12076 result containing all the found arguments each prepended by
12077 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
12078 intended to be passed to the LTO linker plugin.
12080 @smallexample
12081 %:pass-through-libs(%G %L %G)
12082 @end smallexample
12084 @item @code{print-asm-header}
12085 The @code{print-asm-header} function takes no arguments and simply
12086 prints a banner like:
12088 @smallexample
12089 Assembler options
12090 =================
12092 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
12093 @end smallexample
12095 It is used to separate compiler options from assembler options
12096 in the @option{--target-help} output.
12097 @end table
12099 @item %@{@code{S}@}
12100 Substitutes the @code{-S} switch, if that switch is given to GCC@.
12101 If that switch is not specified, this substitutes nothing.  Note that
12102 the leading dash is omitted when specifying this option, and it is
12103 automatically inserted if the substitution is performed.  Thus the spec
12104 string @samp{%@{foo@}} matches the command-line option @option{-foo}
12105 and outputs the command-line option @option{-foo}.
12107 @item %W@{@code{S}@}
12108 Like %@{@code{S}@} but mark last argument supplied within as a file to be
12109 deleted on failure.
12111 @item %@{@code{S}*@}
12112 Substitutes all the switches specified to GCC whose names start
12113 with @code{-S}, but which also take an argument.  This is used for
12114 switches like @option{-o}, @option{-D}, @option{-I}, etc.
12115 GCC considers @option{-o foo} as being
12116 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
12117 text, including the space.  Thus two arguments are generated.
12119 @item %@{@code{S}*&@code{T}*@}
12120 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
12121 (the order of @code{S} and @code{T} in the spec is not significant).
12122 There can be any number of ampersand-separated variables; for each the
12123 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
12125 @item %@{@code{S}:@code{X}@}
12126 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
12128 @item %@{!@code{S}:@code{X}@}
12129 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
12131 @item %@{@code{S}*:@code{X}@}
12132 Substitutes @code{X} if one or more switches whose names start with
12133 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
12134 once, no matter how many such switches appeared.  However, if @code{%*}
12135 appears somewhere in @code{X}, then @code{X} is substituted once
12136 for each matching switch, with the @code{%*} replaced by the part of
12137 that switch matching the @code{*}.
12139 If @code{%*} appears as the last part of a spec sequence then a space
12140 is added after the end of the last substitution.  If there is more
12141 text in the sequence, however, then a space is not generated.  This
12142 allows the @code{%*} substitution to be used as part of a larger
12143 string.  For example, a spec string like this:
12145 @smallexample
12146 %@{mcu=*:--script=%*/memory.ld@}
12147 @end smallexample
12149 @noindent
12150 when matching an option like @option{-mcu=newchip} produces:
12152 @smallexample
12153 --script=newchip/memory.ld
12154 @end smallexample
12156 @item %@{.@code{S}:@code{X}@}
12157 Substitutes @code{X}, if processing a file with suffix @code{S}.
12159 @item %@{!.@code{S}:@code{X}@}
12160 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
12162 @item %@{,@code{S}:@code{X}@}
12163 Substitutes @code{X}, if processing a file for language @code{S}.
12165 @item %@{!,@code{S}:@code{X}@}
12166 Substitutes @code{X}, if not processing a file for language @code{S}.
12168 @item %@{@code{S}|@code{P}:@code{X}@}
12169 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
12170 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
12171 @code{*} sequences as well, although they have a stronger binding than
12172 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
12173 alternatives must be starred, and only the first matching alternative
12174 is substituted.
12176 For example, a spec string like this:
12178 @smallexample
12179 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
12180 @end smallexample
12182 @noindent
12183 outputs the following command-line options from the following input
12184 command-line options:
12186 @smallexample
12187 fred.c        -foo -baz
12188 jim.d         -bar -boggle
12189 -d fred.c     -foo -baz -boggle
12190 -d jim.d      -bar -baz -boggle
12191 @end smallexample
12193 @item %@{S:X; T:Y; :D@}
12195 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
12196 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
12197 be as many clauses as you need.  This may be combined with @code{.},
12198 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
12201 @end table
12203 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
12204 construct may contain other nested @samp{%} constructs or spaces, or
12205 even newlines.  They are processed as usual, as described above.
12206 Trailing white space in @code{X} is ignored.  White space may also
12207 appear anywhere on the left side of the colon in these constructs,
12208 except between @code{.} or @code{*} and the corresponding word.
12210 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
12211 handled specifically in these constructs.  If another value of
12212 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
12213 @option{-W} switch is found later in the command line, the earlier
12214 switch value is ignored, except with @{@code{S}*@} where @code{S} is
12215 just one letter, which passes all matching options.
12217 The character @samp{|} at the beginning of the predicate text is used to
12218 indicate that a command should be piped to the following command, but
12219 only if @option{-pipe} is specified.
12221 It is built into GCC which switches take arguments and which do not.
12222 (You might think it would be useful to generalize this to allow each
12223 compiler's spec to say which switches take arguments.  But this cannot
12224 be done in a consistent fashion.  GCC cannot even decide which input
12225 files have been specified without knowing which switches take arguments,
12226 and it must know which input files to compile in order to tell which
12227 compilers to run).
12229 GCC also knows implicitly that arguments starting in @option{-l} are to be
12230 treated as compiler output files, and passed to the linker in their
12231 proper position among the other output files.
12233 @c man begin OPTIONS
12235 @node Target Options
12236 @section Specifying Target Machine and Compiler Version
12237 @cindex target options
12238 @cindex cross compiling
12239 @cindex specifying machine version
12240 @cindex specifying compiler version and target machine
12241 @cindex compiler version, specifying
12242 @cindex target machine, specifying
12244 The usual way to run GCC is to run the executable called @command{gcc}, or
12245 @command{@var{machine}-gcc} when cross-compiling, or
12246 @command{@var{machine}-gcc-@var{version}} to run a version other than the
12247 one that was installed last.
12249 @node Submodel Options
12250 @section Hardware Models and Configurations
12251 @cindex submodel options
12252 @cindex specifying hardware config
12253 @cindex hardware models and configurations, specifying
12254 @cindex machine dependent options
12256 Each target machine types can have its own
12257 special options, starting with @samp{-m}, to choose among various
12258 hardware models or configurations---for example, 68010 vs 68020,
12259 floating coprocessor or none.  A single installed version of the
12260 compiler can compile for any model or configuration, according to the
12261 options specified.
12263 Some configurations of the compiler also support additional special
12264 options, usually for compatibility with other compilers on the same
12265 platform.
12267 @c This list is ordered alphanumerically by subsection name.
12268 @c It should be the same order and spelling as these options are listed
12269 @c in Machine Dependent Options
12271 @menu
12272 * AArch64 Options::
12273 * Adapteva Epiphany Options::
12274 * ARC Options::
12275 * ARM Options::
12276 * AVR Options::
12277 * Blackfin Options::
12278 * C6X Options::
12279 * CRIS Options::
12280 * CR16 Options::
12281 * Darwin Options::
12282 * DEC Alpha Options::
12283 * FR30 Options::
12284 * FT32 Options::
12285 * FRV Options::
12286 * GNU/Linux Options::
12287 * H8/300 Options::
12288 * HPPA Options::
12289 * IA-64 Options::
12290 * LM32 Options::
12291 * M32C Options::
12292 * M32R/D Options::
12293 * M680x0 Options::
12294 * MCore Options::
12295 * MeP Options::
12296 * MicroBlaze Options::
12297 * MIPS Options::
12298 * MMIX Options::
12299 * MN10300 Options::
12300 * Moxie Options::
12301 * MSP430 Options::
12302 * NDS32 Options::
12303 * Nios II Options::
12304 * Nvidia PTX Options::
12305 * PDP-11 Options::
12306 * picoChip Options::
12307 * PowerPC Options::
12308 * RL78 Options::
12309 * RS/6000 and PowerPC Options::
12310 * RX Options::
12311 * S/390 and zSeries Options::
12312 * Score Options::
12313 * SH Options::
12314 * Solaris 2 Options::
12315 * SPARC Options::
12316 * SPU Options::
12317 * System V Options::
12318 * TILE-Gx Options::
12319 * TILEPro Options::
12320 * V850 Options::
12321 * VAX Options::
12322 * Visium Options::
12323 * VMS Options::
12324 * VxWorks Options::
12325 * x86 Options::
12326 * x86 Windows Options::
12327 * Xstormy16 Options::
12328 * Xtensa Options::
12329 * zSeries Options::
12330 @end menu
12332 @node AArch64 Options
12333 @subsection AArch64 Options
12334 @cindex AArch64 Options
12336 These options are defined for AArch64 implementations:
12338 @table @gcctabopt
12340 @item -mabi=@var{name}
12341 @opindex mabi
12342 Generate code for the specified data model.  Permissible values
12343 are @samp{ilp32} for SysV-like data model where int, long int and pointer
12344 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
12345 but long int and pointer are 64-bit.
12347 The default depends on the specific target configuration.  Note that
12348 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
12349 entire program with the same ABI, and link with a compatible set of libraries.
12351 @item -mbig-endian
12352 @opindex mbig-endian
12353 Generate big-endian code.  This is the default when GCC is configured for an
12354 @samp{aarch64_be-*-*} target.
12356 @item -mgeneral-regs-only
12357 @opindex mgeneral-regs-only
12358 Generate code which uses only the general registers.
12360 @item -mlittle-endian
12361 @opindex mlittle-endian
12362 Generate little-endian code.  This is the default when GCC is configured for an
12363 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12365 @item -mcmodel=tiny
12366 @opindex mcmodel=tiny
12367 Generate code for the tiny code model.  The program and its statically defined
12368 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
12369 be statically or dynamically linked.  This model is not fully implemented and
12370 mostly treated as @samp{small}.
12372 @item -mcmodel=small
12373 @opindex mcmodel=small
12374 Generate code for the small code model.  The program and its statically defined
12375 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
12376 be statically or dynamically linked.  This is the default code model.
12378 @item -mcmodel=large
12379 @opindex mcmodel=large
12380 Generate code for the large code model.  This makes no assumptions about
12381 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
12382 statically linked only.
12384 @item -mstrict-align
12385 @opindex mstrict-align
12386 Do not assume that unaligned memory references are handled by the system.
12388 @item -momit-leaf-frame-pointer
12389 @itemx -mno-omit-leaf-frame-pointer
12390 @opindex momit-leaf-frame-pointer
12391 @opindex mno-omit-leaf-frame-pointer
12392 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
12393 default.
12395 @item -mtls-dialect=desc
12396 @opindex mtls-dialect=desc
12397 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12398 of TLS variables.  This is the default.
12400 @item -mtls-dialect=traditional
12401 @opindex mtls-dialect=traditional
12402 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12403 of TLS variables.
12405 @item -mfix-cortex-a53-835769
12406 @itemx -mno-fix-cortex-a53-835769
12407 @opindex mfix-cortex-a53-835769
12408 @opindex mno-fix-cortex-a53-835769
12409 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12410 This involves inserting a NOP instruction between memory instructions and
12411 64-bit integer multiply-accumulate instructions.
12413 @item -mfix-cortex-a53-843419
12414 @itemx -mno-fix-cortex-a53-843419
12415 @opindex mfix-cortex-a53-843419
12416 @opindex mno-fix-cortex-a53-843419
12417 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
12418 This erratum workaround is made at link time and this will only pass the
12419 corresponding flag to the linker.
12421 @item -march=@var{name}
12422 @opindex march
12423 Specify the name of the target architecture, optionally suffixed by one or
12424 more feature modifiers.  This option has the form
12425 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12426 only permissible value for @var{arch} is @samp{armv8-a}.
12427 The permissible values for @var{feature} are documented in the sub-section
12428 below.  Additionally on native AArch64 GNU/Linux systems the value
12429 @samp{native} is available.  This option causes the compiler to pick the
12430 architecture of the host system.  If the compiler is unable to recognize the
12431 architecture of the host system this option has no effect.
12433 Where conflicting feature modifiers are specified, the right-most feature is
12434 used.
12436 GCC uses this name to determine what kind of instructions it can emit when
12437 generating assembly code.
12439 Where @option{-march} is specified without either of @option{-mtune}
12440 or @option{-mcpu} also being specified, the code is tuned to perform
12441 well across a range of target processors implementing the target
12442 architecture.
12444 @item -mtune=@var{name}
12445 @opindex mtune
12446 Specify the name of the target processor for which GCC should tune the
12447 performance of the code.  Permissible values for this option are:
12448 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
12449 @samp{exynos-m1}, @samp{thunderx}, @samp{xgene1}.
12451 Additionally, this option can specify that GCC should tune the performance
12452 of the code for a big.LITTLE system.  Permissible values for this
12453 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
12455 Additionally on native AArch64 GNU/Linux systems the value @samp{native}
12456 is available.
12457 This option causes the compiler to pick the architecture of and tune the
12458 performance of the code for the processor of the host system.
12459 If the compiler is unable to recognize the processor of the host system
12460 this option has no effect.
12462 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12463 are specified, the code is tuned to perform well across a range
12464 of target processors.
12466 This option cannot be suffixed by feature modifiers.
12468 @item -mcpu=@var{name}
12469 @opindex mcpu
12470 Specify the name of the target processor, optionally suffixed by one or more
12471 feature modifiers.  This option has the form
12472 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12473 permissible values for @var{cpu} are the same as those available for
12474 @option{-mtune}.  Additionally on native AArch64 GNU/Linux systems the
12475 value @samp{native} is available.
12476 This option causes the compiler to tune the performance of the code for the
12477 processor of the host system.  If the compiler is unable to recognize the
12478 processor of the host system this option has no effect.
12480 The permissible values for @var{feature} are documented in the sub-section
12481 below.
12483 Where conflicting feature modifiers are specified, the right-most feature is
12484 used.
12486 GCC uses this name to determine what kind of instructions it can emit when
12487 generating assembly code (as if by @option{-march}) and to determine
12488 the target processor for which to tune for performance (as if
12489 by @option{-mtune}).  Where this option is used in conjunction
12490 with @option{-march} or @option{-mtune}, those options take precedence
12491 over the appropriate part of this option.
12492 @end table
12494 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
12495 @cindex @option{-march} feature modifiers
12496 @cindex @option{-mcpu} feature modifiers
12497 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
12498 the following:
12500 @table @samp
12501 @item crc
12502 Enable CRC extension.
12503 @item crypto
12504 Enable Crypto extension.  This implies Advanced SIMD is enabled.
12505 @item fp
12506 Enable floating-point instructions.
12507 @item simd
12508 Enable Advanced SIMD instructions.  This implies floating-point instructions
12509 are enabled.  This is the default for all current possible values for options
12510 @option{-march} and @option{-mcpu=}.
12511 @end table
12513 @node Adapteva Epiphany Options
12514 @subsection Adapteva Epiphany Options
12516 These @samp{-m} options are defined for Adapteva Epiphany:
12518 @table @gcctabopt
12519 @item -mhalf-reg-file
12520 @opindex mhalf-reg-file
12521 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12522 That allows code to run on hardware variants that lack these registers.
12524 @item -mprefer-short-insn-regs
12525 @opindex mprefer-short-insn-regs
12526 Preferrentially allocate registers that allow short instruction generation.
12527 This can result in increased instruction count, so this may either reduce or
12528 increase overall code size.
12530 @item -mbranch-cost=@var{num}
12531 @opindex mbranch-cost
12532 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12533 This cost is only a heuristic and is not guaranteed to produce
12534 consistent results across releases.
12536 @item -mcmove
12537 @opindex mcmove
12538 Enable the generation of conditional moves.
12540 @item -mnops=@var{num}
12541 @opindex mnops
12542 Emit @var{num} NOPs before every other generated instruction.
12544 @item -mno-soft-cmpsf
12545 @opindex mno-soft-cmpsf
12546 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12547 and test the flags.  This is faster than a software comparison, but can
12548 get incorrect results in the presence of NaNs, or when two different small
12549 numbers are compared such that their difference is calculated as zero.
12550 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12551 software comparisons.
12553 @item -mstack-offset=@var{num}
12554 @opindex mstack-offset
12555 Set the offset between the top of the stack and the stack pointer.
12556 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12557 can be used by leaf functions without stack allocation.
12558 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12559 Note also that this option changes the ABI; compiling a program with a
12560 different stack offset than the libraries have been compiled with
12561 generally does not work.
12562 This option can be useful if you want to evaluate if a different stack
12563 offset would give you better code, but to actually use a different stack
12564 offset to build working programs, it is recommended to configure the
12565 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12567 @item -mno-round-nearest
12568 @opindex mno-round-nearest
12569 Make the scheduler assume that the rounding mode has been set to
12570 truncating.  The default is @option{-mround-nearest}.
12572 @item -mlong-calls
12573 @opindex mlong-calls
12574 If not otherwise specified by an attribute, assume all calls might be beyond
12575 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12576 function address into a register before performing a (otherwise direct) call.
12577 This is the default.
12579 @item -mshort-calls
12580 @opindex short-calls
12581 If not otherwise specified by an attribute, assume all direct calls are
12582 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12583 for direct calls.  The default is @option{-mlong-calls}.
12585 @item -msmall16
12586 @opindex msmall16
12587 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12588 apply to function addresses for which @option{-mlong-calls} semantics
12589 are in effect.
12591 @item -mfp-mode=@var{mode}
12592 @opindex mfp-mode
12593 Set the prevailing mode of the floating-point unit.
12594 This determines the floating-point mode that is provided and expected
12595 at function call and return time.  Making this mode match the mode you
12596 predominantly need at function start can make your programs smaller and
12597 faster by avoiding unnecessary mode switches.
12599 @var{mode} can be set to one the following values:
12601 @table @samp
12602 @item caller
12603 Any mode at function entry is valid, and retained or restored when
12604 the function returns, and when it calls other functions.
12605 This mode is useful for compiling libraries or other compilation units
12606 you might want to incorporate into different programs with different
12607 prevailing FPU modes, and the convenience of being able to use a single
12608 object file outweighs the size and speed overhead for any extra
12609 mode switching that might be needed, compared with what would be needed
12610 with a more specific choice of prevailing FPU mode.
12612 @item truncate
12613 This is the mode used for floating-point calculations with
12614 truncating (i.e.@: round towards zero) rounding mode.  That includes
12615 conversion from floating point to integer.
12617 @item round-nearest
12618 This is the mode used for floating-point calculations with
12619 round-to-nearest-or-even rounding mode.
12621 @item int
12622 This is the mode used to perform integer calculations in the FPU, e.g.@:
12623 integer multiply, or integer multiply-and-accumulate.
12624 @end table
12626 The default is @option{-mfp-mode=caller}
12628 @item -mnosplit-lohi
12629 @itemx -mno-postinc
12630 @itemx -mno-postmodify
12631 @opindex mnosplit-lohi
12632 @opindex mno-postinc
12633 @opindex mno-postmodify
12634 Code generation tweaks that disable, respectively, splitting of 32-bit
12635 loads, generation of post-increment addresses, and generation of
12636 post-modify addresses.  The defaults are @option{msplit-lohi},
12637 @option{-mpost-inc}, and @option{-mpost-modify}.
12639 @item -mnovect-double
12640 @opindex mno-vect-double
12641 Change the preferred SIMD mode to SImode.  The default is
12642 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12644 @item -max-vect-align=@var{num}
12645 @opindex max-vect-align
12646 The maximum alignment for SIMD vector mode types.
12647 @var{num} may be 4 or 8.  The default is 8.
12648 Note that this is an ABI change, even though many library function
12649 interfaces are unaffected if they don't use SIMD vector modes
12650 in places that affect size and/or alignment of relevant types.
12652 @item -msplit-vecmove-early
12653 @opindex msplit-vecmove-early
12654 Split vector moves into single word moves before reload.  In theory this
12655 can give better register allocation, but so far the reverse seems to be
12656 generally the case.
12658 @item -m1reg-@var{reg}
12659 @opindex m1reg-
12660 Specify a register to hold the constant @minus{}1, which makes loading small negative
12661 constants and certain bitmasks faster.
12662 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12663 which specify use of that register as a fixed register,
12664 and @samp{none}, which means that no register is used for this
12665 purpose.  The default is @option{-m1reg-none}.
12667 @end table
12669 @node ARC Options
12670 @subsection ARC Options
12671 @cindex ARC options
12673 The following options control the architecture variant for which code
12674 is being compiled:
12676 @c architecture variants
12677 @table @gcctabopt
12679 @item -mbarrel-shifter
12680 @opindex mbarrel-shifter
12681 Generate instructions supported by barrel shifter.  This is the default
12682 unless @option{-mcpu=ARC601} is in effect.
12684 @item -mcpu=@var{cpu}
12685 @opindex mcpu
12686 Set architecture type, register usage, and instruction scheduling
12687 parameters for @var{cpu}.  There are also shortcut alias options
12688 available for backward compatibility and convenience.  Supported
12689 values for @var{cpu} are
12691 @table @samp
12692 @opindex mA6
12693 @opindex mARC600
12694 @item ARC600
12695 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12697 @item ARC601
12698 @opindex mARC601
12699 Compile for ARC601.  Alias: @option{-mARC601}.
12701 @item ARC700
12702 @opindex mA7
12703 @opindex mARC700
12704 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12705 This is the default when configured with @option{--with-cpu=arc700}@.
12706 @end table
12708 @item -mdpfp
12709 @opindex mdpfp
12710 @itemx -mdpfp-compact
12711 @opindex mdpfp-compact
12712 FPX: Generate Double Precision FPX instructions, tuned for the compact
12713 implementation.
12715 @item -mdpfp-fast
12716 @opindex mdpfp-fast
12717 FPX: Generate Double Precision FPX instructions, tuned for the fast
12718 implementation.
12720 @item -mno-dpfp-lrsr
12721 @opindex mno-dpfp-lrsr
12722 Disable LR and SR instructions from using FPX extension aux registers.
12724 @item -mea
12725 @opindex mea
12726 Generate Extended arithmetic instructions.  Currently only
12727 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12728 supported.  This is always enabled for @option{-mcpu=ARC700}.
12730 @item -mno-mpy
12731 @opindex mno-mpy
12732 Do not generate mpy instructions for ARC700.
12734 @item -mmul32x16
12735 @opindex mmul32x16
12736 Generate 32x16 bit multiply and mac instructions.
12738 @item -mmul64
12739 @opindex mmul64
12740 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
12742 @item -mnorm
12743 @opindex mnorm
12744 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
12745 is in effect.
12747 @item -mspfp
12748 @opindex mspfp
12749 @itemx -mspfp-compact
12750 @opindex mspfp-compact
12751 FPX: Generate Single Precision FPX instructions, tuned for the compact
12752 implementation.
12754 @item -mspfp-fast
12755 @opindex mspfp-fast
12756 FPX: Generate Single Precision FPX instructions, tuned for the fast
12757 implementation.
12759 @item -msimd
12760 @opindex msimd
12761 Enable generation of ARC SIMD instructions via target-specific
12762 builtins.  Only valid for @option{-mcpu=ARC700}.
12764 @item -msoft-float
12765 @opindex msoft-float
12766 This option ignored; it is provided for compatibility purposes only.
12767 Software floating point code is emitted by default, and this default
12768 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12769 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12770 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12772 @item -mswap
12773 @opindex mswap
12774 Generate swap instructions.
12776 @end table
12778 The following options are passed through to the assembler, and also
12779 define preprocessor macro symbols.
12781 @c Flags used by the assembler, but for which we define preprocessor
12782 @c macro symbols as well.
12783 @table @gcctabopt
12784 @item -mdsp-packa
12785 @opindex mdsp-packa
12786 Passed down to the assembler to enable the DSP Pack A extensions.
12787 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12789 @item -mdvbf
12790 @opindex mdvbf
12791 Passed down to the assembler to enable the dual viterbi butterfly
12792 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12794 @c ARC700 4.10 extension instruction
12795 @item -mlock
12796 @opindex mlock
12797 Passed down to the assembler to enable the Locked Load/Store
12798 Conditional extension.  Also sets the preprocessor symbol
12799 @code{__Xlock}.
12801 @item -mmac-d16
12802 @opindex mmac-d16
12803 Passed down to the assembler.  Also sets the preprocessor symbol
12804 @code{__Xxmac_d16}.
12806 @item -mmac-24
12807 @opindex mmac-24
12808 Passed down to the assembler.  Also sets the preprocessor symbol
12809 @code{__Xxmac_24}.
12811 @c ARC700 4.10 extension instruction
12812 @item -mrtsc
12813 @opindex mrtsc
12814 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12815 extension instruction.  Also sets the preprocessor symbol
12816 @code{__Xrtsc}.
12818 @c ARC700 4.10 extension instruction
12819 @item -mswape
12820 @opindex mswape
12821 Passed down to the assembler to enable the swap byte ordering
12822 extension instruction.  Also sets the preprocessor symbol
12823 @code{__Xswape}.
12825 @item -mtelephony
12826 @opindex mtelephony
12827 Passed down to the assembler to enable dual and single operand
12828 instructions for telephony.  Also sets the preprocessor symbol
12829 @code{__Xtelephony}.
12831 @item -mxy
12832 @opindex mxy
12833 Passed down to the assembler to enable the XY Memory extension.  Also
12834 sets the preprocessor symbol @code{__Xxy}.
12836 @end table
12838 The following options control how the assembly code is annotated:
12840 @c Assembly annotation options
12841 @table @gcctabopt
12842 @item -misize
12843 @opindex misize
12844 Annotate assembler instructions with estimated addresses.
12846 @item -mannotate-align
12847 @opindex mannotate-align
12848 Explain what alignment considerations lead to the decision to make an
12849 instruction short or long.
12851 @end table
12853 The following options are passed through to the linker:
12855 @c options passed through to the linker
12856 @table @gcctabopt
12857 @item -marclinux
12858 @opindex marclinux
12859 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12860 This option is enabled by default in tool chains built for
12861 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12862 when profiling is not requested.
12864 @item -marclinux_prof
12865 @opindex marclinux_prof
12866 Passed through to the linker, to specify use of the
12867 @code{arclinux_prof} emulation.  This option is enabled by default in
12868 tool chains built for @w{@code{arc-linux-uclibc}} and
12869 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12871 @end table
12873 The following options control the semantics of generated code:
12875 @c semantically relevant code generation options
12876 @table @gcctabopt
12877 @item -mepilogue-cfi
12878 @opindex mepilogue-cfi
12879 Enable generation of call frame information for epilogues.
12881 @item -mno-epilogue-cfi
12882 @opindex mno-epilogue-cfi
12883 Disable generation of call frame information for epilogues.
12885 @item -mlong-calls
12886 @opindex mlong-calls
12887 Generate call insns as register indirect calls, thus providing access
12888 to the full 32-bit address range.
12890 @item -mmedium-calls
12891 @opindex mmedium-calls
12892 Don't use less than 25 bit addressing range for calls, which is the
12893 offset available for an unconditional branch-and-link
12894 instruction.  Conditional execution of function calls is suppressed, to
12895 allow use of the 25-bit range, rather than the 21-bit range with
12896 conditional branch-and-link.  This is the default for tool chains built
12897 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12899 @item -mno-sdata
12900 @opindex mno-sdata
12901 Do not generate sdata references.  This is the default for tool chains
12902 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12903 targets.
12905 @item -mucb-mcount
12906 @opindex mucb-mcount
12907 Instrument with mcount calls as used in UCB code.  I.e. do the
12908 counting in the callee, not the caller.  By default ARC instrumentation
12909 counts in the caller.
12911 @item -mvolatile-cache
12912 @opindex mvolatile-cache
12913 Use ordinarily cached memory accesses for volatile references.  This is the
12914 default.
12916 @item -mno-volatile-cache
12917 @opindex mno-volatile-cache
12918 Enable cache bypass for volatile references.
12920 @end table
12922 The following options fine tune code generation:
12923 @c code generation tuning options
12924 @table @gcctabopt
12925 @item -malign-call
12926 @opindex malign-call
12927 Do alignment optimizations for call instructions.
12929 @item -mauto-modify-reg
12930 @opindex mauto-modify-reg
12931 Enable the use of pre/post modify with register displacement.
12933 @item -mbbit-peephole
12934 @opindex mbbit-peephole
12935 Enable bbit peephole2.
12937 @item -mno-brcc
12938 @opindex mno-brcc
12939 This option disables a target-specific pass in @file{arc_reorg} to
12940 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12941 generation driven by the combiner pass.
12943 @item -mcase-vector-pcrel
12944 @opindex mcase-vector-pcrel
12945 Use pc-relative switch case tables - this enables case table shortening.
12946 This is the default for @option{-Os}.
12948 @item -mcompact-casesi
12949 @opindex mcompact-casesi
12950 Enable compact casesi pattern.
12951 This is the default for @option{-Os}.
12953 @item -mno-cond-exec
12954 @opindex mno-cond-exec
12955 Disable ARCompact specific pass to generate conditional execution instructions.
12956 Due to delay slot scheduling and interactions between operand numbers,
12957 literal sizes, instruction lengths, and the support for conditional execution,
12958 the target-independent pass to generate conditional execution is often lacking,
12959 so the ARC port has kept a special pass around that tries to find more
12960 conditional execution generating opportunities after register allocation,
12961 branch shortening, and delay slot scheduling have been done.  This pass
12962 generally, but not always, improves performance and code size, at the cost of
12963 extra compilation time, which is why there is an option to switch it off.
12964 If you have a problem with call instructions exceeding their allowable
12965 offset range because they are conditionalized, you should consider using
12966 @option{-mmedium-calls} instead.
12968 @item -mearly-cbranchsi
12969 @opindex mearly-cbranchsi
12970 Enable pre-reload use of the cbranchsi pattern.
12972 @item -mexpand-adddi
12973 @opindex mexpand-adddi
12974 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12975 @code{add.f}, @code{adc} etc.
12977 @item -mindexed-loads
12978 @opindex mindexed-loads
12979 Enable the use of indexed loads.  This can be problematic because some
12980 optimizers then assume that indexed stores exist, which is not
12981 the case.
12983 @item -mlra
12984 @opindex mlra
12985 Enable Local Register Allocation.  This is still experimental for ARC,
12986 so by default the compiler uses standard reload
12987 (i.e. @option{-mno-lra}).
12989 @item -mlra-priority-none
12990 @opindex mlra-priority-none
12991 Don't indicate any priority for target registers.
12993 @item -mlra-priority-compact
12994 @opindex mlra-priority-compact
12995 Indicate target register priority for r0..r3 / r12..r15.
12997 @item -mlra-priority-noncompact
12998 @opindex mlra-priority-noncompact
12999 Reduce target regsiter priority for r0..r3 / r12..r15.
13001 @item -mno-millicode
13002 @opindex mno-millicode
13003 When optimizing for size (using @option{-Os}), prologues and epilogues
13004 that have to save or restore a large number of registers are often
13005 shortened by using call to a special function in libgcc; this is
13006 referred to as a @emph{millicode} call.  As these calls can pose
13007 performance issues, and/or cause linking issues when linking in a
13008 nonstandard way, this option is provided to turn off millicode call
13009 generation.
13011 @item -mmixed-code
13012 @opindex mmixed-code
13013 Tweak register allocation to help 16-bit instruction generation.
13014 This generally has the effect of decreasing the average instruction size
13015 while increasing the instruction count.
13017 @item -mq-class
13018 @opindex mq-class
13019 Enable 'q' instruction alternatives.
13020 This is the default for @option{-Os}.
13022 @item -mRcq
13023 @opindex mRcq
13024 Enable Rcq constraint handling - most short code generation depends on this.
13025 This is the default.
13027 @item -mRcw
13028 @opindex mRcw
13029 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
13030 This is the default.
13032 @item -msize-level=@var{level}
13033 @opindex msize-level
13034 Fine-tune size optimization with regards to instruction lengths and alignment.
13035 The recognized values for @var{level} are:
13036 @table @samp
13037 @item 0
13038 No size optimization.  This level is deprecated and treated like @samp{1}.
13040 @item 1
13041 Short instructions are used opportunistically.
13043 @item 2
13044 In addition, alignment of loops and of code after barriers are dropped.
13046 @item 3
13047 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
13049 @end table
13051 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
13052 the behavior when this is not set is equivalent to level @samp{1}.
13054 @item -mtune=@var{cpu}
13055 @opindex mtune
13056 Set instruction scheduling parameters for @var{cpu}, overriding any implied
13057 by @option{-mcpu=}.
13059 Supported values for @var{cpu} are
13061 @table @samp
13062 @item ARC600
13063 Tune for ARC600 cpu.
13065 @item ARC601
13066 Tune for ARC601 cpu.
13068 @item ARC700
13069 Tune for ARC700 cpu with standard multiplier block.
13071 @item ARC700-xmac
13072 Tune for ARC700 cpu with XMAC block.
13074 @item ARC725D
13075 Tune for ARC725D cpu.
13077 @item ARC750D
13078 Tune for ARC750D cpu.
13080 @end table
13082 @item -mmultcost=@var{num}
13083 @opindex mmultcost
13084 Cost to assume for a multiply instruction, with @samp{4} being equal to a
13085 normal instruction.
13087 @item -munalign-prob-threshold=@var{probability}
13088 @opindex munalign-prob-threshold
13089 Set probability threshold for unaligning branches.
13090 When tuning for @samp{ARC700} and optimizing for speed, branches without
13091 filled delay slot are preferably emitted unaligned and long, unless
13092 profiling indicates that the probability for the branch to be taken
13093 is below @var{probability}.  @xref{Cross-profiling}.
13094 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13096 @end table
13098 The following options are maintained for backward compatibility, but
13099 are now deprecated and will be removed in a future release:
13101 @c Deprecated options
13102 @table @gcctabopt
13104 @item -margonaut
13105 @opindex margonaut
13106 Obsolete FPX.
13108 @item -mbig-endian
13109 @opindex mbig-endian
13110 @itemx -EB
13111 @opindex EB
13112 Compile code for big endian targets.  Use of these options is now
13113 deprecated.  Users wanting big-endian code, should use the
13114 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13115 building the tool chain, for which big-endian is the default.
13117 @item -mlittle-endian
13118 @opindex mlittle-endian
13119 @itemx -EL
13120 @opindex EL
13121 Compile code for little endian targets.  Use of these options is now
13122 deprecated.  Users wanting little-endian code should use the
13123 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13124 building the tool chain, for which little-endian is the default.
13126 @item -mbarrel_shifter
13127 @opindex mbarrel_shifter
13128 Replaced by @option{-mbarrel-shifter}.
13130 @item -mdpfp_compact
13131 @opindex mdpfp_compact
13132 Replaced by @option{-mdpfp-compact}.
13134 @item -mdpfp_fast
13135 @opindex mdpfp_fast
13136 Replaced by @option{-mdpfp-fast}.
13138 @item -mdsp_packa
13139 @opindex mdsp_packa
13140 Replaced by @option{-mdsp-packa}.
13142 @item -mEA
13143 @opindex mEA
13144 Replaced by @option{-mea}.
13146 @item -mmac_24
13147 @opindex mmac_24
13148 Replaced by @option{-mmac-24}.
13150 @item -mmac_d16
13151 @opindex mmac_d16
13152 Replaced by @option{-mmac-d16}.
13154 @item -mspfp_compact
13155 @opindex mspfp_compact
13156 Replaced by @option{-mspfp-compact}.
13158 @item -mspfp_fast
13159 @opindex mspfp_fast
13160 Replaced by @option{-mspfp-fast}.
13162 @item -mtune=@var{cpu}
13163 @opindex mtune
13164 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13165 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13166 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13168 @item -multcost=@var{num}
13169 @opindex multcost
13170 Replaced by @option{-mmultcost}.
13172 @end table
13174 @node ARM Options
13175 @subsection ARM Options
13176 @cindex ARM options
13178 These @samp{-m} options are defined for the ARM port:
13180 @table @gcctabopt
13181 @item -mabi=@var{name}
13182 @opindex mabi
13183 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13184 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13186 @item -mapcs-frame
13187 @opindex mapcs-frame
13188 Generate a stack frame that is compliant with the ARM Procedure Call
13189 Standard for all functions, even if this is not strictly necessary for
13190 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13191 with this option causes the stack frames not to be generated for
13192 leaf functions.  The default is @option{-mno-apcs-frame}.
13193 This option is deprecated.
13195 @item -mapcs
13196 @opindex mapcs
13197 This is a synonym for @option{-mapcs-frame} and is deprecated.
13199 @ignore
13200 @c not currently implemented
13201 @item -mapcs-stack-check
13202 @opindex mapcs-stack-check
13203 Generate code to check the amount of stack space available upon entry to
13204 every function (that actually uses some stack space).  If there is
13205 insufficient space available then either the function
13206 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13207 called, depending upon the amount of stack space required.  The runtime
13208 system is required to provide these functions.  The default is
13209 @option{-mno-apcs-stack-check}, since this produces smaller code.
13211 @c not currently implemented
13212 @item -mapcs-float
13213 @opindex mapcs-float
13214 Pass floating-point arguments using the floating-point registers.  This is
13215 one of the variants of the APCS@.  This option is recommended if the
13216 target hardware has a floating-point unit or if a lot of floating-point
13217 arithmetic is going to be performed by the code.  The default is
13218 @option{-mno-apcs-float}, since the size of integer-only code is 
13219 slightly increased if @option{-mapcs-float} is used.
13221 @c not currently implemented
13222 @item -mapcs-reentrant
13223 @opindex mapcs-reentrant
13224 Generate reentrant, position-independent code.  The default is
13225 @option{-mno-apcs-reentrant}.
13226 @end ignore
13228 @item -mthumb-interwork
13229 @opindex mthumb-interwork
13230 Generate code that supports calling between the ARM and Thumb
13231 instruction sets.  Without this option, on pre-v5 architectures, the
13232 two instruction sets cannot be reliably used inside one program.  The
13233 default is @option{-mno-thumb-interwork}, since slightly larger code
13234 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13235 configurations this option is meaningless.
13237 @item -mno-sched-prolog
13238 @opindex mno-sched-prolog
13239 Prevent the reordering of instructions in the function prologue, or the
13240 merging of those instruction with the instructions in the function's
13241 body.  This means that all functions start with a recognizable set
13242 of instructions (or in fact one of a choice from a small set of
13243 different function prologues), and this information can be used to
13244 locate the start of functions inside an executable piece of code.  The
13245 default is @option{-msched-prolog}.
13247 @item -mfloat-abi=@var{name}
13248 @opindex mfloat-abi
13249 Specifies which floating-point ABI to use.  Permissible values
13250 are: @samp{soft}, @samp{softfp} and @samp{hard}.
13252 Specifying @samp{soft} causes GCC to generate output containing
13253 library calls for floating-point operations.
13254 @samp{softfp} allows the generation of code using hardware floating-point
13255 instructions, but still uses the soft-float calling conventions.
13256 @samp{hard} allows generation of floating-point instructions
13257 and uses FPU-specific calling conventions.
13259 The default depends on the specific target configuration.  Note that
13260 the hard-float and soft-float ABIs are not link-compatible; you must
13261 compile your entire program with the same ABI, and link with a
13262 compatible set of libraries.
13264 @item -mlittle-endian
13265 @opindex mlittle-endian
13266 Generate code for a processor running in little-endian mode.  This is
13267 the default for all standard configurations.
13269 @item -mbig-endian
13270 @opindex mbig-endian
13271 Generate code for a processor running in big-endian mode; the default is
13272 to compile code for a little-endian processor.
13274 @item -march=@var{name}
13275 @opindex march
13276 This specifies the name of the target ARM architecture.  GCC uses this
13277 name to determine what kind of instructions it can emit when generating
13278 assembly code.  This option can be used in conjunction with or instead
13279 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
13280 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
13281 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
13282 @samp{armv6}, @samp{armv6j},
13283 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
13284 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
13285 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
13286 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
13288 @option{-march=armv7ve} is the armv7-a architecture with virtualization
13289 extensions.
13291 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
13292 architecture together with the optional CRC32 extensions.
13294 @option{-march=native} causes the compiler to auto-detect the architecture
13295 of the build computer.  At present, this feature is only supported on
13296 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13297 is unsuccessful the option has no effect.
13299 @item -mtune=@var{name}
13300 @opindex mtune
13301 This option specifies the name of the target ARM processor for
13302 which GCC should tune the performance of the code.
13303 For some ARM implementations better performance can be obtained by using
13304 this option.
13305 Permissible names are: @samp{arm2}, @samp{arm250},
13306 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
13307 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
13308 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
13309 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
13310 @samp{arm720},
13311 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
13312 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
13313 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
13314 @samp{strongarm1110},
13315 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
13316 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
13317 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
13318 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
13319 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
13320 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
13321 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
13322 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
13323 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
13324 @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
13325 @samp{cortex-r4},
13326 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
13327 @samp{cortex-m4},
13328 @samp{cortex-m3},
13329 @samp{cortex-m1},
13330 @samp{cortex-m0},
13331 @samp{cortex-m0plus},
13332 @samp{cortex-m1.small-multiply},
13333 @samp{cortex-m0.small-multiply},
13334 @samp{cortex-m0plus.small-multiply},
13335 @samp{exynos-m1},
13336 @samp{marvell-pj4},
13337 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
13338 @samp{fa526}, @samp{fa626},
13339 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
13340 @samp{xgene1}.
13342 Additionally, this option can specify that GCC should tune the performance
13343 of the code for a big.LITTLE system.  Permissible names are:
13344 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
13345 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
13347 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
13348 performance for a blend of processors within architecture @var{arch}.
13349 The aim is to generate code that run well on the current most popular
13350 processors, balancing between optimizations that benefit some CPUs in the
13351 range, and avoiding performance pitfalls of other CPUs.  The effects of
13352 this option may change in future GCC versions as CPU models come and go.
13354 @option{-mtune=native} causes the compiler to auto-detect the CPU
13355 of the build computer.  At present, this feature is only supported on
13356 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
13357 unsuccessful the option has no effect.
13359 @item -mcpu=@var{name}
13360 @opindex mcpu
13361 This specifies the name of the target ARM processor.  GCC uses this name
13362 to derive the name of the target ARM architecture (as if specified
13363 by @option{-march}) and the ARM processor type for which to tune for
13364 performance (as if specified by @option{-mtune}).  Where this option
13365 is used in conjunction with @option{-march} or @option{-mtune},
13366 those options take precedence over the appropriate part of this option.
13368 Permissible names for this option are the same as those for
13369 @option{-mtune}.
13371 @option{-mcpu=generic-@var{arch}} is also permissible, and is
13372 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
13373 See @option{-mtune} for more information.
13375 @option{-mcpu=native} causes the compiler to auto-detect the CPU
13376 of the build computer.  At present, this feature is only supported on
13377 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13378 is unsuccessful the option has no effect.
13380 @item -mfpu=@var{name}
13381 @opindex mfpu
13382 This specifies what floating-point hardware (or hardware emulation) is
13383 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
13384 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
13385 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
13386 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
13387 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
13388 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
13390 If @option{-msoft-float} is specified this specifies the format of
13391 floating-point values.
13393 If the selected floating-point hardware includes the NEON extension
13394 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
13395 operations are not generated by GCC's auto-vectorization pass unless
13396 @option{-funsafe-math-optimizations} is also specified.  This is
13397 because NEON hardware does not fully implement the IEEE 754 standard for
13398 floating-point arithmetic (in particular denormal values are treated as
13399 zero), so the use of NEON instructions may lead to a loss of precision.
13401 @item -mfp16-format=@var{name}
13402 @opindex mfp16-format
13403 Specify the format of the @code{__fp16} half-precision floating-point type.
13404 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
13405 the default is @samp{none}, in which case the @code{__fp16} type is not
13406 defined.  @xref{Half-Precision}, for more information.
13408 @item -mstructure-size-boundary=@var{n}
13409 @opindex mstructure-size-boundary
13410 The sizes of all structures and unions are rounded up to a multiple
13411 of the number of bits set by this option.  Permissible values are 8, 32
13412 and 64.  The default value varies for different toolchains.  For the COFF
13413 targeted toolchain the default value is 8.  A value of 64 is only allowed
13414 if the underlying ABI supports it.
13416 Specifying a larger number can produce faster, more efficient code, but
13417 can also increase the size of the program.  Different values are potentially
13418 incompatible.  Code compiled with one value cannot necessarily expect to
13419 work with code or libraries compiled with another value, if they exchange
13420 information using structures or unions.
13422 @item -mabort-on-noreturn
13423 @opindex mabort-on-noreturn
13424 Generate a call to the function @code{abort} at the end of a
13425 @code{noreturn} function.  It is executed if the function tries to
13426 return.
13428 @item -mlong-calls
13429 @itemx -mno-long-calls
13430 @opindex mlong-calls
13431 @opindex mno-long-calls
13432 Tells the compiler to perform function calls by first loading the
13433 address of the function into a register and then performing a subroutine
13434 call on this register.  This switch is needed if the target function
13435 lies outside of the 64-megabyte addressing range of the offset-based
13436 version of subroutine call instruction.
13438 Even if this switch is enabled, not all function calls are turned
13439 into long calls.  The heuristic is that static functions, functions
13440 that have the @code{short_call} attribute, functions that are inside
13441 the scope of a @code{#pragma no_long_calls} directive, and functions whose
13442 definitions have already been compiled within the current compilation
13443 unit are not turned into long calls.  The exceptions to this rule are
13444 that weak function definitions, functions with the @code{long_call}
13445 attribute or the @code{section} attribute, and functions that are within
13446 the scope of a @code{#pragma long_calls} directive are always
13447 turned into long calls.
13449 This feature is not enabled by default.  Specifying
13450 @option{-mno-long-calls} restores the default behavior, as does
13451 placing the function calls within the scope of a @code{#pragma
13452 long_calls_off} directive.  Note these switches have no effect on how
13453 the compiler generates code to handle function calls via function
13454 pointers.
13456 @item -msingle-pic-base
13457 @opindex msingle-pic-base
13458 Treat the register used for PIC addressing as read-only, rather than
13459 loading it in the prologue for each function.  The runtime system is
13460 responsible for initializing this register with an appropriate value
13461 before execution begins.
13463 @item -mpic-register=@var{reg}
13464 @opindex mpic-register
13465 Specify the register to be used for PIC addressing.
13466 For standard PIC base case, the default is any suitable register
13467 determined by compiler.  For single PIC base case, the default is
13468 @samp{R9} if target is EABI based or stack-checking is enabled,
13469 otherwise the default is @samp{R10}.
13471 @item -mpic-data-is-text-relative
13472 @opindex mpic-data-is-text-relative
13473 Assume that each data segments are relative to text segment at load time.
13474 Therefore, it permits addressing data using PC-relative operations.
13475 This option is on by default for targets other than VxWorks RTP.
13477 @item -mpoke-function-name
13478 @opindex mpoke-function-name
13479 Write the name of each function into the text section, directly
13480 preceding the function prologue.  The generated code is similar to this:
13482 @smallexample
13483      t0
13484          .ascii "arm_poke_function_name", 0
13485          .align
13486      t1
13487          .word 0xff000000 + (t1 - t0)
13488      arm_poke_function_name
13489          mov     ip, sp
13490          stmfd   sp!, @{fp, ip, lr, pc@}
13491          sub     fp, ip, #4
13492 @end smallexample
13494 When performing a stack backtrace, code can inspect the value of
13495 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13496 location @code{pc - 12} and the top 8 bits are set, then we know that
13497 there is a function name embedded immediately preceding this location
13498 and has length @code{((pc[-3]) & 0xff000000)}.
13500 @item -mthumb
13501 @itemx -marm
13502 @opindex marm
13503 @opindex mthumb
13505 Select between generating code that executes in ARM and Thumb
13506 states.  The default for most configurations is to generate code
13507 that executes in ARM state, but the default can be changed by
13508 configuring GCC with the @option{--with-mode=}@var{state}
13509 configure option.
13511 @item -mtpcs-frame
13512 @opindex mtpcs-frame
13513 Generate a stack frame that is compliant with the Thumb Procedure Call
13514 Standard for all non-leaf functions.  (A leaf function is one that does
13515 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13517 @item -mtpcs-leaf-frame
13518 @opindex mtpcs-leaf-frame
13519 Generate a stack frame that is compliant with the Thumb Procedure Call
13520 Standard for all leaf functions.  (A leaf function is one that does
13521 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13523 @item -mcallee-super-interworking
13524 @opindex mcallee-super-interworking
13525 Gives all externally visible functions in the file being compiled an ARM
13526 instruction set header which switches to Thumb mode before executing the
13527 rest of the function.  This allows these functions to be called from
13528 non-interworking code.  This option is not valid in AAPCS configurations
13529 because interworking is enabled by default.
13531 @item -mcaller-super-interworking
13532 @opindex mcaller-super-interworking
13533 Allows calls via function pointers (including virtual functions) to
13534 execute correctly regardless of whether the target code has been
13535 compiled for interworking or not.  There is a small overhead in the cost
13536 of executing a function pointer if this option is enabled.  This option
13537 is not valid in AAPCS configurations because interworking is enabled
13538 by default.
13540 @item -mtp=@var{name}
13541 @opindex mtp
13542 Specify the access model for the thread local storage pointer.  The valid
13543 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
13544 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
13545 (supported in the arm6k architecture), and @samp{auto}, which uses the
13546 best available method for the selected processor.  The default setting is
13547 @samp{auto}.
13549 @item -mtls-dialect=@var{dialect}
13550 @opindex mtls-dialect
13551 Specify the dialect to use for accessing thread local storage.  Two
13552 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13553 @samp{gnu} dialect selects the original GNU scheme for supporting
13554 local and global dynamic TLS models.  The @samp{gnu2} dialect
13555 selects the GNU descriptor scheme, which provides better performance
13556 for shared libraries.  The GNU descriptor scheme is compatible with
13557 the original scheme, but does require new assembler, linker and
13558 library support.  Initial and local exec TLS models are unaffected by
13559 this option and always use the original scheme.
13561 @item -mword-relocations
13562 @opindex mword-relocations
13563 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13564 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13565 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13566 is specified.
13568 @item -mfix-cortex-m3-ldrd
13569 @opindex mfix-cortex-m3-ldrd
13570 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13571 with overlapping destination and base registers are used.  This option avoids
13572 generating these instructions.  This option is enabled by default when
13573 @option{-mcpu=cortex-m3} is specified.
13575 @item -munaligned-access
13576 @itemx -mno-unaligned-access
13577 @opindex munaligned-access
13578 @opindex mno-unaligned-access
13579 Enables (or disables) reading and writing of 16- and 32- bit values
13580 from addresses that are not 16- or 32- bit aligned.  By default
13581 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13582 architectures, and enabled for all other architectures.  If unaligned
13583 access is not enabled then words in packed data structures are
13584 accessed a byte at a time.
13586 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
13587 generated object file to either true or false, depending upon the
13588 setting of this option.  If unaligned access is enabled then the
13589 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
13590 defined.
13592 @item -mneon-for-64bits
13593 @opindex mneon-for-64bits
13594 Enables using Neon to handle scalar 64-bits operations. This is
13595 disabled by default since the cost of moving data from core registers
13596 to Neon is high.
13598 @item -mslow-flash-data
13599 @opindex mslow-flash-data
13600 Assume loading data from flash is slower than fetching instruction.
13601 Therefore literal load is minimized for better performance.
13602 This option is only supported when compiling for ARMv7 M-profile and
13603 off by default.
13605 @item -masm-syntax-unified
13606 @opindex masm-syntax-unified
13607 Assume inline assembler is using unified asm syntax.  The default is
13608 currently off which implies divided syntax.  Currently this option is
13609 available only for Thumb1 and has no effect on ARM state and Thumb2.
13610 However, this may change in future releases of GCC.  Divided syntax
13611 should be considered deprecated.
13613 @item -mrestrict-it
13614 @opindex mrestrict-it
13615 Restricts generation of IT blocks to conform to the rules of ARMv8.
13616 IT blocks can only contain a single 16-bit instruction from a select
13617 set of instructions. This option is on by default for ARMv8 Thumb mode.
13619 @item -mprint-tune-info
13620 @opindex mprint-tune-info
13621 Print CPU tuning information as comment in assembler file.  This is
13622 an option used only for regression testing of the compiler and not
13623 intended for ordinary use in compiling code.  This option is disabled
13624 by default.
13625 @end table
13627 @node AVR Options
13628 @subsection AVR Options
13629 @cindex AVR Options
13631 These options are defined for AVR implementations:
13633 @table @gcctabopt
13634 @item -mmcu=@var{mcu}
13635 @opindex mmcu
13636 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13638 The default for this option is@tie{}@samp{avr2}.
13640 GCC supports the following AVR devices and ISAs:
13642 @include avr-mmcu.texi
13644 @item -maccumulate-args
13645 @opindex maccumulate-args
13646 Accumulate outgoing function arguments and acquire/release the needed
13647 stack space for outgoing function arguments once in function
13648 prologue/epilogue.  Without this option, outgoing arguments are pushed
13649 before calling a function and popped afterwards.
13651 Popping the arguments after the function call can be expensive on
13652 AVR so that accumulating the stack space might lead to smaller
13653 executables because arguments need not to be removed from the
13654 stack after such a function call.
13656 This option can lead to reduced code size for functions that perform
13657 several calls to functions that get their arguments on the stack like
13658 calls to printf-like functions.
13660 @item -mbranch-cost=@var{cost}
13661 @opindex mbranch-cost
13662 Set the branch costs for conditional branch instructions to
13663 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13664 integers. The default branch cost is 0.
13666 @item -mcall-prologues
13667 @opindex mcall-prologues
13668 Functions prologues/epilogues are expanded as calls to appropriate
13669 subroutines.  Code size is smaller.
13671 @item -mint8
13672 @opindex mint8
13673 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13674 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13675 and @code{long long} is 4 bytes.  Please note that this option does not
13676 conform to the C standards, but it results in smaller code
13677 size.
13679 @item -mn-flash=@var{num}
13680 @opindex mn-flash
13681 Assume that the flash memory has a size of 
13682 @var{num} times 64@tie{}KiB.
13684 @item -mno-interrupts
13685 @opindex mno-interrupts
13686 Generated code is not compatible with hardware interrupts.
13687 Code size is smaller.
13689 @item -mrelax
13690 @opindex mrelax
13691 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13692 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13693 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
13694 the assembler's command line and the @option{--relax} option to the
13695 linker's command line.
13697 Jump relaxing is performed by the linker because jump offsets are not
13698 known before code is located. Therefore, the assembler code generated by the
13699 compiler is the same, but the instructions in the executable may
13700 differ from instructions in the assembler code.
13702 Relaxing must be turned on if linker stubs are needed, see the
13703 section on @code{EIND} and linker stubs below.
13705 @item -mrmw
13706 @opindex mrmw
13707 Assume that the device supports the Read-Modify-Write
13708 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
13710 @item -msp8
13711 @opindex msp8
13712 Treat the stack pointer register as an 8-bit register,
13713 i.e.@: assume the high byte of the stack pointer is zero.
13714 In general, you don't need to set this option by hand.
13716 This option is used internally by the compiler to select and
13717 build multilibs for architectures @code{avr2} and @code{avr25}.
13718 These architectures mix devices with and without @code{SPH}.
13719 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
13720 the compiler driver adds or removes this option from the compiler
13721 proper's command line, because the compiler then knows if the device
13722 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13723 register or not.
13725 @item -mstrict-X
13726 @opindex mstrict-X
13727 Use address register @code{X} in a way proposed by the hardware.  This means
13728 that @code{X} is only used in indirect, post-increment or
13729 pre-decrement addressing.
13731 Without this option, the @code{X} register may be used in the same way
13732 as @code{Y} or @code{Z} which then is emulated by additional
13733 instructions.  
13734 For example, loading a value with @code{X+const} addressing with a
13735 small non-negative @code{const < 64} to a register @var{Rn} is
13736 performed as
13738 @example
13739 adiw r26, const   ; X += const
13740 ld   @var{Rn}, X        ; @var{Rn} = *X
13741 sbiw r26, const   ; X -= const
13742 @end example
13744 @item -mtiny-stack
13745 @opindex mtiny-stack
13746 Only change the lower 8@tie{}bits of the stack pointer.
13748 @item -nodevicelib
13749 @opindex nodevicelib
13750 Don't link against AVR-LibC's device specific library @code{libdev.a}.
13752 @item -Waddr-space-convert
13753 @opindex Waddr-space-convert
13754 Warn about conversions between address spaces in the case where the
13755 resulting address space is not contained in the incoming address space.
13756 @end table
13758 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
13759 @cindex @code{EIND}
13760 Pointers in the implementation are 16@tie{}bits wide.
13761 The address of a function or label is represented as word address so
13762 that indirect jumps and calls can target any code address in the
13763 range of 64@tie{}Ki words.
13765 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13766 bytes of program memory space, there is a special function register called
13767 @code{EIND} that serves as most significant part of the target address
13768 when @code{EICALL} or @code{EIJMP} instructions are used.
13770 Indirect jumps and calls on these devices are handled as follows by
13771 the compiler and are subject to some limitations:
13773 @itemize @bullet
13775 @item
13776 The compiler never sets @code{EIND}.
13778 @item
13779 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13780 instructions or might read @code{EIND} directly in order to emulate an
13781 indirect call/jump by means of a @code{RET} instruction.
13783 @item
13784 The compiler assumes that @code{EIND} never changes during the startup
13785 code or during the application. In particular, @code{EIND} is not
13786 saved/restored in function or interrupt service routine
13787 prologue/epilogue.
13789 @item
13790 For indirect calls to functions and computed goto, the linker
13791 generates @emph{stubs}. Stubs are jump pads sometimes also called
13792 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13793 The stub contains a direct jump to the desired address.
13795 @item
13796 Linker relaxation must be turned on so that the linker generates
13797 the stubs correctly in all situations. See the compiler option
13798 @option{-mrelax} and the linker option @option{--relax}.
13799 There are corner cases where the linker is supposed to generate stubs
13800 but aborts without relaxation and without a helpful error message.
13802 @item
13803 The default linker script is arranged for code with @code{EIND = 0}.
13804 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13805 linker script has to be used in order to place the sections whose
13806 name start with @code{.trampolines} into the segment where @code{EIND}
13807 points to.
13809 @item
13810 The startup code from libgcc never sets @code{EIND}.
13811 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13812 For the impact of AVR-LibC on @code{EIND}, see the
13813 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13815 @item
13816 It is legitimate for user-specific startup code to set up @code{EIND}
13817 early, for example by means of initialization code located in
13818 section @code{.init3}. Such code runs prior to general startup code
13819 that initializes RAM and calls constructors, but after the bit
13820 of startup code from AVR-LibC that sets @code{EIND} to the segment
13821 where the vector table is located.
13822 @example
13823 #include <avr/io.h>
13825 static void
13826 __attribute__((section(".init3"),naked,used,no_instrument_function))
13827 init3_set_eind (void)
13829   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13830                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13832 @end example
13834 @noindent
13835 The @code{__trampolines_start} symbol is defined in the linker script.
13837 @item
13838 Stubs are generated automatically by the linker if
13839 the following two conditions are met:
13840 @itemize @minus
13842 @item The address of a label is taken by means of the @code{gs} modifier
13843 (short for @emph{generate stubs}) like so:
13844 @example
13845 LDI r24, lo8(gs(@var{func}))
13846 LDI r25, hi8(gs(@var{func}))
13847 @end example
13848 @item The final location of that label is in a code segment
13849 @emph{outside} the segment where the stubs are located.
13850 @end itemize
13852 @item
13853 The compiler emits such @code{gs} modifiers for code labels in the
13854 following situations:
13855 @itemize @minus
13856 @item Taking address of a function or code label.
13857 @item Computed goto.
13858 @item If prologue-save function is used, see @option{-mcall-prologues}
13859 command-line option.
13860 @item Switch/case dispatch tables. If you do not want such dispatch
13861 tables you can specify the @option{-fno-jump-tables} command-line option.
13862 @item C and C++ constructors/destructors called during startup/shutdown.
13863 @item If the tools hit a @code{gs()} modifier explained above.
13864 @end itemize
13866 @item
13867 Jumping to non-symbolic addresses like so is @emph{not} supported:
13869 @example
13870 int main (void)
13872     /* Call function at word address 0x2 */
13873     return ((int(*)(void)) 0x2)();
13875 @end example
13877 Instead, a stub has to be set up, i.e.@: the function has to be called
13878 through a symbol (@code{func_4} in the example):
13880 @example
13881 int main (void)
13883     extern int func_4 (void);
13885     /* Call function at byte address 0x4 */
13886     return func_4();
13888 @end example
13890 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
13891 Alternatively, @code{func_4} can be defined in the linker script.
13892 @end itemize
13894 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13895 @cindex @code{RAMPD}
13896 @cindex @code{RAMPX}
13897 @cindex @code{RAMPY}
13898 @cindex @code{RAMPZ}
13899 Some AVR devices support memories larger than the 64@tie{}KiB range
13900 that can be accessed with 16-bit pointers.  To access memory locations
13901 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13902 register is used as high part of the address:
13903 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13904 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13905 register, respectively, to get a wide address. Similarly,
13906 @code{RAMPD} is used together with direct addressing.
13908 @itemize
13909 @item
13910 The startup code initializes the @code{RAMP} special function
13911 registers with zero.
13913 @item
13914 If a @ref{AVR Named Address Spaces,named address space} other than
13915 generic or @code{__flash} is used, then @code{RAMPZ} is set
13916 as needed before the operation.
13918 @item
13919 If the device supports RAM larger than 64@tie{}KiB and the compiler
13920 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13921 is reset to zero after the operation.
13923 @item
13924 If the device comes with a specific @code{RAMP} register, the ISR
13925 prologue/epilogue saves/restores that SFR and initializes it with
13926 zero in case the ISR code might (implicitly) use it.
13928 @item
13929 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13930 If you use inline assembler to read from locations outside the
13931 16-bit address range and change one of the @code{RAMP} registers,
13932 you must reset it to zero after the access.
13934 @end itemize
13936 @subsubsection AVR Built-in Macros
13938 GCC defines several built-in macros so that the user code can test
13939 for the presence or absence of features.  Almost any of the following
13940 built-in macros are deduced from device capabilities and thus
13941 triggered by the @option{-mmcu=} command-line option.
13943 For even more AVR-specific built-in macros see
13944 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13946 @table @code
13948 @item __AVR_ARCH__
13949 Build-in macro that resolves to a decimal number that identifies the
13950 architecture and depends on the @option{-mmcu=@var{mcu}} option.
13951 Possible values are:
13953 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13954 @code{4}, @code{5}, @code{51}, @code{6}
13956 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
13957 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
13959 respectively and
13961 @code{100}, @code{102}, @code{104},
13962 @code{105}, @code{106}, @code{107}
13964 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
13965 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
13966 If @var{mcu} specifies a device, this built-in macro is set
13967 accordingly. For example, with @option{-mmcu=atmega8} the macro is
13968 defined to @code{4}.
13970 @item __AVR_@var{Device}__
13971 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
13972 the device's name. For example, @option{-mmcu=atmega8} defines the
13973 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
13974 @code{__AVR_ATtiny261A__}, etc.
13976 The built-in macros' names follow
13977 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13978 the device name as from the AVR user manual. The difference between
13979 @var{Device} in the built-in macro and @var{device} in
13980 @option{-mmcu=@var{device}} is that the latter is always lowercase.
13982 If @var{device} is not a device but only a core architecture like
13983 @samp{avr51}, this macro is not defined.
13985 @item __AVR_DEVICE_NAME__
13986 Setting @option{-mmcu=@var{device}} defines this built-in macro to
13987 the device's name. For example, with @option{-mmcu=atmega8} the macro
13988 is defined to @code{atmega8}.
13990 If @var{device} is not a device but only a core architecture like
13991 @samp{avr51}, this macro is not defined.
13993 @item __AVR_XMEGA__
13994 The device / architecture belongs to the XMEGA family of devices.
13996 @item __AVR_HAVE_ELPM__
13997 The device has the the @code{ELPM} instruction.
13999 @item __AVR_HAVE_ELPMX__
14000 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
14001 R@var{n},Z+} instructions.
14003 @item __AVR_HAVE_MOVW__
14004 The device has the @code{MOVW} instruction to perform 16-bit
14005 register-register moves.
14007 @item __AVR_HAVE_LPMX__
14008 The device has the @code{LPM R@var{n},Z} and
14009 @code{LPM R@var{n},Z+} instructions.
14011 @item __AVR_HAVE_MUL__
14012 The device has a hardware multiplier. 
14014 @item __AVR_HAVE_JMP_CALL__
14015 The device has the @code{JMP} and @code{CALL} instructions.
14016 This is the case for devices with at least 16@tie{}KiB of program
14017 memory.
14019 @item __AVR_HAVE_EIJMP_EICALL__
14020 @itemx __AVR_3_BYTE_PC__
14021 The device has the @code{EIJMP} and @code{EICALL} instructions.
14022 This is the case for devices with more than 128@tie{}KiB of program memory.
14023 This also means that the program counter
14024 (PC) is 3@tie{}bytes wide.
14026 @item __AVR_2_BYTE_PC__
14027 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
14028 with up to 128@tie{}KiB of program memory.
14030 @item __AVR_HAVE_8BIT_SP__
14031 @itemx __AVR_HAVE_16BIT_SP__
14032 The stack pointer (SP) register is treated as 8-bit respectively
14033 16-bit register by the compiler.
14034 The definition of these macros is affected by @option{-mtiny-stack}.
14036 @item __AVR_HAVE_SPH__
14037 @itemx __AVR_SP8__
14038 The device has the SPH (high part of stack pointer) special function
14039 register or has an 8-bit stack pointer, respectively.
14040 The definition of these macros is affected by @option{-mmcu=} and
14041 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
14042 by @option{-msp8}.
14044 @item __AVR_HAVE_RAMPD__
14045 @itemx __AVR_HAVE_RAMPX__
14046 @itemx __AVR_HAVE_RAMPY__
14047 @itemx __AVR_HAVE_RAMPZ__
14048 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
14049 @code{RAMPZ} special function register, respectively.
14051 @item __NO_INTERRUPTS__
14052 This macro reflects the @option{-mno-interrupts} command-line option.
14054 @item __AVR_ERRATA_SKIP__
14055 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
14056 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
14057 instructions because of a hardware erratum.  Skip instructions are
14058 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
14059 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
14060 set.
14062 @item __AVR_ISA_RMW__
14063 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
14065 @item __AVR_SFR_OFFSET__=@var{offset}
14066 Instructions that can address I/O special function registers directly
14067 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
14068 address as if addressed by an instruction to access RAM like @code{LD}
14069 or @code{STS}. This offset depends on the device architecture and has
14070 to be subtracted from the RAM address in order to get the
14071 respective I/O@tie{}address.
14073 @item __WITH_AVRLIBC__
14074 The compiler is configured to be used together with AVR-Libc.
14075 See the @option{--with-avrlibc} configure option.
14077 @end table
14079 @node Blackfin Options
14080 @subsection Blackfin Options
14081 @cindex Blackfin Options
14083 @table @gcctabopt
14084 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
14085 @opindex mcpu=
14086 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
14087 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14088 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14089 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14090 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14091 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14092 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14093 @samp{bf561}, @samp{bf592}.
14095 The optional @var{sirevision} specifies the silicon revision of the target
14096 Blackfin processor.  Any workarounds available for the targeted silicon revision
14097 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14098 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14099 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14100 hexadecimal digits representing the major and minor numbers in the silicon
14101 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14102 is not defined.  If @var{sirevision} is @samp{any}, the
14103 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14104 If this optional @var{sirevision} is not used, GCC assumes the latest known
14105 silicon revision of the targeted Blackfin processor.
14107 GCC defines a preprocessor macro for the specified @var{cpu}.
14108 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14109 provided by libgloss to be linked in if @option{-msim} is not given.
14111 Without this option, @samp{bf532} is used as the processor by default.
14113 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14114 only the preprocessor macro is defined.
14116 @item -msim
14117 @opindex msim
14118 Specifies that the program will be run on the simulator.  This causes
14119 the simulator BSP provided by libgloss to be linked in.  This option
14120 has effect only for @samp{bfin-elf} toolchain.
14121 Certain other options, such as @option{-mid-shared-library} and
14122 @option{-mfdpic}, imply @option{-msim}.
14124 @item -momit-leaf-frame-pointer
14125 @opindex momit-leaf-frame-pointer
14126 Don't keep the frame pointer in a register for leaf functions.  This
14127 avoids the instructions to save, set up and restore frame pointers and
14128 makes an extra register available in leaf functions.  The option
14129 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14130 which might make debugging harder.
14132 @item -mspecld-anomaly
14133 @opindex mspecld-anomaly
14134 When enabled, the compiler ensures that the generated code does not
14135 contain speculative loads after jump instructions. If this option is used,
14136 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14138 @item -mno-specld-anomaly
14139 @opindex mno-specld-anomaly
14140 Don't generate extra code to prevent speculative loads from occurring.
14142 @item -mcsync-anomaly
14143 @opindex mcsync-anomaly
14144 When enabled, the compiler ensures that the generated code does not
14145 contain CSYNC or SSYNC instructions too soon after conditional branches.
14146 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14148 @item -mno-csync-anomaly
14149 @opindex mno-csync-anomaly
14150 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14151 occurring too soon after a conditional branch.
14153 @item -mlow-64k
14154 @opindex mlow-64k
14155 When enabled, the compiler is free to take advantage of the knowledge that
14156 the entire program fits into the low 64k of memory.
14158 @item -mno-low-64k
14159 @opindex mno-low-64k
14160 Assume that the program is arbitrarily large.  This is the default.
14162 @item -mstack-check-l1
14163 @opindex mstack-check-l1
14164 Do stack checking using information placed into L1 scratchpad memory by the
14165 uClinux kernel.
14167 @item -mid-shared-library
14168 @opindex mid-shared-library
14169 Generate code that supports shared libraries via the library ID method.
14170 This allows for execute in place and shared libraries in an environment
14171 without virtual memory management.  This option implies @option{-fPIC}.
14172 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14174 @item -mno-id-shared-library
14175 @opindex mno-id-shared-library
14176 Generate code that doesn't assume ID-based shared libraries are being used.
14177 This is the default.
14179 @item -mleaf-id-shared-library
14180 @opindex mleaf-id-shared-library
14181 Generate code that supports shared libraries via the library ID method,
14182 but assumes that this library or executable won't link against any other
14183 ID shared libraries.  That allows the compiler to use faster code for jumps
14184 and calls.
14186 @item -mno-leaf-id-shared-library
14187 @opindex mno-leaf-id-shared-library
14188 Do not assume that the code being compiled won't link against any ID shared
14189 libraries.  Slower code is generated for jump and call insns.
14191 @item -mshared-library-id=n
14192 @opindex mshared-library-id
14193 Specifies the identification number of the ID-based shared library being
14194 compiled.  Specifying a value of 0 generates more compact code; specifying
14195 other values forces the allocation of that number to the current
14196 library but is no more space- or time-efficient than omitting this option.
14198 @item -msep-data
14199 @opindex msep-data
14200 Generate code that allows the data segment to be located in a different
14201 area of memory from the text segment.  This allows for execute in place in
14202 an environment without virtual memory management by eliminating relocations
14203 against the text section.
14205 @item -mno-sep-data
14206 @opindex mno-sep-data
14207 Generate code that assumes that the data segment follows the text segment.
14208 This is the default.
14210 @item -mlong-calls
14211 @itemx -mno-long-calls
14212 @opindex mlong-calls
14213 @opindex mno-long-calls
14214 Tells the compiler to perform function calls by first loading the
14215 address of the function into a register and then performing a subroutine
14216 call on this register.  This switch is needed if the target function
14217 lies outside of the 24-bit addressing range of the offset-based
14218 version of subroutine call instruction.
14220 This feature is not enabled by default.  Specifying
14221 @option{-mno-long-calls} restores the default behavior.  Note these
14222 switches have no effect on how the compiler generates code to handle
14223 function calls via function pointers.
14225 @item -mfast-fp
14226 @opindex mfast-fp
14227 Link with the fast floating-point library. This library relaxes some of
14228 the IEEE floating-point standard's rules for checking inputs against
14229 Not-a-Number (NAN), in the interest of performance.
14231 @item -minline-plt
14232 @opindex minline-plt
14233 Enable inlining of PLT entries in function calls to functions that are
14234 not known to bind locally.  It has no effect without @option{-mfdpic}.
14236 @item -mmulticore
14237 @opindex mmulticore
14238 Build a standalone application for multicore Blackfin processors. 
14239 This option causes proper start files and link scripts supporting 
14240 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
14241 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
14243 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
14244 selects the one-application-per-core programming model.  Without
14245 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
14246 programming model is used. In this model, the main function of Core B
14247 should be named as @code{coreb_main}.
14249 If this option is not used, the single-core application programming
14250 model is used.
14252 @item -mcorea
14253 @opindex mcorea
14254 Build a standalone application for Core A of BF561 when using
14255 the one-application-per-core programming model. Proper start files
14256 and link scripts are used to support Core A, and the macro
14257 @code{__BFIN_COREA} is defined.
14258 This option can only be used in conjunction with @option{-mmulticore}.
14260 @item -mcoreb
14261 @opindex mcoreb
14262 Build a standalone application for Core B of BF561 when using
14263 the one-application-per-core programming model. Proper start files
14264 and link scripts are used to support Core B, and the macro
14265 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
14266 should be used instead of @code{main}. 
14267 This option can only be used in conjunction with @option{-mmulticore}.
14269 @item -msdram
14270 @opindex msdram
14271 Build a standalone application for SDRAM. Proper start files and
14272 link scripts are used to put the application into SDRAM, and the macro
14273 @code{__BFIN_SDRAM} is defined.
14274 The loader should initialize SDRAM before loading the application.
14276 @item -micplb
14277 @opindex micplb
14278 Assume that ICPLBs are enabled at run time.  This has an effect on certain
14279 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
14280 are enabled; for standalone applications the default is off.
14281 @end table
14283 @node C6X Options
14284 @subsection C6X Options
14285 @cindex C6X Options
14287 @table @gcctabopt
14288 @item -march=@var{name}
14289 @opindex march
14290 This specifies the name of the target architecture.  GCC uses this
14291 name to determine what kind of instructions it can emit when generating
14292 assembly code.  Permissible names are: @samp{c62x},
14293 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
14295 @item -mbig-endian
14296 @opindex mbig-endian
14297 Generate code for a big-endian target.
14299 @item -mlittle-endian
14300 @opindex mlittle-endian
14301 Generate code for a little-endian target.  This is the default.
14303 @item -msim
14304 @opindex msim
14305 Choose startup files and linker script suitable for the simulator.
14307 @item -msdata=default
14308 @opindex msdata=default
14309 Put small global and static data in the @code{.neardata} section,
14310 which is pointed to by register @code{B14}.  Put small uninitialized
14311 global and static data in the @code{.bss} section, which is adjacent
14312 to the @code{.neardata} section.  Put small read-only data into the
14313 @code{.rodata} section.  The corresponding sections used for large
14314 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
14316 @item -msdata=all
14317 @opindex msdata=all
14318 Put all data, not just small objects, into the sections reserved for
14319 small data, and use addressing relative to the @code{B14} register to
14320 access them.
14322 @item -msdata=none
14323 @opindex msdata=none
14324 Make no use of the sections reserved for small data, and use absolute
14325 addresses to access all data.  Put all initialized global and static
14326 data in the @code{.fardata} section, and all uninitialized data in the
14327 @code{.far} section.  Put all constant data into the @code{.const}
14328 section.
14329 @end table
14331 @node CRIS Options
14332 @subsection CRIS Options
14333 @cindex CRIS Options
14335 These options are defined specifically for the CRIS ports.
14337 @table @gcctabopt
14338 @item -march=@var{architecture-type}
14339 @itemx -mcpu=@var{architecture-type}
14340 @opindex march
14341 @opindex mcpu
14342 Generate code for the specified architecture.  The choices for
14343 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
14344 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
14345 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
14346 @samp{v10}.
14348 @item -mtune=@var{architecture-type}
14349 @opindex mtune
14350 Tune to @var{architecture-type} everything applicable about the generated
14351 code, except for the ABI and the set of available instructions.  The
14352 choices for @var{architecture-type} are the same as for
14353 @option{-march=@var{architecture-type}}.
14355 @item -mmax-stack-frame=@var{n}
14356 @opindex mmax-stack-frame
14357 Warn when the stack frame of a function exceeds @var{n} bytes.
14359 @item -metrax4
14360 @itemx -metrax100
14361 @opindex metrax4
14362 @opindex metrax100
14363 The options @option{-metrax4} and @option{-metrax100} are synonyms for
14364 @option{-march=v3} and @option{-march=v8} respectively.
14366 @item -mmul-bug-workaround
14367 @itemx -mno-mul-bug-workaround
14368 @opindex mmul-bug-workaround
14369 @opindex mno-mul-bug-workaround
14370 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
14371 models where it applies.  This option is active by default.
14373 @item -mpdebug
14374 @opindex mpdebug
14375 Enable CRIS-specific verbose debug-related information in the assembly
14376 code.  This option also has the effect of turning off the @samp{#NO_APP}
14377 formatted-code indicator to the assembler at the beginning of the
14378 assembly file.
14380 @item -mcc-init
14381 @opindex mcc-init
14382 Do not use condition-code results from previous instruction; always emit
14383 compare and test instructions before use of condition codes.
14385 @item -mno-side-effects
14386 @opindex mno-side-effects
14387 Do not emit instructions with side effects in addressing modes other than
14388 post-increment.
14390 @item -mstack-align
14391 @itemx -mno-stack-align
14392 @itemx -mdata-align
14393 @itemx -mno-data-align
14394 @itemx -mconst-align
14395 @itemx -mno-const-align
14396 @opindex mstack-align
14397 @opindex mno-stack-align
14398 @opindex mdata-align
14399 @opindex mno-data-align
14400 @opindex mconst-align
14401 @opindex mno-const-align
14402 These options (@samp{no-} options) arrange (eliminate arrangements) for the
14403 stack frame, individual data and constants to be aligned for the maximum
14404 single data access size for the chosen CPU model.  The default is to
14405 arrange for 32-bit alignment.  ABI details such as structure layout are
14406 not affected by these options.
14408 @item -m32-bit
14409 @itemx -m16-bit
14410 @itemx -m8-bit
14411 @opindex m32-bit
14412 @opindex m16-bit
14413 @opindex m8-bit
14414 Similar to the stack- data- and const-align options above, these options
14415 arrange for stack frame, writable data and constants to all be 32-bit,
14416 16-bit or 8-bit aligned.  The default is 32-bit alignment.
14418 @item -mno-prologue-epilogue
14419 @itemx -mprologue-epilogue
14420 @opindex mno-prologue-epilogue
14421 @opindex mprologue-epilogue
14422 With @option{-mno-prologue-epilogue}, the normal function prologue and
14423 epilogue which set up the stack frame are omitted and no return
14424 instructions or return sequences are generated in the code.  Use this
14425 option only together with visual inspection of the compiled code: no
14426 warnings or errors are generated when call-saved registers must be saved,
14427 or storage for local variables needs to be allocated.
14429 @item -mno-gotplt
14430 @itemx -mgotplt
14431 @opindex mno-gotplt
14432 @opindex mgotplt
14433 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
14434 instruction sequences that load addresses for functions from the PLT part
14435 of the GOT rather than (traditional on other architectures) calls to the
14436 PLT@.  The default is @option{-mgotplt}.
14438 @item -melf
14439 @opindex melf
14440 Legacy no-op option only recognized with the cris-axis-elf and
14441 cris-axis-linux-gnu targets.
14443 @item -mlinux
14444 @opindex mlinux
14445 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
14447 @item -sim
14448 @opindex sim
14449 This option, recognized for the cris-axis-elf, arranges
14450 to link with input-output functions from a simulator library.  Code,
14451 initialized data and zero-initialized data are allocated consecutively.
14453 @item -sim2
14454 @opindex sim2
14455 Like @option{-sim}, but pass linker options to locate initialized data at
14456 0x40000000 and zero-initialized data at 0x80000000.
14457 @end table
14459 @node CR16 Options
14460 @subsection CR16 Options
14461 @cindex CR16 Options
14463 These options are defined specifically for the CR16 ports.
14465 @table @gcctabopt
14467 @item -mmac
14468 @opindex mmac
14469 Enable the use of multiply-accumulate instructions. Disabled by default.
14471 @item -mcr16cplus
14472 @itemx -mcr16c
14473 @opindex mcr16cplus
14474 @opindex mcr16c
14475 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14476 is default.
14478 @item -msim
14479 @opindex msim
14480 Links the library libsim.a which is in compatible with simulator. Applicable
14481 to ELF compiler only.
14483 @item -mint32
14484 @opindex mint32
14485 Choose integer type as 32-bit wide.
14487 @item -mbit-ops
14488 @opindex mbit-ops
14489 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14491 @item -mdata-model=@var{model}
14492 @opindex mdata-model
14493 Choose a data model. The choices for @var{model} are @samp{near},
14494 @samp{far} or @samp{medium}. @samp{medium} is default.
14495 However, @samp{far} is not valid with @option{-mcr16c}, as the
14496 CR16C architecture does not support the far data model.
14497 @end table
14499 @node Darwin Options
14500 @subsection Darwin Options
14501 @cindex Darwin options
14503 These options are defined for all architectures running the Darwin operating
14504 system.
14506 FSF GCC on Darwin does not create ``fat'' object files; it creates
14507 an object file for the single architecture that GCC was built to
14508 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14509 @option{-arch} options are used; it does so by running the compiler or
14510 linker multiple times and joining the results together with
14511 @file{lipo}.
14513 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14514 @samp{i686}) is determined by the flags that specify the ISA
14515 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14516 @option{-force_cpusubtype_ALL} option can be used to override this.
14518 The Darwin tools vary in their behavior when presented with an ISA
14519 mismatch.  The assembler, @file{as}, only permits instructions to
14520 be used that are valid for the subtype of the file it is generating,
14521 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14522 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14523 and prints an error if asked to create a shared library with a less
14524 restrictive subtype than its input files (for instance, trying to put
14525 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14526 for executables, @command{ld}, quietly gives the executable the most
14527 restrictive subtype of any of its input files.
14529 @table @gcctabopt
14530 @item -F@var{dir}
14531 @opindex F
14532 Add the framework directory @var{dir} to the head of the list of
14533 directories to be searched for header files.  These directories are
14534 interleaved with those specified by @option{-I} options and are
14535 scanned in a left-to-right order.
14537 A framework directory is a directory with frameworks in it.  A
14538 framework is a directory with a @file{Headers} and/or
14539 @file{PrivateHeaders} directory contained directly in it that ends
14540 in @file{.framework}.  The name of a framework is the name of this
14541 directory excluding the @file{.framework}.  Headers associated with
14542 the framework are found in one of those two directories, with
14543 @file{Headers} being searched first.  A subframework is a framework
14544 directory that is in a framework's @file{Frameworks} directory.
14545 Includes of subframework headers can only appear in a header of a
14546 framework that contains the subframework, or in a sibling subframework
14547 header.  Two subframeworks are siblings if they occur in the same
14548 framework.  A subframework should not have the same name as a
14549 framework; a warning is issued if this is violated.  Currently a
14550 subframework cannot have subframeworks; in the future, the mechanism
14551 may be extended to support this.  The standard frameworks can be found
14552 in @file{/System/Library/Frameworks} and
14553 @file{/Library/Frameworks}.  An example include looks like
14554 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14555 the name of the framework and @file{header.h} is found in the
14556 @file{PrivateHeaders} or @file{Headers} directory.
14558 @item -iframework@var{dir}
14559 @opindex iframework
14560 Like @option{-F} except the directory is a treated as a system
14561 directory.  The main difference between this @option{-iframework} and
14562 @option{-F} is that with @option{-iframework} the compiler does not
14563 warn about constructs contained within header files found via
14564 @var{dir}.  This option is valid only for the C family of languages.
14566 @item -gused
14567 @opindex gused
14568 Emit debugging information for symbols that are used.  For stabs
14569 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14570 This is by default ON@.
14572 @item -gfull
14573 @opindex gfull
14574 Emit debugging information for all symbols and types.
14576 @item -mmacosx-version-min=@var{version}
14577 The earliest version of MacOS X that this executable will run on
14578 is @var{version}.  Typical values of @var{version} include @code{10.1},
14579 @code{10.2}, and @code{10.3.9}.
14581 If the compiler was built to use the system's headers by default,
14582 then the default for this option is the system version on which the
14583 compiler is running, otherwise the default is to make choices that
14584 are compatible with as many systems and code bases as possible.
14586 @item -mkernel
14587 @opindex mkernel
14588 Enable kernel development mode.  The @option{-mkernel} option sets
14589 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14590 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14591 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14592 applicable.  This mode also sets @option{-mno-altivec},
14593 @option{-msoft-float}, @option{-fno-builtin} and
14594 @option{-mlong-branch} for PowerPC targets.
14596 @item -mone-byte-bool
14597 @opindex mone-byte-bool
14598 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
14599 By default @code{sizeof(bool)} is @code{4} when compiling for
14600 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
14601 option has no effect on x86.
14603 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14604 to generate code that is not binary compatible with code generated
14605 without that switch.  Using this switch may require recompiling all
14606 other modules in a program, including system libraries.  Use this
14607 switch to conform to a non-default data model.
14609 @item -mfix-and-continue
14610 @itemx -ffix-and-continue
14611 @itemx -findirect-data
14612 @opindex mfix-and-continue
14613 @opindex ffix-and-continue
14614 @opindex findirect-data
14615 Generate code suitable for fast turnaround development, such as to
14616 allow GDB to dynamically load @file{.o} files into already-running
14617 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14618 are provided for backwards compatibility.
14620 @item -all_load
14621 @opindex all_load
14622 Loads all members of static archive libraries.
14623 See man ld(1) for more information.
14625 @item -arch_errors_fatal
14626 @opindex arch_errors_fatal
14627 Cause the errors having to do with files that have the wrong architecture
14628 to be fatal.
14630 @item -bind_at_load
14631 @opindex bind_at_load
14632 Causes the output file to be marked such that the dynamic linker will
14633 bind all undefined references when the file is loaded or launched.
14635 @item -bundle
14636 @opindex bundle
14637 Produce a Mach-o bundle format file.
14638 See man ld(1) for more information.
14640 @item -bundle_loader @var{executable}
14641 @opindex bundle_loader
14642 This option specifies the @var{executable} that will load the build
14643 output file being linked.  See man ld(1) for more information.
14645 @item -dynamiclib
14646 @opindex dynamiclib
14647 When passed this option, GCC produces a dynamic library instead of
14648 an executable when linking, using the Darwin @file{libtool} command.
14650 @item -force_cpusubtype_ALL
14651 @opindex force_cpusubtype_ALL
14652 This causes GCC's output file to have the @samp{ALL} subtype, instead of
14653 one controlled by the @option{-mcpu} or @option{-march} option.
14655 @item -allowable_client  @var{client_name}
14656 @itemx -client_name
14657 @itemx -compatibility_version
14658 @itemx -current_version
14659 @itemx -dead_strip
14660 @itemx -dependency-file
14661 @itemx -dylib_file
14662 @itemx -dylinker_install_name
14663 @itemx -dynamic
14664 @itemx -exported_symbols_list
14665 @itemx -filelist
14666 @need 800
14667 @itemx -flat_namespace
14668 @itemx -force_flat_namespace
14669 @itemx -headerpad_max_install_names
14670 @itemx -image_base
14671 @itemx -init
14672 @itemx -install_name
14673 @itemx -keep_private_externs
14674 @itemx -multi_module
14675 @itemx -multiply_defined
14676 @itemx -multiply_defined_unused
14677 @need 800
14678 @itemx -noall_load
14679 @itemx -no_dead_strip_inits_and_terms
14680 @itemx -nofixprebinding
14681 @itemx -nomultidefs
14682 @itemx -noprebind
14683 @itemx -noseglinkedit
14684 @itemx -pagezero_size
14685 @itemx -prebind
14686 @itemx -prebind_all_twolevel_modules
14687 @itemx -private_bundle
14688 @need 800
14689 @itemx -read_only_relocs
14690 @itemx -sectalign
14691 @itemx -sectobjectsymbols
14692 @itemx -whyload
14693 @itemx -seg1addr
14694 @itemx -sectcreate
14695 @itemx -sectobjectsymbols
14696 @itemx -sectorder
14697 @itemx -segaddr
14698 @itemx -segs_read_only_addr
14699 @need 800
14700 @itemx -segs_read_write_addr
14701 @itemx -seg_addr_table
14702 @itemx -seg_addr_table_filename
14703 @itemx -seglinkedit
14704 @itemx -segprot
14705 @itemx -segs_read_only_addr
14706 @itemx -segs_read_write_addr
14707 @itemx -single_module
14708 @itemx -static
14709 @itemx -sub_library
14710 @need 800
14711 @itemx -sub_umbrella
14712 @itemx -twolevel_namespace
14713 @itemx -umbrella
14714 @itemx -undefined
14715 @itemx -unexported_symbols_list
14716 @itemx -weak_reference_mismatches
14717 @itemx -whatsloaded
14718 @opindex allowable_client
14719 @opindex client_name
14720 @opindex compatibility_version
14721 @opindex current_version
14722 @opindex dead_strip
14723 @opindex dependency-file
14724 @opindex dylib_file
14725 @opindex dylinker_install_name
14726 @opindex dynamic
14727 @opindex exported_symbols_list
14728 @opindex filelist
14729 @opindex flat_namespace
14730 @opindex force_flat_namespace
14731 @opindex headerpad_max_install_names
14732 @opindex image_base
14733 @opindex init
14734 @opindex install_name
14735 @opindex keep_private_externs
14736 @opindex multi_module
14737 @opindex multiply_defined
14738 @opindex multiply_defined_unused
14739 @opindex noall_load
14740 @opindex no_dead_strip_inits_and_terms
14741 @opindex nofixprebinding
14742 @opindex nomultidefs
14743 @opindex noprebind
14744 @opindex noseglinkedit
14745 @opindex pagezero_size
14746 @opindex prebind
14747 @opindex prebind_all_twolevel_modules
14748 @opindex private_bundle
14749 @opindex read_only_relocs
14750 @opindex sectalign
14751 @opindex sectobjectsymbols
14752 @opindex whyload
14753 @opindex seg1addr
14754 @opindex sectcreate
14755 @opindex sectobjectsymbols
14756 @opindex sectorder
14757 @opindex segaddr
14758 @opindex segs_read_only_addr
14759 @opindex segs_read_write_addr
14760 @opindex seg_addr_table
14761 @opindex seg_addr_table_filename
14762 @opindex seglinkedit
14763 @opindex segprot
14764 @opindex segs_read_only_addr
14765 @opindex segs_read_write_addr
14766 @opindex single_module
14767 @opindex static
14768 @opindex sub_library
14769 @opindex sub_umbrella
14770 @opindex twolevel_namespace
14771 @opindex umbrella
14772 @opindex undefined
14773 @opindex unexported_symbols_list
14774 @opindex weak_reference_mismatches
14775 @opindex whatsloaded
14776 These options are passed to the Darwin linker.  The Darwin linker man page
14777 describes them in detail.
14778 @end table
14780 @node DEC Alpha Options
14781 @subsection DEC Alpha Options
14783 These @samp{-m} options are defined for the DEC Alpha implementations:
14785 @table @gcctabopt
14786 @item -mno-soft-float
14787 @itemx -msoft-float
14788 @opindex mno-soft-float
14789 @opindex msoft-float
14790 Use (do not use) the hardware floating-point instructions for
14791 floating-point operations.  When @option{-msoft-float} is specified,
14792 functions in @file{libgcc.a} are used to perform floating-point
14793 operations.  Unless they are replaced by routines that emulate the
14794 floating-point operations, or compiled in such a way as to call such
14795 emulations routines, these routines issue floating-point
14796 operations.   If you are compiling for an Alpha without floating-point
14797 operations, you must ensure that the library is built so as not to call
14798 them.
14800 Note that Alpha implementations without floating-point operations are
14801 required to have floating-point registers.
14803 @item -mfp-reg
14804 @itemx -mno-fp-regs
14805 @opindex mfp-reg
14806 @opindex mno-fp-regs
14807 Generate code that uses (does not use) the floating-point register set.
14808 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14809 register set is not used, floating-point operands are passed in integer
14810 registers as if they were integers and floating-point results are passed
14811 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14812 so any function with a floating-point argument or return value called by code
14813 compiled with @option{-mno-fp-regs} must also be compiled with that
14814 option.
14816 A typical use of this option is building a kernel that does not use,
14817 and hence need not save and restore, any floating-point registers.
14819 @item -mieee
14820 @opindex mieee
14821 The Alpha architecture implements floating-point hardware optimized for
14822 maximum performance.  It is mostly compliant with the IEEE floating-point
14823 standard.  However, for full compliance, software assistance is
14824 required.  This option generates code fully IEEE-compliant code
14825 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14826 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14827 defined during compilation.  The resulting code is less efficient but is
14828 able to correctly support denormalized numbers and exceptional IEEE
14829 values such as not-a-number and plus/minus infinity.  Other Alpha
14830 compilers call this option @option{-ieee_with_no_inexact}.
14832 @item -mieee-with-inexact
14833 @opindex mieee-with-inexact
14834 This is like @option{-mieee} except the generated code also maintains
14835 the IEEE @var{inexact-flag}.  Turning on this option causes the
14836 generated code to implement fully-compliant IEEE math.  In addition to
14837 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14838 macro.  On some Alpha implementations the resulting code may execute
14839 significantly slower than the code generated by default.  Since there is
14840 very little code that depends on the @var{inexact-flag}, you should
14841 normally not specify this option.  Other Alpha compilers call this
14842 option @option{-ieee_with_inexact}.
14844 @item -mfp-trap-mode=@var{trap-mode}
14845 @opindex mfp-trap-mode
14846 This option controls what floating-point related traps are enabled.
14847 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14848 The trap mode can be set to one of four values:
14850 @table @samp
14851 @item n
14852 This is the default (normal) setting.  The only traps that are enabled
14853 are the ones that cannot be disabled in software (e.g., division by zero
14854 trap).
14856 @item u
14857 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14858 as well.
14860 @item su
14861 Like @samp{u}, but the instructions are marked to be safe for software
14862 completion (see Alpha architecture manual for details).
14864 @item sui
14865 Like @samp{su}, but inexact traps are enabled as well.
14866 @end table
14868 @item -mfp-rounding-mode=@var{rounding-mode}
14869 @opindex mfp-rounding-mode
14870 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14871 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14874 @table @samp
14875 @item n
14876 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14877 the nearest machine number or towards the even machine number in case
14878 of a tie.
14880 @item m
14881 Round towards minus infinity.
14883 @item c
14884 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14886 @item d
14887 Dynamic rounding mode.  A field in the floating-point control register
14888 (@var{fpcr}, see Alpha architecture reference manual) controls the
14889 rounding mode in effect.  The C library initializes this register for
14890 rounding towards plus infinity.  Thus, unless your program modifies the
14891 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14892 @end table
14894 @item -mtrap-precision=@var{trap-precision}
14895 @opindex mtrap-precision
14896 In the Alpha architecture, floating-point traps are imprecise.  This
14897 means without software assistance it is impossible to recover from a
14898 floating trap and program execution normally needs to be terminated.
14899 GCC can generate code that can assist operating system trap handlers
14900 in determining the exact location that caused a floating-point trap.
14901 Depending on the requirements of an application, different levels of
14902 precisions can be selected:
14904 @table @samp
14905 @item p
14906 Program precision.  This option is the default and means a trap handler
14907 can only identify which program caused a floating-point exception.
14909 @item f
14910 Function precision.  The trap handler can determine the function that
14911 caused a floating-point exception.
14913 @item i
14914 Instruction precision.  The trap handler can determine the exact
14915 instruction that caused a floating-point exception.
14916 @end table
14918 Other Alpha compilers provide the equivalent options called
14919 @option{-scope_safe} and @option{-resumption_safe}.
14921 @item -mieee-conformant
14922 @opindex mieee-conformant
14923 This option marks the generated code as IEEE conformant.  You must not
14924 use this option unless you also specify @option{-mtrap-precision=i} and either
14925 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14926 is to emit the line @samp{.eflag 48} in the function prologue of the
14927 generated assembly file.
14929 @item -mbuild-constants
14930 @opindex mbuild-constants
14931 Normally GCC examines a 32- or 64-bit integer constant to
14932 see if it can construct it from smaller constants in two or three
14933 instructions.  If it cannot, it outputs the constant as a literal and
14934 generates code to load it from the data segment at run time.
14936 Use this option to require GCC to construct @emph{all} integer constants
14937 using code, even if it takes more instructions (the maximum is six).
14939 You typically use this option to build a shared library dynamic
14940 loader.  Itself a shared library, it must relocate itself in memory
14941 before it can find the variables and constants in its own data segment.
14943 @item -mbwx
14944 @itemx -mno-bwx
14945 @itemx -mcix
14946 @itemx -mno-cix
14947 @itemx -mfix
14948 @itemx -mno-fix
14949 @itemx -mmax
14950 @itemx -mno-max
14951 @opindex mbwx
14952 @opindex mno-bwx
14953 @opindex mcix
14954 @opindex mno-cix
14955 @opindex mfix
14956 @opindex mno-fix
14957 @opindex mmax
14958 @opindex mno-max
14959 Indicate whether GCC should generate code to use the optional BWX,
14960 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14961 sets supported by the CPU type specified via @option{-mcpu=} option or that
14962 of the CPU on which GCC was built if none is specified.
14964 @item -mfloat-vax
14965 @itemx -mfloat-ieee
14966 @opindex mfloat-vax
14967 @opindex mfloat-ieee
14968 Generate code that uses (does not use) VAX F and G floating-point
14969 arithmetic instead of IEEE single and double precision.
14971 @item -mexplicit-relocs
14972 @itemx -mno-explicit-relocs
14973 @opindex mexplicit-relocs
14974 @opindex mno-explicit-relocs
14975 Older Alpha assemblers provided no way to generate symbol relocations
14976 except via assembler macros.  Use of these macros does not allow
14977 optimal instruction scheduling.  GNU binutils as of version 2.12
14978 supports a new syntax that allows the compiler to explicitly mark
14979 which relocations should apply to which instructions.  This option
14980 is mostly useful for debugging, as GCC detects the capabilities of
14981 the assembler when it is built and sets the default accordingly.
14983 @item -msmall-data
14984 @itemx -mlarge-data
14985 @opindex msmall-data
14986 @opindex mlarge-data
14987 When @option{-mexplicit-relocs} is in effect, static data is
14988 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14989 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14990 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14991 16-bit relocations off of the @code{$gp} register.  This limits the
14992 size of the small data area to 64KB, but allows the variables to be
14993 directly accessed via a single instruction.
14995 The default is @option{-mlarge-data}.  With this option the data area
14996 is limited to just below 2GB@.  Programs that require more than 2GB of
14997 data must use @code{malloc} or @code{mmap} to allocate the data in the
14998 heap instead of in the program's data segment.
15000 When generating code for shared libraries, @option{-fpic} implies
15001 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
15003 @item -msmall-text
15004 @itemx -mlarge-text
15005 @opindex msmall-text
15006 @opindex mlarge-text
15007 When @option{-msmall-text} is used, the compiler assumes that the
15008 code of the entire program (or shared library) fits in 4MB, and is
15009 thus reachable with a branch instruction.  When @option{-msmall-data}
15010 is used, the compiler can assume that all local symbols share the
15011 same @code{$gp} value, and thus reduce the number of instructions
15012 required for a function call from 4 to 1.
15014 The default is @option{-mlarge-text}.
15016 @item -mcpu=@var{cpu_type}
15017 @opindex mcpu
15018 Set the instruction set and instruction scheduling parameters for
15019 machine type @var{cpu_type}.  You can specify either the @samp{EV}
15020 style name or the corresponding chip number.  GCC supports scheduling
15021 parameters for the EV4, EV5 and EV6 family of processors and
15022 chooses the default values for the instruction set from the processor
15023 you specify.  If you do not specify a processor type, GCC defaults
15024 to the processor on which the compiler was built.
15026 Supported values for @var{cpu_type} are
15028 @table @samp
15029 @item ev4
15030 @itemx ev45
15031 @itemx 21064
15032 Schedules as an EV4 and has no instruction set extensions.
15034 @item ev5
15035 @itemx 21164
15036 Schedules as an EV5 and has no instruction set extensions.
15038 @item ev56
15039 @itemx 21164a
15040 Schedules as an EV5 and supports the BWX extension.
15042 @item pca56
15043 @itemx 21164pc
15044 @itemx 21164PC
15045 Schedules as an EV5 and supports the BWX and MAX extensions.
15047 @item ev6
15048 @itemx 21264
15049 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
15051 @item ev67
15052 @itemx 21264a
15053 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
15054 @end table
15056 Native toolchains also support the value @samp{native},
15057 which selects the best architecture option for the host processor.
15058 @option{-mcpu=native} has no effect if GCC does not recognize
15059 the processor.
15061 @item -mtune=@var{cpu_type}
15062 @opindex mtune
15063 Set only the instruction scheduling parameters for machine type
15064 @var{cpu_type}.  The instruction set is not changed.
15066 Native toolchains also support the value @samp{native},
15067 which selects the best architecture option for the host processor.
15068 @option{-mtune=native} has no effect if GCC does not recognize
15069 the processor.
15071 @item -mmemory-latency=@var{time}
15072 @opindex mmemory-latency
15073 Sets the latency the scheduler should assume for typical memory
15074 references as seen by the application.  This number is highly
15075 dependent on the memory access patterns used by the application
15076 and the size of the external cache on the machine.
15078 Valid options for @var{time} are
15080 @table @samp
15081 @item @var{number}
15082 A decimal number representing clock cycles.
15084 @item L1
15085 @itemx L2
15086 @itemx L3
15087 @itemx main
15088 The compiler contains estimates of the number of clock cycles for
15089 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15090 (also called Dcache, Scache, and Bcache), as well as to main memory.
15091 Note that L3 is only valid for EV5.
15093 @end table
15094 @end table
15096 @node FR30 Options
15097 @subsection FR30 Options
15098 @cindex FR30 Options
15100 These options are defined specifically for the FR30 port.
15102 @table @gcctabopt
15104 @item -msmall-model
15105 @opindex msmall-model
15106 Use the small address space model.  This can produce smaller code, but
15107 it does assume that all symbolic values and addresses fit into a
15108 20-bit range.
15110 @item -mno-lsim
15111 @opindex mno-lsim
15112 Assume that runtime support has been provided and so there is no need
15113 to include the simulator library (@file{libsim.a}) on the linker
15114 command line.
15116 @end table
15118 @node FT32 Options
15119 @subsection FT32 Options
15120 @cindex FT32 Options
15122 These options are defined specifically for the FT32 port.
15124 @table @gcctabopt
15126 @item -msim
15127 @opindex msim
15128 Specifies that the program will be run on the simulator.  This causes
15129 an alternate runtime startup and library to be linked.
15130 You must not use this option when generating programs that will run on
15131 real hardware; you must provide your own runtime library for whatever
15132 I/O functions are needed.
15134 @item -mlra
15135 @opindex mlra
15136 Enable Local Register Allocation.  This is still experimental for FT32,
15137 so by default the compiler uses standard reload.
15139 @end table
15141 @node FRV Options
15142 @subsection FRV Options
15143 @cindex FRV Options
15145 @table @gcctabopt
15146 @item -mgpr-32
15147 @opindex mgpr-32
15149 Only use the first 32 general-purpose registers.
15151 @item -mgpr-64
15152 @opindex mgpr-64
15154 Use all 64 general-purpose registers.
15156 @item -mfpr-32
15157 @opindex mfpr-32
15159 Use only the first 32 floating-point registers.
15161 @item -mfpr-64
15162 @opindex mfpr-64
15164 Use all 64 floating-point registers.
15166 @item -mhard-float
15167 @opindex mhard-float
15169 Use hardware instructions for floating-point operations.
15171 @item -msoft-float
15172 @opindex msoft-float
15174 Use library routines for floating-point operations.
15176 @item -malloc-cc
15177 @opindex malloc-cc
15179 Dynamically allocate condition code registers.
15181 @item -mfixed-cc
15182 @opindex mfixed-cc
15184 Do not try to dynamically allocate condition code registers, only
15185 use @code{icc0} and @code{fcc0}.
15187 @item -mdword
15188 @opindex mdword
15190 Change ABI to use double word insns.
15192 @item -mno-dword
15193 @opindex mno-dword
15195 Do not use double word instructions.
15197 @item -mdouble
15198 @opindex mdouble
15200 Use floating-point double instructions.
15202 @item -mno-double
15203 @opindex mno-double
15205 Do not use floating-point double instructions.
15207 @item -mmedia
15208 @opindex mmedia
15210 Use media instructions.
15212 @item -mno-media
15213 @opindex mno-media
15215 Do not use media instructions.
15217 @item -mmuladd
15218 @opindex mmuladd
15220 Use multiply and add/subtract instructions.
15222 @item -mno-muladd
15223 @opindex mno-muladd
15225 Do not use multiply and add/subtract instructions.
15227 @item -mfdpic
15228 @opindex mfdpic
15230 Select the FDPIC ABI, which uses function descriptors to represent
15231 pointers to functions.  Without any PIC/PIE-related options, it
15232 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
15233 assumes GOT entries and small data are within a 12-bit range from the
15234 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
15235 are computed with 32 bits.
15236 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15238 @item -minline-plt
15239 @opindex minline-plt
15241 Enable inlining of PLT entries in function calls to functions that are
15242 not known to bind locally.  It has no effect without @option{-mfdpic}.
15243 It's enabled by default if optimizing for speed and compiling for
15244 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
15245 optimization option such as @option{-O3} or above is present in the
15246 command line.
15248 @item -mTLS
15249 @opindex mTLS
15251 Assume a large TLS segment when generating thread-local code.
15253 @item -mtls
15254 @opindex mtls
15256 Do not assume a large TLS segment when generating thread-local code.
15258 @item -mgprel-ro
15259 @opindex mgprel-ro
15261 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
15262 that is known to be in read-only sections.  It's enabled by default,
15263 except for @option{-fpic} or @option{-fpie}: even though it may help
15264 make the global offset table smaller, it trades 1 instruction for 4.
15265 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
15266 one of which may be shared by multiple symbols, and it avoids the need
15267 for a GOT entry for the referenced symbol, so it's more likely to be a
15268 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
15270 @item -multilib-library-pic
15271 @opindex multilib-library-pic
15273 Link with the (library, not FD) pic libraries.  It's implied by
15274 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
15275 @option{-fpic} without @option{-mfdpic}.  You should never have to use
15276 it explicitly.
15278 @item -mlinked-fp
15279 @opindex mlinked-fp
15281 Follow the EABI requirement of always creating a frame pointer whenever
15282 a stack frame is allocated.  This option is enabled by default and can
15283 be disabled with @option{-mno-linked-fp}.
15285 @item -mlong-calls
15286 @opindex mlong-calls
15288 Use indirect addressing to call functions outside the current
15289 compilation unit.  This allows the functions to be placed anywhere
15290 within the 32-bit address space.
15292 @item -malign-labels
15293 @opindex malign-labels
15295 Try to align labels to an 8-byte boundary by inserting NOPs into the
15296 previous packet.  This option only has an effect when VLIW packing
15297 is enabled.  It doesn't create new packets; it merely adds NOPs to
15298 existing ones.
15300 @item -mlibrary-pic
15301 @opindex mlibrary-pic
15303 Generate position-independent EABI code.
15305 @item -macc-4
15306 @opindex macc-4
15308 Use only the first four media accumulator registers.
15310 @item -macc-8
15311 @opindex macc-8
15313 Use all eight media accumulator registers.
15315 @item -mpack
15316 @opindex mpack
15318 Pack VLIW instructions.
15320 @item -mno-pack
15321 @opindex mno-pack
15323 Do not pack VLIW instructions.
15325 @item -mno-eflags
15326 @opindex mno-eflags
15328 Do not mark ABI switches in e_flags.
15330 @item -mcond-move
15331 @opindex mcond-move
15333 Enable the use of conditional-move instructions (default).
15335 This switch is mainly for debugging the compiler and will likely be removed
15336 in a future version.
15338 @item -mno-cond-move
15339 @opindex mno-cond-move
15341 Disable the use of conditional-move instructions.
15343 This switch is mainly for debugging the compiler and will likely be removed
15344 in a future version.
15346 @item -mscc
15347 @opindex mscc
15349 Enable the use of conditional set instructions (default).
15351 This switch is mainly for debugging the compiler and will likely be removed
15352 in a future version.
15354 @item -mno-scc
15355 @opindex mno-scc
15357 Disable the use of conditional set instructions.
15359 This switch is mainly for debugging the compiler and will likely be removed
15360 in a future version.
15362 @item -mcond-exec
15363 @opindex mcond-exec
15365 Enable the use of conditional execution (default).
15367 This switch is mainly for debugging the compiler and will likely be removed
15368 in a future version.
15370 @item -mno-cond-exec
15371 @opindex mno-cond-exec
15373 Disable the use of conditional execution.
15375 This switch is mainly for debugging the compiler and will likely be removed
15376 in a future version.
15378 @item -mvliw-branch
15379 @opindex mvliw-branch
15381 Run a pass to pack branches into VLIW instructions (default).
15383 This switch is mainly for debugging the compiler and will likely be removed
15384 in a future version.
15386 @item -mno-vliw-branch
15387 @opindex mno-vliw-branch
15389 Do not run a pass to pack branches into VLIW instructions.
15391 This switch is mainly for debugging the compiler and will likely be removed
15392 in a future version.
15394 @item -mmulti-cond-exec
15395 @opindex mmulti-cond-exec
15397 Enable optimization of @code{&&} and @code{||} in conditional execution
15398 (default).
15400 This switch is mainly for debugging the compiler and will likely be removed
15401 in a future version.
15403 @item -mno-multi-cond-exec
15404 @opindex mno-multi-cond-exec
15406 Disable optimization of @code{&&} and @code{||} in conditional execution.
15408 This switch is mainly for debugging the compiler and will likely be removed
15409 in a future version.
15411 @item -mnested-cond-exec
15412 @opindex mnested-cond-exec
15414 Enable nested conditional execution optimizations (default).
15416 This switch is mainly for debugging the compiler and will likely be removed
15417 in a future version.
15419 @item -mno-nested-cond-exec
15420 @opindex mno-nested-cond-exec
15422 Disable nested conditional execution optimizations.
15424 This switch is mainly for debugging the compiler and will likely be removed
15425 in a future version.
15427 @item -moptimize-membar
15428 @opindex moptimize-membar
15430 This switch removes redundant @code{membar} instructions from the
15431 compiler-generated code.  It is enabled by default.
15433 @item -mno-optimize-membar
15434 @opindex mno-optimize-membar
15436 This switch disables the automatic removal of redundant @code{membar}
15437 instructions from the generated code.
15439 @item -mtomcat-stats
15440 @opindex mtomcat-stats
15442 Cause gas to print out tomcat statistics.
15444 @item -mcpu=@var{cpu}
15445 @opindex mcpu
15447 Select the processor type for which to generate code.  Possible values are
15448 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
15449 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
15451 @end table
15453 @node GNU/Linux Options
15454 @subsection GNU/Linux Options
15456 These @samp{-m} options are defined for GNU/Linux targets:
15458 @table @gcctabopt
15459 @item -mglibc
15460 @opindex mglibc
15461 Use the GNU C library.  This is the default except
15462 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
15463 @samp{*-*-linux-*android*} targets.
15465 @item -muclibc
15466 @opindex muclibc
15467 Use uClibc C library.  This is the default on
15468 @samp{*-*-linux-*uclibc*} targets.
15470 @item -mmusl
15471 @opindex mmusl
15472 Use the musl C library.  This is the default on
15473 @samp{*-*-linux-*musl*} targets.
15475 @item -mbionic
15476 @opindex mbionic
15477 Use Bionic C library.  This is the default on
15478 @samp{*-*-linux-*android*} targets.
15480 @item -mandroid
15481 @opindex mandroid
15482 Compile code compatible with Android platform.  This is the default on
15483 @samp{*-*-linux-*android*} targets.
15485 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15486 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15487 this option makes the GCC driver pass Android-specific options to the linker.
15488 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15489 to be defined.
15491 @item -tno-android-cc
15492 @opindex tno-android-cc
15493 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15494 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15495 @option{-fno-rtti} by default.
15497 @item -tno-android-ld
15498 @opindex tno-android-ld
15499 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15500 linking options to the linker.
15502 @end table
15504 @node H8/300 Options
15505 @subsection H8/300 Options
15507 These @samp{-m} options are defined for the H8/300 implementations:
15509 @table @gcctabopt
15510 @item -mrelax
15511 @opindex mrelax
15512 Shorten some address references at link time, when possible; uses the
15513 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15514 ld, Using ld}, for a fuller description.
15516 @item -mh
15517 @opindex mh
15518 Generate code for the H8/300H@.
15520 @item -ms
15521 @opindex ms
15522 Generate code for the H8S@.
15524 @item -mn
15525 @opindex mn
15526 Generate code for the H8S and H8/300H in the normal mode.  This switch
15527 must be used either with @option{-mh} or @option{-ms}.
15529 @item -ms2600
15530 @opindex ms2600
15531 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15533 @item -mexr
15534 @opindex mexr
15535 Extended registers are stored on stack before execution of function
15536 with monitor attribute. Default option is @option{-mexr}.
15537 This option is valid only for H8S targets.
15539 @item -mno-exr
15540 @opindex mno-exr
15541 Extended registers are not stored on stack before execution of function 
15542 with monitor attribute. Default option is @option{-mno-exr}. 
15543 This option is valid only for H8S targets.
15545 @item -mint32
15546 @opindex mint32
15547 Make @code{int} data 32 bits by default.
15549 @item -malign-300
15550 @opindex malign-300
15551 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15552 The default for the H8/300H and H8S is to align longs and floats on
15553 4-byte boundaries.
15554 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15555 This option has no effect on the H8/300.
15556 @end table
15558 @node HPPA Options
15559 @subsection HPPA Options
15560 @cindex HPPA Options
15562 These @samp{-m} options are defined for the HPPA family of computers:
15564 @table @gcctabopt
15565 @item -march=@var{architecture-type}
15566 @opindex march
15567 Generate code for the specified architecture.  The choices for
15568 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15569 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15570 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15571 architecture option for your machine.  Code compiled for lower numbered
15572 architectures runs on higher numbered architectures, but not the
15573 other way around.
15575 @item -mpa-risc-1-0
15576 @itemx -mpa-risc-1-1
15577 @itemx -mpa-risc-2-0
15578 @opindex mpa-risc-1-0
15579 @opindex mpa-risc-1-1
15580 @opindex mpa-risc-2-0
15581 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15583 @item -mjump-in-delay
15584 @opindex mjump-in-delay
15585 This option is ignored and provided for compatibility purposes only.
15587 @item -mdisable-fpregs
15588 @opindex mdisable-fpregs
15589 Prevent floating-point registers from being used in any manner.  This is
15590 necessary for compiling kernels that perform lazy context switching of
15591 floating-point registers.  If you use this option and attempt to perform
15592 floating-point operations, the compiler aborts.
15594 @item -mdisable-indexing
15595 @opindex mdisable-indexing
15596 Prevent the compiler from using indexing address modes.  This avoids some
15597 rather obscure problems when compiling MIG generated code under MACH@.
15599 @item -mno-space-regs
15600 @opindex mno-space-regs
15601 Generate code that assumes the target has no space registers.  This allows
15602 GCC to generate faster indirect calls and use unscaled index address modes.
15604 Such code is suitable for level 0 PA systems and kernels.
15606 @item -mfast-indirect-calls
15607 @opindex mfast-indirect-calls
15608 Generate code that assumes calls never cross space boundaries.  This
15609 allows GCC to emit code that performs faster indirect calls.
15611 This option does not work in the presence of shared libraries or nested
15612 functions.
15614 @item -mfixed-range=@var{register-range}
15615 @opindex mfixed-range
15616 Generate code treating the given register range as fixed registers.
15617 A fixed register is one that the register allocator cannot use.  This is
15618 useful when compiling kernel code.  A register range is specified as
15619 two registers separated by a dash.  Multiple register ranges can be
15620 specified separated by a comma.
15622 @item -mlong-load-store
15623 @opindex mlong-load-store
15624 Generate 3-instruction load and store sequences as sometimes required by
15625 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15626 the HP compilers.
15628 @item -mportable-runtime
15629 @opindex mportable-runtime
15630 Use the portable calling conventions proposed by HP for ELF systems.
15632 @item -mgas
15633 @opindex mgas
15634 Enable the use of assembler directives only GAS understands.
15636 @item -mschedule=@var{cpu-type}
15637 @opindex mschedule
15638 Schedule code according to the constraints for the machine type
15639 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15640 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15641 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15642 proper scheduling option for your machine.  The default scheduling is
15643 @samp{8000}.
15645 @item -mlinker-opt
15646 @opindex mlinker-opt
15647 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15648 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15649 linkers in which they give bogus error messages when linking some programs.
15651 @item -msoft-float
15652 @opindex msoft-float
15653 Generate output containing library calls for floating point.
15654 @strong{Warning:} the requisite libraries are not available for all HPPA
15655 targets.  Normally the facilities of the machine's usual C compiler are
15656 used, but this cannot be done directly in cross-compilation.  You must make
15657 your own arrangements to provide suitable library functions for
15658 cross-compilation.
15660 @option{-msoft-float} changes the calling convention in the output file;
15661 therefore, it is only useful if you compile @emph{all} of a program with
15662 this option.  In particular, you need to compile @file{libgcc.a}, the
15663 library that comes with GCC, with @option{-msoft-float} in order for
15664 this to work.
15666 @item -msio
15667 @opindex msio
15668 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15669 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15670 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15671 options are available under HP-UX and HI-UX@.
15673 @item -mgnu-ld
15674 @opindex mgnu-ld
15675 Use options specific to GNU @command{ld}.
15676 This passes @option{-shared} to @command{ld} when
15677 building a shared library.  It is the default when GCC is configured,
15678 explicitly or implicitly, with the GNU linker.  This option does not
15679 affect which @command{ld} is called; it only changes what parameters
15680 are passed to that @command{ld}.
15681 The @command{ld} that is called is determined by the
15682 @option{--with-ld} configure option, GCC's program search path, and
15683 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15684 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15685 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15687 @item -mhp-ld
15688 @opindex mhp-ld
15689 Use options specific to HP @command{ld}.
15690 This passes @option{-b} to @command{ld} when building
15691 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15692 links.  It is the default when GCC is configured, explicitly or
15693 implicitly, with the HP linker.  This option does not affect
15694 which @command{ld} is called; it only changes what parameters are passed to that
15695 @command{ld}.
15696 The @command{ld} that is called is determined by the @option{--with-ld}
15697 configure option, GCC's program search path, and finally by the user's
15698 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15699 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15700 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15702 @item -mlong-calls
15703 @opindex mno-long-calls
15704 Generate code that uses long call sequences.  This ensures that a call
15705 is always able to reach linker generated stubs.  The default is to generate
15706 long calls only when the distance from the call site to the beginning
15707 of the function or translation unit, as the case may be, exceeds a
15708 predefined limit set by the branch type being used.  The limits for
15709 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15710 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15711 240,000 bytes.
15713 Distances are measured from the beginning of functions when using the
15714 @option{-ffunction-sections} option, or when using the @option{-mgas}
15715 and @option{-mno-portable-runtime} options together under HP-UX with
15716 the SOM linker.
15718 It is normally not desirable to use this option as it degrades
15719 performance.  However, it may be useful in large applications,
15720 particularly when partial linking is used to build the application.
15722 The types of long calls used depends on the capabilities of the
15723 assembler and linker, and the type of code being generated.  The
15724 impact on systems that support long absolute calls, and long pic
15725 symbol-difference or pc-relative calls should be relatively small.
15726 However, an indirect call is used on 32-bit ELF systems in pic code
15727 and it is quite long.
15729 @item -munix=@var{unix-std}
15730 @opindex march
15731 Generate compiler predefines and select a startfile for the specified
15732 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15733 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15734 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15735 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15736 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15737 and later.
15739 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15740 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15741 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15742 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15743 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15744 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15746 It is @emph{important} to note that this option changes the interfaces
15747 for various library routines.  It also affects the operational behavior
15748 of the C library.  Thus, @emph{extreme} care is needed in using this
15749 option.
15751 Library code that is intended to operate with more than one UNIX
15752 standard must test, set and restore the variable @code{__xpg4_extended_mask}
15753 as appropriate.  Most GNU software doesn't provide this capability.
15755 @item -nolibdld
15756 @opindex nolibdld
15757 Suppress the generation of link options to search libdld.sl when the
15758 @option{-static} option is specified on HP-UX 10 and later.
15760 @item -static
15761 @opindex static
15762 The HP-UX implementation of setlocale in libc has a dependency on
15763 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15764 when the @option{-static} option is specified, special link options
15765 are needed to resolve this dependency.
15767 On HP-UX 10 and later, the GCC driver adds the necessary options to
15768 link with libdld.sl when the @option{-static} option is specified.
15769 This causes the resulting binary to be dynamic.  On the 64-bit port,
15770 the linkers generate dynamic binaries by default in any case.  The
15771 @option{-nolibdld} option can be used to prevent the GCC driver from
15772 adding these link options.
15774 @item -threads
15775 @opindex threads
15776 Add support for multithreading with the @dfn{dce thread} library
15777 under HP-UX@.  This option sets flags for both the preprocessor and
15778 linker.
15779 @end table
15781 @node IA-64 Options
15782 @subsection IA-64 Options
15783 @cindex IA-64 Options
15785 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15787 @table @gcctabopt
15788 @item -mbig-endian
15789 @opindex mbig-endian
15790 Generate code for a big-endian target.  This is the default for HP-UX@.
15792 @item -mlittle-endian
15793 @opindex mlittle-endian
15794 Generate code for a little-endian target.  This is the default for AIX5
15795 and GNU/Linux.
15797 @item -mgnu-as
15798 @itemx -mno-gnu-as
15799 @opindex mgnu-as
15800 @opindex mno-gnu-as
15801 Generate (or don't) code for the GNU assembler.  This is the default.
15802 @c Also, this is the default if the configure option @option{--with-gnu-as}
15803 @c is used.
15805 @item -mgnu-ld
15806 @itemx -mno-gnu-ld
15807 @opindex mgnu-ld
15808 @opindex mno-gnu-ld
15809 Generate (or don't) code for the GNU linker.  This is the default.
15810 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15811 @c is used.
15813 @item -mno-pic
15814 @opindex mno-pic
15815 Generate code that does not use a global pointer register.  The result
15816 is not position independent code, and violates the IA-64 ABI@.
15818 @item -mvolatile-asm-stop
15819 @itemx -mno-volatile-asm-stop
15820 @opindex mvolatile-asm-stop
15821 @opindex mno-volatile-asm-stop
15822 Generate (or don't) a stop bit immediately before and after volatile asm
15823 statements.
15825 @item -mregister-names
15826 @itemx -mno-register-names
15827 @opindex mregister-names
15828 @opindex mno-register-names
15829 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15830 the stacked registers.  This may make assembler output more readable.
15832 @item -mno-sdata
15833 @itemx -msdata
15834 @opindex mno-sdata
15835 @opindex msdata
15836 Disable (or enable) optimizations that use the small data section.  This may
15837 be useful for working around optimizer bugs.
15839 @item -mconstant-gp
15840 @opindex mconstant-gp
15841 Generate code that uses a single constant global pointer value.  This is
15842 useful when compiling kernel code.
15844 @item -mauto-pic
15845 @opindex mauto-pic
15846 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15847 This is useful when compiling firmware code.
15849 @item -minline-float-divide-min-latency
15850 @opindex minline-float-divide-min-latency
15851 Generate code for inline divides of floating-point values
15852 using the minimum latency algorithm.
15854 @item -minline-float-divide-max-throughput
15855 @opindex minline-float-divide-max-throughput
15856 Generate code for inline divides of floating-point values
15857 using the maximum throughput algorithm.
15859 @item -mno-inline-float-divide
15860 @opindex mno-inline-float-divide
15861 Do not generate inline code for divides of floating-point values.
15863 @item -minline-int-divide-min-latency
15864 @opindex minline-int-divide-min-latency
15865 Generate code for inline divides of integer values
15866 using the minimum latency algorithm.
15868 @item -minline-int-divide-max-throughput
15869 @opindex minline-int-divide-max-throughput
15870 Generate code for inline divides of integer values
15871 using the maximum throughput algorithm.
15873 @item -mno-inline-int-divide
15874 @opindex mno-inline-int-divide
15875 Do not generate inline code for divides of integer values.
15877 @item -minline-sqrt-min-latency
15878 @opindex minline-sqrt-min-latency
15879 Generate code for inline square roots
15880 using the minimum latency algorithm.
15882 @item -minline-sqrt-max-throughput
15883 @opindex minline-sqrt-max-throughput
15884 Generate code for inline square roots
15885 using the maximum throughput algorithm.
15887 @item -mno-inline-sqrt
15888 @opindex mno-inline-sqrt
15889 Do not generate inline code for @code{sqrt}.
15891 @item -mfused-madd
15892 @itemx -mno-fused-madd
15893 @opindex mfused-madd
15894 @opindex mno-fused-madd
15895 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
15896 instructions.  The default is to use these instructions.
15898 @item -mno-dwarf2-asm
15899 @itemx -mdwarf2-asm
15900 @opindex mno-dwarf2-asm
15901 @opindex mdwarf2-asm
15902 Don't (or do) generate assembler code for the DWARF 2 line number debugging
15903 info.  This may be useful when not using the GNU assembler.
15905 @item -mearly-stop-bits
15906 @itemx -mno-early-stop-bits
15907 @opindex mearly-stop-bits
15908 @opindex mno-early-stop-bits
15909 Allow stop bits to be placed earlier than immediately preceding the
15910 instruction that triggered the stop bit.  This can improve instruction
15911 scheduling, but does not always do so.
15913 @item -mfixed-range=@var{register-range}
15914 @opindex mfixed-range
15915 Generate code treating the given register range as fixed registers.
15916 A fixed register is one that the register allocator cannot use.  This is
15917 useful when compiling kernel code.  A register range is specified as
15918 two registers separated by a dash.  Multiple register ranges can be
15919 specified separated by a comma.
15921 @item -mtls-size=@var{tls-size}
15922 @opindex mtls-size
15923 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
15926 @item -mtune=@var{cpu-type}
15927 @opindex mtune
15928 Tune the instruction scheduling for a particular CPU, Valid values are
15929 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15930 and @samp{mckinley}.
15932 @item -milp32
15933 @itemx -mlp64
15934 @opindex milp32
15935 @opindex mlp64
15936 Generate code for a 32-bit or 64-bit environment.
15937 The 32-bit environment sets int, long and pointer to 32 bits.
15938 The 64-bit environment sets int to 32 bits and long and pointer
15939 to 64 bits.  These are HP-UX specific flags.
15941 @item -mno-sched-br-data-spec
15942 @itemx -msched-br-data-spec
15943 @opindex mno-sched-br-data-spec
15944 @opindex msched-br-data-spec
15945 (Dis/En)able data speculative scheduling before reload.
15946 This results in generation of @code{ld.a} instructions and
15947 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15948 The default is 'disable'.
15950 @item -msched-ar-data-spec
15951 @itemx -mno-sched-ar-data-spec
15952 @opindex msched-ar-data-spec
15953 @opindex mno-sched-ar-data-spec
15954 (En/Dis)able data speculative scheduling after reload.
15955 This results in generation of @code{ld.a} instructions and
15956 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15957 The default is 'enable'.
15959 @item -mno-sched-control-spec
15960 @itemx -msched-control-spec
15961 @opindex mno-sched-control-spec
15962 @opindex msched-control-spec
15963 (Dis/En)able control speculative scheduling.  This feature is
15964 available only during region scheduling (i.e.@: before reload).
15965 This results in generation of the @code{ld.s} instructions and
15966 the corresponding check instructions @code{chk.s}.
15967 The default is 'disable'.
15969 @item -msched-br-in-data-spec
15970 @itemx -mno-sched-br-in-data-spec
15971 @opindex msched-br-in-data-spec
15972 @opindex mno-sched-br-in-data-spec
15973 (En/Dis)able speculative scheduling of the instructions that
15974 are dependent on the data speculative loads before reload.
15975 This is effective only with @option{-msched-br-data-spec} enabled.
15976 The default is 'enable'.
15978 @item -msched-ar-in-data-spec
15979 @itemx -mno-sched-ar-in-data-spec
15980 @opindex msched-ar-in-data-spec
15981 @opindex mno-sched-ar-in-data-spec
15982 (En/Dis)able speculative scheduling of the instructions that
15983 are dependent on the data speculative loads after reload.
15984 This is effective only with @option{-msched-ar-data-spec} enabled.
15985 The default is 'enable'.
15987 @item -msched-in-control-spec
15988 @itemx -mno-sched-in-control-spec
15989 @opindex msched-in-control-spec
15990 @opindex mno-sched-in-control-spec
15991 (En/Dis)able speculative scheduling of the instructions that
15992 are dependent on the control speculative loads.
15993 This is effective only with @option{-msched-control-spec} enabled.
15994 The default is 'enable'.
15996 @item -mno-sched-prefer-non-data-spec-insns
15997 @itemx -msched-prefer-non-data-spec-insns
15998 @opindex mno-sched-prefer-non-data-spec-insns
15999 @opindex msched-prefer-non-data-spec-insns
16000 If enabled, data-speculative instructions are chosen for schedule
16001 only if there are no other choices at the moment.  This makes
16002 the use of the data speculation much more conservative.
16003 The default is 'disable'.
16005 @item -mno-sched-prefer-non-control-spec-insns
16006 @itemx -msched-prefer-non-control-spec-insns
16007 @opindex mno-sched-prefer-non-control-spec-insns
16008 @opindex msched-prefer-non-control-spec-insns
16009 If enabled, control-speculative instructions are chosen for schedule
16010 only if there are no other choices at the moment.  This makes
16011 the use of the control speculation much more conservative.
16012 The default is 'disable'.
16014 @item -mno-sched-count-spec-in-critical-path
16015 @itemx -msched-count-spec-in-critical-path
16016 @opindex mno-sched-count-spec-in-critical-path
16017 @opindex msched-count-spec-in-critical-path
16018 If enabled, speculative dependencies are considered during
16019 computation of the instructions priorities.  This makes the use of the
16020 speculation a bit more conservative.
16021 The default is 'disable'.
16023 @item -msched-spec-ldc
16024 @opindex msched-spec-ldc
16025 Use a simple data speculation check.  This option is on by default.
16027 @item -msched-control-spec-ldc
16028 @opindex msched-spec-ldc
16029 Use a simple check for control speculation.  This option is on by default.
16031 @item -msched-stop-bits-after-every-cycle
16032 @opindex msched-stop-bits-after-every-cycle
16033 Place a stop bit after every cycle when scheduling.  This option is on
16034 by default.
16036 @item -msched-fp-mem-deps-zero-cost
16037 @opindex msched-fp-mem-deps-zero-cost
16038 Assume that floating-point stores and loads are not likely to cause a conflict
16039 when placed into the same instruction group.  This option is disabled by
16040 default.
16042 @item -msel-sched-dont-check-control-spec
16043 @opindex msel-sched-dont-check-control-spec
16044 Generate checks for control speculation in selective scheduling.
16045 This flag is disabled by default.
16047 @item -msched-max-memory-insns=@var{max-insns}
16048 @opindex msched-max-memory-insns
16049 Limit on the number of memory insns per instruction group, giving lower
16050 priority to subsequent memory insns attempting to schedule in the same
16051 instruction group. Frequently useful to prevent cache bank conflicts.
16052 The default value is 1.
16054 @item -msched-max-memory-insns-hard-limit
16055 @opindex msched-max-memory-insns-hard-limit
16056 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16057 disallowing more than that number in an instruction group.
16058 Otherwise, the limit is ``soft'', meaning that non-memory operations
16059 are preferred when the limit is reached, but memory operations may still
16060 be scheduled.
16062 @end table
16064 @node LM32 Options
16065 @subsection LM32 Options
16066 @cindex LM32 options
16068 These @option{-m} options are defined for the LatticeMico32 architecture:
16070 @table @gcctabopt
16071 @item -mbarrel-shift-enabled
16072 @opindex mbarrel-shift-enabled
16073 Enable barrel-shift instructions.
16075 @item -mdivide-enabled
16076 @opindex mdivide-enabled
16077 Enable divide and modulus instructions.
16079 @item -mmultiply-enabled
16080 @opindex multiply-enabled
16081 Enable multiply instructions.
16083 @item -msign-extend-enabled
16084 @opindex msign-extend-enabled
16085 Enable sign extend instructions.
16087 @item -muser-enabled
16088 @opindex muser-enabled
16089 Enable user-defined instructions.
16091 @end table
16093 @node M32C Options
16094 @subsection M32C Options
16095 @cindex M32C options
16097 @table @gcctabopt
16098 @item -mcpu=@var{name}
16099 @opindex mcpu=
16100 Select the CPU for which code is generated.  @var{name} may be one of
16101 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16102 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16103 the M32C/80 series.
16105 @item -msim
16106 @opindex msim
16107 Specifies that the program will be run on the simulator.  This causes
16108 an alternate runtime library to be linked in which supports, for
16109 example, file I/O@.  You must not use this option when generating
16110 programs that will run on real hardware; you must provide your own
16111 runtime library for whatever I/O functions are needed.
16113 @item -memregs=@var{number}
16114 @opindex memregs=
16115 Specifies the number of memory-based pseudo-registers GCC uses
16116 during code generation.  These pseudo-registers are used like real
16117 registers, so there is a tradeoff between GCC's ability to fit the
16118 code into available registers, and the performance penalty of using
16119 memory instead of registers.  Note that all modules in a program must
16120 be compiled with the same value for this option.  Because of that, you
16121 must not use this option with GCC's default runtime libraries.
16123 @end table
16125 @node M32R/D Options
16126 @subsection M32R/D Options
16127 @cindex M32R/D options
16129 These @option{-m} options are defined for Renesas M32R/D architectures:
16131 @table @gcctabopt
16132 @item -m32r2
16133 @opindex m32r2
16134 Generate code for the M32R/2@.
16136 @item -m32rx
16137 @opindex m32rx
16138 Generate code for the M32R/X@.
16140 @item -m32r
16141 @opindex m32r
16142 Generate code for the M32R@.  This is the default.
16144 @item -mmodel=small
16145 @opindex mmodel=small
16146 Assume all objects live in the lower 16MB of memory (so that their addresses
16147 can be loaded with the @code{ld24} instruction), and assume all subroutines
16148 are reachable with the @code{bl} instruction.
16149 This is the default.
16151 The addressability of a particular object can be set with the
16152 @code{model} attribute.
16154 @item -mmodel=medium
16155 @opindex mmodel=medium
16156 Assume objects may be anywhere in the 32-bit address space (the compiler
16157 generates @code{seth/add3} instructions to load their addresses), and
16158 assume all subroutines are reachable with the @code{bl} instruction.
16160 @item -mmodel=large
16161 @opindex mmodel=large
16162 Assume objects may be anywhere in the 32-bit address space (the compiler
16163 generates @code{seth/add3} instructions to load their addresses), and
16164 assume subroutines may not be reachable with the @code{bl} instruction
16165 (the compiler generates the much slower @code{seth/add3/jl}
16166 instruction sequence).
16168 @item -msdata=none
16169 @opindex msdata=none
16170 Disable use of the small data area.  Variables are put into
16171 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16172 @code{section} attribute has been specified).
16173 This is the default.
16175 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16176 Objects may be explicitly put in the small data area with the
16177 @code{section} attribute using one of these sections.
16179 @item -msdata=sdata
16180 @opindex msdata=sdata
16181 Put small global and static data in the small data area, but do not
16182 generate special code to reference them.
16184 @item -msdata=use
16185 @opindex msdata=use
16186 Put small global and static data in the small data area, and generate
16187 special instructions to reference them.
16189 @item -G @var{num}
16190 @opindex G
16191 @cindex smaller data references
16192 Put global and static objects less than or equal to @var{num} bytes
16193 into the small data or BSS sections instead of the normal data or BSS
16194 sections.  The default value of @var{num} is 8.
16195 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16196 for this option to have any effect.
16198 All modules should be compiled with the same @option{-G @var{num}} value.
16199 Compiling with different values of @var{num} may or may not work; if it
16200 doesn't the linker gives an error message---incorrect code is not
16201 generated.
16203 @item -mdebug
16204 @opindex mdebug
16205 Makes the M32R-specific code in the compiler display some statistics
16206 that might help in debugging programs.
16208 @item -malign-loops
16209 @opindex malign-loops
16210 Align all loops to a 32-byte boundary.
16212 @item -mno-align-loops
16213 @opindex mno-align-loops
16214 Do not enforce a 32-byte alignment for loops.  This is the default.
16216 @item -missue-rate=@var{number}
16217 @opindex missue-rate=@var{number}
16218 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16219 or 2.
16221 @item -mbranch-cost=@var{number}
16222 @opindex mbranch-cost=@var{number}
16223 @var{number} can only be 1 or 2.  If it is 1 then branches are
16224 preferred over conditional code, if it is 2, then the opposite applies.
16226 @item -mflush-trap=@var{number}
16227 @opindex mflush-trap=@var{number}
16228 Specifies the trap number to use to flush the cache.  The default is
16229 12.  Valid numbers are between 0 and 15 inclusive.
16231 @item -mno-flush-trap
16232 @opindex mno-flush-trap
16233 Specifies that the cache cannot be flushed by using a trap.
16235 @item -mflush-func=@var{name}
16236 @opindex mflush-func=@var{name}
16237 Specifies the name of the operating system function to call to flush
16238 the cache.  The default is @samp{_flush_cache}, but a function call
16239 is only used if a trap is not available.
16241 @item -mno-flush-func
16242 @opindex mno-flush-func
16243 Indicates that there is no OS function for flushing the cache.
16245 @end table
16247 @node M680x0 Options
16248 @subsection M680x0 Options
16249 @cindex M680x0 options
16251 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16252 The default settings depend on which architecture was selected when
16253 the compiler was configured; the defaults for the most common choices
16254 are given below.
16256 @table @gcctabopt
16257 @item -march=@var{arch}
16258 @opindex march
16259 Generate code for a specific M680x0 or ColdFire instruction set
16260 architecture.  Permissible values of @var{arch} for M680x0
16261 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16262 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16263 architectures are selected according to Freescale's ISA classification
16264 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16265 @samp{isab} and @samp{isac}.
16267 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
16268 code for a ColdFire target.  The @var{arch} in this macro is one of the
16269 @option{-march} arguments given above.
16271 When used together, @option{-march} and @option{-mtune} select code
16272 that runs on a family of similar processors but that is optimized
16273 for a particular microarchitecture.
16275 @item -mcpu=@var{cpu}
16276 @opindex mcpu
16277 Generate code for a specific M680x0 or ColdFire processor.
16278 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16279 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16280 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16281 below, which also classifies the CPUs into families:
16283 @multitable @columnfractions 0.20 0.80
16284 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16285 @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}
16286 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16287 @item @samp{5206e} @tab @samp{5206e}
16288 @item @samp{5208} @tab @samp{5207} @samp{5208}
16289 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16290 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16291 @item @samp{5216} @tab @samp{5214} @samp{5216}
16292 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16293 @item @samp{5225} @tab @samp{5224} @samp{5225}
16294 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16295 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16296 @item @samp{5249} @tab @samp{5249}
16297 @item @samp{5250} @tab @samp{5250}
16298 @item @samp{5271} @tab @samp{5270} @samp{5271}
16299 @item @samp{5272} @tab @samp{5272}
16300 @item @samp{5275} @tab @samp{5274} @samp{5275}
16301 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16302 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16303 @item @samp{5307} @tab @samp{5307}
16304 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16305 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16306 @item @samp{5407} @tab @samp{5407}
16307 @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}
16308 @end multitable
16310 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16311 @var{arch} is compatible with @var{cpu}.  Other combinations of
16312 @option{-mcpu} and @option{-march} are rejected.
16314 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
16315 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
16316 where the value of @var{family} is given by the table above.
16318 @item -mtune=@var{tune}
16319 @opindex mtune
16320 Tune the code for a particular microarchitecture within the
16321 constraints set by @option{-march} and @option{-mcpu}.
16322 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16323 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16324 and @samp{cpu32}.  The ColdFire microarchitectures
16325 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16327 You can also use @option{-mtune=68020-40} for code that needs
16328 to run relatively well on 68020, 68030 and 68040 targets.
16329 @option{-mtune=68020-60} is similar but includes 68060 targets
16330 as well.  These two options select the same tuning decisions as
16331 @option{-m68020-40} and @option{-m68020-60} respectively.
16333 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
16334 when tuning for 680x0 architecture @var{arch}.  It also defines
16335 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16336 option is used.  If GCC is tuning for a range of architectures,
16337 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16338 it defines the macros for every architecture in the range.
16340 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
16341 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16342 of the arguments given above.
16344 @item -m68000
16345 @itemx -mc68000
16346 @opindex m68000
16347 @opindex mc68000
16348 Generate output for a 68000.  This is the default
16349 when the compiler is configured for 68000-based systems.
16350 It is equivalent to @option{-march=68000}.
16352 Use this option for microcontrollers with a 68000 or EC000 core,
16353 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16355 @item -m68010
16356 @opindex m68010
16357 Generate output for a 68010.  This is the default
16358 when the compiler is configured for 68010-based systems.
16359 It is equivalent to @option{-march=68010}.
16361 @item -m68020
16362 @itemx -mc68020
16363 @opindex m68020
16364 @opindex mc68020
16365 Generate output for a 68020.  This is the default
16366 when the compiler is configured for 68020-based systems.
16367 It is equivalent to @option{-march=68020}.
16369 @item -m68030
16370 @opindex m68030
16371 Generate output for a 68030.  This is the default when the compiler is
16372 configured for 68030-based systems.  It is equivalent to
16373 @option{-march=68030}.
16375 @item -m68040
16376 @opindex m68040
16377 Generate output for a 68040.  This is the default when the compiler is
16378 configured for 68040-based systems.  It is equivalent to
16379 @option{-march=68040}.
16381 This option inhibits the use of 68881/68882 instructions that have to be
16382 emulated by software on the 68040.  Use this option if your 68040 does not
16383 have code to emulate those instructions.
16385 @item -m68060
16386 @opindex m68060
16387 Generate output for a 68060.  This is the default when the compiler is
16388 configured for 68060-based systems.  It is equivalent to
16389 @option{-march=68060}.
16391 This option inhibits the use of 68020 and 68881/68882 instructions that
16392 have to be emulated by software on the 68060.  Use this option if your 68060
16393 does not have code to emulate those instructions.
16395 @item -mcpu32
16396 @opindex mcpu32
16397 Generate output for a CPU32.  This is the default
16398 when the compiler is configured for CPU32-based systems.
16399 It is equivalent to @option{-march=cpu32}.
16401 Use this option for microcontrollers with a
16402 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16403 68336, 68340, 68341, 68349 and 68360.
16405 @item -m5200
16406 @opindex m5200
16407 Generate output for a 520X ColdFire CPU@.  This is the default
16408 when the compiler is configured for 520X-based systems.
16409 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16410 in favor of that option.
16412 Use this option for microcontroller with a 5200 core, including
16413 the MCF5202, MCF5203, MCF5204 and MCF5206.
16415 @item -m5206e
16416 @opindex m5206e
16417 Generate output for a 5206e ColdFire CPU@.  The option is now
16418 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16420 @item -m528x
16421 @opindex m528x
16422 Generate output for a member of the ColdFire 528X family.
16423 The option is now deprecated in favor of the equivalent
16424 @option{-mcpu=528x}.
16426 @item -m5307
16427 @opindex m5307
16428 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16429 in favor of the equivalent @option{-mcpu=5307}.
16431 @item -m5407
16432 @opindex m5407
16433 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16434 in favor of the equivalent @option{-mcpu=5407}.
16436 @item -mcfv4e
16437 @opindex mcfv4e
16438 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16439 This includes use of hardware floating-point instructions.
16440 The option is equivalent to @option{-mcpu=547x}, and is now
16441 deprecated in favor of that option.
16443 @item -m68020-40
16444 @opindex m68020-40
16445 Generate output for a 68040, without using any of the new instructions.
16446 This results in code that can run relatively efficiently on either a
16447 68020/68881 or a 68030 or a 68040.  The generated code does use the
16448 68881 instructions that are emulated on the 68040.
16450 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16452 @item -m68020-60
16453 @opindex m68020-60
16454 Generate output for a 68060, without using any of the new instructions.
16455 This results in code that can run relatively efficiently on either a
16456 68020/68881 or a 68030 or a 68040.  The generated code does use the
16457 68881 instructions that are emulated on the 68060.
16459 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16461 @item -mhard-float
16462 @itemx -m68881
16463 @opindex mhard-float
16464 @opindex m68881
16465 Generate floating-point instructions.  This is the default for 68020
16466 and above, and for ColdFire devices that have an FPU@.  It defines the
16467 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
16468 on ColdFire targets.
16470 @item -msoft-float
16471 @opindex msoft-float
16472 Do not generate floating-point instructions; use library calls instead.
16473 This is the default for 68000, 68010, and 68832 targets.  It is also
16474 the default for ColdFire devices that have no FPU.
16476 @item -mdiv
16477 @itemx -mno-div
16478 @opindex mdiv
16479 @opindex mno-div
16480 Generate (do not generate) ColdFire hardware divide and remainder
16481 instructions.  If @option{-march} is used without @option{-mcpu},
16482 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16483 architectures.  Otherwise, the default is taken from the target CPU
16484 (either the default CPU, or the one specified by @option{-mcpu}).  For
16485 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16486 @option{-mcpu=5206e}.
16488 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
16490 @item -mshort
16491 @opindex mshort
16492 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16493 Additionally, parameters passed on the stack are also aligned to a
16494 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16496 @item -mno-short
16497 @opindex mno-short
16498 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16500 @item -mnobitfield
16501 @itemx -mno-bitfield
16502 @opindex mnobitfield
16503 @opindex mno-bitfield
16504 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16505 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16507 @item -mbitfield
16508 @opindex mbitfield
16509 Do use the bit-field instructions.  The @option{-m68020} option implies
16510 @option{-mbitfield}.  This is the default if you use a configuration
16511 designed for a 68020.
16513 @item -mrtd
16514 @opindex mrtd
16515 Use a different function-calling convention, in which functions
16516 that take a fixed number of arguments return with the @code{rtd}
16517 instruction, which pops their arguments while returning.  This
16518 saves one instruction in the caller since there is no need to pop
16519 the arguments there.
16521 This calling convention is incompatible with the one normally
16522 used on Unix, so you cannot use it if you need to call libraries
16523 compiled with the Unix compiler.
16525 Also, you must provide function prototypes for all functions that
16526 take variable numbers of arguments (including @code{printf});
16527 otherwise incorrect code is generated for calls to those
16528 functions.
16530 In addition, seriously incorrect code results if you call a
16531 function with too many arguments.  (Normally, extra arguments are
16532 harmlessly ignored.)
16534 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16535 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16537 @item -mno-rtd
16538 @opindex mno-rtd
16539 Do not use the calling conventions selected by @option{-mrtd}.
16540 This is the default.
16542 @item -malign-int
16543 @itemx -mno-align-int
16544 @opindex malign-int
16545 @opindex mno-align-int
16546 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16547 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16548 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16549 Aligning variables on 32-bit boundaries produces code that runs somewhat
16550 faster on processors with 32-bit busses at the expense of more memory.
16552 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16553 aligns structures containing the above types differently than
16554 most published application binary interface specifications for the m68k.
16556 @item -mpcrel
16557 @opindex mpcrel
16558 Use the pc-relative addressing mode of the 68000 directly, instead of
16559 using a global offset table.  At present, this option implies @option{-fpic},
16560 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16561 not presently supported with @option{-mpcrel}, though this could be supported for
16562 68020 and higher processors.
16564 @item -mno-strict-align
16565 @itemx -mstrict-align
16566 @opindex mno-strict-align
16567 @opindex mstrict-align
16568 Do not (do) assume that unaligned memory references are handled by
16569 the system.
16571 @item -msep-data
16572 Generate code that allows the data segment to be located in a different
16573 area of memory from the text segment.  This allows for execute-in-place in
16574 an environment without virtual memory management.  This option implies
16575 @option{-fPIC}.
16577 @item -mno-sep-data
16578 Generate code that assumes that the data segment follows the text segment.
16579 This is the default.
16581 @item -mid-shared-library
16582 Generate code that supports shared libraries via the library ID method.
16583 This allows for execute-in-place and shared libraries in an environment
16584 without virtual memory management.  This option implies @option{-fPIC}.
16586 @item -mno-id-shared-library
16587 Generate code that doesn't assume ID-based shared libraries are being used.
16588 This is the default.
16590 @item -mshared-library-id=n
16591 Specifies the identification number of the ID-based shared library being
16592 compiled.  Specifying a value of 0 generates more compact code; specifying
16593 other values forces the allocation of that number to the current
16594 library, but is no more space- or time-efficient than omitting this option.
16596 @item -mxgot
16597 @itemx -mno-xgot
16598 @opindex mxgot
16599 @opindex mno-xgot
16600 When generating position-independent code for ColdFire, generate code
16601 that works if the GOT has more than 8192 entries.  This code is
16602 larger and slower than code generated without this option.  On M680x0
16603 processors, this option is not needed; @option{-fPIC} suffices.
16605 GCC normally uses a single instruction to load values from the GOT@.
16606 While this is relatively efficient, it only works if the GOT
16607 is smaller than about 64k.  Anything larger causes the linker
16608 to report an error such as:
16610 @cindex relocation truncated to fit (ColdFire)
16611 @smallexample
16612 relocation truncated to fit: R_68K_GOT16O foobar
16613 @end smallexample
16615 If this happens, you should recompile your code with @option{-mxgot}.
16616 It should then work with very large GOTs.  However, code generated with
16617 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16618 the value of a global symbol.
16620 Note that some linkers, including newer versions of the GNU linker,
16621 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16622 you should only need to use @option{-mxgot} when compiling a single
16623 object file that accesses more than 8192 GOT entries.  Very few do.
16625 These options have no effect unless GCC is generating
16626 position-independent code.
16628 @end table
16630 @node MCore Options
16631 @subsection MCore Options
16632 @cindex MCore options
16634 These are the @samp{-m} options defined for the Motorola M*Core
16635 processors.
16637 @table @gcctabopt
16639 @item -mhardlit
16640 @itemx -mno-hardlit
16641 @opindex mhardlit
16642 @opindex mno-hardlit
16643 Inline constants into the code stream if it can be done in two
16644 instructions or less.
16646 @item -mdiv
16647 @itemx -mno-div
16648 @opindex mdiv
16649 @opindex mno-div
16650 Use the divide instruction.  (Enabled by default).
16652 @item -mrelax-immediate
16653 @itemx -mno-relax-immediate
16654 @opindex mrelax-immediate
16655 @opindex mno-relax-immediate
16656 Allow arbitrary-sized immediates in bit operations.
16658 @item -mwide-bitfields
16659 @itemx -mno-wide-bitfields
16660 @opindex mwide-bitfields
16661 @opindex mno-wide-bitfields
16662 Always treat bit-fields as @code{int}-sized.
16664 @item -m4byte-functions
16665 @itemx -mno-4byte-functions
16666 @opindex m4byte-functions
16667 @opindex mno-4byte-functions
16668 Force all functions to be aligned to a 4-byte boundary.
16670 @item -mcallgraph-data
16671 @itemx -mno-callgraph-data
16672 @opindex mcallgraph-data
16673 @opindex mno-callgraph-data
16674 Emit callgraph information.
16676 @item -mslow-bytes
16677 @itemx -mno-slow-bytes
16678 @opindex mslow-bytes
16679 @opindex mno-slow-bytes
16680 Prefer word access when reading byte quantities.
16682 @item -mlittle-endian
16683 @itemx -mbig-endian
16684 @opindex mlittle-endian
16685 @opindex mbig-endian
16686 Generate code for a little-endian target.
16688 @item -m210
16689 @itemx -m340
16690 @opindex m210
16691 @opindex m340
16692 Generate code for the 210 processor.
16694 @item -mno-lsim
16695 @opindex mno-lsim
16696 Assume that runtime support has been provided and so omit the
16697 simulator library (@file{libsim.a)} from the linker command line.
16699 @item -mstack-increment=@var{size}
16700 @opindex mstack-increment
16701 Set the maximum amount for a single stack increment operation.  Large
16702 values can increase the speed of programs that contain functions
16703 that need a large amount of stack space, but they can also trigger a
16704 segmentation fault if the stack is extended too much.  The default
16705 value is 0x1000.
16707 @end table
16709 @node MeP Options
16710 @subsection MeP Options
16711 @cindex MeP options
16713 @table @gcctabopt
16715 @item -mabsdiff
16716 @opindex mabsdiff
16717 Enables the @code{abs} instruction, which is the absolute difference
16718 between two registers.
16720 @item -mall-opts
16721 @opindex mall-opts
16722 Enables all the optional instructions---average, multiply, divide, bit
16723 operations, leading zero, absolute difference, min/max, clip, and
16724 saturation.
16727 @item -maverage
16728 @opindex maverage
16729 Enables the @code{ave} instruction, which computes the average of two
16730 registers.
16732 @item -mbased=@var{n}
16733 @opindex mbased=
16734 Variables of size @var{n} bytes or smaller are placed in the
16735 @code{.based} section by default.  Based variables use the @code{$tp}
16736 register as a base register, and there is a 128-byte limit to the
16737 @code{.based} section.
16739 @item -mbitops
16740 @opindex mbitops
16741 Enables the bit operation instructions---bit test (@code{btstm}), set
16742 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16743 test-and-set (@code{tas}).
16745 @item -mc=@var{name}
16746 @opindex mc=
16747 Selects which section constant data is placed in.  @var{name} may
16748 be @samp{tiny}, @samp{near}, or @samp{far}.
16750 @item -mclip
16751 @opindex mclip
16752 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
16753 useful unless you also provide @option{-mminmax}.
16755 @item -mconfig=@var{name}
16756 @opindex mconfig=
16757 Selects one of the built-in core configurations.  Each MeP chip has
16758 one or more modules in it; each module has a core CPU and a variety of
16759 coprocessors, optional instructions, and peripherals.  The
16760 @code{MeP-Integrator} tool, not part of GCC, provides these
16761 configurations through this option; using this option is the same as
16762 using all the corresponding command-line options.  The default
16763 configuration is @samp{default}.
16765 @item -mcop
16766 @opindex mcop
16767 Enables the coprocessor instructions.  By default, this is a 32-bit
16768 coprocessor.  Note that the coprocessor is normally enabled via the
16769 @option{-mconfig=} option.
16771 @item -mcop32
16772 @opindex mcop32
16773 Enables the 32-bit coprocessor's instructions.
16775 @item -mcop64
16776 @opindex mcop64
16777 Enables the 64-bit coprocessor's instructions.
16779 @item -mivc2
16780 @opindex mivc2
16781 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16783 @item -mdc
16784 @opindex mdc
16785 Causes constant variables to be placed in the @code{.near} section.
16787 @item -mdiv
16788 @opindex mdiv
16789 Enables the @code{div} and @code{divu} instructions.
16791 @item -meb
16792 @opindex meb
16793 Generate big-endian code.
16795 @item -mel
16796 @opindex mel
16797 Generate little-endian code.
16799 @item -mio-volatile
16800 @opindex mio-volatile
16801 Tells the compiler that any variable marked with the @code{io}
16802 attribute is to be considered volatile.
16804 @item -ml
16805 @opindex ml
16806 Causes variables to be assigned to the @code{.far} section by default.
16808 @item -mleadz
16809 @opindex mleadz
16810 Enables the @code{leadz} (leading zero) instruction.
16812 @item -mm
16813 @opindex mm
16814 Causes variables to be assigned to the @code{.near} section by default.
16816 @item -mminmax
16817 @opindex mminmax
16818 Enables the @code{min} and @code{max} instructions.
16820 @item -mmult
16821 @opindex mmult
16822 Enables the multiplication and multiply-accumulate instructions.
16824 @item -mno-opts
16825 @opindex mno-opts
16826 Disables all the optional instructions enabled by @option{-mall-opts}.
16828 @item -mrepeat
16829 @opindex mrepeat
16830 Enables the @code{repeat} and @code{erepeat} instructions, used for
16831 low-overhead looping.
16833 @item -ms
16834 @opindex ms
16835 Causes all variables to default to the @code{.tiny} section.  Note
16836 that there is a 65536-byte limit to this section.  Accesses to these
16837 variables use the @code{%gp} base register.
16839 @item -msatur
16840 @opindex msatur
16841 Enables the saturation instructions.  Note that the compiler does not
16842 currently generate these itself, but this option is included for
16843 compatibility with other tools, like @code{as}.
16845 @item -msdram
16846 @opindex msdram
16847 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16849 @item -msim
16850 @opindex msim
16851 Link the simulator run-time libraries.
16853 @item -msimnovec
16854 @opindex msimnovec
16855 Link the simulator runtime libraries, excluding built-in support
16856 for reset and exception vectors and tables.
16858 @item -mtf
16859 @opindex mtf
16860 Causes all functions to default to the @code{.far} section.  Without
16861 this option, functions default to the @code{.near} section.
16863 @item -mtiny=@var{n}
16864 @opindex mtiny=
16865 Variables that are @var{n} bytes or smaller are allocated to the
16866 @code{.tiny} section.  These variables use the @code{$gp} base
16867 register.  The default for this option is 4, but note that there's a
16868 65536-byte limit to the @code{.tiny} section.
16870 @end table
16872 @node MicroBlaze Options
16873 @subsection MicroBlaze Options
16874 @cindex MicroBlaze Options
16876 @table @gcctabopt
16878 @item -msoft-float
16879 @opindex msoft-float
16880 Use software emulation for floating point (default).
16882 @item -mhard-float
16883 @opindex mhard-float
16884 Use hardware floating-point instructions.
16886 @item -mmemcpy
16887 @opindex mmemcpy
16888 Do not optimize block moves, use @code{memcpy}.
16890 @item -mno-clearbss
16891 @opindex mno-clearbss
16892 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
16894 @item -mcpu=@var{cpu-type}
16895 @opindex mcpu=
16896 Use features of, and schedule code for, the given CPU.
16897 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
16898 where @var{X} is a major version, @var{YY} is the minor version, and
16899 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
16900 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
16902 @item -mxl-soft-mul
16903 @opindex mxl-soft-mul
16904 Use software multiply emulation (default).
16906 @item -mxl-soft-div
16907 @opindex mxl-soft-div
16908 Use software emulation for divides (default).
16910 @item -mxl-barrel-shift
16911 @opindex mxl-barrel-shift
16912 Use the hardware barrel shifter.
16914 @item -mxl-pattern-compare
16915 @opindex mxl-pattern-compare
16916 Use pattern compare instructions.
16918 @item -msmall-divides
16919 @opindex msmall-divides
16920 Use table lookup optimization for small signed integer divisions.
16922 @item -mxl-stack-check
16923 @opindex mxl-stack-check
16924 This option is deprecated.  Use @option{-fstack-check} instead.
16926 @item -mxl-gp-opt
16927 @opindex mxl-gp-opt
16928 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16930 @item -mxl-multiply-high
16931 @opindex mxl-multiply-high
16932 Use multiply high instructions for high part of 32x32 multiply.
16934 @item -mxl-float-convert
16935 @opindex mxl-float-convert
16936 Use hardware floating-point conversion instructions.
16938 @item -mxl-float-sqrt
16939 @opindex mxl-float-sqrt
16940 Use hardware floating-point square root instruction.
16942 @item -mbig-endian
16943 @opindex mbig-endian
16944 Generate code for a big-endian target.
16946 @item -mlittle-endian
16947 @opindex mlittle-endian
16948 Generate code for a little-endian target.
16950 @item -mxl-reorder
16951 @opindex mxl-reorder
16952 Use reorder instructions (swap and byte reversed load/store).
16954 @item -mxl-mode-@var{app-model}
16955 Select application model @var{app-model}.  Valid models are
16956 @table @samp
16957 @item executable
16958 normal executable (default), uses startup code @file{crt0.o}.
16960 @item xmdstub
16961 for use with Xilinx Microprocessor Debugger (XMD) based
16962 software intrusive debug agent called xmdstub. This uses startup file
16963 @file{crt1.o} and sets the start address of the program to 0x800.
16965 @item bootstrap
16966 for applications that are loaded using a bootloader.
16967 This model uses startup file @file{crt2.o} which does not contain a processor
16968 reset vector handler. This is suitable for transferring control on a
16969 processor reset to the bootloader rather than the application.
16971 @item novectors
16972 for applications that do not require any of the
16973 MicroBlaze vectors. This option may be useful for applications running
16974 within a monitoring application. This model uses @file{crt3.o} as a startup file.
16975 @end table
16977 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
16978 @option{-mxl-mode-@var{app-model}}.
16980 @end table
16982 @node MIPS Options
16983 @subsection MIPS Options
16984 @cindex MIPS options
16986 @table @gcctabopt
16988 @item -EB
16989 @opindex EB
16990 Generate big-endian code.
16992 @item -EL
16993 @opindex EL
16994 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
16995 configurations.
16997 @item -march=@var{arch}
16998 @opindex march
16999 Generate code that runs on @var{arch}, which can be the name of a
17000 generic MIPS ISA, or the name of a particular processor.
17001 The ISA names are:
17002 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17003 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17004 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17005 @samp{mips64r5} and @samp{mips64r6}.
17006 The processor names are:
17007 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17008 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17009 @samp{5kc}, @samp{5kf},
17010 @samp{20kc},
17011 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17012 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17013 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17014 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17015 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17016 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17017 @samp{m4k},
17018 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17019 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17020 @samp{orion},
17021 @samp{p5600},
17022 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17023 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17024 @samp{rm7000}, @samp{rm9000},
17025 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17026 @samp{sb1},
17027 @samp{sr71000},
17028 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17029 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17030 @samp{xlr} and @samp{xlp}.
17031 The special value @samp{from-abi} selects the
17032 most compatible architecture for the selected ABI (that is,
17033 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17035 The native Linux/GNU toolchain also supports the value @samp{native},
17036 which selects the best architecture option for the host processor.
17037 @option{-march=native} has no effect if GCC does not recognize
17038 the processor.
17040 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17041 (for example, @option{-march=r2k}).  Prefixes are optional, and
17042 @samp{vr} may be written @samp{r}.
17044 Names of the form @samp{@var{n}f2_1} refer to processors with
17045 FPUs clocked at half the rate of the core, names of the form
17046 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17047 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17048 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17049 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17050 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17051 accepted as synonyms for @samp{@var{n}f1_1}.
17053 GCC defines two macros based on the value of this option.  The first
17054 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
17055 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
17056 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
17057 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
17058 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
17060 Note that the @code{_MIPS_ARCH} macro uses the processor names given
17061 above.  In other words, it has the full prefix and does not
17062 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17063 the macro names the resolved architecture (either @code{"mips1"} or
17064 @code{"mips3"}).  It names the default architecture when no
17065 @option{-march} option is given.
17067 @item -mtune=@var{arch}
17068 @opindex mtune
17069 Optimize for @var{arch}.  Among other things, this option controls
17070 the way instructions are scheduled, and the perceived cost of arithmetic
17071 operations.  The list of @var{arch} values is the same as for
17072 @option{-march}.
17074 When this option is not used, GCC optimizes for the processor
17075 specified by @option{-march}.  By using @option{-march} and
17076 @option{-mtune} together, it is possible to generate code that
17077 runs on a family of processors, but optimize the code for one
17078 particular member of that family.
17080 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
17081 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17082 @option{-march} ones described above.
17084 @item -mips1
17085 @opindex mips1
17086 Equivalent to @option{-march=mips1}.
17088 @item -mips2
17089 @opindex mips2
17090 Equivalent to @option{-march=mips2}.
17092 @item -mips3
17093 @opindex mips3
17094 Equivalent to @option{-march=mips3}.
17096 @item -mips4
17097 @opindex mips4
17098 Equivalent to @option{-march=mips4}.
17100 @item -mips32
17101 @opindex mips32
17102 Equivalent to @option{-march=mips32}.
17104 @item -mips32r3
17105 @opindex mips32r3
17106 Equivalent to @option{-march=mips32r3}.
17108 @item -mips32r5
17109 @opindex mips32r5
17110 Equivalent to @option{-march=mips32r5}.
17112 @item -mips32r6
17113 @opindex mips32r6
17114 Equivalent to @option{-march=mips32r6}.
17116 @item -mips64
17117 @opindex mips64
17118 Equivalent to @option{-march=mips64}.
17120 @item -mips64r2
17121 @opindex mips64r2
17122 Equivalent to @option{-march=mips64r2}.
17124 @item -mips64r3
17125 @opindex mips64r3
17126 Equivalent to @option{-march=mips64r3}.
17128 @item -mips64r5
17129 @opindex mips64r5
17130 Equivalent to @option{-march=mips64r5}.
17132 @item -mips64r6
17133 @opindex mips64r6
17134 Equivalent to @option{-march=mips64r6}.
17136 @item -mips16
17137 @itemx -mno-mips16
17138 @opindex mips16
17139 @opindex mno-mips16
17140 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17141 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17143 MIPS16 code generation can also be controlled on a per-function basis
17144 by means of @code{mips16} and @code{nomips16} attributes.
17145 @xref{Function Attributes}, for more information.
17147 @item -mflip-mips16
17148 @opindex mflip-mips16
17149 Generate MIPS16 code on alternating functions.  This option is provided
17150 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17151 not intended for ordinary use in compiling user code.
17153 @item -minterlink-compressed
17154 @item -mno-interlink-compressed
17155 @opindex minterlink-compressed
17156 @opindex mno-interlink-compressed
17157 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17158 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17160 For example, code using the standard ISA encoding cannot jump directly
17161 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17162 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17163 knows that the target of the jump is not compressed.
17165 @item -minterlink-mips16
17166 @itemx -mno-interlink-mips16
17167 @opindex minterlink-mips16
17168 @opindex mno-interlink-mips16
17169 Aliases of @option{-minterlink-compressed} and
17170 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17171 and are retained for backwards compatibility.
17173 @item -mabi=32
17174 @itemx -mabi=o64
17175 @itemx -mabi=n32
17176 @itemx -mabi=64
17177 @itemx -mabi=eabi
17178 @opindex mabi=32
17179 @opindex mabi=o64
17180 @opindex mabi=n32
17181 @opindex mabi=64
17182 @opindex mabi=eabi
17183 Generate code for the given ABI@.
17185 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17186 generates 64-bit code when you select a 64-bit architecture, but you
17187 can use @option{-mgp32} to get 32-bit code instead.
17189 For information about the O64 ABI, see
17190 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17192 GCC supports a variant of the o32 ABI in which floating-point registers
17193 are 64 rather than 32 bits wide.  You can select this combination with
17194 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17195 and @code{mfhc1} instructions and is therefore only supported for
17196 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17198 The register assignments for arguments and return values remain the
17199 same, but each scalar value is passed in a single 64-bit register
17200 rather than a pair of 32-bit registers.  For example, scalar
17201 floating-point values are returned in @samp{$f0} only, not a
17202 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17203 remains the same in that the even-numbered double-precision registers
17204 are saved.
17206 Two additional variants of the o32 ABI are supported to enable
17207 a transition from 32-bit to 64-bit registers.  These are FPXX
17208 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17209 The FPXX extension mandates that all code must execute correctly
17210 when run using 32-bit or 64-bit registers.  The code can be interlinked
17211 with either FP32 or FP64, but not both.
17212 The FP64A extension is similar to the FP64 extension but forbids the
17213 use of odd-numbered single-precision registers.  This can be used
17214 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17215 processors and allows both FP32 and FP64A code to interlink and
17216 run in the same process without changing FPU modes.
17218 @item -mabicalls
17219 @itemx -mno-abicalls
17220 @opindex mabicalls
17221 @opindex mno-abicalls
17222 Generate (do not generate) code that is suitable for SVR4-style
17223 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17224 systems.
17226 @item -mshared
17227 @itemx -mno-shared
17228 Generate (do not generate) code that is fully position-independent,
17229 and that can therefore be linked into shared libraries.  This option
17230 only affects @option{-mabicalls}.
17232 All @option{-mabicalls} code has traditionally been position-independent,
17233 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17234 as an extension, the GNU toolchain allows executables to use absolute
17235 accesses for locally-binding symbols.  It can also use shorter GP
17236 initialization sequences and generate direct calls to locally-defined
17237 functions.  This mode is selected by @option{-mno-shared}.
17239 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17240 objects that can only be linked by the GNU linker.  However, the option
17241 does not affect the ABI of the final executable; it only affects the ABI
17242 of relocatable objects.  Using @option{-mno-shared} generally makes
17243 executables both smaller and quicker.
17245 @option{-mshared} is the default.
17247 @item -mplt
17248 @itemx -mno-plt
17249 @opindex mplt
17250 @opindex mno-plt
17251 Assume (do not assume) that the static and dynamic linkers
17252 support PLTs and copy relocations.  This option only affects
17253 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17254 has no effect without @option{-msym32}.
17256 You can make @option{-mplt} the default by configuring
17257 GCC with @option{--with-mips-plt}.  The default is
17258 @option{-mno-plt} otherwise.
17260 @item -mxgot
17261 @itemx -mno-xgot
17262 @opindex mxgot
17263 @opindex mno-xgot
17264 Lift (do not lift) the usual restrictions on the size of the global
17265 offset table.
17267 GCC normally uses a single instruction to load values from the GOT@.
17268 While this is relatively efficient, it only works if the GOT
17269 is smaller than about 64k.  Anything larger causes the linker
17270 to report an error such as:
17272 @cindex relocation truncated to fit (MIPS)
17273 @smallexample
17274 relocation truncated to fit: R_MIPS_GOT16 foobar
17275 @end smallexample
17277 If this happens, you should recompile your code with @option{-mxgot}.
17278 This works with very large GOTs, although the code is also
17279 less efficient, since it takes three instructions to fetch the
17280 value of a global symbol.
17282 Note that some linkers can create multiple GOTs.  If you have such a
17283 linker, you should only need to use @option{-mxgot} when a single object
17284 file accesses more than 64k's worth of GOT entries.  Very few do.
17286 These options have no effect unless GCC is generating position
17287 independent code.
17289 @item -mgp32
17290 @opindex mgp32
17291 Assume that general-purpose registers are 32 bits wide.
17293 @item -mgp64
17294 @opindex mgp64
17295 Assume that general-purpose registers are 64 bits wide.
17297 @item -mfp32
17298 @opindex mfp32
17299 Assume that floating-point registers are 32 bits wide.
17301 @item -mfp64
17302 @opindex mfp64
17303 Assume that floating-point registers are 64 bits wide.
17305 @item -mfpxx
17306 @opindex mfpxx
17307 Do not assume the width of floating-point registers.
17309 @item -mhard-float
17310 @opindex mhard-float
17311 Use floating-point coprocessor instructions.
17313 @item -msoft-float
17314 @opindex msoft-float
17315 Do not use floating-point coprocessor instructions.  Implement
17316 floating-point calculations using library calls instead.
17318 @item -mno-float
17319 @opindex mno-float
17320 Equivalent to @option{-msoft-float}, but additionally asserts that the
17321 program being compiled does not perform any floating-point operations.
17322 This option is presently supported only by some bare-metal MIPS
17323 configurations, where it may select a special set of libraries
17324 that lack all floating-point support (including, for example, the
17325 floating-point @code{printf} formats).  
17326 If code compiled with @option{-mno-float} accidentally contains
17327 floating-point operations, it is likely to suffer a link-time
17328 or run-time failure.
17330 @item -msingle-float
17331 @opindex msingle-float
17332 Assume that the floating-point coprocessor only supports single-precision
17333 operations.
17335 @item -mdouble-float
17336 @opindex mdouble-float
17337 Assume that the floating-point coprocessor supports double-precision
17338 operations.  This is the default.
17340 @item -modd-spreg
17341 @itemx -mno-odd-spreg
17342 @opindex modd-spreg
17343 @opindex mno-odd-spreg
17344 Enable the use of odd-numbered single-precision floating-point registers
17345 for the o32 ABI.  This is the default for processors that are known to
17346 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
17347 is set by default.
17349 @item -mabs=2008
17350 @itemx -mabs=legacy
17351 @opindex mabs=2008
17352 @opindex mabs=legacy
17353 These options control the treatment of the special not-a-number (NaN)
17354 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17355 @code{neg.@i{fmt}} machine instructions.
17357 By default or when @option{-mabs=legacy} is used the legacy
17358 treatment is selected.  In this case these instructions are considered
17359 arithmetic and avoided where correct operation is required and the
17360 input operand might be a NaN.  A longer sequence of instructions that
17361 manipulate the sign bit of floating-point datum manually is used
17362 instead unless the @option{-ffinite-math-only} option has also been
17363 specified.
17365 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17366 this case these instructions are considered non-arithmetic and therefore
17367 operating correctly in all cases, including in particular where the
17368 input operand is a NaN.  These instructions are therefore always used
17369 for the respective operations.
17371 @item -mnan=2008
17372 @itemx -mnan=legacy
17373 @opindex mnan=2008
17374 @opindex mnan=legacy
17375 These options control the encoding of the special not-a-number (NaN)
17376 IEEE 754 floating-point data.
17378 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17379 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17380 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17381 by the first bit of their trailing significand field being 1.
17383 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17384 this case qNaNs are denoted by the first bit of their trailing
17385 significand field being 1, whereas sNaNs are denoted by the first bit of
17386 their trailing significand field being 0.
17388 The default is @option{-mnan=legacy} unless GCC has been configured with
17389 @option{--with-nan=2008}.
17391 @item -mllsc
17392 @itemx -mno-llsc
17393 @opindex mllsc
17394 @opindex mno-llsc
17395 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17396 implement atomic memory built-in functions.  When neither option is
17397 specified, GCC uses the instructions if the target architecture
17398 supports them.
17400 @option{-mllsc} is useful if the runtime environment can emulate the
17401 instructions and @option{-mno-llsc} can be useful when compiling for
17402 nonstandard ISAs.  You can make either option the default by
17403 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17404 respectively.  @option{--with-llsc} is the default for some
17405 configurations; see the installation documentation for details.
17407 @item -mdsp
17408 @itemx -mno-dsp
17409 @opindex mdsp
17410 @opindex mno-dsp
17411 Use (do not use) revision 1 of the MIPS DSP ASE@.
17412 @xref{MIPS DSP Built-in Functions}.  This option defines the
17413 preprocessor macro @code{__mips_dsp}.  It also defines
17414 @code{__mips_dsp_rev} to 1.
17416 @item -mdspr2
17417 @itemx -mno-dspr2
17418 @opindex mdspr2
17419 @opindex mno-dspr2
17420 Use (do not use) revision 2 of the MIPS DSP ASE@.
17421 @xref{MIPS DSP Built-in Functions}.  This option defines the
17422 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
17423 It also defines @code{__mips_dsp_rev} to 2.
17425 @item -msmartmips
17426 @itemx -mno-smartmips
17427 @opindex msmartmips
17428 @opindex mno-smartmips
17429 Use (do not use) the MIPS SmartMIPS ASE.
17431 @item -mpaired-single
17432 @itemx -mno-paired-single
17433 @opindex mpaired-single
17434 @opindex mno-paired-single
17435 Use (do not use) paired-single floating-point instructions.
17436 @xref{MIPS Paired-Single Support}.  This option requires
17437 hardware floating-point support to be enabled.
17439 @item -mdmx
17440 @itemx -mno-mdmx
17441 @opindex mdmx
17442 @opindex mno-mdmx
17443 Use (do not use) MIPS Digital Media Extension instructions.
17444 This option can only be used when generating 64-bit code and requires
17445 hardware floating-point support to be enabled.
17447 @item -mips3d
17448 @itemx -mno-mips3d
17449 @opindex mips3d
17450 @opindex mno-mips3d
17451 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17452 The option @option{-mips3d} implies @option{-mpaired-single}.
17454 @item -mmicromips
17455 @itemx -mno-micromips
17456 @opindex mmicromips
17457 @opindex mno-mmicromips
17458 Generate (do not generate) microMIPS code.
17460 MicroMIPS code generation can also be controlled on a per-function basis
17461 by means of @code{micromips} and @code{nomicromips} attributes.
17462 @xref{Function Attributes}, for more information.
17464 @item -mmt
17465 @itemx -mno-mt
17466 @opindex mmt
17467 @opindex mno-mt
17468 Use (do not use) MT Multithreading instructions.
17470 @item -mmcu
17471 @itemx -mno-mcu
17472 @opindex mmcu
17473 @opindex mno-mcu
17474 Use (do not use) the MIPS MCU ASE instructions.
17476 @item -meva
17477 @itemx -mno-eva
17478 @opindex meva
17479 @opindex mno-eva
17480 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17482 @item -mvirt
17483 @itemx -mno-virt
17484 @opindex mvirt
17485 @opindex mno-virt
17486 Use (do not use) the MIPS Virtualization Application Specific instructions.
17488 @item -mxpa
17489 @itemx -mno-xpa
17490 @opindex mxpa
17491 @opindex mno-xpa
17492 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17494 @item -mlong64
17495 @opindex mlong64
17496 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17497 an explanation of the default and the way that the pointer size is
17498 determined.
17500 @item -mlong32
17501 @opindex mlong32
17502 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17504 The default size of @code{int}s, @code{long}s and pointers depends on
17505 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17506 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17507 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17508 or the same size as integer registers, whichever is smaller.
17510 @item -msym32
17511 @itemx -mno-sym32
17512 @opindex msym32
17513 @opindex mno-sym32
17514 Assume (do not assume) that all symbols have 32-bit values, regardless
17515 of the selected ABI@.  This option is useful in combination with
17516 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17517 to generate shorter and faster references to symbolic addresses.
17519 @item -G @var{num}
17520 @opindex G
17521 Put definitions of externally-visible data in a small data section
17522 if that data is no bigger than @var{num} bytes.  GCC can then generate
17523 more efficient accesses to the data; see @option{-mgpopt} for details.
17525 The default @option{-G} option depends on the configuration.
17527 @item -mlocal-sdata
17528 @itemx -mno-local-sdata
17529 @opindex mlocal-sdata
17530 @opindex mno-local-sdata
17531 Extend (do not extend) the @option{-G} behavior to local data too,
17532 such as to static variables in C@.  @option{-mlocal-sdata} is the
17533 default for all configurations.
17535 If the linker complains that an application is using too much small data,
17536 you might want to try rebuilding the less performance-critical parts with
17537 @option{-mno-local-sdata}.  You might also want to build large
17538 libraries with @option{-mno-local-sdata}, so that the libraries leave
17539 more room for the main program.
17541 @item -mextern-sdata
17542 @itemx -mno-extern-sdata
17543 @opindex mextern-sdata
17544 @opindex mno-extern-sdata
17545 Assume (do not assume) that externally-defined data is in
17546 a small data section if the size of that data is within the @option{-G} limit.
17547 @option{-mextern-sdata} is the default for all configurations.
17549 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17550 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17551 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17552 is placed in a small data section.  If @var{Var} is defined by another
17553 module, you must either compile that module with a high-enough
17554 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17555 definition.  If @var{Var} is common, you must link the application
17556 with a high-enough @option{-G} setting.
17558 The easiest way of satisfying these restrictions is to compile
17559 and link every module with the same @option{-G} option.  However,
17560 you may wish to build a library that supports several different
17561 small data limits.  You can do this by compiling the library with
17562 the highest supported @option{-G} setting and additionally using
17563 @option{-mno-extern-sdata} to stop the library from making assumptions
17564 about externally-defined data.
17566 @item -mgpopt
17567 @itemx -mno-gpopt
17568 @opindex mgpopt
17569 @opindex mno-gpopt
17570 Use (do not use) GP-relative accesses for symbols that are known to be
17571 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17572 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17573 configurations.
17575 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17576 might not hold the value of @code{_gp}.  For example, if the code is
17577 part of a library that might be used in a boot monitor, programs that
17578 call boot monitor routines pass an unknown value in @code{$gp}.
17579 (In such situations, the boot monitor itself is usually compiled
17580 with @option{-G0}.)
17582 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17583 @option{-mno-extern-sdata}.
17585 @item -membedded-data
17586 @itemx -mno-embedded-data
17587 @opindex membedded-data
17588 @opindex mno-embedded-data
17589 Allocate variables to the read-only data section first if possible, then
17590 next in the small data section if possible, otherwise in data.  This gives
17591 slightly slower code than the default, but reduces the amount of RAM required
17592 when executing, and thus may be preferred for some embedded systems.
17594 @item -muninit-const-in-rodata
17595 @itemx -mno-uninit-const-in-rodata
17596 @opindex muninit-const-in-rodata
17597 @opindex mno-uninit-const-in-rodata
17598 Put uninitialized @code{const} variables in the read-only data section.
17599 This option is only meaningful in conjunction with @option{-membedded-data}.
17601 @item -mcode-readable=@var{setting}
17602 @opindex mcode-readable
17603 Specify whether GCC may generate code that reads from executable sections.
17604 There are three possible settings:
17606 @table @gcctabopt
17607 @item -mcode-readable=yes
17608 Instructions may freely access executable sections.  This is the
17609 default setting.
17611 @item -mcode-readable=pcrel
17612 MIPS16 PC-relative load instructions can access executable sections,
17613 but other instructions must not do so.  This option is useful on 4KSc
17614 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17615 It is also useful on processors that can be configured to have a dual
17616 instruction/data SRAM interface and that, like the M4K, automatically
17617 redirect PC-relative loads to the instruction RAM.
17619 @item -mcode-readable=no
17620 Instructions must not access executable sections.  This option can be
17621 useful on targets that are configured to have a dual instruction/data
17622 SRAM interface but that (unlike the M4K) do not automatically redirect
17623 PC-relative loads to the instruction RAM.
17624 @end table
17626 @item -msplit-addresses
17627 @itemx -mno-split-addresses
17628 @opindex msplit-addresses
17629 @opindex mno-split-addresses
17630 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17631 relocation operators.  This option has been superseded by
17632 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17634 @item -mexplicit-relocs
17635 @itemx -mno-explicit-relocs
17636 @opindex mexplicit-relocs
17637 @opindex mno-explicit-relocs
17638 Use (do not use) assembler relocation operators when dealing with symbolic
17639 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17640 is to use assembler macros instead.
17642 @option{-mexplicit-relocs} is the default if GCC was configured
17643 to use an assembler that supports relocation operators.
17645 @item -mcheck-zero-division
17646 @itemx -mno-check-zero-division
17647 @opindex mcheck-zero-division
17648 @opindex mno-check-zero-division
17649 Trap (do not trap) on integer division by zero.
17651 The default is @option{-mcheck-zero-division}.
17653 @item -mdivide-traps
17654 @itemx -mdivide-breaks
17655 @opindex mdivide-traps
17656 @opindex mdivide-breaks
17657 MIPS systems check for division by zero by generating either a
17658 conditional trap or a break instruction.  Using traps results in
17659 smaller code, but is only supported on MIPS II and later.  Also, some
17660 versions of the Linux kernel have a bug that prevents trap from
17661 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17662 allow conditional traps on architectures that support them and
17663 @option{-mdivide-breaks} to force the use of breaks.
17665 The default is usually @option{-mdivide-traps}, but this can be
17666 overridden at configure time using @option{--with-divide=breaks}.
17667 Divide-by-zero checks can be completely disabled using
17668 @option{-mno-check-zero-division}.
17670 @item -mmemcpy
17671 @itemx -mno-memcpy
17672 @opindex mmemcpy
17673 @opindex mno-memcpy
17674 Force (do not force) the use of @code{memcpy} for non-trivial block
17675 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17676 most constant-sized copies.
17678 @item -mlong-calls
17679 @itemx -mno-long-calls
17680 @opindex mlong-calls
17681 @opindex mno-long-calls
17682 Disable (do not disable) use of the @code{jal} instruction.  Calling
17683 functions using @code{jal} is more efficient but requires the caller
17684 and callee to be in the same 256 megabyte segment.
17686 This option has no effect on abicalls code.  The default is
17687 @option{-mno-long-calls}.
17689 @item -mmad
17690 @itemx -mno-mad
17691 @opindex mmad
17692 @opindex mno-mad
17693 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17694 instructions, as provided by the R4650 ISA@.
17696 @item -mimadd
17697 @itemx -mno-imadd
17698 @opindex mimadd
17699 @opindex mno-imadd
17700 Enable (disable) use of the @code{madd} and @code{msub} integer
17701 instructions.  The default is @option{-mimadd} on architectures
17702 that support @code{madd} and @code{msub} except for the 74k 
17703 architecture where it was found to generate slower code.
17705 @item -mfused-madd
17706 @itemx -mno-fused-madd
17707 @opindex mfused-madd
17708 @opindex mno-fused-madd
17709 Enable (disable) use of the floating-point multiply-accumulate
17710 instructions, when they are available.  The default is
17711 @option{-mfused-madd}.
17713 On the R8000 CPU when multiply-accumulate instructions are used,
17714 the intermediate product is calculated to infinite precision
17715 and is not subject to the FCSR Flush to Zero bit.  This may be
17716 undesirable in some circumstances.  On other processors the result
17717 is numerically identical to the equivalent computation using
17718 separate multiply, add, subtract and negate instructions.
17720 @item -nocpp
17721 @opindex nocpp
17722 Tell the MIPS assembler to not run its preprocessor over user
17723 assembler files (with a @samp{.s} suffix) when assembling them.
17725 @item -mfix-24k
17726 @item -mno-fix-24k
17727 @opindex mfix-24k
17728 @opindex mno-fix-24k
17729 Work around the 24K E48 (lost data on stores during refill) errata.
17730 The workarounds are implemented by the assembler rather than by GCC@.
17732 @item -mfix-r4000
17733 @itemx -mno-fix-r4000
17734 @opindex mfix-r4000
17735 @opindex mno-fix-r4000
17736 Work around certain R4000 CPU errata:
17737 @itemize @minus
17738 @item
17739 A double-word or a variable shift may give an incorrect result if executed
17740 immediately after starting an integer division.
17741 @item
17742 A double-word or a variable shift may give an incorrect result if executed
17743 while an integer multiplication is in progress.
17744 @item
17745 An integer division may give an incorrect result if started in a delay slot
17746 of a taken branch or a jump.
17747 @end itemize
17749 @item -mfix-r4400
17750 @itemx -mno-fix-r4400
17751 @opindex mfix-r4400
17752 @opindex mno-fix-r4400
17753 Work around certain R4400 CPU errata:
17754 @itemize @minus
17755 @item
17756 A double-word or a variable shift may give an incorrect result if executed
17757 immediately after starting an integer division.
17758 @end itemize
17760 @item -mfix-r10000
17761 @itemx -mno-fix-r10000
17762 @opindex mfix-r10000
17763 @opindex mno-fix-r10000
17764 Work around certain R10000 errata:
17765 @itemize @minus
17766 @item
17767 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17768 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17769 @end itemize
17771 This option can only be used if the target architecture supports
17772 branch-likely instructions.  @option{-mfix-r10000} is the default when
17773 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17774 otherwise.
17776 @item -mfix-rm7000
17777 @itemx -mno-fix-rm7000
17778 @opindex mfix-rm7000
17779 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17780 workarounds are implemented by the assembler rather than by GCC@.
17782 @item -mfix-vr4120
17783 @itemx -mno-fix-vr4120
17784 @opindex mfix-vr4120
17785 Work around certain VR4120 errata:
17786 @itemize @minus
17787 @item
17788 @code{dmultu} does not always produce the correct result.
17789 @item
17790 @code{div} and @code{ddiv} do not always produce the correct result if one
17791 of the operands is negative.
17792 @end itemize
17793 The workarounds for the division errata rely on special functions in
17794 @file{libgcc.a}.  At present, these functions are only provided by
17795 the @code{mips64vr*-elf} configurations.
17797 Other VR4120 errata require a NOP to be inserted between certain pairs of
17798 instructions.  These errata are handled by the assembler, not by GCC itself.
17800 @item -mfix-vr4130
17801 @opindex mfix-vr4130
17802 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17803 workarounds are implemented by the assembler rather than by GCC,
17804 although GCC avoids using @code{mflo} and @code{mfhi} if the
17805 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17806 instructions are available instead.
17808 @item -mfix-sb1
17809 @itemx -mno-fix-sb1
17810 @opindex mfix-sb1
17811 Work around certain SB-1 CPU core errata.
17812 (This flag currently works around the SB-1 revision 2
17813 ``F1'' and ``F2'' floating-point errata.)
17815 @item -mr10k-cache-barrier=@var{setting}
17816 @opindex mr10k-cache-barrier
17817 Specify whether GCC should insert cache barriers to avoid the
17818 side-effects of speculation on R10K processors.
17820 In common with many processors, the R10K tries to predict the outcome
17821 of a conditional branch and speculatively executes instructions from
17822 the ``taken'' branch.  It later aborts these instructions if the
17823 predicted outcome is wrong.  However, on the R10K, even aborted
17824 instructions can have side effects.
17826 This problem only affects kernel stores and, depending on the system,
17827 kernel loads.  As an example, a speculatively-executed store may load
17828 the target memory into cache and mark the cache line as dirty, even if
17829 the store itself is later aborted.  If a DMA operation writes to the
17830 same area of memory before the ``dirty'' line is flushed, the cached
17831 data overwrites the DMA-ed data.  See the R10K processor manual
17832 for a full description, including other potential problems.
17834 One workaround is to insert cache barrier instructions before every memory
17835 access that might be speculatively executed and that might have side
17836 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17837 controls GCC's implementation of this workaround.  It assumes that
17838 aborted accesses to any byte in the following regions does not have
17839 side effects:
17841 @enumerate
17842 @item
17843 the memory occupied by the current function's stack frame;
17845 @item
17846 the memory occupied by an incoming stack argument;
17848 @item
17849 the memory occupied by an object with a link-time-constant address.
17850 @end enumerate
17852 It is the kernel's responsibility to ensure that speculative
17853 accesses to these regions are indeed safe.
17855 If the input program contains a function declaration such as:
17857 @smallexample
17858 void foo (void);
17859 @end smallexample
17861 then the implementation of @code{foo} must allow @code{j foo} and
17862 @code{jal foo} to be executed speculatively.  GCC honors this
17863 restriction for functions it compiles itself.  It expects non-GCC
17864 functions (such as hand-written assembly code) to do the same.
17866 The option has three forms:
17868 @table @gcctabopt
17869 @item -mr10k-cache-barrier=load-store
17870 Insert a cache barrier before a load or store that might be
17871 speculatively executed and that might have side effects even
17872 if aborted.
17874 @item -mr10k-cache-barrier=store
17875 Insert a cache barrier before a store that might be speculatively
17876 executed and that might have side effects even if aborted.
17878 @item -mr10k-cache-barrier=none
17879 Disable the insertion of cache barriers.  This is the default setting.
17880 @end table
17882 @item -mflush-func=@var{func}
17883 @itemx -mno-flush-func
17884 @opindex mflush-func
17885 Specifies the function to call to flush the I and D caches, or to not
17886 call any such function.  If called, the function must take the same
17887 arguments as the common @code{_flush_func}, that is, the address of the
17888 memory range for which the cache is being flushed, the size of the
17889 memory range, and the number 3 (to flush both caches).  The default
17890 depends on the target GCC was configured for, but commonly is either
17891 @code{_flush_func} or @code{__cpu_flush}.
17893 @item mbranch-cost=@var{num}
17894 @opindex mbranch-cost
17895 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17896 This cost is only a heuristic and is not guaranteed to produce
17897 consistent results across releases.  A zero cost redundantly selects
17898 the default, which is based on the @option{-mtune} setting.
17900 @item -mbranch-likely
17901 @itemx -mno-branch-likely
17902 @opindex mbranch-likely
17903 @opindex mno-branch-likely
17904 Enable or disable use of Branch Likely instructions, regardless of the
17905 default for the selected architecture.  By default, Branch Likely
17906 instructions may be generated if they are supported by the selected
17907 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17908 and processors that implement those architectures; for those, Branch
17909 Likely instructions are not be generated by default because the MIPS32
17910 and MIPS64 architectures specifically deprecate their use.
17912 @item -mfp-exceptions
17913 @itemx -mno-fp-exceptions
17914 @opindex mfp-exceptions
17915 Specifies whether FP exceptions are enabled.  This affects how
17916 FP instructions are scheduled for some processors.
17917 The default is that FP exceptions are
17918 enabled.
17920 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17921 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17922 FP pipe.
17924 @item -mvr4130-align
17925 @itemx -mno-vr4130-align
17926 @opindex mvr4130-align
17927 The VR4130 pipeline is two-way superscalar, but can only issue two
17928 instructions together if the first one is 8-byte aligned.  When this
17929 option is enabled, GCC aligns pairs of instructions that it
17930 thinks should execute in parallel.
17932 This option only has an effect when optimizing for the VR4130.
17933 It normally makes code faster, but at the expense of making it bigger.
17934 It is enabled by default at optimization level @option{-O3}.
17936 @item -msynci
17937 @itemx -mno-synci
17938 @opindex msynci
17939 Enable (disable) generation of @code{synci} instructions on
17940 architectures that support it.  The @code{synci} instructions (if
17941 enabled) are generated when @code{__builtin___clear_cache} is
17942 compiled.
17944 This option defaults to @option{-mno-synci}, but the default can be
17945 overridden by configuring GCC with @option{--with-synci}.
17947 When compiling code for single processor systems, it is generally safe
17948 to use @code{synci}.  However, on many multi-core (SMP) systems, it
17949 does not invalidate the instruction caches on all cores and may lead
17950 to undefined behavior.
17952 @item -mrelax-pic-calls
17953 @itemx -mno-relax-pic-calls
17954 @opindex mrelax-pic-calls
17955 Try to turn PIC calls that are normally dispatched via register
17956 @code{$25} into direct calls.  This is only possible if the linker can
17957 resolve the destination at link-time and if the destination is within
17958 range for a direct call.
17960 @option{-mrelax-pic-calls} is the default if GCC was configured to use
17961 an assembler and a linker that support the @code{.reloc} assembly
17962 directive and @option{-mexplicit-relocs} is in effect.  With
17963 @option{-mno-explicit-relocs}, this optimization can be performed by the
17964 assembler and the linker alone without help from the compiler.
17966 @item -mmcount-ra-address
17967 @itemx -mno-mcount-ra-address
17968 @opindex mmcount-ra-address
17969 @opindex mno-mcount-ra-address
17970 Emit (do not emit) code that allows @code{_mcount} to modify the
17971 calling function's return address.  When enabled, this option extends
17972 the usual @code{_mcount} interface with a new @var{ra-address}
17973 parameter, which has type @code{intptr_t *} and is passed in register
17974 @code{$12}.  @code{_mcount} can then modify the return address by
17975 doing both of the following:
17976 @itemize
17977 @item
17978 Returning the new address in register @code{$31}.
17979 @item
17980 Storing the new address in @code{*@var{ra-address}},
17981 if @var{ra-address} is nonnull.
17982 @end itemize
17984 The default is @option{-mno-mcount-ra-address}.
17986 @end table
17988 @node MMIX Options
17989 @subsection MMIX Options
17990 @cindex MMIX Options
17992 These options are defined for the MMIX:
17994 @table @gcctabopt
17995 @item -mlibfuncs
17996 @itemx -mno-libfuncs
17997 @opindex mlibfuncs
17998 @opindex mno-libfuncs
17999 Specify that intrinsic library functions are being compiled, passing all
18000 values in registers, no matter the size.
18002 @item -mepsilon
18003 @itemx -mno-epsilon
18004 @opindex mepsilon
18005 @opindex mno-epsilon
18006 Generate floating-point comparison instructions that compare with respect
18007 to the @code{rE} epsilon register.
18009 @item -mabi=mmixware
18010 @itemx -mabi=gnu
18011 @opindex mabi=mmixware
18012 @opindex mabi=gnu
18013 Generate code that passes function parameters and return values that (in
18014 the called function) are seen as registers @code{$0} and up, as opposed to
18015 the GNU ABI which uses global registers @code{$231} and up.
18017 @item -mzero-extend
18018 @itemx -mno-zero-extend
18019 @opindex mzero-extend
18020 @opindex mno-zero-extend
18021 When reading data from memory in sizes shorter than 64 bits, use (do not
18022 use) zero-extending load instructions by default, rather than
18023 sign-extending ones.
18025 @item -mknuthdiv
18026 @itemx -mno-knuthdiv
18027 @opindex mknuthdiv
18028 @opindex mno-knuthdiv
18029 Make the result of a division yielding a remainder have the same sign as
18030 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18031 remainder follows the sign of the dividend.  Both methods are
18032 arithmetically valid, the latter being almost exclusively used.
18034 @item -mtoplevel-symbols
18035 @itemx -mno-toplevel-symbols
18036 @opindex mtoplevel-symbols
18037 @opindex mno-toplevel-symbols
18038 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18039 code can be used with the @code{PREFIX} assembly directive.
18041 @item -melf
18042 @opindex melf
18043 Generate an executable in the ELF format, rather than the default
18044 @samp{mmo} format used by the @command{mmix} simulator.
18046 @item -mbranch-predict
18047 @itemx -mno-branch-predict
18048 @opindex mbranch-predict
18049 @opindex mno-branch-predict
18050 Use (do not use) the probable-branch instructions, when static branch
18051 prediction indicates a probable branch.
18053 @item -mbase-addresses
18054 @itemx -mno-base-addresses
18055 @opindex mbase-addresses
18056 @opindex mno-base-addresses
18057 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18058 base address automatically generates a request (handled by the assembler
18059 and the linker) for a constant to be set up in a global register.  The
18060 register is used for one or more base address requests within the range 0
18061 to 255 from the value held in the register.  The generally leads to short
18062 and fast code, but the number of different data items that can be
18063 addressed is limited.  This means that a program that uses lots of static
18064 data may require @option{-mno-base-addresses}.
18066 @item -msingle-exit
18067 @itemx -mno-single-exit
18068 @opindex msingle-exit
18069 @opindex mno-single-exit
18070 Force (do not force) generated code to have a single exit point in each
18071 function.
18072 @end table
18074 @node MN10300 Options
18075 @subsection MN10300 Options
18076 @cindex MN10300 options
18078 These @option{-m} options are defined for Matsushita MN10300 architectures:
18080 @table @gcctabopt
18081 @item -mmult-bug
18082 @opindex mmult-bug
18083 Generate code to avoid bugs in the multiply instructions for the MN10300
18084 processors.  This is the default.
18086 @item -mno-mult-bug
18087 @opindex mno-mult-bug
18088 Do not generate code to avoid bugs in the multiply instructions for the
18089 MN10300 processors.
18091 @item -mam33
18092 @opindex mam33
18093 Generate code using features specific to the AM33 processor.
18095 @item -mno-am33
18096 @opindex mno-am33
18097 Do not generate code using features specific to the AM33 processor.  This
18098 is the default.
18100 @item -mam33-2
18101 @opindex mam33-2
18102 Generate code using features specific to the AM33/2.0 processor.
18104 @item -mam34
18105 @opindex mam34
18106 Generate code using features specific to the AM34 processor.
18108 @item -mtune=@var{cpu-type}
18109 @opindex mtune
18110 Use the timing characteristics of the indicated CPU type when
18111 scheduling instructions.  This does not change the targeted processor
18112 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18113 @samp{am33-2} or @samp{am34}.
18115 @item -mreturn-pointer-on-d0
18116 @opindex mreturn-pointer-on-d0
18117 When generating a function that returns a pointer, return the pointer
18118 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18119 only in @code{a0}, and attempts to call such functions without a prototype
18120 result in errors.  Note that this option is on by default; use
18121 @option{-mno-return-pointer-on-d0} to disable it.
18123 @item -mno-crt0
18124 @opindex mno-crt0
18125 Do not link in the C run-time initialization object file.
18127 @item -mrelax
18128 @opindex mrelax
18129 Indicate to the linker that it should perform a relaxation optimization pass
18130 to shorten branches, calls and absolute memory addresses.  This option only
18131 has an effect when used on the command line for the final link step.
18133 This option makes symbolic debugging impossible.
18135 @item -mliw
18136 @opindex mliw
18137 Allow the compiler to generate @emph{Long Instruction Word}
18138 instructions if the target is the @samp{AM33} or later.  This is the
18139 default.  This option defines the preprocessor macro @code{__LIW__}.
18141 @item -mnoliw
18142 @opindex mnoliw
18143 Do not allow the compiler to generate @emph{Long Instruction Word}
18144 instructions.  This option defines the preprocessor macro
18145 @code{__NO_LIW__}.
18147 @item -msetlb
18148 @opindex msetlb
18149 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18150 instructions if the target is the @samp{AM33} or later.  This is the
18151 default.  This option defines the preprocessor macro @code{__SETLB__}.
18153 @item -mnosetlb
18154 @opindex mnosetlb
18155 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18156 instructions.  This option defines the preprocessor macro
18157 @code{__NO_SETLB__}.
18159 @end table
18161 @node Moxie Options
18162 @subsection Moxie Options
18163 @cindex Moxie Options
18165 @table @gcctabopt
18167 @item -meb
18168 @opindex meb
18169 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18170 configurations.
18172 @item -mel
18173 @opindex mel
18174 Generate little-endian code.
18176 @item -mmul.x
18177 @opindex mmul.x
18178 Generate mul.x and umul.x instructions.  This is the default for
18179 @samp{moxiebox-*-*} configurations.
18181 @item -mno-crt0
18182 @opindex mno-crt0
18183 Do not link in the C run-time initialization object file.
18185 @end table
18187 @node MSP430 Options
18188 @subsection MSP430 Options
18189 @cindex MSP430 Options
18191 These options are defined for the MSP430:
18193 @table @gcctabopt
18195 @item -masm-hex
18196 @opindex masm-hex
18197 Force assembly output to always use hex constants.  Normally such
18198 constants are signed decimals, but this option is available for
18199 testsuite and/or aesthetic purposes.
18201 @item -mmcu=
18202 @opindex mmcu=
18203 Select the MCU to target.  This is used to create a C preprocessor
18204 symbol based upon the MCU name, converted to upper case and pre- and
18205 post-fixed with @samp{__}.  This in turn is used by the
18206 @file{msp430.h} header file to select an MCU-specific supplementary
18207 header file.
18209 The option also sets the ISA to use.  If the MCU name is one that is
18210 known to only support the 430 ISA then that is selected, otherwise the
18211 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
18212 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
18213 name selects the 430X ISA.
18215 In addition an MCU-specific linker script is added to the linker
18216 command line.  The script's name is the name of the MCU with
18217 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
18218 command line defines the C preprocessor symbol @code{__XXX__} and
18219 cause the linker to search for a script called @file{xxx.ld}.
18221 This option is also passed on to the assembler.
18223 @item -mcpu=
18224 @opindex mcpu=
18225 Specifies the ISA to use.  Accepted values are @samp{msp430},
18226 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
18227 @option{-mmcu=} option should be used to select the ISA.
18229 @item -msim
18230 @opindex msim
18231 Link to the simulator runtime libraries and linker script.  Overrides
18232 any scripts that would be selected by the @option{-mmcu=} option.
18234 @item -mlarge
18235 @opindex mlarge
18236 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18238 @item -msmall
18239 @opindex msmall
18240 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18242 @item -mrelax
18243 @opindex mrelax
18244 This option is passed to the assembler and linker, and allows the
18245 linker to perform certain optimizations that cannot be done until
18246 the final link.
18248 @item mhwmult=
18249 @opindex mhwmult=
18250 Describes the type of hardware multiply supported by the target.
18251 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
18252 for the original 16-bit-only multiply supported by early MCUs.
18253 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
18254 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18255 A value of @samp{auto} can also be given.  This tells GCC to deduce
18256 the hardware multiply support based upon the MCU name provided by the
18257 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18258 @samp{32bit} hardware multiply support is assumed.  @samp{auto} is the
18259 default setting.
18261 Hardware multiplies are normally performed by calling a library
18262 routine.  This saves space in the generated code.  When compiling at
18263 @option{-O3} or higher however the hardware multiplier is invoked
18264 inline.  This makes for bigger, but faster code.
18266 The hardware multiply routines disable interrupts whilst running and
18267 restore the previous interrupt state when they finish.  This makes
18268 them safe to use inside interrupt handlers as well as in normal code.
18270 @item -minrt
18271 @opindex minrt
18272 Enable the use of a minimum runtime environment - no static
18273 initializers or constructors.  This is intended for memory-constrained
18274 devices.  The compiler includes special symbols in some objects
18275 that tell the linker and runtime which code fragments are required.
18277 @item -mcode-region=
18278 @itemx -mdata-region=
18279 @opindex mcode-region
18280 @opindex mdata-region
18281 These options tell the compiler where to place functions and data that
18282 do not have one of the @code{lower}, @code{upper}, @code{either} or
18283 @code{section} attributes.  Possible values are @code{lower},
18284 @code{upper}, @code{either} or @code{any}.  The first three behave
18285 like the corresponding attribute.  The fourth possible value -
18286 @code{any} - is the default.  It leaves placement entirely up to the
18287 linker script and how it assigns the standard sections (.text, .data
18288 etc) to the memory regions.
18290 @end table
18292 @node NDS32 Options
18293 @subsection NDS32 Options
18294 @cindex NDS32 Options
18296 These options are defined for NDS32 implementations:
18298 @table @gcctabopt
18300 @item -mbig-endian
18301 @opindex mbig-endian
18302 Generate code in big-endian mode.
18304 @item -mlittle-endian
18305 @opindex mlittle-endian
18306 Generate code in little-endian mode.
18308 @item -mreduced-regs
18309 @opindex mreduced-regs
18310 Use reduced-set registers for register allocation.
18312 @item -mfull-regs
18313 @opindex mfull-regs
18314 Use full-set registers for register allocation.
18316 @item -mcmov
18317 @opindex mcmov
18318 Generate conditional move instructions.
18320 @item -mno-cmov
18321 @opindex mno-cmov
18322 Do not generate conditional move instructions.
18324 @item -mperf-ext
18325 @opindex mperf-ext
18326 Generate performance extension instructions.
18328 @item -mno-perf-ext
18329 @opindex mno-perf-ext
18330 Do not generate performance extension instructions.
18332 @item -mv3push
18333 @opindex mv3push
18334 Generate v3 push25/pop25 instructions.
18336 @item -mno-v3push
18337 @opindex mno-v3push
18338 Do not generate v3 push25/pop25 instructions.
18340 @item -m16-bit
18341 @opindex m16-bit
18342 Generate 16-bit instructions.
18344 @item -mno-16-bit
18345 @opindex mno-16-bit
18346 Do not generate 16-bit instructions.
18348 @item -misr-vector-size=@var{num}
18349 @opindex misr-vector-size
18350 Specify the size of each interrupt vector, which must be 4 or 16.
18352 @item -mcache-block-size=@var{num}
18353 @opindex mcache-block-size
18354 Specify the size of each cache block,
18355 which must be a power of 2 between 4 and 512.
18357 @item -march=@var{arch}
18358 @opindex march
18359 Specify the name of the target architecture.
18361 @item -mcmodel=@var{code-model}
18362 @opindex mcmodel
18363 Set the code model to one of
18364 @table @asis
18365 @item @samp{small}
18366 All the data and read-only data segments must be within 512KB addressing space.
18367 The text segment must be within 16MB addressing space.
18368 @item @samp{medium}
18369 The data segment must be within 512KB while the read-only data segment can be
18370 within 4GB addressing space.  The text segment should be still within 16MB
18371 addressing space.
18372 @item @samp{large}
18373 All the text and data segments can be within 4GB addressing space.
18374 @end table
18376 @item -mctor-dtor
18377 @opindex mctor-dtor
18378 Enable constructor/destructor feature.
18380 @item -mrelax
18381 @opindex mrelax
18382 Guide linker to relax instructions.
18384 @end table
18386 @node Nios II Options
18387 @subsection Nios II Options
18388 @cindex Nios II options
18389 @cindex Altera Nios II options
18391 These are the options defined for the Altera Nios II processor.
18393 @table @gcctabopt
18395 @item -G @var{num}
18396 @opindex G
18397 @cindex smaller data references
18398 Put global and static objects less than or equal to @var{num} bytes
18399 into the small data or BSS sections instead of the normal data or BSS
18400 sections.  The default value of @var{num} is 8.
18402 @item -mgpopt=@var{option}
18403 @item -mgpopt
18404 @itemx -mno-gpopt
18405 @opindex mgpopt
18406 @opindex mno-gpopt
18407 Generate (do not generate) GP-relative accesses.  The following 
18408 @var{option} names are recognized:
18410 @table @samp
18412 @item none
18413 Do not generate GP-relative accesses.
18415 @item local
18416 Generate GP-relative accesses for small data objects that are not 
18417 external or weak.  Also use GP-relative addressing for objects that
18418 have been explicitly placed in a small data section via a @code{section}
18419 attribute.
18421 @item global
18422 As for @samp{local}, but also generate GP-relative accesses for
18423 small data objects that are external or weak.  If you use this option,
18424 you must ensure that all parts of your program (including libraries) are
18425 compiled with the same @option{-G} setting.
18427 @item data
18428 Generate GP-relative accesses for all data objects in the program.  If you
18429 use this option, the entire data and BSS segments
18430 of your program must fit in 64K of memory and you must use an appropriate
18431 linker script to allocate them within the addressible range of the
18432 global pointer.
18434 @item all
18435 Generate GP-relative addresses for function pointers as well as data
18436 pointers.  If you use this option, the entire text, data, and BSS segments
18437 of your program must fit in 64K of memory and you must use an appropriate
18438 linker script to allocate them within the addressible range of the
18439 global pointer.
18441 @end table
18443 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
18444 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
18446 The default is @option{-mgpopt} except when @option{-fpic} or
18447 @option{-fPIC} is specified to generate position-independent code.
18448 Note that the Nios II ABI does not permit GP-relative accesses from
18449 shared libraries.
18451 You may need to specify @option{-mno-gpopt} explicitly when building
18452 programs that include large amounts of small data, including large
18453 GOT data sections.  In this case, the 16-bit offset for GP-relative
18454 addressing may not be large enough to allow access to the entire 
18455 small data section.
18457 @item -mel
18458 @itemx -meb
18459 @opindex mel
18460 @opindex meb
18461 Generate little-endian (default) or big-endian (experimental) code,
18462 respectively.
18464 @item -mbypass-cache
18465 @itemx -mno-bypass-cache
18466 @opindex mno-bypass-cache
18467 @opindex mbypass-cache
18468 Force all load and store instructions to always bypass cache by 
18469 using I/O variants of the instructions. The default is not to
18470 bypass the cache.
18472 @item -mno-cache-volatile 
18473 @itemx -mcache-volatile       
18474 @opindex mcache-volatile 
18475 @opindex mno-cache-volatile
18476 Volatile memory access bypass the cache using the I/O variants of 
18477 the load and store instructions. The default is not to bypass the cache.
18479 @item -mno-fast-sw-div
18480 @itemx -mfast-sw-div
18481 @opindex mno-fast-sw-div
18482 @opindex mfast-sw-div
18483 Do not use table-based fast divide for small numbers. The default 
18484 is to use the fast divide at @option{-O3} and above.
18486 @item -mno-hw-mul
18487 @itemx -mhw-mul
18488 @itemx -mno-hw-mulx
18489 @itemx -mhw-mulx
18490 @itemx -mno-hw-div
18491 @itemx -mhw-div
18492 @opindex mno-hw-mul
18493 @opindex mhw-mul
18494 @opindex mno-hw-mulx
18495 @opindex mhw-mulx
18496 @opindex mno-hw-div
18497 @opindex mhw-div
18498 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18499 instructions by the compiler. The default is to emit @code{mul}
18500 and not emit @code{div} and @code{mulx}.
18502 @item -mcustom-@var{insn}=@var{N}
18503 @itemx -mno-custom-@var{insn}
18504 @opindex mcustom-@var{insn}
18505 @opindex mno-custom-@var{insn}
18506 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18507 custom instruction with encoding @var{N} when generating code that uses 
18508 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
18509 instruction 253 for single-precision floating-point add operations instead
18510 of the default behavior of using a library call.
18512 The following values of @var{insn} are supported.  Except as otherwise
18513 noted, floating-point operations are expected to be implemented with
18514 normal IEEE 754 semantics and correspond directly to the C operators or the
18515 equivalent GCC built-in functions (@pxref{Other Builtins}).
18517 Single-precision floating point:
18518 @table @asis
18520 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18521 Binary arithmetic operations.
18523 @item @samp{fnegs}
18524 Unary negation.
18526 @item @samp{fabss}
18527 Unary absolute value.
18529 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18530 Comparison operations.
18532 @item @samp{fmins}, @samp{fmaxs}
18533 Floating-point minimum and maximum.  These instructions are only
18534 generated if @option{-ffinite-math-only} is specified.
18536 @item @samp{fsqrts}
18537 Unary square root operation.
18539 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18540 Floating-point trigonometric and exponential functions.  These instructions
18541 are only generated if @option{-funsafe-math-optimizations} is also specified.
18543 @end table
18545 Double-precision floating point:
18546 @table @asis
18548 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18549 Binary arithmetic operations.
18551 @item @samp{fnegd}
18552 Unary negation.
18554 @item @samp{fabsd}
18555 Unary absolute value.
18557 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18558 Comparison operations.
18560 @item @samp{fmind}, @samp{fmaxd}
18561 Double-precision minimum and maximum.  These instructions are only
18562 generated if @option{-ffinite-math-only} is specified.
18564 @item @samp{fsqrtd}
18565 Unary square root operation.
18567 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18568 Double-precision trigonometric and exponential functions.  These instructions
18569 are only generated if @option{-funsafe-math-optimizations} is also specified.
18571 @end table
18573 Conversions:
18574 @table @asis
18575 @item @samp{fextsd}
18576 Conversion from single precision to double precision.
18578 @item @samp{ftruncds}
18579 Conversion from double precision to single precision.
18581 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18582 Conversion from floating point to signed or unsigned integer types, with
18583 truncation towards zero.
18585 @item @samp{round}
18586 Conversion from single-precision floating point to signed integer,
18587 rounding to the nearest integer and ties away from zero.
18588 This corresponds to the @code{__builtin_lroundf} function when
18589 @option{-fno-math-errno} is used.
18591 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18592 Conversion from signed or unsigned integer types to floating-point types.
18594 @end table
18596 In addition, all of the following transfer instructions for internal
18597 registers X and Y must be provided to use any of the double-precision
18598 floating-point instructions.  Custom instructions taking two
18599 double-precision source operands expect the first operand in the
18600 64-bit register X.  The other operand (or only operand of a unary
18601 operation) is given to the custom arithmetic instruction with the
18602 least significant half in source register @var{src1} and the most
18603 significant half in @var{src2}.  A custom instruction that returns a
18604 double-precision result returns the most significant 32 bits in the
18605 destination register and the other half in 32-bit register Y.  
18606 GCC automatically generates the necessary code sequences to write
18607 register X and/or read register Y when double-precision floating-point
18608 instructions are used.
18610 @table @asis
18612 @item @samp{fwrx}
18613 Write @var{src1} into the least significant half of X and @var{src2} into
18614 the most significant half of X.
18616 @item @samp{fwry}
18617 Write @var{src1} into Y.
18619 @item @samp{frdxhi}, @samp{frdxlo}
18620 Read the most or least (respectively) significant half of X and store it in
18621 @var{dest}.
18623 @item @samp{frdy}
18624 Read the value of Y and store it into @var{dest}.
18625 @end table
18627 Note that you can gain more local control over generation of Nios II custom
18628 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18629 and @code{target("no-custom-@var{insn}")} function attributes
18630 (@pxref{Function Attributes})
18631 or pragmas (@pxref{Function Specific Option Pragmas}).
18633 @item -mcustom-fpu-cfg=@var{name}
18634 @opindex mcustom-fpu-cfg
18636 This option enables a predefined, named set of custom instruction encodings
18637 (see @option{-mcustom-@var{insn}} above).  
18638 Currently, the following sets are defined:
18640 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18641 @gccoptlist{-mcustom-fmuls=252 @gol
18642 -mcustom-fadds=253 @gol
18643 -mcustom-fsubs=254 @gol
18644 -fsingle-precision-constant}
18646 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18647 @gccoptlist{-mcustom-fmuls=252 @gol
18648 -mcustom-fadds=253 @gol
18649 -mcustom-fsubs=254 @gol
18650 -mcustom-fdivs=255 @gol
18651 -fsingle-precision-constant}
18653 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18654 @gccoptlist{-mcustom-floatus=243 @gol
18655 -mcustom-fixsi=244 @gol
18656 -mcustom-floatis=245 @gol
18657 -mcustom-fcmpgts=246 @gol
18658 -mcustom-fcmples=249 @gol
18659 -mcustom-fcmpeqs=250 @gol
18660 -mcustom-fcmpnes=251 @gol
18661 -mcustom-fmuls=252 @gol
18662 -mcustom-fadds=253 @gol
18663 -mcustom-fsubs=254 @gol
18664 -mcustom-fdivs=255 @gol
18665 -fsingle-precision-constant}
18667 Custom instruction assignments given by individual
18668 @option{-mcustom-@var{insn}=} options override those given by
18669 @option{-mcustom-fpu-cfg=}, regardless of the
18670 order of the options on the command line.
18672 Note that you can gain more local control over selection of a FPU
18673 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18674 function attribute (@pxref{Function Attributes})
18675 or pragma (@pxref{Function Specific Option Pragmas}).
18677 @end table
18679 These additional @samp{-m} options are available for the Altera Nios II
18680 ELF (bare-metal) target:
18682 @table @gcctabopt
18684 @item -mhal
18685 @opindex mhal
18686 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18687 startup and termination code, and is typically used in conjunction with
18688 @option{-msys-crt0=} to specify the location of the alternate startup code
18689 provided by the HAL BSP.
18691 @item -msmallc
18692 @opindex msmallc
18693 Link with a limited version of the C library, @option{-lsmallc}, rather than
18694 Newlib.
18696 @item -msys-crt0=@var{startfile}
18697 @opindex msys-crt0
18698 @var{startfile} is the file name of the startfile (crt0) to use 
18699 when linking.  This option is only useful in conjunction with @option{-mhal}.
18701 @item -msys-lib=@var{systemlib}
18702 @opindex msys-lib
18703 @var{systemlib} is the library name of the library that provides
18704 low-level system calls required by the C library,
18705 e.g. @code{read} and @code{write}.
18706 This option is typically used to link with a library provided by a HAL BSP.
18708 @end table
18710 @node Nvidia PTX Options
18711 @subsection Nvidia PTX Options
18712 @cindex Nvidia PTX options
18713 @cindex nvptx options
18715 These options are defined for Nvidia PTX:
18717 @table @gcctabopt
18719 @item -m32
18720 @itemx -m64
18721 @opindex m32
18722 @opindex m64
18723 Generate code for 32-bit or 64-bit ABI.
18725 @item -mmainkernel
18726 @opindex mmainkernel
18727 Link in code for a __main kernel.  This is for stand-alone instead of
18728 offloading execution.
18730 @end table
18732 @node PDP-11 Options
18733 @subsection PDP-11 Options
18734 @cindex PDP-11 Options
18736 These options are defined for the PDP-11:
18738 @table @gcctabopt
18739 @item -mfpu
18740 @opindex mfpu
18741 Use hardware FPP floating point.  This is the default.  (FIS floating
18742 point on the PDP-11/40 is not supported.)
18744 @item -msoft-float
18745 @opindex msoft-float
18746 Do not use hardware floating point.
18748 @item -mac0
18749 @opindex mac0
18750 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18752 @item -mno-ac0
18753 @opindex mno-ac0
18754 Return floating-point results in memory.  This is the default.
18756 @item -m40
18757 @opindex m40
18758 Generate code for a PDP-11/40.
18760 @item -m45
18761 @opindex m45
18762 Generate code for a PDP-11/45.  This is the default.
18764 @item -m10
18765 @opindex m10
18766 Generate code for a PDP-11/10.
18768 @item -mbcopy-builtin
18769 @opindex mbcopy-builtin
18770 Use inline @code{movmemhi} patterns for copying memory.  This is the
18771 default.
18773 @item -mbcopy
18774 @opindex mbcopy
18775 Do not use inline @code{movmemhi} patterns for copying memory.
18777 @item -mint16
18778 @itemx -mno-int32
18779 @opindex mint16
18780 @opindex mno-int32
18781 Use 16-bit @code{int}.  This is the default.
18783 @item -mint32
18784 @itemx -mno-int16
18785 @opindex mint32
18786 @opindex mno-int16
18787 Use 32-bit @code{int}.
18789 @item -mfloat64
18790 @itemx -mno-float32
18791 @opindex mfloat64
18792 @opindex mno-float32
18793 Use 64-bit @code{float}.  This is the default.
18795 @item -mfloat32
18796 @itemx -mno-float64
18797 @opindex mfloat32
18798 @opindex mno-float64
18799 Use 32-bit @code{float}.
18801 @item -mabshi
18802 @opindex mabshi
18803 Use @code{abshi2} pattern.  This is the default.
18805 @item -mno-abshi
18806 @opindex mno-abshi
18807 Do not use @code{abshi2} pattern.
18809 @item -mbranch-expensive
18810 @opindex mbranch-expensive
18811 Pretend that branches are expensive.  This is for experimenting with
18812 code generation only.
18814 @item -mbranch-cheap
18815 @opindex mbranch-cheap
18816 Do not pretend that branches are expensive.  This is the default.
18818 @item -munix-asm
18819 @opindex munix-asm
18820 Use Unix assembler syntax.  This is the default when configured for
18821 @samp{pdp11-*-bsd}.
18823 @item -mdec-asm
18824 @opindex mdec-asm
18825 Use DEC assembler syntax.  This is the default when configured for any
18826 PDP-11 target other than @samp{pdp11-*-bsd}.
18827 @end table
18829 @node picoChip Options
18830 @subsection picoChip Options
18831 @cindex picoChip options
18833 These @samp{-m} options are defined for picoChip implementations:
18835 @table @gcctabopt
18837 @item -mae=@var{ae_type}
18838 @opindex mcpu
18839 Set the instruction set, register set, and instruction scheduling
18840 parameters for array element type @var{ae_type}.  Supported values
18841 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18843 @option{-mae=ANY} selects a completely generic AE type.  Code
18844 generated with this option runs on any of the other AE types.  The
18845 code is not as efficient as it would be if compiled for a specific
18846 AE type, and some types of operation (e.g., multiplication) do not
18847 work properly on all types of AE.
18849 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18850 for compiled code, and is the default.
18852 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18853 option may suffer from poor performance of byte (char) manipulation,
18854 since the DSP AE does not provide hardware support for byte load/stores.
18856 @item -msymbol-as-address
18857 Enable the compiler to directly use a symbol name as an address in a
18858 load/store instruction, without first loading it into a
18859 register.  Typically, the use of this option generates larger
18860 programs, which run faster than when the option isn't used.  However, the
18861 results vary from program to program, so it is left as a user option,
18862 rather than being permanently enabled.
18864 @item -mno-inefficient-warnings
18865 Disables warnings about the generation of inefficient code.  These
18866 warnings can be generated, for example, when compiling code that
18867 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18868 no hardware support for byte-level memory operations, so all byte
18869 load/stores must be synthesized from word load/store operations.  This is
18870 inefficient and a warning is generated to indicate
18871 that you should rewrite the code to avoid byte operations, or to target
18872 an AE type that has the necessary hardware support.  This option disables
18873 these warnings.
18875 @end table
18877 @node PowerPC Options
18878 @subsection PowerPC Options
18879 @cindex PowerPC options
18881 These are listed under @xref{RS/6000 and PowerPC Options}.
18883 @node RL78 Options
18884 @subsection RL78 Options
18885 @cindex RL78 Options
18887 @table @gcctabopt
18889 @item -msim
18890 @opindex msim
18891 Links in additional target libraries to support operation within a
18892 simulator.
18894 @item -mmul=none
18895 @itemx -mmul=g10
18896 @itemx -mmul=g13
18897 @itemx -mmul=g14
18898 @itemx -mmul=rl78
18899 @opindex mmul
18900 Specifies the type of hardware multiplication and division support to
18901 be used.  The simplest is @code{none}, which uses software for both
18902 multiplication and division.  This is the default.  The @code{g13}
18903 value is for the hardware multiply/divide peripheral found on the
18904 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
18905 the multiplication and division instructions supported by the RL78/G14
18906 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
18907 the value @code{mg10} is an alias for @code{none}.
18909 In addition a C preprocessor macro is defined, based upon the setting
18910 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
18911 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
18913 @item -mcpu=g10
18914 @itemx -mcpu=g13
18915 @itemx -mcpu=g14
18916 @itemx -mcpu=rl78
18917 @opindex mcpu
18918 Specifies the RL78 core to target.  The default is the G14 core, also
18919 known as an S3 core or just RL78.  The G13 or S2 core does not have
18920 multiply or divide instructions, instead it uses a hardware peripheral
18921 for these operations.  The G10 or S1 core does not have register
18922 banks, so it uses a different calling convention.
18924 If this option is set it also selects the type of hardware multiply
18925 support to use, unless this is overridden by an explicit
18926 @option{-mmul=none} option on the command line.  Thus specifying
18927 @option{-mcpu=g13} enables the use of the G13 hardware multiply
18928 peripheral and specifying @option{-mcpu=g10} disables the use of
18929 hardware multipications altogether.
18931 Note, although the RL78/G14 core is the default target, specifying
18932 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
18933 change the behaviour of the toolchain since it also enables G14
18934 hardware multiply support.  If these options are not specified on the
18935 command line then software multiplication routines will be used even
18936 though the code targets the RL78 core.  This is for backwards
18937 compatibility with older toolchains which did not have hardware
18938 multiply and divide support.
18940 In addition a C preprocessor macro is defined, based upon the setting
18941 of this option.  Possible values are: @code{__RL78_G10__},
18942 @code{__RL78_G13__} or @code{__RL78_G14__}.
18944 @item -mg10
18945 @itemx -mg13
18946 @itemx -mg14
18947 @itemx -mrl78
18948 @opindex mg10
18949 @opindex mg13
18950 @opindex mg14
18951 @opindex mrl78
18952 These are aliases for the corresponding @option{-mcpu=} option.  They
18953 are provided for backwards compatibility.
18955 @item -mallregs
18956 @opindex mallregs
18957 Allow the compiler to use all of the available registers.  By default
18958 registers @code{r24..r31} are reserved for use in interrupt handlers.
18959 With this option enabled these registers can be used in ordinary
18960 functions as well.
18962 @item -m64bit-doubles
18963 @itemx -m32bit-doubles
18964 @opindex m64bit-doubles
18965 @opindex m32bit-doubles
18966 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18967 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18968 @option{-m32bit-doubles}.
18970 @end table
18972 @node RS/6000 and PowerPC Options
18973 @subsection IBM RS/6000 and PowerPC Options
18974 @cindex RS/6000 and PowerPC Options
18975 @cindex IBM RS/6000 and PowerPC Options
18977 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18978 @table @gcctabopt
18979 @item -mpowerpc-gpopt
18980 @itemx -mno-powerpc-gpopt
18981 @itemx -mpowerpc-gfxopt
18982 @itemx -mno-powerpc-gfxopt
18983 @need 800
18984 @itemx -mpowerpc64
18985 @itemx -mno-powerpc64
18986 @itemx -mmfcrf
18987 @itemx -mno-mfcrf
18988 @itemx -mpopcntb
18989 @itemx -mno-popcntb
18990 @itemx -mpopcntd
18991 @itemx -mno-popcntd
18992 @itemx -mfprnd
18993 @itemx -mno-fprnd
18994 @need 800
18995 @itemx -mcmpb
18996 @itemx -mno-cmpb
18997 @itemx -mmfpgpr
18998 @itemx -mno-mfpgpr
18999 @itemx -mhard-dfp
19000 @itemx -mno-hard-dfp
19001 @opindex mpowerpc-gpopt
19002 @opindex mno-powerpc-gpopt
19003 @opindex mpowerpc-gfxopt
19004 @opindex mno-powerpc-gfxopt
19005 @opindex mpowerpc64
19006 @opindex mno-powerpc64
19007 @opindex mmfcrf
19008 @opindex mno-mfcrf
19009 @opindex mpopcntb
19010 @opindex mno-popcntb
19011 @opindex mpopcntd
19012 @opindex mno-popcntd
19013 @opindex mfprnd
19014 @opindex mno-fprnd
19015 @opindex mcmpb
19016 @opindex mno-cmpb
19017 @opindex mmfpgpr
19018 @opindex mno-mfpgpr
19019 @opindex mhard-dfp
19020 @opindex mno-hard-dfp
19021 You use these options to specify which instructions are available on the
19022 processor you are using.  The default value of these options is
19023 determined when configuring GCC@.  Specifying the
19024 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19025 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19026 rather than the options listed above.
19028 Specifying @option{-mpowerpc-gpopt} allows
19029 GCC to use the optional PowerPC architecture instructions in the
19030 General Purpose group, including floating-point square root.  Specifying
19031 @option{-mpowerpc-gfxopt} allows GCC to
19032 use the optional PowerPC architecture instructions in the Graphics
19033 group, including floating-point select.
19035 The @option{-mmfcrf} option allows GCC to generate the move from
19036 condition register field instruction implemented on the POWER4
19037 processor and other processors that support the PowerPC V2.01
19038 architecture.
19039 The @option{-mpopcntb} option allows GCC to generate the popcount and
19040 double-precision FP reciprocal estimate instruction implemented on the
19041 POWER5 processor and other processors that support the PowerPC V2.02
19042 architecture.
19043 The @option{-mpopcntd} option allows GCC to generate the popcount
19044 instruction implemented on the POWER7 processor and other processors
19045 that support the PowerPC V2.06 architecture.
19046 The @option{-mfprnd} option allows GCC to generate the FP round to
19047 integer instructions implemented on the POWER5+ processor and other
19048 processors that support the PowerPC V2.03 architecture.
19049 The @option{-mcmpb} option allows GCC to generate the compare bytes
19050 instruction implemented on the POWER6 processor and other processors
19051 that support the PowerPC V2.05 architecture.
19052 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19053 general-purpose register instructions implemented on the POWER6X
19054 processor and other processors that support the extended PowerPC V2.05
19055 architecture.
19056 The @option{-mhard-dfp} option allows GCC to generate the decimal
19057 floating-point instructions implemented on some POWER processors.
19059 The @option{-mpowerpc64} option allows GCC to generate the additional
19060 64-bit instructions that are found in the full PowerPC64 architecture
19061 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19062 @option{-mno-powerpc64}.
19064 @item -mcpu=@var{cpu_type}
19065 @opindex mcpu
19066 Set architecture type, register usage, and
19067 instruction scheduling parameters for machine type @var{cpu_type}.
19068 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19069 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19070 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19071 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19072 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19073 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19074 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19075 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19076 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19077 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19078 @samp{powerpc64}, @samp{powerpc64le}, and @samp{rs64}.
19080 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
19081 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
19082 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
19083 architecture machine types, with an appropriate, generic processor
19084 model assumed for scheduling purposes.
19086 The other options specify a specific processor.  Code generated under
19087 those options runs best on that processor, and may not run at all on
19088 others.
19090 The @option{-mcpu} options automatically enable or disable the
19091 following options:
19093 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19094 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19095 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19096 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19097 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19098 -mquad-memory -mquad-memory-atomic}
19100 The particular options set for any particular CPU varies between
19101 compiler versions, depending on what setting seems to produce optimal
19102 code for that CPU; it doesn't necessarily reflect the actual hardware's
19103 capabilities.  If you wish to set an individual option to a particular
19104 value, you may specify it after the @option{-mcpu} option, like
19105 @option{-mcpu=970 -mno-altivec}.
19107 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19108 not enabled or disabled by the @option{-mcpu} option at present because
19109 AIX does not have full support for these options.  You may still
19110 enable or disable them individually if you're sure it'll work in your
19111 environment.
19113 @item -mtune=@var{cpu_type}
19114 @opindex mtune
19115 Set the instruction scheduling parameters for machine type
19116 @var{cpu_type}, but do not set the architecture type or register usage,
19117 as @option{-mcpu=@var{cpu_type}} does.  The same
19118 values for @var{cpu_type} are used for @option{-mtune} as for
19119 @option{-mcpu}.  If both are specified, the code generated uses the
19120 architecture and registers set by @option{-mcpu}, but the
19121 scheduling parameters set by @option{-mtune}.
19123 @item -mcmodel=small
19124 @opindex mcmodel=small
19125 Generate PowerPC64 code for the small model: The TOC is limited to
19126 64k.
19128 @item -mcmodel=medium
19129 @opindex mcmodel=medium
19130 Generate PowerPC64 code for the medium model: The TOC and other static
19131 data may be up to a total of 4G in size.
19133 @item -mcmodel=large
19134 @opindex mcmodel=large
19135 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19136 in size.  Other data and code is only limited by the 64-bit address
19137 space.
19139 @item -maltivec
19140 @itemx -mno-altivec
19141 @opindex maltivec
19142 @opindex mno-altivec
19143 Generate code that uses (does not use) AltiVec instructions, and also
19144 enable the use of built-in functions that allow more direct access to
19145 the AltiVec instruction set.  You may also need to set
19146 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19147 enhancements.
19149 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19150 @option{-maltivec=be}, the element order for Altivec intrinsics such
19151 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
19152 match array element order corresponding to the endianness of the
19153 target.  That is, element zero identifies the leftmost element in a
19154 vector register when targeting a big-endian platform, and identifies
19155 the rightmost element in a vector register when targeting a
19156 little-endian platform.
19158 @item -maltivec=be
19159 @opindex maltivec=be
19160 Generate Altivec instructions using big-endian element order,
19161 regardless of whether the target is big- or little-endian.  This is
19162 the default when targeting a big-endian platform.
19164 The element order is used to interpret element numbers in Altivec
19165 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19166 @code{vec_insert}.  By default, these match array element order
19167 corresponding to the endianness for the target.
19169 @item -maltivec=le
19170 @opindex maltivec=le
19171 Generate Altivec instructions using little-endian element order,
19172 regardless of whether the target is big- or little-endian.  This is
19173 the default when targeting a little-endian platform.  This option is
19174 currently ignored when targeting a big-endian platform.
19176 The element order is used to interpret element numbers in Altivec
19177 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19178 @code{vec_insert}.  By default, these match array element order
19179 corresponding to the endianness for the target.
19181 @item -mvrsave
19182 @itemx -mno-vrsave
19183 @opindex mvrsave
19184 @opindex mno-vrsave
19185 Generate VRSAVE instructions when generating AltiVec code.
19187 @item -mgen-cell-microcode
19188 @opindex mgen-cell-microcode
19189 Generate Cell microcode instructions.
19191 @item -mwarn-cell-microcode
19192 @opindex mwarn-cell-microcode
19193 Warn when a Cell microcode instruction is emitted.  An example
19194 of a Cell microcode instruction is a variable shift.
19196 @item -msecure-plt
19197 @opindex msecure-plt
19198 Generate code that allows @command{ld} and @command{ld.so}
19199 to build executables and shared
19200 libraries with non-executable @code{.plt} and @code{.got} sections.
19201 This is a PowerPC
19202 32-bit SYSV ABI option.
19204 @item -mbss-plt
19205 @opindex mbss-plt
19206 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19207 fills in, and
19208 requires @code{.plt} and @code{.got}
19209 sections that are both writable and executable.
19210 This is a PowerPC 32-bit SYSV ABI option.
19212 @item -misel
19213 @itemx -mno-isel
19214 @opindex misel
19215 @opindex mno-isel
19216 This switch enables or disables the generation of ISEL instructions.
19218 @item -misel=@var{yes/no}
19219 This switch has been deprecated.  Use @option{-misel} and
19220 @option{-mno-isel} instead.
19222 @item -mspe
19223 @itemx -mno-spe
19224 @opindex mspe
19225 @opindex mno-spe
19226 This switch enables or disables the generation of SPE simd
19227 instructions.
19229 @item -mpaired
19230 @itemx -mno-paired
19231 @opindex mpaired
19232 @opindex mno-paired
19233 This switch enables or disables the generation of PAIRED simd
19234 instructions.
19236 @item -mspe=@var{yes/no}
19237 This option has been deprecated.  Use @option{-mspe} and
19238 @option{-mno-spe} instead.
19240 @item -mvsx
19241 @itemx -mno-vsx
19242 @opindex mvsx
19243 @opindex mno-vsx
19244 Generate code that uses (does not use) vector/scalar (VSX)
19245 instructions, and also enable the use of built-in functions that allow
19246 more direct access to the VSX instruction set.
19248 @item -mcrypto
19249 @itemx -mno-crypto
19250 @opindex mcrypto
19251 @opindex mno-crypto
19252 Enable the use (disable) of the built-in functions that allow direct
19253 access to the cryptographic instructions that were added in version
19254 2.07 of the PowerPC ISA.
19256 @item -mdirect-move
19257 @itemx -mno-direct-move
19258 @opindex mdirect-move
19259 @opindex mno-direct-move
19260 Generate code that uses (does not use) the instructions to move data
19261 between the general purpose registers and the vector/scalar (VSX)
19262 registers that were added in version 2.07 of the PowerPC ISA.
19264 @item -mpower8-fusion
19265 @itemx -mno-power8-fusion
19266 @opindex mpower8-fusion
19267 @opindex mno-power8-fusion
19268 Generate code that keeps (does not keeps) some integer operations
19269 adjacent so that the instructions can be fused together on power8 and
19270 later processors.
19272 @item -mpower8-vector
19273 @itemx -mno-power8-vector
19274 @opindex mpower8-vector
19275 @opindex mno-power8-vector
19276 Generate code that uses (does not use) the vector and scalar
19277 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19278 enable the use of built-in functions that allow more direct access to
19279 the vector instructions.
19281 @item -mquad-memory
19282 @itemx -mno-quad-memory
19283 @opindex mquad-memory
19284 @opindex mno-quad-memory
19285 Generate code that uses (does not use) the non-atomic quad word memory
19286 instructions.  The @option{-mquad-memory} option requires use of
19287 64-bit mode.
19289 @item -mquad-memory-atomic
19290 @itemx -mno-quad-memory-atomic
19291 @opindex mquad-memory-atomic
19292 @opindex mno-quad-memory-atomic
19293 Generate code that uses (does not use) the atomic quad word memory
19294 instructions.  The @option{-mquad-memory-atomic} option requires use of
19295 64-bit mode.
19297 @item -mupper-regs-df
19298 @itemx -mno-upper-regs-df
19299 @opindex mupper-regs-df
19300 @opindex mno-upper-regs-df
19301 Generate code that uses (does not use) the scalar double precision
19302 instructions that target all 64 registers in the vector/scalar
19303 floating point register set that were added in version 2.06 of the
19304 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
19305 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19306 @option{-mvsx} options.
19308 @item -mupper-regs-sf
19309 @itemx -mno-upper-regs-sf
19310 @opindex mupper-regs-sf
19311 @opindex mno-upper-regs-sf
19312 Generate code that uses (does not use) the scalar single precision
19313 instructions that target all 64 registers in the vector/scalar
19314 floating point register set that were added in version 2.07 of the
19315 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
19316 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
19317 options.
19319 @item -mupper-regs
19320 @itemx -mno-upper-regs
19321 @opindex mupper-regs
19322 @opindex mno-upper-regs
19323 Generate code that uses (does not use) the scalar
19324 instructions that target all 64 registers in the vector/scalar
19325 floating point register set, depending on the model of the machine.
19327 If the @option{-mno-upper-regs} option is used, it turns off both
19328 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19330 @item -mfloat-gprs=@var{yes/single/double/no}
19331 @itemx -mfloat-gprs
19332 @opindex mfloat-gprs
19333 This switch enables or disables the generation of floating-point
19334 operations on the general-purpose registers for architectures that
19335 support it.
19337 The argument @samp{yes} or @samp{single} enables the use of
19338 single-precision floating-point operations.
19340 The argument @samp{double} enables the use of single and
19341 double-precision floating-point operations.
19343 The argument @samp{no} disables floating-point operations on the
19344 general-purpose registers.
19346 This option is currently only available on the MPC854x.
19348 @item -m32
19349 @itemx -m64
19350 @opindex m32
19351 @opindex m64
19352 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19353 targets (including GNU/Linux).  The 32-bit environment sets int, long
19354 and pointer to 32 bits and generates code that runs on any PowerPC
19355 variant.  The 64-bit environment sets int to 32 bits and long and
19356 pointer to 64 bits, and generates code for PowerPC64, as for
19357 @option{-mpowerpc64}.
19359 @item -mfull-toc
19360 @itemx -mno-fp-in-toc
19361 @itemx -mno-sum-in-toc
19362 @itemx -mminimal-toc
19363 @opindex mfull-toc
19364 @opindex mno-fp-in-toc
19365 @opindex mno-sum-in-toc
19366 @opindex mminimal-toc
19367 Modify generation of the TOC (Table Of Contents), which is created for
19368 every executable file.  The @option{-mfull-toc} option is selected by
19369 default.  In that case, GCC allocates at least one TOC entry for
19370 each unique non-automatic variable reference in your program.  GCC
19371 also places floating-point constants in the TOC@.  However, only
19372 16,384 entries are available in the TOC@.
19374 If you receive a linker error message that saying you have overflowed
19375 the available TOC space, you can reduce the amount of TOC space used
19376 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19377 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19378 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19379 generate code to calculate the sum of an address and a constant at
19380 run time instead of putting that sum into the TOC@.  You may specify one
19381 or both of these options.  Each causes GCC to produce very slightly
19382 slower and larger code at the expense of conserving TOC space.
19384 If you still run out of space in the TOC even when you specify both of
19385 these options, specify @option{-mminimal-toc} instead.  This option causes
19386 GCC to make only one TOC entry for every file.  When you specify this
19387 option, GCC produces code that is slower and larger but which
19388 uses extremely little TOC space.  You may wish to use this option
19389 only on files that contain less frequently-executed code.
19391 @item -maix64
19392 @itemx -maix32
19393 @opindex maix64
19394 @opindex maix32
19395 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19396 @code{long} type, and the infrastructure needed to support them.
19397 Specifying @option{-maix64} implies @option{-mpowerpc64},
19398 while @option{-maix32} disables the 64-bit ABI and
19399 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19401 @item -mxl-compat
19402 @itemx -mno-xl-compat
19403 @opindex mxl-compat
19404 @opindex mno-xl-compat
19405 Produce code that conforms more closely to IBM XL compiler semantics
19406 when using AIX-compatible ABI@.  Pass floating-point arguments to
19407 prototyped functions beyond the register save area (RSA) on the stack
19408 in addition to argument FPRs.  Do not assume that most significant
19409 double in 128-bit long double value is properly rounded when comparing
19410 values and converting to double.  Use XL symbol names for long double
19411 support routines.
19413 The AIX calling convention was extended but not initially documented to
19414 handle an obscure K&R C case of calling a function that takes the
19415 address of its arguments with fewer arguments than declared.  IBM XL
19416 compilers access floating-point arguments that do not fit in the
19417 RSA from the stack when a subroutine is compiled without
19418 optimization.  Because always storing floating-point arguments on the
19419 stack is inefficient and rarely needed, this option is not enabled by
19420 default and only is necessary when calling subroutines compiled by IBM
19421 XL compilers without optimization.
19423 @item -mpe
19424 @opindex mpe
19425 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19426 application written to use message passing with special startup code to
19427 enable the application to run.  The system must have PE installed in the
19428 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19429 must be overridden with the @option{-specs=} option to specify the
19430 appropriate directory location.  The Parallel Environment does not
19431 support threads, so the @option{-mpe} option and the @option{-pthread}
19432 option are incompatible.
19434 @item -malign-natural
19435 @itemx -malign-power
19436 @opindex malign-natural
19437 @opindex malign-power
19438 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19439 @option{-malign-natural} overrides the ABI-defined alignment of larger
19440 types, such as floating-point doubles, on their natural size-based boundary.
19441 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19442 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19444 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19445 is not supported.
19447 @item -msoft-float
19448 @itemx -mhard-float
19449 @opindex msoft-float
19450 @opindex mhard-float
19451 Generate code that does not use (uses) the floating-point register set.
19452 Software floating-point emulation is provided if you use the
19453 @option{-msoft-float} option, and pass the option to GCC when linking.
19455 @item -msingle-float
19456 @itemx -mdouble-float
19457 @opindex msingle-float
19458 @opindex mdouble-float
19459 Generate code for single- or double-precision floating-point operations.
19460 @option{-mdouble-float} implies @option{-msingle-float}.
19462 @item -msimple-fpu
19463 @opindex msimple-fpu
19464 Do not generate @code{sqrt} and @code{div} instructions for hardware
19465 floating-point unit.
19467 @item -mfpu=@var{name}
19468 @opindex mfpu
19469 Specify type of floating-point unit.  Valid values for @var{name} are
19470 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19471 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19472 @samp{sp_full} (equivalent to @option{-msingle-float}),
19473 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19475 @item -mxilinx-fpu
19476 @opindex mxilinx-fpu
19477 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19479 @item -mmultiple
19480 @itemx -mno-multiple
19481 @opindex mmultiple
19482 @opindex mno-multiple
19483 Generate code that uses (does not use) the load multiple word
19484 instructions and the store multiple word instructions.  These
19485 instructions are generated by default on POWER systems, and not
19486 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19487 PowerPC systems, since those instructions do not work when the
19488 processor is in little-endian mode.  The exceptions are PPC740 and
19489 PPC750 which permit these instructions in little-endian mode.
19491 @item -mstring
19492 @itemx -mno-string
19493 @opindex mstring
19494 @opindex mno-string
19495 Generate code that uses (does not use) the load string instructions
19496 and the store string word instructions to save multiple registers and
19497 do small block moves.  These instructions are generated by default on
19498 POWER systems, and not generated on PowerPC systems.  Do not use
19499 @option{-mstring} on little-endian PowerPC systems, since those
19500 instructions do not work when the processor is in little-endian mode.
19501 The exceptions are PPC740 and PPC750 which permit these instructions
19502 in little-endian mode.
19504 @item -mupdate
19505 @itemx -mno-update
19506 @opindex mupdate
19507 @opindex mno-update
19508 Generate code that uses (does not use) the load or store instructions
19509 that update the base register to the address of the calculated memory
19510 location.  These instructions are generated by default.  If you use
19511 @option{-mno-update}, there is a small window between the time that the
19512 stack pointer is updated and the address of the previous frame is
19513 stored, which means code that walks the stack frame across interrupts or
19514 signals may get corrupted data.
19516 @item -mavoid-indexed-addresses
19517 @itemx -mno-avoid-indexed-addresses
19518 @opindex mavoid-indexed-addresses
19519 @opindex mno-avoid-indexed-addresses
19520 Generate code that tries to avoid (not avoid) the use of indexed load
19521 or store instructions. These instructions can incur a performance
19522 penalty on Power6 processors in certain situations, such as when
19523 stepping through large arrays that cross a 16M boundary.  This option
19524 is enabled by default when targeting Power6 and disabled otherwise.
19526 @item -mfused-madd
19527 @itemx -mno-fused-madd
19528 @opindex mfused-madd
19529 @opindex mno-fused-madd
19530 Generate code that uses (does not use) the floating-point multiply and
19531 accumulate instructions.  These instructions are generated by default
19532 if hardware floating point is used.  The machine-dependent
19533 @option{-mfused-madd} option is now mapped to the machine-independent
19534 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19535 mapped to @option{-ffp-contract=off}.
19537 @item -mmulhw
19538 @itemx -mno-mulhw
19539 @opindex mmulhw
19540 @opindex mno-mulhw
19541 Generate code that uses (does not use) the half-word multiply and
19542 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19543 These instructions are generated by default when targeting those
19544 processors.
19546 @item -mdlmzb
19547 @itemx -mno-dlmzb
19548 @opindex mdlmzb
19549 @opindex mno-dlmzb
19550 Generate code that uses (does not use) the string-search @samp{dlmzb}
19551 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19552 generated by default when targeting those processors.
19554 @item -mno-bit-align
19555 @itemx -mbit-align
19556 @opindex mno-bit-align
19557 @opindex mbit-align
19558 On System V.4 and embedded PowerPC systems do not (do) force structures
19559 and unions that contain bit-fields to be aligned to the base type of the
19560 bit-field.
19562 For example, by default a structure containing nothing but 8
19563 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19564 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19565 the structure is aligned to a 1-byte boundary and is 1 byte in
19566 size.
19568 @item -mno-strict-align
19569 @itemx -mstrict-align
19570 @opindex mno-strict-align
19571 @opindex mstrict-align
19572 On System V.4 and embedded PowerPC systems do not (do) assume that
19573 unaligned memory references are handled by the system.
19575 @item -mrelocatable
19576 @itemx -mno-relocatable
19577 @opindex mrelocatable
19578 @opindex mno-relocatable
19579 Generate code that allows (does not allow) a static executable to be
19580 relocated to a different address at run time.  A simple embedded
19581 PowerPC system loader should relocate the entire contents of
19582 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19583 a table of 32-bit addresses generated by this option.  For this to
19584 work, all objects linked together must be compiled with
19585 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19586 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19588 @item -mrelocatable-lib
19589 @itemx -mno-relocatable-lib
19590 @opindex mrelocatable-lib
19591 @opindex mno-relocatable-lib
19592 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19593 @code{.fixup} section to allow static executables to be relocated at
19594 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19595 alignment of @option{-mrelocatable}.  Objects compiled with
19596 @option{-mrelocatable-lib} may be linked with objects compiled with
19597 any combination of the @option{-mrelocatable} options.
19599 @item -mno-toc
19600 @itemx -mtoc
19601 @opindex mno-toc
19602 @opindex mtoc
19603 On System V.4 and embedded PowerPC systems do not (do) assume that
19604 register 2 contains a pointer to a global area pointing to the addresses
19605 used in the program.
19607 @item -mlittle
19608 @itemx -mlittle-endian
19609 @opindex mlittle
19610 @opindex mlittle-endian
19611 On System V.4 and embedded PowerPC systems compile code for the
19612 processor in little-endian mode.  The @option{-mlittle-endian} option is
19613 the same as @option{-mlittle}.
19615 @item -mbig
19616 @itemx -mbig-endian
19617 @opindex mbig
19618 @opindex mbig-endian
19619 On System V.4 and embedded PowerPC systems compile code for the
19620 processor in big-endian mode.  The @option{-mbig-endian} option is
19621 the same as @option{-mbig}.
19623 @item -mdynamic-no-pic
19624 @opindex mdynamic-no-pic
19625 On Darwin and Mac OS X systems, compile code so that it is not
19626 relocatable, but that its external references are relocatable.  The
19627 resulting code is suitable for applications, but not shared
19628 libraries.
19630 @item -msingle-pic-base
19631 @opindex msingle-pic-base
19632 Treat the register used for PIC addressing as read-only, rather than
19633 loading it in the prologue for each function.  The runtime system is
19634 responsible for initializing this register with an appropriate value
19635 before execution begins.
19637 @item -mprioritize-restricted-insns=@var{priority}
19638 @opindex mprioritize-restricted-insns
19639 This option controls the priority that is assigned to
19640 dispatch-slot restricted instructions during the second scheduling
19641 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19642 or @samp{2} to assign no, highest, or second-highest (respectively) 
19643 priority to dispatch-slot restricted
19644 instructions.
19646 @item -msched-costly-dep=@var{dependence_type}
19647 @opindex msched-costly-dep
19648 This option controls which dependences are considered costly
19649 by the target during instruction scheduling.  The argument
19650 @var{dependence_type} takes one of the following values:
19652 @table @asis
19653 @item @samp{no}
19654 No dependence is costly.
19656 @item @samp{all}
19657 All dependences are costly.
19659 @item @samp{true_store_to_load}
19660 A true dependence from store to load is costly.
19662 @item @samp{store_to_load}
19663 Any dependence from store to load is costly.
19665 @item @var{number}
19666 Any dependence for which the latency is greater than or equal to 
19667 @var{number} is costly.
19668 @end table
19670 @item -minsert-sched-nops=@var{scheme}
19671 @opindex minsert-sched-nops
19672 This option controls which NOP insertion scheme is used during
19673 the second scheduling pass.  The argument @var{scheme} takes one of the
19674 following values:
19676 @table @asis
19677 @item @samp{no}
19678 Don't insert NOPs.
19680 @item @samp{pad}
19681 Pad with NOPs any dispatch group that has vacant issue slots,
19682 according to the scheduler's grouping.
19684 @item @samp{regroup_exact}
19685 Insert NOPs to force costly dependent insns into
19686 separate groups.  Insert exactly as many NOPs as needed to force an insn
19687 to a new group, according to the estimated processor grouping.
19689 @item @var{number}
19690 Insert NOPs to force costly dependent insns into
19691 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19692 @end table
19694 @item -mcall-sysv
19695 @opindex mcall-sysv
19696 On System V.4 and embedded PowerPC systems compile code using calling
19697 conventions that adhere to the March 1995 draft of the System V
19698 Application Binary Interface, PowerPC processor supplement.  This is the
19699 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19701 @item -mcall-sysv-eabi
19702 @itemx -mcall-eabi
19703 @opindex mcall-sysv-eabi
19704 @opindex mcall-eabi
19705 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19707 @item -mcall-sysv-noeabi
19708 @opindex mcall-sysv-noeabi
19709 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19711 @item -mcall-aixdesc
19712 @opindex m
19713 On System V.4 and embedded PowerPC systems compile code for the AIX
19714 operating system.
19716 @item -mcall-linux
19717 @opindex mcall-linux
19718 On System V.4 and embedded PowerPC systems compile code for the
19719 Linux-based GNU system.
19721 @item -mcall-freebsd
19722 @opindex mcall-freebsd
19723 On System V.4 and embedded PowerPC systems compile code for the
19724 FreeBSD operating system.
19726 @item -mcall-netbsd
19727 @opindex mcall-netbsd
19728 On System V.4 and embedded PowerPC systems compile code for the
19729 NetBSD operating system.
19731 @item -mcall-openbsd
19732 @opindex mcall-netbsd
19733 On System V.4 and embedded PowerPC systems compile code for the
19734 OpenBSD operating system.
19736 @item -maix-struct-return
19737 @opindex maix-struct-return
19738 Return all structures in memory (as specified by the AIX ABI)@.
19740 @item -msvr4-struct-return
19741 @opindex msvr4-struct-return
19742 Return structures smaller than 8 bytes in registers (as specified by the
19743 SVR4 ABI)@.
19745 @item -mabi=@var{abi-type}
19746 @opindex mabi
19747 Extend the current ABI with a particular extension, or remove such extension.
19748 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
19749 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
19750 @samp{elfv1}, @samp{elfv2}@.
19752 @item -mabi=spe
19753 @opindex mabi=spe
19754 Extend the current ABI with SPE ABI extensions.  This does not change
19755 the default ABI, instead it adds the SPE ABI extensions to the current
19756 ABI@.
19758 @item -mabi=no-spe
19759 @opindex mabi=no-spe
19760 Disable Book-E SPE ABI extensions for the current ABI@.
19762 @item -mabi=ibmlongdouble
19763 @opindex mabi=ibmlongdouble
19764 Change the current ABI to use IBM extended-precision long double.
19765 This is a PowerPC 32-bit SYSV ABI option.
19767 @item -mabi=ieeelongdouble
19768 @opindex mabi=ieeelongdouble
19769 Change the current ABI to use IEEE extended-precision long double.
19770 This is a PowerPC 32-bit Linux ABI option.
19772 @item -mabi=elfv1
19773 @opindex mabi=elfv1
19774 Change the current ABI to use the ELFv1 ABI.
19775 This is the default ABI for big-endian PowerPC 64-bit Linux.
19776 Overriding the default ABI requires special system support and is
19777 likely to fail in spectacular ways.
19779 @item -mabi=elfv2
19780 @opindex mabi=elfv2
19781 Change the current ABI to use the ELFv2 ABI.
19782 This is the default ABI for little-endian PowerPC 64-bit Linux.
19783 Overriding the default ABI requires special system support and is
19784 likely to fail in spectacular ways.
19786 @item -mprototype
19787 @itemx -mno-prototype
19788 @opindex mprototype
19789 @opindex mno-prototype
19790 On System V.4 and embedded PowerPC systems assume that all calls to
19791 variable argument functions are properly prototyped.  Otherwise, the
19792 compiler must insert an instruction before every non-prototyped call to
19793 set or clear bit 6 of the condition code register (@code{CR}) to
19794 indicate whether floating-point values are passed in the floating-point
19795 registers in case the function takes variable arguments.  With
19796 @option{-mprototype}, only calls to prototyped variable argument functions
19797 set or clear the bit.
19799 @item -msim
19800 @opindex msim
19801 On embedded PowerPC systems, assume that the startup module is called
19802 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19803 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19804 configurations.
19806 @item -mmvme
19807 @opindex mmvme
19808 On embedded PowerPC systems, assume that the startup module is called
19809 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19810 @file{libc.a}.
19812 @item -mads
19813 @opindex mads
19814 On embedded PowerPC systems, assume that the startup module is called
19815 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19816 @file{libc.a}.
19818 @item -myellowknife
19819 @opindex myellowknife
19820 On embedded PowerPC systems, assume that the startup module is called
19821 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19822 @file{libc.a}.
19824 @item -mvxworks
19825 @opindex mvxworks
19826 On System V.4 and embedded PowerPC systems, specify that you are
19827 compiling for a VxWorks system.
19829 @item -memb
19830 @opindex memb
19831 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
19832 header to indicate that @samp{eabi} extended relocations are used.
19834 @item -meabi
19835 @itemx -mno-eabi
19836 @opindex meabi
19837 @opindex mno-eabi
19838 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19839 Embedded Applications Binary Interface (EABI), which is a set of
19840 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19841 means that the stack is aligned to an 8-byte boundary, a function
19842 @code{__eabi} is called from @code{main} to set up the EABI
19843 environment, and the @option{-msdata} option can use both @code{r2} and
19844 @code{r13} to point to two separate small data areas.  Selecting
19845 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19846 no EABI initialization function is called from @code{main}, and the
19847 @option{-msdata} option only uses @code{r13} to point to a single
19848 small data area.  The @option{-meabi} option is on by default if you
19849 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19851 @item -msdata=eabi
19852 @opindex msdata=eabi
19853 On System V.4 and embedded PowerPC systems, put small initialized
19854 @code{const} global and static data in the @code{.sdata2} section, which
19855 is pointed to by register @code{r2}.  Put small initialized
19856 non-@code{const} global and static data in the @code{.sdata} section,
19857 which is pointed to by register @code{r13}.  Put small uninitialized
19858 global and static data in the @code{.sbss} section, which is adjacent to
19859 the @code{.sdata} section.  The @option{-msdata=eabi} option is
19860 incompatible with the @option{-mrelocatable} option.  The
19861 @option{-msdata=eabi} option also sets the @option{-memb} option.
19863 @item -msdata=sysv
19864 @opindex msdata=sysv
19865 On System V.4 and embedded PowerPC systems, put small global and static
19866 data in the @code{.sdata} section, which is pointed to by register
19867 @code{r13}.  Put small uninitialized global and static data in the
19868 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
19869 The @option{-msdata=sysv} option is incompatible with the
19870 @option{-mrelocatable} option.
19872 @item -msdata=default
19873 @itemx -msdata
19874 @opindex msdata=default
19875 @opindex msdata
19876 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19877 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19878 same as @option{-msdata=sysv}.
19880 @item -msdata=data
19881 @opindex msdata=data
19882 On System V.4 and embedded PowerPC systems, put small global
19883 data in the @code{.sdata} section.  Put small uninitialized global
19884 data in the @code{.sbss} section.  Do not use register @code{r13}
19885 to address small data however.  This is the default behavior unless
19886 other @option{-msdata} options are used.
19888 @item -msdata=none
19889 @itemx -mno-sdata
19890 @opindex msdata=none
19891 @opindex mno-sdata
19892 On embedded PowerPC systems, put all initialized global and static data
19893 in the @code{.data} section, and all uninitialized data in the
19894 @code{.bss} section.
19896 @item -mblock-move-inline-limit=@var{num}
19897 @opindex mblock-move-inline-limit
19898 Inline all block moves (such as calls to @code{memcpy} or structure
19899 copies) less than or equal to @var{num} bytes.  The minimum value for
19900 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19901 targets.  The default value is target-specific.
19903 @item -G @var{num}
19904 @opindex G
19905 @cindex smaller data references (PowerPC)
19906 @cindex .sdata/.sdata2 references (PowerPC)
19907 On embedded PowerPC systems, put global and static items less than or
19908 equal to @var{num} bytes into the small data or BSS sections instead of
19909 the normal data or BSS section.  By default, @var{num} is 8.  The
19910 @option{-G @var{num}} switch is also passed to the linker.
19911 All modules should be compiled with the same @option{-G @var{num}} value.
19913 @item -mregnames
19914 @itemx -mno-regnames
19915 @opindex mregnames
19916 @opindex mno-regnames
19917 On System V.4 and embedded PowerPC systems do (do not) emit register
19918 names in the assembly language output using symbolic forms.
19920 @item -mlongcall
19921 @itemx -mno-longcall
19922 @opindex mlongcall
19923 @opindex mno-longcall
19924 By default assume that all calls are far away so that a longer and more
19925 expensive calling sequence is required.  This is required for calls
19926 farther than 32 megabytes (33,554,432 bytes) from the current location.
19927 A short call is generated if the compiler knows
19928 the call cannot be that far away.  This setting can be overridden by
19929 the @code{shortcall} function attribute, or by @code{#pragma
19930 longcall(0)}.
19932 Some linkers are capable of detecting out-of-range calls and generating
19933 glue code on the fly.  On these systems, long calls are unnecessary and
19934 generate slower code.  As of this writing, the AIX linker can do this,
19935 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19936 to the GNU linker for 32-bit PowerPC systems as well.
19938 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19939 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19940 addresses represent the callee and the branch island.  The
19941 Darwin/PPC linker prefers the first address and generates a @code{bl
19942 callee} if the PPC @code{bl} instruction reaches the callee directly;
19943 otherwise, the linker generates @code{bl L42} to call the branch
19944 island.  The branch island is appended to the body of the
19945 calling function; it computes the full 32-bit address of the callee
19946 and jumps to it.
19948 On Mach-O (Darwin) systems, this option directs the compiler emit to
19949 the glue for every direct call, and the Darwin linker decides whether
19950 to use or discard it.
19952 In the future, GCC may ignore all longcall specifications
19953 when the linker is known to generate glue.
19955 @item -mtls-markers
19956 @itemx -mno-tls-markers
19957 @opindex mtls-markers
19958 @opindex mno-tls-markers
19959 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19960 specifying the function argument.  The relocation allows the linker to
19961 reliably associate function call with argument setup instructions for
19962 TLS optimization, which in turn allows GCC to better schedule the
19963 sequence.
19965 @item -pthread
19966 @opindex pthread
19967 Adds support for multithreading with the @dfn{pthreads} library.
19968 This option sets flags for both the preprocessor and linker.
19970 @item -mrecip
19971 @itemx -mno-recip
19972 @opindex mrecip
19973 This option enables use of the reciprocal estimate and
19974 reciprocal square root estimate instructions with additional
19975 Newton-Raphson steps to increase precision instead of doing a divide or
19976 square root and divide for floating-point arguments.  You should use
19977 the @option{-ffast-math} option when using @option{-mrecip} (or at
19978 least @option{-funsafe-math-optimizations},
19979 @option{-finite-math-only}, @option{-freciprocal-math} and
19980 @option{-fno-trapping-math}).  Note that while the throughput of the
19981 sequence is generally higher than the throughput of the non-reciprocal
19982 instruction, the precision of the sequence can be decreased by up to 2
19983 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19984 roots.
19986 @item -mrecip=@var{opt}
19987 @opindex mrecip=opt
19988 This option controls which reciprocal estimate instructions
19989 may be used.  @var{opt} is a comma-separated list of options, which may
19990 be preceded by a @code{!} to invert the option:
19992 @table @samp
19994 @item all
19995 Enable all estimate instructions.
19997 @item default 
19998 Enable the default instructions, equivalent to @option{-mrecip}.
20000 @item none 
20001 Disable all estimate instructions, equivalent to @option{-mno-recip}.
20003 @item div 
20004 Enable the reciprocal approximation instructions for both 
20005 single and double precision.
20007 @item divf 
20008 Enable the single-precision reciprocal approximation instructions.
20010 @item divd 
20011 Enable the double-precision reciprocal approximation instructions.
20013 @item rsqrt 
20014 Enable the reciprocal square root approximation instructions for both
20015 single and double precision.
20017 @item rsqrtf 
20018 Enable the single-precision reciprocal square root approximation instructions.
20020 @item rsqrtd 
20021 Enable the double-precision reciprocal square root approximation instructions.
20023 @end table
20025 So, for example, @option{-mrecip=all,!rsqrtd} enables
20026 all of the reciprocal estimate instructions, except for the
20027 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20028 which handle the double-precision reciprocal square root calculations.
20030 @item -mrecip-precision
20031 @itemx -mno-recip-precision
20032 @opindex mrecip-precision
20033 Assume (do not assume) that the reciprocal estimate instructions
20034 provide higher-precision estimates than is mandated by the PowerPC
20035 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20036 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20037 The double-precision square root estimate instructions are not generated by
20038 default on low-precision machines, since they do not provide an
20039 estimate that converges after three steps.
20041 @item -mveclibabi=@var{type}
20042 @opindex mveclibabi
20043 Specifies the ABI type to use for vectorizing intrinsics using an
20044 external library.  The only type supported at present is @samp{mass},
20045 which specifies to use IBM's Mathematical Acceleration Subsystem
20046 (MASS) libraries for vectorizing intrinsics using external libraries.
20047 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20048 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20049 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20050 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20051 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20052 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20053 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20054 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20055 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20056 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20057 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20058 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20059 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20060 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20061 for power7.  Both @option{-ftree-vectorize} and
20062 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20063 libraries must be specified at link time.
20065 @item -mfriz
20066 @itemx -mno-friz
20067 @opindex mfriz
20068 Generate (do not generate) the @code{friz} instruction when the
20069 @option{-funsafe-math-optimizations} option is used to optimize
20070 rounding of floating-point values to 64-bit integer and back to floating
20071 point.  The @code{friz} instruction does not return the same value if
20072 the floating-point number is too large to fit in an integer.
20074 @item -mpointers-to-nested-functions
20075 @itemx -mno-pointers-to-nested-functions
20076 @opindex mpointers-to-nested-functions
20077 Generate (do not generate) code to load up the static chain register
20078 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
20079 systems where a function pointer points to a 3-word descriptor giving
20080 the function address, TOC value to be loaded in register @code{r2}, and
20081 static chain value to be loaded in register @code{r11}.  The
20082 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20083 call through pointers to nested functions or pointers
20084 to functions compiled in other languages that use the static chain if
20085 you use @option{-mno-pointers-to-nested-functions}.
20087 @item -msave-toc-indirect
20088 @itemx -mno-save-toc-indirect
20089 @opindex msave-toc-indirect
20090 Generate (do not generate) code to save the TOC value in the reserved
20091 stack location in the function prologue if the function calls through
20092 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20093 saved in the prologue, it is saved just before the call through the
20094 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20096 @item -mcompat-align-parm
20097 @itemx -mno-compat-align-parm
20098 @opindex mcompat-align-parm
20099 Generate (do not generate) code to pass structure parameters with a
20100 maximum alignment of 64 bits, for compatibility with older versions
20101 of GCC.
20103 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20104 structure parameter on a 128-bit boundary when that structure contained
20105 a member requiring 128-bit alignment.  This is corrected in more
20106 recent versions of GCC.  This option may be used to generate code
20107 that is compatible with functions compiled with older versions of
20108 GCC.
20110 The @option{-mno-compat-align-parm} option is the default.
20111 @end table
20113 @node RX Options
20114 @subsection RX Options
20115 @cindex RX Options
20117 These command-line options are defined for RX targets:
20119 @table @gcctabopt
20120 @item -m64bit-doubles
20121 @itemx -m32bit-doubles
20122 @opindex m64bit-doubles
20123 @opindex m32bit-doubles
20124 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20125 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20126 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20127 works on 32-bit values, which is why the default is
20128 @option{-m32bit-doubles}.
20130 @item -fpu
20131 @itemx -nofpu
20132 @opindex fpu
20133 @opindex nofpu
20134 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20135 floating-point hardware.  The default is enabled for the RX600
20136 series and disabled for the RX200 series.
20138 Floating-point instructions are only generated for 32-bit floating-point 
20139 values, however, so the FPU hardware is not used for doubles if the
20140 @option{-m64bit-doubles} option is used.
20142 @emph{Note} If the @option{-fpu} option is enabled then
20143 @option{-funsafe-math-optimizations} is also enabled automatically.
20144 This is because the RX FPU instructions are themselves unsafe.
20146 @item -mcpu=@var{name}
20147 @opindex mcpu
20148 Selects the type of RX CPU to be targeted.  Currently three types are
20149 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
20150 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
20152 The only difference between @samp{RX600} and @samp{RX610} is that the
20153 @samp{RX610} does not support the @code{MVTIPL} instruction.
20155 The @samp{RX200} series does not have a hardware floating-point unit
20156 and so @option{-nofpu} is enabled by default when this type is
20157 selected.
20159 @item -mbig-endian-data
20160 @itemx -mlittle-endian-data
20161 @opindex mbig-endian-data
20162 @opindex mlittle-endian-data
20163 Store data (but not code) in the big-endian format.  The default is
20164 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20165 format.
20167 @item -msmall-data-limit=@var{N}
20168 @opindex msmall-data-limit
20169 Specifies the maximum size in bytes of global and static variables
20170 which can be placed into the small data area.  Using the small data
20171 area can lead to smaller and faster code, but the size of area is
20172 limited and it is up to the programmer to ensure that the area does
20173 not overflow.  Also when the small data area is used one of the RX's
20174 registers (usually @code{r13}) is reserved for use pointing to this
20175 area, so it is no longer available for use by the compiler.  This
20176 could result in slower and/or larger code if variables are pushed onto
20177 the stack instead of being held in this register.
20179 Note, common variables (variables that have not been initialized) and
20180 constants are not placed into the small data area as they are assigned
20181 to other sections in the output executable.
20183 The default value is zero, which disables this feature.  Note, this
20184 feature is not enabled by default with higher optimization levels
20185 (@option{-O2} etc) because of the potentially detrimental effects of
20186 reserving a register.  It is up to the programmer to experiment and
20187 discover whether this feature is of benefit to their program.  See the
20188 description of the @option{-mpid} option for a description of how the
20189 actual register to hold the small data area pointer is chosen.
20191 @item -msim
20192 @itemx -mno-sim
20193 @opindex msim
20194 @opindex mno-sim
20195 Use the simulator runtime.  The default is to use the libgloss
20196 board-specific runtime.
20198 @item -mas100-syntax
20199 @itemx -mno-as100-syntax
20200 @opindex mas100-syntax
20201 @opindex mno-as100-syntax
20202 When generating assembler output use a syntax that is compatible with
20203 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20204 assembler, but it has some restrictions so it is not generated by default.
20206 @item -mmax-constant-size=@var{N}
20207 @opindex mmax-constant-size
20208 Specifies the maximum size, in bytes, of a constant that can be used as
20209 an operand in a RX instruction.  Although the RX instruction set does
20210 allow constants of up to 4 bytes in length to be used in instructions,
20211 a longer value equates to a longer instruction.  Thus in some
20212 circumstances it can be beneficial to restrict the size of constants
20213 that are used in instructions.  Constants that are too big are instead
20214 placed into a constant pool and referenced via register indirection.
20216 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20217 or 4 means that constants of any size are allowed.
20219 @item -mrelax
20220 @opindex mrelax
20221 Enable linker relaxation.  Linker relaxation is a process whereby the
20222 linker attempts to reduce the size of a program by finding shorter
20223 versions of various instructions.  Disabled by default.
20225 @item -mint-register=@var{N}
20226 @opindex mint-register
20227 Specify the number of registers to reserve for fast interrupt handler
20228 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20229 means that register @code{r13} is reserved for the exclusive use
20230 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20231 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20232 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20233 A value of 0, the default, does not reserve any registers.
20235 @item -msave-acc-in-interrupts
20236 @opindex msave-acc-in-interrupts
20237 Specifies that interrupt handler functions should preserve the
20238 accumulator register.  This is only necessary if normal code might use
20239 the accumulator register, for example because it performs 64-bit
20240 multiplications.  The default is to ignore the accumulator as this
20241 makes the interrupt handlers faster.
20243 @item -mpid
20244 @itemx -mno-pid
20245 @opindex mpid
20246 @opindex mno-pid
20247 Enables the generation of position independent data.  When enabled any
20248 access to constant data is done via an offset from a base address
20249 held in a register.  This allows the location of constant data to be
20250 determined at run time without requiring the executable to be
20251 relocated, which is a benefit to embedded applications with tight
20252 memory constraints.  Data that can be modified is not affected by this
20253 option.
20255 Note, using this feature reserves a register, usually @code{r13}, for
20256 the constant data base address.  This can result in slower and/or
20257 larger code, especially in complicated functions.
20259 The actual register chosen to hold the constant data base address
20260 depends upon whether the @option{-msmall-data-limit} and/or the
20261 @option{-mint-register} command-line options are enabled.  Starting
20262 with register @code{r13} and proceeding downwards, registers are
20263 allocated first to satisfy the requirements of @option{-mint-register},
20264 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20265 is possible for the small data area register to be @code{r8} if both
20266 @option{-mint-register=4} and @option{-mpid} are specified on the
20267 command line.
20269 By default this feature is not enabled.  The default can be restored
20270 via the @option{-mno-pid} command-line option.
20272 @item -mno-warn-multiple-fast-interrupts
20273 @itemx -mwarn-multiple-fast-interrupts
20274 @opindex mno-warn-multiple-fast-interrupts
20275 @opindex mwarn-multiple-fast-interrupts
20276 Prevents GCC from issuing a warning message if it finds more than one
20277 fast interrupt handler when it is compiling a file.  The default is to
20278 issue a warning for each extra fast interrupt handler found, as the RX
20279 only supports one such interrupt.
20281 @item -mallow-string-insns
20282 @itemx -mno-allow-string-insns
20283 @opindex mallow-string-insns
20284 @opindex mno-allow-string-insns
20285 Enables or disables the use of the string manipulation instructions
20286 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
20287 @code{SWHILE} and also the @code{RMPA} instruction.  These
20288 instructions may prefetch data, which is not safe to do if accessing
20289 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
20290 for more information).
20292 The default is to allow these instructions, but it is not possible for
20293 GCC to reliably detect all circumstances where a string instruction
20294 might be used to access an I/O register, so their use cannot be
20295 disabled automatically.  Instead it is reliant upon the programmer to
20296 use the @option{-mno-allow-string-insns} option if their program
20297 accesses I/O space.
20299 When the instructions are enabled GCC defines the C preprocessor
20300 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
20301 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
20302 @end table
20304 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20305 has special significance to the RX port when used with the
20306 @code{interrupt} function attribute.  This attribute indicates a
20307 function intended to process fast interrupts.  GCC ensures
20308 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20309 and/or @code{r13} and only provided that the normal use of the
20310 corresponding registers have been restricted via the
20311 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20312 options.
20314 @node S/390 and zSeries Options
20315 @subsection S/390 and zSeries Options
20316 @cindex S/390 and zSeries Options
20318 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20320 @table @gcctabopt
20321 @item -mhard-float
20322 @itemx -msoft-float
20323 @opindex mhard-float
20324 @opindex msoft-float
20325 Use (do not use) the hardware floating-point instructions and registers
20326 for floating-point operations.  When @option{-msoft-float} is specified,
20327 functions in @file{libgcc.a} are used to perform floating-point
20328 operations.  When @option{-mhard-float} is specified, the compiler
20329 generates IEEE floating-point instructions.  This is the default.
20331 @item -mhard-dfp
20332 @itemx -mno-hard-dfp
20333 @opindex mhard-dfp
20334 @opindex mno-hard-dfp
20335 Use (do not use) the hardware decimal-floating-point instructions for
20336 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20337 specified, functions in @file{libgcc.a} are used to perform
20338 decimal-floating-point operations.  When @option{-mhard-dfp} is
20339 specified, the compiler generates decimal-floating-point hardware
20340 instructions.  This is the default for @option{-march=z9-ec} or higher.
20342 @item -mlong-double-64
20343 @itemx -mlong-double-128
20344 @opindex mlong-double-64
20345 @opindex mlong-double-128
20346 These switches control the size of @code{long double} type. A size
20347 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20348 type. This is the default.
20350 @item -mbackchain
20351 @itemx -mno-backchain
20352 @opindex mbackchain
20353 @opindex mno-backchain
20354 Store (do not store) the address of the caller's frame as backchain pointer
20355 into the callee's stack frame.
20356 A backchain may be needed to allow debugging using tools that do not understand
20357 DWARF 2 call frame information.
20358 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20359 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20360 the backchain is placed into the topmost word of the 96/160 byte register
20361 save area.
20363 In general, code compiled with @option{-mbackchain} is call-compatible with
20364 code compiled with @option{-mmo-backchain}; however, use of the backchain
20365 for debugging purposes usually requires that the whole binary is built with
20366 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20367 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20368 to build a linux kernel use @option{-msoft-float}.
20370 The default is to not maintain the backchain.
20372 @item -mpacked-stack
20373 @itemx -mno-packed-stack
20374 @opindex mpacked-stack
20375 @opindex mno-packed-stack
20376 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20377 specified, the compiler uses the all fields of the 96/160 byte register save
20378 area only for their default purpose; unused fields still take up stack space.
20379 When @option{-mpacked-stack} is specified, register save slots are densely
20380 packed at the top of the register save area; unused space is reused for other
20381 purposes, allowing for more efficient use of the available stack space.
20382 However, when @option{-mbackchain} is also in effect, the topmost word of
20383 the save area is always used to store the backchain, and the return address
20384 register is always saved two words below the backchain.
20386 As long as the stack frame backchain is not used, code generated with
20387 @option{-mpacked-stack} is call-compatible with code generated with
20388 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20389 S/390 or zSeries generated code that uses the stack frame backchain at run
20390 time, not just for debugging purposes.  Such code is not call-compatible
20391 with code compiled with @option{-mpacked-stack}.  Also, note that the
20392 combination of @option{-mbackchain},
20393 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20394 to build a linux kernel use @option{-msoft-float}.
20396 The default is to not use the packed stack layout.
20398 @item -msmall-exec
20399 @itemx -mno-small-exec
20400 @opindex msmall-exec
20401 @opindex mno-small-exec
20402 Generate (or do not generate) code using the @code{bras} instruction
20403 to do subroutine calls.
20404 This only works reliably if the total executable size does not
20405 exceed 64k.  The default is to use the @code{basr} instruction instead,
20406 which does not have this limitation.
20408 @item -m64
20409 @itemx -m31
20410 @opindex m64
20411 @opindex m31
20412 When @option{-m31} is specified, generate code compliant to the
20413 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20414 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20415 particular to generate 64-bit instructions.  For the @samp{s390}
20416 targets, the default is @option{-m31}, while the @samp{s390x}
20417 targets default to @option{-m64}.
20419 @item -mzarch
20420 @itemx -mesa
20421 @opindex mzarch
20422 @opindex mesa
20423 When @option{-mzarch} is specified, generate code using the
20424 instructions available on z/Architecture.
20425 When @option{-mesa} is specified, generate code using the
20426 instructions available on ESA/390.  Note that @option{-mesa} is
20427 not possible with @option{-m64}.
20428 When generating code compliant to the GNU/Linux for S/390 ABI,
20429 the default is @option{-mesa}.  When generating code compliant
20430 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20432 @item -mmvcle
20433 @itemx -mno-mvcle
20434 @opindex mmvcle
20435 @opindex mno-mvcle
20436 Generate (or do not generate) code using the @code{mvcle} instruction
20437 to perform block moves.  When @option{-mno-mvcle} is specified,
20438 use a @code{mvc} loop instead.  This is the default unless optimizing for
20439 size.
20441 @item -mdebug
20442 @itemx -mno-debug
20443 @opindex mdebug
20444 @opindex mno-debug
20445 Print (or do not print) additional debug information when compiling.
20446 The default is to not print debug information.
20448 @item -march=@var{cpu-type}
20449 @opindex march
20450 Generate code that runs on @var{cpu-type}, which is the name of a system
20451 representing a certain processor type.  Possible values for
20452 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20453 @samp{z9-109}, @samp{z9-ec}, @samp{z10},  @samp{z196}, @samp{zEC12},
20454 and @samp{z13}.
20455 When generating code using the instructions available on z/Architecture,
20456 the default is @option{-march=z900}.  Otherwise, the default is
20457 @option{-march=g5}.
20459 @item -mtune=@var{cpu-type}
20460 @opindex mtune
20461 Tune to @var{cpu-type} everything applicable about the generated code,
20462 except for the ABI and the set of available instructions.
20463 The list of @var{cpu-type} values is the same as for @option{-march}.
20464 The default is the value used for @option{-march}.
20466 @item -mtpf-trace
20467 @itemx -mno-tpf-trace
20468 @opindex mtpf-trace
20469 @opindex mno-tpf-trace
20470 Generate code that adds (does not add) in TPF OS specific branches to trace
20471 routines in the operating system.  This option is off by default, even
20472 when compiling for the TPF OS@.
20474 @item -mfused-madd
20475 @itemx -mno-fused-madd
20476 @opindex mfused-madd
20477 @opindex mno-fused-madd
20478 Generate code that uses (does not use) the floating-point multiply and
20479 accumulate instructions.  These instructions are generated by default if
20480 hardware floating point is used.
20482 @item -mwarn-framesize=@var{framesize}
20483 @opindex mwarn-framesize
20484 Emit a warning if the current function exceeds the given frame size.  Because
20485 this is a compile-time check it doesn't need to be a real problem when the program
20486 runs.  It is intended to identify functions that most probably cause
20487 a stack overflow.  It is useful to be used in an environment with limited stack
20488 size e.g.@: the linux kernel.
20490 @item -mwarn-dynamicstack
20491 @opindex mwarn-dynamicstack
20492 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20493 arrays.  This is generally a bad idea with a limited stack size.
20495 @item -mstack-guard=@var{stack-guard}
20496 @itemx -mstack-size=@var{stack-size}
20497 @opindex mstack-guard
20498 @opindex mstack-size
20499 If these options are provided the S/390 back end emits additional instructions in
20500 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20501 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20502 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20503 the frame size of the compiled function is chosen.
20504 These options are intended to be used to help debugging stack overflow problems.
20505 The additionally emitted code causes only little overhead and hence can also be
20506 used in production-like systems without greater performance degradation.  The given
20507 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20508 @var{stack-guard} without exceeding 64k.
20509 In order to be efficient the extra code makes the assumption that the stack starts
20510 at an address aligned to the value given by @var{stack-size}.
20511 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20513 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20514 @opindex mhotpatch
20515 If the hotpatch option is enabled, a ``hot-patching'' function
20516 prologue is generated for all functions in the compilation unit.
20517 The funtion label is prepended with the given number of two-byte
20518 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20519 the label, 2 * @var{post-halfwords} bytes are appended, using the
20520 largest NOP like instructions the architecture allows (maximum
20521 1000000).
20523 If both arguments are zero, hotpatching is disabled.
20525 This option can be overridden for individual functions with the
20526 @code{hotpatch} attribute.
20527 @end table
20529 @node Score Options
20530 @subsection Score Options
20531 @cindex Score Options
20533 These options are defined for Score implementations:
20535 @table @gcctabopt
20536 @item -meb
20537 @opindex meb
20538 Compile code for big-endian mode.  This is the default.
20540 @item -mel
20541 @opindex mel
20542 Compile code for little-endian mode.
20544 @item -mnhwloop
20545 @opindex mnhwloop
20546 Disable generation of @code{bcnz} instructions.
20548 @item -muls
20549 @opindex muls
20550 Enable generation of unaligned load and store instructions.
20552 @item -mmac
20553 @opindex mmac
20554 Enable the use of multiply-accumulate instructions. Disabled by default.
20556 @item -mscore5
20557 @opindex mscore5
20558 Specify the SCORE5 as the target architecture.
20560 @item -mscore5u
20561 @opindex mscore5u
20562 Specify the SCORE5U of the target architecture.
20564 @item -mscore7
20565 @opindex mscore7
20566 Specify the SCORE7 as the target architecture. This is the default.
20568 @item -mscore7d
20569 @opindex mscore7d
20570 Specify the SCORE7D as the target architecture.
20571 @end table
20573 @node SH Options
20574 @subsection SH Options
20576 These @samp{-m} options are defined for the SH implementations:
20578 @table @gcctabopt
20579 @item -m1
20580 @opindex m1
20581 Generate code for the SH1.
20583 @item -m2
20584 @opindex m2
20585 Generate code for the SH2.
20587 @item -m2e
20588 Generate code for the SH2e.
20590 @item -m2a-nofpu
20591 @opindex m2a-nofpu
20592 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20593 that the floating-point unit is not used.
20595 @item -m2a-single-only
20596 @opindex m2a-single-only
20597 Generate code for the SH2a-FPU, in such a way that no double-precision
20598 floating-point operations are used.
20600 @item -m2a-single
20601 @opindex m2a-single
20602 Generate code for the SH2a-FPU assuming the floating-point unit is in
20603 single-precision mode by default.
20605 @item -m2a
20606 @opindex m2a
20607 Generate code for the SH2a-FPU assuming the floating-point unit is in
20608 double-precision mode by default.
20610 @item -m3
20611 @opindex m3
20612 Generate code for the SH3.
20614 @item -m3e
20615 @opindex m3e
20616 Generate code for the SH3e.
20618 @item -m4-nofpu
20619 @opindex m4-nofpu
20620 Generate code for the SH4 without a floating-point unit.
20622 @item -m4-single-only
20623 @opindex m4-single-only
20624 Generate code for the SH4 with a floating-point unit that only
20625 supports single-precision arithmetic.
20627 @item -m4-single
20628 @opindex m4-single
20629 Generate code for the SH4 assuming the floating-point unit is in
20630 single-precision mode by default.
20632 @item -m4
20633 @opindex m4
20634 Generate code for the SH4.
20636 @item -m4-100
20637 @opindex m4-100
20638 Generate code for SH4-100.
20640 @item -m4-100-nofpu
20641 @opindex m4-100-nofpu
20642 Generate code for SH4-100 in such a way that the
20643 floating-point unit is not used.
20645 @item -m4-100-single
20646 @opindex m4-100-single
20647 Generate code for SH4-100 assuming the floating-point unit is in
20648 single-precision mode by default.
20650 @item -m4-100-single-only
20651 @opindex m4-100-single-only
20652 Generate code for SH4-100 in such a way that no double-precision
20653 floating-point operations are used.
20655 @item -m4-200
20656 @opindex m4-200
20657 Generate code for SH4-200.
20659 @item -m4-200-nofpu
20660 @opindex m4-200-nofpu
20661 Generate code for SH4-200 without in such a way that the
20662 floating-point unit is not used.
20664 @item -m4-200-single
20665 @opindex m4-200-single
20666 Generate code for SH4-200 assuming the floating-point unit is in
20667 single-precision mode by default.
20669 @item -m4-200-single-only
20670 @opindex m4-200-single-only
20671 Generate code for SH4-200 in such a way that no double-precision
20672 floating-point operations are used.
20674 @item -m4-300
20675 @opindex m4-300
20676 Generate code for SH4-300.
20678 @item -m4-300-nofpu
20679 @opindex m4-300-nofpu
20680 Generate code for SH4-300 without in such a way that the
20681 floating-point unit is not used.
20683 @item -m4-300-single
20684 @opindex m4-300-single
20685 Generate code for SH4-300 in such a way that no double-precision
20686 floating-point operations are used.
20688 @item -m4-300-single-only
20689 @opindex m4-300-single-only
20690 Generate code for SH4-300 in such a way that no double-precision
20691 floating-point operations are used.
20693 @item -m4-340
20694 @opindex m4-340
20695 Generate code for SH4-340 (no MMU, no FPU).
20697 @item -m4-500
20698 @opindex m4-500
20699 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20700 assembler.
20702 @item -m4a-nofpu
20703 @opindex m4a-nofpu
20704 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20705 floating-point unit is not used.
20707 @item -m4a-single-only
20708 @opindex m4a-single-only
20709 Generate code for the SH4a, in such a way that no double-precision
20710 floating-point operations are used.
20712 @item -m4a-single
20713 @opindex m4a-single
20714 Generate code for the SH4a assuming the floating-point unit is in
20715 single-precision mode by default.
20717 @item -m4a
20718 @opindex m4a
20719 Generate code for the SH4a.
20721 @item -m4al
20722 @opindex m4al
20723 Same as @option{-m4a-nofpu}, except that it implicitly passes
20724 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20725 instructions at the moment.
20727 @item -m5-32media
20728 @opindex m5-32media
20729 Generate 32-bit code for SHmedia.
20731 @item -m5-32media-nofpu
20732 @opindex m5-32media-nofpu
20733 Generate 32-bit code for SHmedia in such a way that the
20734 floating-point unit is not used.
20736 @item -m5-64media
20737 @opindex m5-64media
20738 Generate 64-bit code for SHmedia.
20740 @item -m5-64media-nofpu
20741 @opindex m5-64media-nofpu
20742 Generate 64-bit code for SHmedia in such a way that the
20743 floating-point unit is not used.
20745 @item -m5-compact
20746 @opindex m5-compact
20747 Generate code for SHcompact.
20749 @item -m5-compact-nofpu
20750 @opindex m5-compact-nofpu
20751 Generate code for SHcompact in such a way that the
20752 floating-point unit is not used.
20754 @item -mb
20755 @opindex mb
20756 Compile code for the processor in big-endian mode.
20758 @item -ml
20759 @opindex ml
20760 Compile code for the processor in little-endian mode.
20762 @item -mdalign
20763 @opindex mdalign
20764 Align doubles at 64-bit boundaries.  Note that this changes the calling
20765 conventions, and thus some functions from the standard C library do
20766 not work unless you recompile it first with @option{-mdalign}.
20768 @item -mrelax
20769 @opindex mrelax
20770 Shorten some address references at link time, when possible; uses the
20771 linker option @option{-relax}.
20773 @item -mbigtable
20774 @opindex mbigtable
20775 Use 32-bit offsets in @code{switch} tables.  The default is to use
20776 16-bit offsets.
20778 @item -mbitops
20779 @opindex mbitops
20780 Enable the use of bit manipulation instructions on SH2A.
20782 @item -mfmovd
20783 @opindex mfmovd
20784 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20785 alignment constraints.
20787 @item -mrenesas
20788 @opindex mrenesas
20789 Comply with the calling conventions defined by Renesas.
20791 @item -mno-renesas
20792 @opindex mno-renesas
20793 Comply with the calling conventions defined for GCC before the Renesas
20794 conventions were available.  This option is the default for all
20795 targets of the SH toolchain.
20797 @item -mnomacsave
20798 @opindex mnomacsave
20799 Mark the @code{MAC} register as call-clobbered, even if
20800 @option{-mrenesas} is given.
20802 @item -mieee
20803 @itemx -mno-ieee
20804 @opindex mieee
20805 @opindex mno-ieee
20806 Control the IEEE compliance of floating-point comparisons, which affects the
20807 handling of cases where the result of a comparison is unordered.  By default
20808 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20809 enabled @option{-mno-ieee} is implicitly set, which results in faster
20810 floating-point greater-equal and less-equal comparisons.  The implcit settings
20811 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20813 @item -minline-ic_invalidate
20814 @opindex minline-ic_invalidate
20815 Inline code to invalidate instruction cache entries after setting up
20816 nested function trampolines.
20817 This option has no effect if @option{-musermode} is in effect and the selected
20818 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20819 instruction.
20820 If the selected code generation option does not allow the use of the @code{icbi}
20821 instruction, and @option{-musermode} is not in effect, the inlined code
20822 manipulates the instruction cache address array directly with an associative
20823 write.  This not only requires privileged mode at run time, but it also
20824 fails if the cache line had been mapped via the TLB and has become unmapped.
20826 @item -misize
20827 @opindex misize
20828 Dump instruction size and location in the assembly code.
20830 @item -mpadstruct
20831 @opindex mpadstruct
20832 This option is deprecated.  It pads structures to multiple of 4 bytes,
20833 which is incompatible with the SH ABI@.
20835 @item -matomic-model=@var{model}
20836 @opindex matomic-model=@var{model}
20837 Sets the model of atomic operations and additional parameters as a comma
20838 separated list.  For details on the atomic built-in functions see
20839 @ref{__atomic Builtins}.  The following models and parameters are supported:
20841 @table @samp
20843 @item none
20844 Disable compiler generated atomic sequences and emit library calls for atomic
20845 operations.  This is the default if the target is not @code{sh*-*-linux*}.
20847 @item soft-gusa
20848 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20849 built-in functions.  The generated atomic sequences require additional support
20850 from the interrupt/exception handling code of the system and are only suitable
20851 for SH3* and SH4* single-core systems.  This option is enabled by default when
20852 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20853 this option also partially utilizes the hardware atomic instructions
20854 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20855 @samp{strict} is specified.  
20857 @item soft-tcb
20858 Generate software atomic sequences that use a variable in the thread control
20859 block.  This is a variation of the gUSA sequences which can also be used on
20860 SH1* and SH2* targets.  The generated atomic sequences require additional
20861 support from the interrupt/exception handling code of the system and are only
20862 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20863 parameter has to be specified as well.
20865 @item soft-imask
20866 Generate software atomic sequences that temporarily disable interrupts by
20867 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20868 in privileged mode and is only suitable for single-core systems.  Additional
20869 support from the interrupt/exception handling code of the system is not
20870 required.  This model is enabled by default when the target is
20871 @code{sh*-*-linux*} and SH1* or SH2*.
20873 @item hard-llcs
20874 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20875 instructions only.  This is only available on SH4A and is suitable for
20876 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20877 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20878 Code compiled with this option is also compatible with other software
20879 atomic model interrupt/exception handling systems if executed on an SH4A
20880 system.  Additional support from the interrupt/exception handling code of the
20881 system is not required for this model.
20883 @item gbr-offset=
20884 This parameter specifies the offset in bytes of the variable in the thread
20885 control block structure that should be used by the generated atomic sequences
20886 when the @samp{soft-tcb} model has been selected.  For other models this
20887 parameter is ignored.  The specified value must be an integer multiple of four
20888 and in the range 0-1020.
20890 @item strict
20891 This parameter prevents mixed usage of multiple atomic models, even if they
20892 are compatible, and makes the compiler generate atomic sequences of the
20893 specified model only.
20895 @end table
20897 @item -mtas
20898 @opindex mtas
20899 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20900 Notice that depending on the particular hardware and software configuration
20901 this can degrade overall performance due to the operand cache line flushes
20902 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20903 processors the @code{tas.b} instruction must be used with caution since it
20904 can result in data corruption for certain cache configurations.
20906 @item -mprefergot
20907 @opindex mprefergot
20908 When generating position-independent code, emit function calls using
20909 the Global Offset Table instead of the Procedure Linkage Table.
20911 @item -musermode
20912 @itemx -mno-usermode
20913 @opindex musermode
20914 @opindex mno-usermode
20915 Don't allow (allow) the compiler generating privileged mode code.  Specifying
20916 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
20917 inlined code would not work in user mode.  @option{-musermode} is the default
20918 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
20919 @option{-musermode} has no effect, since there is no user mode.
20921 @item -multcost=@var{number}
20922 @opindex multcost=@var{number}
20923 Set the cost to assume for a multiply insn.
20925 @item -mdiv=@var{strategy}
20926 @opindex mdiv=@var{strategy}
20927 Set the division strategy to be used for integer division operations.
20928 For SHmedia @var{strategy} can be one of: 
20930 @table @samp
20932 @item fp 
20933 Performs the operation in floating point.  This has a very high latency,
20934 but needs only a few instructions, so it might be a good choice if
20935 your code has enough easily-exploitable ILP to allow the compiler to
20936 schedule the floating-point instructions together with other instructions.
20937 Division by zero causes a floating-point exception.
20939 @item inv
20940 Uses integer operations to calculate the inverse of the divisor,
20941 and then multiplies the dividend with the inverse.  This strategy allows
20942 CSE and hoisting of the inverse calculation.  Division by zero calculates
20943 an unspecified result, but does not trap.
20945 @item inv:minlat
20946 A variant of @samp{inv} where, if no CSE or hoisting opportunities
20947 have been found, or if the entire operation has been hoisted to the same
20948 place, the last stages of the inverse calculation are intertwined with the
20949 final multiply to reduce the overall latency, at the expense of using a few
20950 more instructions, and thus offering fewer scheduling opportunities with
20951 other code.
20953 @item call
20954 Calls a library function that usually implements the @samp{inv:minlat}
20955 strategy.
20956 This gives high code density for @code{m5-*media-nofpu} compilations.
20958 @item call2
20959 Uses a different entry point of the same library function, where it
20960 assumes that a pointer to a lookup table has already been set up, which
20961 exposes the pointer load to CSE and code hoisting optimizations.
20963 @item inv:call
20964 @itemx inv:call2
20965 @itemx inv:fp
20966 Use the @samp{inv} algorithm for initial
20967 code generation, but if the code stays unoptimized, revert to the @samp{call},
20968 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
20969 potentially-trapping side effect of division by zero is carried by a
20970 separate instruction, so it is possible that all the integer instructions
20971 are hoisted out, but the marker for the side effect stays where it is.
20972 A recombination to floating-point operations or a call is not possible
20973 in that case.
20975 @item inv20u
20976 @itemx inv20l
20977 Variants of the @samp{inv:minlat} strategy.  In the case
20978 that the inverse calculation is not separated from the multiply, they speed
20979 up division where the dividend fits into 20 bits (plus sign where applicable)
20980 by inserting a test to skip a number of operations in this case; this test
20981 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
20982 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
20984 @end table
20986 For targets other than SHmedia @var{strategy} can be one of:
20988 @table @samp
20990 @item call-div1
20991 Calls a library function that uses the single-step division instruction
20992 @code{div1} to perform the operation.  Division by zero calculates an
20993 unspecified result and does not trap.  This is the default except for SH4,
20994 SH2A and SHcompact.
20996 @item call-fp
20997 Calls a library function that performs the operation in double precision
20998 floating point.  Division by zero causes a floating-point exception.  This is
20999 the default for SHcompact with FPU.  Specifying this for targets that do not
21000 have a double precision FPU defaults to @code{call-div1}.
21002 @item call-table
21003 Calls a library function that uses a lookup table for small divisors and
21004 the @code{div1} instruction with case distinction for larger divisors.  Division
21005 by zero calculates an unspecified result and does not trap.  This is the default
21006 for SH4.  Specifying this for targets that do not have dynamic shift
21007 instructions defaults to @code{call-div1}.
21009 @end table
21011 When a division strategy has not been specified the default strategy is
21012 selected based on the current target.  For SH2A the default strategy is to
21013 use the @code{divs} and @code{divu} instructions instead of library function
21014 calls.
21016 @item -maccumulate-outgoing-args
21017 @opindex maccumulate-outgoing-args
21018 Reserve space once for outgoing arguments in the function prologue rather
21019 than around each call.  Generally beneficial for performance and size.  Also
21020 needed for unwinding to avoid changing the stack frame around conditional code.
21022 @item -mdivsi3_libfunc=@var{name}
21023 @opindex mdivsi3_libfunc=@var{name}
21024 Set the name of the library function used for 32-bit signed division to
21025 @var{name}.
21026 This only affects the name used in the @samp{call} and @samp{inv:call}
21027 division strategies, and the compiler still expects the same
21028 sets of input/output/clobbered registers as if this option were not present.
21030 @item -mfixed-range=@var{register-range}
21031 @opindex mfixed-range
21032 Generate code treating the given register range as fixed registers.
21033 A fixed register is one that the register allocator can not use.  This is
21034 useful when compiling kernel code.  A register range is specified as
21035 two registers separated by a dash.  Multiple register ranges can be
21036 specified separated by a comma.
21038 @item -mindexed-addressing
21039 @opindex mindexed-addressing
21040 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21041 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21042 semantics for the indexed addressing mode.  The architecture allows the
21043 implementation of processors with 64-bit MMU, which the OS could use to
21044 get 32-bit addressing, but since no current hardware implementation supports
21045 this or any other way to make the indexed addressing mode safe to use in
21046 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21048 @item -mgettrcost=@var{number}
21049 @opindex mgettrcost=@var{number}
21050 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21051 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21053 @item -mpt-fixed
21054 @opindex mpt-fixed
21055 Assume @code{pt*} instructions won't trap.  This generally generates
21056 better-scheduled code, but is unsafe on current hardware.
21057 The current architecture
21058 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21059 anded with 3 is 3.
21060 This has the unintentional effect of making it unsafe to schedule these
21061 instructions before a branch, or hoist them out of a loop.  For example,
21062 @code{__do_global_ctors}, a part of @file{libgcc}
21063 that runs constructors at program
21064 startup, calls functions in a list which is delimited by @minus{}1.  With the
21065 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21066 That means that all the constructors run a bit more quickly, but when
21067 the loop comes to the end of the list, the program crashes because @code{ptabs}
21068 loads @minus{}1 into a target register.  
21070 Since this option is unsafe for any
21071 hardware implementing the current architecture specification, the default
21072 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21073 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21074 this deters register allocation from using target registers for storing
21075 ordinary integers.
21077 @item -minvalid-symbols
21078 @opindex minvalid-symbols
21079 Assume symbols might be invalid.  Ordinary function symbols generated by
21080 the compiler are always valid to load with
21081 @code{movi}/@code{shori}/@code{ptabs} or
21082 @code{movi}/@code{shori}/@code{ptrel},
21083 but with assembler and/or linker tricks it is possible
21084 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21085 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21086 It prevents cross-basic-block CSE, hoisting and most scheduling
21087 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21089 @item -mbranch-cost=@var{num}
21090 @opindex mbranch-cost=@var{num}
21091 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21092 make the compiler try to generate more branch-free code if possible.  
21093 If not specified the value is selected depending on the processor type that
21094 is being compiled for.
21096 @item -mzdcbranch
21097 @itemx -mno-zdcbranch
21098 @opindex mzdcbranch
21099 @opindex mno-zdcbranch
21100 Assume (do not assume) that zero displacement conditional branch instructions
21101 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21102 compiler prefers zero displacement branch code sequences.  This is
21103 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21104 disabled by specifying @option{-mno-zdcbranch}.
21106 @item -mcbranch-force-delay-slot
21107 @opindex mcbranch-force-delay-slot
21108 Force the usage of delay slots for conditional branches, which stuffs the delay
21109 slot with a @code{nop} if a suitable instruction can't be found.  By default
21110 this option is disabled.  It can be enabled to work around hardware bugs as
21111 found in the original SH7055.
21113 @item -mfused-madd
21114 @itemx -mno-fused-madd
21115 @opindex mfused-madd
21116 @opindex mno-fused-madd
21117 Generate code that uses (does not use) the floating-point multiply and
21118 accumulate instructions.  These instructions are generated by default
21119 if hardware floating point is used.  The machine-dependent
21120 @option{-mfused-madd} option is now mapped to the machine-independent
21121 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21122 mapped to @option{-ffp-contract=off}.
21124 @item -mfsca
21125 @itemx -mno-fsca
21126 @opindex mfsca
21127 @opindex mno-fsca
21128 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21129 and cosine approximations.  The option @option{-mfsca} must be used in
21130 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21131 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21132 approximations even if @option{-funsafe-math-optimizations} is in effect.
21134 @item -mfsrra
21135 @itemx -mno-fsrra
21136 @opindex mfsrra
21137 @opindex mno-fsrra
21138 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21139 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21140 in combination with @option{-funsafe-math-optimizations} and
21141 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21142 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21143 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21144 in effect.
21146 @item -mpretend-cmove
21147 @opindex mpretend-cmove
21148 Prefer zero-displacement conditional branches for conditional move instruction
21149 patterns.  This can result in faster code on the SH4 processor.
21151 @end table
21153 @node Solaris 2 Options
21154 @subsection Solaris 2 Options
21155 @cindex Solaris 2 options
21157 These @samp{-m} options are supported on Solaris 2:
21159 @table @gcctabopt
21160 @item -mclear-hwcap
21161 @opindex mclear-hwcap
21162 @option{-mclear-hwcap} tells the compiler to remove the hardware
21163 capabilities generated by the Solaris assembler.  This is only necessary
21164 when object files use ISA extensions not supported by the current
21165 machine, but check at runtime whether or not to use them.
21167 @item -mimpure-text
21168 @opindex mimpure-text
21169 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21170 the compiler to not pass @option{-z text} to the linker when linking a
21171 shared object.  Using this option, you can link position-dependent
21172 code into a shared object.
21174 @option{-mimpure-text} suppresses the ``relocations remain against
21175 allocatable but non-writable sections'' linker error message.
21176 However, the necessary relocations trigger copy-on-write, and the
21177 shared object is not actually shared across processes.  Instead of
21178 using @option{-mimpure-text}, you should compile all source code with
21179 @option{-fpic} or @option{-fPIC}.
21181 @end table
21183 These switches are supported in addition to the above on Solaris 2:
21185 @table @gcctabopt
21186 @item -pthreads
21187 @opindex pthreads
21188 Add support for multithreading using the POSIX threads library.  This
21189 option sets flags for both the preprocessor and linker.  This option does
21190 not affect the thread safety of object code produced  by the compiler or
21191 that of libraries supplied with it.
21193 @item -pthread
21194 @opindex pthread
21195 This is a synonym for @option{-pthreads}.
21196 @end table
21198 @node SPARC Options
21199 @subsection SPARC Options
21200 @cindex SPARC options
21202 These @samp{-m} options are supported on the SPARC:
21204 @table @gcctabopt
21205 @item -mno-app-regs
21206 @itemx -mapp-regs
21207 @opindex mno-app-regs
21208 @opindex mapp-regs
21209 Specify @option{-mapp-regs} to generate output using the global registers
21210 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21211 global register 1, each global register 2 through 4 is then treated as an
21212 allocable register that is clobbered by function calls.  This is the default.
21214 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21215 specify @option{-mno-app-regs}.  You should compile libraries and system
21216 software with this option.
21218 @item -mflat
21219 @itemx -mno-flat
21220 @opindex mflat
21221 @opindex mno-flat
21222 With @option{-mflat}, the compiler does not generate save/restore instructions
21223 and uses a ``flat'' or single register window model.  This model is compatible
21224 with the regular register window model.  The local registers and the input
21225 registers (0--5) are still treated as ``call-saved'' registers and are
21226 saved on the stack as needed.
21228 With @option{-mno-flat} (the default), the compiler generates save/restore
21229 instructions (except for leaf functions).  This is the normal operating mode.
21231 @item -mfpu
21232 @itemx -mhard-float
21233 @opindex mfpu
21234 @opindex mhard-float
21235 Generate output containing floating-point instructions.  This is the
21236 default.
21238 @item -mno-fpu
21239 @itemx -msoft-float
21240 @opindex mno-fpu
21241 @opindex msoft-float
21242 Generate output containing library calls for floating point.
21243 @strong{Warning:} the requisite libraries are not available for all SPARC
21244 targets.  Normally the facilities of the machine's usual C compiler are
21245 used, but this cannot be done directly in cross-compilation.  You must make
21246 your own arrangements to provide suitable library functions for
21247 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21248 @samp{sparclite-*-*} do provide software floating-point support.
21250 @option{-msoft-float} changes the calling convention in the output file;
21251 therefore, it is only useful if you compile @emph{all} of a program with
21252 this option.  In particular, you need to compile @file{libgcc.a}, the
21253 library that comes with GCC, with @option{-msoft-float} in order for
21254 this to work.
21256 @item -mhard-quad-float
21257 @opindex mhard-quad-float
21258 Generate output containing quad-word (long double) floating-point
21259 instructions.
21261 @item -msoft-quad-float
21262 @opindex msoft-quad-float
21263 Generate output containing library calls for quad-word (long double)
21264 floating-point instructions.  The functions called are those specified
21265 in the SPARC ABI@.  This is the default.
21267 As of this writing, there are no SPARC implementations that have hardware
21268 support for the quad-word floating-point instructions.  They all invoke
21269 a trap handler for one of these instructions, and then the trap handler
21270 emulates the effect of the instruction.  Because of the trap handler overhead,
21271 this is much slower than calling the ABI library routines.  Thus the
21272 @option{-msoft-quad-float} option is the default.
21274 @item -mno-unaligned-doubles
21275 @itemx -munaligned-doubles
21276 @opindex mno-unaligned-doubles
21277 @opindex munaligned-doubles
21278 Assume that doubles have 8-byte alignment.  This is the default.
21280 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21281 alignment only if they are contained in another type, or if they have an
21282 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21283 Specifying this option avoids some rare compatibility problems with code
21284 generated by other compilers.  It is not the default because it results
21285 in a performance loss, especially for floating-point code.
21287 @item -muser-mode
21288 @itemx -mno-user-mode
21289 @opindex muser-mode
21290 @opindex mno-user-mode
21291 Do not generate code that can only run in supervisor mode.  This is relevant
21292 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21293 default is @option{-mno-user-mode}.
21295 @item -mno-faster-structs
21296 @itemx -mfaster-structs
21297 @opindex mno-faster-structs
21298 @opindex mfaster-structs
21299 With @option{-mfaster-structs}, the compiler assumes that structures
21300 should have 8-byte alignment.  This enables the use of pairs of
21301 @code{ldd} and @code{std} instructions for copies in structure
21302 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21303 However, the use of this changed alignment directly violates the SPARC
21304 ABI@.  Thus, it's intended only for use on targets where the developer
21305 acknowledges that their resulting code is not directly in line with
21306 the rules of the ABI@.
21308 @item -mcpu=@var{cpu_type}
21309 @opindex mcpu
21310 Set the instruction set, register set, and instruction scheduling parameters
21311 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21312 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21313 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21314 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21315 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21316 @samp{niagara3} and @samp{niagara4}.
21318 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21319 which selects the best architecture option for the host processor.
21320 @option{-mcpu=native} has no effect if GCC does not recognize
21321 the processor.
21323 Default instruction scheduling parameters are used for values that select
21324 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21325 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21327 Here is a list of each supported architecture and their supported
21328 implementations.
21330 @table @asis
21331 @item v7
21332 cypress, leon3v7
21334 @item v8
21335 supersparc, hypersparc, leon, leon3
21337 @item sparclite
21338 f930, f934, sparclite86x
21340 @item sparclet
21341 tsc701
21343 @item v9
21344 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21345 @end table
21347 By default (unless configured otherwise), GCC generates code for the V7
21348 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21349 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21350 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21351 SPARCStation 1, 2, IPX etc.
21353 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21354 architecture.  The only difference from V7 code is that the compiler emits
21355 the integer multiply and integer divide instructions which exist in SPARC-V8
21356 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21357 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21358 2000 series.
21360 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21361 the SPARC architecture.  This adds the integer multiply, integer divide step
21362 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21363 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21364 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21365 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21366 MB86934 chip, which is the more recent SPARClite with FPU@.
21368 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21369 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21370 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21371 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21372 optimizes it for the TEMIC SPARClet chip.
21374 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21375 architecture.  This adds 64-bit integer and floating-point move instructions,
21376 3 additional floating-point condition code registers and conditional move
21377 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21378 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21379 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21380 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21381 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21382 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21383 additionally optimizes it for Sun UltraSPARC T2 chips. With
21384 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21385 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21386 additionally optimizes it for Sun UltraSPARC T4 chips.
21388 @item -mtune=@var{cpu_type}
21389 @opindex mtune
21390 Set the instruction scheduling parameters for machine type
21391 @var{cpu_type}, but do not set the instruction set or register set that the
21392 option @option{-mcpu=@var{cpu_type}} does.
21394 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21395 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21396 that select a particular CPU implementation.  Those are @samp{cypress},
21397 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21398 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21399 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21400 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21401 toolchains, @samp{native} can also be used.
21403 @item -mv8plus
21404 @itemx -mno-v8plus
21405 @opindex mv8plus
21406 @opindex mno-v8plus
21407 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21408 difference from the V8 ABI is that the global and out registers are
21409 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21410 mode for all SPARC-V9 processors.
21412 @item -mvis
21413 @itemx -mno-vis
21414 @opindex mvis
21415 @opindex mno-vis
21416 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21417 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21419 @item -mvis2
21420 @itemx -mno-vis2
21421 @opindex mvis2
21422 @opindex mno-vis2
21423 With @option{-mvis2}, GCC generates code that takes advantage of
21424 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21425 default is @option{-mvis2} when targeting a cpu that supports such
21426 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21427 also sets @option{-mvis}.
21429 @item -mvis3
21430 @itemx -mno-vis3
21431 @opindex mvis3
21432 @opindex mno-vis3
21433 With @option{-mvis3}, GCC generates code that takes advantage of
21434 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21435 default is @option{-mvis3} when targeting a cpu that supports such
21436 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21437 also sets @option{-mvis2} and @option{-mvis}.
21439 @item -mcbcond
21440 @itemx -mno-cbcond
21441 @opindex mcbcond
21442 @opindex mno-cbcond
21443 With @option{-mcbcond}, GCC generates code that takes advantage of
21444 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21445 The default is @option{-mcbcond} when targeting a cpu that supports such
21446 instructions, such as niagara-4 and later.
21448 @item -mpopc
21449 @itemx -mno-popc
21450 @opindex mpopc
21451 @opindex mno-popc
21452 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21453 population count instruction.  The default is @option{-mpopc}
21454 when targeting a cpu that supports such instructions, such as Niagara-2 and
21455 later.
21457 @item -mfmaf
21458 @itemx -mno-fmaf
21459 @opindex mfmaf
21460 @opindex mno-fmaf
21461 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21462 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21463 when targeting a cpu that supports such instructions, such as Niagara-3 and
21464 later.
21466 @item -mfix-at697f
21467 @opindex mfix-at697f
21468 Enable the documented workaround for the single erratum of the Atmel AT697F
21469 processor (which corresponds to erratum #13 of the AT697E processor).
21471 @item -mfix-ut699
21472 @opindex mfix-ut699
21473 Enable the documented workarounds for the floating-point errata and the data
21474 cache nullify errata of the UT699 processor.
21475 @end table
21477 These @samp{-m} options are supported in addition to the above
21478 on SPARC-V9 processors in 64-bit environments:
21480 @table @gcctabopt
21481 @item -m32
21482 @itemx -m64
21483 @opindex m32
21484 @opindex m64
21485 Generate code for a 32-bit or 64-bit environment.
21486 The 32-bit environment sets int, long and pointer to 32 bits.
21487 The 64-bit environment sets int to 32 bits and long and pointer
21488 to 64 bits.
21490 @item -mcmodel=@var{which}
21491 @opindex mcmodel
21492 Set the code model to one of
21494 @table @samp
21495 @item medlow
21496 The Medium/Low code model: 64-bit addresses, programs
21497 must be linked in the low 32 bits of memory.  Programs can be statically
21498 or dynamically linked.
21500 @item medmid
21501 The Medium/Middle code model: 64-bit addresses, programs
21502 must be linked in the low 44 bits of memory, the text and data segments must
21503 be less than 2GB in size and the data segment must be located within 2GB of
21504 the text segment.
21506 @item medany
21507 The Medium/Anywhere code model: 64-bit addresses, programs
21508 may be linked anywhere in memory, the text and data segments must be less
21509 than 2GB in size and the data segment must be located within 2GB of the
21510 text segment.
21512 @item embmedany
21513 The Medium/Anywhere code model for embedded systems:
21514 64-bit addresses, the text and data segments must be less than 2GB in
21515 size, both starting anywhere in memory (determined at link time).  The
21516 global register %g4 points to the base of the data segment.  Programs
21517 are statically linked and PIC is not supported.
21518 @end table
21520 @item -mmemory-model=@var{mem-model}
21521 @opindex mmemory-model
21522 Set the memory model in force on the processor to one of
21524 @table @samp
21525 @item default
21526 The default memory model for the processor and operating system.
21528 @item rmo
21529 Relaxed Memory Order
21531 @item pso
21532 Partial Store Order
21534 @item tso
21535 Total Store Order
21537 @item sc
21538 Sequential Consistency
21539 @end table
21541 These memory models are formally defined in Appendix D of the Sparc V9
21542 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21544 @item -mstack-bias
21545 @itemx -mno-stack-bias
21546 @opindex mstack-bias
21547 @opindex mno-stack-bias
21548 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21549 frame pointer if present, are offset by @minus{}2047 which must be added back
21550 when making stack frame references.  This is the default in 64-bit mode.
21551 Otherwise, assume no such offset is present.
21552 @end table
21554 @node SPU Options
21555 @subsection SPU Options
21556 @cindex SPU options
21558 These @samp{-m} options are supported on the SPU:
21560 @table @gcctabopt
21561 @item -mwarn-reloc
21562 @itemx -merror-reloc
21563 @opindex mwarn-reloc
21564 @opindex merror-reloc
21566 The loader for SPU does not handle dynamic relocations.  By default, GCC
21567 gives an error when it generates code that requires a dynamic
21568 relocation.  @option{-mno-error-reloc} disables the error,
21569 @option{-mwarn-reloc} generates a warning instead.
21571 @item -msafe-dma
21572 @itemx -munsafe-dma
21573 @opindex msafe-dma
21574 @opindex munsafe-dma
21576 Instructions that initiate or test completion of DMA must not be
21577 reordered with respect to loads and stores of the memory that is being
21578 accessed.
21579 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21580 memory accesses, but that can lead to inefficient code in places where the
21581 memory is known to not change.  Rather than mark the memory as volatile,
21582 you can use @option{-msafe-dma} to tell the compiler to treat
21583 the DMA instructions as potentially affecting all memory.  
21585 @item -mbranch-hints
21586 @opindex mbranch-hints
21588 By default, GCC generates a branch hint instruction to avoid
21589 pipeline stalls for always-taken or probably-taken branches.  A hint
21590 is not generated closer than 8 instructions away from its branch.
21591 There is little reason to disable them, except for debugging purposes,
21592 or to make an object a little bit smaller.
21594 @item -msmall-mem
21595 @itemx -mlarge-mem
21596 @opindex msmall-mem
21597 @opindex mlarge-mem
21599 By default, GCC generates code assuming that addresses are never larger
21600 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21601 a full 32-bit address.
21603 @item -mstdmain
21604 @opindex mstdmain
21606 By default, GCC links against startup code that assumes the SPU-style
21607 main function interface (which has an unconventional parameter list).
21608 With @option{-mstdmain}, GCC links your program against startup
21609 code that assumes a C99-style interface to @code{main}, including a
21610 local copy of @code{argv} strings.
21612 @item -mfixed-range=@var{register-range}
21613 @opindex mfixed-range
21614 Generate code treating the given register range as fixed registers.
21615 A fixed register is one that the register allocator cannot use.  This is
21616 useful when compiling kernel code.  A register range is specified as
21617 two registers separated by a dash.  Multiple register ranges can be
21618 specified separated by a comma.
21620 @item -mea32
21621 @itemx -mea64
21622 @opindex mea32
21623 @opindex mea64
21624 Compile code assuming that pointers to the PPU address space accessed
21625 via the @code{__ea} named address space qualifier are either 32 or 64
21626 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21627 all object code in an executable must be compiled with the same setting.
21629 @item -maddress-space-conversion
21630 @itemx -mno-address-space-conversion
21631 @opindex maddress-space-conversion
21632 @opindex mno-address-space-conversion
21633 Allow/disallow treating the @code{__ea} address space as superset
21634 of the generic address space.  This enables explicit type casts
21635 between @code{__ea} and generic pointer as well as implicit
21636 conversions of generic pointers to @code{__ea} pointers.  The
21637 default is to allow address space pointer conversions.
21639 @item -mcache-size=@var{cache-size}
21640 @opindex mcache-size
21641 This option controls the version of libgcc that the compiler links to an
21642 executable and selects a software-managed cache for accessing variables
21643 in the @code{__ea} address space with a particular cache size.  Possible
21644 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21645 and @samp{128}.  The default cache size is 64KB.
21647 @item -matomic-updates
21648 @itemx -mno-atomic-updates
21649 @opindex matomic-updates
21650 @opindex mno-atomic-updates
21651 This option controls the version of libgcc that the compiler links to an
21652 executable and selects whether atomic updates to the software-managed
21653 cache of PPU-side variables are used.  If you use atomic updates, changes
21654 to a PPU variable from SPU code using the @code{__ea} named address space
21655 qualifier do not interfere with changes to other PPU variables residing
21656 in the same cache line from PPU code.  If you do not use atomic updates,
21657 such interference may occur; however, writing back cache lines is
21658 more efficient.  The default behavior is to use atomic updates.
21660 @item -mdual-nops
21661 @itemx -mdual-nops=@var{n}
21662 @opindex mdual-nops
21663 By default, GCC inserts nops to increase dual issue when it expects
21664 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21665 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21666 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21668 @item -mhint-max-nops=@var{n}
21669 @opindex mhint-max-nops
21670 Maximum number of nops to insert for a branch hint.  A branch hint must
21671 be at least 8 instructions away from the branch it is affecting.  GCC
21672 inserts up to @var{n} nops to enforce this, otherwise it does not
21673 generate the branch hint.
21675 @item -mhint-max-distance=@var{n}
21676 @opindex mhint-max-distance
21677 The encoding of the branch hint instruction limits the hint to be within
21678 256 instructions of the branch it is affecting.  By default, GCC makes
21679 sure it is within 125.
21681 @item -msafe-hints
21682 @opindex msafe-hints
21683 Work around a hardware bug that causes the SPU to stall indefinitely.
21684 By default, GCC inserts the @code{hbrp} instruction to make sure
21685 this stall won't happen.
21687 @end table
21689 @node System V Options
21690 @subsection Options for System V
21692 These additional options are available on System V Release 4 for
21693 compatibility with other compilers on those systems:
21695 @table @gcctabopt
21696 @item -G
21697 @opindex G
21698 Create a shared object.
21699 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21701 @item -Qy
21702 @opindex Qy
21703 Identify the versions of each tool used by the compiler, in a
21704 @code{.ident} assembler directive in the output.
21706 @item -Qn
21707 @opindex Qn
21708 Refrain from adding @code{.ident} directives to the output file (this is
21709 the default).
21711 @item -YP,@var{dirs}
21712 @opindex YP
21713 Search the directories @var{dirs}, and no others, for libraries
21714 specified with @option{-l}.
21716 @item -Ym,@var{dir}
21717 @opindex Ym
21718 Look in the directory @var{dir} to find the M4 preprocessor.
21719 The assembler uses this option.
21720 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21721 @c the generic assembler that comes with Solaris takes just -Ym.
21722 @end table
21724 @node TILE-Gx Options
21725 @subsection TILE-Gx Options
21726 @cindex TILE-Gx options
21728 These @samp{-m} options are supported on the TILE-Gx:
21730 @table @gcctabopt
21731 @item -mcmodel=small
21732 @opindex mcmodel=small
21733 Generate code for the small model.  The distance for direct calls is
21734 limited to 500M in either direction.  PC-relative addresses are 32
21735 bits.  Absolute addresses support the full address range.
21737 @item -mcmodel=large
21738 @opindex mcmodel=large
21739 Generate code for the large model.  There is no limitation on call
21740 distance, pc-relative addresses, or absolute addresses.
21742 @item -mcpu=@var{name}
21743 @opindex mcpu
21744 Selects the type of CPU to be targeted.  Currently the only supported
21745 type is @samp{tilegx}.
21747 @item -m32
21748 @itemx -m64
21749 @opindex m32
21750 @opindex m64
21751 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21752 environment sets int, long, and pointer to 32 bits.  The 64-bit
21753 environment sets int to 32 bits and long and pointer to 64 bits.
21755 @item -mbig-endian
21756 @itemx -mlittle-endian
21757 @opindex mbig-endian
21758 @opindex mlittle-endian
21759 Generate code in big/little endian mode, respectively.
21760 @end table
21762 @node TILEPro Options
21763 @subsection TILEPro Options
21764 @cindex TILEPro options
21766 These @samp{-m} options are supported on the TILEPro:
21768 @table @gcctabopt
21769 @item -mcpu=@var{name}
21770 @opindex mcpu
21771 Selects the type of CPU to be targeted.  Currently the only supported
21772 type is @samp{tilepro}.
21774 @item -m32
21775 @opindex m32
21776 Generate code for a 32-bit environment, which sets int, long, and
21777 pointer to 32 bits.  This is the only supported behavior so the flag
21778 is essentially ignored.
21779 @end table
21781 @node V850 Options
21782 @subsection V850 Options
21783 @cindex V850 Options
21785 These @samp{-m} options are defined for V850 implementations:
21787 @table @gcctabopt
21788 @item -mlong-calls
21789 @itemx -mno-long-calls
21790 @opindex mlong-calls
21791 @opindex mno-long-calls
21792 Treat all calls as being far away (near).  If calls are assumed to be
21793 far away, the compiler always loads the function's address into a
21794 register, and calls indirect through the pointer.
21796 @item -mno-ep
21797 @itemx -mep
21798 @opindex mno-ep
21799 @opindex mep
21800 Do not optimize (do optimize) basic blocks that use the same index
21801 pointer 4 or more times to copy pointer into the @code{ep} register, and
21802 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21803 option is on by default if you optimize.
21805 @item -mno-prolog-function
21806 @itemx -mprolog-function
21807 @opindex mno-prolog-function
21808 @opindex mprolog-function
21809 Do not use (do use) external functions to save and restore registers
21810 at the prologue and epilogue of a function.  The external functions
21811 are slower, but use less code space if more than one function saves
21812 the same number of registers.  The @option{-mprolog-function} option
21813 is on by default if you optimize.
21815 @item -mspace
21816 @opindex mspace
21817 Try to make the code as small as possible.  At present, this just turns
21818 on the @option{-mep} and @option{-mprolog-function} options.
21820 @item -mtda=@var{n}
21821 @opindex mtda
21822 Put static or global variables whose size is @var{n} bytes or less into
21823 the tiny data area that register @code{ep} points to.  The tiny data
21824 area can hold up to 256 bytes in total (128 bytes for byte references).
21826 @item -msda=@var{n}
21827 @opindex msda
21828 Put static or global variables whose size is @var{n} bytes or less into
21829 the small data area that register @code{gp} points to.  The small data
21830 area can hold up to 64 kilobytes.
21832 @item -mzda=@var{n}
21833 @opindex mzda
21834 Put static or global variables whose size is @var{n} bytes or less into
21835 the first 32 kilobytes of memory.
21837 @item -mv850
21838 @opindex mv850
21839 Specify that the target processor is the V850.
21841 @item -mv850e3v5
21842 @opindex mv850e3v5
21843 Specify that the target processor is the V850E3V5.  The preprocessor
21844 constant @code{__v850e3v5__} is defined if this option is used.
21846 @item -mv850e2v4
21847 @opindex mv850e2v4
21848 Specify that the target processor is the V850E3V5.  This is an alias for
21849 the @option{-mv850e3v5} option.
21851 @item -mv850e2v3
21852 @opindex mv850e2v3
21853 Specify that the target processor is the V850E2V3.  The preprocessor
21854 constant @code{__v850e2v3__} is defined if this option is used.
21856 @item -mv850e2
21857 @opindex mv850e2
21858 Specify that the target processor is the V850E2.  The preprocessor
21859 constant @code{__v850e2__} is defined if this option is used.
21861 @item -mv850e1
21862 @opindex mv850e1
21863 Specify that the target processor is the V850E1.  The preprocessor
21864 constants @code{__v850e1__} and @code{__v850e__} are defined if
21865 this option is used.
21867 @item -mv850es
21868 @opindex mv850es
21869 Specify that the target processor is the V850ES.  This is an alias for
21870 the @option{-mv850e1} option.
21872 @item -mv850e
21873 @opindex mv850e
21874 Specify that the target processor is the V850E@.  The preprocessor
21875 constant @code{__v850e__} is defined if this option is used.
21877 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21878 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21879 are defined then a default target processor is chosen and the
21880 relevant @samp{__v850*__} preprocessor constant is defined.
21882 The preprocessor constants @code{__v850} and @code{__v851__} are always
21883 defined, regardless of which processor variant is the target.
21885 @item -mdisable-callt
21886 @itemx -mno-disable-callt
21887 @opindex mdisable-callt
21888 @opindex mno-disable-callt
21889 This option suppresses generation of the @code{CALLT} instruction for the
21890 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21891 architecture.
21893 This option is enabled by default when the RH850 ABI is
21894 in use (see @option{-mrh850-abi}), and disabled by default when the
21895 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21896 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
21898 @item -mrelax
21899 @itemx -mno-relax
21900 @opindex mrelax
21901 @opindex mno-relax
21902 Pass on (or do not pass on) the @option{-mrelax} command-line option
21903 to the assembler.
21905 @item -mlong-jumps
21906 @itemx -mno-long-jumps
21907 @opindex mlong-jumps
21908 @opindex mno-long-jumps
21909 Disable (or re-enable) the generation of PC-relative jump instructions.
21911 @item -msoft-float
21912 @itemx -mhard-float
21913 @opindex msoft-float
21914 @opindex mhard-float
21915 Disable (or re-enable) the generation of hardware floating point
21916 instructions.  This option is only significant when the target
21917 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21918 instructions are being generated then the C preprocessor symbol
21919 @code{__FPU_OK__} is defined, otherwise the symbol
21920 @code{__NO_FPU__} is defined.
21922 @item -mloop
21923 @opindex mloop
21924 Enables the use of the e3v5 LOOP instruction.  The use of this
21925 instruction is not enabled by default when the e3v5 architecture is
21926 selected because its use is still experimental.
21928 @item -mrh850-abi
21929 @itemx -mghs
21930 @opindex mrh850-abi
21931 @opindex mghs
21932 Enables support for the RH850 version of the V850 ABI.  This is the
21933 default.  With this version of the ABI the following rules apply:
21935 @itemize
21936 @item
21937 Integer sized structures and unions are returned via a memory pointer
21938 rather than a register.
21940 @item
21941 Large structures and unions (more than 8 bytes in size) are passed by
21942 value.
21944 @item
21945 Functions are aligned to 16-bit boundaries.
21947 @item
21948 The @option{-m8byte-align} command-line option is supported.
21950 @item
21951 The @option{-mdisable-callt} command-line option is enabled by
21952 default.  The @option{-mno-disable-callt} command-line option is not
21953 supported.
21954 @end itemize
21956 When this version of the ABI is enabled the C preprocessor symbol
21957 @code{__V850_RH850_ABI__} is defined.
21959 @item -mgcc-abi
21960 @opindex mgcc-abi
21961 Enables support for the old GCC version of the V850 ABI.  With this
21962 version of the ABI the following rules apply:
21964 @itemize
21965 @item
21966 Integer sized structures and unions are returned in register @code{r10}.
21968 @item
21969 Large structures and unions (more than 8 bytes in size) are passed by
21970 reference.
21972 @item
21973 Functions are aligned to 32-bit boundaries, unless optimizing for
21974 size.
21976 @item
21977 The @option{-m8byte-align} command-line option is not supported.
21979 @item
21980 The @option{-mdisable-callt} command-line option is supported but not
21981 enabled by default.
21982 @end itemize
21984 When this version of the ABI is enabled the C preprocessor symbol
21985 @code{__V850_GCC_ABI__} is defined.
21987 @item -m8byte-align
21988 @itemx -mno-8byte-align
21989 @opindex m8byte-align
21990 @opindex mno-8byte-align
21991 Enables support for @code{double} and @code{long long} types to be
21992 aligned on 8-byte boundaries.  The default is to restrict the
21993 alignment of all objects to at most 4-bytes.  When
21994 @option{-m8byte-align} is in effect the C preprocessor symbol
21995 @code{__V850_8BYTE_ALIGN__} is defined.
21997 @item -mbig-switch
21998 @opindex mbig-switch
21999 Generate code suitable for big switch tables.  Use this option only if
22000 the assembler/linker complain about out of range branches within a switch
22001 table.
22003 @item -mapp-regs
22004 @opindex mapp-regs
22005 This option causes r2 and r5 to be used in the code generated by
22006 the compiler.  This setting is the default.
22008 @item -mno-app-regs
22009 @opindex mno-app-regs
22010 This option causes r2 and r5 to be treated as fixed registers.
22012 @end table
22014 @node VAX Options
22015 @subsection VAX Options
22016 @cindex VAX options
22018 These @samp{-m} options are defined for the VAX:
22020 @table @gcctabopt
22021 @item -munix
22022 @opindex munix
22023 Do not output certain jump instructions (@code{aobleq} and so on)
22024 that the Unix assembler for the VAX cannot handle across long
22025 ranges.
22027 @item -mgnu
22028 @opindex mgnu
22029 Do output those jump instructions, on the assumption that the
22030 GNU assembler is being used.
22032 @item -mg
22033 @opindex mg
22034 Output code for G-format floating-point numbers instead of D-format.
22035 @end table
22037 @node Visium Options
22038 @subsection Visium Options
22039 @cindex Visium options
22041 @table @gcctabopt
22043 @item -mdebug
22044 @opindex mdebug
22045 A program which performs file I/O and is destined to run on an MCM target
22046 should be linked with this option.  It causes the libraries libc.a and
22047 libdebug.a to be linked.  The program should be run on the target under
22048 the control of the GDB remote debugging stub.
22050 @item -msim
22051 @opindex msim
22052 A program which performs file I/O and is destined to run on the simulator
22053 should be linked with option.  This causes libraries libc.a and libsim.a to
22054 be linked.
22056 @item -mfpu
22057 @itemx -mhard-float
22058 @opindex mfpu
22059 @opindex mhard-float
22060 Generate code containing floating-point instructions.  This is the
22061 default.
22063 @item -mno-fpu
22064 @itemx -msoft-float
22065 @opindex mno-fpu
22066 @opindex msoft-float
22067 Generate code containing library calls for floating-point.
22069 @option{-msoft-float} changes the calling convention in the output file;
22070 therefore, it is only useful if you compile @emph{all} of a program with
22071 this option.  In particular, you need to compile @file{libgcc.a}, the
22072 library that comes with GCC, with @option{-msoft-float} in order for
22073 this to work.
22075 @item -mcpu=@var{cpu_type}
22076 @opindex mcpu
22077 Set the instruction set, register set, and instruction scheduling parameters
22078 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22079 @samp{mcm}, @samp{gr5} and @samp{gr6}.
22081 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
22083 By default (unless configured otherwise), GCC generates code for the GR5
22084 variant of the Visium architecture.  
22086 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
22087 architecture.  The only difference from GR5 code is that the compiler will
22088 generate block move instructions.
22090 @item -mtune=@var{cpu_type}
22091 @opindex mtune
22092 Set the instruction scheduling parameters for machine type @var{cpu_type},
22093 but do not set the instruction set or register set that the option
22094 @option{-mcpu=@var{cpu_type}} would.
22096 @item -msv-mode
22097 @opindex msv-mode
22098 Generate code for the supervisor mode, where there are no restrictions on
22099 the access to general registers.  This is the default.
22101 @item -muser-mode
22102 @opindex muser-mode
22103 Generate code for the user mode, where the access to some general registers
22104 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
22105 mode; on the GR6, only registers r29 to r31 are affected.
22106 @end table
22108 @node VMS Options
22109 @subsection VMS Options
22111 These @samp{-m} options are defined for the VMS implementations:
22113 @table @gcctabopt
22114 @item -mvms-return-codes
22115 @opindex mvms-return-codes
22116 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22117 condition (e.g.@ error) codes.
22119 @item -mdebug-main=@var{prefix}
22120 @opindex mdebug-main=@var{prefix}
22121 Flag the first routine whose name starts with @var{prefix} as the main
22122 routine for the debugger.
22124 @item -mmalloc64
22125 @opindex mmalloc64
22126 Default to 64-bit memory allocation routines.
22128 @item -mpointer-size=@var{size}
22129 @opindex mpointer-size=@var{size}
22130 Set the default size of pointers. Possible options for @var{size} are
22131 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22132 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22133 The later option disables @code{pragma pointer_size}.
22134 @end table
22136 @node VxWorks Options
22137 @subsection VxWorks Options
22138 @cindex VxWorks Options
22140 The options in this section are defined for all VxWorks targets.
22141 Options specific to the target hardware are listed with the other
22142 options for that target.
22144 @table @gcctabopt
22145 @item -mrtp
22146 @opindex mrtp
22147 GCC can generate code for both VxWorks kernels and real time processes
22148 (RTPs).  This option switches from the former to the latter.  It also
22149 defines the preprocessor macro @code{__RTP__}.
22151 @item -non-static
22152 @opindex non-static
22153 Link an RTP executable against shared libraries rather than static
22154 libraries.  The options @option{-static} and @option{-shared} can
22155 also be used for RTPs (@pxref{Link Options}); @option{-static}
22156 is the default.
22158 @item -Bstatic
22159 @itemx -Bdynamic
22160 @opindex Bstatic
22161 @opindex Bdynamic
22162 These options are passed down to the linker.  They are defined for
22163 compatibility with Diab.
22165 @item -Xbind-lazy
22166 @opindex Xbind-lazy
22167 Enable lazy binding of function calls.  This option is equivalent to
22168 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22170 @item -Xbind-now
22171 @opindex Xbind-now
22172 Disable lazy binding of function calls.  This option is the default and
22173 is defined for compatibility with Diab.
22174 @end table
22176 @node x86 Options
22177 @subsection x86 Options
22178 @cindex x86 Options
22180 These @samp{-m} options are defined for the x86 family of computers.
22182 @table @gcctabopt
22184 @item -march=@var{cpu-type}
22185 @opindex march
22186 Generate instructions for the machine type @var{cpu-type}.  In contrast to
22187 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
22188 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
22189 to generate code that may not run at all on processors other than the one
22190 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
22191 @option{-mtune=@var{cpu-type}}.
22193 The choices for @var{cpu-type} are:
22195 @table @samp
22196 @item native
22197 This selects the CPU to generate code for at compilation time by determining
22198 the processor type of the compiling machine.  Using @option{-march=native}
22199 enables all instruction subsets supported by the local machine (hence
22200 the result might not run on different machines).  Using @option{-mtune=native}
22201 produces code optimized for the local machine under the constraints
22202 of the selected instruction set.  
22204 @item i386
22205 Original Intel i386 CPU@.
22207 @item i486
22208 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
22210 @item i586
22211 @itemx pentium
22212 Intel Pentium CPU with no MMX support.
22214 @item pentium-mmx
22215 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
22217 @item pentiumpro
22218 Intel Pentium Pro CPU@.
22220 @item i686
22221 When used with @option{-march}, the Pentium Pro
22222 instruction set is used, so the code runs on all i686 family chips.
22223 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
22225 @item pentium2
22226 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
22227 support.
22229 @item pentium3
22230 @itemx pentium3m
22231 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
22232 set support.
22234 @item pentium-m
22235 Intel Pentium M; low-power version of Intel Pentium III CPU
22236 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
22238 @item pentium4
22239 @itemx pentium4m
22240 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
22242 @item prescott
22243 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
22244 set support.
22246 @item nocona
22247 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
22248 SSE2 and SSE3 instruction set support.
22250 @item core2
22251 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
22252 instruction set support.
22254 @item nehalem
22255 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22256 SSE4.1, SSE4.2 and POPCNT instruction set support.
22258 @item westmere
22259 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22260 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
22262 @item sandybridge
22263 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22264 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
22266 @item ivybridge
22267 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22268 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
22269 instruction set support.
22271 @item haswell
22272 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22273 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22274 BMI, BMI2 and F16C instruction set support.
22276 @item broadwell
22277 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22278 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22279 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
22281 @item bonnell
22282 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
22283 instruction set support.
22285 @item silvermont
22286 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22287 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
22289 @item knl
22290 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22291 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22292 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
22293 AVX512CD instruction set support.
22295 @item k6
22296 AMD K6 CPU with MMX instruction set support.
22298 @item k6-2
22299 @itemx k6-3
22300 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
22302 @item athlon
22303 @itemx athlon-tbird
22304 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
22305 support.
22307 @item athlon-4
22308 @itemx athlon-xp
22309 @itemx athlon-mp
22310 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
22311 instruction set support.
22313 @item k8
22314 @itemx opteron
22315 @itemx athlon64
22316 @itemx athlon-fx
22317 Processors based on the AMD K8 core with x86-64 instruction set support,
22318 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
22319 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
22320 instruction set extensions.)
22322 @item k8-sse3
22323 @itemx opteron-sse3
22324 @itemx athlon64-sse3
22325 Improved versions of AMD K8 cores with SSE3 instruction set support.
22327 @item amdfam10
22328 @itemx barcelona
22329 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
22330 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
22331 instruction set extensions.)
22333 @item bdver1
22334 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
22335 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
22336 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
22337 @item bdver2
22338 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22339 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
22340 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
22341 extensions.)
22342 @item bdver3
22343 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22344 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
22345 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
22346 64-bit instruction set extensions.
22347 @item bdver4
22348 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22349 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
22350 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
22351 SSE4.2, ABM and 64-bit instruction set extensions.
22353 @item btver1
22354 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
22355 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
22356 instruction set extensions.)
22358 @item btver2
22359 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
22360 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
22361 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
22363 @item winchip-c6
22364 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
22365 set support.
22367 @item winchip2
22368 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
22369 instruction set support.
22371 @item c3
22372 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
22373 implemented for this chip.)
22375 @item c3-2
22376 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
22377 (No scheduling is
22378 implemented for this chip.)
22380 @item geode
22381 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
22382 @end table
22384 @item -mtune=@var{cpu-type}
22385 @opindex mtune
22386 Tune to @var{cpu-type} everything applicable about the generated code, except
22387 for the ABI and the set of available instructions.  
22388 While picking a specific @var{cpu-type} schedules things appropriately
22389 for that particular chip, the compiler does not generate any code that
22390 cannot run on the default machine type unless you use a
22391 @option{-march=@var{cpu-type}} option.
22392 For example, if GCC is configured for i686-pc-linux-gnu
22393 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
22394 but still runs on i686 machines.
22396 The choices for @var{cpu-type} are the same as for @option{-march}.
22397 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
22399 @table @samp
22400 @item generic
22401 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
22402 If you know the CPU on which your code will run, then you should use
22403 the corresponding @option{-mtune} or @option{-march} option instead of
22404 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
22405 of your application will have, then you should use this option.
22407 As new processors are deployed in the marketplace, the behavior of this
22408 option will change.  Therefore, if you upgrade to a newer version of
22409 GCC, code generation controlled by this option will change to reflect
22410 the processors
22411 that are most common at the time that version of GCC is released.
22413 There is no @option{-march=generic} option because @option{-march}
22414 indicates the instruction set the compiler can use, and there is no
22415 generic instruction set applicable to all processors.  In contrast,
22416 @option{-mtune} indicates the processor (or, in this case, collection of
22417 processors) for which the code is optimized.
22419 @item intel
22420 Produce code optimized for the most current Intel processors, which are
22421 Haswell and Silvermont for this version of GCC.  If you know the CPU
22422 on which your code will run, then you should use the corresponding
22423 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
22424 But, if you want your application performs better on both Haswell and
22425 Silvermont, then you should use this option.
22427 As new Intel processors are deployed in the marketplace, the behavior of
22428 this option will change.  Therefore, if you upgrade to a newer version of
22429 GCC, code generation controlled by this option will change to reflect
22430 the most current Intel processors at the time that version of GCC is
22431 released.
22433 There is no @option{-march=intel} option because @option{-march} indicates
22434 the instruction set the compiler can use, and there is no common
22435 instruction set applicable to all processors.  In contrast,
22436 @option{-mtune} indicates the processor (or, in this case, collection of
22437 processors) for which the code is optimized.
22438 @end table
22440 @item -mcpu=@var{cpu-type}
22441 @opindex mcpu
22442 A deprecated synonym for @option{-mtune}.
22444 @item -mfpmath=@var{unit}
22445 @opindex mfpmath
22446 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
22447 for @var{unit} are:
22449 @table @samp
22450 @item 387
22451 Use the standard 387 floating-point coprocessor present on the majority of chips and
22452 emulated otherwise.  Code compiled with this option runs almost everywhere.
22453 The temporary results are computed in 80-bit precision instead of the precision
22454 specified by the type, resulting in slightly different results compared to most
22455 of other chips.  See @option{-ffloat-store} for more detailed description.
22457 This is the default choice for x86-32 targets.
22459 @item sse
22460 Use scalar floating-point instructions present in the SSE instruction set.
22461 This instruction set is supported by Pentium III and newer chips,
22462 and in the AMD line
22463 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
22464 instruction set supports only single-precision arithmetic, thus the double and
22465 extended-precision arithmetic are still done using 387.  A later version, present
22466 only in Pentium 4 and AMD x86-64 chips, supports double-precision
22467 arithmetic too.
22469 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
22470 or @option{-msse2} switches to enable SSE extensions and make this option
22471 effective.  For the x86-64 compiler, these extensions are enabled by default.
22473 The resulting code should be considerably faster in the majority of cases and avoid
22474 the numerical instability problems of 387 code, but may break some existing
22475 code that expects temporaries to be 80 bits.
22477 This is the default choice for the x86-64 compiler.
22479 @item sse,387
22480 @itemx sse+387
22481 @itemx both
22482 Attempt to utilize both instruction sets at once.  This effectively doubles the
22483 amount of available registers, and on chips with separate execution units for
22484 387 and SSE the execution resources too.  Use this option with care, as it is
22485 still experimental, because the GCC register allocator does not model separate
22486 functional units well, resulting in unstable performance.
22487 @end table
22489 @item -masm=@var{dialect}
22490 @opindex masm=@var{dialect}
22491 Output assembly instructions using selected @var{dialect}.  Also affects
22492 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
22493 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
22494 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
22495 not support @samp{intel}.
22497 @item -mieee-fp
22498 @itemx -mno-ieee-fp
22499 @opindex mieee-fp
22500 @opindex mno-ieee-fp
22501 Control whether or not the compiler uses IEEE floating-point
22502 comparisons.  These correctly handle the case where the result of a
22503 comparison is unordered.
22505 @item -msoft-float
22506 @opindex msoft-float
22507 Generate output containing library calls for floating point.
22509 @strong{Warning:} the requisite libraries are not part of GCC@.
22510 Normally the facilities of the machine's usual C compiler are used, but
22511 this can't be done directly in cross-compilation.  You must make your
22512 own arrangements to provide suitable library functions for
22513 cross-compilation.
22515 On machines where a function returns floating-point results in the 80387
22516 register stack, some floating-point opcodes may be emitted even if
22517 @option{-msoft-float} is used.
22519 @item -mno-fp-ret-in-387
22520 @opindex mno-fp-ret-in-387
22521 Do not use the FPU registers for return values of functions.
22523 The usual calling convention has functions return values of types
22524 @code{float} and @code{double} in an FPU register, even if there
22525 is no FPU@.  The idea is that the operating system should emulate
22526 an FPU@.
22528 The option @option{-mno-fp-ret-in-387} causes such values to be returned
22529 in ordinary CPU registers instead.
22531 @item -mno-fancy-math-387
22532 @opindex mno-fancy-math-387
22533 Some 387 emulators do not support the @code{sin}, @code{cos} and
22534 @code{sqrt} instructions for the 387.  Specify this option to avoid
22535 generating those instructions.  This option is the default on FreeBSD,
22536 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
22537 indicates that the target CPU always has an FPU and so the
22538 instruction does not need emulation.  These
22539 instructions are not generated unless you also use the
22540 @option{-funsafe-math-optimizations} switch.
22542 @item -malign-double
22543 @itemx -mno-align-double
22544 @opindex malign-double
22545 @opindex mno-align-double
22546 Control whether GCC aligns @code{double}, @code{long double}, and
22547 @code{long long} variables on a two-word boundary or a one-word
22548 boundary.  Aligning @code{double} variables on a two-word boundary
22549 produces code that runs somewhat faster on a Pentium at the
22550 expense of more memory.
22552 On x86-64, @option{-malign-double} is enabled by default.
22554 @strong{Warning:} if you use the @option{-malign-double} switch,
22555 structures containing the above types are aligned differently than
22556 the published application binary interface specifications for the x86-32
22557 and are not binary compatible with structures in code compiled
22558 without that switch.
22560 @item -m96bit-long-double
22561 @itemx -m128bit-long-double
22562 @opindex m96bit-long-double
22563 @opindex m128bit-long-double
22564 These switches control the size of @code{long double} type.  The x86-32
22565 application binary interface specifies the size to be 96 bits,
22566 so @option{-m96bit-long-double} is the default in 32-bit mode.
22568 Modern architectures (Pentium and newer) prefer @code{long double}
22569 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
22570 conforming to the ABI, this is not possible.  So specifying
22571 @option{-m128bit-long-double} aligns @code{long double}
22572 to a 16-byte boundary by padding the @code{long double} with an additional
22573 32-bit zero.
22575 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
22576 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
22578 Notice that neither of these options enable any extra precision over the x87
22579 standard of 80 bits for a @code{long double}.
22581 @strong{Warning:} if you override the default value for your target ABI, this
22582 changes the size of 
22583 structures and arrays containing @code{long double} variables,
22584 as well as modifying the function calling convention for functions taking
22585 @code{long double}.  Hence they are not binary-compatible
22586 with code compiled without that switch.
22588 @item -mlong-double-64
22589 @itemx -mlong-double-80
22590 @itemx -mlong-double-128
22591 @opindex mlong-double-64
22592 @opindex mlong-double-80
22593 @opindex mlong-double-128
22594 These switches control the size of @code{long double} type. A size
22595 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22596 type. This is the default for 32-bit Bionic C library.  A size
22597 of 128 bits makes the @code{long double} type equivalent to the
22598 @code{__float128} type. This is the default for 64-bit Bionic C library.
22600 @strong{Warning:} if you override the default value for your target ABI, this
22601 changes the size of
22602 structures and arrays containing @code{long double} variables,
22603 as well as modifying the function calling convention for functions taking
22604 @code{long double}.  Hence they are not binary-compatible
22605 with code compiled without that switch.
22607 @item -malign-data=@var{type}
22608 @opindex malign-data
22609 Control how GCC aligns variables.  Supported values for @var{type} are
22610 @samp{compat} uses increased alignment value compatible uses GCC 4.8
22611 and earlier, @samp{abi} uses alignment value as specified by the
22612 psABI, and @samp{cacheline} uses increased alignment value to match
22613 the cache line size.  @samp{compat} is the default.
22615 @item -mlarge-data-threshold=@var{threshold}
22616 @opindex mlarge-data-threshold
22617 When @option{-mcmodel=medium} is specified, data objects larger than
22618 @var{threshold} are placed in the large data section.  This value must be the
22619 same across all objects linked into the binary, and defaults to 65535.
22621 @item -mrtd
22622 @opindex mrtd
22623 Use a different function-calling convention, in which functions that
22624 take a fixed number of arguments return with the @code{ret @var{num}}
22625 instruction, which pops their arguments while returning.  This saves one
22626 instruction in the caller since there is no need to pop the arguments
22627 there.
22629 You can specify that an individual function is called with this calling
22630 sequence with the function attribute @code{stdcall}.  You can also
22631 override the @option{-mrtd} option by using the function attribute
22632 @code{cdecl}.  @xref{Function Attributes}.
22634 @strong{Warning:} this calling convention is incompatible with the one
22635 normally used on Unix, so you cannot use it if you need to call
22636 libraries compiled with the Unix compiler.
22638 Also, you must provide function prototypes for all functions that
22639 take variable numbers of arguments (including @code{printf});
22640 otherwise incorrect code is generated for calls to those
22641 functions.
22643 In addition, seriously incorrect code results if you call a
22644 function with too many arguments.  (Normally, extra arguments are
22645 harmlessly ignored.)
22647 @item -mregparm=@var{num}
22648 @opindex mregparm
22649 Control how many registers are used to pass integer arguments.  By
22650 default, no registers are used to pass arguments, and at most 3
22651 registers can be used.  You can control this behavior for a specific
22652 function by using the function attribute @code{regparm}.
22653 @xref{Function Attributes}.
22655 @strong{Warning:} if you use this switch, and
22656 @var{num} is nonzero, then you must build all modules with the same
22657 value, including any libraries.  This includes the system libraries and
22658 startup modules.
22660 @item -msseregparm
22661 @opindex msseregparm
22662 Use SSE register passing conventions for float and double arguments
22663 and return values.  You can control this behavior for a specific
22664 function by using the function attribute @code{sseregparm}.
22665 @xref{Function Attributes}.
22667 @strong{Warning:} if you use this switch then you must build all
22668 modules with the same value, including any libraries.  This includes
22669 the system libraries and startup modules.
22671 @item -mvect8-ret-in-mem
22672 @opindex mvect8-ret-in-mem
22673 Return 8-byte vectors in memory instead of MMX registers.  This is the
22674 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
22675 Studio compilers until version 12.  Later compiler versions (starting
22676 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
22677 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
22678 you need to remain compatible with existing code produced by those
22679 previous compiler versions or older versions of GCC@.
22681 @item -mpc32
22682 @itemx -mpc64
22683 @itemx -mpc80
22684 @opindex mpc32
22685 @opindex mpc64
22686 @opindex mpc80
22688 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
22689 is specified, the significands of results of floating-point operations are
22690 rounded to 24 bits (single precision); @option{-mpc64} rounds the
22691 significands of results of floating-point operations to 53 bits (double
22692 precision) and @option{-mpc80} rounds the significands of results of
22693 floating-point operations to 64 bits (extended double precision), which is
22694 the default.  When this option is used, floating-point operations in higher
22695 precisions are not available to the programmer without setting the FPU
22696 control word explicitly.
22698 Setting the rounding of floating-point operations to less than the default
22699 80 bits can speed some programs by 2% or more.  Note that some mathematical
22700 libraries assume that extended-precision (80-bit) floating-point operations
22701 are enabled by default; routines in such libraries could suffer significant
22702 loss of accuracy, typically through so-called ``catastrophic cancellation'',
22703 when this option is used to set the precision to less than extended precision.
22705 @item -mstackrealign
22706 @opindex mstackrealign
22707 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
22708 option generates an alternate prologue and epilogue that realigns the
22709 run-time stack if necessary.  This supports mixing legacy codes that keep
22710 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
22711 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
22712 applicable to individual functions.
22714 @item -mpreferred-stack-boundary=@var{num}
22715 @opindex mpreferred-stack-boundary
22716 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
22717 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
22718 the default is 4 (16 bytes or 128 bits).
22720 @strong{Warning:} When generating code for the x86-64 architecture with
22721 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
22722 used to keep the stack boundary aligned to 8 byte boundary.  Since
22723 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
22724 intended to be used in controlled environment where stack space is
22725 important limitation.  This option leads to wrong code when functions
22726 compiled with 16 byte stack alignment (such as functions from a standard
22727 library) are called with misaligned stack.  In this case, SSE
22728 instructions may lead to misaligned memory access traps.  In addition,
22729 variable arguments are handled incorrectly for 16 byte aligned
22730 objects (including x87 long double and __int128), leading to wrong
22731 results.  You must build all modules with
22732 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
22733 includes the system libraries and startup modules.
22735 @item -mincoming-stack-boundary=@var{num}
22736 @opindex mincoming-stack-boundary
22737 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
22738 boundary.  If @option{-mincoming-stack-boundary} is not specified,
22739 the one specified by @option{-mpreferred-stack-boundary} is used.
22741 On Pentium and Pentium Pro, @code{double} and @code{long double} values
22742 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
22743 suffer significant run time performance penalties.  On Pentium III, the
22744 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
22745 properly if it is not 16-byte aligned.
22747 To ensure proper alignment of this values on the stack, the stack boundary
22748 must be as aligned as that required by any value stored on the stack.
22749 Further, every function must be generated such that it keeps the stack
22750 aligned.  Thus calling a function compiled with a higher preferred
22751 stack boundary from a function compiled with a lower preferred stack
22752 boundary most likely misaligns the stack.  It is recommended that
22753 libraries that use callbacks always use the default setting.
22755 This extra alignment does consume extra stack space, and generally
22756 increases code size.  Code that is sensitive to stack space usage, such
22757 as embedded systems and operating system kernels, may want to reduce the
22758 preferred alignment to @option{-mpreferred-stack-boundary=2}.
22760 @need 200
22761 @item -mmmx
22762 @opindex mmmx
22763 @need 200
22764 @itemx -msse
22765 @opindex msse
22766 @need 200
22767 @itemx -msse2
22768 @need 200
22769 @itemx -msse3
22770 @need 200
22771 @itemx -mssse3
22772 @need 200
22773 @itemx -msse4
22774 @need 200
22775 @itemx -msse4a
22776 @need 200
22777 @itemx -msse4.1
22778 @need 200
22779 @itemx -msse4.2
22780 @need 200
22781 @itemx -mavx
22782 @opindex mavx
22783 @need 200
22784 @itemx -mavx2
22785 @need 200
22786 @itemx -mavx512f
22787 @need 200
22788 @itemx -mavx512pf
22789 @need 200
22790 @itemx -mavx512er
22791 @need 200
22792 @itemx -mavx512cd
22793 @need 200
22794 @itemx -msha
22795 @opindex msha
22796 @need 200
22797 @itemx -maes
22798 @opindex maes
22799 @need 200
22800 @itemx -mpclmul
22801 @opindex mpclmul
22802 @need 200
22803 @itemx -mclfushopt
22804 @opindex mclfushopt
22805 @need 200
22806 @itemx -mfsgsbase
22807 @opindex mfsgsbase
22808 @need 200
22809 @itemx -mrdrnd
22810 @opindex mrdrnd
22811 @need 200
22812 @itemx -mf16c
22813 @opindex mf16c
22814 @need 200
22815 @itemx -mfma
22816 @opindex mfma
22817 @need 200
22818 @itemx -mfma4
22819 @need 200
22820 @itemx -mno-fma4
22821 @need 200
22822 @itemx -mprefetchwt1
22823 @opindex mprefetchwt1
22824 @need 200
22825 @itemx -mxop
22826 @opindex mxop
22827 @need 200
22828 @itemx -mlwp
22829 @opindex mlwp
22830 @need 200
22831 @itemx -m3dnow
22832 @opindex m3dnow
22833 @need 200
22834 @itemx -mpopcnt
22835 @opindex mpopcnt
22836 @need 200
22837 @itemx -mabm
22838 @opindex mabm
22839 @need 200
22840 @itemx -mbmi
22841 @opindex mbmi
22842 @need 200
22843 @itemx -mbmi2
22844 @need 200
22845 @itemx -mlzcnt
22846 @opindex mlzcnt
22847 @need 200
22848 @itemx -mfxsr
22849 @opindex mfxsr
22850 @need 200
22851 @itemx -mxsave
22852 @opindex mxsave
22853 @need 200
22854 @itemx -mxsaveopt
22855 @opindex mxsaveopt
22856 @need 200
22857 @itemx -mxsavec
22858 @opindex mxsavec
22859 @need 200
22860 @itemx -mxsaves
22861 @opindex mxsaves
22862 @need 200
22863 @itemx -mrtm
22864 @opindex mrtm
22865 @need 200
22866 @itemx -mtbm
22867 @opindex mtbm
22868 @need 200
22869 @itemx -mmpx
22870 @opindex mmpx
22871 These switches enable the use of instructions in the MMX, SSE,
22872 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
22873 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
22874 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
22875 extended instruction sets.  Each has a corresponding @option{-mno-} option
22876 to disable use of these instructions.
22878 These extensions are also available as built-in functions: see
22879 @ref{x86 Built-in Functions}, for details of the functions enabled and
22880 disabled by these switches.
22882 To generate SSE/SSE2 instructions automatically from floating-point
22883 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
22885 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
22886 generates new AVX instructions or AVX equivalence for all SSEx instructions
22887 when needed.
22889 These options enable GCC to use these extended instructions in
22890 generated code, even without @option{-mfpmath=sse}.  Applications that
22891 perform run-time CPU detection must compile separate files for each
22892 supported architecture, using the appropriate flags.  In particular,
22893 the file containing the CPU detection code should be compiled without
22894 these options.
22896 @item -mdump-tune-features
22897 @opindex mdump-tune-features
22898 This option instructs GCC to dump the names of the x86 performance 
22899 tuning features and default settings. The names can be used in 
22900 @option{-mtune-ctrl=@var{feature-list}}.
22902 @item -mtune-ctrl=@var{feature-list}
22903 @opindex mtune-ctrl=@var{feature-list}
22904 This option is used to do fine grain control of x86 code generation features.
22905 @var{feature-list} is a comma separated list of @var{feature} names. See also
22906 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
22907 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
22908 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
22909 developers. Using it may lead to code paths not covered by testing and can
22910 potentially result in compiler ICEs or runtime errors.
22912 @item -mno-default
22913 @opindex mno-default
22914 This option instructs GCC to turn off all tunable features. See also 
22915 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
22917 @item -mcld
22918 @opindex mcld
22919 This option instructs GCC to emit a @code{cld} instruction in the prologue
22920 of functions that use string instructions.  String instructions depend on
22921 the DF flag to select between autoincrement or autodecrement mode.  While the
22922 ABI specifies the DF flag to be cleared on function entry, some operating
22923 systems violate this specification by not clearing the DF flag in their
22924 exception dispatchers.  The exception handler can be invoked with the DF flag
22925 set, which leads to wrong direction mode when string instructions are used.
22926 This option can be enabled by default on 32-bit x86 targets by configuring
22927 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
22928 instructions can be suppressed with the @option{-mno-cld} compiler option
22929 in this case.
22931 @item -mvzeroupper
22932 @opindex mvzeroupper
22933 This option instructs GCC to emit a @code{vzeroupper} instruction
22934 before a transfer of control flow out of the function to minimize
22935 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
22936 intrinsics.
22938 @item -mprefer-avx128
22939 @opindex mprefer-avx128
22940 This option instructs GCC to use 128-bit AVX instructions instead of
22941 256-bit AVX instructions in the auto-vectorizer.
22943 @item -mcx16
22944 @opindex mcx16
22945 This option enables GCC to generate @code{CMPXCHG16B} instructions.
22946 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
22947 (or oword) data types.  
22948 This is useful for high-resolution counters that can be updated
22949 by multiple processors (or cores).  This instruction is generated as part of
22950 atomic built-in functions: see @ref{__sync Builtins} or
22951 @ref{__atomic Builtins} for details.
22953 @item -msahf
22954 @opindex msahf
22955 This option enables generation of @code{SAHF} instructions in 64-bit code.
22956 Early Intel Pentium 4 CPUs with Intel 64 support,
22957 prior to the introduction of Pentium 4 G1 step in December 2005,
22958 lacked the @code{LAHF} and @code{SAHF} instructions
22959 which are supported by AMD64.
22960 These are load and store instructions, respectively, for certain status flags.
22961 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
22962 @code{drem}, and @code{remainder} built-in functions;
22963 see @ref{Other Builtins} for details.
22965 @item -mmovbe
22966 @opindex mmovbe
22967 This option enables use of the @code{movbe} instruction to implement
22968 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
22970 @item -mcrc32
22971 @opindex mcrc32
22972 This option enables built-in functions @code{__builtin_ia32_crc32qi},
22973 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
22974 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
22976 @item -mrecip
22977 @opindex mrecip
22978 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
22979 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
22980 with an additional Newton-Raphson step
22981 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
22982 (and their vectorized
22983 variants) for single-precision floating-point arguments.  These instructions
22984 are generated only when @option{-funsafe-math-optimizations} is enabled
22985 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
22986 Note that while the throughput of the sequence is higher than the throughput
22987 of the non-reciprocal instruction, the precision of the sequence can be
22988 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
22990 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
22991 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
22992 combination), and doesn't need @option{-mrecip}.
22994 Also note that GCC emits the above sequence with additional Newton-Raphson step
22995 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
22996 already with @option{-ffast-math} (or the above option combination), and
22997 doesn't need @option{-mrecip}.
22999 @item -mrecip=@var{opt}
23000 @opindex mrecip=opt
23001 This option controls which reciprocal estimate instructions
23002 may be used.  @var{opt} is a comma-separated list of options, which may
23003 be preceded by a @samp{!} to invert the option:
23005 @table @samp
23006 @item all
23007 Enable all estimate instructions.
23009 @item default
23010 Enable the default instructions, equivalent to @option{-mrecip}.
23012 @item none
23013 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23015 @item div
23016 Enable the approximation for scalar division.
23018 @item vec-div
23019 Enable the approximation for vectorized division.
23021 @item sqrt
23022 Enable the approximation for scalar square root.
23024 @item vec-sqrt
23025 Enable the approximation for vectorized square root.
23026 @end table
23028 So, for example, @option{-mrecip=all,!sqrt} enables
23029 all of the reciprocal approximations, except for square root.
23031 @item -mveclibabi=@var{type}
23032 @opindex mveclibabi
23033 Specifies the ABI type to use for vectorizing intrinsics using an
23034 external library.  Supported values for @var{type} are @samp{svml} 
23035 for the Intel short
23036 vector math library and @samp{acml} for the AMD math core library.
23037 To use this option, both @option{-ftree-vectorize} and
23038 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
23039 ABI-compatible library must be specified at link time.
23041 GCC currently emits calls to @code{vmldExp2},
23042 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
23043 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
23044 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
23045 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
23046 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
23047 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
23048 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
23049 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
23050 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
23051 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
23052 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
23053 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
23054 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
23055 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
23056 when @option{-mveclibabi=acml} is used.  
23058 @item -mabi=@var{name}
23059 @opindex mabi
23060 Generate code for the specified calling convention.  Permissible values
23061 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
23062 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
23063 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
23064 You can control this behavior for specific functions by
23065 using the function attributes @code{ms_abi} and @code{sysv_abi}.
23066 @xref{Function Attributes}.
23068 @item -mtls-dialect=@var{type}
23069 @opindex mtls-dialect
23070 Generate code to access thread-local storage using the @samp{gnu} or
23071 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
23072 @samp{gnu2} is more efficient, but it may add compile- and run-time
23073 requirements that cannot be satisfied on all systems.
23075 @item -mpush-args
23076 @itemx -mno-push-args
23077 @opindex mpush-args
23078 @opindex mno-push-args
23079 Use PUSH operations to store outgoing parameters.  This method is shorter
23080 and usually equally fast as method using SUB/MOV operations and is enabled
23081 by default.  In some cases disabling it may improve performance because of
23082 improved scheduling and reduced dependencies.
23084 @item -maccumulate-outgoing-args
23085 @opindex maccumulate-outgoing-args
23086 If enabled, the maximum amount of space required for outgoing arguments is
23087 computed in the function prologue.  This is faster on most modern CPUs
23088 because of reduced dependencies, improved scheduling and reduced stack usage
23089 when the preferred stack boundary is not equal to 2.  The drawback is a notable
23090 increase in code size.  This switch implies @option{-mno-push-args}.
23092 @item -mthreads
23093 @opindex mthreads
23094 Support thread-safe exception handling on MinGW.  Programs that rely
23095 on thread-safe exception handling must compile and link all code with the
23096 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
23097 @option{-D_MT}; when linking, it links in a special thread helper library
23098 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
23100 @item -mno-align-stringops
23101 @opindex mno-align-stringops
23102 Do not align the destination of inlined string operations.  This switch reduces
23103 code size and improves performance in case the destination is already aligned,
23104 but GCC doesn't know about it.
23106 @item -minline-all-stringops
23107 @opindex minline-all-stringops
23108 By default GCC inlines string operations only when the destination is 
23109 known to be aligned to least a 4-byte boundary.  
23110 This enables more inlining and increases code
23111 size, but may improve performance of code that depends on fast
23112 @code{memcpy}, @code{strlen},
23113 and @code{memset} for short lengths.
23115 @item -minline-stringops-dynamically
23116 @opindex minline-stringops-dynamically
23117 For string operations of unknown size, use run-time checks with
23118 inline code for small blocks and a library call for large blocks.
23120 @item -mstringop-strategy=@var{alg}
23121 @opindex mstringop-strategy=@var{alg}
23122 Override the internal decision heuristic for the particular algorithm to use
23123 for inlining string operations.  The allowed values for @var{alg} are:
23125 @table @samp
23126 @item rep_byte
23127 @itemx rep_4byte
23128 @itemx rep_8byte
23129 Expand using i386 @code{rep} prefix of the specified size.
23131 @item byte_loop
23132 @itemx loop
23133 @itemx unrolled_loop
23134 Expand into an inline loop.
23136 @item libcall
23137 Always use a library call.
23138 @end table
23140 @item -mmemcpy-strategy=@var{strategy}
23141 @opindex mmemcpy-strategy=@var{strategy}
23142 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
23143 should be inlined and what inline algorithm to use when the expected size
23144 of the copy operation is known. @var{strategy} 
23145 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
23146 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
23147 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
23148 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
23149 in the list must be specified in increasing order.  The minimal byte size for 
23150 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
23151 preceding range.
23153 @item -mmemset-strategy=@var{strategy}
23154 @opindex mmemset-strategy=@var{strategy}
23155 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
23156 @code{__builtin_memset} expansion.
23158 @item -momit-leaf-frame-pointer
23159 @opindex momit-leaf-frame-pointer
23160 Don't keep the frame pointer in a register for leaf functions.  This
23161 avoids the instructions to save, set up, and restore frame pointers and
23162 makes an extra register available in leaf functions.  The option
23163 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
23164 which might make debugging harder.
23166 @item -mtls-direct-seg-refs
23167 @itemx -mno-tls-direct-seg-refs
23168 @opindex mtls-direct-seg-refs
23169 Controls whether TLS variables may be accessed with offsets from the
23170 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
23171 or whether the thread base pointer must be added.  Whether or not this
23172 is valid depends on the operating system, and whether it maps the
23173 segment to cover the entire TLS area.
23175 For systems that use the GNU C Library, the default is on.
23177 @item -msse2avx
23178 @itemx -mno-sse2avx
23179 @opindex msse2avx
23180 Specify that the assembler should encode SSE instructions with VEX
23181 prefix.  The option @option{-mavx} turns this on by default.
23183 @item -mfentry
23184 @itemx -mno-fentry
23185 @opindex mfentry
23186 If profiling is active (@option{-pg}), put the profiling
23187 counter call before the prologue.
23188 Note: On x86 architectures the attribute @code{ms_hook_prologue}
23189 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
23191 @item -mrecord-mcount
23192 @itemx -mno-record-mcount
23193 @opindex mrecord-mcount
23194 If profiling is active (@option{-pg}), generate a __mcount_loc section
23195 that contains pointers to each profiling call. This is useful for
23196 automatically patching and out calls.
23198 @item -mnop-mcount
23199 @itemx -mno-nop-mcount
23200 @opindex mnop-mcount
23201 If profiling is active (@option{-pg}), generate the calls to
23202 the profiling functions as nops. This is useful when they
23203 should be patched in later dynamically. This is likely only
23204 useful together with @option{-mrecord-mcount}.
23206 @item -mskip-rax-setup
23207 @itemx -mno-skip-rax-setup
23208 @opindex mskip-rax-setup
23209 When generating code for the x86-64 architecture with SSE extensions
23210 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
23211 register when there are no variable arguments passed in vector registers.
23213 @strong{Warning:} Since RAX register is used to avoid unnecessarily
23214 saving vector registers on stack when passing variable arguments, the
23215 impacts of this option are callees may waste some stack space,
23216 misbehave or jump to a random location.  GCC 4.4 or newer don't have
23217 those issues, regardless the RAX register value.
23219 @item -m8bit-idiv
23220 @itemx -mno-8bit-idiv
23221 @opindex m8bit-idiv
23222 On some processors, like Intel Atom, 8-bit unsigned integer divide is
23223 much faster than 32-bit/64-bit integer divide.  This option generates a
23224 run-time check.  If both dividend and divisor are within range of 0
23225 to 255, 8-bit unsigned integer divide is used instead of
23226 32-bit/64-bit integer divide.
23228 @item -mavx256-split-unaligned-load
23229 @itemx -mavx256-split-unaligned-store
23230 @opindex mavx256-split-unaligned-load
23231 @opindex mavx256-split-unaligned-store
23232 Split 32-byte AVX unaligned load and store.
23234 @item -mstack-protector-guard=@var{guard}
23235 @opindex mstack-protector-guard=@var{guard}
23236 Generate stack protection code using canary at @var{guard}.  Supported
23237 locations are @samp{global} for global canary or @samp{tls} for per-thread
23238 canary in the TLS block (the default).  This option has effect only when
23239 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
23241 @end table
23243 These @samp{-m} switches are supported in addition to the above
23244 on x86-64 processors in 64-bit environments.
23246 @table @gcctabopt
23247 @item -m32
23248 @itemx -m64
23249 @itemx -mx32
23250 @itemx -m16
23251 @opindex m32
23252 @opindex m64
23253 @opindex mx32
23254 @opindex m16
23255 Generate code for a 16-bit, 32-bit or 64-bit environment.
23256 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
23257 to 32 bits, and
23258 generates code that runs on any i386 system.
23260 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
23261 types to 64 bits, and generates code for the x86-64 architecture.
23262 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
23263 and @option{-mdynamic-no-pic} options.
23265 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
23266 to 32 bits, and
23267 generates code for the x86-64 architecture.
23269 The @option{-m16} option is the same as @option{-m32}, except for that
23270 it outputs the @code{.code16gcc} assembly directive at the beginning of
23271 the assembly output so that the binary can run in 16-bit mode.
23273 @item -mno-red-zone
23274 @opindex mno-red-zone
23275 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
23276 by the x86-64 ABI; it is a 128-byte area beyond the location of the
23277 stack pointer that is not modified by signal or interrupt handlers
23278 and therefore can be used for temporary data without adjusting the stack
23279 pointer.  The flag @option{-mno-red-zone} disables this red zone.
23281 @item -mcmodel=small
23282 @opindex mcmodel=small
23283 Generate code for the small code model: the program and its symbols must
23284 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
23285 Programs can be statically or dynamically linked.  This is the default
23286 code model.
23288 @item -mcmodel=kernel
23289 @opindex mcmodel=kernel
23290 Generate code for the kernel code model.  The kernel runs in the
23291 negative 2 GB of the address space.
23292 This model has to be used for Linux kernel code.
23294 @item -mcmodel=medium
23295 @opindex mcmodel=medium
23296 Generate code for the medium model: the program is linked in the lower 2
23297 GB of the address space.  Small symbols are also placed there.  Symbols
23298 with sizes larger than @option{-mlarge-data-threshold} are put into
23299 large data or BSS sections and can be located above 2GB.  Programs can
23300 be statically or dynamically linked.
23302 @item -mcmodel=large
23303 @opindex mcmodel=large
23304 Generate code for the large model.  This model makes no assumptions
23305 about addresses and sizes of sections.
23307 @item -maddress-mode=long
23308 @opindex maddress-mode=long
23309 Generate code for long address mode.  This is only supported for 64-bit
23310 and x32 environments.  It is the default address mode for 64-bit
23311 environments.
23313 @item -maddress-mode=short
23314 @opindex maddress-mode=short
23315 Generate code for short address mode.  This is only supported for 32-bit
23316 and x32 environments.  It is the default address mode for 32-bit and
23317 x32 environments.
23318 @end table
23320 @node x86 Windows Options
23321 @subsection x86 Windows Options
23322 @cindex x86 Windows Options
23323 @cindex Windows Options for x86
23325 These additional options are available for Microsoft Windows targets:
23327 @table @gcctabopt
23328 @item -mconsole
23329 @opindex mconsole
23330 This option
23331 specifies that a console application is to be generated, by
23332 instructing the linker to set the PE header subsystem type
23333 required for console applications.
23334 This option is available for Cygwin and MinGW targets and is
23335 enabled by default on those targets.
23337 @item -mdll
23338 @opindex mdll
23339 This option is available for Cygwin and MinGW targets.  It
23340 specifies that a DLL---a dynamic link library---is to be
23341 generated, enabling the selection of the required runtime
23342 startup object and entry point.
23344 @item -mnop-fun-dllimport
23345 @opindex mnop-fun-dllimport
23346 This option is available for Cygwin and MinGW targets.  It
23347 specifies that the @code{dllimport} attribute should be ignored.
23349 @item -mthread
23350 @opindex mthread
23351 This option is available for MinGW targets. It specifies
23352 that MinGW-specific thread support is to be used.
23354 @item -municode
23355 @opindex municode
23356 This option is available for MinGW-w64 targets.  It causes
23357 the @code{UNICODE} preprocessor macro to be predefined, and
23358 chooses Unicode-capable runtime startup code.
23360 @item -mwin32
23361 @opindex mwin32
23362 This option is available for Cygwin and MinGW targets.  It
23363 specifies that the typical Microsoft Windows predefined macros are to
23364 be set in the pre-processor, but does not influence the choice
23365 of runtime library/startup code.
23367 @item -mwindows
23368 @opindex mwindows
23369 This option is available for Cygwin and MinGW targets.  It
23370 specifies that a GUI application is to be generated by
23371 instructing the linker to set the PE header subsystem type
23372 appropriately.
23374 @item -fno-set-stack-executable
23375 @opindex fno-set-stack-executable
23376 This option is available for MinGW targets. It specifies that
23377 the executable flag for the stack used by nested functions isn't
23378 set. This is necessary for binaries running in kernel mode of
23379 Microsoft Windows, as there the User32 API, which is used to set executable
23380 privileges, isn't available.
23382 @item -fwritable-relocated-rdata
23383 @opindex fno-writable-relocated-rdata
23384 This option is available for MinGW and Cygwin targets.  It specifies
23385 that relocated-data in read-only section is put into .data
23386 section.  This is a necessary for older runtimes not supporting
23387 modification of .rdata sections for pseudo-relocation.
23389 @item -mpe-aligned-commons
23390 @opindex mpe-aligned-commons
23391 This option is available for Cygwin and MinGW targets.  It
23392 specifies that the GNU extension to the PE file format that
23393 permits the correct alignment of COMMON variables should be
23394 used when generating code.  It is enabled by default if
23395 GCC detects that the target assembler found during configuration
23396 supports the feature.
23397 @end table
23399 See also under @ref{x86 Options} for standard options.
23401 @node Xstormy16 Options
23402 @subsection Xstormy16 Options
23403 @cindex Xstormy16 Options
23405 These options are defined for Xstormy16:
23407 @table @gcctabopt
23408 @item -msim
23409 @opindex msim
23410 Choose startup files and linker script suitable for the simulator.
23411 @end table
23413 @node Xtensa Options
23414 @subsection Xtensa Options
23415 @cindex Xtensa Options
23417 These options are supported for Xtensa targets:
23419 @table @gcctabopt
23420 @item -mconst16
23421 @itemx -mno-const16
23422 @opindex mconst16
23423 @opindex mno-const16
23424 Enable or disable use of @code{CONST16} instructions for loading
23425 constant values.  The @code{CONST16} instruction is currently not a
23426 standard option from Tensilica.  When enabled, @code{CONST16}
23427 instructions are always used in place of the standard @code{L32R}
23428 instructions.  The use of @code{CONST16} is enabled by default only if
23429 the @code{L32R} instruction is not available.
23431 @item -mfused-madd
23432 @itemx -mno-fused-madd
23433 @opindex mfused-madd
23434 @opindex mno-fused-madd
23435 Enable or disable use of fused multiply/add and multiply/subtract
23436 instructions in the floating-point option.  This has no effect if the
23437 floating-point option is not also enabled.  Disabling fused multiply/add
23438 and multiply/subtract instructions forces the compiler to use separate
23439 instructions for the multiply and add/subtract operations.  This may be
23440 desirable in some cases where strict IEEE 754-compliant results are
23441 required: the fused multiply add/subtract instructions do not round the
23442 intermediate result, thereby producing results with @emph{more} bits of
23443 precision than specified by the IEEE standard.  Disabling fused multiply
23444 add/subtract instructions also ensures that the program output is not
23445 sensitive to the compiler's ability to combine multiply and add/subtract
23446 operations.
23448 @item -mserialize-volatile
23449 @itemx -mno-serialize-volatile
23450 @opindex mserialize-volatile
23451 @opindex mno-serialize-volatile
23452 When this option is enabled, GCC inserts @code{MEMW} instructions before
23453 @code{volatile} memory references to guarantee sequential consistency.
23454 The default is @option{-mserialize-volatile}.  Use
23455 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
23457 @item -mforce-no-pic
23458 @opindex mforce-no-pic
23459 For targets, like GNU/Linux, where all user-mode Xtensa code must be
23460 position-independent code (PIC), this option disables PIC for compiling
23461 kernel code.
23463 @item -mtext-section-literals
23464 @itemx -mno-text-section-literals
23465 @opindex mtext-section-literals
23466 @opindex mno-text-section-literals
23467 These options control the treatment of literal pools.  The default is
23468 @option{-mno-text-section-literals}, which places literals in a separate
23469 section in the output file.  This allows the literal pool to be placed
23470 in a data RAM/ROM, and it also allows the linker to combine literal
23471 pools from separate object files to remove redundant literals and
23472 improve code size.  With @option{-mtext-section-literals}, the literals
23473 are interspersed in the text section in order to keep them as close as
23474 possible to their references.  This may be necessary for large assembly
23475 files.
23477 @item -mtarget-align
23478 @itemx -mno-target-align
23479 @opindex mtarget-align
23480 @opindex mno-target-align
23481 When this option is enabled, GCC instructs the assembler to
23482 automatically align instructions to reduce branch penalties at the
23483 expense of some code density.  The assembler attempts to widen density
23484 instructions to align branch targets and the instructions following call
23485 instructions.  If there are not enough preceding safe density
23486 instructions to align a target, no widening is performed.  The
23487 default is @option{-mtarget-align}.  These options do not affect the
23488 treatment of auto-aligned instructions like @code{LOOP}, which the
23489 assembler always aligns, either by widening density instructions or
23490 by inserting NOP instructions.
23492 @item -mlongcalls
23493 @itemx -mno-longcalls
23494 @opindex mlongcalls
23495 @opindex mno-longcalls
23496 When this option is enabled, GCC instructs the assembler to translate
23497 direct calls to indirect calls unless it can determine that the target
23498 of a direct call is in the range allowed by the call instruction.  This
23499 translation typically occurs for calls to functions in other source
23500 files.  Specifically, the assembler translates a direct @code{CALL}
23501 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
23502 The default is @option{-mno-longcalls}.  This option should be used in
23503 programs where the call target can potentially be out of range.  This
23504 option is implemented in the assembler, not the compiler, so the
23505 assembly code generated by GCC still shows direct call
23506 instructions---look at the disassembled object code to see the actual
23507 instructions.  Note that the assembler uses an indirect call for
23508 every cross-file call, not just those that really are out of range.
23509 @end table
23511 @node zSeries Options
23512 @subsection zSeries Options
23513 @cindex zSeries options
23515 These are listed under @xref{S/390 and zSeries Options}.
23517 @node Code Gen Options
23518 @section Options for Code Generation Conventions
23519 @cindex code generation conventions
23520 @cindex options, code generation
23521 @cindex run-time options
23523 These machine-independent options control the interface conventions
23524 used in code generation.
23526 Most of them have both positive and negative forms; the negative form
23527 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
23528 one of the forms is listed---the one that is not the default.  You
23529 can figure out the other form by either removing @samp{no-} or adding
23532 @table @gcctabopt
23533 @item -fbounds-check
23534 @opindex fbounds-check
23535 For front ends that support it, generate additional code to check that
23536 indices used to access arrays are within the declared range.  This is
23537 currently only supported by the Java and Fortran front ends, where
23538 this option defaults to true and false respectively.
23540 @item -fstack-reuse=@var{reuse-level}
23541 @opindex fstack_reuse
23542 This option controls stack space reuse for user declared local/auto variables
23543 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
23544 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
23545 local variables and temporaries, @samp{named_vars} enables the reuse only for
23546 user defined local variables with names, and @samp{none} disables stack reuse
23547 completely. The default value is @samp{all}. The option is needed when the
23548 program extends the lifetime of a scoped local variable or a compiler generated
23549 temporary beyond the end point defined by the language.  When a lifetime of
23550 a variable ends, and if the variable lives in memory, the optimizing compiler
23551 has the freedom to reuse its stack space with other temporaries or scoped
23552 local variables whose live range does not overlap with it. Legacy code extending
23553 local lifetime is likely to break with the stack reuse optimization.
23555 For example,
23557 @smallexample
23558    int *p;
23559    @{
23560      int local1;
23562      p = &local1;
23563      local1 = 10;
23564      ....
23565    @}
23566    @{
23567       int local2;
23568       local2 = 20;
23569       ...
23570    @}
23572    if (*p == 10)  // out of scope use of local1
23573      @{
23575      @}
23576 @end smallexample
23578 Another example:
23579 @smallexample
23581    struct A
23582    @{
23583        A(int k) : i(k), j(k) @{ @}
23584        int i;
23585        int j;
23586    @};
23588    A *ap;
23590    void foo(const A& ar)
23591    @{
23592       ap = &ar;
23593    @}
23595    void bar()
23596    @{
23597       foo(A(10)); // temp object's lifetime ends when foo returns
23599       @{
23600         A a(20);
23601         ....
23602       @}
23603       ap->i+= 10;  // ap references out of scope temp whose space
23604                    // is reused with a. What is the value of ap->i?
23605    @}
23607 @end smallexample
23609 The lifetime of a compiler generated temporary is well defined by the C++
23610 standard. When a lifetime of a temporary ends, and if the temporary lives
23611 in memory, the optimizing compiler has the freedom to reuse its stack
23612 space with other temporaries or scoped local variables whose live range
23613 does not overlap with it. However some of the legacy code relies on
23614 the behavior of older compilers in which temporaries' stack space is
23615 not reused, the aggressive stack reuse can lead to runtime errors. This
23616 option is used to control the temporary stack reuse optimization.
23618 @item -ftrapv
23619 @opindex ftrapv
23620 This option generates traps for signed overflow on addition, subtraction,
23621 multiplication operations.
23623 @item -fwrapv
23624 @opindex fwrapv
23625 This option instructs the compiler to assume that signed arithmetic
23626 overflow of addition, subtraction and multiplication wraps around
23627 using twos-complement representation.  This flag enables some optimizations
23628 and disables others.  This option is enabled by default for the Java
23629 front end, as required by the Java language specification.
23631 @item -fexceptions
23632 @opindex fexceptions
23633 Enable exception handling.  Generates extra code needed to propagate
23634 exceptions.  For some targets, this implies GCC generates frame
23635 unwind information for all functions, which can produce significant data
23636 size overhead, although it does not affect execution.  If you do not
23637 specify this option, GCC enables it by default for languages like
23638 C++ that normally require exception handling, and disables it for
23639 languages like C that do not normally require it.  However, you may need
23640 to enable this option when compiling C code that needs to interoperate
23641 properly with exception handlers written in C++.  You may also wish to
23642 disable this option if you are compiling older C++ programs that don't
23643 use exception handling.
23645 @item -fnon-call-exceptions
23646 @opindex fnon-call-exceptions
23647 Generate code that allows trapping instructions to throw exceptions.
23648 Note that this requires platform-specific runtime support that does
23649 not exist everywhere.  Moreover, it only allows @emph{trapping}
23650 instructions to throw exceptions, i.e.@: memory references or floating-point
23651 instructions.  It does not allow exceptions to be thrown from
23652 arbitrary signal handlers such as @code{SIGALRM}.
23654 @item -fdelete-dead-exceptions
23655 @opindex fdelete-dead-exceptions
23656 Consider that instructions that may throw exceptions but don't otherwise
23657 contribute to the execution of the program can be optimized away.
23658 This option is enabled by default for the Ada front end, as permitted by
23659 the Ada language specification.
23660 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
23662 @item -funwind-tables
23663 @opindex funwind-tables
23664 Similar to @option{-fexceptions}, except that it just generates any needed
23665 static data, but does not affect the generated code in any other way.
23666 You normally do not need to enable this option; instead, a language processor
23667 that needs this handling enables it on your behalf.
23669 @item -fasynchronous-unwind-tables
23670 @opindex fasynchronous-unwind-tables
23671 Generate unwind table in DWARF 2 format, if supported by target machine.  The
23672 table is exact at each instruction boundary, so it can be used for stack
23673 unwinding from asynchronous events (such as debugger or garbage collector).
23675 @item -fno-gnu-unique
23676 @opindex fno-gnu-unique
23677 On systems with recent GNU assembler and C library, the C++ compiler
23678 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
23679 of template static data members and static local variables in inline
23680 functions are unique even in the presence of @code{RTLD_LOCAL}; this
23681 is necessary to avoid problems with a library used by two different
23682 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
23683 therefore disagreeing with the other one about the binding of the
23684 symbol.  But this causes @code{dlclose} to be ignored for affected
23685 DSOs; if your program relies on reinitialization of a DSO via
23686 @code{dlclose} and @code{dlopen}, you can use
23687 @option{-fno-gnu-unique}.
23689 @item -fpcc-struct-return
23690 @opindex fpcc-struct-return
23691 Return ``short'' @code{struct} and @code{union} values in memory like
23692 longer ones, rather than in registers.  This convention is less
23693 efficient, but it has the advantage of allowing intercallability between
23694 GCC-compiled files and files compiled with other compilers, particularly
23695 the Portable C Compiler (pcc).
23697 The precise convention for returning structures in memory depends
23698 on the target configuration macros.
23700 Short structures and unions are those whose size and alignment match
23701 that of some integer type.
23703 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
23704 switch is not binary compatible with code compiled with the
23705 @option{-freg-struct-return} switch.
23706 Use it to conform to a non-default application binary interface.
23708 @item -freg-struct-return
23709 @opindex freg-struct-return
23710 Return @code{struct} and @code{union} values in registers when possible.
23711 This is more efficient for small structures than
23712 @option{-fpcc-struct-return}.
23714 If you specify neither @option{-fpcc-struct-return} nor
23715 @option{-freg-struct-return}, GCC defaults to whichever convention is
23716 standard for the target.  If there is no standard convention, GCC
23717 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
23718 the principal compiler.  In those cases, we can choose the standard, and
23719 we chose the more efficient register return alternative.
23721 @strong{Warning:} code compiled with the @option{-freg-struct-return}
23722 switch is not binary compatible with code compiled with the
23723 @option{-fpcc-struct-return} switch.
23724 Use it to conform to a non-default application binary interface.
23726 @item -fshort-enums
23727 @opindex fshort-enums
23728 Allocate to an @code{enum} type only as many bytes as it needs for the
23729 declared range of possible values.  Specifically, the @code{enum} type
23730 is equivalent to the smallest integer type that has enough room.
23732 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
23733 code that is not binary compatible with code generated without that switch.
23734 Use it to conform to a non-default application binary interface.
23736 @item -fshort-double
23737 @opindex fshort-double
23738 Use the same size for @code{double} as for @code{float}.
23740 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
23741 code that is not binary compatible with code generated without that switch.
23742 Use it to conform to a non-default application binary interface.
23744 @item -fshort-wchar
23745 @opindex fshort-wchar
23746 Override the underlying type for @code{wchar_t} to be @code{short
23747 unsigned int} instead of the default for the target.  This option is
23748 useful for building programs to run under WINE@.
23750 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
23751 code that is not binary compatible with code generated without that switch.
23752 Use it to conform to a non-default application binary interface.
23754 @item -fno-common
23755 @opindex fno-common
23756 In C code, controls the placement of uninitialized global variables.
23757 Unix C compilers have traditionally permitted multiple definitions of
23758 such variables in different compilation units by placing the variables
23759 in a common block.
23760 This is the behavior specified by @option{-fcommon}, and is the default
23761 for GCC on most targets.
23762 On the other hand, this behavior is not required by ISO C, and on some
23763 targets may carry a speed or code size penalty on variable references.
23764 The @option{-fno-common} option specifies that the compiler should place
23765 uninitialized global variables in the data section of the object file,
23766 rather than generating them as common blocks.
23767 This has the effect that if the same variable is declared
23768 (without @code{extern}) in two different compilations,
23769 you get a multiple-definition error when you link them.
23770 In this case, you must compile with @option{-fcommon} instead.
23771 Compiling with @option{-fno-common} is useful on targets for which
23772 it provides better performance, or if you wish to verify that the
23773 program will work on other systems that always treat uninitialized
23774 variable declarations this way.
23776 @item -fno-ident
23777 @opindex fno-ident
23778 Ignore the @code{#ident} directive.
23780 @item -finhibit-size-directive
23781 @opindex finhibit-size-directive
23782 Don't output a @code{.size} assembler directive, or anything else that
23783 would cause trouble if the function is split in the middle, and the
23784 two halves are placed at locations far apart in memory.  This option is
23785 used when compiling @file{crtstuff.c}; you should not need to use it
23786 for anything else.
23788 @item -fverbose-asm
23789 @opindex fverbose-asm
23790 Put extra commentary information in the generated assembly code to
23791 make it more readable.  This option is generally only of use to those
23792 who actually need to read the generated assembly code (perhaps while
23793 debugging the compiler itself).
23795 @option{-fno-verbose-asm}, the default, causes the
23796 extra information to be omitted and is useful when comparing two assembler
23797 files.
23799 @item -frecord-gcc-switches
23800 @opindex frecord-gcc-switches
23801 This switch causes the command line used to invoke the
23802 compiler to be recorded into the object file that is being created.
23803 This switch is only implemented on some targets and the exact format
23804 of the recording is target and binary file format dependent, but it
23805 usually takes the form of a section containing ASCII text.  This
23806 switch is related to the @option{-fverbose-asm} switch, but that
23807 switch only records information in the assembler output file as
23808 comments, so it never reaches the object file.
23809 See also @option{-grecord-gcc-switches} for another
23810 way of storing compiler options into the object file.
23812 @item -fpic
23813 @opindex fpic
23814 @cindex global offset table
23815 @cindex PIC
23816 Generate position-independent code (PIC) suitable for use in a shared
23817 library, if supported for the target machine.  Such code accesses all
23818 constant addresses through a global offset table (GOT)@.  The dynamic
23819 loader resolves the GOT entries when the program starts (the dynamic
23820 loader is not part of GCC; it is part of the operating system).  If
23821 the GOT size for the linked executable exceeds a machine-specific
23822 maximum size, you get an error message from the linker indicating that
23823 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23824 instead.  (These maximums are 8k on the SPARC and 32k
23825 on the m68k and RS/6000.  The x86 has no such limit.)
23827 Position-independent code requires special support, and therefore works
23828 only on certain machines.  For the x86, GCC supports PIC for System V
23829 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23830 position-independent.
23832 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23833 are defined to 1.
23835 @item -fPIC
23836 @opindex fPIC
23837 If supported for the target machine, emit position-independent code,
23838 suitable for dynamic linking and avoiding any limit on the size of the
23839 global offset table.  This option makes a difference on the m68k,
23840 PowerPC and SPARC@.
23842 Position-independent code requires special support, and therefore works
23843 only on certain machines.
23845 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23846 are defined to 2.
23848 @item -fpie
23849 @itemx -fPIE
23850 @opindex fpie
23851 @opindex fPIE
23852 These options are similar to @option{-fpic} and @option{-fPIC}, but
23853 generated position independent code can be only linked into executables.
23854 Usually these options are used when @option{-pie} GCC option is
23855 used during linking.
23857 @option{-fpie} and @option{-fPIE} both define the macros
23858 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23859 for @option{-fpie} and 2 for @option{-fPIE}.
23861 @item -fno-plt
23862 @opindex fno-plt
23863 Do not use PLT for external function calls in position-independent code.
23864 Instead, load callee address at call site from GOT and branch to it.
23865 This leads to more efficient code by eliminating PLT stubs and exposing
23866 GOT load to optimizations.  On architectures such as 32-bit x86 where
23867 PLT stubs expect GOT pointer in a specific register, this gives more
23868 register allocation freedom to the compiler.  Lazy binding requires PLT:
23869 with @option{-fno-plt} all external symbols are resolved at load time.
23871 @item -fno-jump-tables
23872 @opindex fno-jump-tables
23873 Do not use jump tables for switch statements even where it would be
23874 more efficient than other code generation strategies.  This option is
23875 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23876 building code that forms part of a dynamic linker and cannot
23877 reference the address of a jump table.  On some targets, jump tables
23878 do not require a GOT and this option is not needed.
23880 @item -ffixed-@var{reg}
23881 @opindex ffixed
23882 Treat the register named @var{reg} as a fixed register; generated code
23883 should never refer to it (except perhaps as a stack pointer, frame
23884 pointer or in some other fixed role).
23886 @var{reg} must be the name of a register.  The register names accepted
23887 are machine-specific and are defined in the @code{REGISTER_NAMES}
23888 macro in the machine description macro file.
23890 This flag does not have a negative form, because it specifies a
23891 three-way choice.
23893 @item -fcall-used-@var{reg}
23894 @opindex fcall-used
23895 Treat the register named @var{reg} as an allocable register that is
23896 clobbered by function calls.  It may be allocated for temporaries or
23897 variables that do not live across a call.  Functions compiled this way
23898 do not save and restore the register @var{reg}.
23900 It is an error to use this flag with the frame pointer or stack pointer.
23901 Use of this flag for other registers that have fixed pervasive roles in
23902 the machine's execution model produces disastrous results.
23904 This flag does not have a negative form, because it specifies a
23905 three-way choice.
23907 @item -fcall-saved-@var{reg}
23908 @opindex fcall-saved
23909 Treat the register named @var{reg} as an allocable register saved by
23910 functions.  It may be allocated even for temporaries or variables that
23911 live across a call.  Functions compiled this way save and restore
23912 the register @var{reg} if they use it.
23914 It is an error to use this flag with the frame pointer or stack pointer.
23915 Use of this flag for other registers that have fixed pervasive roles in
23916 the machine's execution model produces disastrous results.
23918 A different sort of disaster results from the use of this flag for
23919 a register in which function values may be returned.
23921 This flag does not have a negative form, because it specifies a
23922 three-way choice.
23924 @item -fpack-struct[=@var{n}]
23925 @opindex fpack-struct
23926 Without a value specified, pack all structure members together without
23927 holes.  When a value is specified (which must be a small power of two), pack
23928 structure members according to this value, representing the maximum
23929 alignment (that is, objects with default alignment requirements larger than
23930 this are output potentially unaligned at the next fitting location.
23932 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23933 code that is not binary compatible with code generated without that switch.
23934 Additionally, it makes the code suboptimal.
23935 Use it to conform to a non-default application binary interface.
23937 @item -finstrument-functions
23938 @opindex finstrument-functions
23939 Generate instrumentation calls for entry and exit to functions.  Just
23940 after function entry and just before function exit, the following
23941 profiling functions are called with the address of the current
23942 function and its call site.  (On some platforms,
23943 @code{__builtin_return_address} does not work beyond the current
23944 function, so the call site information may not be available to the
23945 profiling functions otherwise.)
23947 @smallexample
23948 void __cyg_profile_func_enter (void *this_fn,
23949                                void *call_site);
23950 void __cyg_profile_func_exit  (void *this_fn,
23951                                void *call_site);
23952 @end smallexample
23954 The first argument is the address of the start of the current function,
23955 which may be looked up exactly in the symbol table.
23957 This instrumentation is also done for functions expanded inline in other
23958 functions.  The profiling calls indicate where, conceptually, the
23959 inline function is entered and exited.  This means that addressable
23960 versions of such functions must be available.  If all your uses of a
23961 function are expanded inline, this may mean an additional expansion of
23962 code size.  If you use @code{extern inline} in your C code, an
23963 addressable version of such functions must be provided.  (This is
23964 normally the case anyway, but if you get lucky and the optimizer always
23965 expands the functions inline, you might have gotten away without
23966 providing static copies.)
23968 A function may be given the attribute @code{no_instrument_function}, in
23969 which case this instrumentation is not done.  This can be used, for
23970 example, for the profiling functions listed above, high-priority
23971 interrupt routines, and any functions from which the profiling functions
23972 cannot safely be called (perhaps signal handlers, if the profiling
23973 routines generate output or allocate memory).
23975 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
23976 @opindex finstrument-functions-exclude-file-list
23978 Set the list of functions that are excluded from instrumentation (see
23979 the description of @option{-finstrument-functions}).  If the file that
23980 contains a function definition matches with one of @var{file}, then
23981 that function is not instrumented.  The match is done on substrings:
23982 if the @var{file} parameter is a substring of the file name, it is
23983 considered to be a match.
23985 For example:
23987 @smallexample
23988 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
23989 @end smallexample
23991 @noindent
23992 excludes any inline function defined in files whose pathnames
23993 contain @file{/bits/stl} or @file{include/sys}.
23995 If, for some reason, you want to include letter @samp{,} in one of
23996 @var{sym}, write @samp{\,}. For example,
23997 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
23998 (note the single quote surrounding the option).
24000 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
24001 @opindex finstrument-functions-exclude-function-list
24003 This is similar to @option{-finstrument-functions-exclude-file-list},
24004 but this option sets the list of function names to be excluded from
24005 instrumentation.  The function name to be matched is its user-visible
24006 name, such as @code{vector<int> blah(const vector<int> &)}, not the
24007 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
24008 match is done on substrings: if the @var{sym} parameter is a substring
24009 of the function name, it is considered to be a match.  For C99 and C++
24010 extended identifiers, the function name must be given in UTF-8, not
24011 using universal character names.
24013 @item -fstack-check
24014 @opindex fstack-check
24015 Generate code to verify that you do not go beyond the boundary of the
24016 stack.  You should specify this flag if you are running in an
24017 environment with multiple threads, but you only rarely need to specify it in
24018 a single-threaded environment since stack overflow is automatically
24019 detected on nearly all systems if there is only one stack.
24021 Note that this switch does not actually cause checking to be done; the
24022 operating system or the language runtime must do that.  The switch causes
24023 generation of code to ensure that they see the stack being extended.
24025 You can additionally specify a string parameter: @samp{no} means no
24026 checking, @samp{generic} means force the use of old-style checking,
24027 @samp{specific} means use the best checking method and is equivalent
24028 to bare @option{-fstack-check}.
24030 Old-style checking is a generic mechanism that requires no specific
24031 target support in the compiler but comes with the following drawbacks:
24033 @enumerate
24034 @item
24035 Modified allocation strategy for large objects: they are always
24036 allocated dynamically if their size exceeds a fixed threshold.
24038 @item
24039 Fixed limit on the size of the static frame of functions: when it is
24040 topped by a particular function, stack checking is not reliable and
24041 a warning is issued by the compiler.
24043 @item
24044 Inefficiency: because of both the modified allocation strategy and the
24045 generic implementation, code performance is hampered.
24046 @end enumerate
24048 Note that old-style stack checking is also the fallback method for
24049 @samp{specific} if no target support has been added in the compiler.
24051 @item -fstack-limit-register=@var{reg}
24052 @itemx -fstack-limit-symbol=@var{sym}
24053 @itemx -fno-stack-limit
24054 @opindex fstack-limit-register
24055 @opindex fstack-limit-symbol
24056 @opindex fno-stack-limit
24057 Generate code to ensure that the stack does not grow beyond a certain value,
24058 either the value of a register or the address of a symbol.  If a larger
24059 stack is required, a signal is raised at run time.  For most targets,
24060 the signal is raised before the stack overruns the boundary, so
24061 it is possible to catch the signal without taking special precautions.
24063 For instance, if the stack starts at absolute address @samp{0x80000000}
24064 and grows downwards, you can use the flags
24065 @option{-fstack-limit-symbol=__stack_limit} and
24066 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
24067 of 128KB@.  Note that this may only work with the GNU linker.
24069 @item -fsplit-stack
24070 @opindex fsplit-stack
24071 Generate code to automatically split the stack before it overflows.
24072 The resulting program has a discontiguous stack which can only
24073 overflow if the program is unable to allocate any more memory.  This
24074 is most useful when running threaded programs, as it is no longer
24075 necessary to calculate a good stack size to use for each thread.  This
24076 is currently only implemented for the x86 targets running
24077 GNU/Linux.
24079 When code compiled with @option{-fsplit-stack} calls code compiled
24080 without @option{-fsplit-stack}, there may not be much stack space
24081 available for the latter code to run.  If compiling all code,
24082 including library code, with @option{-fsplit-stack} is not an option,
24083 then the linker can fix up these calls so that the code compiled
24084 without @option{-fsplit-stack} always has a large stack.  Support for
24085 this is implemented in the gold linker in GNU binutils release 2.21
24086 and later.
24088 @item -fleading-underscore
24089 @opindex fleading-underscore
24090 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
24091 change the way C symbols are represented in the object file.  One use
24092 is to help link with legacy assembly code.
24094 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
24095 generate code that is not binary compatible with code generated without that
24096 switch.  Use it to conform to a non-default application binary interface.
24097 Not all targets provide complete support for this switch.
24099 @item -ftls-model=@var{model}
24100 @opindex ftls-model
24101 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
24102 The @var{model} argument should be one of @samp{global-dynamic},
24103 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
24104 Note that the choice is subject to optimization: the compiler may use
24105 a more efficient model for symbols not visible outside of the translation
24106 unit, or if @option{-fpic} is not given on the command line.
24108 The default without @option{-fpic} is @samp{initial-exec}; with
24109 @option{-fpic} the default is @samp{global-dynamic}.
24111 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
24112 @opindex fvisibility
24113 Set the default ELF image symbol visibility to the specified option---all
24114 symbols are marked with this unless overridden within the code.
24115 Using this feature can very substantially improve linking and
24116 load times of shared object libraries, produce more optimized
24117 code, provide near-perfect API export and prevent symbol clashes.
24118 It is @strong{strongly} recommended that you use this in any shared objects
24119 you distribute.
24121 Despite the nomenclature, @samp{default} always means public; i.e.,
24122 available to be linked against from outside the shared object.
24123 @samp{protected} and @samp{internal} are pretty useless in real-world
24124 usage so the only other commonly used option is @samp{hidden}.
24125 The default if @option{-fvisibility} isn't specified is
24126 @samp{default}, i.e., make every symbol public.
24128 A good explanation of the benefits offered by ensuring ELF
24129 symbols have the correct visibility is given by ``How To Write
24130 Shared Libraries'' by Ulrich Drepper (which can be found at
24131 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
24132 solution made possible by this option to marking things hidden when
24133 the default is public is to make the default hidden and mark things
24134 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
24135 and @code{__attribute__ ((visibility("default")))} instead of
24136 @code{__declspec(dllexport)} you get almost identical semantics with
24137 identical syntax.  This is a great boon to those working with
24138 cross-platform projects.
24140 For those adding visibility support to existing code, you may find
24141 @code{#pragma GCC visibility} of use.  This works by you enclosing
24142 the declarations you wish to set visibility for with (for example)
24143 @code{#pragma GCC visibility push(hidden)} and
24144 @code{#pragma GCC visibility pop}.
24145 Bear in mind that symbol visibility should be viewed @strong{as
24146 part of the API interface contract} and thus all new code should
24147 always specify visibility when it is not the default; i.e., declarations
24148 only for use within the local DSO should @strong{always} be marked explicitly
24149 as hidden as so to avoid PLT indirection overheads---making this
24150 abundantly clear also aids readability and self-documentation of the code.
24151 Note that due to ISO C++ specification requirements, @code{operator new} and
24152 @code{operator delete} must always be of default visibility.
24154 Be aware that headers from outside your project, in particular system
24155 headers and headers from any other library you use, may not be
24156 expecting to be compiled with visibility other than the default.  You
24157 may need to explicitly say @code{#pragma GCC visibility push(default)}
24158 before including any such headers.
24160 @code{extern} declarations are not affected by @option{-fvisibility}, so
24161 a lot of code can be recompiled with @option{-fvisibility=hidden} with
24162 no modifications.  However, this means that calls to @code{extern}
24163 functions with no explicit visibility use the PLT, so it is more
24164 effective to use @code{__attribute ((visibility))} and/or
24165 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
24166 declarations should be treated as hidden.
24168 Note that @option{-fvisibility} does affect C++ vague linkage
24169 entities. This means that, for instance, an exception class that is
24170 be thrown between DSOs must be explicitly marked with default
24171 visibility so that the @samp{type_info} nodes are unified between
24172 the DSOs.
24174 An overview of these techniques, their benefits and how to use them
24175 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
24177 @item -fstrict-volatile-bitfields
24178 @opindex fstrict-volatile-bitfields
24179 This option should be used if accesses to volatile bit-fields (or other
24180 structure fields, although the compiler usually honors those types
24181 anyway) should use a single access of the width of the
24182 field's type, aligned to a natural alignment if possible.  For
24183 example, targets with memory-mapped peripheral registers might require
24184 all such accesses to be 16 bits wide; with this flag you can
24185 declare all peripheral bit-fields as @code{unsigned short} (assuming short
24186 is 16 bits on these targets) to force GCC to use 16-bit accesses
24187 instead of, perhaps, a more efficient 32-bit access.
24189 If this option is disabled, the compiler uses the most efficient
24190 instruction.  In the previous example, that might be a 32-bit load
24191 instruction, even though that accesses bytes that do not contain
24192 any portion of the bit-field, or memory-mapped registers unrelated to
24193 the one being updated.
24195 In some cases, such as when the @code{packed} attribute is applied to a 
24196 structure field, it may not be possible to access the field with a single
24197 read or write that is correctly aligned for the target machine.  In this
24198 case GCC falls back to generating multiple accesses rather than code that 
24199 will fault or truncate the result at run time.
24201 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
24202 not allowed to touch non bit-field members.  It is therefore recommended
24203 to define all bits of the field's type as bit-field members.
24205 The default value of this option is determined by the application binary
24206 interface for the target processor.
24208 @item -fsync-libcalls
24209 @opindex fsync-libcalls
24210 This option controls whether any out-of-line instance of the @code{__sync}
24211 family of functions may be used to implement the C++11 @code{__atomic}
24212 family of functions.
24214 The default value of this option is enabled, thus the only useful form
24215 of the option is @option{-fno-sync-libcalls}.  This option is used in
24216 the implementation of the @file{libatomic} runtime library.
24218 @end table
24220 @c man end
24222 @node Environment Variables
24223 @section Environment Variables Affecting GCC
24224 @cindex environment variables
24226 @c man begin ENVIRONMENT
24227 This section describes several environment variables that affect how GCC
24228 operates.  Some of them work by specifying directories or prefixes to use
24229 when searching for various kinds of files.  Some are used to specify other
24230 aspects of the compilation environment.
24232 Note that you can also specify places to search using options such as
24233 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
24234 take precedence over places specified using environment variables, which
24235 in turn take precedence over those specified by the configuration of GCC@.
24236 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
24237 GNU Compiler Collection (GCC) Internals}.
24239 @table @env
24240 @item LANG
24241 @itemx LC_CTYPE
24242 @c @itemx LC_COLLATE
24243 @itemx LC_MESSAGES
24244 @c @itemx LC_MONETARY
24245 @c @itemx LC_NUMERIC
24246 @c @itemx LC_TIME
24247 @itemx LC_ALL
24248 @findex LANG
24249 @findex LC_CTYPE
24250 @c @findex LC_COLLATE
24251 @findex LC_MESSAGES
24252 @c @findex LC_MONETARY
24253 @c @findex LC_NUMERIC
24254 @c @findex LC_TIME
24255 @findex LC_ALL
24256 @cindex locale
24257 These environment variables control the way that GCC uses
24258 localization information which allows GCC to work with different
24259 national conventions.  GCC inspects the locale categories
24260 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
24261 so.  These locale categories can be set to any value supported by your
24262 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
24263 Kingdom encoded in UTF-8.
24265 The @env{LC_CTYPE} environment variable specifies character
24266 classification.  GCC uses it to determine the character boundaries in
24267 a string; this is needed for some multibyte encodings that contain quote
24268 and escape characters that are otherwise interpreted as a string
24269 end or escape.
24271 The @env{LC_MESSAGES} environment variable specifies the language to
24272 use in diagnostic messages.
24274 If the @env{LC_ALL} environment variable is set, it overrides the value
24275 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
24276 and @env{LC_MESSAGES} default to the value of the @env{LANG}
24277 environment variable.  If none of these variables are set, GCC
24278 defaults to traditional C English behavior.
24280 @item TMPDIR
24281 @findex TMPDIR
24282 If @env{TMPDIR} is set, it specifies the directory to use for temporary
24283 files.  GCC uses temporary files to hold the output of one stage of
24284 compilation which is to be used as input to the next stage: for example,
24285 the output of the preprocessor, which is the input to the compiler
24286 proper.
24288 @item GCC_COMPARE_DEBUG
24289 @findex GCC_COMPARE_DEBUG
24290 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
24291 @option{-fcompare-debug} to the compiler driver.  See the documentation
24292 of this option for more details.
24294 @item GCC_EXEC_PREFIX
24295 @findex GCC_EXEC_PREFIX
24296 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
24297 names of the subprograms executed by the compiler.  No slash is added
24298 when this prefix is combined with the name of a subprogram, but you can
24299 specify a prefix that ends with a slash if you wish.
24301 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
24302 an appropriate prefix to use based on the pathname it is invoked with.
24304 If GCC cannot find the subprogram using the specified prefix, it
24305 tries looking in the usual places for the subprogram.
24307 The default value of @env{GCC_EXEC_PREFIX} is
24308 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
24309 the installed compiler. In many cases @var{prefix} is the value
24310 of @code{prefix} when you ran the @file{configure} script.
24312 Other prefixes specified with @option{-B} take precedence over this prefix.
24314 This prefix is also used for finding files such as @file{crt0.o} that are
24315 used for linking.
24317 In addition, the prefix is used in an unusual way in finding the
24318 directories to search for header files.  For each of the standard
24319 directories whose name normally begins with @samp{/usr/local/lib/gcc}
24320 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
24321 replacing that beginning with the specified prefix to produce an
24322 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
24323 @file{foo/bar} just before it searches the standard directory 
24324 @file{/usr/local/lib/bar}.
24325 If a standard directory begins with the configured
24326 @var{prefix} then the value of @var{prefix} is replaced by
24327 @env{GCC_EXEC_PREFIX} when looking for header files.
24329 @item COMPILER_PATH
24330 @findex COMPILER_PATH
24331 The value of @env{COMPILER_PATH} is a colon-separated list of
24332 directories, much like @env{PATH}.  GCC tries the directories thus
24333 specified when searching for subprograms, if it can't find the
24334 subprograms using @env{GCC_EXEC_PREFIX}.
24336 @item LIBRARY_PATH
24337 @findex LIBRARY_PATH
24338 The value of @env{LIBRARY_PATH} is a colon-separated list of
24339 directories, much like @env{PATH}.  When configured as a native compiler,
24340 GCC tries the directories thus specified when searching for special
24341 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
24342 using GCC also uses these directories when searching for ordinary
24343 libraries for the @option{-l} option (but directories specified with
24344 @option{-L} come first).
24346 @item LANG
24347 @findex LANG
24348 @cindex locale definition
24349 This variable is used to pass locale information to the compiler.  One way in
24350 which this information is used is to determine the character set to be used
24351 when character literals, string literals and comments are parsed in C and C++.
24352 When the compiler is configured to allow multibyte characters,
24353 the following values for @env{LANG} are recognized:
24355 @table @samp
24356 @item C-JIS
24357 Recognize JIS characters.
24358 @item C-SJIS
24359 Recognize SJIS characters.
24360 @item C-EUCJP
24361 Recognize EUCJP characters.
24362 @end table
24364 If @env{LANG} is not defined, or if it has some other value, then the
24365 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
24366 recognize and translate multibyte characters.
24367 @end table
24369 @noindent
24370 Some additional environment variables affect the behavior of the
24371 preprocessor.
24373 @include cppenv.texi
24375 @c man end
24377 @node Precompiled Headers
24378 @section Using Precompiled Headers
24379 @cindex precompiled headers
24380 @cindex speed of compilation
24382 Often large projects have many header files that are included in every
24383 source file.  The time the compiler takes to process these header files
24384 over and over again can account for nearly all of the time required to
24385 build the project.  To make builds faster, GCC allows you to
24386 @dfn{precompile} a header file.
24388 To create a precompiled header file, simply compile it as you would any
24389 other file, if necessary using the @option{-x} option to make the driver
24390 treat it as a C or C++ header file.  You may want to use a
24391 tool like @command{make} to keep the precompiled header up-to-date when
24392 the headers it contains change.
24394 A precompiled header file is searched for when @code{#include} is
24395 seen in the compilation.  As it searches for the included file
24396 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
24397 compiler looks for a precompiled header in each directory just before it
24398 looks for the include file in that directory.  The name searched for is
24399 the name specified in the @code{#include} with @samp{.gch} appended.  If
24400 the precompiled header file can't be used, it is ignored.
24402 For instance, if you have @code{#include "all.h"}, and you have
24403 @file{all.h.gch} in the same directory as @file{all.h}, then the
24404 precompiled header file is used if possible, and the original
24405 header is used otherwise.
24407 Alternatively, you might decide to put the precompiled header file in a
24408 directory and use @option{-I} to ensure that directory is searched
24409 before (or instead of) the directory containing the original header.
24410 Then, if you want to check that the precompiled header file is always
24411 used, you can put a file of the same name as the original header in this
24412 directory containing an @code{#error} command.
24414 This also works with @option{-include}.  So yet another way to use
24415 precompiled headers, good for projects not designed with precompiled
24416 header files in mind, is to simply take most of the header files used by
24417 a project, include them from another header file, precompile that header
24418 file, and @option{-include} the precompiled header.  If the header files
24419 have guards against multiple inclusion, they are skipped because
24420 they've already been included (in the precompiled header).
24422 If you need to precompile the same header file for different
24423 languages, targets, or compiler options, you can instead make a
24424 @emph{directory} named like @file{all.h.gch}, and put each precompiled
24425 header in the directory, perhaps using @option{-o}.  It doesn't matter
24426 what you call the files in the directory; every precompiled header in
24427 the directory is considered.  The first precompiled header
24428 encountered in the directory that is valid for this compilation is
24429 used; they're searched in no particular order.
24431 There are many other possibilities, limited only by your imagination,
24432 good sense, and the constraints of your build system.
24434 A precompiled header file can be used only when these conditions apply:
24436 @itemize
24437 @item
24438 Only one precompiled header can be used in a particular compilation.
24440 @item
24441 A precompiled header can't be used once the first C token is seen.  You
24442 can have preprocessor directives before a precompiled header; you cannot
24443 include a precompiled header from inside another header.
24445 @item
24446 The precompiled header file must be produced for the same language as
24447 the current compilation.  You can't use a C precompiled header for a C++
24448 compilation.
24450 @item
24451 The precompiled header file must have been produced by the same compiler
24452 binary as the current compilation is using.
24454 @item
24455 Any macros defined before the precompiled header is included must
24456 either be defined in the same way as when the precompiled header was
24457 generated, or must not affect the precompiled header, which usually
24458 means that they don't appear in the precompiled header at all.
24460 The @option{-D} option is one way to define a macro before a
24461 precompiled header is included; using a @code{#define} can also do it.
24462 There are also some options that define macros implicitly, like
24463 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
24464 defined this way.
24466 @item If debugging information is output when using the precompiled
24467 header, using @option{-g} or similar, the same kind of debugging information
24468 must have been output when building the precompiled header.  However,
24469 a precompiled header built using @option{-g} can be used in a compilation
24470 when no debugging information is being output.
24472 @item The same @option{-m} options must generally be used when building
24473 and using the precompiled header.  @xref{Submodel Options},
24474 for any cases where this rule is relaxed.
24476 @item Each of the following options must be the same when building and using
24477 the precompiled header:
24479 @gccoptlist{-fexceptions}
24481 @item
24482 Some other command-line options starting with @option{-f},
24483 @option{-p}, or @option{-O} must be defined in the same way as when
24484 the precompiled header was generated.  At present, it's not clear
24485 which options are safe to change and which are not; the safest choice
24486 is to use exactly the same options when generating and using the
24487 precompiled header.  The following are known to be safe:
24489 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
24490 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
24491 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
24492 -pedantic-errors}
24494 @end itemize
24496 For all of these except the last, the compiler automatically
24497 ignores the precompiled header if the conditions aren't met.  If you
24498 find an option combination that doesn't work and doesn't cause the
24499 precompiled header to be ignored, please consider filing a bug report,
24500 see @ref{Bugs}.
24502 If you do use differing options when generating and using the
24503 precompiled header, the actual behavior is a mixture of the
24504 behavior for the options.  For instance, if you use @option{-g} to
24505 generate the precompiled header but not when using it, you may or may
24506 not get debugging information for routines in the precompiled header.