Document ftrapv/fwrapv interaction
[official-gcc.git] / gcc / doc / invoke.texi
blob76e5e29450e3416877200754dd8fa96aa7fa7c03
1 @c Copyright (C) 1988-2015 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2015 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified.  Also,
105 the placement of the @option{-l} option is significant.
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}.  This manual documents
112 only one of these two forms, whichever one is not the default.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
118 @menu
119 * Option Summary::      Brief list of all options, without explanations.
120 * Overall Options::     Controlling the kind of output:
121                         an executable, object files, assembler files,
122                         or preprocessed source.
123 * Invoking G++::        Compiling C++ programs.
124 * C Dialect Options::   Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127                         and Objective-C++.
128 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
129                         be formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
161 -pipe  -pass-exit-codes  @gol
162 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
171 -fhosted  -ffreestanding -fopenacc -fopenmp -fopenmp-simd @gol
172 -fms-extensions -fplan9-extensions -trigraphs -traditional -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti -fsized-deallocation @gol
191 -fstats  -ftemplate-backtrace-limit=@var{n} @gol
192 -ftemplate-depth=@var{n} @gol
193 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
194 -fno-weak  -nostdinc++ @gol
195 -fvisibility-inlines-hidden @gol
196 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
197 -fvtv-counts -fvtv-debug @gol
198 -fvisibility-ms-compat @gol
199 -fext-numeric-literals @gol
200 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime  -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -fno-local-ivars @gol
222 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
223 -freplace-objc-classes @gol
224 -fzero-link @gol
225 -gen-decls @gol
226 -Wassign-intercept @gol
227 -Wno-protocol  -Wselector @gol
228 -Wstrict-selector-match @gol
229 -Wundeclared-selector}
231 @item Diagnostic Message Formatting Options
232 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
233 @gccoptlist{-fmessage-length=@var{n}  @gol
234 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
235 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
236 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
238 @item Warning Options
239 @xref{Warning Options,,Options to Request or Suppress Warnings}.
240 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
241 -pedantic-errors @gol
242 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
243 -Waggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
244 -Wbool-compare -Wframe-address @gol
245 -Wno-attributes -Wno-builtin-macro-redefined @gol
246 -Wc90-c99-compat -Wc99-c11-compat @gol
247 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
248 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
249 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
250 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
251 -Wdisabled-optimization @gol
252 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
253 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
254 -Wno-endif-labels -Werror  -Werror=* @gol
255 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
256 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
257 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
258 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
259 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
260 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
261 -Winit-self  -Winline  -Wno-int-conversion @gol
262 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
263 -Wnull-dereference @gol
264 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
265 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
266 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args @gol
267 -Wmisleading-indentation -Wmissing-braces @gol
268 -Wmissing-field-initializers -Wmissing-include-dirs @gol
269 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
270 -Wodr  -Wno-overflow  -Wopenmp-simd @gol
271 -Woverride-init-side-effects @gol
272 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
273 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
274 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
275 -Wredundant-decls  -Wno-return-local-addr @gol
276 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
277 -Wshift-overflow -Wshift-overflow=@var{n} @gol
278 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
279 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
280 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
281 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
282 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
283 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
284 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
285 -Wmissing-format-attribute @gol
286 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
287 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
288 -Wtype-limits  -Wundef @gol
289 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
290 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
291 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
292 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
293 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
294 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
295 -Wvla -Wvolatile-register-var  -Wwrite-strings @gol
296 -Wzero-as-null-pointer-constant}
298 @item C and Objective-C-only Warning Options
299 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
300 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
301 -Wold-style-declaration  -Wold-style-definition @gol
302 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
303 -Wdeclaration-after-statement -Wpointer-sign}
305 @item Debugging Options
306 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
307 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
308 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
309 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
310 -fsanitize-undefined-trap-on-error @gol
311 -fcheck-pointer-bounds -fchkp-check-incomplete-type @gol
312 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
313 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
314 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
315 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
316 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
317 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
318 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
319 -fchkp-use-wrappers @gol
320 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
321 -fdisable-ipa-@var{pass_name} @gol
322 -fdisable-rtl-@var{pass_name} @gol
323 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
324 -fdisable-tree-@var{pass_name} @gol
325 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
326 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
327 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
328 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
329 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
330 -fdump-passes @gol
331 -fdump-statistics @gol
332 -fdump-tree-all @gol
333 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
334 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
335 -fdump-tree-cfg -fdump-tree-alias @gol
336 -fdump-tree-ch @gol
337 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
338 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
339 -fdump-tree-gimple@r{[}-raw@r{]} @gol
340 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
341 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
342 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
343 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
344 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
345 -fdump-tree-nrv -fdump-tree-vect @gol
346 -fdump-tree-sink @gol
347 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
348 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
349 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
350 -fdump-tree-vtable-verify @gol
351 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
352 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
353 -fdump-final-insns=@var{file} @gol
354 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
355 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
356 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
357 -fenable-@var{kind}-@var{pass} @gol
358 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
359 -fdebug-types-section -fmem-report-wpa @gol
360 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
361 -fopt-info @gol
362 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
363 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
364 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
365 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
366 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
367 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
368 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
369 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
370 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
371 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
372 -fdebug-prefix-map=@var{old}=@var{new} @gol
373 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
374 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
375 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
376 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
377 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
378 -print-sysroot -print-sysroot-headers-suffix @gol
379 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
381 @item Optimization Options
382 @xref{Optimize Options,,Options that Control Optimization}.
383 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
384 -falign-jumps[=@var{n}] @gol
385 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
386 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
387 -fauto-inc-dec -fbranch-probabilities @gol
388 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
389 -fbtr-bb-exclusive -fcaller-saves @gol
390 -fcombine-stack-adjustments -fconserve-stack @gol
391 -fcompare-elim -fcprop-registers -fcrossjumping @gol
392 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
393 -fcx-limited-range @gol
394 -fdata-sections -fdce -fdelayed-branch @gol
395 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
396 -fdevirtualize-at-ltrans -fdse @gol
397 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
398 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
399 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
400 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
401 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
402 -fif-conversion2 -findirect-inlining @gol
403 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
404 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment @gol
405 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
406 -fira-algorithm=@var{algorithm} @gol
407 -fira-region=@var{region} -fira-hoist-pressure @gol
408 -fira-loop-pressure -fno-ira-share-save-slots @gol
409 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
410 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
411 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
412 -flive-range-shrinkage @gol
413 -floop-block -floop-interchange -floop-strip-mine @gol
414 -floop-unroll-and-jam -floop-nest-optimize @gol
415 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
416 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
417 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
418 -fmove-loop-invariants -fno-branch-count-reg @gol
419 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
420 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
421 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
422 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
423 -fomit-frame-pointer -foptimize-sibling-calls @gol
424 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
425 -fprefetch-loop-arrays -fprofile-report @gol
426 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
427 -fprofile-generate=@var{path} @gol
428 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
429 -fprofile-reorder-functions @gol
430 -freciprocal-math -free -frename-registers -freorder-blocks @gol
431 -freorder-blocks-and-partition -freorder-functions @gol
432 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
433 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
434 -fsched-spec-load -fsched-spec-load-dangerous @gol
435 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
436 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
437 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
438 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
439 -fschedule-fusion @gol
440 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
441 -fselective-scheduling -fselective-scheduling2 @gol
442 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
443 -fsemantic-interposition @gol
444 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
445 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt @gol
446 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
447 -fstack-protector-explicit -fstdarg-opt -fstrict-aliasing @gol
448 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
449 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
450 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
451 -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
452 -ftree-loop-if-convert-stores -ftree-loop-im @gol
453 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
454 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
455 -ftree-loop-vectorize @gol
456 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
457 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
458 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
459 -ftree-vectorize -ftree-vrp @gol
460 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
461 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
462 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
463 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
464 --param @var{name}=@var{value}
465 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
467 @item Preprocessor Options
468 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
469 @gccoptlist{-A@var{question}=@var{answer} @gol
470 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
471 -C  -dD  -dI  -dM  -dN @gol
472 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
473 -idirafter @var{dir} @gol
474 -include @var{file}  -imacros @var{file} @gol
475 -iprefix @var{file}  -iwithprefix @var{dir} @gol
476 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
477 -imultilib @var{dir} -isysroot @var{dir} @gol
478 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
479 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
480 -remap -trigraphs  -undef  -U@var{macro}  @gol
481 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
483 @item Assembler Option
484 @xref{Assembler Options,,Passing Options to the Assembler}.
485 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
487 @item Linker Options
488 @xref{Link Options,,Options for Linking}.
489 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
490 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
491 -s  -static -static-libgcc -static-libstdc++ @gol
492 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
493 -static-libmpx -static-libmpxwrappers @gol
494 -shared -shared-libgcc  -symbolic @gol
495 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
496 -u @var{symbol} -z @var{keyword}}
498 @item Directory Options
499 @xref{Directory Options,,Options for Directory Search}.
500 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
501 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
502 --sysroot=@var{dir} --no-sysroot-suffix}
504 @item Machine Dependent Options
505 @xref{Submodel Options,,Hardware Models and Configurations}.
506 @c This list is ordered alphanumerically by subsection name.
507 @c Try and put the significant identifier (CPU or system) first,
508 @c so users have a clue at guessing where the ones they want will be.
510 @emph{AArch64 Options}
511 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
512 -mgeneral-regs-only @gol
513 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
514 -mstrict-align @gol
515 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
516 -mtls-dialect=desc  -mtls-dialect=traditional @gol
517 -mtls-size=@var{size} @gol
518 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
519 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
520 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
522 @emph{Adapteva Epiphany Options}
523 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
524 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
525 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
526 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
527 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
528 -msplit-vecmove-early -m1reg-@var{reg}}
530 @emph{ARC Options}
531 @gccoptlist{-mbarrel-shifter @gol
532 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
533 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
534 -mea -mno-mpy -mmul32x16 -mmul64 @gol
535 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
536 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
537 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
538 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
539 -mucb-mcount -mvolatile-cache @gol
540 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
541 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
542 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
543 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
544 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
545 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
547 @emph{ARM Options}
548 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
549 -mabi=@var{name} @gol
550 -mapcs-stack-check  -mno-apcs-stack-check @gol
551 -mapcs-float  -mno-apcs-float @gol
552 -mapcs-reentrant  -mno-apcs-reentrant @gol
553 -msched-prolog  -mno-sched-prolog @gol
554 -mlittle-endian  -mbig-endian @gol
555 -mfloat-abi=@var{name} @gol
556 -mfp16-format=@var{name}
557 -mthumb-interwork  -mno-thumb-interwork @gol
558 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
559 -mtune=@var{name} -mprint-tune-info @gol
560 -mstructure-size-boundary=@var{n} @gol
561 -mabort-on-noreturn @gol
562 -mlong-calls  -mno-long-calls @gol
563 -msingle-pic-base  -mno-single-pic-base @gol
564 -mpic-register=@var{reg} @gol
565 -mnop-fun-dllimport @gol
566 -mpoke-function-name @gol
567 -mthumb  -marm @gol
568 -mtpcs-frame  -mtpcs-leaf-frame @gol
569 -mcaller-super-interworking  -mcallee-super-interworking @gol
570 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
571 -mword-relocations @gol
572 -mfix-cortex-m3-ldrd @gol
573 -munaligned-access @gol
574 -mneon-for-64bits @gol
575 -mslow-flash-data @gol
576 -masm-syntax-unified @gol
577 -mrestrict-it}
579 @emph{AVR Options}
580 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
581 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
582 -mrelax -mrmw -mstrict-X -mtiny-stack -nodevicelib -Waddr-space-convert}
584 @emph{Blackfin Options}
585 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
586 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
587 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
588 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
589 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
590 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
591 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
592 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
593 -micplb}
595 @emph{C6X Options}
596 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
597 -msim -msdata=@var{sdata-type}}
599 @emph{CRIS Options}
600 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
601 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
602 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
603 -mstack-align  -mdata-align  -mconst-align @gol
604 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
605 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
606 -mmul-bug-workaround  -mno-mul-bug-workaround}
608 @emph{CR16 Options}
609 @gccoptlist{-mmac @gol
610 -mcr16cplus -mcr16c @gol
611 -msim -mint32 -mbit-ops
612 -mdata-model=@var{model}}
614 @emph{Darwin Options}
615 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
616 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
617 -client_name  -compatibility_version  -current_version @gol
618 -dead_strip @gol
619 -dependency-file  -dylib_file  -dylinker_install_name @gol
620 -dynamic  -dynamiclib  -exported_symbols_list @gol
621 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
622 -force_flat_namespace  -headerpad_max_install_names @gol
623 -iframework @gol
624 -image_base  -init  -install_name  -keep_private_externs @gol
625 -multi_module  -multiply_defined  -multiply_defined_unused @gol
626 -noall_load   -no_dead_strip_inits_and_terms @gol
627 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
628 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
629 -private_bundle  -read_only_relocs  -sectalign @gol
630 -sectobjectsymbols  -whyload  -seg1addr @gol
631 -sectcreate  -sectobjectsymbols  -sectorder @gol
632 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
633 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
634 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
635 -single_module  -static  -sub_library  -sub_umbrella @gol
636 -twolevel_namespace  -umbrella  -undefined @gol
637 -unexported_symbols_list  -weak_reference_mismatches @gol
638 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
639 -mkernel -mone-byte-bool}
641 @emph{DEC Alpha Options}
642 @gccoptlist{-mno-fp-regs  -msoft-float @gol
643 -mieee  -mieee-with-inexact  -mieee-conformant @gol
644 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
645 -mtrap-precision=@var{mode}  -mbuild-constants @gol
646 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
647 -mbwx  -mmax  -mfix  -mcix @gol
648 -mfloat-vax  -mfloat-ieee @gol
649 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
650 -msmall-text  -mlarge-text @gol
651 -mmemory-latency=@var{time}}
653 @emph{FR30 Options}
654 @gccoptlist{-msmall-model -mno-lsim}
656 @emph{FT32 Options}
657 @gccoptlist{-msim -mlra}
659 @emph{FRV Options}
660 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
661 -mhard-float  -msoft-float @gol
662 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
663 -mdouble  -mno-double @gol
664 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
665 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
666 -mlinked-fp  -mlong-calls  -malign-labels @gol
667 -mlibrary-pic  -macc-4  -macc-8 @gol
668 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
669 -moptimize-membar -mno-optimize-membar @gol
670 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
671 -mvliw-branch  -mno-vliw-branch @gol
672 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
673 -mno-nested-cond-exec  -mtomcat-stats @gol
674 -mTLS -mtls @gol
675 -mcpu=@var{cpu}}
677 @emph{GNU/Linux Options}
678 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
679 -tno-android-cc -tno-android-ld}
681 @emph{H8/300 Options}
682 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
684 @emph{HPPA Options}
685 @gccoptlist{-march=@var{architecture-type} @gol
686 -mdisable-fpregs  -mdisable-indexing @gol
687 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
688 -mfixed-range=@var{register-range} @gol
689 -mjump-in-delay -mlinker-opt -mlong-calls @gol
690 -mlong-load-store  -mno-disable-fpregs @gol
691 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
692 -mno-jump-in-delay  -mno-long-load-store @gol
693 -mno-portable-runtime  -mno-soft-float @gol
694 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
695 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
696 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
697 -munix=@var{unix-std}  -nolibdld  -static  -threads}
699 @emph{IA-64 Options}
700 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
701 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
702 -mconstant-gp  -mauto-pic  -mfused-madd @gol
703 -minline-float-divide-min-latency @gol
704 -minline-float-divide-max-throughput @gol
705 -mno-inline-float-divide @gol
706 -minline-int-divide-min-latency @gol
707 -minline-int-divide-max-throughput  @gol
708 -mno-inline-int-divide @gol
709 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
710 -mno-inline-sqrt @gol
711 -mdwarf2-asm -mearly-stop-bits @gol
712 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
713 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
714 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
715 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
716 -msched-spec-ldc -msched-spec-control-ldc @gol
717 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
718 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
719 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
720 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
722 @emph{LM32 Options}
723 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
724 -msign-extend-enabled -muser-enabled}
726 @emph{M32R/D Options}
727 @gccoptlist{-m32r2 -m32rx -m32r @gol
728 -mdebug @gol
729 -malign-loops -mno-align-loops @gol
730 -missue-rate=@var{number} @gol
731 -mbranch-cost=@var{number} @gol
732 -mmodel=@var{code-size-model-type} @gol
733 -msdata=@var{sdata-type} @gol
734 -mno-flush-func -mflush-func=@var{name} @gol
735 -mno-flush-trap -mflush-trap=@var{number} @gol
736 -G @var{num}}
738 @emph{M32C Options}
739 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
741 @emph{M680x0 Options}
742 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
743 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
744 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
745 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
746 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
747 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
748 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
749 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
750 -mxgot -mno-xgot}
752 @emph{MCore Options}
753 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
754 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
755 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
756 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
757 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
759 @emph{MeP Options}
760 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
761 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
762 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
763 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
764 -mtiny=@var{n}}
766 @emph{MicroBlaze Options}
767 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
768 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
769 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
770 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
771 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
773 @emph{MIPS Options}
774 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
775 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
776 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
777 -mips16  -mno-mips16  -mflip-mips16 @gol
778 -minterlink-compressed -mno-interlink-compressed @gol
779 -minterlink-mips16  -mno-interlink-mips16 @gol
780 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
781 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
782 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
783 -mno-float  -msingle-float  -mdouble-float @gol
784 -modd-spreg -mno-odd-spreg @gol
785 -mcompact-branches=@var{policy} @gol
786 -mabs=@var{mode}  -mnan=@var{encoding} @gol
787 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
788 -mmcu -mmno-mcu @gol
789 -meva -mno-eva @gol
790 -mvirt -mno-virt @gol
791 -mxpa -mno-xpa @gol
792 -mmicromips -mno-micromips @gol
793 -mfpu=@var{fpu-type} @gol
794 -msmartmips  -mno-smartmips @gol
795 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
796 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
797 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
798 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
799 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
800 -membedded-data  -mno-embedded-data @gol
801 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
802 -mcode-readable=@var{setting} @gol
803 -msplit-addresses  -mno-split-addresses @gol
804 -mexplicit-relocs  -mno-explicit-relocs @gol
805 -mcheck-zero-division  -mno-check-zero-division @gol
806 -mdivide-traps  -mdivide-breaks @gol
807 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
808 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
809 -mfix-24k -mno-fix-24k @gol
810 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
811 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
812 -mfix-vr4120  -mno-fix-vr4120 @gol
813 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
814 -mflush-func=@var{func}  -mno-flush-func @gol
815 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
816 -mfp-exceptions -mno-fp-exceptions @gol
817 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
818 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
820 @emph{MMIX Options}
821 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
822 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
823 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
824 -mno-base-addresses  -msingle-exit  -mno-single-exit}
826 @emph{MN10300 Options}
827 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
828 -mno-am33 -mam33 -mam33-2 -mam34 @gol
829 -mtune=@var{cpu-type} @gol
830 -mreturn-pointer-on-d0 @gol
831 -mno-crt0  -mrelax -mliw -msetlb}
833 @emph{Moxie Options}
834 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
836 @emph{MSP430 Options}
837 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
838 -mcode-region= -mdata-region= @gol
839 -mhwmult= -minrt}
841 @emph{NDS32 Options}
842 @gccoptlist{-mbig-endian -mlittle-endian @gol
843 -mreduced-regs -mfull-regs @gol
844 -mcmov -mno-cmov @gol
845 -mperf-ext -mno-perf-ext @gol
846 -mv3push -mno-v3push @gol
847 -m16bit -mno-16bit @gol
848 -misr-vector-size=@var{num} @gol
849 -mcache-block-size=@var{num} @gol
850 -march=@var{arch} @gol
851 -mcmodel=@var{code-model} @gol
852 -mctor-dtor -mrelax}
854 @emph{Nios II Options}
855 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
856 -mel -meb @gol
857 -mno-bypass-cache -mbypass-cache @gol
858 -mno-cache-volatile -mcache-volatile @gol
859 -mno-fast-sw-div -mfast-sw-div @gol
860 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
861 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
862 -mcustom-fpu-cfg=@var{name} @gol
863 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
864 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
866 @emph{Nvidia PTX Options}
867 @gccoptlist{-m32 -m64 -mmainkernel}
869 @emph{PDP-11 Options}
870 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
871 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
872 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
873 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
874 -mbranch-expensive  -mbranch-cheap @gol
875 -munix-asm  -mdec-asm}
877 @emph{picoChip Options}
878 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
879 -msymbol-as-address -mno-inefficient-warnings}
881 @emph{PowerPC Options}
882 See RS/6000 and PowerPC Options.
884 @emph{RL78 Options}
885 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
886 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
887 -m64bit-doubles -m32bit-doubles}
889 @emph{RS/6000 and PowerPC Options}
890 @gccoptlist{-mcpu=@var{cpu-type} @gol
891 -mtune=@var{cpu-type} @gol
892 -mcmodel=@var{code-model} @gol
893 -mpowerpc64 @gol
894 -maltivec  -mno-altivec @gol
895 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
896 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
897 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
898 -mfprnd  -mno-fprnd @gol
899 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
900 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
901 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
902 -malign-power  -malign-natural @gol
903 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
904 -msingle-float -mdouble-float -msimple-fpu @gol
905 -mstring  -mno-string  -mupdate  -mno-update @gol
906 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
907 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
908 -mstrict-align  -mno-strict-align  -mrelocatable @gol
909 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
910 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
911 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
912 -mprioritize-restricted-insns=@var{priority} @gol
913 -msched-costly-dep=@var{dependence_type} @gol
914 -minsert-sched-nops=@var{scheme} @gol
915 -mcall-sysv  -mcall-netbsd @gol
916 -maix-struct-return  -msvr4-struct-return @gol
917 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
918 -mblock-move-inline-limit=@var{num} @gol
919 -misel -mno-isel @gol
920 -misel=yes  -misel=no @gol
921 -mspe -mno-spe @gol
922 -mspe=yes  -mspe=no @gol
923 -mpaired @gol
924 -mgen-cell-microcode -mwarn-cell-microcode @gol
925 -mvrsave -mno-vrsave @gol
926 -mmulhw -mno-mulhw @gol
927 -mdlmzb -mno-dlmzb @gol
928 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
929 -mprototype  -mno-prototype @gol
930 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
931 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
932 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
933 -mno-recip-precision @gol
934 -mveclibabi=@var{type} -mfriz -mno-friz @gol
935 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
936 -msave-toc-indirect -mno-save-toc-indirect @gol
937 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
938 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
939 -mquad-memory -mno-quad-memory @gol
940 -mquad-memory-atomic -mno-quad-memory-atomic @gol
941 -mcompat-align-parm -mno-compat-align-parm @gol
942 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
943 -mupper-regs -mno-upper-regs}
945 @emph{RX Options}
946 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
947 -mcpu=@gol
948 -mbig-endian-data -mlittle-endian-data @gol
949 -msmall-data @gol
950 -msim  -mno-sim@gol
951 -mas100-syntax -mno-as100-syntax@gol
952 -mrelax@gol
953 -mmax-constant-size=@gol
954 -mint-register=@gol
955 -mpid@gol
956 -mallow-string-insns -mno-allow-string-insns@gol
957 -mno-warn-multiple-fast-interrupts@gol
958 -msave-acc-in-interrupts}
960 @emph{S/390 and zSeries Options}
961 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
962 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
963 -mlong-double-64 -mlong-double-128 @gol
964 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
965 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
966 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
967 -mhtm -mvx -mzvector @gol
968 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
969 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
970 -mhotpatch=@var{halfwords},@var{halfwords}}
972 @emph{Score Options}
973 @gccoptlist{-meb -mel @gol
974 -mnhwloop @gol
975 -muls @gol
976 -mmac @gol
977 -mscore5 -mscore5u -mscore7 -mscore7d}
979 @emph{SH Options}
980 @gccoptlist{-m1  -m2  -m2e @gol
981 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
982 -m3  -m3e @gol
983 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
984 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
985 -m5-64media  -m5-64media-nofpu @gol
986 -m5-32media  -m5-32media-nofpu @gol
987 -m5-compact  -m5-compact-nofpu @gol
988 -mb  -ml  -mdalign  -mrelax @gol
989 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
990 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
991 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
992 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
993 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
994 -maccumulate-outgoing-args -minvalid-symbols @gol
995 -matomic-model=@var{atomic-model} @gol
996 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
997 -mcbranch-force-delay-slot @gol
998 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
999 -mpretend-cmove -mtas}
1001 @emph{Solaris 2 Options}
1002 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1003 -pthreads -pthread}
1005 @emph{SPARC Options}
1006 @gccoptlist{-mcpu=@var{cpu-type} @gol
1007 -mtune=@var{cpu-type} @gol
1008 -mcmodel=@var{code-model} @gol
1009 -mmemory-model=@var{mem-model} @gol
1010 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1011 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1012 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1013 -mhard-quad-float  -msoft-quad-float @gol
1014 -mstack-bias  -mno-stack-bias @gol
1015 -munaligned-doubles  -mno-unaligned-doubles @gol
1016 -muser-mode  -mno-user-mode @gol
1017 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1018 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1019 -mcbcond -mno-cbcond @gol
1020 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1021 -mfix-at697f -mfix-ut699}
1023 @emph{SPU Options}
1024 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1025 -msafe-dma -munsafe-dma @gol
1026 -mbranch-hints @gol
1027 -msmall-mem -mlarge-mem -mstdmain @gol
1028 -mfixed-range=@var{register-range} @gol
1029 -mea32 -mea64 @gol
1030 -maddress-space-conversion -mno-address-space-conversion @gol
1031 -mcache-size=@var{cache-size} @gol
1032 -matomic-updates -mno-atomic-updates}
1034 @emph{System V Options}
1035 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1037 @emph{TILE-Gx Options}
1038 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1039 -mcmodel=@var{code-model}}
1041 @emph{TILEPro Options}
1042 @gccoptlist{-mcpu=@var{cpu} -m32}
1044 @emph{V850 Options}
1045 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1046 -mprolog-function  -mno-prolog-function  -mspace @gol
1047 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1048 -mapp-regs  -mno-app-regs @gol
1049 -mdisable-callt  -mno-disable-callt @gol
1050 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1051 -mv850e -mv850 -mv850e3v5 @gol
1052 -mloop @gol
1053 -mrelax @gol
1054 -mlong-jumps @gol
1055 -msoft-float @gol
1056 -mhard-float @gol
1057 -mgcc-abi @gol
1058 -mrh850-abi @gol
1059 -mbig-switch}
1061 @emph{VAX Options}
1062 @gccoptlist{-mg  -mgnu  -munix}
1064 @emph{Visium Options}
1065 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1066 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1068 @emph{VMS Options}
1069 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1070 -mpointer-size=@var{size}}
1072 @emph{VxWorks Options}
1073 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1074 -Xbind-lazy  -Xbind-now}
1076 @emph{x86 Options}
1077 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1078 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1079 -mfpmath=@var{unit} @gol
1080 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1081 -mno-fp-ret-in-387  -msoft-float @gol
1082 -mno-wide-multiply  -mrtd  -malign-double @gol
1083 -mpreferred-stack-boundary=@var{num} @gol
1084 -mincoming-stack-boundary=@var{num} @gol
1085 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1086 -mrecip -mrecip=@var{opt} @gol
1087 -mvzeroupper -mprefer-avx128 @gol
1088 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1089 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
1090 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
1091 -mclflushopt -mxsavec -mxsaves @gol
1092 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1093 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mthreads @gol
1094 -mno-align-stringops  -minline-all-stringops @gol
1095 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1096 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1097 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1098 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1099 -mregparm=@var{num}  -msseregparm @gol
1100 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1101 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1102 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1103 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1104 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1105 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1106 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1107 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
1109 @emph{x86 Windows Options}
1110 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1111 -mnop-fun-dllimport -mthread @gol
1112 -municode -mwin32 -mwindows -fno-set-stack-executable}
1114 @emph{Xstormy16 Options}
1115 @gccoptlist{-msim}
1117 @emph{Xtensa Options}
1118 @gccoptlist{-mconst16 -mno-const16 @gol
1119 -mfused-madd  -mno-fused-madd @gol
1120 -mforce-no-pic @gol
1121 -mserialize-volatile  -mno-serialize-volatile @gol
1122 -mtext-section-literals  -mno-text-section-literals @gol
1123 -mauto-litpools  -mno-auto-litpools @gol
1124 -mtarget-align  -mno-target-align @gol
1125 -mlongcalls  -mno-longcalls}
1127 @emph{zSeries Options}
1128 See S/390 and zSeries Options.
1130 @item Code Generation Options
1131 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1132 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1133 -ffixed-@var{reg}  -fexceptions @gol
1134 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1135 -fasynchronous-unwind-tables @gol
1136 -fno-gnu-unique @gol
1137 -finhibit-size-directive  -finstrument-functions @gol
1138 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1139 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1140 -fno-common  -fno-ident @gol
1141 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
1142 -fno-jump-tables @gol
1143 -frecord-gcc-switches @gol
1144 -freg-struct-return  -fshort-enums @gol
1145 -fshort-double  -fshort-wchar @gol
1146 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1147 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1148 -fno-stack-limit -fsplit-stack @gol
1149 -fleading-underscore  -ftls-model=@var{model} @gol
1150 -fstack-reuse=@var{reuse_level} @gol
1151 -ftrapv  -fwrapv  -fbounds-check @gol
1152 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
1153 -fstrict-volatile-bitfields -fsync-libcalls}
1154 @end table
1157 @node Overall Options
1158 @section Options Controlling the Kind of Output
1160 Compilation can involve up to four stages: preprocessing, compilation
1161 proper, assembly and linking, always in that order.  GCC is capable of
1162 preprocessing and compiling several files either into several
1163 assembler input files, or into one assembler input file; then each
1164 assembler input file produces an object file, and linking combines all
1165 the object files (those newly compiled, and those specified as input)
1166 into an executable file.
1168 @cindex file name suffix
1169 For any given input file, the file name suffix determines what kind of
1170 compilation is done:
1172 @table @gcctabopt
1173 @item @var{file}.c
1174 C source code that must be preprocessed.
1176 @item @var{file}.i
1177 C source code that should not be preprocessed.
1179 @item @var{file}.ii
1180 C++ source code that should not be preprocessed.
1182 @item @var{file}.m
1183 Objective-C source code.  Note that you must link with the @file{libobjc}
1184 library to make an Objective-C program work.
1186 @item @var{file}.mi
1187 Objective-C source code that should not be preprocessed.
1189 @item @var{file}.mm
1190 @itemx @var{file}.M
1191 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1192 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1193 to a literal capital M@.
1195 @item @var{file}.mii
1196 Objective-C++ source code that should not be preprocessed.
1198 @item @var{file}.h
1199 C, C++, Objective-C or Objective-C++ header file to be turned into a
1200 precompiled header (default), or C, C++ header file to be turned into an
1201 Ada spec (via the @option{-fdump-ada-spec} switch).
1203 @item @var{file}.cc
1204 @itemx @var{file}.cp
1205 @itemx @var{file}.cxx
1206 @itemx @var{file}.cpp
1207 @itemx @var{file}.CPP
1208 @itemx @var{file}.c++
1209 @itemx @var{file}.C
1210 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1211 the last two letters must both be literally @samp{x}.  Likewise,
1212 @samp{.C} refers to a literal capital C@.
1214 @item @var{file}.mm
1215 @itemx @var{file}.M
1216 Objective-C++ source code that must be preprocessed.
1218 @item @var{file}.mii
1219 Objective-C++ source code that should not be preprocessed.
1221 @item @var{file}.hh
1222 @itemx @var{file}.H
1223 @itemx @var{file}.hp
1224 @itemx @var{file}.hxx
1225 @itemx @var{file}.hpp
1226 @itemx @var{file}.HPP
1227 @itemx @var{file}.h++
1228 @itemx @var{file}.tcc
1229 C++ header file to be turned into a precompiled header or Ada spec.
1231 @item @var{file}.f
1232 @itemx @var{file}.for
1233 @itemx @var{file}.ftn
1234 Fixed form Fortran source code that should not be preprocessed.
1236 @item @var{file}.F
1237 @itemx @var{file}.FOR
1238 @itemx @var{file}.fpp
1239 @itemx @var{file}.FPP
1240 @itemx @var{file}.FTN
1241 Fixed form Fortran source code that must be preprocessed (with the traditional
1242 preprocessor).
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 should not be preprocessed.
1250 @item @var{file}.F90
1251 @itemx @var{file}.F95
1252 @itemx @var{file}.F03
1253 @itemx @var{file}.F08
1254 Free form Fortran source code that must be preprocessed (with the
1255 traditional preprocessor).
1257 @item @var{file}.go
1258 Go source code.
1260 @c FIXME: Descriptions of Java file types.
1261 @c @var{file}.java
1262 @c @var{file}.class
1263 @c @var{file}.zip
1264 @c @var{file}.jar
1266 @item @var{file}.ads
1267 Ada source code file that contains a library unit declaration (a
1268 declaration of a package, subprogram, or generic, or a generic
1269 instantiation), or a library unit renaming declaration (a package,
1270 generic, or subprogram renaming declaration).  Such files are also
1271 called @dfn{specs}.
1273 @item @var{file}.adb
1274 Ada source code file containing a library unit body (a subprogram or
1275 package body).  Such files are also called @dfn{bodies}.
1277 @c GCC also knows about some suffixes for languages not yet included:
1278 @c Pascal:
1279 @c @var{file}.p
1280 @c @var{file}.pas
1281 @c Ratfor:
1282 @c @var{file}.r
1284 @item @var{file}.s
1285 Assembler code.
1287 @item @var{file}.S
1288 @itemx @var{file}.sx
1289 Assembler code that must be preprocessed.
1291 @item @var{other}
1292 An object file to be fed straight into linking.
1293 Any file name with no recognized suffix is treated this way.
1294 @end table
1296 @opindex x
1297 You can specify the input language explicitly with the @option{-x} option:
1299 @table @gcctabopt
1300 @item -x @var{language}
1301 Specify explicitly the @var{language} for the following input files
1302 (rather than letting the compiler choose a default based on the file
1303 name suffix).  This option applies to all following input files until
1304 the next @option{-x} option.  Possible values for @var{language} are:
1305 @smallexample
1306 c  c-header  cpp-output
1307 c++  c++-header  c++-cpp-output
1308 objective-c  objective-c-header  objective-c-cpp-output
1309 objective-c++ objective-c++-header objective-c++-cpp-output
1310 assembler  assembler-with-cpp
1312 f77  f77-cpp-input f95  f95-cpp-input
1314 java
1315 @end smallexample
1317 @item -x none
1318 Turn off any specification of a language, so that subsequent files are
1319 handled according to their file name suffixes (as they are if @option{-x}
1320 has not been used at all).
1322 @item -pass-exit-codes
1323 @opindex pass-exit-codes
1324 Normally the @command{gcc} program exits with the code of 1 if any
1325 phase of the compiler returns a non-success return code.  If you specify
1326 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1327 the numerically highest error produced by any phase returning an error
1328 indication.  The C, C++, and Fortran front ends return 4 if an internal
1329 compiler error is encountered.
1330 @end table
1332 If you only want some of the stages of compilation, you can use
1333 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1334 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1335 @command{gcc} is to stop.  Note that some combinations (for example,
1336 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1338 @table @gcctabopt
1339 @item -c
1340 @opindex c
1341 Compile or assemble the source files, but do not link.  The linking
1342 stage simply is not done.  The ultimate output is in the form of an
1343 object file for each source file.
1345 By default, the object file name for a source file is made by replacing
1346 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1348 Unrecognized input files, not requiring compilation or assembly, are
1349 ignored.
1351 @item -S
1352 @opindex S
1353 Stop after the stage of compilation proper; do not assemble.  The output
1354 is in the form of an assembler code file for each non-assembler input
1355 file specified.
1357 By default, the assembler file name for a source file is made by
1358 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1360 Input files that don't require compilation are ignored.
1362 @item -E
1363 @opindex E
1364 Stop after the preprocessing stage; do not run the compiler proper.  The
1365 output is in the form of preprocessed source code, which is sent to the
1366 standard output.
1368 Input files that don't require preprocessing are ignored.
1370 @cindex output file option
1371 @item -o @var{file}
1372 @opindex o
1373 Place output in file @var{file}.  This applies to whatever
1374 sort of output is being produced, whether it be an executable file,
1375 an object file, an assembler file or preprocessed C code.
1377 If @option{-o} is not specified, the default is to put an executable
1378 file in @file{a.out}, the object file for
1379 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1380 assembler file in @file{@var{source}.s}, a precompiled header file in
1381 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1382 standard output.
1384 @item -v
1385 @opindex v
1386 Print (on standard error output) the commands executed to run the stages
1387 of compilation.  Also print the version number of the compiler driver
1388 program and of the preprocessor and the compiler proper.
1390 @item -###
1391 @opindex ###
1392 Like @option{-v} except the commands are not executed and arguments
1393 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1394 This is useful for shell scripts to capture the driver-generated command lines.
1396 @item -pipe
1397 @opindex pipe
1398 Use pipes rather than temporary files for communication between the
1399 various stages of compilation.  This fails to work on some systems where
1400 the assembler is unable to read from a pipe; but the GNU assembler has
1401 no trouble.
1403 @item --help
1404 @opindex help
1405 Print (on the standard output) a description of the command-line options
1406 understood by @command{gcc}.  If the @option{-v} option is also specified
1407 then @option{--help} is also passed on to the various processes
1408 invoked by @command{gcc}, so that they can display the command-line options
1409 they accept.  If the @option{-Wextra} option has also been specified
1410 (prior to the @option{--help} option), then command-line options that
1411 have no documentation associated with them are also displayed.
1413 @item --target-help
1414 @opindex target-help
1415 Print (on the standard output) a description of target-specific command-line
1416 options for each tool.  For some targets extra target-specific
1417 information may also be printed.
1419 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1420 Print (on the standard output) a description of the command-line
1421 options understood by the compiler that fit into all specified classes
1422 and qualifiers.  These are the supported classes:
1424 @table @asis
1425 @item @samp{optimizers}
1426 Display all of the optimization options supported by the
1427 compiler.
1429 @item @samp{warnings}
1430 Display all of the options controlling warning messages
1431 produced by the compiler.
1433 @item @samp{target}
1434 Display target-specific options.  Unlike the
1435 @option{--target-help} option however, target-specific options of the
1436 linker and assembler are not displayed.  This is because those
1437 tools do not currently support the extended @option{--help=} syntax.
1439 @item @samp{params}
1440 Display the values recognized by the @option{--param}
1441 option.
1443 @item @var{language}
1444 Display the options supported for @var{language}, where
1445 @var{language} is the name of one of the languages supported in this
1446 version of GCC@.
1448 @item @samp{common}
1449 Display the options that are common to all languages.
1450 @end table
1452 These are the supported qualifiers:
1454 @table @asis
1455 @item @samp{undocumented}
1456 Display only those options that are undocumented.
1458 @item @samp{joined}
1459 Display options taking an argument that appears after an equal
1460 sign in the same continuous piece of text, such as:
1461 @samp{--help=target}.
1463 @item @samp{separate}
1464 Display options taking an argument that appears as a separate word
1465 following the original option, such as: @samp{-o output-file}.
1466 @end table
1468 Thus for example to display all the undocumented target-specific
1469 switches supported by the compiler, use:
1471 @smallexample
1472 --help=target,undocumented
1473 @end smallexample
1475 The sense of a qualifier can be inverted by prefixing it with the
1476 @samp{^} character, so for example to display all binary warning
1477 options (i.e., ones that are either on or off and that do not take an
1478 argument) that have a description, use:
1480 @smallexample
1481 --help=warnings,^joined,^undocumented
1482 @end smallexample
1484 The argument to @option{--help=} should not consist solely of inverted
1485 qualifiers.
1487 Combining several classes is possible, although this usually
1488 restricts the output so much that there is nothing to display.  One
1489 case where it does work, however, is when one of the classes is
1490 @var{target}.  For example, to display all the target-specific
1491 optimization options, use:
1493 @smallexample
1494 --help=target,optimizers
1495 @end smallexample
1497 The @option{--help=} option can be repeated on the command line.  Each
1498 successive use displays its requested class of options, skipping
1499 those that have already been displayed.
1501 If the @option{-Q} option appears on the command line before the
1502 @option{--help=} option, then the descriptive text displayed by
1503 @option{--help=} is changed.  Instead of describing the displayed
1504 options, an indication is given as to whether the option is enabled,
1505 disabled or set to a specific value (assuming that the compiler
1506 knows this at the point where the @option{--help=} option is used).
1508 Here is a truncated example from the ARM port of @command{gcc}:
1510 @smallexample
1511   % gcc -Q -mabi=2 --help=target -c
1512   The following options are target specific:
1513   -mabi=                                2
1514   -mabort-on-noreturn                   [disabled]
1515   -mapcs                                [disabled]
1516 @end smallexample
1518 The output is sensitive to the effects of previous command-line
1519 options, so for example it is possible to find out which optimizations
1520 are enabled at @option{-O2} by using:
1522 @smallexample
1523 -Q -O2 --help=optimizers
1524 @end smallexample
1526 Alternatively you can discover which binary optimizations are enabled
1527 by @option{-O3} by using:
1529 @smallexample
1530 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1531 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1532 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1533 @end smallexample
1535 @item -no-canonical-prefixes
1536 @opindex no-canonical-prefixes
1537 Do not expand any symbolic links, resolve references to @samp{/../}
1538 or @samp{/./}, or make the path absolute when generating a relative
1539 prefix.
1541 @item --version
1542 @opindex version
1543 Display the version number and copyrights of the invoked GCC@.
1545 @item -wrapper
1546 @opindex wrapper
1547 Invoke all subcommands under a wrapper program.  The name of the
1548 wrapper program and its parameters are passed as a comma separated
1549 list.
1551 @smallexample
1552 gcc -c t.c -wrapper gdb,--args
1553 @end smallexample
1555 @noindent
1556 This invokes all subprograms of @command{gcc} under
1557 @samp{gdb --args}, thus the invocation of @command{cc1} is
1558 @samp{gdb --args cc1 @dots{}}.
1560 @item -fplugin=@var{name}.so
1561 @opindex fplugin
1562 Load the plugin code in file @var{name}.so, assumed to be a
1563 shared object to be dlopen'd by the compiler.  The base name of
1564 the shared object file is used to identify the plugin for the
1565 purposes of argument parsing (See
1566 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1567 Each plugin should define the callback functions specified in the
1568 Plugins API.
1570 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1571 @opindex fplugin-arg
1572 Define an argument called @var{key} with a value of @var{value}
1573 for the plugin called @var{name}.
1575 @item -fdump-ada-spec@r{[}-slim@r{]}
1576 @opindex fdump-ada-spec
1577 For C and C++ source and include files, generate corresponding Ada specs.
1578 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1579 GNAT User's Guide}, which provides detailed documentation on this feature.
1581 @item -fada-spec-parent=@var{unit}
1582 @opindex fada-spec-parent
1583 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1584 Ada specs as child units of parent @var{unit}.
1586 @item -fdump-go-spec=@var{file}
1587 @opindex fdump-go-spec
1588 For input files in any language, generate corresponding Go
1589 declarations in @var{file}.  This generates Go @code{const},
1590 @code{type}, @code{var}, and @code{func} declarations which may be a
1591 useful way to start writing a Go interface to code written in some
1592 other language.
1594 @include @value{srcdir}/../libiberty/at-file.texi
1595 @end table
1597 @node Invoking G++
1598 @section Compiling C++ Programs
1600 @cindex suffixes for C++ source
1601 @cindex C++ source file suffixes
1602 C++ source files conventionally use one of the suffixes @samp{.C},
1603 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1604 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1605 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1606 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1607 files with these names and compiles them as C++ programs even if you
1608 call the compiler the same way as for compiling C programs (usually
1609 with the name @command{gcc}).
1611 @findex g++
1612 @findex c++
1613 However, the use of @command{gcc} does not add the C++ library.
1614 @command{g++} is a program that calls GCC and automatically specifies linking
1615 against the C++ library.  It treats @samp{.c},
1616 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1617 files unless @option{-x} is used.  This program is also useful when
1618 precompiling a C header file with a @samp{.h} extension for use in C++
1619 compilations.  On many systems, @command{g++} is also installed with
1620 the name @command{c++}.
1622 @cindex invoking @command{g++}
1623 When you compile C++ programs, you may specify many of the same
1624 command-line options that you use for compiling programs in any
1625 language; or command-line options meaningful for C and related
1626 languages; or options that are meaningful only for C++ programs.
1627 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1628 explanations of options for languages related to C@.
1629 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1630 explanations of options that are meaningful only for C++ programs.
1632 @node C Dialect Options
1633 @section Options Controlling C Dialect
1634 @cindex dialect options
1635 @cindex language dialect options
1636 @cindex options, dialect
1638 The following options control the dialect of C (or languages derived
1639 from C, such as C++, Objective-C and Objective-C++) that the compiler
1640 accepts:
1642 @table @gcctabopt
1643 @cindex ANSI support
1644 @cindex ISO support
1645 @item -ansi
1646 @opindex ansi
1647 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1648 equivalent to @option{-std=c++98}.
1650 This turns off certain features of GCC that are incompatible with ISO
1651 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1652 such as the @code{asm} and @code{typeof} keywords, and
1653 predefined macros such as @code{unix} and @code{vax} that identify the
1654 type of system you are using.  It also enables the undesirable and
1655 rarely used ISO trigraph feature.  For the C compiler,
1656 it disables recognition of C++ style @samp{//} comments as well as
1657 the @code{inline} keyword.
1659 The alternate keywords @code{__asm__}, @code{__extension__},
1660 @code{__inline__} and @code{__typeof__} continue to work despite
1661 @option{-ansi}.  You would not want to use them in an ISO C program, of
1662 course, but it is useful to put them in header files that might be included
1663 in compilations done with @option{-ansi}.  Alternate predefined macros
1664 such as @code{__unix__} and @code{__vax__} are also available, with or
1665 without @option{-ansi}.
1667 The @option{-ansi} option does not cause non-ISO programs to be
1668 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1669 addition to @option{-ansi}.  @xref{Warning Options}.
1671 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1672 option is used.  Some header files may notice this macro and refrain
1673 from declaring certain functions or defining certain macros that the
1674 ISO standard doesn't call for; this is to avoid interfering with any
1675 programs that might use these names for other things.
1677 Functions that are normally built in but do not have semantics
1678 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1679 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1680 built-in functions provided by GCC}, for details of the functions
1681 affected.
1683 @item -std=
1684 @opindex std
1685 Determine the language standard. @xref{Standards,,Language Standards
1686 Supported by GCC}, for details of these standard versions.  This option
1687 is currently only supported when compiling C or C++.
1689 The compiler can accept several base standards, such as @samp{c90} or
1690 @samp{c++98}, and GNU dialects of those standards, such as
1691 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1692 compiler accepts all programs following that standard plus those
1693 using GNU extensions that do not contradict it.  For example,
1694 @option{-std=c90} turns off certain features of GCC that are
1695 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1696 keywords, but not other GNU extensions that do not have a meaning in
1697 ISO C90, such as omitting the middle term of a @code{?:}
1698 expression. On the other hand, when a GNU dialect of a standard is
1699 specified, all features supported by the compiler are enabled, even when
1700 those features change the meaning of the base standard.  As a result, some
1701 strict-conforming programs may be rejected.  The particular standard
1702 is used by @option{-Wpedantic} to identify which features are GNU
1703 extensions given that version of the standard. For example
1704 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1705 comments, while @option{-std=gnu99 -Wpedantic} does not.
1707 A value for this option must be provided; possible values are
1709 @table @samp
1710 @item c90
1711 @itemx c89
1712 @itemx iso9899:1990
1713 Support all ISO C90 programs (certain GNU extensions that conflict
1714 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1716 @item iso9899:199409
1717 ISO C90 as modified in amendment 1.
1719 @item c99
1720 @itemx c9x
1721 @itemx iso9899:1999
1722 @itemx iso9899:199x
1723 ISO C99.  This standard is substantially completely supported, modulo
1724 bugs and floating-point issues
1725 (mainly but not entirely relating to optional C99 features from
1726 Annexes F and G).  See
1727 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1728 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1730 @item c11
1731 @itemx c1x
1732 @itemx iso9899:2011
1733 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1734 substantially completely supported, modulo bugs, floating-point issues
1735 (mainly but not entirely relating to optional C11 features from
1736 Annexes F and G) and the optional Annexes K (Bounds-checking
1737 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1739 @item gnu90
1740 @itemx gnu89
1741 GNU dialect of ISO C90 (including some C99 features).
1743 @item gnu99
1744 @itemx gnu9x
1745 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1747 @item gnu11
1748 @itemx gnu1x
1749 GNU dialect of ISO C11.  This is the default for C code.
1750 The name @samp{gnu1x} is deprecated.
1752 @item c++98
1753 @itemx c++03
1754 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1755 additional defect reports. Same as @option{-ansi} for C++ code.
1757 @item gnu++98
1758 @itemx gnu++03
1759 GNU dialect of @option{-std=c++98}.  This is the default for
1760 C++ code.
1762 @item c++11
1763 @itemx c++0x
1764 The 2011 ISO C++ standard plus amendments.
1765 The name @samp{c++0x} is deprecated.
1767 @item gnu++11
1768 @itemx gnu++0x
1769 GNU dialect of @option{-std=c++11}.
1770 The name @samp{gnu++0x} is deprecated.
1772 @item c++14
1773 @itemx c++1y
1774 The 2014 ISO C++ standard plus amendments.
1775 The name @samp{c++1y} is deprecated.
1777 @item gnu++14
1778 @itemx gnu++1y
1779 GNU dialect of @option{-std=c++14}.
1780 The name @samp{gnu++1y} is deprecated.
1782 @item c++1z
1783 The next revision of the ISO C++ standard, tentatively planned for
1784 2017.  Support is highly experimental, and will almost certainly
1785 change in incompatible ways in future releases.
1787 @item gnu++1z
1788 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1789 and will almost certainly change in incompatible ways in future
1790 releases.
1791 @end table
1793 @item -fgnu89-inline
1794 @opindex fgnu89-inline
1795 The option @option{-fgnu89-inline} tells GCC to use the traditional
1796 GNU semantics for @code{inline} functions when in C99 mode.
1797 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1798 Using this option is roughly equivalent to adding the
1799 @code{gnu_inline} function attribute to all inline functions
1800 (@pxref{Function Attributes}).
1802 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1803 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1804 specifies the default behavior).
1805 This option is not supported in @option{-std=c90} or
1806 @option{-std=gnu90} mode.
1808 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1809 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1810 in effect for @code{inline} functions.  @xref{Common Predefined
1811 Macros,,,cpp,The C Preprocessor}.
1813 @item -aux-info @var{filename}
1814 @opindex aux-info
1815 Output to the given filename prototyped declarations for all functions
1816 declared and/or defined in a translation unit, including those in header
1817 files.  This option is silently ignored in any language other than C@.
1819 Besides declarations, the file indicates, in comments, the origin of
1820 each declaration (source file and line), whether the declaration was
1821 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1822 @samp{O} for old, respectively, in the first character after the line
1823 number and the colon), and whether it came from a declaration or a
1824 definition (@samp{C} or @samp{F}, respectively, in the following
1825 character).  In the case of function definitions, a K&R-style list of
1826 arguments followed by their declarations is also provided, inside
1827 comments, after the declaration.
1829 @item -fallow-parameterless-variadic-functions
1830 @opindex fallow-parameterless-variadic-functions
1831 Accept variadic functions without named parameters.
1833 Although it is possible to define such a function, this is not very
1834 useful as it is not possible to read the arguments.  This is only
1835 supported for C as this construct is allowed by C++.
1837 @item -fno-asm
1838 @opindex fno-asm
1839 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1840 keyword, so that code can use these words as identifiers.  You can use
1841 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1842 instead.  @option{-ansi} implies @option{-fno-asm}.
1844 In C++, this switch only affects the @code{typeof} keyword, since
1845 @code{asm} and @code{inline} are standard keywords.  You may want to
1846 use the @option{-fno-gnu-keywords} flag instead, which has the same
1847 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1848 switch only affects the @code{asm} and @code{typeof} keywords, since
1849 @code{inline} is a standard keyword in ISO C99.
1851 @item -fno-builtin
1852 @itemx -fno-builtin-@var{function}
1853 @opindex fno-builtin
1854 @cindex built-in functions
1855 Don't recognize built-in functions that do not begin with
1856 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1857 functions provided by GCC}, for details of the functions affected,
1858 including those which are not built-in functions when @option{-ansi} or
1859 @option{-std} options for strict ISO C conformance are used because they
1860 do not have an ISO standard meaning.
1862 GCC normally generates special code to handle certain built-in functions
1863 more efficiently; for instance, calls to @code{alloca} may become single
1864 instructions which adjust the stack directly, and calls to @code{memcpy}
1865 may become inline copy loops.  The resulting code is often both smaller
1866 and faster, but since the function calls no longer appear as such, you
1867 cannot set a breakpoint on those calls, nor can you change the behavior
1868 of the functions by linking with a different library.  In addition,
1869 when a function is recognized as a built-in function, GCC may use
1870 information about that function to warn about problems with calls to
1871 that function, or to generate more efficient code, even if the
1872 resulting code still contains calls to that function.  For example,
1873 warnings are given with @option{-Wformat} for bad calls to
1874 @code{printf} when @code{printf} is built in and @code{strlen} is
1875 known not to modify global memory.
1877 With the @option{-fno-builtin-@var{function}} option
1878 only the built-in function @var{function} is
1879 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1880 function is named that is not built-in in this version of GCC, this
1881 option is ignored.  There is no corresponding
1882 @option{-fbuiltin-@var{function}} option; if you wish to enable
1883 built-in functions selectively when using @option{-fno-builtin} or
1884 @option{-ffreestanding}, you may define macros such as:
1886 @smallexample
1887 #define abs(n)          __builtin_abs ((n))
1888 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1889 @end smallexample
1891 @item -fhosted
1892 @opindex fhosted
1893 @cindex hosted environment
1895 Assert that compilation targets a hosted environment.  This implies
1896 @option{-fbuiltin}.  A hosted environment is one in which the
1897 entire standard library is available, and in which @code{main} has a return
1898 type of @code{int}.  Examples are nearly everything except a kernel.
1899 This is equivalent to @option{-fno-freestanding}.
1901 @item -ffreestanding
1902 @opindex ffreestanding
1903 @cindex hosted environment
1905 Assert that compilation targets a freestanding environment.  This
1906 implies @option{-fno-builtin}.  A freestanding environment
1907 is one in which the standard library may not exist, and program startup may
1908 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1909 This is equivalent to @option{-fno-hosted}.
1911 @xref{Standards,,Language Standards Supported by GCC}, for details of
1912 freestanding and hosted environments.
1914 @item -fopenacc
1915 @opindex fopenacc
1916 @cindex OpenACC accelerator programming
1917 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1918 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1919 compiler generates accelerated code according to the OpenACC Application
1920 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1921 implies @option{-pthread}, and thus is only supported on targets that
1922 have support for @option{-pthread}.
1924 Note that this is an experimental feature, incomplete, and subject to
1925 change in future versions of GCC.  See
1926 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
1928 @item -fopenmp
1929 @opindex fopenmp
1930 @cindex OpenMP parallel
1931 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1932 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1933 compiler generates parallel code according to the OpenMP Application
1934 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1935 implies @option{-pthread}, and thus is only supported on targets that
1936 have support for @option{-pthread}. @option{-fopenmp} implies
1937 @option{-fopenmp-simd}.
1939 @item -fopenmp-simd
1940 @opindex fopenmp-simd
1941 @cindex OpenMP SIMD
1942 @cindex SIMD
1943 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1944 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1945 are ignored.
1947 @item -fcilkplus
1948 @opindex fcilkplus
1949 @cindex Enable Cilk Plus
1950 Enable the usage of Cilk Plus language extension features for C/C++.
1951 When the option @option{-fcilkplus} is specified, enable the usage of
1952 the Cilk Plus Language extension features for C/C++.  The present
1953 implementation follows ABI version 1.2.  This is an experimental
1954 feature that is only partially complete, and whose interface may
1955 change in future versions of GCC as the official specification
1956 changes.  Currently, all features but @code{_Cilk_for} have been
1957 implemented.
1959 @item -fgnu-tm
1960 @opindex fgnu-tm
1961 When the option @option{-fgnu-tm} is specified, the compiler
1962 generates code for the Linux variant of Intel's current Transactional
1963 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1964 an experimental feature whose interface may change in future versions
1965 of GCC, as the official specification changes.  Please note that not
1966 all architectures are supported for this feature.
1968 For more information on GCC's support for transactional memory,
1969 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1970 Transactional Memory Library}.
1972 Note that the transactional memory feature is not supported with
1973 non-call exceptions (@option{-fnon-call-exceptions}).
1975 @item -fms-extensions
1976 @opindex fms-extensions
1977 Accept some non-standard constructs used in Microsoft header files.
1979 In C++ code, this allows member names in structures to be similar
1980 to previous types declarations.
1982 @smallexample
1983 typedef int UOW;
1984 struct ABC @{
1985   UOW UOW;
1987 @end smallexample
1989 Some cases of unnamed fields in structures and unions are only
1990 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1991 fields within structs/unions}, for details.
1993 Note that this option is off for all targets but x86 
1994 targets using ms-abi.
1996 @item -fplan9-extensions
1997 @opindex fplan9-extensions
1998 Accept some non-standard constructs used in Plan 9 code.
2000 This enables @option{-fms-extensions}, permits passing pointers to
2001 structures with anonymous fields to functions that expect pointers to
2002 elements of the type of the field, and permits referring to anonymous
2003 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2004 struct/union fields within structs/unions}, for details.  This is only
2005 supported for C, not C++.
2007 @item -trigraphs
2008 @opindex trigraphs
2009 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2010 options for strict ISO C conformance) implies @option{-trigraphs}.
2012 @cindex traditional C language
2013 @cindex C language, traditional
2014 @item -traditional
2015 @itemx -traditional-cpp
2016 @opindex traditional-cpp
2017 @opindex traditional
2018 Formerly, these options caused GCC to attempt to emulate a pre-standard
2019 C compiler.  They are now only supported with the @option{-E} switch.
2020 The preprocessor continues to support a pre-standard mode.  See the GNU
2021 CPP manual for details.
2023 @item -fcond-mismatch
2024 @opindex fcond-mismatch
2025 Allow conditional expressions with mismatched types in the second and
2026 third arguments.  The value of such an expression is void.  This option
2027 is not supported for C++.
2029 @item -flax-vector-conversions
2030 @opindex flax-vector-conversions
2031 Allow implicit conversions between vectors with differing numbers of
2032 elements and/or incompatible element types.  This option should not be
2033 used for new code.
2035 @item -funsigned-char
2036 @opindex funsigned-char
2037 Let the type @code{char} be unsigned, like @code{unsigned char}.
2039 Each kind of machine has a default for what @code{char} should
2040 be.  It is either like @code{unsigned char} by default or like
2041 @code{signed char} by default.
2043 Ideally, a portable program should always use @code{signed char} or
2044 @code{unsigned char} when it depends on the signedness of an object.
2045 But many programs have been written to use plain @code{char} and
2046 expect it to be signed, or expect it to be unsigned, depending on the
2047 machines they were written for.  This option, and its inverse, let you
2048 make such a program work with the opposite default.
2050 The type @code{char} is always a distinct type from each of
2051 @code{signed char} or @code{unsigned char}, even though its behavior
2052 is always just like one of those two.
2054 @item -fsigned-char
2055 @opindex fsigned-char
2056 Let the type @code{char} be signed, like @code{signed char}.
2058 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2059 the negative form of @option{-funsigned-char}.  Likewise, the option
2060 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2062 @item -fsigned-bitfields
2063 @itemx -funsigned-bitfields
2064 @itemx -fno-signed-bitfields
2065 @itemx -fno-unsigned-bitfields
2066 @opindex fsigned-bitfields
2067 @opindex funsigned-bitfields
2068 @opindex fno-signed-bitfields
2069 @opindex fno-unsigned-bitfields
2070 These options control whether a bit-field is signed or unsigned, when the
2071 declaration does not use either @code{signed} or @code{unsigned}.  By
2072 default, such a bit-field is signed, because this is consistent: the
2073 basic integer types such as @code{int} are signed types.
2074 @end table
2076 @node C++ Dialect Options
2077 @section Options Controlling C++ Dialect
2079 @cindex compiler options, C++
2080 @cindex C++ options, command-line
2081 @cindex options, C++
2082 This section describes the command-line options that are only meaningful
2083 for C++ programs.  You can also use most of the GNU compiler options
2084 regardless of what language your program is in.  For example, you
2085 might compile a file @file{firstClass.C} like this:
2087 @smallexample
2088 g++ -g -frepo -O -c firstClass.C
2089 @end smallexample
2091 @noindent
2092 In this example, only @option{-frepo} is an option meant
2093 only for C++ programs; you can use the other options with any
2094 language supported by GCC@.
2096 Here is a list of options that are @emph{only} for compiling C++ programs:
2098 @table @gcctabopt
2100 @item -fabi-version=@var{n}
2101 @opindex fabi-version
2102 Use version @var{n} of the C++ ABI@.  The default is version 0.
2104 Version 0 refers to the version conforming most closely to
2105 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2106 will change in different versions of G++ as ABI bugs are fixed.
2108 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2110 Version 2 is the version of the C++ ABI that first appeared in G++
2111 3.4, and was the default through G++ 4.9.
2113 Version 3 corrects an error in mangling a constant address as a
2114 template argument.
2116 Version 4, which first appeared in G++ 4.5, implements a standard
2117 mangling for vector types.
2119 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2120 attribute const/volatile on function pointer types, decltype of a
2121 plain decl, and use of a function parameter in the declaration of
2122 another parameter.
2124 Version 6, which first appeared in G++ 4.7, corrects the promotion
2125 behavior of C++11 scoped enums and the mangling of template argument
2126 packs, const/static_cast, prefix ++ and --, and a class scope function
2127 used as a template argument.
2129 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2130 builtin type and corrects the mangling of lambdas in default argument
2131 scope.
2133 Version 8, which first appeared in G++ 4.9, corrects the substitution
2134 behavior of function types with function-cv-qualifiers.
2136 See also @option{-Wabi}.
2138 @item -fabi-compat-version=@var{n}
2139 @opindex fabi-compat-version
2140 On targets that support strong aliases, G++
2141 works around mangling changes by creating an alias with the correct
2142 mangled name when defining a symbol with an incorrect mangled name.
2143 This switch specifies which ABI version to use for the alias.
2145 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2146 another ABI version is explicitly selected, this defaults to 0.
2148 The compatibility version is also set by @option{-Wabi=@var{n}}.
2150 @item -fno-access-control
2151 @opindex fno-access-control
2152 Turn off all access checking.  This switch is mainly useful for working
2153 around bugs in the access control code.
2155 @item -fcheck-new
2156 @opindex fcheck-new
2157 Check that the pointer returned by @code{operator new} is non-null
2158 before attempting to modify the storage allocated.  This check is
2159 normally unnecessary because the C++ standard specifies that
2160 @code{operator new} only returns @code{0} if it is declared
2161 @code{throw()}, in which case the compiler always checks the
2162 return value even without this option.  In all other cases, when
2163 @code{operator new} has a non-empty exception specification, memory
2164 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2165 @samp{new (nothrow)}.
2167 @item -fconstexpr-depth=@var{n}
2168 @opindex fconstexpr-depth
2169 Set the maximum nested evaluation depth for C++11 constexpr functions
2170 to @var{n}.  A limit is needed to detect endless recursion during
2171 constant expression evaluation.  The minimum specified by the standard
2172 is 512.
2174 @item -fdeduce-init-list
2175 @opindex fdeduce-init-list
2176 Enable deduction of a template type parameter as
2177 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2179 @smallexample
2180 template <class T> auto forward(T t) -> decltype (realfn (t))
2182   return realfn (t);
2185 void f()
2187   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2189 @end smallexample
2191 This deduction was implemented as a possible extension to the
2192 originally proposed semantics for the C++11 standard, but was not part
2193 of the final standard, so it is disabled by default.  This option is
2194 deprecated, and may be removed in a future version of G++.
2196 @item -ffriend-injection
2197 @opindex ffriend-injection
2198 Inject friend functions into the enclosing namespace, so that they are
2199 visible outside the scope of the class in which they are declared.
2200 Friend functions were documented to work this way in the old Annotated
2201 C++ Reference Manual.  
2202 However, in ISO C++ a friend function that is not declared
2203 in an enclosing scope can only be found using argument dependent
2204 lookup.  GCC defaults to the standard behavior.
2206 This option is for compatibility, and may be removed in a future
2207 release of G++.
2209 @item -fno-elide-constructors
2210 @opindex fno-elide-constructors
2211 The C++ standard allows an implementation to omit creating a temporary
2212 that is only used to initialize another object of the same type.
2213 Specifying this option disables that optimization, and forces G++ to
2214 call the copy constructor in all cases.
2216 @item -fno-enforce-eh-specs
2217 @opindex fno-enforce-eh-specs
2218 Don't generate code to check for violation of exception specifications
2219 at run time.  This option violates the C++ standard, but may be useful
2220 for reducing code size in production builds, much like defining
2221 @code{NDEBUG}.  This does not give user code permission to throw
2222 exceptions in violation of the exception specifications; the compiler
2223 still optimizes based on the specifications, so throwing an
2224 unexpected exception results in undefined behavior at run time.
2226 @item -fextern-tls-init
2227 @itemx -fno-extern-tls-init
2228 @opindex fextern-tls-init
2229 @opindex fno-extern-tls-init
2230 The C++11 and OpenMP standards allow @code{thread_local} and
2231 @code{threadprivate} variables to have dynamic (runtime)
2232 initialization.  To support this, any use of such a variable goes
2233 through a wrapper function that performs any necessary initialization.
2234 When the use and definition of the variable are in the same
2235 translation unit, this overhead can be optimized away, but when the
2236 use is in a different translation unit there is significant overhead
2237 even if the variable doesn't actually need dynamic initialization.  If
2238 the programmer can be sure that no use of the variable in a
2239 non-defining TU needs to trigger dynamic initialization (either
2240 because the variable is statically initialized, or a use of the
2241 variable in the defining TU will be executed before any uses in
2242 another TU), they can avoid this overhead with the
2243 @option{-fno-extern-tls-init} option.
2245 On targets that support symbol aliases, the default is
2246 @option{-fextern-tls-init}.  On targets that do not support symbol
2247 aliases, the default is @option{-fno-extern-tls-init}.
2249 @item -ffor-scope
2250 @itemx -fno-for-scope
2251 @opindex ffor-scope
2252 @opindex fno-for-scope
2253 If @option{-ffor-scope} is specified, the scope of variables declared in
2254 a @i{for-init-statement} is limited to the @code{for} loop itself,
2255 as specified by the C++ standard.
2256 If @option{-fno-for-scope} is specified, the scope of variables declared in
2257 a @i{for-init-statement} extends to the end of the enclosing scope,
2258 as was the case in old versions of G++, and other (traditional)
2259 implementations of C++.
2261 If neither flag is given, the default is to follow the standard,
2262 but to allow and give a warning for old-style code that would
2263 otherwise be invalid, or have different behavior.
2265 @item -fno-gnu-keywords
2266 @opindex fno-gnu-keywords
2267 Do not recognize @code{typeof} as a keyword, so that code can use this
2268 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2269 @option{-ansi} implies @option{-fno-gnu-keywords}.
2271 @item -fno-implicit-templates
2272 @opindex fno-implicit-templates
2273 Never emit code for non-inline templates that are instantiated
2274 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2275 @xref{Template Instantiation}, for more information.
2277 @item -fno-implicit-inline-templates
2278 @opindex fno-implicit-inline-templates
2279 Don't emit code for implicit instantiations of inline templates, either.
2280 The default is to handle inlines differently so that compiles with and
2281 without optimization need the same set of explicit instantiations.
2283 @item -fno-implement-inlines
2284 @opindex fno-implement-inlines
2285 To save space, do not emit out-of-line copies of inline functions
2286 controlled by @code{#pragma implementation}.  This causes linker
2287 errors if these functions are not inlined everywhere they are called.
2289 @item -fms-extensions
2290 @opindex fms-extensions
2291 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2292 int and getting a pointer to member function via non-standard syntax.
2294 @item -fno-nonansi-builtins
2295 @opindex fno-nonansi-builtins
2296 Disable built-in declarations of functions that are not mandated by
2297 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2298 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2300 @item -fnothrow-opt
2301 @opindex fnothrow-opt
2302 Treat a @code{throw()} exception specification as if it were a
2303 @code{noexcept} specification to reduce or eliminate the text size
2304 overhead relative to a function with no exception specification.  If
2305 the function has local variables of types with non-trivial
2306 destructors, the exception specification actually makes the
2307 function smaller because the EH cleanups for those variables can be
2308 optimized away.  The semantic effect is that an exception thrown out of
2309 a function with such an exception specification results in a call
2310 to @code{terminate} rather than @code{unexpected}.
2312 @item -fno-operator-names
2313 @opindex fno-operator-names
2314 Do not treat the operator name keywords @code{and}, @code{bitand},
2315 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2316 synonyms as keywords.
2318 @item -fno-optional-diags
2319 @opindex fno-optional-diags
2320 Disable diagnostics that the standard says a compiler does not need to
2321 issue.  Currently, the only such diagnostic issued by G++ is the one for
2322 a name having multiple meanings within a class.
2324 @item -fpermissive
2325 @opindex fpermissive
2326 Downgrade some diagnostics about nonconformant code from errors to
2327 warnings.  Thus, using @option{-fpermissive} allows some
2328 nonconforming code to compile.
2330 @item -fno-pretty-templates
2331 @opindex fno-pretty-templates
2332 When an error message refers to a specialization of a function
2333 template, the compiler normally prints the signature of the
2334 template followed by the template arguments and any typedefs or
2335 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2336 rather than @code{void f(int)}) so that it's clear which template is
2337 involved.  When an error message refers to a specialization of a class
2338 template, the compiler omits any template arguments that match
2339 the default template arguments for that template.  If either of these
2340 behaviors make it harder to understand the error message rather than
2341 easier, you can use @option{-fno-pretty-templates} to disable them.
2343 @item -frepo
2344 @opindex frepo
2345 Enable automatic template instantiation at link time.  This option also
2346 implies @option{-fno-implicit-templates}.  @xref{Template
2347 Instantiation}, for more information.
2349 @item -fno-rtti
2350 @opindex fno-rtti
2351 Disable generation of information about every class with virtual
2352 functions for use by the C++ run-time type identification features
2353 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2354 of the language, you can save some space by using this flag.  Note that
2355 exception handling uses the same information, but G++ generates it as
2356 needed. The @code{dynamic_cast} operator can still be used for casts that
2357 do not require run-time type information, i.e.@: casts to @code{void *} or to
2358 unambiguous base classes.
2360 @item -fsized-deallocation
2361 @opindex fsized-deallocation
2362 Enable the built-in global declarations
2363 @smallexample
2364 void operator delete (void *, std::size_t) noexcept;
2365 void operator delete[] (void *, std::size_t) noexcept;
2366 @end smallexample
2367 as introduced in C++14.  This is useful for user-defined replacement
2368 deallocation functions that, for example, use the size of the object
2369 to make deallocation faster.  Enabled by default under
2370 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2371 warns about places that might want to add a definition.
2373 @item -fstats
2374 @opindex fstats
2375 Emit statistics about front-end processing at the end of the compilation.
2376 This information is generally only useful to the G++ development team.
2378 @item -fstrict-enums
2379 @opindex fstrict-enums
2380 Allow the compiler to optimize using the assumption that a value of
2381 enumerated type can only be one of the values of the enumeration (as
2382 defined in the C++ standard; basically, a value that can be
2383 represented in the minimum number of bits needed to represent all the
2384 enumerators).  This assumption may not be valid if the program uses a
2385 cast to convert an arbitrary integer value to the enumerated type.
2387 @item -ftemplate-backtrace-limit=@var{n}
2388 @opindex ftemplate-backtrace-limit
2389 Set the maximum number of template instantiation notes for a single
2390 warning or error to @var{n}.  The default value is 10.
2392 @item -ftemplate-depth=@var{n}
2393 @opindex ftemplate-depth
2394 Set the maximum instantiation depth for template classes to @var{n}.
2395 A limit on the template instantiation depth is needed to detect
2396 endless recursions during template class instantiation.  ANSI/ISO C++
2397 conforming programs must not rely on a maximum depth greater than 17
2398 (changed to 1024 in C++11).  The default value is 900, as the compiler
2399 can run out of stack space before hitting 1024 in some situations.
2401 @item -fno-threadsafe-statics
2402 @opindex fno-threadsafe-statics
2403 Do not emit the extra code to use the routines specified in the C++
2404 ABI for thread-safe initialization of local statics.  You can use this
2405 option to reduce code size slightly in code that doesn't need to be
2406 thread-safe.
2408 @item -fuse-cxa-atexit
2409 @opindex fuse-cxa-atexit
2410 Register destructors for objects with static storage duration with the
2411 @code{__cxa_atexit} function rather than the @code{atexit} function.
2412 This option is required for fully standards-compliant handling of static
2413 destructors, but only works if your C library supports
2414 @code{__cxa_atexit}.
2416 @item -fno-use-cxa-get-exception-ptr
2417 @opindex fno-use-cxa-get-exception-ptr
2418 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2419 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2420 if the runtime routine is not available.
2422 @item -fvisibility-inlines-hidden
2423 @opindex fvisibility-inlines-hidden
2424 This switch declares that the user does not attempt to compare
2425 pointers to inline functions or methods where the addresses of the two functions
2426 are taken in different shared objects.
2428 The effect of this is that GCC may, effectively, mark inline methods with
2429 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2430 appear in the export table of a DSO and do not require a PLT indirection
2431 when used within the DSO@.  Enabling this option can have a dramatic effect
2432 on load and link times of a DSO as it massively reduces the size of the
2433 dynamic export table when the library makes heavy use of templates.
2435 The behavior of this switch is not quite the same as marking the
2436 methods as hidden directly, because it does not affect static variables
2437 local to the function or cause the compiler to deduce that
2438 the function is defined in only one shared object.
2440 You may mark a method as having a visibility explicitly to negate the
2441 effect of the switch for that method.  For example, if you do want to
2442 compare pointers to a particular inline method, you might mark it as
2443 having default visibility.  Marking the enclosing class with explicit
2444 visibility has no effect.
2446 Explicitly instantiated inline methods are unaffected by this option
2447 as their linkage might otherwise cross a shared library boundary.
2448 @xref{Template Instantiation}.
2450 @item -fvisibility-ms-compat
2451 @opindex fvisibility-ms-compat
2452 This flag attempts to use visibility settings to make GCC's C++
2453 linkage model compatible with that of Microsoft Visual Studio.
2455 The flag makes these changes to GCC's linkage model:
2457 @enumerate
2458 @item
2459 It sets the default visibility to @code{hidden}, like
2460 @option{-fvisibility=hidden}.
2462 @item
2463 Types, but not their members, are not hidden by default.
2465 @item
2466 The One Definition Rule is relaxed for types without explicit
2467 visibility specifications that are defined in more than one
2468 shared object: those declarations are permitted if they are
2469 permitted when this option is not used.
2470 @end enumerate
2472 In new code it is better to use @option{-fvisibility=hidden} and
2473 export those classes that are intended to be externally visible.
2474 Unfortunately it is possible for code to rely, perhaps accidentally,
2475 on the Visual Studio behavior.
2477 Among the consequences of these changes are that static data members
2478 of the same type with the same name but defined in different shared
2479 objects are different, so changing one does not change the other;
2480 and that pointers to function members defined in different shared
2481 objects may not compare equal.  When this flag is given, it is a
2482 violation of the ODR to define types with the same name differently.
2484 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
2485 @opindex fvtable-verify
2486 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2487 feature that verifies at run time, for every virtual call, that
2488 the vtable pointer through which the call is made is valid for the type of
2489 the object, and has not been corrupted or overwritten.  If an invalid vtable
2490 pointer is detected at run time, an error is reported and execution of the
2491 program is immediately halted.
2493 This option causes run-time data structures to be built at program startup,
2494 which are used for verifying the vtable pointers.  
2495 The options @samp{std} and @samp{preinit}
2496 control the timing of when these data structures are built.  In both cases the
2497 data structures are built before execution reaches @code{main}.  Using
2498 @option{-fvtable-verify=std} causes the data structures to be built after
2499 shared libraries have been loaded and initialized.
2500 @option{-fvtable-verify=preinit} causes them to be built before shared
2501 libraries have been loaded and initialized.
2503 If this option appears multiple times in the command line with different
2504 values specified, @samp{none} takes highest priority over both @samp{std} and
2505 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
2507 @item -fvtv-debug
2508 @opindex fvtv-debug
2509 When used in conjunction with @option{-fvtable-verify=std} or 
2510 @option{-fvtable-verify=preinit}, causes debug versions of the 
2511 runtime functions for the vtable verification feature to be called.  
2512 This flag also causes the compiler to log information about which 
2513 vtable pointers it finds for each class.
2514 This information is written to a file named @file{vtv_set_ptr_data.log} 
2515 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
2516 if that is defined or the current working directory otherwise.
2518 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
2519 file, be sure to delete any existing one.
2521 @item -fvtv-counts
2522 @opindex fvtv-counts
2523 This is a debugging flag.  When used in conjunction with
2524 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2525 causes the compiler to keep track of the total number of virtual calls
2526 it encounters and the number of verifications it inserts.  It also
2527 counts the number of calls to certain run-time library functions
2528 that it inserts and logs this information for each compilation unit.
2529 The compiler writes this information to a file named
2530 @file{vtv_count_data.log} in the directory named by the environment
2531 variable @env{VTV_LOGS_DIR} if that is defined or the current working
2532 directory otherwise.  It also counts the size of the vtable pointer sets
2533 for each class, and writes this information to @file{vtv_class_set_sizes.log}
2534 in the same directory.
2536 Note:  This feature @emph{appends} data to the log files.  To get fresh log
2537 files, be sure to delete any existing ones.
2539 @item -fno-weak
2540 @opindex fno-weak
2541 Do not use weak symbol support, even if it is provided by the linker.
2542 By default, G++ uses weak symbols if they are available.  This
2543 option exists only for testing, and should not be used by end-users;
2544 it results in inferior code and has no benefits.  This option may
2545 be removed in a future release of G++.
2547 @item -nostdinc++
2548 @opindex nostdinc++
2549 Do not search for header files in the standard directories specific to
2550 C++, but do still search the other standard directories.  (This option
2551 is used when building the C++ library.)
2552 @end table
2554 In addition, these optimization, warning, and code generation options
2555 have meanings only for C++ programs:
2557 @table @gcctabopt
2558 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2559 @opindex Wabi
2560 @opindex Wno-abi
2561 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2562 G++ to warn when it generates code that is probably not compatible with the
2563 vendor-neutral C++ ABI@.  Since G++ now defaults to
2564 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2565 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2566 or an older compatibility version is selected (with
2567 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2569 Although an effort has been made to warn about
2570 all such cases, there are probably some cases that are not warned about,
2571 even though G++ is generating incompatible code.  There may also be
2572 cases where warnings are emitted even though the code that is generated
2573 is compatible.
2575 You should rewrite your code to avoid these warnings if you are
2576 concerned about the fact that code generated by G++ may not be binary
2577 compatible with code generated by other compilers.
2579 @option{-Wabi} can also be used with an explicit version number to
2580 warn about compatibility with a particular @option{-fabi-version}
2581 level, e.g. @option{-Wabi=2} to warn about changes relative to
2582 @option{-fabi-version=2}.  Specifying a version number also sets
2583 @option{-fabi-compat-version=@var{n}}.
2585 The known incompatibilities in @option{-fabi-version=2} (which was the
2586 default from GCC 3.4 to 4.9) include:
2588 @itemize @bullet
2590 @item
2591 A template with a non-type template parameter of reference type was
2592 mangled incorrectly:
2593 @smallexample
2594 extern int N;
2595 template <int &> struct S @{@};
2596 void n (S<N>) @{2@}
2597 @end smallexample
2599 This was fixed in @option{-fabi-version=3}.
2601 @item
2602 SIMD vector types declared using @code{__attribute ((vector_size))} were
2603 mangled in a non-standard way that does not allow for overloading of
2604 functions taking vectors of different sizes.
2606 The mangling was changed in @option{-fabi-version=4}.
2608 @item
2609 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2610 qualifiers, and @code{decltype} of a plain declaration was folded away.
2612 These mangling issues were fixed in @option{-fabi-version=5}.
2614 @item
2615 Scoped enumerators passed as arguments to a variadic function are
2616 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2617 On most targets this does not actually affect the parameter passing
2618 ABI, as there is no way to pass an argument smaller than @code{int}.
2620 Also, the ABI changed the mangling of template argument packs,
2621 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2622 a class scope function used as a template argument.
2624 These issues were corrected in @option{-fabi-version=6}.
2626 @item
2627 Lambdas in default argument scope were mangled incorrectly, and the
2628 ABI changed the mangling of @code{nullptr_t}.
2630 These issues were corrected in @option{-fabi-version=7}.
2632 @item
2633 When mangling a function type with function-cv-qualifiers, the
2634 un-qualified function type was incorrectly treated as a substitution
2635 candidate.
2637 This was fixed in @option{-fabi-version=8}.
2638 @end itemize
2640 It also warns about psABI-related changes.  The known psABI changes at this
2641 point include:
2643 @itemize @bullet
2645 @item
2646 For SysV/x86-64, unions with @code{long double} members are 
2647 passed in memory as specified in psABI.  For example:
2649 @smallexample
2650 union U @{
2651   long double ld;
2652   int i;
2654 @end smallexample
2656 @noindent
2657 @code{union U} is always passed in memory.
2659 @end itemize
2661 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2662 @opindex Wabi-tag
2663 @opindex -Wabi-tag
2664 Warn when a type with an ABI tag is used in a context that does not
2665 have that ABI tag.  See @ref{C++ Attributes} for more information
2666 about ABI tags.
2668 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2669 @opindex Wctor-dtor-privacy
2670 @opindex Wno-ctor-dtor-privacy
2671 Warn when a class seems unusable because all the constructors or
2672 destructors in that class are private, and it has neither friends nor
2673 public static member functions.  Also warn if there are no non-private
2674 methods, and there's at least one private member function that isn't
2675 a constructor or destructor.
2677 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2678 @opindex Wdelete-non-virtual-dtor
2679 @opindex Wno-delete-non-virtual-dtor
2680 Warn when @code{delete} is used to destroy an instance of a class that
2681 has virtual functions and non-virtual destructor. It is unsafe to delete
2682 an instance of a derived class through a pointer to a base class if the
2683 base class does not have a virtual destructor.  This warning is enabled
2684 by @option{-Wall}.
2686 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2687 @opindex Wliteral-suffix
2688 @opindex Wno-literal-suffix
2689 Warn when a string or character literal is followed by a ud-suffix which does
2690 not begin with an underscore.  As a conforming extension, GCC treats such
2691 suffixes as separate preprocessing tokens in order to maintain backwards
2692 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2693 For example:
2695 @smallexample
2696 #define __STDC_FORMAT_MACROS
2697 #include <inttypes.h>
2698 #include <stdio.h>
2700 int main() @{
2701   int64_t i64 = 123;
2702   printf("My int64: %" PRId64"\n", i64);
2704 @end smallexample
2706 In this case, @code{PRId64} is treated as a separate preprocessing token.
2708 This warning is enabled by default.
2710 @item -Wlto-type-mismatch
2711 @opindex Wlto-type-mismatch
2712 @opindex Wno-lto-type-mistmach
2714 During the link-time optimization warn about type mismatches in between
2715 global declarations from different compilation units.
2716 Requires @option{-flto} to be enabled.  Enabled by default.
2718 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2719 @opindex Wnarrowing
2720 @opindex Wno-narrowing
2721 Warn when a narrowing conversion prohibited by C++11 occurs within
2722 @samp{@{ @}}, e.g.
2724 @smallexample
2725 int i = @{ 2.2 @}; // error: narrowing from double to int
2726 @end smallexample
2728 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2730 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2731 required by the standard.  Note that this does not affect the meaning
2732 of well-formed code; narrowing conversions are still considered
2733 ill-formed in SFINAE context.
2735 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2736 @opindex Wnoexcept
2737 @opindex Wno-noexcept
2738 Warn when a noexcept-expression evaluates to false because of a call
2739 to a function that does not have a non-throwing exception
2740 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2741 the compiler to never throw an exception.
2743 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2744 @opindex Wnon-virtual-dtor
2745 @opindex Wno-non-virtual-dtor
2746 Warn when a class has virtual functions and an accessible non-virtual
2747 destructor itself or in an accessible polymorphic base class, in which
2748 case it is possible but unsafe to delete an instance of a derived
2749 class through a pointer to the class itself or base class.  This
2750 warning is automatically enabled if @option{-Weffc++} is specified.
2752 @item -Wreorder @r{(C++ and Objective-C++ only)}
2753 @opindex Wreorder
2754 @opindex Wno-reorder
2755 @cindex reordering, warning
2756 @cindex warning for reordering of member initializers
2757 Warn when the order of member initializers given in the code does not
2758 match the order in which they must be executed.  For instance:
2760 @smallexample
2761 struct A @{
2762   int i;
2763   int j;
2764   A(): j (0), i (1) @{ @}
2766 @end smallexample
2768 @noindent
2769 The compiler rearranges the member initializers for @code{i}
2770 and @code{j} to match the declaration order of the members, emitting
2771 a warning to that effect.  This warning is enabled by @option{-Wall}.
2773 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2774 @opindex fext-numeric-literals
2775 @opindex fno-ext-numeric-literals
2776 Accept imaginary, fixed-point, or machine-defined
2777 literal number suffixes as GNU extensions.
2778 When this option is turned off these suffixes are treated
2779 as C++11 user-defined literal numeric suffixes.
2780 This is on by default for all pre-C++11 dialects and all GNU dialects:
2781 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2782 @option{-std=gnu++14}.
2783 This option is off by default
2784 for ISO C++11 onwards (@option{-std=c++11}, ...).
2785 @end table
2787 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2789 @table @gcctabopt
2790 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2791 @opindex Weffc++
2792 @opindex Wno-effc++
2793 Warn about violations of the following style guidelines from Scott Meyers'
2794 @cite{Effective C++} series of books:
2796 @itemize @bullet
2797 @item
2798 Define a copy constructor and an assignment operator for classes
2799 with dynamically-allocated memory.
2801 @item
2802 Prefer initialization to assignment in constructors.
2804 @item
2805 Have @code{operator=} return a reference to @code{*this}.
2807 @item
2808 Don't try to return a reference when you must return an object.
2810 @item
2811 Distinguish between prefix and postfix forms of increment and
2812 decrement operators.
2814 @item
2815 Never overload @code{&&}, @code{||}, or @code{,}.
2817 @end itemize
2819 This option also enables @option{-Wnon-virtual-dtor}, which is also
2820 one of the effective C++ recommendations.  However, the check is
2821 extended to warn about the lack of virtual destructor in accessible
2822 non-polymorphic bases classes too.
2824 When selecting this option, be aware that the standard library
2825 headers do not obey all of these guidelines; use @samp{grep -v}
2826 to filter out those warnings.
2828 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2829 @opindex Wstrict-null-sentinel
2830 @opindex Wno-strict-null-sentinel
2831 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2832 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2833 to @code{__null}.  Although it is a null pointer constant rather than a
2834 null pointer, it is guaranteed to be of the same size as a pointer.
2835 But this use is not portable across different compilers.
2837 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2838 @opindex Wno-non-template-friend
2839 @opindex Wnon-template-friend
2840 Disable warnings when non-templatized friend functions are declared
2841 within a template.  Since the advent of explicit template specification
2842 support in G++, if the name of the friend is an unqualified-id (i.e.,
2843 @samp{friend foo(int)}), the C++ language specification demands that the
2844 friend declare or define an ordinary, nontemplate function.  (Section
2845 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2846 could be interpreted as a particular specialization of a templatized
2847 function.  Because this non-conforming behavior is no longer the default
2848 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2849 check existing code for potential trouble spots and is on by default.
2850 This new compiler behavior can be turned off with
2851 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2852 but disables the helpful warning.
2854 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2855 @opindex Wold-style-cast
2856 @opindex Wno-old-style-cast
2857 Warn if an old-style (C-style) cast to a non-void type is used within
2858 a C++ program.  The new-style casts (@code{dynamic_cast},
2859 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2860 less vulnerable to unintended effects and much easier to search for.
2862 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2863 @opindex Woverloaded-virtual
2864 @opindex Wno-overloaded-virtual
2865 @cindex overloaded virtual function, warning
2866 @cindex warning for overloaded virtual function
2867 Warn when a function declaration hides virtual functions from a
2868 base class.  For example, in:
2870 @smallexample
2871 struct A @{
2872   virtual void f();
2875 struct B: public A @{
2876   void f(int);
2878 @end smallexample
2880 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2881 like:
2883 @smallexample
2884 B* b;
2885 b->f();
2886 @end smallexample
2888 @noindent
2889 fails to compile.
2891 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2892 @opindex Wno-pmf-conversions
2893 @opindex Wpmf-conversions
2894 Disable the diagnostic for converting a bound pointer to member function
2895 to a plain pointer.
2897 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2898 @opindex Wsign-promo
2899 @opindex Wno-sign-promo
2900 Warn when overload resolution chooses a promotion from unsigned or
2901 enumerated type to a signed type, over a conversion to an unsigned type of
2902 the same size.  Previous versions of G++ tried to preserve
2903 unsignedness, but the standard mandates the current behavior.
2905 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
2906 @opindex Wterminate
2907 @opindex Wno-terminate
2908 Disable the warning about a throw-expression that will immediately
2909 result in a call to @code{terminate}.
2910 @end table
2912 @node Objective-C and Objective-C++ Dialect Options
2913 @section Options Controlling Objective-C and Objective-C++ Dialects
2915 @cindex compiler options, Objective-C and Objective-C++
2916 @cindex Objective-C and Objective-C++ options, command-line
2917 @cindex options, Objective-C and Objective-C++
2918 (NOTE: This manual does not describe the Objective-C and Objective-C++
2919 languages themselves.  @xref{Standards,,Language Standards
2920 Supported by GCC}, for references.)
2922 This section describes the command-line options that are only meaningful
2923 for Objective-C and Objective-C++ programs.  You can also use most of
2924 the language-independent GNU compiler options.
2925 For example, you might compile a file @file{some_class.m} like this:
2927 @smallexample
2928 gcc -g -fgnu-runtime -O -c some_class.m
2929 @end smallexample
2931 @noindent
2932 In this example, @option{-fgnu-runtime} is an option meant only for
2933 Objective-C and Objective-C++ programs; you can use the other options with
2934 any language supported by GCC@.
2936 Note that since Objective-C is an extension of the C language, Objective-C
2937 compilations may also use options specific to the C front-end (e.g.,
2938 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2939 C++-specific options (e.g., @option{-Wabi}).
2941 Here is a list of options that are @emph{only} for compiling Objective-C
2942 and Objective-C++ programs:
2944 @table @gcctabopt
2945 @item -fconstant-string-class=@var{class-name}
2946 @opindex fconstant-string-class
2947 Use @var{class-name} as the name of the class to instantiate for each
2948 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2949 class name is @code{NXConstantString} if the GNU runtime is being used, and
2950 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2951 @option{-fconstant-cfstrings} option, if also present, overrides the
2952 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2953 to be laid out as constant CoreFoundation strings.
2955 @item -fgnu-runtime
2956 @opindex fgnu-runtime
2957 Generate object code compatible with the standard GNU Objective-C
2958 runtime.  This is the default for most types of systems.
2960 @item -fnext-runtime
2961 @opindex fnext-runtime
2962 Generate output compatible with the NeXT runtime.  This is the default
2963 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2964 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2965 used.
2967 @item -fno-nil-receivers
2968 @opindex fno-nil-receivers
2969 Assume that all Objective-C message dispatches (@code{[receiver
2970 message:arg]}) in this translation unit ensure that the receiver is
2971 not @code{nil}.  This allows for more efficient entry points in the
2972 runtime to be used.  This option is only available in conjunction with
2973 the NeXT runtime and ABI version 0 or 1.
2975 @item -fobjc-abi-version=@var{n}
2976 @opindex fobjc-abi-version
2977 Use version @var{n} of the Objective-C ABI for the selected runtime.
2978 This option is currently supported only for the NeXT runtime.  In that
2979 case, Version 0 is the traditional (32-bit) ABI without support for
2980 properties and other Objective-C 2.0 additions.  Version 1 is the
2981 traditional (32-bit) ABI with support for properties and other
2982 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2983 nothing is specified, the default is Version 0 on 32-bit target
2984 machines, and Version 2 on 64-bit target machines.
2986 @item -fobjc-call-cxx-cdtors
2987 @opindex fobjc-call-cxx-cdtors
2988 For each Objective-C class, check if any of its instance variables is a
2989 C++ object with a non-trivial default constructor.  If so, synthesize a
2990 special @code{- (id) .cxx_construct} instance method which runs
2991 non-trivial default constructors on any such instance variables, in order,
2992 and then return @code{self}.  Similarly, check if any instance variable
2993 is a C++ object with a non-trivial destructor, and if so, synthesize a
2994 special @code{- (void) .cxx_destruct} method which runs
2995 all such default destructors, in reverse order.
2997 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2998 methods thusly generated only operate on instance variables
2999 declared in the current Objective-C class, and not those inherited
3000 from superclasses.  It is the responsibility of the Objective-C
3001 runtime to invoke all such methods in an object's inheritance
3002 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3003 by the runtime immediately after a new object instance is allocated;
3004 the @code{- (void) .cxx_destruct} methods are invoked immediately
3005 before the runtime deallocates an object instance.
3007 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3008 support for invoking the @code{- (id) .cxx_construct} and
3009 @code{- (void) .cxx_destruct} methods.
3011 @item -fobjc-direct-dispatch
3012 @opindex fobjc-direct-dispatch
3013 Allow fast jumps to the message dispatcher.  On Darwin this is
3014 accomplished via the comm page.
3016 @item -fobjc-exceptions
3017 @opindex fobjc-exceptions
3018 Enable syntactic support for structured exception handling in
3019 Objective-C, similar to what is offered by C++ and Java.  This option
3020 is required to use the Objective-C keywords @code{@@try},
3021 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3022 @code{@@synchronized}.  This option is available with both the GNU
3023 runtime and the NeXT runtime (but not available in conjunction with
3024 the NeXT runtime on Mac OS X 10.2 and earlier).
3026 @item -fobjc-gc
3027 @opindex fobjc-gc
3028 Enable garbage collection (GC) in Objective-C and Objective-C++
3029 programs.  This option is only available with the NeXT runtime; the
3030 GNU runtime has a different garbage collection implementation that
3031 does not require special compiler flags.
3033 @item -fobjc-nilcheck
3034 @opindex fobjc-nilcheck
3035 For the NeXT runtime with version 2 of the ABI, check for a nil
3036 receiver in method invocations before doing the actual method call.
3037 This is the default and can be disabled using
3038 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3039 checked for nil in this way no matter what this flag is set to.
3040 Currently this flag does nothing when the GNU runtime, or an older
3041 version of the NeXT runtime ABI, is used.
3043 @item -fobjc-std=objc1
3044 @opindex fobjc-std
3045 Conform to the language syntax of Objective-C 1.0, the language
3046 recognized by GCC 4.0.  This only affects the Objective-C additions to
3047 the C/C++ language; it does not affect conformance to C/C++ standards,
3048 which is controlled by the separate C/C++ dialect option flags.  When
3049 this option is used with the Objective-C or Objective-C++ compiler,
3050 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3051 This is useful if you need to make sure that your Objective-C code can
3052 be compiled with older versions of GCC@.
3054 @item -freplace-objc-classes
3055 @opindex freplace-objc-classes
3056 Emit a special marker instructing @command{ld(1)} not to statically link in
3057 the resulting object file, and allow @command{dyld(1)} to load it in at
3058 run time instead.  This is used in conjunction with the Fix-and-Continue
3059 debugging mode, where the object file in question may be recompiled and
3060 dynamically reloaded in the course of program execution, without the need
3061 to restart the program itself.  Currently, Fix-and-Continue functionality
3062 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3063 and later.
3065 @item -fzero-link
3066 @opindex fzero-link
3067 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3068 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3069 compile time) with static class references that get initialized at load time,
3070 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3071 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3072 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3073 for individual class implementations to be modified during program execution.
3074 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3075 regardless of command-line options.
3077 @item -fno-local-ivars
3078 @opindex fno-local-ivars
3079 @opindex flocal-ivars
3080 By default instance variables in Objective-C can be accessed as if
3081 they were local variables from within the methods of the class they're
3082 declared in.  This can lead to shadowing between instance variables
3083 and other variables declared either locally inside a class method or
3084 globally with the same name.  Specifying the @option{-fno-local-ivars}
3085 flag disables this behavior thus avoiding variable shadowing issues.
3087 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3088 @opindex fivar-visibility
3089 Set the default instance variable visibility to the specified option
3090 so that instance variables declared outside the scope of any access
3091 modifier directives default to the specified visibility.
3093 @item -gen-decls
3094 @opindex gen-decls
3095 Dump interface declarations for all classes seen in the source file to a
3096 file named @file{@var{sourcename}.decl}.
3098 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3099 @opindex Wassign-intercept
3100 @opindex Wno-assign-intercept
3101 Warn whenever an Objective-C assignment is being intercepted by the
3102 garbage collector.
3104 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3105 @opindex Wno-protocol
3106 @opindex Wprotocol
3107 If a class is declared to implement a protocol, a warning is issued for
3108 every method in the protocol that is not implemented by the class.  The
3109 default behavior is to issue a warning for every method not explicitly
3110 implemented in the class, even if a method implementation is inherited
3111 from the superclass.  If you use the @option{-Wno-protocol} option, then
3112 methods inherited from the superclass are considered to be implemented,
3113 and no warning is issued for them.
3115 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3116 @opindex Wselector
3117 @opindex Wno-selector
3118 Warn if multiple methods of different types for the same selector are
3119 found during compilation.  The check is performed on the list of methods
3120 in the final stage of compilation.  Additionally, a check is performed
3121 for each selector appearing in a @code{@@selector(@dots{})}
3122 expression, and a corresponding method for that selector has been found
3123 during compilation.  Because these checks scan the method table only at
3124 the end of compilation, these warnings are not produced if the final
3125 stage of compilation is not reached, for example because an error is
3126 found during compilation, or because the @option{-fsyntax-only} option is
3127 being used.
3129 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3130 @opindex Wstrict-selector-match
3131 @opindex Wno-strict-selector-match
3132 Warn if multiple methods with differing argument and/or return types are
3133 found for a given selector when attempting to send a message using this
3134 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3135 is off (which is the default behavior), the compiler omits such warnings
3136 if any differences found are confined to types that share the same size
3137 and alignment.
3139 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3140 @opindex Wundeclared-selector
3141 @opindex Wno-undeclared-selector
3142 Warn if a @code{@@selector(@dots{})} expression referring to an
3143 undeclared selector is found.  A selector is considered undeclared if no
3144 method with that name has been declared before the
3145 @code{@@selector(@dots{})} expression, either explicitly in an
3146 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3147 an @code{@@implementation} section.  This option always performs its
3148 checks as soon as a @code{@@selector(@dots{})} expression is found,
3149 while @option{-Wselector} only performs its checks in the final stage of
3150 compilation.  This also enforces the coding style convention
3151 that methods and selectors must be declared before being used.
3153 @item -print-objc-runtime-info
3154 @opindex print-objc-runtime-info
3155 Generate C header describing the largest structure that is passed by
3156 value, if any.
3158 @end table
3160 @node Diagnostic Message Formatting Options
3161 @section Options to Control Diagnostic Messages Formatting
3162 @cindex options to control diagnostics formatting
3163 @cindex diagnostic messages
3164 @cindex message formatting
3166 Traditionally, diagnostic messages have been formatted irrespective of
3167 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3168 options described below
3169 to control the formatting algorithm for diagnostic messages, 
3170 e.g.@: how many characters per line, how often source location
3171 information should be reported.  Note that some language front ends may not
3172 honor these options.
3174 @table @gcctabopt
3175 @item -fmessage-length=@var{n}
3176 @opindex fmessage-length
3177 Try to format error messages so that they fit on lines of about
3178 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3179 done; each error message appears on a single line.  This is the
3180 default for all front ends.
3182 @item -fdiagnostics-show-location=once
3183 @opindex fdiagnostics-show-location
3184 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3185 reporter to emit source location information @emph{once}; that is, in
3186 case the message is too long to fit on a single physical line and has to
3187 be wrapped, the source location won't be emitted (as prefix) again,
3188 over and over, in subsequent continuation lines.  This is the default
3189 behavior.
3191 @item -fdiagnostics-show-location=every-line
3192 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3193 messages reporter to emit the same source location information (as
3194 prefix) for physical lines that result from the process of breaking
3195 a message which is too long to fit on a single line.
3197 @item -fdiagnostics-color[=@var{WHEN}]
3198 @itemx -fno-diagnostics-color
3199 @opindex fdiagnostics-color
3200 @cindex highlight, color, colour
3201 @vindex GCC_COLORS @r{environment variable}
3202 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3203 or @samp{auto}.  The default depends on how the compiler has been configured,
3204 it can be any of the above @var{WHEN} options or also @samp{never}
3205 if @env{GCC_COLORS} environment variable isn't present in the environment,
3206 and @samp{auto} otherwise.
3207 @samp{auto} means to use color only when the standard error is a terminal.
3208 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3209 aliases for @option{-fdiagnostics-color=always} and
3210 @option{-fdiagnostics-color=never}, respectively.
3212 The colors are defined by the environment variable @env{GCC_COLORS}.
3213 Its value is a colon-separated list of capabilities and Select Graphic
3214 Rendition (SGR) substrings. SGR commands are interpreted by the
3215 terminal or terminal emulator.  (See the section in the documentation
3216 of your text terminal for permitted values and their meanings as
3217 character attributes.)  These substring values are integers in decimal
3218 representation and can be concatenated with semicolons.
3219 Common values to concatenate include
3220 @samp{1} for bold,
3221 @samp{4} for underline,
3222 @samp{5} for blink,
3223 @samp{7} for inverse,
3224 @samp{39} for default foreground color,
3225 @samp{30} to @samp{37} for foreground colors,
3226 @samp{90} to @samp{97} for 16-color mode foreground colors,
3227 @samp{38;5;0} to @samp{38;5;255}
3228 for 88-color and 256-color modes foreground colors,
3229 @samp{49} for default background color,
3230 @samp{40} to @samp{47} for background colors,
3231 @samp{100} to @samp{107} for 16-color mode background colors,
3232 and @samp{48;5;0} to @samp{48;5;255}
3233 for 88-color and 256-color modes background colors.
3235 The default @env{GCC_COLORS} is
3236 @smallexample
3237 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3238 @end smallexample
3239 @noindent
3240 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3241 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3242 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3243 string disables colors.
3244 Supported capabilities are as follows.
3246 @table @code
3247 @item error=
3248 @vindex error GCC_COLORS @r{capability}
3249 SGR substring for error: markers.
3251 @item warning=
3252 @vindex warning GCC_COLORS @r{capability}
3253 SGR substring for warning: markers.
3255 @item note=
3256 @vindex note GCC_COLORS @r{capability}
3257 SGR substring for note: markers.
3259 @item caret=
3260 @vindex caret GCC_COLORS @r{capability}
3261 SGR substring for caret line.
3263 @item locus=
3264 @vindex locus GCC_COLORS @r{capability}
3265 SGR substring for location information, @samp{file:line} or
3266 @samp{file:line:column} etc.
3268 @item quote=
3269 @vindex quote GCC_COLORS @r{capability}
3270 SGR substring for information printed within quotes.
3271 @end table
3273 @item -fno-diagnostics-show-option
3274 @opindex fno-diagnostics-show-option
3275 @opindex fdiagnostics-show-option
3276 By default, each diagnostic emitted includes text indicating the
3277 command-line option that directly controls the diagnostic (if such an
3278 option is known to the diagnostic machinery).  Specifying the
3279 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3281 @item -fno-diagnostics-show-caret
3282 @opindex fno-diagnostics-show-caret
3283 @opindex fdiagnostics-show-caret
3284 By default, each diagnostic emitted includes the original source line
3285 and a caret '^' indicating the column.  This option suppresses this
3286 information.  The source line is truncated to @var{n} characters, if
3287 the @option{-fmessage-length=n} option is given.  When the output is done
3288 to the terminal, the width is limited to the width given by the
3289 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3291 @end table
3293 @node Warning Options
3294 @section Options to Request or Suppress Warnings
3295 @cindex options to control warnings
3296 @cindex warning messages
3297 @cindex messages, warning
3298 @cindex suppressing warnings
3300 Warnings are diagnostic messages that report constructions that
3301 are not inherently erroneous but that are risky or suggest there
3302 may have been an error.
3304 The following language-independent options do not enable specific
3305 warnings but control the kinds of diagnostics produced by GCC@.
3307 @table @gcctabopt
3308 @cindex syntax checking
3309 @item -fsyntax-only
3310 @opindex fsyntax-only
3311 Check the code for syntax errors, but don't do anything beyond that.
3313 @item -fmax-errors=@var{n}
3314 @opindex fmax-errors
3315 Limits the maximum number of error messages to @var{n}, at which point
3316 GCC bails out rather than attempting to continue processing the source
3317 code.  If @var{n} is 0 (the default), there is no limit on the number
3318 of error messages produced.  If @option{-Wfatal-errors} is also
3319 specified, then @option{-Wfatal-errors} takes precedence over this
3320 option.
3322 @item -w
3323 @opindex w
3324 Inhibit all warning messages.
3326 @item -Werror
3327 @opindex Werror
3328 @opindex Wno-error
3329 Make all warnings into errors.
3331 @item -Werror=
3332 @opindex Werror=
3333 @opindex Wno-error=
3334 Make the specified warning into an error.  The specifier for a warning
3335 is appended; for example @option{-Werror=switch} turns the warnings
3336 controlled by @option{-Wswitch} into errors.  This switch takes a
3337 negative form, to be used to negate @option{-Werror} for specific
3338 warnings; for example @option{-Wno-error=switch} makes
3339 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3340 is in effect.
3342 The warning message for each controllable warning includes the
3343 option that controls the warning.  That option can then be used with
3344 @option{-Werror=} and @option{-Wno-error=} as described above.
3345 (Printing of the option in the warning message can be disabled using the
3346 @option{-fno-diagnostics-show-option} flag.)
3348 Note that specifying @option{-Werror=}@var{foo} automatically implies
3349 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3350 imply anything.
3352 @item -Wfatal-errors
3353 @opindex Wfatal-errors
3354 @opindex Wno-fatal-errors
3355 This option causes the compiler to abort compilation on the first error
3356 occurred rather than trying to keep going and printing further error
3357 messages.
3359 @end table
3361 You can request many specific warnings with options beginning with
3362 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3363 implicit declarations.  Each of these specific warning options also
3364 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3365 example, @option{-Wno-implicit}.  This manual lists only one of the
3366 two forms, whichever is not the default.  For further
3367 language-specific options also refer to @ref{C++ Dialect Options} and
3368 @ref{Objective-C and Objective-C++ Dialect Options}.
3370 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3371 options, such as @option{-Wunused}, which may turn on further options,
3372 such as @option{-Wunused-value}. The combined effect of positive and
3373 negative forms is that more specific options have priority over less
3374 specific ones, independently of their position in the command-line. For
3375 options of the same specificity, the last one takes effect. Options
3376 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3377 as if they appeared at the end of the command-line.
3379 When an unrecognized warning option is requested (e.g.,
3380 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3381 that the option is not recognized.  However, if the @option{-Wno-} form
3382 is used, the behavior is slightly different: no diagnostic is
3383 produced for @option{-Wno-unknown-warning} unless other diagnostics
3384 are being produced.  This allows the use of new @option{-Wno-} options
3385 with old compilers, but if something goes wrong, the compiler
3386 warns that an unrecognized option is present.
3388 @table @gcctabopt
3389 @item -Wpedantic
3390 @itemx -pedantic
3391 @opindex pedantic
3392 @opindex Wpedantic
3393 Issue all the warnings demanded by strict ISO C and ISO C++;
3394 reject all programs that use forbidden extensions, and some other
3395 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3396 version of the ISO C standard specified by any @option{-std} option used.
3398 Valid ISO C and ISO C++ programs should compile properly with or without
3399 this option (though a rare few require @option{-ansi} or a
3400 @option{-std} option specifying the required version of ISO C)@.  However,
3401 without this option, certain GNU extensions and traditional C and C++
3402 features are supported as well.  With this option, they are rejected.
3404 @option{-Wpedantic} does not cause warning messages for use of the
3405 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3406 warnings are also disabled in the expression that follows
3407 @code{__extension__}.  However, only system header files should use
3408 these escape routes; application programs should avoid them.
3409 @xref{Alternate Keywords}.
3411 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3412 C conformance.  They soon find that it does not do quite what they want:
3413 it finds some non-ISO practices, but not all---only those for which
3414 ISO C @emph{requires} a diagnostic, and some others for which
3415 diagnostics have been added.
3417 A feature to report any failure to conform to ISO C might be useful in
3418 some instances, but would require considerable additional work and would
3419 be quite different from @option{-Wpedantic}.  We don't have plans to
3420 support such a feature in the near future.
3422 Where the standard specified with @option{-std} represents a GNU
3423 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3424 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3425 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3426 where they are required by the base standard.  (It does not make sense
3427 for such warnings to be given only for features not in the specified GNU
3428 C dialect, since by definition the GNU dialects of C include all
3429 features the compiler supports with the given option, and there would be
3430 nothing to warn about.)
3432 @item -pedantic-errors
3433 @opindex pedantic-errors
3434 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3435 requires a diagnostic, in some cases where there is undefined behavior
3436 at compile-time and in some other cases that do not prevent compilation
3437 of programs that are valid according to the standard. This is not
3438 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3439 by this option and not enabled by the latter and vice versa.
3441 @item -Wall
3442 @opindex Wall
3443 @opindex Wno-all
3444 This enables all the warnings about constructions that some users
3445 consider questionable, and that are easy to avoid (or modify to
3446 prevent the warning), even in conjunction with macros.  This also
3447 enables some language-specific warnings described in @ref{C++ Dialect
3448 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3450 @option{-Wall} turns on the following warning flags:
3452 @gccoptlist{-Waddress   @gol
3453 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3454 -Wc++11-compat  -Wc++14-compat@gol
3455 -Wchar-subscripts  @gol
3456 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3457 -Wimplicit-int @r{(C and Objective-C only)} @gol
3458 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3459 -Wbool-compare  @gol
3460 -Wcomment  @gol
3461 -Wformat   @gol
3462 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3463 -Wmaybe-uninitialized @gol
3464 -Wmissing-braces @r{(only for C/ObjC)} @gol
3465 -Wnonnull  @gol
3466 -Wopenmp-simd @gol
3467 -Wparentheses  @gol
3468 -Wpointer-sign  @gol
3469 -Wreorder   @gol
3470 -Wreturn-type  @gol
3471 -Wsequence-point  @gol
3472 -Wsign-compare @r{(only in C++)}  @gol
3473 -Wstrict-aliasing  @gol
3474 -Wstrict-overflow=1  @gol
3475 -Wswitch  @gol
3476 -Wtautological-compare  @gol
3477 -Wtrigraphs  @gol
3478 -Wuninitialized  @gol
3479 -Wunknown-pragmas  @gol
3480 -Wunused-function  @gol
3481 -Wunused-label     @gol
3482 -Wunused-value     @gol
3483 -Wunused-variable  @gol
3484 -Wvolatile-register-var @gol
3487 Note that some warning flags are not implied by @option{-Wall}.  Some of
3488 them warn about constructions that users generally do not consider
3489 questionable, but which occasionally you might wish to check for;
3490 others warn about constructions that are necessary or hard to avoid in
3491 some cases, and there is no simple way to modify the code to suppress
3492 the warning. Some of them are enabled by @option{-Wextra} but many of
3493 them must be enabled individually.
3495 @item -Wextra
3496 @opindex W
3497 @opindex Wextra
3498 @opindex Wno-extra
3499 This enables some extra warning flags that are not enabled by
3500 @option{-Wall}. (This option used to be called @option{-W}.  The older
3501 name is still supported, but the newer name is more descriptive.)
3503 @gccoptlist{-Wclobbered  @gol
3504 -Wempty-body  @gol
3505 -Wignored-qualifiers @gol
3506 -Wmissing-field-initializers  @gol
3507 -Wmissing-parameter-type @r{(C only)}  @gol
3508 -Wold-style-declaration @r{(C only)}  @gol
3509 -Woverride-init  @gol
3510 -Wsign-compare  @gol
3511 -Wtype-limits  @gol
3512 -Wuninitialized  @gol
3513 -Wshift-negative-value  @gol
3514 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3515 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3518 The option @option{-Wextra} also prints warning messages for the
3519 following cases:
3521 @itemize @bullet
3523 @item
3524 A pointer is compared against integer zero with @code{<}, @code{<=},
3525 @code{>}, or @code{>=}.
3527 @item
3528 (C++ only) An enumerator and a non-enumerator both appear in a
3529 conditional expression.
3531 @item
3532 (C++ only) Ambiguous virtual bases.
3534 @item
3535 (C++ only) Subscripting an array that has been declared @code{register}.
3537 @item
3538 (C++ only) Taking the address of a variable that has been declared
3539 @code{register}.
3541 @item
3542 (C++ only) A base class is not initialized in a derived class's copy
3543 constructor.
3545 @end itemize
3547 @item -Wchar-subscripts
3548 @opindex Wchar-subscripts
3549 @opindex Wno-char-subscripts
3550 Warn if an array subscript has type @code{char}.  This is a common cause
3551 of error, as programmers often forget that this type is signed on some
3552 machines.
3553 This warning is enabled by @option{-Wall}.
3555 @item -Wcomment
3556 @opindex Wcomment
3557 @opindex Wno-comment
3558 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3559 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3560 This warning is enabled by @option{-Wall}.
3562 @item -Wno-coverage-mismatch
3563 @opindex Wno-coverage-mismatch
3564 Warn if feedback profiles do not match when using the
3565 @option{-fprofile-use} option.
3566 If a source file is changed between compiling with @option{-fprofile-gen} and
3567 with @option{-fprofile-use}, the files with the profile feedback can fail
3568 to match the source file and GCC cannot use the profile feedback
3569 information.  By default, this warning is enabled and is treated as an
3570 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3571 warning or @option{-Wno-error=coverage-mismatch} can be used to
3572 disable the error.  Disabling the error for this warning can result in
3573 poorly optimized code and is useful only in the
3574 case of very minor changes such as bug fixes to an existing code-base.
3575 Completely disabling the warning is not recommended.
3577 @item -Wno-cpp
3578 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3580 Suppress warning messages emitted by @code{#warning} directives.
3582 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3583 @opindex Wdouble-promotion
3584 @opindex Wno-double-promotion
3585 Give a warning when a value of type @code{float} is implicitly
3586 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3587 floating-point unit implement @code{float} in hardware, but emulate
3588 @code{double} in software.  On such a machine, doing computations
3589 using @code{double} values is much more expensive because of the
3590 overhead required for software emulation.
3592 It is easy to accidentally do computations with @code{double} because
3593 floating-point literals are implicitly of type @code{double}.  For
3594 example, in:
3595 @smallexample
3596 @group
3597 float area(float radius)
3599    return 3.14159 * radius * radius;
3601 @end group
3602 @end smallexample
3603 the compiler performs the entire computation with @code{double}
3604 because the floating-point literal is a @code{double}.
3606 @item -Wformat
3607 @itemx -Wformat=@var{n}
3608 @opindex Wformat
3609 @opindex Wno-format
3610 @opindex ffreestanding
3611 @opindex fno-builtin
3612 @opindex Wformat=
3613 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3614 the arguments supplied have types appropriate to the format string
3615 specified, and that the conversions specified in the format string make
3616 sense.  This includes standard functions, and others specified by format
3617 attributes (@pxref{Function Attributes}), in the @code{printf},
3618 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3619 not in the C standard) families (or other target-specific families).
3620 Which functions are checked without format attributes having been
3621 specified depends on the standard version selected, and such checks of
3622 functions without the attribute specified are disabled by
3623 @option{-ffreestanding} or @option{-fno-builtin}.
3625 The formats are checked against the format features supported by GNU
3626 libc version 2.2.  These include all ISO C90 and C99 features, as well
3627 as features from the Single Unix Specification and some BSD and GNU
3628 extensions.  Other library implementations may not support all these
3629 features; GCC does not support warning about features that go beyond a
3630 particular library's limitations.  However, if @option{-Wpedantic} is used
3631 with @option{-Wformat}, warnings are given about format features not
3632 in the selected standard version (but not for @code{strfmon} formats,
3633 since those are not in any version of the C standard).  @xref{C Dialect
3634 Options,,Options Controlling C Dialect}.
3636 @table @gcctabopt
3637 @item -Wformat=1
3638 @itemx -Wformat
3639 @opindex Wformat
3640 @opindex Wformat=1
3641 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3642 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3643 @option{-Wformat} also checks for null format arguments for several
3644 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3645 aspects of this level of format checking can be disabled by the
3646 options: @option{-Wno-format-contains-nul},
3647 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3648 @option{-Wformat} is enabled by @option{-Wall}.
3650 @item -Wno-format-contains-nul
3651 @opindex Wno-format-contains-nul
3652 @opindex Wformat-contains-nul
3653 If @option{-Wformat} is specified, do not warn about format strings that
3654 contain NUL bytes.
3656 @item -Wno-format-extra-args
3657 @opindex Wno-format-extra-args
3658 @opindex Wformat-extra-args
3659 If @option{-Wformat} is specified, do not warn about excess arguments to a
3660 @code{printf} or @code{scanf} format function.  The C standard specifies
3661 that such arguments are ignored.
3663 Where the unused arguments lie between used arguments that are
3664 specified with @samp{$} operand number specifications, normally
3665 warnings are still given, since the implementation could not know what
3666 type to pass to @code{va_arg} to skip the unused arguments.  However,
3667 in the case of @code{scanf} formats, this option suppresses the
3668 warning if the unused arguments are all pointers, since the Single
3669 Unix Specification says that such unused arguments are allowed.
3671 @item -Wno-format-zero-length
3672 @opindex Wno-format-zero-length
3673 @opindex Wformat-zero-length
3674 If @option{-Wformat} is specified, do not warn about zero-length formats.
3675 The C standard specifies that zero-length formats are allowed.
3678 @item -Wformat=2
3679 @opindex Wformat=2
3680 Enable @option{-Wformat} plus additional format checks.  Currently
3681 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3682 -Wformat-y2k}.
3684 @item -Wformat-nonliteral
3685 @opindex Wformat-nonliteral
3686 @opindex Wno-format-nonliteral
3687 If @option{-Wformat} is specified, also warn if the format string is not a
3688 string literal and so cannot be checked, unless the format function
3689 takes its format arguments as a @code{va_list}.
3691 @item -Wformat-security
3692 @opindex Wformat-security
3693 @opindex Wno-format-security
3694 If @option{-Wformat} is specified, also warn about uses of format
3695 functions that represent possible security problems.  At present, this
3696 warns about calls to @code{printf} and @code{scanf} functions where the
3697 format string is not a string literal and there are no format arguments,
3698 as in @code{printf (foo);}.  This may be a security hole if the format
3699 string came from untrusted input and contains @samp{%n}.  (This is
3700 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3701 in future warnings may be added to @option{-Wformat-security} that are not
3702 included in @option{-Wformat-nonliteral}.)
3704 @item -Wformat-signedness
3705 @opindex Wformat-signedness
3706 @opindex Wno-format-signedness
3707 If @option{-Wformat} is specified, also warn if the format string
3708 requires an unsigned argument and the argument is signed and vice versa.
3710 @item -Wformat-y2k
3711 @opindex Wformat-y2k
3712 @opindex Wno-format-y2k
3713 If @option{-Wformat} is specified, also warn about @code{strftime}
3714 formats that may yield only a two-digit year.
3715 @end table
3717 @item -Wnonnull
3718 @opindex Wnonnull
3719 @opindex Wno-nonnull
3720 Warn about passing a null pointer for arguments marked as
3721 requiring a non-null value by the @code{nonnull} function attribute.
3723 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3724 can be disabled with the @option{-Wno-nonnull} option.
3726 @item -Wnull-dereference
3727 @opindex Wnull-dereference
3728 @opindex Wno-null-dereference
3729 Warn if the compiler detects paths that trigger erroneous or
3730 undefined behavior due to dereferencing a null pointer.  This option
3731 is only active when @option{-fdelete-null-pointer-checks} is active,
3732 which is enabled by optimizations in most targets.  The precision of
3733 the warnings depends on the optimization options used.
3735 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3736 @opindex Winit-self
3737 @opindex Wno-init-self
3738 Warn about uninitialized variables that are initialized with themselves.
3739 Note this option can only be used with the @option{-Wuninitialized} option.
3741 For example, GCC warns about @code{i} being uninitialized in the
3742 following snippet only when @option{-Winit-self} has been specified:
3743 @smallexample
3744 @group
3745 int f()
3747   int i = i;
3748   return i;
3750 @end group
3751 @end smallexample
3753 This warning is enabled by @option{-Wall} in C++.
3755 @item -Wimplicit-int @r{(C and Objective-C only)}
3756 @opindex Wimplicit-int
3757 @opindex Wno-implicit-int
3758 Warn when a declaration does not specify a type.
3759 This warning is enabled by @option{-Wall}.
3761 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3762 @opindex Wimplicit-function-declaration
3763 @opindex Wno-implicit-function-declaration
3764 Give a warning whenever a function is used before being declared. In
3765 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3766 enabled by default and it is made into an error by
3767 @option{-pedantic-errors}. This warning is also enabled by
3768 @option{-Wall}.
3770 @item -Wimplicit @r{(C and Objective-C only)}
3771 @opindex Wimplicit
3772 @opindex Wno-implicit
3773 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3774 This warning is enabled by @option{-Wall}.
3776 @item -Wignored-qualifiers @r{(C and C++ only)}
3777 @opindex Wignored-qualifiers
3778 @opindex Wno-ignored-qualifiers
3779 Warn if the return type of a function has a type qualifier
3780 such as @code{const}.  For ISO C such a type qualifier has no effect,
3781 since the value returned by a function is not an lvalue.
3782 For C++, the warning is only emitted for scalar types or @code{void}.
3783 ISO C prohibits qualified @code{void} return types on function
3784 definitions, so such return types always receive a warning
3785 even without this option.
3787 This warning is also enabled by @option{-Wextra}.
3789 @item -Wmain
3790 @opindex Wmain
3791 @opindex Wno-main
3792 Warn if the type of @code{main} is suspicious.  @code{main} should be
3793 a function with external linkage, returning int, taking either zero
3794 arguments, two, or three arguments of appropriate types.  This warning
3795 is enabled by default in C++ and is enabled by either @option{-Wall}
3796 or @option{-Wpedantic}.
3798 @item -Wmisleading-indentation @r{(C and C++ only)}
3799 @opindex Wmisleading-indentation
3800 @opindex Wno-misleading-indentation
3801 Warn when the indentation of the code does not reflect the block structure.
3802 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
3803 @code{for} clauses with a guarded statement that does not use braces,
3804 followed by an unguarded statement with the same indentation.
3806 This warning is disabled by default.
3808 In the following example, the call to ``bar'' is misleadingly indented as
3809 if it were guarded by the ``if'' conditional.
3811 @smallexample
3812   if (some_condition ())
3813     foo ();
3814     bar ();  /* Gotcha: this is not guarded by the "if".  */
3815 @end smallexample
3817 In the case of mixed tabs and spaces, the warning uses the
3818 @option{-ftabstop=} option to determine if the statements line up
3819 (defaulting to 8).
3821 The warning is not issued for code involving multiline preprocessor logic
3822 such as the following example.
3824 @smallexample
3825   if (flagA)
3826     foo (0);
3827 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
3828   if (flagB)
3829 #endif
3830     foo (1);
3831 @end smallexample
3833 The warning is not issued after a @code{#line} directive, since this
3834 typically indicates autogenerated code, and no assumptions can be made
3835 about the layout of the file that the directive references.
3837 @item -Wmissing-braces
3838 @opindex Wmissing-braces
3839 @opindex Wno-missing-braces
3840 Warn if an aggregate or union initializer is not fully bracketed.  In
3841 the following example, the initializer for @code{a} is not fully
3842 bracketed, but that for @code{b} is fully bracketed.  This warning is
3843 enabled by @option{-Wall} in C.
3845 @smallexample
3846 int a[2][2] = @{ 0, 1, 2, 3 @};
3847 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3848 @end smallexample
3850 This warning is enabled by @option{-Wall}.
3852 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3853 @opindex Wmissing-include-dirs
3854 @opindex Wno-missing-include-dirs
3855 Warn if a user-supplied include directory does not exist.
3857 @item -Wparentheses
3858 @opindex Wparentheses
3859 @opindex Wno-parentheses
3860 Warn if parentheses are omitted in certain contexts, such
3861 as when there is an assignment in a context where a truth value
3862 is expected, or when operators are nested whose precedence people
3863 often get confused about.
3865 Also warn if a comparison like @code{x<=y<=z} appears; this is
3866 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3867 interpretation from that of ordinary mathematical notation.
3869 Also warn about constructions where there may be confusion to which
3870 @code{if} statement an @code{else} branch belongs.  Here is an example of
3871 such a case:
3873 @smallexample
3874 @group
3876   if (a)
3877     if (b)
3878       foo ();
3879   else
3880     bar ();
3882 @end group
3883 @end smallexample
3885 In C/C++, every @code{else} branch belongs to the innermost possible
3886 @code{if} statement, which in this example is @code{if (b)}.  This is
3887 often not what the programmer expected, as illustrated in the above
3888 example by indentation the programmer chose.  When there is the
3889 potential for this confusion, GCC issues a warning when this flag
3890 is specified.  To eliminate the warning, add explicit braces around
3891 the innermost @code{if} statement so there is no way the @code{else}
3892 can belong to the enclosing @code{if}.  The resulting code
3893 looks like this:
3895 @smallexample
3896 @group
3898   if (a)
3899     @{
3900       if (b)
3901         foo ();
3902       else
3903         bar ();
3904     @}
3906 @end group
3907 @end smallexample
3909 Also warn for dangerous uses of the GNU extension to
3910 @code{?:} with omitted middle operand. When the condition
3911 in the @code{?}: operator is a boolean expression, the omitted value is
3912 always 1.  Often programmers expect it to be a value computed
3913 inside the conditional expression instead.
3915 This warning is enabled by @option{-Wall}.
3917 @item -Wsequence-point
3918 @opindex Wsequence-point
3919 @opindex Wno-sequence-point
3920 Warn about code that may have undefined semantics because of violations
3921 of sequence point rules in the C and C++ standards.
3923 The C and C++ standards define the order in which expressions in a C/C++
3924 program are evaluated in terms of @dfn{sequence points}, which represent
3925 a partial ordering between the execution of parts of the program: those
3926 executed before the sequence point, and those executed after it.  These
3927 occur after the evaluation of a full expression (one which is not part
3928 of a larger expression), after the evaluation of the first operand of a
3929 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3930 function is called (but after the evaluation of its arguments and the
3931 expression denoting the called function), and in certain other places.
3932 Other than as expressed by the sequence point rules, the order of
3933 evaluation of subexpressions of an expression is not specified.  All
3934 these rules describe only a partial order rather than a total order,
3935 since, for example, if two functions are called within one expression
3936 with no sequence point between them, the order in which the functions
3937 are called is not specified.  However, the standards committee have
3938 ruled that function calls do not overlap.
3940 It is not specified when between sequence points modifications to the
3941 values of objects take effect.  Programs whose behavior depends on this
3942 have undefined behavior; the C and C++ standards specify that ``Between
3943 the previous and next sequence point an object shall have its stored
3944 value modified at most once by the evaluation of an expression.
3945 Furthermore, the prior value shall be read only to determine the value
3946 to be stored.''.  If a program breaks these rules, the results on any
3947 particular implementation are entirely unpredictable.
3949 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3950 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3951 diagnosed by this option, and it may give an occasional false positive
3952 result, but in general it has been found fairly effective at detecting
3953 this sort of problem in programs.
3955 The standard is worded confusingly, therefore there is some debate
3956 over the precise meaning of the sequence point rules in subtle cases.
3957 Links to discussions of the problem, including proposed formal
3958 definitions, may be found on the GCC readings page, at
3959 @uref{http://gcc.gnu.org/@/readings.html}.
3961 This warning is enabled by @option{-Wall} for C and C++.
3963 @item -Wno-return-local-addr
3964 @opindex Wno-return-local-addr
3965 @opindex Wreturn-local-addr
3966 Do not warn about returning a pointer (or in C++, a reference) to a
3967 variable that goes out of scope after the function returns.
3969 @item -Wreturn-type
3970 @opindex Wreturn-type
3971 @opindex Wno-return-type
3972 Warn whenever a function is defined with a return type that defaults
3973 to @code{int}.  Also warn about any @code{return} statement with no
3974 return value in a function whose return type is not @code{void}
3975 (falling off the end of the function body is considered returning
3976 without a value), and about a @code{return} statement with an
3977 expression in a function whose return type is @code{void}.
3979 For C++, a function without return type always produces a diagnostic
3980 message, even when @option{-Wno-return-type} is specified.  The only
3981 exceptions are @code{main} and functions defined in system headers.
3983 This warning is enabled by @option{-Wall}.
3985 @item -Wshift-count-negative
3986 @opindex Wshift-count-negative
3987 @opindex Wno-shift-count-negative
3988 Warn if shift count is negative. This warning is enabled by default.
3990 @item -Wshift-count-overflow
3991 @opindex Wshift-count-overflow
3992 @opindex Wno-shift-count-overflow
3993 Warn if shift count >= width of type. This warning is enabled by default.
3995 @item -Wshift-negative-value
3996 @opindex Wshift-negative-value
3997 @opindex Wno-shift-negative-value
3998 Warn if left shifting a negative value.  This warning is enabled by
3999 @option{-Wextra} in C99 and C++11 modes (and newer).
4001 @item -Wshift-overflow
4002 @itemx -Wshift-overflow=@var{n}
4003 @opindex Wshift-overflow
4004 @opindex Wno-shift-overflow
4005 Warn about left shift overflows.  This warning is enabled by
4006 default in C99 and C++11 modes (and newer).
4008 @table @gcctabopt
4009 @item -Wshift-overflow=1
4010 This is the warning level of @option{-Wshift-overflow} and is enabled
4011 by default in C99 and C++11 modes (and newer).  This warning level does
4012 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4013 an overflow is still rejected in contexts where an integer constant expression
4014 is required.)
4016 @item -Wshift-overflow=2
4017 This warning level also warns about left-shifting 1 into the sign bit,
4018 unless C++14 mode is active.
4019 @end table
4021 @item -Wswitch
4022 @opindex Wswitch
4023 @opindex Wno-switch
4024 Warn whenever a @code{switch} statement has an index of enumerated type
4025 and lacks a @code{case} for one or more of the named codes of that
4026 enumeration.  (The presence of a @code{default} label prevents this
4027 warning.)  @code{case} labels outside the enumeration range also
4028 provoke warnings when this option is used (even if there is a
4029 @code{default} label).
4030 This warning is enabled by @option{-Wall}.
4032 @item -Wswitch-default
4033 @opindex Wswitch-default
4034 @opindex Wno-switch-default
4035 Warn whenever a @code{switch} statement does not have a @code{default}
4036 case.
4038 @item -Wswitch-enum
4039 @opindex Wswitch-enum
4040 @opindex Wno-switch-enum
4041 Warn whenever a @code{switch} statement has an index of enumerated type
4042 and lacks a @code{case} for one or more of the named codes of that
4043 enumeration.  @code{case} labels outside the enumeration range also
4044 provoke warnings when this option is used.  The only difference
4045 between @option{-Wswitch} and this option is that this option gives a
4046 warning about an omitted enumeration code even if there is a
4047 @code{default} label.
4049 @item -Wswitch-bool
4050 @opindex Wswitch-bool
4051 @opindex Wno-switch-bool
4052 Warn whenever a @code{switch} statement has an index of boolean type
4053 and the case values are outside the range of a boolean type.
4054 It is possible to suppress this warning by casting the controlling
4055 expression to a type other than @code{bool}.  For example:
4056 @smallexample
4057 @group
4058 switch ((int) (a == 4))
4059   @{
4060   @dots{}
4061   @}
4062 @end group
4063 @end smallexample
4064 This warning is enabled by default for C and C++ programs.
4066 @item -Wsync-nand @r{(C and C++ only)}
4067 @opindex Wsync-nand
4068 @opindex Wno-sync-nand
4069 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4070 built-in functions are used.  These functions changed semantics in GCC 4.4.
4072 @item -Wtrigraphs
4073 @opindex Wtrigraphs
4074 @opindex Wno-trigraphs
4075 Warn if any trigraphs are encountered that might change the meaning of
4076 the program (trigraphs within comments are not warned about).
4077 This warning is enabled by @option{-Wall}.
4079 @item -Wunused-but-set-parameter
4080 @opindex Wunused-but-set-parameter
4081 @opindex Wno-unused-but-set-parameter
4082 Warn whenever a function parameter is assigned to, but otherwise unused
4083 (aside from its declaration).
4085 To suppress this warning use the @code{unused} attribute
4086 (@pxref{Variable Attributes}).
4088 This warning is also enabled by @option{-Wunused} together with
4089 @option{-Wextra}.
4091 @item -Wunused-but-set-variable
4092 @opindex Wunused-but-set-variable
4093 @opindex Wno-unused-but-set-variable
4094 Warn whenever a local variable is assigned to, but otherwise unused
4095 (aside from its declaration).
4096 This warning is enabled by @option{-Wall}.
4098 To suppress this warning use the @code{unused} attribute
4099 (@pxref{Variable Attributes}).
4101 This warning is also enabled by @option{-Wunused}, which is enabled
4102 by @option{-Wall}.
4104 @item -Wunused-function
4105 @opindex Wunused-function
4106 @opindex Wno-unused-function
4107 Warn whenever a static function is declared but not defined or a
4108 non-inline static function is unused.
4109 This warning is enabled by @option{-Wall}.
4111 @item -Wunused-label
4112 @opindex Wunused-label
4113 @opindex Wno-unused-label
4114 Warn whenever a label is declared but not used.
4115 This warning is enabled by @option{-Wall}.
4117 To suppress this warning use the @code{unused} attribute
4118 (@pxref{Variable Attributes}).
4120 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4121 @opindex Wunused-local-typedefs
4122 Warn when a typedef locally defined in a function is not used.
4123 This warning is enabled by @option{-Wall}.
4125 @item -Wunused-parameter
4126 @opindex Wunused-parameter
4127 @opindex Wno-unused-parameter
4128 Warn whenever a function parameter is unused aside from its declaration.
4130 To suppress this warning use the @code{unused} attribute
4131 (@pxref{Variable Attributes}).
4133 @item -Wno-unused-result
4134 @opindex Wunused-result
4135 @opindex Wno-unused-result
4136 Do not warn if a caller of a function marked with attribute
4137 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4138 its return value. The default is @option{-Wunused-result}.
4140 @item -Wunused-variable
4141 @opindex Wunused-variable
4142 @opindex Wno-unused-variable
4143 Warn whenever a local variable or non-constant static variable is unused
4144 aside from its declaration.
4145 This warning is enabled by @option{-Wall}.
4147 To suppress this warning use the @code{unused} attribute
4148 (@pxref{Variable Attributes}).
4150 @item -Wunused-value
4151 @opindex Wunused-value
4152 @opindex Wno-unused-value
4153 Warn whenever a statement computes a result that is explicitly not
4154 used. To suppress this warning cast the unused expression to
4155 @code{void}. This includes an expression-statement or the left-hand
4156 side of a comma expression that contains no side effects. For example,
4157 an expression such as @code{x[i,j]} causes a warning, while
4158 @code{x[(void)i,j]} does not.
4160 This warning is enabled by @option{-Wall}.
4162 @item -Wunused
4163 @opindex Wunused
4164 @opindex Wno-unused
4165 All the above @option{-Wunused} options combined.
4167 In order to get a warning about an unused function parameter, you must
4168 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4169 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4171 @item -Wuninitialized
4172 @opindex Wuninitialized
4173 @opindex Wno-uninitialized
4174 Warn if an automatic variable is used without first being initialized
4175 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4176 warn if a non-static reference or non-static @code{const} member
4177 appears in a class without constructors.
4179 If you want to warn about code that uses the uninitialized value of the
4180 variable in its own initializer, use the @option{-Winit-self} option.
4182 These warnings occur for individual uninitialized or clobbered
4183 elements of structure, union or array variables as well as for
4184 variables that are uninitialized or clobbered as a whole.  They do
4185 not occur for variables or elements declared @code{volatile}.  Because
4186 these warnings depend on optimization, the exact variables or elements
4187 for which there are warnings depends on the precise optimization
4188 options and version of GCC used.
4190 Note that there may be no warning about a variable that is used only
4191 to compute a value that itself is never used, because such
4192 computations may be deleted by data flow analysis before the warnings
4193 are printed.
4195 @item -Wmaybe-uninitialized
4196 @opindex Wmaybe-uninitialized
4197 @opindex Wno-maybe-uninitialized
4198 For an automatic variable, if there exists a path from the function
4199 entry to a use of the variable that is initialized, but there exist
4200 some other paths for which the variable is not initialized, the compiler
4201 emits a warning if it cannot prove the uninitialized paths are not
4202 executed at run time. These warnings are made optional because GCC is
4203 not smart enough to see all the reasons why the code might be correct
4204 in spite of appearing to have an error.  Here is one example of how
4205 this can happen:
4207 @smallexample
4208 @group
4210   int x;
4211   switch (y)
4212     @{
4213     case 1: x = 1;
4214       break;
4215     case 2: x = 4;
4216       break;
4217     case 3: x = 5;
4218     @}
4219   foo (x);
4221 @end group
4222 @end smallexample
4224 @noindent
4225 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4226 always initialized, but GCC doesn't know this. To suppress the
4227 warning, you need to provide a default case with assert(0) or
4228 similar code.
4230 @cindex @code{longjmp} warnings
4231 This option also warns when a non-volatile automatic variable might be
4232 changed by a call to @code{longjmp}.  These warnings as well are possible
4233 only in optimizing compilation.
4235 The compiler sees only the calls to @code{setjmp}.  It cannot know
4236 where @code{longjmp} will be called; in fact, a signal handler could
4237 call it at any point in the code.  As a result, you may get a warning
4238 even when there is in fact no problem because @code{longjmp} cannot
4239 in fact be called at the place that would cause a problem.
4241 Some spurious warnings can be avoided if you declare all the functions
4242 you use that never return as @code{noreturn}.  @xref{Function
4243 Attributes}.
4245 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4247 @item -Wunknown-pragmas
4248 @opindex Wunknown-pragmas
4249 @opindex Wno-unknown-pragmas
4250 @cindex warning for unknown pragmas
4251 @cindex unknown pragmas, warning
4252 @cindex pragmas, warning of unknown
4253 Warn when a @code{#pragma} directive is encountered that is not understood by 
4254 GCC@.  If this command-line option is used, warnings are even issued
4255 for unknown pragmas in system header files.  This is not the case if
4256 the warnings are only enabled by the @option{-Wall} command-line option.
4258 @item -Wno-pragmas
4259 @opindex Wno-pragmas
4260 @opindex Wpragmas
4261 Do not warn about misuses of pragmas, such as incorrect parameters,
4262 invalid syntax, or conflicts between pragmas.  See also
4263 @option{-Wunknown-pragmas}.
4265 @item -Wstrict-aliasing
4266 @opindex Wstrict-aliasing
4267 @opindex Wno-strict-aliasing
4268 This option is only active when @option{-fstrict-aliasing} is active.
4269 It warns about code that might break the strict aliasing rules that the
4270 compiler is using for optimization.  The warning does not catch all
4271 cases, but does attempt to catch the more common pitfalls.  It is
4272 included in @option{-Wall}.
4273 It is equivalent to @option{-Wstrict-aliasing=3}
4275 @item -Wstrict-aliasing=n
4276 @opindex Wstrict-aliasing=n
4277 This option is only active when @option{-fstrict-aliasing} is active.
4278 It warns about code that might break the strict aliasing rules that the
4279 compiler is using for optimization.
4280 Higher levels correspond to higher accuracy (fewer false positives).
4281 Higher levels also correspond to more effort, similar to the way @option{-O} 
4282 works.
4283 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4285 Level 1: Most aggressive, quick, least accurate.
4286 Possibly useful when higher levels
4287 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4288 false negatives.  However, it has many false positives.
4289 Warns for all pointer conversions between possibly incompatible types,
4290 even if never dereferenced.  Runs in the front end only.
4292 Level 2: Aggressive, quick, not too precise.
4293 May still have many false positives (not as many as level 1 though),
4294 and few false negatives (but possibly more than level 1).
4295 Unlike level 1, it only warns when an address is taken.  Warns about
4296 incomplete types.  Runs in the front end only.
4298 Level 3 (default for @option{-Wstrict-aliasing}):
4299 Should have very few false positives and few false
4300 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4301 Takes care of the common pun+dereference pattern in the front end:
4302 @code{*(int*)&some_float}.
4303 If optimization is enabled, it also runs in the back end, where it deals
4304 with multiple statement cases using flow-sensitive points-to information.
4305 Only warns when the converted pointer is dereferenced.
4306 Does not warn about incomplete types.
4308 @item -Wstrict-overflow
4309 @itemx -Wstrict-overflow=@var{n}
4310 @opindex Wstrict-overflow
4311 @opindex Wno-strict-overflow
4312 This option is only active when @option{-fstrict-overflow} is active.
4313 It warns about cases where the compiler optimizes based on the
4314 assumption that signed overflow does not occur.  Note that it does not
4315 warn about all cases where the code might overflow: it only warns
4316 about cases where the compiler implements some optimization.  Thus
4317 this warning depends on the optimization level.
4319 An optimization that assumes that signed overflow does not occur is
4320 perfectly safe if the values of the variables involved are such that
4321 overflow never does, in fact, occur.  Therefore this warning can
4322 easily give a false positive: a warning about code that is not
4323 actually a problem.  To help focus on important issues, several
4324 warning levels are defined.  No warnings are issued for the use of
4325 undefined signed overflow when estimating how many iterations a loop
4326 requires, in particular when determining whether a loop will be
4327 executed at all.
4329 @table @gcctabopt
4330 @item -Wstrict-overflow=1
4331 Warn about cases that are both questionable and easy to avoid.  For
4332 example,  with @option{-fstrict-overflow}, the compiler simplifies
4333 @code{x + 1 > x} to @code{1}.  This level of
4334 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4335 are not, and must be explicitly requested.
4337 @item -Wstrict-overflow=2
4338 Also warn about other cases where a comparison is simplified to a
4339 constant.  For example: @code{abs (x) >= 0}.  This can only be
4340 simplified when @option{-fstrict-overflow} is in effect, because
4341 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4342 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4343 @option{-Wstrict-overflow=2}.
4345 @item -Wstrict-overflow=3
4346 Also warn about other cases where a comparison is simplified.  For
4347 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4349 @item -Wstrict-overflow=4
4350 Also warn about other simplifications not covered by the above cases.
4351 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4353 @item -Wstrict-overflow=5
4354 Also warn about cases where the compiler reduces the magnitude of a
4355 constant involved in a comparison.  For example: @code{x + 2 > y} is
4356 simplified to @code{x + 1 >= y}.  This is reported only at the
4357 highest warning level because this simplification applies to many
4358 comparisons, so this warning level gives a very large number of
4359 false positives.
4360 @end table
4362 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4363 @opindex Wsuggest-attribute=
4364 @opindex Wno-suggest-attribute=
4365 Warn for cases where adding an attribute may be beneficial. The
4366 attributes currently supported are listed below.
4368 @table @gcctabopt
4369 @item -Wsuggest-attribute=pure
4370 @itemx -Wsuggest-attribute=const
4371 @itemx -Wsuggest-attribute=noreturn
4372 @opindex Wsuggest-attribute=pure
4373 @opindex Wno-suggest-attribute=pure
4374 @opindex Wsuggest-attribute=const
4375 @opindex Wno-suggest-attribute=const
4376 @opindex Wsuggest-attribute=noreturn
4377 @opindex Wno-suggest-attribute=noreturn
4379 Warn about functions that might be candidates for attributes
4380 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4381 functions visible in other compilation units or (in the case of @code{pure} and
4382 @code{const}) if it cannot prove that the function returns normally. A function
4383 returns normally if it doesn't contain an infinite loop or return abnormally
4384 by throwing, calling @code{abort} or trapping.  This analysis requires option
4385 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4386 higher.  Higher optimization levels improve the accuracy of the analysis.
4388 @item -Wsuggest-attribute=format
4389 @itemx -Wmissing-format-attribute
4390 @opindex Wsuggest-attribute=format
4391 @opindex Wmissing-format-attribute
4392 @opindex Wno-suggest-attribute=format
4393 @opindex Wno-missing-format-attribute
4394 @opindex Wformat
4395 @opindex Wno-format
4397 Warn about function pointers that might be candidates for @code{format}
4398 attributes.  Note these are only possible candidates, not absolute ones.
4399 GCC guesses that function pointers with @code{format} attributes that
4400 are used in assignment, initialization, parameter passing or return
4401 statements should have a corresponding @code{format} attribute in the
4402 resulting type.  I.e.@: the left-hand side of the assignment or
4403 initialization, the type of the parameter variable, or the return type
4404 of the containing function respectively should also have a @code{format}
4405 attribute to avoid the warning.
4407 GCC also warns about function definitions that might be
4408 candidates for @code{format} attributes.  Again, these are only
4409 possible candidates.  GCC guesses that @code{format} attributes
4410 might be appropriate for any function that calls a function like
4411 @code{vprintf} or @code{vscanf}, but this might not always be the
4412 case, and some functions for which @code{format} attributes are
4413 appropriate may not be detected.
4414 @end table
4416 @item -Wsuggest-final-types
4417 @opindex Wno-suggest-final-types
4418 @opindex Wsuggest-final-types
4419 Warn about types with virtual methods where code quality would be improved
4420 if the type were declared with the C++11 @code{final} specifier, 
4421 or, if possible,
4422 declared in an anonymous namespace. This allows GCC to more aggressively
4423 devirtualize the polymorphic calls. This warning is more effective with link
4424 time optimization, where the information about the class hierarchy graph is
4425 more complete.
4427 @item -Wsuggest-final-methods
4428 @opindex Wno-suggest-final-methods
4429 @opindex Wsuggest-final-methods
4430 Warn about virtual methods where code quality would be improved if the method
4431 were declared with the C++11 @code{final} specifier, 
4432 or, if possible, its type were
4433 declared in an anonymous namespace or with the @code{final} specifier.
4434 This warning is
4435 more effective with link time optimization, where the information about the
4436 class hierarchy graph is more complete. It is recommended to first consider
4437 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4438 annotations.
4440 @item -Wsuggest-override
4441 Warn about overriding virtual functions that are not marked with the override
4442 keyword.
4444 @item -Warray-bounds
4445 @itemx -Warray-bounds=@var{n}
4446 @opindex Wno-array-bounds
4447 @opindex Warray-bounds
4448 This option is only active when @option{-ftree-vrp} is active
4449 (default for @option{-O2} and above). It warns about subscripts to arrays
4450 that are always out of bounds. This warning is enabled by @option{-Wall}.
4452 @table @gcctabopt
4453 @item -Warray-bounds=1
4454 This is the warning level of @option{-Warray-bounds} and is enabled
4455 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4457 @item -Warray-bounds=2
4458 This warning level also warns about out of bounds access for
4459 arrays at the end of a struct and for arrays accessed through
4460 pointers. This warning level may give a larger number of
4461 false positives and is deactivated by default.
4462 @end table
4464 @item -Wbool-compare
4465 @opindex Wno-bool-compare
4466 @opindex Wbool-compare
4467 Warn about boolean expression compared with an integer value different from
4468 @code{true}/@code{false}.  For instance, the following comparison is
4469 always false:
4470 @smallexample
4471 int n = 5;
4472 @dots{}
4473 if ((n > 1) == 2) @{ @dots{} @}
4474 @end smallexample
4475 This warning is enabled by @option{-Wall}.
4477 @item -Wframe-address
4478 @opindex Wno-frame-address
4479 @opindex Wframe-address
4480 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
4481 is called with an argument greater than 0.  Such calls may return indeterminate
4482 values or crash the program.  The warning is included in @option{-Wall}.
4484 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4485 @opindex Wno-discarded-qualifiers
4486 @opindex Wdiscarded-qualifiers
4487 Do not warn if type qualifiers on pointers are being discarded.
4488 Typically, the compiler warns if a @code{const char *} variable is
4489 passed to a function that takes a @code{char *} parameter.  This option
4490 can be used to suppress such a warning.
4492 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4493 @opindex Wno-discarded-array-qualifiers
4494 @opindex Wdiscarded-array-qualifiers
4495 Do not warn if type qualifiers on arrays which are pointer targets
4496 are being discarded. Typically, the compiler warns if a
4497 @code{const int (*)[]} variable is passed to a function that
4498 takes a @code{int (*)[]} parameter.  This option can be used to
4499 suppress such a warning.
4501 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4502 @opindex Wno-incompatible-pointer-types
4503 @opindex Wincompatible-pointer-types
4504 Do not warn when there is a conversion between pointers that have incompatible
4505 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4506 which warns for pointer argument passing or assignment with different
4507 signedness.
4509 @item -Wno-int-conversion @r{(C and Objective-C only)}
4510 @opindex Wno-int-conversion
4511 @opindex Wint-conversion
4512 Do not warn about incompatible integer to pointer and pointer to integer
4513 conversions.  This warning is about implicit conversions; for explicit
4514 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4515 @option{-Wno-pointer-to-int-cast} may be used.
4517 @item -Wno-div-by-zero
4518 @opindex Wno-div-by-zero
4519 @opindex Wdiv-by-zero
4520 Do not warn about compile-time integer division by zero.  Floating-point
4521 division by zero is not warned about, as it can be a legitimate way of
4522 obtaining infinities and NaNs.
4524 @item -Wsystem-headers
4525 @opindex Wsystem-headers
4526 @opindex Wno-system-headers
4527 @cindex warnings from system headers
4528 @cindex system headers, warnings from
4529 Print warning messages for constructs found in system header files.
4530 Warnings from system headers are normally suppressed, on the assumption
4531 that they usually do not indicate real problems and would only make the
4532 compiler output harder to read.  Using this command-line option tells
4533 GCC to emit warnings from system headers as if they occurred in user
4534 code.  However, note that using @option{-Wall} in conjunction with this
4535 option does @emph{not} warn about unknown pragmas in system
4536 headers---for that, @option{-Wunknown-pragmas} must also be used.
4538 @item -Wtautological-compare
4539 @opindex Wtautological-compare
4540 @opindex Wno-tautological-compare
4541 Warn if a self-comparison always evaluates to true or false.  This
4542 warning detects various mistakes such as:
4543 @smallexample
4544 int i = 1;
4545 @dots{}
4546 if (i > i) @{ @dots{} @}
4547 @end smallexample
4548 This warning is enabled by @option{-Wall}.
4550 @item -Wtrampolines
4551 @opindex Wtrampolines
4552 @opindex Wno-trampolines
4553 Warn about trampolines generated for pointers to nested functions.
4554 A trampoline is a small piece of data or code that is created at run
4555 time on the stack when the address of a nested function is taken, and is
4556 used to call the nested function indirectly.  For some targets, it is
4557 made up of data only and thus requires no special treatment.  But, for
4558 most targets, it is made up of code and thus requires the stack to be
4559 made executable in order for the program to work properly.
4561 @item -Wfloat-equal
4562 @opindex Wfloat-equal
4563 @opindex Wno-float-equal
4564 Warn if floating-point values are used in equality comparisons.
4566 The idea behind this is that sometimes it is convenient (for the
4567 programmer) to consider floating-point values as approximations to
4568 infinitely precise real numbers.  If you are doing this, then you need
4569 to compute (by analyzing the code, or in some other way) the maximum or
4570 likely maximum error that the computation introduces, and allow for it
4571 when performing comparisons (and when producing output, but that's a
4572 different problem).  In particular, instead of testing for equality, you
4573 should check to see whether the two values have ranges that overlap; and
4574 this is done with the relational operators, so equality comparisons are
4575 probably mistaken.
4577 @item -Wtraditional @r{(C and Objective-C only)}
4578 @opindex Wtraditional
4579 @opindex Wno-traditional
4580 Warn about certain constructs that behave differently in traditional and
4581 ISO C@.  Also warn about ISO C constructs that have no traditional C
4582 equivalent, and/or problematic constructs that should be avoided.
4584 @itemize @bullet
4585 @item
4586 Macro parameters that appear within string literals in the macro body.
4587 In traditional C macro replacement takes place within string literals,
4588 but in ISO C it does not.
4590 @item
4591 In traditional C, some preprocessor directives did not exist.
4592 Traditional preprocessors only considered a line to be a directive
4593 if the @samp{#} appeared in column 1 on the line.  Therefore
4594 @option{-Wtraditional} warns about directives that traditional C
4595 understands but ignores because the @samp{#} does not appear as the
4596 first character on the line.  It also suggests you hide directives like
4597 @code{#pragma} not understood by traditional C by indenting them.  Some
4598 traditional implementations do not recognize @code{#elif}, so this option
4599 suggests avoiding it altogether.
4601 @item
4602 A function-like macro that appears without arguments.
4604 @item
4605 The unary plus operator.
4607 @item
4608 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4609 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4610 constants.)  Note, these suffixes appear in macros defined in the system
4611 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4612 Use of these macros in user code might normally lead to spurious
4613 warnings, however GCC's integrated preprocessor has enough context to
4614 avoid warning in these cases.
4616 @item
4617 A function declared external in one block and then used after the end of
4618 the block.
4620 @item
4621 A @code{switch} statement has an operand of type @code{long}.
4623 @item
4624 A non-@code{static} function declaration follows a @code{static} one.
4625 This construct is not accepted by some traditional C compilers.
4627 @item
4628 The ISO type of an integer constant has a different width or
4629 signedness from its traditional type.  This warning is only issued if
4630 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4631 typically represent bit patterns, are not warned about.
4633 @item
4634 Usage of ISO string concatenation is detected.
4636 @item
4637 Initialization of automatic aggregates.
4639 @item
4640 Identifier conflicts with labels.  Traditional C lacks a separate
4641 namespace for labels.
4643 @item
4644 Initialization of unions.  If the initializer is zero, the warning is
4645 omitted.  This is done under the assumption that the zero initializer in
4646 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4647 initializer warnings and relies on default initialization to zero in the
4648 traditional C case.
4650 @item
4651 Conversions by prototypes between fixed/floating-point values and vice
4652 versa.  The absence of these prototypes when compiling with traditional
4653 C causes serious problems.  This is a subset of the possible
4654 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4656 @item
4657 Use of ISO C style function definitions.  This warning intentionally is
4658 @emph{not} issued for prototype declarations or variadic functions
4659 because these ISO C features appear in your code when using
4660 libiberty's traditional C compatibility macros, @code{PARAMS} and
4661 @code{VPARAMS}.  This warning is also bypassed for nested functions
4662 because that feature is already a GCC extension and thus not relevant to
4663 traditional C compatibility.
4664 @end itemize
4666 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4667 @opindex Wtraditional-conversion
4668 @opindex Wno-traditional-conversion
4669 Warn if a prototype causes a type conversion that is different from what
4670 would happen to the same argument in the absence of a prototype.  This
4671 includes conversions of fixed point to floating and vice versa, and
4672 conversions changing the width or signedness of a fixed-point argument
4673 except when the same as the default promotion.
4675 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4676 @opindex Wdeclaration-after-statement
4677 @opindex Wno-declaration-after-statement
4678 Warn when a declaration is found after a statement in a block.  This
4679 construct, known from C++, was introduced with ISO C99 and is by default
4680 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4682 @item -Wundef
4683 @opindex Wundef
4684 @opindex Wno-undef
4685 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4687 @item -Wno-endif-labels
4688 @opindex Wno-endif-labels
4689 @opindex Wendif-labels
4690 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4692 @item -Wshadow
4693 @opindex Wshadow
4694 @opindex Wno-shadow
4695 Warn whenever a local variable or type declaration shadows another
4696 variable, parameter, type, class member (in C++), or instance variable
4697 (in Objective-C) or whenever a built-in function is shadowed. Note
4698 that in C++, the compiler warns if a local variable shadows an
4699 explicit typedef, but not if it shadows a struct/class/enum.
4701 @item -Wno-shadow-ivar @r{(Objective-C only)}
4702 @opindex Wno-shadow-ivar
4703 @opindex Wshadow-ivar
4704 Do not warn whenever a local variable shadows an instance variable in an
4705 Objective-C method.
4707 @item -Wlarger-than=@var{len}
4708 @opindex Wlarger-than=@var{len}
4709 @opindex Wlarger-than-@var{len}
4710 Warn whenever an object of larger than @var{len} bytes is defined.
4712 @item -Wframe-larger-than=@var{len}
4713 @opindex Wframe-larger-than
4714 Warn if the size of a function frame is larger than @var{len} bytes.
4715 The computation done to determine the stack frame size is approximate
4716 and not conservative.
4717 The actual requirements may be somewhat greater than @var{len}
4718 even if you do not get a warning.  In addition, any space allocated
4719 via @code{alloca}, variable-length arrays, or related constructs
4720 is not included by the compiler when determining
4721 whether or not to issue a warning.
4723 @item -Wno-free-nonheap-object
4724 @opindex Wno-free-nonheap-object
4725 @opindex Wfree-nonheap-object
4726 Do not warn when attempting to free an object that was not allocated
4727 on the heap.
4729 @item -Wstack-usage=@var{len}
4730 @opindex Wstack-usage
4731 Warn if the stack usage of a function might be larger than @var{len} bytes.
4732 The computation done to determine the stack usage is conservative.
4733 Any space allocated via @code{alloca}, variable-length arrays, or related
4734 constructs is included by the compiler when determining whether or not to
4735 issue a warning.
4737 The message is in keeping with the output of @option{-fstack-usage}.
4739 @itemize
4740 @item
4741 If the stack usage is fully static but exceeds the specified amount, it's:
4743 @smallexample
4744   warning: stack usage is 1120 bytes
4745 @end smallexample
4746 @item
4747 If the stack usage is (partly) dynamic but bounded, it's:
4749 @smallexample
4750   warning: stack usage might be 1648 bytes
4751 @end smallexample
4752 @item
4753 If the stack usage is (partly) dynamic and not bounded, it's:
4755 @smallexample
4756   warning: stack usage might be unbounded
4757 @end smallexample
4758 @end itemize
4760 @item -Wunsafe-loop-optimizations
4761 @opindex Wunsafe-loop-optimizations
4762 @opindex Wno-unsafe-loop-optimizations
4763 Warn if the loop cannot be optimized because the compiler cannot
4764 assume anything on the bounds of the loop indices.  With
4765 @option{-funsafe-loop-optimizations} warn if the compiler makes
4766 such assumptions.
4768 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4769 @opindex Wno-pedantic-ms-format
4770 @opindex Wpedantic-ms-format
4771 When used in combination with @option{-Wformat}
4772 and @option{-pedantic} without GNU extensions, this option
4773 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4774 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4775 which depend on the MS runtime.
4777 @item -Wpointer-arith
4778 @opindex Wpointer-arith
4779 @opindex Wno-pointer-arith
4780 Warn about anything that depends on the ``size of'' a function type or
4781 of @code{void}.  GNU C assigns these types a size of 1, for
4782 convenience in calculations with @code{void *} pointers and pointers
4783 to functions.  In C++, warn also when an arithmetic operation involves
4784 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4786 @item -Wtype-limits
4787 @opindex Wtype-limits
4788 @opindex Wno-type-limits
4789 Warn if a comparison is always true or always false due to the limited
4790 range of the data type, but do not warn for constant expressions.  For
4791 example, warn if an unsigned variable is compared against zero with
4792 @code{<} or @code{>=}.  This warning is also enabled by
4793 @option{-Wextra}.
4795 @item -Wbad-function-cast @r{(C and Objective-C only)}
4796 @opindex Wbad-function-cast
4797 @opindex Wno-bad-function-cast
4798 Warn when a function call is cast to a non-matching type.
4799 For example, warn if a call to a function returning an integer type 
4800 is cast to a pointer type.
4802 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4803 @opindex Wc90-c99-compat
4804 @opindex Wno-c90-c99-compat
4805 Warn about features not present in ISO C90, but present in ISO C99.
4806 For instance, warn about use of variable length arrays, @code{long long}
4807 type, @code{bool} type, compound literals, designated initializers, and so
4808 on.  This option is independent of the standards mode.  Warnings are disabled
4809 in the expression that follows @code{__extension__}.
4811 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4812 @opindex Wc99-c11-compat
4813 @opindex Wno-c99-c11-compat
4814 Warn about features not present in ISO C99, but present in ISO C11.
4815 For instance, warn about use of anonymous structures and unions,
4816 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4817 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4818 and so on.  This option is independent of the standards mode.  Warnings are
4819 disabled in the expression that follows @code{__extension__}.
4821 @item -Wc++-compat @r{(C and Objective-C only)}
4822 @opindex Wc++-compat
4823 Warn about ISO C constructs that are outside of the common subset of
4824 ISO C and ISO C++, e.g.@: request for implicit conversion from
4825 @code{void *} to a pointer to non-@code{void} type.
4827 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4828 @opindex Wc++11-compat
4829 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4830 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4831 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4832 enabled by @option{-Wall}.
4834 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4835 @opindex Wc++14-compat
4836 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4837 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4839 @item -Wcast-qual
4840 @opindex Wcast-qual
4841 @opindex Wno-cast-qual
4842 Warn whenever a pointer is cast so as to remove a type qualifier from
4843 the target type.  For example, warn if a @code{const char *} is cast
4844 to an ordinary @code{char *}.
4846 Also warn when making a cast that introduces a type qualifier in an
4847 unsafe way.  For example, casting @code{char **} to @code{const char **}
4848 is unsafe, as in this example:
4850 @smallexample
4851   /* p is char ** value.  */
4852   const char **q = (const char **) p;
4853   /* Assignment of readonly string to const char * is OK.  */
4854   *q = "string";
4855   /* Now char** pointer points to read-only memory.  */
4856   **p = 'b';
4857 @end smallexample
4859 @item -Wcast-align
4860 @opindex Wcast-align
4861 @opindex Wno-cast-align
4862 Warn whenever a pointer is cast such that the required alignment of the
4863 target is increased.  For example, warn if a @code{char *} is cast to
4864 an @code{int *} on machines where integers can only be accessed at
4865 two- or four-byte boundaries.
4867 @item -Wwrite-strings
4868 @opindex Wwrite-strings
4869 @opindex Wno-write-strings
4870 When compiling C, give string constants the type @code{const
4871 char[@var{length}]} so that copying the address of one into a
4872 non-@code{const} @code{char *} pointer produces a warning.  These
4873 warnings help you find at compile time code that can try to write
4874 into a string constant, but only if you have been very careful about
4875 using @code{const} in declarations and prototypes.  Otherwise, it is
4876 just a nuisance. This is why we did not make @option{-Wall} request
4877 these warnings.
4879 When compiling C++, warn about the deprecated conversion from string
4880 literals to @code{char *}.  This warning is enabled by default for C++
4881 programs.
4883 @item -Wclobbered
4884 @opindex Wclobbered
4885 @opindex Wno-clobbered
4886 Warn for variables that might be changed by @code{longjmp} or
4887 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
4889 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4890 @opindex Wconditionally-supported
4891 @opindex Wno-conditionally-supported
4892 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4894 @item -Wconversion
4895 @opindex Wconversion
4896 @opindex Wno-conversion
4897 Warn for implicit conversions that may alter a value. This includes
4898 conversions between real and integer, like @code{abs (x)} when
4899 @code{x} is @code{double}; conversions between signed and unsigned,
4900 like @code{unsigned ui = -1}; and conversions to smaller types, like
4901 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4902 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4903 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4904 conversions between signed and unsigned integers can be disabled by
4905 using @option{-Wno-sign-conversion}.
4907 For C++, also warn for confusing overload resolution for user-defined
4908 conversions; and conversions that never use a type conversion
4909 operator: conversions to @code{void}, the same type, a base class or a
4910 reference to them. Warnings about conversions between signed and
4911 unsigned integers are disabled by default in C++ unless
4912 @option{-Wsign-conversion} is explicitly enabled.
4914 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4915 @opindex Wconversion-null
4916 @opindex Wno-conversion-null
4917 Do not warn for conversions between @code{NULL} and non-pointer
4918 types. @option{-Wconversion-null} is enabled by default.
4920 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4921 @opindex Wzero-as-null-pointer-constant
4922 @opindex Wno-zero-as-null-pointer-constant
4923 Warn when a literal '0' is used as null pointer constant.  This can
4924 be useful to facilitate the conversion to @code{nullptr} in C++11.
4926 @item -Wdate-time
4927 @opindex Wdate-time
4928 @opindex Wno-date-time
4929 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4930 are encountered as they might prevent bit-wise-identical reproducible
4931 compilations.
4933 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4934 @opindex Wdelete-incomplete
4935 @opindex Wno-delete-incomplete
4936 Warn when deleting a pointer to incomplete type, which may cause
4937 undefined behavior at runtime.  This warning is enabled by default.
4939 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4940 @opindex Wuseless-cast
4941 @opindex Wno-useless-cast
4942 Warn when an expression is casted to its own type.
4944 @item -Wempty-body
4945 @opindex Wempty-body
4946 @opindex Wno-empty-body
4947 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
4948 while} statement.  This warning is also enabled by @option{-Wextra}.
4950 @item -Wenum-compare
4951 @opindex Wenum-compare
4952 @opindex Wno-enum-compare
4953 Warn about a comparison between values of different enumerated types.
4954 In C++ enumeral mismatches in conditional expressions are also
4955 diagnosed and the warning is enabled by default.  In C this warning is 
4956 enabled by @option{-Wall}.
4958 @item -Wjump-misses-init @r{(C, Objective-C only)}
4959 @opindex Wjump-misses-init
4960 @opindex Wno-jump-misses-init
4961 Warn if a @code{goto} statement or a @code{switch} statement jumps
4962 forward across the initialization of a variable, or jumps backward to a
4963 label after the variable has been initialized.  This only warns about
4964 variables that are initialized when they are declared.  This warning is
4965 only supported for C and Objective-C; in C++ this sort of branch is an
4966 error in any case.
4968 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4969 can be disabled with the @option{-Wno-jump-misses-init} option.
4971 @item -Wsign-compare
4972 @opindex Wsign-compare
4973 @opindex Wno-sign-compare
4974 @cindex warning for comparison of signed and unsigned values
4975 @cindex comparison of signed and unsigned values, warning
4976 @cindex signed and unsigned values, comparison warning
4977 Warn when a comparison between signed and unsigned values could produce
4978 an incorrect result when the signed value is converted to unsigned.
4979 This warning is also enabled by @option{-Wextra}; to get the other warnings
4980 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4982 @item -Wsign-conversion
4983 @opindex Wsign-conversion
4984 @opindex Wno-sign-conversion
4985 Warn for implicit conversions that may change the sign of an integer
4986 value, like assigning a signed integer expression to an unsigned
4987 integer variable. An explicit cast silences the warning. In C, this
4988 option is enabled also by @option{-Wconversion}.
4990 @item -Wfloat-conversion
4991 @opindex Wfloat-conversion
4992 @opindex Wno-float-conversion
4993 Warn for implicit conversions that reduce the precision of a real value.
4994 This includes conversions from real to integer, and from higher precision
4995 real to lower precision real values.  This option is also enabled by
4996 @option{-Wconversion}.
4998 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4999 @opindex Wsized-deallocation
5000 @opindex Wno-sized-deallocation
5001 Warn about a definition of an unsized deallocation function
5002 @smallexample
5003 void operator delete (void *) noexcept;
5004 void operator delete[] (void *) noexcept;
5005 @end smallexample
5006 without a definition of the corresponding sized deallocation function
5007 @smallexample
5008 void operator delete (void *, std::size_t) noexcept;
5009 void operator delete[] (void *, std::size_t) noexcept;
5010 @end smallexample
5011 or vice versa.  Enabled by @option{-Wextra} along with
5012 @option{-fsized-deallocation}.
5014 @item -Wsizeof-pointer-memaccess
5015 @opindex Wsizeof-pointer-memaccess
5016 @opindex Wno-sizeof-pointer-memaccess
5017 Warn for suspicious length parameters to certain string and memory built-in
5018 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
5019 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
5020 but a pointer, and suggests a possible fix, or about
5021 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
5022 @option{-Wall}.
5024 @item -Wsizeof-array-argument
5025 @opindex Wsizeof-array-argument
5026 @opindex Wno-sizeof-array-argument
5027 Warn when the @code{sizeof} operator is applied to a parameter that is
5028 declared as an array in a function definition.  This warning is enabled by
5029 default for C and C++ programs.
5031 @item -Wmemset-transposed-args
5032 @opindex Wmemset-transposed-args
5033 @opindex Wno-memset-transposed-args
5034 Warn for suspicious calls to the @code{memset} built-in function, if the
5035 second argument is not zero and the third argument is zero.  This warns e.g.@
5036 about @code{memset (buf, sizeof buf, 0)} where most probably
5037 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
5038 is only emitted if the third argument is literal zero.  If it is some
5039 expression that is folded to zero, a cast of zero to some type, etc., 
5040 it is far less likely that the user has mistakenly exchanged the arguments 
5041 and no warning is emitted.  This warning is enabled by @option{-Wall}.
5043 @item -Waddress
5044 @opindex Waddress
5045 @opindex Wno-address
5046 Warn about suspicious uses of memory addresses. These include using
5047 the address of a function in a conditional expression, such as
5048 @code{void func(void); if (func)}, and comparisons against the memory
5049 address of a string literal, such as @code{if (x == "abc")}.  Such
5050 uses typically indicate a programmer error: the address of a function
5051 always evaluates to true, so their use in a conditional usually
5052 indicate that the programmer forgot the parentheses in a function
5053 call; and comparisons against string literals result in unspecified
5054 behavior and are not portable in C, so they usually indicate that the
5055 programmer intended to use @code{strcmp}.  This warning is enabled by
5056 @option{-Wall}.
5058 @item -Wlogical-op
5059 @opindex Wlogical-op
5060 @opindex Wno-logical-op
5061 Warn about suspicious uses of logical operators in expressions.
5062 This includes using logical operators in contexts where a
5063 bit-wise operator is likely to be expected.  Also warns when
5064 the operands of a logical operator are the same:
5065 @smallexample
5066 extern int a;
5067 if (a < 0 && a < 0) @{ @dots{} @}
5068 @end smallexample
5070 @item -Wlogical-not-parentheses
5071 @opindex Wlogical-not-parentheses
5072 @opindex Wno-logical-not-parentheses
5073 Warn about logical not used on the left hand side operand of a comparison.
5074 This option does not warn if the RHS operand is of a boolean type.  Its
5075 purpose is to detect suspicious code like the following:
5076 @smallexample
5077 int a;
5078 @dots{}
5079 if (!a > 1) @{ @dots{} @}
5080 @end smallexample
5082 It is possible to suppress the warning by wrapping the LHS into
5083 parentheses:
5084 @smallexample
5085 if ((!a) > 1) @{ @dots{} @}
5086 @end smallexample
5088 This warning is enabled by @option{-Wall}.
5090 @item -Waggregate-return
5091 @opindex Waggregate-return
5092 @opindex Wno-aggregate-return
5093 Warn if any functions that return structures or unions are defined or
5094 called.  (In languages where you can return an array, this also elicits
5095 a warning.)
5097 @item -Wno-aggressive-loop-optimizations
5098 @opindex Wno-aggressive-loop-optimizations
5099 @opindex Waggressive-loop-optimizations
5100 Warn if in a loop with constant number of iterations the compiler detects
5101 undefined behavior in some statement during one or more of the iterations.
5103 @item -Wno-attributes
5104 @opindex Wno-attributes
5105 @opindex Wattributes
5106 Do not warn if an unexpected @code{__attribute__} is used, such as
5107 unrecognized attributes, function attributes applied to variables,
5108 etc.  This does not stop errors for incorrect use of supported
5109 attributes.
5111 @item -Wno-builtin-macro-redefined
5112 @opindex Wno-builtin-macro-redefined
5113 @opindex Wbuiltin-macro-redefined
5114 Do not warn if certain built-in macros are redefined.  This suppresses
5115 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5116 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5118 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5119 @opindex Wstrict-prototypes
5120 @opindex Wno-strict-prototypes
5121 Warn if a function is declared or defined without specifying the
5122 argument types.  (An old-style function definition is permitted without
5123 a warning if preceded by a declaration that specifies the argument
5124 types.)
5126 @item -Wold-style-declaration @r{(C and Objective-C only)}
5127 @opindex Wold-style-declaration
5128 @opindex Wno-old-style-declaration
5129 Warn for obsolescent usages, according to the C Standard, in a
5130 declaration. For example, warn if storage-class specifiers like
5131 @code{static} are not the first things in a declaration.  This warning
5132 is also enabled by @option{-Wextra}.
5134 @item -Wold-style-definition @r{(C and Objective-C only)}
5135 @opindex Wold-style-definition
5136 @opindex Wno-old-style-definition
5137 Warn if an old-style function definition is used.  A warning is given
5138 even if there is a previous prototype.
5140 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5141 @opindex Wmissing-parameter-type
5142 @opindex Wno-missing-parameter-type
5143 A function parameter is declared without a type specifier in K&R-style
5144 functions:
5146 @smallexample
5147 void foo(bar) @{ @}
5148 @end smallexample
5150 This warning is also enabled by @option{-Wextra}.
5152 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5153 @opindex Wmissing-prototypes
5154 @opindex Wno-missing-prototypes
5155 Warn if a global function is defined without a previous prototype
5156 declaration.  This warning is issued even if the definition itself
5157 provides a prototype.  Use this option to detect global functions
5158 that do not have a matching prototype declaration in a header file.
5159 This option is not valid for C++ because all function declarations
5160 provide prototypes and a non-matching declaration declares an
5161 overload rather than conflict with an earlier declaration.
5162 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5164 @item -Wmissing-declarations
5165 @opindex Wmissing-declarations
5166 @opindex Wno-missing-declarations
5167 Warn if a global function is defined without a previous declaration.
5168 Do so even if the definition itself provides a prototype.
5169 Use this option to detect global functions that are not declared in
5170 header files.  In C, no warnings are issued for functions with previous
5171 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5172 missing prototypes.  In C++, no warnings are issued for function templates,
5173 or for inline functions, or for functions in anonymous namespaces.
5175 @item -Wmissing-field-initializers
5176 @opindex Wmissing-field-initializers
5177 @opindex Wno-missing-field-initializers
5178 @opindex W
5179 @opindex Wextra
5180 @opindex Wno-extra
5181 Warn if a structure's initializer has some fields missing.  For
5182 example, the following code causes such a warning, because
5183 @code{x.h} is implicitly zero:
5185 @smallexample
5186 struct s @{ int f, g, h; @};
5187 struct s x = @{ 3, 4 @};
5188 @end smallexample
5190 This option does not warn about designated initializers, so the following
5191 modification does not trigger a warning:
5193 @smallexample
5194 struct s @{ int f, g, h; @};
5195 struct s x = @{ .f = 3, .g = 4 @};
5196 @end smallexample
5198 In C++ this option does not warn either about the empty @{ @}
5199 initializer, for example:
5201 @smallexample
5202 struct s @{ int f, g, h; @};
5203 s x = @{ @};
5204 @end smallexample
5206 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5207 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5209 @item -Wno-multichar
5210 @opindex Wno-multichar
5211 @opindex Wmultichar
5212 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5213 Usually they indicate a typo in the user's code, as they have
5214 implementation-defined values, and should not be used in portable code.
5216 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5217 @opindex Wnormalized=
5218 @opindex Wnormalized
5219 @opindex Wno-normalized
5220 @cindex NFC
5221 @cindex NFKC
5222 @cindex character set, input normalization
5223 In ISO C and ISO C++, two identifiers are different if they are
5224 different sequences of characters.  However, sometimes when characters
5225 outside the basic ASCII character set are used, you can have two
5226 different character sequences that look the same.  To avoid confusion,
5227 the ISO 10646 standard sets out some @dfn{normalization rules} which
5228 when applied ensure that two sequences that look the same are turned into
5229 the same sequence.  GCC can warn you if you are using identifiers that
5230 have not been normalized; this option controls that warning.
5232 There are four levels of warning supported by GCC@.  The default is
5233 @option{-Wnormalized=nfc}, which warns about any identifier that is
5234 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5235 recommended form for most uses.  It is equivalent to
5236 @option{-Wnormalized}.
5238 Unfortunately, there are some characters allowed in identifiers by
5239 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5240 identifiers.  That is, there's no way to use these symbols in portable
5241 ISO C or C++ and have all your identifiers in NFC@.
5242 @option{-Wnormalized=id} suppresses the warning for these characters.
5243 It is hoped that future versions of the standards involved will correct
5244 this, which is why this option is not the default.
5246 You can switch the warning off for all characters by writing
5247 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5248 only do this if you are using some other normalization scheme (like
5249 ``D''), because otherwise you can easily create bugs that are
5250 literally impossible to see.
5252 Some characters in ISO 10646 have distinct meanings but look identical
5253 in some fonts or display methodologies, especially once formatting has
5254 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5255 LETTER N'', displays just like a regular @code{n} that has been
5256 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5257 normalization scheme to convert all these into a standard form as
5258 well, and GCC warns if your code is not in NFKC if you use
5259 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5260 about every identifier that contains the letter O because it might be
5261 confused with the digit 0, and so is not the default, but may be
5262 useful as a local coding convention if the programming environment 
5263 cannot be fixed to display these characters distinctly.
5265 @item -Wno-deprecated
5266 @opindex Wno-deprecated
5267 @opindex Wdeprecated
5268 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5270 @item -Wno-deprecated-declarations
5271 @opindex Wno-deprecated-declarations
5272 @opindex Wdeprecated-declarations
5273 Do not warn about uses of functions (@pxref{Function Attributes}),
5274 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5275 Attributes}) marked as deprecated by using the @code{deprecated}
5276 attribute.
5278 @item -Wno-overflow
5279 @opindex Wno-overflow
5280 @opindex Woverflow
5281 Do not warn about compile-time overflow in constant expressions.
5283 @item -Wno-odr
5284 @opindex Wno-odr
5285 @opindex Wodr
5286 Warn about One Definition Rule violations during link-time optimization.
5287 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5289 @item -Wopenmp-simd
5290 @opindex Wopenm-simd
5291 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5292 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5293 option can be used to relax the cost model.
5295 @item -Woverride-init @r{(C and Objective-C only)}
5296 @opindex Woverride-init
5297 @opindex Wno-override-init
5298 @opindex W
5299 @opindex Wextra
5300 @opindex Wno-extra
5301 Warn if an initialized field without side effects is overridden when
5302 using designated initializers (@pxref{Designated Inits, , Designated
5303 Initializers}).
5305 This warning is included in @option{-Wextra}.  To get other
5306 @option{-Wextra} warnings without this one, use @option{-Wextra
5307 -Wno-override-init}.
5309 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
5310 @opindex Woverride-init-side-effects
5311 @opindex Wno-override-init-side-effects
5312 Warn if an initialized field with side effects is overridden when
5313 using designated initializers (@pxref{Designated Inits, , Designated
5314 Initializers}).  This warning is enabled by default.
5316 @item -Wpacked
5317 @opindex Wpacked
5318 @opindex Wno-packed
5319 Warn if a structure is given the packed attribute, but the packed
5320 attribute has no effect on the layout or size of the structure.
5321 Such structures may be mis-aligned for little benefit.  For
5322 instance, in this code, the variable @code{f.x} in @code{struct bar}
5323 is misaligned even though @code{struct bar} does not itself
5324 have the packed attribute:
5326 @smallexample
5327 @group
5328 struct foo @{
5329   int x;
5330   char a, b, c, d;
5331 @} __attribute__((packed));
5332 struct bar @{
5333   char z;
5334   struct foo f;
5336 @end group
5337 @end smallexample
5339 @item -Wpacked-bitfield-compat
5340 @opindex Wpacked-bitfield-compat
5341 @opindex Wno-packed-bitfield-compat
5342 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5343 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5344 the change can lead to differences in the structure layout.  GCC
5345 informs you when the offset of such a field has changed in GCC 4.4.
5346 For example there is no longer a 4-bit padding between field @code{a}
5347 and @code{b} in this structure:
5349 @smallexample
5350 struct foo
5352   char a:4;
5353   char b:8;
5354 @} __attribute__ ((packed));
5355 @end smallexample
5357 This warning is enabled by default.  Use
5358 @option{-Wno-packed-bitfield-compat} to disable this warning.
5360 @item -Wpadded
5361 @opindex Wpadded
5362 @opindex Wno-padded
5363 Warn if padding is included in a structure, either to align an element
5364 of the structure or to align the whole structure.  Sometimes when this
5365 happens it is possible to rearrange the fields of the structure to
5366 reduce the padding and so make the structure smaller.
5368 @item -Wredundant-decls
5369 @opindex Wredundant-decls
5370 @opindex Wno-redundant-decls
5371 Warn if anything is declared more than once in the same scope, even in
5372 cases where multiple declaration is valid and changes nothing.
5374 @item -Wnested-externs @r{(C and Objective-C only)}
5375 @opindex Wnested-externs
5376 @opindex Wno-nested-externs
5377 Warn if an @code{extern} declaration is encountered within a function.
5379 @item -Wno-inherited-variadic-ctor
5380 @opindex Winherited-variadic-ctor
5381 @opindex Wno-inherited-variadic-ctor
5382 Suppress warnings about use of C++11 inheriting constructors when the
5383 base class inherited from has a C variadic constructor; the warning is
5384 on by default because the ellipsis is not inherited.
5386 @item -Winline
5387 @opindex Winline
5388 @opindex Wno-inline
5389 Warn if a function that is declared as inline cannot be inlined.
5390 Even with this option, the compiler does not warn about failures to
5391 inline functions declared in system headers.
5393 The compiler uses a variety of heuristics to determine whether or not
5394 to inline a function.  For example, the compiler takes into account
5395 the size of the function being inlined and the amount of inlining
5396 that has already been done in the current function.  Therefore,
5397 seemingly insignificant changes in the source program can cause the
5398 warnings produced by @option{-Winline} to appear or disappear.
5400 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5401 @opindex Wno-invalid-offsetof
5402 @opindex Winvalid-offsetof
5403 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5404 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5405 to a non-standard-layout type is undefined.  In existing C++ implementations,
5406 however, @code{offsetof} typically gives meaningful results.
5407 This flag is for users who are aware that they are
5408 writing nonportable code and who have deliberately chosen to ignore the
5409 warning about it.
5411 The restrictions on @code{offsetof} may be relaxed in a future version
5412 of the C++ standard.
5414 @item -Wno-int-to-pointer-cast
5415 @opindex Wno-int-to-pointer-cast
5416 @opindex Wint-to-pointer-cast
5417 Suppress warnings from casts to pointer type of an integer of a
5418 different size. In C++, casting to a pointer type of smaller size is
5419 an error. @option{Wint-to-pointer-cast} is enabled by default.
5422 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5423 @opindex Wno-pointer-to-int-cast
5424 @opindex Wpointer-to-int-cast
5425 Suppress warnings from casts from a pointer to an integer type of a
5426 different size.
5428 @item -Winvalid-pch
5429 @opindex Winvalid-pch
5430 @opindex Wno-invalid-pch
5431 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5432 the search path but can't be used.
5434 @item -Wlong-long
5435 @opindex Wlong-long
5436 @opindex Wno-long-long
5437 Warn if @code{long long} type is used.  This is enabled by either
5438 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5439 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5441 @item -Wvariadic-macros
5442 @opindex Wvariadic-macros
5443 @opindex Wno-variadic-macros
5444 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5445 alternate syntax is used in ISO C99 mode.  This is enabled by either
5446 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5447 messages, use @option{-Wno-variadic-macros}.
5449 @item -Wvarargs
5450 @opindex Wvarargs
5451 @opindex Wno-varargs
5452 Warn upon questionable usage of the macros used to handle variable
5453 arguments like @code{va_start}.  This is default.  To inhibit the
5454 warning messages, use @option{-Wno-varargs}.
5456 @item -Wvector-operation-performance
5457 @opindex Wvector-operation-performance
5458 @opindex Wno-vector-operation-performance
5459 Warn if vector operation is not implemented via SIMD capabilities of the
5460 architecture.  Mainly useful for the performance tuning.
5461 Vector operation can be implemented @code{piecewise}, which means that the
5462 scalar operation is performed on every vector element; 
5463 @code{in parallel}, which means that the vector operation is implemented
5464 using scalars of wider type, which normally is more performance efficient;
5465 and @code{as a single scalar}, which means that vector fits into a
5466 scalar type.
5468 @item -Wno-virtual-move-assign
5469 @opindex Wvirtual-move-assign
5470 @opindex Wno-virtual-move-assign
5471 Suppress warnings about inheriting from a virtual base with a
5472 non-trivial C++11 move assignment operator.  This is dangerous because
5473 if the virtual base is reachable along more than one path, it is
5474 moved multiple times, which can mean both objects end up in the
5475 moved-from state.  If the move assignment operator is written to avoid
5476 moving from a moved-from object, this warning can be disabled.
5478 @item -Wvla
5479 @opindex Wvla
5480 @opindex Wno-vla
5481 Warn if variable length array is used in the code.
5482 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5483 the variable length array.
5485 @item -Wvolatile-register-var
5486 @opindex Wvolatile-register-var
5487 @opindex Wno-volatile-register-var
5488 Warn if a register variable is declared volatile.  The volatile
5489 modifier does not inhibit all optimizations that may eliminate reads
5490 and/or writes to register variables.  This warning is enabled by
5491 @option{-Wall}.
5493 @item -Wdisabled-optimization
5494 @opindex Wdisabled-optimization
5495 @opindex Wno-disabled-optimization
5496 Warn if a requested optimization pass is disabled.  This warning does
5497 not generally indicate that there is anything wrong with your code; it
5498 merely indicates that GCC's optimizers are unable to handle the code
5499 effectively.  Often, the problem is that your code is too big or too
5500 complex; GCC refuses to optimize programs when the optimization
5501 itself is likely to take inordinate amounts of time.
5503 @item -Wpointer-sign @r{(C and Objective-C only)}
5504 @opindex Wpointer-sign
5505 @opindex Wno-pointer-sign
5506 Warn for pointer argument passing or assignment with different signedness.
5507 This option is only supported for C and Objective-C@.  It is implied by
5508 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5509 @option{-Wno-pointer-sign}.
5511 @item -Wstack-protector
5512 @opindex Wstack-protector
5513 @opindex Wno-stack-protector
5514 This option is only active when @option{-fstack-protector} is active.  It
5515 warns about functions that are not protected against stack smashing.
5517 @item -Woverlength-strings
5518 @opindex Woverlength-strings
5519 @opindex Wno-overlength-strings
5520 Warn about string constants that are longer than the ``minimum
5521 maximum'' length specified in the C standard.  Modern compilers
5522 generally allow string constants that are much longer than the
5523 standard's minimum limit, but very portable programs should avoid
5524 using longer strings.
5526 The limit applies @emph{after} string constant concatenation, and does
5527 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5528 C99, it was raised to 4095.  C++98 does not specify a normative
5529 minimum maximum, so we do not diagnose overlength strings in C++@.
5531 This option is implied by @option{-Wpedantic}, and can be disabled with
5532 @option{-Wno-overlength-strings}.
5534 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5535 @opindex Wunsuffixed-float-constants
5537 Issue a warning for any floating constant that does not have
5538 a suffix.  When used together with @option{-Wsystem-headers} it
5539 warns about such constants in system header files.  This can be useful
5540 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5541 from the decimal floating-point extension to C99.
5543 @item -Wno-designated-init @r{(C and Objective-C only)}
5544 Suppress warnings when a positional initializer is used to initialize
5545 a structure that has been marked with the @code{designated_init}
5546 attribute.
5548 @end table
5550 @node Debugging Options
5551 @section Options for Debugging Your Program or GCC
5552 @cindex options, debugging
5553 @cindex debugging information options
5555 GCC has various special options that are used for debugging
5556 either your program or GCC:
5558 @table @gcctabopt
5559 @item -g
5560 @opindex g
5561 Produce debugging information in the operating system's native format
5562 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5563 information.
5565 On most systems that use stabs format, @option{-g} enables use of extra
5566 debugging information that only GDB can use; this extra information
5567 makes debugging work better in GDB but probably makes other debuggers
5568 crash or
5569 refuse to read the program.  If you want to control for certain whether
5570 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5571 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5573 GCC allows you to use @option{-g} with
5574 @option{-O}.  The shortcuts taken by optimized code may occasionally
5575 produce surprising results: some variables you declared may not exist
5576 at all; flow of control may briefly move where you did not expect it;
5577 some statements may not be executed because they compute constant
5578 results or their values are already at hand; some statements may
5579 execute in different places because they have been moved out of loops.
5581 Nevertheless it proves possible to debug optimized output.  This makes
5582 it reasonable to use the optimizer for programs that might have bugs.
5584 The following options are useful when GCC is generated with the
5585 capability for more than one debugging format.
5587 @item -gsplit-dwarf
5588 @opindex gsplit-dwarf
5589 Separate as much dwarf debugging information as possible into a
5590 separate output file with the extension .dwo.  This option allows
5591 the build system to avoid linking files with debug information.  To
5592 be useful, this option requires a debugger capable of reading .dwo
5593 files.
5595 @item -ggdb
5596 @opindex ggdb
5597 Produce debugging information for use by GDB@.  This means to use the
5598 most expressive format available (DWARF 2, stabs, or the native format
5599 if neither of those are supported), including GDB extensions if at all
5600 possible.
5602 @item -gpubnames
5603 @opindex gpubnames
5604 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5606 @item -ggnu-pubnames
5607 @opindex ggnu-pubnames
5608 Generate .debug_pubnames and .debug_pubtypes sections in a format
5609 suitable for conversion into a GDB@ index.  This option is only useful
5610 with a linker that can produce GDB@ index version 7.
5612 @item -gstabs
5613 @opindex gstabs
5614 Produce debugging information in stabs format (if that is supported),
5615 without GDB extensions.  This is the format used by DBX on most BSD
5616 systems.  On MIPS, Alpha and System V Release 4 systems this option
5617 produces stabs debugging output that is not understood by DBX or SDB@.
5618 On System V Release 4 systems this option requires the GNU assembler.
5620 @item -feliminate-unused-debug-symbols
5621 @opindex feliminate-unused-debug-symbols
5622 Produce debugging information in stabs format (if that is supported),
5623 for only symbols that are actually used.
5625 @item -femit-class-debug-always
5626 @opindex femit-class-debug-always
5627 Instead of emitting debugging information for a C++ class in only one
5628 object file, emit it in all object files using the class.  This option
5629 should be used only with debuggers that are unable to handle the way GCC
5630 normally emits debugging information for classes because using this
5631 option increases the size of debugging information by as much as a
5632 factor of two.
5634 @item -fdebug-types-section
5635 @opindex fdebug-types-section
5636 @opindex fno-debug-types-section
5637 When using DWARF Version 4 or higher, type DIEs can be put into
5638 their own @code{.debug_types} section instead of making them part of the
5639 @code{.debug_info} section.  It is more efficient to put them in a separate
5640 comdat sections since the linker can then remove duplicates.
5641 But not all DWARF consumers support @code{.debug_types} sections yet
5642 and on some objects @code{.debug_types} produces larger instead of smaller
5643 debugging information.
5645 @item -gstabs+
5646 @opindex gstabs+
5647 Produce debugging information in stabs format (if that is supported),
5648 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5649 use of these extensions is likely to make other debuggers crash or
5650 refuse to read the program.
5652 @item -gcoff
5653 @opindex gcoff
5654 Produce debugging information in COFF format (if that is supported).
5655 This is the format used by SDB on most System V systems prior to
5656 System V Release 4.
5658 @item -gxcoff
5659 @opindex gxcoff
5660 Produce debugging information in XCOFF format (if that is supported).
5661 This is the format used by the DBX debugger on IBM RS/6000 systems.
5663 @item -gxcoff+
5664 @opindex gxcoff+
5665 Produce debugging information in XCOFF format (if that is supported),
5666 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5667 use of these extensions is likely to make other debuggers crash or
5668 refuse to read the program, and may cause assemblers other than the GNU
5669 assembler (GAS) to fail with an error.
5671 @item -gdwarf-@var{version}
5672 @opindex gdwarf-@var{version}
5673 Produce debugging information in DWARF format (if that is supported).
5674 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5675 for most targets is 4.  DWARF Version 5 is only experimental.
5677 Note that with DWARF Version 2, some ports require and always
5678 use some non-conflicting DWARF 3 extensions in the unwind tables.
5680 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5681 for maximum benefit.
5683 @item -grecord-gcc-switches
5684 @opindex grecord-gcc-switches
5685 This switch causes the command-line options used to invoke the
5686 compiler that may affect code generation to be appended to the
5687 DW_AT_producer attribute in DWARF debugging information.  The options
5688 are concatenated with spaces separating them from each other and from
5689 the compiler version.  See also @option{-frecord-gcc-switches} for another
5690 way of storing compiler options into the object file.  This is the default.
5692 @item -gno-record-gcc-switches
5693 @opindex gno-record-gcc-switches
5694 Disallow appending command-line options to the DW_AT_producer attribute
5695 in DWARF debugging information.
5697 @item -gstrict-dwarf
5698 @opindex gstrict-dwarf
5699 Disallow using extensions of later DWARF standard version than selected
5700 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5701 DWARF extensions from later standard versions is allowed.
5703 @item -gno-strict-dwarf
5704 @opindex gno-strict-dwarf
5705 Allow using extensions of later DWARF standard version than selected with
5706 @option{-gdwarf-@var{version}}.
5708 @item -gz@r{[}=@var{type}@r{]}
5709 @opindex gz
5710 Produce compressed debug sections in DWARF format, if that is supported.
5711 If @var{type} is not given, the default type depends on the capabilities
5712 of the assembler and linker used.  @var{type} may be one of
5713 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
5714 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
5715 compression in traditional GNU format).  If the linker doesn't support
5716 writing compressed debug sections, the option is rejected.  Otherwise,
5717 if the assembler does not support them, @option{-gz} is silently ignored
5718 when producing object files.
5720 @item -gvms
5721 @opindex gvms
5722 Produce debugging information in Alpha/VMS debug format (if that is
5723 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5725 @item -g@var{level}
5726 @itemx -ggdb@var{level}
5727 @itemx -gstabs@var{level}
5728 @itemx -gcoff@var{level}
5729 @itemx -gxcoff@var{level}
5730 @itemx -gvms@var{level}
5731 Request debugging information and also use @var{level} to specify how
5732 much information.  The default level is 2.
5734 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5735 @option{-g}.
5737 Level 1 produces minimal information, enough for making backtraces in
5738 parts of the program that you don't plan to debug.  This includes
5739 descriptions of functions and external variables, and line number
5740 tables, but no information about local variables.
5742 Level 3 includes extra information, such as all the macro definitions
5743 present in the program.  Some debuggers support macro expansion when
5744 you use @option{-g3}.
5746 @option{-gdwarf-2} does not accept a concatenated debug level, because
5747 GCC used to support an option @option{-gdwarf} that meant to generate
5748 debug information in version 1 of the DWARF format (which is very
5749 different from version 2), and it would have been too confusing.  That
5750 debug format is long obsolete, but the option cannot be changed now.
5751 Instead use an additional @option{-g@var{level}} option to change the
5752 debug level for DWARF.
5754 @item -gtoggle
5755 @opindex gtoggle
5756 Turn off generation of debug info, if leaving out this option
5757 generates it, or turn it on at level 2 otherwise.  The position of this
5758 argument in the command line does not matter; it takes effect after all
5759 other options are processed, and it does so only once, no matter how
5760 many times it is given.  This is mainly intended to be used with
5761 @option{-fcompare-debug}.
5763 @item -fsanitize=address
5764 @opindex fsanitize=address
5765 Enable AddressSanitizer, a fast memory error detector.
5766 Memory access instructions are instrumented to detect
5767 out-of-bounds and use-after-free bugs.
5768 See @uref{http://code.google.com/p/address-sanitizer/} for
5769 more details.  The run-time behavior can be influenced using the
5770 @env{ASAN_OPTIONS} environment variable; see
5771 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5772 a list of supported options.
5774 @item -fsanitize=kernel-address
5775 @opindex fsanitize=kernel-address
5776 Enable AddressSanitizer for Linux kernel.
5777 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5779 @item -fsanitize=thread
5780 @opindex fsanitize=thread
5781 Enable ThreadSanitizer, a fast data race detector.
5782 Memory access instructions are instrumented to detect
5783 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5784 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5785 environment variable; see
5786 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5787 supported options.
5789 @item -fsanitize=leak
5790 @opindex fsanitize=leak
5791 Enable LeakSanitizer, a memory leak detector.
5792 This option only matters for linking of executables and if neither
5793 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5794 case the executable is linked against a library that overrides @code{malloc}
5795 and other allocator functions.  See
5796 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5797 details.  The run-time behavior can be influenced using the
5798 @env{LSAN_OPTIONS} environment variable.
5800 @item -fsanitize=undefined
5801 @opindex fsanitize=undefined
5802 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5803 Various computations are instrumented to detect undefined behavior
5804 at runtime.  Current suboptions are:
5806 @table @gcctabopt
5808 @item -fsanitize=shift
5809 @opindex fsanitize=shift
5810 This option enables checking that the result of a shift operation is
5811 not undefined.  Note that what exactly is considered undefined differs
5812 slightly between C and C++, as well as between ISO C90 and C99, etc.
5814 @item -fsanitize=integer-divide-by-zero
5815 @opindex fsanitize=integer-divide-by-zero
5816 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5818 @item -fsanitize=unreachable
5819 @opindex fsanitize=unreachable
5820 With this option, the compiler turns the @code{__builtin_unreachable}
5821 call into a diagnostics message call instead.  When reaching the
5822 @code{__builtin_unreachable} call, the behavior is undefined.
5824 @item -fsanitize=vla-bound
5825 @opindex fsanitize=vla-bound
5826 This option instructs the compiler to check that the size of a variable
5827 length array is positive.
5829 @item -fsanitize=null
5830 @opindex fsanitize=null
5831 This option enables pointer checking.  Particularly, the application
5832 built with this option turned on will issue an error message when it
5833 tries to dereference a NULL pointer, or if a reference (possibly an
5834 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5835 on an object pointed by a NULL pointer.
5837 @item -fsanitize=return
5838 @opindex fsanitize=return
5839 This option enables return statement checking.  Programs
5840 built with this option turned on will issue an error message
5841 when the end of a non-void function is reached without actually
5842 returning a value.  This option works in C++ only.
5844 @item -fsanitize=signed-integer-overflow
5845 @opindex fsanitize=signed-integer-overflow
5846 This option enables signed integer overflow checking.  We check that
5847 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5848 does not overflow in the signed arithmetics.  Note, integer promotion
5849 rules must be taken into account.  That is, the following is not an
5850 overflow:
5851 @smallexample
5852 signed char a = SCHAR_MAX;
5853 a++;
5854 @end smallexample
5856 @item -fsanitize=bounds
5857 @opindex fsanitize=bounds
5858 This option enables instrumentation of array bounds.  Various out of bounds
5859 accesses are detected.  Flexible array members, flexible array member-like
5860 arrays, and initializers of variables with static storage are not instrumented.
5862 @item -fsanitize=bounds-strict
5863 @opindex fsanitize=bounds-strict
5864 This option enables strict instrumentation of array bounds.  Most out of bounds
5865 accesses are detected, including flexible array members and flexible array
5866 member-like arrays.  Initializers of variables with static storage are not
5867 instrumented.
5869 @item -fsanitize=alignment
5870 @opindex fsanitize=alignment
5872 This option enables checking of alignment of pointers when they are
5873 dereferenced, or when a reference is bound to insufficiently aligned target,
5874 or when a method or constructor is invoked on insufficiently aligned object.
5876 @item -fsanitize=object-size
5877 @opindex fsanitize=object-size
5878 This option enables instrumentation of memory references using the
5879 @code{__builtin_object_size} function.  Various out of bounds pointer
5880 accesses are detected.
5882 @item -fsanitize=float-divide-by-zero
5883 @opindex fsanitize=float-divide-by-zero
5884 Detect floating-point division by zero.  Unlike other similar options,
5885 @option{-fsanitize=float-divide-by-zero} is not enabled by
5886 @option{-fsanitize=undefined}, since floating-point division by zero can
5887 be a legitimate way of obtaining infinities and NaNs.
5889 @item -fsanitize=float-cast-overflow
5890 @opindex fsanitize=float-cast-overflow
5891 This option enables floating-point type to integer conversion checking.
5892 We check that the result of the conversion does not overflow.
5893 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
5894 not enabled by @option{-fsanitize=undefined}.
5895 This option does not work well with @code{FE_INVALID} exceptions enabled.
5897 @item -fsanitize=nonnull-attribute
5898 @opindex fsanitize=nonnull-attribute
5900 This option enables instrumentation of calls, checking whether null values
5901 are not passed to arguments marked as requiring a non-null value by the
5902 @code{nonnull} function attribute.
5904 @item -fsanitize=returns-nonnull-attribute
5905 @opindex fsanitize=returns-nonnull-attribute
5907 This option enables instrumentation of return statements in functions
5908 marked with @code{returns_nonnull} function attribute, to detect returning
5909 of null values from such functions.
5911 @item -fsanitize=bool
5912 @opindex fsanitize=bool
5914 This option enables instrumentation of loads from bool.  If a value other
5915 than 0/1 is loaded, a run-time error is issued.
5917 @item -fsanitize=enum
5918 @opindex fsanitize=enum
5920 This option enables instrumentation of loads from an enum type.  If
5921 a value outside the range of values for the enum type is loaded,
5922 a run-time error is issued.
5924 @item -fsanitize=vptr
5925 @opindex fsanitize=vptr
5927 This option enables instrumentation of C++ member function calls, member
5928 accesses and some conversions between pointers to base and derived classes,
5929 to verify the referenced object has the correct dynamic type.
5931 @end table
5933 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5934 @option{-fsanitize=undefined} gives a diagnostic message.
5935 This currently works only for the C family of languages.
5937 @item -fno-sanitize=all
5938 @opindex fno-sanitize=all
5940 This option disables all previously enabled sanitizers.
5941 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
5942 together.
5944 @item -fasan-shadow-offset=@var{number}
5945 @opindex fasan-shadow-offset
5946 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5947 It is useful for experimenting with different shadow memory layouts in
5948 Kernel AddressSanitizer.
5950 @item -fsanitize-sections=@var{s1},@var{s2},...
5951 @opindex fsanitize-sections
5952 Sanitize global variables in selected user-defined sections.  @var{si} may
5953 contain wildcards.
5955 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5956 @opindex fsanitize-recover
5957 @opindex fno-sanitize-recover
5958 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5959 mentioned in comma-separated list of @var{opts}.  Enabling this option
5960 for a sanitizer component causes it to attempt to continue
5961 running the program as if no error happened.  This means multiple
5962 runtime errors can be reported in a single program run, and the exit
5963 code of the program may indicate success even when errors
5964 have been reported.  The @option{-fno-sanitize-recover=} option
5965 can be used to alter
5966 this behavior: only the first detected error is reported
5967 and program then exits with a non-zero exit code.
5969 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5970 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5971 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5972 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5973 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
5974 accepted, the former enables recovery for all sanitizers that support it,
5975 the latter disables recovery for all sanitizers that support it.
5977 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5978 @smallexample
5979 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5980 @end smallexample
5981 @noindent
5982 Similarly @option{-fno-sanitize-recover} is equivalent to
5983 @smallexample
5984 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5985 @end smallexample
5987 @item -fsanitize-undefined-trap-on-error
5988 @opindex fsanitize-undefined-trap-on-error
5989 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
5990 report undefined behavior using @code{__builtin_trap} rather than
5991 a @code{libubsan} library routine.  The advantage of this is that the
5992 @code{libubsan} library is not needed and is not linked in, so this
5993 is usable even in freestanding environments.
5995 @item -fcheck-pointer-bounds
5996 @opindex fcheck-pointer-bounds
5997 @opindex fno-check-pointer-bounds
5998 @cindex Pointer Bounds Checker options
5999 Enable Pointer Bounds Checker instrumentation.  Each memory reference
6000 is instrumented with checks of the pointer used for memory access against
6001 bounds associated with that pointer.  
6003 Currently there
6004 is only an implementation for Intel MPX available, thus x86 target
6005 and @option{-mmpx} are required to enable this feature.  
6006 MPX-based instrumentation requires
6007 a runtime library to enable MPX in hardware and handle bounds
6008 violation signals.  By default when @option{-fcheck-pointer-bounds}
6009 and @option{-mmpx} options are used to link a program, the GCC driver
6010 links against the @file{libmpx} runtime library and @file{libmpxwrappers}
6011 library.  It also passes '-z bndplt' to a linker in case it supports this
6012 option (which is checked on libmpx configuration).  Note that old versions
6013 of linker may ignore option.  Gold linker doesn't support '-z bndplt'
6014 option.  With no '-z bndplt' support in linker all calls to dynamic libraries
6015 lose passed bounds reducing overall protection level.  It's highly
6016 recommended to use linker with '-z bndplt' support.  In case such linker
6017 is not available it is adviced to always use @option{-static-libmpxwrappers}
6018 for better protection level or use @option{-static} to completely avoid
6019 external calls to dynamic libraries.  MPX-based instrumentation
6020 may be used for debugging and also may be included in production code
6021 to increase program security.  Depending on usage, you may
6022 have different requirements for the runtime library.  The current version
6023 of the MPX runtime library is more oriented for use as a debugging
6024 tool.  MPX runtime library usage implies @option{-lpthread}.  See
6025 also @option{-static-libmpx}.  The runtime library  behavior can be
6026 influenced using various @env{CHKP_RT_*} environment variables.  See
6027 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
6028 for more details.
6030 Generated instrumentation may be controlled by various
6031 @option{-fchkp-*} options and by the @code{bnd_variable_size}
6032 structure field attribute (@pxref{Type Attributes}) and
6033 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
6034 (@pxref{Function Attributes}).  GCC also provides a number of built-in
6035 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
6036 Bounds Checker builtins}, for more information.
6038 @item -fchkp-check-incomplete-type
6039 @opindex fchkp-check-incomplete-type
6040 @opindex fno-chkp-check-incomplete-type
6041 Generate pointer bounds checks for variables with incomplete type.
6042 Enabled by default.
6044 @item -fchkp-narrow-bounds
6045 @opindex fchkp-narrow-bounds
6046 @opindex fno-chkp-narrow-bounds
6047 Controls bounds used by Pointer Bounds Checker for pointers to object
6048 fields.  If narrowing is enabled then field bounds are used.  Otherwise
6049 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
6050 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
6052 @item -fchkp-first-field-has-own-bounds
6053 @opindex fchkp-first-field-has-own-bounds
6054 @opindex fno-chkp-first-field-has-own-bounds
6055 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
6056 first field in the structure.  By default a pointer to the first field has
6057 the same bounds as a pointer to the whole structure.
6059 @item -fchkp-narrow-to-innermost-array
6060 @opindex fchkp-narrow-to-innermost-array
6061 @opindex fno-chkp-narrow-to-innermost-array
6062 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
6063 case of nested static array access.  By default this option is disabled and
6064 bounds of the outermost array are used.
6066 @item -fchkp-optimize
6067 @opindex fchkp-optimize
6068 @opindex fno-chkp-optimize
6069 Enables Pointer Bounds Checker optimizations.  Enabled by default at
6070 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
6072 @item -fchkp-use-fast-string-functions
6073 @opindex fchkp-use-fast-string-functions
6074 @opindex fno-chkp-use-fast-string-functions
6075 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
6076 by Pointer Bounds Checker.  Disabled by default.
6078 @item -fchkp-use-nochk-string-functions
6079 @opindex fchkp-use-nochk-string-functions
6080 @opindex fno-chkp-use-nochk-string-functions
6081 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
6082 by Pointer Bounds Checker.  Disabled by default.
6084 @item -fchkp-use-static-bounds
6085 @opindex fchkp-use-static-bounds
6086 @opindex fno-chkp-use-static-bounds
6087 Allow Pointer Bounds Checker to generate static bounds holding
6088 bounds of static variables.  Enabled by default.
6090 @item -fchkp-use-static-const-bounds
6091 @opindex fchkp-use-static-const-bounds
6092 @opindex fno-chkp-use-static-const-bounds
6093 Use statically-initialized bounds for constant bounds instead of
6094 generating them each time they are required.  By default enabled when
6095 @option{-fchkp-use-static-bounds} is enabled.
6097 @item -fchkp-treat-zero-dynamic-size-as-infinite
6098 @opindex fchkp-treat-zero-dynamic-size-as-infinite
6099 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
6100 With this option, objects with incomplete type whose
6101 dynamically-obtained size is zero are treated as having infinite size
6102 instead by Pointer Bounds
6103 Checker.  This option may be helpful if a program is linked with a library
6104 missing size information for some symbols.  Disabled by default.
6106 @item -fchkp-check-read
6107 @opindex fchkp-check-read
6108 @opindex fno-chkp-check-read
6109 Instructs Pointer Bounds Checker to generate checks for all read
6110 accesses to memory.  Enabled by default.
6112 @item -fchkp-check-write
6113 @opindex fchkp-check-write
6114 @opindex fno-chkp-check-write
6115 Instructs Pointer Bounds Checker to generate checks for all write
6116 accesses to memory.  Enabled by default.
6118 @item -fchkp-store-bounds
6119 @opindex fchkp-store-bounds
6120 @opindex fno-chkp-store-bounds
6121 Instructs Pointer Bounds Checker to generate bounds stores for
6122 pointer writes.  Enabled by default.
6124 @item -fchkp-instrument-calls
6125 @opindex fchkp-instrument-calls
6126 @opindex fno-chkp-instrument-calls
6127 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
6128 Enabled by default.
6130 @item -fchkp-instrument-marked-only
6131 @opindex fchkp-instrument-marked-only
6132 @opindex fno-chkp-instrument-marked-only
6133 Instructs Pointer Bounds Checker to instrument only functions
6134 marked with the @code{bnd_instrument} attribute
6135 (@pxref{Function Attributes}).  Disabled by default.
6137 @item -fchkp-use-wrappers
6138 @opindex fchkp-use-wrappers
6139 @opindex fno-chkp-use-wrappers
6140 Allows Pointer Bounds Checker to replace calls to built-in functions
6141 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
6142 is used to link a program, the GCC driver automatically links
6143 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
6144 Enabled by default.
6146 @item -fdump-final-insns@r{[}=@var{file}@r{]}
6147 @opindex fdump-final-insns
6148 Dump the final internal representation (RTL) to @var{file}.  If the
6149 optional argument is omitted (or if @var{file} is @code{.}), the name
6150 of the dump file is determined by appending @code{.gkd} to the
6151 compilation output file name.
6153 @item -fcompare-debug@r{[}=@var{opts}@r{]}
6154 @opindex fcompare-debug
6155 @opindex fno-compare-debug
6156 If no error occurs during compilation, run the compiler a second time,
6157 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
6158 passed to the second compilation.  Dump the final internal
6159 representation in both compilations, and print an error if they differ.
6161 If the equal sign is omitted, the default @option{-gtoggle} is used.
6163 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
6164 and nonzero, implicitly enables @option{-fcompare-debug}.  If
6165 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
6166 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
6167 is used.
6169 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
6170 is equivalent to @option{-fno-compare-debug}, which disables the dumping
6171 of the final representation and the second compilation, preventing even
6172 @env{GCC_COMPARE_DEBUG} from taking effect.
6174 To verify full coverage during @option{-fcompare-debug} testing, set
6175 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
6176 which GCC rejects as an invalid option in any actual compilation
6177 (rather than preprocessing, assembly or linking).  To get just a
6178 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
6179 not overridden} will do.
6181 @item -fcompare-debug-second
6182 @opindex fcompare-debug-second
6183 This option is implicitly passed to the compiler for the second
6184 compilation requested by @option{-fcompare-debug}, along with options to
6185 silence warnings, and omitting other options that would cause
6186 side-effect compiler outputs to files or to the standard output.  Dump
6187 files and preserved temporary files are renamed so as to contain the
6188 @code{.gk} additional extension during the second compilation, to avoid
6189 overwriting those generated by the first.
6191 When this option is passed to the compiler driver, it causes the
6192 @emph{first} compilation to be skipped, which makes it useful for little
6193 other than debugging the compiler proper.
6195 @item -feliminate-dwarf2-dups
6196 @opindex feliminate-dwarf2-dups
6197 Compress DWARF 2 debugging information by eliminating duplicated
6198 information about each symbol.  This option only makes sense when
6199 generating DWARF 2 debugging information with @option{-gdwarf-2}.
6201 @item -femit-struct-debug-baseonly
6202 @opindex femit-struct-debug-baseonly
6203 Emit debug information for struct-like types
6204 only when the base name of the compilation source file
6205 matches the base name of file in which the struct is defined.
6207 This option substantially reduces the size of debugging information,
6208 but at significant potential loss in type information to the debugger.
6209 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6210 See @option{-femit-struct-debug-detailed} for more detailed control.
6212 This option works only with DWARF 2.
6214 @item -femit-struct-debug-reduced
6215 @opindex femit-struct-debug-reduced
6216 Emit debug information for struct-like types
6217 only when the base name of the compilation source file
6218 matches the base name of file in which the type is defined,
6219 unless the struct is a template or defined in a system header.
6221 This option significantly reduces the size of debugging information,
6222 with some potential loss in type information to the debugger.
6223 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6224 See @option{-femit-struct-debug-detailed} for more detailed control.
6226 This option works only with DWARF 2.
6228 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6229 @opindex femit-struct-debug-detailed
6230 Specify the struct-like types
6231 for which the compiler generates debug information.
6232 The intent is to reduce duplicate struct debug information
6233 between different object files within the same program.
6235 This option is a detailed version of
6236 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6237 which serves for most needs.
6239 A specification has the syntax@*
6240 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6242 The optional first word limits the specification to
6243 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6244 A struct type is used directly when it is the type of a variable, member.
6245 Indirect uses arise through pointers to structs.
6246 That is, when use of an incomplete struct is valid, the use is indirect.
6247 An example is
6248 @samp{struct one direct; struct two * indirect;}.
6250 The optional second word limits the specification to
6251 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6252 Generic structs are a bit complicated to explain.
6253 For C++, these are non-explicit specializations of template classes,
6254 or non-template classes within the above.
6255 Other programming languages have generics,
6256 but @option{-femit-struct-debug-detailed} does not yet implement them.
6258 The third word specifies the source files for those
6259 structs for which the compiler should emit debug information.
6260 The values @samp{none} and @samp{any} have the normal meaning.
6261 The value @samp{base} means that
6262 the base of name of the file in which the type declaration appears
6263 must match the base of the name of the main compilation file.
6264 In practice, this means that when compiling @file{foo.c}, debug information
6265 is generated for types declared in that file and @file{foo.h},
6266 but not other header files.
6267 The value @samp{sys} means those types satisfying @samp{base}
6268 or declared in system or compiler headers.
6270 You may need to experiment to determine the best settings for your application.
6272 The default is @option{-femit-struct-debug-detailed=all}.
6274 This option works only with DWARF 2.
6276 @item -fno-merge-debug-strings
6277 @opindex fmerge-debug-strings
6278 @opindex fno-merge-debug-strings
6279 Direct the linker to not merge together strings in the debugging
6280 information that are identical in different object files.  Merging is
6281 not supported by all assemblers or linkers.  Merging decreases the size
6282 of the debug information in the output file at the cost of increasing
6283 link processing time.  Merging is enabled by default.
6285 @item -fdebug-prefix-map=@var{old}=@var{new}
6286 @opindex fdebug-prefix-map
6287 When compiling files in directory @file{@var{old}}, record debugging
6288 information describing them as in @file{@var{new}} instead.
6290 @item -fno-dwarf2-cfi-asm
6291 @opindex fdwarf2-cfi-asm
6292 @opindex fno-dwarf2-cfi-asm
6293 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
6294 instead of using GAS @code{.cfi_*} directives.
6296 @cindex @command{prof}
6297 @item -p
6298 @opindex p
6299 Generate extra code to write profile information suitable for the
6300 analysis program @command{prof}.  You must use this option when compiling
6301 the source files you want data about, and you must also use it when
6302 linking.
6304 @cindex @command{gprof}
6305 @item -pg
6306 @opindex pg
6307 Generate extra code to write profile information suitable for the
6308 analysis program @command{gprof}.  You must use this option when compiling
6309 the source files you want data about, and you must also use it when
6310 linking.
6312 @item -Q
6313 @opindex Q
6314 Makes the compiler print out each function name as it is compiled, and
6315 print some statistics about each pass when it finishes.
6317 @item -ftime-report
6318 @opindex ftime-report
6319 Makes the compiler print some statistics about the time consumed by each
6320 pass when it finishes.
6322 @item -fmem-report
6323 @opindex fmem-report
6324 Makes the compiler print some statistics about permanent memory
6325 allocation when it finishes.
6327 @item -fmem-report-wpa
6328 @opindex fmem-report-wpa
6329 Makes the compiler print some statistics about permanent memory
6330 allocation for the WPA phase only.
6332 @item -fpre-ipa-mem-report
6333 @opindex fpre-ipa-mem-report
6334 @item -fpost-ipa-mem-report
6335 @opindex fpost-ipa-mem-report
6336 Makes the compiler print some statistics about permanent memory
6337 allocation before or after interprocedural optimization.
6339 @item -fprofile-report
6340 @opindex fprofile-report
6341 Makes the compiler print some statistics about consistency of the
6342 (estimated) profile and effect of individual passes.
6344 @item -fstack-usage
6345 @opindex fstack-usage
6346 Makes the compiler output stack usage information for the program, on a
6347 per-function basis.  The filename for the dump is made by appending
6348 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
6349 the output file, if explicitly specified and it is not an executable,
6350 otherwise it is the basename of the source file.  An entry is made up
6351 of three fields:
6353 @itemize
6354 @item
6355 The name of the function.
6356 @item
6357 A number of bytes.
6358 @item
6359 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
6360 @end itemize
6362 The qualifier @code{static} means that the function manipulates the stack
6363 statically: a fixed number of bytes are allocated for the frame on function
6364 entry and released on function exit; no stack adjustments are otherwise made
6365 in the function.  The second field is this fixed number of bytes.
6367 The qualifier @code{dynamic} means that the function manipulates the stack
6368 dynamically: in addition to the static allocation described above, stack
6369 adjustments are made in the body of the function, for example to push/pop
6370 arguments around function calls.  If the qualifier @code{bounded} is also
6371 present, the amount of these adjustments is bounded at compile time and
6372 the second field is an upper bound of the total amount of stack used by
6373 the function.  If it is not present, the amount of these adjustments is
6374 not bounded at compile time and the second field only represents the
6375 bounded part.
6377 @item -fprofile-arcs
6378 @opindex fprofile-arcs
6379 Add code so that program flow @dfn{arcs} are instrumented.  During
6380 execution the program records how many times each branch and call is
6381 executed and how many times it is taken or returns.  When the compiled
6382 program exits it saves this data to a file called
6383 @file{@var{auxname}.gcda} for each source file.  The data may be used for
6384 profile-directed optimizations (@option{-fbranch-probabilities}), or for
6385 test coverage analysis (@option{-ftest-coverage}).  Each object file's
6386 @var{auxname} is generated from the name of the output file, if
6387 explicitly specified and it is not the final executable, otherwise it is
6388 the basename of the source file.  In both cases any suffix is removed
6389 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
6390 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
6391 @xref{Cross-profiling}.
6393 @cindex @command{gcov}
6394 @item --coverage
6395 @opindex coverage
6397 This option is used to compile and link code instrumented for coverage
6398 analysis.  The option is a synonym for @option{-fprofile-arcs}
6399 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6400 linking).  See the documentation for those options for more details.
6402 @itemize
6404 @item
6405 Compile the source files with @option{-fprofile-arcs} plus optimization
6406 and code generation options.  For test coverage analysis, use the
6407 additional @option{-ftest-coverage} option.  You do not need to profile
6408 every source file in a program.
6410 @item
6411 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6412 (the latter implies the former).
6414 @item
6415 Run the program on a representative workload to generate the arc profile
6416 information.  This may be repeated any number of times.  You can run
6417 concurrent instances of your program, and provided that the file system
6418 supports locking, the data files will be correctly updated.  Also
6419 @code{fork} calls are detected and correctly handled (double counting
6420 will not happen).
6422 @item
6423 For profile-directed optimizations, compile the source files again with
6424 the same optimization and code generation options plus
6425 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6426 Control Optimization}).
6428 @item
6429 For test coverage analysis, use @command{gcov} to produce human readable
6430 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6431 @command{gcov} documentation for further information.
6433 @end itemize
6435 With @option{-fprofile-arcs}, for each function of your program GCC
6436 creates a program flow graph, then finds a spanning tree for the graph.
6437 Only arcs that are not on the spanning tree have to be instrumented: the
6438 compiler adds code to count the number of times that these arcs are
6439 executed.  When an arc is the only exit or only entrance to a block, the
6440 instrumentation code can be added to the block; otherwise, a new basic
6441 block must be created to hold the instrumentation code.
6443 @need 2000
6444 @item -ftest-coverage
6445 @opindex ftest-coverage
6446 Produce a notes file that the @command{gcov} code-coverage utility
6447 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6448 show program coverage.  Each source file's note file is called
6449 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6450 above for a description of @var{auxname} and instructions on how to
6451 generate test coverage data.  Coverage data matches the source files
6452 more closely if you do not optimize.
6454 @item -fdbg-cnt-list
6455 @opindex fdbg-cnt-list
6456 Print the name and the counter upper bound for all debug counters.
6459 @item -fdbg-cnt=@var{counter-value-list}
6460 @opindex fdbg-cnt
6461 Set the internal debug counter upper bound.  @var{counter-value-list}
6462 is a comma-separated list of @var{name}:@var{value} pairs
6463 which sets the upper bound of each debug counter @var{name} to @var{value}.
6464 All debug counters have the initial upper bound of @code{UINT_MAX};
6465 thus @code{dbg_cnt} returns true always unless the upper bound
6466 is set by this option.
6467 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6468 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6470 @item -fenable-@var{kind}-@var{pass}
6471 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6472 @opindex fdisable-
6473 @opindex fenable-
6475 This is a set of options that are used to explicitly disable/enable
6476 optimization passes.  These options are intended for use for debugging GCC.
6477 Compiler users should use regular options for enabling/disabling
6478 passes instead.
6480 @table @gcctabopt
6482 @item -fdisable-ipa-@var{pass}
6483 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6484 statically invoked in the compiler multiple times, the pass name should be
6485 appended with a sequential number starting from 1.
6487 @item -fdisable-rtl-@var{pass}
6488 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6489 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6490 statically invoked in the compiler multiple times, the pass name should be
6491 appended with a sequential number starting from 1.  @var{range-list} is a 
6492 comma-separated list of function ranges or assembler names.  Each range is a number
6493 pair separated by a colon.  The range is inclusive in both ends.  If the range
6494 is trivial, the number pair can be simplified as a single number.  If the
6495 function's call graph node's @var{uid} falls within one of the specified ranges,
6496 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6497 function header of a dump file, and the pass names can be dumped by using
6498 option @option{-fdump-passes}.
6500 @item -fdisable-tree-@var{pass}
6501 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6502 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6503 option arguments.
6505 @item -fenable-ipa-@var{pass}
6506 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6507 statically invoked in the compiler multiple times, the pass name should be
6508 appended with a sequential number starting from 1.
6510 @item -fenable-rtl-@var{pass}
6511 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6512 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6513 description and examples.
6515 @item -fenable-tree-@var{pass}
6516 @itemx -fenable-tree-@var{pass}=@var{range-list}
6517 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6518 of option arguments.
6520 @end table
6522 Here are some examples showing uses of these options.
6524 @smallexample
6526 # disable ccp1 for all functions
6527    -fdisable-tree-ccp1
6528 # disable complete unroll for function whose cgraph node uid is 1
6529    -fenable-tree-cunroll=1
6530 # disable gcse2 for functions at the following ranges [1,1],
6531 # [300,400], and [400,1000]
6532 # disable gcse2 for functions foo and foo2
6533    -fdisable-rtl-gcse2=foo,foo2
6534 # disable early inlining
6535    -fdisable-tree-einline
6536 # disable ipa inlining
6537    -fdisable-ipa-inline
6538 # enable tree full unroll
6539    -fenable-tree-unroll
6541 @end smallexample
6543 @item -d@var{letters}
6544 @itemx -fdump-rtl-@var{pass}
6545 @itemx -fdump-rtl-@var{pass}=@var{filename}
6546 @opindex d
6547 @opindex fdump-rtl-@var{pass}
6548 Says to make debugging dumps during compilation at times specified by
6549 @var{letters}.  This is used for debugging the RTL-based passes of the
6550 compiler.  The file names for most of the dumps are made by appending
6551 a pass number and a word to the @var{dumpname}, and the files are
6552 created in the directory of the output file. In case of
6553 @option{=@var{filename}} option, the dump is output on the given file
6554 instead of the pass numbered dump files. Note that the pass number is
6555 computed statically as passes get registered into the pass manager.
6556 Thus the numbering is not related to the dynamic order of execution of
6557 passes.  In particular, a pass installed by a plugin could have a
6558 number over 200 even if it executed quite early.  @var{dumpname} is
6559 generated from the name of the output file, if explicitly specified
6560 and it is not an executable, otherwise it is the basename of the
6561 source file. These switches may have different effects when
6562 @option{-E} is used for preprocessing.
6564 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6565 @option{-d} option @var{letters}.  Here are the possible
6566 letters for use in @var{pass} and @var{letters}, and their meanings:
6568 @table @gcctabopt
6570 @item -fdump-rtl-alignments
6571 @opindex fdump-rtl-alignments
6572 Dump after branch alignments have been computed.
6574 @item -fdump-rtl-asmcons
6575 @opindex fdump-rtl-asmcons
6576 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6578 @item -fdump-rtl-auto_inc_dec
6579 @opindex fdump-rtl-auto_inc_dec
6580 Dump after auto-inc-dec discovery.  This pass is only run on
6581 architectures that have auto inc or auto dec instructions.
6583 @item -fdump-rtl-barriers
6584 @opindex fdump-rtl-barriers
6585 Dump after cleaning up the barrier instructions.
6587 @item -fdump-rtl-bbpart
6588 @opindex fdump-rtl-bbpart
6589 Dump after partitioning hot and cold basic blocks.
6591 @item -fdump-rtl-bbro
6592 @opindex fdump-rtl-bbro
6593 Dump after block reordering.
6595 @item -fdump-rtl-btl1
6596 @itemx -fdump-rtl-btl2
6597 @opindex fdump-rtl-btl2
6598 @opindex fdump-rtl-btl2
6599 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6600 after the two branch
6601 target load optimization passes.
6603 @item -fdump-rtl-bypass
6604 @opindex fdump-rtl-bypass
6605 Dump after jump bypassing and control flow optimizations.
6607 @item -fdump-rtl-combine
6608 @opindex fdump-rtl-combine
6609 Dump after the RTL instruction combination pass.
6611 @item -fdump-rtl-compgotos
6612 @opindex fdump-rtl-compgotos
6613 Dump after duplicating the computed gotos.
6615 @item -fdump-rtl-ce1
6616 @itemx -fdump-rtl-ce2
6617 @itemx -fdump-rtl-ce3
6618 @opindex fdump-rtl-ce1
6619 @opindex fdump-rtl-ce2
6620 @opindex fdump-rtl-ce3
6621 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6622 @option{-fdump-rtl-ce3} enable dumping after the three
6623 if conversion passes.
6625 @item -fdump-rtl-cprop_hardreg
6626 @opindex fdump-rtl-cprop_hardreg
6627 Dump after hard register copy propagation.
6629 @item -fdump-rtl-csa
6630 @opindex fdump-rtl-csa
6631 Dump after combining stack adjustments.
6633 @item -fdump-rtl-cse1
6634 @itemx -fdump-rtl-cse2
6635 @opindex fdump-rtl-cse1
6636 @opindex fdump-rtl-cse2
6637 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6638 the two common subexpression elimination passes.
6640 @item -fdump-rtl-dce
6641 @opindex fdump-rtl-dce
6642 Dump after the standalone dead code elimination passes.
6644 @item -fdump-rtl-dbr
6645 @opindex fdump-rtl-dbr
6646 Dump after delayed branch scheduling.
6648 @item -fdump-rtl-dce1
6649 @itemx -fdump-rtl-dce2
6650 @opindex fdump-rtl-dce1
6651 @opindex fdump-rtl-dce2
6652 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6653 the two dead store elimination passes.
6655 @item -fdump-rtl-eh
6656 @opindex fdump-rtl-eh
6657 Dump after finalization of EH handling code.
6659 @item -fdump-rtl-eh_ranges
6660 @opindex fdump-rtl-eh_ranges
6661 Dump after conversion of EH handling range regions.
6663 @item -fdump-rtl-expand
6664 @opindex fdump-rtl-expand
6665 Dump after RTL generation.
6667 @item -fdump-rtl-fwprop1
6668 @itemx -fdump-rtl-fwprop2
6669 @opindex fdump-rtl-fwprop1
6670 @opindex fdump-rtl-fwprop2
6671 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6672 dumping after the two forward propagation passes.
6674 @item -fdump-rtl-gcse1
6675 @itemx -fdump-rtl-gcse2
6676 @opindex fdump-rtl-gcse1
6677 @opindex fdump-rtl-gcse2
6678 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6679 after global common subexpression elimination.
6681 @item -fdump-rtl-init-regs
6682 @opindex fdump-rtl-init-regs
6683 Dump after the initialization of the registers.
6685 @item -fdump-rtl-initvals
6686 @opindex fdump-rtl-initvals
6687 Dump after the computation of the initial value sets.
6689 @item -fdump-rtl-into_cfglayout
6690 @opindex fdump-rtl-into_cfglayout
6691 Dump after converting to cfglayout mode.
6693 @item -fdump-rtl-ira
6694 @opindex fdump-rtl-ira
6695 Dump after iterated register allocation.
6697 @item -fdump-rtl-jump
6698 @opindex fdump-rtl-jump
6699 Dump after the second jump optimization.
6701 @item -fdump-rtl-loop2
6702 @opindex fdump-rtl-loop2
6703 @option{-fdump-rtl-loop2} enables dumping after the rtl
6704 loop optimization passes.
6706 @item -fdump-rtl-mach
6707 @opindex fdump-rtl-mach
6708 Dump after performing the machine dependent reorganization pass, if that
6709 pass exists.
6711 @item -fdump-rtl-mode_sw
6712 @opindex fdump-rtl-mode_sw
6713 Dump after removing redundant mode switches.
6715 @item -fdump-rtl-rnreg
6716 @opindex fdump-rtl-rnreg
6717 Dump after register renumbering.
6719 @item -fdump-rtl-outof_cfglayout
6720 @opindex fdump-rtl-outof_cfglayout
6721 Dump after converting from cfglayout mode.
6723 @item -fdump-rtl-peephole2
6724 @opindex fdump-rtl-peephole2
6725 Dump after the peephole pass.
6727 @item -fdump-rtl-postreload
6728 @opindex fdump-rtl-postreload
6729 Dump after post-reload optimizations.
6731 @item -fdump-rtl-pro_and_epilogue
6732 @opindex fdump-rtl-pro_and_epilogue
6733 Dump after generating the function prologues and epilogues.
6735 @item -fdump-rtl-sched1
6736 @itemx -fdump-rtl-sched2
6737 @opindex fdump-rtl-sched1
6738 @opindex fdump-rtl-sched2
6739 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6740 after the basic block scheduling passes.
6742 @item -fdump-rtl-ree
6743 @opindex fdump-rtl-ree
6744 Dump after sign/zero extension elimination.
6746 @item -fdump-rtl-seqabstr
6747 @opindex fdump-rtl-seqabstr
6748 Dump after common sequence discovery.
6750 @item -fdump-rtl-shorten
6751 @opindex fdump-rtl-shorten
6752 Dump after shortening branches.
6754 @item -fdump-rtl-sibling
6755 @opindex fdump-rtl-sibling
6756 Dump after sibling call optimizations.
6758 @item -fdump-rtl-split1
6759 @itemx -fdump-rtl-split2
6760 @itemx -fdump-rtl-split3
6761 @itemx -fdump-rtl-split4
6762 @itemx -fdump-rtl-split5
6763 @opindex fdump-rtl-split1
6764 @opindex fdump-rtl-split2
6765 @opindex fdump-rtl-split3
6766 @opindex fdump-rtl-split4
6767 @opindex fdump-rtl-split5
6768 These options enable dumping after five rounds of
6769 instruction splitting.
6771 @item -fdump-rtl-sms
6772 @opindex fdump-rtl-sms
6773 Dump after modulo scheduling.  This pass is only run on some
6774 architectures.
6776 @item -fdump-rtl-stack
6777 @opindex fdump-rtl-stack
6778 Dump after conversion from GCC's ``flat register file'' registers to the
6779 x87's stack-like registers.  This pass is only run on x86 variants.
6781 @item -fdump-rtl-subreg1
6782 @itemx -fdump-rtl-subreg2
6783 @opindex fdump-rtl-subreg1
6784 @opindex fdump-rtl-subreg2
6785 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6786 the two subreg expansion passes.
6788 @item -fdump-rtl-unshare
6789 @opindex fdump-rtl-unshare
6790 Dump after all rtl has been unshared.
6792 @item -fdump-rtl-vartrack
6793 @opindex fdump-rtl-vartrack
6794 Dump after variable tracking.
6796 @item -fdump-rtl-vregs
6797 @opindex fdump-rtl-vregs
6798 Dump after converting virtual registers to hard registers.
6800 @item -fdump-rtl-web
6801 @opindex fdump-rtl-web
6802 Dump after live range splitting.
6804 @item -fdump-rtl-regclass
6805 @itemx -fdump-rtl-subregs_of_mode_init
6806 @itemx -fdump-rtl-subregs_of_mode_finish
6807 @itemx -fdump-rtl-dfinit
6808 @itemx -fdump-rtl-dfinish
6809 @opindex fdump-rtl-regclass
6810 @opindex fdump-rtl-subregs_of_mode_init
6811 @opindex fdump-rtl-subregs_of_mode_finish
6812 @opindex fdump-rtl-dfinit
6813 @opindex fdump-rtl-dfinish
6814 These dumps are defined but always produce empty files.
6816 @item -da
6817 @itemx -fdump-rtl-all
6818 @opindex da
6819 @opindex fdump-rtl-all
6820 Produce all the dumps listed above.
6822 @item -dA
6823 @opindex dA
6824 Annotate the assembler output with miscellaneous debugging information.
6826 @item -dD
6827 @opindex dD
6828 Dump all macro definitions, at the end of preprocessing, in addition to
6829 normal output.
6831 @item -dH
6832 @opindex dH
6833 Produce a core dump whenever an error occurs.
6835 @item -dp
6836 @opindex dp
6837 Annotate the assembler output with a comment indicating which
6838 pattern and alternative is used.  The length of each instruction is
6839 also printed.
6841 @item -dP
6842 @opindex dP
6843 Dump the RTL in the assembler output as a comment before each instruction.
6844 Also turns on @option{-dp} annotation.
6846 @item -dx
6847 @opindex dx
6848 Just generate RTL for a function instead of compiling it.  Usually used
6849 with @option{-fdump-rtl-expand}.
6850 @end table
6852 @item -fdump-noaddr
6853 @opindex fdump-noaddr
6854 When doing debugging dumps, suppress address output.  This makes it more
6855 feasible to use diff on debugging dumps for compiler invocations with
6856 different compiler binaries and/or different
6857 text / bss / data / heap / stack / dso start locations.
6859 @item -freport-bug
6860 @opindex freport-bug
6861 Collect and dump debug information into temporary file if ICE in C/C++
6862 compiler occured.
6864 @item -fdump-unnumbered
6865 @opindex fdump-unnumbered
6866 When doing debugging dumps, suppress instruction numbers and address output.
6867 This makes it more feasible to use diff on debugging dumps for compiler
6868 invocations with different options, in particular with and without
6869 @option{-g}.
6871 @item -fdump-unnumbered-links
6872 @opindex fdump-unnumbered-links
6873 When doing debugging dumps (see @option{-d} option above), suppress
6874 instruction numbers for the links to the previous and next instructions
6875 in a sequence.
6877 @item -fdump-translation-unit @r{(C++ only)}
6878 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6879 @opindex fdump-translation-unit
6880 Dump a representation of the tree structure for the entire translation
6881 unit to a file.  The file name is made by appending @file{.tu} to the
6882 source file name, and the file is created in the same directory as the
6883 output file.  If the @samp{-@var{options}} form is used, @var{options}
6884 controls the details of the dump as described for the
6885 @option{-fdump-tree} options.
6887 @item -fdump-class-hierarchy @r{(C++ only)}
6888 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6889 @opindex fdump-class-hierarchy
6890 Dump a representation of each class's hierarchy and virtual function
6891 table layout to a file.  The file name is made by appending
6892 @file{.class} to the source file name, and the file is created in the
6893 same directory as the output file.  If the @samp{-@var{options}} form
6894 is used, @var{options} controls the details of the dump as described
6895 for the @option{-fdump-tree} options.
6897 @item -fdump-ipa-@var{switch}
6898 @opindex fdump-ipa
6899 Control the dumping at various stages of inter-procedural analysis
6900 language tree to a file.  The file name is generated by appending a
6901 switch specific suffix to the source file name, and the file is created
6902 in the same directory as the output file.  The following dumps are
6903 possible:
6905 @table @samp
6906 @item all
6907 Enables all inter-procedural analysis dumps.
6909 @item cgraph
6910 Dumps information about call-graph optimization, unused function removal,
6911 and inlining decisions.
6913 @item inline
6914 Dump after function inlining.
6916 @end table
6918 @item -fdump-passes
6919 @opindex fdump-passes
6920 Dump the list of optimization passes that are turned on and off by
6921 the current command-line options.
6923 @item -fdump-statistics-@var{option}
6924 @opindex fdump-statistics
6925 Enable and control dumping of pass statistics in a separate file.  The
6926 file name is generated by appending a suffix ending in
6927 @samp{.statistics} to the source file name, and the file is created in
6928 the same directory as the output file.  If the @samp{-@var{option}}
6929 form is used, @samp{-stats} causes counters to be summed over the
6930 whole compilation unit while @samp{-details} dumps every event as
6931 the passes generate them.  The default with no option is to sum
6932 counters for each function compiled.
6934 @item -fdump-tree-@var{switch}
6935 @itemx -fdump-tree-@var{switch}-@var{options}
6936 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6937 @opindex fdump-tree
6938 Control the dumping at various stages of processing the intermediate
6939 language tree to a file.  The file name is generated by appending a
6940 switch-specific suffix to the source file name, and the file is
6941 created in the same directory as the output file. In case of
6942 @option{=@var{filename}} option, the dump is output on the given file
6943 instead of the auto named dump files.  If the @samp{-@var{options}}
6944 form is used, @var{options} is a list of @samp{-} separated options
6945 which control the details of the dump.  Not all options are applicable
6946 to all dumps; those that are not meaningful are ignored.  The
6947 following options are available
6949 @table @samp
6950 @item address
6951 Print the address of each node.  Usually this is not meaningful as it
6952 changes according to the environment and source file.  Its primary use
6953 is for tying up a dump file with a debug environment.
6954 @item asmname
6955 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6956 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6957 use working backward from mangled names in the assembly file.
6958 @item slim
6959 When dumping front-end intermediate representations, inhibit dumping
6960 of members of a scope or body of a function merely because that scope
6961 has been reached.  Only dump such items when they are directly reachable
6962 by some other path.
6964 When dumping pretty-printed trees, this option inhibits dumping the
6965 bodies of control structures.
6967 When dumping RTL, print the RTL in slim (condensed) form instead of
6968 the default LISP-like representation.
6969 @item raw
6970 Print a raw representation of the tree.  By default, trees are
6971 pretty-printed into a C-like representation.
6972 @item details
6973 Enable more detailed dumps (not honored by every dump option). Also
6974 include information from the optimization passes.
6975 @item stats
6976 Enable dumping various statistics about the pass (not honored by every dump
6977 option).
6978 @item blocks
6979 Enable showing basic block boundaries (disabled in raw dumps).
6980 @item graph
6981 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6982 dump a representation of the control flow graph suitable for viewing with
6983 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6984 the file is pretty-printed as a subgraph, so that GraphViz can render them
6985 all in a single plot.
6987 This option currently only works for RTL dumps, and the RTL is always
6988 dumped in slim form.
6989 @item vops
6990 Enable showing virtual operands for every statement.
6991 @item lineno
6992 Enable showing line numbers for statements.
6993 @item uid
6994 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6995 @item verbose
6996 Enable showing the tree dump for each statement.
6997 @item eh
6998 Enable showing the EH region number holding each statement.
6999 @item scev
7000 Enable showing scalar evolution analysis details.
7001 @item optimized
7002 Enable showing optimization information (only available in certain
7003 passes).
7004 @item missed
7005 Enable showing missed optimization information (only available in certain
7006 passes).
7007 @item note
7008 Enable other detailed optimization information (only available in
7009 certain passes).
7010 @item =@var{filename}
7011 Instead of an auto named dump file, output into the given file
7012 name. The file names @file{stdout} and @file{stderr} are treated
7013 specially and are considered already open standard streams. For
7014 example,
7016 @smallexample
7017 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
7018      -fdump-tree-pre=stderr file.c
7019 @end smallexample
7021 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
7022 output on to @file{stderr}. If two conflicting dump filenames are
7023 given for the same pass, then the latter option overrides the earlier
7024 one.
7026 @item all
7027 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
7028 and @option{lineno}.
7030 @item optall
7031 Turn on all optimization options, i.e., @option{optimized},
7032 @option{missed}, and @option{note}.
7033 @end table
7035 The following tree dumps are possible:
7036 @table @samp
7038 @item original
7039 @opindex fdump-tree-original
7040 Dump before any tree based optimization, to @file{@var{file}.original}.
7042 @item optimized
7043 @opindex fdump-tree-optimized
7044 Dump after all tree based optimization, to @file{@var{file}.optimized}.
7046 @item gimple
7047 @opindex fdump-tree-gimple
7048 Dump each function before and after the gimplification pass to a file.  The
7049 file name is made by appending @file{.gimple} to the source file name.
7051 @item cfg
7052 @opindex fdump-tree-cfg
7053 Dump the control flow graph of each function to a file.  The file name is
7054 made by appending @file{.cfg} to the source file name.
7056 @item ch
7057 @opindex fdump-tree-ch
7058 Dump each function after copying loop headers.  The file name is made by
7059 appending @file{.ch} to the source file name.
7061 @item ssa
7062 @opindex fdump-tree-ssa
7063 Dump SSA related information to a file.  The file name is made by appending
7064 @file{.ssa} to the source file name.
7066 @item alias
7067 @opindex fdump-tree-alias
7068 Dump aliasing information for each function.  The file name is made by
7069 appending @file{.alias} to the source file name.
7071 @item ccp
7072 @opindex fdump-tree-ccp
7073 Dump each function after CCP@.  The file name is made by appending
7074 @file{.ccp} to the source file name.
7076 @item storeccp
7077 @opindex fdump-tree-storeccp
7078 Dump each function after STORE-CCP@.  The file name is made by appending
7079 @file{.storeccp} to the source file name.
7081 @item pre
7082 @opindex fdump-tree-pre
7083 Dump trees after partial redundancy elimination.  The file name is made
7084 by appending @file{.pre} to the source file name.
7086 @item fre
7087 @opindex fdump-tree-fre
7088 Dump trees after full redundancy elimination.  The file name is made
7089 by appending @file{.fre} to the source file name.
7091 @item copyprop
7092 @opindex fdump-tree-copyprop
7093 Dump trees after copy propagation.  The file name is made
7094 by appending @file{.copyprop} to the source file name.
7096 @item store_copyprop
7097 @opindex fdump-tree-store_copyprop
7098 Dump trees after store copy-propagation.  The file name is made
7099 by appending @file{.store_copyprop} to the source file name.
7101 @item dce
7102 @opindex fdump-tree-dce
7103 Dump each function after dead code elimination.  The file name is made by
7104 appending @file{.dce} to the source file name.
7106 @item sra
7107 @opindex fdump-tree-sra
7108 Dump each function after performing scalar replacement of aggregates.  The
7109 file name is made by appending @file{.sra} to the source file name.
7111 @item sink
7112 @opindex fdump-tree-sink
7113 Dump each function after performing code sinking.  The file name is made
7114 by appending @file{.sink} to the source file name.
7116 @item dom
7117 @opindex fdump-tree-dom
7118 Dump each function after applying dominator tree optimizations.  The file
7119 name is made by appending @file{.dom} to the source file name.
7121 @item dse
7122 @opindex fdump-tree-dse
7123 Dump each function after applying dead store elimination.  The file
7124 name is made by appending @file{.dse} to the source file name.
7126 @item phiopt
7127 @opindex fdump-tree-phiopt
7128 Dump each function after optimizing PHI nodes into straightline code.  The file
7129 name is made by appending @file{.phiopt} to the source file name.
7131 @item forwprop
7132 @opindex fdump-tree-forwprop
7133 Dump each function after forward propagating single use variables.  The file
7134 name is made by appending @file{.forwprop} to the source file name.
7136 @item nrv
7137 @opindex fdump-tree-nrv
7138 Dump each function after applying the named return value optimization on
7139 generic trees.  The file name is made by appending @file{.nrv} to the source
7140 file name.
7142 @item vect
7143 @opindex fdump-tree-vect
7144 Dump each function after applying vectorization of loops.  The file name is
7145 made by appending @file{.vect} to the source file name.
7147 @item slp
7148 @opindex fdump-tree-slp
7149 Dump each function after applying vectorization of basic blocks.  The file name
7150 is made by appending @file{.slp} to the source file name.
7152 @item vrp
7153 @opindex fdump-tree-vrp
7154 Dump each function after Value Range Propagation (VRP).  The file name
7155 is made by appending @file{.vrp} to the source file name.
7157 @item all
7158 @opindex fdump-tree-all
7159 Enable all the available tree dumps with the flags provided in this option.
7160 @end table
7162 @item -fopt-info
7163 @itemx -fopt-info-@var{options}
7164 @itemx -fopt-info-@var{options}=@var{filename}
7165 @opindex fopt-info
7166 Controls optimization dumps from various optimization passes. If the
7167 @samp{-@var{options}} form is used, @var{options} is a list of
7168 @samp{-} separated option keywords to select the dump details and
7169 optimizations.  
7171 The @var{options} can be divided into two groups: options describing the
7172 verbosity of the dump, and options describing which optimizations
7173 should be included. The options from both the groups can be freely
7174 mixed as they are non-overlapping. However, in case of any conflicts,
7175 the later options override the earlier options on the command
7176 line. 
7178 The following options control the dump verbosity:
7180 @table @samp
7181 @item optimized
7182 Print information when an optimization is successfully applied. It is
7183 up to a pass to decide which information is relevant. For example, the
7184 vectorizer passes print the source location of loops which are
7185 successfully vectorized.
7186 @item missed
7187 Print information about missed optimizations. Individual passes
7188 control which information to include in the output. 
7189 @item note
7190 Print verbose information about optimizations, such as certain
7191 transformations, more detailed messages about decisions etc.
7192 @item all
7193 Print detailed optimization information. This includes
7194 @samp{optimized}, @samp{missed}, and @samp{note}.
7195 @end table
7197 One or more of the following option keywords can be used to describe a
7198 group of optimizations:
7200 @table @samp
7201 @item ipa
7202 Enable dumps from all interprocedural optimizations.
7203 @item loop
7204 Enable dumps from all loop optimizations.
7205 @item inline
7206 Enable dumps from all inlining optimizations.
7207 @item vec
7208 Enable dumps from all vectorization optimizations.
7209 @item optall
7210 Enable dumps from all optimizations. This is a superset of
7211 the optimization groups listed above.
7212 @end table
7214 If @var{options} is
7215 omitted, it defaults to @samp{optimized-optall}, which means to dump all
7216 info about successful optimizations from all the passes.  
7218 If the @var{filename} is provided, then the dumps from all the
7219 applicable optimizations are concatenated into the @var{filename}.
7220 Otherwise the dump is output onto @file{stderr}. Though multiple
7221 @option{-fopt-info} options are accepted, only one of them can include
7222 a @var{filename}. If other filenames are provided then all but the
7223 first such option are ignored.
7225 Note that the output @var{filename} is overwritten
7226 in case of multiple translation units. If a combined output from
7227 multiple translation units is desired, @file{stderr} should be used
7228 instead.
7230 In the following example, the optimization info is output to
7231 @file{stderr}:
7233 @smallexample
7234 gcc -O3 -fopt-info
7235 @end smallexample
7237 This example:
7238 @smallexample
7239 gcc -O3 -fopt-info-missed=missed.all
7240 @end smallexample
7242 @noindent
7243 outputs missed optimization report from all the passes into
7244 @file{missed.all}, and this one:
7246 @smallexample
7247 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
7248 @end smallexample
7250 @noindent
7251 prints information about missed optimization opportunities from
7252 vectorization passes on @file{stderr}.  
7253 Note that @option{-fopt-info-vec-missed} is equivalent to 
7254 @option{-fopt-info-missed-vec}.
7256 As another example,
7257 @smallexample
7258 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
7259 @end smallexample
7261 @noindent
7262 outputs information about missed optimizations as well as
7263 optimized locations from all the inlining passes into
7264 @file{inline.txt}.
7266 Finally, consider:
7268 @smallexample
7269 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
7270 @end smallexample
7272 @noindent
7273 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
7274 in conflict since only one output file is allowed. In this case, only
7275 the first option takes effect and the subsequent options are
7276 ignored. Thus only @file{vec.miss} is produced which contains
7277 dumps from the vectorizer about missed opportunities.
7279 @item -frandom-seed=@var{number}
7280 @opindex frandom-seed
7281 This option provides a seed that GCC uses in place of
7282 random numbers in generating certain symbol names
7283 that have to be different in every compiled file.  It is also used to
7284 place unique stamps in coverage data files and the object files that
7285 produce them.  You can use the @option{-frandom-seed} option to produce
7286 reproducibly identical object files.
7288 The @var{number} should be different for every file you compile.
7290 @item -fsched-verbose=@var{n}
7291 @opindex fsched-verbose
7292 On targets that use instruction scheduling, this option controls the
7293 amount of debugging output the scheduler prints.  This information is
7294 written to standard error, unless @option{-fdump-rtl-sched1} or
7295 @option{-fdump-rtl-sched2} is specified, in which case it is output
7296 to the usual dump listing file, @file{.sched1} or @file{.sched2}
7297 respectively.  However for @var{n} greater than nine, the output is
7298 always printed to standard error.
7300 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
7301 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
7302 For @var{n} greater than one, it also output basic block probabilities,
7303 detailed ready list information and unit/insn info.  For @var{n} greater
7304 than two, it includes RTL at abort point, control-flow and regions info.
7305 And for @var{n} over four, @option{-fsched-verbose} also includes
7306 dependence info.
7308 @item -save-temps
7309 @itemx -save-temps=cwd
7310 @opindex save-temps
7311 Store the usual ``temporary'' intermediate files permanently; place them
7312 in the current directory and name them based on the source file.  Thus,
7313 compiling @file{foo.c} with @option{-c -save-temps} produces files
7314 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
7315 preprocessed @file{foo.i} output file even though the compiler now
7316 normally uses an integrated preprocessor.
7318 When used in combination with the @option{-x} command-line option,
7319 @option{-save-temps} is sensible enough to avoid over writing an
7320 input source file with the same extension as an intermediate file.
7321 The corresponding intermediate file may be obtained by renaming the
7322 source file before using @option{-save-temps}.
7324 If you invoke GCC in parallel, compiling several different source
7325 files that share a common base name in different subdirectories or the
7326 same source file compiled for multiple output destinations, it is
7327 likely that the different parallel compilers will interfere with each
7328 other, and overwrite the temporary files.  For instance:
7330 @smallexample
7331 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
7332 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
7333 @end smallexample
7335 may result in @file{foo.i} and @file{foo.o} being written to
7336 simultaneously by both compilers.
7338 @item -save-temps=obj
7339 @opindex save-temps=obj
7340 Store the usual ``temporary'' intermediate files permanently.  If the
7341 @option{-o} option is used, the temporary files are based on the
7342 object file.  If the @option{-o} option is not used, the
7343 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
7345 For example:
7347 @smallexample
7348 gcc -save-temps=obj -c foo.c
7349 gcc -save-temps=obj -c bar.c -o dir/xbar.o
7350 gcc -save-temps=obj foobar.c -o dir2/yfoobar
7351 @end smallexample
7353 @noindent
7354 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
7355 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
7356 @file{dir2/yfoobar.o}.
7358 @item -time@r{[}=@var{file}@r{]}
7359 @opindex time
7360 Report the CPU time taken by each subprocess in the compilation
7361 sequence.  For C source files, this is the compiler proper and assembler
7362 (plus the linker if linking is done).
7364 Without the specification of an output file, the output looks like this:
7366 @smallexample
7367 # cc1 0.12 0.01
7368 # as 0.00 0.01
7369 @end smallexample
7371 The first number on each line is the ``user time'', that is time spent
7372 executing the program itself.  The second number is ``system time'',
7373 time spent executing operating system routines on behalf of the program.
7374 Both numbers are in seconds.
7376 With the specification of an output file, the output is appended to the
7377 named file, and it looks like this:
7379 @smallexample
7380 0.12 0.01 cc1 @var{options}
7381 0.00 0.01 as @var{options}
7382 @end smallexample
7384 The ``user time'' and the ``system time'' are moved before the program
7385 name, and the options passed to the program are displayed, so that one
7386 can later tell what file was being compiled, and with which options.
7388 @item -fvar-tracking
7389 @opindex fvar-tracking
7390 Run variable tracking pass.  It computes where variables are stored at each
7391 position in code.  Better debugging information is then generated
7392 (if the debugging information format supports this information).
7394 It is enabled by default when compiling with optimization (@option{-Os},
7395 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7396 the debug info format supports it.
7398 @item -fvar-tracking-assignments
7399 @opindex fvar-tracking-assignments
7400 @opindex fno-var-tracking-assignments
7401 Annotate assignments to user variables early in the compilation and
7402 attempt to carry the annotations over throughout the compilation all the
7403 way to the end, in an attempt to improve debug information while
7404 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7406 It can be enabled even if var-tracking is disabled, in which case
7407 annotations are created and maintained, but discarded at the end.
7408 By default, this flag is enabled together with @option{-fvar-tracking},
7409 except when selective scheduling is enabled.
7411 @item -fvar-tracking-assignments-toggle
7412 @opindex fvar-tracking-assignments-toggle
7413 @opindex fno-var-tracking-assignments-toggle
7414 Toggle @option{-fvar-tracking-assignments}, in the same way that
7415 @option{-gtoggle} toggles @option{-g}.
7417 @item -print-file-name=@var{library}
7418 @opindex print-file-name
7419 Print the full absolute name of the library file @var{library} that
7420 would be used when linking---and don't do anything else.  With this
7421 option, GCC does not compile or link anything; it just prints the
7422 file name.
7424 @item -print-multi-directory
7425 @opindex print-multi-directory
7426 Print the directory name corresponding to the multilib selected by any
7427 other switches present in the command line.  This directory is supposed
7428 to exist in @env{GCC_EXEC_PREFIX}.
7430 @item -print-multi-lib
7431 @opindex print-multi-lib
7432 Print the mapping from multilib directory names to compiler switches
7433 that enable them.  The directory name is separated from the switches by
7434 @samp{;}, and each switch starts with an @samp{@@} instead of the
7435 @samp{-}, without spaces between multiple switches.  This is supposed to
7436 ease shell processing.
7438 @item -print-multi-os-directory
7439 @opindex print-multi-os-directory
7440 Print the path to OS libraries for the selected
7441 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7442 present in the @file{lib} subdirectory and no multilibs are used, this is
7443 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7444 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7445 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7446 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7448 @item -print-multiarch
7449 @opindex print-multiarch
7450 Print the path to OS libraries for the selected multiarch,
7451 relative to some @file{lib} subdirectory.
7453 @item -print-prog-name=@var{program}
7454 @opindex print-prog-name
7455 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
7457 @item -print-libgcc-file-name
7458 @opindex print-libgcc-file-name
7459 Same as @option{-print-file-name=libgcc.a}.
7461 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7462 but you do want to link with @file{libgcc.a}.  You can do:
7464 @smallexample
7465 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7466 @end smallexample
7468 @item -print-search-dirs
7469 @opindex print-search-dirs
7470 Print the name of the configured installation directory and a list of
7471 program and library directories @command{gcc} searches---and don't do anything else.
7473 This is useful when @command{gcc} prints the error message
7474 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7475 To resolve this you either need to put @file{cpp0} and the other compiler
7476 components where @command{gcc} expects to find them, or you can set the environment
7477 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7478 Don't forget the trailing @samp{/}.
7479 @xref{Environment Variables}.
7481 @item -print-sysroot
7482 @opindex print-sysroot
7483 Print the target sysroot directory that is used during
7484 compilation.  This is the target sysroot specified either at configure
7485 time or using the @option{--sysroot} option, possibly with an extra
7486 suffix that depends on compilation options.  If no target sysroot is
7487 specified, the option prints nothing.
7489 @item -print-sysroot-headers-suffix
7490 @opindex print-sysroot-headers-suffix
7491 Print the suffix added to the target sysroot when searching for
7492 headers, or give an error if the compiler is not configured with such
7493 a suffix---and don't do anything else.
7495 @item -dumpmachine
7496 @opindex dumpmachine
7497 Print the compiler's target machine (for example,
7498 @samp{i686-pc-linux-gnu})---and don't do anything else.
7500 @item -dumpversion
7501 @opindex dumpversion
7502 Print the compiler version (for example, @code{3.0})---and don't do
7503 anything else.
7505 @item -dumpspecs
7506 @opindex dumpspecs
7507 Print the compiler's built-in specs---and don't do anything else.  (This
7508 is used when GCC itself is being built.)  @xref{Spec Files}.
7510 @item -fno-eliminate-unused-debug-types
7511 @opindex feliminate-unused-debug-types
7512 @opindex fno-eliminate-unused-debug-types
7513 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7514 output for types that are nowhere used in the source file being compiled.
7515 Sometimes it is useful to have GCC emit debugging
7516 information for all types declared in a compilation
7517 unit, regardless of whether or not they are actually used
7518 in that compilation unit, for example 
7519 if, in the debugger, you want to cast a value to a type that is
7520 not actually used in your program (but is declared).  More often,
7521 however, this results in a significant amount of wasted space.
7522 @end table
7524 @node Optimize Options
7525 @section Options That Control Optimization
7526 @cindex optimize options
7527 @cindex options, optimization
7529 These options control various sorts of optimizations.
7531 Without any optimization option, the compiler's goal is to reduce the
7532 cost of compilation and to make debugging produce the expected
7533 results.  Statements are independent: if you stop the program with a
7534 breakpoint between statements, you can then assign a new value to any
7535 variable or change the program counter to any other statement in the
7536 function and get exactly the results you expect from the source
7537 code.
7539 Turning on optimization flags makes the compiler attempt to improve
7540 the performance and/or code size at the expense of compilation time
7541 and possibly the ability to debug the program.
7543 The compiler performs optimization based on the knowledge it has of the
7544 program.  Compiling multiple files at once to a single output file mode allows
7545 the compiler to use information gained from all of the files when compiling
7546 each of them.
7548 Not all optimizations are controlled directly by a flag.  Only
7549 optimizations that have a flag are listed in this section.
7551 Most optimizations are only enabled if an @option{-O} level is set on
7552 the command line.  Otherwise they are disabled, even if individual
7553 optimization flags are specified.
7555 Depending on the target and how GCC was configured, a slightly different
7556 set of optimizations may be enabled at each @option{-O} level than
7557 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7558 to find out the exact set of optimizations that are enabled at each level.
7559 @xref{Overall Options}, for examples.
7561 @table @gcctabopt
7562 @item -O
7563 @itemx -O1
7564 @opindex O
7565 @opindex O1
7566 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7567 more memory for a large function.
7569 With @option{-O}, the compiler tries to reduce code size and execution
7570 time, without performing any optimizations that take a great deal of
7571 compilation time.
7573 @option{-O} turns on the following optimization flags:
7574 @gccoptlist{
7575 -fauto-inc-dec @gol
7576 -fbranch-count-reg @gol
7577 -fcombine-stack-adjustments @gol
7578 -fcompare-elim @gol
7579 -fcprop-registers @gol
7580 -fdce @gol
7581 -fdefer-pop @gol
7582 -fdelayed-branch @gol
7583 -fdse @gol
7584 -fforward-propagate @gol
7585 -fguess-branch-probability @gol
7586 -fif-conversion2 @gol
7587 -fif-conversion @gol
7588 -finline-functions-called-once @gol
7589 -fipa-pure-const @gol
7590 -fipa-profile @gol
7591 -fipa-reference @gol
7592 -fmerge-constants @gol
7593 -fmove-loop-invariants @gol
7594 -fshrink-wrap @gol
7595 -fsplit-wide-types @gol
7596 -ftree-bit-ccp @gol
7597 -ftree-ccp @gol
7598 -fssa-phiopt @gol
7599 -ftree-ch @gol
7600 -ftree-coalesce-vars @gol
7601 -ftree-copy-prop @gol
7602 -ftree-dce @gol
7603 -ftree-dominator-opts @gol
7604 -ftree-dse @gol
7605 -ftree-forwprop @gol
7606 -ftree-fre @gol
7607 -ftree-phiprop @gol
7608 -ftree-sink @gol
7609 -ftree-slsr @gol
7610 -ftree-sra @gol
7611 -ftree-pta @gol
7612 -ftree-ter @gol
7613 -funit-at-a-time}
7615 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7616 where doing so does not interfere with debugging.
7618 @item -O2
7619 @opindex O2
7620 Optimize even more.  GCC performs nearly all supported optimizations
7621 that do not involve a space-speed tradeoff.
7622 As compared to @option{-O}, this option increases both compilation time
7623 and the performance of the generated code.
7625 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7626 also turns on the following optimization flags:
7627 @gccoptlist{-fthread-jumps @gol
7628 -falign-functions  -falign-jumps @gol
7629 -falign-loops  -falign-labels @gol
7630 -fcaller-saves @gol
7631 -fcrossjumping @gol
7632 -fcse-follow-jumps  -fcse-skip-blocks @gol
7633 -fdelete-null-pointer-checks @gol
7634 -fdevirtualize -fdevirtualize-speculatively @gol
7635 -fexpensive-optimizations @gol
7636 -fgcse  -fgcse-lm  @gol
7637 -fhoist-adjacent-loads @gol
7638 -finline-small-functions @gol
7639 -findirect-inlining @gol
7640 -fipa-cp @gol
7641 -fipa-cp-alignment @gol
7642 -fipa-sra @gol
7643 -fipa-icf @gol
7644 -fisolate-erroneous-paths-dereference @gol
7645 -flra-remat @gol
7646 -foptimize-sibling-calls @gol
7647 -foptimize-strlen @gol
7648 -fpartial-inlining @gol
7649 -fpeephole2 @gol
7650 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7651 -frerun-cse-after-loop  @gol
7652 -fsched-interblock  -fsched-spec @gol
7653 -fschedule-insns  -fschedule-insns2 @gol
7654 -fstrict-aliasing -fstrict-overflow @gol
7655 -ftree-builtin-call-dce @gol
7656 -ftree-switch-conversion -ftree-tail-merge @gol
7657 -ftree-pre @gol
7658 -ftree-vrp @gol
7659 -fipa-ra}
7661 Please note the warning under @option{-fgcse} about
7662 invoking @option{-O2} on programs that use computed gotos.
7664 @item -O3
7665 @opindex O3
7666 Optimize yet more.  @option{-O3} turns on all optimizations specified
7667 by @option{-O2} and also turns on the @option{-finline-functions},
7668 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7669 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7670 @option{-ftree-loop-distribute-patterns},
7671 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7672 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7674 @item -O0
7675 @opindex O0
7676 Reduce compilation time and make debugging produce the expected
7677 results.  This is the default.
7679 @item -Os
7680 @opindex Os
7681 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7682 do not typically increase code size.  It also performs further
7683 optimizations designed to reduce code size.
7685 @option{-Os} disables the following optimization flags:
7686 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7687 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7688 -fprefetch-loop-arrays}
7690 @item -Ofast
7691 @opindex Ofast
7692 Disregard strict standards compliance.  @option{-Ofast} enables all
7693 @option{-O3} optimizations.  It also enables optimizations that are not
7694 valid for all standard-compliant programs.
7695 It turns on @option{-ffast-math} and the Fortran-specific
7696 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7698 @item -Og
7699 @opindex Og
7700 Optimize debugging experience.  @option{-Og} enables optimizations
7701 that do not interfere with debugging. It should be the optimization
7702 level of choice for the standard edit-compile-debug cycle, offering
7703 a reasonable level of optimization while maintaining fast compilation
7704 and a good debugging experience.
7706 If you use multiple @option{-O} options, with or without level numbers,
7707 the last such option is the one that is effective.
7708 @end table
7710 Options of the form @option{-f@var{flag}} specify machine-independent
7711 flags.  Most flags have both positive and negative forms; the negative
7712 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7713 below, only one of the forms is listed---the one you typically 
7714 use.  You can figure out the other form by either removing @samp{no-}
7715 or adding it.
7717 The following options control specific optimizations.  They are either
7718 activated by @option{-O} options or are related to ones that are.  You
7719 can use the following flags in the rare cases when ``fine-tuning'' of
7720 optimizations to be performed is desired.
7722 @table @gcctabopt
7723 @item -fno-defer-pop
7724 @opindex fno-defer-pop
7725 Always pop the arguments to each function call as soon as that function
7726 returns.  For machines that must pop arguments after a function call,
7727 the compiler normally lets arguments accumulate on the stack for several
7728 function calls and pops them all at once.
7730 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7732 @item -fforward-propagate
7733 @opindex fforward-propagate
7734 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7735 instructions and checks if the result can be simplified.  If loop unrolling
7736 is active, two passes are performed and the second is scheduled after
7737 loop unrolling.
7739 This option is enabled by default at optimization levels @option{-O},
7740 @option{-O2}, @option{-O3}, @option{-Os}.
7742 @item -ffp-contract=@var{style}
7743 @opindex ffp-contract
7744 @option{-ffp-contract=off} disables floating-point expression contraction.
7745 @option{-ffp-contract=fast} enables floating-point expression contraction
7746 such as forming of fused multiply-add operations if the target has
7747 native support for them.
7748 @option{-ffp-contract=on} enables floating-point expression contraction
7749 if allowed by the language standard.  This is currently not implemented
7750 and treated equal to @option{-ffp-contract=off}.
7752 The default is @option{-ffp-contract=fast}.
7754 @item -fomit-frame-pointer
7755 @opindex fomit-frame-pointer
7756 Don't keep the frame pointer in a register for functions that
7757 don't need one.  This avoids the instructions to save, set up and
7758 restore frame pointers; it also makes an extra register available
7759 in many functions.  @strong{It also makes debugging impossible on
7760 some machines.}
7762 On some machines, such as the VAX, this flag has no effect, because
7763 the standard calling sequence automatically handles the frame pointer
7764 and nothing is saved by pretending it doesn't exist.  The
7765 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7766 whether a target machine supports this flag.  @xref{Registers,,Register
7767 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7769 The default setting (when not optimizing for
7770 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7771 @option{-fomit-frame-pointer}.  You can configure GCC with the
7772 @option{--enable-frame-pointer} configure option to change the default.
7774 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7776 @item -foptimize-sibling-calls
7777 @opindex foptimize-sibling-calls
7778 Optimize sibling and tail recursive calls.
7780 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7782 @item -foptimize-strlen
7783 @opindex foptimize-strlen
7784 Optimize various standard C string functions (e.g. @code{strlen},
7785 @code{strchr} or @code{strcpy}) and
7786 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7788 Enabled at levels @option{-O2}, @option{-O3}.
7790 @item -fno-inline
7791 @opindex fno-inline
7792 Do not expand any functions inline apart from those marked with
7793 the @code{always_inline} attribute.  This is the default when not
7794 optimizing.
7796 Single functions can be exempted from inlining by marking them
7797 with the @code{noinline} attribute.
7799 @item -finline-small-functions
7800 @opindex finline-small-functions
7801 Integrate functions into their callers when their body is smaller than expected
7802 function call code (so overall size of program gets smaller).  The compiler
7803 heuristically decides which functions are simple enough to be worth integrating
7804 in this way.  This inlining applies to all functions, even those not declared
7805 inline.
7807 Enabled at level @option{-O2}.
7809 @item -findirect-inlining
7810 @opindex findirect-inlining
7811 Inline also indirect calls that are discovered to be known at compile
7812 time thanks to previous inlining.  This option has any effect only
7813 when inlining itself is turned on by the @option{-finline-functions}
7814 or @option{-finline-small-functions} options.
7816 Enabled at level @option{-O2}.
7818 @item -finline-functions
7819 @opindex finline-functions
7820 Consider all functions for inlining, even if they are not declared inline.
7821 The compiler heuristically decides which functions are worth integrating
7822 in this way.
7824 If all calls to a given function are integrated, and the function is
7825 declared @code{static}, then the function is normally not output as
7826 assembler code in its own right.
7828 Enabled at level @option{-O3}.
7830 @item -finline-functions-called-once
7831 @opindex finline-functions-called-once
7832 Consider all @code{static} functions called once for inlining into their
7833 caller even if they are not marked @code{inline}.  If a call to a given
7834 function is integrated, then the function is not output as assembler code
7835 in its own right.
7837 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7839 @item -fearly-inlining
7840 @opindex fearly-inlining
7841 Inline functions marked by @code{always_inline} and functions whose body seems
7842 smaller than the function call overhead early before doing
7843 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7844 makes profiling significantly cheaper and usually inlining faster on programs
7845 having large chains of nested wrapper functions.
7847 Enabled by default.
7849 @item -fipa-sra
7850 @opindex fipa-sra
7851 Perform interprocedural scalar replacement of aggregates, removal of
7852 unused parameters and replacement of parameters passed by reference
7853 by parameters passed by value.
7855 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7857 @item -finline-limit=@var{n}
7858 @opindex finline-limit
7859 By default, GCC limits the size of functions that can be inlined.  This flag
7860 allows coarse control of this limit.  @var{n} is the size of functions that
7861 can be inlined in number of pseudo instructions.
7863 Inlining is actually controlled by a number of parameters, which may be
7864 specified individually by using @option{--param @var{name}=@var{value}}.
7865 The @option{-finline-limit=@var{n}} option sets some of these parameters
7866 as follows:
7868 @table @gcctabopt
7869 @item max-inline-insns-single
7870 is set to @var{n}/2.
7871 @item max-inline-insns-auto
7872 is set to @var{n}/2.
7873 @end table
7875 See below for a documentation of the individual
7876 parameters controlling inlining and for the defaults of these parameters.
7878 @emph{Note:} there may be no value to @option{-finline-limit} that results
7879 in default behavior.
7881 @emph{Note:} pseudo instruction represents, in this particular context, an
7882 abstract measurement of function's size.  In no way does it represent a count
7883 of assembly instructions and as such its exact meaning might change from one
7884 release to an another.
7886 @item -fno-keep-inline-dllexport
7887 @opindex fno-keep-inline-dllexport
7888 This is a more fine-grained version of @option{-fkeep-inline-functions},
7889 which applies only to functions that are declared using the @code{dllexport}
7890 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7891 Functions}.)
7893 @item -fkeep-inline-functions
7894 @opindex fkeep-inline-functions
7895 In C, emit @code{static} functions that are declared @code{inline}
7896 into the object file, even if the function has been inlined into all
7897 of its callers.  This switch does not affect functions using the
7898 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7899 inline functions into the object file.
7901 @item -fkeep-static-consts
7902 @opindex fkeep-static-consts
7903 Emit variables declared @code{static const} when optimization isn't turned
7904 on, even if the variables aren't referenced.
7906 GCC enables this option by default.  If you want to force the compiler to
7907 check if a variable is referenced, regardless of whether or not
7908 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7910 @item -fmerge-constants
7911 @opindex fmerge-constants
7912 Attempt to merge identical constants (string constants and floating-point
7913 constants) across compilation units.
7915 This option is the default for optimized compilation if the assembler and
7916 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7917 behavior.
7919 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7921 @item -fmerge-all-constants
7922 @opindex fmerge-all-constants
7923 Attempt to merge identical constants and identical variables.
7925 This option implies @option{-fmerge-constants}.  In addition to
7926 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7927 arrays or initialized constant variables with integral or floating-point
7928 types.  Languages like C or C++ require each variable, including multiple
7929 instances of the same variable in recursive calls, to have distinct locations,
7930 so using this option results in non-conforming
7931 behavior.
7933 @item -fmodulo-sched
7934 @opindex fmodulo-sched
7935 Perform swing modulo scheduling immediately before the first scheduling
7936 pass.  This pass looks at innermost loops and reorders their
7937 instructions by overlapping different iterations.
7939 @item -fmodulo-sched-allow-regmoves
7940 @opindex fmodulo-sched-allow-regmoves
7941 Perform more aggressive SMS-based modulo scheduling with register moves
7942 allowed.  By setting this flag certain anti-dependences edges are
7943 deleted, which triggers the generation of reg-moves based on the
7944 life-range analysis.  This option is effective only with
7945 @option{-fmodulo-sched} enabled.
7947 @item -fno-branch-count-reg
7948 @opindex fno-branch-count-reg
7949 Do not use ``decrement and branch'' instructions on a count register,
7950 but instead generate a sequence of instructions that decrement a
7951 register, compare it against zero, then branch based upon the result.
7952 This option is only meaningful on architectures that support such
7953 instructions, which include x86, PowerPC, IA-64 and S/390.
7955 Enabled by default at @option{-O1} and higher.
7957 The default is @option{-fbranch-count-reg}.
7959 @item -fno-function-cse
7960 @opindex fno-function-cse
7961 Do not put function addresses in registers; make each instruction that
7962 calls a constant function contain the function's address explicitly.
7964 This option results in less efficient code, but some strange hacks
7965 that alter the assembler output may be confused by the optimizations
7966 performed when this option is not used.
7968 The default is @option{-ffunction-cse}
7970 @item -fno-zero-initialized-in-bss
7971 @opindex fno-zero-initialized-in-bss
7972 If the target supports a BSS section, GCC by default puts variables that
7973 are initialized to zero into BSS@.  This can save space in the resulting
7974 code.
7976 This option turns off this behavior because some programs explicitly
7977 rely on variables going to the data section---e.g., so that the
7978 resulting executable can find the beginning of that section and/or make
7979 assumptions based on that.
7981 The default is @option{-fzero-initialized-in-bss}.
7983 @item -fthread-jumps
7984 @opindex fthread-jumps
7985 Perform optimizations that check to see if a jump branches to a
7986 location where another comparison subsumed by the first is found.  If
7987 so, the first branch is redirected to either the destination of the
7988 second branch or a point immediately following it, depending on whether
7989 the condition is known to be true or false.
7991 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7993 @item -fsplit-wide-types
7994 @opindex fsplit-wide-types
7995 When using a type that occupies multiple registers, such as @code{long
7996 long} on a 32-bit system, split the registers apart and allocate them
7997 independently.  This normally generates better code for those types,
7998 but may make debugging more difficult.
8000 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
8001 @option{-Os}.
8003 @item -fcse-follow-jumps
8004 @opindex fcse-follow-jumps
8005 In common subexpression elimination (CSE), scan through jump instructions
8006 when the target of the jump is not reached by any other path.  For
8007 example, when CSE encounters an @code{if} statement with an
8008 @code{else} clause, CSE follows the jump when the condition
8009 tested is false.
8011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8013 @item -fcse-skip-blocks
8014 @opindex fcse-skip-blocks
8015 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8016 follow jumps that conditionally skip over blocks.  When CSE
8017 encounters a simple @code{if} statement with no else clause,
8018 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8019 body of the @code{if}.
8021 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8023 @item -frerun-cse-after-loop
8024 @opindex frerun-cse-after-loop
8025 Re-run common subexpression elimination after loop optimizations are
8026 performed.
8028 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8030 @item -fgcse
8031 @opindex fgcse
8032 Perform a global common subexpression elimination pass.
8033 This pass also performs global constant and copy propagation.
8035 @emph{Note:} When compiling a program using computed gotos, a GCC
8036 extension, you may get better run-time performance if you disable
8037 the global common subexpression elimination pass by adding
8038 @option{-fno-gcse} to the command line.
8040 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8042 @item -fgcse-lm
8043 @opindex fgcse-lm
8044 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8045 attempts to move loads that are only killed by stores into themselves.  This
8046 allows a loop containing a load/store sequence to be changed to a load outside
8047 the loop, and a copy/store within the loop.
8049 Enabled by default when @option{-fgcse} is enabled.
8051 @item -fgcse-sm
8052 @opindex fgcse-sm
8053 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8054 global common subexpression elimination.  This pass attempts to move
8055 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8056 loops containing a load/store sequence can be changed to a load before
8057 the loop and a store after the loop.
8059 Not enabled at any optimization level.
8061 @item -fgcse-las
8062 @opindex fgcse-las
8063 When @option{-fgcse-las} is enabled, the global common subexpression
8064 elimination pass eliminates redundant loads that come after stores to the
8065 same memory location (both partial and full redundancies).
8067 Not enabled at any optimization level.
8069 @item -fgcse-after-reload
8070 @opindex fgcse-after-reload
8071 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8072 pass is performed after reload.  The purpose of this pass is to clean up
8073 redundant spilling.
8075 @item -faggressive-loop-optimizations
8076 @opindex faggressive-loop-optimizations
8077 This option tells the loop optimizer to use language constraints to
8078 derive bounds for the number of iterations of a loop.  This assumes that
8079 loop code does not invoke undefined behavior by for example causing signed
8080 integer overflows or out-of-bound array accesses.  The bounds for the
8081 number of iterations of a loop are used to guide loop unrolling and peeling
8082 and loop exit test optimizations.
8083 This option is enabled by default.
8085 @item -funsafe-loop-optimizations
8086 @opindex funsafe-loop-optimizations
8087 This option tells the loop optimizer to assume that loop indices do not
8088 overflow, and that loops with nontrivial exit condition are not
8089 infinite.  This enables a wider range of loop optimizations even if
8090 the loop optimizer itself cannot prove that these assumptions are valid.
8091 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
8092 if it finds this kind of loop.
8094 @item -fcrossjumping
8095 @opindex fcrossjumping
8096 Perform cross-jumping transformation.
8097 This transformation unifies equivalent code and saves code size.  The
8098 resulting code may or may not perform better than without cross-jumping.
8100 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8102 @item -fauto-inc-dec
8103 @opindex fauto-inc-dec
8104 Combine increments or decrements of addresses with memory accesses.
8105 This pass is always skipped on architectures that do not have
8106 instructions to support this.  Enabled by default at @option{-O} and
8107 higher on architectures that support this.
8109 @item -fdce
8110 @opindex fdce
8111 Perform dead code elimination (DCE) on RTL@.
8112 Enabled by default at @option{-O} and higher.
8114 @item -fdse
8115 @opindex fdse
8116 Perform dead store elimination (DSE) on RTL@.
8117 Enabled by default at @option{-O} and higher.
8119 @item -fif-conversion
8120 @opindex fif-conversion
8121 Attempt to transform conditional jumps into branch-less equivalents.  This
8122 includes use of conditional moves, min, max, set flags and abs instructions, and
8123 some tricks doable by standard arithmetics.  The use of conditional execution
8124 on chips where it is available is controlled by @option{-fif-conversion2}.
8126 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8128 @item -fif-conversion2
8129 @opindex fif-conversion2
8130 Use conditional execution (where available) to transform conditional jumps into
8131 branch-less equivalents.
8133 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8135 @item -fdeclone-ctor-dtor
8136 @opindex fdeclone-ctor-dtor
8137 The C++ ABI requires multiple entry points for constructors and
8138 destructors: one for a base subobject, one for a complete object, and
8139 one for a virtual destructor that calls operator delete afterwards.
8140 For a hierarchy with virtual bases, the base and complete variants are
8141 clones, which means two copies of the function.  With this option, the
8142 base and complete variants are changed to be thunks that call a common
8143 implementation.
8145 Enabled by @option{-Os}.
8147 @item -fdelete-null-pointer-checks
8148 @opindex fdelete-null-pointer-checks
8149 Assume that programs cannot safely dereference null pointers, and that
8150 no code or data element resides at address zero.
8151 This option enables simple constant
8152 folding optimizations at all optimization levels.  In addition, other
8153 optimization passes in GCC use this flag to control global dataflow
8154 analyses that eliminate useless checks for null pointers; these assume
8155 that a memory access to address zero always results in a trap, so
8156 that if a pointer is checked after it has already been dereferenced,
8157 it cannot be null.
8159 Note however that in some environments this assumption is not true.
8160 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8161 for programs that depend on that behavior.
8163 This option is enabled by default on most targets.  On Nios II ELF, it
8164 defaults to off.  On AVR and CR16, this option is completely disabled.  
8166 Passes that use the dataflow information
8167 are enabled independently at different optimization levels.
8169 @item -fdevirtualize
8170 @opindex fdevirtualize
8171 Attempt to convert calls to virtual functions to direct calls.  This
8172 is done both within a procedure and interprocedurally as part of
8173 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8174 propagation (@option{-fipa-cp}).
8175 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8177 @item -fdevirtualize-speculatively
8178 @opindex fdevirtualize-speculatively
8179 Attempt to convert calls to virtual functions to speculative direct calls.
8180 Based on the analysis of the type inheritance graph, determine for a given call
8181 the set of likely targets. If the set is small, preferably of size 1, change
8182 the call into a conditional deciding between direct and indirect calls.  The
8183 speculative calls enable more optimizations, such as inlining.  When they seem
8184 useless after further optimization, they are converted back into original form.
8186 @item -fdevirtualize-at-ltrans
8187 @opindex fdevirtualize-at-ltrans
8188 Stream extra information needed for aggressive devirtualization when running
8189 the link-time optimizer in local transformation mode.  
8190 This option enables more devirtualization but
8191 significantly increases the size of streamed data. For this reason it is
8192 disabled by default.
8194 @item -fexpensive-optimizations
8195 @opindex fexpensive-optimizations
8196 Perform a number of minor optimizations that are relatively expensive.
8198 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8200 @item -free
8201 @opindex free
8202 Attempt to remove redundant extension instructions.  This is especially
8203 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8204 registers after writing to their lower 32-bit half.
8206 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8207 @option{-O3}, @option{-Os}.
8209 @item -fno-lifetime-dse
8210 @opindex fno-lifetime-dse
8211 In C++ the value of an object is only affected by changes within its
8212 lifetime: when the constructor begins, the object has an indeterminate
8213 value, and any changes during the lifetime of the object are dead when
8214 the object is destroyed.  Normally dead store elimination will take
8215 advantage of this; if your code relies on the value of the object
8216 storage persisting beyond the lifetime of the object, you can use this
8217 flag to disable this optimization.
8219 @item -flive-range-shrinkage
8220 @opindex flive-range-shrinkage
8221 Attempt to decrease register pressure through register live range
8222 shrinkage.  This is helpful for fast processors with small or moderate
8223 size register sets.
8225 @item -fira-algorithm=@var{algorithm}
8226 @opindex fira-algorithm
8227 Use the specified coloring algorithm for the integrated register
8228 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8229 specifies Chow's priority coloring, or @samp{CB}, which specifies
8230 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8231 for all architectures, but for those targets that do support it, it is
8232 the default because it generates better code.
8234 @item -fira-region=@var{region}
8235 @opindex fira-region
8236 Use specified regions for the integrated register allocator.  The
8237 @var{region} argument should be one of the following:
8239 @table @samp
8241 @item all
8242 Use all loops as register allocation regions.
8243 This can give the best results for machines with a small and/or
8244 irregular register set.
8246 @item mixed
8247 Use all loops except for loops with small register pressure 
8248 as the regions.  This value usually gives
8249 the best results in most cases and for most architectures,
8250 and is enabled by default when compiling with optimization for speed
8251 (@option{-O}, @option{-O2}, @dots{}).
8253 @item one
8254 Use all functions as a single region.  
8255 This typically results in the smallest code size, and is enabled by default for
8256 @option{-Os} or @option{-O0}.
8258 @end table
8260 @item -fira-hoist-pressure
8261 @opindex fira-hoist-pressure
8262 Use IRA to evaluate register pressure in the code hoisting pass for
8263 decisions to hoist expressions.  This option usually results in smaller
8264 code, but it can slow the compiler down.
8266 This option is enabled at level @option{-Os} for all targets.
8268 @item -fira-loop-pressure
8269 @opindex fira-loop-pressure
8270 Use IRA to evaluate register pressure in loops for decisions to move
8271 loop invariants.  This option usually results in generation
8272 of faster and smaller code on machines with large register files (>= 32
8273 registers), but it can slow the compiler down.
8275 This option is enabled at level @option{-O3} for some targets.
8277 @item -fno-ira-share-save-slots
8278 @opindex fno-ira-share-save-slots
8279 Disable sharing of stack slots used for saving call-used hard
8280 registers living through a call.  Each hard register gets a
8281 separate stack slot, and as a result function stack frames are
8282 larger.
8284 @item -fno-ira-share-spill-slots
8285 @opindex fno-ira-share-spill-slots
8286 Disable sharing of stack slots allocated for pseudo-registers.  Each
8287 pseudo-register that does not get a hard register gets a separate
8288 stack slot, and as a result function stack frames are larger.
8290 @item -fira-verbose=@var{n}
8291 @opindex fira-verbose
8292 Control the verbosity of the dump file for the integrated register allocator.
8293 The default value is 5.  If the value @var{n} is greater or equal to 10,
8294 the dump output is sent to stderr using the same format as @var{n} minus 10.
8296 @item -flra-remat
8297 @opindex flra-remat
8298 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8299 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8300 values if it is profitable.
8302 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8304 @item -fdelayed-branch
8305 @opindex fdelayed-branch
8306 If supported for the target machine, attempt to reorder instructions
8307 to exploit instruction slots available after delayed branch
8308 instructions.
8310 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8312 @item -fschedule-insns
8313 @opindex fschedule-insns
8314 If supported for the target machine, attempt to reorder instructions to
8315 eliminate execution stalls due to required data being unavailable.  This
8316 helps machines that have slow floating point or memory load instructions
8317 by allowing other instructions to be issued until the result of the load
8318 or floating-point instruction is required.
8320 Enabled at levels @option{-O2}, @option{-O3}.
8322 @item -fschedule-insns2
8323 @opindex fschedule-insns2
8324 Similar to @option{-fschedule-insns}, but requests an additional pass of
8325 instruction scheduling after register allocation has been done.  This is
8326 especially useful on machines with a relatively small number of
8327 registers and where memory load instructions take more than one cycle.
8329 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8331 @item -fno-sched-interblock
8332 @opindex fno-sched-interblock
8333 Don't schedule instructions across basic blocks.  This is normally
8334 enabled by default when scheduling before register allocation, i.e.@:
8335 with @option{-fschedule-insns} or at @option{-O2} or higher.
8337 @item -fno-sched-spec
8338 @opindex fno-sched-spec
8339 Don't allow speculative motion of non-load instructions.  This is normally
8340 enabled by default when scheduling before register allocation, i.e.@:
8341 with @option{-fschedule-insns} or at @option{-O2} or higher.
8343 @item -fsched-pressure
8344 @opindex fsched-pressure
8345 Enable register pressure sensitive insn scheduling before register
8346 allocation.  This only makes sense when scheduling before register
8347 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8348 @option{-O2} or higher.  Usage of this option can improve the
8349 generated code and decrease its size by preventing register pressure
8350 increase above the number of available hard registers and subsequent
8351 spills in register allocation.
8353 @item -fsched-spec-load
8354 @opindex fsched-spec-load
8355 Allow speculative motion of some load instructions.  This only makes
8356 sense when scheduling before register allocation, i.e.@: with
8357 @option{-fschedule-insns} or at @option{-O2} or higher.
8359 @item -fsched-spec-load-dangerous
8360 @opindex fsched-spec-load-dangerous
8361 Allow speculative motion of more load instructions.  This only makes
8362 sense when scheduling before register allocation, i.e.@: with
8363 @option{-fschedule-insns} or at @option{-O2} or higher.
8365 @item -fsched-stalled-insns
8366 @itemx -fsched-stalled-insns=@var{n}
8367 @opindex fsched-stalled-insns
8368 Define how many insns (if any) can be moved prematurely from the queue
8369 of stalled insns into the ready list during the second scheduling pass.
8370 @option{-fno-sched-stalled-insns} means that no insns are moved
8371 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8372 on how many queued insns can be moved prematurely.
8373 @option{-fsched-stalled-insns} without a value is equivalent to
8374 @option{-fsched-stalled-insns=1}.
8376 @item -fsched-stalled-insns-dep
8377 @itemx -fsched-stalled-insns-dep=@var{n}
8378 @opindex fsched-stalled-insns-dep
8379 Define how many insn groups (cycles) are examined for a dependency
8380 on a stalled insn that is a candidate for premature removal from the queue
8381 of stalled insns.  This has an effect only during the second scheduling pass,
8382 and only if @option{-fsched-stalled-insns} is used.
8383 @option{-fno-sched-stalled-insns-dep} is equivalent to
8384 @option{-fsched-stalled-insns-dep=0}.
8385 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8386 @option{-fsched-stalled-insns-dep=1}.
8388 @item -fsched2-use-superblocks
8389 @opindex fsched2-use-superblocks
8390 When scheduling after register allocation, use superblock scheduling.
8391 This allows motion across basic block boundaries,
8392 resulting in faster schedules.  This option is experimental, as not all machine
8393 descriptions used by GCC model the CPU closely enough to avoid unreliable
8394 results from the algorithm.
8396 This only makes sense when scheduling after register allocation, i.e.@: with
8397 @option{-fschedule-insns2} or at @option{-O2} or higher.
8399 @item -fsched-group-heuristic
8400 @opindex fsched-group-heuristic
8401 Enable the group heuristic in the scheduler.  This heuristic favors
8402 the instruction that belongs to a schedule group.  This is enabled
8403 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8404 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8406 @item -fsched-critical-path-heuristic
8407 @opindex fsched-critical-path-heuristic
8408 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8409 instructions on the critical path.  This is enabled by default when
8410 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8411 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8413 @item -fsched-spec-insn-heuristic
8414 @opindex fsched-spec-insn-heuristic
8415 Enable the speculative instruction heuristic in the scheduler.  This
8416 heuristic favors speculative instructions with greater dependency weakness.
8417 This is enabled by default when scheduling is enabled, i.e.@:
8418 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8419 or at @option{-O2} or higher.
8421 @item -fsched-rank-heuristic
8422 @opindex fsched-rank-heuristic
8423 Enable the rank heuristic in the scheduler.  This heuristic favors
8424 the instruction belonging to a basic block with greater size or frequency.
8425 This is enabled by default when scheduling is enabled, i.e.@:
8426 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8427 at @option{-O2} or higher.
8429 @item -fsched-last-insn-heuristic
8430 @opindex fsched-last-insn-heuristic
8431 Enable the last-instruction heuristic in the scheduler.  This heuristic
8432 favors the instruction that is less dependent on the last instruction
8433 scheduled.  This is enabled by default when scheduling is enabled,
8434 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8435 at @option{-O2} or higher.
8437 @item -fsched-dep-count-heuristic
8438 @opindex fsched-dep-count-heuristic
8439 Enable the dependent-count heuristic in the scheduler.  This heuristic
8440 favors the instruction that has more instructions depending on it.
8441 This is enabled by default when scheduling is enabled, i.e.@:
8442 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8443 at @option{-O2} or higher.
8445 @item -freschedule-modulo-scheduled-loops
8446 @opindex freschedule-modulo-scheduled-loops
8447 Modulo scheduling is performed before traditional scheduling.  If a loop
8448 is modulo scheduled, later scheduling passes may change its schedule.  
8449 Use this option to control that behavior.
8451 @item -fselective-scheduling
8452 @opindex fselective-scheduling
8453 Schedule instructions using selective scheduling algorithm.  Selective
8454 scheduling runs instead of the first scheduler pass.
8456 @item -fselective-scheduling2
8457 @opindex fselective-scheduling2
8458 Schedule instructions using selective scheduling algorithm.  Selective
8459 scheduling runs instead of the second scheduler pass.
8461 @item -fsel-sched-pipelining
8462 @opindex fsel-sched-pipelining
8463 Enable software pipelining of innermost loops during selective scheduling.
8464 This option has no effect unless one of @option{-fselective-scheduling} or
8465 @option{-fselective-scheduling2} is turned on.
8467 @item -fsel-sched-pipelining-outer-loops
8468 @opindex fsel-sched-pipelining-outer-loops
8469 When pipelining loops during selective scheduling, also pipeline outer loops.
8470 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8472 @item -fsemantic-interposition
8473 @opindex fsemantic-interposition
8474 Some object formats, like ELF, allow interposing of symbols by the 
8475 dynamic linker.
8476 This means that for symbols exported from the DSO, the compiler cannot perform
8477 interprocedural propagation, inlining and other optimizations in anticipation
8478 that the function or variable in question may change. While this feature is
8479 useful, for example, to rewrite memory allocation functions by a debugging
8480 implementation, it is expensive in the terms of code quality.
8481 With @option{-fno-semantic-interposition} the compiler assumes that 
8482 if interposition happens for functions the overwriting function will have 
8483 precisely the same semantics (and side effects). 
8484 Similarly if interposition happens
8485 for variables, the constructor of the variable will be the same. The flag
8486 has no effect for functions explicitly declared inline 
8487 (where it is never allowed for interposition to change semantics) 
8488 and for symbols explicitly declared weak.
8490 @item -fshrink-wrap
8491 @opindex fshrink-wrap
8492 Emit function prologues only before parts of the function that need it,
8493 rather than at the top of the function.  This flag is enabled by default at
8494 @option{-O} and higher.
8496 @item -fcaller-saves
8497 @opindex fcaller-saves
8498 Enable allocation of values to registers that are clobbered by
8499 function calls, by emitting extra instructions to save and restore the
8500 registers around such calls.  Such allocation is done only when it
8501 seems to result in better code.
8503 This option is always enabled by default on certain machines, usually
8504 those which have no call-preserved registers to use instead.
8506 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8508 @item -fcombine-stack-adjustments
8509 @opindex fcombine-stack-adjustments
8510 Tracks stack adjustments (pushes and pops) and stack memory references
8511 and then tries to find ways to combine them.
8513 Enabled by default at @option{-O1} and higher.
8515 @item -fipa-ra
8516 @opindex fipa-ra
8517 Use caller save registers for allocation if those registers are not used by
8518 any called function.  In that case it is not necessary to save and restore
8519 them around calls.  This is only possible if called functions are part of
8520 same compilation unit as current function and they are compiled before it.
8522 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8524 @item -fconserve-stack
8525 @opindex fconserve-stack
8526 Attempt to minimize stack usage.  The compiler attempts to use less
8527 stack space, even if that makes the program slower.  This option
8528 implies setting the @option{large-stack-frame} parameter to 100
8529 and the @option{large-stack-frame-growth} parameter to 400.
8531 @item -ftree-reassoc
8532 @opindex ftree-reassoc
8533 Perform reassociation on trees.  This flag is enabled by default
8534 at @option{-O} and higher.
8536 @item -ftree-pre
8537 @opindex ftree-pre
8538 Perform partial redundancy elimination (PRE) on trees.  This flag is
8539 enabled by default at @option{-O2} and @option{-O3}.
8541 @item -ftree-partial-pre
8542 @opindex ftree-partial-pre
8543 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8544 enabled by default at @option{-O3}.
8546 @item -ftree-forwprop
8547 @opindex ftree-forwprop
8548 Perform forward propagation on trees.  This flag is enabled by default
8549 at @option{-O} and higher.
8551 @item -ftree-fre
8552 @opindex ftree-fre
8553 Perform full redundancy elimination (FRE) on trees.  The difference
8554 between FRE and PRE is that FRE only considers expressions
8555 that are computed on all paths leading to the redundant computation.
8556 This analysis is faster than PRE, though it exposes fewer redundancies.
8557 This flag is enabled by default at @option{-O} and higher.
8559 @item -ftree-phiprop
8560 @opindex ftree-phiprop
8561 Perform hoisting of loads from conditional pointers on trees.  This
8562 pass is enabled by default at @option{-O} and higher.
8564 @item -fhoist-adjacent-loads
8565 @opindex fhoist-adjacent-loads
8566 Speculatively hoist loads from both branches of an if-then-else if the
8567 loads are from adjacent locations in the same structure and the target
8568 architecture has a conditional move instruction.  This flag is enabled
8569 by default at @option{-O2} and higher.
8571 @item -ftree-copy-prop
8572 @opindex ftree-copy-prop
8573 Perform copy propagation on trees.  This pass eliminates unnecessary
8574 copy operations.  This flag is enabled by default at @option{-O} and
8575 higher.
8577 @item -fipa-pure-const
8578 @opindex fipa-pure-const
8579 Discover which functions are pure or constant.
8580 Enabled by default at @option{-O} and higher.
8582 @item -fipa-reference
8583 @opindex fipa-reference
8584 Discover which static variables do not escape the
8585 compilation unit.
8586 Enabled by default at @option{-O} and higher.
8588 @item -fipa-pta
8589 @opindex fipa-pta
8590 Perform interprocedural pointer analysis and interprocedural modification
8591 and reference analysis.  This option can cause excessive memory and
8592 compile-time usage on large compilation units.  It is not enabled by
8593 default at any optimization level.
8595 @item -fipa-profile
8596 @opindex fipa-profile
8597 Perform interprocedural profile propagation.  The functions called only from
8598 cold functions are marked as cold. Also functions executed once (such as
8599 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8600 functions and loop less parts of functions executed once are then optimized for
8601 size.
8602 Enabled by default at @option{-O} and higher.
8604 @item -fipa-cp
8605 @opindex fipa-cp
8606 Perform interprocedural constant propagation.
8607 This optimization analyzes the program to determine when values passed
8608 to functions are constants and then optimizes accordingly.
8609 This optimization can substantially increase performance
8610 if the application has constants passed to functions.
8611 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8613 @item -fipa-cp-clone
8614 @opindex fipa-cp-clone
8615 Perform function cloning to make interprocedural constant propagation stronger.
8616 When enabled, interprocedural constant propagation performs function cloning
8617 when externally visible function can be called with constant arguments.
8618 Because this optimization can create multiple copies of functions,
8619 it may significantly increase code size
8620 (see @option{--param ipcp-unit-growth=@var{value}}).
8621 This flag is enabled by default at @option{-O3}.
8623 @item -fipa-cp-alignment
8624 @opindex -fipa-cp-alignment
8625 When enabled, this optimization propagates alignment of function
8626 parameters to support better vectorization and string operations.
8628 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8629 requires that @option{-fipa-cp} is enabled.
8631 @item -fipa-icf
8632 @opindex fipa-icf
8633 Perform Identical Code Folding for functions and read-only variables.
8634 The optimization reduces code size and may disturb unwind stacks by replacing
8635 a function by equivalent one with a different name. The optimization works
8636 more effectively with link time optimization enabled.
8638 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8639 works on different levels and thus the optimizations are not same - there are
8640 equivalences that are found only by GCC and equivalences found only by Gold.
8642 This flag is enabled by default at @option{-O2} and @option{-Os}.
8644 @item -fisolate-erroneous-paths-dereference
8645 @opindex fisolate-erroneous-paths-dereference
8646 Detect paths that trigger erroneous or undefined behavior due to
8647 dereferencing a null pointer.  Isolate those paths from the main control
8648 flow and turn the statement with erroneous or undefined behavior into a trap.
8649 This flag is enabled by default at @option{-O2} and higher and depends on
8650 @option{-fdelete-null-pointer-checks} also being enabled.
8652 @item -fisolate-erroneous-paths-attribute
8653 @opindex fisolate-erroneous-paths-attribute
8654 Detect paths that trigger erroneous or undefined behavior due a null value
8655 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8656 attribute.  Isolate those paths from the main control flow and turn the
8657 statement with erroneous or undefined behavior into a trap.  This is not
8658 currently enabled, but may be enabled by @option{-O2} in the future.
8660 @item -ftree-sink
8661 @opindex ftree-sink
8662 Perform forward store motion  on trees.  This flag is
8663 enabled by default at @option{-O} and higher.
8665 @item -ftree-bit-ccp
8666 @opindex ftree-bit-ccp
8667 Perform sparse conditional bit constant propagation on trees and propagate
8668 pointer alignment information.
8669 This pass only operates on local scalar variables and is enabled by default
8670 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8672 @item -ftree-ccp
8673 @opindex ftree-ccp
8674 Perform sparse conditional constant propagation (CCP) on trees.  This
8675 pass only operates on local scalar variables and is enabled by default
8676 at @option{-O} and higher.
8678 @item -fssa-phiopt
8679 @opindex fssa-phiopt
8680 Perform pattern matching on SSA PHI nodes to optimize conditional
8681 code.  This pass is enabled by default at @option{-O} and higher.
8683 @item -ftree-switch-conversion
8684 @opindex ftree-switch-conversion
8685 Perform conversion of simple initializations in a switch to
8686 initializations from a scalar array.  This flag is enabled by default
8687 at @option{-O2} and higher.
8689 @item -ftree-tail-merge
8690 @opindex ftree-tail-merge
8691 Look for identical code sequences.  When found, replace one with a jump to the
8692 other.  This optimization is known as tail merging or cross jumping.  This flag
8693 is enabled by default at @option{-O2} and higher.  The compilation time
8694 in this pass can
8695 be limited using @option{max-tail-merge-comparisons} parameter and
8696 @option{max-tail-merge-iterations} parameter.
8698 @item -ftree-dce
8699 @opindex ftree-dce
8700 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8701 default at @option{-O} and higher.
8703 @item -ftree-builtin-call-dce
8704 @opindex ftree-builtin-call-dce
8705 Perform conditional dead code elimination (DCE) for calls to built-in functions
8706 that may set @code{errno} but are otherwise side-effect free.  This flag is
8707 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8708 specified.
8710 @item -ftree-dominator-opts
8711 @opindex ftree-dominator-opts
8712 Perform a variety of simple scalar cleanups (constant/copy
8713 propagation, redundancy elimination, range propagation and expression
8714 simplification) based on a dominator tree traversal.  This also
8715 performs jump threading (to reduce jumps to jumps). This flag is
8716 enabled by default at @option{-O} and higher.
8718 @item -ftree-dse
8719 @opindex ftree-dse
8720 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8721 a memory location that is later overwritten by another store without
8722 any intervening loads.  In this case the earlier store can be deleted.  This
8723 flag is enabled by default at @option{-O} and higher.
8725 @item -ftree-ch
8726 @opindex ftree-ch
8727 Perform loop header copying on trees.  This is beneficial since it increases
8728 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8729 is enabled by default at @option{-O} and higher.  It is not enabled
8730 for @option{-Os}, since it usually increases code size.
8732 @item -ftree-loop-optimize
8733 @opindex ftree-loop-optimize
8734 Perform loop optimizations on trees.  This flag is enabled by default
8735 at @option{-O} and higher.
8737 @item -ftree-loop-linear
8738 @itemx -floop-interchange
8739 @itemx -floop-strip-mine
8740 @itemx -floop-block
8741 @itemx -floop-unroll-and-jam
8742 @opindex ftree-loop-linear
8743 @opindex floop-interchange
8744 @opindex floop-strip-mine
8745 @opindex floop-block
8746 @opindex floop-unroll-and-jam
8747 Perform loop nest optimizations.  Same as
8748 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8749 to be configured with @option{--with-isl} to enable the Graphite loop
8750 transformation infrastructure.
8752 @item -fgraphite-identity
8753 @opindex fgraphite-identity
8754 Enable the identity transformation for graphite.  For every SCoP we generate
8755 the polyhedral representation and transform it back to gimple.  Using
8756 @option{-fgraphite-identity} we can check the costs or benefits of the
8757 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8758 are also performed by the code generator ISL, like index splitting and
8759 dead code elimination in loops.
8761 @item -floop-nest-optimize
8762 @opindex floop-nest-optimize
8763 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8764 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8765 structure optimized for data-locality and parallelism.  This option
8766 is experimental.
8768 @item -floop-parallelize-all
8769 @opindex floop-parallelize-all
8770 Use the Graphite data dependence analysis to identify loops that can
8771 be parallelized.  Parallelize all the loops that can be analyzed to
8772 not contain loop carried dependences without checking that it is
8773 profitable to parallelize the loops.
8775 @item -ftree-coalesce-vars
8776 @opindex ftree-coalesce-vars
8777 Tell the compiler to attempt to combine small user-defined variables
8778 too, instead of just compiler temporaries.  This may severely limit the
8779 ability to debug an optimized program compiled with
8780 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8781 prevents SSA coalescing of user variables.  This option is enabled by
8782 default if optimization is enabled.
8784 @item -ftree-loop-if-convert
8785 @opindex ftree-loop-if-convert
8786 Attempt to transform conditional jumps in the innermost loops to
8787 branch-less equivalents.  The intent is to remove control-flow from
8788 the innermost loops in order to improve the ability of the
8789 vectorization pass to handle these loops.  This is enabled by default
8790 if vectorization is enabled.
8792 @item -ftree-loop-if-convert-stores
8793 @opindex ftree-loop-if-convert-stores
8794 Attempt to also if-convert conditional jumps containing memory writes.
8795 This transformation can be unsafe for multi-threaded programs as it
8796 transforms conditional memory writes into unconditional memory writes.
8797 For example,
8798 @smallexample
8799 for (i = 0; i < N; i++)
8800   if (cond)
8801     A[i] = expr;
8802 @end smallexample
8803 is transformed to
8804 @smallexample
8805 for (i = 0; i < N; i++)
8806   A[i] = cond ? expr : A[i];
8807 @end smallexample
8808 potentially producing data races.
8810 @item -ftree-loop-distribution
8811 @opindex ftree-loop-distribution
8812 Perform loop distribution.  This flag can improve cache performance on
8813 big loop bodies and allow further loop optimizations, like
8814 parallelization or vectorization, to take place.  For example, the loop
8815 @smallexample
8816 DO I = 1, N
8817   A(I) = B(I) + C
8818   D(I) = E(I) * F
8819 ENDDO
8820 @end smallexample
8821 is transformed to
8822 @smallexample
8823 DO I = 1, N
8824    A(I) = B(I) + C
8825 ENDDO
8826 DO I = 1, N
8827    D(I) = E(I) * F
8828 ENDDO
8829 @end smallexample
8831 @item -ftree-loop-distribute-patterns
8832 @opindex ftree-loop-distribute-patterns
8833 Perform loop distribution of patterns that can be code generated with
8834 calls to a library.  This flag is enabled by default at @option{-O3}.
8836 This pass distributes the initialization loops and generates a call to
8837 memset zero.  For example, the loop
8838 @smallexample
8839 DO I = 1, N
8840   A(I) = 0
8841   B(I) = A(I) + I
8842 ENDDO
8843 @end smallexample
8844 is transformed to
8845 @smallexample
8846 DO I = 1, N
8847    A(I) = 0
8848 ENDDO
8849 DO I = 1, N
8850    B(I) = A(I) + I
8851 ENDDO
8852 @end smallexample
8853 and the initialization loop is transformed into a call to memset zero.
8855 @item -ftree-loop-im
8856 @opindex ftree-loop-im
8857 Perform loop invariant motion on trees.  This pass moves only invariants that
8858 are hard to handle at RTL level (function calls, operations that expand to
8859 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8860 operands of conditions that are invariant out of the loop, so that we can use
8861 just trivial invariantness analysis in loop unswitching.  The pass also includes
8862 store motion.
8864 @item -ftree-loop-ivcanon
8865 @opindex ftree-loop-ivcanon
8866 Create a canonical counter for number of iterations in loops for which
8867 determining number of iterations requires complicated analysis.  Later
8868 optimizations then may determine the number easily.  Useful especially
8869 in connection with unrolling.
8871 @item -fivopts
8872 @opindex fivopts
8873 Perform induction variable optimizations (strength reduction, induction
8874 variable merging and induction variable elimination) on trees.
8876 @item -ftree-parallelize-loops=n
8877 @opindex ftree-parallelize-loops
8878 Parallelize loops, i.e., split their iteration space to run in n threads.
8879 This is only possible for loops whose iterations are independent
8880 and can be arbitrarily reordered.  The optimization is only
8881 profitable on multiprocessor machines, for loops that are CPU-intensive,
8882 rather than constrained e.g.@: by memory bandwidth.  This option
8883 implies @option{-pthread}, and thus is only supported on targets
8884 that have support for @option{-pthread}.
8886 @item -ftree-pta
8887 @opindex ftree-pta
8888 Perform function-local points-to analysis on trees.  This flag is
8889 enabled by default at @option{-O} and higher.
8891 @item -ftree-sra
8892 @opindex ftree-sra
8893 Perform scalar replacement of aggregates.  This pass replaces structure
8894 references with scalars to prevent committing structures to memory too
8895 early.  This flag is enabled by default at @option{-O} and higher.
8897 @item -ftree-ter
8898 @opindex ftree-ter
8899 Perform temporary expression replacement during the SSA->normal phase.  Single
8900 use/single def temporaries are replaced at their use location with their
8901 defining expression.  This results in non-GIMPLE code, but gives the expanders
8902 much more complex trees to work on resulting in better RTL generation.  This is
8903 enabled by default at @option{-O} and higher.
8905 @item -ftree-slsr
8906 @opindex ftree-slsr
8907 Perform straight-line strength reduction on trees.  This recognizes related
8908 expressions involving multiplications and replaces them by less expensive
8909 calculations when possible.  This is enabled by default at @option{-O} and
8910 higher.
8912 @item -ftree-vectorize
8913 @opindex ftree-vectorize
8914 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8915 and @option{-ftree-slp-vectorize} if not explicitly specified.
8917 @item -ftree-loop-vectorize
8918 @opindex ftree-loop-vectorize
8919 Perform loop vectorization on trees. This flag is enabled by default at
8920 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8922 @item -ftree-slp-vectorize
8923 @opindex ftree-slp-vectorize
8924 Perform basic block vectorization on trees. This flag is enabled by default at
8925 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8927 @item -fvect-cost-model=@var{model}
8928 @opindex fvect-cost-model
8929 Alter the cost model used for vectorization.  The @var{model} argument
8930 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8931 With the @samp{unlimited} model the vectorized code-path is assumed
8932 to be profitable while with the @samp{dynamic} model a runtime check
8933 guards the vectorized code-path to enable it only for iteration
8934 counts that will likely execute faster than when executing the original
8935 scalar loop.  The @samp{cheap} model disables vectorization of
8936 loops where doing so would be cost prohibitive for example due to
8937 required runtime checks for data dependence or alignment but otherwise
8938 is equal to the @samp{dynamic} model.
8939 The default cost model depends on other optimization flags and is
8940 either @samp{dynamic} or @samp{cheap}.
8942 @item -fsimd-cost-model=@var{model}
8943 @opindex fsimd-cost-model
8944 Alter the cost model used for vectorization of loops marked with the OpenMP
8945 or Cilk Plus simd directive.  The @var{model} argument should be one of
8946 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8947 have the same meaning as described in @option{-fvect-cost-model} and by
8948 default a cost model defined with @option{-fvect-cost-model} is used.
8950 @item -ftree-vrp
8951 @opindex ftree-vrp
8952 Perform Value Range Propagation on trees.  This is similar to the
8953 constant propagation pass, but instead of values, ranges of values are
8954 propagated.  This allows the optimizers to remove unnecessary range
8955 checks like array bound checks and null pointer checks.  This is
8956 enabled by default at @option{-O2} and higher.  Null pointer check
8957 elimination is only done if @option{-fdelete-null-pointer-checks} is
8958 enabled.
8960 @item -fsplit-ivs-in-unroller
8961 @opindex fsplit-ivs-in-unroller
8962 Enables expression of values of induction variables in later iterations
8963 of the unrolled loop using the value in the first iteration.  This breaks
8964 long dependency chains, thus improving efficiency of the scheduling passes.
8966 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8967 same effect.  However, that is not reliable in cases where the loop body
8968 is more complicated than a single basic block.  It also does not work at all
8969 on some architectures due to restrictions in the CSE pass.
8971 This optimization is enabled by default.
8973 @item -fvariable-expansion-in-unroller
8974 @opindex fvariable-expansion-in-unroller
8975 With this option, the compiler creates multiple copies of some
8976 local variables when unrolling a loop, which can result in superior code.
8978 @item -fpartial-inlining
8979 @opindex fpartial-inlining
8980 Inline parts of functions.  This option has any effect only
8981 when inlining itself is turned on by the @option{-finline-functions}
8982 or @option{-finline-small-functions} options.
8984 Enabled at level @option{-O2}.
8986 @item -fpredictive-commoning
8987 @opindex fpredictive-commoning
8988 Perform predictive commoning optimization, i.e., reusing computations
8989 (especially memory loads and stores) performed in previous
8990 iterations of loops.
8992 This option is enabled at level @option{-O3}.
8994 @item -fprefetch-loop-arrays
8995 @opindex fprefetch-loop-arrays
8996 If supported by the target machine, generate instructions to prefetch
8997 memory to improve the performance of loops that access large arrays.
8999 This option may generate better or worse code; results are highly
9000 dependent on the structure of loops within the source code.
9002 Disabled at level @option{-Os}.
9004 @item -fno-peephole
9005 @itemx -fno-peephole2
9006 @opindex fno-peephole
9007 @opindex fno-peephole2
9008 Disable any machine-specific peephole optimizations.  The difference
9009 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9010 are implemented in the compiler; some targets use one, some use the
9011 other, a few use both.
9013 @option{-fpeephole} is enabled by default.
9014 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9016 @item -fno-guess-branch-probability
9017 @opindex fno-guess-branch-probability
9018 Do not guess branch probabilities using heuristics.
9020 GCC uses heuristics to guess branch probabilities if they are
9021 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9022 heuristics are based on the control flow graph.  If some branch probabilities
9023 are specified by @code{__builtin_expect}, then the heuristics are
9024 used to guess branch probabilities for the rest of the control flow graph,
9025 taking the @code{__builtin_expect} info into account.  The interactions
9026 between the heuristics and @code{__builtin_expect} can be complex, and in
9027 some cases, it may be useful to disable the heuristics so that the effects
9028 of @code{__builtin_expect} are easier to understand.
9030 The default is @option{-fguess-branch-probability} at levels
9031 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9033 @item -freorder-blocks
9034 @opindex freorder-blocks
9035 Reorder basic blocks in the compiled function in order to reduce number of
9036 taken branches and improve code locality.
9038 Enabled at levels @option{-O2}, @option{-O3}.
9040 @item -freorder-blocks-and-partition
9041 @opindex freorder-blocks-and-partition
9042 In addition to reordering basic blocks in the compiled function, in order
9043 to reduce number of taken branches, partitions hot and cold basic blocks
9044 into separate sections of the assembly and .o files, to improve
9045 paging and cache locality performance.
9047 This optimization is automatically turned off in the presence of
9048 exception handling, for linkonce sections, for functions with a user-defined
9049 section attribute and on any architecture that does not support named
9050 sections.
9052 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9054 @item -freorder-functions
9055 @opindex freorder-functions
9056 Reorder functions in the object file in order to
9057 improve code locality.  This is implemented by using special
9058 subsections @code{.text.hot} for most frequently executed functions and
9059 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9060 the linker so object file format must support named sections and linker must
9061 place them in a reasonable way.
9063 Also profile feedback must be available to make this option effective.  See
9064 @option{-fprofile-arcs} for details.
9066 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9068 @item -fstrict-aliasing
9069 @opindex fstrict-aliasing
9070 Allow the compiler to assume the strictest aliasing rules applicable to
9071 the language being compiled.  For C (and C++), this activates
9072 optimizations based on the type of expressions.  In particular, an
9073 object of one type is assumed never to reside at the same address as an
9074 object of a different type, unless the types are almost the same.  For
9075 example, an @code{unsigned int} can alias an @code{int}, but not a
9076 @code{void*} or a @code{double}.  A character type may alias any other
9077 type.
9079 @anchor{Type-punning}Pay special attention to code like this:
9080 @smallexample
9081 union a_union @{
9082   int i;
9083   double d;
9086 int f() @{
9087   union a_union t;
9088   t.d = 3.0;
9089   return t.i;
9091 @end smallexample
9092 The practice of reading from a different union member than the one most
9093 recently written to (called ``type-punning'') is common.  Even with
9094 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9095 is accessed through the union type.  So, the code above works as
9096 expected.  @xref{Structures unions enumerations and bit-fields
9097 implementation}.  However, this code might not:
9098 @smallexample
9099 int f() @{
9100   union a_union t;
9101   int* ip;
9102   t.d = 3.0;
9103   ip = &t.i;
9104   return *ip;
9106 @end smallexample
9108 Similarly, access by taking the address, casting the resulting pointer
9109 and dereferencing the result has undefined behavior, even if the cast
9110 uses a union type, e.g.:
9111 @smallexample
9112 int f() @{
9113   double d = 3.0;
9114   return ((union a_union *) &d)->i;
9116 @end smallexample
9118 The @option{-fstrict-aliasing} option is enabled at levels
9119 @option{-O2}, @option{-O3}, @option{-Os}.
9121 @item -fstrict-overflow
9122 @opindex fstrict-overflow
9123 Allow the compiler to assume strict signed overflow rules, depending
9124 on the language being compiled.  For C (and C++) this means that
9125 overflow when doing arithmetic with signed numbers is undefined, which
9126 means that the compiler may assume that it does not happen.  This
9127 permits various optimizations.  For example, the compiler assumes
9128 that an expression like @code{i + 10 > i} is always true for
9129 signed @code{i}.  This assumption is only valid if signed overflow is
9130 undefined, as the expression is false if @code{i + 10} overflows when
9131 using twos complement arithmetic.  When this option is in effect any
9132 attempt to determine whether an operation on signed numbers 
9133 overflows must be written carefully to not actually involve overflow.
9135 This option also allows the compiler to assume strict pointer
9136 semantics: given a pointer to an object, if adding an offset to that
9137 pointer does not produce a pointer to the same object, the addition is
9138 undefined.  This permits the compiler to conclude that @code{p + u >
9139 p} is always true for a pointer @code{p} and unsigned integer
9140 @code{u}.  This assumption is only valid because pointer wraparound is
9141 undefined, as the expression is false if @code{p + u} overflows using
9142 twos complement arithmetic.
9144 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
9145 that integer signed overflow is fully defined: it wraps.  When
9146 @option{-fwrapv} is used, there is no difference between
9147 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
9148 integers.  With @option{-fwrapv} certain types of overflow are
9149 permitted.  For example, if the compiler gets an overflow when doing
9150 arithmetic on constants, the overflowed value can still be used with
9151 @option{-fwrapv}, but not otherwise.
9153 The @option{-fstrict-overflow} option is enabled at levels
9154 @option{-O2}, @option{-O3}, @option{-Os}.
9156 @item -falign-functions
9157 @itemx -falign-functions=@var{n}
9158 @opindex falign-functions
9159 Align the start of functions to the next power-of-two greater than
9160 @var{n}, skipping up to @var{n} bytes.  For instance,
9161 @option{-falign-functions=32} aligns functions to the next 32-byte
9162 boundary, but @option{-falign-functions=24} aligns to the next
9163 32-byte boundary only if this can be done by skipping 23 bytes or less.
9165 @option{-fno-align-functions} and @option{-falign-functions=1} are
9166 equivalent and mean that functions are not aligned.
9168 Some assemblers only support this flag when @var{n} is a power of two;
9169 in that case, it is rounded up.
9171 If @var{n} is not specified or is zero, use a machine-dependent default.
9173 Enabled at levels @option{-O2}, @option{-O3}.
9175 @item -falign-labels
9176 @itemx -falign-labels=@var{n}
9177 @opindex falign-labels
9178 Align all branch targets to a power-of-two boundary, skipping up to
9179 @var{n} bytes like @option{-falign-functions}.  This option can easily
9180 make code slower, because it must insert dummy operations for when the
9181 branch target is reached in the usual flow of the code.
9183 @option{-fno-align-labels} and @option{-falign-labels=1} are
9184 equivalent and mean that labels are not aligned.
9186 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9187 are greater than this value, then their values are used instead.
9189 If @var{n} is not specified or is zero, use a machine-dependent default
9190 which is very likely to be @samp{1}, meaning no alignment.
9192 Enabled at levels @option{-O2}, @option{-O3}.
9194 @item -falign-loops
9195 @itemx -falign-loops=@var{n}
9196 @opindex falign-loops
9197 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9198 like @option{-falign-functions}.  If the loops are
9199 executed many times, this makes up for any execution of the dummy
9200 operations.
9202 @option{-fno-align-loops} and @option{-falign-loops=1} are
9203 equivalent and mean that loops are not aligned.
9205 If @var{n} is not specified or is zero, use a machine-dependent default.
9207 Enabled at levels @option{-O2}, @option{-O3}.
9209 @item -falign-jumps
9210 @itemx -falign-jumps=@var{n}
9211 @opindex falign-jumps
9212 Align branch targets to a power-of-two boundary, for branch targets
9213 where the targets can only be reached by jumping, skipping up to @var{n}
9214 bytes like @option{-falign-functions}.  In this case, no dummy operations
9215 need be executed.
9217 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9218 equivalent and mean that loops are not aligned.
9220 If @var{n} is not specified or is zero, use a machine-dependent default.
9222 Enabled at levels @option{-O2}, @option{-O3}.
9224 @item -funit-at-a-time
9225 @opindex funit-at-a-time
9226 This option is left for compatibility reasons. @option{-funit-at-a-time}
9227 has no effect, while @option{-fno-unit-at-a-time} implies
9228 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9230 Enabled by default.
9232 @item -fno-toplevel-reorder
9233 @opindex fno-toplevel-reorder
9234 Do not reorder top-level functions, variables, and @code{asm}
9235 statements.  Output them in the same order that they appear in the
9236 input file.  When this option is used, unreferenced static variables
9237 are not removed.  This option is intended to support existing code
9238 that relies on a particular ordering.  For new code, it is better to
9239 use attributes when possible.
9241 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9242 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9243 targets.
9245 @item -fweb
9246 @opindex fweb
9247 Constructs webs as commonly used for register allocation purposes and assign
9248 each web individual pseudo register.  This allows the register allocation pass
9249 to operate on pseudos directly, but also strengthens several other optimization
9250 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9251 however, make debugging impossible, since variables no longer stay in a
9252 ``home register''.
9254 Enabled by default with @option{-funroll-loops}.
9256 @item -fwhole-program
9257 @opindex fwhole-program
9258 Assume that the current compilation unit represents the whole program being
9259 compiled.  All public functions and variables with the exception of @code{main}
9260 and those merged by attribute @code{externally_visible} become static functions
9261 and in effect are optimized more aggressively by interprocedural optimizers.
9263 This option should not be used in combination with @option{-flto}.
9264 Instead relying on a linker plugin should provide safer and more precise
9265 information.
9267 @item -flto[=@var{n}]
9268 @opindex flto
9269 This option runs the standard link-time optimizer.  When invoked
9270 with source code, it generates GIMPLE (one of GCC's internal
9271 representations) and writes it to special ELF sections in the object
9272 file.  When the object files are linked together, all the function
9273 bodies are read from these ELF sections and instantiated as if they
9274 had been part of the same translation unit.
9276 To use the link-time optimizer, @option{-flto} and optimization
9277 options should be specified at compile time and during the final link.
9278 For example:
9280 @smallexample
9281 gcc -c -O2 -flto foo.c
9282 gcc -c -O2 -flto bar.c
9283 gcc -o myprog -flto -O2 foo.o bar.o
9284 @end smallexample
9286 The first two invocations to GCC save a bytecode representation
9287 of GIMPLE into special ELF sections inside @file{foo.o} and
9288 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9289 @file{foo.o} and @file{bar.o}, merges the two files into a single
9290 internal image, and compiles the result as usual.  Since both
9291 @file{foo.o} and @file{bar.o} are merged into a single image, this
9292 causes all the interprocedural analyses and optimizations in GCC to
9293 work across the two files as if they were a single one.  This means,
9294 for example, that the inliner is able to inline functions in
9295 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9297 Another (simpler) way to enable link-time optimization is:
9299 @smallexample
9300 gcc -o myprog -flto -O2 foo.c bar.c
9301 @end smallexample
9303 The above generates bytecode for @file{foo.c} and @file{bar.c},
9304 merges them together into a single GIMPLE representation and optimizes
9305 them as usual to produce @file{myprog}.
9307 The only important thing to keep in mind is that to enable link-time
9308 optimizations you need to use the GCC driver to perform the link-step.
9309 GCC then automatically performs link-time optimization if any of the
9310 objects involved were compiled with the @option{-flto} command-line option.  
9311 You generally
9312 should specify the optimization options to be used for link-time
9313 optimization though GCC tries to be clever at guessing an
9314 optimization level to use from the options used at compile-time
9315 if you fail to specify one at link-time.  You can always override
9316 the automatic decision to do link-time optimization at link-time
9317 by passing @option{-fno-lto} to the link command.
9319 To make whole program optimization effective, it is necessary to make
9320 certain whole program assumptions.  The compiler needs to know
9321 what functions and variables can be accessed by libraries and runtime
9322 outside of the link-time optimized unit.  When supported by the linker,
9323 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9324 to the compiler about used and externally visible symbols.  When
9325 the linker plugin is not available, @option{-fwhole-program} should be
9326 used to allow the compiler to make these assumptions, which leads
9327 to more aggressive optimization decisions.
9329 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9330 compiled with @option{-flto}, the generated object file is larger than
9331 a regular object file because it contains GIMPLE bytecodes and the usual
9332 final code (see @option{-ffat-lto-objects}.  This means that
9333 object files with LTO information can be linked as normal object
9334 files; if @option{-fno-lto} is passed to the linker, no
9335 interprocedural optimizations are applied.  Note that when
9336 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9337 but you cannot perform a regular, non-LTO link on them.
9339 Additionally, the optimization flags used to compile individual files
9340 are not necessarily related to those used at link time.  For instance,
9342 @smallexample
9343 gcc -c -O0 -ffat-lto-objects -flto foo.c
9344 gcc -c -O0 -ffat-lto-objects -flto bar.c
9345 gcc -o myprog -O3 foo.o bar.o
9346 @end smallexample
9348 This produces individual object files with unoptimized assembler
9349 code, but the resulting binary @file{myprog} is optimized at
9350 @option{-O3}.  If, instead, the final binary is generated with
9351 @option{-fno-lto}, then @file{myprog} is not optimized.
9353 When producing the final binary, GCC only
9354 applies link-time optimizations to those files that contain bytecode.
9355 Therefore, you can mix and match object files and libraries with
9356 GIMPLE bytecodes and final object code.  GCC automatically selects
9357 which files to optimize in LTO mode and which files to link without
9358 further processing.
9360 There are some code generation flags preserved by GCC when
9361 generating bytecodes, as they need to be used during the final link
9362 stage.  Generally options specified at link-time override those
9363 specified at compile-time.
9365 If you do not specify an optimization level option @option{-O} at
9366 link-time then GCC computes one based on the optimization levels
9367 used when compiling the object files.  The highest optimization
9368 level wins here.
9370 Currently, the following options and their setting are take from
9371 the first object file that explicitely specified it: 
9372 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9373 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9374 and all the @option{-m} target flags.
9376 Certain ABI changing flags are required to match in all compilation-units
9377 and trying to override this at link-time with a conflicting value
9378 is ignored.  This includes options such as @option{-freg-struct-return}
9379 and @option{-fpcc-struct-return}. 
9381 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9382 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9383 are passed through to the link stage and merged conservatively for
9384 conflicting translation units.  Specifically
9385 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9386 precedence and for example @option{-ffp-contract=off} takes precedence
9387 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9389 It is recommended that you compile all the files participating in the
9390 same link with the same options and also specify those options at
9391 link time.
9393 If LTO encounters objects with C linkage declared with incompatible
9394 types in separate translation units to be linked together (undefined
9395 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9396 issued.  The behavior is still undefined at run time.  Similar
9397 diagnostics may be raised for other languages.
9399 Another feature of LTO is that it is possible to apply interprocedural
9400 optimizations on files written in different languages:
9402 @smallexample
9403 gcc -c -flto foo.c
9404 g++ -c -flto bar.cc
9405 gfortran -c -flto baz.f90
9406 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9407 @end smallexample
9409 Notice that the final link is done with @command{g++} to get the C++
9410 runtime libraries and @option{-lgfortran} is added to get the Fortran
9411 runtime libraries.  In general, when mixing languages in LTO mode, you
9412 should use the same link command options as when mixing languages in a
9413 regular (non-LTO) compilation.
9415 If object files containing GIMPLE bytecode are stored in a library archive, say
9416 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9417 are using a linker with plugin support.  To create static libraries suitable
9418 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9419 and @command{ranlib}; 
9420 to show the symbols of object files with GIMPLE bytecode, use
9421 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9422 and @command{nm} have been compiled with plugin support.  At link time, use the the
9423 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9424 the LTO optimization process:
9426 @smallexample
9427 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9428 @end smallexample
9430 With the linker plugin enabled, the linker extracts the needed
9431 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9432 to make them part of the aggregated GIMPLE image to be optimized.
9434 If you are not using a linker with plugin support and/or do not
9435 enable the linker plugin, then the objects inside @file{libfoo.a}
9436 are extracted and linked as usual, but they do not participate
9437 in the LTO optimization process.  In order to make a static library suitable
9438 for both LTO optimization and usual linkage, compile its object files with
9439 @option{-flto} @option{-ffat-lto-objects}.
9441 Link-time optimizations do not require the presence of the whole program to
9442 operate.  If the program does not require any symbols to be exported, it is
9443 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9444 the interprocedural optimizers to use more aggressive assumptions which may
9445 lead to improved optimization opportunities.
9446 Use of @option{-fwhole-program} is not needed when linker plugin is
9447 active (see @option{-fuse-linker-plugin}).
9449 The current implementation of LTO makes no
9450 attempt to generate bytecode that is portable between different
9451 types of hosts.  The bytecode files are versioned and there is a
9452 strict version check, so bytecode files generated in one version of
9453 GCC do not work with an older or newer version of GCC.
9455 Link-time optimization does not work well with generation of debugging
9456 information.  Combining @option{-flto} with
9457 @option{-g} is currently experimental and expected to produce unexpected
9458 results.
9460 If you specify the optional @var{n}, the optimization and code
9461 generation done at link time is executed in parallel using @var{n}
9462 parallel jobs by utilizing an installed @command{make} program.  The
9463 environment variable @env{MAKE} may be used to override the program
9464 used.  The default value for @var{n} is 1.
9466 You can also specify @option{-flto=jobserver} to use GNU make's
9467 job server mode to determine the number of parallel jobs. This
9468 is useful when the Makefile calling GCC is already executing in parallel.
9469 You must prepend a @samp{+} to the command recipe in the parent Makefile
9470 for this to work.  This option likely only works if @env{MAKE} is
9471 GNU make.
9473 @item -flto-partition=@var{alg}
9474 @opindex flto-partition
9475 Specify the partitioning algorithm used by the link-time optimizer.
9476 The value is either @samp{1to1} to specify a partitioning mirroring
9477 the original source files or @samp{balanced} to specify partitioning
9478 into equally sized chunks (whenever possible) or @samp{max} to create
9479 new partition for every symbol where possible.  Specifying @samp{none}
9480 as an algorithm disables partitioning and streaming completely. 
9481 The default value is @samp{balanced}. While @samp{1to1} can be used
9482 as an workaround for various code ordering issues, the @samp{max}
9483 partitioning is intended for internal testing only.
9484 The value @samp{one} specifies that exactly one partition should be
9485 used while the value @samp{none} bypasses partitioning and executes
9486 the link-time optimization step directly from the WPA phase.
9488 @item -flto-odr-type-merging
9489 @opindex flto-odr-type-merging
9490 Enable streaming of mangled types names of C++ types and their unification
9491 at linktime.  This increases size of LTO object files, but enable
9492 diagnostics about One Definition Rule violations.
9494 @item -flto-compression-level=@var{n}
9495 @opindex flto-compression-level
9496 This option specifies the level of compression used for intermediate
9497 language written to LTO object files, and is only meaningful in
9498 conjunction with LTO mode (@option{-flto}).  Valid
9499 values are 0 (no compression) to 9 (maximum compression).  Values
9500 outside this range are clamped to either 0 or 9.  If the option is not
9501 given, a default balanced compression setting is used.
9503 @item -flto-report
9504 @opindex flto-report
9505 Prints a report with internal details on the workings of the link-time
9506 optimizer.  The contents of this report vary from version to version.
9507 It is meant to be useful to GCC developers when processing object
9508 files in LTO mode (via @option{-flto}).
9510 Disabled by default.
9512 @item -flto-report-wpa
9513 @opindex flto-report-wpa
9514 Like @option{-flto-report}, but only print for the WPA phase of Link
9515 Time Optimization.
9517 @item -fuse-linker-plugin
9518 @opindex fuse-linker-plugin
9519 Enables the use of a linker plugin during link-time optimization.  This
9520 option relies on plugin support in the linker, which is available in gold
9521 or in GNU ld 2.21 or newer.
9523 This option enables the extraction of object files with GIMPLE bytecode out
9524 of library archives. This improves the quality of optimization by exposing
9525 more code to the link-time optimizer.  This information specifies what
9526 symbols can be accessed externally (by non-LTO object or during dynamic
9527 linking).  Resulting code quality improvements on binaries (and shared
9528 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9529 See @option{-flto} for a description of the effect of this flag and how to
9530 use it.
9532 This option is enabled by default when LTO support in GCC is enabled
9533 and GCC was configured for use with
9534 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9536 @item -ffat-lto-objects
9537 @opindex ffat-lto-objects
9538 Fat LTO objects are object files that contain both the intermediate language
9539 and the object code. This makes them usable for both LTO linking and normal
9540 linking. This option is effective only when compiling with @option{-flto}
9541 and is ignored at link time.
9543 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9544 requires the complete toolchain to be aware of LTO. It requires a linker with
9545 linker plugin support for basic functionality.  Additionally,
9546 @command{nm}, @command{ar} and @command{ranlib}
9547 need to support linker plugins to allow a full-featured build environment
9548 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9549 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9550 to these tools. With non fat LTO makefiles need to be modified to use them.
9552 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9553 support.
9555 @item -fcompare-elim
9556 @opindex fcompare-elim
9557 After register allocation and post-register allocation instruction splitting,
9558 identify arithmetic instructions that compute processor flags similar to a
9559 comparison operation based on that arithmetic.  If possible, eliminate the
9560 explicit comparison operation.
9562 This pass only applies to certain targets that cannot explicitly represent
9563 the comparison operation before register allocation is complete.
9565 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9567 @item -fcprop-registers
9568 @opindex fcprop-registers
9569 After register allocation and post-register allocation instruction splitting,
9570 perform a copy-propagation pass to try to reduce scheduling dependencies
9571 and occasionally eliminate the copy.
9573 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9575 @item -fprofile-correction
9576 @opindex fprofile-correction
9577 Profiles collected using an instrumented binary for multi-threaded programs may
9578 be inconsistent due to missed counter updates. When this option is specified,
9579 GCC uses heuristics to correct or smooth out such inconsistencies. By
9580 default, GCC emits an error message when an inconsistent profile is detected.
9582 @item -fprofile-dir=@var{path}
9583 @opindex fprofile-dir
9585 Set the directory to search for the profile data files in to @var{path}.
9586 This option affects only the profile data generated by
9587 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9588 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9589 and its related options.  Both absolute and relative paths can be used.
9590 By default, GCC uses the current directory as @var{path}, thus the
9591 profile data file appears in the same directory as the object file.
9593 @item -fprofile-generate
9594 @itemx -fprofile-generate=@var{path}
9595 @opindex fprofile-generate
9597 Enable options usually used for instrumenting application to produce
9598 profile useful for later recompilation with profile feedback based
9599 optimization.  You must use @option{-fprofile-generate} both when
9600 compiling and when linking your program.
9602 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9604 If @var{path} is specified, GCC looks at the @var{path} to find
9605 the profile feedback data files. See @option{-fprofile-dir}.
9607 @item -fprofile-use
9608 @itemx -fprofile-use=@var{path}
9609 @opindex fprofile-use
9610 Enable profile feedback-directed optimizations, 
9611 and the following optimizations
9612 which are generally profitable only with profile feedback available:
9613 @option{-fbranch-probabilities}, @option{-fvpt},
9614 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9615 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9617 By default, GCC emits an error message if the feedback profiles do not
9618 match the source code.  This error can be turned into a warning by using
9619 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9620 code.
9622 If @var{path} is specified, GCC looks at the @var{path} to find
9623 the profile feedback data files. See @option{-fprofile-dir}.
9625 @item -fauto-profile
9626 @itemx -fauto-profile=@var{path}
9627 @opindex fauto-profile
9628 Enable sampling-based feedback-directed optimizations, 
9629 and the following optimizations
9630 which are generally profitable only with profile feedback available:
9631 @option{-fbranch-probabilities}, @option{-fvpt},
9632 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9633 @option{-ftree-vectorize},
9634 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9635 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9636 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9638 @var{path} is the name of a file containing AutoFDO profile information.
9639 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9641 Producing an AutoFDO profile data file requires running your program
9642 with the @command{perf} utility on a supported GNU/Linux target system.
9643 For more information, see @uref{https://perf.wiki.kernel.org/}.
9645 E.g.
9646 @smallexample
9647 perf record -e br_inst_retired:near_taken -b -o perf.data \
9648     -- your_program
9649 @end smallexample
9651 Then use the @command{create_gcov} tool to convert the raw profile data
9652 to a format that can be used by GCC.@  You must also supply the 
9653 unstripped binary for your program to this tool.  
9654 See @uref{https://github.com/google/autofdo}.
9656 E.g.
9657 @smallexample
9658 create_gcov --binary=your_program.unstripped --profile=perf.data \
9659     --gcov=profile.afdo
9660 @end smallexample
9661 @end table
9663 The following options control compiler behavior regarding floating-point 
9664 arithmetic.  These options trade off between speed and
9665 correctness.  All must be specifically enabled.
9667 @table @gcctabopt
9668 @item -ffloat-store
9669 @opindex ffloat-store
9670 Do not store floating-point variables in registers, and inhibit other
9671 options that might change whether a floating-point value is taken from a
9672 register or memory.
9674 @cindex floating-point precision
9675 This option prevents undesirable excess precision on machines such as
9676 the 68000 where the floating registers (of the 68881) keep more
9677 precision than a @code{double} is supposed to have.  Similarly for the
9678 x86 architecture.  For most programs, the excess precision does only
9679 good, but a few programs rely on the precise definition of IEEE floating
9680 point.  Use @option{-ffloat-store} for such programs, after modifying
9681 them to store all pertinent intermediate computations into variables.
9683 @item -fexcess-precision=@var{style}
9684 @opindex fexcess-precision
9685 This option allows further control over excess precision on machines
9686 where floating-point registers have more precision than the IEEE
9687 @code{float} and @code{double} types and the processor does not
9688 support operations rounding to those types.  By default,
9689 @option{-fexcess-precision=fast} is in effect; this means that
9690 operations are carried out in the precision of the registers and that
9691 it is unpredictable when rounding to the types specified in the source
9692 code takes place.  When compiling C, if
9693 @option{-fexcess-precision=standard} is specified then excess
9694 precision follows the rules specified in ISO C99; in particular,
9695 both casts and assignments cause values to be rounded to their
9696 semantic types (whereas @option{-ffloat-store} only affects
9697 assignments).  This option is enabled by default for C if a strict
9698 conformance option such as @option{-std=c99} is used.
9700 @opindex mfpmath
9701 @option{-fexcess-precision=standard} is not implemented for languages
9702 other than C, and has no effect if
9703 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9704 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9705 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9706 semantics apply without excess precision, and in the latter, rounding
9707 is unpredictable.
9709 @item -ffast-math
9710 @opindex ffast-math
9711 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9712 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9713 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9715 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9717 This option is not turned on by any @option{-O} option besides
9718 @option{-Ofast} since it can result in incorrect output for programs
9719 that depend on an exact implementation of IEEE or ISO rules/specifications
9720 for math functions. It may, however, yield faster code for programs
9721 that do not require the guarantees of these specifications.
9723 @item -fno-math-errno
9724 @opindex fno-math-errno
9725 Do not set @code{errno} after calling math functions that are executed
9726 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9727 IEEE exceptions for math error handling may want to use this flag
9728 for speed while maintaining IEEE arithmetic compatibility.
9730 This option is not turned on by any @option{-O} option since
9731 it can result in incorrect output for programs that depend on
9732 an exact implementation of IEEE or ISO rules/specifications for
9733 math functions. It may, however, yield faster code for programs
9734 that do not require the guarantees of these specifications.
9736 The default is @option{-fmath-errno}.
9738 On Darwin systems, the math library never sets @code{errno}.  There is
9739 therefore no reason for the compiler to consider the possibility that
9740 it might, and @option{-fno-math-errno} is the default.
9742 @item -funsafe-math-optimizations
9743 @opindex funsafe-math-optimizations
9745 Allow optimizations for floating-point arithmetic that (a) assume
9746 that arguments and results are valid and (b) may violate IEEE or
9747 ANSI standards.  When used at link-time, it may include libraries
9748 or startup files that change the default FPU control word or other
9749 similar optimizations.
9751 This option is not turned on by any @option{-O} option since
9752 it can result in incorrect output for programs that depend on
9753 an exact implementation of IEEE or ISO rules/specifications for
9754 math functions. It may, however, yield faster code for programs
9755 that do not require the guarantees of these specifications.
9756 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9757 @option{-fassociative-math} and @option{-freciprocal-math}.
9759 The default is @option{-fno-unsafe-math-optimizations}.
9761 @item -fassociative-math
9762 @opindex fassociative-math
9764 Allow re-association of operands in series of floating-point operations.
9765 This violates the ISO C and C++ language standard by possibly changing
9766 computation result.  NOTE: re-ordering may change the sign of zero as
9767 well as ignore NaNs and inhibit or create underflow or overflow (and
9768 thus cannot be used on code that relies on rounding behavior like
9769 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9770 and thus may not be used when ordered comparisons are required.
9771 This option requires that both @option{-fno-signed-zeros} and
9772 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9773 much sense with @option{-frounding-math}. For Fortran the option
9774 is automatically enabled when both @option{-fno-signed-zeros} and
9775 @option{-fno-trapping-math} are in effect.
9777 The default is @option{-fno-associative-math}.
9779 @item -freciprocal-math
9780 @opindex freciprocal-math
9782 Allow the reciprocal of a value to be used instead of dividing by
9783 the value if this enables optimizations.  For example @code{x / y}
9784 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9785 is subject to common subexpression elimination.  Note that this loses
9786 precision and increases the number of flops operating on the value.
9788 The default is @option{-fno-reciprocal-math}.
9790 @item -ffinite-math-only
9791 @opindex ffinite-math-only
9792 Allow optimizations for floating-point arithmetic that assume
9793 that arguments and results are not NaNs or +-Infs.
9795 This option is not turned on by any @option{-O} option since
9796 it can result in incorrect output for programs that depend on
9797 an exact implementation of IEEE or ISO rules/specifications for
9798 math functions. It may, however, yield faster code for programs
9799 that do not require the guarantees of these specifications.
9801 The default is @option{-fno-finite-math-only}.
9803 @item -fno-signed-zeros
9804 @opindex fno-signed-zeros
9805 Allow optimizations for floating-point arithmetic that ignore the
9806 signedness of zero.  IEEE arithmetic specifies the behavior of
9807 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9808 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9809 This option implies that the sign of a zero result isn't significant.
9811 The default is @option{-fsigned-zeros}.
9813 @item -fno-trapping-math
9814 @opindex fno-trapping-math
9815 Compile code assuming that floating-point operations cannot generate
9816 user-visible traps.  These traps include division by zero, overflow,
9817 underflow, inexact result and invalid operation.  This option requires
9818 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9819 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9821 This option should never be turned on by any @option{-O} option since
9822 it can result in incorrect output for programs that depend on
9823 an exact implementation of IEEE or ISO rules/specifications for
9824 math functions.
9826 The default is @option{-ftrapping-math}.
9828 @item -frounding-math
9829 @opindex frounding-math
9830 Disable transformations and optimizations that assume default floating-point
9831 rounding behavior.  This is round-to-zero for all floating point
9832 to integer conversions, and round-to-nearest for all other arithmetic
9833 truncations.  This option should be specified for programs that change
9834 the FP rounding mode dynamically, or that may be executed with a
9835 non-default rounding mode.  This option disables constant folding of
9836 floating-point expressions at compile time (which may be affected by
9837 rounding mode) and arithmetic transformations that are unsafe in the
9838 presence of sign-dependent rounding modes.
9840 The default is @option{-fno-rounding-math}.
9842 This option is experimental and does not currently guarantee to
9843 disable all GCC optimizations that are affected by rounding mode.
9844 Future versions of GCC may provide finer control of this setting
9845 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9846 will be used to specify the default state for @code{FENV_ACCESS}.
9848 @item -fsignaling-nans
9849 @opindex fsignaling-nans
9850 Compile code assuming that IEEE signaling NaNs may generate user-visible
9851 traps during floating-point operations.  Setting this option disables
9852 optimizations that may change the number of exceptions visible with
9853 signaling NaNs.  This option implies @option{-ftrapping-math}.
9855 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9856 be defined.
9858 The default is @option{-fno-signaling-nans}.
9860 This option is experimental and does not currently guarantee to
9861 disable all GCC optimizations that affect signaling NaN behavior.
9863 @item -fsingle-precision-constant
9864 @opindex fsingle-precision-constant
9865 Treat floating-point constants as single precision instead of
9866 implicitly converting them to double-precision constants.
9868 @item -fcx-limited-range
9869 @opindex fcx-limited-range
9870 When enabled, this option states that a range reduction step is not
9871 needed when performing complex division.  Also, there is no checking
9872 whether the result of a complex multiplication or division is @code{NaN
9873 + I*NaN}, with an attempt to rescue the situation in that case.  The
9874 default is @option{-fno-cx-limited-range}, but is enabled by
9875 @option{-ffast-math}.
9877 This option controls the default setting of the ISO C99
9878 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9879 all languages.
9881 @item -fcx-fortran-rules
9882 @opindex fcx-fortran-rules
9883 Complex multiplication and division follow Fortran rules.  Range
9884 reduction is done as part of complex division, but there is no checking
9885 whether the result of a complex multiplication or division is @code{NaN
9886 + I*NaN}, with an attempt to rescue the situation in that case.
9888 The default is @option{-fno-cx-fortran-rules}.
9890 @end table
9892 The following options control optimizations that may improve
9893 performance, but are not enabled by any @option{-O} options.  This
9894 section includes experimental options that may produce broken code.
9896 @table @gcctabopt
9897 @item -fbranch-probabilities
9898 @opindex fbranch-probabilities
9899 After running a program compiled with @option{-fprofile-arcs}
9900 (@pxref{Debugging Options,, Options for Debugging Your Program or
9901 @command{gcc}}), you can compile it a second time using
9902 @option{-fbranch-probabilities}, to improve optimizations based on
9903 the number of times each branch was taken.  When a program
9904 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9905 counts to a file called @file{@var{sourcename}.gcda} for each source
9906 file.  The information in this data file is very dependent on the
9907 structure of the generated code, so you must use the same source code
9908 and the same optimization options for both compilations.
9910 With @option{-fbranch-probabilities}, GCC puts a
9911 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9912 These can be used to improve optimization.  Currently, they are only
9913 used in one place: in @file{reorg.c}, instead of guessing which path a
9914 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9915 exactly determine which path is taken more often.
9917 @item -fprofile-values
9918 @opindex fprofile-values
9919 If combined with @option{-fprofile-arcs}, it adds code so that some
9920 data about values of expressions in the program is gathered.
9922 With @option{-fbranch-probabilities}, it reads back the data gathered
9923 from profiling values of expressions for usage in optimizations.
9925 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9927 @item -fprofile-reorder-functions
9928 @opindex fprofile-reorder-functions
9929 Function reordering based on profile instrumentation collects
9930 first time of execution of a function and orders these functions
9931 in ascending order.
9933 Enabled with @option{-fprofile-use}.
9935 @item -fvpt
9936 @opindex fvpt
9937 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9938 to add code to gather information about values of expressions.
9940 With @option{-fbranch-probabilities}, it reads back the data gathered
9941 and actually performs the optimizations based on them.
9942 Currently the optimizations include specialization of division operations
9943 using the knowledge about the value of the denominator.
9945 @item -frename-registers
9946 @opindex frename-registers
9947 Attempt to avoid false dependencies in scheduled code by making use
9948 of registers left over after register allocation.  This optimization
9949 most benefits processors with lots of registers.  Depending on the
9950 debug information format adopted by the target, however, it can
9951 make debugging impossible, since variables no longer stay in
9952 a ``home register''.
9954 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9956 @item -fschedule-fusion
9957 @opindex fschedule-fusion
9958 Performs a target dependent pass over the instruction stream to schedule
9959 instructions of same type together because target machine can execute them
9960 more efficiently if they are adjacent to each other in the instruction flow.
9962 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9964 @item -ftracer
9965 @opindex ftracer
9966 Perform tail duplication to enlarge superblock size.  This transformation
9967 simplifies the control flow of the function allowing other optimizations to do
9968 a better job.
9970 Enabled with @option{-fprofile-use}.
9972 @item -funroll-loops
9973 @opindex funroll-loops
9974 Unroll loops whose number of iterations can be determined at compile time or
9975 upon entry to the loop.  @option{-funroll-loops} implies
9976 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9977 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9978 a small constant number of iterations).  This option makes code larger, and may
9979 or may not make it run faster.
9981 Enabled with @option{-fprofile-use}.
9983 @item -funroll-all-loops
9984 @opindex funroll-all-loops
9985 Unroll all loops, even if their number of iterations is uncertain when
9986 the loop is entered.  This usually makes programs run more slowly.
9987 @option{-funroll-all-loops} implies the same options as
9988 @option{-funroll-loops}.
9990 @item -fpeel-loops
9991 @opindex fpeel-loops
9992 Peels loops for which there is enough information that they do not
9993 roll much (from profile feedback).  It also turns on complete loop peeling
9994 (i.e.@: complete removal of loops with small constant number of iterations).
9996 Enabled with @option{-fprofile-use}.
9998 @item -fmove-loop-invariants
9999 @opindex fmove-loop-invariants
10000 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10001 at level @option{-O1}
10003 @item -funswitch-loops
10004 @opindex funswitch-loops
10005 Move branches with loop invariant conditions out of the loop, with duplicates
10006 of the loop on both branches (modified according to result of the condition).
10008 @item -ffunction-sections
10009 @itemx -fdata-sections
10010 @opindex ffunction-sections
10011 @opindex fdata-sections
10012 Place each function or data item into its own section in the output
10013 file if the target supports arbitrary sections.  The name of the
10014 function or the name of the data item determines the section's name
10015 in the output file.
10017 Use these options on systems where the linker can perform optimizations
10018 to improve locality of reference in the instruction space.  Most systems
10019 using the ELF object format and SPARC processors running Solaris 2 have
10020 linkers with such optimizations.  AIX may have these optimizations in
10021 the future.
10023 Only use these options when there are significant benefits from doing
10024 so.  When you specify these options, the assembler and linker
10025 create larger object and executable files and are also slower.
10026 You cannot use @command{gprof} on all systems if you
10027 specify this option, and you may have problems with debugging if
10028 you specify both this option and @option{-g}.
10030 @item -fbranch-target-load-optimize
10031 @opindex fbranch-target-load-optimize
10032 Perform branch target register load optimization before prologue / epilogue
10033 threading.
10034 The use of target registers can typically be exposed only during reload,
10035 thus hoisting loads out of loops and doing inter-block scheduling needs
10036 a separate optimization pass.
10038 @item -fbranch-target-load-optimize2
10039 @opindex fbranch-target-load-optimize2
10040 Perform branch target register load optimization after prologue / epilogue
10041 threading.
10043 @item -fbtr-bb-exclusive
10044 @opindex fbtr-bb-exclusive
10045 When performing branch target register load optimization, don't reuse
10046 branch target registers within any basic block.
10048 @item -fstack-protector
10049 @opindex fstack-protector
10050 Emit extra code to check for buffer overflows, such as stack smashing
10051 attacks.  This is done by adding a guard variable to functions with
10052 vulnerable objects.  This includes functions that call @code{alloca}, and
10053 functions with buffers larger than 8 bytes.  The guards are initialized
10054 when a function is entered and then checked when the function exits.
10055 If a guard check fails, an error message is printed and the program exits.
10057 @item -fstack-protector-all
10058 @opindex fstack-protector-all
10059 Like @option{-fstack-protector} except that all functions are protected.
10061 @item -fstack-protector-strong
10062 @opindex fstack-protector-strong
10063 Like @option{-fstack-protector} but includes additional functions to
10064 be protected --- those that have local array definitions, or have
10065 references to local frame addresses.
10067 @item -fstack-protector-explicit
10068 @opindex fstack-protector-explicit
10069 Like @option{-fstack-protector} but only protects those functions which
10070 have the @code{stack_protect} attribute
10072 @item -fstdarg-opt
10073 @opindex fstdarg-opt
10074 Optimize the prologue of variadic argument functions with respect to usage of
10075 those arguments.
10077 @item -fsection-anchors
10078 @opindex fsection-anchors
10079 Try to reduce the number of symbolic address calculations by using
10080 shared ``anchor'' symbols to address nearby objects.  This transformation
10081 can help to reduce the number of GOT entries and GOT accesses on some
10082 targets.
10084 For example, the implementation of the following function @code{foo}:
10086 @smallexample
10087 static int a, b, c;
10088 int foo (void) @{ return a + b + c; @}
10089 @end smallexample
10091 @noindent
10092 usually calculates the addresses of all three variables, but if you
10093 compile it with @option{-fsection-anchors}, it accesses the variables
10094 from a common anchor point instead.  The effect is similar to the
10095 following pseudocode (which isn't valid C):
10097 @smallexample
10098 int foo (void)
10100   register int *xr = &x;
10101   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10103 @end smallexample
10105 Not all targets support this option.
10107 @item --param @var{name}=@var{value}
10108 @opindex param
10109 In some places, GCC uses various constants to control the amount of
10110 optimization that is done.  For example, GCC does not inline functions
10111 that contain more than a certain number of instructions.  You can
10112 control some of these constants on the command line using the
10113 @option{--param} option.
10115 The names of specific parameters, and the meaning of the values, are
10116 tied to the internals of the compiler, and are subject to change
10117 without notice in future releases.
10119 In each case, the @var{value} is an integer.  The allowable choices for
10120 @var{name} are:
10122 @table @gcctabopt
10123 @item predictable-branch-outcome
10124 When branch is predicted to be taken with probability lower than this threshold
10125 (in percent), then it is considered well predictable. The default is 10.
10127 @item max-crossjump-edges
10128 The maximum number of incoming edges to consider for cross-jumping.
10129 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10130 the number of edges incoming to each block.  Increasing values mean
10131 more aggressive optimization, making the compilation time increase with
10132 probably small improvement in executable size.
10134 @item min-crossjump-insns
10135 The minimum number of instructions that must be matched at the end
10136 of two blocks before cross-jumping is performed on them.  This
10137 value is ignored in the case where all instructions in the block being
10138 cross-jumped from are matched.  The default value is 5.
10140 @item max-grow-copy-bb-insns
10141 The maximum code size expansion factor when copying basic blocks
10142 instead of jumping.  The expansion is relative to a jump instruction.
10143 The default value is 8.
10145 @item max-goto-duplication-insns
10146 The maximum number of instructions to duplicate to a block that jumps
10147 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10148 passes, GCC factors computed gotos early in the compilation process,
10149 and unfactors them as late as possible.  Only computed jumps at the
10150 end of a basic blocks with no more than max-goto-duplication-insns are
10151 unfactored.  The default value is 8.
10153 @item max-delay-slot-insn-search
10154 The maximum number of instructions to consider when looking for an
10155 instruction to fill a delay slot.  If more than this arbitrary number of
10156 instructions are searched, the time savings from filling the delay slot
10157 are minimal, so stop searching.  Increasing values mean more
10158 aggressive optimization, making the compilation time increase with probably
10159 small improvement in execution time.
10161 @item max-delay-slot-live-search
10162 When trying to fill delay slots, the maximum number of instructions to
10163 consider when searching for a block with valid live register
10164 information.  Increasing this arbitrarily chosen value means more
10165 aggressive optimization, increasing the compilation time.  This parameter
10166 should be removed when the delay slot code is rewritten to maintain the
10167 control-flow graph.
10169 @item max-gcse-memory
10170 The approximate maximum amount of memory that can be allocated in
10171 order to perform the global common subexpression elimination
10172 optimization.  If more memory than specified is required, the
10173 optimization is not done.
10175 @item max-gcse-insertion-ratio
10176 If the ratio of expression insertions to deletions is larger than this value
10177 for any expression, then RTL PRE inserts or removes the expression and thus
10178 leaves partially redundant computations in the instruction stream.  The default value is 20.
10180 @item max-pending-list-length
10181 The maximum number of pending dependencies scheduling allows
10182 before flushing the current state and starting over.  Large functions
10183 with few branches or calls can create excessively large lists which
10184 needlessly consume memory and resources.
10186 @item max-modulo-backtrack-attempts
10187 The maximum number of backtrack attempts the scheduler should make
10188 when modulo scheduling a loop.  Larger values can exponentially increase
10189 compilation time.
10191 @item max-inline-insns-single
10192 Several parameters control the tree inliner used in GCC@.
10193 This number sets the maximum number of instructions (counted in GCC's
10194 internal representation) in a single function that the tree inliner
10195 considers for inlining.  This only affects functions declared
10196 inline and methods implemented in a class declaration (C++).
10197 The default value is 400.
10199 @item max-inline-insns-auto
10200 When you use @option{-finline-functions} (included in @option{-O3}),
10201 a lot of functions that would otherwise not be considered for inlining
10202 by the compiler are investigated.  To those functions, a different
10203 (more restrictive) limit compared to functions declared inline can
10204 be applied.
10205 The default value is 40.
10207 @item inline-min-speedup
10208 When estimated performance improvement of caller + callee runtime exceeds this
10209 threshold (in precent), the function can be inlined regardless the limit on
10210 @option{--param max-inline-insns-single} and @option{--param
10211 max-inline-insns-auto}.
10213 @item large-function-insns
10214 The limit specifying really large functions.  For functions larger than this
10215 limit after inlining, inlining is constrained by
10216 @option{--param large-function-growth}.  This parameter is useful primarily
10217 to avoid extreme compilation time caused by non-linear algorithms used by the
10218 back end.
10219 The default value is 2700.
10221 @item large-function-growth
10222 Specifies maximal growth of large function caused by inlining in percents.
10223 The default value is 100 which limits large function growth to 2.0 times
10224 the original size.
10226 @item large-unit-insns
10227 The limit specifying large translation unit.  Growth caused by inlining of
10228 units larger than this limit is limited by @option{--param inline-unit-growth}.
10229 For small units this might be too tight.
10230 For example, consider a unit consisting of function A
10231 that is inline and B that just calls A three times.  If B is small relative to
10232 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10233 large units consisting of small inlineable functions, however, the overall unit
10234 growth limit is needed to avoid exponential explosion of code size.  Thus for
10235 smaller units, the size is increased to @option{--param large-unit-insns}
10236 before applying @option{--param inline-unit-growth}.  The default is 10000.
10238 @item inline-unit-growth
10239 Specifies maximal overall growth of the compilation unit caused by inlining.
10240 The default value is 20 which limits unit growth to 1.2 times the original
10241 size. Cold functions (either marked cold via an attribute or by profile
10242 feedback) are not accounted into the unit size.
10244 @item ipcp-unit-growth
10245 Specifies maximal overall growth of the compilation unit caused by
10246 interprocedural constant propagation.  The default value is 10 which limits
10247 unit growth to 1.1 times the original size.
10249 @item large-stack-frame
10250 The limit specifying large stack frames.  While inlining the algorithm is trying
10251 to not grow past this limit too much.  The default value is 256 bytes.
10253 @item large-stack-frame-growth
10254 Specifies maximal growth of large stack frames caused by inlining in percents.
10255 The default value is 1000 which limits large stack frame growth to 11 times
10256 the original size.
10258 @item max-inline-insns-recursive
10259 @itemx max-inline-insns-recursive-auto
10260 Specifies the maximum number of instructions an out-of-line copy of a
10261 self-recursive inline
10262 function can grow into by performing recursive inlining.
10264 @option{--param max-inline-insns-recursive} applies to functions
10265 declared inline.
10266 For functions not declared inline, recursive inlining
10267 happens only when @option{-finline-functions} (included in @option{-O3}) is
10268 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10269 default value is 450.
10271 @item max-inline-recursive-depth
10272 @itemx max-inline-recursive-depth-auto
10273 Specifies the maximum recursion depth used for recursive inlining.
10275 @option{--param max-inline-recursive-depth} applies to functions
10276 declared inline.  For functions not declared inline, recursive inlining
10277 happens only when @option{-finline-functions} (included in @option{-O3}) is
10278 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10279 default value is 8.
10281 @item min-inline-recursive-probability
10282 Recursive inlining is profitable only for function having deep recursion
10283 in average and can hurt for function having little recursion depth by
10284 increasing the prologue size or complexity of function body to other
10285 optimizers.
10287 When profile feedback is available (see @option{-fprofile-generate}) the actual
10288 recursion depth can be guessed from probability that function recurses via a
10289 given call expression.  This parameter limits inlining only to call expressions
10290 whose probability exceeds the given threshold (in percents).
10291 The default value is 10.
10293 @item early-inlining-insns
10294 Specify growth that the early inliner can make.  In effect it increases
10295 the amount of inlining for code having a large abstraction penalty.
10296 The default value is 14.
10298 @item max-early-inliner-iterations
10299 Limit of iterations of the early inliner.  This basically bounds
10300 the number of nested indirect calls the early inliner can resolve.
10301 Deeper chains are still handled by late inlining.
10303 @item comdat-sharing-probability
10304 Probability (in percent) that C++ inline function with comdat visibility
10305 are shared across multiple compilation units.  The default value is 20.
10307 @item profile-func-internal-id
10308 A parameter to control whether to use function internal id in profile
10309 database lookup. If the value is 0, the compiler uses an id that
10310 is based on function assembler name and filename, which makes old profile
10311 data more tolerant to source changes such as function reordering etc.
10312 The default value is 0.
10314 @item min-vect-loop-bound
10315 The minimum number of iterations under which loops are not vectorized
10316 when @option{-ftree-vectorize} is used.  The number of iterations after
10317 vectorization needs to be greater than the value specified by this option
10318 to allow vectorization.  The default value is 0.
10320 @item gcse-cost-distance-ratio
10321 Scaling factor in calculation of maximum distance an expression
10322 can be moved by GCSE optimizations.  This is currently supported only in the
10323 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10324 is with simple expressions, i.e., the expressions that have cost
10325 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10326 hoisting of simple expressions.  The default value is 10.
10328 @item gcse-unrestricted-cost
10329 Cost, roughly measured as the cost of a single typical machine
10330 instruction, at which GCSE optimizations do not constrain
10331 the distance an expression can travel.  This is currently
10332 supported only in the code hoisting pass.  The lesser the cost,
10333 the more aggressive code hoisting is.  Specifying 0 
10334 allows all expressions to travel unrestricted distances.
10335 The default value is 3.
10337 @item max-hoist-depth
10338 The depth of search in the dominator tree for expressions to hoist.
10339 This is used to avoid quadratic behavior in hoisting algorithm.
10340 The value of 0 does not limit on the search, but may slow down compilation
10341 of huge functions.  The default value is 30.
10343 @item max-tail-merge-comparisons
10344 The maximum amount of similar bbs to compare a bb with.  This is used to
10345 avoid quadratic behavior in tree tail merging.  The default value is 10.
10347 @item max-tail-merge-iterations
10348 The maximum amount of iterations of the pass over the function.  This is used to
10349 limit compilation time in tree tail merging.  The default value is 2.
10351 @item max-unrolled-insns
10352 The maximum number of instructions that a loop may have to be unrolled.
10353 If a loop is unrolled, this parameter also determines how many times
10354 the loop code is unrolled.
10356 @item max-average-unrolled-insns
10357 The maximum number of instructions biased by probabilities of their execution
10358 that a loop may have to be unrolled.  If a loop is unrolled,
10359 this parameter also determines how many times the loop code is unrolled.
10361 @item max-unroll-times
10362 The maximum number of unrollings of a single loop.
10364 @item max-peeled-insns
10365 The maximum number of instructions that a loop may have to be peeled.
10366 If a loop is peeled, this parameter also determines how many times
10367 the loop code is peeled.
10369 @item max-peel-times
10370 The maximum number of peelings of a single loop.
10372 @item max-peel-branches
10373 The maximum number of branches on the hot path through the peeled sequence.
10375 @item max-completely-peeled-insns
10376 The maximum number of insns of a completely peeled loop.
10378 @item max-completely-peel-times
10379 The maximum number of iterations of a loop to be suitable for complete peeling.
10381 @item max-completely-peel-loop-nest-depth
10382 The maximum depth of a loop nest suitable for complete peeling.
10384 @item max-unswitch-insns
10385 The maximum number of insns of an unswitched loop.
10387 @item max-unswitch-level
10388 The maximum number of branches unswitched in a single loop.
10390 @item lim-expensive
10391 The minimum cost of an expensive expression in the loop invariant motion.
10393 @item iv-consider-all-candidates-bound
10394 Bound on number of candidates for induction variables, below which
10395 all candidates are considered for each use in induction variable
10396 optimizations.  If there are more candidates than this,
10397 only the most relevant ones are considered to avoid quadratic time complexity.
10399 @item iv-max-considered-uses
10400 The induction variable optimizations give up on loops that contain more
10401 induction variable uses.
10403 @item iv-always-prune-cand-set-bound
10404 If the number of candidates in the set is smaller than this value,
10405 always try to remove unnecessary ivs from the set
10406 when adding a new one.
10408 @item scev-max-expr-size
10409 Bound on size of expressions used in the scalar evolutions analyzer.
10410 Large expressions slow the analyzer.
10412 @item scev-max-expr-complexity
10413 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10414 Complex expressions slow the analyzer.
10416 @item vect-max-version-for-alignment-checks
10417 The maximum number of run-time checks that can be performed when
10418 doing loop versioning for alignment in the vectorizer.
10420 @item vect-max-version-for-alias-checks
10421 The maximum number of run-time checks that can be performed when
10422 doing loop versioning for alias in the vectorizer.
10424 @item vect-max-peeling-for-alignment
10425 The maximum number of loop peels to enhance access alignment
10426 for vectorizer. Value -1 means 'no limit'.
10428 @item max-iterations-to-track
10429 The maximum number of iterations of a loop the brute-force algorithm
10430 for analysis of the number of iterations of the loop tries to evaluate.
10432 @item hot-bb-count-ws-permille
10433 A basic block profile count is considered hot if it contributes to 
10434 the given permillage (i.e. 0...1000) of the entire profiled execution.
10436 @item hot-bb-frequency-fraction
10437 Select fraction of the entry block frequency of executions of basic block in
10438 function given basic block needs to have to be considered hot.
10440 @item max-predicted-iterations
10441 The maximum number of loop iterations we predict statically.  This is useful
10442 in cases where a function contains a single loop with known bound and
10443 another loop with unknown bound.
10444 The known number of iterations is predicted correctly, while
10445 the unknown number of iterations average to roughly 10.  This means that the
10446 loop without bounds appears artificially cold relative to the other one.
10448 @item builtin-expect-probability
10449 Control the probability of the expression having the specified value. This
10450 parameter takes a percentage (i.e. 0 ... 100) as input.
10451 The default probability of 90 is obtained empirically.
10453 @item align-threshold
10455 Select fraction of the maximal frequency of executions of a basic block in
10456 a function to align the basic block.
10458 @item align-loop-iterations
10460 A loop expected to iterate at least the selected number of iterations is
10461 aligned.
10463 @item tracer-dynamic-coverage
10464 @itemx tracer-dynamic-coverage-feedback
10466 This value is used to limit superblock formation once the given percentage of
10467 executed instructions is covered.  This limits unnecessary code size
10468 expansion.
10470 The @option{tracer-dynamic-coverage-feedback} parameter
10471 is used only when profile
10472 feedback is available.  The real profiles (as opposed to statically estimated
10473 ones) are much less balanced allowing the threshold to be larger value.
10475 @item tracer-max-code-growth
10476 Stop tail duplication once code growth has reached given percentage.  This is
10477 a rather artificial limit, as most of the duplicates are eliminated later in
10478 cross jumping, so it may be set to much higher values than is the desired code
10479 growth.
10481 @item tracer-min-branch-ratio
10483 Stop reverse growth when the reverse probability of best edge is less than this
10484 threshold (in percent).
10486 @item tracer-min-branch-ratio
10487 @itemx tracer-min-branch-ratio-feedback
10489 Stop forward growth if the best edge has probability lower than this
10490 threshold.
10492 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10493 compilation for profile feedback and one for compilation without.  The value
10494 for compilation with profile feedback needs to be more conservative (higher) in
10495 order to make tracer effective.
10497 @item max-cse-path-length
10499 The maximum number of basic blocks on path that CSE considers.
10500 The default is 10.
10502 @item max-cse-insns
10503 The maximum number of instructions CSE processes before flushing.
10504 The default is 1000.
10506 @item ggc-min-expand
10508 GCC uses a garbage collector to manage its own memory allocation.  This
10509 parameter specifies the minimum percentage by which the garbage
10510 collector's heap should be allowed to expand between collections.
10511 Tuning this may improve compilation speed; it has no effect on code
10512 generation.
10514 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10515 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10516 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10517 GCC is not able to calculate RAM on a particular platform, the lower
10518 bound of 30% is used.  Setting this parameter and
10519 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10520 every opportunity.  This is extremely slow, but can be useful for
10521 debugging.
10523 @item ggc-min-heapsize
10525 Minimum size of the garbage collector's heap before it begins bothering
10526 to collect garbage.  The first collection occurs after the heap expands
10527 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10528 tuning this may improve compilation speed, and has no effect on code
10529 generation.
10531 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10532 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10533 with a lower bound of 4096 (four megabytes) and an upper bound of
10534 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10535 particular platform, the lower bound is used.  Setting this parameter
10536 very large effectively disables garbage collection.  Setting this
10537 parameter and @option{ggc-min-expand} to zero causes a full collection
10538 to occur at every opportunity.
10540 @item max-reload-search-insns
10541 The maximum number of instruction reload should look backward for equivalent
10542 register.  Increasing values mean more aggressive optimization, making the
10543 compilation time increase with probably slightly better performance.
10544 The default value is 100.
10546 @item max-cselib-memory-locations
10547 The maximum number of memory locations cselib should take into account.
10548 Increasing values mean more aggressive optimization, making the compilation time
10549 increase with probably slightly better performance.  The default value is 500.
10551 @item reorder-blocks-duplicate
10552 @itemx reorder-blocks-duplicate-feedback
10554 Used by the basic block reordering pass to decide whether to use unconditional
10555 branch or duplicate the code on its destination.  Code is duplicated when its
10556 estimated size is smaller than this value multiplied by the estimated size of
10557 unconditional jump in the hot spots of the program.
10559 The @option{reorder-block-duplicate-feedback} parameter
10560 is used only when profile
10561 feedback is available.  It may be set to higher values than
10562 @option{reorder-block-duplicate} since information about the hot spots is more
10563 accurate.
10565 @item max-sched-ready-insns
10566 The maximum number of instructions ready to be issued the scheduler should
10567 consider at any given time during the first scheduling pass.  Increasing
10568 values mean more thorough searches, making the compilation time increase
10569 with probably little benefit.  The default value is 100.
10571 @item max-sched-region-blocks
10572 The maximum number of blocks in a region to be considered for
10573 interblock scheduling.  The default value is 10.
10575 @item max-pipeline-region-blocks
10576 The maximum number of blocks in a region to be considered for
10577 pipelining in the selective scheduler.  The default value is 15.
10579 @item max-sched-region-insns
10580 The maximum number of insns in a region to be considered for
10581 interblock scheduling.  The default value is 100.
10583 @item max-pipeline-region-insns
10584 The maximum number of insns in a region to be considered for
10585 pipelining in the selective scheduler.  The default value is 200.
10587 @item min-spec-prob
10588 The minimum probability (in percents) of reaching a source block
10589 for interblock speculative scheduling.  The default value is 40.
10591 @item max-sched-extend-regions-iters
10592 The maximum number of iterations through CFG to extend regions.
10593 A value of 0 (the default) disables region extensions.
10595 @item max-sched-insn-conflict-delay
10596 The maximum conflict delay for an insn to be considered for speculative motion.
10597 The default value is 3.
10599 @item sched-spec-prob-cutoff
10600 The minimal probability of speculation success (in percents), so that
10601 speculative insns are scheduled.
10602 The default value is 40.
10604 @item sched-spec-state-edge-prob-cutoff
10605 The minimum probability an edge must have for the scheduler to save its
10606 state across it.
10607 The default value is 10.
10609 @item sched-mem-true-dep-cost
10610 Minimal distance (in CPU cycles) between store and load targeting same
10611 memory locations.  The default value is 1.
10613 @item selsched-max-lookahead
10614 The maximum size of the lookahead window of selective scheduling.  It is a
10615 depth of search for available instructions.
10616 The default value is 50.
10618 @item selsched-max-sched-times
10619 The maximum number of times that an instruction is scheduled during
10620 selective scheduling.  This is the limit on the number of iterations
10621 through which the instruction may be pipelined.  The default value is 2.
10623 @item selsched-max-insns-to-rename
10624 The maximum number of best instructions in the ready list that are considered
10625 for renaming in the selective scheduler.  The default value is 2.
10627 @item sms-min-sc
10628 The minimum value of stage count that swing modulo scheduler
10629 generates.  The default value is 2.
10631 @item max-last-value-rtl
10632 The maximum size measured as number of RTLs that can be recorded in an expression
10633 in combiner for a pseudo register as last known value of that register.  The default
10634 is 10000.
10636 @item max-combine-insns
10637 The maximum number of instructions the RTL combiner tries to combine.
10638 The default value is 2 at @option{-Og} and 4 otherwise.
10640 @item integer-share-limit
10641 Small integer constants can use a shared data structure, reducing the
10642 compiler's memory usage and increasing its speed.  This sets the maximum
10643 value of a shared integer constant.  The default value is 256.
10645 @item ssp-buffer-size
10646 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10647 protection when @option{-fstack-protection} is used.
10649 @item min-size-for-stack-sharing
10650 The minimum size of variables taking part in stack slot sharing when not
10651 optimizing. The default value is 32.
10653 @item max-jump-thread-duplication-stmts
10654 Maximum number of statements allowed in a block that needs to be
10655 duplicated when threading jumps.
10657 @item max-fields-for-field-sensitive
10658 Maximum number of fields in a structure treated in
10659 a field sensitive manner during pointer analysis.  The default is zero
10660 for @option{-O0} and @option{-O1},
10661 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10663 @item prefetch-latency
10664 Estimate on average number of instructions that are executed before
10665 prefetch finishes.  The distance prefetched ahead is proportional
10666 to this constant.  Increasing this number may also lead to less
10667 streams being prefetched (see @option{simultaneous-prefetches}).
10669 @item simultaneous-prefetches
10670 Maximum number of prefetches that can run at the same time.
10672 @item l1-cache-line-size
10673 The size of cache line in L1 cache, in bytes.
10675 @item l1-cache-size
10676 The size of L1 cache, in kilobytes.
10678 @item l2-cache-size
10679 The size of L2 cache, in kilobytes.
10681 @item min-insn-to-prefetch-ratio
10682 The minimum ratio between the number of instructions and the
10683 number of prefetches to enable prefetching in a loop.
10685 @item prefetch-min-insn-to-mem-ratio
10686 The minimum ratio between the number of instructions and the
10687 number of memory references to enable prefetching in a loop.
10689 @item use-canonical-types
10690 Whether the compiler should use the ``canonical'' type system.  By
10691 default, this should always be 1, which uses a more efficient internal
10692 mechanism for comparing types in C++ and Objective-C++.  However, if
10693 bugs in the canonical type system are causing compilation failures,
10694 set this value to 0 to disable canonical types.
10696 @item switch-conversion-max-branch-ratio
10697 Switch initialization conversion refuses to create arrays that are
10698 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10699 branches in the switch.
10701 @item max-partial-antic-length
10702 Maximum length of the partial antic set computed during the tree
10703 partial redundancy elimination optimization (@option{-ftree-pre}) when
10704 optimizing at @option{-O3} and above.  For some sorts of source code
10705 the enhanced partial redundancy elimination optimization can run away,
10706 consuming all of the memory available on the host machine.  This
10707 parameter sets a limit on the length of the sets that are computed,
10708 which prevents the runaway behavior.  Setting a value of 0 for
10709 this parameter allows an unlimited set length.
10711 @item sccvn-max-scc-size
10712 Maximum size of a strongly connected component (SCC) during SCCVN
10713 processing.  If this limit is hit, SCCVN processing for the whole
10714 function is not done and optimizations depending on it are
10715 disabled.  The default maximum SCC size is 10000.
10717 @item sccvn-max-alias-queries-per-access
10718 Maximum number of alias-oracle queries we perform when looking for
10719 redundancies for loads and stores.  If this limit is hit the search
10720 is aborted and the load or store is not considered redundant.  The
10721 number of queries is algorithmically limited to the number of
10722 stores on all paths from the load to the function entry.
10723 The default maxmimum number of queries is 1000.
10725 @item ira-max-loops-num
10726 IRA uses regional register allocation by default.  If a function
10727 contains more loops than the number given by this parameter, only at most
10728 the given number of the most frequently-executed loops form regions
10729 for regional register allocation.  The default value of the
10730 parameter is 100.
10732 @item ira-max-conflict-table-size 
10733 Although IRA uses a sophisticated algorithm to compress the conflict
10734 table, the table can still require excessive amounts of memory for
10735 huge functions.  If the conflict table for a function could be more
10736 than the size in MB given by this parameter, the register allocator
10737 instead uses a faster, simpler, and lower-quality
10738 algorithm that does not require building a pseudo-register conflict table.  
10739 The default value of the parameter is 2000.
10741 @item ira-loop-reserved-regs
10742 IRA can be used to evaluate more accurate register pressure in loops
10743 for decisions to move loop invariants (see @option{-O3}).  The number
10744 of available registers reserved for some other purposes is given
10745 by this parameter.  The default value of the parameter is 2, which is
10746 the minimal number of registers needed by typical instructions.
10747 This value is the best found from numerous experiments.
10749 @item lra-inheritance-ebb-probability-cutoff
10750 LRA tries to reuse values reloaded in registers in subsequent insns.
10751 This optimization is called inheritance.  EBB is used as a region to
10752 do this optimization.  The parameter defines a minimal fall-through
10753 edge probability in percentage used to add BB to inheritance EBB in
10754 LRA.  The default value of the parameter is 40.  The value was chosen
10755 from numerous runs of SPEC2000 on x86-64.
10757 @item loop-invariant-max-bbs-in-loop
10758 Loop invariant motion can be very expensive, both in compilation time and
10759 in amount of needed compile-time memory, with very large loops.  Loops
10760 with more basic blocks than this parameter won't have loop invariant
10761 motion optimization performed on them.  The default value of the
10762 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10764 @item loop-max-datarefs-for-datadeps
10765 Building data dapendencies is expensive for very large loops.  This
10766 parameter limits the number of data references in loops that are
10767 considered for data dependence analysis.  These large loops are no
10768 handled by the optimizations using loop data dependencies.
10769 The default value is 1000.
10771 @item max-vartrack-size
10772 Sets a maximum number of hash table slots to use during variable
10773 tracking dataflow analysis of any function.  If this limit is exceeded
10774 with variable tracking at assignments enabled, analysis for that
10775 function is retried without it, after removing all debug insns from
10776 the function.  If the limit is exceeded even without debug insns, var
10777 tracking analysis is completely disabled for the function.  Setting
10778 the parameter to zero makes it unlimited.
10780 @item max-vartrack-expr-depth
10781 Sets a maximum number of recursion levels when attempting to map
10782 variable names or debug temporaries to value expressions.  This trades
10783 compilation time for more complete debug information.  If this is set too
10784 low, value expressions that are available and could be represented in
10785 debug information may end up not being used; setting this higher may
10786 enable the compiler to find more complex debug expressions, but compile
10787 time and memory use may grow.  The default is 12.
10789 @item min-nondebug-insn-uid
10790 Use uids starting at this parameter for nondebug insns.  The range below
10791 the parameter is reserved exclusively for debug insns created by
10792 @option{-fvar-tracking-assignments}, but debug insns may get
10793 (non-overlapping) uids above it if the reserved range is exhausted.
10795 @item ipa-sra-ptr-growth-factor
10796 IPA-SRA replaces a pointer to an aggregate with one or more new
10797 parameters only when their cumulative size is less or equal to
10798 @option{ipa-sra-ptr-growth-factor} times the size of the original
10799 pointer parameter.
10801 @item sra-max-scalarization-size-Ospeed
10802 @item sra-max-scalarization-size-Osize
10803 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10804 replace scalar parts of aggregates with uses of independent scalar
10805 variables.  These parameters control the maximum size, in storage units,
10806 of aggregate which is considered for replacement when compiling for
10807 speed
10808 (@option{sra-max-scalarization-size-Ospeed}) or size
10809 (@option{sra-max-scalarization-size-Osize}) respectively.
10811 @item tm-max-aggregate-size
10812 When making copies of thread-local variables in a transaction, this
10813 parameter specifies the size in bytes after which variables are
10814 saved with the logging functions as opposed to save/restore code
10815 sequence pairs.  This option only applies when using
10816 @option{-fgnu-tm}.
10818 @item graphite-max-nb-scop-params
10819 To avoid exponential effects in the Graphite loop transforms, the
10820 number of parameters in a Static Control Part (SCoP) is bounded.  The
10821 default value is 10 parameters.  A variable whose value is unknown at
10822 compilation time and defined outside a SCoP is a parameter of the SCoP.
10824 @item graphite-max-bbs-per-function
10825 To avoid exponential effects in the detection of SCoPs, the size of
10826 the functions analyzed by Graphite is bounded.  The default value is
10827 100 basic blocks.
10829 @item loop-block-tile-size
10830 Loop blocking or strip mining transforms, enabled with
10831 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10832 loop in the loop nest by a given number of iterations.  The strip
10833 length can be changed using the @option{loop-block-tile-size}
10834 parameter.  The default value is 51 iterations.
10836 @item loop-unroll-jam-size
10837 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10838 default value is 4.
10840 @item loop-unroll-jam-depth
10841 Specify the dimension to be unrolled (counting from the most inner loop)
10842 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10844 @item ipa-cp-value-list-size
10845 IPA-CP attempts to track all possible values and types passed to a function's
10846 parameter in order to propagate them and perform devirtualization.
10847 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10848 stores per one formal parameter of a function.
10850 @item ipa-cp-eval-threshold
10851 IPA-CP calculates its own score of cloning profitability heuristics
10852 and performs those cloning opportunities with scores that exceed
10853 @option{ipa-cp-eval-threshold}.
10855 @item ipa-cp-recursion-penalty
10856 Percentage penalty the recursive functions will receive when they
10857 are evaluated for cloning.
10859 @item ipa-cp-single-call-penalty
10860 Percentage penalty functions containg a single call to another
10861 function will receive when they are evaluated for cloning.
10864 @item ipa-max-agg-items
10865 IPA-CP is also capable to propagate a number of scalar values passed
10866 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10867 number of such values per one parameter.
10869 @item ipa-cp-loop-hint-bonus
10870 When IPA-CP determines that a cloning candidate would make the number
10871 of iterations of a loop known, it adds a bonus of
10872 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10873 the candidate.
10875 @item ipa-cp-array-index-hint-bonus
10876 When IPA-CP determines that a cloning candidate would make the index of
10877 an array access known, it adds a bonus of
10878 @option{ipa-cp-array-index-hint-bonus} to the profitability
10879 score of the candidate.
10881 @item ipa-max-aa-steps
10882 During its analysis of function bodies, IPA-CP employs alias analysis
10883 in order to track values pointed to by function parameters.  In order
10884 not spend too much time analyzing huge functions, it gives up and
10885 consider all memory clobbered after examining
10886 @option{ipa-max-aa-steps} statements modifying memory.
10888 @item lto-partitions
10889 Specify desired number of partitions produced during WHOPR compilation.
10890 The number of partitions should exceed the number of CPUs used for compilation.
10891 The default value is 32.
10893 @item lto-minpartition
10894 Size of minimal partition for WHOPR (in estimated instructions).
10895 This prevents expenses of splitting very small programs into too many
10896 partitions.
10898 @item cxx-max-namespaces-for-diagnostic-help
10899 The maximum number of namespaces to consult for suggestions when C++
10900 name lookup fails for an identifier.  The default is 1000.
10902 @item sink-frequency-threshold
10903 The maximum relative execution frequency (in percents) of the target block
10904 relative to a statement's original block to allow statement sinking of a
10905 statement.  Larger numbers result in more aggressive statement sinking.
10906 The default value is 75.  A small positive adjustment is applied for
10907 statements with memory operands as those are even more profitable so sink.
10909 @item max-stores-to-sink
10910 The maximum number of conditional stores paires that can be sunk.  Set to 0
10911 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10912 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10914 @item allow-store-data-races
10915 Allow optimizers to introduce new data races on stores.
10916 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10917 at optimization level @option{-Ofast}.
10919 @item case-values-threshold
10920 The smallest number of different values for which it is best to use a
10921 jump-table instead of a tree of conditional branches.  If the value is
10922 0, use the default for the machine.  The default is 0.
10924 @item tree-reassoc-width
10925 Set the maximum number of instructions executed in parallel in
10926 reassociated tree. This parameter overrides target dependent
10927 heuristics used by default if has non zero value.
10929 @item sched-pressure-algorithm
10930 Choose between the two available implementations of
10931 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10932 and is the more likely to prevent instructions from being reordered.
10933 Algorithm 2 was designed to be a compromise between the relatively
10934 conservative approach taken by algorithm 1 and the rather aggressive
10935 approach taken by the default scheduler.  It relies more heavily on
10936 having a regular register file and accurate register pressure classes.
10937 See @file{haifa-sched.c} in the GCC sources for more details.
10939 The default choice depends on the target.
10941 @item max-slsr-cand-scan
10942 Set the maximum number of existing candidates that are considered when
10943 seeking a basis for a new straight-line strength reduction candidate.
10945 @item asan-globals
10946 Enable buffer overflow detection for global objects.  This kind
10947 of protection is enabled by default if you are using
10948 @option{-fsanitize=address} option.
10949 To disable global objects protection use @option{--param asan-globals=0}.
10951 @item asan-stack
10952 Enable buffer overflow detection for stack objects.  This kind of
10953 protection is enabled by default when using @option{-fsanitize=address}.
10954 To disable stack protection use @option{--param asan-stack=0} option.
10956 @item asan-instrument-reads
10957 Enable buffer overflow detection for memory reads.  This kind of
10958 protection is enabled by default when using @option{-fsanitize=address}.
10959 To disable memory reads protection use
10960 @option{--param asan-instrument-reads=0}.
10962 @item asan-instrument-writes
10963 Enable buffer overflow detection for memory writes.  This kind of
10964 protection is enabled by default when using @option{-fsanitize=address}.
10965 To disable memory writes protection use
10966 @option{--param asan-instrument-writes=0} option.
10968 @item asan-memintrin
10969 Enable detection for built-in functions.  This kind of protection
10970 is enabled by default when using @option{-fsanitize=address}.
10971 To disable built-in functions protection use
10972 @option{--param asan-memintrin=0}.
10974 @item asan-use-after-return
10975 Enable detection of use-after-return.  This kind of protection
10976 is enabled by default when using @option{-fsanitize=address} option.
10977 To disable use-after-return detection use 
10978 @option{--param asan-use-after-return=0}.
10980 @item asan-instrumentation-with-call-threshold
10981 If number of memory accesses in function being instrumented
10982 is greater or equal to this number, use callbacks instead of inline checks.
10983 E.g. to disable inline code use
10984 @option{--param asan-instrumentation-with-call-threshold=0}.
10986 @item chkp-max-ctor-size
10987 Static constructors generated by Pointer Bounds Checker may become very
10988 large and significantly increase compile time at optimization level
10989 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10990 in a single generated constructor.  Default value is 5000.
10992 @item max-fsm-thread-path-insns
10993 Maximum number of instructions to copy when duplicating blocks on a
10994 finite state automaton jump thread path.  The default is 100.
10996 @item max-fsm-thread-length
10997 Maximum number of basic blocks on a finite state automaton jump thread
10998 path.  The default is 10.
11000 @item max-fsm-thread-paths
11001 Maximum number of new jump thread paths to create for a finite state
11002 automaton.  The default is 50.
11004 @item parloops-chunk-size
11005 Chunk size of omp schedule for loops parallelized by parloops.  The default
11006 is 0.
11008 @end table
11009 @end table
11011 @node Preprocessor Options
11012 @section Options Controlling the Preprocessor
11013 @cindex preprocessor options
11014 @cindex options, preprocessor
11016 These options control the C preprocessor, which is run on each C source
11017 file before actual compilation.
11019 If you use the @option{-E} option, nothing is done except preprocessing.
11020 Some of these options make sense only together with @option{-E} because
11021 they cause the preprocessor output to be unsuitable for actual
11022 compilation.
11024 @table @gcctabopt
11025 @item -Wp,@var{option}
11026 @opindex Wp
11027 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11028 and pass @var{option} directly through to the preprocessor.  If
11029 @var{option} contains commas, it is split into multiple options at the
11030 commas.  However, many options are modified, translated or interpreted
11031 by the compiler driver before being passed to the preprocessor, and
11032 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11033 interface is undocumented and subject to change, so whenever possible
11034 you should avoid using @option{-Wp} and let the driver handle the
11035 options instead.
11037 @item -Xpreprocessor @var{option}
11038 @opindex Xpreprocessor
11039 Pass @var{option} as an option to the preprocessor.  You can use this to
11040 supply system-specific preprocessor options that GCC does not 
11041 recognize.
11043 If you want to pass an option that takes an argument, you must use
11044 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11046 @item -no-integrated-cpp
11047 @opindex no-integrated-cpp
11048 Perform preprocessing as a separate pass before compilation.
11049 By default, GCC performs preprocessing as an integrated part of
11050 input tokenization and parsing.
11051 If this option is provided, the appropriate language front end
11052 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11053 and Objective-C, respectively) is instead invoked twice,
11054 once for preprocessing only and once for actual compilation
11055 of the preprocessed input.
11056 This option may be useful in conjunction with the @option{-B} or
11057 @option{-wrapper} options to specify an alternate preprocessor or
11058 perform additional processing of the program source between
11059 normal preprocessing and compilation.
11060 @end table
11062 @include cppopts.texi
11064 @node Assembler Options
11065 @section Passing Options to the Assembler
11067 @c prevent bad page break with this line
11068 You can pass options to the assembler.
11070 @table @gcctabopt
11071 @item -Wa,@var{option}
11072 @opindex Wa
11073 Pass @var{option} as an option to the assembler.  If @var{option}
11074 contains commas, it is split into multiple options at the commas.
11076 @item -Xassembler @var{option}
11077 @opindex Xassembler
11078 Pass @var{option} as an option to the assembler.  You can use this to
11079 supply system-specific assembler options that GCC does not
11080 recognize.
11082 If you want to pass an option that takes an argument, you must use
11083 @option{-Xassembler} twice, once for the option and once for the argument.
11085 @end table
11087 @node Link Options
11088 @section Options for Linking
11089 @cindex link options
11090 @cindex options, linking
11092 These options come into play when the compiler links object files into
11093 an executable output file.  They are meaningless if the compiler is
11094 not doing a link step.
11096 @table @gcctabopt
11097 @cindex file names
11098 @item @var{object-file-name}
11099 A file name that does not end in a special recognized suffix is
11100 considered to name an object file or library.  (Object files are
11101 distinguished from libraries by the linker according to the file
11102 contents.)  If linking is done, these object files are used as input
11103 to the linker.
11105 @item -c
11106 @itemx -S
11107 @itemx -E
11108 @opindex c
11109 @opindex S
11110 @opindex E
11111 If any of these options is used, then the linker is not run, and
11112 object file names should not be used as arguments.  @xref{Overall
11113 Options}.
11115 @item -fuse-ld=bfd
11116 @opindex fuse-ld=bfd
11117 Use the @command{bfd} linker instead of the default linker.
11119 @item -fuse-ld=gold
11120 @opindex fuse-ld=gold
11121 Use the @command{gold} linker instead of the default linker.
11123 @cindex Libraries
11124 @item -l@var{library}
11125 @itemx -l @var{library}
11126 @opindex l
11127 Search the library named @var{library} when linking.  (The second
11128 alternative with the library as a separate argument is only for
11129 POSIX compliance and is not recommended.)
11131 It makes a difference where in the command you write this option; the
11132 linker searches and processes libraries and object files in the order they
11133 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11134 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11135 to functions in @samp{z}, those functions may not be loaded.
11137 The linker searches a standard list of directories for the library,
11138 which is actually a file named @file{lib@var{library}.a}.  The linker
11139 then uses this file as if it had been specified precisely by name.
11141 The directories searched include several standard system directories
11142 plus any that you specify with @option{-L}.
11144 Normally the files found this way are library files---archive files
11145 whose members are object files.  The linker handles an archive file by
11146 scanning through it for members which define symbols that have so far
11147 been referenced but not defined.  But if the file that is found is an
11148 ordinary object file, it is linked in the usual fashion.  The only
11149 difference between using an @option{-l} option and specifying a file name
11150 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11151 and searches several directories.
11153 @item -lobjc
11154 @opindex lobjc
11155 You need this special case of the @option{-l} option in order to
11156 link an Objective-C or Objective-C++ program.
11158 @item -nostartfiles
11159 @opindex nostartfiles
11160 Do not use the standard system startup files when linking.
11161 The standard system libraries are used normally, unless @option{-nostdlib}
11162 or @option{-nodefaultlibs} is used.
11164 @item -nodefaultlibs
11165 @opindex nodefaultlibs
11166 Do not use the standard system libraries when linking.
11167 Only the libraries you specify are passed to the linker, and options
11168 specifying linkage of the system libraries, such as @option{-static-libgcc}
11169 or @option{-shared-libgcc}, are ignored.  
11170 The standard startup files are used normally, unless @option{-nostartfiles}
11171 is used.  
11173 The compiler may generate calls to @code{memcmp},
11174 @code{memset}, @code{memcpy} and @code{memmove}.
11175 These entries are usually resolved by entries in
11176 libc.  These entry points should be supplied through some other
11177 mechanism when this option is specified.
11179 @item -nostdlib
11180 @opindex nostdlib
11181 Do not use the standard system startup files or libraries when linking.
11182 No startup files and only the libraries you specify are passed to
11183 the linker, and options specifying linkage of the system libraries, such as
11184 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11186 The compiler may generate calls to @code{memcmp}, @code{memset},
11187 @code{memcpy} and @code{memmove}.
11188 These entries are usually resolved by entries in
11189 libc.  These entry points should be supplied through some other
11190 mechanism when this option is specified.
11192 @cindex @option{-lgcc}, use with @option{-nostdlib}
11193 @cindex @option{-nostdlib} and unresolved references
11194 @cindex unresolved references and @option{-nostdlib}
11195 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11196 @cindex @option{-nodefaultlibs} and unresolved references
11197 @cindex unresolved references and @option{-nodefaultlibs}
11198 One of the standard libraries bypassed by @option{-nostdlib} and
11199 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11200 which GCC uses to overcome shortcomings of particular machines, or special
11201 needs for some languages.
11202 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11203 Collection (GCC) Internals},
11204 for more discussion of @file{libgcc.a}.)
11205 In most cases, you need @file{libgcc.a} even when you want to avoid
11206 other standard libraries.  In other words, when you specify @option{-nostdlib}
11207 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11208 This ensures that you have no unresolved references to internal GCC
11209 library subroutines.
11210 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11211 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11212 GNU Compiler Collection (GCC) Internals}.)
11214 @item -pie
11215 @opindex pie
11216 Produce a position independent executable on targets that support it.
11217 For predictable results, you must also specify the same set of options
11218 used for compilation (@option{-fpie}, @option{-fPIE},
11219 or model suboptions) when you specify this linker option.
11221 @item -no-pie
11222 @opindex no-pie
11223 Don't produce a position independent executable.
11225 @item -rdynamic
11226 @opindex rdynamic
11227 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11228 that support it. This instructs the linker to add all symbols, not
11229 only used ones, to the dynamic symbol table. This option is needed
11230 for some uses of @code{dlopen} or to allow obtaining backtraces
11231 from within a program.
11233 @item -s
11234 @opindex s
11235 Remove all symbol table and relocation information from the executable.
11237 @item -static
11238 @opindex static
11239 On systems that support dynamic linking, this prevents linking with the shared
11240 libraries.  On other systems, this option has no effect.
11242 @item -shared
11243 @opindex shared
11244 Produce a shared object which can then be linked with other objects to
11245 form an executable.  Not all systems support this option.  For predictable
11246 results, you must also specify the same set of options used for compilation
11247 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11248 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11249 needs to build supplementary stub code for constructors to work.  On
11250 multi-libbed systems, @samp{gcc -shared} must select the correct support
11251 libraries to link against.  Failing to supply the correct flags may lead
11252 to subtle defects.  Supplying them in cases where they are not necessary
11253 is innocuous.}
11255 @item -shared-libgcc
11256 @itemx -static-libgcc
11257 @opindex shared-libgcc
11258 @opindex static-libgcc
11259 On systems that provide @file{libgcc} as a shared library, these options
11260 force the use of either the shared or static version, respectively.
11261 If no shared version of @file{libgcc} was built when the compiler was
11262 configured, these options have no effect.
11264 There are several situations in which an application should use the
11265 shared @file{libgcc} instead of the static version.  The most common
11266 of these is when the application wishes to throw and catch exceptions
11267 across different shared libraries.  In that case, each of the libraries
11268 as well as the application itself should use the shared @file{libgcc}.
11270 Therefore, the G++ and GCJ drivers automatically add
11271 @option{-shared-libgcc} whenever you build a shared library or a main
11272 executable, because C++ and Java programs typically use exceptions, so
11273 this is the right thing to do.
11275 If, instead, you use the GCC driver to create shared libraries, you may
11276 find that they are not always linked with the shared @file{libgcc}.
11277 If GCC finds, at its configuration time, that you have a non-GNU linker
11278 or a GNU linker that does not support option @option{--eh-frame-hdr},
11279 it links the shared version of @file{libgcc} into shared libraries
11280 by default.  Otherwise, it takes advantage of the linker and optimizes
11281 away the linking with the shared version of @file{libgcc}, linking with
11282 the static version of libgcc by default.  This allows exceptions to
11283 propagate through such shared libraries, without incurring relocation
11284 costs at library load time.
11286 However, if a library or main executable is supposed to throw or catch
11287 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11288 for the languages used in the program, or using the option
11289 @option{-shared-libgcc}, such that it is linked with the shared
11290 @file{libgcc}.
11292 @item -static-libasan
11293 @opindex static-libasan
11294 When the @option{-fsanitize=address} option is used to link a program,
11295 the GCC driver automatically links against @option{libasan}.  If
11296 @file{libasan} is available as a shared library, and the @option{-static}
11297 option is not used, then this links against the shared version of
11298 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11299 driver to link @file{libasan} statically, without necessarily linking
11300 other libraries statically.
11302 @item -static-libtsan
11303 @opindex static-libtsan
11304 When the @option{-fsanitize=thread} option is used to link a program,
11305 the GCC driver automatically links against @option{libtsan}.  If
11306 @file{libtsan} is available as a shared library, and the @option{-static}
11307 option is not used, then this links against the shared version of
11308 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11309 driver to link @file{libtsan} statically, without necessarily linking
11310 other libraries statically.
11312 @item -static-liblsan
11313 @opindex static-liblsan
11314 When the @option{-fsanitize=leak} option is used to link a program,
11315 the GCC driver automatically links against @option{liblsan}.  If
11316 @file{liblsan} is available as a shared library, and the @option{-static}
11317 option is not used, then this links against the shared version of
11318 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11319 driver to link @file{liblsan} statically, without necessarily linking
11320 other libraries statically.
11322 @item -static-libubsan
11323 @opindex static-libubsan
11324 When the @option{-fsanitize=undefined} option is used to link a program,
11325 the GCC driver automatically links against @option{libubsan}.  If
11326 @file{libubsan} is available as a shared library, and the @option{-static}
11327 option is not used, then this links against the shared version of
11328 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11329 driver to link @file{libubsan} statically, without necessarily linking
11330 other libraries statically.
11332 @item -static-libmpx
11333 @opindex static-libmpx
11334 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11335 used to link a program, the GCC driver automatically links against
11336 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11337 and the @option{-static} option is not used, then this links against
11338 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11339 option directs the GCC driver to link @file{libmpx} statically,
11340 without necessarily linking other libraries statically.
11342 @item -static-libmpxwrappers
11343 @opindex static-libmpxwrappers
11344 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11345 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11346 GCC driver automatically links against @file{libmpxwrappers}.  If
11347 @file{libmpxwrappers} is available as a shared library, and the
11348 @option{-static} option is not used, then this links against the shared
11349 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11350 option directs the GCC driver to link @file{libmpxwrappers} statically,
11351 without necessarily linking other libraries statically.
11353 @item -static-libstdc++
11354 @opindex static-libstdc++
11355 When the @command{g++} program is used to link a C++ program, it
11356 normally automatically links against @option{libstdc++}.  If
11357 @file{libstdc++} is available as a shared library, and the
11358 @option{-static} option is not used, then this links against the
11359 shared version of @file{libstdc++}.  That is normally fine.  However, it
11360 is sometimes useful to freeze the version of @file{libstdc++} used by
11361 the program without going all the way to a fully static link.  The
11362 @option{-static-libstdc++} option directs the @command{g++} driver to
11363 link @file{libstdc++} statically, without necessarily linking other
11364 libraries statically.
11366 @item -symbolic
11367 @opindex symbolic
11368 Bind references to global symbols when building a shared object.  Warn
11369 about any unresolved references (unless overridden by the link editor
11370 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11371 this option.
11373 @item -T @var{script}
11374 @opindex T
11375 @cindex linker script
11376 Use @var{script} as the linker script.  This option is supported by most
11377 systems using the GNU linker.  On some targets, such as bare-board
11378 targets without an operating system, the @option{-T} option may be required
11379 when linking to avoid references to undefined symbols.
11381 @item -Xlinker @var{option}
11382 @opindex Xlinker
11383 Pass @var{option} as an option to the linker.  You can use this to
11384 supply system-specific linker options that GCC does not recognize.
11386 If you want to pass an option that takes a separate argument, you must use
11387 @option{-Xlinker} twice, once for the option and once for the argument.
11388 For example, to pass @option{-assert definitions}, you must write
11389 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11390 @option{-Xlinker "-assert definitions"}, because this passes the entire
11391 string as a single argument, which is not what the linker expects.
11393 When using the GNU linker, it is usually more convenient to pass
11394 arguments to linker options using the @option{@var{option}=@var{value}}
11395 syntax than as separate arguments.  For example, you can specify
11396 @option{-Xlinker -Map=output.map} rather than
11397 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11398 this syntax for command-line options.
11400 @item -Wl,@var{option}
11401 @opindex Wl
11402 Pass @var{option} as an option to the linker.  If @var{option} contains
11403 commas, it is split into multiple options at the commas.  You can use this
11404 syntax to pass an argument to the option.
11405 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11406 linker.  When using the GNU linker, you can also get the same effect with
11407 @option{-Wl,-Map=output.map}.
11409 @item -u @var{symbol}
11410 @opindex u
11411 Pretend the symbol @var{symbol} is undefined, to force linking of
11412 library modules to define it.  You can use @option{-u} multiple times with
11413 different symbols to force loading of additional library modules.
11415 @item -z @var{keyword}
11416 @opindex z
11417 @option{-z} is passed directly on to the linker along with the keyword
11418 @var{keyword}. See the section in the documentation of your linker for
11419 permitted values and their meanings.
11420 @end table
11422 @node Directory Options
11423 @section Options for Directory Search
11424 @cindex directory options
11425 @cindex options, directory search
11426 @cindex search path
11428 These options specify directories to search for header files, for
11429 libraries and for parts of the compiler:
11431 @table @gcctabopt
11432 @item -I@var{dir}
11433 @opindex I
11434 Add the directory @var{dir} to the head of the list of directories to be
11435 searched for header files.  This can be used to override a system header
11436 file, substituting your own version, since these directories are
11437 searched before the system header file directories.  However, you should
11438 not use this option to add directories that contain vendor-supplied
11439 system header files (use @option{-isystem} for that).  If you use more than
11440 one @option{-I} option, the directories are scanned in left-to-right
11441 order; the standard system directories come after.
11443 If a standard system include directory, or a directory specified with
11444 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11445 option is ignored.  The directory is still searched but as a
11446 system directory at its normal position in the system include chain.
11447 This is to ensure that GCC's procedure to fix buggy system headers and
11448 the ordering for the @code{include_next} directive are not inadvertently changed.
11449 If you really need to change the search order for system directories,
11450 use the @option{-nostdinc} and/or @option{-isystem} options.
11452 @item -iplugindir=@var{dir}
11453 @opindex iplugindir=
11454 Set the directory to search for plugins that are passed
11455 by @option{-fplugin=@var{name}} instead of
11456 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11457 to be used by the user, but only passed by the driver.
11459 @item -iquote@var{dir}
11460 @opindex iquote
11461 Add the directory @var{dir} to the head of the list of directories to
11462 be searched for header files only for the case of @code{#include
11463 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11464 otherwise just like @option{-I}.
11466 @item -L@var{dir}
11467 @opindex L
11468 Add directory @var{dir} to the list of directories to be searched
11469 for @option{-l}.
11471 @item -B@var{prefix}
11472 @opindex B
11473 This option specifies where to find the executables, libraries,
11474 include files, and data files of the compiler itself.
11476 The compiler driver program runs one or more of the subprograms
11477 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11478 @var{prefix} as a prefix for each program it tries to run, both with and
11479 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11481 For each subprogram to be run, the compiler driver first tries the
11482 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11483 is not specified, the driver tries two standard prefixes, 
11484 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11485 those results in a file name that is found, the unmodified program
11486 name is searched for using the directories specified in your
11487 @env{PATH} environment variable.
11489 The compiler checks to see if the path provided by @option{-B}
11490 refers to a directory, and if necessary it adds a directory
11491 separator character at the end of the path.
11493 @option{-B} prefixes that effectively specify directory names also apply
11494 to libraries in the linker, because the compiler translates these
11495 options into @option{-L} options for the linker.  They also apply to
11496 include files in the preprocessor, because the compiler translates these
11497 options into @option{-isystem} options for the preprocessor.  In this case,
11498 the compiler appends @samp{include} to the prefix.
11500 The runtime support file @file{libgcc.a} can also be searched for using
11501 the @option{-B} prefix, if needed.  If it is not found there, the two
11502 standard prefixes above are tried, and that is all.  The file is left
11503 out of the link if it is not found by those means.
11505 Another way to specify a prefix much like the @option{-B} prefix is to use
11506 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11507 Variables}.
11509 As a special kludge, if the path provided by @option{-B} is
11510 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11511 9, then it is replaced by @file{[dir/]include}.  This is to help
11512 with boot-strapping the compiler.
11514 @item -specs=@var{file}
11515 @opindex specs
11516 Process @var{file} after the compiler reads in the standard @file{specs}
11517 file, in order to override the defaults which the @command{gcc} driver
11518 program uses when determining what switches to pass to @command{cc1},
11519 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11520 @option{-specs=@var{file}} can be specified on the command line, and they
11521 are processed in order, from left to right.
11523 @item --sysroot=@var{dir}
11524 @opindex sysroot
11525 Use @var{dir} as the logical root directory for headers and libraries.
11526 For example, if the compiler normally searches for headers in
11527 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11528 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11530 If you use both this option and the @option{-isysroot} option, then
11531 the @option{--sysroot} option applies to libraries, but the
11532 @option{-isysroot} option applies to header files.
11534 The GNU linker (beginning with version 2.16) has the necessary support
11535 for this option.  If your linker does not support this option, the
11536 header file aspect of @option{--sysroot} still works, but the
11537 library aspect does not.
11539 @item --no-sysroot-suffix
11540 @opindex no-sysroot-suffix
11541 For some targets, a suffix is added to the root directory specified
11542 with @option{--sysroot}, depending on the other options used, so that
11543 headers may for example be found in
11544 @file{@var{dir}/@var{suffix}/usr/include} instead of
11545 @file{@var{dir}/usr/include}.  This option disables the addition of
11546 such a suffix.
11548 @item -I-
11549 @opindex I-
11550 This option has been deprecated.  Please use @option{-iquote} instead for
11551 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11552 option.
11553 Any directories you specify with @option{-I} options before the @option{-I-}
11554 option are searched only for the case of @code{#include "@var{file}"};
11555 they are not searched for @code{#include <@var{file}>}.
11557 If additional directories are specified with @option{-I} options after
11558 the @option{-I-} option, these directories are searched for all @code{#include}
11559 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11560 this way.)
11562 In addition, the @option{-I-} option inhibits the use of the current
11563 directory (where the current input file came from) as the first search
11564 directory for @code{#include "@var{file}"}.  There is no way to
11565 override this effect of @option{-I-}.  With @option{-I.} you can specify
11566 searching the directory that is current when the compiler is
11567 invoked.  That is not exactly the same as what the preprocessor does
11568 by default, but it is often satisfactory.
11570 @option{-I-} does not inhibit the use of the standard system directories
11571 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11572 independent.
11573 @end table
11575 @c man end
11577 @node Spec Files
11578 @section Specifying Subprocesses and the Switches to Pass to Them
11579 @cindex Spec Files
11581 @command{gcc} is a driver program.  It performs its job by invoking a
11582 sequence of other programs to do the work of compiling, assembling and
11583 linking.  GCC interprets its command-line parameters and uses these to
11584 deduce which programs it should invoke, and which command-line options
11585 it ought to place on their command lines.  This behavior is controlled
11586 by @dfn{spec strings}.  In most cases there is one spec string for each
11587 program that GCC can invoke, but a few programs have multiple spec
11588 strings to control their behavior.  The spec strings built into GCC can
11589 be overridden by using the @option{-specs=} command-line switch to specify
11590 a spec file.
11592 @dfn{Spec files} are plaintext files that are used to construct spec
11593 strings.  They consist of a sequence of directives separated by blank
11594 lines.  The type of directive is determined by the first non-whitespace
11595 character on the line, which can be one of the following:
11597 @table @code
11598 @item %@var{command}
11599 Issues a @var{command} to the spec file processor.  The commands that can
11600 appear here are:
11602 @table @code
11603 @item %include <@var{file}>
11604 @cindex @code{%include}
11605 Search for @var{file} and insert its text at the current point in the
11606 specs file.
11608 @item %include_noerr <@var{file}>
11609 @cindex @code{%include_noerr}
11610 Just like @samp{%include}, but do not generate an error message if the include
11611 file cannot be found.
11613 @item %rename @var{old_name} @var{new_name}
11614 @cindex @code{%rename}
11615 Rename the spec string @var{old_name} to @var{new_name}.
11617 @end table
11619 @item *[@var{spec_name}]:
11620 This tells the compiler to create, override or delete the named spec
11621 string.  All lines after this directive up to the next directive or
11622 blank line are considered to be the text for the spec string.  If this
11623 results in an empty string then the spec is deleted.  (Or, if the
11624 spec did not exist, then nothing happens.)  Otherwise, if the spec
11625 does not currently exist a new spec is created.  If the spec does
11626 exist then its contents are overridden by the text of this
11627 directive, unless the first character of that text is the @samp{+}
11628 character, in which case the text is appended to the spec.
11630 @item [@var{suffix}]:
11631 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11632 and up to the next directive or blank line are considered to make up the
11633 spec string for the indicated suffix.  When the compiler encounters an
11634 input file with the named suffix, it processes the spec string in
11635 order to work out how to compile that file.  For example:
11637 @smallexample
11638 .ZZ:
11639 z-compile -input %i
11640 @end smallexample
11642 This says that any input file whose name ends in @samp{.ZZ} should be
11643 passed to the program @samp{z-compile}, which should be invoked with the
11644 command-line switch @option{-input} and with the result of performing the
11645 @samp{%i} substitution.  (See below.)
11647 As an alternative to providing a spec string, the text following a
11648 suffix directive can be one of the following:
11650 @table @code
11651 @item @@@var{language}
11652 This says that the suffix is an alias for a known @var{language}.  This is
11653 similar to using the @option{-x} command-line switch to GCC to specify a
11654 language explicitly.  For example:
11656 @smallexample
11657 .ZZ:
11658 @@c++
11659 @end smallexample
11661 Says that .ZZ files are, in fact, C++ source files.
11663 @item #@var{name}
11664 This causes an error messages saying:
11666 @smallexample
11667 @var{name} compiler not installed on this system.
11668 @end smallexample
11669 @end table
11671 GCC already has an extensive list of suffixes built into it.
11672 This directive adds an entry to the end of the list of suffixes, but
11673 since the list is searched from the end backwards, it is effectively
11674 possible to override earlier entries using this technique.
11676 @end table
11678 GCC has the following spec strings built into it.  Spec files can
11679 override these strings or create their own.  Note that individual
11680 targets can also add their own spec strings to this list.
11682 @smallexample
11683 asm          Options to pass to the assembler
11684 asm_final    Options to pass to the assembler post-processor
11685 cpp          Options to pass to the C preprocessor
11686 cc1          Options to pass to the C compiler
11687 cc1plus      Options to pass to the C++ compiler
11688 endfile      Object files to include at the end of the link
11689 link         Options to pass to the linker
11690 lib          Libraries to include on the command line to the linker
11691 libgcc       Decides which GCC support library to pass to the linker
11692 linker       Sets the name of the linker
11693 predefines   Defines to be passed to the C preprocessor
11694 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11695              by default
11696 startfile    Object files to include at the start of the link
11697 @end smallexample
11699 Here is a small example of a spec file:
11701 @smallexample
11702 %rename lib                 old_lib
11704 *lib:
11705 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11706 @end smallexample
11708 This example renames the spec called @samp{lib} to @samp{old_lib} and
11709 then overrides the previous definition of @samp{lib} with a new one.
11710 The new definition adds in some extra command-line options before
11711 including the text of the old definition.
11713 @dfn{Spec strings} are a list of command-line options to be passed to their
11714 corresponding program.  In addition, the spec strings can contain
11715 @samp{%}-prefixed sequences to substitute variable text or to
11716 conditionally insert text into the command line.  Using these constructs
11717 it is possible to generate quite complex command lines.
11719 Here is a table of all defined @samp{%}-sequences for spec
11720 strings.  Note that spaces are not generated automatically around the
11721 results of expanding these sequences.  Therefore you can concatenate them
11722 together or combine them with constant text in a single argument.
11724 @table @code
11725 @item %%
11726 Substitute one @samp{%} into the program name or argument.
11728 @item %i
11729 Substitute the name of the input file being processed.
11731 @item %b
11732 Substitute the basename of the input file being processed.
11733 This is the substring up to (and not including) the last period
11734 and not including the directory.
11736 @item %B
11737 This is the same as @samp{%b}, but include the file suffix (text after
11738 the last period).
11740 @item %d
11741 Marks the argument containing or following the @samp{%d} as a
11742 temporary file name, so that that file is deleted if GCC exits
11743 successfully.  Unlike @samp{%g}, this contributes no text to the
11744 argument.
11746 @item %g@var{suffix}
11747 Substitute a file name that has suffix @var{suffix} and is chosen
11748 once per compilation, and mark the argument in the same way as
11749 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11750 name is now chosen in a way that is hard to predict even when previously
11751 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11752 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11753 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11754 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11755 was simply substituted with a file name chosen once per compilation,
11756 without regard to any appended suffix (which was therefore treated
11757 just like ordinary text), making such attacks more likely to succeed.
11759 @item %u@var{suffix}
11760 Like @samp{%g}, but generates a new temporary file name
11761 each time it appears instead of once per compilation.
11763 @item %U@var{suffix}
11764 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11765 new one if there is no such last file name.  In the absence of any
11766 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11767 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11768 involves the generation of two distinct file names, one
11769 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11770 simply substituted with a file name chosen for the previous @samp{%u},
11771 without regard to any appended suffix.
11773 @item %j@var{suffix}
11774 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11775 writable, and if @option{-save-temps} is not used; 
11776 otherwise, substitute the name
11777 of a temporary file, just like @samp{%u}.  This temporary file is not
11778 meant for communication between processes, but rather as a junk
11779 disposal mechanism.
11781 @item %|@var{suffix}
11782 @itemx %m@var{suffix}
11783 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11784 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11785 all.  These are the two most common ways to instruct a program that it
11786 should read from standard input or write to standard output.  If you
11787 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11788 construct: see for example @file{f/lang-specs.h}.
11790 @item %.@var{SUFFIX}
11791 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11792 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11793 terminated by the next space or %.
11795 @item %w
11796 Marks the argument containing or following the @samp{%w} as the
11797 designated output file of this compilation.  This puts the argument
11798 into the sequence of arguments that @samp{%o} substitutes.
11800 @item %o
11801 Substitutes the names of all the output files, with spaces
11802 automatically placed around them.  You should write spaces
11803 around the @samp{%o} as well or the results are undefined.
11804 @samp{%o} is for use in the specs for running the linker.
11805 Input files whose names have no recognized suffix are not compiled
11806 at all, but they are included among the output files, so they are
11807 linked.
11809 @item %O
11810 Substitutes the suffix for object files.  Note that this is
11811 handled specially when it immediately follows @samp{%g, %u, or %U},
11812 because of the need for those to form complete file names.  The
11813 handling is such that @samp{%O} is treated exactly as if it had already
11814 been substituted, except that @samp{%g, %u, and %U} do not currently
11815 support additional @var{suffix} characters following @samp{%O} as they do
11816 following, for example, @samp{.o}.
11818 @item %p
11819 Substitutes the standard macro predefinitions for the
11820 current target machine.  Use this when running @command{cpp}.
11822 @item %P
11823 Like @samp{%p}, but puts @samp{__} before and after the name of each
11824 predefined macro, except for macros that start with @samp{__} or with
11825 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11828 @item %I
11829 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11830 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11831 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11832 and @option{-imultilib} as necessary.
11834 @item %s
11835 Current argument is the name of a library or startup file of some sort.
11836 Search for that file in a standard list of directories and substitute
11837 the full name found.  The current working directory is included in the
11838 list of directories scanned.
11840 @item %T
11841 Current argument is the name of a linker script.  Search for that file
11842 in the current list of directories to scan for libraries. If the file
11843 is located insert a @option{--script} option into the command line
11844 followed by the full path name found.  If the file is not found then
11845 generate an error message.  Note: the current working directory is not
11846 searched.
11848 @item %e@var{str}
11849 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11850 Use this when inconsistent options are detected.
11852 @item %(@var{name})
11853 Substitute the contents of spec string @var{name} at this point.
11855 @item %x@{@var{option}@}
11856 Accumulate an option for @samp{%X}.
11858 @item %X
11859 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11860 spec string.
11862 @item %Y
11863 Output the accumulated assembler options specified by @option{-Wa}.
11865 @item %Z
11866 Output the accumulated preprocessor options specified by @option{-Wp}.
11868 @item %a
11869 Process the @code{asm} spec.  This is used to compute the
11870 switches to be passed to the assembler.
11872 @item %A
11873 Process the @code{asm_final} spec.  This is a spec string for
11874 passing switches to an assembler post-processor, if such a program is
11875 needed.
11877 @item %l
11878 Process the @code{link} spec.  This is the spec for computing the
11879 command line passed to the linker.  Typically it makes use of the
11880 @samp{%L %G %S %D and %E} sequences.
11882 @item %D
11883 Dump out a @option{-L} option for each directory that GCC believes might
11884 contain startup files.  If the target supports multilibs then the
11885 current multilib directory is prepended to each of these paths.
11887 @item %L
11888 Process the @code{lib} spec.  This is a spec string for deciding which
11889 libraries are included on the command line to the linker.
11891 @item %G
11892 Process the @code{libgcc} spec.  This is a spec string for deciding
11893 which GCC support library is included on the command line to the linker.
11895 @item %S
11896 Process the @code{startfile} spec.  This is a spec for deciding which
11897 object files are the first ones passed to the linker.  Typically
11898 this might be a file named @file{crt0.o}.
11900 @item %E
11901 Process the @code{endfile} spec.  This is a spec string that specifies
11902 the last object files that are passed to the linker.
11904 @item %C
11905 Process the @code{cpp} spec.  This is used to construct the arguments
11906 to be passed to the C preprocessor.
11908 @item %1
11909 Process the @code{cc1} spec.  This is used to construct the options to be
11910 passed to the actual C compiler (@command{cc1}).
11912 @item %2
11913 Process the @code{cc1plus} spec.  This is used to construct the options to be
11914 passed to the actual C++ compiler (@command{cc1plus}).
11916 @item %*
11917 Substitute the variable part of a matched option.  See below.
11918 Note that each comma in the substituted string is replaced by
11919 a single space.
11921 @item %<@code{S}
11922 Remove all occurrences of @code{-S} from the command line.  Note---this
11923 command is position dependent.  @samp{%} commands in the spec string
11924 before this one see @code{-S}, @samp{%} commands in the spec string
11925 after this one do not.
11927 @item %:@var{function}(@var{args})
11928 Call the named function @var{function}, passing it @var{args}.
11929 @var{args} is first processed as a nested spec string, then split
11930 into an argument vector in the usual fashion.  The function returns
11931 a string which is processed as if it had appeared literally as part
11932 of the current spec.
11934 The following built-in spec functions are provided:
11936 @table @code
11937 @item @code{getenv}
11938 The @code{getenv} spec function takes two arguments: an environment
11939 variable name and a string.  If the environment variable is not
11940 defined, a fatal error is issued.  Otherwise, the return value is the
11941 value of the environment variable concatenated with the string.  For
11942 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11944 @smallexample
11945 %:getenv(TOPDIR /include)
11946 @end smallexample
11948 expands to @file{/path/to/top/include}.
11950 @item @code{if-exists}
11951 The @code{if-exists} spec function takes one argument, an absolute
11952 pathname to a file.  If the file exists, @code{if-exists} returns the
11953 pathname.  Here is a small example of its usage:
11955 @smallexample
11956 *startfile:
11957 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11958 @end smallexample
11960 @item @code{if-exists-else}
11961 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11962 spec function, except that it takes two arguments.  The first argument is
11963 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11964 returns the pathname.  If it does not exist, it returns the second argument.
11965 This way, @code{if-exists-else} can be used to select one file or another,
11966 based on the existence of the first.  Here is a small example of its usage:
11968 @smallexample
11969 *startfile:
11970 crt0%O%s %:if-exists(crti%O%s) \
11971 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11972 @end smallexample
11974 @item @code{replace-outfile}
11975 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11976 first argument in the outfiles array and replaces it with the second argument.  Here
11977 is a small example of its usage:
11979 @smallexample
11980 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11981 @end smallexample
11983 @item @code{remove-outfile}
11984 The @code{remove-outfile} spec function takes one argument.  It looks for the
11985 first argument in the outfiles array and removes it.  Here is a small example
11986 its usage:
11988 @smallexample
11989 %:remove-outfile(-lm)
11990 @end smallexample
11992 @item @code{pass-through-libs}
11993 The @code{pass-through-libs} spec function takes any number of arguments.  It
11994 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11995 assumes are the names of linker input library archive files) and returns a
11996 result containing all the found arguments each prepended by
11997 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11998 intended to be passed to the LTO linker plugin.
12000 @smallexample
12001 %:pass-through-libs(%G %L %G)
12002 @end smallexample
12004 @item @code{print-asm-header}
12005 The @code{print-asm-header} function takes no arguments and simply
12006 prints a banner like:
12008 @smallexample
12009 Assembler options
12010 =================
12012 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
12013 @end smallexample
12015 It is used to separate compiler options from assembler options
12016 in the @option{--target-help} output.
12017 @end table
12019 @item %@{@code{S}@}
12020 Substitutes the @code{-S} switch, if that switch is given to GCC@.
12021 If that switch is not specified, this substitutes nothing.  Note that
12022 the leading dash is omitted when specifying this option, and it is
12023 automatically inserted if the substitution is performed.  Thus the spec
12024 string @samp{%@{foo@}} matches the command-line option @option{-foo}
12025 and outputs the command-line option @option{-foo}.
12027 @item %W@{@code{S}@}
12028 Like %@{@code{S}@} but mark last argument supplied within as a file to be
12029 deleted on failure.
12031 @item %@{@code{S}*@}
12032 Substitutes all the switches specified to GCC whose names start
12033 with @code{-S}, but which also take an argument.  This is used for
12034 switches like @option{-o}, @option{-D}, @option{-I}, etc.
12035 GCC considers @option{-o foo} as being
12036 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
12037 text, including the space.  Thus two arguments are generated.
12039 @item %@{@code{S}*&@code{T}*@}
12040 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
12041 (the order of @code{S} and @code{T} in the spec is not significant).
12042 There can be any number of ampersand-separated variables; for each the
12043 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
12045 @item %@{@code{S}:@code{X}@}
12046 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
12048 @item %@{!@code{S}:@code{X}@}
12049 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
12051 @item %@{@code{S}*:@code{X}@}
12052 Substitutes @code{X} if one or more switches whose names start with
12053 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
12054 once, no matter how many such switches appeared.  However, if @code{%*}
12055 appears somewhere in @code{X}, then @code{X} is substituted once
12056 for each matching switch, with the @code{%*} replaced by the part of
12057 that switch matching the @code{*}.
12059 If @code{%*} appears as the last part of a spec sequence then a space
12060 is added after the end of the last substitution.  If there is more
12061 text in the sequence, however, then a space is not generated.  This
12062 allows the @code{%*} substitution to be used as part of a larger
12063 string.  For example, a spec string like this:
12065 @smallexample
12066 %@{mcu=*:--script=%*/memory.ld@}
12067 @end smallexample
12069 @noindent
12070 when matching an option like @option{-mcu=newchip} produces:
12072 @smallexample
12073 --script=newchip/memory.ld
12074 @end smallexample
12076 @item %@{.@code{S}:@code{X}@}
12077 Substitutes @code{X}, if processing a file with suffix @code{S}.
12079 @item %@{!.@code{S}:@code{X}@}
12080 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
12082 @item %@{,@code{S}:@code{X}@}
12083 Substitutes @code{X}, if processing a file for language @code{S}.
12085 @item %@{!,@code{S}:@code{X}@}
12086 Substitutes @code{X}, if not processing a file for language @code{S}.
12088 @item %@{@code{S}|@code{P}:@code{X}@}
12089 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
12090 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
12091 @code{*} sequences as well, although they have a stronger binding than
12092 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
12093 alternatives must be starred, and only the first matching alternative
12094 is substituted.
12096 For example, a spec string like this:
12098 @smallexample
12099 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
12100 @end smallexample
12102 @noindent
12103 outputs the following command-line options from the following input
12104 command-line options:
12106 @smallexample
12107 fred.c        -foo -baz
12108 jim.d         -bar -boggle
12109 -d fred.c     -foo -baz -boggle
12110 -d jim.d      -bar -baz -boggle
12111 @end smallexample
12113 @item %@{S:X; T:Y; :D@}
12115 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
12116 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
12117 be as many clauses as you need.  This may be combined with @code{.},
12118 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
12121 @end table
12123 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
12124 construct may contain other nested @samp{%} constructs or spaces, or
12125 even newlines.  They are processed as usual, as described above.
12126 Trailing white space in @code{X} is ignored.  White space may also
12127 appear anywhere on the left side of the colon in these constructs,
12128 except between @code{.} or @code{*} and the corresponding word.
12130 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
12131 handled specifically in these constructs.  If another value of
12132 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
12133 @option{-W} switch is found later in the command line, the earlier
12134 switch value is ignored, except with @{@code{S}*@} where @code{S} is
12135 just one letter, which passes all matching options.
12137 The character @samp{|} at the beginning of the predicate text is used to
12138 indicate that a command should be piped to the following command, but
12139 only if @option{-pipe} is specified.
12141 It is built into GCC which switches take arguments and which do not.
12142 (You might think it would be useful to generalize this to allow each
12143 compiler's spec to say which switches take arguments.  But this cannot
12144 be done in a consistent fashion.  GCC cannot even decide which input
12145 files have been specified without knowing which switches take arguments,
12146 and it must know which input files to compile in order to tell which
12147 compilers to run).
12149 GCC also knows implicitly that arguments starting in @option{-l} are to be
12150 treated as compiler output files, and passed to the linker in their
12151 proper position among the other output files.
12153 @c man begin OPTIONS
12155 @node Target Options
12156 @section Specifying Target Machine and Compiler Version
12157 @cindex target options
12158 @cindex cross compiling
12159 @cindex specifying machine version
12160 @cindex specifying compiler version and target machine
12161 @cindex compiler version, specifying
12162 @cindex target machine, specifying
12164 The usual way to run GCC is to run the executable called @command{gcc}, or
12165 @command{@var{machine}-gcc} when cross-compiling, or
12166 @command{@var{machine}-gcc-@var{version}} to run a version other than the
12167 one that was installed last.
12169 @node Submodel Options
12170 @section Hardware Models and Configurations
12171 @cindex submodel options
12172 @cindex specifying hardware config
12173 @cindex hardware models and configurations, specifying
12174 @cindex machine dependent options
12176 Each target machine types can have its own
12177 special options, starting with @samp{-m}, to choose among various
12178 hardware models or configurations---for example, 68010 vs 68020,
12179 floating coprocessor or none.  A single installed version of the
12180 compiler can compile for any model or configuration, according to the
12181 options specified.
12183 Some configurations of the compiler also support additional special
12184 options, usually for compatibility with other compilers on the same
12185 platform.
12187 @c This list is ordered alphanumerically by subsection name.
12188 @c It should be the same order and spelling as these options are listed
12189 @c in Machine Dependent Options
12191 @menu
12192 * AArch64 Options::
12193 * Adapteva Epiphany Options::
12194 * ARC Options::
12195 * ARM Options::
12196 * AVR Options::
12197 * Blackfin Options::
12198 * C6X Options::
12199 * CRIS Options::
12200 * CR16 Options::
12201 * Darwin Options::
12202 * DEC Alpha Options::
12203 * FR30 Options::
12204 * FT32 Options::
12205 * FRV Options::
12206 * GNU/Linux Options::
12207 * H8/300 Options::
12208 * HPPA Options::
12209 * IA-64 Options::
12210 * LM32 Options::
12211 * M32C Options::
12212 * M32R/D Options::
12213 * M680x0 Options::
12214 * MCore Options::
12215 * MeP Options::
12216 * MicroBlaze Options::
12217 * MIPS Options::
12218 * MMIX Options::
12219 * MN10300 Options::
12220 * Moxie Options::
12221 * MSP430 Options::
12222 * NDS32 Options::
12223 * Nios II Options::
12224 * Nvidia PTX Options::
12225 * PDP-11 Options::
12226 * picoChip Options::
12227 * PowerPC Options::
12228 * RL78 Options::
12229 * RS/6000 and PowerPC Options::
12230 * RX Options::
12231 * S/390 and zSeries Options::
12232 * Score Options::
12233 * SH Options::
12234 * Solaris 2 Options::
12235 * SPARC Options::
12236 * SPU Options::
12237 * System V Options::
12238 * TILE-Gx Options::
12239 * TILEPro Options::
12240 * V850 Options::
12241 * VAX Options::
12242 * Visium Options::
12243 * VMS Options::
12244 * VxWorks Options::
12245 * x86 Options::
12246 * x86 Windows Options::
12247 * Xstormy16 Options::
12248 * Xtensa Options::
12249 * zSeries Options::
12250 @end menu
12252 @node AArch64 Options
12253 @subsection AArch64 Options
12254 @cindex AArch64 Options
12256 These options are defined for AArch64 implementations:
12258 @table @gcctabopt
12260 @item -mabi=@var{name}
12261 @opindex mabi
12262 Generate code for the specified data model.  Permissible values
12263 are @samp{ilp32} for SysV-like data model where int, long int and pointer
12264 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
12265 but long int and pointer are 64-bit.
12267 The default depends on the specific target configuration.  Note that
12268 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
12269 entire program with the same ABI, and link with a compatible set of libraries.
12271 @item -mbig-endian
12272 @opindex mbig-endian
12273 Generate big-endian code.  This is the default when GCC is configured for an
12274 @samp{aarch64_be-*-*} target.
12276 @item -mgeneral-regs-only
12277 @opindex mgeneral-regs-only
12278 Generate code which uses only the general-purpose registers.  This is equivalent
12279 to feature modifier @option{nofp} of @option{-march} or @option{-mcpu}, except
12280 that @option{-mgeneral-regs-only} takes precedence over any conflicting feature
12281 modifier regardless of sequence.
12283 @item -mlittle-endian
12284 @opindex mlittle-endian
12285 Generate little-endian code.  This is the default when GCC is configured for an
12286 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12288 @item -mcmodel=tiny
12289 @opindex mcmodel=tiny
12290 Generate code for the tiny code model.  The program and its statically defined
12291 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
12292 be statically or dynamically linked.  This model is not fully implemented and
12293 mostly treated as @samp{small}.
12295 @item -mcmodel=small
12296 @opindex mcmodel=small
12297 Generate code for the small code model.  The program and its statically defined
12298 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
12299 be statically or dynamically linked.  This is the default code model.
12301 @item -mcmodel=large
12302 @opindex mcmodel=large
12303 Generate code for the large code model.  This makes no assumptions about
12304 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
12305 statically linked only.
12307 @item -mstrict-align
12308 @opindex mstrict-align
12309 Do not assume that unaligned memory references are handled by the system.
12311 @item -momit-leaf-frame-pointer
12312 @itemx -mno-omit-leaf-frame-pointer
12313 @opindex momit-leaf-frame-pointer
12314 @opindex mno-omit-leaf-frame-pointer
12315 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
12316 default.
12318 @item -mtls-dialect=desc
12319 @opindex mtls-dialect=desc
12320 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12321 of TLS variables.  This is the default.
12323 @item -mtls-dialect=traditional
12324 @opindex mtls-dialect=traditional
12325 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12326 of TLS variables.
12328 @item -mtls-size=@var{size}
12329 @opindex mtls-size
12330 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
12331 This option depends on binutils higher than 2.25.
12333 @item -mfix-cortex-a53-835769
12334 @itemx -mno-fix-cortex-a53-835769
12335 @opindex mfix-cortex-a53-835769
12336 @opindex mno-fix-cortex-a53-835769
12337 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12338 This involves inserting a NOP instruction between memory instructions and
12339 64-bit integer multiply-accumulate instructions.
12341 @item -mfix-cortex-a53-843419
12342 @itemx -mno-fix-cortex-a53-843419
12343 @opindex mfix-cortex-a53-843419
12344 @opindex mno-fix-cortex-a53-843419
12345 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
12346 This erratum workaround is made at link time and this will only pass the
12347 corresponding flag to the linker.
12349 @item -march=@var{name}
12350 @opindex march
12351 Specify the name of the target architecture, optionally suffixed by one or
12352 more feature modifiers.  This option has the form
12353 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
12355 The permissible values for @var{arch} are @samp{armv8-a} or
12356 @samp{armv8.1-a}.
12358 For the permissible values for @var{feature}, see the sub-section on
12359 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12360 Feature Modifiers}.  Where conflicting feature modifiers are
12361 specified, the right-most feature is used.
12363 Additionally on native AArch64 GNU/Linux systems the value
12364 @samp{native} is available.  This option causes the compiler to pick the
12365 architecture of the host system.  If the compiler is unable to recognize the
12366 architecture of the host system this option has no effect.
12368 GCC uses @var{name} to determine what kind of instructions it can emit
12369 when generating assembly code.  If @option{-march} is specified
12370 without either of @option{-mtune} or @option{-mcpu} also being
12371 specified, the code is tuned to perform well across a range of target
12372 processors implementing the target architecture.
12374 @item -mtune=@var{name}
12375 @opindex mtune
12376 Specify the name of the target processor for which GCC should tune the
12377 performance of the code.  Permissible values for this option are:
12378 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
12379 @samp{exynos-m1}, @samp{thunderx}, @samp{xgene1}.
12381 Additionally, this option can specify that GCC should tune the performance
12382 of the code for a big.LITTLE system.  Permissible values for this
12383 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
12385 Additionally on native AArch64 GNU/Linux systems the value
12386 @samp{native} is available.  This option causes the compiler to pick
12387 the architecture of and tune the performance of the code for the
12388 processor of the host system.  If the compiler is unable to recognize
12389 the processor of the host system this option has no effect.
12391 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12392 are specified, the code is tuned to perform well across a range
12393 of target processors.
12395 This option cannot be suffixed by feature modifiers.
12397 @item -mcpu=@var{name}
12398 @opindex mcpu
12399 Specify the name of the target processor, optionally suffixed by one
12400 or more feature modifiers.  This option has the form
12401 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
12402 the permissible values for @var{cpu} are the same as those available
12403 for @option{-mtune}.  The permissible values for @var{feature} are
12404 documented in the sub-section on
12405 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12406 Feature Modifiers}.  Where conflicting feature modifiers are
12407 specified, the right-most feature is used.
12409 Additionally on native AArch64 GNU/Linux systems the value
12410 @samp{native} is available.  This option causes the compiler to tune
12411 the performance of the code for the processor of the host system.  If
12412 the compiler is unable to recognize the processor of the host system
12413 this option has no effect.
12415 GCC uses @var{name} to determine what kind of instructions it can emit when
12416 generating assembly code (as if by @option{-march}) and to determine
12417 the target processor for which to tune for performance (as if
12418 by @option{-mtune}).  Where this option is used in conjunction
12419 with @option{-march} or @option{-mtune}, those options take precedence
12420 over the appropriate part of this option.
12422 @item -moverride=@var{string}
12423 @opindex moverride
12424 Override tuning decisions made by the back-end in response to a
12425 @option{-mtune=} switch.  The syntax, semantics, and accepted values
12426 for @var{string} in this option are not guaranteed to be consistent
12427 across releases.
12429 This option is only intended to be useful when developing GCC.
12430 @end table
12432 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
12433 @anchor{aarch64-feature-modifiers}
12434 @cindex @option{-march} feature modifiers
12435 @cindex @option{-mcpu} feature modifiers
12436 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
12437 the following and their inverses @option{no@var{feature}}:
12439 @table @samp
12440 @item crc
12441 Enable CRC extension.
12442 @item crypto
12443 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
12444 instructions.
12445 @item fp
12446 Enable floating-point instructions.  This is on by default for all possible
12447 values for options @option{-march} and @option{-mcpu}.
12448 @item simd
12449 Enable Advanced SIMD instructions.  This also enables floating-point
12450 instructions.  This is on by default for all possible values for options
12451 @option{-march} and @option{-mcpu}.
12452 @item lse
12453 Enable Large System Extension instructions.
12454 @item pan
12455 Enable Privileged Access Never support.
12456 @item lor
12457 Enable Limited Ordering Regions support.
12458 @item rdma
12459 Enable ARMv8.1 Advanced SIMD instructions.  This implies Advanced SIMD
12460 is enabled.
12462 @end table
12464 That is, @option{crypto} implies @option{simd} implies @option{fp}.
12465 Conversely, @option{nofp} (or equivalently, @option{-mgeneral-regs-only})
12466 implies @option{nosimd} implies @option{nocrypto}.
12468 @node Adapteva Epiphany Options
12469 @subsection Adapteva Epiphany Options
12471 These @samp{-m} options are defined for Adapteva Epiphany:
12473 @table @gcctabopt
12474 @item -mhalf-reg-file
12475 @opindex mhalf-reg-file
12476 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12477 That allows code to run on hardware variants that lack these registers.
12479 @item -mprefer-short-insn-regs
12480 @opindex mprefer-short-insn-regs
12481 Preferrentially allocate registers that allow short instruction generation.
12482 This can result in increased instruction count, so this may either reduce or
12483 increase overall code size.
12485 @item -mbranch-cost=@var{num}
12486 @opindex mbranch-cost
12487 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12488 This cost is only a heuristic and is not guaranteed to produce
12489 consistent results across releases.
12491 @item -mcmove
12492 @opindex mcmove
12493 Enable the generation of conditional moves.
12495 @item -mnops=@var{num}
12496 @opindex mnops
12497 Emit @var{num} NOPs before every other generated instruction.
12499 @item -mno-soft-cmpsf
12500 @opindex mno-soft-cmpsf
12501 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12502 and test the flags.  This is faster than a software comparison, but can
12503 get incorrect results in the presence of NaNs, or when two different small
12504 numbers are compared such that their difference is calculated as zero.
12505 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12506 software comparisons.
12508 @item -mstack-offset=@var{num}
12509 @opindex mstack-offset
12510 Set the offset between the top of the stack and the stack pointer.
12511 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12512 can be used by leaf functions without stack allocation.
12513 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12514 Note also that this option changes the ABI; compiling a program with a
12515 different stack offset than the libraries have been compiled with
12516 generally does not work.
12517 This option can be useful if you want to evaluate if a different stack
12518 offset would give you better code, but to actually use a different stack
12519 offset to build working programs, it is recommended to configure the
12520 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12522 @item -mno-round-nearest
12523 @opindex mno-round-nearest
12524 Make the scheduler assume that the rounding mode has been set to
12525 truncating.  The default is @option{-mround-nearest}.
12527 @item -mlong-calls
12528 @opindex mlong-calls
12529 If not otherwise specified by an attribute, assume all calls might be beyond
12530 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12531 function address into a register before performing a (otherwise direct) call.
12532 This is the default.
12534 @item -mshort-calls
12535 @opindex short-calls
12536 If not otherwise specified by an attribute, assume all direct calls are
12537 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12538 for direct calls.  The default is @option{-mlong-calls}.
12540 @item -msmall16
12541 @opindex msmall16
12542 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12543 apply to function addresses for which @option{-mlong-calls} semantics
12544 are in effect.
12546 @item -mfp-mode=@var{mode}
12547 @opindex mfp-mode
12548 Set the prevailing mode of the floating-point unit.
12549 This determines the floating-point mode that is provided and expected
12550 at function call and return time.  Making this mode match the mode you
12551 predominantly need at function start can make your programs smaller and
12552 faster by avoiding unnecessary mode switches.
12554 @var{mode} can be set to one the following values:
12556 @table @samp
12557 @item caller
12558 Any mode at function entry is valid, and retained or restored when
12559 the function returns, and when it calls other functions.
12560 This mode is useful for compiling libraries or other compilation units
12561 you might want to incorporate into different programs with different
12562 prevailing FPU modes, and the convenience of being able to use a single
12563 object file outweighs the size and speed overhead for any extra
12564 mode switching that might be needed, compared with what would be needed
12565 with a more specific choice of prevailing FPU mode.
12567 @item truncate
12568 This is the mode used for floating-point calculations with
12569 truncating (i.e.@: round towards zero) rounding mode.  That includes
12570 conversion from floating point to integer.
12572 @item round-nearest
12573 This is the mode used for floating-point calculations with
12574 round-to-nearest-or-even rounding mode.
12576 @item int
12577 This is the mode used to perform integer calculations in the FPU, e.g.@:
12578 integer multiply, or integer multiply-and-accumulate.
12579 @end table
12581 The default is @option{-mfp-mode=caller}
12583 @item -mnosplit-lohi
12584 @itemx -mno-postinc
12585 @itemx -mno-postmodify
12586 @opindex mnosplit-lohi
12587 @opindex mno-postinc
12588 @opindex mno-postmodify
12589 Code generation tweaks that disable, respectively, splitting of 32-bit
12590 loads, generation of post-increment addresses, and generation of
12591 post-modify addresses.  The defaults are @option{msplit-lohi},
12592 @option{-mpost-inc}, and @option{-mpost-modify}.
12594 @item -mnovect-double
12595 @opindex mno-vect-double
12596 Change the preferred SIMD mode to SImode.  The default is
12597 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12599 @item -max-vect-align=@var{num}
12600 @opindex max-vect-align
12601 The maximum alignment for SIMD vector mode types.
12602 @var{num} may be 4 or 8.  The default is 8.
12603 Note that this is an ABI change, even though many library function
12604 interfaces are unaffected if they don't use SIMD vector modes
12605 in places that affect size and/or alignment of relevant types.
12607 @item -msplit-vecmove-early
12608 @opindex msplit-vecmove-early
12609 Split vector moves into single word moves before reload.  In theory this
12610 can give better register allocation, but so far the reverse seems to be
12611 generally the case.
12613 @item -m1reg-@var{reg}
12614 @opindex m1reg-
12615 Specify a register to hold the constant @minus{}1, which makes loading small negative
12616 constants and certain bitmasks faster.
12617 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12618 which specify use of that register as a fixed register,
12619 and @samp{none}, which means that no register is used for this
12620 purpose.  The default is @option{-m1reg-none}.
12622 @end table
12624 @node ARC Options
12625 @subsection ARC Options
12626 @cindex ARC options
12628 The following options control the architecture variant for which code
12629 is being compiled:
12631 @c architecture variants
12632 @table @gcctabopt
12634 @item -mbarrel-shifter
12635 @opindex mbarrel-shifter
12636 Generate instructions supported by barrel shifter.  This is the default
12637 unless @option{-mcpu=ARC601} is in effect.
12639 @item -mcpu=@var{cpu}
12640 @opindex mcpu
12641 Set architecture type, register usage, and instruction scheduling
12642 parameters for @var{cpu}.  There are also shortcut alias options
12643 available for backward compatibility and convenience.  Supported
12644 values for @var{cpu} are
12646 @table @samp
12647 @opindex mA6
12648 @opindex mARC600
12649 @item ARC600
12650 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12652 @item ARC601
12653 @opindex mARC601
12654 Compile for ARC601.  Alias: @option{-mARC601}.
12656 @item ARC700
12657 @opindex mA7
12658 @opindex mARC700
12659 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12660 This is the default when configured with @option{--with-cpu=arc700}@.
12661 @end table
12663 @item -mdpfp
12664 @opindex mdpfp
12665 @itemx -mdpfp-compact
12666 @opindex mdpfp-compact
12667 FPX: Generate Double Precision FPX instructions, tuned for the compact
12668 implementation.
12670 @item -mdpfp-fast
12671 @opindex mdpfp-fast
12672 FPX: Generate Double Precision FPX instructions, tuned for the fast
12673 implementation.
12675 @item -mno-dpfp-lrsr
12676 @opindex mno-dpfp-lrsr
12677 Disable LR and SR instructions from using FPX extension aux registers.
12679 @item -mea
12680 @opindex mea
12681 Generate Extended arithmetic instructions.  Currently only
12682 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12683 supported.  This is always enabled for @option{-mcpu=ARC700}.
12685 @item -mno-mpy
12686 @opindex mno-mpy
12687 Do not generate mpy instructions for ARC700.
12689 @item -mmul32x16
12690 @opindex mmul32x16
12691 Generate 32x16 bit multiply and mac instructions.
12693 @item -mmul64
12694 @opindex mmul64
12695 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
12697 @item -mnorm
12698 @opindex mnorm
12699 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
12700 is in effect.
12702 @item -mspfp
12703 @opindex mspfp
12704 @itemx -mspfp-compact
12705 @opindex mspfp-compact
12706 FPX: Generate Single Precision FPX instructions, tuned for the compact
12707 implementation.
12709 @item -mspfp-fast
12710 @opindex mspfp-fast
12711 FPX: Generate Single Precision FPX instructions, tuned for the fast
12712 implementation.
12714 @item -msimd
12715 @opindex msimd
12716 Enable generation of ARC SIMD instructions via target-specific
12717 builtins.  Only valid for @option{-mcpu=ARC700}.
12719 @item -msoft-float
12720 @opindex msoft-float
12721 This option ignored; it is provided for compatibility purposes only.
12722 Software floating point code is emitted by default, and this default
12723 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12724 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12725 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12727 @item -mswap
12728 @opindex mswap
12729 Generate swap instructions.
12731 @end table
12733 The following options are passed through to the assembler, and also
12734 define preprocessor macro symbols.
12736 @c Flags used by the assembler, but for which we define preprocessor
12737 @c macro symbols as well.
12738 @table @gcctabopt
12739 @item -mdsp-packa
12740 @opindex mdsp-packa
12741 Passed down to the assembler to enable the DSP Pack A extensions.
12742 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12744 @item -mdvbf
12745 @opindex mdvbf
12746 Passed down to the assembler to enable the dual viterbi butterfly
12747 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12749 @c ARC700 4.10 extension instruction
12750 @item -mlock
12751 @opindex mlock
12752 Passed down to the assembler to enable the Locked Load/Store
12753 Conditional extension.  Also sets the preprocessor symbol
12754 @code{__Xlock}.
12756 @item -mmac-d16
12757 @opindex mmac-d16
12758 Passed down to the assembler.  Also sets the preprocessor symbol
12759 @code{__Xxmac_d16}.
12761 @item -mmac-24
12762 @opindex mmac-24
12763 Passed down to the assembler.  Also sets the preprocessor symbol
12764 @code{__Xxmac_24}.
12766 @c ARC700 4.10 extension instruction
12767 @item -mrtsc
12768 @opindex mrtsc
12769 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12770 extension instruction.  Also sets the preprocessor symbol
12771 @code{__Xrtsc}.
12773 @c ARC700 4.10 extension instruction
12774 @item -mswape
12775 @opindex mswape
12776 Passed down to the assembler to enable the swap byte ordering
12777 extension instruction.  Also sets the preprocessor symbol
12778 @code{__Xswape}.
12780 @item -mtelephony
12781 @opindex mtelephony
12782 Passed down to the assembler to enable dual and single operand
12783 instructions for telephony.  Also sets the preprocessor symbol
12784 @code{__Xtelephony}.
12786 @item -mxy
12787 @opindex mxy
12788 Passed down to the assembler to enable the XY Memory extension.  Also
12789 sets the preprocessor symbol @code{__Xxy}.
12791 @end table
12793 The following options control how the assembly code is annotated:
12795 @c Assembly annotation options
12796 @table @gcctabopt
12797 @item -misize
12798 @opindex misize
12799 Annotate assembler instructions with estimated addresses.
12801 @item -mannotate-align
12802 @opindex mannotate-align
12803 Explain what alignment considerations lead to the decision to make an
12804 instruction short or long.
12806 @end table
12808 The following options are passed through to the linker:
12810 @c options passed through to the linker
12811 @table @gcctabopt
12812 @item -marclinux
12813 @opindex marclinux
12814 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12815 This option is enabled by default in tool chains built for
12816 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12817 when profiling is not requested.
12819 @item -marclinux_prof
12820 @opindex marclinux_prof
12821 Passed through to the linker, to specify use of the
12822 @code{arclinux_prof} emulation.  This option is enabled by default in
12823 tool chains built for @w{@code{arc-linux-uclibc}} and
12824 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12826 @end table
12828 The following options control the semantics of generated code:
12830 @c semantically relevant code generation options
12831 @table @gcctabopt
12832 @item -mepilogue-cfi
12833 @opindex mepilogue-cfi
12834 Enable generation of call frame information for epilogues.
12836 @item -mno-epilogue-cfi
12837 @opindex mno-epilogue-cfi
12838 Disable generation of call frame information for epilogues.
12840 @item -mlong-calls
12841 @opindex mlong-calls
12842 Generate call insns as register indirect calls, thus providing access
12843 to the full 32-bit address range.
12845 @item -mmedium-calls
12846 @opindex mmedium-calls
12847 Don't use less than 25 bit addressing range for calls, which is the
12848 offset available for an unconditional branch-and-link
12849 instruction.  Conditional execution of function calls is suppressed, to
12850 allow use of the 25-bit range, rather than the 21-bit range with
12851 conditional branch-and-link.  This is the default for tool chains built
12852 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12854 @item -mno-sdata
12855 @opindex mno-sdata
12856 Do not generate sdata references.  This is the default for tool chains
12857 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12858 targets.
12860 @item -mucb-mcount
12861 @opindex mucb-mcount
12862 Instrument with mcount calls as used in UCB code.  I.e. do the
12863 counting in the callee, not the caller.  By default ARC instrumentation
12864 counts in the caller.
12866 @item -mvolatile-cache
12867 @opindex mvolatile-cache
12868 Use ordinarily cached memory accesses for volatile references.  This is the
12869 default.
12871 @item -mno-volatile-cache
12872 @opindex mno-volatile-cache
12873 Enable cache bypass for volatile references.
12875 @end table
12877 The following options fine tune code generation:
12878 @c code generation tuning options
12879 @table @gcctabopt
12880 @item -malign-call
12881 @opindex malign-call
12882 Do alignment optimizations for call instructions.
12884 @item -mauto-modify-reg
12885 @opindex mauto-modify-reg
12886 Enable the use of pre/post modify with register displacement.
12888 @item -mbbit-peephole
12889 @opindex mbbit-peephole
12890 Enable bbit peephole2.
12892 @item -mno-brcc
12893 @opindex mno-brcc
12894 This option disables a target-specific pass in @file{arc_reorg} to
12895 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12896 generation driven by the combiner pass.
12898 @item -mcase-vector-pcrel
12899 @opindex mcase-vector-pcrel
12900 Use pc-relative switch case tables - this enables case table shortening.
12901 This is the default for @option{-Os}.
12903 @item -mcompact-casesi
12904 @opindex mcompact-casesi
12905 Enable compact casesi pattern.
12906 This is the default for @option{-Os}.
12908 @item -mno-cond-exec
12909 @opindex mno-cond-exec
12910 Disable ARCompact specific pass to generate conditional execution instructions.
12911 Due to delay slot scheduling and interactions between operand numbers,
12912 literal sizes, instruction lengths, and the support for conditional execution,
12913 the target-independent pass to generate conditional execution is often lacking,
12914 so the ARC port has kept a special pass around that tries to find more
12915 conditional execution generating opportunities after register allocation,
12916 branch shortening, and delay slot scheduling have been done.  This pass
12917 generally, but not always, improves performance and code size, at the cost of
12918 extra compilation time, which is why there is an option to switch it off.
12919 If you have a problem with call instructions exceeding their allowable
12920 offset range because they are conditionalized, you should consider using
12921 @option{-mmedium-calls} instead.
12923 @item -mearly-cbranchsi
12924 @opindex mearly-cbranchsi
12925 Enable pre-reload use of the cbranchsi pattern.
12927 @item -mexpand-adddi
12928 @opindex mexpand-adddi
12929 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12930 @code{add.f}, @code{adc} etc.
12932 @item -mindexed-loads
12933 @opindex mindexed-loads
12934 Enable the use of indexed loads.  This can be problematic because some
12935 optimizers then assume that indexed stores exist, which is not
12936 the case.
12938 @item -mlra
12939 @opindex mlra
12940 Enable Local Register Allocation.  This is still experimental for ARC,
12941 so by default the compiler uses standard reload
12942 (i.e. @option{-mno-lra}).
12944 @item -mlra-priority-none
12945 @opindex mlra-priority-none
12946 Don't indicate any priority for target registers.
12948 @item -mlra-priority-compact
12949 @opindex mlra-priority-compact
12950 Indicate target register priority for r0..r3 / r12..r15.
12952 @item -mlra-priority-noncompact
12953 @opindex mlra-priority-noncompact
12954 Reduce target regsiter priority for r0..r3 / r12..r15.
12956 @item -mno-millicode
12957 @opindex mno-millicode
12958 When optimizing for size (using @option{-Os}), prologues and epilogues
12959 that have to save or restore a large number of registers are often
12960 shortened by using call to a special function in libgcc; this is
12961 referred to as a @emph{millicode} call.  As these calls can pose
12962 performance issues, and/or cause linking issues when linking in a
12963 nonstandard way, this option is provided to turn off millicode call
12964 generation.
12966 @item -mmixed-code
12967 @opindex mmixed-code
12968 Tweak register allocation to help 16-bit instruction generation.
12969 This generally has the effect of decreasing the average instruction size
12970 while increasing the instruction count.
12972 @item -mq-class
12973 @opindex mq-class
12974 Enable 'q' instruction alternatives.
12975 This is the default for @option{-Os}.
12977 @item -mRcq
12978 @opindex mRcq
12979 Enable Rcq constraint handling - most short code generation depends on this.
12980 This is the default.
12982 @item -mRcw
12983 @opindex mRcw
12984 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12985 This is the default.
12987 @item -msize-level=@var{level}
12988 @opindex msize-level
12989 Fine-tune size optimization with regards to instruction lengths and alignment.
12990 The recognized values for @var{level} are:
12991 @table @samp
12992 @item 0
12993 No size optimization.  This level is deprecated and treated like @samp{1}.
12995 @item 1
12996 Short instructions are used opportunistically.
12998 @item 2
12999 In addition, alignment of loops and of code after barriers are dropped.
13001 @item 3
13002 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
13004 @end table
13006 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
13007 the behavior when this is not set is equivalent to level @samp{1}.
13009 @item -mtune=@var{cpu}
13010 @opindex mtune
13011 Set instruction scheduling parameters for @var{cpu}, overriding any implied
13012 by @option{-mcpu=}.
13014 Supported values for @var{cpu} are
13016 @table @samp
13017 @item ARC600
13018 Tune for ARC600 cpu.
13020 @item ARC601
13021 Tune for ARC601 cpu.
13023 @item ARC700
13024 Tune for ARC700 cpu with standard multiplier block.
13026 @item ARC700-xmac
13027 Tune for ARC700 cpu with XMAC block.
13029 @item ARC725D
13030 Tune for ARC725D cpu.
13032 @item ARC750D
13033 Tune for ARC750D cpu.
13035 @end table
13037 @item -mmultcost=@var{num}
13038 @opindex mmultcost
13039 Cost to assume for a multiply instruction, with @samp{4} being equal to a
13040 normal instruction.
13042 @item -munalign-prob-threshold=@var{probability}
13043 @opindex munalign-prob-threshold
13044 Set probability threshold for unaligning branches.
13045 When tuning for @samp{ARC700} and optimizing for speed, branches without
13046 filled delay slot are preferably emitted unaligned and long, unless
13047 profiling indicates that the probability for the branch to be taken
13048 is below @var{probability}.  @xref{Cross-profiling}.
13049 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13051 @end table
13053 The following options are maintained for backward compatibility, but
13054 are now deprecated and will be removed in a future release:
13056 @c Deprecated options
13057 @table @gcctabopt
13059 @item -margonaut
13060 @opindex margonaut
13061 Obsolete FPX.
13063 @item -mbig-endian
13064 @opindex mbig-endian
13065 @itemx -EB
13066 @opindex EB
13067 Compile code for big endian targets.  Use of these options is now
13068 deprecated.  Users wanting big-endian code, should use the
13069 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13070 building the tool chain, for which big-endian is the default.
13072 @item -mlittle-endian
13073 @opindex mlittle-endian
13074 @itemx -EL
13075 @opindex EL
13076 Compile code for little endian targets.  Use of these options is now
13077 deprecated.  Users wanting little-endian code should use the
13078 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13079 building the tool chain, for which little-endian is the default.
13081 @item -mbarrel_shifter
13082 @opindex mbarrel_shifter
13083 Replaced by @option{-mbarrel-shifter}.
13085 @item -mdpfp_compact
13086 @opindex mdpfp_compact
13087 Replaced by @option{-mdpfp-compact}.
13089 @item -mdpfp_fast
13090 @opindex mdpfp_fast
13091 Replaced by @option{-mdpfp-fast}.
13093 @item -mdsp_packa
13094 @opindex mdsp_packa
13095 Replaced by @option{-mdsp-packa}.
13097 @item -mEA
13098 @opindex mEA
13099 Replaced by @option{-mea}.
13101 @item -mmac_24
13102 @opindex mmac_24
13103 Replaced by @option{-mmac-24}.
13105 @item -mmac_d16
13106 @opindex mmac_d16
13107 Replaced by @option{-mmac-d16}.
13109 @item -mspfp_compact
13110 @opindex mspfp_compact
13111 Replaced by @option{-mspfp-compact}.
13113 @item -mspfp_fast
13114 @opindex mspfp_fast
13115 Replaced by @option{-mspfp-fast}.
13117 @item -mtune=@var{cpu}
13118 @opindex mtune
13119 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13120 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13121 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13123 @item -multcost=@var{num}
13124 @opindex multcost
13125 Replaced by @option{-mmultcost}.
13127 @end table
13129 @node ARM Options
13130 @subsection ARM Options
13131 @cindex ARM options
13133 These @samp{-m} options are defined for the ARM port:
13135 @table @gcctabopt
13136 @item -mabi=@var{name}
13137 @opindex mabi
13138 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13139 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13141 @item -mapcs-frame
13142 @opindex mapcs-frame
13143 Generate a stack frame that is compliant with the ARM Procedure Call
13144 Standard for all functions, even if this is not strictly necessary for
13145 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13146 with this option causes the stack frames not to be generated for
13147 leaf functions.  The default is @option{-mno-apcs-frame}.
13148 This option is deprecated.
13150 @item -mapcs
13151 @opindex mapcs
13152 This is a synonym for @option{-mapcs-frame} and is deprecated.
13154 @ignore
13155 @c not currently implemented
13156 @item -mapcs-stack-check
13157 @opindex mapcs-stack-check
13158 Generate code to check the amount of stack space available upon entry to
13159 every function (that actually uses some stack space).  If there is
13160 insufficient space available then either the function
13161 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13162 called, depending upon the amount of stack space required.  The runtime
13163 system is required to provide these functions.  The default is
13164 @option{-mno-apcs-stack-check}, since this produces smaller code.
13166 @c not currently implemented
13167 @item -mapcs-float
13168 @opindex mapcs-float
13169 Pass floating-point arguments using the floating-point registers.  This is
13170 one of the variants of the APCS@.  This option is recommended if the
13171 target hardware has a floating-point unit or if a lot of floating-point
13172 arithmetic is going to be performed by the code.  The default is
13173 @option{-mno-apcs-float}, since the size of integer-only code is 
13174 slightly increased if @option{-mapcs-float} is used.
13176 @c not currently implemented
13177 @item -mapcs-reentrant
13178 @opindex mapcs-reentrant
13179 Generate reentrant, position-independent code.  The default is
13180 @option{-mno-apcs-reentrant}.
13181 @end ignore
13183 @item -mthumb-interwork
13184 @opindex mthumb-interwork
13185 Generate code that supports calling between the ARM and Thumb
13186 instruction sets.  Without this option, on pre-v5 architectures, the
13187 two instruction sets cannot be reliably used inside one program.  The
13188 default is @option{-mno-thumb-interwork}, since slightly larger code
13189 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13190 configurations this option is meaningless.
13192 @item -mno-sched-prolog
13193 @opindex mno-sched-prolog
13194 Prevent the reordering of instructions in the function prologue, or the
13195 merging of those instruction with the instructions in the function's
13196 body.  This means that all functions start with a recognizable set
13197 of instructions (or in fact one of a choice from a small set of
13198 different function prologues), and this information can be used to
13199 locate the start of functions inside an executable piece of code.  The
13200 default is @option{-msched-prolog}.
13202 @item -mfloat-abi=@var{name}
13203 @opindex mfloat-abi
13204 Specifies which floating-point ABI to use.  Permissible values
13205 are: @samp{soft}, @samp{softfp} and @samp{hard}.
13207 Specifying @samp{soft} causes GCC to generate output containing
13208 library calls for floating-point operations.
13209 @samp{softfp} allows the generation of code using hardware floating-point
13210 instructions, but still uses the soft-float calling conventions.
13211 @samp{hard} allows generation of floating-point instructions
13212 and uses FPU-specific calling conventions.
13214 The default depends on the specific target configuration.  Note that
13215 the hard-float and soft-float ABIs are not link-compatible; you must
13216 compile your entire program with the same ABI, and link with a
13217 compatible set of libraries.
13219 @item -mlittle-endian
13220 @opindex mlittle-endian
13221 Generate code for a processor running in little-endian mode.  This is
13222 the default for all standard configurations.
13224 @item -mbig-endian
13225 @opindex mbig-endian
13226 Generate code for a processor running in big-endian mode; the default is
13227 to compile code for a little-endian processor.
13229 @item -march=@var{name}
13230 @opindex march
13231 This specifies the name of the target ARM architecture.  GCC uses this
13232 name to determine what kind of instructions it can emit when generating
13233 assembly code.  This option can be used in conjunction with or instead
13234 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
13235 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
13236 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
13237 @samp{armv6}, @samp{armv6j},
13238 @samp{armv6t2}, @samp{armv6z}, @samp{armv6kz}, @samp{armv6-m},
13239 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
13240 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
13241 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
13243 @option{-march=armv7ve} is the armv7-a architecture with virtualization
13244 extensions.
13246 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
13247 architecture together with the optional CRC32 extensions.
13249 @option{-march=native} causes the compiler to auto-detect the architecture
13250 of the build computer.  At present, this feature is only supported on
13251 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13252 is unsuccessful the option has no effect.
13254 @item -mtune=@var{name}
13255 @opindex mtune
13256 This option specifies the name of the target ARM processor for
13257 which GCC should tune the performance of the code.
13258 For some ARM implementations better performance can be obtained by using
13259 this option.
13260 Permissible names are: @samp{arm2}, @samp{arm250},
13261 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
13262 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
13263 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
13264 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
13265 @samp{arm720},
13266 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
13267 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
13268 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
13269 @samp{strongarm1110},
13270 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
13271 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
13272 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
13273 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
13274 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
13275 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
13276 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
13277 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
13278 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
13279 @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
13280 @samp{cortex-r4},
13281 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
13282 @samp{cortex-m4},
13283 @samp{cortex-m3},
13284 @samp{cortex-m1},
13285 @samp{cortex-m0},
13286 @samp{cortex-m0plus},
13287 @samp{cortex-m1.small-multiply},
13288 @samp{cortex-m0.small-multiply},
13289 @samp{cortex-m0plus.small-multiply},
13290 @samp{exynos-m1},
13291 @samp{marvell-pj4},
13292 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
13293 @samp{fa526}, @samp{fa626},
13294 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
13295 @samp{xgene1}.
13297 Additionally, this option can specify that GCC should tune the performance
13298 of the code for a big.LITTLE system.  Permissible names are:
13299 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
13300 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
13302 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
13303 performance for a blend of processors within architecture @var{arch}.
13304 The aim is to generate code that run well on the current most popular
13305 processors, balancing between optimizations that benefit some CPUs in the
13306 range, and avoiding performance pitfalls of other CPUs.  The effects of
13307 this option may change in future GCC versions as CPU models come and go.
13309 @option{-mtune=native} causes the compiler to auto-detect the CPU
13310 of the build computer.  At present, this feature is only supported on
13311 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
13312 unsuccessful the option has no effect.
13314 @item -mcpu=@var{name}
13315 @opindex mcpu
13316 This specifies the name of the target ARM processor.  GCC uses this name
13317 to derive the name of the target ARM architecture (as if specified
13318 by @option{-march}) and the ARM processor type for which to tune for
13319 performance (as if specified by @option{-mtune}).  Where this option
13320 is used in conjunction with @option{-march} or @option{-mtune},
13321 those options take precedence over the appropriate part of this option.
13323 Permissible names for this option are the same as those for
13324 @option{-mtune}.
13326 @option{-mcpu=generic-@var{arch}} is also permissible, and is
13327 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
13328 See @option{-mtune} for more information.
13330 @option{-mcpu=native} causes the compiler to auto-detect the CPU
13331 of the build computer.  At present, this feature is only supported on
13332 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13333 is unsuccessful the option has no effect.
13335 @item -mfpu=@var{name}
13336 @opindex mfpu
13337 This specifies what floating-point hardware (or hardware emulation) is
13338 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
13339 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
13340 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
13341 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
13342 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
13343 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
13345 If @option{-msoft-float} is specified this specifies the format of
13346 floating-point values.
13348 If the selected floating-point hardware includes the NEON extension
13349 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
13350 operations are not generated by GCC's auto-vectorization pass unless
13351 @option{-funsafe-math-optimizations} is also specified.  This is
13352 because NEON hardware does not fully implement the IEEE 754 standard for
13353 floating-point arithmetic (in particular denormal values are treated as
13354 zero), so the use of NEON instructions may lead to a loss of precision.
13356 @item -mfp16-format=@var{name}
13357 @opindex mfp16-format
13358 Specify the format of the @code{__fp16} half-precision floating-point type.
13359 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
13360 the default is @samp{none}, in which case the @code{__fp16} type is not
13361 defined.  @xref{Half-Precision}, for more information.
13363 @item -mstructure-size-boundary=@var{n}
13364 @opindex mstructure-size-boundary
13365 The sizes of all structures and unions are rounded up to a multiple
13366 of the number of bits set by this option.  Permissible values are 8, 32
13367 and 64.  The default value varies for different toolchains.  For the COFF
13368 targeted toolchain the default value is 8.  A value of 64 is only allowed
13369 if the underlying ABI supports it.
13371 Specifying a larger number can produce faster, more efficient code, but
13372 can also increase the size of the program.  Different values are potentially
13373 incompatible.  Code compiled with one value cannot necessarily expect to
13374 work with code or libraries compiled with another value, if they exchange
13375 information using structures or unions.
13377 @item -mabort-on-noreturn
13378 @opindex mabort-on-noreturn
13379 Generate a call to the function @code{abort} at the end of a
13380 @code{noreturn} function.  It is executed if the function tries to
13381 return.
13383 @item -mlong-calls
13384 @itemx -mno-long-calls
13385 @opindex mlong-calls
13386 @opindex mno-long-calls
13387 Tells the compiler to perform function calls by first loading the
13388 address of the function into a register and then performing a subroutine
13389 call on this register.  This switch is needed if the target function
13390 lies outside of the 64-megabyte addressing range of the offset-based
13391 version of subroutine call instruction.
13393 Even if this switch is enabled, not all function calls are turned
13394 into long calls.  The heuristic is that static functions, functions
13395 that have the @code{short_call} attribute, functions that are inside
13396 the scope of a @code{#pragma no_long_calls} directive, and functions whose
13397 definitions have already been compiled within the current compilation
13398 unit are not turned into long calls.  The exceptions to this rule are
13399 that weak function definitions, functions with the @code{long_call}
13400 attribute or the @code{section} attribute, and functions that are within
13401 the scope of a @code{#pragma long_calls} directive are always
13402 turned into long calls.
13404 This feature is not enabled by default.  Specifying
13405 @option{-mno-long-calls} restores the default behavior, as does
13406 placing the function calls within the scope of a @code{#pragma
13407 long_calls_off} directive.  Note these switches have no effect on how
13408 the compiler generates code to handle function calls via function
13409 pointers.
13411 @item -msingle-pic-base
13412 @opindex msingle-pic-base
13413 Treat the register used for PIC addressing as read-only, rather than
13414 loading it in the prologue for each function.  The runtime system is
13415 responsible for initializing this register with an appropriate value
13416 before execution begins.
13418 @item -mpic-register=@var{reg}
13419 @opindex mpic-register
13420 Specify the register to be used for PIC addressing.
13421 For standard PIC base case, the default is any suitable register
13422 determined by compiler.  For single PIC base case, the default is
13423 @samp{R9} if target is EABI based or stack-checking is enabled,
13424 otherwise the default is @samp{R10}.
13426 @item -mpic-data-is-text-relative
13427 @opindex mpic-data-is-text-relative
13428 Assume that each data segments are relative to text segment at load time.
13429 Therefore, it permits addressing data using PC-relative operations.
13430 This option is on by default for targets other than VxWorks RTP.
13432 @item -mpoke-function-name
13433 @opindex mpoke-function-name
13434 Write the name of each function into the text section, directly
13435 preceding the function prologue.  The generated code is similar to this:
13437 @smallexample
13438      t0
13439          .ascii "arm_poke_function_name", 0
13440          .align
13441      t1
13442          .word 0xff000000 + (t1 - t0)
13443      arm_poke_function_name
13444          mov     ip, sp
13445          stmfd   sp!, @{fp, ip, lr, pc@}
13446          sub     fp, ip, #4
13447 @end smallexample
13449 When performing a stack backtrace, code can inspect the value of
13450 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13451 location @code{pc - 12} and the top 8 bits are set, then we know that
13452 there is a function name embedded immediately preceding this location
13453 and has length @code{((pc[-3]) & 0xff000000)}.
13455 @item -mthumb
13456 @itemx -marm
13457 @opindex marm
13458 @opindex mthumb
13460 Select between generating code that executes in ARM and Thumb
13461 states.  The default for most configurations is to generate code
13462 that executes in ARM state, but the default can be changed by
13463 configuring GCC with the @option{--with-mode=}@var{state}
13464 configure option.
13466 You can also override the ARM and Thumb mode for each function
13467 by using the @code{target("thumb")} and @code{target("arm")} function attributes
13468 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
13470 @item -mtpcs-frame
13471 @opindex mtpcs-frame
13472 Generate a stack frame that is compliant with the Thumb Procedure Call
13473 Standard for all non-leaf functions.  (A leaf function is one that does
13474 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13476 @item -mtpcs-leaf-frame
13477 @opindex mtpcs-leaf-frame
13478 Generate a stack frame that is compliant with the Thumb Procedure Call
13479 Standard for all leaf functions.  (A leaf function is one that does
13480 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13482 @item -mcallee-super-interworking
13483 @opindex mcallee-super-interworking
13484 Gives all externally visible functions in the file being compiled an ARM
13485 instruction set header which switches to Thumb mode before executing the
13486 rest of the function.  This allows these functions to be called from
13487 non-interworking code.  This option is not valid in AAPCS configurations
13488 because interworking is enabled by default.
13490 @item -mcaller-super-interworking
13491 @opindex mcaller-super-interworking
13492 Allows calls via function pointers (including virtual functions) to
13493 execute correctly regardless of whether the target code has been
13494 compiled for interworking or not.  There is a small overhead in the cost
13495 of executing a function pointer if this option is enabled.  This option
13496 is not valid in AAPCS configurations because interworking is enabled
13497 by default.
13499 @item -mtp=@var{name}
13500 @opindex mtp
13501 Specify the access model for the thread local storage pointer.  The valid
13502 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
13503 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
13504 (supported in the arm6k architecture), and @samp{auto}, which uses the
13505 best available method for the selected processor.  The default setting is
13506 @samp{auto}.
13508 @item -mtls-dialect=@var{dialect}
13509 @opindex mtls-dialect
13510 Specify the dialect to use for accessing thread local storage.  Two
13511 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13512 @samp{gnu} dialect selects the original GNU scheme for supporting
13513 local and global dynamic TLS models.  The @samp{gnu2} dialect
13514 selects the GNU descriptor scheme, which provides better performance
13515 for shared libraries.  The GNU descriptor scheme is compatible with
13516 the original scheme, but does require new assembler, linker and
13517 library support.  Initial and local exec TLS models are unaffected by
13518 this option and always use the original scheme.
13520 @item -mword-relocations
13521 @opindex mword-relocations
13522 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13523 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13524 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13525 is specified.
13527 @item -mfix-cortex-m3-ldrd
13528 @opindex mfix-cortex-m3-ldrd
13529 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13530 with overlapping destination and base registers are used.  This option avoids
13531 generating these instructions.  This option is enabled by default when
13532 @option{-mcpu=cortex-m3} is specified.
13534 @item -munaligned-access
13535 @itemx -mno-unaligned-access
13536 @opindex munaligned-access
13537 @opindex mno-unaligned-access
13538 Enables (or disables) reading and writing of 16- and 32- bit values
13539 from addresses that are not 16- or 32- bit aligned.  By default
13540 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13541 architectures, and enabled for all other architectures.  If unaligned
13542 access is not enabled then words in packed data structures are
13543 accessed a byte at a time.
13545 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
13546 generated object file to either true or false, depending upon the
13547 setting of this option.  If unaligned access is enabled then the
13548 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
13549 defined.
13551 @item -mneon-for-64bits
13552 @opindex mneon-for-64bits
13553 Enables using Neon to handle scalar 64-bits operations. This is
13554 disabled by default since the cost of moving data from core registers
13555 to Neon is high.
13557 @item -mslow-flash-data
13558 @opindex mslow-flash-data
13559 Assume loading data from flash is slower than fetching instruction.
13560 Therefore literal load is minimized for better performance.
13561 This option is only supported when compiling for ARMv7 M-profile and
13562 off by default.
13564 @item -masm-syntax-unified
13565 @opindex masm-syntax-unified
13566 Assume inline assembler is using unified asm syntax.  The default is
13567 currently off which implies divided syntax.  Currently this option is
13568 available only for Thumb1 and has no effect on ARM state and Thumb2.
13569 However, this may change in future releases of GCC.  Divided syntax
13570 should be considered deprecated.
13572 @item -mrestrict-it
13573 @opindex mrestrict-it
13574 Restricts generation of IT blocks to conform to the rules of ARMv8.
13575 IT blocks can only contain a single 16-bit instruction from a select
13576 set of instructions. This option is on by default for ARMv8 Thumb mode.
13578 @item -mprint-tune-info
13579 @opindex mprint-tune-info
13580 Print CPU tuning information as comment in assembler file.  This is
13581 an option used only for regression testing of the compiler and not
13582 intended for ordinary use in compiling code.  This option is disabled
13583 by default.
13584 @end table
13586 @node AVR Options
13587 @subsection AVR Options
13588 @cindex AVR Options
13590 These options are defined for AVR implementations:
13592 @table @gcctabopt
13593 @item -mmcu=@var{mcu}
13594 @opindex mmcu
13595 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13597 The default for this option is@tie{}@samp{avr2}.
13599 GCC supports the following AVR devices and ISAs:
13601 @include avr-mmcu.texi
13603 @item -maccumulate-args
13604 @opindex maccumulate-args
13605 Accumulate outgoing function arguments and acquire/release the needed
13606 stack space for outgoing function arguments once in function
13607 prologue/epilogue.  Without this option, outgoing arguments are pushed
13608 before calling a function and popped afterwards.
13610 Popping the arguments after the function call can be expensive on
13611 AVR so that accumulating the stack space might lead to smaller
13612 executables because arguments need not to be removed from the
13613 stack after such a function call.
13615 This option can lead to reduced code size for functions that perform
13616 several calls to functions that get their arguments on the stack like
13617 calls to printf-like functions.
13619 @item -mbranch-cost=@var{cost}
13620 @opindex mbranch-cost
13621 Set the branch costs for conditional branch instructions to
13622 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13623 integers. The default branch cost is 0.
13625 @item -mcall-prologues
13626 @opindex mcall-prologues
13627 Functions prologues/epilogues are expanded as calls to appropriate
13628 subroutines.  Code size is smaller.
13630 @item -mint8
13631 @opindex mint8
13632 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13633 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13634 and @code{long long} is 4 bytes.  Please note that this option does not
13635 conform to the C standards, but it results in smaller code
13636 size.
13638 @item -mn-flash=@var{num}
13639 @opindex mn-flash
13640 Assume that the flash memory has a size of 
13641 @var{num} times 64@tie{}KiB.
13643 @item -mno-interrupts
13644 @opindex mno-interrupts
13645 Generated code is not compatible with hardware interrupts.
13646 Code size is smaller.
13648 @item -mrelax
13649 @opindex mrelax
13650 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13651 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13652 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
13653 the assembler's command line and the @option{--relax} option to the
13654 linker's command line.
13656 Jump relaxing is performed by the linker because jump offsets are not
13657 known before code is located. Therefore, the assembler code generated by the
13658 compiler is the same, but the instructions in the executable may
13659 differ from instructions in the assembler code.
13661 Relaxing must be turned on if linker stubs are needed, see the
13662 section on @code{EIND} and linker stubs below.
13664 @item -mrmw
13665 @opindex mrmw
13666 Assume that the device supports the Read-Modify-Write
13667 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
13669 @item -msp8
13670 @opindex msp8
13671 Treat the stack pointer register as an 8-bit register,
13672 i.e.@: assume the high byte of the stack pointer is zero.
13673 In general, you don't need to set this option by hand.
13675 This option is used internally by the compiler to select and
13676 build multilibs for architectures @code{avr2} and @code{avr25}.
13677 These architectures mix devices with and without @code{SPH}.
13678 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
13679 the compiler driver adds or removes this option from the compiler
13680 proper's command line, because the compiler then knows if the device
13681 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13682 register or not.
13684 @item -mstrict-X
13685 @opindex mstrict-X
13686 Use address register @code{X} in a way proposed by the hardware.  This means
13687 that @code{X} is only used in indirect, post-increment or
13688 pre-decrement addressing.
13690 Without this option, the @code{X} register may be used in the same way
13691 as @code{Y} or @code{Z} which then is emulated by additional
13692 instructions.  
13693 For example, loading a value with @code{X+const} addressing with a
13694 small non-negative @code{const < 64} to a register @var{Rn} is
13695 performed as
13697 @example
13698 adiw r26, const   ; X += const
13699 ld   @var{Rn}, X        ; @var{Rn} = *X
13700 sbiw r26, const   ; X -= const
13701 @end example
13703 @item -mtiny-stack
13704 @opindex mtiny-stack
13705 Only change the lower 8@tie{}bits of the stack pointer.
13707 @item -nodevicelib
13708 @opindex nodevicelib
13709 Don't link against AVR-LibC's device specific library @code{libdev.a}.
13711 @item -Waddr-space-convert
13712 @opindex Waddr-space-convert
13713 Warn about conversions between address spaces in the case where the
13714 resulting address space is not contained in the incoming address space.
13715 @end table
13717 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
13718 @cindex @code{EIND}
13719 Pointers in the implementation are 16@tie{}bits wide.
13720 The address of a function or label is represented as word address so
13721 that indirect jumps and calls can target any code address in the
13722 range of 64@tie{}Ki words.
13724 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13725 bytes of program memory space, there is a special function register called
13726 @code{EIND} that serves as most significant part of the target address
13727 when @code{EICALL} or @code{EIJMP} instructions are used.
13729 Indirect jumps and calls on these devices are handled as follows by
13730 the compiler and are subject to some limitations:
13732 @itemize @bullet
13734 @item
13735 The compiler never sets @code{EIND}.
13737 @item
13738 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13739 instructions or might read @code{EIND} directly in order to emulate an
13740 indirect call/jump by means of a @code{RET} instruction.
13742 @item
13743 The compiler assumes that @code{EIND} never changes during the startup
13744 code or during the application. In particular, @code{EIND} is not
13745 saved/restored in function or interrupt service routine
13746 prologue/epilogue.
13748 @item
13749 For indirect calls to functions and computed goto, the linker
13750 generates @emph{stubs}. Stubs are jump pads sometimes also called
13751 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13752 The stub contains a direct jump to the desired address.
13754 @item
13755 Linker relaxation must be turned on so that the linker generates
13756 the stubs correctly in all situations. See the compiler option
13757 @option{-mrelax} and the linker option @option{--relax}.
13758 There are corner cases where the linker is supposed to generate stubs
13759 but aborts without relaxation and without a helpful error message.
13761 @item
13762 The default linker script is arranged for code with @code{EIND = 0}.
13763 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13764 linker script has to be used in order to place the sections whose
13765 name start with @code{.trampolines} into the segment where @code{EIND}
13766 points to.
13768 @item
13769 The startup code from libgcc never sets @code{EIND}.
13770 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13771 For the impact of AVR-LibC on @code{EIND}, see the
13772 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13774 @item
13775 It is legitimate for user-specific startup code to set up @code{EIND}
13776 early, for example by means of initialization code located in
13777 section @code{.init3}. Such code runs prior to general startup code
13778 that initializes RAM and calls constructors, but after the bit
13779 of startup code from AVR-LibC that sets @code{EIND} to the segment
13780 where the vector table is located.
13781 @example
13782 #include <avr/io.h>
13784 static void
13785 __attribute__((section(".init3"),naked,used,no_instrument_function))
13786 init3_set_eind (void)
13788   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13789                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13791 @end example
13793 @noindent
13794 The @code{__trampolines_start} symbol is defined in the linker script.
13796 @item
13797 Stubs are generated automatically by the linker if
13798 the following two conditions are met:
13799 @itemize @minus
13801 @item The address of a label is taken by means of the @code{gs} modifier
13802 (short for @emph{generate stubs}) like so:
13803 @example
13804 LDI r24, lo8(gs(@var{func}))
13805 LDI r25, hi8(gs(@var{func}))
13806 @end example
13807 @item The final location of that label is in a code segment
13808 @emph{outside} the segment where the stubs are located.
13809 @end itemize
13811 @item
13812 The compiler emits such @code{gs} modifiers for code labels in the
13813 following situations:
13814 @itemize @minus
13815 @item Taking address of a function or code label.
13816 @item Computed goto.
13817 @item If prologue-save function is used, see @option{-mcall-prologues}
13818 command-line option.
13819 @item Switch/case dispatch tables. If you do not want such dispatch
13820 tables you can specify the @option{-fno-jump-tables} command-line option.
13821 @item C and C++ constructors/destructors called during startup/shutdown.
13822 @item If the tools hit a @code{gs()} modifier explained above.
13823 @end itemize
13825 @item
13826 Jumping to non-symbolic addresses like so is @emph{not} supported:
13828 @example
13829 int main (void)
13831     /* Call function at word address 0x2 */
13832     return ((int(*)(void)) 0x2)();
13834 @end example
13836 Instead, a stub has to be set up, i.e.@: the function has to be called
13837 through a symbol (@code{func_4} in the example):
13839 @example
13840 int main (void)
13842     extern int func_4 (void);
13844     /* Call function at byte address 0x4 */
13845     return func_4();
13847 @end example
13849 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
13850 Alternatively, @code{func_4} can be defined in the linker script.
13851 @end itemize
13853 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13854 @cindex @code{RAMPD}
13855 @cindex @code{RAMPX}
13856 @cindex @code{RAMPY}
13857 @cindex @code{RAMPZ}
13858 Some AVR devices support memories larger than the 64@tie{}KiB range
13859 that can be accessed with 16-bit pointers.  To access memory locations
13860 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13861 register is used as high part of the address:
13862 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13863 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13864 register, respectively, to get a wide address. Similarly,
13865 @code{RAMPD} is used together with direct addressing.
13867 @itemize
13868 @item
13869 The startup code initializes the @code{RAMP} special function
13870 registers with zero.
13872 @item
13873 If a @ref{AVR Named Address Spaces,named address space} other than
13874 generic or @code{__flash} is used, then @code{RAMPZ} is set
13875 as needed before the operation.
13877 @item
13878 If the device supports RAM larger than 64@tie{}KiB and the compiler
13879 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13880 is reset to zero after the operation.
13882 @item
13883 If the device comes with a specific @code{RAMP} register, the ISR
13884 prologue/epilogue saves/restores that SFR and initializes it with
13885 zero in case the ISR code might (implicitly) use it.
13887 @item
13888 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13889 If you use inline assembler to read from locations outside the
13890 16-bit address range and change one of the @code{RAMP} registers,
13891 you must reset it to zero after the access.
13893 @end itemize
13895 @subsubsection AVR Built-in Macros
13897 GCC defines several built-in macros so that the user code can test
13898 for the presence or absence of features.  Almost any of the following
13899 built-in macros are deduced from device capabilities and thus
13900 triggered by the @option{-mmcu=} command-line option.
13902 For even more AVR-specific built-in macros see
13903 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13905 @table @code
13907 @item __AVR_ARCH__
13908 Build-in macro that resolves to a decimal number that identifies the
13909 architecture and depends on the @option{-mmcu=@var{mcu}} option.
13910 Possible values are:
13912 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13913 @code{4}, @code{5}, @code{51}, @code{6}
13915 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
13916 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
13918 respectively and
13920 @code{100}, @code{102}, @code{104},
13921 @code{105}, @code{106}, @code{107}
13923 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
13924 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
13925 If @var{mcu} specifies a device, this built-in macro is set
13926 accordingly. For example, with @option{-mmcu=atmega8} the macro is
13927 defined to @code{4}.
13929 @item __AVR_@var{Device}__
13930 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
13931 the device's name. For example, @option{-mmcu=atmega8} defines the
13932 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
13933 @code{__AVR_ATtiny261A__}, etc.
13935 The built-in macros' names follow
13936 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13937 the device name as from the AVR user manual. The difference between
13938 @var{Device} in the built-in macro and @var{device} in
13939 @option{-mmcu=@var{device}} is that the latter is always lowercase.
13941 If @var{device} is not a device but only a core architecture like
13942 @samp{avr51}, this macro is not defined.
13944 @item __AVR_DEVICE_NAME__
13945 Setting @option{-mmcu=@var{device}} defines this built-in macro to
13946 the device's name. For example, with @option{-mmcu=atmega8} the macro
13947 is defined to @code{atmega8}.
13949 If @var{device} is not a device but only a core architecture like
13950 @samp{avr51}, this macro is not defined.
13952 @item __AVR_XMEGA__
13953 The device / architecture belongs to the XMEGA family of devices.
13955 @item __AVR_HAVE_ELPM__
13956 The device has the @code{ELPM} instruction.
13958 @item __AVR_HAVE_ELPMX__
13959 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13960 R@var{n},Z+} instructions.
13962 @item __AVR_HAVE_MOVW__
13963 The device has the @code{MOVW} instruction to perform 16-bit
13964 register-register moves.
13966 @item __AVR_HAVE_LPMX__
13967 The device has the @code{LPM R@var{n},Z} and
13968 @code{LPM R@var{n},Z+} instructions.
13970 @item __AVR_HAVE_MUL__
13971 The device has a hardware multiplier. 
13973 @item __AVR_HAVE_JMP_CALL__
13974 The device has the @code{JMP} and @code{CALL} instructions.
13975 This is the case for devices with at least 16@tie{}KiB of program
13976 memory.
13978 @item __AVR_HAVE_EIJMP_EICALL__
13979 @itemx __AVR_3_BYTE_PC__
13980 The device has the @code{EIJMP} and @code{EICALL} instructions.
13981 This is the case for devices with more than 128@tie{}KiB of program memory.
13982 This also means that the program counter
13983 (PC) is 3@tie{}bytes wide.
13985 @item __AVR_2_BYTE_PC__
13986 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13987 with up to 128@tie{}KiB of program memory.
13989 @item __AVR_HAVE_8BIT_SP__
13990 @itemx __AVR_HAVE_16BIT_SP__
13991 The stack pointer (SP) register is treated as 8-bit respectively
13992 16-bit register by the compiler.
13993 The definition of these macros is affected by @option{-mtiny-stack}.
13995 @item __AVR_HAVE_SPH__
13996 @itemx __AVR_SP8__
13997 The device has the SPH (high part of stack pointer) special function
13998 register or has an 8-bit stack pointer, respectively.
13999 The definition of these macros is affected by @option{-mmcu=} and
14000 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
14001 by @option{-msp8}.
14003 @item __AVR_HAVE_RAMPD__
14004 @itemx __AVR_HAVE_RAMPX__
14005 @itemx __AVR_HAVE_RAMPY__
14006 @itemx __AVR_HAVE_RAMPZ__
14007 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
14008 @code{RAMPZ} special function register, respectively.
14010 @item __NO_INTERRUPTS__
14011 This macro reflects the @option{-mno-interrupts} command-line option.
14013 @item __AVR_ERRATA_SKIP__
14014 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
14015 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
14016 instructions because of a hardware erratum.  Skip instructions are
14017 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
14018 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
14019 set.
14021 @item __AVR_ISA_RMW__
14022 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
14024 @item __AVR_SFR_OFFSET__=@var{offset}
14025 Instructions that can address I/O special function registers directly
14026 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
14027 address as if addressed by an instruction to access RAM like @code{LD}
14028 or @code{STS}. This offset depends on the device architecture and has
14029 to be subtracted from the RAM address in order to get the
14030 respective I/O@tie{}address.
14032 @item __WITH_AVRLIBC__
14033 The compiler is configured to be used together with AVR-Libc.
14034 See the @option{--with-avrlibc} configure option.
14036 @end table
14038 @node Blackfin Options
14039 @subsection Blackfin Options
14040 @cindex Blackfin Options
14042 @table @gcctabopt
14043 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
14044 @opindex mcpu=
14045 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
14046 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14047 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14048 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14049 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14050 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14051 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14052 @samp{bf561}, @samp{bf592}.
14054 The optional @var{sirevision} specifies the silicon revision of the target
14055 Blackfin processor.  Any workarounds available for the targeted silicon revision
14056 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14057 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14058 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14059 hexadecimal digits representing the major and minor numbers in the silicon
14060 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14061 is not defined.  If @var{sirevision} is @samp{any}, the
14062 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14063 If this optional @var{sirevision} is not used, GCC assumes the latest known
14064 silicon revision of the targeted Blackfin processor.
14066 GCC defines a preprocessor macro for the specified @var{cpu}.
14067 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14068 provided by libgloss to be linked in if @option{-msim} is not given.
14070 Without this option, @samp{bf532} is used as the processor by default.
14072 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14073 only the preprocessor macro is defined.
14075 @item -msim
14076 @opindex msim
14077 Specifies that the program will be run on the simulator.  This causes
14078 the simulator BSP provided by libgloss to be linked in.  This option
14079 has effect only for @samp{bfin-elf} toolchain.
14080 Certain other options, such as @option{-mid-shared-library} and
14081 @option{-mfdpic}, imply @option{-msim}.
14083 @item -momit-leaf-frame-pointer
14084 @opindex momit-leaf-frame-pointer
14085 Don't keep the frame pointer in a register for leaf functions.  This
14086 avoids the instructions to save, set up and restore frame pointers and
14087 makes an extra register available in leaf functions.  The option
14088 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14089 which might make debugging harder.
14091 @item -mspecld-anomaly
14092 @opindex mspecld-anomaly
14093 When enabled, the compiler ensures that the generated code does not
14094 contain speculative loads after jump instructions. If this option is used,
14095 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14097 @item -mno-specld-anomaly
14098 @opindex mno-specld-anomaly
14099 Don't generate extra code to prevent speculative loads from occurring.
14101 @item -mcsync-anomaly
14102 @opindex mcsync-anomaly
14103 When enabled, the compiler ensures that the generated code does not
14104 contain CSYNC or SSYNC instructions too soon after conditional branches.
14105 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14107 @item -mno-csync-anomaly
14108 @opindex mno-csync-anomaly
14109 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14110 occurring too soon after a conditional branch.
14112 @item -mlow-64k
14113 @opindex mlow-64k
14114 When enabled, the compiler is free to take advantage of the knowledge that
14115 the entire program fits into the low 64k of memory.
14117 @item -mno-low-64k
14118 @opindex mno-low-64k
14119 Assume that the program is arbitrarily large.  This is the default.
14121 @item -mstack-check-l1
14122 @opindex mstack-check-l1
14123 Do stack checking using information placed into L1 scratchpad memory by the
14124 uClinux kernel.
14126 @item -mid-shared-library
14127 @opindex mid-shared-library
14128 Generate code that supports shared libraries via the library ID method.
14129 This allows for execute in place and shared libraries in an environment
14130 without virtual memory management.  This option implies @option{-fPIC}.
14131 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14133 @item -mno-id-shared-library
14134 @opindex mno-id-shared-library
14135 Generate code that doesn't assume ID-based shared libraries are being used.
14136 This is the default.
14138 @item -mleaf-id-shared-library
14139 @opindex mleaf-id-shared-library
14140 Generate code that supports shared libraries via the library ID method,
14141 but assumes that this library or executable won't link against any other
14142 ID shared libraries.  That allows the compiler to use faster code for jumps
14143 and calls.
14145 @item -mno-leaf-id-shared-library
14146 @opindex mno-leaf-id-shared-library
14147 Do not assume that the code being compiled won't link against any ID shared
14148 libraries.  Slower code is generated for jump and call insns.
14150 @item -mshared-library-id=n
14151 @opindex mshared-library-id
14152 Specifies the identification number of the ID-based shared library being
14153 compiled.  Specifying a value of 0 generates more compact code; specifying
14154 other values forces the allocation of that number to the current
14155 library but is no more space- or time-efficient than omitting this option.
14157 @item -msep-data
14158 @opindex msep-data
14159 Generate code that allows the data segment to be located in a different
14160 area of memory from the text segment.  This allows for execute in place in
14161 an environment without virtual memory management by eliminating relocations
14162 against the text section.
14164 @item -mno-sep-data
14165 @opindex mno-sep-data
14166 Generate code that assumes that the data segment follows the text segment.
14167 This is the default.
14169 @item -mlong-calls
14170 @itemx -mno-long-calls
14171 @opindex mlong-calls
14172 @opindex mno-long-calls
14173 Tells the compiler to perform function calls by first loading the
14174 address of the function into a register and then performing a subroutine
14175 call on this register.  This switch is needed if the target function
14176 lies outside of the 24-bit addressing range of the offset-based
14177 version of subroutine call instruction.
14179 This feature is not enabled by default.  Specifying
14180 @option{-mno-long-calls} restores the default behavior.  Note these
14181 switches have no effect on how the compiler generates code to handle
14182 function calls via function pointers.
14184 @item -mfast-fp
14185 @opindex mfast-fp
14186 Link with the fast floating-point library. This library relaxes some of
14187 the IEEE floating-point standard's rules for checking inputs against
14188 Not-a-Number (NAN), in the interest of performance.
14190 @item -minline-plt
14191 @opindex minline-plt
14192 Enable inlining of PLT entries in function calls to functions that are
14193 not known to bind locally.  It has no effect without @option{-mfdpic}.
14195 @item -mmulticore
14196 @opindex mmulticore
14197 Build a standalone application for multicore Blackfin processors. 
14198 This option causes proper start files and link scripts supporting 
14199 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
14200 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
14202 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
14203 selects the one-application-per-core programming model.  Without
14204 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
14205 programming model is used. In this model, the main function of Core B
14206 should be named as @code{coreb_main}.
14208 If this option is not used, the single-core application programming
14209 model is used.
14211 @item -mcorea
14212 @opindex mcorea
14213 Build a standalone application for Core A of BF561 when using
14214 the one-application-per-core programming model. Proper start files
14215 and link scripts are used to support Core A, and the macro
14216 @code{__BFIN_COREA} is defined.
14217 This option can only be used in conjunction with @option{-mmulticore}.
14219 @item -mcoreb
14220 @opindex mcoreb
14221 Build a standalone application for Core B of BF561 when using
14222 the one-application-per-core programming model. Proper start files
14223 and link scripts are used to support Core B, and the macro
14224 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
14225 should be used instead of @code{main}. 
14226 This option can only be used in conjunction with @option{-mmulticore}.
14228 @item -msdram
14229 @opindex msdram
14230 Build a standalone application for SDRAM. Proper start files and
14231 link scripts are used to put the application into SDRAM, and the macro
14232 @code{__BFIN_SDRAM} is defined.
14233 The loader should initialize SDRAM before loading the application.
14235 @item -micplb
14236 @opindex micplb
14237 Assume that ICPLBs are enabled at run time.  This has an effect on certain
14238 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
14239 are enabled; for standalone applications the default is off.
14240 @end table
14242 @node C6X Options
14243 @subsection C6X Options
14244 @cindex C6X Options
14246 @table @gcctabopt
14247 @item -march=@var{name}
14248 @opindex march
14249 This specifies the name of the target architecture.  GCC uses this
14250 name to determine what kind of instructions it can emit when generating
14251 assembly code.  Permissible names are: @samp{c62x},
14252 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
14254 @item -mbig-endian
14255 @opindex mbig-endian
14256 Generate code for a big-endian target.
14258 @item -mlittle-endian
14259 @opindex mlittle-endian
14260 Generate code for a little-endian target.  This is the default.
14262 @item -msim
14263 @opindex msim
14264 Choose startup files and linker script suitable for the simulator.
14266 @item -msdata=default
14267 @opindex msdata=default
14268 Put small global and static data in the @code{.neardata} section,
14269 which is pointed to by register @code{B14}.  Put small uninitialized
14270 global and static data in the @code{.bss} section, which is adjacent
14271 to the @code{.neardata} section.  Put small read-only data into the
14272 @code{.rodata} section.  The corresponding sections used for large
14273 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
14275 @item -msdata=all
14276 @opindex msdata=all
14277 Put all data, not just small objects, into the sections reserved for
14278 small data, and use addressing relative to the @code{B14} register to
14279 access them.
14281 @item -msdata=none
14282 @opindex msdata=none
14283 Make no use of the sections reserved for small data, and use absolute
14284 addresses to access all data.  Put all initialized global and static
14285 data in the @code{.fardata} section, and all uninitialized data in the
14286 @code{.far} section.  Put all constant data into the @code{.const}
14287 section.
14288 @end table
14290 @node CRIS Options
14291 @subsection CRIS Options
14292 @cindex CRIS Options
14294 These options are defined specifically for the CRIS ports.
14296 @table @gcctabopt
14297 @item -march=@var{architecture-type}
14298 @itemx -mcpu=@var{architecture-type}
14299 @opindex march
14300 @opindex mcpu
14301 Generate code for the specified architecture.  The choices for
14302 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
14303 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
14304 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
14305 @samp{v10}.
14307 @item -mtune=@var{architecture-type}
14308 @opindex mtune
14309 Tune to @var{architecture-type} everything applicable about the generated
14310 code, except for the ABI and the set of available instructions.  The
14311 choices for @var{architecture-type} are the same as for
14312 @option{-march=@var{architecture-type}}.
14314 @item -mmax-stack-frame=@var{n}
14315 @opindex mmax-stack-frame
14316 Warn when the stack frame of a function exceeds @var{n} bytes.
14318 @item -metrax4
14319 @itemx -metrax100
14320 @opindex metrax4
14321 @opindex metrax100
14322 The options @option{-metrax4} and @option{-metrax100} are synonyms for
14323 @option{-march=v3} and @option{-march=v8} respectively.
14325 @item -mmul-bug-workaround
14326 @itemx -mno-mul-bug-workaround
14327 @opindex mmul-bug-workaround
14328 @opindex mno-mul-bug-workaround
14329 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
14330 models where it applies.  This option is active by default.
14332 @item -mpdebug
14333 @opindex mpdebug
14334 Enable CRIS-specific verbose debug-related information in the assembly
14335 code.  This option also has the effect of turning off the @samp{#NO_APP}
14336 formatted-code indicator to the assembler at the beginning of the
14337 assembly file.
14339 @item -mcc-init
14340 @opindex mcc-init
14341 Do not use condition-code results from previous instruction; always emit
14342 compare and test instructions before use of condition codes.
14344 @item -mno-side-effects
14345 @opindex mno-side-effects
14346 Do not emit instructions with side effects in addressing modes other than
14347 post-increment.
14349 @item -mstack-align
14350 @itemx -mno-stack-align
14351 @itemx -mdata-align
14352 @itemx -mno-data-align
14353 @itemx -mconst-align
14354 @itemx -mno-const-align
14355 @opindex mstack-align
14356 @opindex mno-stack-align
14357 @opindex mdata-align
14358 @opindex mno-data-align
14359 @opindex mconst-align
14360 @opindex mno-const-align
14361 These options (@samp{no-} options) arrange (eliminate arrangements) for the
14362 stack frame, individual data and constants to be aligned for the maximum
14363 single data access size for the chosen CPU model.  The default is to
14364 arrange for 32-bit alignment.  ABI details such as structure layout are
14365 not affected by these options.
14367 @item -m32-bit
14368 @itemx -m16-bit
14369 @itemx -m8-bit
14370 @opindex m32-bit
14371 @opindex m16-bit
14372 @opindex m8-bit
14373 Similar to the stack- data- and const-align options above, these options
14374 arrange for stack frame, writable data and constants to all be 32-bit,
14375 16-bit or 8-bit aligned.  The default is 32-bit alignment.
14377 @item -mno-prologue-epilogue
14378 @itemx -mprologue-epilogue
14379 @opindex mno-prologue-epilogue
14380 @opindex mprologue-epilogue
14381 With @option{-mno-prologue-epilogue}, the normal function prologue and
14382 epilogue which set up the stack frame are omitted and no return
14383 instructions or return sequences are generated in the code.  Use this
14384 option only together with visual inspection of the compiled code: no
14385 warnings or errors are generated when call-saved registers must be saved,
14386 or storage for local variables needs to be allocated.
14388 @item -mno-gotplt
14389 @itemx -mgotplt
14390 @opindex mno-gotplt
14391 @opindex mgotplt
14392 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
14393 instruction sequences that load addresses for functions from the PLT part
14394 of the GOT rather than (traditional on other architectures) calls to the
14395 PLT@.  The default is @option{-mgotplt}.
14397 @item -melf
14398 @opindex melf
14399 Legacy no-op option only recognized with the cris-axis-elf and
14400 cris-axis-linux-gnu targets.
14402 @item -mlinux
14403 @opindex mlinux
14404 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
14406 @item -sim
14407 @opindex sim
14408 This option, recognized for the cris-axis-elf, arranges
14409 to link with input-output functions from a simulator library.  Code,
14410 initialized data and zero-initialized data are allocated consecutively.
14412 @item -sim2
14413 @opindex sim2
14414 Like @option{-sim}, but pass linker options to locate initialized data at
14415 0x40000000 and zero-initialized data at 0x80000000.
14416 @end table
14418 @node CR16 Options
14419 @subsection CR16 Options
14420 @cindex CR16 Options
14422 These options are defined specifically for the CR16 ports.
14424 @table @gcctabopt
14426 @item -mmac
14427 @opindex mmac
14428 Enable the use of multiply-accumulate instructions. Disabled by default.
14430 @item -mcr16cplus
14431 @itemx -mcr16c
14432 @opindex mcr16cplus
14433 @opindex mcr16c
14434 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14435 is default.
14437 @item -msim
14438 @opindex msim
14439 Links the library libsim.a which is in compatible with simulator. Applicable
14440 to ELF compiler only.
14442 @item -mint32
14443 @opindex mint32
14444 Choose integer type as 32-bit wide.
14446 @item -mbit-ops
14447 @opindex mbit-ops
14448 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14450 @item -mdata-model=@var{model}
14451 @opindex mdata-model
14452 Choose a data model. The choices for @var{model} are @samp{near},
14453 @samp{far} or @samp{medium}. @samp{medium} is default.
14454 However, @samp{far} is not valid with @option{-mcr16c}, as the
14455 CR16C architecture does not support the far data model.
14456 @end table
14458 @node Darwin Options
14459 @subsection Darwin Options
14460 @cindex Darwin options
14462 These options are defined for all architectures running the Darwin operating
14463 system.
14465 FSF GCC on Darwin does not create ``fat'' object files; it creates
14466 an object file for the single architecture that GCC was built to
14467 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14468 @option{-arch} options are used; it does so by running the compiler or
14469 linker multiple times and joining the results together with
14470 @file{lipo}.
14472 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14473 @samp{i686}) is determined by the flags that specify the ISA
14474 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14475 @option{-force_cpusubtype_ALL} option can be used to override this.
14477 The Darwin tools vary in their behavior when presented with an ISA
14478 mismatch.  The assembler, @file{as}, only permits instructions to
14479 be used that are valid for the subtype of the file it is generating,
14480 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14481 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14482 and prints an error if asked to create a shared library with a less
14483 restrictive subtype than its input files (for instance, trying to put
14484 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14485 for executables, @command{ld}, quietly gives the executable the most
14486 restrictive subtype of any of its input files.
14488 @table @gcctabopt
14489 @item -F@var{dir}
14490 @opindex F
14491 Add the framework directory @var{dir} to the head of the list of
14492 directories to be searched for header files.  These directories are
14493 interleaved with those specified by @option{-I} options and are
14494 scanned in a left-to-right order.
14496 A framework directory is a directory with frameworks in it.  A
14497 framework is a directory with a @file{Headers} and/or
14498 @file{PrivateHeaders} directory contained directly in it that ends
14499 in @file{.framework}.  The name of a framework is the name of this
14500 directory excluding the @file{.framework}.  Headers associated with
14501 the framework are found in one of those two directories, with
14502 @file{Headers} being searched first.  A subframework is a framework
14503 directory that is in a framework's @file{Frameworks} directory.
14504 Includes of subframework headers can only appear in a header of a
14505 framework that contains the subframework, or in a sibling subframework
14506 header.  Two subframeworks are siblings if they occur in the same
14507 framework.  A subframework should not have the same name as a
14508 framework; a warning is issued if this is violated.  Currently a
14509 subframework cannot have subframeworks; in the future, the mechanism
14510 may be extended to support this.  The standard frameworks can be found
14511 in @file{/System/Library/Frameworks} and
14512 @file{/Library/Frameworks}.  An example include looks like
14513 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14514 the name of the framework and @file{header.h} is found in the
14515 @file{PrivateHeaders} or @file{Headers} directory.
14517 @item -iframework@var{dir}
14518 @opindex iframework
14519 Like @option{-F} except the directory is a treated as a system
14520 directory.  The main difference between this @option{-iframework} and
14521 @option{-F} is that with @option{-iframework} the compiler does not
14522 warn about constructs contained within header files found via
14523 @var{dir}.  This option is valid only for the C family of languages.
14525 @item -gused
14526 @opindex gused
14527 Emit debugging information for symbols that are used.  For stabs
14528 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14529 This is by default ON@.
14531 @item -gfull
14532 @opindex gfull
14533 Emit debugging information for all symbols and types.
14535 @item -mmacosx-version-min=@var{version}
14536 The earliest version of MacOS X that this executable will run on
14537 is @var{version}.  Typical values of @var{version} include @code{10.1},
14538 @code{10.2}, and @code{10.3.9}.
14540 If the compiler was built to use the system's headers by default,
14541 then the default for this option is the system version on which the
14542 compiler is running, otherwise the default is to make choices that
14543 are compatible with as many systems and code bases as possible.
14545 @item -mkernel
14546 @opindex mkernel
14547 Enable kernel development mode.  The @option{-mkernel} option sets
14548 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14549 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14550 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14551 applicable.  This mode also sets @option{-mno-altivec},
14552 @option{-msoft-float}, @option{-fno-builtin} and
14553 @option{-mlong-branch} for PowerPC targets.
14555 @item -mone-byte-bool
14556 @opindex mone-byte-bool
14557 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
14558 By default @code{sizeof(bool)} is @code{4} when compiling for
14559 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
14560 option has no effect on x86.
14562 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14563 to generate code that is not binary compatible with code generated
14564 without that switch.  Using this switch may require recompiling all
14565 other modules in a program, including system libraries.  Use this
14566 switch to conform to a non-default data model.
14568 @item -mfix-and-continue
14569 @itemx -ffix-and-continue
14570 @itemx -findirect-data
14571 @opindex mfix-and-continue
14572 @opindex ffix-and-continue
14573 @opindex findirect-data
14574 Generate code suitable for fast turnaround development, such as to
14575 allow GDB to dynamically load @file{.o} files into already-running
14576 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14577 are provided for backwards compatibility.
14579 @item -all_load
14580 @opindex all_load
14581 Loads all members of static archive libraries.
14582 See man ld(1) for more information.
14584 @item -arch_errors_fatal
14585 @opindex arch_errors_fatal
14586 Cause the errors having to do with files that have the wrong architecture
14587 to be fatal.
14589 @item -bind_at_load
14590 @opindex bind_at_load
14591 Causes the output file to be marked such that the dynamic linker will
14592 bind all undefined references when the file is loaded or launched.
14594 @item -bundle
14595 @opindex bundle
14596 Produce a Mach-o bundle format file.
14597 See man ld(1) for more information.
14599 @item -bundle_loader @var{executable}
14600 @opindex bundle_loader
14601 This option specifies the @var{executable} that will load the build
14602 output file being linked.  See man ld(1) for more information.
14604 @item -dynamiclib
14605 @opindex dynamiclib
14606 When passed this option, GCC produces a dynamic library instead of
14607 an executable when linking, using the Darwin @file{libtool} command.
14609 @item -force_cpusubtype_ALL
14610 @opindex force_cpusubtype_ALL
14611 This causes GCC's output file to have the @samp{ALL} subtype, instead of
14612 one controlled by the @option{-mcpu} or @option{-march} option.
14614 @item -allowable_client  @var{client_name}
14615 @itemx -client_name
14616 @itemx -compatibility_version
14617 @itemx -current_version
14618 @itemx -dead_strip
14619 @itemx -dependency-file
14620 @itemx -dylib_file
14621 @itemx -dylinker_install_name
14622 @itemx -dynamic
14623 @itemx -exported_symbols_list
14624 @itemx -filelist
14625 @need 800
14626 @itemx -flat_namespace
14627 @itemx -force_flat_namespace
14628 @itemx -headerpad_max_install_names
14629 @itemx -image_base
14630 @itemx -init
14631 @itemx -install_name
14632 @itemx -keep_private_externs
14633 @itemx -multi_module
14634 @itemx -multiply_defined
14635 @itemx -multiply_defined_unused
14636 @need 800
14637 @itemx -noall_load
14638 @itemx -no_dead_strip_inits_and_terms
14639 @itemx -nofixprebinding
14640 @itemx -nomultidefs
14641 @itemx -noprebind
14642 @itemx -noseglinkedit
14643 @itemx -pagezero_size
14644 @itemx -prebind
14645 @itemx -prebind_all_twolevel_modules
14646 @itemx -private_bundle
14647 @need 800
14648 @itemx -read_only_relocs
14649 @itemx -sectalign
14650 @itemx -sectobjectsymbols
14651 @itemx -whyload
14652 @itemx -seg1addr
14653 @itemx -sectcreate
14654 @itemx -sectobjectsymbols
14655 @itemx -sectorder
14656 @itemx -segaddr
14657 @itemx -segs_read_only_addr
14658 @need 800
14659 @itemx -segs_read_write_addr
14660 @itemx -seg_addr_table
14661 @itemx -seg_addr_table_filename
14662 @itemx -seglinkedit
14663 @itemx -segprot
14664 @itemx -segs_read_only_addr
14665 @itemx -segs_read_write_addr
14666 @itemx -single_module
14667 @itemx -static
14668 @itemx -sub_library
14669 @need 800
14670 @itemx -sub_umbrella
14671 @itemx -twolevel_namespace
14672 @itemx -umbrella
14673 @itemx -undefined
14674 @itemx -unexported_symbols_list
14675 @itemx -weak_reference_mismatches
14676 @itemx -whatsloaded
14677 @opindex allowable_client
14678 @opindex client_name
14679 @opindex compatibility_version
14680 @opindex current_version
14681 @opindex dead_strip
14682 @opindex dependency-file
14683 @opindex dylib_file
14684 @opindex dylinker_install_name
14685 @opindex dynamic
14686 @opindex exported_symbols_list
14687 @opindex filelist
14688 @opindex flat_namespace
14689 @opindex force_flat_namespace
14690 @opindex headerpad_max_install_names
14691 @opindex image_base
14692 @opindex init
14693 @opindex install_name
14694 @opindex keep_private_externs
14695 @opindex multi_module
14696 @opindex multiply_defined
14697 @opindex multiply_defined_unused
14698 @opindex noall_load
14699 @opindex no_dead_strip_inits_and_terms
14700 @opindex nofixprebinding
14701 @opindex nomultidefs
14702 @opindex noprebind
14703 @opindex noseglinkedit
14704 @opindex pagezero_size
14705 @opindex prebind
14706 @opindex prebind_all_twolevel_modules
14707 @opindex private_bundle
14708 @opindex read_only_relocs
14709 @opindex sectalign
14710 @opindex sectobjectsymbols
14711 @opindex whyload
14712 @opindex seg1addr
14713 @opindex sectcreate
14714 @opindex sectobjectsymbols
14715 @opindex sectorder
14716 @opindex segaddr
14717 @opindex segs_read_only_addr
14718 @opindex segs_read_write_addr
14719 @opindex seg_addr_table
14720 @opindex seg_addr_table_filename
14721 @opindex seglinkedit
14722 @opindex segprot
14723 @opindex segs_read_only_addr
14724 @opindex segs_read_write_addr
14725 @opindex single_module
14726 @opindex static
14727 @opindex sub_library
14728 @opindex sub_umbrella
14729 @opindex twolevel_namespace
14730 @opindex umbrella
14731 @opindex undefined
14732 @opindex unexported_symbols_list
14733 @opindex weak_reference_mismatches
14734 @opindex whatsloaded
14735 These options are passed to the Darwin linker.  The Darwin linker man page
14736 describes them in detail.
14737 @end table
14739 @node DEC Alpha Options
14740 @subsection DEC Alpha Options
14742 These @samp{-m} options are defined for the DEC Alpha implementations:
14744 @table @gcctabopt
14745 @item -mno-soft-float
14746 @itemx -msoft-float
14747 @opindex mno-soft-float
14748 @opindex msoft-float
14749 Use (do not use) the hardware floating-point instructions for
14750 floating-point operations.  When @option{-msoft-float} is specified,
14751 functions in @file{libgcc.a} are used to perform floating-point
14752 operations.  Unless they are replaced by routines that emulate the
14753 floating-point operations, or compiled in such a way as to call such
14754 emulations routines, these routines issue floating-point
14755 operations.   If you are compiling for an Alpha without floating-point
14756 operations, you must ensure that the library is built so as not to call
14757 them.
14759 Note that Alpha implementations without floating-point operations are
14760 required to have floating-point registers.
14762 @item -mfp-reg
14763 @itemx -mno-fp-regs
14764 @opindex mfp-reg
14765 @opindex mno-fp-regs
14766 Generate code that uses (does not use) the floating-point register set.
14767 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14768 register set is not used, floating-point operands are passed in integer
14769 registers as if they were integers and floating-point results are passed
14770 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14771 so any function with a floating-point argument or return value called by code
14772 compiled with @option{-mno-fp-regs} must also be compiled with that
14773 option.
14775 A typical use of this option is building a kernel that does not use,
14776 and hence need not save and restore, any floating-point registers.
14778 @item -mieee
14779 @opindex mieee
14780 The Alpha architecture implements floating-point hardware optimized for
14781 maximum performance.  It is mostly compliant with the IEEE floating-point
14782 standard.  However, for full compliance, software assistance is
14783 required.  This option generates code fully IEEE-compliant code
14784 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14785 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14786 defined during compilation.  The resulting code is less efficient but is
14787 able to correctly support denormalized numbers and exceptional IEEE
14788 values such as not-a-number and plus/minus infinity.  Other Alpha
14789 compilers call this option @option{-ieee_with_no_inexact}.
14791 @item -mieee-with-inexact
14792 @opindex mieee-with-inexact
14793 This is like @option{-mieee} except the generated code also maintains
14794 the IEEE @var{inexact-flag}.  Turning on this option causes the
14795 generated code to implement fully-compliant IEEE math.  In addition to
14796 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14797 macro.  On some Alpha implementations the resulting code may execute
14798 significantly slower than the code generated by default.  Since there is
14799 very little code that depends on the @var{inexact-flag}, you should
14800 normally not specify this option.  Other Alpha compilers call this
14801 option @option{-ieee_with_inexact}.
14803 @item -mfp-trap-mode=@var{trap-mode}
14804 @opindex mfp-trap-mode
14805 This option controls what floating-point related traps are enabled.
14806 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14807 The trap mode can be set to one of four values:
14809 @table @samp
14810 @item n
14811 This is the default (normal) setting.  The only traps that are enabled
14812 are the ones that cannot be disabled in software (e.g., division by zero
14813 trap).
14815 @item u
14816 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14817 as well.
14819 @item su
14820 Like @samp{u}, but the instructions are marked to be safe for software
14821 completion (see Alpha architecture manual for details).
14823 @item sui
14824 Like @samp{su}, but inexact traps are enabled as well.
14825 @end table
14827 @item -mfp-rounding-mode=@var{rounding-mode}
14828 @opindex mfp-rounding-mode
14829 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14830 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14833 @table @samp
14834 @item n
14835 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14836 the nearest machine number or towards the even machine number in case
14837 of a tie.
14839 @item m
14840 Round towards minus infinity.
14842 @item c
14843 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14845 @item d
14846 Dynamic rounding mode.  A field in the floating-point control register
14847 (@var{fpcr}, see Alpha architecture reference manual) controls the
14848 rounding mode in effect.  The C library initializes this register for
14849 rounding towards plus infinity.  Thus, unless your program modifies the
14850 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14851 @end table
14853 @item -mtrap-precision=@var{trap-precision}
14854 @opindex mtrap-precision
14855 In the Alpha architecture, floating-point traps are imprecise.  This
14856 means without software assistance it is impossible to recover from a
14857 floating trap and program execution normally needs to be terminated.
14858 GCC can generate code that can assist operating system trap handlers
14859 in determining the exact location that caused a floating-point trap.
14860 Depending on the requirements of an application, different levels of
14861 precisions can be selected:
14863 @table @samp
14864 @item p
14865 Program precision.  This option is the default and means a trap handler
14866 can only identify which program caused a floating-point exception.
14868 @item f
14869 Function precision.  The trap handler can determine the function that
14870 caused a floating-point exception.
14872 @item i
14873 Instruction precision.  The trap handler can determine the exact
14874 instruction that caused a floating-point exception.
14875 @end table
14877 Other Alpha compilers provide the equivalent options called
14878 @option{-scope_safe} and @option{-resumption_safe}.
14880 @item -mieee-conformant
14881 @opindex mieee-conformant
14882 This option marks the generated code as IEEE conformant.  You must not
14883 use this option unless you also specify @option{-mtrap-precision=i} and either
14884 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14885 is to emit the line @samp{.eflag 48} in the function prologue of the
14886 generated assembly file.
14888 @item -mbuild-constants
14889 @opindex mbuild-constants
14890 Normally GCC examines a 32- or 64-bit integer constant to
14891 see if it can construct it from smaller constants in two or three
14892 instructions.  If it cannot, it outputs the constant as a literal and
14893 generates code to load it from the data segment at run time.
14895 Use this option to require GCC to construct @emph{all} integer constants
14896 using code, even if it takes more instructions (the maximum is six).
14898 You typically use this option to build a shared library dynamic
14899 loader.  Itself a shared library, it must relocate itself in memory
14900 before it can find the variables and constants in its own data segment.
14902 @item -mbwx
14903 @itemx -mno-bwx
14904 @itemx -mcix
14905 @itemx -mno-cix
14906 @itemx -mfix
14907 @itemx -mno-fix
14908 @itemx -mmax
14909 @itemx -mno-max
14910 @opindex mbwx
14911 @opindex mno-bwx
14912 @opindex mcix
14913 @opindex mno-cix
14914 @opindex mfix
14915 @opindex mno-fix
14916 @opindex mmax
14917 @opindex mno-max
14918 Indicate whether GCC should generate code to use the optional BWX,
14919 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14920 sets supported by the CPU type specified via @option{-mcpu=} option or that
14921 of the CPU on which GCC was built if none is specified.
14923 @item -mfloat-vax
14924 @itemx -mfloat-ieee
14925 @opindex mfloat-vax
14926 @opindex mfloat-ieee
14927 Generate code that uses (does not use) VAX F and G floating-point
14928 arithmetic instead of IEEE single and double precision.
14930 @item -mexplicit-relocs
14931 @itemx -mno-explicit-relocs
14932 @opindex mexplicit-relocs
14933 @opindex mno-explicit-relocs
14934 Older Alpha assemblers provided no way to generate symbol relocations
14935 except via assembler macros.  Use of these macros does not allow
14936 optimal instruction scheduling.  GNU binutils as of version 2.12
14937 supports a new syntax that allows the compiler to explicitly mark
14938 which relocations should apply to which instructions.  This option
14939 is mostly useful for debugging, as GCC detects the capabilities of
14940 the assembler when it is built and sets the default accordingly.
14942 @item -msmall-data
14943 @itemx -mlarge-data
14944 @opindex msmall-data
14945 @opindex mlarge-data
14946 When @option{-mexplicit-relocs} is in effect, static data is
14947 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14948 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14949 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14950 16-bit relocations off of the @code{$gp} register.  This limits the
14951 size of the small data area to 64KB, but allows the variables to be
14952 directly accessed via a single instruction.
14954 The default is @option{-mlarge-data}.  With this option the data area
14955 is limited to just below 2GB@.  Programs that require more than 2GB of
14956 data must use @code{malloc} or @code{mmap} to allocate the data in the
14957 heap instead of in the program's data segment.
14959 When generating code for shared libraries, @option{-fpic} implies
14960 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14962 @item -msmall-text
14963 @itemx -mlarge-text
14964 @opindex msmall-text
14965 @opindex mlarge-text
14966 When @option{-msmall-text} is used, the compiler assumes that the
14967 code of the entire program (or shared library) fits in 4MB, and is
14968 thus reachable with a branch instruction.  When @option{-msmall-data}
14969 is used, the compiler can assume that all local symbols share the
14970 same @code{$gp} value, and thus reduce the number of instructions
14971 required for a function call from 4 to 1.
14973 The default is @option{-mlarge-text}.
14975 @item -mcpu=@var{cpu_type}
14976 @opindex mcpu
14977 Set the instruction set and instruction scheduling parameters for
14978 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14979 style name or the corresponding chip number.  GCC supports scheduling
14980 parameters for the EV4, EV5 and EV6 family of processors and
14981 chooses the default values for the instruction set from the processor
14982 you specify.  If you do not specify a processor type, GCC defaults
14983 to the processor on which the compiler was built.
14985 Supported values for @var{cpu_type} are
14987 @table @samp
14988 @item ev4
14989 @itemx ev45
14990 @itemx 21064
14991 Schedules as an EV4 and has no instruction set extensions.
14993 @item ev5
14994 @itemx 21164
14995 Schedules as an EV5 and has no instruction set extensions.
14997 @item ev56
14998 @itemx 21164a
14999 Schedules as an EV5 and supports the BWX extension.
15001 @item pca56
15002 @itemx 21164pc
15003 @itemx 21164PC
15004 Schedules as an EV5 and supports the BWX and MAX extensions.
15006 @item ev6
15007 @itemx 21264
15008 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
15010 @item ev67
15011 @itemx 21264a
15012 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
15013 @end table
15015 Native toolchains also support the value @samp{native},
15016 which selects the best architecture option for the host processor.
15017 @option{-mcpu=native} has no effect if GCC does not recognize
15018 the processor.
15020 @item -mtune=@var{cpu_type}
15021 @opindex mtune
15022 Set only the instruction scheduling parameters for machine type
15023 @var{cpu_type}.  The instruction set is not changed.
15025 Native toolchains also support the value @samp{native},
15026 which selects the best architecture option for the host processor.
15027 @option{-mtune=native} has no effect if GCC does not recognize
15028 the processor.
15030 @item -mmemory-latency=@var{time}
15031 @opindex mmemory-latency
15032 Sets the latency the scheduler should assume for typical memory
15033 references as seen by the application.  This number is highly
15034 dependent on the memory access patterns used by the application
15035 and the size of the external cache on the machine.
15037 Valid options for @var{time} are
15039 @table @samp
15040 @item @var{number}
15041 A decimal number representing clock cycles.
15043 @item L1
15044 @itemx L2
15045 @itemx L3
15046 @itemx main
15047 The compiler contains estimates of the number of clock cycles for
15048 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15049 (also called Dcache, Scache, and Bcache), as well as to main memory.
15050 Note that L3 is only valid for EV5.
15052 @end table
15053 @end table
15055 @node FR30 Options
15056 @subsection FR30 Options
15057 @cindex FR30 Options
15059 These options are defined specifically for the FR30 port.
15061 @table @gcctabopt
15063 @item -msmall-model
15064 @opindex msmall-model
15065 Use the small address space model.  This can produce smaller code, but
15066 it does assume that all symbolic values and addresses fit into a
15067 20-bit range.
15069 @item -mno-lsim
15070 @opindex mno-lsim
15071 Assume that runtime support has been provided and so there is no need
15072 to include the simulator library (@file{libsim.a}) on the linker
15073 command line.
15075 @end table
15077 @node FT32 Options
15078 @subsection FT32 Options
15079 @cindex FT32 Options
15081 These options are defined specifically for the FT32 port.
15083 @table @gcctabopt
15085 @item -msim
15086 @opindex msim
15087 Specifies that the program will be run on the simulator.  This causes
15088 an alternate runtime startup and library to be linked.
15089 You must not use this option when generating programs that will run on
15090 real hardware; you must provide your own runtime library for whatever
15091 I/O functions are needed.
15093 @item -mlra
15094 @opindex mlra
15095 Enable Local Register Allocation.  This is still experimental for FT32,
15096 so by default the compiler uses standard reload.
15098 @end table
15100 @node FRV Options
15101 @subsection FRV Options
15102 @cindex FRV Options
15104 @table @gcctabopt
15105 @item -mgpr-32
15106 @opindex mgpr-32
15108 Only use the first 32 general-purpose registers.
15110 @item -mgpr-64
15111 @opindex mgpr-64
15113 Use all 64 general-purpose registers.
15115 @item -mfpr-32
15116 @opindex mfpr-32
15118 Use only the first 32 floating-point registers.
15120 @item -mfpr-64
15121 @opindex mfpr-64
15123 Use all 64 floating-point registers.
15125 @item -mhard-float
15126 @opindex mhard-float
15128 Use hardware instructions for floating-point operations.
15130 @item -msoft-float
15131 @opindex msoft-float
15133 Use library routines for floating-point operations.
15135 @item -malloc-cc
15136 @opindex malloc-cc
15138 Dynamically allocate condition code registers.
15140 @item -mfixed-cc
15141 @opindex mfixed-cc
15143 Do not try to dynamically allocate condition code registers, only
15144 use @code{icc0} and @code{fcc0}.
15146 @item -mdword
15147 @opindex mdword
15149 Change ABI to use double word insns.
15151 @item -mno-dword
15152 @opindex mno-dword
15154 Do not use double word instructions.
15156 @item -mdouble
15157 @opindex mdouble
15159 Use floating-point double instructions.
15161 @item -mno-double
15162 @opindex mno-double
15164 Do not use floating-point double instructions.
15166 @item -mmedia
15167 @opindex mmedia
15169 Use media instructions.
15171 @item -mno-media
15172 @opindex mno-media
15174 Do not use media instructions.
15176 @item -mmuladd
15177 @opindex mmuladd
15179 Use multiply and add/subtract instructions.
15181 @item -mno-muladd
15182 @opindex mno-muladd
15184 Do not use multiply and add/subtract instructions.
15186 @item -mfdpic
15187 @opindex mfdpic
15189 Select the FDPIC ABI, which uses function descriptors to represent
15190 pointers to functions.  Without any PIC/PIE-related options, it
15191 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
15192 assumes GOT entries and small data are within a 12-bit range from the
15193 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
15194 are computed with 32 bits.
15195 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15197 @item -minline-plt
15198 @opindex minline-plt
15200 Enable inlining of PLT entries in function calls to functions that are
15201 not known to bind locally.  It has no effect without @option{-mfdpic}.
15202 It's enabled by default if optimizing for speed and compiling for
15203 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
15204 optimization option such as @option{-O3} or above is present in the
15205 command line.
15207 @item -mTLS
15208 @opindex mTLS
15210 Assume a large TLS segment when generating thread-local code.
15212 @item -mtls
15213 @opindex mtls
15215 Do not assume a large TLS segment when generating thread-local code.
15217 @item -mgprel-ro
15218 @opindex mgprel-ro
15220 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
15221 that is known to be in read-only sections.  It's enabled by default,
15222 except for @option{-fpic} or @option{-fpie}: even though it may help
15223 make the global offset table smaller, it trades 1 instruction for 4.
15224 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
15225 one of which may be shared by multiple symbols, and it avoids the need
15226 for a GOT entry for the referenced symbol, so it's more likely to be a
15227 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
15229 @item -multilib-library-pic
15230 @opindex multilib-library-pic
15232 Link with the (library, not FD) pic libraries.  It's implied by
15233 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
15234 @option{-fpic} without @option{-mfdpic}.  You should never have to use
15235 it explicitly.
15237 @item -mlinked-fp
15238 @opindex mlinked-fp
15240 Follow the EABI requirement of always creating a frame pointer whenever
15241 a stack frame is allocated.  This option is enabled by default and can
15242 be disabled with @option{-mno-linked-fp}.
15244 @item -mlong-calls
15245 @opindex mlong-calls
15247 Use indirect addressing to call functions outside the current
15248 compilation unit.  This allows the functions to be placed anywhere
15249 within the 32-bit address space.
15251 @item -malign-labels
15252 @opindex malign-labels
15254 Try to align labels to an 8-byte boundary by inserting NOPs into the
15255 previous packet.  This option only has an effect when VLIW packing
15256 is enabled.  It doesn't create new packets; it merely adds NOPs to
15257 existing ones.
15259 @item -mlibrary-pic
15260 @opindex mlibrary-pic
15262 Generate position-independent EABI code.
15264 @item -macc-4
15265 @opindex macc-4
15267 Use only the first four media accumulator registers.
15269 @item -macc-8
15270 @opindex macc-8
15272 Use all eight media accumulator registers.
15274 @item -mpack
15275 @opindex mpack
15277 Pack VLIW instructions.
15279 @item -mno-pack
15280 @opindex mno-pack
15282 Do not pack VLIW instructions.
15284 @item -mno-eflags
15285 @opindex mno-eflags
15287 Do not mark ABI switches in e_flags.
15289 @item -mcond-move
15290 @opindex mcond-move
15292 Enable the use of conditional-move instructions (default).
15294 This switch is mainly for debugging the compiler and will likely be removed
15295 in a future version.
15297 @item -mno-cond-move
15298 @opindex mno-cond-move
15300 Disable the use of conditional-move instructions.
15302 This switch is mainly for debugging the compiler and will likely be removed
15303 in a future version.
15305 @item -mscc
15306 @opindex mscc
15308 Enable the use of conditional set instructions (default).
15310 This switch is mainly for debugging the compiler and will likely be removed
15311 in a future version.
15313 @item -mno-scc
15314 @opindex mno-scc
15316 Disable the use of conditional set instructions.
15318 This switch is mainly for debugging the compiler and will likely be removed
15319 in a future version.
15321 @item -mcond-exec
15322 @opindex mcond-exec
15324 Enable the use of conditional execution (default).
15326 This switch is mainly for debugging the compiler and will likely be removed
15327 in a future version.
15329 @item -mno-cond-exec
15330 @opindex mno-cond-exec
15332 Disable the use of conditional execution.
15334 This switch is mainly for debugging the compiler and will likely be removed
15335 in a future version.
15337 @item -mvliw-branch
15338 @opindex mvliw-branch
15340 Run a pass to pack branches into VLIW instructions (default).
15342 This switch is mainly for debugging the compiler and will likely be removed
15343 in a future version.
15345 @item -mno-vliw-branch
15346 @opindex mno-vliw-branch
15348 Do not run a pass to pack branches into VLIW instructions.
15350 This switch is mainly for debugging the compiler and will likely be removed
15351 in a future version.
15353 @item -mmulti-cond-exec
15354 @opindex mmulti-cond-exec
15356 Enable optimization of @code{&&} and @code{||} in conditional execution
15357 (default).
15359 This switch is mainly for debugging the compiler and will likely be removed
15360 in a future version.
15362 @item -mno-multi-cond-exec
15363 @opindex mno-multi-cond-exec
15365 Disable optimization of @code{&&} and @code{||} in conditional execution.
15367 This switch is mainly for debugging the compiler and will likely be removed
15368 in a future version.
15370 @item -mnested-cond-exec
15371 @opindex mnested-cond-exec
15373 Enable nested conditional execution optimizations (default).
15375 This switch is mainly for debugging the compiler and will likely be removed
15376 in a future version.
15378 @item -mno-nested-cond-exec
15379 @opindex mno-nested-cond-exec
15381 Disable nested conditional execution optimizations.
15383 This switch is mainly for debugging the compiler and will likely be removed
15384 in a future version.
15386 @item -moptimize-membar
15387 @opindex moptimize-membar
15389 This switch removes redundant @code{membar} instructions from the
15390 compiler-generated code.  It is enabled by default.
15392 @item -mno-optimize-membar
15393 @opindex mno-optimize-membar
15395 This switch disables the automatic removal of redundant @code{membar}
15396 instructions from the generated code.
15398 @item -mtomcat-stats
15399 @opindex mtomcat-stats
15401 Cause gas to print out tomcat statistics.
15403 @item -mcpu=@var{cpu}
15404 @opindex mcpu
15406 Select the processor type for which to generate code.  Possible values are
15407 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
15408 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
15410 @end table
15412 @node GNU/Linux Options
15413 @subsection GNU/Linux Options
15415 These @samp{-m} options are defined for GNU/Linux targets:
15417 @table @gcctabopt
15418 @item -mglibc
15419 @opindex mglibc
15420 Use the GNU C library.  This is the default except
15421 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
15422 @samp{*-*-linux-*android*} targets.
15424 @item -muclibc
15425 @opindex muclibc
15426 Use uClibc C library.  This is the default on
15427 @samp{*-*-linux-*uclibc*} targets.
15429 @item -mmusl
15430 @opindex mmusl
15431 Use the musl C library.  This is the default on
15432 @samp{*-*-linux-*musl*} targets.
15434 @item -mbionic
15435 @opindex mbionic
15436 Use Bionic C library.  This is the default on
15437 @samp{*-*-linux-*android*} targets.
15439 @item -mandroid
15440 @opindex mandroid
15441 Compile code compatible with Android platform.  This is the default on
15442 @samp{*-*-linux-*android*} targets.
15444 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15445 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15446 this option makes the GCC driver pass Android-specific options to the linker.
15447 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15448 to be defined.
15450 @item -tno-android-cc
15451 @opindex tno-android-cc
15452 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15453 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15454 @option{-fno-rtti} by default.
15456 @item -tno-android-ld
15457 @opindex tno-android-ld
15458 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15459 linking options to the linker.
15461 @end table
15463 @node H8/300 Options
15464 @subsection H8/300 Options
15466 These @samp{-m} options are defined for the H8/300 implementations:
15468 @table @gcctabopt
15469 @item -mrelax
15470 @opindex mrelax
15471 Shorten some address references at link time, when possible; uses the
15472 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15473 ld, Using ld}, for a fuller description.
15475 @item -mh
15476 @opindex mh
15477 Generate code for the H8/300H@.
15479 @item -ms
15480 @opindex ms
15481 Generate code for the H8S@.
15483 @item -mn
15484 @opindex mn
15485 Generate code for the H8S and H8/300H in the normal mode.  This switch
15486 must be used either with @option{-mh} or @option{-ms}.
15488 @item -ms2600
15489 @opindex ms2600
15490 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15492 @item -mexr
15493 @opindex mexr
15494 Extended registers are stored on stack before execution of function
15495 with monitor attribute. Default option is @option{-mexr}.
15496 This option is valid only for H8S targets.
15498 @item -mno-exr
15499 @opindex mno-exr
15500 Extended registers are not stored on stack before execution of function 
15501 with monitor attribute. Default option is @option{-mno-exr}. 
15502 This option is valid only for H8S targets.
15504 @item -mint32
15505 @opindex mint32
15506 Make @code{int} data 32 bits by default.
15508 @item -malign-300
15509 @opindex malign-300
15510 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15511 The default for the H8/300H and H8S is to align longs and floats on
15512 4-byte boundaries.
15513 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15514 This option has no effect on the H8/300.
15515 @end table
15517 @node HPPA Options
15518 @subsection HPPA Options
15519 @cindex HPPA Options
15521 These @samp{-m} options are defined for the HPPA family of computers:
15523 @table @gcctabopt
15524 @item -march=@var{architecture-type}
15525 @opindex march
15526 Generate code for the specified architecture.  The choices for
15527 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15528 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15529 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15530 architecture option for your machine.  Code compiled for lower numbered
15531 architectures runs on higher numbered architectures, but not the
15532 other way around.
15534 @item -mpa-risc-1-0
15535 @itemx -mpa-risc-1-1
15536 @itemx -mpa-risc-2-0
15537 @opindex mpa-risc-1-0
15538 @opindex mpa-risc-1-1
15539 @opindex mpa-risc-2-0
15540 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15542 @item -mjump-in-delay
15543 @opindex mjump-in-delay
15544 This option is ignored and provided for compatibility purposes only.
15546 @item -mdisable-fpregs
15547 @opindex mdisable-fpregs
15548 Prevent floating-point registers from being used in any manner.  This is
15549 necessary for compiling kernels that perform lazy context switching of
15550 floating-point registers.  If you use this option and attempt to perform
15551 floating-point operations, the compiler aborts.
15553 @item -mdisable-indexing
15554 @opindex mdisable-indexing
15555 Prevent the compiler from using indexing address modes.  This avoids some
15556 rather obscure problems when compiling MIG generated code under MACH@.
15558 @item -mno-space-regs
15559 @opindex mno-space-regs
15560 Generate code that assumes the target has no space registers.  This allows
15561 GCC to generate faster indirect calls and use unscaled index address modes.
15563 Such code is suitable for level 0 PA systems and kernels.
15565 @item -mfast-indirect-calls
15566 @opindex mfast-indirect-calls
15567 Generate code that assumes calls never cross space boundaries.  This
15568 allows GCC to emit code that performs faster indirect calls.
15570 This option does not work in the presence of shared libraries or nested
15571 functions.
15573 @item -mfixed-range=@var{register-range}
15574 @opindex mfixed-range
15575 Generate code treating the given register range as fixed registers.
15576 A fixed register is one that the register allocator cannot use.  This is
15577 useful when compiling kernel code.  A register range is specified as
15578 two registers separated by a dash.  Multiple register ranges can be
15579 specified separated by a comma.
15581 @item -mlong-load-store
15582 @opindex mlong-load-store
15583 Generate 3-instruction load and store sequences as sometimes required by
15584 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15585 the HP compilers.
15587 @item -mportable-runtime
15588 @opindex mportable-runtime
15589 Use the portable calling conventions proposed by HP for ELF systems.
15591 @item -mgas
15592 @opindex mgas
15593 Enable the use of assembler directives only GAS understands.
15595 @item -mschedule=@var{cpu-type}
15596 @opindex mschedule
15597 Schedule code according to the constraints for the machine type
15598 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15599 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15600 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15601 proper scheduling option for your machine.  The default scheduling is
15602 @samp{8000}.
15604 @item -mlinker-opt
15605 @opindex mlinker-opt
15606 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15607 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15608 linkers in which they give bogus error messages when linking some programs.
15610 @item -msoft-float
15611 @opindex msoft-float
15612 Generate output containing library calls for floating point.
15613 @strong{Warning:} the requisite libraries are not available for all HPPA
15614 targets.  Normally the facilities of the machine's usual C compiler are
15615 used, but this cannot be done directly in cross-compilation.  You must make
15616 your own arrangements to provide suitable library functions for
15617 cross-compilation.
15619 @option{-msoft-float} changes the calling convention in the output file;
15620 therefore, it is only useful if you compile @emph{all} of a program with
15621 this option.  In particular, you need to compile @file{libgcc.a}, the
15622 library that comes with GCC, with @option{-msoft-float} in order for
15623 this to work.
15625 @item -msio
15626 @opindex msio
15627 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15628 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15629 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15630 options are available under HP-UX and HI-UX@.
15632 @item -mgnu-ld
15633 @opindex mgnu-ld
15634 Use options specific to GNU @command{ld}.
15635 This passes @option{-shared} to @command{ld} when
15636 building a shared library.  It is the default when GCC is configured,
15637 explicitly or implicitly, with the GNU linker.  This option does not
15638 affect which @command{ld} is called; it only changes what parameters
15639 are passed to that @command{ld}.
15640 The @command{ld} that is called is determined by the
15641 @option{--with-ld} configure option, GCC's program search path, and
15642 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15643 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15644 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15646 @item -mhp-ld
15647 @opindex mhp-ld
15648 Use options specific to HP @command{ld}.
15649 This passes @option{-b} to @command{ld} when building
15650 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15651 links.  It is the default when GCC is configured, explicitly or
15652 implicitly, with the HP linker.  This option does not affect
15653 which @command{ld} is called; it only changes what parameters are passed to that
15654 @command{ld}.
15655 The @command{ld} that is called is determined by the @option{--with-ld}
15656 configure option, GCC's program search path, and finally by the user's
15657 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15658 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15659 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15661 @item -mlong-calls
15662 @opindex mno-long-calls
15663 Generate code that uses long call sequences.  This ensures that a call
15664 is always able to reach linker generated stubs.  The default is to generate
15665 long calls only when the distance from the call site to the beginning
15666 of the function or translation unit, as the case may be, exceeds a
15667 predefined limit set by the branch type being used.  The limits for
15668 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15669 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15670 240,000 bytes.
15672 Distances are measured from the beginning of functions when using the
15673 @option{-ffunction-sections} option, or when using the @option{-mgas}
15674 and @option{-mno-portable-runtime} options together under HP-UX with
15675 the SOM linker.
15677 It is normally not desirable to use this option as it degrades
15678 performance.  However, it may be useful in large applications,
15679 particularly when partial linking is used to build the application.
15681 The types of long calls used depends on the capabilities of the
15682 assembler and linker, and the type of code being generated.  The
15683 impact on systems that support long absolute calls, and long pic
15684 symbol-difference or pc-relative calls should be relatively small.
15685 However, an indirect call is used on 32-bit ELF systems in pic code
15686 and it is quite long.
15688 @item -munix=@var{unix-std}
15689 @opindex march
15690 Generate compiler predefines and select a startfile for the specified
15691 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15692 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15693 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15694 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15695 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15696 and later.
15698 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15699 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15700 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15701 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15702 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15703 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15705 It is @emph{important} to note that this option changes the interfaces
15706 for various library routines.  It also affects the operational behavior
15707 of the C library.  Thus, @emph{extreme} care is needed in using this
15708 option.
15710 Library code that is intended to operate with more than one UNIX
15711 standard must test, set and restore the variable @code{__xpg4_extended_mask}
15712 as appropriate.  Most GNU software doesn't provide this capability.
15714 @item -nolibdld
15715 @opindex nolibdld
15716 Suppress the generation of link options to search libdld.sl when the
15717 @option{-static} option is specified on HP-UX 10 and later.
15719 @item -static
15720 @opindex static
15721 The HP-UX implementation of setlocale in libc has a dependency on
15722 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15723 when the @option{-static} option is specified, special link options
15724 are needed to resolve this dependency.
15726 On HP-UX 10 and later, the GCC driver adds the necessary options to
15727 link with libdld.sl when the @option{-static} option is specified.
15728 This causes the resulting binary to be dynamic.  On the 64-bit port,
15729 the linkers generate dynamic binaries by default in any case.  The
15730 @option{-nolibdld} option can be used to prevent the GCC driver from
15731 adding these link options.
15733 @item -threads
15734 @opindex threads
15735 Add support for multithreading with the @dfn{dce thread} library
15736 under HP-UX@.  This option sets flags for both the preprocessor and
15737 linker.
15738 @end table
15740 @node IA-64 Options
15741 @subsection IA-64 Options
15742 @cindex IA-64 Options
15744 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15746 @table @gcctabopt
15747 @item -mbig-endian
15748 @opindex mbig-endian
15749 Generate code for a big-endian target.  This is the default for HP-UX@.
15751 @item -mlittle-endian
15752 @opindex mlittle-endian
15753 Generate code for a little-endian target.  This is the default for AIX5
15754 and GNU/Linux.
15756 @item -mgnu-as
15757 @itemx -mno-gnu-as
15758 @opindex mgnu-as
15759 @opindex mno-gnu-as
15760 Generate (or don't) code for the GNU assembler.  This is the default.
15761 @c Also, this is the default if the configure option @option{--with-gnu-as}
15762 @c is used.
15764 @item -mgnu-ld
15765 @itemx -mno-gnu-ld
15766 @opindex mgnu-ld
15767 @opindex mno-gnu-ld
15768 Generate (or don't) code for the GNU linker.  This is the default.
15769 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15770 @c is used.
15772 @item -mno-pic
15773 @opindex mno-pic
15774 Generate code that does not use a global pointer register.  The result
15775 is not position independent code, and violates the IA-64 ABI@.
15777 @item -mvolatile-asm-stop
15778 @itemx -mno-volatile-asm-stop
15779 @opindex mvolatile-asm-stop
15780 @opindex mno-volatile-asm-stop
15781 Generate (or don't) a stop bit immediately before and after volatile asm
15782 statements.
15784 @item -mregister-names
15785 @itemx -mno-register-names
15786 @opindex mregister-names
15787 @opindex mno-register-names
15788 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15789 the stacked registers.  This may make assembler output more readable.
15791 @item -mno-sdata
15792 @itemx -msdata
15793 @opindex mno-sdata
15794 @opindex msdata
15795 Disable (or enable) optimizations that use the small data section.  This may
15796 be useful for working around optimizer bugs.
15798 @item -mconstant-gp
15799 @opindex mconstant-gp
15800 Generate code that uses a single constant global pointer value.  This is
15801 useful when compiling kernel code.
15803 @item -mauto-pic
15804 @opindex mauto-pic
15805 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15806 This is useful when compiling firmware code.
15808 @item -minline-float-divide-min-latency
15809 @opindex minline-float-divide-min-latency
15810 Generate code for inline divides of floating-point values
15811 using the minimum latency algorithm.
15813 @item -minline-float-divide-max-throughput
15814 @opindex minline-float-divide-max-throughput
15815 Generate code for inline divides of floating-point values
15816 using the maximum throughput algorithm.
15818 @item -mno-inline-float-divide
15819 @opindex mno-inline-float-divide
15820 Do not generate inline code for divides of floating-point values.
15822 @item -minline-int-divide-min-latency
15823 @opindex minline-int-divide-min-latency
15824 Generate code for inline divides of integer values
15825 using the minimum latency algorithm.
15827 @item -minline-int-divide-max-throughput
15828 @opindex minline-int-divide-max-throughput
15829 Generate code for inline divides of integer values
15830 using the maximum throughput algorithm.
15832 @item -mno-inline-int-divide
15833 @opindex mno-inline-int-divide
15834 Do not generate inline code for divides of integer values.
15836 @item -minline-sqrt-min-latency
15837 @opindex minline-sqrt-min-latency
15838 Generate code for inline square roots
15839 using the minimum latency algorithm.
15841 @item -minline-sqrt-max-throughput
15842 @opindex minline-sqrt-max-throughput
15843 Generate code for inline square roots
15844 using the maximum throughput algorithm.
15846 @item -mno-inline-sqrt
15847 @opindex mno-inline-sqrt
15848 Do not generate inline code for @code{sqrt}.
15850 @item -mfused-madd
15851 @itemx -mno-fused-madd
15852 @opindex mfused-madd
15853 @opindex mno-fused-madd
15854 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
15855 instructions.  The default is to use these instructions.
15857 @item -mno-dwarf2-asm
15858 @itemx -mdwarf2-asm
15859 @opindex mno-dwarf2-asm
15860 @opindex mdwarf2-asm
15861 Don't (or do) generate assembler code for the DWARF 2 line number debugging
15862 info.  This may be useful when not using the GNU assembler.
15864 @item -mearly-stop-bits
15865 @itemx -mno-early-stop-bits
15866 @opindex mearly-stop-bits
15867 @opindex mno-early-stop-bits
15868 Allow stop bits to be placed earlier than immediately preceding the
15869 instruction that triggered the stop bit.  This can improve instruction
15870 scheduling, but does not always do so.
15872 @item -mfixed-range=@var{register-range}
15873 @opindex mfixed-range
15874 Generate code treating the given register range as fixed registers.
15875 A fixed register is one that the register allocator cannot use.  This is
15876 useful when compiling kernel code.  A register range is specified as
15877 two registers separated by a dash.  Multiple register ranges can be
15878 specified separated by a comma.
15880 @item -mtls-size=@var{tls-size}
15881 @opindex mtls-size
15882 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
15885 @item -mtune=@var{cpu-type}
15886 @opindex mtune
15887 Tune the instruction scheduling for a particular CPU, Valid values are
15888 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15889 and @samp{mckinley}.
15891 @item -milp32
15892 @itemx -mlp64
15893 @opindex milp32
15894 @opindex mlp64
15895 Generate code for a 32-bit or 64-bit environment.
15896 The 32-bit environment sets int, long and pointer to 32 bits.
15897 The 64-bit environment sets int to 32 bits and long and pointer
15898 to 64 bits.  These are HP-UX specific flags.
15900 @item -mno-sched-br-data-spec
15901 @itemx -msched-br-data-spec
15902 @opindex mno-sched-br-data-spec
15903 @opindex msched-br-data-spec
15904 (Dis/En)able data speculative scheduling before reload.
15905 This results in generation of @code{ld.a} instructions and
15906 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15907 The default is 'disable'.
15909 @item -msched-ar-data-spec
15910 @itemx -mno-sched-ar-data-spec
15911 @opindex msched-ar-data-spec
15912 @opindex mno-sched-ar-data-spec
15913 (En/Dis)able data speculative scheduling after reload.
15914 This results in generation of @code{ld.a} instructions and
15915 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15916 The default is 'enable'.
15918 @item -mno-sched-control-spec
15919 @itemx -msched-control-spec
15920 @opindex mno-sched-control-spec
15921 @opindex msched-control-spec
15922 (Dis/En)able control speculative scheduling.  This feature is
15923 available only during region scheduling (i.e.@: before reload).
15924 This results in generation of the @code{ld.s} instructions and
15925 the corresponding check instructions @code{chk.s}.
15926 The default is 'disable'.
15928 @item -msched-br-in-data-spec
15929 @itemx -mno-sched-br-in-data-spec
15930 @opindex msched-br-in-data-spec
15931 @opindex mno-sched-br-in-data-spec
15932 (En/Dis)able speculative scheduling of the instructions that
15933 are dependent on the data speculative loads before reload.
15934 This is effective only with @option{-msched-br-data-spec} enabled.
15935 The default is 'enable'.
15937 @item -msched-ar-in-data-spec
15938 @itemx -mno-sched-ar-in-data-spec
15939 @opindex msched-ar-in-data-spec
15940 @opindex mno-sched-ar-in-data-spec
15941 (En/Dis)able speculative scheduling of the instructions that
15942 are dependent on the data speculative loads after reload.
15943 This is effective only with @option{-msched-ar-data-spec} enabled.
15944 The default is 'enable'.
15946 @item -msched-in-control-spec
15947 @itemx -mno-sched-in-control-spec
15948 @opindex msched-in-control-spec
15949 @opindex mno-sched-in-control-spec
15950 (En/Dis)able speculative scheduling of the instructions that
15951 are dependent on the control speculative loads.
15952 This is effective only with @option{-msched-control-spec} enabled.
15953 The default is 'enable'.
15955 @item -mno-sched-prefer-non-data-spec-insns
15956 @itemx -msched-prefer-non-data-spec-insns
15957 @opindex mno-sched-prefer-non-data-spec-insns
15958 @opindex msched-prefer-non-data-spec-insns
15959 If enabled, data-speculative instructions are chosen for schedule
15960 only if there are no other choices at the moment.  This makes
15961 the use of the data speculation much more conservative.
15962 The default is 'disable'.
15964 @item -mno-sched-prefer-non-control-spec-insns
15965 @itemx -msched-prefer-non-control-spec-insns
15966 @opindex mno-sched-prefer-non-control-spec-insns
15967 @opindex msched-prefer-non-control-spec-insns
15968 If enabled, control-speculative instructions are chosen for schedule
15969 only if there are no other choices at the moment.  This makes
15970 the use of the control speculation much more conservative.
15971 The default is 'disable'.
15973 @item -mno-sched-count-spec-in-critical-path
15974 @itemx -msched-count-spec-in-critical-path
15975 @opindex mno-sched-count-spec-in-critical-path
15976 @opindex msched-count-spec-in-critical-path
15977 If enabled, speculative dependencies are considered during
15978 computation of the instructions priorities.  This makes the use of the
15979 speculation a bit more conservative.
15980 The default is 'disable'.
15982 @item -msched-spec-ldc
15983 @opindex msched-spec-ldc
15984 Use a simple data speculation check.  This option is on by default.
15986 @item -msched-control-spec-ldc
15987 @opindex msched-spec-ldc
15988 Use a simple check for control speculation.  This option is on by default.
15990 @item -msched-stop-bits-after-every-cycle
15991 @opindex msched-stop-bits-after-every-cycle
15992 Place a stop bit after every cycle when scheduling.  This option is on
15993 by default.
15995 @item -msched-fp-mem-deps-zero-cost
15996 @opindex msched-fp-mem-deps-zero-cost
15997 Assume that floating-point stores and loads are not likely to cause a conflict
15998 when placed into the same instruction group.  This option is disabled by
15999 default.
16001 @item -msel-sched-dont-check-control-spec
16002 @opindex msel-sched-dont-check-control-spec
16003 Generate checks for control speculation in selective scheduling.
16004 This flag is disabled by default.
16006 @item -msched-max-memory-insns=@var{max-insns}
16007 @opindex msched-max-memory-insns
16008 Limit on the number of memory insns per instruction group, giving lower
16009 priority to subsequent memory insns attempting to schedule in the same
16010 instruction group. Frequently useful to prevent cache bank conflicts.
16011 The default value is 1.
16013 @item -msched-max-memory-insns-hard-limit
16014 @opindex msched-max-memory-insns-hard-limit
16015 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16016 disallowing more than that number in an instruction group.
16017 Otherwise, the limit is ``soft'', meaning that non-memory operations
16018 are preferred when the limit is reached, but memory operations may still
16019 be scheduled.
16021 @end table
16023 @node LM32 Options
16024 @subsection LM32 Options
16025 @cindex LM32 options
16027 These @option{-m} options are defined for the LatticeMico32 architecture:
16029 @table @gcctabopt
16030 @item -mbarrel-shift-enabled
16031 @opindex mbarrel-shift-enabled
16032 Enable barrel-shift instructions.
16034 @item -mdivide-enabled
16035 @opindex mdivide-enabled
16036 Enable divide and modulus instructions.
16038 @item -mmultiply-enabled
16039 @opindex multiply-enabled
16040 Enable multiply instructions.
16042 @item -msign-extend-enabled
16043 @opindex msign-extend-enabled
16044 Enable sign extend instructions.
16046 @item -muser-enabled
16047 @opindex muser-enabled
16048 Enable user-defined instructions.
16050 @end table
16052 @node M32C Options
16053 @subsection M32C Options
16054 @cindex M32C options
16056 @table @gcctabopt
16057 @item -mcpu=@var{name}
16058 @opindex mcpu=
16059 Select the CPU for which code is generated.  @var{name} may be one of
16060 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16061 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16062 the M32C/80 series.
16064 @item -msim
16065 @opindex msim
16066 Specifies that the program will be run on the simulator.  This causes
16067 an alternate runtime library to be linked in which supports, for
16068 example, file I/O@.  You must not use this option when generating
16069 programs that will run on real hardware; you must provide your own
16070 runtime library for whatever I/O functions are needed.
16072 @item -memregs=@var{number}
16073 @opindex memregs=
16074 Specifies the number of memory-based pseudo-registers GCC uses
16075 during code generation.  These pseudo-registers are used like real
16076 registers, so there is a tradeoff between GCC's ability to fit the
16077 code into available registers, and the performance penalty of using
16078 memory instead of registers.  Note that all modules in a program must
16079 be compiled with the same value for this option.  Because of that, you
16080 must not use this option with GCC's default runtime libraries.
16082 @end table
16084 @node M32R/D Options
16085 @subsection M32R/D Options
16086 @cindex M32R/D options
16088 These @option{-m} options are defined for Renesas M32R/D architectures:
16090 @table @gcctabopt
16091 @item -m32r2
16092 @opindex m32r2
16093 Generate code for the M32R/2@.
16095 @item -m32rx
16096 @opindex m32rx
16097 Generate code for the M32R/X@.
16099 @item -m32r
16100 @opindex m32r
16101 Generate code for the M32R@.  This is the default.
16103 @item -mmodel=small
16104 @opindex mmodel=small
16105 Assume all objects live in the lower 16MB of memory (so that their addresses
16106 can be loaded with the @code{ld24} instruction), and assume all subroutines
16107 are reachable with the @code{bl} instruction.
16108 This is the default.
16110 The addressability of a particular object can be set with the
16111 @code{model} attribute.
16113 @item -mmodel=medium
16114 @opindex mmodel=medium
16115 Assume objects may be anywhere in the 32-bit address space (the compiler
16116 generates @code{seth/add3} instructions to load their addresses), and
16117 assume all subroutines are reachable with the @code{bl} instruction.
16119 @item -mmodel=large
16120 @opindex mmodel=large
16121 Assume objects may be anywhere in the 32-bit address space (the compiler
16122 generates @code{seth/add3} instructions to load their addresses), and
16123 assume subroutines may not be reachable with the @code{bl} instruction
16124 (the compiler generates the much slower @code{seth/add3/jl}
16125 instruction sequence).
16127 @item -msdata=none
16128 @opindex msdata=none
16129 Disable use of the small data area.  Variables are put into
16130 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16131 @code{section} attribute has been specified).
16132 This is the default.
16134 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16135 Objects may be explicitly put in the small data area with the
16136 @code{section} attribute using one of these sections.
16138 @item -msdata=sdata
16139 @opindex msdata=sdata
16140 Put small global and static data in the small data area, but do not
16141 generate special code to reference them.
16143 @item -msdata=use
16144 @opindex msdata=use
16145 Put small global and static data in the small data area, and generate
16146 special instructions to reference them.
16148 @item -G @var{num}
16149 @opindex G
16150 @cindex smaller data references
16151 Put global and static objects less than or equal to @var{num} bytes
16152 into the small data or BSS sections instead of the normal data or BSS
16153 sections.  The default value of @var{num} is 8.
16154 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16155 for this option to have any effect.
16157 All modules should be compiled with the same @option{-G @var{num}} value.
16158 Compiling with different values of @var{num} may or may not work; if it
16159 doesn't the linker gives an error message---incorrect code is not
16160 generated.
16162 @item -mdebug
16163 @opindex mdebug
16164 Makes the M32R-specific code in the compiler display some statistics
16165 that might help in debugging programs.
16167 @item -malign-loops
16168 @opindex malign-loops
16169 Align all loops to a 32-byte boundary.
16171 @item -mno-align-loops
16172 @opindex mno-align-loops
16173 Do not enforce a 32-byte alignment for loops.  This is the default.
16175 @item -missue-rate=@var{number}
16176 @opindex missue-rate=@var{number}
16177 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16178 or 2.
16180 @item -mbranch-cost=@var{number}
16181 @opindex mbranch-cost=@var{number}
16182 @var{number} can only be 1 or 2.  If it is 1 then branches are
16183 preferred over conditional code, if it is 2, then the opposite applies.
16185 @item -mflush-trap=@var{number}
16186 @opindex mflush-trap=@var{number}
16187 Specifies the trap number to use to flush the cache.  The default is
16188 12.  Valid numbers are between 0 and 15 inclusive.
16190 @item -mno-flush-trap
16191 @opindex mno-flush-trap
16192 Specifies that the cache cannot be flushed by using a trap.
16194 @item -mflush-func=@var{name}
16195 @opindex mflush-func=@var{name}
16196 Specifies the name of the operating system function to call to flush
16197 the cache.  The default is @samp{_flush_cache}, but a function call
16198 is only used if a trap is not available.
16200 @item -mno-flush-func
16201 @opindex mno-flush-func
16202 Indicates that there is no OS function for flushing the cache.
16204 @end table
16206 @node M680x0 Options
16207 @subsection M680x0 Options
16208 @cindex M680x0 options
16210 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16211 The default settings depend on which architecture was selected when
16212 the compiler was configured; the defaults for the most common choices
16213 are given below.
16215 @table @gcctabopt
16216 @item -march=@var{arch}
16217 @opindex march
16218 Generate code for a specific M680x0 or ColdFire instruction set
16219 architecture.  Permissible values of @var{arch} for M680x0
16220 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16221 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16222 architectures are selected according to Freescale's ISA classification
16223 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16224 @samp{isab} and @samp{isac}.
16226 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
16227 code for a ColdFire target.  The @var{arch} in this macro is one of the
16228 @option{-march} arguments given above.
16230 When used together, @option{-march} and @option{-mtune} select code
16231 that runs on a family of similar processors but that is optimized
16232 for a particular microarchitecture.
16234 @item -mcpu=@var{cpu}
16235 @opindex mcpu
16236 Generate code for a specific M680x0 or ColdFire processor.
16237 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16238 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16239 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16240 below, which also classifies the CPUs into families:
16242 @multitable @columnfractions 0.20 0.80
16243 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16244 @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}
16245 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16246 @item @samp{5206e} @tab @samp{5206e}
16247 @item @samp{5208} @tab @samp{5207} @samp{5208}
16248 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16249 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16250 @item @samp{5216} @tab @samp{5214} @samp{5216}
16251 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16252 @item @samp{5225} @tab @samp{5224} @samp{5225}
16253 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16254 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16255 @item @samp{5249} @tab @samp{5249}
16256 @item @samp{5250} @tab @samp{5250}
16257 @item @samp{5271} @tab @samp{5270} @samp{5271}
16258 @item @samp{5272} @tab @samp{5272}
16259 @item @samp{5275} @tab @samp{5274} @samp{5275}
16260 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16261 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16262 @item @samp{5307} @tab @samp{5307}
16263 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16264 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16265 @item @samp{5407} @tab @samp{5407}
16266 @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}
16267 @end multitable
16269 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16270 @var{arch} is compatible with @var{cpu}.  Other combinations of
16271 @option{-mcpu} and @option{-march} are rejected.
16273 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
16274 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
16275 where the value of @var{family} is given by the table above.
16277 @item -mtune=@var{tune}
16278 @opindex mtune
16279 Tune the code for a particular microarchitecture within the
16280 constraints set by @option{-march} and @option{-mcpu}.
16281 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16282 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16283 and @samp{cpu32}.  The ColdFire microarchitectures
16284 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16286 You can also use @option{-mtune=68020-40} for code that needs
16287 to run relatively well on 68020, 68030 and 68040 targets.
16288 @option{-mtune=68020-60} is similar but includes 68060 targets
16289 as well.  These two options select the same tuning decisions as
16290 @option{-m68020-40} and @option{-m68020-60} respectively.
16292 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
16293 when tuning for 680x0 architecture @var{arch}.  It also defines
16294 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16295 option is used.  If GCC is tuning for a range of architectures,
16296 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16297 it defines the macros for every architecture in the range.
16299 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
16300 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16301 of the arguments given above.
16303 @item -m68000
16304 @itemx -mc68000
16305 @opindex m68000
16306 @opindex mc68000
16307 Generate output for a 68000.  This is the default
16308 when the compiler is configured for 68000-based systems.
16309 It is equivalent to @option{-march=68000}.
16311 Use this option for microcontrollers with a 68000 or EC000 core,
16312 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16314 @item -m68010
16315 @opindex m68010
16316 Generate output for a 68010.  This is the default
16317 when the compiler is configured for 68010-based systems.
16318 It is equivalent to @option{-march=68010}.
16320 @item -m68020
16321 @itemx -mc68020
16322 @opindex m68020
16323 @opindex mc68020
16324 Generate output for a 68020.  This is the default
16325 when the compiler is configured for 68020-based systems.
16326 It is equivalent to @option{-march=68020}.
16328 @item -m68030
16329 @opindex m68030
16330 Generate output for a 68030.  This is the default when the compiler is
16331 configured for 68030-based systems.  It is equivalent to
16332 @option{-march=68030}.
16334 @item -m68040
16335 @opindex m68040
16336 Generate output for a 68040.  This is the default when the compiler is
16337 configured for 68040-based systems.  It is equivalent to
16338 @option{-march=68040}.
16340 This option inhibits the use of 68881/68882 instructions that have to be
16341 emulated by software on the 68040.  Use this option if your 68040 does not
16342 have code to emulate those instructions.
16344 @item -m68060
16345 @opindex m68060
16346 Generate output for a 68060.  This is the default when the compiler is
16347 configured for 68060-based systems.  It is equivalent to
16348 @option{-march=68060}.
16350 This option inhibits the use of 68020 and 68881/68882 instructions that
16351 have to be emulated by software on the 68060.  Use this option if your 68060
16352 does not have code to emulate those instructions.
16354 @item -mcpu32
16355 @opindex mcpu32
16356 Generate output for a CPU32.  This is the default
16357 when the compiler is configured for CPU32-based systems.
16358 It is equivalent to @option{-march=cpu32}.
16360 Use this option for microcontrollers with a
16361 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16362 68336, 68340, 68341, 68349 and 68360.
16364 @item -m5200
16365 @opindex m5200
16366 Generate output for a 520X ColdFire CPU@.  This is the default
16367 when the compiler is configured for 520X-based systems.
16368 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16369 in favor of that option.
16371 Use this option for microcontroller with a 5200 core, including
16372 the MCF5202, MCF5203, MCF5204 and MCF5206.
16374 @item -m5206e
16375 @opindex m5206e
16376 Generate output for a 5206e ColdFire CPU@.  The option is now
16377 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16379 @item -m528x
16380 @opindex m528x
16381 Generate output for a member of the ColdFire 528X family.
16382 The option is now deprecated in favor of the equivalent
16383 @option{-mcpu=528x}.
16385 @item -m5307
16386 @opindex m5307
16387 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16388 in favor of the equivalent @option{-mcpu=5307}.
16390 @item -m5407
16391 @opindex m5407
16392 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16393 in favor of the equivalent @option{-mcpu=5407}.
16395 @item -mcfv4e
16396 @opindex mcfv4e
16397 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16398 This includes use of hardware floating-point instructions.
16399 The option is equivalent to @option{-mcpu=547x}, and is now
16400 deprecated in favor of that option.
16402 @item -m68020-40
16403 @opindex m68020-40
16404 Generate output for a 68040, without using any of the new instructions.
16405 This results in code that can run relatively efficiently on either a
16406 68020/68881 or a 68030 or a 68040.  The generated code does use the
16407 68881 instructions that are emulated on the 68040.
16409 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16411 @item -m68020-60
16412 @opindex m68020-60
16413 Generate output for a 68060, without using any of the new instructions.
16414 This results in code that can run relatively efficiently on either a
16415 68020/68881 or a 68030 or a 68040.  The generated code does use the
16416 68881 instructions that are emulated on the 68060.
16418 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16420 @item -mhard-float
16421 @itemx -m68881
16422 @opindex mhard-float
16423 @opindex m68881
16424 Generate floating-point instructions.  This is the default for 68020
16425 and above, and for ColdFire devices that have an FPU@.  It defines the
16426 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
16427 on ColdFire targets.
16429 @item -msoft-float
16430 @opindex msoft-float
16431 Do not generate floating-point instructions; use library calls instead.
16432 This is the default for 68000, 68010, and 68832 targets.  It is also
16433 the default for ColdFire devices that have no FPU.
16435 @item -mdiv
16436 @itemx -mno-div
16437 @opindex mdiv
16438 @opindex mno-div
16439 Generate (do not generate) ColdFire hardware divide and remainder
16440 instructions.  If @option{-march} is used without @option{-mcpu},
16441 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16442 architectures.  Otherwise, the default is taken from the target CPU
16443 (either the default CPU, or the one specified by @option{-mcpu}).  For
16444 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16445 @option{-mcpu=5206e}.
16447 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
16449 @item -mshort
16450 @opindex mshort
16451 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16452 Additionally, parameters passed on the stack are also aligned to a
16453 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16455 @item -mno-short
16456 @opindex mno-short
16457 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16459 @item -mnobitfield
16460 @itemx -mno-bitfield
16461 @opindex mnobitfield
16462 @opindex mno-bitfield
16463 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16464 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16466 @item -mbitfield
16467 @opindex mbitfield
16468 Do use the bit-field instructions.  The @option{-m68020} option implies
16469 @option{-mbitfield}.  This is the default if you use a configuration
16470 designed for a 68020.
16472 @item -mrtd
16473 @opindex mrtd
16474 Use a different function-calling convention, in which functions
16475 that take a fixed number of arguments return with the @code{rtd}
16476 instruction, which pops their arguments while returning.  This
16477 saves one instruction in the caller since there is no need to pop
16478 the arguments there.
16480 This calling convention is incompatible with the one normally
16481 used on Unix, so you cannot use it if you need to call libraries
16482 compiled with the Unix compiler.
16484 Also, you must provide function prototypes for all functions that
16485 take variable numbers of arguments (including @code{printf});
16486 otherwise incorrect code is generated for calls to those
16487 functions.
16489 In addition, seriously incorrect code results if you call a
16490 function with too many arguments.  (Normally, extra arguments are
16491 harmlessly ignored.)
16493 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16494 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16496 @item -mno-rtd
16497 @opindex mno-rtd
16498 Do not use the calling conventions selected by @option{-mrtd}.
16499 This is the default.
16501 @item -malign-int
16502 @itemx -mno-align-int
16503 @opindex malign-int
16504 @opindex mno-align-int
16505 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16506 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16507 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16508 Aligning variables on 32-bit boundaries produces code that runs somewhat
16509 faster on processors with 32-bit busses at the expense of more memory.
16511 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16512 aligns structures containing the above types differently than
16513 most published application binary interface specifications for the m68k.
16515 @item -mpcrel
16516 @opindex mpcrel
16517 Use the pc-relative addressing mode of the 68000 directly, instead of
16518 using a global offset table.  At present, this option implies @option{-fpic},
16519 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16520 not presently supported with @option{-mpcrel}, though this could be supported for
16521 68020 and higher processors.
16523 @item -mno-strict-align
16524 @itemx -mstrict-align
16525 @opindex mno-strict-align
16526 @opindex mstrict-align
16527 Do not (do) assume that unaligned memory references are handled by
16528 the system.
16530 @item -msep-data
16531 Generate code that allows the data segment to be located in a different
16532 area of memory from the text segment.  This allows for execute-in-place in
16533 an environment without virtual memory management.  This option implies
16534 @option{-fPIC}.
16536 @item -mno-sep-data
16537 Generate code that assumes that the data segment follows the text segment.
16538 This is the default.
16540 @item -mid-shared-library
16541 Generate code that supports shared libraries via the library ID method.
16542 This allows for execute-in-place and shared libraries in an environment
16543 without virtual memory management.  This option implies @option{-fPIC}.
16545 @item -mno-id-shared-library
16546 Generate code that doesn't assume ID-based shared libraries are being used.
16547 This is the default.
16549 @item -mshared-library-id=n
16550 Specifies the identification number of the ID-based shared library being
16551 compiled.  Specifying a value of 0 generates more compact code; specifying
16552 other values forces the allocation of that number to the current
16553 library, but is no more space- or time-efficient than omitting this option.
16555 @item -mxgot
16556 @itemx -mno-xgot
16557 @opindex mxgot
16558 @opindex mno-xgot
16559 When generating position-independent code for ColdFire, generate code
16560 that works if the GOT has more than 8192 entries.  This code is
16561 larger and slower than code generated without this option.  On M680x0
16562 processors, this option is not needed; @option{-fPIC} suffices.
16564 GCC normally uses a single instruction to load values from the GOT@.
16565 While this is relatively efficient, it only works if the GOT
16566 is smaller than about 64k.  Anything larger causes the linker
16567 to report an error such as:
16569 @cindex relocation truncated to fit (ColdFire)
16570 @smallexample
16571 relocation truncated to fit: R_68K_GOT16O foobar
16572 @end smallexample
16574 If this happens, you should recompile your code with @option{-mxgot}.
16575 It should then work with very large GOTs.  However, code generated with
16576 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16577 the value of a global symbol.
16579 Note that some linkers, including newer versions of the GNU linker,
16580 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16581 you should only need to use @option{-mxgot} when compiling a single
16582 object file that accesses more than 8192 GOT entries.  Very few do.
16584 These options have no effect unless GCC is generating
16585 position-independent code.
16587 @end table
16589 @node MCore Options
16590 @subsection MCore Options
16591 @cindex MCore options
16593 These are the @samp{-m} options defined for the Motorola M*Core
16594 processors.
16596 @table @gcctabopt
16598 @item -mhardlit
16599 @itemx -mno-hardlit
16600 @opindex mhardlit
16601 @opindex mno-hardlit
16602 Inline constants into the code stream if it can be done in two
16603 instructions or less.
16605 @item -mdiv
16606 @itemx -mno-div
16607 @opindex mdiv
16608 @opindex mno-div
16609 Use the divide instruction.  (Enabled by default).
16611 @item -mrelax-immediate
16612 @itemx -mno-relax-immediate
16613 @opindex mrelax-immediate
16614 @opindex mno-relax-immediate
16615 Allow arbitrary-sized immediates in bit operations.
16617 @item -mwide-bitfields
16618 @itemx -mno-wide-bitfields
16619 @opindex mwide-bitfields
16620 @opindex mno-wide-bitfields
16621 Always treat bit-fields as @code{int}-sized.
16623 @item -m4byte-functions
16624 @itemx -mno-4byte-functions
16625 @opindex m4byte-functions
16626 @opindex mno-4byte-functions
16627 Force all functions to be aligned to a 4-byte boundary.
16629 @item -mcallgraph-data
16630 @itemx -mno-callgraph-data
16631 @opindex mcallgraph-data
16632 @opindex mno-callgraph-data
16633 Emit callgraph information.
16635 @item -mslow-bytes
16636 @itemx -mno-slow-bytes
16637 @opindex mslow-bytes
16638 @opindex mno-slow-bytes
16639 Prefer word access when reading byte quantities.
16641 @item -mlittle-endian
16642 @itemx -mbig-endian
16643 @opindex mlittle-endian
16644 @opindex mbig-endian
16645 Generate code for a little-endian target.
16647 @item -m210
16648 @itemx -m340
16649 @opindex m210
16650 @opindex m340
16651 Generate code for the 210 processor.
16653 @item -mno-lsim
16654 @opindex mno-lsim
16655 Assume that runtime support has been provided and so omit the
16656 simulator library (@file{libsim.a)} from the linker command line.
16658 @item -mstack-increment=@var{size}
16659 @opindex mstack-increment
16660 Set the maximum amount for a single stack increment operation.  Large
16661 values can increase the speed of programs that contain functions
16662 that need a large amount of stack space, but they can also trigger a
16663 segmentation fault if the stack is extended too much.  The default
16664 value is 0x1000.
16666 @end table
16668 @node MeP Options
16669 @subsection MeP Options
16670 @cindex MeP options
16672 @table @gcctabopt
16674 @item -mabsdiff
16675 @opindex mabsdiff
16676 Enables the @code{abs} instruction, which is the absolute difference
16677 between two registers.
16679 @item -mall-opts
16680 @opindex mall-opts
16681 Enables all the optional instructions---average, multiply, divide, bit
16682 operations, leading zero, absolute difference, min/max, clip, and
16683 saturation.
16686 @item -maverage
16687 @opindex maverage
16688 Enables the @code{ave} instruction, which computes the average of two
16689 registers.
16691 @item -mbased=@var{n}
16692 @opindex mbased=
16693 Variables of size @var{n} bytes or smaller are placed in the
16694 @code{.based} section by default.  Based variables use the @code{$tp}
16695 register as a base register, and there is a 128-byte limit to the
16696 @code{.based} section.
16698 @item -mbitops
16699 @opindex mbitops
16700 Enables the bit operation instructions---bit test (@code{btstm}), set
16701 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16702 test-and-set (@code{tas}).
16704 @item -mc=@var{name}
16705 @opindex mc=
16706 Selects which section constant data is placed in.  @var{name} may
16707 be @samp{tiny}, @samp{near}, or @samp{far}.
16709 @item -mclip
16710 @opindex mclip
16711 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
16712 useful unless you also provide @option{-mminmax}.
16714 @item -mconfig=@var{name}
16715 @opindex mconfig=
16716 Selects one of the built-in core configurations.  Each MeP chip has
16717 one or more modules in it; each module has a core CPU and a variety of
16718 coprocessors, optional instructions, and peripherals.  The
16719 @code{MeP-Integrator} tool, not part of GCC, provides these
16720 configurations through this option; using this option is the same as
16721 using all the corresponding command-line options.  The default
16722 configuration is @samp{default}.
16724 @item -mcop
16725 @opindex mcop
16726 Enables the coprocessor instructions.  By default, this is a 32-bit
16727 coprocessor.  Note that the coprocessor is normally enabled via the
16728 @option{-mconfig=} option.
16730 @item -mcop32
16731 @opindex mcop32
16732 Enables the 32-bit coprocessor's instructions.
16734 @item -mcop64
16735 @opindex mcop64
16736 Enables the 64-bit coprocessor's instructions.
16738 @item -mivc2
16739 @opindex mivc2
16740 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16742 @item -mdc
16743 @opindex mdc
16744 Causes constant variables to be placed in the @code{.near} section.
16746 @item -mdiv
16747 @opindex mdiv
16748 Enables the @code{div} and @code{divu} instructions.
16750 @item -meb
16751 @opindex meb
16752 Generate big-endian code.
16754 @item -mel
16755 @opindex mel
16756 Generate little-endian code.
16758 @item -mio-volatile
16759 @opindex mio-volatile
16760 Tells the compiler that any variable marked with the @code{io}
16761 attribute is to be considered volatile.
16763 @item -ml
16764 @opindex ml
16765 Causes variables to be assigned to the @code{.far} section by default.
16767 @item -mleadz
16768 @opindex mleadz
16769 Enables the @code{leadz} (leading zero) instruction.
16771 @item -mm
16772 @opindex mm
16773 Causes variables to be assigned to the @code{.near} section by default.
16775 @item -mminmax
16776 @opindex mminmax
16777 Enables the @code{min} and @code{max} instructions.
16779 @item -mmult
16780 @opindex mmult
16781 Enables the multiplication and multiply-accumulate instructions.
16783 @item -mno-opts
16784 @opindex mno-opts
16785 Disables all the optional instructions enabled by @option{-mall-opts}.
16787 @item -mrepeat
16788 @opindex mrepeat
16789 Enables the @code{repeat} and @code{erepeat} instructions, used for
16790 low-overhead looping.
16792 @item -ms
16793 @opindex ms
16794 Causes all variables to default to the @code{.tiny} section.  Note
16795 that there is a 65536-byte limit to this section.  Accesses to these
16796 variables use the @code{%gp} base register.
16798 @item -msatur
16799 @opindex msatur
16800 Enables the saturation instructions.  Note that the compiler does not
16801 currently generate these itself, but this option is included for
16802 compatibility with other tools, like @code{as}.
16804 @item -msdram
16805 @opindex msdram
16806 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16808 @item -msim
16809 @opindex msim
16810 Link the simulator run-time libraries.
16812 @item -msimnovec
16813 @opindex msimnovec
16814 Link the simulator runtime libraries, excluding built-in support
16815 for reset and exception vectors and tables.
16817 @item -mtf
16818 @opindex mtf
16819 Causes all functions to default to the @code{.far} section.  Without
16820 this option, functions default to the @code{.near} section.
16822 @item -mtiny=@var{n}
16823 @opindex mtiny=
16824 Variables that are @var{n} bytes or smaller are allocated to the
16825 @code{.tiny} section.  These variables use the @code{$gp} base
16826 register.  The default for this option is 4, but note that there's a
16827 65536-byte limit to the @code{.tiny} section.
16829 @end table
16831 @node MicroBlaze Options
16832 @subsection MicroBlaze Options
16833 @cindex MicroBlaze Options
16835 @table @gcctabopt
16837 @item -msoft-float
16838 @opindex msoft-float
16839 Use software emulation for floating point (default).
16841 @item -mhard-float
16842 @opindex mhard-float
16843 Use hardware floating-point instructions.
16845 @item -mmemcpy
16846 @opindex mmemcpy
16847 Do not optimize block moves, use @code{memcpy}.
16849 @item -mno-clearbss
16850 @opindex mno-clearbss
16851 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
16853 @item -mcpu=@var{cpu-type}
16854 @opindex mcpu=
16855 Use features of, and schedule code for, the given CPU.
16856 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
16857 where @var{X} is a major version, @var{YY} is the minor version, and
16858 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
16859 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
16861 @item -mxl-soft-mul
16862 @opindex mxl-soft-mul
16863 Use software multiply emulation (default).
16865 @item -mxl-soft-div
16866 @opindex mxl-soft-div
16867 Use software emulation for divides (default).
16869 @item -mxl-barrel-shift
16870 @opindex mxl-barrel-shift
16871 Use the hardware barrel shifter.
16873 @item -mxl-pattern-compare
16874 @opindex mxl-pattern-compare
16875 Use pattern compare instructions.
16877 @item -msmall-divides
16878 @opindex msmall-divides
16879 Use table lookup optimization for small signed integer divisions.
16881 @item -mxl-stack-check
16882 @opindex mxl-stack-check
16883 This option is deprecated.  Use @option{-fstack-check} instead.
16885 @item -mxl-gp-opt
16886 @opindex mxl-gp-opt
16887 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16889 @item -mxl-multiply-high
16890 @opindex mxl-multiply-high
16891 Use multiply high instructions for high part of 32x32 multiply.
16893 @item -mxl-float-convert
16894 @opindex mxl-float-convert
16895 Use hardware floating-point conversion instructions.
16897 @item -mxl-float-sqrt
16898 @opindex mxl-float-sqrt
16899 Use hardware floating-point square root instruction.
16901 @item -mbig-endian
16902 @opindex mbig-endian
16903 Generate code for a big-endian target.
16905 @item -mlittle-endian
16906 @opindex mlittle-endian
16907 Generate code for a little-endian target.
16909 @item -mxl-reorder
16910 @opindex mxl-reorder
16911 Use reorder instructions (swap and byte reversed load/store).
16913 @item -mxl-mode-@var{app-model}
16914 Select application model @var{app-model}.  Valid models are
16915 @table @samp
16916 @item executable
16917 normal executable (default), uses startup code @file{crt0.o}.
16919 @item xmdstub
16920 for use with Xilinx Microprocessor Debugger (XMD) based
16921 software intrusive debug agent called xmdstub. This uses startup file
16922 @file{crt1.o} and sets the start address of the program to 0x800.
16924 @item bootstrap
16925 for applications that are loaded using a bootloader.
16926 This model uses startup file @file{crt2.o} which does not contain a processor
16927 reset vector handler. This is suitable for transferring control on a
16928 processor reset to the bootloader rather than the application.
16930 @item novectors
16931 for applications that do not require any of the
16932 MicroBlaze vectors. This option may be useful for applications running
16933 within a monitoring application. This model uses @file{crt3.o} as a startup file.
16934 @end table
16936 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
16937 @option{-mxl-mode-@var{app-model}}.
16939 @end table
16941 @node MIPS Options
16942 @subsection MIPS Options
16943 @cindex MIPS options
16945 @table @gcctabopt
16947 @item -EB
16948 @opindex EB
16949 Generate big-endian code.
16951 @item -EL
16952 @opindex EL
16953 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
16954 configurations.
16956 @item -march=@var{arch}
16957 @opindex march
16958 Generate code that runs on @var{arch}, which can be the name of a
16959 generic MIPS ISA, or the name of a particular processor.
16960 The ISA names are:
16961 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
16962 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
16963 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
16964 @samp{mips64r5} and @samp{mips64r6}.
16965 The processor names are:
16966 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
16967 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
16968 @samp{5kc}, @samp{5kf},
16969 @samp{20kc},
16970 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
16971 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
16972 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
16973 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
16974 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
16975 @samp{i6400},
16976 @samp{interaptiv},
16977 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
16978 @samp{m4k},
16979 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
16980 @samp{m5100}, @samp{m5101},
16981 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
16982 @samp{orion},
16983 @samp{p5600},
16984 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
16985 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
16986 @samp{rm7000}, @samp{rm9000},
16987 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
16988 @samp{sb1},
16989 @samp{sr71000},
16990 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
16991 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
16992 @samp{xlr} and @samp{xlp}.
16993 The special value @samp{from-abi} selects the
16994 most compatible architecture for the selected ABI (that is,
16995 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
16997 The native Linux/GNU toolchain also supports the value @samp{native},
16998 which selects the best architecture option for the host processor.
16999 @option{-march=native} has no effect if GCC does not recognize
17000 the processor.
17002 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17003 (for example, @option{-march=r2k}).  Prefixes are optional, and
17004 @samp{vr} may be written @samp{r}.
17006 Names of the form @samp{@var{n}f2_1} refer to processors with
17007 FPUs clocked at half the rate of the core, names of the form
17008 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17009 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17010 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17011 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17012 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17013 accepted as synonyms for @samp{@var{n}f1_1}.
17015 GCC defines two macros based on the value of this option.  The first
17016 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
17017 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
17018 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
17019 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
17020 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
17022 Note that the @code{_MIPS_ARCH} macro uses the processor names given
17023 above.  In other words, it has the full prefix and does not
17024 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17025 the macro names the resolved architecture (either @code{"mips1"} or
17026 @code{"mips3"}).  It names the default architecture when no
17027 @option{-march} option is given.
17029 @item -mtune=@var{arch}
17030 @opindex mtune
17031 Optimize for @var{arch}.  Among other things, this option controls
17032 the way instructions are scheduled, and the perceived cost of arithmetic
17033 operations.  The list of @var{arch} values is the same as for
17034 @option{-march}.
17036 When this option is not used, GCC optimizes for the processor
17037 specified by @option{-march}.  By using @option{-march} and
17038 @option{-mtune} together, it is possible to generate code that
17039 runs on a family of processors, but optimize the code for one
17040 particular member of that family.
17042 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
17043 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17044 @option{-march} ones described above.
17046 @item -mips1
17047 @opindex mips1
17048 Equivalent to @option{-march=mips1}.
17050 @item -mips2
17051 @opindex mips2
17052 Equivalent to @option{-march=mips2}.
17054 @item -mips3
17055 @opindex mips3
17056 Equivalent to @option{-march=mips3}.
17058 @item -mips4
17059 @opindex mips4
17060 Equivalent to @option{-march=mips4}.
17062 @item -mips32
17063 @opindex mips32
17064 Equivalent to @option{-march=mips32}.
17066 @item -mips32r3
17067 @opindex mips32r3
17068 Equivalent to @option{-march=mips32r3}.
17070 @item -mips32r5
17071 @opindex mips32r5
17072 Equivalent to @option{-march=mips32r5}.
17074 @item -mips32r6
17075 @opindex mips32r6
17076 Equivalent to @option{-march=mips32r6}.
17078 @item -mips64
17079 @opindex mips64
17080 Equivalent to @option{-march=mips64}.
17082 @item -mips64r2
17083 @opindex mips64r2
17084 Equivalent to @option{-march=mips64r2}.
17086 @item -mips64r3
17087 @opindex mips64r3
17088 Equivalent to @option{-march=mips64r3}.
17090 @item -mips64r5
17091 @opindex mips64r5
17092 Equivalent to @option{-march=mips64r5}.
17094 @item -mips64r6
17095 @opindex mips64r6
17096 Equivalent to @option{-march=mips64r6}.
17098 @item -mips16
17099 @itemx -mno-mips16
17100 @opindex mips16
17101 @opindex mno-mips16
17102 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17103 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17105 MIPS16 code generation can also be controlled on a per-function basis
17106 by means of @code{mips16} and @code{nomips16} attributes.
17107 @xref{Function Attributes}, for more information.
17109 @item -mflip-mips16
17110 @opindex mflip-mips16
17111 Generate MIPS16 code on alternating functions.  This option is provided
17112 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17113 not intended for ordinary use in compiling user code.
17115 @item -minterlink-compressed
17116 @item -mno-interlink-compressed
17117 @opindex minterlink-compressed
17118 @opindex mno-interlink-compressed
17119 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17120 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17122 For example, code using the standard ISA encoding cannot jump directly
17123 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17124 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17125 knows that the target of the jump is not compressed.
17127 @item -minterlink-mips16
17128 @itemx -mno-interlink-mips16
17129 @opindex minterlink-mips16
17130 @opindex mno-interlink-mips16
17131 Aliases of @option{-minterlink-compressed} and
17132 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17133 and are retained for backwards compatibility.
17135 @item -mabi=32
17136 @itemx -mabi=o64
17137 @itemx -mabi=n32
17138 @itemx -mabi=64
17139 @itemx -mabi=eabi
17140 @opindex mabi=32
17141 @opindex mabi=o64
17142 @opindex mabi=n32
17143 @opindex mabi=64
17144 @opindex mabi=eabi
17145 Generate code for the given ABI@.
17147 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17148 generates 64-bit code when you select a 64-bit architecture, but you
17149 can use @option{-mgp32} to get 32-bit code instead.
17151 For information about the O64 ABI, see
17152 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17154 GCC supports a variant of the o32 ABI in which floating-point registers
17155 are 64 rather than 32 bits wide.  You can select this combination with
17156 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17157 and @code{mfhc1} instructions and is therefore only supported for
17158 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17160 The register assignments for arguments and return values remain the
17161 same, but each scalar value is passed in a single 64-bit register
17162 rather than a pair of 32-bit registers.  For example, scalar
17163 floating-point values are returned in @samp{$f0} only, not a
17164 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17165 remains the same in that the even-numbered double-precision registers
17166 are saved.
17168 Two additional variants of the o32 ABI are supported to enable
17169 a transition from 32-bit to 64-bit registers.  These are FPXX
17170 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17171 The FPXX extension mandates that all code must execute correctly
17172 when run using 32-bit or 64-bit registers.  The code can be interlinked
17173 with either FP32 or FP64, but not both.
17174 The FP64A extension is similar to the FP64 extension but forbids the
17175 use of odd-numbered single-precision registers.  This can be used
17176 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17177 processors and allows both FP32 and FP64A code to interlink and
17178 run in the same process without changing FPU modes.
17180 @item -mabicalls
17181 @itemx -mno-abicalls
17182 @opindex mabicalls
17183 @opindex mno-abicalls
17184 Generate (do not generate) code that is suitable for SVR4-style
17185 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17186 systems.
17188 @item -mshared
17189 @itemx -mno-shared
17190 Generate (do not generate) code that is fully position-independent,
17191 and that can therefore be linked into shared libraries.  This option
17192 only affects @option{-mabicalls}.
17194 All @option{-mabicalls} code has traditionally been position-independent,
17195 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17196 as an extension, the GNU toolchain allows executables to use absolute
17197 accesses for locally-binding symbols.  It can also use shorter GP
17198 initialization sequences and generate direct calls to locally-defined
17199 functions.  This mode is selected by @option{-mno-shared}.
17201 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17202 objects that can only be linked by the GNU linker.  However, the option
17203 does not affect the ABI of the final executable; it only affects the ABI
17204 of relocatable objects.  Using @option{-mno-shared} generally makes
17205 executables both smaller and quicker.
17207 @option{-mshared} is the default.
17209 @item -mplt
17210 @itemx -mno-plt
17211 @opindex mplt
17212 @opindex mno-plt
17213 Assume (do not assume) that the static and dynamic linkers
17214 support PLTs and copy relocations.  This option only affects
17215 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17216 has no effect without @option{-msym32}.
17218 You can make @option{-mplt} the default by configuring
17219 GCC with @option{--with-mips-plt}.  The default is
17220 @option{-mno-plt} otherwise.
17222 @item -mxgot
17223 @itemx -mno-xgot
17224 @opindex mxgot
17225 @opindex mno-xgot
17226 Lift (do not lift) the usual restrictions on the size of the global
17227 offset table.
17229 GCC normally uses a single instruction to load values from the GOT@.
17230 While this is relatively efficient, it only works if the GOT
17231 is smaller than about 64k.  Anything larger causes the linker
17232 to report an error such as:
17234 @cindex relocation truncated to fit (MIPS)
17235 @smallexample
17236 relocation truncated to fit: R_MIPS_GOT16 foobar
17237 @end smallexample
17239 If this happens, you should recompile your code with @option{-mxgot}.
17240 This works with very large GOTs, although the code is also
17241 less efficient, since it takes three instructions to fetch the
17242 value of a global symbol.
17244 Note that some linkers can create multiple GOTs.  If you have such a
17245 linker, you should only need to use @option{-mxgot} when a single object
17246 file accesses more than 64k's worth of GOT entries.  Very few do.
17248 These options have no effect unless GCC is generating position
17249 independent code.
17251 @item -mgp32
17252 @opindex mgp32
17253 Assume that general-purpose registers are 32 bits wide.
17255 @item -mgp64
17256 @opindex mgp64
17257 Assume that general-purpose registers are 64 bits wide.
17259 @item -mfp32
17260 @opindex mfp32
17261 Assume that floating-point registers are 32 bits wide.
17263 @item -mfp64
17264 @opindex mfp64
17265 Assume that floating-point registers are 64 bits wide.
17267 @item -mfpxx
17268 @opindex mfpxx
17269 Do not assume the width of floating-point registers.
17271 @item -mhard-float
17272 @opindex mhard-float
17273 Use floating-point coprocessor instructions.
17275 @item -msoft-float
17276 @opindex msoft-float
17277 Do not use floating-point coprocessor instructions.  Implement
17278 floating-point calculations using library calls instead.
17280 @item -mno-float
17281 @opindex mno-float
17282 Equivalent to @option{-msoft-float}, but additionally asserts that the
17283 program being compiled does not perform any floating-point operations.
17284 This option is presently supported only by some bare-metal MIPS
17285 configurations, where it may select a special set of libraries
17286 that lack all floating-point support (including, for example, the
17287 floating-point @code{printf} formats).  
17288 If code compiled with @option{-mno-float} accidentally contains
17289 floating-point operations, it is likely to suffer a link-time
17290 or run-time failure.
17292 @item -msingle-float
17293 @opindex msingle-float
17294 Assume that the floating-point coprocessor only supports single-precision
17295 operations.
17297 @item -mdouble-float
17298 @opindex mdouble-float
17299 Assume that the floating-point coprocessor supports double-precision
17300 operations.  This is the default.
17302 @item -modd-spreg
17303 @itemx -mno-odd-spreg
17304 @opindex modd-spreg
17305 @opindex mno-odd-spreg
17306 Enable the use of odd-numbered single-precision floating-point registers
17307 for the o32 ABI.  This is the default for processors that are known to
17308 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
17309 is set by default.
17311 @item -mcompact-branches=never
17312 @itemx -mcompact-branches=optimal
17313 @itemx -mcompact-branches=always
17314 @opindex mcompact-branches=never
17315 @opindex mcompact-branches=optimal
17316 @opindex mcompact-branches=always
17317 These options control which form of branches will be generated.  The
17318 default is @option{-mcompact-branches=optimal}.
17320 The @option{-mcompact-branches=never} option ensures that compact branch
17321 instructions will never be generated.
17323 The @option{-mcompact-branches=always} option ensures that a compact
17324 branch instruction will be generated if available.  If a compact branch
17325 instruction is not available, a delay slot form of the branch will be
17326 used instead.
17328 This option is supported from MIPS Release 6 onwards.
17330 The @option{-mcompact-branches=optimal} option will cause a delay slot
17331 branch to be used if one is available in the current ISA and the delay
17332 slot is successfully filled.  If the delay slot is not filled, a compact
17333 branch will be chosen if one is available.
17335 @item -mabs=2008
17336 @itemx -mabs=legacy
17337 @opindex mabs=2008
17338 @opindex mabs=legacy
17339 These options control the treatment of the special not-a-number (NaN)
17340 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17341 @code{neg.@i{fmt}} machine instructions.
17343 By default or when @option{-mabs=legacy} is used the legacy
17344 treatment is selected.  In this case these instructions are considered
17345 arithmetic and avoided where correct operation is required and the
17346 input operand might be a NaN.  A longer sequence of instructions that
17347 manipulate the sign bit of floating-point datum manually is used
17348 instead unless the @option{-ffinite-math-only} option has also been
17349 specified.
17351 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17352 this case these instructions are considered non-arithmetic and therefore
17353 operating correctly in all cases, including in particular where the
17354 input operand is a NaN.  These instructions are therefore always used
17355 for the respective operations.
17357 @item -mnan=2008
17358 @itemx -mnan=legacy
17359 @opindex mnan=2008
17360 @opindex mnan=legacy
17361 These options control the encoding of the special not-a-number (NaN)
17362 IEEE 754 floating-point data.
17364 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17365 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17366 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17367 by the first bit of their trailing significand field being 1.
17369 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17370 this case qNaNs are denoted by the first bit of their trailing
17371 significand field being 1, whereas sNaNs are denoted by the first bit of
17372 their trailing significand field being 0.
17374 The default is @option{-mnan=legacy} unless GCC has been configured with
17375 @option{--with-nan=2008}.
17377 @item -mllsc
17378 @itemx -mno-llsc
17379 @opindex mllsc
17380 @opindex mno-llsc
17381 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17382 implement atomic memory built-in functions.  When neither option is
17383 specified, GCC uses the instructions if the target architecture
17384 supports them.
17386 @option{-mllsc} is useful if the runtime environment can emulate the
17387 instructions and @option{-mno-llsc} can be useful when compiling for
17388 nonstandard ISAs.  You can make either option the default by
17389 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17390 respectively.  @option{--with-llsc} is the default for some
17391 configurations; see the installation documentation for details.
17393 @item -mdsp
17394 @itemx -mno-dsp
17395 @opindex mdsp
17396 @opindex mno-dsp
17397 Use (do not use) revision 1 of the MIPS DSP ASE@.
17398 @xref{MIPS DSP Built-in Functions}.  This option defines the
17399 preprocessor macro @code{__mips_dsp}.  It also defines
17400 @code{__mips_dsp_rev} to 1.
17402 @item -mdspr2
17403 @itemx -mno-dspr2
17404 @opindex mdspr2
17405 @opindex mno-dspr2
17406 Use (do not use) revision 2 of the MIPS DSP ASE@.
17407 @xref{MIPS DSP Built-in Functions}.  This option defines the
17408 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
17409 It also defines @code{__mips_dsp_rev} to 2.
17411 @item -msmartmips
17412 @itemx -mno-smartmips
17413 @opindex msmartmips
17414 @opindex mno-smartmips
17415 Use (do not use) the MIPS SmartMIPS ASE.
17417 @item -mpaired-single
17418 @itemx -mno-paired-single
17419 @opindex mpaired-single
17420 @opindex mno-paired-single
17421 Use (do not use) paired-single floating-point instructions.
17422 @xref{MIPS Paired-Single Support}.  This option requires
17423 hardware floating-point support to be enabled.
17425 @item -mdmx
17426 @itemx -mno-mdmx
17427 @opindex mdmx
17428 @opindex mno-mdmx
17429 Use (do not use) MIPS Digital Media Extension instructions.
17430 This option can only be used when generating 64-bit code and requires
17431 hardware floating-point support to be enabled.
17433 @item -mips3d
17434 @itemx -mno-mips3d
17435 @opindex mips3d
17436 @opindex mno-mips3d
17437 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17438 The option @option{-mips3d} implies @option{-mpaired-single}.
17440 @item -mmicromips
17441 @itemx -mno-micromips
17442 @opindex mmicromips
17443 @opindex mno-mmicromips
17444 Generate (do not generate) microMIPS code.
17446 MicroMIPS code generation can also be controlled on a per-function basis
17447 by means of @code{micromips} and @code{nomicromips} attributes.
17448 @xref{Function Attributes}, for more information.
17450 @item -mmt
17451 @itemx -mno-mt
17452 @opindex mmt
17453 @opindex mno-mt
17454 Use (do not use) MT Multithreading instructions.
17456 @item -mmcu
17457 @itemx -mno-mcu
17458 @opindex mmcu
17459 @opindex mno-mcu
17460 Use (do not use) the MIPS MCU ASE instructions.
17462 @item -meva
17463 @itemx -mno-eva
17464 @opindex meva
17465 @opindex mno-eva
17466 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17468 @item -mvirt
17469 @itemx -mno-virt
17470 @opindex mvirt
17471 @opindex mno-virt
17472 Use (do not use) the MIPS Virtualization Application Specific instructions.
17474 @item -mxpa
17475 @itemx -mno-xpa
17476 @opindex mxpa
17477 @opindex mno-xpa
17478 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17480 @item -mlong64
17481 @opindex mlong64
17482 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17483 an explanation of the default and the way that the pointer size is
17484 determined.
17486 @item -mlong32
17487 @opindex mlong32
17488 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17490 The default size of @code{int}s, @code{long}s and pointers depends on
17491 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17492 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17493 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17494 or the same size as integer registers, whichever is smaller.
17496 @item -msym32
17497 @itemx -mno-sym32
17498 @opindex msym32
17499 @opindex mno-sym32
17500 Assume (do not assume) that all symbols have 32-bit values, regardless
17501 of the selected ABI@.  This option is useful in combination with
17502 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17503 to generate shorter and faster references to symbolic addresses.
17505 @item -G @var{num}
17506 @opindex G
17507 Put definitions of externally-visible data in a small data section
17508 if that data is no bigger than @var{num} bytes.  GCC can then generate
17509 more efficient accesses to the data; see @option{-mgpopt} for details.
17511 The default @option{-G} option depends on the configuration.
17513 @item -mlocal-sdata
17514 @itemx -mno-local-sdata
17515 @opindex mlocal-sdata
17516 @opindex mno-local-sdata
17517 Extend (do not extend) the @option{-G} behavior to local data too,
17518 such as to static variables in C@.  @option{-mlocal-sdata} is the
17519 default for all configurations.
17521 If the linker complains that an application is using too much small data,
17522 you might want to try rebuilding the less performance-critical parts with
17523 @option{-mno-local-sdata}.  You might also want to build large
17524 libraries with @option{-mno-local-sdata}, so that the libraries leave
17525 more room for the main program.
17527 @item -mextern-sdata
17528 @itemx -mno-extern-sdata
17529 @opindex mextern-sdata
17530 @opindex mno-extern-sdata
17531 Assume (do not assume) that externally-defined data is in
17532 a small data section if the size of that data is within the @option{-G} limit.
17533 @option{-mextern-sdata} is the default for all configurations.
17535 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17536 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17537 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17538 is placed in a small data section.  If @var{Var} is defined by another
17539 module, you must either compile that module with a high-enough
17540 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17541 definition.  If @var{Var} is common, you must link the application
17542 with a high-enough @option{-G} setting.
17544 The easiest way of satisfying these restrictions is to compile
17545 and link every module with the same @option{-G} option.  However,
17546 you may wish to build a library that supports several different
17547 small data limits.  You can do this by compiling the library with
17548 the highest supported @option{-G} setting and additionally using
17549 @option{-mno-extern-sdata} to stop the library from making assumptions
17550 about externally-defined data.
17552 @item -mgpopt
17553 @itemx -mno-gpopt
17554 @opindex mgpopt
17555 @opindex mno-gpopt
17556 Use (do not use) GP-relative accesses for symbols that are known to be
17557 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17558 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17559 configurations.
17561 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17562 might not hold the value of @code{_gp}.  For example, if the code is
17563 part of a library that might be used in a boot monitor, programs that
17564 call boot monitor routines pass an unknown value in @code{$gp}.
17565 (In such situations, the boot monitor itself is usually compiled
17566 with @option{-G0}.)
17568 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17569 @option{-mno-extern-sdata}.
17571 @item -membedded-data
17572 @itemx -mno-embedded-data
17573 @opindex membedded-data
17574 @opindex mno-embedded-data
17575 Allocate variables to the read-only data section first if possible, then
17576 next in the small data section if possible, otherwise in data.  This gives
17577 slightly slower code than the default, but reduces the amount of RAM required
17578 when executing, and thus may be preferred for some embedded systems.
17580 @item -muninit-const-in-rodata
17581 @itemx -mno-uninit-const-in-rodata
17582 @opindex muninit-const-in-rodata
17583 @opindex mno-uninit-const-in-rodata
17584 Put uninitialized @code{const} variables in the read-only data section.
17585 This option is only meaningful in conjunction with @option{-membedded-data}.
17587 @item -mcode-readable=@var{setting}
17588 @opindex mcode-readable
17589 Specify whether GCC may generate code that reads from executable sections.
17590 There are three possible settings:
17592 @table @gcctabopt
17593 @item -mcode-readable=yes
17594 Instructions may freely access executable sections.  This is the
17595 default setting.
17597 @item -mcode-readable=pcrel
17598 MIPS16 PC-relative load instructions can access executable sections,
17599 but other instructions must not do so.  This option is useful on 4KSc
17600 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17601 It is also useful on processors that can be configured to have a dual
17602 instruction/data SRAM interface and that, like the M4K, automatically
17603 redirect PC-relative loads to the instruction RAM.
17605 @item -mcode-readable=no
17606 Instructions must not access executable sections.  This option can be
17607 useful on targets that are configured to have a dual instruction/data
17608 SRAM interface but that (unlike the M4K) do not automatically redirect
17609 PC-relative loads to the instruction RAM.
17610 @end table
17612 @item -msplit-addresses
17613 @itemx -mno-split-addresses
17614 @opindex msplit-addresses
17615 @opindex mno-split-addresses
17616 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17617 relocation operators.  This option has been superseded by
17618 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17620 @item -mexplicit-relocs
17621 @itemx -mno-explicit-relocs
17622 @opindex mexplicit-relocs
17623 @opindex mno-explicit-relocs
17624 Use (do not use) assembler relocation operators when dealing with symbolic
17625 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17626 is to use assembler macros instead.
17628 @option{-mexplicit-relocs} is the default if GCC was configured
17629 to use an assembler that supports relocation operators.
17631 @item -mcheck-zero-division
17632 @itemx -mno-check-zero-division
17633 @opindex mcheck-zero-division
17634 @opindex mno-check-zero-division
17635 Trap (do not trap) on integer division by zero.
17637 The default is @option{-mcheck-zero-division}.
17639 @item -mdivide-traps
17640 @itemx -mdivide-breaks
17641 @opindex mdivide-traps
17642 @opindex mdivide-breaks
17643 MIPS systems check for division by zero by generating either a
17644 conditional trap or a break instruction.  Using traps results in
17645 smaller code, but is only supported on MIPS II and later.  Also, some
17646 versions of the Linux kernel have a bug that prevents trap from
17647 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17648 allow conditional traps on architectures that support them and
17649 @option{-mdivide-breaks} to force the use of breaks.
17651 The default is usually @option{-mdivide-traps}, but this can be
17652 overridden at configure time using @option{--with-divide=breaks}.
17653 Divide-by-zero checks can be completely disabled using
17654 @option{-mno-check-zero-division}.
17656 @item -mmemcpy
17657 @itemx -mno-memcpy
17658 @opindex mmemcpy
17659 @opindex mno-memcpy
17660 Force (do not force) the use of @code{memcpy} for non-trivial block
17661 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17662 most constant-sized copies.
17664 @item -mlong-calls
17665 @itemx -mno-long-calls
17666 @opindex mlong-calls
17667 @opindex mno-long-calls
17668 Disable (do not disable) use of the @code{jal} instruction.  Calling
17669 functions using @code{jal} is more efficient but requires the caller
17670 and callee to be in the same 256 megabyte segment.
17672 This option has no effect on abicalls code.  The default is
17673 @option{-mno-long-calls}.
17675 @item -mmad
17676 @itemx -mno-mad
17677 @opindex mmad
17678 @opindex mno-mad
17679 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17680 instructions, as provided by the R4650 ISA@.
17682 @item -mimadd
17683 @itemx -mno-imadd
17684 @opindex mimadd
17685 @opindex mno-imadd
17686 Enable (disable) use of the @code{madd} and @code{msub} integer
17687 instructions.  The default is @option{-mimadd} on architectures
17688 that support @code{madd} and @code{msub} except for the 74k 
17689 architecture where it was found to generate slower code.
17691 @item -mfused-madd
17692 @itemx -mno-fused-madd
17693 @opindex mfused-madd
17694 @opindex mno-fused-madd
17695 Enable (disable) use of the floating-point multiply-accumulate
17696 instructions, when they are available.  The default is
17697 @option{-mfused-madd}.
17699 On the R8000 CPU when multiply-accumulate instructions are used,
17700 the intermediate product is calculated to infinite precision
17701 and is not subject to the FCSR Flush to Zero bit.  This may be
17702 undesirable in some circumstances.  On other processors the result
17703 is numerically identical to the equivalent computation using
17704 separate multiply, add, subtract and negate instructions.
17706 @item -nocpp
17707 @opindex nocpp
17708 Tell the MIPS assembler to not run its preprocessor over user
17709 assembler files (with a @samp{.s} suffix) when assembling them.
17711 @item -mfix-24k
17712 @item -mno-fix-24k
17713 @opindex mfix-24k
17714 @opindex mno-fix-24k
17715 Work around the 24K E48 (lost data on stores during refill) errata.
17716 The workarounds are implemented by the assembler rather than by GCC@.
17718 @item -mfix-r4000
17719 @itemx -mno-fix-r4000
17720 @opindex mfix-r4000
17721 @opindex mno-fix-r4000
17722 Work around certain R4000 CPU errata:
17723 @itemize @minus
17724 @item
17725 A double-word or a variable shift may give an incorrect result if executed
17726 immediately after starting an integer division.
17727 @item
17728 A double-word or a variable shift may give an incorrect result if executed
17729 while an integer multiplication is in progress.
17730 @item
17731 An integer division may give an incorrect result if started in a delay slot
17732 of a taken branch or a jump.
17733 @end itemize
17735 @item -mfix-r4400
17736 @itemx -mno-fix-r4400
17737 @opindex mfix-r4400
17738 @opindex mno-fix-r4400
17739 Work around certain R4400 CPU errata:
17740 @itemize @minus
17741 @item
17742 A double-word or a variable shift may give an incorrect result if executed
17743 immediately after starting an integer division.
17744 @end itemize
17746 @item -mfix-r10000
17747 @itemx -mno-fix-r10000
17748 @opindex mfix-r10000
17749 @opindex mno-fix-r10000
17750 Work around certain R10000 errata:
17751 @itemize @minus
17752 @item
17753 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17754 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17755 @end itemize
17757 This option can only be used if the target architecture supports
17758 branch-likely instructions.  @option{-mfix-r10000} is the default when
17759 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17760 otherwise.
17762 @item -mfix-rm7000
17763 @itemx -mno-fix-rm7000
17764 @opindex mfix-rm7000
17765 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17766 workarounds are implemented by the assembler rather than by GCC@.
17768 @item -mfix-vr4120
17769 @itemx -mno-fix-vr4120
17770 @opindex mfix-vr4120
17771 Work around certain VR4120 errata:
17772 @itemize @minus
17773 @item
17774 @code{dmultu} does not always produce the correct result.
17775 @item
17776 @code{div} and @code{ddiv} do not always produce the correct result if one
17777 of the operands is negative.
17778 @end itemize
17779 The workarounds for the division errata rely on special functions in
17780 @file{libgcc.a}.  At present, these functions are only provided by
17781 the @code{mips64vr*-elf} configurations.
17783 Other VR4120 errata require a NOP to be inserted between certain pairs of
17784 instructions.  These errata are handled by the assembler, not by GCC itself.
17786 @item -mfix-vr4130
17787 @opindex mfix-vr4130
17788 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17789 workarounds are implemented by the assembler rather than by GCC,
17790 although GCC avoids using @code{mflo} and @code{mfhi} if the
17791 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17792 instructions are available instead.
17794 @item -mfix-sb1
17795 @itemx -mno-fix-sb1
17796 @opindex mfix-sb1
17797 Work around certain SB-1 CPU core errata.
17798 (This flag currently works around the SB-1 revision 2
17799 ``F1'' and ``F2'' floating-point errata.)
17801 @item -mr10k-cache-barrier=@var{setting}
17802 @opindex mr10k-cache-barrier
17803 Specify whether GCC should insert cache barriers to avoid the
17804 side-effects of speculation on R10K processors.
17806 In common with many processors, the R10K tries to predict the outcome
17807 of a conditional branch and speculatively executes instructions from
17808 the ``taken'' branch.  It later aborts these instructions if the
17809 predicted outcome is wrong.  However, on the R10K, even aborted
17810 instructions can have side effects.
17812 This problem only affects kernel stores and, depending on the system,
17813 kernel loads.  As an example, a speculatively-executed store may load
17814 the target memory into cache and mark the cache line as dirty, even if
17815 the store itself is later aborted.  If a DMA operation writes to the
17816 same area of memory before the ``dirty'' line is flushed, the cached
17817 data overwrites the DMA-ed data.  See the R10K processor manual
17818 for a full description, including other potential problems.
17820 One workaround is to insert cache barrier instructions before every memory
17821 access that might be speculatively executed and that might have side
17822 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17823 controls GCC's implementation of this workaround.  It assumes that
17824 aborted accesses to any byte in the following regions does not have
17825 side effects:
17827 @enumerate
17828 @item
17829 the memory occupied by the current function's stack frame;
17831 @item
17832 the memory occupied by an incoming stack argument;
17834 @item
17835 the memory occupied by an object with a link-time-constant address.
17836 @end enumerate
17838 It is the kernel's responsibility to ensure that speculative
17839 accesses to these regions are indeed safe.
17841 If the input program contains a function declaration such as:
17843 @smallexample
17844 void foo (void);
17845 @end smallexample
17847 then the implementation of @code{foo} must allow @code{j foo} and
17848 @code{jal foo} to be executed speculatively.  GCC honors this
17849 restriction for functions it compiles itself.  It expects non-GCC
17850 functions (such as hand-written assembly code) to do the same.
17852 The option has three forms:
17854 @table @gcctabopt
17855 @item -mr10k-cache-barrier=load-store
17856 Insert a cache barrier before a load or store that might be
17857 speculatively executed and that might have side effects even
17858 if aborted.
17860 @item -mr10k-cache-barrier=store
17861 Insert a cache barrier before a store that might be speculatively
17862 executed and that might have side effects even if aborted.
17864 @item -mr10k-cache-barrier=none
17865 Disable the insertion of cache barriers.  This is the default setting.
17866 @end table
17868 @item -mflush-func=@var{func}
17869 @itemx -mno-flush-func
17870 @opindex mflush-func
17871 Specifies the function to call to flush the I and D caches, or to not
17872 call any such function.  If called, the function must take the same
17873 arguments as the common @code{_flush_func}, that is, the address of the
17874 memory range for which the cache is being flushed, the size of the
17875 memory range, and the number 3 (to flush both caches).  The default
17876 depends on the target GCC was configured for, but commonly is either
17877 @code{_flush_func} or @code{__cpu_flush}.
17879 @item mbranch-cost=@var{num}
17880 @opindex mbranch-cost
17881 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17882 This cost is only a heuristic and is not guaranteed to produce
17883 consistent results across releases.  A zero cost redundantly selects
17884 the default, which is based on the @option{-mtune} setting.
17886 @item -mbranch-likely
17887 @itemx -mno-branch-likely
17888 @opindex mbranch-likely
17889 @opindex mno-branch-likely
17890 Enable or disable use of Branch Likely instructions, regardless of the
17891 default for the selected architecture.  By default, Branch Likely
17892 instructions may be generated if they are supported by the selected
17893 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17894 and processors that implement those architectures; for those, Branch
17895 Likely instructions are not be generated by default because the MIPS32
17896 and MIPS64 architectures specifically deprecate their use.
17898 @item -mfp-exceptions
17899 @itemx -mno-fp-exceptions
17900 @opindex mfp-exceptions
17901 Specifies whether FP exceptions are enabled.  This affects how
17902 FP instructions are scheduled for some processors.
17903 The default is that FP exceptions are
17904 enabled.
17906 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17907 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17908 FP pipe.
17910 @item -mvr4130-align
17911 @itemx -mno-vr4130-align
17912 @opindex mvr4130-align
17913 The VR4130 pipeline is two-way superscalar, but can only issue two
17914 instructions together if the first one is 8-byte aligned.  When this
17915 option is enabled, GCC aligns pairs of instructions that it
17916 thinks should execute in parallel.
17918 This option only has an effect when optimizing for the VR4130.
17919 It normally makes code faster, but at the expense of making it bigger.
17920 It is enabled by default at optimization level @option{-O3}.
17922 @item -msynci
17923 @itemx -mno-synci
17924 @opindex msynci
17925 Enable (disable) generation of @code{synci} instructions on
17926 architectures that support it.  The @code{synci} instructions (if
17927 enabled) are generated when @code{__builtin___clear_cache} is
17928 compiled.
17930 This option defaults to @option{-mno-synci}, but the default can be
17931 overridden by configuring GCC with @option{--with-synci}.
17933 When compiling code for single processor systems, it is generally safe
17934 to use @code{synci}.  However, on many multi-core (SMP) systems, it
17935 does not invalidate the instruction caches on all cores and may lead
17936 to undefined behavior.
17938 @item -mrelax-pic-calls
17939 @itemx -mno-relax-pic-calls
17940 @opindex mrelax-pic-calls
17941 Try to turn PIC calls that are normally dispatched via register
17942 @code{$25} into direct calls.  This is only possible if the linker can
17943 resolve the destination at link-time and if the destination is within
17944 range for a direct call.
17946 @option{-mrelax-pic-calls} is the default if GCC was configured to use
17947 an assembler and a linker that support the @code{.reloc} assembly
17948 directive and @option{-mexplicit-relocs} is in effect.  With
17949 @option{-mno-explicit-relocs}, this optimization can be performed by the
17950 assembler and the linker alone without help from the compiler.
17952 @item -mmcount-ra-address
17953 @itemx -mno-mcount-ra-address
17954 @opindex mmcount-ra-address
17955 @opindex mno-mcount-ra-address
17956 Emit (do not emit) code that allows @code{_mcount} to modify the
17957 calling function's return address.  When enabled, this option extends
17958 the usual @code{_mcount} interface with a new @var{ra-address}
17959 parameter, which has type @code{intptr_t *} and is passed in register
17960 @code{$12}.  @code{_mcount} can then modify the return address by
17961 doing both of the following:
17962 @itemize
17963 @item
17964 Returning the new address in register @code{$31}.
17965 @item
17966 Storing the new address in @code{*@var{ra-address}},
17967 if @var{ra-address} is nonnull.
17968 @end itemize
17970 The default is @option{-mno-mcount-ra-address}.
17972 @end table
17974 @node MMIX Options
17975 @subsection MMIX Options
17976 @cindex MMIX Options
17978 These options are defined for the MMIX:
17980 @table @gcctabopt
17981 @item -mlibfuncs
17982 @itemx -mno-libfuncs
17983 @opindex mlibfuncs
17984 @opindex mno-libfuncs
17985 Specify that intrinsic library functions are being compiled, passing all
17986 values in registers, no matter the size.
17988 @item -mepsilon
17989 @itemx -mno-epsilon
17990 @opindex mepsilon
17991 @opindex mno-epsilon
17992 Generate floating-point comparison instructions that compare with respect
17993 to the @code{rE} epsilon register.
17995 @item -mabi=mmixware
17996 @itemx -mabi=gnu
17997 @opindex mabi=mmixware
17998 @opindex mabi=gnu
17999 Generate code that passes function parameters and return values that (in
18000 the called function) are seen as registers @code{$0} and up, as opposed to
18001 the GNU ABI which uses global registers @code{$231} and up.
18003 @item -mzero-extend
18004 @itemx -mno-zero-extend
18005 @opindex mzero-extend
18006 @opindex mno-zero-extend
18007 When reading data from memory in sizes shorter than 64 bits, use (do not
18008 use) zero-extending load instructions by default, rather than
18009 sign-extending ones.
18011 @item -mknuthdiv
18012 @itemx -mno-knuthdiv
18013 @opindex mknuthdiv
18014 @opindex mno-knuthdiv
18015 Make the result of a division yielding a remainder have the same sign as
18016 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18017 remainder follows the sign of the dividend.  Both methods are
18018 arithmetically valid, the latter being almost exclusively used.
18020 @item -mtoplevel-symbols
18021 @itemx -mno-toplevel-symbols
18022 @opindex mtoplevel-symbols
18023 @opindex mno-toplevel-symbols
18024 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18025 code can be used with the @code{PREFIX} assembly directive.
18027 @item -melf
18028 @opindex melf
18029 Generate an executable in the ELF format, rather than the default
18030 @samp{mmo} format used by the @command{mmix} simulator.
18032 @item -mbranch-predict
18033 @itemx -mno-branch-predict
18034 @opindex mbranch-predict
18035 @opindex mno-branch-predict
18036 Use (do not use) the probable-branch instructions, when static branch
18037 prediction indicates a probable branch.
18039 @item -mbase-addresses
18040 @itemx -mno-base-addresses
18041 @opindex mbase-addresses
18042 @opindex mno-base-addresses
18043 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18044 base address automatically generates a request (handled by the assembler
18045 and the linker) for a constant to be set up in a global register.  The
18046 register is used for one or more base address requests within the range 0
18047 to 255 from the value held in the register.  The generally leads to short
18048 and fast code, but the number of different data items that can be
18049 addressed is limited.  This means that a program that uses lots of static
18050 data may require @option{-mno-base-addresses}.
18052 @item -msingle-exit
18053 @itemx -mno-single-exit
18054 @opindex msingle-exit
18055 @opindex mno-single-exit
18056 Force (do not force) generated code to have a single exit point in each
18057 function.
18058 @end table
18060 @node MN10300 Options
18061 @subsection MN10300 Options
18062 @cindex MN10300 options
18064 These @option{-m} options are defined for Matsushita MN10300 architectures:
18066 @table @gcctabopt
18067 @item -mmult-bug
18068 @opindex mmult-bug
18069 Generate code to avoid bugs in the multiply instructions for the MN10300
18070 processors.  This is the default.
18072 @item -mno-mult-bug
18073 @opindex mno-mult-bug
18074 Do not generate code to avoid bugs in the multiply instructions for the
18075 MN10300 processors.
18077 @item -mam33
18078 @opindex mam33
18079 Generate code using features specific to the AM33 processor.
18081 @item -mno-am33
18082 @opindex mno-am33
18083 Do not generate code using features specific to the AM33 processor.  This
18084 is the default.
18086 @item -mam33-2
18087 @opindex mam33-2
18088 Generate code using features specific to the AM33/2.0 processor.
18090 @item -mam34
18091 @opindex mam34
18092 Generate code using features specific to the AM34 processor.
18094 @item -mtune=@var{cpu-type}
18095 @opindex mtune
18096 Use the timing characteristics of the indicated CPU type when
18097 scheduling instructions.  This does not change the targeted processor
18098 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18099 @samp{am33-2} or @samp{am34}.
18101 @item -mreturn-pointer-on-d0
18102 @opindex mreturn-pointer-on-d0
18103 When generating a function that returns a pointer, return the pointer
18104 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18105 only in @code{a0}, and attempts to call such functions without a prototype
18106 result in errors.  Note that this option is on by default; use
18107 @option{-mno-return-pointer-on-d0} to disable it.
18109 @item -mno-crt0
18110 @opindex mno-crt0
18111 Do not link in the C run-time initialization object file.
18113 @item -mrelax
18114 @opindex mrelax
18115 Indicate to the linker that it should perform a relaxation optimization pass
18116 to shorten branches, calls and absolute memory addresses.  This option only
18117 has an effect when used on the command line for the final link step.
18119 This option makes symbolic debugging impossible.
18121 @item -mliw
18122 @opindex mliw
18123 Allow the compiler to generate @emph{Long Instruction Word}
18124 instructions if the target is the @samp{AM33} or later.  This is the
18125 default.  This option defines the preprocessor macro @code{__LIW__}.
18127 @item -mnoliw
18128 @opindex mnoliw
18129 Do not allow the compiler to generate @emph{Long Instruction Word}
18130 instructions.  This option defines the preprocessor macro
18131 @code{__NO_LIW__}.
18133 @item -msetlb
18134 @opindex msetlb
18135 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18136 instructions if the target is the @samp{AM33} or later.  This is the
18137 default.  This option defines the preprocessor macro @code{__SETLB__}.
18139 @item -mnosetlb
18140 @opindex mnosetlb
18141 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18142 instructions.  This option defines the preprocessor macro
18143 @code{__NO_SETLB__}.
18145 @end table
18147 @node Moxie Options
18148 @subsection Moxie Options
18149 @cindex Moxie Options
18151 @table @gcctabopt
18153 @item -meb
18154 @opindex meb
18155 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18156 configurations.
18158 @item -mel
18159 @opindex mel
18160 Generate little-endian code.
18162 @item -mmul.x
18163 @opindex mmul.x
18164 Generate mul.x and umul.x instructions.  This is the default for
18165 @samp{moxiebox-*-*} configurations.
18167 @item -mno-crt0
18168 @opindex mno-crt0
18169 Do not link in the C run-time initialization object file.
18171 @end table
18173 @node MSP430 Options
18174 @subsection MSP430 Options
18175 @cindex MSP430 Options
18177 These options are defined for the MSP430:
18179 @table @gcctabopt
18181 @item -masm-hex
18182 @opindex masm-hex
18183 Force assembly output to always use hex constants.  Normally such
18184 constants are signed decimals, but this option is available for
18185 testsuite and/or aesthetic purposes.
18187 @item -mmcu=
18188 @opindex mmcu=
18189 Select the MCU to target.  This is used to create a C preprocessor
18190 symbol based upon the MCU name, converted to upper case and pre- and
18191 post-fixed with @samp{__}.  This in turn is used by the
18192 @file{msp430.h} header file to select an MCU-specific supplementary
18193 header file.
18195 The option also sets the ISA to use.  If the MCU name is one that is
18196 known to only support the 430 ISA then that is selected, otherwise the
18197 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
18198 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
18199 name selects the 430X ISA.
18201 In addition an MCU-specific linker script is added to the linker
18202 command line.  The script's name is the name of the MCU with
18203 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
18204 command line defines the C preprocessor symbol @code{__XXX__} and
18205 cause the linker to search for a script called @file{xxx.ld}.
18207 This option is also passed on to the assembler.
18209 @item -mcpu=
18210 @opindex mcpu=
18211 Specifies the ISA to use.  Accepted values are @samp{msp430},
18212 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
18213 @option{-mmcu=} option should be used to select the ISA.
18215 @item -msim
18216 @opindex msim
18217 Link to the simulator runtime libraries and linker script.  Overrides
18218 any scripts that would be selected by the @option{-mmcu=} option.
18220 @item -mlarge
18221 @opindex mlarge
18222 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18224 @item -msmall
18225 @opindex msmall
18226 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18228 @item -mrelax
18229 @opindex mrelax
18230 This option is passed to the assembler and linker, and allows the
18231 linker to perform certain optimizations that cannot be done until
18232 the final link.
18234 @item mhwmult=
18235 @opindex mhwmult=
18236 Describes the type of hardware multiply supported by the target.
18237 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
18238 for the original 16-bit-only multiply supported by early MCUs.
18239 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
18240 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18241 A value of @samp{auto} can also be given.  This tells GCC to deduce
18242 the hardware multiply support based upon the MCU name provided by the
18243 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18244 @samp{32bit} hardware multiply support is assumed.  @samp{auto} is the
18245 default setting.
18247 Hardware multiplies are normally performed by calling a library
18248 routine.  This saves space in the generated code.  When compiling at
18249 @option{-O3} or higher however the hardware multiplier is invoked
18250 inline.  This makes for bigger, but faster code.
18252 The hardware multiply routines disable interrupts whilst running and
18253 restore the previous interrupt state when they finish.  This makes
18254 them safe to use inside interrupt handlers as well as in normal code.
18256 @item -minrt
18257 @opindex minrt
18258 Enable the use of a minimum runtime environment - no static
18259 initializers or constructors.  This is intended for memory-constrained
18260 devices.  The compiler includes special symbols in some objects
18261 that tell the linker and runtime which code fragments are required.
18263 @item -mcode-region=
18264 @itemx -mdata-region=
18265 @opindex mcode-region
18266 @opindex mdata-region
18267 These options tell the compiler where to place functions and data that
18268 do not have one of the @code{lower}, @code{upper}, @code{either} or
18269 @code{section} attributes.  Possible values are @code{lower},
18270 @code{upper}, @code{either} or @code{any}.  The first three behave
18271 like the corresponding attribute.  The fourth possible value -
18272 @code{any} - is the default.  It leaves placement entirely up to the
18273 linker script and how it assigns the standard sections (.text, .data
18274 etc) to the memory regions.
18276 @end table
18278 @node NDS32 Options
18279 @subsection NDS32 Options
18280 @cindex NDS32 Options
18282 These options are defined for NDS32 implementations:
18284 @table @gcctabopt
18286 @item -mbig-endian
18287 @opindex mbig-endian
18288 Generate code in big-endian mode.
18290 @item -mlittle-endian
18291 @opindex mlittle-endian
18292 Generate code in little-endian mode.
18294 @item -mreduced-regs
18295 @opindex mreduced-regs
18296 Use reduced-set registers for register allocation.
18298 @item -mfull-regs
18299 @opindex mfull-regs
18300 Use full-set registers for register allocation.
18302 @item -mcmov
18303 @opindex mcmov
18304 Generate conditional move instructions.
18306 @item -mno-cmov
18307 @opindex mno-cmov
18308 Do not generate conditional move instructions.
18310 @item -mperf-ext
18311 @opindex mperf-ext
18312 Generate performance extension instructions.
18314 @item -mno-perf-ext
18315 @opindex mno-perf-ext
18316 Do not generate performance extension instructions.
18318 @item -mv3push
18319 @opindex mv3push
18320 Generate v3 push25/pop25 instructions.
18322 @item -mno-v3push
18323 @opindex mno-v3push
18324 Do not generate v3 push25/pop25 instructions.
18326 @item -m16-bit
18327 @opindex m16-bit
18328 Generate 16-bit instructions.
18330 @item -mno-16-bit
18331 @opindex mno-16-bit
18332 Do not generate 16-bit instructions.
18334 @item -misr-vector-size=@var{num}
18335 @opindex misr-vector-size
18336 Specify the size of each interrupt vector, which must be 4 or 16.
18338 @item -mcache-block-size=@var{num}
18339 @opindex mcache-block-size
18340 Specify the size of each cache block,
18341 which must be a power of 2 between 4 and 512.
18343 @item -march=@var{arch}
18344 @opindex march
18345 Specify the name of the target architecture.
18347 @item -mcmodel=@var{code-model}
18348 @opindex mcmodel
18349 Set the code model to one of
18350 @table @asis
18351 @item @samp{small}
18352 All the data and read-only data segments must be within 512KB addressing space.
18353 The text segment must be within 16MB addressing space.
18354 @item @samp{medium}
18355 The data segment must be within 512KB while the read-only data segment can be
18356 within 4GB addressing space.  The text segment should be still within 16MB
18357 addressing space.
18358 @item @samp{large}
18359 All the text and data segments can be within 4GB addressing space.
18360 @end table
18362 @item -mctor-dtor
18363 @opindex mctor-dtor
18364 Enable constructor/destructor feature.
18366 @item -mrelax
18367 @opindex mrelax
18368 Guide linker to relax instructions.
18370 @end table
18372 @node Nios II Options
18373 @subsection Nios II Options
18374 @cindex Nios II options
18375 @cindex Altera Nios II options
18377 These are the options defined for the Altera Nios II processor.
18379 @table @gcctabopt
18381 @item -G @var{num}
18382 @opindex G
18383 @cindex smaller data references
18384 Put global and static objects less than or equal to @var{num} bytes
18385 into the small data or BSS sections instead of the normal data or BSS
18386 sections.  The default value of @var{num} is 8.
18388 @item -mgpopt=@var{option}
18389 @item -mgpopt
18390 @itemx -mno-gpopt
18391 @opindex mgpopt
18392 @opindex mno-gpopt
18393 Generate (do not generate) GP-relative accesses.  The following 
18394 @var{option} names are recognized:
18396 @table @samp
18398 @item none
18399 Do not generate GP-relative accesses.
18401 @item local
18402 Generate GP-relative accesses for small data objects that are not 
18403 external or weak.  Also use GP-relative addressing for objects that
18404 have been explicitly placed in a small data section via a @code{section}
18405 attribute.
18407 @item global
18408 As for @samp{local}, but also generate GP-relative accesses for
18409 small data objects that are external or weak.  If you use this option,
18410 you must ensure that all parts of your program (including libraries) are
18411 compiled with the same @option{-G} setting.
18413 @item data
18414 Generate GP-relative accesses for all data objects in the program.  If you
18415 use this option, the entire data and BSS segments
18416 of your program must fit in 64K of memory and you must use an appropriate
18417 linker script to allocate them within the addressible range of the
18418 global pointer.
18420 @item all
18421 Generate GP-relative addresses for function pointers as well as data
18422 pointers.  If you use this option, the entire text, data, and BSS segments
18423 of your program must fit in 64K of memory and you must use an appropriate
18424 linker script to allocate them within the addressible range of the
18425 global pointer.
18427 @end table
18429 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
18430 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
18432 The default is @option{-mgpopt} except when @option{-fpic} or
18433 @option{-fPIC} is specified to generate position-independent code.
18434 Note that the Nios II ABI does not permit GP-relative accesses from
18435 shared libraries.
18437 You may need to specify @option{-mno-gpopt} explicitly when building
18438 programs that include large amounts of small data, including large
18439 GOT data sections.  In this case, the 16-bit offset for GP-relative
18440 addressing may not be large enough to allow access to the entire 
18441 small data section.
18443 @item -mel
18444 @itemx -meb
18445 @opindex mel
18446 @opindex meb
18447 Generate little-endian (default) or big-endian (experimental) code,
18448 respectively.
18450 @item -march=@var{arch}
18451 @opindex march
18452 This specifies the name of the target Nios II architecture.  GCC uses this
18453 name to determine what kind of instructions it can emit when generating
18454 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
18456 The preprocessor macro @code{__nios2_arch__} is available to programs,
18457 with value 1 or 2, indicating the targeted ISA level.
18459 @item -mbypass-cache
18460 @itemx -mno-bypass-cache
18461 @opindex mno-bypass-cache
18462 @opindex mbypass-cache
18463 Force all load and store instructions to always bypass cache by 
18464 using I/O variants of the instructions. The default is not to
18465 bypass the cache.
18467 @item -mno-cache-volatile 
18468 @itemx -mcache-volatile       
18469 @opindex mcache-volatile 
18470 @opindex mno-cache-volatile
18471 Volatile memory access bypass the cache using the I/O variants of 
18472 the load and store instructions. The default is not to bypass the cache.
18474 @item -mno-fast-sw-div
18475 @itemx -mfast-sw-div
18476 @opindex mno-fast-sw-div
18477 @opindex mfast-sw-div
18478 Do not use table-based fast divide for small numbers. The default 
18479 is to use the fast divide at @option{-O3} and above.
18481 @item -mno-hw-mul
18482 @itemx -mhw-mul
18483 @itemx -mno-hw-mulx
18484 @itemx -mhw-mulx
18485 @itemx -mno-hw-div
18486 @itemx -mhw-div
18487 @opindex mno-hw-mul
18488 @opindex mhw-mul
18489 @opindex mno-hw-mulx
18490 @opindex mhw-mulx
18491 @opindex mno-hw-div
18492 @opindex mhw-div
18493 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18494 instructions by the compiler. The default is to emit @code{mul}
18495 and not emit @code{div} and @code{mulx}.
18497 @item -mbmx
18498 @itemx -mno-bmx
18499 @itemx -mcdx
18500 @itemx -mno-cdx
18501 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
18502 CDX (code density) instructions.  Enabling these instructions also
18503 requires @option{-march=r2}.  Since these instructions are optional
18504 extensions to the R2 architecture, the default is not to emit them.
18506 @item -mcustom-@var{insn}=@var{N}
18507 @itemx -mno-custom-@var{insn}
18508 @opindex mcustom-@var{insn}
18509 @opindex mno-custom-@var{insn}
18510 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18511 custom instruction with encoding @var{N} when generating code that uses 
18512 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
18513 instruction 253 for single-precision floating-point add operations instead
18514 of the default behavior of using a library call.
18516 The following values of @var{insn} are supported.  Except as otherwise
18517 noted, floating-point operations are expected to be implemented with
18518 normal IEEE 754 semantics and correspond directly to the C operators or the
18519 equivalent GCC built-in functions (@pxref{Other Builtins}).
18521 Single-precision floating point:
18522 @table @asis
18524 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18525 Binary arithmetic operations.
18527 @item @samp{fnegs}
18528 Unary negation.
18530 @item @samp{fabss}
18531 Unary absolute value.
18533 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18534 Comparison operations.
18536 @item @samp{fmins}, @samp{fmaxs}
18537 Floating-point minimum and maximum.  These instructions are only
18538 generated if @option{-ffinite-math-only} is specified.
18540 @item @samp{fsqrts}
18541 Unary square root operation.
18543 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18544 Floating-point trigonometric and exponential functions.  These instructions
18545 are only generated if @option{-funsafe-math-optimizations} is also specified.
18547 @end table
18549 Double-precision floating point:
18550 @table @asis
18552 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18553 Binary arithmetic operations.
18555 @item @samp{fnegd}
18556 Unary negation.
18558 @item @samp{fabsd}
18559 Unary absolute value.
18561 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18562 Comparison operations.
18564 @item @samp{fmind}, @samp{fmaxd}
18565 Double-precision minimum and maximum.  These instructions are only
18566 generated if @option{-ffinite-math-only} is specified.
18568 @item @samp{fsqrtd}
18569 Unary square root operation.
18571 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18572 Double-precision trigonometric and exponential functions.  These instructions
18573 are only generated if @option{-funsafe-math-optimizations} is also specified.
18575 @end table
18577 Conversions:
18578 @table @asis
18579 @item @samp{fextsd}
18580 Conversion from single precision to double precision.
18582 @item @samp{ftruncds}
18583 Conversion from double precision to single precision.
18585 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18586 Conversion from floating point to signed or unsigned integer types, with
18587 truncation towards zero.
18589 @item @samp{round}
18590 Conversion from single-precision floating point to signed integer,
18591 rounding to the nearest integer and ties away from zero.
18592 This corresponds to the @code{__builtin_lroundf} function when
18593 @option{-fno-math-errno} is used.
18595 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18596 Conversion from signed or unsigned integer types to floating-point types.
18598 @end table
18600 In addition, all of the following transfer instructions for internal
18601 registers X and Y must be provided to use any of the double-precision
18602 floating-point instructions.  Custom instructions taking two
18603 double-precision source operands expect the first operand in the
18604 64-bit register X.  The other operand (or only operand of a unary
18605 operation) is given to the custom arithmetic instruction with the
18606 least significant half in source register @var{src1} and the most
18607 significant half in @var{src2}.  A custom instruction that returns a
18608 double-precision result returns the most significant 32 bits in the
18609 destination register and the other half in 32-bit register Y.  
18610 GCC automatically generates the necessary code sequences to write
18611 register X and/or read register Y when double-precision floating-point
18612 instructions are used.
18614 @table @asis
18616 @item @samp{fwrx}
18617 Write @var{src1} into the least significant half of X and @var{src2} into
18618 the most significant half of X.
18620 @item @samp{fwry}
18621 Write @var{src1} into Y.
18623 @item @samp{frdxhi}, @samp{frdxlo}
18624 Read the most or least (respectively) significant half of X and store it in
18625 @var{dest}.
18627 @item @samp{frdy}
18628 Read the value of Y and store it into @var{dest}.
18629 @end table
18631 Note that you can gain more local control over generation of Nios II custom
18632 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18633 and @code{target("no-custom-@var{insn}")} function attributes
18634 (@pxref{Function Attributes})
18635 or pragmas (@pxref{Function Specific Option Pragmas}).
18637 @item -mcustom-fpu-cfg=@var{name}
18638 @opindex mcustom-fpu-cfg
18640 This option enables a predefined, named set of custom instruction encodings
18641 (see @option{-mcustom-@var{insn}} above).  
18642 Currently, the following sets are defined:
18644 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18645 @gccoptlist{-mcustom-fmuls=252 @gol
18646 -mcustom-fadds=253 @gol
18647 -mcustom-fsubs=254 @gol
18648 -fsingle-precision-constant}
18650 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18651 @gccoptlist{-mcustom-fmuls=252 @gol
18652 -mcustom-fadds=253 @gol
18653 -mcustom-fsubs=254 @gol
18654 -mcustom-fdivs=255 @gol
18655 -fsingle-precision-constant}
18657 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18658 @gccoptlist{-mcustom-floatus=243 @gol
18659 -mcustom-fixsi=244 @gol
18660 -mcustom-floatis=245 @gol
18661 -mcustom-fcmpgts=246 @gol
18662 -mcustom-fcmples=249 @gol
18663 -mcustom-fcmpeqs=250 @gol
18664 -mcustom-fcmpnes=251 @gol
18665 -mcustom-fmuls=252 @gol
18666 -mcustom-fadds=253 @gol
18667 -mcustom-fsubs=254 @gol
18668 -mcustom-fdivs=255 @gol
18669 -fsingle-precision-constant}
18671 Custom instruction assignments given by individual
18672 @option{-mcustom-@var{insn}=} options override those given by
18673 @option{-mcustom-fpu-cfg=}, regardless of the
18674 order of the options on the command line.
18676 Note that you can gain more local control over selection of a FPU
18677 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18678 function attribute (@pxref{Function Attributes})
18679 or pragma (@pxref{Function Specific Option Pragmas}).
18681 @end table
18683 These additional @samp{-m} options are available for the Altera Nios II
18684 ELF (bare-metal) target:
18686 @table @gcctabopt
18688 @item -mhal
18689 @opindex mhal
18690 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18691 startup and termination code, and is typically used in conjunction with
18692 @option{-msys-crt0=} to specify the location of the alternate startup code
18693 provided by the HAL BSP.
18695 @item -msmallc
18696 @opindex msmallc
18697 Link with a limited version of the C library, @option{-lsmallc}, rather than
18698 Newlib.
18700 @item -msys-crt0=@var{startfile}
18701 @opindex msys-crt0
18702 @var{startfile} is the file name of the startfile (crt0) to use 
18703 when linking.  This option is only useful in conjunction with @option{-mhal}.
18705 @item -msys-lib=@var{systemlib}
18706 @opindex msys-lib
18707 @var{systemlib} is the library name of the library that provides
18708 low-level system calls required by the C library,
18709 e.g. @code{read} and @code{write}.
18710 This option is typically used to link with a library provided by a HAL BSP.
18712 @end table
18714 @node Nvidia PTX Options
18715 @subsection Nvidia PTX Options
18716 @cindex Nvidia PTX options
18717 @cindex nvptx options
18719 These options are defined for Nvidia PTX:
18721 @table @gcctabopt
18723 @item -m32
18724 @itemx -m64
18725 @opindex m32
18726 @opindex m64
18727 Generate code for 32-bit or 64-bit ABI.
18729 @item -mmainkernel
18730 @opindex mmainkernel
18731 Link in code for a __main kernel.  This is for stand-alone instead of
18732 offloading execution.
18734 @end table
18736 @node PDP-11 Options
18737 @subsection PDP-11 Options
18738 @cindex PDP-11 Options
18740 These options are defined for the PDP-11:
18742 @table @gcctabopt
18743 @item -mfpu
18744 @opindex mfpu
18745 Use hardware FPP floating point.  This is the default.  (FIS floating
18746 point on the PDP-11/40 is not supported.)
18748 @item -msoft-float
18749 @opindex msoft-float
18750 Do not use hardware floating point.
18752 @item -mac0
18753 @opindex mac0
18754 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18756 @item -mno-ac0
18757 @opindex mno-ac0
18758 Return floating-point results in memory.  This is the default.
18760 @item -m40
18761 @opindex m40
18762 Generate code for a PDP-11/40.
18764 @item -m45
18765 @opindex m45
18766 Generate code for a PDP-11/45.  This is the default.
18768 @item -m10
18769 @opindex m10
18770 Generate code for a PDP-11/10.
18772 @item -mbcopy-builtin
18773 @opindex mbcopy-builtin
18774 Use inline @code{movmemhi} patterns for copying memory.  This is the
18775 default.
18777 @item -mbcopy
18778 @opindex mbcopy
18779 Do not use inline @code{movmemhi} patterns for copying memory.
18781 @item -mint16
18782 @itemx -mno-int32
18783 @opindex mint16
18784 @opindex mno-int32
18785 Use 16-bit @code{int}.  This is the default.
18787 @item -mint32
18788 @itemx -mno-int16
18789 @opindex mint32
18790 @opindex mno-int16
18791 Use 32-bit @code{int}.
18793 @item -mfloat64
18794 @itemx -mno-float32
18795 @opindex mfloat64
18796 @opindex mno-float32
18797 Use 64-bit @code{float}.  This is the default.
18799 @item -mfloat32
18800 @itemx -mno-float64
18801 @opindex mfloat32
18802 @opindex mno-float64
18803 Use 32-bit @code{float}.
18805 @item -mabshi
18806 @opindex mabshi
18807 Use @code{abshi2} pattern.  This is the default.
18809 @item -mno-abshi
18810 @opindex mno-abshi
18811 Do not use @code{abshi2} pattern.
18813 @item -mbranch-expensive
18814 @opindex mbranch-expensive
18815 Pretend that branches are expensive.  This is for experimenting with
18816 code generation only.
18818 @item -mbranch-cheap
18819 @opindex mbranch-cheap
18820 Do not pretend that branches are expensive.  This is the default.
18822 @item -munix-asm
18823 @opindex munix-asm
18824 Use Unix assembler syntax.  This is the default when configured for
18825 @samp{pdp11-*-bsd}.
18827 @item -mdec-asm
18828 @opindex mdec-asm
18829 Use DEC assembler syntax.  This is the default when configured for any
18830 PDP-11 target other than @samp{pdp11-*-bsd}.
18831 @end table
18833 @node picoChip Options
18834 @subsection picoChip Options
18835 @cindex picoChip options
18837 These @samp{-m} options are defined for picoChip implementations:
18839 @table @gcctabopt
18841 @item -mae=@var{ae_type}
18842 @opindex mcpu
18843 Set the instruction set, register set, and instruction scheduling
18844 parameters for array element type @var{ae_type}.  Supported values
18845 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18847 @option{-mae=ANY} selects a completely generic AE type.  Code
18848 generated with this option runs on any of the other AE types.  The
18849 code is not as efficient as it would be if compiled for a specific
18850 AE type, and some types of operation (e.g., multiplication) do not
18851 work properly on all types of AE.
18853 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18854 for compiled code, and is the default.
18856 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18857 option may suffer from poor performance of byte (char) manipulation,
18858 since the DSP AE does not provide hardware support for byte load/stores.
18860 @item -msymbol-as-address
18861 Enable the compiler to directly use a symbol name as an address in a
18862 load/store instruction, without first loading it into a
18863 register.  Typically, the use of this option generates larger
18864 programs, which run faster than when the option isn't used.  However, the
18865 results vary from program to program, so it is left as a user option,
18866 rather than being permanently enabled.
18868 @item -mno-inefficient-warnings
18869 Disables warnings about the generation of inefficient code.  These
18870 warnings can be generated, for example, when compiling code that
18871 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18872 no hardware support for byte-level memory operations, so all byte
18873 load/stores must be synthesized from word load/store operations.  This is
18874 inefficient and a warning is generated to indicate
18875 that you should rewrite the code to avoid byte operations, or to target
18876 an AE type that has the necessary hardware support.  This option disables
18877 these warnings.
18879 @end table
18881 @node PowerPC Options
18882 @subsection PowerPC Options
18883 @cindex PowerPC options
18885 These are listed under @xref{RS/6000 and PowerPC Options}.
18887 @node RL78 Options
18888 @subsection RL78 Options
18889 @cindex RL78 Options
18891 @table @gcctabopt
18893 @item -msim
18894 @opindex msim
18895 Links in additional target libraries to support operation within a
18896 simulator.
18898 @item -mmul=none
18899 @itemx -mmul=g10
18900 @itemx -mmul=g13
18901 @itemx -mmul=g14
18902 @itemx -mmul=rl78
18903 @opindex mmul
18904 Specifies the type of hardware multiplication and division support to
18905 be used.  The simplest is @code{none}, which uses software for both
18906 multiplication and division.  This is the default.  The @code{g13}
18907 value is for the hardware multiply/divide peripheral found on the
18908 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
18909 the multiplication and division instructions supported by the RL78/G14
18910 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
18911 the value @code{mg10} is an alias for @code{none}.
18913 In addition a C preprocessor macro is defined, based upon the setting
18914 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
18915 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
18917 @item -mcpu=g10
18918 @itemx -mcpu=g13
18919 @itemx -mcpu=g14
18920 @itemx -mcpu=rl78
18921 @opindex mcpu
18922 Specifies the RL78 core to target.  The default is the G14 core, also
18923 known as an S3 core or just RL78.  The G13 or S2 core does not have
18924 multiply or divide instructions, instead it uses a hardware peripheral
18925 for these operations.  The G10 or S1 core does not have register
18926 banks, so it uses a different calling convention.
18928 If this option is set it also selects the type of hardware multiply
18929 support to use, unless this is overridden by an explicit
18930 @option{-mmul=none} option on the command line.  Thus specifying
18931 @option{-mcpu=g13} enables the use of the G13 hardware multiply
18932 peripheral and specifying @option{-mcpu=g10} disables the use of
18933 hardware multipications altogether.
18935 Note, although the RL78/G14 core is the default target, specifying
18936 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
18937 change the behaviour of the toolchain since it also enables G14
18938 hardware multiply support.  If these options are not specified on the
18939 command line then software multiplication routines will be used even
18940 though the code targets the RL78 core.  This is for backwards
18941 compatibility with older toolchains which did not have hardware
18942 multiply and divide support.
18944 In addition a C preprocessor macro is defined, based upon the setting
18945 of this option.  Possible values are: @code{__RL78_G10__},
18946 @code{__RL78_G13__} or @code{__RL78_G14__}.
18948 @item -mg10
18949 @itemx -mg13
18950 @itemx -mg14
18951 @itemx -mrl78
18952 @opindex mg10
18953 @opindex mg13
18954 @opindex mg14
18955 @opindex mrl78
18956 These are aliases for the corresponding @option{-mcpu=} option.  They
18957 are provided for backwards compatibility.
18959 @item -mallregs
18960 @opindex mallregs
18961 Allow the compiler to use all of the available registers.  By default
18962 registers @code{r24..r31} are reserved for use in interrupt handlers.
18963 With this option enabled these registers can be used in ordinary
18964 functions as well.
18966 @item -m64bit-doubles
18967 @itemx -m32bit-doubles
18968 @opindex m64bit-doubles
18969 @opindex m32bit-doubles
18970 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18971 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18972 @option{-m32bit-doubles}.
18974 @end table
18976 @node RS/6000 and PowerPC Options
18977 @subsection IBM RS/6000 and PowerPC Options
18978 @cindex RS/6000 and PowerPC Options
18979 @cindex IBM RS/6000 and PowerPC Options
18981 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18982 @table @gcctabopt
18983 @item -mpowerpc-gpopt
18984 @itemx -mno-powerpc-gpopt
18985 @itemx -mpowerpc-gfxopt
18986 @itemx -mno-powerpc-gfxopt
18987 @need 800
18988 @itemx -mpowerpc64
18989 @itemx -mno-powerpc64
18990 @itemx -mmfcrf
18991 @itemx -mno-mfcrf
18992 @itemx -mpopcntb
18993 @itemx -mno-popcntb
18994 @itemx -mpopcntd
18995 @itemx -mno-popcntd
18996 @itemx -mfprnd
18997 @itemx -mno-fprnd
18998 @need 800
18999 @itemx -mcmpb
19000 @itemx -mno-cmpb
19001 @itemx -mmfpgpr
19002 @itemx -mno-mfpgpr
19003 @itemx -mhard-dfp
19004 @itemx -mno-hard-dfp
19005 @opindex mpowerpc-gpopt
19006 @opindex mno-powerpc-gpopt
19007 @opindex mpowerpc-gfxopt
19008 @opindex mno-powerpc-gfxopt
19009 @opindex mpowerpc64
19010 @opindex mno-powerpc64
19011 @opindex mmfcrf
19012 @opindex mno-mfcrf
19013 @opindex mpopcntb
19014 @opindex mno-popcntb
19015 @opindex mpopcntd
19016 @opindex mno-popcntd
19017 @opindex mfprnd
19018 @opindex mno-fprnd
19019 @opindex mcmpb
19020 @opindex mno-cmpb
19021 @opindex mmfpgpr
19022 @opindex mno-mfpgpr
19023 @opindex mhard-dfp
19024 @opindex mno-hard-dfp
19025 You use these options to specify which instructions are available on the
19026 processor you are using.  The default value of these options is
19027 determined when configuring GCC@.  Specifying the
19028 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19029 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19030 rather than the options listed above.
19032 Specifying @option{-mpowerpc-gpopt} allows
19033 GCC to use the optional PowerPC architecture instructions in the
19034 General Purpose group, including floating-point square root.  Specifying
19035 @option{-mpowerpc-gfxopt} allows GCC to
19036 use the optional PowerPC architecture instructions in the Graphics
19037 group, including floating-point select.
19039 The @option{-mmfcrf} option allows GCC to generate the move from
19040 condition register field instruction implemented on the POWER4
19041 processor and other processors that support the PowerPC V2.01
19042 architecture.
19043 The @option{-mpopcntb} option allows GCC to generate the popcount and
19044 double-precision FP reciprocal estimate instruction implemented on the
19045 POWER5 processor and other processors that support the PowerPC V2.02
19046 architecture.
19047 The @option{-mpopcntd} option allows GCC to generate the popcount
19048 instruction implemented on the POWER7 processor and other processors
19049 that support the PowerPC V2.06 architecture.
19050 The @option{-mfprnd} option allows GCC to generate the FP round to
19051 integer instructions implemented on the POWER5+ processor and other
19052 processors that support the PowerPC V2.03 architecture.
19053 The @option{-mcmpb} option allows GCC to generate the compare bytes
19054 instruction implemented on the POWER6 processor and other processors
19055 that support the PowerPC V2.05 architecture.
19056 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19057 general-purpose register instructions implemented on the POWER6X
19058 processor and other processors that support the extended PowerPC V2.05
19059 architecture.
19060 The @option{-mhard-dfp} option allows GCC to generate the decimal
19061 floating-point instructions implemented on some POWER processors.
19063 The @option{-mpowerpc64} option allows GCC to generate the additional
19064 64-bit instructions that are found in the full PowerPC64 architecture
19065 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19066 @option{-mno-powerpc64}.
19068 @item -mcpu=@var{cpu_type}
19069 @opindex mcpu
19070 Set architecture type, register usage, and
19071 instruction scheduling parameters for machine type @var{cpu_type}.
19072 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19073 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19074 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19075 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19076 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19077 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19078 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19079 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19080 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19081 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19082 @samp{powerpc64}, @samp{powerpc64le}, and @samp{rs64}.
19084 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
19085 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
19086 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
19087 architecture machine types, with an appropriate, generic processor
19088 model assumed for scheduling purposes.
19090 The other options specify a specific processor.  Code generated under
19091 those options runs best on that processor, and may not run at all on
19092 others.
19094 The @option{-mcpu} options automatically enable or disable the
19095 following options:
19097 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19098 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19099 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19100 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19101 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19102 -mquad-memory -mquad-memory-atomic}
19104 The particular options set for any particular CPU varies between
19105 compiler versions, depending on what setting seems to produce optimal
19106 code for that CPU; it doesn't necessarily reflect the actual hardware's
19107 capabilities.  If you wish to set an individual option to a particular
19108 value, you may specify it after the @option{-mcpu} option, like
19109 @option{-mcpu=970 -mno-altivec}.
19111 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19112 not enabled or disabled by the @option{-mcpu} option at present because
19113 AIX does not have full support for these options.  You may still
19114 enable or disable them individually if you're sure it'll work in your
19115 environment.
19117 @item -mtune=@var{cpu_type}
19118 @opindex mtune
19119 Set the instruction scheduling parameters for machine type
19120 @var{cpu_type}, but do not set the architecture type or register usage,
19121 as @option{-mcpu=@var{cpu_type}} does.  The same
19122 values for @var{cpu_type} are used for @option{-mtune} as for
19123 @option{-mcpu}.  If both are specified, the code generated uses the
19124 architecture and registers set by @option{-mcpu}, but the
19125 scheduling parameters set by @option{-mtune}.
19127 @item -mcmodel=small
19128 @opindex mcmodel=small
19129 Generate PowerPC64 code for the small model: The TOC is limited to
19130 64k.
19132 @item -mcmodel=medium
19133 @opindex mcmodel=medium
19134 Generate PowerPC64 code for the medium model: The TOC and other static
19135 data may be up to a total of 4G in size.
19137 @item -mcmodel=large
19138 @opindex mcmodel=large
19139 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19140 in size.  Other data and code is only limited by the 64-bit address
19141 space.
19143 @item -maltivec
19144 @itemx -mno-altivec
19145 @opindex maltivec
19146 @opindex mno-altivec
19147 Generate code that uses (does not use) AltiVec instructions, and also
19148 enable the use of built-in functions that allow more direct access to
19149 the AltiVec instruction set.  You may also need to set
19150 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19151 enhancements.
19153 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19154 @option{-maltivec=be}, the element order for Altivec intrinsics such
19155 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
19156 match array element order corresponding to the endianness of the
19157 target.  That is, element zero identifies the leftmost element in a
19158 vector register when targeting a big-endian platform, and identifies
19159 the rightmost element in a vector register when targeting a
19160 little-endian platform.
19162 @item -maltivec=be
19163 @opindex maltivec=be
19164 Generate Altivec instructions using big-endian element order,
19165 regardless of whether the target is big- or little-endian.  This is
19166 the default when targeting a big-endian platform.
19168 The element order is used to interpret element numbers in Altivec
19169 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19170 @code{vec_insert}.  By default, these match array element order
19171 corresponding to the endianness for the target.
19173 @item -maltivec=le
19174 @opindex maltivec=le
19175 Generate Altivec instructions using little-endian element order,
19176 regardless of whether the target is big- or little-endian.  This is
19177 the default when targeting a little-endian platform.  This option is
19178 currently ignored when targeting a big-endian platform.
19180 The element order is used to interpret element numbers in Altivec
19181 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19182 @code{vec_insert}.  By default, these match array element order
19183 corresponding to the endianness for the target.
19185 @item -mvrsave
19186 @itemx -mno-vrsave
19187 @opindex mvrsave
19188 @opindex mno-vrsave
19189 Generate VRSAVE instructions when generating AltiVec code.
19191 @item -mgen-cell-microcode
19192 @opindex mgen-cell-microcode
19193 Generate Cell microcode instructions.
19195 @item -mwarn-cell-microcode
19196 @opindex mwarn-cell-microcode
19197 Warn when a Cell microcode instruction is emitted.  An example
19198 of a Cell microcode instruction is a variable shift.
19200 @item -msecure-plt
19201 @opindex msecure-plt
19202 Generate code that allows @command{ld} and @command{ld.so}
19203 to build executables and shared
19204 libraries with non-executable @code{.plt} and @code{.got} sections.
19205 This is a PowerPC
19206 32-bit SYSV ABI option.
19208 @item -mbss-plt
19209 @opindex mbss-plt
19210 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19211 fills in, and
19212 requires @code{.plt} and @code{.got}
19213 sections that are both writable and executable.
19214 This is a PowerPC 32-bit SYSV ABI option.
19216 @item -misel
19217 @itemx -mno-isel
19218 @opindex misel
19219 @opindex mno-isel
19220 This switch enables or disables the generation of ISEL instructions.
19222 @item -misel=@var{yes/no}
19223 This switch has been deprecated.  Use @option{-misel} and
19224 @option{-mno-isel} instead.
19226 @item -mspe
19227 @itemx -mno-spe
19228 @opindex mspe
19229 @opindex mno-spe
19230 This switch enables or disables the generation of SPE simd
19231 instructions.
19233 @item -mpaired
19234 @itemx -mno-paired
19235 @opindex mpaired
19236 @opindex mno-paired
19237 This switch enables or disables the generation of PAIRED simd
19238 instructions.
19240 @item -mspe=@var{yes/no}
19241 This option has been deprecated.  Use @option{-mspe} and
19242 @option{-mno-spe} instead.
19244 @item -mvsx
19245 @itemx -mno-vsx
19246 @opindex mvsx
19247 @opindex mno-vsx
19248 Generate code that uses (does not use) vector/scalar (VSX)
19249 instructions, and also enable the use of built-in functions that allow
19250 more direct access to the VSX instruction set.
19252 @item -mcrypto
19253 @itemx -mno-crypto
19254 @opindex mcrypto
19255 @opindex mno-crypto
19256 Enable the use (disable) of the built-in functions that allow direct
19257 access to the cryptographic instructions that were added in version
19258 2.07 of the PowerPC ISA.
19260 @item -mdirect-move
19261 @itemx -mno-direct-move
19262 @opindex mdirect-move
19263 @opindex mno-direct-move
19264 Generate code that uses (does not use) the instructions to move data
19265 between the general purpose registers and the vector/scalar (VSX)
19266 registers that were added in version 2.07 of the PowerPC ISA.
19268 @item -mpower8-fusion
19269 @itemx -mno-power8-fusion
19270 @opindex mpower8-fusion
19271 @opindex mno-power8-fusion
19272 Generate code that keeps (does not keeps) some integer operations
19273 adjacent so that the instructions can be fused together on power8 and
19274 later processors.
19276 @item -mpower8-vector
19277 @itemx -mno-power8-vector
19278 @opindex mpower8-vector
19279 @opindex mno-power8-vector
19280 Generate code that uses (does not use) the vector and scalar
19281 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19282 enable the use of built-in functions that allow more direct access to
19283 the vector instructions.
19285 @item -mquad-memory
19286 @itemx -mno-quad-memory
19287 @opindex mquad-memory
19288 @opindex mno-quad-memory
19289 Generate code that uses (does not use) the non-atomic quad word memory
19290 instructions.  The @option{-mquad-memory} option requires use of
19291 64-bit mode.
19293 @item -mquad-memory-atomic
19294 @itemx -mno-quad-memory-atomic
19295 @opindex mquad-memory-atomic
19296 @opindex mno-quad-memory-atomic
19297 Generate code that uses (does not use) the atomic quad word memory
19298 instructions.  The @option{-mquad-memory-atomic} option requires use of
19299 64-bit mode.
19301 @item -mupper-regs-df
19302 @itemx -mno-upper-regs-df
19303 @opindex mupper-regs-df
19304 @opindex mno-upper-regs-df
19305 Generate code that uses (does not use) the scalar double precision
19306 instructions that target all 64 registers in the vector/scalar
19307 floating point register set that were added in version 2.06 of the
19308 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
19309 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19310 @option{-mvsx} options.
19312 @item -mupper-regs-sf
19313 @itemx -mno-upper-regs-sf
19314 @opindex mupper-regs-sf
19315 @opindex mno-upper-regs-sf
19316 Generate code that uses (does not use) the scalar single precision
19317 instructions that target all 64 registers in the vector/scalar
19318 floating point register set that were added in version 2.07 of the
19319 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
19320 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
19321 options.
19323 @item -mupper-regs
19324 @itemx -mno-upper-regs
19325 @opindex mupper-regs
19326 @opindex mno-upper-regs
19327 Generate code that uses (does not use) the scalar
19328 instructions that target all 64 registers in the vector/scalar
19329 floating point register set, depending on the model of the machine.
19331 If the @option{-mno-upper-regs} option is used, it turns off both
19332 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19334 @item -mfloat-gprs=@var{yes/single/double/no}
19335 @itemx -mfloat-gprs
19336 @opindex mfloat-gprs
19337 This switch enables or disables the generation of floating-point
19338 operations on the general-purpose registers for architectures that
19339 support it.
19341 The argument @samp{yes} or @samp{single} enables the use of
19342 single-precision floating-point operations.
19344 The argument @samp{double} enables the use of single and
19345 double-precision floating-point operations.
19347 The argument @samp{no} disables floating-point operations on the
19348 general-purpose registers.
19350 This option is currently only available on the MPC854x.
19352 @item -m32
19353 @itemx -m64
19354 @opindex m32
19355 @opindex m64
19356 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19357 targets (including GNU/Linux).  The 32-bit environment sets int, long
19358 and pointer to 32 bits and generates code that runs on any PowerPC
19359 variant.  The 64-bit environment sets int to 32 bits and long and
19360 pointer to 64 bits, and generates code for PowerPC64, as for
19361 @option{-mpowerpc64}.
19363 @item -mfull-toc
19364 @itemx -mno-fp-in-toc
19365 @itemx -mno-sum-in-toc
19366 @itemx -mminimal-toc
19367 @opindex mfull-toc
19368 @opindex mno-fp-in-toc
19369 @opindex mno-sum-in-toc
19370 @opindex mminimal-toc
19371 Modify generation of the TOC (Table Of Contents), which is created for
19372 every executable file.  The @option{-mfull-toc} option is selected by
19373 default.  In that case, GCC allocates at least one TOC entry for
19374 each unique non-automatic variable reference in your program.  GCC
19375 also places floating-point constants in the TOC@.  However, only
19376 16,384 entries are available in the TOC@.
19378 If you receive a linker error message that saying you have overflowed
19379 the available TOC space, you can reduce the amount of TOC space used
19380 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19381 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19382 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19383 generate code to calculate the sum of an address and a constant at
19384 run time instead of putting that sum into the TOC@.  You may specify one
19385 or both of these options.  Each causes GCC to produce very slightly
19386 slower and larger code at the expense of conserving TOC space.
19388 If you still run out of space in the TOC even when you specify both of
19389 these options, specify @option{-mminimal-toc} instead.  This option causes
19390 GCC to make only one TOC entry for every file.  When you specify this
19391 option, GCC produces code that is slower and larger but which
19392 uses extremely little TOC space.  You may wish to use this option
19393 only on files that contain less frequently-executed code.
19395 @item -maix64
19396 @itemx -maix32
19397 @opindex maix64
19398 @opindex maix32
19399 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19400 @code{long} type, and the infrastructure needed to support them.
19401 Specifying @option{-maix64} implies @option{-mpowerpc64},
19402 while @option{-maix32} disables the 64-bit ABI and
19403 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19405 @item -mxl-compat
19406 @itemx -mno-xl-compat
19407 @opindex mxl-compat
19408 @opindex mno-xl-compat
19409 Produce code that conforms more closely to IBM XL compiler semantics
19410 when using AIX-compatible ABI@.  Pass floating-point arguments to
19411 prototyped functions beyond the register save area (RSA) on the stack
19412 in addition to argument FPRs.  Do not assume that most significant
19413 double in 128-bit long double value is properly rounded when comparing
19414 values and converting to double.  Use XL symbol names for long double
19415 support routines.
19417 The AIX calling convention was extended but not initially documented to
19418 handle an obscure K&R C case of calling a function that takes the
19419 address of its arguments with fewer arguments than declared.  IBM XL
19420 compilers access floating-point arguments that do not fit in the
19421 RSA from the stack when a subroutine is compiled without
19422 optimization.  Because always storing floating-point arguments on the
19423 stack is inefficient and rarely needed, this option is not enabled by
19424 default and only is necessary when calling subroutines compiled by IBM
19425 XL compilers without optimization.
19427 @item -mpe
19428 @opindex mpe
19429 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19430 application written to use message passing with special startup code to
19431 enable the application to run.  The system must have PE installed in the
19432 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19433 must be overridden with the @option{-specs=} option to specify the
19434 appropriate directory location.  The Parallel Environment does not
19435 support threads, so the @option{-mpe} option and the @option{-pthread}
19436 option are incompatible.
19438 @item -malign-natural
19439 @itemx -malign-power
19440 @opindex malign-natural
19441 @opindex malign-power
19442 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19443 @option{-malign-natural} overrides the ABI-defined alignment of larger
19444 types, such as floating-point doubles, on their natural size-based boundary.
19445 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19446 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19448 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19449 is not supported.
19451 @item -msoft-float
19452 @itemx -mhard-float
19453 @opindex msoft-float
19454 @opindex mhard-float
19455 Generate code that does not use (uses) the floating-point register set.
19456 Software floating-point emulation is provided if you use the
19457 @option{-msoft-float} option, and pass the option to GCC when linking.
19459 @item -msingle-float
19460 @itemx -mdouble-float
19461 @opindex msingle-float
19462 @opindex mdouble-float
19463 Generate code for single- or double-precision floating-point operations.
19464 @option{-mdouble-float} implies @option{-msingle-float}.
19466 @item -msimple-fpu
19467 @opindex msimple-fpu
19468 Do not generate @code{sqrt} and @code{div} instructions for hardware
19469 floating-point unit.
19471 @item -mfpu=@var{name}
19472 @opindex mfpu
19473 Specify type of floating-point unit.  Valid values for @var{name} are
19474 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19475 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19476 @samp{sp_full} (equivalent to @option{-msingle-float}),
19477 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19479 @item -mxilinx-fpu
19480 @opindex mxilinx-fpu
19481 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19483 @item -mmultiple
19484 @itemx -mno-multiple
19485 @opindex mmultiple
19486 @opindex mno-multiple
19487 Generate code that uses (does not use) the load multiple word
19488 instructions and the store multiple word instructions.  These
19489 instructions are generated by default on POWER systems, and not
19490 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19491 PowerPC systems, since those instructions do not work when the
19492 processor is in little-endian mode.  The exceptions are PPC740 and
19493 PPC750 which permit these instructions in little-endian mode.
19495 @item -mstring
19496 @itemx -mno-string
19497 @opindex mstring
19498 @opindex mno-string
19499 Generate code that uses (does not use) the load string instructions
19500 and the store string word instructions to save multiple registers and
19501 do small block moves.  These instructions are generated by default on
19502 POWER systems, and not generated on PowerPC systems.  Do not use
19503 @option{-mstring} on little-endian PowerPC systems, since those
19504 instructions do not work when the processor is in little-endian mode.
19505 The exceptions are PPC740 and PPC750 which permit these instructions
19506 in little-endian mode.
19508 @item -mupdate
19509 @itemx -mno-update
19510 @opindex mupdate
19511 @opindex mno-update
19512 Generate code that uses (does not use) the load or store instructions
19513 that update the base register to the address of the calculated memory
19514 location.  These instructions are generated by default.  If you use
19515 @option{-mno-update}, there is a small window between the time that the
19516 stack pointer is updated and the address of the previous frame is
19517 stored, which means code that walks the stack frame across interrupts or
19518 signals may get corrupted data.
19520 @item -mavoid-indexed-addresses
19521 @itemx -mno-avoid-indexed-addresses
19522 @opindex mavoid-indexed-addresses
19523 @opindex mno-avoid-indexed-addresses
19524 Generate code that tries to avoid (not avoid) the use of indexed load
19525 or store instructions. These instructions can incur a performance
19526 penalty on Power6 processors in certain situations, such as when
19527 stepping through large arrays that cross a 16M boundary.  This option
19528 is enabled by default when targeting Power6 and disabled otherwise.
19530 @item -mfused-madd
19531 @itemx -mno-fused-madd
19532 @opindex mfused-madd
19533 @opindex mno-fused-madd
19534 Generate code that uses (does not use) the floating-point multiply and
19535 accumulate instructions.  These instructions are generated by default
19536 if hardware floating point is used.  The machine-dependent
19537 @option{-mfused-madd} option is now mapped to the machine-independent
19538 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19539 mapped to @option{-ffp-contract=off}.
19541 @item -mmulhw
19542 @itemx -mno-mulhw
19543 @opindex mmulhw
19544 @opindex mno-mulhw
19545 Generate code that uses (does not use) the half-word multiply and
19546 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19547 These instructions are generated by default when targeting those
19548 processors.
19550 @item -mdlmzb
19551 @itemx -mno-dlmzb
19552 @opindex mdlmzb
19553 @opindex mno-dlmzb
19554 Generate code that uses (does not use) the string-search @samp{dlmzb}
19555 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19556 generated by default when targeting those processors.
19558 @item -mno-bit-align
19559 @itemx -mbit-align
19560 @opindex mno-bit-align
19561 @opindex mbit-align
19562 On System V.4 and embedded PowerPC systems do not (do) force structures
19563 and unions that contain bit-fields to be aligned to the base type of the
19564 bit-field.
19566 For example, by default a structure containing nothing but 8
19567 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19568 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19569 the structure is aligned to a 1-byte boundary and is 1 byte in
19570 size.
19572 @item -mno-strict-align
19573 @itemx -mstrict-align
19574 @opindex mno-strict-align
19575 @opindex mstrict-align
19576 On System V.4 and embedded PowerPC systems do not (do) assume that
19577 unaligned memory references are handled by the system.
19579 @item -mrelocatable
19580 @itemx -mno-relocatable
19581 @opindex mrelocatable
19582 @opindex mno-relocatable
19583 Generate code that allows (does not allow) a static executable to be
19584 relocated to a different address at run time.  A simple embedded
19585 PowerPC system loader should relocate the entire contents of
19586 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19587 a table of 32-bit addresses generated by this option.  For this to
19588 work, all objects linked together must be compiled with
19589 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19590 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19592 @item -mrelocatable-lib
19593 @itemx -mno-relocatable-lib
19594 @opindex mrelocatable-lib
19595 @opindex mno-relocatable-lib
19596 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19597 @code{.fixup} section to allow static executables to be relocated at
19598 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19599 alignment of @option{-mrelocatable}.  Objects compiled with
19600 @option{-mrelocatable-lib} may be linked with objects compiled with
19601 any combination of the @option{-mrelocatable} options.
19603 @item -mno-toc
19604 @itemx -mtoc
19605 @opindex mno-toc
19606 @opindex mtoc
19607 On System V.4 and embedded PowerPC systems do not (do) assume that
19608 register 2 contains a pointer to a global area pointing to the addresses
19609 used in the program.
19611 @item -mlittle
19612 @itemx -mlittle-endian
19613 @opindex mlittle
19614 @opindex mlittle-endian
19615 On System V.4 and embedded PowerPC systems compile code for the
19616 processor in little-endian mode.  The @option{-mlittle-endian} option is
19617 the same as @option{-mlittle}.
19619 @item -mbig
19620 @itemx -mbig-endian
19621 @opindex mbig
19622 @opindex mbig-endian
19623 On System V.4 and embedded PowerPC systems compile code for the
19624 processor in big-endian mode.  The @option{-mbig-endian} option is
19625 the same as @option{-mbig}.
19627 @item -mdynamic-no-pic
19628 @opindex mdynamic-no-pic
19629 On Darwin and Mac OS X systems, compile code so that it is not
19630 relocatable, but that its external references are relocatable.  The
19631 resulting code is suitable for applications, but not shared
19632 libraries.
19634 @item -msingle-pic-base
19635 @opindex msingle-pic-base
19636 Treat the register used for PIC addressing as read-only, rather than
19637 loading it in the prologue for each function.  The runtime system is
19638 responsible for initializing this register with an appropriate value
19639 before execution begins.
19641 @item -mprioritize-restricted-insns=@var{priority}
19642 @opindex mprioritize-restricted-insns
19643 This option controls the priority that is assigned to
19644 dispatch-slot restricted instructions during the second scheduling
19645 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19646 or @samp{2} to assign no, highest, or second-highest (respectively) 
19647 priority to dispatch-slot restricted
19648 instructions.
19650 @item -msched-costly-dep=@var{dependence_type}
19651 @opindex msched-costly-dep
19652 This option controls which dependences are considered costly
19653 by the target during instruction scheduling.  The argument
19654 @var{dependence_type} takes one of the following values:
19656 @table @asis
19657 @item @samp{no}
19658 No dependence is costly.
19660 @item @samp{all}
19661 All dependences are costly.
19663 @item @samp{true_store_to_load}
19664 A true dependence from store to load is costly.
19666 @item @samp{store_to_load}
19667 Any dependence from store to load is costly.
19669 @item @var{number}
19670 Any dependence for which the latency is greater than or equal to 
19671 @var{number} is costly.
19672 @end table
19674 @item -minsert-sched-nops=@var{scheme}
19675 @opindex minsert-sched-nops
19676 This option controls which NOP insertion scheme is used during
19677 the second scheduling pass.  The argument @var{scheme} takes one of the
19678 following values:
19680 @table @asis
19681 @item @samp{no}
19682 Don't insert NOPs.
19684 @item @samp{pad}
19685 Pad with NOPs any dispatch group that has vacant issue slots,
19686 according to the scheduler's grouping.
19688 @item @samp{regroup_exact}
19689 Insert NOPs to force costly dependent insns into
19690 separate groups.  Insert exactly as many NOPs as needed to force an insn
19691 to a new group, according to the estimated processor grouping.
19693 @item @var{number}
19694 Insert NOPs to force costly dependent insns into
19695 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19696 @end table
19698 @item -mcall-sysv
19699 @opindex mcall-sysv
19700 On System V.4 and embedded PowerPC systems compile code using calling
19701 conventions that adhere to the March 1995 draft of the System V
19702 Application Binary Interface, PowerPC processor supplement.  This is the
19703 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19705 @item -mcall-sysv-eabi
19706 @itemx -mcall-eabi
19707 @opindex mcall-sysv-eabi
19708 @opindex mcall-eabi
19709 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19711 @item -mcall-sysv-noeabi
19712 @opindex mcall-sysv-noeabi
19713 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19715 @item -mcall-aixdesc
19716 @opindex m
19717 On System V.4 and embedded PowerPC systems compile code for the AIX
19718 operating system.
19720 @item -mcall-linux
19721 @opindex mcall-linux
19722 On System V.4 and embedded PowerPC systems compile code for the
19723 Linux-based GNU system.
19725 @item -mcall-freebsd
19726 @opindex mcall-freebsd
19727 On System V.4 and embedded PowerPC systems compile code for the
19728 FreeBSD operating system.
19730 @item -mcall-netbsd
19731 @opindex mcall-netbsd
19732 On System V.4 and embedded PowerPC systems compile code for the
19733 NetBSD operating system.
19735 @item -mcall-openbsd
19736 @opindex mcall-netbsd
19737 On System V.4 and embedded PowerPC systems compile code for the
19738 OpenBSD operating system.
19740 @item -maix-struct-return
19741 @opindex maix-struct-return
19742 Return all structures in memory (as specified by the AIX ABI)@.
19744 @item -msvr4-struct-return
19745 @opindex msvr4-struct-return
19746 Return structures smaller than 8 bytes in registers (as specified by the
19747 SVR4 ABI)@.
19749 @item -mabi=@var{abi-type}
19750 @opindex mabi
19751 Extend the current ABI with a particular extension, or remove such extension.
19752 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
19753 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
19754 @samp{elfv1}, @samp{elfv2}@.
19756 @item -mabi=spe
19757 @opindex mabi=spe
19758 Extend the current ABI with SPE ABI extensions.  This does not change
19759 the default ABI, instead it adds the SPE ABI extensions to the current
19760 ABI@.
19762 @item -mabi=no-spe
19763 @opindex mabi=no-spe
19764 Disable Book-E SPE ABI extensions for the current ABI@.
19766 @item -mabi=ibmlongdouble
19767 @opindex mabi=ibmlongdouble
19768 Change the current ABI to use IBM extended-precision long double.
19769 This is a PowerPC 32-bit SYSV ABI option.
19771 @item -mabi=ieeelongdouble
19772 @opindex mabi=ieeelongdouble
19773 Change the current ABI to use IEEE extended-precision long double.
19774 This is a PowerPC 32-bit Linux ABI option.
19776 @item -mabi=elfv1
19777 @opindex mabi=elfv1
19778 Change the current ABI to use the ELFv1 ABI.
19779 This is the default ABI for big-endian PowerPC 64-bit Linux.
19780 Overriding the default ABI requires special system support and is
19781 likely to fail in spectacular ways.
19783 @item -mabi=elfv2
19784 @opindex mabi=elfv2
19785 Change the current ABI to use the ELFv2 ABI.
19786 This is the default ABI for little-endian PowerPC 64-bit Linux.
19787 Overriding the default ABI requires special system support and is
19788 likely to fail in spectacular ways.
19790 @item -mprototype
19791 @itemx -mno-prototype
19792 @opindex mprototype
19793 @opindex mno-prototype
19794 On System V.4 and embedded PowerPC systems assume that all calls to
19795 variable argument functions are properly prototyped.  Otherwise, the
19796 compiler must insert an instruction before every non-prototyped call to
19797 set or clear bit 6 of the condition code register (@code{CR}) to
19798 indicate whether floating-point values are passed in the floating-point
19799 registers in case the function takes variable arguments.  With
19800 @option{-mprototype}, only calls to prototyped variable argument functions
19801 set or clear the bit.
19803 @item -msim
19804 @opindex msim
19805 On embedded PowerPC systems, assume that the startup module is called
19806 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19807 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19808 configurations.
19810 @item -mmvme
19811 @opindex mmvme
19812 On embedded PowerPC systems, assume that the startup module is called
19813 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19814 @file{libc.a}.
19816 @item -mads
19817 @opindex mads
19818 On embedded PowerPC systems, assume that the startup module is called
19819 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19820 @file{libc.a}.
19822 @item -myellowknife
19823 @opindex myellowknife
19824 On embedded PowerPC systems, assume that the startup module is called
19825 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19826 @file{libc.a}.
19828 @item -mvxworks
19829 @opindex mvxworks
19830 On System V.4 and embedded PowerPC systems, specify that you are
19831 compiling for a VxWorks system.
19833 @item -memb
19834 @opindex memb
19835 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
19836 header to indicate that @samp{eabi} extended relocations are used.
19838 @item -meabi
19839 @itemx -mno-eabi
19840 @opindex meabi
19841 @opindex mno-eabi
19842 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19843 Embedded Applications Binary Interface (EABI), which is a set of
19844 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19845 means that the stack is aligned to an 8-byte boundary, a function
19846 @code{__eabi} is called from @code{main} to set up the EABI
19847 environment, and the @option{-msdata} option can use both @code{r2} and
19848 @code{r13} to point to two separate small data areas.  Selecting
19849 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19850 no EABI initialization function is called from @code{main}, and the
19851 @option{-msdata} option only uses @code{r13} to point to a single
19852 small data area.  The @option{-meabi} option is on by default if you
19853 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19855 @item -msdata=eabi
19856 @opindex msdata=eabi
19857 On System V.4 and embedded PowerPC systems, put small initialized
19858 @code{const} global and static data in the @code{.sdata2} section, which
19859 is pointed to by register @code{r2}.  Put small initialized
19860 non-@code{const} global and static data in the @code{.sdata} section,
19861 which is pointed to by register @code{r13}.  Put small uninitialized
19862 global and static data in the @code{.sbss} section, which is adjacent to
19863 the @code{.sdata} section.  The @option{-msdata=eabi} option is
19864 incompatible with the @option{-mrelocatable} option.  The
19865 @option{-msdata=eabi} option also sets the @option{-memb} option.
19867 @item -msdata=sysv
19868 @opindex msdata=sysv
19869 On System V.4 and embedded PowerPC systems, put small global and static
19870 data in the @code{.sdata} section, which is pointed to by register
19871 @code{r13}.  Put small uninitialized global and static data in the
19872 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
19873 The @option{-msdata=sysv} option is incompatible with the
19874 @option{-mrelocatable} option.
19876 @item -msdata=default
19877 @itemx -msdata
19878 @opindex msdata=default
19879 @opindex msdata
19880 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19881 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19882 same as @option{-msdata=sysv}.
19884 @item -msdata=data
19885 @opindex msdata=data
19886 On System V.4 and embedded PowerPC systems, put small global
19887 data in the @code{.sdata} section.  Put small uninitialized global
19888 data in the @code{.sbss} section.  Do not use register @code{r13}
19889 to address small data however.  This is the default behavior unless
19890 other @option{-msdata} options are used.
19892 @item -msdata=none
19893 @itemx -mno-sdata
19894 @opindex msdata=none
19895 @opindex mno-sdata
19896 On embedded PowerPC systems, put all initialized global and static data
19897 in the @code{.data} section, and all uninitialized data in the
19898 @code{.bss} section.
19900 @item -mblock-move-inline-limit=@var{num}
19901 @opindex mblock-move-inline-limit
19902 Inline all block moves (such as calls to @code{memcpy} or structure
19903 copies) less than or equal to @var{num} bytes.  The minimum value for
19904 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19905 targets.  The default value is target-specific.
19907 @item -G @var{num}
19908 @opindex G
19909 @cindex smaller data references (PowerPC)
19910 @cindex .sdata/.sdata2 references (PowerPC)
19911 On embedded PowerPC systems, put global and static items less than or
19912 equal to @var{num} bytes into the small data or BSS sections instead of
19913 the normal data or BSS section.  By default, @var{num} is 8.  The
19914 @option{-G @var{num}} switch is also passed to the linker.
19915 All modules should be compiled with the same @option{-G @var{num}} value.
19917 @item -mregnames
19918 @itemx -mno-regnames
19919 @opindex mregnames
19920 @opindex mno-regnames
19921 On System V.4 and embedded PowerPC systems do (do not) emit register
19922 names in the assembly language output using symbolic forms.
19924 @item -mlongcall
19925 @itemx -mno-longcall
19926 @opindex mlongcall
19927 @opindex mno-longcall
19928 By default assume that all calls are far away so that a longer and more
19929 expensive calling sequence is required.  This is required for calls
19930 farther than 32 megabytes (33,554,432 bytes) from the current location.
19931 A short call is generated if the compiler knows
19932 the call cannot be that far away.  This setting can be overridden by
19933 the @code{shortcall} function attribute, or by @code{#pragma
19934 longcall(0)}.
19936 Some linkers are capable of detecting out-of-range calls and generating
19937 glue code on the fly.  On these systems, long calls are unnecessary and
19938 generate slower code.  As of this writing, the AIX linker can do this,
19939 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19940 to the GNU linker for 32-bit PowerPC systems as well.
19942 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19943 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19944 addresses represent the callee and the branch island.  The
19945 Darwin/PPC linker prefers the first address and generates a @code{bl
19946 callee} if the PPC @code{bl} instruction reaches the callee directly;
19947 otherwise, the linker generates @code{bl L42} to call the branch
19948 island.  The branch island is appended to the body of the
19949 calling function; it computes the full 32-bit address of the callee
19950 and jumps to it.
19952 On Mach-O (Darwin) systems, this option directs the compiler emit to
19953 the glue for every direct call, and the Darwin linker decides whether
19954 to use or discard it.
19956 In the future, GCC may ignore all longcall specifications
19957 when the linker is known to generate glue.
19959 @item -mtls-markers
19960 @itemx -mno-tls-markers
19961 @opindex mtls-markers
19962 @opindex mno-tls-markers
19963 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19964 specifying the function argument.  The relocation allows the linker to
19965 reliably associate function call with argument setup instructions for
19966 TLS optimization, which in turn allows GCC to better schedule the
19967 sequence.
19969 @item -pthread
19970 @opindex pthread
19971 Adds support for multithreading with the @dfn{pthreads} library.
19972 This option sets flags for both the preprocessor and linker.
19974 @item -mrecip
19975 @itemx -mno-recip
19976 @opindex mrecip
19977 This option enables use of the reciprocal estimate and
19978 reciprocal square root estimate instructions with additional
19979 Newton-Raphson steps to increase precision instead of doing a divide or
19980 square root and divide for floating-point arguments.  You should use
19981 the @option{-ffast-math} option when using @option{-mrecip} (or at
19982 least @option{-funsafe-math-optimizations},
19983 @option{-finite-math-only}, @option{-freciprocal-math} and
19984 @option{-fno-trapping-math}).  Note that while the throughput of the
19985 sequence is generally higher than the throughput of the non-reciprocal
19986 instruction, the precision of the sequence can be decreased by up to 2
19987 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19988 roots.
19990 @item -mrecip=@var{opt}
19991 @opindex mrecip=opt
19992 This option controls which reciprocal estimate instructions
19993 may be used.  @var{opt} is a comma-separated list of options, which may
19994 be preceded by a @code{!} to invert the option:
19996 @table @samp
19998 @item all
19999 Enable all estimate instructions.
20001 @item default 
20002 Enable the default instructions, equivalent to @option{-mrecip}.
20004 @item none 
20005 Disable all estimate instructions, equivalent to @option{-mno-recip}.
20007 @item div 
20008 Enable the reciprocal approximation instructions for both 
20009 single and double precision.
20011 @item divf 
20012 Enable the single-precision reciprocal approximation instructions.
20014 @item divd 
20015 Enable the double-precision reciprocal approximation instructions.
20017 @item rsqrt 
20018 Enable the reciprocal square root approximation instructions for both
20019 single and double precision.
20021 @item rsqrtf 
20022 Enable the single-precision reciprocal square root approximation instructions.
20024 @item rsqrtd 
20025 Enable the double-precision reciprocal square root approximation instructions.
20027 @end table
20029 So, for example, @option{-mrecip=all,!rsqrtd} enables
20030 all of the reciprocal estimate instructions, except for the
20031 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20032 which handle the double-precision reciprocal square root calculations.
20034 @item -mrecip-precision
20035 @itemx -mno-recip-precision
20036 @opindex mrecip-precision
20037 Assume (do not assume) that the reciprocal estimate instructions
20038 provide higher-precision estimates than is mandated by the PowerPC
20039 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20040 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20041 The double-precision square root estimate instructions are not generated by
20042 default on low-precision machines, since they do not provide an
20043 estimate that converges after three steps.
20045 @item -mveclibabi=@var{type}
20046 @opindex mveclibabi
20047 Specifies the ABI type to use for vectorizing intrinsics using an
20048 external library.  The only type supported at present is @samp{mass},
20049 which specifies to use IBM's Mathematical Acceleration Subsystem
20050 (MASS) libraries for vectorizing intrinsics using external libraries.
20051 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20052 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20053 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20054 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20055 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20056 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20057 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20058 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20059 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20060 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20061 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20062 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20063 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20064 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20065 for power7.  Both @option{-ftree-vectorize} and
20066 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20067 libraries must be specified at link time.
20069 @item -mfriz
20070 @itemx -mno-friz
20071 @opindex mfriz
20072 Generate (do not generate) the @code{friz} instruction when the
20073 @option{-funsafe-math-optimizations} option is used to optimize
20074 rounding of floating-point values to 64-bit integer and back to floating
20075 point.  The @code{friz} instruction does not return the same value if
20076 the floating-point number is too large to fit in an integer.
20078 @item -mpointers-to-nested-functions
20079 @itemx -mno-pointers-to-nested-functions
20080 @opindex mpointers-to-nested-functions
20081 Generate (do not generate) code to load up the static chain register
20082 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
20083 systems where a function pointer points to a 3-word descriptor giving
20084 the function address, TOC value to be loaded in register @code{r2}, and
20085 static chain value to be loaded in register @code{r11}.  The
20086 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20087 call through pointers to nested functions or pointers
20088 to functions compiled in other languages that use the static chain if
20089 you use @option{-mno-pointers-to-nested-functions}.
20091 @item -msave-toc-indirect
20092 @itemx -mno-save-toc-indirect
20093 @opindex msave-toc-indirect
20094 Generate (do not generate) code to save the TOC value in the reserved
20095 stack location in the function prologue if the function calls through
20096 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20097 saved in the prologue, it is saved just before the call through the
20098 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20100 @item -mcompat-align-parm
20101 @itemx -mno-compat-align-parm
20102 @opindex mcompat-align-parm
20103 Generate (do not generate) code to pass structure parameters with a
20104 maximum alignment of 64 bits, for compatibility with older versions
20105 of GCC.
20107 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20108 structure parameter on a 128-bit boundary when that structure contained
20109 a member requiring 128-bit alignment.  This is corrected in more
20110 recent versions of GCC.  This option may be used to generate code
20111 that is compatible with functions compiled with older versions of
20112 GCC.
20114 The @option{-mno-compat-align-parm} option is the default.
20115 @end table
20117 @node RX Options
20118 @subsection RX Options
20119 @cindex RX Options
20121 These command-line options are defined for RX targets:
20123 @table @gcctabopt
20124 @item -m64bit-doubles
20125 @itemx -m32bit-doubles
20126 @opindex m64bit-doubles
20127 @opindex m32bit-doubles
20128 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20129 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20130 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20131 works on 32-bit values, which is why the default is
20132 @option{-m32bit-doubles}.
20134 @item -fpu
20135 @itemx -nofpu
20136 @opindex fpu
20137 @opindex nofpu
20138 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20139 floating-point hardware.  The default is enabled for the RX600
20140 series and disabled for the RX200 series.
20142 Floating-point instructions are only generated for 32-bit floating-point 
20143 values, however, so the FPU hardware is not used for doubles if the
20144 @option{-m64bit-doubles} option is used.
20146 @emph{Note} If the @option{-fpu} option is enabled then
20147 @option{-funsafe-math-optimizations} is also enabled automatically.
20148 This is because the RX FPU instructions are themselves unsafe.
20150 @item -mcpu=@var{name}
20151 @opindex mcpu
20152 Selects the type of RX CPU to be targeted.  Currently three types are
20153 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
20154 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
20156 The only difference between @samp{RX600} and @samp{RX610} is that the
20157 @samp{RX610} does not support the @code{MVTIPL} instruction.
20159 The @samp{RX200} series does not have a hardware floating-point unit
20160 and so @option{-nofpu} is enabled by default when this type is
20161 selected.
20163 @item -mbig-endian-data
20164 @itemx -mlittle-endian-data
20165 @opindex mbig-endian-data
20166 @opindex mlittle-endian-data
20167 Store data (but not code) in the big-endian format.  The default is
20168 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20169 format.
20171 @item -msmall-data-limit=@var{N}
20172 @opindex msmall-data-limit
20173 Specifies the maximum size in bytes of global and static variables
20174 which can be placed into the small data area.  Using the small data
20175 area can lead to smaller and faster code, but the size of area is
20176 limited and it is up to the programmer to ensure that the area does
20177 not overflow.  Also when the small data area is used one of the RX's
20178 registers (usually @code{r13}) is reserved for use pointing to this
20179 area, so it is no longer available for use by the compiler.  This
20180 could result in slower and/or larger code if variables are pushed onto
20181 the stack instead of being held in this register.
20183 Note, common variables (variables that have not been initialized) and
20184 constants are not placed into the small data area as they are assigned
20185 to other sections in the output executable.
20187 The default value is zero, which disables this feature.  Note, this
20188 feature is not enabled by default with higher optimization levels
20189 (@option{-O2} etc) because of the potentially detrimental effects of
20190 reserving a register.  It is up to the programmer to experiment and
20191 discover whether this feature is of benefit to their program.  See the
20192 description of the @option{-mpid} option for a description of how the
20193 actual register to hold the small data area pointer is chosen.
20195 @item -msim
20196 @itemx -mno-sim
20197 @opindex msim
20198 @opindex mno-sim
20199 Use the simulator runtime.  The default is to use the libgloss
20200 board-specific runtime.
20202 @item -mas100-syntax
20203 @itemx -mno-as100-syntax
20204 @opindex mas100-syntax
20205 @opindex mno-as100-syntax
20206 When generating assembler output use a syntax that is compatible with
20207 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20208 assembler, but it has some restrictions so it is not generated by default.
20210 @item -mmax-constant-size=@var{N}
20211 @opindex mmax-constant-size
20212 Specifies the maximum size, in bytes, of a constant that can be used as
20213 an operand in a RX instruction.  Although the RX instruction set does
20214 allow constants of up to 4 bytes in length to be used in instructions,
20215 a longer value equates to a longer instruction.  Thus in some
20216 circumstances it can be beneficial to restrict the size of constants
20217 that are used in instructions.  Constants that are too big are instead
20218 placed into a constant pool and referenced via register indirection.
20220 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20221 or 4 means that constants of any size are allowed.
20223 @item -mrelax
20224 @opindex mrelax
20225 Enable linker relaxation.  Linker relaxation is a process whereby the
20226 linker attempts to reduce the size of a program by finding shorter
20227 versions of various instructions.  Disabled by default.
20229 @item -mint-register=@var{N}
20230 @opindex mint-register
20231 Specify the number of registers to reserve for fast interrupt handler
20232 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20233 means that register @code{r13} is reserved for the exclusive use
20234 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20235 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20236 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20237 A value of 0, the default, does not reserve any registers.
20239 @item -msave-acc-in-interrupts
20240 @opindex msave-acc-in-interrupts
20241 Specifies that interrupt handler functions should preserve the
20242 accumulator register.  This is only necessary if normal code might use
20243 the accumulator register, for example because it performs 64-bit
20244 multiplications.  The default is to ignore the accumulator as this
20245 makes the interrupt handlers faster.
20247 @item -mpid
20248 @itemx -mno-pid
20249 @opindex mpid
20250 @opindex mno-pid
20251 Enables the generation of position independent data.  When enabled any
20252 access to constant data is done via an offset from a base address
20253 held in a register.  This allows the location of constant data to be
20254 determined at run time without requiring the executable to be
20255 relocated, which is a benefit to embedded applications with tight
20256 memory constraints.  Data that can be modified is not affected by this
20257 option.
20259 Note, using this feature reserves a register, usually @code{r13}, for
20260 the constant data base address.  This can result in slower and/or
20261 larger code, especially in complicated functions.
20263 The actual register chosen to hold the constant data base address
20264 depends upon whether the @option{-msmall-data-limit} and/or the
20265 @option{-mint-register} command-line options are enabled.  Starting
20266 with register @code{r13} and proceeding downwards, registers are
20267 allocated first to satisfy the requirements of @option{-mint-register},
20268 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20269 is possible for the small data area register to be @code{r8} if both
20270 @option{-mint-register=4} and @option{-mpid} are specified on the
20271 command line.
20273 By default this feature is not enabled.  The default can be restored
20274 via the @option{-mno-pid} command-line option.
20276 @item -mno-warn-multiple-fast-interrupts
20277 @itemx -mwarn-multiple-fast-interrupts
20278 @opindex mno-warn-multiple-fast-interrupts
20279 @opindex mwarn-multiple-fast-interrupts
20280 Prevents GCC from issuing a warning message if it finds more than one
20281 fast interrupt handler when it is compiling a file.  The default is to
20282 issue a warning for each extra fast interrupt handler found, as the RX
20283 only supports one such interrupt.
20285 @item -mallow-string-insns
20286 @itemx -mno-allow-string-insns
20287 @opindex mallow-string-insns
20288 @opindex mno-allow-string-insns
20289 Enables or disables the use of the string manipulation instructions
20290 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
20291 @code{SWHILE} and also the @code{RMPA} instruction.  These
20292 instructions may prefetch data, which is not safe to do if accessing
20293 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
20294 for more information).
20296 The default is to allow these instructions, but it is not possible for
20297 GCC to reliably detect all circumstances where a string instruction
20298 might be used to access an I/O register, so their use cannot be
20299 disabled automatically.  Instead it is reliant upon the programmer to
20300 use the @option{-mno-allow-string-insns} option if their program
20301 accesses I/O space.
20303 When the instructions are enabled GCC defines the C preprocessor
20304 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
20305 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
20306 @end table
20308 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20309 has special significance to the RX port when used with the
20310 @code{interrupt} function attribute.  This attribute indicates a
20311 function intended to process fast interrupts.  GCC ensures
20312 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20313 and/or @code{r13} and only provided that the normal use of the
20314 corresponding registers have been restricted via the
20315 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20316 options.
20318 @node S/390 and zSeries Options
20319 @subsection S/390 and zSeries Options
20320 @cindex S/390 and zSeries Options
20322 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20324 @table @gcctabopt
20325 @item -mhard-float
20326 @itemx -msoft-float
20327 @opindex mhard-float
20328 @opindex msoft-float
20329 Use (do not use) the hardware floating-point instructions and registers
20330 for floating-point operations.  When @option{-msoft-float} is specified,
20331 functions in @file{libgcc.a} are used to perform floating-point
20332 operations.  When @option{-mhard-float} is specified, the compiler
20333 generates IEEE floating-point instructions.  This is the default.
20335 @item -mhard-dfp
20336 @itemx -mno-hard-dfp
20337 @opindex mhard-dfp
20338 @opindex mno-hard-dfp
20339 Use (do not use) the hardware decimal-floating-point instructions for
20340 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20341 specified, functions in @file{libgcc.a} are used to perform
20342 decimal-floating-point operations.  When @option{-mhard-dfp} is
20343 specified, the compiler generates decimal-floating-point hardware
20344 instructions.  This is the default for @option{-march=z9-ec} or higher.
20346 @item -mlong-double-64
20347 @itemx -mlong-double-128
20348 @opindex mlong-double-64
20349 @opindex mlong-double-128
20350 These switches control the size of @code{long double} type. A size
20351 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20352 type. This is the default.
20354 @item -mbackchain
20355 @itemx -mno-backchain
20356 @opindex mbackchain
20357 @opindex mno-backchain
20358 Store (do not store) the address of the caller's frame as backchain pointer
20359 into the callee's stack frame.
20360 A backchain may be needed to allow debugging using tools that do not understand
20361 DWARF 2 call frame information.
20362 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20363 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20364 the backchain is placed into the topmost word of the 96/160 byte register
20365 save area.
20367 In general, code compiled with @option{-mbackchain} is call-compatible with
20368 code compiled with @option{-mmo-backchain}; however, use of the backchain
20369 for debugging purposes usually requires that the whole binary is built with
20370 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20371 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20372 to build a linux kernel use @option{-msoft-float}.
20374 The default is to not maintain the backchain.
20376 @item -mpacked-stack
20377 @itemx -mno-packed-stack
20378 @opindex mpacked-stack
20379 @opindex mno-packed-stack
20380 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20381 specified, the compiler uses the all fields of the 96/160 byte register save
20382 area only for their default purpose; unused fields still take up stack space.
20383 When @option{-mpacked-stack} is specified, register save slots are densely
20384 packed at the top of the register save area; unused space is reused for other
20385 purposes, allowing for more efficient use of the available stack space.
20386 However, when @option{-mbackchain} is also in effect, the topmost word of
20387 the save area is always used to store the backchain, and the return address
20388 register is always saved two words below the backchain.
20390 As long as the stack frame backchain is not used, code generated with
20391 @option{-mpacked-stack} is call-compatible with code generated with
20392 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20393 S/390 or zSeries generated code that uses the stack frame backchain at run
20394 time, not just for debugging purposes.  Such code is not call-compatible
20395 with code compiled with @option{-mpacked-stack}.  Also, note that the
20396 combination of @option{-mbackchain},
20397 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20398 to build a linux kernel use @option{-msoft-float}.
20400 The default is to not use the packed stack layout.
20402 @item -msmall-exec
20403 @itemx -mno-small-exec
20404 @opindex msmall-exec
20405 @opindex mno-small-exec
20406 Generate (or do not generate) code using the @code{bras} instruction
20407 to do subroutine calls.
20408 This only works reliably if the total executable size does not
20409 exceed 64k.  The default is to use the @code{basr} instruction instead,
20410 which does not have this limitation.
20412 @item -m64
20413 @itemx -m31
20414 @opindex m64
20415 @opindex m31
20416 When @option{-m31} is specified, generate code compliant to the
20417 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20418 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20419 particular to generate 64-bit instructions.  For the @samp{s390}
20420 targets, the default is @option{-m31}, while the @samp{s390x}
20421 targets default to @option{-m64}.
20423 @item -mzarch
20424 @itemx -mesa
20425 @opindex mzarch
20426 @opindex mesa
20427 When @option{-mzarch} is specified, generate code using the
20428 instructions available on z/Architecture.
20429 When @option{-mesa} is specified, generate code using the
20430 instructions available on ESA/390.  Note that @option{-mesa} is
20431 not possible with @option{-m64}.
20432 When generating code compliant to the GNU/Linux for S/390 ABI,
20433 the default is @option{-mesa}.  When generating code compliant
20434 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20436 @item -mhtm
20437 @itemx -mno-htm
20438 @opindex mhtm
20439 @opindex mno-htm
20440 The @option{-mhtm} option enables a set of builtins making use of
20441 instructions available with the transactional execution facility
20442 introduced with the IBM zEnterprise EC12 machine generation
20443 @ref{S/390 System z Built-in Functions}.
20444 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
20446 @item -mvx
20447 @itemx -mno-vx
20448 @opindex mvx
20449 @opindex mno-vx
20450 When @option{-mvx} is specified, generate code using the instructions
20451 available with the vector extension facility introduced with the IBM
20452 z13 machine generation.
20453 This option changes the ABI for some vector type values with regard to
20454 alignment and calling conventions.  In case vector type values are
20455 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
20456 command will be added to mark the resulting binary with the ABI used.
20457 @option{-mvx} is enabled by default when using @option{-march=z13}.
20459 @item -mzvector
20460 @itemx -mno-zvector
20461 @opindex mzvector
20462 @opindex mno-zvector
20463 The @option{-mzvector} option enables vector language extensions and
20464 builtins using instructions available with the vector extension
20465 facility introduced with the IBM z13 machine generation.
20466 This option adds support for @samp{vector} to be used as a keyword to
20467 define vector type variables and arguments.  @samp{vector} is only
20468 available when GNU extensions are enabled.  It will not be expanded
20469 when requesting strict standard compliance e.g. with @option{-std=c99}.
20470 In addition to the GCC low-level builtins @option{-mzvector} enables
20471 a set of builtins added for compatibility with Altivec-style
20472 implementations like Power and Cell.  In order to make use of these
20473 builtins the header file @file{vecintrin.h} needs to be included.
20474 @option{-mzvector} is disabled by default.
20476 @item -mmvcle
20477 @itemx -mno-mvcle
20478 @opindex mmvcle
20479 @opindex mno-mvcle
20480 Generate (or do not generate) code using the @code{mvcle} instruction
20481 to perform block moves.  When @option{-mno-mvcle} is specified,
20482 use a @code{mvc} loop instead.  This is the default unless optimizing for
20483 size.
20485 @item -mdebug
20486 @itemx -mno-debug
20487 @opindex mdebug
20488 @opindex mno-debug
20489 Print (or do not print) additional debug information when compiling.
20490 The default is to not print debug information.
20492 @item -march=@var{cpu-type}
20493 @opindex march
20494 Generate code that runs on @var{cpu-type}, which is the name of a system
20495 representing a certain processor type.  Possible values for
20496 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20497 @samp{z9-109}, @samp{z9-ec}, @samp{z10},  @samp{z196}, @samp{zEC12},
20498 and @samp{z13}.
20499 When generating code using the instructions available on z/Architecture,
20500 the default is @option{-march=z900}.  Otherwise, the default is
20501 @option{-march=g5}.
20503 @item -mtune=@var{cpu-type}
20504 @opindex mtune
20505 Tune to @var{cpu-type} everything applicable about the generated code,
20506 except for the ABI and the set of available instructions.
20507 The list of @var{cpu-type} values is the same as for @option{-march}.
20508 The default is the value used for @option{-march}.
20510 @item -mtpf-trace
20511 @itemx -mno-tpf-trace
20512 @opindex mtpf-trace
20513 @opindex mno-tpf-trace
20514 Generate code that adds (does not add) in TPF OS specific branches to trace
20515 routines in the operating system.  This option is off by default, even
20516 when compiling for the TPF OS@.
20518 @item -mfused-madd
20519 @itemx -mno-fused-madd
20520 @opindex mfused-madd
20521 @opindex mno-fused-madd
20522 Generate code that uses (does not use) the floating-point multiply and
20523 accumulate instructions.  These instructions are generated by default if
20524 hardware floating point is used.
20526 @item -mwarn-framesize=@var{framesize}
20527 @opindex mwarn-framesize
20528 Emit a warning if the current function exceeds the given frame size.  Because
20529 this is a compile-time check it doesn't need to be a real problem when the program
20530 runs.  It is intended to identify functions that most probably cause
20531 a stack overflow.  It is useful to be used in an environment with limited stack
20532 size e.g.@: the linux kernel.
20534 @item -mwarn-dynamicstack
20535 @opindex mwarn-dynamicstack
20536 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20537 arrays.  This is generally a bad idea with a limited stack size.
20539 @item -mstack-guard=@var{stack-guard}
20540 @itemx -mstack-size=@var{stack-size}
20541 @opindex mstack-guard
20542 @opindex mstack-size
20543 If these options are provided the S/390 back end emits additional instructions in
20544 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20545 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20546 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20547 the frame size of the compiled function is chosen.
20548 These options are intended to be used to help debugging stack overflow problems.
20549 The additionally emitted code causes only little overhead and hence can also be
20550 used in production-like systems without greater performance degradation.  The given
20551 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20552 @var{stack-guard} without exceeding 64k.
20553 In order to be efficient the extra code makes the assumption that the stack starts
20554 at an address aligned to the value given by @var{stack-size}.
20555 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20557 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20558 @opindex mhotpatch
20559 If the hotpatch option is enabled, a ``hot-patching'' function
20560 prologue is generated for all functions in the compilation unit.
20561 The funtion label is prepended with the given number of two-byte
20562 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20563 the label, 2 * @var{post-halfwords} bytes are appended, using the
20564 largest NOP like instructions the architecture allows (maximum
20565 1000000).
20567 If both arguments are zero, hotpatching is disabled.
20569 This option can be overridden for individual functions with the
20570 @code{hotpatch} attribute.
20571 @end table
20573 @node Score Options
20574 @subsection Score Options
20575 @cindex Score Options
20577 These options are defined for Score implementations:
20579 @table @gcctabopt
20580 @item -meb
20581 @opindex meb
20582 Compile code for big-endian mode.  This is the default.
20584 @item -mel
20585 @opindex mel
20586 Compile code for little-endian mode.
20588 @item -mnhwloop
20589 @opindex mnhwloop
20590 Disable generation of @code{bcnz} instructions.
20592 @item -muls
20593 @opindex muls
20594 Enable generation of unaligned load and store instructions.
20596 @item -mmac
20597 @opindex mmac
20598 Enable the use of multiply-accumulate instructions. Disabled by default.
20600 @item -mscore5
20601 @opindex mscore5
20602 Specify the SCORE5 as the target architecture.
20604 @item -mscore5u
20605 @opindex mscore5u
20606 Specify the SCORE5U of the target architecture.
20608 @item -mscore7
20609 @opindex mscore7
20610 Specify the SCORE7 as the target architecture. This is the default.
20612 @item -mscore7d
20613 @opindex mscore7d
20614 Specify the SCORE7D as the target architecture.
20615 @end table
20617 @node SH Options
20618 @subsection SH Options
20620 These @samp{-m} options are defined for the SH implementations:
20622 @table @gcctabopt
20623 @item -m1
20624 @opindex m1
20625 Generate code for the SH1.
20627 @item -m2
20628 @opindex m2
20629 Generate code for the SH2.
20631 @item -m2e
20632 Generate code for the SH2e.
20634 @item -m2a-nofpu
20635 @opindex m2a-nofpu
20636 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20637 that the floating-point unit is not used.
20639 @item -m2a-single-only
20640 @opindex m2a-single-only
20641 Generate code for the SH2a-FPU, in such a way that no double-precision
20642 floating-point operations are used.
20644 @item -m2a-single
20645 @opindex m2a-single
20646 Generate code for the SH2a-FPU assuming the floating-point unit is in
20647 single-precision mode by default.
20649 @item -m2a
20650 @opindex m2a
20651 Generate code for the SH2a-FPU assuming the floating-point unit is in
20652 double-precision mode by default.
20654 @item -m3
20655 @opindex m3
20656 Generate code for the SH3.
20658 @item -m3e
20659 @opindex m3e
20660 Generate code for the SH3e.
20662 @item -m4-nofpu
20663 @opindex m4-nofpu
20664 Generate code for the SH4 without a floating-point unit.
20666 @item -m4-single-only
20667 @opindex m4-single-only
20668 Generate code for the SH4 with a floating-point unit that only
20669 supports single-precision arithmetic.
20671 @item -m4-single
20672 @opindex m4-single
20673 Generate code for the SH4 assuming the floating-point unit is in
20674 single-precision mode by default.
20676 @item -m4
20677 @opindex m4
20678 Generate code for the SH4.
20680 @item -m4-100
20681 @opindex m4-100
20682 Generate code for SH4-100.
20684 @item -m4-100-nofpu
20685 @opindex m4-100-nofpu
20686 Generate code for SH4-100 in such a way that the
20687 floating-point unit is not used.
20689 @item -m4-100-single
20690 @opindex m4-100-single
20691 Generate code for SH4-100 assuming the floating-point unit is in
20692 single-precision mode by default.
20694 @item -m4-100-single-only
20695 @opindex m4-100-single-only
20696 Generate code for SH4-100 in such a way that no double-precision
20697 floating-point operations are used.
20699 @item -m4-200
20700 @opindex m4-200
20701 Generate code for SH4-200.
20703 @item -m4-200-nofpu
20704 @opindex m4-200-nofpu
20705 Generate code for SH4-200 without in such a way that the
20706 floating-point unit is not used.
20708 @item -m4-200-single
20709 @opindex m4-200-single
20710 Generate code for SH4-200 assuming the floating-point unit is in
20711 single-precision mode by default.
20713 @item -m4-200-single-only
20714 @opindex m4-200-single-only
20715 Generate code for SH4-200 in such a way that no double-precision
20716 floating-point operations are used.
20718 @item -m4-300
20719 @opindex m4-300
20720 Generate code for SH4-300.
20722 @item -m4-300-nofpu
20723 @opindex m4-300-nofpu
20724 Generate code for SH4-300 without in such a way that the
20725 floating-point unit is not used.
20727 @item -m4-300-single
20728 @opindex m4-300-single
20729 Generate code for SH4-300 in such a way that no double-precision
20730 floating-point operations are used.
20732 @item -m4-300-single-only
20733 @opindex m4-300-single-only
20734 Generate code for SH4-300 in such a way that no double-precision
20735 floating-point operations are used.
20737 @item -m4-340
20738 @opindex m4-340
20739 Generate code for SH4-340 (no MMU, no FPU).
20741 @item -m4-500
20742 @opindex m4-500
20743 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20744 assembler.
20746 @item -m4a-nofpu
20747 @opindex m4a-nofpu
20748 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20749 floating-point unit is not used.
20751 @item -m4a-single-only
20752 @opindex m4a-single-only
20753 Generate code for the SH4a, in such a way that no double-precision
20754 floating-point operations are used.
20756 @item -m4a-single
20757 @opindex m4a-single
20758 Generate code for the SH4a assuming the floating-point unit is in
20759 single-precision mode by default.
20761 @item -m4a
20762 @opindex m4a
20763 Generate code for the SH4a.
20765 @item -m4al
20766 @opindex m4al
20767 Same as @option{-m4a-nofpu}, except that it implicitly passes
20768 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20769 instructions at the moment.
20771 @item -m5-32media
20772 @opindex m5-32media
20773 Generate 32-bit code for SHmedia.
20775 @item -m5-32media-nofpu
20776 @opindex m5-32media-nofpu
20777 Generate 32-bit code for SHmedia in such a way that the
20778 floating-point unit is not used.
20780 @item -m5-64media
20781 @opindex m5-64media
20782 Generate 64-bit code for SHmedia.
20784 @item -m5-64media-nofpu
20785 @opindex m5-64media-nofpu
20786 Generate 64-bit code for SHmedia in such a way that the
20787 floating-point unit is not used.
20789 @item -m5-compact
20790 @opindex m5-compact
20791 Generate code for SHcompact.
20793 @item -m5-compact-nofpu
20794 @opindex m5-compact-nofpu
20795 Generate code for SHcompact in such a way that the
20796 floating-point unit is not used.
20798 @item -mb
20799 @opindex mb
20800 Compile code for the processor in big-endian mode.
20802 @item -ml
20803 @opindex ml
20804 Compile code for the processor in little-endian mode.
20806 @item -mdalign
20807 @opindex mdalign
20808 Align doubles at 64-bit boundaries.  Note that this changes the calling
20809 conventions, and thus some functions from the standard C library do
20810 not work unless you recompile it first with @option{-mdalign}.
20812 @item -mrelax
20813 @opindex mrelax
20814 Shorten some address references at link time, when possible; uses the
20815 linker option @option{-relax}.
20817 @item -mbigtable
20818 @opindex mbigtable
20819 Use 32-bit offsets in @code{switch} tables.  The default is to use
20820 16-bit offsets.
20822 @item -mbitops
20823 @opindex mbitops
20824 Enable the use of bit manipulation instructions on SH2A.
20826 @item -mfmovd
20827 @opindex mfmovd
20828 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20829 alignment constraints.
20831 @item -mrenesas
20832 @opindex mrenesas
20833 Comply with the calling conventions defined by Renesas.
20835 @item -mno-renesas
20836 @opindex mno-renesas
20837 Comply with the calling conventions defined for GCC before the Renesas
20838 conventions were available.  This option is the default for all
20839 targets of the SH toolchain.
20841 @item -mnomacsave
20842 @opindex mnomacsave
20843 Mark the @code{MAC} register as call-clobbered, even if
20844 @option{-mrenesas} is given.
20846 @item -mieee
20847 @itemx -mno-ieee
20848 @opindex mieee
20849 @opindex mno-ieee
20850 Control the IEEE compliance of floating-point comparisons, which affects the
20851 handling of cases where the result of a comparison is unordered.  By default
20852 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20853 enabled @option{-mno-ieee} is implicitly set, which results in faster
20854 floating-point greater-equal and less-equal comparisons.  The implcit settings
20855 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20857 @item -minline-ic_invalidate
20858 @opindex minline-ic_invalidate
20859 Inline code to invalidate instruction cache entries after setting up
20860 nested function trampolines.
20861 This option has no effect if @option{-musermode} is in effect and the selected
20862 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20863 instruction.
20864 If the selected code generation option does not allow the use of the @code{icbi}
20865 instruction, and @option{-musermode} is not in effect, the inlined code
20866 manipulates the instruction cache address array directly with an associative
20867 write.  This not only requires privileged mode at run time, but it also
20868 fails if the cache line had been mapped via the TLB and has become unmapped.
20870 @item -misize
20871 @opindex misize
20872 Dump instruction size and location in the assembly code.
20874 @item -mpadstruct
20875 @opindex mpadstruct
20876 This option is deprecated.  It pads structures to multiple of 4 bytes,
20877 which is incompatible with the SH ABI@.
20879 @item -matomic-model=@var{model}
20880 @opindex matomic-model=@var{model}
20881 Sets the model of atomic operations and additional parameters as a comma
20882 separated list.  For details on the atomic built-in functions see
20883 @ref{__atomic Builtins}.  The following models and parameters are supported:
20885 @table @samp
20887 @item none
20888 Disable compiler generated atomic sequences and emit library calls for atomic
20889 operations.  This is the default if the target is not @code{sh*-*-linux*}.
20891 @item soft-gusa
20892 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20893 built-in functions.  The generated atomic sequences require additional support
20894 from the interrupt/exception handling code of the system and are only suitable
20895 for SH3* and SH4* single-core systems.  This option is enabled by default when
20896 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20897 this option also partially utilizes the hardware atomic instructions
20898 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20899 @samp{strict} is specified.  
20901 @item soft-tcb
20902 Generate software atomic sequences that use a variable in the thread control
20903 block.  This is a variation of the gUSA sequences which can also be used on
20904 SH1* and SH2* targets.  The generated atomic sequences require additional
20905 support from the interrupt/exception handling code of the system and are only
20906 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20907 parameter has to be specified as well.
20909 @item soft-imask
20910 Generate software atomic sequences that temporarily disable interrupts by
20911 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20912 in privileged mode and is only suitable for single-core systems.  Additional
20913 support from the interrupt/exception handling code of the system is not
20914 required.  This model is enabled by default when the target is
20915 @code{sh*-*-linux*} and SH1* or SH2*.
20917 @item hard-llcs
20918 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20919 instructions only.  This is only available on SH4A and is suitable for
20920 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20921 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20922 Code compiled with this option is also compatible with other software
20923 atomic model interrupt/exception handling systems if executed on an SH4A
20924 system.  Additional support from the interrupt/exception handling code of the
20925 system is not required for this model.
20927 @item gbr-offset=
20928 This parameter specifies the offset in bytes of the variable in the thread
20929 control block structure that should be used by the generated atomic sequences
20930 when the @samp{soft-tcb} model has been selected.  For other models this
20931 parameter is ignored.  The specified value must be an integer multiple of four
20932 and in the range 0-1020.
20934 @item strict
20935 This parameter prevents mixed usage of multiple atomic models, even if they
20936 are compatible, and makes the compiler generate atomic sequences of the
20937 specified model only.
20939 @end table
20941 @item -mtas
20942 @opindex mtas
20943 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20944 Notice that depending on the particular hardware and software configuration
20945 this can degrade overall performance due to the operand cache line flushes
20946 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20947 processors the @code{tas.b} instruction must be used with caution since it
20948 can result in data corruption for certain cache configurations.
20950 @item -mprefergot
20951 @opindex mprefergot
20952 When generating position-independent code, emit function calls using
20953 the Global Offset Table instead of the Procedure Linkage Table.
20955 @item -musermode
20956 @itemx -mno-usermode
20957 @opindex musermode
20958 @opindex mno-usermode
20959 Don't allow (allow) the compiler generating privileged mode code.  Specifying
20960 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
20961 inlined code would not work in user mode.  @option{-musermode} is the default
20962 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
20963 @option{-musermode} has no effect, since there is no user mode.
20965 @item -multcost=@var{number}
20966 @opindex multcost=@var{number}
20967 Set the cost to assume for a multiply insn.
20969 @item -mdiv=@var{strategy}
20970 @opindex mdiv=@var{strategy}
20971 Set the division strategy to be used for integer division operations.
20972 For SHmedia @var{strategy} can be one of: 
20974 @table @samp
20976 @item fp 
20977 Performs the operation in floating point.  This has a very high latency,
20978 but needs only a few instructions, so it might be a good choice if
20979 your code has enough easily-exploitable ILP to allow the compiler to
20980 schedule the floating-point instructions together with other instructions.
20981 Division by zero causes a floating-point exception.
20983 @item inv
20984 Uses integer operations to calculate the inverse of the divisor,
20985 and then multiplies the dividend with the inverse.  This strategy allows
20986 CSE and hoisting of the inverse calculation.  Division by zero calculates
20987 an unspecified result, but does not trap.
20989 @item inv:minlat
20990 A variant of @samp{inv} where, if no CSE or hoisting opportunities
20991 have been found, or if the entire operation has been hoisted to the same
20992 place, the last stages of the inverse calculation are intertwined with the
20993 final multiply to reduce the overall latency, at the expense of using a few
20994 more instructions, and thus offering fewer scheduling opportunities with
20995 other code.
20997 @item call
20998 Calls a library function that usually implements the @samp{inv:minlat}
20999 strategy.
21000 This gives high code density for @code{m5-*media-nofpu} compilations.
21002 @item call2
21003 Uses a different entry point of the same library function, where it
21004 assumes that a pointer to a lookup table has already been set up, which
21005 exposes the pointer load to CSE and code hoisting optimizations.
21007 @item inv:call
21008 @itemx inv:call2
21009 @itemx inv:fp
21010 Use the @samp{inv} algorithm for initial
21011 code generation, but if the code stays unoptimized, revert to the @samp{call},
21012 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21013 potentially-trapping side effect of division by zero is carried by a
21014 separate instruction, so it is possible that all the integer instructions
21015 are hoisted out, but the marker for the side effect stays where it is.
21016 A recombination to floating-point operations or a call is not possible
21017 in that case.
21019 @item inv20u
21020 @itemx inv20l
21021 Variants of the @samp{inv:minlat} strategy.  In the case
21022 that the inverse calculation is not separated from the multiply, they speed
21023 up division where the dividend fits into 20 bits (plus sign where applicable)
21024 by inserting a test to skip a number of operations in this case; this test
21025 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21026 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21028 @end table
21030 For targets other than SHmedia @var{strategy} can be one of:
21032 @table @samp
21034 @item call-div1
21035 Calls a library function that uses the single-step division instruction
21036 @code{div1} to perform the operation.  Division by zero calculates an
21037 unspecified result and does not trap.  This is the default except for SH4,
21038 SH2A and SHcompact.
21040 @item call-fp
21041 Calls a library function that performs the operation in double precision
21042 floating point.  Division by zero causes a floating-point exception.  This is
21043 the default for SHcompact with FPU.  Specifying this for targets that do not
21044 have a double precision FPU defaults to @code{call-div1}.
21046 @item call-table
21047 Calls a library function that uses a lookup table for small divisors and
21048 the @code{div1} instruction with case distinction for larger divisors.  Division
21049 by zero calculates an unspecified result and does not trap.  This is the default
21050 for SH4.  Specifying this for targets that do not have dynamic shift
21051 instructions defaults to @code{call-div1}.
21053 @end table
21055 When a division strategy has not been specified the default strategy is
21056 selected based on the current target.  For SH2A the default strategy is to
21057 use the @code{divs} and @code{divu} instructions instead of library function
21058 calls.
21060 @item -maccumulate-outgoing-args
21061 @opindex maccumulate-outgoing-args
21062 Reserve space once for outgoing arguments in the function prologue rather
21063 than around each call.  Generally beneficial for performance and size.  Also
21064 needed for unwinding to avoid changing the stack frame around conditional code.
21066 @item -mdivsi3_libfunc=@var{name}
21067 @opindex mdivsi3_libfunc=@var{name}
21068 Set the name of the library function used for 32-bit signed division to
21069 @var{name}.
21070 This only affects the name used in the @samp{call} and @samp{inv:call}
21071 division strategies, and the compiler still expects the same
21072 sets of input/output/clobbered registers as if this option were not present.
21074 @item -mfixed-range=@var{register-range}
21075 @opindex mfixed-range
21076 Generate code treating the given register range as fixed registers.
21077 A fixed register is one that the register allocator can not use.  This is
21078 useful when compiling kernel code.  A register range is specified as
21079 two registers separated by a dash.  Multiple register ranges can be
21080 specified separated by a comma.
21082 @item -mindexed-addressing
21083 @opindex mindexed-addressing
21084 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21085 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21086 semantics for the indexed addressing mode.  The architecture allows the
21087 implementation of processors with 64-bit MMU, which the OS could use to
21088 get 32-bit addressing, but since no current hardware implementation supports
21089 this or any other way to make the indexed addressing mode safe to use in
21090 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21092 @item -mgettrcost=@var{number}
21093 @opindex mgettrcost=@var{number}
21094 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21095 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21097 @item -mpt-fixed
21098 @opindex mpt-fixed
21099 Assume @code{pt*} instructions won't trap.  This generally generates
21100 better-scheduled code, but is unsafe on current hardware.
21101 The current architecture
21102 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21103 anded with 3 is 3.
21104 This has the unintentional effect of making it unsafe to schedule these
21105 instructions before a branch, or hoist them out of a loop.  For example,
21106 @code{__do_global_ctors}, a part of @file{libgcc}
21107 that runs constructors at program
21108 startup, calls functions in a list which is delimited by @minus{}1.  With the
21109 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21110 That means that all the constructors run a bit more quickly, but when
21111 the loop comes to the end of the list, the program crashes because @code{ptabs}
21112 loads @minus{}1 into a target register.  
21114 Since this option is unsafe for any
21115 hardware implementing the current architecture specification, the default
21116 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21117 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21118 this deters register allocation from using target registers for storing
21119 ordinary integers.
21121 @item -minvalid-symbols
21122 @opindex minvalid-symbols
21123 Assume symbols might be invalid.  Ordinary function symbols generated by
21124 the compiler are always valid to load with
21125 @code{movi}/@code{shori}/@code{ptabs} or
21126 @code{movi}/@code{shori}/@code{ptrel},
21127 but with assembler and/or linker tricks it is possible
21128 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21129 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21130 It prevents cross-basic-block CSE, hoisting and most scheduling
21131 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21133 @item -mbranch-cost=@var{num}
21134 @opindex mbranch-cost=@var{num}
21135 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21136 make the compiler try to generate more branch-free code if possible.  
21137 If not specified the value is selected depending on the processor type that
21138 is being compiled for.
21140 @item -mzdcbranch
21141 @itemx -mno-zdcbranch
21142 @opindex mzdcbranch
21143 @opindex mno-zdcbranch
21144 Assume (do not assume) that zero displacement conditional branch instructions
21145 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21146 compiler prefers zero displacement branch code sequences.  This is
21147 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21148 disabled by specifying @option{-mno-zdcbranch}.
21150 @item -mcbranch-force-delay-slot
21151 @opindex mcbranch-force-delay-slot
21152 Force the usage of delay slots for conditional branches, which stuffs the delay
21153 slot with a @code{nop} if a suitable instruction can't be found.  By default
21154 this option is disabled.  It can be enabled to work around hardware bugs as
21155 found in the original SH7055.
21157 @item -mfused-madd
21158 @itemx -mno-fused-madd
21159 @opindex mfused-madd
21160 @opindex mno-fused-madd
21161 Generate code that uses (does not use) the floating-point multiply and
21162 accumulate instructions.  These instructions are generated by default
21163 if hardware floating point is used.  The machine-dependent
21164 @option{-mfused-madd} option is now mapped to the machine-independent
21165 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21166 mapped to @option{-ffp-contract=off}.
21168 @item -mfsca
21169 @itemx -mno-fsca
21170 @opindex mfsca
21171 @opindex mno-fsca
21172 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21173 and cosine approximations.  The option @option{-mfsca} must be used in
21174 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21175 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21176 approximations even if @option{-funsafe-math-optimizations} is in effect.
21178 @item -mfsrra
21179 @itemx -mno-fsrra
21180 @opindex mfsrra
21181 @opindex mno-fsrra
21182 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21183 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21184 in combination with @option{-funsafe-math-optimizations} and
21185 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21186 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21187 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21188 in effect.
21190 @item -mpretend-cmove
21191 @opindex mpretend-cmove
21192 Prefer zero-displacement conditional branches for conditional move instruction
21193 patterns.  This can result in faster code on the SH4 processor.
21195 @end table
21197 @node Solaris 2 Options
21198 @subsection Solaris 2 Options
21199 @cindex Solaris 2 options
21201 These @samp{-m} options are supported on Solaris 2:
21203 @table @gcctabopt
21204 @item -mclear-hwcap
21205 @opindex mclear-hwcap
21206 @option{-mclear-hwcap} tells the compiler to remove the hardware
21207 capabilities generated by the Solaris assembler.  This is only necessary
21208 when object files use ISA extensions not supported by the current
21209 machine, but check at runtime whether or not to use them.
21211 @item -mimpure-text
21212 @opindex mimpure-text
21213 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21214 the compiler to not pass @option{-z text} to the linker when linking a
21215 shared object.  Using this option, you can link position-dependent
21216 code into a shared object.
21218 @option{-mimpure-text} suppresses the ``relocations remain against
21219 allocatable but non-writable sections'' linker error message.
21220 However, the necessary relocations trigger copy-on-write, and the
21221 shared object is not actually shared across processes.  Instead of
21222 using @option{-mimpure-text}, you should compile all source code with
21223 @option{-fpic} or @option{-fPIC}.
21225 @end table
21227 These switches are supported in addition to the above on Solaris 2:
21229 @table @gcctabopt
21230 @item -pthreads
21231 @opindex pthreads
21232 Add support for multithreading using the POSIX threads library.  This
21233 option sets flags for both the preprocessor and linker.  This option does
21234 not affect the thread safety of object code produced  by the compiler or
21235 that of libraries supplied with it.
21237 @item -pthread
21238 @opindex pthread
21239 This is a synonym for @option{-pthreads}.
21240 @end table
21242 @node SPARC Options
21243 @subsection SPARC Options
21244 @cindex SPARC options
21246 These @samp{-m} options are supported on the SPARC:
21248 @table @gcctabopt
21249 @item -mno-app-regs
21250 @itemx -mapp-regs
21251 @opindex mno-app-regs
21252 @opindex mapp-regs
21253 Specify @option{-mapp-regs} to generate output using the global registers
21254 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21255 global register 1, each global register 2 through 4 is then treated as an
21256 allocable register that is clobbered by function calls.  This is the default.
21258 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21259 specify @option{-mno-app-regs}.  You should compile libraries and system
21260 software with this option.
21262 @item -mflat
21263 @itemx -mno-flat
21264 @opindex mflat
21265 @opindex mno-flat
21266 With @option{-mflat}, the compiler does not generate save/restore instructions
21267 and uses a ``flat'' or single register window model.  This model is compatible
21268 with the regular register window model.  The local registers and the input
21269 registers (0--5) are still treated as ``call-saved'' registers and are
21270 saved on the stack as needed.
21272 With @option{-mno-flat} (the default), the compiler generates save/restore
21273 instructions (except for leaf functions).  This is the normal operating mode.
21275 @item -mfpu
21276 @itemx -mhard-float
21277 @opindex mfpu
21278 @opindex mhard-float
21279 Generate output containing floating-point instructions.  This is the
21280 default.
21282 @item -mno-fpu
21283 @itemx -msoft-float
21284 @opindex mno-fpu
21285 @opindex msoft-float
21286 Generate output containing library calls for floating point.
21287 @strong{Warning:} the requisite libraries are not available for all SPARC
21288 targets.  Normally the facilities of the machine's usual C compiler are
21289 used, but this cannot be done directly in cross-compilation.  You must make
21290 your own arrangements to provide suitable library functions for
21291 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21292 @samp{sparclite-*-*} do provide software floating-point support.
21294 @option{-msoft-float} changes the calling convention in the output file;
21295 therefore, it is only useful if you compile @emph{all} of a program with
21296 this option.  In particular, you need to compile @file{libgcc.a}, the
21297 library that comes with GCC, with @option{-msoft-float} in order for
21298 this to work.
21300 @item -mhard-quad-float
21301 @opindex mhard-quad-float
21302 Generate output containing quad-word (long double) floating-point
21303 instructions.
21305 @item -msoft-quad-float
21306 @opindex msoft-quad-float
21307 Generate output containing library calls for quad-word (long double)
21308 floating-point instructions.  The functions called are those specified
21309 in the SPARC ABI@.  This is the default.
21311 As of this writing, there are no SPARC implementations that have hardware
21312 support for the quad-word floating-point instructions.  They all invoke
21313 a trap handler for one of these instructions, and then the trap handler
21314 emulates the effect of the instruction.  Because of the trap handler overhead,
21315 this is much slower than calling the ABI library routines.  Thus the
21316 @option{-msoft-quad-float} option is the default.
21318 @item -mno-unaligned-doubles
21319 @itemx -munaligned-doubles
21320 @opindex mno-unaligned-doubles
21321 @opindex munaligned-doubles
21322 Assume that doubles have 8-byte alignment.  This is the default.
21324 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21325 alignment only if they are contained in another type, or if they have an
21326 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21327 Specifying this option avoids some rare compatibility problems with code
21328 generated by other compilers.  It is not the default because it results
21329 in a performance loss, especially for floating-point code.
21331 @item -muser-mode
21332 @itemx -mno-user-mode
21333 @opindex muser-mode
21334 @opindex mno-user-mode
21335 Do not generate code that can only run in supervisor mode.  This is relevant
21336 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21337 default is @option{-mno-user-mode}.
21339 @item -mno-faster-structs
21340 @itemx -mfaster-structs
21341 @opindex mno-faster-structs
21342 @opindex mfaster-structs
21343 With @option{-mfaster-structs}, the compiler assumes that structures
21344 should have 8-byte alignment.  This enables the use of pairs of
21345 @code{ldd} and @code{std} instructions for copies in structure
21346 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21347 However, the use of this changed alignment directly violates the SPARC
21348 ABI@.  Thus, it's intended only for use on targets where the developer
21349 acknowledges that their resulting code is not directly in line with
21350 the rules of the ABI@.
21352 @item -mcpu=@var{cpu_type}
21353 @opindex mcpu
21354 Set the instruction set, register set, and instruction scheduling parameters
21355 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21356 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21357 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21358 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21359 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21360 @samp{niagara3} and @samp{niagara4}.
21362 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21363 which selects the best architecture option for the host processor.
21364 @option{-mcpu=native} has no effect if GCC does not recognize
21365 the processor.
21367 Default instruction scheduling parameters are used for values that select
21368 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21369 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21371 Here is a list of each supported architecture and their supported
21372 implementations.
21374 @table @asis
21375 @item v7
21376 cypress, leon3v7
21378 @item v8
21379 supersparc, hypersparc, leon, leon3
21381 @item sparclite
21382 f930, f934, sparclite86x
21384 @item sparclet
21385 tsc701
21387 @item v9
21388 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21389 @end table
21391 By default (unless configured otherwise), GCC generates code for the V7
21392 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21393 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21394 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21395 SPARCStation 1, 2, IPX etc.
21397 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21398 architecture.  The only difference from V7 code is that the compiler emits
21399 the integer multiply and integer divide instructions which exist in SPARC-V8
21400 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21401 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21402 2000 series.
21404 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21405 the SPARC architecture.  This adds the integer multiply, integer divide step
21406 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21407 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21408 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21409 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21410 MB86934 chip, which is the more recent SPARClite with FPU@.
21412 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21413 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21414 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21415 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21416 optimizes it for the TEMIC SPARClet chip.
21418 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21419 architecture.  This adds 64-bit integer and floating-point move instructions,
21420 3 additional floating-point condition code registers and conditional move
21421 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21422 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21423 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21424 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21425 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21426 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21427 additionally optimizes it for Sun UltraSPARC T2 chips. With
21428 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21429 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21430 additionally optimizes it for Sun UltraSPARC T4 chips.
21432 @item -mtune=@var{cpu_type}
21433 @opindex mtune
21434 Set the instruction scheduling parameters for machine type
21435 @var{cpu_type}, but do not set the instruction set or register set that the
21436 option @option{-mcpu=@var{cpu_type}} does.
21438 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21439 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21440 that select a particular CPU implementation.  Those are @samp{cypress},
21441 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21442 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21443 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21444 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21445 toolchains, @samp{native} can also be used.
21447 @item -mv8plus
21448 @itemx -mno-v8plus
21449 @opindex mv8plus
21450 @opindex mno-v8plus
21451 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21452 difference from the V8 ABI is that the global and out registers are
21453 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21454 mode for all SPARC-V9 processors.
21456 @item -mvis
21457 @itemx -mno-vis
21458 @opindex mvis
21459 @opindex mno-vis
21460 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21461 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21463 @item -mvis2
21464 @itemx -mno-vis2
21465 @opindex mvis2
21466 @opindex mno-vis2
21467 With @option{-mvis2}, GCC generates code that takes advantage of
21468 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21469 default is @option{-mvis2} when targeting a cpu that supports such
21470 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21471 also sets @option{-mvis}.
21473 @item -mvis3
21474 @itemx -mno-vis3
21475 @opindex mvis3
21476 @opindex mno-vis3
21477 With @option{-mvis3}, GCC generates code that takes advantage of
21478 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21479 default is @option{-mvis3} when targeting a cpu that supports such
21480 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21481 also sets @option{-mvis2} and @option{-mvis}.
21483 @item -mcbcond
21484 @itemx -mno-cbcond
21485 @opindex mcbcond
21486 @opindex mno-cbcond
21487 With @option{-mcbcond}, GCC generates code that takes advantage of
21488 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21489 The default is @option{-mcbcond} when targeting a cpu that supports such
21490 instructions, such as niagara-4 and later.
21492 @item -mpopc
21493 @itemx -mno-popc
21494 @opindex mpopc
21495 @opindex mno-popc
21496 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21497 population count instruction.  The default is @option{-mpopc}
21498 when targeting a cpu that supports such instructions, such as Niagara-2 and
21499 later.
21501 @item -mfmaf
21502 @itemx -mno-fmaf
21503 @opindex mfmaf
21504 @opindex mno-fmaf
21505 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21506 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21507 when targeting a cpu that supports such instructions, such as Niagara-3 and
21508 later.
21510 @item -mfix-at697f
21511 @opindex mfix-at697f
21512 Enable the documented workaround for the single erratum of the Atmel AT697F
21513 processor (which corresponds to erratum #13 of the AT697E processor).
21515 @item -mfix-ut699
21516 @opindex mfix-ut699
21517 Enable the documented workarounds for the floating-point errata and the data
21518 cache nullify errata of the UT699 processor.
21519 @end table
21521 These @samp{-m} options are supported in addition to the above
21522 on SPARC-V9 processors in 64-bit environments:
21524 @table @gcctabopt
21525 @item -m32
21526 @itemx -m64
21527 @opindex m32
21528 @opindex m64
21529 Generate code for a 32-bit or 64-bit environment.
21530 The 32-bit environment sets int, long and pointer to 32 bits.
21531 The 64-bit environment sets int to 32 bits and long and pointer
21532 to 64 bits.
21534 @item -mcmodel=@var{which}
21535 @opindex mcmodel
21536 Set the code model to one of
21538 @table @samp
21539 @item medlow
21540 The Medium/Low code model: 64-bit addresses, programs
21541 must be linked in the low 32 bits of memory.  Programs can be statically
21542 or dynamically linked.
21544 @item medmid
21545 The Medium/Middle code model: 64-bit addresses, programs
21546 must be linked in the low 44 bits of memory, the text and data segments must
21547 be less than 2GB in size and the data segment must be located within 2GB of
21548 the text segment.
21550 @item medany
21551 The Medium/Anywhere code model: 64-bit addresses, programs
21552 may be linked anywhere in memory, the text and data segments must be less
21553 than 2GB in size and the data segment must be located within 2GB of the
21554 text segment.
21556 @item embmedany
21557 The Medium/Anywhere code model for embedded systems:
21558 64-bit addresses, the text and data segments must be less than 2GB in
21559 size, both starting anywhere in memory (determined at link time).  The
21560 global register %g4 points to the base of the data segment.  Programs
21561 are statically linked and PIC is not supported.
21562 @end table
21564 @item -mmemory-model=@var{mem-model}
21565 @opindex mmemory-model
21566 Set the memory model in force on the processor to one of
21568 @table @samp
21569 @item default
21570 The default memory model for the processor and operating system.
21572 @item rmo
21573 Relaxed Memory Order
21575 @item pso
21576 Partial Store Order
21578 @item tso
21579 Total Store Order
21581 @item sc
21582 Sequential Consistency
21583 @end table
21585 These memory models are formally defined in Appendix D of the Sparc V9
21586 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21588 @item -mstack-bias
21589 @itemx -mno-stack-bias
21590 @opindex mstack-bias
21591 @opindex mno-stack-bias
21592 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21593 frame pointer if present, are offset by @minus{}2047 which must be added back
21594 when making stack frame references.  This is the default in 64-bit mode.
21595 Otherwise, assume no such offset is present.
21596 @end table
21598 @node SPU Options
21599 @subsection SPU Options
21600 @cindex SPU options
21602 These @samp{-m} options are supported on the SPU:
21604 @table @gcctabopt
21605 @item -mwarn-reloc
21606 @itemx -merror-reloc
21607 @opindex mwarn-reloc
21608 @opindex merror-reloc
21610 The loader for SPU does not handle dynamic relocations.  By default, GCC
21611 gives an error when it generates code that requires a dynamic
21612 relocation.  @option{-mno-error-reloc} disables the error,
21613 @option{-mwarn-reloc} generates a warning instead.
21615 @item -msafe-dma
21616 @itemx -munsafe-dma
21617 @opindex msafe-dma
21618 @opindex munsafe-dma
21620 Instructions that initiate or test completion of DMA must not be
21621 reordered with respect to loads and stores of the memory that is being
21622 accessed.
21623 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21624 memory accesses, but that can lead to inefficient code in places where the
21625 memory is known to not change.  Rather than mark the memory as volatile,
21626 you can use @option{-msafe-dma} to tell the compiler to treat
21627 the DMA instructions as potentially affecting all memory.  
21629 @item -mbranch-hints
21630 @opindex mbranch-hints
21632 By default, GCC generates a branch hint instruction to avoid
21633 pipeline stalls for always-taken or probably-taken branches.  A hint
21634 is not generated closer than 8 instructions away from its branch.
21635 There is little reason to disable them, except for debugging purposes,
21636 or to make an object a little bit smaller.
21638 @item -msmall-mem
21639 @itemx -mlarge-mem
21640 @opindex msmall-mem
21641 @opindex mlarge-mem
21643 By default, GCC generates code assuming that addresses are never larger
21644 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21645 a full 32-bit address.
21647 @item -mstdmain
21648 @opindex mstdmain
21650 By default, GCC links against startup code that assumes the SPU-style
21651 main function interface (which has an unconventional parameter list).
21652 With @option{-mstdmain}, GCC links your program against startup
21653 code that assumes a C99-style interface to @code{main}, including a
21654 local copy of @code{argv} strings.
21656 @item -mfixed-range=@var{register-range}
21657 @opindex mfixed-range
21658 Generate code treating the given register range as fixed registers.
21659 A fixed register is one that the register allocator cannot use.  This is
21660 useful when compiling kernel code.  A register range is specified as
21661 two registers separated by a dash.  Multiple register ranges can be
21662 specified separated by a comma.
21664 @item -mea32
21665 @itemx -mea64
21666 @opindex mea32
21667 @opindex mea64
21668 Compile code assuming that pointers to the PPU address space accessed
21669 via the @code{__ea} named address space qualifier are either 32 or 64
21670 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21671 all object code in an executable must be compiled with the same setting.
21673 @item -maddress-space-conversion
21674 @itemx -mno-address-space-conversion
21675 @opindex maddress-space-conversion
21676 @opindex mno-address-space-conversion
21677 Allow/disallow treating the @code{__ea} address space as superset
21678 of the generic address space.  This enables explicit type casts
21679 between @code{__ea} and generic pointer as well as implicit
21680 conversions of generic pointers to @code{__ea} pointers.  The
21681 default is to allow address space pointer conversions.
21683 @item -mcache-size=@var{cache-size}
21684 @opindex mcache-size
21685 This option controls the version of libgcc that the compiler links to an
21686 executable and selects a software-managed cache for accessing variables
21687 in the @code{__ea} address space with a particular cache size.  Possible
21688 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21689 and @samp{128}.  The default cache size is 64KB.
21691 @item -matomic-updates
21692 @itemx -mno-atomic-updates
21693 @opindex matomic-updates
21694 @opindex mno-atomic-updates
21695 This option controls the version of libgcc that the compiler links to an
21696 executable and selects whether atomic updates to the software-managed
21697 cache of PPU-side variables are used.  If you use atomic updates, changes
21698 to a PPU variable from SPU code using the @code{__ea} named address space
21699 qualifier do not interfere with changes to other PPU variables residing
21700 in the same cache line from PPU code.  If you do not use atomic updates,
21701 such interference may occur; however, writing back cache lines is
21702 more efficient.  The default behavior is to use atomic updates.
21704 @item -mdual-nops
21705 @itemx -mdual-nops=@var{n}
21706 @opindex mdual-nops
21707 By default, GCC inserts nops to increase dual issue when it expects
21708 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21709 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21710 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21712 @item -mhint-max-nops=@var{n}
21713 @opindex mhint-max-nops
21714 Maximum number of nops to insert for a branch hint.  A branch hint must
21715 be at least 8 instructions away from the branch it is affecting.  GCC
21716 inserts up to @var{n} nops to enforce this, otherwise it does not
21717 generate the branch hint.
21719 @item -mhint-max-distance=@var{n}
21720 @opindex mhint-max-distance
21721 The encoding of the branch hint instruction limits the hint to be within
21722 256 instructions of the branch it is affecting.  By default, GCC makes
21723 sure it is within 125.
21725 @item -msafe-hints
21726 @opindex msafe-hints
21727 Work around a hardware bug that causes the SPU to stall indefinitely.
21728 By default, GCC inserts the @code{hbrp} instruction to make sure
21729 this stall won't happen.
21731 @end table
21733 @node System V Options
21734 @subsection Options for System V
21736 These additional options are available on System V Release 4 for
21737 compatibility with other compilers on those systems:
21739 @table @gcctabopt
21740 @item -G
21741 @opindex G
21742 Create a shared object.
21743 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21745 @item -Qy
21746 @opindex Qy
21747 Identify the versions of each tool used by the compiler, in a
21748 @code{.ident} assembler directive in the output.
21750 @item -Qn
21751 @opindex Qn
21752 Refrain from adding @code{.ident} directives to the output file (this is
21753 the default).
21755 @item -YP,@var{dirs}
21756 @opindex YP
21757 Search the directories @var{dirs}, and no others, for libraries
21758 specified with @option{-l}.
21760 @item -Ym,@var{dir}
21761 @opindex Ym
21762 Look in the directory @var{dir} to find the M4 preprocessor.
21763 The assembler uses this option.
21764 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21765 @c the generic assembler that comes with Solaris takes just -Ym.
21766 @end table
21768 @node TILE-Gx Options
21769 @subsection TILE-Gx Options
21770 @cindex TILE-Gx options
21772 These @samp{-m} options are supported on the TILE-Gx:
21774 @table @gcctabopt
21775 @item -mcmodel=small
21776 @opindex mcmodel=small
21777 Generate code for the small model.  The distance for direct calls is
21778 limited to 500M in either direction.  PC-relative addresses are 32
21779 bits.  Absolute addresses support the full address range.
21781 @item -mcmodel=large
21782 @opindex mcmodel=large
21783 Generate code for the large model.  There is no limitation on call
21784 distance, pc-relative addresses, or absolute addresses.
21786 @item -mcpu=@var{name}
21787 @opindex mcpu
21788 Selects the type of CPU to be targeted.  Currently the only supported
21789 type is @samp{tilegx}.
21791 @item -m32
21792 @itemx -m64
21793 @opindex m32
21794 @opindex m64
21795 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21796 environment sets int, long, and pointer to 32 bits.  The 64-bit
21797 environment sets int to 32 bits and long and pointer to 64 bits.
21799 @item -mbig-endian
21800 @itemx -mlittle-endian
21801 @opindex mbig-endian
21802 @opindex mlittle-endian
21803 Generate code in big/little endian mode, respectively.
21804 @end table
21806 @node TILEPro Options
21807 @subsection TILEPro Options
21808 @cindex TILEPro options
21810 These @samp{-m} options are supported on the TILEPro:
21812 @table @gcctabopt
21813 @item -mcpu=@var{name}
21814 @opindex mcpu
21815 Selects the type of CPU to be targeted.  Currently the only supported
21816 type is @samp{tilepro}.
21818 @item -m32
21819 @opindex m32
21820 Generate code for a 32-bit environment, which sets int, long, and
21821 pointer to 32 bits.  This is the only supported behavior so the flag
21822 is essentially ignored.
21823 @end table
21825 @node V850 Options
21826 @subsection V850 Options
21827 @cindex V850 Options
21829 These @samp{-m} options are defined for V850 implementations:
21831 @table @gcctabopt
21832 @item -mlong-calls
21833 @itemx -mno-long-calls
21834 @opindex mlong-calls
21835 @opindex mno-long-calls
21836 Treat all calls as being far away (near).  If calls are assumed to be
21837 far away, the compiler always loads the function's address into a
21838 register, and calls indirect through the pointer.
21840 @item -mno-ep
21841 @itemx -mep
21842 @opindex mno-ep
21843 @opindex mep
21844 Do not optimize (do optimize) basic blocks that use the same index
21845 pointer 4 or more times to copy pointer into the @code{ep} register, and
21846 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21847 option is on by default if you optimize.
21849 @item -mno-prolog-function
21850 @itemx -mprolog-function
21851 @opindex mno-prolog-function
21852 @opindex mprolog-function
21853 Do not use (do use) external functions to save and restore registers
21854 at the prologue and epilogue of a function.  The external functions
21855 are slower, but use less code space if more than one function saves
21856 the same number of registers.  The @option{-mprolog-function} option
21857 is on by default if you optimize.
21859 @item -mspace
21860 @opindex mspace
21861 Try to make the code as small as possible.  At present, this just turns
21862 on the @option{-mep} and @option{-mprolog-function} options.
21864 @item -mtda=@var{n}
21865 @opindex mtda
21866 Put static or global variables whose size is @var{n} bytes or less into
21867 the tiny data area that register @code{ep} points to.  The tiny data
21868 area can hold up to 256 bytes in total (128 bytes for byte references).
21870 @item -msda=@var{n}
21871 @opindex msda
21872 Put static or global variables whose size is @var{n} bytes or less into
21873 the small data area that register @code{gp} points to.  The small data
21874 area can hold up to 64 kilobytes.
21876 @item -mzda=@var{n}
21877 @opindex mzda
21878 Put static or global variables whose size is @var{n} bytes or less into
21879 the first 32 kilobytes of memory.
21881 @item -mv850
21882 @opindex mv850
21883 Specify that the target processor is the V850.
21885 @item -mv850e3v5
21886 @opindex mv850e3v5
21887 Specify that the target processor is the V850E3V5.  The preprocessor
21888 constant @code{__v850e3v5__} is defined if this option is used.
21890 @item -mv850e2v4
21891 @opindex mv850e2v4
21892 Specify that the target processor is the V850E3V5.  This is an alias for
21893 the @option{-mv850e3v5} option.
21895 @item -mv850e2v3
21896 @opindex mv850e2v3
21897 Specify that the target processor is the V850E2V3.  The preprocessor
21898 constant @code{__v850e2v3__} is defined if this option is used.
21900 @item -mv850e2
21901 @opindex mv850e2
21902 Specify that the target processor is the V850E2.  The preprocessor
21903 constant @code{__v850e2__} is defined if this option is used.
21905 @item -mv850e1
21906 @opindex mv850e1
21907 Specify that the target processor is the V850E1.  The preprocessor
21908 constants @code{__v850e1__} and @code{__v850e__} are defined if
21909 this option is used.
21911 @item -mv850es
21912 @opindex mv850es
21913 Specify that the target processor is the V850ES.  This is an alias for
21914 the @option{-mv850e1} option.
21916 @item -mv850e
21917 @opindex mv850e
21918 Specify that the target processor is the V850E@.  The preprocessor
21919 constant @code{__v850e__} is defined if this option is used.
21921 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21922 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21923 are defined then a default target processor is chosen and the
21924 relevant @samp{__v850*__} preprocessor constant is defined.
21926 The preprocessor constants @code{__v850} and @code{__v851__} are always
21927 defined, regardless of which processor variant is the target.
21929 @item -mdisable-callt
21930 @itemx -mno-disable-callt
21931 @opindex mdisable-callt
21932 @opindex mno-disable-callt
21933 This option suppresses generation of the @code{CALLT} instruction for the
21934 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21935 architecture.
21937 This option is enabled by default when the RH850 ABI is
21938 in use (see @option{-mrh850-abi}), and disabled by default when the
21939 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21940 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
21942 @item -mrelax
21943 @itemx -mno-relax
21944 @opindex mrelax
21945 @opindex mno-relax
21946 Pass on (or do not pass on) the @option{-mrelax} command-line option
21947 to the assembler.
21949 @item -mlong-jumps
21950 @itemx -mno-long-jumps
21951 @opindex mlong-jumps
21952 @opindex mno-long-jumps
21953 Disable (or re-enable) the generation of PC-relative jump instructions.
21955 @item -msoft-float
21956 @itemx -mhard-float
21957 @opindex msoft-float
21958 @opindex mhard-float
21959 Disable (or re-enable) the generation of hardware floating point
21960 instructions.  This option is only significant when the target
21961 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21962 instructions are being generated then the C preprocessor symbol
21963 @code{__FPU_OK__} is defined, otherwise the symbol
21964 @code{__NO_FPU__} is defined.
21966 @item -mloop
21967 @opindex mloop
21968 Enables the use of the e3v5 LOOP instruction.  The use of this
21969 instruction is not enabled by default when the e3v5 architecture is
21970 selected because its use is still experimental.
21972 @item -mrh850-abi
21973 @itemx -mghs
21974 @opindex mrh850-abi
21975 @opindex mghs
21976 Enables support for the RH850 version of the V850 ABI.  This is the
21977 default.  With this version of the ABI the following rules apply:
21979 @itemize
21980 @item
21981 Integer sized structures and unions are returned via a memory pointer
21982 rather than a register.
21984 @item
21985 Large structures and unions (more than 8 bytes in size) are passed by
21986 value.
21988 @item
21989 Functions are aligned to 16-bit boundaries.
21991 @item
21992 The @option{-m8byte-align} command-line option is supported.
21994 @item
21995 The @option{-mdisable-callt} command-line option is enabled by
21996 default.  The @option{-mno-disable-callt} command-line option is not
21997 supported.
21998 @end itemize
22000 When this version of the ABI is enabled the C preprocessor symbol
22001 @code{__V850_RH850_ABI__} is defined.
22003 @item -mgcc-abi
22004 @opindex mgcc-abi
22005 Enables support for the old GCC version of the V850 ABI.  With this
22006 version of the ABI the following rules apply:
22008 @itemize
22009 @item
22010 Integer sized structures and unions are returned in register @code{r10}.
22012 @item
22013 Large structures and unions (more than 8 bytes in size) are passed by
22014 reference.
22016 @item
22017 Functions are aligned to 32-bit boundaries, unless optimizing for
22018 size.
22020 @item
22021 The @option{-m8byte-align} command-line option is not supported.
22023 @item
22024 The @option{-mdisable-callt} command-line option is supported but not
22025 enabled by default.
22026 @end itemize
22028 When this version of the ABI is enabled the C preprocessor symbol
22029 @code{__V850_GCC_ABI__} is defined.
22031 @item -m8byte-align
22032 @itemx -mno-8byte-align
22033 @opindex m8byte-align
22034 @opindex mno-8byte-align
22035 Enables support for @code{double} and @code{long long} types to be
22036 aligned on 8-byte boundaries.  The default is to restrict the
22037 alignment of all objects to at most 4-bytes.  When
22038 @option{-m8byte-align} is in effect the C preprocessor symbol
22039 @code{__V850_8BYTE_ALIGN__} is defined.
22041 @item -mbig-switch
22042 @opindex mbig-switch
22043 Generate code suitable for big switch tables.  Use this option only if
22044 the assembler/linker complain about out of range branches within a switch
22045 table.
22047 @item -mapp-regs
22048 @opindex mapp-regs
22049 This option causes r2 and r5 to be used in the code generated by
22050 the compiler.  This setting is the default.
22052 @item -mno-app-regs
22053 @opindex mno-app-regs
22054 This option causes r2 and r5 to be treated as fixed registers.
22056 @end table
22058 @node VAX Options
22059 @subsection VAX Options
22060 @cindex VAX options
22062 These @samp{-m} options are defined for the VAX:
22064 @table @gcctabopt
22065 @item -munix
22066 @opindex munix
22067 Do not output certain jump instructions (@code{aobleq} and so on)
22068 that the Unix assembler for the VAX cannot handle across long
22069 ranges.
22071 @item -mgnu
22072 @opindex mgnu
22073 Do output those jump instructions, on the assumption that the
22074 GNU assembler is being used.
22076 @item -mg
22077 @opindex mg
22078 Output code for G-format floating-point numbers instead of D-format.
22079 @end table
22081 @node Visium Options
22082 @subsection Visium Options
22083 @cindex Visium options
22085 @table @gcctabopt
22087 @item -mdebug
22088 @opindex mdebug
22089 A program which performs file I/O and is destined to run on an MCM target
22090 should be linked with this option.  It causes the libraries libc.a and
22091 libdebug.a to be linked.  The program should be run on the target under
22092 the control of the GDB remote debugging stub.
22094 @item -msim
22095 @opindex msim
22096 A program which performs file I/O and is destined to run on the simulator
22097 should be linked with option.  This causes libraries libc.a and libsim.a to
22098 be linked.
22100 @item -mfpu
22101 @itemx -mhard-float
22102 @opindex mfpu
22103 @opindex mhard-float
22104 Generate code containing floating-point instructions.  This is the
22105 default.
22107 @item -mno-fpu
22108 @itemx -msoft-float
22109 @opindex mno-fpu
22110 @opindex msoft-float
22111 Generate code containing library calls for floating-point.
22113 @option{-msoft-float} changes the calling convention in the output file;
22114 therefore, it is only useful if you compile @emph{all} of a program with
22115 this option.  In particular, you need to compile @file{libgcc.a}, the
22116 library that comes with GCC, with @option{-msoft-float} in order for
22117 this to work.
22119 @item -mcpu=@var{cpu_type}
22120 @opindex mcpu
22121 Set the instruction set, register set, and instruction scheduling parameters
22122 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22123 @samp{mcm}, @samp{gr5} and @samp{gr6}.
22125 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
22127 By default (unless configured otherwise), GCC generates code for the GR5
22128 variant of the Visium architecture.  
22130 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
22131 architecture.  The only difference from GR5 code is that the compiler will
22132 generate block move instructions.
22134 @item -mtune=@var{cpu_type}
22135 @opindex mtune
22136 Set the instruction scheduling parameters for machine type @var{cpu_type},
22137 but do not set the instruction set or register set that the option
22138 @option{-mcpu=@var{cpu_type}} would.
22140 @item -msv-mode
22141 @opindex msv-mode
22142 Generate code for the supervisor mode, where there are no restrictions on
22143 the access to general registers.  This is the default.
22145 @item -muser-mode
22146 @opindex muser-mode
22147 Generate code for the user mode, where the access to some general registers
22148 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
22149 mode; on the GR6, only registers r29 to r31 are affected.
22150 @end table
22152 @node VMS Options
22153 @subsection VMS Options
22155 These @samp{-m} options are defined for the VMS implementations:
22157 @table @gcctabopt
22158 @item -mvms-return-codes
22159 @opindex mvms-return-codes
22160 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22161 condition (e.g.@ error) codes.
22163 @item -mdebug-main=@var{prefix}
22164 @opindex mdebug-main=@var{prefix}
22165 Flag the first routine whose name starts with @var{prefix} as the main
22166 routine for the debugger.
22168 @item -mmalloc64
22169 @opindex mmalloc64
22170 Default to 64-bit memory allocation routines.
22172 @item -mpointer-size=@var{size}
22173 @opindex mpointer-size=@var{size}
22174 Set the default size of pointers. Possible options for @var{size} are
22175 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22176 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22177 The later option disables @code{pragma pointer_size}.
22178 @end table
22180 @node VxWorks Options
22181 @subsection VxWorks Options
22182 @cindex VxWorks Options
22184 The options in this section are defined for all VxWorks targets.
22185 Options specific to the target hardware are listed with the other
22186 options for that target.
22188 @table @gcctabopt
22189 @item -mrtp
22190 @opindex mrtp
22191 GCC can generate code for both VxWorks kernels and real time processes
22192 (RTPs).  This option switches from the former to the latter.  It also
22193 defines the preprocessor macro @code{__RTP__}.
22195 @item -non-static
22196 @opindex non-static
22197 Link an RTP executable against shared libraries rather than static
22198 libraries.  The options @option{-static} and @option{-shared} can
22199 also be used for RTPs (@pxref{Link Options}); @option{-static}
22200 is the default.
22202 @item -Bstatic
22203 @itemx -Bdynamic
22204 @opindex Bstatic
22205 @opindex Bdynamic
22206 These options are passed down to the linker.  They are defined for
22207 compatibility with Diab.
22209 @item -Xbind-lazy
22210 @opindex Xbind-lazy
22211 Enable lazy binding of function calls.  This option is equivalent to
22212 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22214 @item -Xbind-now
22215 @opindex Xbind-now
22216 Disable lazy binding of function calls.  This option is the default and
22217 is defined for compatibility with Diab.
22218 @end table
22220 @node x86 Options
22221 @subsection x86 Options
22222 @cindex x86 Options
22224 These @samp{-m} options are defined for the x86 family of computers.
22226 @table @gcctabopt
22228 @item -march=@var{cpu-type}
22229 @opindex march
22230 Generate instructions for the machine type @var{cpu-type}.  In contrast to
22231 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
22232 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
22233 to generate code that may not run at all on processors other than the one
22234 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
22235 @option{-mtune=@var{cpu-type}}.
22237 The choices for @var{cpu-type} are:
22239 @table @samp
22240 @item native
22241 This selects the CPU to generate code for at compilation time by determining
22242 the processor type of the compiling machine.  Using @option{-march=native}
22243 enables all instruction subsets supported by the local machine (hence
22244 the result might not run on different machines).  Using @option{-mtune=native}
22245 produces code optimized for the local machine under the constraints
22246 of the selected instruction set.  
22248 @item i386
22249 Original Intel i386 CPU@.
22251 @item i486
22252 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
22254 @item i586
22255 @itemx pentium
22256 Intel Pentium CPU with no MMX support.
22258 @item iamcu
22259 Intel MCU, based on Intel Pentium CPU.
22261 @item pentium-mmx
22262 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
22264 @item pentiumpro
22265 Intel Pentium Pro CPU@.
22267 @item i686
22268 When used with @option{-march}, the Pentium Pro
22269 instruction set is used, so the code runs on all i686 family chips.
22270 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
22272 @item pentium2
22273 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
22274 support.
22276 @item pentium3
22277 @itemx pentium3m
22278 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
22279 set support.
22281 @item pentium-m
22282 Intel Pentium M; low-power version of Intel Pentium III CPU
22283 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
22285 @item pentium4
22286 @itemx pentium4m
22287 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
22289 @item prescott
22290 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
22291 set support.
22293 @item nocona
22294 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
22295 SSE2 and SSE3 instruction set support.
22297 @item core2
22298 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
22299 instruction set support.
22301 @item nehalem
22302 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22303 SSE4.1, SSE4.2 and POPCNT instruction set support.
22305 @item westmere
22306 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22307 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
22309 @item sandybridge
22310 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22311 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
22313 @item ivybridge
22314 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22315 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
22316 instruction set support.
22318 @item haswell
22319 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22320 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22321 BMI, BMI2 and F16C instruction set support.
22323 @item broadwell
22324 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22325 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22326 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
22328 @item skylake
22329 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22330 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22331 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
22332 XSAVES instruction set support.
22334 @item bonnell
22335 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
22336 instruction set support.
22338 @item silvermont
22339 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22340 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
22342 @item knl
22343 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22344 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22345 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
22346 AVX512CD instruction set support.
22348 @item k6
22349 AMD K6 CPU with MMX instruction set support.
22351 @item k6-2
22352 @itemx k6-3
22353 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
22355 @item athlon
22356 @itemx athlon-tbird
22357 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
22358 support.
22360 @item athlon-4
22361 @itemx athlon-xp
22362 @itemx athlon-mp
22363 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
22364 instruction set support.
22366 @item k8
22367 @itemx opteron
22368 @itemx athlon64
22369 @itemx athlon-fx
22370 Processors based on the AMD K8 core with x86-64 instruction set support,
22371 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
22372 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
22373 instruction set extensions.)
22375 @item k8-sse3
22376 @itemx opteron-sse3
22377 @itemx athlon64-sse3
22378 Improved versions of AMD K8 cores with SSE3 instruction set support.
22380 @item amdfam10
22381 @itemx barcelona
22382 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
22383 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
22384 instruction set extensions.)
22386 @item bdver1
22387 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
22388 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
22389 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
22390 @item bdver2
22391 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22392 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
22393 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
22394 extensions.)
22395 @item bdver3
22396 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22397 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
22398 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
22399 64-bit instruction set extensions.
22400 @item bdver4
22401 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22402 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
22403 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
22404 SSE4.2, ABM and 64-bit instruction set extensions.
22406 @item btver1
22407 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
22408 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
22409 instruction set extensions.)
22411 @item btver2
22412 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
22413 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
22414 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
22416 @item winchip-c6
22417 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
22418 set support.
22420 @item winchip2
22421 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
22422 instruction set support.
22424 @item c3
22425 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
22426 implemented for this chip.)
22428 @item c3-2
22429 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
22430 (No scheduling is
22431 implemented for this chip.)
22433 @item geode
22434 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
22435 @end table
22437 @item -mtune=@var{cpu-type}
22438 @opindex mtune
22439 Tune to @var{cpu-type} everything applicable about the generated code, except
22440 for the ABI and the set of available instructions.  
22441 While picking a specific @var{cpu-type} schedules things appropriately
22442 for that particular chip, the compiler does not generate any code that
22443 cannot run on the default machine type unless you use a
22444 @option{-march=@var{cpu-type}} option.
22445 For example, if GCC is configured for i686-pc-linux-gnu
22446 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
22447 but still runs on i686 machines.
22449 The choices for @var{cpu-type} are the same as for @option{-march}.
22450 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
22452 @table @samp
22453 @item generic
22454 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
22455 If you know the CPU on which your code will run, then you should use
22456 the corresponding @option{-mtune} or @option{-march} option instead of
22457 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
22458 of your application will have, then you should use this option.
22460 As new processors are deployed in the marketplace, the behavior of this
22461 option will change.  Therefore, if you upgrade to a newer version of
22462 GCC, code generation controlled by this option will change to reflect
22463 the processors
22464 that are most common at the time that version of GCC is released.
22466 There is no @option{-march=generic} option because @option{-march}
22467 indicates the instruction set the compiler can use, and there is no
22468 generic instruction set applicable to all processors.  In contrast,
22469 @option{-mtune} indicates the processor (or, in this case, collection of
22470 processors) for which the code is optimized.
22472 @item intel
22473 Produce code optimized for the most current Intel processors, which are
22474 Haswell and Silvermont for this version of GCC.  If you know the CPU
22475 on which your code will run, then you should use the corresponding
22476 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
22477 But, if you want your application performs better on both Haswell and
22478 Silvermont, then you should use this option.
22480 As new Intel processors are deployed in the marketplace, the behavior of
22481 this option will change.  Therefore, if you upgrade to a newer version of
22482 GCC, code generation controlled by this option will change to reflect
22483 the most current Intel processors at the time that version of GCC is
22484 released.
22486 There is no @option{-march=intel} option because @option{-march} indicates
22487 the instruction set the compiler can use, and there is no common
22488 instruction set applicable to all processors.  In contrast,
22489 @option{-mtune} indicates the processor (or, in this case, collection of
22490 processors) for which the code is optimized.
22491 @end table
22493 @item -mcpu=@var{cpu-type}
22494 @opindex mcpu
22495 A deprecated synonym for @option{-mtune}.
22497 @item -mfpmath=@var{unit}
22498 @opindex mfpmath
22499 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
22500 for @var{unit} are:
22502 @table @samp
22503 @item 387
22504 Use the standard 387 floating-point coprocessor present on the majority of chips and
22505 emulated otherwise.  Code compiled with this option runs almost everywhere.
22506 The temporary results are computed in 80-bit precision instead of the precision
22507 specified by the type, resulting in slightly different results compared to most
22508 of other chips.  See @option{-ffloat-store} for more detailed description.
22510 This is the default choice for x86-32 targets.
22512 @item sse
22513 Use scalar floating-point instructions present in the SSE instruction set.
22514 This instruction set is supported by Pentium III and newer chips,
22515 and in the AMD line
22516 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
22517 instruction set supports only single-precision arithmetic, thus the double and
22518 extended-precision arithmetic are still done using 387.  A later version, present
22519 only in Pentium 4 and AMD x86-64 chips, supports double-precision
22520 arithmetic too.
22522 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
22523 or @option{-msse2} switches to enable SSE extensions and make this option
22524 effective.  For the x86-64 compiler, these extensions are enabled by default.
22526 The resulting code should be considerably faster in the majority of cases and avoid
22527 the numerical instability problems of 387 code, but may break some existing
22528 code that expects temporaries to be 80 bits.
22530 This is the default choice for the x86-64 compiler.
22532 @item sse,387
22533 @itemx sse+387
22534 @itemx both
22535 Attempt to utilize both instruction sets at once.  This effectively doubles the
22536 amount of available registers, and on chips with separate execution units for
22537 387 and SSE the execution resources too.  Use this option with care, as it is
22538 still experimental, because the GCC register allocator does not model separate
22539 functional units well, resulting in unstable performance.
22540 @end table
22542 @item -masm=@var{dialect}
22543 @opindex masm=@var{dialect}
22544 Output assembly instructions using selected @var{dialect}.  Also affects
22545 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
22546 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
22547 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
22548 not support @samp{intel}.
22550 @item -mieee-fp
22551 @itemx -mno-ieee-fp
22552 @opindex mieee-fp
22553 @opindex mno-ieee-fp
22554 Control whether or not the compiler uses IEEE floating-point
22555 comparisons.  These correctly handle the case where the result of a
22556 comparison is unordered.
22558 @item -msoft-float
22559 @opindex msoft-float
22560 Generate output containing library calls for floating point.
22562 @strong{Warning:} the requisite libraries are not part of GCC@.
22563 Normally the facilities of the machine's usual C compiler are used, but
22564 this can't be done directly in cross-compilation.  You must make your
22565 own arrangements to provide suitable library functions for
22566 cross-compilation.
22568 On machines where a function returns floating-point results in the 80387
22569 register stack, some floating-point opcodes may be emitted even if
22570 @option{-msoft-float} is used.
22572 @item -mno-fp-ret-in-387
22573 @opindex mno-fp-ret-in-387
22574 Do not use the FPU registers for return values of functions.
22576 The usual calling convention has functions return values of types
22577 @code{float} and @code{double} in an FPU register, even if there
22578 is no FPU@.  The idea is that the operating system should emulate
22579 an FPU@.
22581 The option @option{-mno-fp-ret-in-387} causes such values to be returned
22582 in ordinary CPU registers instead.
22584 @item -mno-fancy-math-387
22585 @opindex mno-fancy-math-387
22586 Some 387 emulators do not support the @code{sin}, @code{cos} and
22587 @code{sqrt} instructions for the 387.  Specify this option to avoid
22588 generating those instructions.  This option is the default on
22589 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
22590 indicates that the target CPU always has an FPU and so the
22591 instruction does not need emulation.  These
22592 instructions are not generated unless you also use the
22593 @option{-funsafe-math-optimizations} switch.
22595 @item -malign-double
22596 @itemx -mno-align-double
22597 @opindex malign-double
22598 @opindex mno-align-double
22599 Control whether GCC aligns @code{double}, @code{long double}, and
22600 @code{long long} variables on a two-word boundary or a one-word
22601 boundary.  Aligning @code{double} variables on a two-word boundary
22602 produces code that runs somewhat faster on a Pentium at the
22603 expense of more memory.
22605 On x86-64, @option{-malign-double} is enabled by default.
22607 @strong{Warning:} if you use the @option{-malign-double} switch,
22608 structures containing the above types are aligned differently than
22609 the published application binary interface specifications for the x86-32
22610 and are not binary compatible with structures in code compiled
22611 without that switch.
22613 @item -m96bit-long-double
22614 @itemx -m128bit-long-double
22615 @opindex m96bit-long-double
22616 @opindex m128bit-long-double
22617 These switches control the size of @code{long double} type.  The x86-32
22618 application binary interface specifies the size to be 96 bits,
22619 so @option{-m96bit-long-double} is the default in 32-bit mode.
22621 Modern architectures (Pentium and newer) prefer @code{long double}
22622 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
22623 conforming to the ABI, this is not possible.  So specifying
22624 @option{-m128bit-long-double} aligns @code{long double}
22625 to a 16-byte boundary by padding the @code{long double} with an additional
22626 32-bit zero.
22628 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
22629 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
22631 Notice that neither of these options enable any extra precision over the x87
22632 standard of 80 bits for a @code{long double}.
22634 @strong{Warning:} if you override the default value for your target ABI, this
22635 changes the size of 
22636 structures and arrays containing @code{long double} variables,
22637 as well as modifying the function calling convention for functions taking
22638 @code{long double}.  Hence they are not binary-compatible
22639 with code compiled without that switch.
22641 @item -mlong-double-64
22642 @itemx -mlong-double-80
22643 @itemx -mlong-double-128
22644 @opindex mlong-double-64
22645 @opindex mlong-double-80
22646 @opindex mlong-double-128
22647 These switches control the size of @code{long double} type. A size
22648 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22649 type. This is the default for 32-bit Bionic C library.  A size
22650 of 128 bits makes the @code{long double} type equivalent to the
22651 @code{__float128} type. This is the default for 64-bit Bionic C library.
22653 @strong{Warning:} if you override the default value for your target ABI, this
22654 changes the size of
22655 structures and arrays containing @code{long double} variables,
22656 as well as modifying the function calling convention for functions taking
22657 @code{long double}.  Hence they are not binary-compatible
22658 with code compiled without that switch.
22660 @item -malign-data=@var{type}
22661 @opindex malign-data
22662 Control how GCC aligns variables.  Supported values for @var{type} are
22663 @samp{compat} uses increased alignment value compatible uses GCC 4.8
22664 and earlier, @samp{abi} uses alignment value as specified by the
22665 psABI, and @samp{cacheline} uses increased alignment value to match
22666 the cache line size.  @samp{compat} is the default.
22668 @item -mlarge-data-threshold=@var{threshold}
22669 @opindex mlarge-data-threshold
22670 When @option{-mcmodel=medium} is specified, data objects larger than
22671 @var{threshold} are placed in the large data section.  This value must be the
22672 same across all objects linked into the binary, and defaults to 65535.
22674 @item -mrtd
22675 @opindex mrtd
22676 Use a different function-calling convention, in which functions that
22677 take a fixed number of arguments return with the @code{ret @var{num}}
22678 instruction, which pops their arguments while returning.  This saves one
22679 instruction in the caller since there is no need to pop the arguments
22680 there.
22682 You can specify that an individual function is called with this calling
22683 sequence with the function attribute @code{stdcall}.  You can also
22684 override the @option{-mrtd} option by using the function attribute
22685 @code{cdecl}.  @xref{Function Attributes}.
22687 @strong{Warning:} this calling convention is incompatible with the one
22688 normally used on Unix, so you cannot use it if you need to call
22689 libraries compiled with the Unix compiler.
22691 Also, you must provide function prototypes for all functions that
22692 take variable numbers of arguments (including @code{printf});
22693 otherwise incorrect code is generated for calls to those
22694 functions.
22696 In addition, seriously incorrect code results if you call a
22697 function with too many arguments.  (Normally, extra arguments are
22698 harmlessly ignored.)
22700 @item -mregparm=@var{num}
22701 @opindex mregparm
22702 Control how many registers are used to pass integer arguments.  By
22703 default, no registers are used to pass arguments, and at most 3
22704 registers can be used.  You can control this behavior for a specific
22705 function by using the function attribute @code{regparm}.
22706 @xref{Function Attributes}.
22708 @strong{Warning:} if you use this switch, and
22709 @var{num} is nonzero, then you must build all modules with the same
22710 value, including any libraries.  This includes the system libraries and
22711 startup modules.
22713 @item -msseregparm
22714 @opindex msseregparm
22715 Use SSE register passing conventions for float and double arguments
22716 and return values.  You can control this behavior for a specific
22717 function by using the function attribute @code{sseregparm}.
22718 @xref{Function Attributes}.
22720 @strong{Warning:} if you use this switch then you must build all
22721 modules with the same value, including any libraries.  This includes
22722 the system libraries and startup modules.
22724 @item -mvect8-ret-in-mem
22725 @opindex mvect8-ret-in-mem
22726 Return 8-byte vectors in memory instead of MMX registers.  This is the
22727 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
22728 Studio compilers until version 12.  Later compiler versions (starting
22729 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
22730 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
22731 you need to remain compatible with existing code produced by those
22732 previous compiler versions or older versions of GCC@.
22734 @item -mpc32
22735 @itemx -mpc64
22736 @itemx -mpc80
22737 @opindex mpc32
22738 @opindex mpc64
22739 @opindex mpc80
22741 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
22742 is specified, the significands of results of floating-point operations are
22743 rounded to 24 bits (single precision); @option{-mpc64} rounds the
22744 significands of results of floating-point operations to 53 bits (double
22745 precision) and @option{-mpc80} rounds the significands of results of
22746 floating-point operations to 64 bits (extended double precision), which is
22747 the default.  When this option is used, floating-point operations in higher
22748 precisions are not available to the programmer without setting the FPU
22749 control word explicitly.
22751 Setting the rounding of floating-point operations to less than the default
22752 80 bits can speed some programs by 2% or more.  Note that some mathematical
22753 libraries assume that extended-precision (80-bit) floating-point operations
22754 are enabled by default; routines in such libraries could suffer significant
22755 loss of accuracy, typically through so-called ``catastrophic cancellation'',
22756 when this option is used to set the precision to less than extended precision.
22758 @item -mstackrealign
22759 @opindex mstackrealign
22760 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
22761 option generates an alternate prologue and epilogue that realigns the
22762 run-time stack if necessary.  This supports mixing legacy codes that keep
22763 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
22764 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
22765 applicable to individual functions.
22767 @item -mpreferred-stack-boundary=@var{num}
22768 @opindex mpreferred-stack-boundary
22769 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
22770 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
22771 the default is 4 (16 bytes or 128 bits).
22773 @strong{Warning:} When generating code for the x86-64 architecture with
22774 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
22775 used to keep the stack boundary aligned to 8 byte boundary.  Since
22776 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
22777 intended to be used in controlled environment where stack space is
22778 important limitation.  This option leads to wrong code when functions
22779 compiled with 16 byte stack alignment (such as functions from a standard
22780 library) are called with misaligned stack.  In this case, SSE
22781 instructions may lead to misaligned memory access traps.  In addition,
22782 variable arguments are handled incorrectly for 16 byte aligned
22783 objects (including x87 long double and __int128), leading to wrong
22784 results.  You must build all modules with
22785 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
22786 includes the system libraries and startup modules.
22788 @item -mincoming-stack-boundary=@var{num}
22789 @opindex mincoming-stack-boundary
22790 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
22791 boundary.  If @option{-mincoming-stack-boundary} is not specified,
22792 the one specified by @option{-mpreferred-stack-boundary} is used.
22794 On Pentium and Pentium Pro, @code{double} and @code{long double} values
22795 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
22796 suffer significant run time performance penalties.  On Pentium III, the
22797 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
22798 properly if it is not 16-byte aligned.
22800 To ensure proper alignment of this values on the stack, the stack boundary
22801 must be as aligned as that required by any value stored on the stack.
22802 Further, every function must be generated such that it keeps the stack
22803 aligned.  Thus calling a function compiled with a higher preferred
22804 stack boundary from a function compiled with a lower preferred stack
22805 boundary most likely misaligns the stack.  It is recommended that
22806 libraries that use callbacks always use the default setting.
22808 This extra alignment does consume extra stack space, and generally
22809 increases code size.  Code that is sensitive to stack space usage, such
22810 as embedded systems and operating system kernels, may want to reduce the
22811 preferred alignment to @option{-mpreferred-stack-boundary=2}.
22813 @need 200
22814 @item -mmmx
22815 @opindex mmmx
22816 @need 200
22817 @itemx -msse
22818 @opindex msse
22819 @need 200
22820 @itemx -msse2
22821 @need 200
22822 @itemx -msse3
22823 @need 200
22824 @itemx -mssse3
22825 @need 200
22826 @itemx -msse4
22827 @need 200
22828 @itemx -msse4a
22829 @need 200
22830 @itemx -msse4.1
22831 @need 200
22832 @itemx -msse4.2
22833 @need 200
22834 @itemx -mavx
22835 @opindex mavx
22836 @need 200
22837 @itemx -mavx2
22838 @need 200
22839 @itemx -mavx512f
22840 @need 200
22841 @itemx -mavx512pf
22842 @need 200
22843 @itemx -mavx512er
22844 @need 200
22845 @itemx -mavx512cd
22846 @need 200
22847 @itemx -msha
22848 @opindex msha
22849 @need 200
22850 @itemx -maes
22851 @opindex maes
22852 @need 200
22853 @itemx -mpclmul
22854 @opindex mpclmul
22855 @need 200
22856 @itemx -mclfushopt
22857 @opindex mclfushopt
22858 @need 200
22859 @itemx -mfsgsbase
22860 @opindex mfsgsbase
22861 @need 200
22862 @itemx -mrdrnd
22863 @opindex mrdrnd
22864 @need 200
22865 @itemx -mf16c
22866 @opindex mf16c
22867 @need 200
22868 @itemx -mfma
22869 @opindex mfma
22870 @need 200
22871 @itemx -mfma4
22872 @need 200
22873 @itemx -mno-fma4
22874 @need 200
22875 @itemx -mprefetchwt1
22876 @opindex mprefetchwt1
22877 @need 200
22878 @itemx -mxop
22879 @opindex mxop
22880 @need 200
22881 @itemx -mlwp
22882 @opindex mlwp
22883 @need 200
22884 @itemx -m3dnow
22885 @opindex m3dnow
22886 @need 200
22887 @itemx -mpopcnt
22888 @opindex mpopcnt
22889 @need 200
22890 @itemx -mabm
22891 @opindex mabm
22892 @need 200
22893 @itemx -mbmi
22894 @opindex mbmi
22895 @need 200
22896 @itemx -mbmi2
22897 @need 200
22898 @itemx -mlzcnt
22899 @opindex mlzcnt
22900 @need 200
22901 @itemx -mfxsr
22902 @opindex mfxsr
22903 @need 200
22904 @itemx -mxsave
22905 @opindex mxsave
22906 @need 200
22907 @itemx -mxsaveopt
22908 @opindex mxsaveopt
22909 @need 200
22910 @itemx -mxsavec
22911 @opindex mxsavec
22912 @need 200
22913 @itemx -mxsaves
22914 @opindex mxsaves
22915 @need 200
22916 @itemx -mrtm
22917 @opindex mrtm
22918 @need 200
22919 @itemx -mtbm
22920 @opindex mtbm
22921 @need 200
22922 @itemx -mmpx
22923 @opindex mmpx
22924 @need 200
22925 @itemx -mmwaitx
22926 @opindex mmwaitx
22927 These switches enable the use of instructions in the MMX, SSE,
22928 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
22929 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
22930 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX or 3DNow!@:
22931 extended instruction sets.  Each has a corresponding @option{-mno-} option
22932 to disable use of these instructions.
22934 These extensions are also available as built-in functions: see
22935 @ref{x86 Built-in Functions}, for details of the functions enabled and
22936 disabled by these switches.
22938 To generate SSE/SSE2 instructions automatically from floating-point
22939 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
22941 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
22942 generates new AVX instructions or AVX equivalence for all SSEx instructions
22943 when needed.
22945 These options enable GCC to use these extended instructions in
22946 generated code, even without @option{-mfpmath=sse}.  Applications that
22947 perform run-time CPU detection must compile separate files for each
22948 supported architecture, using the appropriate flags.  In particular,
22949 the file containing the CPU detection code should be compiled without
22950 these options.
22952 @item -mdump-tune-features
22953 @opindex mdump-tune-features
22954 This option instructs GCC to dump the names of the x86 performance 
22955 tuning features and default settings. The names can be used in 
22956 @option{-mtune-ctrl=@var{feature-list}}.
22958 @item -mtune-ctrl=@var{feature-list}
22959 @opindex mtune-ctrl=@var{feature-list}
22960 This option is used to do fine grain control of x86 code generation features.
22961 @var{feature-list} is a comma separated list of @var{feature} names. See also
22962 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
22963 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
22964 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
22965 developers. Using it may lead to code paths not covered by testing and can
22966 potentially result in compiler ICEs or runtime errors.
22968 @item -mno-default
22969 @opindex mno-default
22970 This option instructs GCC to turn off all tunable features. See also 
22971 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
22973 @item -mcld
22974 @opindex mcld
22975 This option instructs GCC to emit a @code{cld} instruction in the prologue
22976 of functions that use string instructions.  String instructions depend on
22977 the DF flag to select between autoincrement or autodecrement mode.  While the
22978 ABI specifies the DF flag to be cleared on function entry, some operating
22979 systems violate this specification by not clearing the DF flag in their
22980 exception dispatchers.  The exception handler can be invoked with the DF flag
22981 set, which leads to wrong direction mode when string instructions are used.
22982 This option can be enabled by default on 32-bit x86 targets by configuring
22983 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
22984 instructions can be suppressed with the @option{-mno-cld} compiler option
22985 in this case.
22987 @item -mvzeroupper
22988 @opindex mvzeroupper
22989 This option instructs GCC to emit a @code{vzeroupper} instruction
22990 before a transfer of control flow out of the function to minimize
22991 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
22992 intrinsics.
22994 @item -mprefer-avx128
22995 @opindex mprefer-avx128
22996 This option instructs GCC to use 128-bit AVX instructions instead of
22997 256-bit AVX instructions in the auto-vectorizer.
22999 @item -mcx16
23000 @opindex mcx16
23001 This option enables GCC to generate @code{CMPXCHG16B} instructions.
23002 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
23003 (or oword) data types.  
23004 This is useful for high-resolution counters that can be updated
23005 by multiple processors (or cores).  This instruction is generated as part of
23006 atomic built-in functions: see @ref{__sync Builtins} or
23007 @ref{__atomic Builtins} for details.
23009 @item -msahf
23010 @opindex msahf
23011 This option enables generation of @code{SAHF} instructions in 64-bit code.
23012 Early Intel Pentium 4 CPUs with Intel 64 support,
23013 prior to the introduction of Pentium 4 G1 step in December 2005,
23014 lacked the @code{LAHF} and @code{SAHF} instructions
23015 which are supported by AMD64.
23016 These are load and store instructions, respectively, for certain status flags.
23017 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
23018 @code{drem}, and @code{remainder} built-in functions;
23019 see @ref{Other Builtins} for details.
23021 @item -mmovbe
23022 @opindex mmovbe
23023 This option enables use of the @code{movbe} instruction to implement
23024 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
23026 @item -mcrc32
23027 @opindex mcrc32
23028 This option enables built-in functions @code{__builtin_ia32_crc32qi},
23029 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
23030 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
23032 @item -mrecip
23033 @opindex mrecip
23034 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
23035 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
23036 with an additional Newton-Raphson step
23037 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
23038 (and their vectorized
23039 variants) for single-precision floating-point arguments.  These instructions
23040 are generated only when @option{-funsafe-math-optimizations} is enabled
23041 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
23042 Note that while the throughput of the sequence is higher than the throughput
23043 of the non-reciprocal instruction, the precision of the sequence can be
23044 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
23046 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
23047 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
23048 combination), and doesn't need @option{-mrecip}.
23050 Also note that GCC emits the above sequence with additional Newton-Raphson step
23051 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
23052 already with @option{-ffast-math} (or the above option combination), and
23053 doesn't need @option{-mrecip}.
23055 @item -mrecip=@var{opt}
23056 @opindex mrecip=opt
23057 This option controls which reciprocal estimate instructions
23058 may be used.  @var{opt} is a comma-separated list of options, which may
23059 be preceded by a @samp{!} to invert the option:
23061 @table @samp
23062 @item all
23063 Enable all estimate instructions.
23065 @item default
23066 Enable the default instructions, equivalent to @option{-mrecip}.
23068 @item none
23069 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23071 @item div
23072 Enable the approximation for scalar division.
23074 @item vec-div
23075 Enable the approximation for vectorized division.
23077 @item sqrt
23078 Enable the approximation for scalar square root.
23080 @item vec-sqrt
23081 Enable the approximation for vectorized square root.
23082 @end table
23084 So, for example, @option{-mrecip=all,!sqrt} enables
23085 all of the reciprocal approximations, except for square root.
23087 @item -mveclibabi=@var{type}
23088 @opindex mveclibabi
23089 Specifies the ABI type to use for vectorizing intrinsics using an
23090 external library.  Supported values for @var{type} are @samp{svml} 
23091 for the Intel short
23092 vector math library and @samp{acml} for the AMD math core library.
23093 To use this option, both @option{-ftree-vectorize} and
23094 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
23095 ABI-compatible library must be specified at link time.
23097 GCC currently emits calls to @code{vmldExp2},
23098 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
23099 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
23100 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
23101 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
23102 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
23103 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
23104 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
23105 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
23106 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
23107 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
23108 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
23109 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
23110 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
23111 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
23112 when @option{-mveclibabi=acml} is used.  
23114 @item -mabi=@var{name}
23115 @opindex mabi
23116 Generate code for the specified calling convention.  Permissible values
23117 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
23118 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
23119 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
23120 You can control this behavior for specific functions by
23121 using the function attributes @code{ms_abi} and @code{sysv_abi}.
23122 @xref{Function Attributes}.
23124 @item -mtls-dialect=@var{type}
23125 @opindex mtls-dialect
23126 Generate code to access thread-local storage using the @samp{gnu} or
23127 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
23128 @samp{gnu2} is more efficient, but it may add compile- and run-time
23129 requirements that cannot be satisfied on all systems.
23131 @item -mpush-args
23132 @itemx -mno-push-args
23133 @opindex mpush-args
23134 @opindex mno-push-args
23135 Use PUSH operations to store outgoing parameters.  This method is shorter
23136 and usually equally fast as method using SUB/MOV operations and is enabled
23137 by default.  In some cases disabling it may improve performance because of
23138 improved scheduling and reduced dependencies.
23140 @item -maccumulate-outgoing-args
23141 @opindex maccumulate-outgoing-args
23142 If enabled, the maximum amount of space required for outgoing arguments is
23143 computed in the function prologue.  This is faster on most modern CPUs
23144 because of reduced dependencies, improved scheduling and reduced stack usage
23145 when the preferred stack boundary is not equal to 2.  The drawback is a notable
23146 increase in code size.  This switch implies @option{-mno-push-args}.
23148 @item -mthreads
23149 @opindex mthreads
23150 Support thread-safe exception handling on MinGW.  Programs that rely
23151 on thread-safe exception handling must compile and link all code with the
23152 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
23153 @option{-D_MT}; when linking, it links in a special thread helper library
23154 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
23156 @item -mno-align-stringops
23157 @opindex mno-align-stringops
23158 Do not align the destination of inlined string operations.  This switch reduces
23159 code size and improves performance in case the destination is already aligned,
23160 but GCC doesn't know about it.
23162 @item -minline-all-stringops
23163 @opindex minline-all-stringops
23164 By default GCC inlines string operations only when the destination is 
23165 known to be aligned to least a 4-byte boundary.  
23166 This enables more inlining and increases code
23167 size, but may improve performance of code that depends on fast
23168 @code{memcpy}, @code{strlen},
23169 and @code{memset} for short lengths.
23171 @item -minline-stringops-dynamically
23172 @opindex minline-stringops-dynamically
23173 For string operations of unknown size, use run-time checks with
23174 inline code for small blocks and a library call for large blocks.
23176 @item -mstringop-strategy=@var{alg}
23177 @opindex mstringop-strategy=@var{alg}
23178 Override the internal decision heuristic for the particular algorithm to use
23179 for inlining string operations.  The allowed values for @var{alg} are:
23181 @table @samp
23182 @item rep_byte
23183 @itemx rep_4byte
23184 @itemx rep_8byte
23185 Expand using i386 @code{rep} prefix of the specified size.
23187 @item byte_loop
23188 @itemx loop
23189 @itemx unrolled_loop
23190 Expand into an inline loop.
23192 @item libcall
23193 Always use a library call.
23194 @end table
23196 @item -mmemcpy-strategy=@var{strategy}
23197 @opindex mmemcpy-strategy=@var{strategy}
23198 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
23199 should be inlined and what inline algorithm to use when the expected size
23200 of the copy operation is known. @var{strategy} 
23201 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
23202 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
23203 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
23204 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
23205 in the list must be specified in increasing order.  The minimal byte size for 
23206 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
23207 preceding range.
23209 @item -mmemset-strategy=@var{strategy}
23210 @opindex mmemset-strategy=@var{strategy}
23211 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
23212 @code{__builtin_memset} expansion.
23214 @item -momit-leaf-frame-pointer
23215 @opindex momit-leaf-frame-pointer
23216 Don't keep the frame pointer in a register for leaf functions.  This
23217 avoids the instructions to save, set up, and restore frame pointers and
23218 makes an extra register available in leaf functions.  The option
23219 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
23220 which might make debugging harder.
23222 @item -mtls-direct-seg-refs
23223 @itemx -mno-tls-direct-seg-refs
23224 @opindex mtls-direct-seg-refs
23225 Controls whether TLS variables may be accessed with offsets from the
23226 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
23227 or whether the thread base pointer must be added.  Whether or not this
23228 is valid depends on the operating system, and whether it maps the
23229 segment to cover the entire TLS area.
23231 For systems that use the GNU C Library, the default is on.
23233 @item -msse2avx
23234 @itemx -mno-sse2avx
23235 @opindex msse2avx
23236 Specify that the assembler should encode SSE instructions with VEX
23237 prefix.  The option @option{-mavx} turns this on by default.
23239 @item -mfentry
23240 @itemx -mno-fentry
23241 @opindex mfentry
23242 If profiling is active (@option{-pg}), put the profiling
23243 counter call before the prologue.
23244 Note: On x86 architectures the attribute @code{ms_hook_prologue}
23245 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
23247 @item -mrecord-mcount
23248 @itemx -mno-record-mcount
23249 @opindex mrecord-mcount
23250 If profiling is active (@option{-pg}), generate a __mcount_loc section
23251 that contains pointers to each profiling call. This is useful for
23252 automatically patching and out calls.
23254 @item -mnop-mcount
23255 @itemx -mno-nop-mcount
23256 @opindex mnop-mcount
23257 If profiling is active (@option{-pg}), generate the calls to
23258 the profiling functions as nops. This is useful when they
23259 should be patched in later dynamically. This is likely only
23260 useful together with @option{-mrecord-mcount}.
23262 @item -mskip-rax-setup
23263 @itemx -mno-skip-rax-setup
23264 @opindex mskip-rax-setup
23265 When generating code for the x86-64 architecture with SSE extensions
23266 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
23267 register when there are no variable arguments passed in vector registers.
23269 @strong{Warning:} Since RAX register is used to avoid unnecessarily
23270 saving vector registers on stack when passing variable arguments, the
23271 impacts of this option are callees may waste some stack space,
23272 misbehave or jump to a random location.  GCC 4.4 or newer don't have
23273 those issues, regardless the RAX register value.
23275 @item -m8bit-idiv
23276 @itemx -mno-8bit-idiv
23277 @opindex m8bit-idiv
23278 On some processors, like Intel Atom, 8-bit unsigned integer divide is
23279 much faster than 32-bit/64-bit integer divide.  This option generates a
23280 run-time check.  If both dividend and divisor are within range of 0
23281 to 255, 8-bit unsigned integer divide is used instead of
23282 32-bit/64-bit integer divide.
23284 @item -mavx256-split-unaligned-load
23285 @itemx -mavx256-split-unaligned-store
23286 @opindex mavx256-split-unaligned-load
23287 @opindex mavx256-split-unaligned-store
23288 Split 32-byte AVX unaligned load and store.
23290 @item -mstack-protector-guard=@var{guard}
23291 @opindex mstack-protector-guard=@var{guard}
23292 Generate stack protection code using canary at @var{guard}.  Supported
23293 locations are @samp{global} for global canary or @samp{tls} for per-thread
23294 canary in the TLS block (the default).  This option has effect only when
23295 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
23297 @end table
23299 These @samp{-m} switches are supported in addition to the above
23300 on x86-64 processors in 64-bit environments.
23302 @table @gcctabopt
23303 @item -m32
23304 @itemx -m64
23305 @itemx -mx32
23306 @itemx -m16
23307 @itemx -miamcu
23308 @opindex m32
23309 @opindex m64
23310 @opindex mx32
23311 @opindex m16
23312 @opindex miamcu
23313 Generate code for a 16-bit, 32-bit or 64-bit environment.
23314 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
23315 to 32 bits, and
23316 generates code that runs on any i386 system.
23318 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
23319 types to 64 bits, and generates code for the x86-64 architecture.
23320 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
23321 and @option{-mdynamic-no-pic} options.
23323 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
23324 to 32 bits, and
23325 generates code for the x86-64 architecture.
23327 The @option{-m16} option is the same as @option{-m32}, except for that
23328 it outputs the @code{.code16gcc} assembly directive at the beginning of
23329 the assembly output so that the binary can run in 16-bit mode.
23331 The @option{-miamcu} option generates code which conforms to Intel MCU
23332 psABI.  It requires the @option{-m32} option to be turned on.
23334 @item -mno-red-zone
23335 @opindex mno-red-zone
23336 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
23337 by the x86-64 ABI; it is a 128-byte area beyond the location of the
23338 stack pointer that is not modified by signal or interrupt handlers
23339 and therefore can be used for temporary data without adjusting the stack
23340 pointer.  The flag @option{-mno-red-zone} disables this red zone.
23342 @item -mcmodel=small
23343 @opindex mcmodel=small
23344 Generate code for the small code model: the program and its symbols must
23345 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
23346 Programs can be statically or dynamically linked.  This is the default
23347 code model.
23349 @item -mcmodel=kernel
23350 @opindex mcmodel=kernel
23351 Generate code for the kernel code model.  The kernel runs in the
23352 negative 2 GB of the address space.
23353 This model has to be used for Linux kernel code.
23355 @item -mcmodel=medium
23356 @opindex mcmodel=medium
23357 Generate code for the medium model: the program is linked in the lower 2
23358 GB of the address space.  Small symbols are also placed there.  Symbols
23359 with sizes larger than @option{-mlarge-data-threshold} are put into
23360 large data or BSS sections and can be located above 2GB.  Programs can
23361 be statically or dynamically linked.
23363 @item -mcmodel=large
23364 @opindex mcmodel=large
23365 Generate code for the large model.  This model makes no assumptions
23366 about addresses and sizes of sections.
23368 @item -maddress-mode=long
23369 @opindex maddress-mode=long
23370 Generate code for long address mode.  This is only supported for 64-bit
23371 and x32 environments.  It is the default address mode for 64-bit
23372 environments.
23374 @item -maddress-mode=short
23375 @opindex maddress-mode=short
23376 Generate code for short address mode.  This is only supported for 32-bit
23377 and x32 environments.  It is the default address mode for 32-bit and
23378 x32 environments.
23379 @end table
23381 @node x86 Windows Options
23382 @subsection x86 Windows Options
23383 @cindex x86 Windows Options
23384 @cindex Windows Options for x86
23386 These additional options are available for Microsoft Windows targets:
23388 @table @gcctabopt
23389 @item -mconsole
23390 @opindex mconsole
23391 This option
23392 specifies that a console application is to be generated, by
23393 instructing the linker to set the PE header subsystem type
23394 required for console applications.
23395 This option is available for Cygwin and MinGW targets and is
23396 enabled by default on those targets.
23398 @item -mdll
23399 @opindex mdll
23400 This option is available for Cygwin and MinGW targets.  It
23401 specifies that a DLL---a dynamic link library---is to be
23402 generated, enabling the selection of the required runtime
23403 startup object and entry point.
23405 @item -mnop-fun-dllimport
23406 @opindex mnop-fun-dllimport
23407 This option is available for Cygwin and MinGW targets.  It
23408 specifies that the @code{dllimport} attribute should be ignored.
23410 @item -mthread
23411 @opindex mthread
23412 This option is available for MinGW targets. It specifies
23413 that MinGW-specific thread support is to be used.
23415 @item -municode
23416 @opindex municode
23417 This option is available for MinGW-w64 targets.  It causes
23418 the @code{UNICODE} preprocessor macro to be predefined, and
23419 chooses Unicode-capable runtime startup code.
23421 @item -mwin32
23422 @opindex mwin32
23423 This option is available for Cygwin and MinGW targets.  It
23424 specifies that the typical Microsoft Windows predefined macros are to
23425 be set in the pre-processor, but does not influence the choice
23426 of runtime library/startup code.
23428 @item -mwindows
23429 @opindex mwindows
23430 This option is available for Cygwin and MinGW targets.  It
23431 specifies that a GUI application is to be generated by
23432 instructing the linker to set the PE header subsystem type
23433 appropriately.
23435 @item -fno-set-stack-executable
23436 @opindex fno-set-stack-executable
23437 This option is available for MinGW targets. It specifies that
23438 the executable flag for the stack used by nested functions isn't
23439 set. This is necessary for binaries running in kernel mode of
23440 Microsoft Windows, as there the User32 API, which is used to set executable
23441 privileges, isn't available.
23443 @item -fwritable-relocated-rdata
23444 @opindex fno-writable-relocated-rdata
23445 This option is available for MinGW and Cygwin targets.  It specifies
23446 that relocated-data in read-only section is put into .data
23447 section.  This is a necessary for older runtimes not supporting
23448 modification of .rdata sections for pseudo-relocation.
23450 @item -mpe-aligned-commons
23451 @opindex mpe-aligned-commons
23452 This option is available for Cygwin and MinGW targets.  It
23453 specifies that the GNU extension to the PE file format that
23454 permits the correct alignment of COMMON variables should be
23455 used when generating code.  It is enabled by default if
23456 GCC detects that the target assembler found during configuration
23457 supports the feature.
23458 @end table
23460 See also under @ref{x86 Options} for standard options.
23462 @node Xstormy16 Options
23463 @subsection Xstormy16 Options
23464 @cindex Xstormy16 Options
23466 These options are defined for Xstormy16:
23468 @table @gcctabopt
23469 @item -msim
23470 @opindex msim
23471 Choose startup files and linker script suitable for the simulator.
23472 @end table
23474 @node Xtensa Options
23475 @subsection Xtensa Options
23476 @cindex Xtensa Options
23478 These options are supported for Xtensa targets:
23480 @table @gcctabopt
23481 @item -mconst16
23482 @itemx -mno-const16
23483 @opindex mconst16
23484 @opindex mno-const16
23485 Enable or disable use of @code{CONST16} instructions for loading
23486 constant values.  The @code{CONST16} instruction is currently not a
23487 standard option from Tensilica.  When enabled, @code{CONST16}
23488 instructions are always used in place of the standard @code{L32R}
23489 instructions.  The use of @code{CONST16} is enabled by default only if
23490 the @code{L32R} instruction is not available.
23492 @item -mfused-madd
23493 @itemx -mno-fused-madd
23494 @opindex mfused-madd
23495 @opindex mno-fused-madd
23496 Enable or disable use of fused multiply/add and multiply/subtract
23497 instructions in the floating-point option.  This has no effect if the
23498 floating-point option is not also enabled.  Disabling fused multiply/add
23499 and multiply/subtract instructions forces the compiler to use separate
23500 instructions for the multiply and add/subtract operations.  This may be
23501 desirable in some cases where strict IEEE 754-compliant results are
23502 required: the fused multiply add/subtract instructions do not round the
23503 intermediate result, thereby producing results with @emph{more} bits of
23504 precision than specified by the IEEE standard.  Disabling fused multiply
23505 add/subtract instructions also ensures that the program output is not
23506 sensitive to the compiler's ability to combine multiply and add/subtract
23507 operations.
23509 @item -mserialize-volatile
23510 @itemx -mno-serialize-volatile
23511 @opindex mserialize-volatile
23512 @opindex mno-serialize-volatile
23513 When this option is enabled, GCC inserts @code{MEMW} instructions before
23514 @code{volatile} memory references to guarantee sequential consistency.
23515 The default is @option{-mserialize-volatile}.  Use
23516 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
23518 @item -mforce-no-pic
23519 @opindex mforce-no-pic
23520 For targets, like GNU/Linux, where all user-mode Xtensa code must be
23521 position-independent code (PIC), this option disables PIC for compiling
23522 kernel code.
23524 @item -mtext-section-literals
23525 @itemx -mno-text-section-literals
23526 @opindex mtext-section-literals
23527 @opindex mno-text-section-literals
23528 These options control the treatment of literal pools.  The default is
23529 @option{-mno-text-section-literals}, which places literals in a separate
23530 section in the output file.  This allows the literal pool to be placed
23531 in a data RAM/ROM, and it also allows the linker to combine literal
23532 pools from separate object files to remove redundant literals and
23533 improve code size.  With @option{-mtext-section-literals}, the literals
23534 are interspersed in the text section in order to keep them as close as
23535 possible to their references.  This may be necessary for large assembly
23536 files.  Literals for each function are placed right before that function.
23538 @item -mauto-litpools
23539 @itemx -mno-auto-litpools
23540 @opindex mauto-litpools
23541 @opindex mno-auto-litpools
23542 These options control the treatment of literal pools.  The default is
23543 @option{-mno-auto-litpools}, which places literals in a separate
23544 section in the output file unless @option{-mtext-section-literals} is
23545 used.  With @option{-mauto-litpools} the literals are interspersed in
23546 the text section by the assembler.  Compiler does not produce explicit
23547 @code{.literal} directives and loads literals into registers with
23548 @code{MOVI} instructions instead of @code{L32R} to let the assembler
23549 do relaxation and place literals as necessary.  This option allows
23550 assembler to create several literal pools per function and assemble
23551 very big functions, which may not be possible with
23552 @option{-mtext-section-literals}.
23554 @item -mtarget-align
23555 @itemx -mno-target-align
23556 @opindex mtarget-align
23557 @opindex mno-target-align
23558 When this option is enabled, GCC instructs the assembler to
23559 automatically align instructions to reduce branch penalties at the
23560 expense of some code density.  The assembler attempts to widen density
23561 instructions to align branch targets and the instructions following call
23562 instructions.  If there are not enough preceding safe density
23563 instructions to align a target, no widening is performed.  The
23564 default is @option{-mtarget-align}.  These options do not affect the
23565 treatment of auto-aligned instructions like @code{LOOP}, which the
23566 assembler always aligns, either by widening density instructions or
23567 by inserting NOP instructions.
23569 @item -mlongcalls
23570 @itemx -mno-longcalls
23571 @opindex mlongcalls
23572 @opindex mno-longcalls
23573 When this option is enabled, GCC instructs the assembler to translate
23574 direct calls to indirect calls unless it can determine that the target
23575 of a direct call is in the range allowed by the call instruction.  This
23576 translation typically occurs for calls to functions in other source
23577 files.  Specifically, the assembler translates a direct @code{CALL}
23578 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
23579 The default is @option{-mno-longcalls}.  This option should be used in
23580 programs where the call target can potentially be out of range.  This
23581 option is implemented in the assembler, not the compiler, so the
23582 assembly code generated by GCC still shows direct call
23583 instructions---look at the disassembled object code to see the actual
23584 instructions.  Note that the assembler uses an indirect call for
23585 every cross-file call, not just those that really are out of range.
23586 @end table
23588 @node zSeries Options
23589 @subsection zSeries Options
23590 @cindex zSeries options
23592 These are listed under @xref{S/390 and zSeries Options}.
23594 @node Code Gen Options
23595 @section Options for Code Generation Conventions
23596 @cindex code generation conventions
23597 @cindex options, code generation
23598 @cindex run-time options
23600 These machine-independent options control the interface conventions
23601 used in code generation.
23603 Most of them have both positive and negative forms; the negative form
23604 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
23605 one of the forms is listed---the one that is not the default.  You
23606 can figure out the other form by either removing @samp{no-} or adding
23609 @table @gcctabopt
23610 @item -fbounds-check
23611 @opindex fbounds-check
23612 For front ends that support it, generate additional code to check that
23613 indices used to access arrays are within the declared range.  This is
23614 currently only supported by the Java and Fortran front ends, where
23615 this option defaults to true and false respectively.
23617 @item -fstack-reuse=@var{reuse-level}
23618 @opindex fstack_reuse
23619 This option controls stack space reuse for user declared local/auto variables
23620 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
23621 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
23622 local variables and temporaries, @samp{named_vars} enables the reuse only for
23623 user defined local variables with names, and @samp{none} disables stack reuse
23624 completely. The default value is @samp{all}. The option is needed when the
23625 program extends the lifetime of a scoped local variable or a compiler generated
23626 temporary beyond the end point defined by the language.  When a lifetime of
23627 a variable ends, and if the variable lives in memory, the optimizing compiler
23628 has the freedom to reuse its stack space with other temporaries or scoped
23629 local variables whose live range does not overlap with it. Legacy code extending
23630 local lifetime is likely to break with the stack reuse optimization.
23632 For example,
23634 @smallexample
23635    int *p;
23636    @{
23637      int local1;
23639      p = &local1;
23640      local1 = 10;
23641      ....
23642    @}
23643    @{
23644       int local2;
23645       local2 = 20;
23646       ...
23647    @}
23649    if (*p == 10)  // out of scope use of local1
23650      @{
23652      @}
23653 @end smallexample
23655 Another example:
23656 @smallexample
23658    struct A
23659    @{
23660        A(int k) : i(k), j(k) @{ @}
23661        int i;
23662        int j;
23663    @};
23665    A *ap;
23667    void foo(const A& ar)
23668    @{
23669       ap = &ar;
23670    @}
23672    void bar()
23673    @{
23674       foo(A(10)); // temp object's lifetime ends when foo returns
23676       @{
23677         A a(20);
23678         ....
23679       @}
23680       ap->i+= 10;  // ap references out of scope temp whose space
23681                    // is reused with a. What is the value of ap->i?
23682    @}
23684 @end smallexample
23686 The lifetime of a compiler generated temporary is well defined by the C++
23687 standard. When a lifetime of a temporary ends, and if the temporary lives
23688 in memory, the optimizing compiler has the freedom to reuse its stack
23689 space with other temporaries or scoped local variables whose live range
23690 does not overlap with it. However some of the legacy code relies on
23691 the behavior of older compilers in which temporaries' stack space is
23692 not reused, the aggressive stack reuse can lead to runtime errors. This
23693 option is used to control the temporary stack reuse optimization.
23695 @item -ftrapv
23696 @opindex ftrapv
23697 This option generates traps for signed overflow on addition, subtraction,
23698 multiplication operations.
23699 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
23700 @option{-ftrapv} @option{-fwrapv} on the command-line results in
23701 @option{-fwrapv} being effective.  Note that only active options override, so
23702 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
23703 results in @option{-ftrapv} being effective.
23705 @item -fwrapv
23706 @opindex fwrapv
23707 This option instructs the compiler to assume that signed arithmetic
23708 overflow of addition, subtraction and multiplication wraps around
23709 using twos-complement representation.  This flag enables some optimizations
23710 and disables others.  This option is enabled by default for the Java
23711 front end, as required by the Java language specification.
23712 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
23713 @option{-ftrapv} @option{-fwrapv} on the command-line results in
23714 @option{-fwrapv} being effective.  Note that only active options override, so
23715 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
23716 results in @option{-ftrapv} being effective.
23718 @item -fexceptions
23719 @opindex fexceptions
23720 Enable exception handling.  Generates extra code needed to propagate
23721 exceptions.  For some targets, this implies GCC generates frame
23722 unwind information for all functions, which can produce significant data
23723 size overhead, although it does not affect execution.  If you do not
23724 specify this option, GCC enables it by default for languages like
23725 C++ that normally require exception handling, and disables it for
23726 languages like C that do not normally require it.  However, you may need
23727 to enable this option when compiling C code that needs to interoperate
23728 properly with exception handlers written in C++.  You may also wish to
23729 disable this option if you are compiling older C++ programs that don't
23730 use exception handling.
23732 @item -fnon-call-exceptions
23733 @opindex fnon-call-exceptions
23734 Generate code that allows trapping instructions to throw exceptions.
23735 Note that this requires platform-specific runtime support that does
23736 not exist everywhere.  Moreover, it only allows @emph{trapping}
23737 instructions to throw exceptions, i.e.@: memory references or floating-point
23738 instructions.  It does not allow exceptions to be thrown from
23739 arbitrary signal handlers such as @code{SIGALRM}.
23741 @item -fdelete-dead-exceptions
23742 @opindex fdelete-dead-exceptions
23743 Consider that instructions that may throw exceptions but don't otherwise
23744 contribute to the execution of the program can be optimized away.
23745 This option is enabled by default for the Ada front end, as permitted by
23746 the Ada language specification.
23747 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
23749 @item -funwind-tables
23750 @opindex funwind-tables
23751 Similar to @option{-fexceptions}, except that it just generates any needed
23752 static data, but does not affect the generated code in any other way.
23753 You normally do not need to enable this option; instead, a language processor
23754 that needs this handling enables it on your behalf.
23756 @item -fasynchronous-unwind-tables
23757 @opindex fasynchronous-unwind-tables
23758 Generate unwind table in DWARF 2 format, if supported by target machine.  The
23759 table is exact at each instruction boundary, so it can be used for stack
23760 unwinding from asynchronous events (such as debugger or garbage collector).
23762 @item -fno-gnu-unique
23763 @opindex fno-gnu-unique
23764 On systems with recent GNU assembler and C library, the C++ compiler
23765 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
23766 of template static data members and static local variables in inline
23767 functions are unique even in the presence of @code{RTLD_LOCAL}; this
23768 is necessary to avoid problems with a library used by two different
23769 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
23770 therefore disagreeing with the other one about the binding of the
23771 symbol.  But this causes @code{dlclose} to be ignored for affected
23772 DSOs; if your program relies on reinitialization of a DSO via
23773 @code{dlclose} and @code{dlopen}, you can use
23774 @option{-fno-gnu-unique}.
23776 @item -fpcc-struct-return
23777 @opindex fpcc-struct-return
23778 Return ``short'' @code{struct} and @code{union} values in memory like
23779 longer ones, rather than in registers.  This convention is less
23780 efficient, but it has the advantage of allowing intercallability between
23781 GCC-compiled files and files compiled with other compilers, particularly
23782 the Portable C Compiler (pcc).
23784 The precise convention for returning structures in memory depends
23785 on the target configuration macros.
23787 Short structures and unions are those whose size and alignment match
23788 that of some integer type.
23790 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
23791 switch is not binary compatible with code compiled with the
23792 @option{-freg-struct-return} switch.
23793 Use it to conform to a non-default application binary interface.
23795 @item -freg-struct-return
23796 @opindex freg-struct-return
23797 Return @code{struct} and @code{union} values in registers when possible.
23798 This is more efficient for small structures than
23799 @option{-fpcc-struct-return}.
23801 If you specify neither @option{-fpcc-struct-return} nor
23802 @option{-freg-struct-return}, GCC defaults to whichever convention is
23803 standard for the target.  If there is no standard convention, GCC
23804 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
23805 the principal compiler.  In those cases, we can choose the standard, and
23806 we chose the more efficient register return alternative.
23808 @strong{Warning:} code compiled with the @option{-freg-struct-return}
23809 switch is not binary compatible with code compiled with the
23810 @option{-fpcc-struct-return} switch.
23811 Use it to conform to a non-default application binary interface.
23813 @item -fshort-enums
23814 @opindex fshort-enums
23815 Allocate to an @code{enum} type only as many bytes as it needs for the
23816 declared range of possible values.  Specifically, the @code{enum} type
23817 is equivalent to the smallest integer type that has enough room.
23819 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
23820 code that is not binary compatible with code generated without that switch.
23821 Use it to conform to a non-default application binary interface.
23823 @item -fshort-double
23824 @opindex fshort-double
23825 Use the same size for @code{double} as for @code{float}.
23827 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
23828 code that is not binary compatible with code generated without that switch.
23829 Use it to conform to a non-default application binary interface.
23831 @item -fshort-wchar
23832 @opindex fshort-wchar
23833 Override the underlying type for @code{wchar_t} to be @code{short
23834 unsigned int} instead of the default for the target.  This option is
23835 useful for building programs to run under WINE@.
23837 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
23838 code that is not binary compatible with code generated without that switch.
23839 Use it to conform to a non-default application binary interface.
23841 @item -fno-common
23842 @opindex fno-common
23843 In C code, controls the placement of uninitialized global variables.
23844 Unix C compilers have traditionally permitted multiple definitions of
23845 such variables in different compilation units by placing the variables
23846 in a common block.
23847 This is the behavior specified by @option{-fcommon}, and is the default
23848 for GCC on most targets.
23849 On the other hand, this behavior is not required by ISO C, and on some
23850 targets may carry a speed or code size penalty on variable references.
23851 The @option{-fno-common} option specifies that the compiler should place
23852 uninitialized global variables in the data section of the object file,
23853 rather than generating them as common blocks.
23854 This has the effect that if the same variable is declared
23855 (without @code{extern}) in two different compilations,
23856 you get a multiple-definition error when you link them.
23857 In this case, you must compile with @option{-fcommon} instead.
23858 Compiling with @option{-fno-common} is useful on targets for which
23859 it provides better performance, or if you wish to verify that the
23860 program will work on other systems that always treat uninitialized
23861 variable declarations this way.
23863 @item -fno-ident
23864 @opindex fno-ident
23865 Ignore the @code{#ident} directive.
23867 @item -finhibit-size-directive
23868 @opindex finhibit-size-directive
23869 Don't output a @code{.size} assembler directive, or anything else that
23870 would cause trouble if the function is split in the middle, and the
23871 two halves are placed at locations far apart in memory.  This option is
23872 used when compiling @file{crtstuff.c}; you should not need to use it
23873 for anything else.
23875 @item -fverbose-asm
23876 @opindex fverbose-asm
23877 Put extra commentary information in the generated assembly code to
23878 make it more readable.  This option is generally only of use to those
23879 who actually need to read the generated assembly code (perhaps while
23880 debugging the compiler itself).
23882 @option{-fno-verbose-asm}, the default, causes the
23883 extra information to be omitted and is useful when comparing two assembler
23884 files.
23886 @item -frecord-gcc-switches
23887 @opindex frecord-gcc-switches
23888 This switch causes the command line used to invoke the
23889 compiler to be recorded into the object file that is being created.
23890 This switch is only implemented on some targets and the exact format
23891 of the recording is target and binary file format dependent, but it
23892 usually takes the form of a section containing ASCII text.  This
23893 switch is related to the @option{-fverbose-asm} switch, but that
23894 switch only records information in the assembler output file as
23895 comments, so it never reaches the object file.
23896 See also @option{-grecord-gcc-switches} for another
23897 way of storing compiler options into the object file.
23899 @item -fpic
23900 @opindex fpic
23901 @cindex global offset table
23902 @cindex PIC
23903 Generate position-independent code (PIC) suitable for use in a shared
23904 library, if supported for the target machine.  Such code accesses all
23905 constant addresses through a global offset table (GOT)@.  The dynamic
23906 loader resolves the GOT entries when the program starts (the dynamic
23907 loader is not part of GCC; it is part of the operating system).  If
23908 the GOT size for the linked executable exceeds a machine-specific
23909 maximum size, you get an error message from the linker indicating that
23910 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23911 instead.  (These maximums are 8k on the SPARC and 32k
23912 on the m68k and RS/6000.  The x86 has no such limit.)
23914 Position-independent code requires special support, and therefore works
23915 only on certain machines.  For the x86, GCC supports PIC for System V
23916 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23917 position-independent.
23919 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23920 are defined to 1.
23922 @item -fPIC
23923 @opindex fPIC
23924 If supported for the target machine, emit position-independent code,
23925 suitable for dynamic linking and avoiding any limit on the size of the
23926 global offset table.  This option makes a difference on the m68k,
23927 PowerPC and SPARC@.
23929 Position-independent code requires special support, and therefore works
23930 only on certain machines.
23932 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23933 are defined to 2.
23935 @item -fpie
23936 @itemx -fPIE
23937 @opindex fpie
23938 @opindex fPIE
23939 These options are similar to @option{-fpic} and @option{-fPIC}, but
23940 generated position independent code can be only linked into executables.
23941 Usually these options are used when @option{-pie} GCC option is
23942 used during linking.
23944 @option{-fpie} and @option{-fPIE} both define the macros
23945 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23946 for @option{-fpie} and 2 for @option{-fPIE}.
23948 @item -fno-plt
23949 @opindex fno-plt
23950 Do not use PLT for external function calls in position-independent code.
23951 Instead, load callee address at call site from GOT and branch to it.
23952 This leads to more efficient code by eliminating PLT stubs and exposing
23953 GOT load to optimizations.  On architectures such as 32-bit x86 where
23954 PLT stubs expect GOT pointer in a specific register, this gives more
23955 register allocation freedom to the compiler.  Lazy binding requires PLT:
23956 with @option{-fno-plt} all external symbols are resolved at load time.
23958 Alternatively, function attribute @code{noplt} can be used to avoid PLT
23959 for calls to specific external functions by marking those functions with
23960 this attribute.
23962 Additionally, a few targets also convert calls to those functions that are
23963 marked to not use the PLT to use the GOT instead for non-position independent
23964 code.
23966 @item -fno-jump-tables
23967 @opindex fno-jump-tables
23968 Do not use jump tables for switch statements even where it would be
23969 more efficient than other code generation strategies.  This option is
23970 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23971 building code that forms part of a dynamic linker and cannot
23972 reference the address of a jump table.  On some targets, jump tables
23973 do not require a GOT and this option is not needed.
23975 @item -ffixed-@var{reg}
23976 @opindex ffixed
23977 Treat the register named @var{reg} as a fixed register; generated code
23978 should never refer to it (except perhaps as a stack pointer, frame
23979 pointer or in some other fixed role).
23981 @var{reg} must be the name of a register.  The register names accepted
23982 are machine-specific and are defined in the @code{REGISTER_NAMES}
23983 macro in the machine description macro file.
23985 This flag does not have a negative form, because it specifies a
23986 three-way choice.
23988 @item -fcall-used-@var{reg}
23989 @opindex fcall-used
23990 Treat the register named @var{reg} as an allocable register that is
23991 clobbered by function calls.  It may be allocated for temporaries or
23992 variables that do not live across a call.  Functions compiled this way
23993 do not save and restore the register @var{reg}.
23995 It is an error to use this flag with the frame pointer or stack pointer.
23996 Use of this flag for other registers that have fixed pervasive roles in
23997 the machine's execution model produces disastrous results.
23999 This flag does not have a negative form, because it specifies a
24000 three-way choice.
24002 @item -fcall-saved-@var{reg}
24003 @opindex fcall-saved
24004 Treat the register named @var{reg} as an allocable register saved by
24005 functions.  It may be allocated even for temporaries or variables that
24006 live across a call.  Functions compiled this way save and restore
24007 the register @var{reg} if they use it.
24009 It is an error to use this flag with the frame pointer or stack pointer.
24010 Use of this flag for other registers that have fixed pervasive roles in
24011 the machine's execution model produces disastrous results.
24013 A different sort of disaster results from the use of this flag for
24014 a register in which function values may be returned.
24016 This flag does not have a negative form, because it specifies a
24017 three-way choice.
24019 @item -fpack-struct[=@var{n}]
24020 @opindex fpack-struct
24021 Without a value specified, pack all structure members together without
24022 holes.  When a value is specified (which must be a small power of two), pack
24023 structure members according to this value, representing the maximum
24024 alignment (that is, objects with default alignment requirements larger than
24025 this are output potentially unaligned at the next fitting location.
24027 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
24028 code that is not binary compatible with code generated without that switch.
24029 Additionally, it makes the code suboptimal.
24030 Use it to conform to a non-default application binary interface.
24032 @item -finstrument-functions
24033 @opindex finstrument-functions
24034 Generate instrumentation calls for entry and exit to functions.  Just
24035 after function entry and just before function exit, the following
24036 profiling functions are called with the address of the current
24037 function and its call site.  (On some platforms,
24038 @code{__builtin_return_address} does not work beyond the current
24039 function, so the call site information may not be available to the
24040 profiling functions otherwise.)
24042 @smallexample
24043 void __cyg_profile_func_enter (void *this_fn,
24044                                void *call_site);
24045 void __cyg_profile_func_exit  (void *this_fn,
24046                                void *call_site);
24047 @end smallexample
24049 The first argument is the address of the start of the current function,
24050 which may be looked up exactly in the symbol table.
24052 This instrumentation is also done for functions expanded inline in other
24053 functions.  The profiling calls indicate where, conceptually, the
24054 inline function is entered and exited.  This means that addressable
24055 versions of such functions must be available.  If all your uses of a
24056 function are expanded inline, this may mean an additional expansion of
24057 code size.  If you use @code{extern inline} in your C code, an
24058 addressable version of such functions must be provided.  (This is
24059 normally the case anyway, but if you get lucky and the optimizer always
24060 expands the functions inline, you might have gotten away without
24061 providing static copies.)
24063 A function may be given the attribute @code{no_instrument_function}, in
24064 which case this instrumentation is not done.  This can be used, for
24065 example, for the profiling functions listed above, high-priority
24066 interrupt routines, and any functions from which the profiling functions
24067 cannot safely be called (perhaps signal handlers, if the profiling
24068 routines generate output or allocate memory).
24070 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
24071 @opindex finstrument-functions-exclude-file-list
24073 Set the list of functions that are excluded from instrumentation (see
24074 the description of @option{-finstrument-functions}).  If the file that
24075 contains a function definition matches with one of @var{file}, then
24076 that function is not instrumented.  The match is done on substrings:
24077 if the @var{file} parameter is a substring of the file name, it is
24078 considered to be a match.
24080 For example:
24082 @smallexample
24083 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
24084 @end smallexample
24086 @noindent
24087 excludes any inline function defined in files whose pathnames
24088 contain @file{/bits/stl} or @file{include/sys}.
24090 If, for some reason, you want to include letter @samp{,} in one of
24091 @var{sym}, write @samp{\,}. For example,
24092 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
24093 (note the single quote surrounding the option).
24095 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
24096 @opindex finstrument-functions-exclude-function-list
24098 This is similar to @option{-finstrument-functions-exclude-file-list},
24099 but this option sets the list of function names to be excluded from
24100 instrumentation.  The function name to be matched is its user-visible
24101 name, such as @code{vector<int> blah(const vector<int> &)}, not the
24102 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
24103 match is done on substrings: if the @var{sym} parameter is a substring
24104 of the function name, it is considered to be a match.  For C99 and C++
24105 extended identifiers, the function name must be given in UTF-8, not
24106 using universal character names.
24108 @item -fstack-check
24109 @opindex fstack-check
24110 Generate code to verify that you do not go beyond the boundary of the
24111 stack.  You should specify this flag if you are running in an
24112 environment with multiple threads, but you only rarely need to specify it in
24113 a single-threaded environment since stack overflow is automatically
24114 detected on nearly all systems if there is only one stack.
24116 Note that this switch does not actually cause checking to be done; the
24117 operating system or the language runtime must do that.  The switch causes
24118 generation of code to ensure that they see the stack being extended.
24120 You can additionally specify a string parameter: @samp{no} means no
24121 checking, @samp{generic} means force the use of old-style checking,
24122 @samp{specific} means use the best checking method and is equivalent
24123 to bare @option{-fstack-check}.
24125 Old-style checking is a generic mechanism that requires no specific
24126 target support in the compiler but comes with the following drawbacks:
24128 @enumerate
24129 @item
24130 Modified allocation strategy for large objects: they are always
24131 allocated dynamically if their size exceeds a fixed threshold.
24133 @item
24134 Fixed limit on the size of the static frame of functions: when it is
24135 topped by a particular function, stack checking is not reliable and
24136 a warning is issued by the compiler.
24138 @item
24139 Inefficiency: because of both the modified allocation strategy and the
24140 generic implementation, code performance is hampered.
24141 @end enumerate
24143 Note that old-style stack checking is also the fallback method for
24144 @samp{specific} if no target support has been added in the compiler.
24146 @item -fstack-limit-register=@var{reg}
24147 @itemx -fstack-limit-symbol=@var{sym}
24148 @itemx -fno-stack-limit
24149 @opindex fstack-limit-register
24150 @opindex fstack-limit-symbol
24151 @opindex fno-stack-limit
24152 Generate code to ensure that the stack does not grow beyond a certain value,
24153 either the value of a register or the address of a symbol.  If a larger
24154 stack is required, a signal is raised at run time.  For most targets,
24155 the signal is raised before the stack overruns the boundary, so
24156 it is possible to catch the signal without taking special precautions.
24158 For instance, if the stack starts at absolute address @samp{0x80000000}
24159 and grows downwards, you can use the flags
24160 @option{-fstack-limit-symbol=__stack_limit} and
24161 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
24162 of 128KB@.  Note that this may only work with the GNU linker.
24164 @item -fsplit-stack
24165 @opindex fsplit-stack
24166 Generate code to automatically split the stack before it overflows.
24167 The resulting program has a discontiguous stack which can only
24168 overflow if the program is unable to allocate any more memory.  This
24169 is most useful when running threaded programs, as it is no longer
24170 necessary to calculate a good stack size to use for each thread.  This
24171 is currently only implemented for the x86 targets running
24172 GNU/Linux.
24174 When code compiled with @option{-fsplit-stack} calls code compiled
24175 without @option{-fsplit-stack}, there may not be much stack space
24176 available for the latter code to run.  If compiling all code,
24177 including library code, with @option{-fsplit-stack} is not an option,
24178 then the linker can fix up these calls so that the code compiled
24179 without @option{-fsplit-stack} always has a large stack.  Support for
24180 this is implemented in the gold linker in GNU binutils release 2.21
24181 and later.
24183 @item -fleading-underscore
24184 @opindex fleading-underscore
24185 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
24186 change the way C symbols are represented in the object file.  One use
24187 is to help link with legacy assembly code.
24189 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
24190 generate code that is not binary compatible with code generated without that
24191 switch.  Use it to conform to a non-default application binary interface.
24192 Not all targets provide complete support for this switch.
24194 @item -ftls-model=@var{model}
24195 @opindex ftls-model
24196 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
24197 The @var{model} argument should be one of @samp{global-dynamic},
24198 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
24199 Note that the choice is subject to optimization: the compiler may use
24200 a more efficient model for symbols not visible outside of the translation
24201 unit, or if @option{-fpic} is not given on the command line.
24203 The default without @option{-fpic} is @samp{initial-exec}; with
24204 @option{-fpic} the default is @samp{global-dynamic}.
24206 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
24207 @opindex fvisibility
24208 Set the default ELF image symbol visibility to the specified option---all
24209 symbols are marked with this unless overridden within the code.
24210 Using this feature can very substantially improve linking and
24211 load times of shared object libraries, produce more optimized
24212 code, provide near-perfect API export and prevent symbol clashes.
24213 It is @strong{strongly} recommended that you use this in any shared objects
24214 you distribute.
24216 Despite the nomenclature, @samp{default} always means public; i.e.,
24217 available to be linked against from outside the shared object.
24218 @samp{protected} and @samp{internal} are pretty useless in real-world
24219 usage so the only other commonly used option is @samp{hidden}.
24220 The default if @option{-fvisibility} isn't specified is
24221 @samp{default}, i.e., make every symbol public.
24223 A good explanation of the benefits offered by ensuring ELF
24224 symbols have the correct visibility is given by ``How To Write
24225 Shared Libraries'' by Ulrich Drepper (which can be found at
24226 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
24227 solution made possible by this option to marking things hidden when
24228 the default is public is to make the default hidden and mark things
24229 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
24230 and @code{__attribute__ ((visibility("default")))} instead of
24231 @code{__declspec(dllexport)} you get almost identical semantics with
24232 identical syntax.  This is a great boon to those working with
24233 cross-platform projects.
24235 For those adding visibility support to existing code, you may find
24236 @code{#pragma GCC visibility} of use.  This works by you enclosing
24237 the declarations you wish to set visibility for with (for example)
24238 @code{#pragma GCC visibility push(hidden)} and
24239 @code{#pragma GCC visibility pop}.
24240 Bear in mind that symbol visibility should be viewed @strong{as
24241 part of the API interface contract} and thus all new code should
24242 always specify visibility when it is not the default; i.e., declarations
24243 only for use within the local DSO should @strong{always} be marked explicitly
24244 as hidden as so to avoid PLT indirection overheads---making this
24245 abundantly clear also aids readability and self-documentation of the code.
24246 Note that due to ISO C++ specification requirements, @code{operator new} and
24247 @code{operator delete} must always be of default visibility.
24249 Be aware that headers from outside your project, in particular system
24250 headers and headers from any other library you use, may not be
24251 expecting to be compiled with visibility other than the default.  You
24252 may need to explicitly say @code{#pragma GCC visibility push(default)}
24253 before including any such headers.
24255 @code{extern} declarations are not affected by @option{-fvisibility}, so
24256 a lot of code can be recompiled with @option{-fvisibility=hidden} with
24257 no modifications.  However, this means that calls to @code{extern}
24258 functions with no explicit visibility use the PLT, so it is more
24259 effective to use @code{__attribute ((visibility))} and/or
24260 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
24261 declarations should be treated as hidden.
24263 Note that @option{-fvisibility} does affect C++ vague linkage
24264 entities. This means that, for instance, an exception class that is
24265 be thrown between DSOs must be explicitly marked with default
24266 visibility so that the @samp{type_info} nodes are unified between
24267 the DSOs.
24269 An overview of these techniques, their benefits and how to use them
24270 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
24272 @item -fstrict-volatile-bitfields
24273 @opindex fstrict-volatile-bitfields
24274 This option should be used if accesses to volatile bit-fields (or other
24275 structure fields, although the compiler usually honors those types
24276 anyway) should use a single access of the width of the
24277 field's type, aligned to a natural alignment if possible.  For
24278 example, targets with memory-mapped peripheral registers might require
24279 all such accesses to be 16 bits wide; with this flag you can
24280 declare all peripheral bit-fields as @code{unsigned short} (assuming short
24281 is 16 bits on these targets) to force GCC to use 16-bit accesses
24282 instead of, perhaps, a more efficient 32-bit access.
24284 If this option is disabled, the compiler uses the most efficient
24285 instruction.  In the previous example, that might be a 32-bit load
24286 instruction, even though that accesses bytes that do not contain
24287 any portion of the bit-field, or memory-mapped registers unrelated to
24288 the one being updated.
24290 In some cases, such as when the @code{packed} attribute is applied to a 
24291 structure field, it may not be possible to access the field with a single
24292 read or write that is correctly aligned for the target machine.  In this
24293 case GCC falls back to generating multiple accesses rather than code that 
24294 will fault or truncate the result at run time.
24296 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
24297 not allowed to touch non bit-field members.  It is therefore recommended
24298 to define all bits of the field's type as bit-field members.
24300 The default value of this option is determined by the application binary
24301 interface for the target processor.
24303 @item -fsync-libcalls
24304 @opindex fsync-libcalls
24305 This option controls whether any out-of-line instance of the @code{__sync}
24306 family of functions may be used to implement the C++11 @code{__atomic}
24307 family of functions.
24309 The default value of this option is enabled, thus the only useful form
24310 of the option is @option{-fno-sync-libcalls}.  This option is used in
24311 the implementation of the @file{libatomic} runtime library.
24313 @end table
24315 @c man end
24317 @node Environment Variables
24318 @section Environment Variables Affecting GCC
24319 @cindex environment variables
24321 @c man begin ENVIRONMENT
24322 This section describes several environment variables that affect how GCC
24323 operates.  Some of them work by specifying directories or prefixes to use
24324 when searching for various kinds of files.  Some are used to specify other
24325 aspects of the compilation environment.
24327 Note that you can also specify places to search using options such as
24328 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
24329 take precedence over places specified using environment variables, which
24330 in turn take precedence over those specified by the configuration of GCC@.
24331 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
24332 GNU Compiler Collection (GCC) Internals}.
24334 @table @env
24335 @item LANG
24336 @itemx LC_CTYPE
24337 @c @itemx LC_COLLATE
24338 @itemx LC_MESSAGES
24339 @c @itemx LC_MONETARY
24340 @c @itemx LC_NUMERIC
24341 @c @itemx LC_TIME
24342 @itemx LC_ALL
24343 @findex LANG
24344 @findex LC_CTYPE
24345 @c @findex LC_COLLATE
24346 @findex LC_MESSAGES
24347 @c @findex LC_MONETARY
24348 @c @findex LC_NUMERIC
24349 @c @findex LC_TIME
24350 @findex LC_ALL
24351 @cindex locale
24352 These environment variables control the way that GCC uses
24353 localization information which allows GCC to work with different
24354 national conventions.  GCC inspects the locale categories
24355 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
24356 so.  These locale categories can be set to any value supported by your
24357 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
24358 Kingdom encoded in UTF-8.
24360 The @env{LC_CTYPE} environment variable specifies character
24361 classification.  GCC uses it to determine the character boundaries in
24362 a string; this is needed for some multibyte encodings that contain quote
24363 and escape characters that are otherwise interpreted as a string
24364 end or escape.
24366 The @env{LC_MESSAGES} environment variable specifies the language to
24367 use in diagnostic messages.
24369 If the @env{LC_ALL} environment variable is set, it overrides the value
24370 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
24371 and @env{LC_MESSAGES} default to the value of the @env{LANG}
24372 environment variable.  If none of these variables are set, GCC
24373 defaults to traditional C English behavior.
24375 @item TMPDIR
24376 @findex TMPDIR
24377 If @env{TMPDIR} is set, it specifies the directory to use for temporary
24378 files.  GCC uses temporary files to hold the output of one stage of
24379 compilation which is to be used as input to the next stage: for example,
24380 the output of the preprocessor, which is the input to the compiler
24381 proper.
24383 @item GCC_COMPARE_DEBUG
24384 @findex GCC_COMPARE_DEBUG
24385 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
24386 @option{-fcompare-debug} to the compiler driver.  See the documentation
24387 of this option for more details.
24389 @item GCC_EXEC_PREFIX
24390 @findex GCC_EXEC_PREFIX
24391 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
24392 names of the subprograms executed by the compiler.  No slash is added
24393 when this prefix is combined with the name of a subprogram, but you can
24394 specify a prefix that ends with a slash if you wish.
24396 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
24397 an appropriate prefix to use based on the pathname it is invoked with.
24399 If GCC cannot find the subprogram using the specified prefix, it
24400 tries looking in the usual places for the subprogram.
24402 The default value of @env{GCC_EXEC_PREFIX} is
24403 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
24404 the installed compiler. In many cases @var{prefix} is the value
24405 of @code{prefix} when you ran the @file{configure} script.
24407 Other prefixes specified with @option{-B} take precedence over this prefix.
24409 This prefix is also used for finding files such as @file{crt0.o} that are
24410 used for linking.
24412 In addition, the prefix is used in an unusual way in finding the
24413 directories to search for header files.  For each of the standard
24414 directories whose name normally begins with @samp{/usr/local/lib/gcc}
24415 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
24416 replacing that beginning with the specified prefix to produce an
24417 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
24418 @file{foo/bar} just before it searches the standard directory 
24419 @file{/usr/local/lib/bar}.
24420 If a standard directory begins with the configured
24421 @var{prefix} then the value of @var{prefix} is replaced by
24422 @env{GCC_EXEC_PREFIX} when looking for header files.
24424 @item COMPILER_PATH
24425 @findex COMPILER_PATH
24426 The value of @env{COMPILER_PATH} is a colon-separated list of
24427 directories, much like @env{PATH}.  GCC tries the directories thus
24428 specified when searching for subprograms, if it can't find the
24429 subprograms using @env{GCC_EXEC_PREFIX}.
24431 @item LIBRARY_PATH
24432 @findex LIBRARY_PATH
24433 The value of @env{LIBRARY_PATH} is a colon-separated list of
24434 directories, much like @env{PATH}.  When configured as a native compiler,
24435 GCC tries the directories thus specified when searching for special
24436 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
24437 using GCC also uses these directories when searching for ordinary
24438 libraries for the @option{-l} option (but directories specified with
24439 @option{-L} come first).
24441 @item LANG
24442 @findex LANG
24443 @cindex locale definition
24444 This variable is used to pass locale information to the compiler.  One way in
24445 which this information is used is to determine the character set to be used
24446 when character literals, string literals and comments are parsed in C and C++.
24447 When the compiler is configured to allow multibyte characters,
24448 the following values for @env{LANG} are recognized:
24450 @table @samp
24451 @item C-JIS
24452 Recognize JIS characters.
24453 @item C-SJIS
24454 Recognize SJIS characters.
24455 @item C-EUCJP
24456 Recognize EUCJP characters.
24457 @end table
24459 If @env{LANG} is not defined, or if it has some other value, then the
24460 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
24461 recognize and translate multibyte characters.
24462 @end table
24464 @noindent
24465 Some additional environment variables affect the behavior of the
24466 preprocessor.
24468 @include cppenv.texi
24470 @c man end
24472 @node Precompiled Headers
24473 @section Using Precompiled Headers
24474 @cindex precompiled headers
24475 @cindex speed of compilation
24477 Often large projects have many header files that are included in every
24478 source file.  The time the compiler takes to process these header files
24479 over and over again can account for nearly all of the time required to
24480 build the project.  To make builds faster, GCC allows you to
24481 @dfn{precompile} a header file.
24483 To create a precompiled header file, simply compile it as you would any
24484 other file, if necessary using the @option{-x} option to make the driver
24485 treat it as a C or C++ header file.  You may want to use a
24486 tool like @command{make} to keep the precompiled header up-to-date when
24487 the headers it contains change.
24489 A precompiled header file is searched for when @code{#include} is
24490 seen in the compilation.  As it searches for the included file
24491 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
24492 compiler looks for a precompiled header in each directory just before it
24493 looks for the include file in that directory.  The name searched for is
24494 the name specified in the @code{#include} with @samp{.gch} appended.  If
24495 the precompiled header file can't be used, it is ignored.
24497 For instance, if you have @code{#include "all.h"}, and you have
24498 @file{all.h.gch} in the same directory as @file{all.h}, then the
24499 precompiled header file is used if possible, and the original
24500 header is used otherwise.
24502 Alternatively, you might decide to put the precompiled header file in a
24503 directory and use @option{-I} to ensure that directory is searched
24504 before (or instead of) the directory containing the original header.
24505 Then, if you want to check that the precompiled header file is always
24506 used, you can put a file of the same name as the original header in this
24507 directory containing an @code{#error} command.
24509 This also works with @option{-include}.  So yet another way to use
24510 precompiled headers, good for projects not designed with precompiled
24511 header files in mind, is to simply take most of the header files used by
24512 a project, include them from another header file, precompile that header
24513 file, and @option{-include} the precompiled header.  If the header files
24514 have guards against multiple inclusion, they are skipped because
24515 they've already been included (in the precompiled header).
24517 If you need to precompile the same header file for different
24518 languages, targets, or compiler options, you can instead make a
24519 @emph{directory} named like @file{all.h.gch}, and put each precompiled
24520 header in the directory, perhaps using @option{-o}.  It doesn't matter
24521 what you call the files in the directory; every precompiled header in
24522 the directory is considered.  The first precompiled header
24523 encountered in the directory that is valid for this compilation is
24524 used; they're searched in no particular order.
24526 There are many other possibilities, limited only by your imagination,
24527 good sense, and the constraints of your build system.
24529 A precompiled header file can be used only when these conditions apply:
24531 @itemize
24532 @item
24533 Only one precompiled header can be used in a particular compilation.
24535 @item
24536 A precompiled header can't be used once the first C token is seen.  You
24537 can have preprocessor directives before a precompiled header; you cannot
24538 include a precompiled header from inside another header.
24540 @item
24541 The precompiled header file must be produced for the same language as
24542 the current compilation.  You can't use a C precompiled header for a C++
24543 compilation.
24545 @item
24546 The precompiled header file must have been produced by the same compiler
24547 binary as the current compilation is using.
24549 @item
24550 Any macros defined before the precompiled header is included must
24551 either be defined in the same way as when the precompiled header was
24552 generated, or must not affect the precompiled header, which usually
24553 means that they don't appear in the precompiled header at all.
24555 The @option{-D} option is one way to define a macro before a
24556 precompiled header is included; using a @code{#define} can also do it.
24557 There are also some options that define macros implicitly, like
24558 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
24559 defined this way.
24561 @item If debugging information is output when using the precompiled
24562 header, using @option{-g} or similar, the same kind of debugging information
24563 must have been output when building the precompiled header.  However,
24564 a precompiled header built using @option{-g} can be used in a compilation
24565 when no debugging information is being output.
24567 @item The same @option{-m} options must generally be used when building
24568 and using the precompiled header.  @xref{Submodel Options},
24569 for any cases where this rule is relaxed.
24571 @item Each of the following options must be the same when building and using
24572 the precompiled header:
24574 @gccoptlist{-fexceptions}
24576 @item
24577 Some other command-line options starting with @option{-f},
24578 @option{-p}, or @option{-O} must be defined in the same way as when
24579 the precompiled header was generated.  At present, it's not clear
24580 which options are safe to change and which are not; the safest choice
24581 is to use exactly the same options when generating and using the
24582 precompiled header.  The following are known to be safe:
24584 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
24585 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
24586 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
24587 -pedantic-errors}
24589 @end itemize
24591 For all of these except the last, the compiler automatically
24592 ignores the precompiled header if the conditions aren't met.  If you
24593 find an option combination that doesn't work and doesn't cause the
24594 precompiled header to be ignored, please consider filing a bug report,
24595 see @ref{Bugs}.
24597 If you do use differing options when generating and using the
24598 precompiled header, the actual behavior is a mixture of the
24599 behavior for the options.  For instance, if you use @option{-g} to
24600 generate the precompiled header but not when using it, you may or may
24601 not get debugging information for routines in the precompiled header.