Merge from trunk @222673.
[official-gcc.git] / gcc / doc / invoke.texi
blob01f2887243cc47552bb0d206b9d75db28a84363f
1 @c Copyright (C) 1988-2015 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2015 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified.  Also,
105 the placement of the @option{-l} option is significant.
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}.  This manual documents
112 only one of these two forms, whichever one is not the default.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
118 @menu
119 * Option Summary::      Brief list of all options, without explanations.
120 * Overall Options::     Controlling the kind of output:
121                         an executable, object files, assembler files,
122                         or preprocessed source.
123 * Invoking G++::        Compiling C++ programs.
124 * C Dialect Options::   Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127                         and Objective-C++.
128 * Language Independent Options:: Controlling how diagnostics should be
129                         formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
161 -pipe  -pass-exit-codes  @gol
162 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
171 -fhosted  -ffreestanding -fopenacc -fopenmp -fopenmp-simd @gol
172 -fms-extensions -fplan9-extensions -trigraphs -traditional -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti -fsized-deallocation @gol
191 -fstats  -ftemplate-backtrace-limit=@var{n} @gol
192 -ftemplate-depth=@var{n} @gol
193 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
194 -fno-weak  -nostdinc++ @gol
195 -fvisibility-inlines-hidden @gol
196 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
197 -fvtv-counts -fvtv-debug @gol
198 -fvisibility-ms-compat @gol
199 -fext-numeric-literals @gol
200 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime  -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -fno-local-ivars @gol
222 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
223 -freplace-objc-classes @gol
224 -fzero-link @gol
225 -gen-decls @gol
226 -Wassign-intercept @gol
227 -Wno-protocol  -Wselector @gol
228 -Wstrict-selector-match @gol
229 -Wundeclared-selector}
231 @item Language Independent Options
232 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
233 @gccoptlist{-fmessage-length=@var{n}  @gol
234 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
235 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
236 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
238 @item Warning Options
239 @xref{Warning Options,,Options to Request or Suppress Warnings}.
240 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
241 -pedantic-errors @gol
242 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
243 -Waggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
244 -Wbool-compare @gol
245 -Wno-attributes -Wno-builtin-macro-redefined @gol
246 -Wc90-c99-compat -Wc99-c11-compat @gol
247 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
248 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
249 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
250 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
251 -Wdisabled-optimization @gol
252 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
253 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
254 -Wno-endif-labels -Werror  -Werror=* @gol
255 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
256 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
257 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
258 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
259 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
260 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
261 -Winit-self  -Winline  -Wno-int-conversion @gol
262 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
263 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
264 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
265 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args -Wmissing-braces @gol
266 -Wmissing-field-initializers -Wmissing-include-dirs @gol
267 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
268 -Wodr  -Wno-overflow  -Wopenmp-simd @gol
269 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
270 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
271 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
272 -Wredundant-decls  -Wno-return-local-addr @gol
273 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
274 -Wshift-count-negative -Wshift-count-overflow @gol
275 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
276 -Wno-scalar-storage-order @gol
277 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
278 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
279 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
280 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
281 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
282 -Wmissing-format-attribute @gol
283 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
284 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
285 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
286 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
287 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
288 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
289 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
290 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
291 -Wvla -Wvolatile-register-var  -Wwrite-strings @gol
292 -Wzero-as-null-pointer-constant}
294 @item C and Objective-C-only Warning Options
295 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
296 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
297 -Wold-style-declaration  -Wold-style-definition @gol
298 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
299 -Wdeclaration-after-statement -Wpointer-sign}
301 @item Debugging Options
302 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
303 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
304 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
305 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1,s2,...} @gol
306 -fsanitize-undefined-trap-on-error @gol
307 -fcheck-pointer-bounds -fchkp-check-incomplete-type @gol
308 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
309 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
310 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
311 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
312 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
313 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
314 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
315 -fchkp-use-wrappers @gol
316 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
317 -fdisable-ipa-@var{pass_name} @gol
318 -fdisable-rtl-@var{pass_name} @gol
319 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
320 -fdisable-tree-@var{pass_name} @gol
321 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
322 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
323 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
324 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
325 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
326 -fdump-passes @gol
327 -fdump-statistics @gol
328 -fdump-tree-all @gol
329 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
330 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
331 -fdump-tree-cfg -fdump-tree-alias @gol
332 -fdump-tree-ch @gol
333 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
334 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
335 -fdump-tree-gimple@r{[}-raw@r{]} @gol
336 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
337 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
338 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
339 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
340 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
341 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
342 -fdump-tree-nrv -fdump-tree-vect @gol
343 -fdump-tree-sink @gol
344 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
345 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
346 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
347 -fdump-tree-vtable-verify @gol
348 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
349 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
350 -fdump-final-insns=@var{file} @gol
351 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
352 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
353 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
354 -fenable-@var{kind}-@var{pass} @gol
355 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
356 -fdebug-types-section -fmem-report-wpa @gol
357 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
358 -fopt-info @gol
359 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
360 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
361 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
362 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
363 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
364 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
365 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
366 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
367 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
368 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
369 -fdebug-prefix-map=@var{old}=@var{new} @gol
370 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
371 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
372 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
373 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
374 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
375 -print-sysroot -print-sysroot-headers-suffix @gol
376 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
378 @item Optimization Options
379 @xref{Optimize Options,,Options that Control Optimization}.
380 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
381 -falign-jumps[=@var{n}] @gol
382 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
383 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
384 -fauto-inc-dec -fbranch-probabilities @gol
385 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
386 -fbtr-bb-exclusive -fcaller-saves @gol
387 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
388 -fcompare-elim -fcprop-registers -fcrossjumping @gol
389 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
390 -fcx-limited-range @gol
391 -fdata-sections -fdce -fdelayed-branch @gol
392 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
393 -fdevirtualize-at-ltrans -fdse @gol
394 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
395 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
396 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
397 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
398 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
399 -fif-conversion2 -findirect-inlining @gol
400 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
401 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment @gol
402 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
403 -fira-algorithm=@var{algorithm} @gol
404 -fira-region=@var{region} -fira-hoist-pressure @gol
405 -fira-loop-pressure -fno-ira-share-save-slots @gol
406 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
407 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
408 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
409 -flive-range-shrinkage @gol
410 -floop-block -floop-interchange -floop-strip-mine @gol
411 -floop-unroll-and-jam -floop-nest-optimize @gol
412 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
413 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
414 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
415 -fmove-loop-invariants -fno-branch-count-reg @gol
416 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
417 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
418 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
419 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
420 -fomit-frame-pointer -foptimize-sibling-calls @gol
421 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
422 -fprefetch-loop-arrays -fprofile-report @gol
423 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
424 -fprofile-generate=@var{path} @gol
425 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
426 -fprofile-reorder-functions @gol
427 -freciprocal-math -free -frename-registers -freorder-blocks @gol
428 -freorder-blocks-and-partition -freorder-functions @gol
429 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
430 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
431 -fsched-spec-load -fsched-spec-load-dangerous @gol
432 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
433 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
434 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
435 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
436 -fschedule-fusion @gol
437 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
438 -fselective-scheduling -fselective-scheduling2 @gol
439 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
440 -fsemantic-interposition @gol
441 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
442 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt @gol
443 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
444 -fstack-protector-explicit -fstdarg-opt -fstrict-aliasing @gol
445 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
446 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
447 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
448 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
449 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
450 -ftree-loop-if-convert-stores -ftree-loop-im @gol
451 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
452 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
453 -ftree-loop-vectorize @gol
454 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
455 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
456 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
457 -ftree-vectorize -ftree-vrp @gol
458 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
459 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
460 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
461 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
462 --param @var{name}=@var{value}
463 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
465 @item Preprocessor Options
466 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
467 @gccoptlist{-A@var{question}=@var{answer} @gol
468 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
469 -C  -dD  -dI  -dM  -dN @gol
470 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
471 -idirafter @var{dir} @gol
472 -include @var{file}  -imacros @var{file} @gol
473 -iprefix @var{file}  -iwithprefix @var{dir} @gol
474 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
475 -imultilib @var{dir} -isysroot @var{dir} @gol
476 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
477 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
478 -remap -trigraphs  -undef  -U@var{macro}  @gol
479 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
481 @item Assembler Option
482 @xref{Assembler Options,,Passing Options to the Assembler}.
483 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
485 @item Linker Options
486 @xref{Link Options,,Options for Linking}.
487 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
488 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
489 -s  -static -static-libgcc -static-libstdc++ @gol
490 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
491 -static-libmpx -static-libmpxwrappers @gol
492 -shared -shared-libgcc  -symbolic @gol
493 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
494 -u @var{symbol} -z @var{keyword}}
496 @item Directory Options
497 @xref{Directory Options,,Options for Directory Search}.
498 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
499 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
500 --sysroot=@var{dir} --no-sysroot-suffix}
502 @item Machine Dependent Options
503 @xref{Submodel Options,,Hardware Models and Configurations}.
504 @c This list is ordered alphanumerically by subsection name.
505 @c Try and put the significant identifier (CPU or system) first,
506 @c so users have a clue at guessing where the ones they want will be.
508 @emph{AArch64 Options}
509 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
510 -mgeneral-regs-only @gol
511 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
512 -mstrict-align @gol
513 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
514 -mtls-dialect=desc  -mtls-dialect=traditional @gol
515 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
516 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
518 @emph{Adapteva Epiphany Options}
519 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
520 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
521 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
522 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
523 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
524 -msplit-vecmove-early -m1reg-@var{reg}}
526 @emph{ARC Options}
527 @gccoptlist{-mbarrel-shifter @gol
528 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
529 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
530 -mea -mno-mpy -mmul32x16 -mmul64 @gol
531 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
532 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
533 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
534 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
535 -mucb-mcount -mvolatile-cache @gol
536 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
537 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
538 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
539 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
540 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
541 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
543 @emph{ARM Options}
544 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
545 -mabi=@var{name} @gol
546 -mapcs-stack-check  -mno-apcs-stack-check @gol
547 -mapcs-float  -mno-apcs-float @gol
548 -mapcs-reentrant  -mno-apcs-reentrant @gol
549 -msched-prolog  -mno-sched-prolog @gol
550 -mlittle-endian  -mbig-endian @gol
551 -mfloat-abi=@var{name} @gol
552 -mfp16-format=@var{name}
553 -mthumb-interwork  -mno-thumb-interwork @gol
554 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
555 -mtune=@var{name} -mprint-tune-info @gol
556 -mstructure-size-boundary=@var{n} @gol
557 -mabort-on-noreturn @gol
558 -mlong-calls  -mno-long-calls @gol
559 -msingle-pic-base  -mno-single-pic-base @gol
560 -mpic-register=@var{reg} @gol
561 -mnop-fun-dllimport @gol
562 -mpoke-function-name @gol
563 -mthumb  -marm @gol
564 -mtpcs-frame  -mtpcs-leaf-frame @gol
565 -mcaller-super-interworking  -mcallee-super-interworking @gol
566 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
567 -mword-relocations @gol
568 -mfix-cortex-m3-ldrd @gol
569 -munaligned-access @gol
570 -mneon-for-64bits @gol
571 -mslow-flash-data @gol
572 -masm-syntax-unified @gol
573 -mrestrict-it}
575 @emph{AVR Options}
576 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
577 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
578 -mrelax -mrmw -mstrict-X -mtiny-stack -nodevicelib -Waddr-space-convert}
580 @emph{Blackfin Options}
581 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
582 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
583 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
584 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
585 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
586 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
587 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
588 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
589 -micplb}
591 @emph{C6X Options}
592 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
593 -msim -msdata=@var{sdata-type}}
595 @emph{CRIS Options}
596 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
597 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
598 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
599 -mstack-align  -mdata-align  -mconst-align @gol
600 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
601 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
602 -mmul-bug-workaround  -mno-mul-bug-workaround}
604 @emph{CR16 Options}
605 @gccoptlist{-mmac @gol
606 -mcr16cplus -mcr16c @gol
607 -msim -mint32 -mbit-ops
608 -mdata-model=@var{model}}
610 @emph{Darwin Options}
611 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
612 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
613 -client_name  -compatibility_version  -current_version @gol
614 -dead_strip @gol
615 -dependency-file  -dylib_file  -dylinker_install_name @gol
616 -dynamic  -dynamiclib  -exported_symbols_list @gol
617 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
618 -force_flat_namespace  -headerpad_max_install_names @gol
619 -iframework @gol
620 -image_base  -init  -install_name  -keep_private_externs @gol
621 -multi_module  -multiply_defined  -multiply_defined_unused @gol
622 -noall_load   -no_dead_strip_inits_and_terms @gol
623 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
624 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
625 -private_bundle  -read_only_relocs  -sectalign @gol
626 -sectobjectsymbols  -whyload  -seg1addr @gol
627 -sectcreate  -sectobjectsymbols  -sectorder @gol
628 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
629 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
630 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
631 -single_module  -static  -sub_library  -sub_umbrella @gol
632 -twolevel_namespace  -umbrella  -undefined @gol
633 -unexported_symbols_list  -weak_reference_mismatches @gol
634 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
635 -mkernel -mone-byte-bool}
637 @emph{DEC Alpha Options}
638 @gccoptlist{-mno-fp-regs  -msoft-float @gol
639 -mieee  -mieee-with-inexact  -mieee-conformant @gol
640 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
641 -mtrap-precision=@var{mode}  -mbuild-constants @gol
642 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
643 -mbwx  -mmax  -mfix  -mcix @gol
644 -mfloat-vax  -mfloat-ieee @gol
645 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
646 -msmall-text  -mlarge-text @gol
647 -mmemory-latency=@var{time}}
649 @emph{FR30 Options}
650 @gccoptlist{-msmall-model -mno-lsim}
652 @emph{FRV Options}
653 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
654 -mhard-float  -msoft-float @gol
655 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
656 -mdouble  -mno-double @gol
657 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
658 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
659 -mlinked-fp  -mlong-calls  -malign-labels @gol
660 -mlibrary-pic  -macc-4  -macc-8 @gol
661 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
662 -moptimize-membar -mno-optimize-membar @gol
663 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
664 -mvliw-branch  -mno-vliw-branch @gol
665 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
666 -mno-nested-cond-exec  -mtomcat-stats @gol
667 -mTLS -mtls @gol
668 -mcpu=@var{cpu}}
670 @emph{GNU/Linux Options}
671 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
672 -tno-android-cc -tno-android-ld}
674 @emph{H8/300 Options}
675 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
677 @emph{HPPA Options}
678 @gccoptlist{-march=@var{architecture-type} @gol
679 -mdisable-fpregs  -mdisable-indexing @gol
680 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
681 -mfixed-range=@var{register-range} @gol
682 -mjump-in-delay -mlinker-opt -mlong-calls @gol
683 -mlong-load-store  -mno-disable-fpregs @gol
684 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
685 -mno-jump-in-delay  -mno-long-load-store @gol
686 -mno-portable-runtime  -mno-soft-float @gol
687 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
688 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
689 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
690 -munix=@var{unix-std}  -nolibdld  -static  -threads}
692 @emph{IA-64 Options}
693 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
694 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
695 -mconstant-gp  -mauto-pic  -mfused-madd @gol
696 -minline-float-divide-min-latency @gol
697 -minline-float-divide-max-throughput @gol
698 -mno-inline-float-divide @gol
699 -minline-int-divide-min-latency @gol
700 -minline-int-divide-max-throughput  @gol
701 -mno-inline-int-divide @gol
702 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
703 -mno-inline-sqrt @gol
704 -mdwarf2-asm -mearly-stop-bits @gol
705 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
706 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
707 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
708 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
709 -msched-spec-ldc -msched-spec-control-ldc @gol
710 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
711 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
712 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
713 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
715 @emph{LM32 Options}
716 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
717 -msign-extend-enabled -muser-enabled}
719 @emph{M32R/D Options}
720 @gccoptlist{-m32r2 -m32rx -m32r @gol
721 -mdebug @gol
722 -malign-loops -mno-align-loops @gol
723 -missue-rate=@var{number} @gol
724 -mbranch-cost=@var{number} @gol
725 -mmodel=@var{code-size-model-type} @gol
726 -msdata=@var{sdata-type} @gol
727 -mno-flush-func -mflush-func=@var{name} @gol
728 -mno-flush-trap -mflush-trap=@var{number} @gol
729 -G @var{num}}
731 @emph{M32C Options}
732 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
734 @emph{M680x0 Options}
735 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
736 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
737 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
738 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
739 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
740 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
741 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
742 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
743 -mxgot -mno-xgot}
745 @emph{MCore Options}
746 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
747 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
748 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
749 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
750 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
752 @emph{MeP Options}
753 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
754 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
755 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
756 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
757 -mtiny=@var{n}}
759 @emph{MicroBlaze Options}
760 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
761 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
762 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
763 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
764 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
766 @emph{MIPS Options}
767 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
768 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
769 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
770 -mips16  -mno-mips16  -mflip-mips16 @gol
771 -minterlink-compressed -mno-interlink-compressed @gol
772 -minterlink-mips16  -mno-interlink-mips16 @gol
773 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
774 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
775 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
776 -mno-float  -msingle-float  -mdouble-float @gol
777 -modd-spreg -mno-odd-spreg @gol
778 -mabs=@var{mode}  -mnan=@var{encoding} @gol
779 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
780 -mmcu -mmno-mcu @gol
781 -meva -mno-eva @gol
782 -mvirt -mno-virt @gol
783 -mxpa -mno-xpa @gol
784 -mmicromips -mno-micromips @gol
785 -mfpu=@var{fpu-type} @gol
786 -msmartmips  -mno-smartmips @gol
787 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
788 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
789 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
790 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
791 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
792 -membedded-data  -mno-embedded-data @gol
793 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
794 -mcode-readable=@var{setting} @gol
795 -msplit-addresses  -mno-split-addresses @gol
796 -mexplicit-relocs  -mno-explicit-relocs @gol
797 -mcheck-zero-division  -mno-check-zero-division @gol
798 -mdivide-traps  -mdivide-breaks @gol
799 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
800 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
801 -mfix-24k -mno-fix-24k @gol
802 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
803 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
804 -mfix-vr4120  -mno-fix-vr4120 @gol
805 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
806 -mflush-func=@var{func}  -mno-flush-func @gol
807 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
808 -mfp-exceptions -mno-fp-exceptions @gol
809 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
810 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
812 @emph{MMIX Options}
813 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
814 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
815 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
816 -mno-base-addresses  -msingle-exit  -mno-single-exit}
818 @emph{MN10300 Options}
819 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
820 -mno-am33 -mam33 -mam33-2 -mam34 @gol
821 -mtune=@var{cpu-type} @gol
822 -mreturn-pointer-on-d0 @gol
823 -mno-crt0  -mrelax -mliw -msetlb}
825 @emph{Moxie Options}
826 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
828 @emph{MSP430 Options}
829 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
830 -mhwmult= -minrt}
832 @emph{NDS32 Options}
833 @gccoptlist{-mbig-endian -mlittle-endian @gol
834 -mreduced-regs -mfull-regs @gol
835 -mcmov -mno-cmov @gol
836 -mperf-ext -mno-perf-ext @gol
837 -mv3push -mno-v3push @gol
838 -m16bit -mno-16bit @gol
839 -misr-vector-size=@var{num} @gol
840 -mcache-block-size=@var{num} @gol
841 -march=@var{arch} @gol
842 -mcmodel=@var{code-model} @gol
843 -mctor-dtor -mrelax}
845 @emph{Nios II Options}
846 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
847 -mel -meb @gol
848 -mno-bypass-cache -mbypass-cache @gol
849 -mno-cache-volatile -mcache-volatile @gol
850 -mno-fast-sw-div -mfast-sw-div @gol
851 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
852 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
853 -mcustom-fpu-cfg=@var{name} @gol
854 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
856 @emph{Nvidia PTX Options}
857 @gccoptlist{-m32 -m64 -mmainkernel}
859 @emph{PDP-11 Options}
860 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
861 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
862 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
863 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
864 -mbranch-expensive  -mbranch-cheap @gol
865 -munix-asm  -mdec-asm}
867 @emph{picoChip Options}
868 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
869 -msymbol-as-address -mno-inefficient-warnings}
871 @emph{PowerPC Options}
872 See RS/6000 and PowerPC Options.
874 @emph{RL78 Options}
875 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
876 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
877 -m64bit-doubles -m32bit-doubles}
879 @emph{RS/6000 and PowerPC Options}
880 @gccoptlist{-mcpu=@var{cpu-type} @gol
881 -mtune=@var{cpu-type} @gol
882 -mcmodel=@var{code-model} @gol
883 -mpowerpc64 @gol
884 -maltivec  -mno-altivec @gol
885 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
886 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
887 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
888 -mfprnd  -mno-fprnd @gol
889 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
890 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
891 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
892 -malign-power  -malign-natural @gol
893 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
894 -msingle-float -mdouble-float -msimple-fpu @gol
895 -mstring  -mno-string  -mupdate  -mno-update @gol
896 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
897 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
898 -mstrict-align  -mno-strict-align  -mrelocatable @gol
899 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
900 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
901 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
902 -mprioritize-restricted-insns=@var{priority} @gol
903 -msched-costly-dep=@var{dependence_type} @gol
904 -minsert-sched-nops=@var{scheme} @gol
905 -mcall-sysv  -mcall-netbsd @gol
906 -maix-struct-return  -msvr4-struct-return @gol
907 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
908 -mblock-move-inline-limit=@var{num} @gol
909 -misel -mno-isel @gol
910 -misel=yes  -misel=no @gol
911 -mspe -mno-spe @gol
912 -mspe=yes  -mspe=no @gol
913 -mpaired @gol
914 -mgen-cell-microcode -mwarn-cell-microcode @gol
915 -mvrsave -mno-vrsave @gol
916 -mmulhw -mno-mulhw @gol
917 -mdlmzb -mno-dlmzb @gol
918 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
919 -mprototype  -mno-prototype @gol
920 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
921 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
922 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
923 -mno-recip-precision @gol
924 -mveclibabi=@var{type} -mfriz -mno-friz @gol
925 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
926 -msave-toc-indirect -mno-save-toc-indirect @gol
927 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
928 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
929 -mquad-memory -mno-quad-memory @gol
930 -mquad-memory-atomic -mno-quad-memory-atomic @gol
931 -mcompat-align-parm -mno-compat-align-parm @gol
932 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
933 -mupper-regs -mno-upper-regs}
935 @emph{RX Options}
936 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
937 -mcpu=@gol
938 -mbig-endian-data -mlittle-endian-data @gol
939 -msmall-data @gol
940 -msim  -mno-sim@gol
941 -mas100-syntax -mno-as100-syntax@gol
942 -mrelax@gol
943 -mmax-constant-size=@gol
944 -mint-register=@gol
945 -mpid@gol
946 -mallow-string-insns -mno-allow-string-insns@gol
947 -mno-warn-multiple-fast-interrupts@gol
948 -msave-acc-in-interrupts}
950 @emph{S/390 and zSeries Options}
951 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
952 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
953 -mlong-double-64 -mlong-double-128 @gol
954 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
955 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
956 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
957 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
958 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
959 -mhotpatch=@var{halfwords},@var{halfwords}}
961 @emph{Score Options}
962 @gccoptlist{-meb -mel @gol
963 -mnhwloop @gol
964 -muls @gol
965 -mmac @gol
966 -mscore5 -mscore5u -mscore7 -mscore7d}
968 @emph{SH Options}
969 @gccoptlist{-m1  -m2  -m2e @gol
970 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
971 -m3  -m3e @gol
972 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
973 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
974 -m5-64media  -m5-64media-nofpu @gol
975 -m5-32media  -m5-32media-nofpu @gol
976 -m5-compact  -m5-compact-nofpu @gol
977 -mb  -ml  -mdalign  -mrelax @gol
978 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
979 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
980 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
981 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
982 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
983 -maccumulate-outgoing-args -minvalid-symbols @gol
984 -matomic-model=@var{atomic-model} @gol
985 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
986 -mcbranch-force-delay-slot @gol
987 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
988 -mpretend-cmove -mtas}
990 @emph{Solaris 2 Options}
991 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
992 -pthreads -pthread}
994 @emph{SPARC Options}
995 @gccoptlist{-mcpu=@var{cpu-type} @gol
996 -mtune=@var{cpu-type} @gol
997 -mcmodel=@var{code-model} @gol
998 -mmemory-model=@var{mem-model} @gol
999 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1000 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1001 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1002 -mhard-quad-float  -msoft-quad-float @gol
1003 -mstack-bias  -mno-stack-bias @gol
1004 -munaligned-doubles  -mno-unaligned-doubles @gol
1005 -muser-mode  -mno-user-mode @gol
1006 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1007 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1008 -mcbcond -mno-cbcond @gol
1009 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1010 -mfix-at697f -mfix-ut699}
1012 @emph{SPU Options}
1013 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1014 -msafe-dma -munsafe-dma @gol
1015 -mbranch-hints @gol
1016 -msmall-mem -mlarge-mem -mstdmain @gol
1017 -mfixed-range=@var{register-range} @gol
1018 -mea32 -mea64 @gol
1019 -maddress-space-conversion -mno-address-space-conversion @gol
1020 -mcache-size=@var{cache-size} @gol
1021 -matomic-updates -mno-atomic-updates}
1023 @emph{System V Options}
1024 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1026 @emph{TILE-Gx Options}
1027 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1028 -mcmodel=@var{code-model}}
1030 @emph{TILEPro Options}
1031 @gccoptlist{-mcpu=@var{cpu} -m32}
1033 @emph{V850 Options}
1034 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1035 -mprolog-function  -mno-prolog-function  -mspace @gol
1036 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1037 -mapp-regs  -mno-app-regs @gol
1038 -mdisable-callt  -mno-disable-callt @gol
1039 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1040 -mv850e -mv850 -mv850e3v5 @gol
1041 -mloop @gol
1042 -mrelax @gol
1043 -mlong-jumps @gol
1044 -msoft-float @gol
1045 -mhard-float @gol
1046 -mgcc-abi @gol
1047 -mrh850-abi @gol
1048 -mbig-switch}
1050 @emph{VAX Options}
1051 @gccoptlist{-mg  -mgnu  -munix}
1053 @emph{Visium Options}
1054 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1055 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1057 @emph{VMS Options}
1058 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1059 -mpointer-size=@var{size}}
1061 @emph{VxWorks Options}
1062 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1063 -Xbind-lazy  -Xbind-now}
1065 @emph{x86 Options}
1066 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1067 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1068 -mfpmath=@var{unit} @gol
1069 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1070 -mno-fp-ret-in-387  -msoft-float @gol
1071 -mno-wide-multiply  -mrtd  -malign-double @gol
1072 -mpreferred-stack-boundary=@var{num} @gol
1073 -mincoming-stack-boundary=@var{num} @gol
1074 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1075 -mrecip -mrecip=@var{opt} @gol
1076 -mvzeroupper -mprefer-avx128 @gol
1077 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1078 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
1079 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
1080 -mclflushopt -mxsavec -mxsaves @gol
1081 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1082 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mthreads @gol
1083 -mno-align-stringops  -minline-all-stringops @gol
1084 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1085 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1086 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1087 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1088 -mregparm=@var{num}  -msseregparm @gol
1089 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1090 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1091 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1092 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1093 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
1094 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1095 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1096 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
1098 @emph{x86 Windows Options}
1099 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1100 -mnop-fun-dllimport -mthread @gol
1101 -municode -mwin32 -mwindows -fno-set-stack-executable}
1103 @emph{Xstormy16 Options}
1104 @gccoptlist{-msim}
1106 @emph{Xtensa Options}
1107 @gccoptlist{-mconst16 -mno-const16 @gol
1108 -mfused-madd  -mno-fused-madd @gol
1109 -mforce-no-pic @gol
1110 -mserialize-volatile  -mno-serialize-volatile @gol
1111 -mtext-section-literals  -mno-text-section-literals @gol
1112 -mtarget-align  -mno-target-align @gol
1113 -mlongcalls  -mno-longcalls}
1115 @emph{zSeries Options}
1116 See S/390 and zSeries Options.
1118 @item Code Generation Options
1119 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1120 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1121 -ffixed-@var{reg}  -fexceptions @gol
1122 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1123 -fasynchronous-unwind-tables @gol
1124 -fno-gnu-unique @gol
1125 -finhibit-size-directive  -finstrument-functions @gol
1126 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1127 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1128 -fno-common  -fno-ident @gol
1129 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1130 -fno-jump-tables @gol
1131 -frecord-gcc-switches @gol
1132 -freg-struct-return  -fshort-enums @gol
1133 -fshort-double  -fshort-wchar @gol
1134 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1135 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1136 -fno-stack-limit -fsplit-stack @gol
1137 -fleading-underscore  -ftls-model=@var{model} @gol
1138 -fstack-reuse=@var{reuse_level} @gol
1139 -ftrapv  -fwrapv  -fbounds-check @gol
1140 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
1141 -fstrict-volatile-bitfields -fsync-libcalls}
1142 @end table
1145 @node Overall Options
1146 @section Options Controlling the Kind of Output
1148 Compilation can involve up to four stages: preprocessing, compilation
1149 proper, assembly and linking, always in that order.  GCC is capable of
1150 preprocessing and compiling several files either into several
1151 assembler input files, or into one assembler input file; then each
1152 assembler input file produces an object file, and linking combines all
1153 the object files (those newly compiled, and those specified as input)
1154 into an executable file.
1156 @cindex file name suffix
1157 For any given input file, the file name suffix determines what kind of
1158 compilation is done:
1160 @table @gcctabopt
1161 @item @var{file}.c
1162 C source code that must be preprocessed.
1164 @item @var{file}.i
1165 C source code that should not be preprocessed.
1167 @item @var{file}.ii
1168 C++ source code that should not be preprocessed.
1170 @item @var{file}.m
1171 Objective-C source code.  Note that you must link with the @file{libobjc}
1172 library to make an Objective-C program work.
1174 @item @var{file}.mi
1175 Objective-C source code that should not be preprocessed.
1177 @item @var{file}.mm
1178 @itemx @var{file}.M
1179 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1180 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1181 to a literal capital M@.
1183 @item @var{file}.mii
1184 Objective-C++ source code that should not be preprocessed.
1186 @item @var{file}.h
1187 C, C++, Objective-C or Objective-C++ header file to be turned into a
1188 precompiled header (default), or C, C++ header file to be turned into an
1189 Ada spec (via the @option{-fdump-ada-spec} switch).
1191 @item @var{file}.cc
1192 @itemx @var{file}.cp
1193 @itemx @var{file}.cxx
1194 @itemx @var{file}.cpp
1195 @itemx @var{file}.CPP
1196 @itemx @var{file}.c++
1197 @itemx @var{file}.C
1198 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1199 the last two letters must both be literally @samp{x}.  Likewise,
1200 @samp{.C} refers to a literal capital C@.
1202 @item @var{file}.mm
1203 @itemx @var{file}.M
1204 Objective-C++ source code that must be preprocessed.
1206 @item @var{file}.mii
1207 Objective-C++ source code that should not be preprocessed.
1209 @item @var{file}.hh
1210 @itemx @var{file}.H
1211 @itemx @var{file}.hp
1212 @itemx @var{file}.hxx
1213 @itemx @var{file}.hpp
1214 @itemx @var{file}.HPP
1215 @itemx @var{file}.h++
1216 @itemx @var{file}.tcc
1217 C++ header file to be turned into a precompiled header or Ada spec.
1219 @item @var{file}.f
1220 @itemx @var{file}.for
1221 @itemx @var{file}.ftn
1222 Fixed form Fortran source code that should not be preprocessed.
1224 @item @var{file}.F
1225 @itemx @var{file}.FOR
1226 @itemx @var{file}.fpp
1227 @itemx @var{file}.FPP
1228 @itemx @var{file}.FTN
1229 Fixed form Fortran source code that must be preprocessed (with the traditional
1230 preprocessor).
1232 @item @var{file}.f90
1233 @itemx @var{file}.f95
1234 @itemx @var{file}.f03
1235 @itemx @var{file}.f08
1236 Free form Fortran source code that should not be preprocessed.
1238 @item @var{file}.F90
1239 @itemx @var{file}.F95
1240 @itemx @var{file}.F03
1241 @itemx @var{file}.F08
1242 Free form Fortran source code that must be preprocessed (with the
1243 traditional preprocessor).
1245 @item @var{file}.go
1246 Go source code.
1248 @c FIXME: Descriptions of Java file types.
1249 @c @var{file}.java
1250 @c @var{file}.class
1251 @c @var{file}.zip
1252 @c @var{file}.jar
1254 @item @var{file}.ads
1255 Ada source code file that contains a library unit declaration (a
1256 declaration of a package, subprogram, or generic, or a generic
1257 instantiation), or a library unit renaming declaration (a package,
1258 generic, or subprogram renaming declaration).  Such files are also
1259 called @dfn{specs}.
1261 @item @var{file}.adb
1262 Ada source code file containing a library unit body (a subprogram or
1263 package body).  Such files are also called @dfn{bodies}.
1265 @c GCC also knows about some suffixes for languages not yet included:
1266 @c Pascal:
1267 @c @var{file}.p
1268 @c @var{file}.pas
1269 @c Ratfor:
1270 @c @var{file}.r
1272 @item @var{file}.s
1273 Assembler code.
1275 @item @var{file}.S
1276 @itemx @var{file}.sx
1277 Assembler code that must be preprocessed.
1279 @item @var{other}
1280 An object file to be fed straight into linking.
1281 Any file name with no recognized suffix is treated this way.
1282 @end table
1284 @opindex x
1285 You can specify the input language explicitly with the @option{-x} option:
1287 @table @gcctabopt
1288 @item -x @var{language}
1289 Specify explicitly the @var{language} for the following input files
1290 (rather than letting the compiler choose a default based on the file
1291 name suffix).  This option applies to all following input files until
1292 the next @option{-x} option.  Possible values for @var{language} are:
1293 @smallexample
1294 c  c-header  cpp-output
1295 c++  c++-header  c++-cpp-output
1296 objective-c  objective-c-header  objective-c-cpp-output
1297 objective-c++ objective-c++-header objective-c++-cpp-output
1298 assembler  assembler-with-cpp
1300 f77  f77-cpp-input f95  f95-cpp-input
1302 java
1303 @end smallexample
1305 @item -x none
1306 Turn off any specification of a language, so that subsequent files are
1307 handled according to their file name suffixes (as they are if @option{-x}
1308 has not been used at all).
1310 @item -pass-exit-codes
1311 @opindex pass-exit-codes
1312 Normally the @command{gcc} program exits with the code of 1 if any
1313 phase of the compiler returns a non-success return code.  If you specify
1314 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1315 the numerically highest error produced by any phase returning an error
1316 indication.  The C, C++, and Fortran front ends return 4 if an internal
1317 compiler error is encountered.
1318 @end table
1320 If you only want some of the stages of compilation, you can use
1321 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1322 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1323 @command{gcc} is to stop.  Note that some combinations (for example,
1324 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1326 @table @gcctabopt
1327 @item -c
1328 @opindex c
1329 Compile or assemble the source files, but do not link.  The linking
1330 stage simply is not done.  The ultimate output is in the form of an
1331 object file for each source file.
1333 By default, the object file name for a source file is made by replacing
1334 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1336 Unrecognized input files, not requiring compilation or assembly, are
1337 ignored.
1339 @item -S
1340 @opindex S
1341 Stop after the stage of compilation proper; do not assemble.  The output
1342 is in the form of an assembler code file for each non-assembler input
1343 file specified.
1345 By default, the assembler file name for a source file is made by
1346 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1348 Input files that don't require compilation are ignored.
1350 @item -E
1351 @opindex E
1352 Stop after the preprocessing stage; do not run the compiler proper.  The
1353 output is in the form of preprocessed source code, which is sent to the
1354 standard output.
1356 Input files that don't require preprocessing are ignored.
1358 @cindex output file option
1359 @item -o @var{file}
1360 @opindex o
1361 Place output in file @var{file}.  This applies to whatever
1362 sort of output is being produced, whether it be an executable file,
1363 an object file, an assembler file or preprocessed C code.
1365 If @option{-o} is not specified, the default is to put an executable
1366 file in @file{a.out}, the object file for
1367 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1368 assembler file in @file{@var{source}.s}, a precompiled header file in
1369 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1370 standard output.
1372 @item -v
1373 @opindex v
1374 Print (on standard error output) the commands executed to run the stages
1375 of compilation.  Also print the version number of the compiler driver
1376 program and of the preprocessor and the compiler proper.
1378 @item -###
1379 @opindex ###
1380 Like @option{-v} except the commands are not executed and arguments
1381 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1382 This is useful for shell scripts to capture the driver-generated command lines.
1384 @item -pipe
1385 @opindex pipe
1386 Use pipes rather than temporary files for communication between the
1387 various stages of compilation.  This fails to work on some systems where
1388 the assembler is unable to read from a pipe; but the GNU assembler has
1389 no trouble.
1391 @item --help
1392 @opindex help
1393 Print (on the standard output) a description of the command-line options
1394 understood by @command{gcc}.  If the @option{-v} option is also specified
1395 then @option{--help} is also passed on to the various processes
1396 invoked by @command{gcc}, so that they can display the command-line options
1397 they accept.  If the @option{-Wextra} option has also been specified
1398 (prior to the @option{--help} option), then command-line options that
1399 have no documentation associated with them are also displayed.
1401 @item --target-help
1402 @opindex target-help
1403 Print (on the standard output) a description of target-specific command-line
1404 options for each tool.  For some targets extra target-specific
1405 information may also be printed.
1407 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1408 Print (on the standard output) a description of the command-line
1409 options understood by the compiler that fit into all specified classes
1410 and qualifiers.  These are the supported classes:
1412 @table @asis
1413 @item @samp{optimizers}
1414 Display all of the optimization options supported by the
1415 compiler.
1417 @item @samp{warnings}
1418 Display all of the options controlling warning messages
1419 produced by the compiler.
1421 @item @samp{target}
1422 Display target-specific options.  Unlike the
1423 @option{--target-help} option however, target-specific options of the
1424 linker and assembler are not displayed.  This is because those
1425 tools do not currently support the extended @option{--help=} syntax.
1427 @item @samp{params}
1428 Display the values recognized by the @option{--param}
1429 option.
1431 @item @var{language}
1432 Display the options supported for @var{language}, where
1433 @var{language} is the name of one of the languages supported in this
1434 version of GCC@.
1436 @item @samp{common}
1437 Display the options that are common to all languages.
1438 @end table
1440 These are the supported qualifiers:
1442 @table @asis
1443 @item @samp{undocumented}
1444 Display only those options that are undocumented.
1446 @item @samp{joined}
1447 Display options taking an argument that appears after an equal
1448 sign in the same continuous piece of text, such as:
1449 @samp{--help=target}.
1451 @item @samp{separate}
1452 Display options taking an argument that appears as a separate word
1453 following the original option, such as: @samp{-o output-file}.
1454 @end table
1456 Thus for example to display all the undocumented target-specific
1457 switches supported by the compiler, use:
1459 @smallexample
1460 --help=target,undocumented
1461 @end smallexample
1463 The sense of a qualifier can be inverted by prefixing it with the
1464 @samp{^} character, so for example to display all binary warning
1465 options (i.e., ones that are either on or off and that do not take an
1466 argument) that have a description, use:
1468 @smallexample
1469 --help=warnings,^joined,^undocumented
1470 @end smallexample
1472 The argument to @option{--help=} should not consist solely of inverted
1473 qualifiers.
1475 Combining several classes is possible, although this usually
1476 restricts the output so much that there is nothing to display.  One
1477 case where it does work, however, is when one of the classes is
1478 @var{target}.  For example, to display all the target-specific
1479 optimization options, use:
1481 @smallexample
1482 --help=target,optimizers
1483 @end smallexample
1485 The @option{--help=} option can be repeated on the command line.  Each
1486 successive use displays its requested class of options, skipping
1487 those that have already been displayed.
1489 If the @option{-Q} option appears on the command line before the
1490 @option{--help=} option, then the descriptive text displayed by
1491 @option{--help=} is changed.  Instead of describing the displayed
1492 options, an indication is given as to whether the option is enabled,
1493 disabled or set to a specific value (assuming that the compiler
1494 knows this at the point where the @option{--help=} option is used).
1496 Here is a truncated example from the ARM port of @command{gcc}:
1498 @smallexample
1499   % gcc -Q -mabi=2 --help=target -c
1500   The following options are target specific:
1501   -mabi=                                2
1502   -mabort-on-noreturn                   [disabled]
1503   -mapcs                                [disabled]
1504 @end smallexample
1506 The output is sensitive to the effects of previous command-line
1507 options, so for example it is possible to find out which optimizations
1508 are enabled at @option{-O2} by using:
1510 @smallexample
1511 -Q -O2 --help=optimizers
1512 @end smallexample
1514 Alternatively you can discover which binary optimizations are enabled
1515 by @option{-O3} by using:
1517 @smallexample
1518 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1519 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1520 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1521 @end smallexample
1523 @item -no-canonical-prefixes
1524 @opindex no-canonical-prefixes
1525 Do not expand any symbolic links, resolve references to @samp{/../}
1526 or @samp{/./}, or make the path absolute when generating a relative
1527 prefix.
1529 @item --version
1530 @opindex version
1531 Display the version number and copyrights of the invoked GCC@.
1533 @item -wrapper
1534 @opindex wrapper
1535 Invoke all subcommands under a wrapper program.  The name of the
1536 wrapper program and its parameters are passed as a comma separated
1537 list.
1539 @smallexample
1540 gcc -c t.c -wrapper gdb,--args
1541 @end smallexample
1543 @noindent
1544 This invokes all subprograms of @command{gcc} under
1545 @samp{gdb --args}, thus the invocation of @command{cc1} is
1546 @samp{gdb --args cc1 @dots{}}.
1548 @item -fplugin=@var{name}.so
1549 @opindex fplugin
1550 Load the plugin code in file @var{name}.so, assumed to be a
1551 shared object to be dlopen'd by the compiler.  The base name of
1552 the shared object file is used to identify the plugin for the
1553 purposes of argument parsing (See
1554 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1555 Each plugin should define the callback functions specified in the
1556 Plugins API.
1558 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1559 @opindex fplugin-arg
1560 Define an argument called @var{key} with a value of @var{value}
1561 for the plugin called @var{name}.
1563 @item -fdump-ada-spec@r{[}-slim@r{]}
1564 @opindex fdump-ada-spec
1565 For C and C++ source and include files, generate corresponding Ada specs.
1566 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1567 GNAT User's Guide}, which provides detailed documentation on this feature.
1569 @item -fada-spec-parent=@var{unit}
1570 @opindex fada-spec-parent
1571 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1572 Ada specs as child units of parent @var{unit}.
1574 @item -fdump-go-spec=@var{file}
1575 @opindex fdump-go-spec
1576 For input files in any language, generate corresponding Go
1577 declarations in @var{file}.  This generates Go @code{const},
1578 @code{type}, @code{var}, and @code{func} declarations which may be a
1579 useful way to start writing a Go interface to code written in some
1580 other language.
1582 @include @value{srcdir}/../libiberty/at-file.texi
1583 @end table
1585 @node Invoking G++
1586 @section Compiling C++ Programs
1588 @cindex suffixes for C++ source
1589 @cindex C++ source file suffixes
1590 C++ source files conventionally use one of the suffixes @samp{.C},
1591 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1592 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1593 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1594 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1595 files with these names and compiles them as C++ programs even if you
1596 call the compiler the same way as for compiling C programs (usually
1597 with the name @command{gcc}).
1599 @findex g++
1600 @findex c++
1601 However, the use of @command{gcc} does not add the C++ library.
1602 @command{g++} is a program that calls GCC and automatically specifies linking
1603 against the C++ library.  It treats @samp{.c},
1604 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1605 files unless @option{-x} is used.  This program is also useful when
1606 precompiling a C header file with a @samp{.h} extension for use in C++
1607 compilations.  On many systems, @command{g++} is also installed with
1608 the name @command{c++}.
1610 @cindex invoking @command{g++}
1611 When you compile C++ programs, you may specify many of the same
1612 command-line options that you use for compiling programs in any
1613 language; or command-line options meaningful for C and related
1614 languages; or options that are meaningful only for C++ programs.
1615 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1616 explanations of options for languages related to C@.
1617 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1618 explanations of options that are meaningful only for C++ programs.
1620 @node C Dialect Options
1621 @section Options Controlling C Dialect
1622 @cindex dialect options
1623 @cindex language dialect options
1624 @cindex options, dialect
1626 The following options control the dialect of C (or languages derived
1627 from C, such as C++, Objective-C and Objective-C++) that the compiler
1628 accepts:
1630 @table @gcctabopt
1631 @cindex ANSI support
1632 @cindex ISO support
1633 @item -ansi
1634 @opindex ansi
1635 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1636 equivalent to @option{-std=c++98}.
1638 This turns off certain features of GCC that are incompatible with ISO
1639 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1640 such as the @code{asm} and @code{typeof} keywords, and
1641 predefined macros such as @code{unix} and @code{vax} that identify the
1642 type of system you are using.  It also enables the undesirable and
1643 rarely used ISO trigraph feature.  For the C compiler,
1644 it disables recognition of C++ style @samp{//} comments as well as
1645 the @code{inline} keyword.
1647 The alternate keywords @code{__asm__}, @code{__extension__},
1648 @code{__inline__} and @code{__typeof__} continue to work despite
1649 @option{-ansi}.  You would not want to use them in an ISO C program, of
1650 course, but it is useful to put them in header files that might be included
1651 in compilations done with @option{-ansi}.  Alternate predefined macros
1652 such as @code{__unix__} and @code{__vax__} are also available, with or
1653 without @option{-ansi}.
1655 The @option{-ansi} option does not cause non-ISO programs to be
1656 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1657 addition to @option{-ansi}.  @xref{Warning Options}.
1659 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1660 option is used.  Some header files may notice this macro and refrain
1661 from declaring certain functions or defining certain macros that the
1662 ISO standard doesn't call for; this is to avoid interfering with any
1663 programs that might use these names for other things.
1665 Functions that are normally built in but do not have semantics
1666 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1667 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1668 built-in functions provided by GCC}, for details of the functions
1669 affected.
1671 @item -std=
1672 @opindex std
1673 Determine the language standard. @xref{Standards,,Language Standards
1674 Supported by GCC}, for details of these standard versions.  This option
1675 is currently only supported when compiling C or C++.
1677 The compiler can accept several base standards, such as @samp{c90} or
1678 @samp{c++98}, and GNU dialects of those standards, such as
1679 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1680 compiler accepts all programs following that standard plus those
1681 using GNU extensions that do not contradict it.  For example,
1682 @option{-std=c90} turns off certain features of GCC that are
1683 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1684 keywords, but not other GNU extensions that do not have a meaning in
1685 ISO C90, such as omitting the middle term of a @code{?:}
1686 expression. On the other hand, when a GNU dialect of a standard is
1687 specified, all features supported by the compiler are enabled, even when
1688 those features change the meaning of the base standard.  As a result, some
1689 strict-conforming programs may be rejected.  The particular standard
1690 is used by @option{-Wpedantic} to identify which features are GNU
1691 extensions given that version of the standard. For example
1692 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1693 comments, while @option{-std=gnu99 -Wpedantic} does not.
1695 A value for this option must be provided; possible values are
1697 @table @samp
1698 @item c90
1699 @itemx c89
1700 @itemx iso9899:1990
1701 Support all ISO C90 programs (certain GNU extensions that conflict
1702 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1704 @item iso9899:199409
1705 ISO C90 as modified in amendment 1.
1707 @item c99
1708 @itemx c9x
1709 @itemx iso9899:1999
1710 @itemx iso9899:199x
1711 ISO C99.  This standard is substantially completely supported, modulo
1712 bugs and floating-point issues
1713 (mainly but not entirely relating to optional C99 features from
1714 Annexes F and G).  See
1715 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1716 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1718 @item c11
1719 @itemx c1x
1720 @itemx iso9899:2011
1721 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1722 substantially completely supported, modulo bugs, floating-point issues
1723 (mainly but not entirely relating to optional C11 features from
1724 Annexes F and G) and the optional Annexes K (Bounds-checking
1725 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1727 @item gnu90
1728 @itemx gnu89
1729 GNU dialect of ISO C90 (including some C99 features).
1731 @item gnu99
1732 @itemx gnu9x
1733 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1735 @item gnu11
1736 @itemx gnu1x
1737 GNU dialect of ISO C11.  This is the default for C code.
1738 The name @samp{gnu1x} is deprecated.
1740 @item c++98
1741 @itemx c++03
1742 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1743 additional defect reports. Same as @option{-ansi} for C++ code.
1745 @item gnu++98
1746 @itemx gnu++03
1747 GNU dialect of @option{-std=c++98}.  This is the default for
1748 C++ code.
1750 @item c++11
1751 @itemx c++0x
1752 The 2011 ISO C++ standard plus amendments.
1753 The name @samp{c++0x} is deprecated.
1755 @item gnu++11
1756 @itemx gnu++0x
1757 GNU dialect of @option{-std=c++11}.
1758 The name @samp{gnu++0x} is deprecated.
1760 @item c++14
1761 @itemx c++1y
1762 The 2014 ISO C++ standard plus amendments.
1763 The name @samp{c++1y} is deprecated.
1765 @item gnu++14
1766 @itemx gnu++1y
1767 GNU dialect of @option{-std=c++14}.
1768 The name @samp{gnu++1y} is deprecated.
1770 @item c++1z
1771 The next revision of the ISO C++ standard, tentatively planned for
1772 2017.  Support is highly experimental, and will almost certainly
1773 change in incompatible ways in future releases.
1775 @item gnu++1z
1776 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1777 and will almost certainly change in incompatible ways in future
1778 releases.
1779 @end table
1781 @item -fgnu89-inline
1782 @opindex fgnu89-inline
1783 The option @option{-fgnu89-inline} tells GCC to use the traditional
1784 GNU semantics for @code{inline} functions when in C99 mode.
1785 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1786 Using this option is roughly equivalent to adding the
1787 @code{gnu_inline} function attribute to all inline functions
1788 (@pxref{Function Attributes}).
1790 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1791 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1792 specifies the default behavior).
1793 This option is not supported in @option{-std=c90} or
1794 @option{-std=gnu90} mode.
1796 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1797 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1798 in effect for @code{inline} functions.  @xref{Common Predefined
1799 Macros,,,cpp,The C Preprocessor}.
1801 @item -aux-info @var{filename}
1802 @opindex aux-info
1803 Output to the given filename prototyped declarations for all functions
1804 declared and/or defined in a translation unit, including those in header
1805 files.  This option is silently ignored in any language other than C@.
1807 Besides declarations, the file indicates, in comments, the origin of
1808 each declaration (source file and line), whether the declaration was
1809 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1810 @samp{O} for old, respectively, in the first character after the line
1811 number and the colon), and whether it came from a declaration or a
1812 definition (@samp{C} or @samp{F}, respectively, in the following
1813 character).  In the case of function definitions, a K&R-style list of
1814 arguments followed by their declarations is also provided, inside
1815 comments, after the declaration.
1817 @item -fallow-parameterless-variadic-functions
1818 @opindex fallow-parameterless-variadic-functions
1819 Accept variadic functions without named parameters.
1821 Although it is possible to define such a function, this is not very
1822 useful as it is not possible to read the arguments.  This is only
1823 supported for C as this construct is allowed by C++.
1825 @item -fno-asm
1826 @opindex fno-asm
1827 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1828 keyword, so that code can use these words as identifiers.  You can use
1829 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1830 instead.  @option{-ansi} implies @option{-fno-asm}.
1832 In C++, this switch only affects the @code{typeof} keyword, since
1833 @code{asm} and @code{inline} are standard keywords.  You may want to
1834 use the @option{-fno-gnu-keywords} flag instead, which has the same
1835 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1836 switch only affects the @code{asm} and @code{typeof} keywords, since
1837 @code{inline} is a standard keyword in ISO C99.
1839 @item -fno-builtin
1840 @itemx -fno-builtin-@var{function}
1841 @opindex fno-builtin
1842 @cindex built-in functions
1843 Don't recognize built-in functions that do not begin with
1844 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1845 functions provided by GCC}, for details of the functions affected,
1846 including those which are not built-in functions when @option{-ansi} or
1847 @option{-std} options for strict ISO C conformance are used because they
1848 do not have an ISO standard meaning.
1850 GCC normally generates special code to handle certain built-in functions
1851 more efficiently; for instance, calls to @code{alloca} may become single
1852 instructions which adjust the stack directly, and calls to @code{memcpy}
1853 may become inline copy loops.  The resulting code is often both smaller
1854 and faster, but since the function calls no longer appear as such, you
1855 cannot set a breakpoint on those calls, nor can you change the behavior
1856 of the functions by linking with a different library.  In addition,
1857 when a function is recognized as a built-in function, GCC may use
1858 information about that function to warn about problems with calls to
1859 that function, or to generate more efficient code, even if the
1860 resulting code still contains calls to that function.  For example,
1861 warnings are given with @option{-Wformat} for bad calls to
1862 @code{printf} when @code{printf} is built in and @code{strlen} is
1863 known not to modify global memory.
1865 With the @option{-fno-builtin-@var{function}} option
1866 only the built-in function @var{function} is
1867 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1868 function is named that is not built-in in this version of GCC, this
1869 option is ignored.  There is no corresponding
1870 @option{-fbuiltin-@var{function}} option; if you wish to enable
1871 built-in functions selectively when using @option{-fno-builtin} or
1872 @option{-ffreestanding}, you may define macros such as:
1874 @smallexample
1875 #define abs(n)          __builtin_abs ((n))
1876 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1877 @end smallexample
1879 @item -fhosted
1880 @opindex fhosted
1881 @cindex hosted environment
1883 Assert that compilation targets a hosted environment.  This implies
1884 @option{-fbuiltin}.  A hosted environment is one in which the
1885 entire standard library is available, and in which @code{main} has a return
1886 type of @code{int}.  Examples are nearly everything except a kernel.
1887 This is equivalent to @option{-fno-freestanding}.
1889 @item -ffreestanding
1890 @opindex ffreestanding
1891 @cindex hosted environment
1893 Assert that compilation targets a freestanding environment.  This
1894 implies @option{-fno-builtin}.  A freestanding environment
1895 is one in which the standard library may not exist, and program startup may
1896 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1897 This is equivalent to @option{-fno-hosted}.
1899 @xref{Standards,,Language Standards Supported by GCC}, for details of
1900 freestanding and hosted environments.
1902 @item -fopenacc
1903 @opindex fopenacc
1904 @cindex OpenACC accelerator programming
1905 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1906 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1907 compiler generates accelerated code according to the OpenACC Application
1908 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1909 implies @option{-pthread}, and thus is only supported on targets that
1910 have support for @option{-pthread}.
1912 Note that this is an experimental feature, incomplete, and subject to
1913 change in future versions of GCC.  See
1914 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
1916 @item -fopenmp
1917 @opindex fopenmp
1918 @cindex OpenMP parallel
1919 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1920 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1921 compiler generates parallel code according to the OpenMP Application
1922 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1923 implies @option{-pthread}, and thus is only supported on targets that
1924 have support for @option{-pthread}. @option{-fopenmp} implies
1925 @option{-fopenmp-simd}.
1927 @item -fopenmp-simd
1928 @opindex fopenmp-simd
1929 @cindex OpenMP SIMD
1930 @cindex SIMD
1931 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1932 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1933 are ignored.
1935 @item -fcilkplus
1936 @opindex fcilkplus
1937 @cindex Enable Cilk Plus
1938 Enable the usage of Cilk Plus language extension features for C/C++.
1939 When the option @option{-fcilkplus} is specified, enable the usage of
1940 the Cilk Plus Language extension features for C/C++.  The present
1941 implementation follows ABI version 1.2.  This is an experimental
1942 feature that is only partially complete, and whose interface may
1943 change in future versions of GCC as the official specification
1944 changes.  Currently, all features but @code{_Cilk_for} have been
1945 implemented.
1947 @item -fgnu-tm
1948 @opindex fgnu-tm
1949 When the option @option{-fgnu-tm} is specified, the compiler
1950 generates code for the Linux variant of Intel's current Transactional
1951 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1952 an experimental feature whose interface may change in future versions
1953 of GCC, as the official specification changes.  Please note that not
1954 all architectures are supported for this feature.
1956 For more information on GCC's support for transactional memory,
1957 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1958 Transactional Memory Library}.
1960 Note that the transactional memory feature is not supported with
1961 non-call exceptions (@option{-fnon-call-exceptions}).
1963 @item -fms-extensions
1964 @opindex fms-extensions
1965 Accept some non-standard constructs used in Microsoft header files.
1967 In C++ code, this allows member names in structures to be similar
1968 to previous types declarations.
1970 @smallexample
1971 typedef int UOW;
1972 struct ABC @{
1973   UOW UOW;
1975 @end smallexample
1977 Some cases of unnamed fields in structures and unions are only
1978 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1979 fields within structs/unions}, for details.
1981 Note that this option is off for all targets but x86 
1982 targets using ms-abi.
1984 @item -fplan9-extensions
1985 @opindex fplan9-extensions
1986 Accept some non-standard constructs used in Plan 9 code.
1988 This enables @option{-fms-extensions}, permits passing pointers to
1989 structures with anonymous fields to functions that expect pointers to
1990 elements of the type of the field, and permits referring to anonymous
1991 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1992 struct/union fields within structs/unions}, for details.  This is only
1993 supported for C, not C++.
1995 @item -trigraphs
1996 @opindex trigraphs
1997 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1998 options for strict ISO C conformance) implies @option{-trigraphs}.
2000 @cindex traditional C language
2001 @cindex C language, traditional
2002 @item -traditional
2003 @itemx -traditional-cpp
2004 @opindex traditional-cpp
2005 @opindex traditional
2006 Formerly, these options caused GCC to attempt to emulate a pre-standard
2007 C compiler.  They are now only supported with the @option{-E} switch.
2008 The preprocessor continues to support a pre-standard mode.  See the GNU
2009 CPP manual for details.
2011 @item -fcond-mismatch
2012 @opindex fcond-mismatch
2013 Allow conditional expressions with mismatched types in the second and
2014 third arguments.  The value of such an expression is void.  This option
2015 is not supported for C++.
2017 @item -flax-vector-conversions
2018 @opindex flax-vector-conversions
2019 Allow implicit conversions between vectors with differing numbers of
2020 elements and/or incompatible element types.  This option should not be
2021 used for new code.
2023 @item -funsigned-char
2024 @opindex funsigned-char
2025 Let the type @code{char} be unsigned, like @code{unsigned char}.
2027 Each kind of machine has a default for what @code{char} should
2028 be.  It is either like @code{unsigned char} by default or like
2029 @code{signed char} by default.
2031 Ideally, a portable program should always use @code{signed char} or
2032 @code{unsigned char} when it depends on the signedness of an object.
2033 But many programs have been written to use plain @code{char} and
2034 expect it to be signed, or expect it to be unsigned, depending on the
2035 machines they were written for.  This option, and its inverse, let you
2036 make such a program work with the opposite default.
2038 The type @code{char} is always a distinct type from each of
2039 @code{signed char} or @code{unsigned char}, even though its behavior
2040 is always just like one of those two.
2042 @item -fsigned-char
2043 @opindex fsigned-char
2044 Let the type @code{char} be signed, like @code{signed char}.
2046 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2047 the negative form of @option{-funsigned-char}.  Likewise, the option
2048 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2050 @item -fsigned-bitfields
2051 @itemx -funsigned-bitfields
2052 @itemx -fno-signed-bitfields
2053 @itemx -fno-unsigned-bitfields
2054 @opindex fsigned-bitfields
2055 @opindex funsigned-bitfields
2056 @opindex fno-signed-bitfields
2057 @opindex fno-unsigned-bitfields
2058 These options control whether a bit-field is signed or unsigned, when the
2059 declaration does not use either @code{signed} or @code{unsigned}.  By
2060 default, such a bit-field is signed, because this is consistent: the
2061 basic integer types such as @code{int} are signed types.
2062 @end table
2064 @node C++ Dialect Options
2065 @section Options Controlling C++ Dialect
2067 @cindex compiler options, C++
2068 @cindex C++ options, command-line
2069 @cindex options, C++
2070 This section describes the command-line options that are only meaningful
2071 for C++ programs.  You can also use most of the GNU compiler options
2072 regardless of what language your program is in.  For example, you
2073 might compile a file @file{firstClass.C} like this:
2075 @smallexample
2076 g++ -g -frepo -O -c firstClass.C
2077 @end smallexample
2079 @noindent
2080 In this example, only @option{-frepo} is an option meant
2081 only for C++ programs; you can use the other options with any
2082 language supported by GCC@.
2084 Here is a list of options that are @emph{only} for compiling C++ programs:
2086 @table @gcctabopt
2088 @item -fabi-version=@var{n}
2089 @opindex fabi-version
2090 Use version @var{n} of the C++ ABI@.  The default is version 0.
2092 Version 0 refers to the version conforming most closely to
2093 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2094 will change in different versions of G++ as ABI bugs are fixed.
2096 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2098 Version 2 is the version of the C++ ABI that first appeared in G++
2099 3.4, and was the default through G++ 4.9.
2101 Version 3 corrects an error in mangling a constant address as a
2102 template argument.
2104 Version 4, which first appeared in G++ 4.5, implements a standard
2105 mangling for vector types.
2107 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2108 attribute const/volatile on function pointer types, decltype of a
2109 plain decl, and use of a function parameter in the declaration of
2110 another parameter.
2112 Version 6, which first appeared in G++ 4.7, corrects the promotion
2113 behavior of C++11 scoped enums and the mangling of template argument
2114 packs, const/static_cast, prefix ++ and --, and a class scope function
2115 used as a template argument.
2117 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2118 builtin type and corrects the mangling of lambdas in default argument
2119 scope.
2121 Version 8, which first appeared in G++ 4.9, corrects the substitution
2122 behavior of function types with function-cv-qualifiers.
2124 See also @option{-Wabi}.
2126 @item -fabi-compat-version=@var{n}
2127 @opindex fabi-compat-version
2128 On targets that support strong aliases, G++
2129 works around mangling changes by creating an alias with the correct
2130 mangled name when defining a symbol with an incorrect mangled name.
2131 This switch specifies which ABI version to use for the alias.
2133 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2134 another ABI version is explicitly selected, this defaults to 0.
2136 The compatibility version is also set by @option{-Wabi=@var{n}}.
2138 @item -fno-access-control
2139 @opindex fno-access-control
2140 Turn off all access checking.  This switch is mainly useful for working
2141 around bugs in the access control code.
2143 @item -fcheck-new
2144 @opindex fcheck-new
2145 Check that the pointer returned by @code{operator new} is non-null
2146 before attempting to modify the storage allocated.  This check is
2147 normally unnecessary because the C++ standard specifies that
2148 @code{operator new} only returns @code{0} if it is declared
2149 @code{throw()}, in which case the compiler always checks the
2150 return value even without this option.  In all other cases, when
2151 @code{operator new} has a non-empty exception specification, memory
2152 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2153 @samp{new (nothrow)}.
2155 @item -fconstexpr-depth=@var{n}
2156 @opindex fconstexpr-depth
2157 Set the maximum nested evaluation depth for C++11 constexpr functions
2158 to @var{n}.  A limit is needed to detect endless recursion during
2159 constant expression evaluation.  The minimum specified by the standard
2160 is 512.
2162 @item -fdeduce-init-list
2163 @opindex fdeduce-init-list
2164 Enable deduction of a template type parameter as
2165 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2167 @smallexample
2168 template <class T> auto forward(T t) -> decltype (realfn (t))
2170   return realfn (t);
2173 void f()
2175   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2177 @end smallexample
2179 This deduction was implemented as a possible extension to the
2180 originally proposed semantics for the C++11 standard, but was not part
2181 of the final standard, so it is disabled by default.  This option is
2182 deprecated, and may be removed in a future version of G++.
2184 @item -ffriend-injection
2185 @opindex ffriend-injection
2186 Inject friend functions into the enclosing namespace, so that they are
2187 visible outside the scope of the class in which they are declared.
2188 Friend functions were documented to work this way in the old Annotated
2189 C++ Reference Manual.  
2190 However, in ISO C++ a friend function that is not declared
2191 in an enclosing scope can only be found using argument dependent
2192 lookup.  GCC defaults to the standard behavior.
2194 This option is for compatibility, and may be removed in a future
2195 release of G++.
2197 @item -fno-elide-constructors
2198 @opindex fno-elide-constructors
2199 The C++ standard allows an implementation to omit creating a temporary
2200 that is only used to initialize another object of the same type.
2201 Specifying this option disables that optimization, and forces G++ to
2202 call the copy constructor in all cases.
2204 @item -fno-enforce-eh-specs
2205 @opindex fno-enforce-eh-specs
2206 Don't generate code to check for violation of exception specifications
2207 at run time.  This option violates the C++ standard, but may be useful
2208 for reducing code size in production builds, much like defining
2209 @code{NDEBUG}.  This does not give user code permission to throw
2210 exceptions in violation of the exception specifications; the compiler
2211 still optimizes based on the specifications, so throwing an
2212 unexpected exception results in undefined behavior at run time.
2214 @item -fextern-tls-init
2215 @itemx -fno-extern-tls-init
2216 @opindex fextern-tls-init
2217 @opindex fno-extern-tls-init
2218 The C++11 and OpenMP standards allow @code{thread_local} and
2219 @code{threadprivate} variables to have dynamic (runtime)
2220 initialization.  To support this, any use of such a variable goes
2221 through a wrapper function that performs any necessary initialization.
2222 When the use and definition of the variable are in the same
2223 translation unit, this overhead can be optimized away, but when the
2224 use is in a different translation unit there is significant overhead
2225 even if the variable doesn't actually need dynamic initialization.  If
2226 the programmer can be sure that no use of the variable in a
2227 non-defining TU needs to trigger dynamic initialization (either
2228 because the variable is statically initialized, or a use of the
2229 variable in the defining TU will be executed before any uses in
2230 another TU), they can avoid this overhead with the
2231 @option{-fno-extern-tls-init} option.
2233 On targets that support symbol aliases, the default is
2234 @option{-fextern-tls-init}.  On targets that do not support symbol
2235 aliases, the default is @option{-fno-extern-tls-init}.
2237 @item -ffor-scope
2238 @itemx -fno-for-scope
2239 @opindex ffor-scope
2240 @opindex fno-for-scope
2241 If @option{-ffor-scope} is specified, the scope of variables declared in
2242 a @i{for-init-statement} is limited to the @code{for} loop itself,
2243 as specified by the C++ standard.
2244 If @option{-fno-for-scope} is specified, the scope of variables declared in
2245 a @i{for-init-statement} extends to the end of the enclosing scope,
2246 as was the case in old versions of G++, and other (traditional)
2247 implementations of C++.
2249 If neither flag is given, the default is to follow the standard,
2250 but to allow and give a warning for old-style code that would
2251 otherwise be invalid, or have different behavior.
2253 @item -fno-gnu-keywords
2254 @opindex fno-gnu-keywords
2255 Do not recognize @code{typeof} as a keyword, so that code can use this
2256 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2257 @option{-ansi} implies @option{-fno-gnu-keywords}.
2259 @item -fno-implicit-templates
2260 @opindex fno-implicit-templates
2261 Never emit code for non-inline templates that are instantiated
2262 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2263 @xref{Template Instantiation}, for more information.
2265 @item -fno-implicit-inline-templates
2266 @opindex fno-implicit-inline-templates
2267 Don't emit code for implicit instantiations of inline templates, either.
2268 The default is to handle inlines differently so that compiles with and
2269 without optimization need the same set of explicit instantiations.
2271 @item -fno-implement-inlines
2272 @opindex fno-implement-inlines
2273 To save space, do not emit out-of-line copies of inline functions
2274 controlled by @code{#pragma implementation}.  This causes linker
2275 errors if these functions are not inlined everywhere they are called.
2277 @item -fms-extensions
2278 @opindex fms-extensions
2279 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2280 int and getting a pointer to member function via non-standard syntax.
2282 @item -fno-nonansi-builtins
2283 @opindex fno-nonansi-builtins
2284 Disable built-in declarations of functions that are not mandated by
2285 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2286 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2288 @item -fnothrow-opt
2289 @opindex fnothrow-opt
2290 Treat a @code{throw()} exception specification as if it were a
2291 @code{noexcept} specification to reduce or eliminate the text size
2292 overhead relative to a function with no exception specification.  If
2293 the function has local variables of types with non-trivial
2294 destructors, the exception specification actually makes the
2295 function smaller because the EH cleanups for those variables can be
2296 optimized away.  The semantic effect is that an exception thrown out of
2297 a function with such an exception specification results in a call
2298 to @code{terminate} rather than @code{unexpected}.
2300 @item -fno-operator-names
2301 @opindex fno-operator-names
2302 Do not treat the operator name keywords @code{and}, @code{bitand},
2303 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2304 synonyms as keywords.
2306 @item -fno-optional-diags
2307 @opindex fno-optional-diags
2308 Disable diagnostics that the standard says a compiler does not need to
2309 issue.  Currently, the only such diagnostic issued by G++ is the one for
2310 a name having multiple meanings within a class.
2312 @item -fpermissive
2313 @opindex fpermissive
2314 Downgrade some diagnostics about nonconformant code from errors to
2315 warnings.  Thus, using @option{-fpermissive} allows some
2316 nonconforming code to compile.
2318 @item -fno-pretty-templates
2319 @opindex fno-pretty-templates
2320 When an error message refers to a specialization of a function
2321 template, the compiler normally prints the signature of the
2322 template followed by the template arguments and any typedefs or
2323 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2324 rather than @code{void f(int)}) so that it's clear which template is
2325 involved.  When an error message refers to a specialization of a class
2326 template, the compiler omits any template arguments that match
2327 the default template arguments for that template.  If either of these
2328 behaviors make it harder to understand the error message rather than
2329 easier, you can use @option{-fno-pretty-templates} to disable them.
2331 @item -frepo
2332 @opindex frepo
2333 Enable automatic template instantiation at link time.  This option also
2334 implies @option{-fno-implicit-templates}.  @xref{Template
2335 Instantiation}, for more information.
2337 @item -fno-rtti
2338 @opindex fno-rtti
2339 Disable generation of information about every class with virtual
2340 functions for use by the C++ run-time type identification features
2341 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2342 of the language, you can save some space by using this flag.  Note that
2343 exception handling uses the same information, but G++ generates it as
2344 needed. The @code{dynamic_cast} operator can still be used for casts that
2345 do not require run-time type information, i.e.@: casts to @code{void *} or to
2346 unambiguous base classes.
2348 @item -fsized-deallocation
2349 @opindex fsized-deallocation
2350 Enable the built-in global declarations
2351 @smallexample
2352 void operator delete (void *, std::size_t) noexcept;
2353 void operator delete[] (void *, std::size_t) noexcept;
2354 @end smallexample
2355 as introduced in C++14.  This is useful for user-defined replacement
2356 deallocation functions that, for example, use the size of the object
2357 to make deallocation faster.  Enabled by default under
2358 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2359 warns about places that might want to add a definition.
2361 @item -fstats
2362 @opindex fstats
2363 Emit statistics about front-end processing at the end of the compilation.
2364 This information is generally only useful to the G++ development team.
2366 @item -fstrict-enums
2367 @opindex fstrict-enums
2368 Allow the compiler to optimize using the assumption that a value of
2369 enumerated type can only be one of the values of the enumeration (as
2370 defined in the C++ standard; basically, a value that can be
2371 represented in the minimum number of bits needed to represent all the
2372 enumerators).  This assumption may not be valid if the program uses a
2373 cast to convert an arbitrary integer value to the enumerated type.
2375 @item -ftemplate-backtrace-limit=@var{n}
2376 @opindex ftemplate-backtrace-limit
2377 Set the maximum number of template instantiation notes for a single
2378 warning or error to @var{n}.  The default value is 10.
2380 @item -ftemplate-depth=@var{n}
2381 @opindex ftemplate-depth
2382 Set the maximum instantiation depth for template classes to @var{n}.
2383 A limit on the template instantiation depth is needed to detect
2384 endless recursions during template class instantiation.  ANSI/ISO C++
2385 conforming programs must not rely on a maximum depth greater than 17
2386 (changed to 1024 in C++11).  The default value is 900, as the compiler
2387 can run out of stack space before hitting 1024 in some situations.
2389 @item -fno-threadsafe-statics
2390 @opindex fno-threadsafe-statics
2391 Do not emit the extra code to use the routines specified in the C++
2392 ABI for thread-safe initialization of local statics.  You can use this
2393 option to reduce code size slightly in code that doesn't need to be
2394 thread-safe.
2396 @item -fuse-cxa-atexit
2397 @opindex fuse-cxa-atexit
2398 Register destructors for objects with static storage duration with the
2399 @code{__cxa_atexit} function rather than the @code{atexit} function.
2400 This option is required for fully standards-compliant handling of static
2401 destructors, but only works if your C library supports
2402 @code{__cxa_atexit}.
2404 @item -fno-use-cxa-get-exception-ptr
2405 @opindex fno-use-cxa-get-exception-ptr
2406 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2407 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2408 if the runtime routine is not available.
2410 @item -fvisibility-inlines-hidden
2411 @opindex fvisibility-inlines-hidden
2412 This switch declares that the user does not attempt to compare
2413 pointers to inline functions or methods where the addresses of the two functions
2414 are taken in different shared objects.
2416 The effect of this is that GCC may, effectively, mark inline methods with
2417 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2418 appear in the export table of a DSO and do not require a PLT indirection
2419 when used within the DSO@.  Enabling this option can have a dramatic effect
2420 on load and link times of a DSO as it massively reduces the size of the
2421 dynamic export table when the library makes heavy use of templates.
2423 The behavior of this switch is not quite the same as marking the
2424 methods as hidden directly, because it does not affect static variables
2425 local to the function or cause the compiler to deduce that
2426 the function is defined in only one shared object.
2428 You may mark a method as having a visibility explicitly to negate the
2429 effect of the switch for that method.  For example, if you do want to
2430 compare pointers to a particular inline method, you might mark it as
2431 having default visibility.  Marking the enclosing class with explicit
2432 visibility has no effect.
2434 Explicitly instantiated inline methods are unaffected by this option
2435 as their linkage might otherwise cross a shared library boundary.
2436 @xref{Template Instantiation}.
2438 @item -fvisibility-ms-compat
2439 @opindex fvisibility-ms-compat
2440 This flag attempts to use visibility settings to make GCC's C++
2441 linkage model compatible with that of Microsoft Visual Studio.
2443 The flag makes these changes to GCC's linkage model:
2445 @enumerate
2446 @item
2447 It sets the default visibility to @code{hidden}, like
2448 @option{-fvisibility=hidden}.
2450 @item
2451 Types, but not their members, are not hidden by default.
2453 @item
2454 The One Definition Rule is relaxed for types without explicit
2455 visibility specifications that are defined in more than one
2456 shared object: those declarations are permitted if they are
2457 permitted when this option is not used.
2458 @end enumerate
2460 In new code it is better to use @option{-fvisibility=hidden} and
2461 export those classes that are intended to be externally visible.
2462 Unfortunately it is possible for code to rely, perhaps accidentally,
2463 on the Visual Studio behavior.
2465 Among the consequences of these changes are that static data members
2466 of the same type with the same name but defined in different shared
2467 objects are different, so changing one does not change the other;
2468 and that pointers to function members defined in different shared
2469 objects may not compare equal.  When this flag is given, it is a
2470 violation of the ODR to define types with the same name differently.
2472 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
2473 @opindex fvtable-verify
2474 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2475 feature that verifies at run time, for every virtual call, that
2476 the vtable pointer through which the call is made is valid for the type of
2477 the object, and has not been corrupted or overwritten.  If an invalid vtable
2478 pointer is detected at run time, an error is reported and execution of the
2479 program is immediately halted.
2481 This option causes run-time data structures to be built at program startup,
2482 which are used for verifying the vtable pointers.  
2483 The options @samp{std} and @samp{preinit}
2484 control the timing of when these data structures are built.  In both cases the
2485 data structures are built before execution reaches @code{main}.  Using
2486 @option{-fvtable-verify=std} causes the data structures to be built after
2487 shared libraries have been loaded and initialized.
2488 @option{-fvtable-verify=preinit} causes them to be built before shared
2489 libraries have been loaded and initialized.
2491 If this option appears multiple times in the command line with different
2492 values specified, @samp{none} takes highest priority over both @samp{std} and
2493 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
2495 @item -fvtv-debug
2496 @opindex fvtv-debug
2497 When used in conjunction with @option{-fvtable-verify=std} or 
2498 @option{-fvtable-verify=preinit}, causes debug versions of the 
2499 runtime functions for the vtable verification feature to be called.  
2500 This flag also causes the compiler to log information about which 
2501 vtable pointers it finds for each class.
2502 This information is written to a file named @file{vtv_set_ptr_data.log} 
2503 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
2504 if that is defined or the current working directory otherwise.
2506 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
2507 file, be sure to delete any existing one.
2509 @item -fvtv-counts
2510 @opindex fvtv-counts
2511 This is a debugging flag.  When used in conjunction with
2512 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2513 causes the compiler to keep track of the total number of virtual calls
2514 it encounters and the number of verifications it inserts.  It also
2515 counts the number of calls to certain run-time library functions
2516 that it inserts and logs this information for each compilation unit.
2517 The compiler writes this information to a file named
2518 @file{vtv_count_data.log} in the directory named by the environment
2519 variable @env{VTV_LOGS_DIR} if that is defined or the current working
2520 directory otherwise.  It also counts the size of the vtable pointer sets
2521 for each class, and writes this information to @file{vtv_class_set_sizes.log}
2522 in the same directory.
2524 Note:  This feature @emph{appends} data to the log files.  To get fresh log
2525 files, be sure to delete any existing ones.
2527 @item -fno-weak
2528 @opindex fno-weak
2529 Do not use weak symbol support, even if it is provided by the linker.
2530 By default, G++ uses weak symbols if they are available.  This
2531 option exists only for testing, and should not be used by end-users;
2532 it results in inferior code and has no benefits.  This option may
2533 be removed in a future release of G++.
2535 @item -nostdinc++
2536 @opindex nostdinc++
2537 Do not search for header files in the standard directories specific to
2538 C++, but do still search the other standard directories.  (This option
2539 is used when building the C++ library.)
2540 @end table
2542 In addition, these optimization, warning, and code generation options
2543 have meanings only for C++ programs:
2545 @table @gcctabopt
2546 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2547 @opindex Wabi
2548 @opindex Wno-abi
2549 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2550 G++ to warn when it generates code that is probably not compatible with the
2551 vendor-neutral C++ ABI@.  Since G++ now defaults to
2552 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2553 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2554 or an older compatibility version is selected (with
2555 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2557 Although an effort has been made to warn about
2558 all such cases, there are probably some cases that are not warned about,
2559 even though G++ is generating incompatible code.  There may also be
2560 cases where warnings are emitted even though the code that is generated
2561 is compatible.
2563 You should rewrite your code to avoid these warnings if you are
2564 concerned about the fact that code generated by G++ may not be binary
2565 compatible with code generated by other compilers.
2567 @option{-Wabi} can also be used with an explicit version number to
2568 warn about compatibility with a particular @option{-fabi-version}
2569 level, e.g. @option{-Wabi=2} to warn about changes relative to
2570 @option{-fabi-version=2}.  Specifying a version number also sets
2571 @option{-fabi-compat-version=@var{n}}.
2573 The known incompatibilities in @option{-fabi-version=2} (which was the
2574 default from GCC 3.4 to 4.9) include:
2576 @itemize @bullet
2578 @item
2579 A template with a non-type template parameter of reference type was
2580 mangled incorrectly:
2581 @smallexample
2582 extern int N;
2583 template <int &> struct S @{@};
2584 void n (S<N>) @{2@}
2585 @end smallexample
2587 This was fixed in @option{-fabi-version=3}.
2589 @item
2590 SIMD vector types declared using @code{__attribute ((vector_size))} were
2591 mangled in a non-standard way that does not allow for overloading of
2592 functions taking vectors of different sizes.
2594 The mangling was changed in @option{-fabi-version=4}.
2596 @item
2597 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2598 qualifiers, and @code{decltype} of a plain declaration was folded away.
2600 These mangling issues were fixed in @option{-fabi-version=5}.
2602 @item
2603 Scoped enumerators passed as arguments to a variadic function are
2604 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2605 On most targets this does not actually affect the parameter passing
2606 ABI, as there is no way to pass an argument smaller than @code{int}.
2608 Also, the ABI changed the mangling of template argument packs,
2609 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2610 a class scope function used as a template argument.
2612 These issues were corrected in @option{-fabi-version=6}.
2614 @item
2615 Lambdas in default argument scope were mangled incorrectly, and the
2616 ABI changed the mangling of @code{nullptr_t}.
2618 These issues were corrected in @option{-fabi-version=7}.
2620 @item
2621 When mangling a function type with function-cv-qualifiers, the
2622 un-qualified function type was incorrectly treated as a substitution
2623 candidate.
2625 This was fixed in @option{-fabi-version=8}.
2626 @end itemize
2628 It also warns about psABI-related changes.  The known psABI changes at this
2629 point include:
2631 @itemize @bullet
2633 @item
2634 For SysV/x86-64, unions with @code{long double} members are 
2635 passed in memory as specified in psABI.  For example:
2637 @smallexample
2638 union U @{
2639   long double ld;
2640   int i;
2642 @end smallexample
2644 @noindent
2645 @code{union U} is always passed in memory.
2647 @end itemize
2649 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2650 @opindex Wabi-tag
2651 @opindex -Wabi-tag
2652 Warn when a type with an ABI tag is used in a context that does not
2653 have that ABI tag.  See @ref{C++ Attributes} for more information
2654 about ABI tags.
2656 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2657 @opindex Wctor-dtor-privacy
2658 @opindex Wno-ctor-dtor-privacy
2659 Warn when a class seems unusable because all the constructors or
2660 destructors in that class are private, and it has neither friends nor
2661 public static member functions.  Also warn if there are no non-private
2662 methods, and there's at least one private member function that isn't
2663 a constructor or destructor.
2665 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2666 @opindex Wdelete-non-virtual-dtor
2667 @opindex Wno-delete-non-virtual-dtor
2668 Warn when @code{delete} is used to destroy an instance of a class that
2669 has virtual functions and non-virtual destructor. It is unsafe to delete
2670 an instance of a derived class through a pointer to a base class if the
2671 base class does not have a virtual destructor.  This warning is enabled
2672 by @option{-Wall}.
2674 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2675 @opindex Wliteral-suffix
2676 @opindex Wno-literal-suffix
2677 Warn when a string or character literal is followed by a ud-suffix which does
2678 not begin with an underscore.  As a conforming extension, GCC treats such
2679 suffixes as separate preprocessing tokens in order to maintain backwards
2680 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2681 For example:
2683 @smallexample
2684 #define __STDC_FORMAT_MACROS
2685 #include <inttypes.h>
2686 #include <stdio.h>
2688 int main() @{
2689   int64_t i64 = 123;
2690   printf("My int64: %"PRId64"\n", i64);
2692 @end smallexample
2694 In this case, @code{PRId64} is treated as a separate preprocessing token.
2696 This warning is enabled by default.
2698 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2699 @opindex Wnarrowing
2700 @opindex Wno-narrowing
2701 Warn when a narrowing conversion prohibited by C++11 occurs within
2702 @samp{@{ @}}, e.g.
2704 @smallexample
2705 int i = @{ 2.2 @}; // error: narrowing from double to int
2706 @end smallexample
2708 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2710 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2711 required by the standard.  Note that this does not affect the meaning
2712 of well-formed code; narrowing conversions are still considered
2713 ill-formed in SFINAE context.
2715 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2716 @opindex Wnoexcept
2717 @opindex Wno-noexcept
2718 Warn when a noexcept-expression evaluates to false because of a call
2719 to a function that does not have a non-throwing exception
2720 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2721 the compiler to never throw an exception.
2723 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2724 @opindex Wnon-virtual-dtor
2725 @opindex Wno-non-virtual-dtor
2726 Warn when a class has virtual functions and an accessible non-virtual
2727 destructor itself or in an accessible polymorphic base class, in which
2728 case it is possible but unsafe to delete an instance of a derived
2729 class through a pointer to the class itself or base class.  This
2730 warning is automatically enabled if @option{-Weffc++} is specified.
2732 @item -Wreorder @r{(C++ and Objective-C++ only)}
2733 @opindex Wreorder
2734 @opindex Wno-reorder
2735 @cindex reordering, warning
2736 @cindex warning for reordering of member initializers
2737 Warn when the order of member initializers given in the code does not
2738 match the order in which they must be executed.  For instance:
2740 @smallexample
2741 struct A @{
2742   int i;
2743   int j;
2744   A(): j (0), i (1) @{ @}
2746 @end smallexample
2748 @noindent
2749 The compiler rearranges the member initializers for @code{i}
2750 and @code{j} to match the declaration order of the members, emitting
2751 a warning to that effect.  This warning is enabled by @option{-Wall}.
2753 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2754 @opindex fext-numeric-literals
2755 @opindex fno-ext-numeric-literals
2756 Accept imaginary, fixed-point, or machine-defined
2757 literal number suffixes as GNU extensions.
2758 When this option is turned off these suffixes are treated
2759 as C++11 user-defined literal numeric suffixes.
2760 This is on by default for all pre-C++11 dialects and all GNU dialects:
2761 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2762 @option{-std=gnu++14}.
2763 This option is off by default
2764 for ISO C++11 onwards (@option{-std=c++11}, ...).
2765 @end table
2767 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2769 @table @gcctabopt
2770 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2771 @opindex Weffc++
2772 @opindex Wno-effc++
2773 Warn about violations of the following style guidelines from Scott Meyers'
2774 @cite{Effective C++} series of books:
2776 @itemize @bullet
2777 @item
2778 Define a copy constructor and an assignment operator for classes
2779 with dynamically-allocated memory.
2781 @item
2782 Prefer initialization to assignment in constructors.
2784 @item
2785 Have @code{operator=} return a reference to @code{*this}.
2787 @item
2788 Don't try to return a reference when you must return an object.
2790 @item
2791 Distinguish between prefix and postfix forms of increment and
2792 decrement operators.
2794 @item
2795 Never overload @code{&&}, @code{||}, or @code{,}.
2797 @end itemize
2799 This option also enables @option{-Wnon-virtual-dtor}, which is also
2800 one of the effective C++ recommendations.  However, the check is
2801 extended to warn about the lack of virtual destructor in accessible
2802 non-polymorphic bases classes too.
2804 When selecting this option, be aware that the standard library
2805 headers do not obey all of these guidelines; use @samp{grep -v}
2806 to filter out those warnings.
2808 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2809 @opindex Wstrict-null-sentinel
2810 @opindex Wno-strict-null-sentinel
2811 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2812 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2813 to @code{__null}.  Although it is a null pointer constant rather than a
2814 null pointer, it is guaranteed to be of the same size as a pointer.
2815 But this use is not portable across different compilers.
2817 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2818 @opindex Wno-non-template-friend
2819 @opindex Wnon-template-friend
2820 Disable warnings when non-templatized friend functions are declared
2821 within a template.  Since the advent of explicit template specification
2822 support in G++, if the name of the friend is an unqualified-id (i.e.,
2823 @samp{friend foo(int)}), the C++ language specification demands that the
2824 friend declare or define an ordinary, nontemplate function.  (Section
2825 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2826 could be interpreted as a particular specialization of a templatized
2827 function.  Because this non-conforming behavior is no longer the default
2828 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2829 check existing code for potential trouble spots and is on by default.
2830 This new compiler behavior can be turned off with
2831 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2832 but disables the helpful warning.
2834 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2835 @opindex Wold-style-cast
2836 @opindex Wno-old-style-cast
2837 Warn if an old-style (C-style) cast to a non-void type is used within
2838 a C++ program.  The new-style casts (@code{dynamic_cast},
2839 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2840 less vulnerable to unintended effects and much easier to search for.
2842 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2843 @opindex Woverloaded-virtual
2844 @opindex Wno-overloaded-virtual
2845 @cindex overloaded virtual function, warning
2846 @cindex warning for overloaded virtual function
2847 Warn when a function declaration hides virtual functions from a
2848 base class.  For example, in:
2850 @smallexample
2851 struct A @{
2852   virtual void f();
2855 struct B: public A @{
2856   void f(int);
2858 @end smallexample
2860 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2861 like:
2863 @smallexample
2864 B* b;
2865 b->f();
2866 @end smallexample
2868 @noindent
2869 fails to compile.
2871 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2872 @opindex Wno-pmf-conversions
2873 @opindex Wpmf-conversions
2874 Disable the diagnostic for converting a bound pointer to member function
2875 to a plain pointer.
2877 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2878 @opindex Wsign-promo
2879 @opindex Wno-sign-promo
2880 Warn when overload resolution chooses a promotion from unsigned or
2881 enumerated type to a signed type, over a conversion to an unsigned type of
2882 the same size.  Previous versions of G++ tried to preserve
2883 unsignedness, but the standard mandates the current behavior.
2884 @end table
2886 @node Objective-C and Objective-C++ Dialect Options
2887 @section Options Controlling Objective-C and Objective-C++ Dialects
2889 @cindex compiler options, Objective-C and Objective-C++
2890 @cindex Objective-C and Objective-C++ options, command-line
2891 @cindex options, Objective-C and Objective-C++
2892 (NOTE: This manual does not describe the Objective-C and Objective-C++
2893 languages themselves.  @xref{Standards,,Language Standards
2894 Supported by GCC}, for references.)
2896 This section describes the command-line options that are only meaningful
2897 for Objective-C and Objective-C++ programs.  You can also use most of
2898 the language-independent GNU compiler options.
2899 For example, you might compile a file @file{some_class.m} like this:
2901 @smallexample
2902 gcc -g -fgnu-runtime -O -c some_class.m
2903 @end smallexample
2905 @noindent
2906 In this example, @option{-fgnu-runtime} is an option meant only for
2907 Objective-C and Objective-C++ programs; you can use the other options with
2908 any language supported by GCC@.
2910 Note that since Objective-C is an extension of the C language, Objective-C
2911 compilations may also use options specific to the C front-end (e.g.,
2912 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2913 C++-specific options (e.g., @option{-Wabi}).
2915 Here is a list of options that are @emph{only} for compiling Objective-C
2916 and Objective-C++ programs:
2918 @table @gcctabopt
2919 @item -fconstant-string-class=@var{class-name}
2920 @opindex fconstant-string-class
2921 Use @var{class-name} as the name of the class to instantiate for each
2922 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2923 class name is @code{NXConstantString} if the GNU runtime is being used, and
2924 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2925 @option{-fconstant-cfstrings} option, if also present, overrides the
2926 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2927 to be laid out as constant CoreFoundation strings.
2929 @item -fgnu-runtime
2930 @opindex fgnu-runtime
2931 Generate object code compatible with the standard GNU Objective-C
2932 runtime.  This is the default for most types of systems.
2934 @item -fnext-runtime
2935 @opindex fnext-runtime
2936 Generate output compatible with the NeXT runtime.  This is the default
2937 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2938 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2939 used.
2941 @item -fno-nil-receivers
2942 @opindex fno-nil-receivers
2943 Assume that all Objective-C message dispatches (@code{[receiver
2944 message:arg]}) in this translation unit ensure that the receiver is
2945 not @code{nil}.  This allows for more efficient entry points in the
2946 runtime to be used.  This option is only available in conjunction with
2947 the NeXT runtime and ABI version 0 or 1.
2949 @item -fobjc-abi-version=@var{n}
2950 @opindex fobjc-abi-version
2951 Use version @var{n} of the Objective-C ABI for the selected runtime.
2952 This option is currently supported only for the NeXT runtime.  In that
2953 case, Version 0 is the traditional (32-bit) ABI without support for
2954 properties and other Objective-C 2.0 additions.  Version 1 is the
2955 traditional (32-bit) ABI with support for properties and other
2956 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2957 nothing is specified, the default is Version 0 on 32-bit target
2958 machines, and Version 2 on 64-bit target machines.
2960 @item -fobjc-call-cxx-cdtors
2961 @opindex fobjc-call-cxx-cdtors
2962 For each Objective-C class, check if any of its instance variables is a
2963 C++ object with a non-trivial default constructor.  If so, synthesize a
2964 special @code{- (id) .cxx_construct} instance method which runs
2965 non-trivial default constructors on any such instance variables, in order,
2966 and then return @code{self}.  Similarly, check if any instance variable
2967 is a C++ object with a non-trivial destructor, and if so, synthesize a
2968 special @code{- (void) .cxx_destruct} method which runs
2969 all such default destructors, in reverse order.
2971 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2972 methods thusly generated only operate on instance variables
2973 declared in the current Objective-C class, and not those inherited
2974 from superclasses.  It is the responsibility of the Objective-C
2975 runtime to invoke all such methods in an object's inheritance
2976 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2977 by the runtime immediately after a new object instance is allocated;
2978 the @code{- (void) .cxx_destruct} methods are invoked immediately
2979 before the runtime deallocates an object instance.
2981 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2982 support for invoking the @code{- (id) .cxx_construct} and
2983 @code{- (void) .cxx_destruct} methods.
2985 @item -fobjc-direct-dispatch
2986 @opindex fobjc-direct-dispatch
2987 Allow fast jumps to the message dispatcher.  On Darwin this is
2988 accomplished via the comm page.
2990 @item -fobjc-exceptions
2991 @opindex fobjc-exceptions
2992 Enable syntactic support for structured exception handling in
2993 Objective-C, similar to what is offered by C++ and Java.  This option
2994 is required to use the Objective-C keywords @code{@@try},
2995 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2996 @code{@@synchronized}.  This option is available with both the GNU
2997 runtime and the NeXT runtime (but not available in conjunction with
2998 the NeXT runtime on Mac OS X 10.2 and earlier).
3000 @item -fobjc-gc
3001 @opindex fobjc-gc
3002 Enable garbage collection (GC) in Objective-C and Objective-C++
3003 programs.  This option is only available with the NeXT runtime; the
3004 GNU runtime has a different garbage collection implementation that
3005 does not require special compiler flags.
3007 @item -fobjc-nilcheck
3008 @opindex fobjc-nilcheck
3009 For the NeXT runtime with version 2 of the ABI, check for a nil
3010 receiver in method invocations before doing the actual method call.
3011 This is the default and can be disabled using
3012 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3013 checked for nil in this way no matter what this flag is set to.
3014 Currently this flag does nothing when the GNU runtime, or an older
3015 version of the NeXT runtime ABI, is used.
3017 @item -fobjc-std=objc1
3018 @opindex fobjc-std
3019 Conform to the language syntax of Objective-C 1.0, the language
3020 recognized by GCC 4.0.  This only affects the Objective-C additions to
3021 the C/C++ language; it does not affect conformance to C/C++ standards,
3022 which is controlled by the separate C/C++ dialect option flags.  When
3023 this option is used with the Objective-C or Objective-C++ compiler,
3024 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3025 This is useful if you need to make sure that your Objective-C code can
3026 be compiled with older versions of GCC@.
3028 @item -freplace-objc-classes
3029 @opindex freplace-objc-classes
3030 Emit a special marker instructing @command{ld(1)} not to statically link in
3031 the resulting object file, and allow @command{dyld(1)} to load it in at
3032 run time instead.  This is used in conjunction with the Fix-and-Continue
3033 debugging mode, where the object file in question may be recompiled and
3034 dynamically reloaded in the course of program execution, without the need
3035 to restart the program itself.  Currently, Fix-and-Continue functionality
3036 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3037 and later.
3039 @item -fzero-link
3040 @opindex fzero-link
3041 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3042 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3043 compile time) with static class references that get initialized at load time,
3044 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3045 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3046 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3047 for individual class implementations to be modified during program execution.
3048 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3049 regardless of command-line options.
3051 @item -fno-local-ivars
3052 @opindex fno-local-ivars
3053 @opindex flocal-ivars
3054 By default instance variables in Objective-C can be accessed as if
3055 they were local variables from within the methods of the class they're
3056 declared in.  This can lead to shadowing between instance variables
3057 and other variables declared either locally inside a class method or
3058 globally with the same name.  Specifying the @option{-fno-local-ivars}
3059 flag disables this behavior thus avoiding variable shadowing issues.
3061 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3062 @opindex fivar-visibility
3063 Set the default instance variable visibility to the specified option
3064 so that instance variables declared outside the scope of any access
3065 modifier directives default to the specified visibility.
3067 @item -gen-decls
3068 @opindex gen-decls
3069 Dump interface declarations for all classes seen in the source file to a
3070 file named @file{@var{sourcename}.decl}.
3072 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3073 @opindex Wassign-intercept
3074 @opindex Wno-assign-intercept
3075 Warn whenever an Objective-C assignment is being intercepted by the
3076 garbage collector.
3078 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3079 @opindex Wno-protocol
3080 @opindex Wprotocol
3081 If a class is declared to implement a protocol, a warning is issued for
3082 every method in the protocol that is not implemented by the class.  The
3083 default behavior is to issue a warning for every method not explicitly
3084 implemented in the class, even if a method implementation is inherited
3085 from the superclass.  If you use the @option{-Wno-protocol} option, then
3086 methods inherited from the superclass are considered to be implemented,
3087 and no warning is issued for them.
3089 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3090 @opindex Wselector
3091 @opindex Wno-selector
3092 Warn if multiple methods of different types for the same selector are
3093 found during compilation.  The check is performed on the list of methods
3094 in the final stage of compilation.  Additionally, a check is performed
3095 for each selector appearing in a @code{@@selector(@dots{})}
3096 expression, and a corresponding method for that selector has been found
3097 during compilation.  Because these checks scan the method table only at
3098 the end of compilation, these warnings are not produced if the final
3099 stage of compilation is not reached, for example because an error is
3100 found during compilation, or because the @option{-fsyntax-only} option is
3101 being used.
3103 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3104 @opindex Wstrict-selector-match
3105 @opindex Wno-strict-selector-match
3106 Warn if multiple methods with differing argument and/or return types are
3107 found for a given selector when attempting to send a message using this
3108 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3109 is off (which is the default behavior), the compiler omits such warnings
3110 if any differences found are confined to types that share the same size
3111 and alignment.
3113 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3114 @opindex Wundeclared-selector
3115 @opindex Wno-undeclared-selector
3116 Warn if a @code{@@selector(@dots{})} expression referring to an
3117 undeclared selector is found.  A selector is considered undeclared if no
3118 method with that name has been declared before the
3119 @code{@@selector(@dots{})} expression, either explicitly in an
3120 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3121 an @code{@@implementation} section.  This option always performs its
3122 checks as soon as a @code{@@selector(@dots{})} expression is found,
3123 while @option{-Wselector} only performs its checks in the final stage of
3124 compilation.  This also enforces the coding style convention
3125 that methods and selectors must be declared before being used.
3127 @item -print-objc-runtime-info
3128 @opindex print-objc-runtime-info
3129 Generate C header describing the largest structure that is passed by
3130 value, if any.
3132 @end table
3134 @node Language Independent Options
3135 @section Options to Control Diagnostic Messages Formatting
3136 @cindex options to control diagnostics formatting
3137 @cindex diagnostic messages
3138 @cindex message formatting
3140 Traditionally, diagnostic messages have been formatted irrespective of
3141 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3142 options described below
3143 to control the formatting algorithm for diagnostic messages, 
3144 e.g.@: how many characters per line, how often source location
3145 information should be reported.  Note that some language front ends may not
3146 honor these options.
3148 @table @gcctabopt
3149 @item -fmessage-length=@var{n}
3150 @opindex fmessage-length
3151 Try to format error messages so that they fit on lines of about
3152 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3153 done; each error message appears on a single line.  This is the
3154 default for all front ends.
3156 @item -fdiagnostics-show-location=once
3157 @opindex fdiagnostics-show-location
3158 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3159 reporter to emit source location information @emph{once}; that is, in
3160 case the message is too long to fit on a single physical line and has to
3161 be wrapped, the source location won't be emitted (as prefix) again,
3162 over and over, in subsequent continuation lines.  This is the default
3163 behavior.
3165 @item -fdiagnostics-show-location=every-line
3166 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3167 messages reporter to emit the same source location information (as
3168 prefix) for physical lines that result from the process of breaking
3169 a message which is too long to fit on a single line.
3171 @item -fdiagnostics-color[=@var{WHEN}]
3172 @itemx -fno-diagnostics-color
3173 @opindex fdiagnostics-color
3174 @cindex highlight, color, colour
3175 @vindex GCC_COLORS @r{environment variable}
3176 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3177 or @samp{auto}.  The default depends on how the compiler has been configured,
3178 it can be any of the above @var{WHEN} options or also @samp{never}
3179 if @env{GCC_COLORS} environment variable isn't present in the environment,
3180 and @samp{auto} otherwise.
3181 @samp{auto} means to use color only when the standard error is a terminal.
3182 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3183 aliases for @option{-fdiagnostics-color=always} and
3184 @option{-fdiagnostics-color=never}, respectively.
3186 The colors are defined by the environment variable @env{GCC_COLORS}.
3187 Its value is a colon-separated list of capabilities and Select Graphic
3188 Rendition (SGR) substrings. SGR commands are interpreted by the
3189 terminal or terminal emulator.  (See the section in the documentation
3190 of your text terminal for permitted values and their meanings as
3191 character attributes.)  These substring values are integers in decimal
3192 representation and can be concatenated with semicolons.
3193 Common values to concatenate include
3194 @samp{1} for bold,
3195 @samp{4} for underline,
3196 @samp{5} for blink,
3197 @samp{7} for inverse,
3198 @samp{39} for default foreground color,
3199 @samp{30} to @samp{37} for foreground colors,
3200 @samp{90} to @samp{97} for 16-color mode foreground colors,
3201 @samp{38;5;0} to @samp{38;5;255}
3202 for 88-color and 256-color modes foreground colors,
3203 @samp{49} for default background color,
3204 @samp{40} to @samp{47} for background colors,
3205 @samp{100} to @samp{107} for 16-color mode background colors,
3206 and @samp{48;5;0} to @samp{48;5;255}
3207 for 88-color and 256-color modes background colors.
3209 The default @env{GCC_COLORS} is
3210 @smallexample
3211 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3212 @end smallexample
3213 @noindent
3214 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3215 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3216 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3217 string disables colors.
3218 Supported capabilities are as follows.
3220 @table @code
3221 @item error=
3222 @vindex error GCC_COLORS @r{capability}
3223 SGR substring for error: markers.
3225 @item warning=
3226 @vindex warning GCC_COLORS @r{capability}
3227 SGR substring for warning: markers.
3229 @item note=
3230 @vindex note GCC_COLORS @r{capability}
3231 SGR substring for note: markers.
3233 @item caret=
3234 @vindex caret GCC_COLORS @r{capability}
3235 SGR substring for caret line.
3237 @item locus=
3238 @vindex locus GCC_COLORS @r{capability}
3239 SGR substring for location information, @samp{file:line} or
3240 @samp{file:line:column} etc.
3242 @item quote=
3243 @vindex quote GCC_COLORS @r{capability}
3244 SGR substring for information printed within quotes.
3245 @end table
3247 @item -fno-diagnostics-show-option
3248 @opindex fno-diagnostics-show-option
3249 @opindex fdiagnostics-show-option
3250 By default, each diagnostic emitted includes text indicating the
3251 command-line option that directly controls the diagnostic (if such an
3252 option is known to the diagnostic machinery).  Specifying the
3253 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3255 @item -fno-diagnostics-show-caret
3256 @opindex fno-diagnostics-show-caret
3257 @opindex fdiagnostics-show-caret
3258 By default, each diagnostic emitted includes the original source line
3259 and a caret '^' indicating the column.  This option suppresses this
3260 information.  The source line is truncated to @var{n} characters, if
3261 the @option{-fmessage-length=n} option is given.  When the output is done
3262 to the terminal, the width is limited to the width given by the
3263 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3265 @end table
3267 @node Warning Options
3268 @section Options to Request or Suppress Warnings
3269 @cindex options to control warnings
3270 @cindex warning messages
3271 @cindex messages, warning
3272 @cindex suppressing warnings
3274 Warnings are diagnostic messages that report constructions that
3275 are not inherently erroneous but that are risky or suggest there
3276 may have been an error.
3278 The following language-independent options do not enable specific
3279 warnings but control the kinds of diagnostics produced by GCC@.
3281 @table @gcctabopt
3282 @cindex syntax checking
3283 @item -fsyntax-only
3284 @opindex fsyntax-only
3285 Check the code for syntax errors, but don't do anything beyond that.
3287 @item -fmax-errors=@var{n}
3288 @opindex fmax-errors
3289 Limits the maximum number of error messages to @var{n}, at which point
3290 GCC bails out rather than attempting to continue processing the source
3291 code.  If @var{n} is 0 (the default), there is no limit on the number
3292 of error messages produced.  If @option{-Wfatal-errors} is also
3293 specified, then @option{-Wfatal-errors} takes precedence over this
3294 option.
3296 @item -w
3297 @opindex w
3298 Inhibit all warning messages.
3300 @item -Werror
3301 @opindex Werror
3302 @opindex Wno-error
3303 Make all warnings into errors.
3305 @item -Werror=
3306 @opindex Werror=
3307 @opindex Wno-error=
3308 Make the specified warning into an error.  The specifier for a warning
3309 is appended; for example @option{-Werror=switch} turns the warnings
3310 controlled by @option{-Wswitch} into errors.  This switch takes a
3311 negative form, to be used to negate @option{-Werror} for specific
3312 warnings; for example @option{-Wno-error=switch} makes
3313 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3314 is in effect.
3316 The warning message for each controllable warning includes the
3317 option that controls the warning.  That option can then be used with
3318 @option{-Werror=} and @option{-Wno-error=} as described above.
3319 (Printing of the option in the warning message can be disabled using the
3320 @option{-fno-diagnostics-show-option} flag.)
3322 Note that specifying @option{-Werror=}@var{foo} automatically implies
3323 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3324 imply anything.
3326 @item -Wfatal-errors
3327 @opindex Wfatal-errors
3328 @opindex Wno-fatal-errors
3329 This option causes the compiler to abort compilation on the first error
3330 occurred rather than trying to keep going and printing further error
3331 messages.
3333 @end table
3335 You can request many specific warnings with options beginning with
3336 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3337 implicit declarations.  Each of these specific warning options also
3338 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3339 example, @option{-Wno-implicit}.  This manual lists only one of the
3340 two forms, whichever is not the default.  For further
3341 language-specific options also refer to @ref{C++ Dialect Options} and
3342 @ref{Objective-C and Objective-C++ Dialect Options}.
3344 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3345 options, such as @option{-Wunused}, which may turn on further options,
3346 such as @option{-Wunused-value}. The combined effect of positive and
3347 negative forms is that more specific options have priority over less
3348 specific ones, independently of their position in the command-line. For
3349 options of the same specificity, the last one takes effect. Options
3350 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3351 as if they appeared at the end of the command-line.
3353 When an unrecognized warning option is requested (e.g.,
3354 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3355 that the option is not recognized.  However, if the @option{-Wno-} form
3356 is used, the behavior is slightly different: no diagnostic is
3357 produced for @option{-Wno-unknown-warning} unless other diagnostics
3358 are being produced.  This allows the use of new @option{-Wno-} options
3359 with old compilers, but if something goes wrong, the compiler
3360 warns that an unrecognized option is present.
3362 @table @gcctabopt
3363 @item -Wpedantic
3364 @itemx -pedantic
3365 @opindex pedantic
3366 @opindex Wpedantic
3367 Issue all the warnings demanded by strict ISO C and ISO C++;
3368 reject all programs that use forbidden extensions, and some other
3369 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3370 version of the ISO C standard specified by any @option{-std} option used.
3372 Valid ISO C and ISO C++ programs should compile properly with or without
3373 this option (though a rare few require @option{-ansi} or a
3374 @option{-std} option specifying the required version of ISO C)@.  However,
3375 without this option, certain GNU extensions and traditional C and C++
3376 features are supported as well.  With this option, they are rejected.
3378 @option{-Wpedantic} does not cause warning messages for use of the
3379 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3380 warnings are also disabled in the expression that follows
3381 @code{__extension__}.  However, only system header files should use
3382 these escape routes; application programs should avoid them.
3383 @xref{Alternate Keywords}.
3385 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3386 C conformance.  They soon find that it does not do quite what they want:
3387 it finds some non-ISO practices, but not all---only those for which
3388 ISO C @emph{requires} a diagnostic, and some others for which
3389 diagnostics have been added.
3391 A feature to report any failure to conform to ISO C might be useful in
3392 some instances, but would require considerable additional work and would
3393 be quite different from @option{-Wpedantic}.  We don't have plans to
3394 support such a feature in the near future.
3396 Where the standard specified with @option{-std} represents a GNU
3397 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3398 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3399 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3400 where they are required by the base standard.  (It does not make sense
3401 for such warnings to be given only for features not in the specified GNU
3402 C dialect, since by definition the GNU dialects of C include all
3403 features the compiler supports with the given option, and there would be
3404 nothing to warn about.)
3406 @item -pedantic-errors
3407 @opindex pedantic-errors
3408 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3409 requires a diagnostic, in some cases where there is undefined behavior
3410 at compile-time and in some other cases that do not prevent compilation
3411 of programs that are valid according to the standard. This is not
3412 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3413 by this option and not enabled by the latter and vice versa.
3415 @item -Wall
3416 @opindex Wall
3417 @opindex Wno-all
3418 This enables all the warnings about constructions that some users
3419 consider questionable, and that are easy to avoid (or modify to
3420 prevent the warning), even in conjunction with macros.  This also
3421 enables some language-specific warnings described in @ref{C++ Dialect
3422 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3424 @option{-Wall} turns on the following warning flags:
3426 @gccoptlist{-Waddress   @gol
3427 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3428 -Wc++11-compat  -Wc++14-compat@gol
3429 -Wchar-subscripts  @gol
3430 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3431 -Wimplicit-int @r{(C and Objective-C only)} @gol
3432 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3433 -Wcomment  @gol
3434 -Wformat   @gol
3435 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3436 -Wmaybe-uninitialized @gol
3437 -Wmissing-braces @r{(only for C/ObjC)} @gol
3438 -Wnonnull  @gol
3439 -Wopenmp-simd @gol
3440 -Wparentheses  @gol
3441 -Wpointer-sign  @gol
3442 -Wreorder   @gol
3443 -Wreturn-type  @gol
3444 -Wsequence-point  @gol
3445 -Wsign-compare @r{(only in C++)}  @gol
3446 -Wstrict-aliasing  @gol
3447 -Wstrict-overflow=1  @gol
3448 -Wswitch  @gol
3449 -Wtrigraphs  @gol
3450 -Wuninitialized  @gol
3451 -Wunknown-pragmas  @gol
3452 -Wunused-function  @gol
3453 -Wunused-label     @gol
3454 -Wunused-value     @gol
3455 -Wunused-variable  @gol
3456 -Wvolatile-register-var @gol
3459 Note that some warning flags are not implied by @option{-Wall}.  Some of
3460 them warn about constructions that users generally do not consider
3461 questionable, but which occasionally you might wish to check for;
3462 others warn about constructions that are necessary or hard to avoid in
3463 some cases, and there is no simple way to modify the code to suppress
3464 the warning. Some of them are enabled by @option{-Wextra} but many of
3465 them must be enabled individually.
3467 @item -Wextra
3468 @opindex W
3469 @opindex Wextra
3470 @opindex Wno-extra
3471 This enables some extra warning flags that are not enabled by
3472 @option{-Wall}. (This option used to be called @option{-W}.  The older
3473 name is still supported, but the newer name is more descriptive.)
3475 @gccoptlist{-Wclobbered  @gol
3476 -Wempty-body  @gol
3477 -Wignored-qualifiers @gol
3478 -Wmissing-field-initializers  @gol
3479 -Wmissing-parameter-type @r{(C only)}  @gol
3480 -Wold-style-declaration @r{(C only)}  @gol
3481 -Woverride-init  @gol
3482 -Wsign-compare  @gol
3483 -Wtype-limits  @gol
3484 -Wuninitialized  @gol
3485 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3486 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3489 The option @option{-Wextra} also prints warning messages for the
3490 following cases:
3492 @itemize @bullet
3494 @item
3495 A pointer is compared against integer zero with @code{<}, @code{<=},
3496 @code{>}, or @code{>=}.
3498 @item
3499 (C++ only) An enumerator and a non-enumerator both appear in a
3500 conditional expression.
3502 @item
3503 (C++ only) Ambiguous virtual bases.
3505 @item
3506 (C++ only) Subscripting an array that has been declared @code{register}.
3508 @item
3509 (C++ only) Taking the address of a variable that has been declared
3510 @code{register}.
3512 @item
3513 (C++ only) A base class is not initialized in a derived class's copy
3514 constructor.
3516 @end itemize
3518 @item -Wchar-subscripts
3519 @opindex Wchar-subscripts
3520 @opindex Wno-char-subscripts
3521 Warn if an array subscript has type @code{char}.  This is a common cause
3522 of error, as programmers often forget that this type is signed on some
3523 machines.
3524 This warning is enabled by @option{-Wall}.
3526 @item -Wcomment
3527 @opindex Wcomment
3528 @opindex Wno-comment
3529 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3530 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3531 This warning is enabled by @option{-Wall}.
3533 @item -Wno-coverage-mismatch
3534 @opindex Wno-coverage-mismatch
3535 Warn if feedback profiles do not match when using the
3536 @option{-fprofile-use} option.
3537 If a source file is changed between compiling with @option{-fprofile-gen} and
3538 with @option{-fprofile-use}, the files with the profile feedback can fail
3539 to match the source file and GCC cannot use the profile feedback
3540 information.  By default, this warning is enabled and is treated as an
3541 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3542 warning or @option{-Wno-error=coverage-mismatch} can be used to
3543 disable the error.  Disabling the error for this warning can result in
3544 poorly optimized code and is useful only in the
3545 case of very minor changes such as bug fixes to an existing code-base.
3546 Completely disabling the warning is not recommended.
3548 @item -Wno-cpp
3549 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3551 Suppress warning messages emitted by @code{#warning} directives.
3553 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3554 @opindex Wdouble-promotion
3555 @opindex Wno-double-promotion
3556 Give a warning when a value of type @code{float} is implicitly
3557 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3558 floating-point unit implement @code{float} in hardware, but emulate
3559 @code{double} in software.  On such a machine, doing computations
3560 using @code{double} values is much more expensive because of the
3561 overhead required for software emulation.
3563 It is easy to accidentally do computations with @code{double} because
3564 floating-point literals are implicitly of type @code{double}.  For
3565 example, in:
3566 @smallexample
3567 @group
3568 float area(float radius)
3570    return 3.14159 * radius * radius;
3572 @end group
3573 @end smallexample
3574 the compiler performs the entire computation with @code{double}
3575 because the floating-point literal is a @code{double}.
3577 @item -Wformat
3578 @itemx -Wformat=@var{n}
3579 @opindex Wformat
3580 @opindex Wno-format
3581 @opindex ffreestanding
3582 @opindex fno-builtin
3583 @opindex Wformat=
3584 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3585 the arguments supplied have types appropriate to the format string
3586 specified, and that the conversions specified in the format string make
3587 sense.  This includes standard functions, and others specified by format
3588 attributes (@pxref{Function Attributes}), in the @code{printf},
3589 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3590 not in the C standard) families (or other target-specific families).
3591 Which functions are checked without format attributes having been
3592 specified depends on the standard version selected, and such checks of
3593 functions without the attribute specified are disabled by
3594 @option{-ffreestanding} or @option{-fno-builtin}.
3596 The formats are checked against the format features supported by GNU
3597 libc version 2.2.  These include all ISO C90 and C99 features, as well
3598 as features from the Single Unix Specification and some BSD and GNU
3599 extensions.  Other library implementations may not support all these
3600 features; GCC does not support warning about features that go beyond a
3601 particular library's limitations.  However, if @option{-Wpedantic} is used
3602 with @option{-Wformat}, warnings are given about format features not
3603 in the selected standard version (but not for @code{strfmon} formats,
3604 since those are not in any version of the C standard).  @xref{C Dialect
3605 Options,,Options Controlling C Dialect}.
3607 @table @gcctabopt
3608 @item -Wformat=1
3609 @itemx -Wformat
3610 @opindex Wformat
3611 @opindex Wformat=1
3612 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3613 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3614 @option{-Wformat} also checks for null format arguments for several
3615 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3616 aspects of this level of format checking can be disabled by the
3617 options: @option{-Wno-format-contains-nul},
3618 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3619 @option{-Wformat} is enabled by @option{-Wall}.
3621 @item -Wno-format-contains-nul
3622 @opindex Wno-format-contains-nul
3623 @opindex Wformat-contains-nul
3624 If @option{-Wformat} is specified, do not warn about format strings that
3625 contain NUL bytes.
3627 @item -Wno-format-extra-args
3628 @opindex Wno-format-extra-args
3629 @opindex Wformat-extra-args
3630 If @option{-Wformat} is specified, do not warn about excess arguments to a
3631 @code{printf} or @code{scanf} format function.  The C standard specifies
3632 that such arguments are ignored.
3634 Where the unused arguments lie between used arguments that are
3635 specified with @samp{$} operand number specifications, normally
3636 warnings are still given, since the implementation could not know what
3637 type to pass to @code{va_arg} to skip the unused arguments.  However,
3638 in the case of @code{scanf} formats, this option suppresses the
3639 warning if the unused arguments are all pointers, since the Single
3640 Unix Specification says that such unused arguments are allowed.
3642 @item -Wno-format-zero-length
3643 @opindex Wno-format-zero-length
3644 @opindex Wformat-zero-length
3645 If @option{-Wformat} is specified, do not warn about zero-length formats.
3646 The C standard specifies that zero-length formats are allowed.
3649 @item -Wformat=2
3650 @opindex Wformat=2
3651 Enable @option{-Wformat} plus additional format checks.  Currently
3652 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3653 -Wformat-y2k}.
3655 @item -Wformat-nonliteral
3656 @opindex Wformat-nonliteral
3657 @opindex Wno-format-nonliteral
3658 If @option{-Wformat} is specified, also warn if the format string is not a
3659 string literal and so cannot be checked, unless the format function
3660 takes its format arguments as a @code{va_list}.
3662 @item -Wformat-security
3663 @opindex Wformat-security
3664 @opindex Wno-format-security
3665 If @option{-Wformat} is specified, also warn about uses of format
3666 functions that represent possible security problems.  At present, this
3667 warns about calls to @code{printf} and @code{scanf} functions where the
3668 format string is not a string literal and there are no format arguments,
3669 as in @code{printf (foo);}.  This may be a security hole if the format
3670 string came from untrusted input and contains @samp{%n}.  (This is
3671 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3672 in future warnings may be added to @option{-Wformat-security} that are not
3673 included in @option{-Wformat-nonliteral}.)
3675 @item -Wformat-signedness
3676 @opindex Wformat-signedness
3677 @opindex Wno-format-signedness
3678 If @option{-Wformat} is specified, also warn if the format string
3679 requires an unsigned argument and the argument is signed and vice versa.
3681 @item -Wformat-y2k
3682 @opindex Wformat-y2k
3683 @opindex Wno-format-y2k
3684 If @option{-Wformat} is specified, also warn about @code{strftime}
3685 formats that may yield only a two-digit year.
3686 @end table
3688 @item -Wnonnull
3689 @opindex Wnonnull
3690 @opindex Wno-nonnull
3691 Warn about passing a null pointer for arguments marked as
3692 requiring a non-null value by the @code{nonnull} function attribute.
3694 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3695 can be disabled with the @option{-Wno-nonnull} option.
3697 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3698 @opindex Winit-self
3699 @opindex Wno-init-self
3700 Warn about uninitialized variables that are initialized with themselves.
3701 Note this option can only be used with the @option{-Wuninitialized} option.
3703 For example, GCC warns about @code{i} being uninitialized in the
3704 following snippet only when @option{-Winit-self} has been specified:
3705 @smallexample
3706 @group
3707 int f()
3709   int i = i;
3710   return i;
3712 @end group
3713 @end smallexample
3715 This warning is enabled by @option{-Wall} in C++.
3717 @item -Wimplicit-int @r{(C and Objective-C only)}
3718 @opindex Wimplicit-int
3719 @opindex Wno-implicit-int
3720 Warn when a declaration does not specify a type.
3721 This warning is enabled by @option{-Wall}.
3723 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3724 @opindex Wimplicit-function-declaration
3725 @opindex Wno-implicit-function-declaration
3726 Give a warning whenever a function is used before being declared. In
3727 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3728 enabled by default and it is made into an error by
3729 @option{-pedantic-errors}. This warning is also enabled by
3730 @option{-Wall}.
3732 @item -Wimplicit @r{(C and Objective-C only)}
3733 @opindex Wimplicit
3734 @opindex Wno-implicit
3735 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3736 This warning is enabled by @option{-Wall}.
3738 @item -Wignored-qualifiers @r{(C and C++ only)}
3739 @opindex Wignored-qualifiers
3740 @opindex Wno-ignored-qualifiers
3741 Warn if the return type of a function has a type qualifier
3742 such as @code{const}.  For ISO C such a type qualifier has no effect,
3743 since the value returned by a function is not an lvalue.
3744 For C++, the warning is only emitted for scalar types or @code{void}.
3745 ISO C prohibits qualified @code{void} return types on function
3746 definitions, so such return types always receive a warning
3747 even without this option.
3749 This warning is also enabled by @option{-Wextra}.
3751 @item -Wmain
3752 @opindex Wmain
3753 @opindex Wno-main
3754 Warn if the type of @code{main} is suspicious.  @code{main} should be
3755 a function with external linkage, returning int, taking either zero
3756 arguments, two, or three arguments of appropriate types.  This warning
3757 is enabled by default in C++ and is enabled by either @option{-Wall}
3758 or @option{-Wpedantic}.
3760 @item -Wmissing-braces
3761 @opindex Wmissing-braces
3762 @opindex Wno-missing-braces
3763 Warn if an aggregate or union initializer is not fully bracketed.  In
3764 the following example, the initializer for @code{a} is not fully
3765 bracketed, but that for @code{b} is fully bracketed.  This warning is
3766 enabled by @option{-Wall} in C.
3768 @smallexample
3769 int a[2][2] = @{ 0, 1, 2, 3 @};
3770 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3771 @end smallexample
3773 This warning is enabled by @option{-Wall}.
3775 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3776 @opindex Wmissing-include-dirs
3777 @opindex Wno-missing-include-dirs
3778 Warn if a user-supplied include directory does not exist.
3780 @item -Wparentheses
3781 @opindex Wparentheses
3782 @opindex Wno-parentheses
3783 Warn if parentheses are omitted in certain contexts, such
3784 as when there is an assignment in a context where a truth value
3785 is expected, or when operators are nested whose precedence people
3786 often get confused about.
3788 Also warn if a comparison like @code{x<=y<=z} appears; this is
3789 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3790 interpretation from that of ordinary mathematical notation.
3792 Also warn about constructions where there may be confusion to which
3793 @code{if} statement an @code{else} branch belongs.  Here is an example of
3794 such a case:
3796 @smallexample
3797 @group
3799   if (a)
3800     if (b)
3801       foo ();
3802   else
3803     bar ();
3805 @end group
3806 @end smallexample
3808 In C/C++, every @code{else} branch belongs to the innermost possible
3809 @code{if} statement, which in this example is @code{if (b)}.  This is
3810 often not what the programmer expected, as illustrated in the above
3811 example by indentation the programmer chose.  When there is the
3812 potential for this confusion, GCC issues a warning when this flag
3813 is specified.  To eliminate the warning, add explicit braces around
3814 the innermost @code{if} statement so there is no way the @code{else}
3815 can belong to the enclosing @code{if}.  The resulting code
3816 looks like this:
3818 @smallexample
3819 @group
3821   if (a)
3822     @{
3823       if (b)
3824         foo ();
3825       else
3826         bar ();
3827     @}
3829 @end group
3830 @end smallexample
3832 Also warn for dangerous uses of the GNU extension to
3833 @code{?:} with omitted middle operand. When the condition
3834 in the @code{?}: operator is a boolean expression, the omitted value is
3835 always 1.  Often programmers expect it to be a value computed
3836 inside the conditional expression instead.
3838 This warning is enabled by @option{-Wall}.
3840 @item -Wsequence-point
3841 @opindex Wsequence-point
3842 @opindex Wno-sequence-point
3843 Warn about code that may have undefined semantics because of violations
3844 of sequence point rules in the C and C++ standards.
3846 The C and C++ standards define the order in which expressions in a C/C++
3847 program are evaluated in terms of @dfn{sequence points}, which represent
3848 a partial ordering between the execution of parts of the program: those
3849 executed before the sequence point, and those executed after it.  These
3850 occur after the evaluation of a full expression (one which is not part
3851 of a larger expression), after the evaluation of the first operand of a
3852 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3853 function is called (but after the evaluation of its arguments and the
3854 expression denoting the called function), and in certain other places.
3855 Other than as expressed by the sequence point rules, the order of
3856 evaluation of subexpressions of an expression is not specified.  All
3857 these rules describe only a partial order rather than a total order,
3858 since, for example, if two functions are called within one expression
3859 with no sequence point between them, the order in which the functions
3860 are called is not specified.  However, the standards committee have
3861 ruled that function calls do not overlap.
3863 It is not specified when between sequence points modifications to the
3864 values of objects take effect.  Programs whose behavior depends on this
3865 have undefined behavior; the C and C++ standards specify that ``Between
3866 the previous and next sequence point an object shall have its stored
3867 value modified at most once by the evaluation of an expression.
3868 Furthermore, the prior value shall be read only to determine the value
3869 to be stored.''.  If a program breaks these rules, the results on any
3870 particular implementation are entirely unpredictable.
3872 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3873 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3874 diagnosed by this option, and it may give an occasional false positive
3875 result, but in general it has been found fairly effective at detecting
3876 this sort of problem in programs.
3878 The standard is worded confusingly, therefore there is some debate
3879 over the precise meaning of the sequence point rules in subtle cases.
3880 Links to discussions of the problem, including proposed formal
3881 definitions, may be found on the GCC readings page, at
3882 @uref{http://gcc.gnu.org/@/readings.html}.
3884 This warning is enabled by @option{-Wall} for C and C++.
3886 @item -Wno-return-local-addr
3887 @opindex Wno-return-local-addr
3888 @opindex Wreturn-local-addr
3889 Do not warn about returning a pointer (or in C++, a reference) to a
3890 variable that goes out of scope after the function returns.
3892 @item -Wreturn-type
3893 @opindex Wreturn-type
3894 @opindex Wno-return-type
3895 Warn whenever a function is defined with a return type that defaults
3896 to @code{int}.  Also warn about any @code{return} statement with no
3897 return value in a function whose return type is not @code{void}
3898 (falling off the end of the function body is considered returning
3899 without a value), and about a @code{return} statement with an
3900 expression in a function whose return type is @code{void}.
3902 For C++, a function without return type always produces a diagnostic
3903 message, even when @option{-Wno-return-type} is specified.  The only
3904 exceptions are @code{main} and functions defined in system headers.
3906 This warning is enabled by @option{-Wall}.
3908 @item -Wshift-count-negative
3909 @opindex Wshift-count-negative
3910 @opindex Wno-shift-count-negative
3911 Warn if shift count is negative. This warning is enabled by default.
3913 @item -Wshift-count-overflow
3914 @opindex Wshift-count-overflow
3915 @opindex Wno-shift-count-overflow
3916 Warn if shift count >= width of type. This warning is enabled by default.
3918 @item -Wswitch
3919 @opindex Wswitch
3920 @opindex Wno-switch
3921 Warn whenever a @code{switch} statement has an index of enumerated type
3922 and lacks a @code{case} for one or more of the named codes of that
3923 enumeration.  (The presence of a @code{default} label prevents this
3924 warning.)  @code{case} labels outside the enumeration range also
3925 provoke warnings when this option is used (even if there is a
3926 @code{default} label).
3927 This warning is enabled by @option{-Wall}.
3929 @item -Wswitch-default
3930 @opindex Wswitch-default
3931 @opindex Wno-switch-default
3932 Warn whenever a @code{switch} statement does not have a @code{default}
3933 case.
3935 @item -Wswitch-enum
3936 @opindex Wswitch-enum
3937 @opindex Wno-switch-enum
3938 Warn whenever a @code{switch} statement has an index of enumerated type
3939 and lacks a @code{case} for one or more of the named codes of that
3940 enumeration.  @code{case} labels outside the enumeration range also
3941 provoke warnings when this option is used.  The only difference
3942 between @option{-Wswitch} and this option is that this option gives a
3943 warning about an omitted enumeration code even if there is a
3944 @code{default} label.
3946 @item -Wswitch-bool
3947 @opindex Wswitch-bool
3948 @opindex Wno-switch-bool
3949 Warn whenever a @code{switch} statement has an index of boolean type.
3950 It is possible to suppress this warning by casting the controlling
3951 expression to a type other than @code{bool}.  For example:
3952 @smallexample
3953 @group
3954 switch ((int) (a == 4))
3955   @{
3956   @dots{}
3957   @}
3958 @end group
3959 @end smallexample
3960 This warning is enabled by default for C and C++ programs.
3962 @item -Wsync-nand @r{(C and C++ only)}
3963 @opindex Wsync-nand
3964 @opindex Wno-sync-nand
3965 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3966 built-in functions are used.  These functions changed semantics in GCC 4.4.
3968 @item -Wtrigraphs
3969 @opindex Wtrigraphs
3970 @opindex Wno-trigraphs
3971 Warn if any trigraphs are encountered that might change the meaning of
3972 the program (trigraphs within comments are not warned about).
3973 This warning is enabled by @option{-Wall}.
3975 @item -Wunused-but-set-parameter
3976 @opindex Wunused-but-set-parameter
3977 @opindex Wno-unused-but-set-parameter
3978 Warn whenever a function parameter is assigned to, but otherwise unused
3979 (aside from its declaration).
3981 To suppress this warning use the @code{unused} attribute
3982 (@pxref{Variable Attributes}).
3984 This warning is also enabled by @option{-Wunused} together with
3985 @option{-Wextra}.
3987 @item -Wunused-but-set-variable
3988 @opindex Wunused-but-set-variable
3989 @opindex Wno-unused-but-set-variable
3990 Warn whenever a local variable is assigned to, but otherwise unused
3991 (aside from its declaration).
3992 This warning is enabled by @option{-Wall}.
3994 To suppress this warning use the @code{unused} attribute
3995 (@pxref{Variable Attributes}).
3997 This warning is also enabled by @option{-Wunused}, which is enabled
3998 by @option{-Wall}.
4000 @item -Wunused-function
4001 @opindex Wunused-function
4002 @opindex Wno-unused-function
4003 Warn whenever a static function is declared but not defined or a
4004 non-inline static function is unused.
4005 This warning is enabled by @option{-Wall}.
4007 @item -Wunused-label
4008 @opindex Wunused-label
4009 @opindex Wno-unused-label
4010 Warn whenever a label is declared but not used.
4011 This warning is enabled by @option{-Wall}.
4013 To suppress this warning use the @code{unused} attribute
4014 (@pxref{Variable Attributes}).
4016 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4017 @opindex Wunused-local-typedefs
4018 Warn when a typedef locally defined in a function is not used.
4019 This warning is enabled by @option{-Wall}.
4021 @item -Wunused-parameter
4022 @opindex Wunused-parameter
4023 @opindex Wno-unused-parameter
4024 Warn whenever a function parameter is unused aside from its declaration.
4026 To suppress this warning use the @code{unused} attribute
4027 (@pxref{Variable Attributes}).
4029 @item -Wno-unused-result
4030 @opindex Wunused-result
4031 @opindex Wno-unused-result
4032 Do not warn if a caller of a function marked with attribute
4033 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4034 its return value. The default is @option{-Wunused-result}.
4036 @item -Wunused-variable
4037 @opindex Wunused-variable
4038 @opindex Wno-unused-variable
4039 Warn whenever a local variable or non-constant static variable is unused
4040 aside from its declaration.
4041 This warning is enabled by @option{-Wall}.
4043 To suppress this warning use the @code{unused} attribute
4044 (@pxref{Variable Attributes}).
4046 @item -Wunused-value
4047 @opindex Wunused-value
4048 @opindex Wno-unused-value
4049 Warn whenever a statement computes a result that is explicitly not
4050 used. To suppress this warning cast the unused expression to
4051 @code{void}. This includes an expression-statement or the left-hand
4052 side of a comma expression that contains no side effects. For example,
4053 an expression such as @code{x[i,j]} causes a warning, while
4054 @code{x[(void)i,j]} does not.
4056 This warning is enabled by @option{-Wall}.
4058 @item -Wunused
4059 @opindex Wunused
4060 @opindex Wno-unused
4061 All the above @option{-Wunused} options combined.
4063 In order to get a warning about an unused function parameter, you must
4064 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4065 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4067 @item -Wuninitialized
4068 @opindex Wuninitialized
4069 @opindex Wno-uninitialized
4070 Warn if an automatic variable is used without first being initialized
4071 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4072 warn if a non-static reference or non-static @code{const} member
4073 appears in a class without constructors.
4075 If you want to warn about code that uses the uninitialized value of the
4076 variable in its own initializer, use the @option{-Winit-self} option.
4078 These warnings occur for individual uninitialized or clobbered
4079 elements of structure, union or array variables as well as for
4080 variables that are uninitialized or clobbered as a whole.  They do
4081 not occur for variables or elements declared @code{volatile}.  Because
4082 these warnings depend on optimization, the exact variables or elements
4083 for which there are warnings depends on the precise optimization
4084 options and version of GCC used.
4086 Note that there may be no warning about a variable that is used only
4087 to compute a value that itself is never used, because such
4088 computations may be deleted by data flow analysis before the warnings
4089 are printed.
4091 @item -Wmaybe-uninitialized
4092 @opindex Wmaybe-uninitialized
4093 @opindex Wno-maybe-uninitialized
4094 For an automatic variable, if there exists a path from the function
4095 entry to a use of the variable that is initialized, but there exist
4096 some other paths for which the variable is not initialized, the compiler
4097 emits a warning if it cannot prove the uninitialized paths are not
4098 executed at run time. These warnings are made optional because GCC is
4099 not smart enough to see all the reasons why the code might be correct
4100 in spite of appearing to have an error.  Here is one example of how
4101 this can happen:
4103 @smallexample
4104 @group
4106   int x;
4107   switch (y)
4108     @{
4109     case 1: x = 1;
4110       break;
4111     case 2: x = 4;
4112       break;
4113     case 3: x = 5;
4114     @}
4115   foo (x);
4117 @end group
4118 @end smallexample
4120 @noindent
4121 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4122 always initialized, but GCC doesn't know this. To suppress the
4123 warning, you need to provide a default case with assert(0) or
4124 similar code.
4126 @cindex @code{longjmp} warnings
4127 This option also warns when a non-volatile automatic variable might be
4128 changed by a call to @code{longjmp}.  These warnings as well are possible
4129 only in optimizing compilation.
4131 The compiler sees only the calls to @code{setjmp}.  It cannot know
4132 where @code{longjmp} will be called; in fact, a signal handler could
4133 call it at any point in the code.  As a result, you may get a warning
4134 even when there is in fact no problem because @code{longjmp} cannot
4135 in fact be called at the place that would cause a problem.
4137 Some spurious warnings can be avoided if you declare all the functions
4138 you use that never return as @code{noreturn}.  @xref{Function
4139 Attributes}.
4141 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4143 @item -Wunknown-pragmas
4144 @opindex Wunknown-pragmas
4145 @opindex Wno-unknown-pragmas
4146 @cindex warning for unknown pragmas
4147 @cindex unknown pragmas, warning
4148 @cindex pragmas, warning of unknown
4149 Warn when a @code{#pragma} directive is encountered that is not understood by 
4150 GCC@.  If this command-line option is used, warnings are even issued
4151 for unknown pragmas in system header files.  This is not the case if
4152 the warnings are only enabled by the @option{-Wall} command-line option.
4154 @item -Wno-pragmas
4155 @opindex Wno-pragmas
4156 @opindex Wpragmas
4157 Do not warn about misuses of pragmas, such as incorrect parameters,
4158 invalid syntax, or conflicts between pragmas.  See also
4159 @option{-Wunknown-pragmas}.
4161 @item -Wstrict-aliasing
4162 @opindex Wstrict-aliasing
4163 @opindex Wno-strict-aliasing
4164 This option is only active when @option{-fstrict-aliasing} is active.
4165 It warns about code that might break the strict aliasing rules that the
4166 compiler is using for optimization.  The warning does not catch all
4167 cases, but does attempt to catch the more common pitfalls.  It is
4168 included in @option{-Wall}.
4169 It is equivalent to @option{-Wstrict-aliasing=3}
4171 @item -Wstrict-aliasing=n
4172 @opindex Wstrict-aliasing=n
4173 This option is only active when @option{-fstrict-aliasing} is active.
4174 It warns about code that might break the strict aliasing rules that the
4175 compiler is using for optimization.
4176 Higher levels correspond to higher accuracy (fewer false positives).
4177 Higher levels also correspond to more effort, similar to the way @option{-O} 
4178 works.
4179 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4181 Level 1: Most aggressive, quick, least accurate.
4182 Possibly useful when higher levels
4183 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4184 false negatives.  However, it has many false positives.
4185 Warns for all pointer conversions between possibly incompatible types,
4186 even if never dereferenced.  Runs in the front end only.
4188 Level 2: Aggressive, quick, not too precise.
4189 May still have many false positives (not as many as level 1 though),
4190 and few false negatives (but possibly more than level 1).
4191 Unlike level 1, it only warns when an address is taken.  Warns about
4192 incomplete types.  Runs in the front end only.
4194 Level 3 (default for @option{-Wstrict-aliasing}):
4195 Should have very few false positives and few false
4196 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4197 Takes care of the common pun+dereference pattern in the front end:
4198 @code{*(int*)&some_float}.
4199 If optimization is enabled, it also runs in the back end, where it deals
4200 with multiple statement cases using flow-sensitive points-to information.
4201 Only warns when the converted pointer is dereferenced.
4202 Does not warn about incomplete types.
4204 @item -Wstrict-overflow
4205 @itemx -Wstrict-overflow=@var{n}
4206 @opindex Wstrict-overflow
4207 @opindex Wno-strict-overflow
4208 This option is only active when @option{-fstrict-overflow} is active.
4209 It warns about cases where the compiler optimizes based on the
4210 assumption that signed overflow does not occur.  Note that it does not
4211 warn about all cases where the code might overflow: it only warns
4212 about cases where the compiler implements some optimization.  Thus
4213 this warning depends on the optimization level.
4215 An optimization that assumes that signed overflow does not occur is
4216 perfectly safe if the values of the variables involved are such that
4217 overflow never does, in fact, occur.  Therefore this warning can
4218 easily give a false positive: a warning about code that is not
4219 actually a problem.  To help focus on important issues, several
4220 warning levels are defined.  No warnings are issued for the use of
4221 undefined signed overflow when estimating how many iterations a loop
4222 requires, in particular when determining whether a loop will be
4223 executed at all.
4225 @table @gcctabopt
4226 @item -Wstrict-overflow=1
4227 Warn about cases that are both questionable and easy to avoid.  For
4228 example,  with @option{-fstrict-overflow}, the compiler simplifies
4229 @code{x + 1 > x} to @code{1}.  This level of
4230 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4231 are not, and must be explicitly requested.
4233 @item -Wstrict-overflow=2
4234 Also warn about other cases where a comparison is simplified to a
4235 constant.  For example: @code{abs (x) >= 0}.  This can only be
4236 simplified when @option{-fstrict-overflow} is in effect, because
4237 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4238 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4239 @option{-Wstrict-overflow=2}.
4241 @item -Wstrict-overflow=3
4242 Also warn about other cases where a comparison is simplified.  For
4243 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4245 @item -Wstrict-overflow=4
4246 Also warn about other simplifications not covered by the above cases.
4247 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4249 @item -Wstrict-overflow=5
4250 Also warn about cases where the compiler reduces the magnitude of a
4251 constant involved in a comparison.  For example: @code{x + 2 > y} is
4252 simplified to @code{x + 1 >= y}.  This is reported only at the
4253 highest warning level because this simplification applies to many
4254 comparisons, so this warning level gives a very large number of
4255 false positives.
4256 @end table
4258 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4259 @opindex Wsuggest-attribute=
4260 @opindex Wno-suggest-attribute=
4261 Warn for cases where adding an attribute may be beneficial. The
4262 attributes currently supported are listed below.
4264 @table @gcctabopt
4265 @item -Wsuggest-attribute=pure
4266 @itemx -Wsuggest-attribute=const
4267 @itemx -Wsuggest-attribute=noreturn
4268 @opindex Wsuggest-attribute=pure
4269 @opindex Wno-suggest-attribute=pure
4270 @opindex Wsuggest-attribute=const
4271 @opindex Wno-suggest-attribute=const
4272 @opindex Wsuggest-attribute=noreturn
4273 @opindex Wno-suggest-attribute=noreturn
4275 Warn about functions that might be candidates for attributes
4276 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4277 functions visible in other compilation units or (in the case of @code{pure} and
4278 @code{const}) if it cannot prove that the function returns normally. A function
4279 returns normally if it doesn't contain an infinite loop or return abnormally
4280 by throwing, calling @code{abort} or trapping.  This analysis requires option
4281 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4282 higher.  Higher optimization levels improve the accuracy of the analysis.
4284 @item -Wsuggest-attribute=format
4285 @itemx -Wmissing-format-attribute
4286 @opindex Wsuggest-attribute=format
4287 @opindex Wmissing-format-attribute
4288 @opindex Wno-suggest-attribute=format
4289 @opindex Wno-missing-format-attribute
4290 @opindex Wformat
4291 @opindex Wno-format
4293 Warn about function pointers that might be candidates for @code{format}
4294 attributes.  Note these are only possible candidates, not absolute ones.
4295 GCC guesses that function pointers with @code{format} attributes that
4296 are used in assignment, initialization, parameter passing or return
4297 statements should have a corresponding @code{format} attribute in the
4298 resulting type.  I.e.@: the left-hand side of the assignment or
4299 initialization, the type of the parameter variable, or the return type
4300 of the containing function respectively should also have a @code{format}
4301 attribute to avoid the warning.
4303 GCC also warns about function definitions that might be
4304 candidates for @code{format} attributes.  Again, these are only
4305 possible candidates.  GCC guesses that @code{format} attributes
4306 might be appropriate for any function that calls a function like
4307 @code{vprintf} or @code{vscanf}, but this might not always be the
4308 case, and some functions for which @code{format} attributes are
4309 appropriate may not be detected.
4310 @end table
4312 @item -Wsuggest-final-types
4313 @opindex Wno-suggest-final-types
4314 @opindex Wsuggest-final-types
4315 Warn about types with virtual methods where code quality would be improved
4316 if the type were declared with the C++11 @code{final} specifier, 
4317 or, if possible,
4318 declared in an anonymous namespace. This allows GCC to more aggressively
4319 devirtualize the polymorphic calls. This warning is more effective with link
4320 time optimization, where the information about the class hierarchy graph is
4321 more complete.
4323 @item -Wsuggest-final-methods
4324 @opindex Wno-suggest-final-methods
4325 @opindex Wsuggest-final-methods
4326 Warn about virtual methods where code quality would be improved if the method
4327 were declared with the C++11 @code{final} specifier, 
4328 or, if possible, its type were
4329 declared in an anonymous namespace or with the @code{final} specifier.
4330 This warning is
4331 more effective with link time optimization, where the information about the
4332 class hierarchy graph is more complete. It is recommended to first consider
4333 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4334 annotations.
4336 @item -Wsuggest-override
4337 Warn about overriding virtual functions that are not marked with the override
4338 keyword.
4340 @item -Warray-bounds
4341 @itemx -Warray-bounds=@var{n}
4342 @opindex Wno-array-bounds
4343 @opindex Warray-bounds
4344 This option is only active when @option{-ftree-vrp} is active
4345 (default for @option{-O2} and above). It warns about subscripts to arrays
4346 that are always out of bounds. This warning is enabled by @option{-Wall}.
4348 @table @gcctabopt
4349 @item -Warray-bounds=1
4350 This is the warning level of @option{-Warray-bounds} and is enabled
4351 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4353 @item -Warray-bounds=2
4354 This warning level also warns about out of bounds access for
4355 arrays at the end of a struct and for arrays accessed through
4356 pointers. This warning level may give a larger number of
4357 false positives and is deactivated by default.
4358 @end table
4360 @item -Wbool-compare
4361 @opindex Wno-bool-compare
4362 @opindex Wbool-compare
4363 Warn about boolean expression compared with an integer value different from
4364 @code{true}/@code{false}.  For instance, the following comparison is
4365 always false:
4366 @smallexample
4367 int n = 5;
4368 @dots{}
4369 if ((n > 1) == 2) @{ @dots{} @}
4370 @end smallexample
4371 This warning is enabled by @option{-Wall}.
4373 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4374 @opindex Wno-discarded-qualifiers
4375 @opindex Wdiscarded-qualifiers
4376 Do not warn if type qualifiers on pointers are being discarded.
4377 Typically, the compiler warns if a @code{const char *} variable is
4378 passed to a function that takes a @code{char *} parameter.  This option
4379 can be used to suppress such a warning.
4381 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4382 @opindex Wno-discarded-array-qualifiers
4383 @opindex Wdiscarded-array-qualifiers
4384 Do not warn if type qualifiers on arrays which are pointer targets
4385 are being discarded. Typically, the compiler warns if a
4386 @code{const int (*)[]} variable is passed to a function that
4387 takes a @code{int (*)[]} parameter.  This option can be used to
4388 suppress such a warning.
4390 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4391 @opindex Wno-incompatible-pointer-types
4392 @opindex Wincompatible-pointer-types
4393 Do not warn when there is a conversion between pointers that have incompatible
4394 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4395 which warns for pointer argument passing or assignment with different
4396 signedness.
4398 @item -Wno-int-conversion @r{(C and Objective-C only)}
4399 @opindex Wno-int-conversion
4400 @opindex Wint-conversion
4401 Do not warn about incompatible integer to pointer and pointer to integer
4402 conversions.  This warning is about implicit conversions; for explicit
4403 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4404 @option{-Wno-pointer-to-int-cast} may be used.
4406 @item -Wno-div-by-zero
4407 @opindex Wno-div-by-zero
4408 @opindex Wdiv-by-zero
4409 Do not warn about compile-time integer division by zero.  Floating-point
4410 division by zero is not warned about, as it can be a legitimate way of
4411 obtaining infinities and NaNs.
4413 @item -Wsystem-headers
4414 @opindex Wsystem-headers
4415 @opindex Wno-system-headers
4416 @cindex warnings from system headers
4417 @cindex system headers, warnings from
4418 Print warning messages for constructs found in system header files.
4419 Warnings from system headers are normally suppressed, on the assumption
4420 that they usually do not indicate real problems and would only make the
4421 compiler output harder to read.  Using this command-line option tells
4422 GCC to emit warnings from system headers as if they occurred in user
4423 code.  However, note that using @option{-Wall} in conjunction with this
4424 option does @emph{not} warn about unknown pragmas in system
4425 headers---for that, @option{-Wunknown-pragmas} must also be used.
4427 @item -Wtrampolines
4428 @opindex Wtrampolines
4429 @opindex Wno-trampolines
4430 Warn about trampolines generated for pointers to nested functions.
4431 A trampoline is a small piece of data or code that is created at run
4432 time on the stack when the address of a nested function is taken, and is
4433 used to call the nested function indirectly.  For some targets, it is
4434 made up of data only and thus requires no special treatment.  But, for
4435 most targets, it is made up of code and thus requires the stack to be
4436 made executable in order for the program to work properly.
4438 @item -Wfloat-equal
4439 @opindex Wfloat-equal
4440 @opindex Wno-float-equal
4441 Warn if floating-point values are used in equality comparisons.
4443 The idea behind this is that sometimes it is convenient (for the
4444 programmer) to consider floating-point values as approximations to
4445 infinitely precise real numbers.  If you are doing this, then you need
4446 to compute (by analyzing the code, or in some other way) the maximum or
4447 likely maximum error that the computation introduces, and allow for it
4448 when performing comparisons (and when producing output, but that's a
4449 different problem).  In particular, instead of testing for equality, you
4450 should check to see whether the two values have ranges that overlap; and
4451 this is done with the relational operators, so equality comparisons are
4452 probably mistaken.
4454 @item -Wtraditional @r{(C and Objective-C only)}
4455 @opindex Wtraditional
4456 @opindex Wno-traditional
4457 Warn about certain constructs that behave differently in traditional and
4458 ISO C@.  Also warn about ISO C constructs that have no traditional C
4459 equivalent, and/or problematic constructs that should be avoided.
4461 @itemize @bullet
4462 @item
4463 Macro parameters that appear within string literals in the macro body.
4464 In traditional C macro replacement takes place within string literals,
4465 but in ISO C it does not.
4467 @item
4468 In traditional C, some preprocessor directives did not exist.
4469 Traditional preprocessors only considered a line to be a directive
4470 if the @samp{#} appeared in column 1 on the line.  Therefore
4471 @option{-Wtraditional} warns about directives that traditional C
4472 understands but ignores because the @samp{#} does not appear as the
4473 first character on the line.  It also suggests you hide directives like
4474 @code{#pragma} not understood by traditional C by indenting them.  Some
4475 traditional implementations do not recognize @code{#elif}, so this option
4476 suggests avoiding it altogether.
4478 @item
4479 A function-like macro that appears without arguments.
4481 @item
4482 The unary plus operator.
4484 @item
4485 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4486 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4487 constants.)  Note, these suffixes appear in macros defined in the system
4488 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4489 Use of these macros in user code might normally lead to spurious
4490 warnings, however GCC's integrated preprocessor has enough context to
4491 avoid warning in these cases.
4493 @item
4494 A function declared external in one block and then used after the end of
4495 the block.
4497 @item
4498 A @code{switch} statement has an operand of type @code{long}.
4500 @item
4501 A non-@code{static} function declaration follows a @code{static} one.
4502 This construct is not accepted by some traditional C compilers.
4504 @item
4505 The ISO type of an integer constant has a different width or
4506 signedness from its traditional type.  This warning is only issued if
4507 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4508 typically represent bit patterns, are not warned about.
4510 @item
4511 Usage of ISO string concatenation is detected.
4513 @item
4514 Initialization of automatic aggregates.
4516 @item
4517 Identifier conflicts with labels.  Traditional C lacks a separate
4518 namespace for labels.
4520 @item
4521 Initialization of unions.  If the initializer is zero, the warning is
4522 omitted.  This is done under the assumption that the zero initializer in
4523 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4524 initializer warnings and relies on default initialization to zero in the
4525 traditional C case.
4527 @item
4528 Conversions by prototypes between fixed/floating-point values and vice
4529 versa.  The absence of these prototypes when compiling with traditional
4530 C causes serious problems.  This is a subset of the possible
4531 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4533 @item
4534 Use of ISO C style function definitions.  This warning intentionally is
4535 @emph{not} issued for prototype declarations or variadic functions
4536 because these ISO C features appear in your code when using
4537 libiberty's traditional C compatibility macros, @code{PARAMS} and
4538 @code{VPARAMS}.  This warning is also bypassed for nested functions
4539 because that feature is already a GCC extension and thus not relevant to
4540 traditional C compatibility.
4541 @end itemize
4543 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4544 @opindex Wtraditional-conversion
4545 @opindex Wno-traditional-conversion
4546 Warn if a prototype causes a type conversion that is different from what
4547 would happen to the same argument in the absence of a prototype.  This
4548 includes conversions of fixed point to floating and vice versa, and
4549 conversions changing the width or signedness of a fixed-point argument
4550 except when the same as the default promotion.
4552 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4553 @opindex Wdeclaration-after-statement
4554 @opindex Wno-declaration-after-statement
4555 Warn when a declaration is found after a statement in a block.  This
4556 construct, known from C++, was introduced with ISO C99 and is by default
4557 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4559 @item -Wundef
4560 @opindex Wundef
4561 @opindex Wno-undef
4562 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4564 @item -Wno-endif-labels
4565 @opindex Wno-endif-labels
4566 @opindex Wendif-labels
4567 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4569 @item -Wshadow
4570 @opindex Wshadow
4571 @opindex Wno-shadow
4572 Warn whenever a local variable or type declaration shadows another
4573 variable, parameter, type, class member (in C++), or instance variable
4574 (in Objective-C) or whenever a built-in function is shadowed. Note
4575 that in C++, the compiler warns if a local variable shadows an
4576 explicit typedef, but not if it shadows a struct/class/enum.
4578 @item -Wno-shadow-ivar @r{(Objective-C only)}
4579 @opindex Wno-shadow-ivar
4580 @opindex Wshadow-ivar
4581 Do not warn whenever a local variable shadows an instance variable in an
4582 Objective-C method.
4584 @item -Wlarger-than=@var{len}
4585 @opindex Wlarger-than=@var{len}
4586 @opindex Wlarger-than-@var{len}
4587 Warn whenever an object of larger than @var{len} bytes is defined.
4589 @item -Wframe-larger-than=@var{len}
4590 @opindex Wframe-larger-than
4591 Warn if the size of a function frame is larger than @var{len} bytes.
4592 The computation done to determine the stack frame size is approximate
4593 and not conservative.
4594 The actual requirements may be somewhat greater than @var{len}
4595 even if you do not get a warning.  In addition, any space allocated
4596 via @code{alloca}, variable-length arrays, or related constructs
4597 is not included by the compiler when determining
4598 whether or not to issue a warning.
4600 @item -Wno-free-nonheap-object
4601 @opindex Wno-free-nonheap-object
4602 @opindex Wfree-nonheap-object
4603 Do not warn when attempting to free an object that was not allocated
4604 on the heap.
4606 @item -Wstack-usage=@var{len}
4607 @opindex Wstack-usage
4608 Warn if the stack usage of a function might be larger than @var{len} bytes.
4609 The computation done to determine the stack usage is conservative.
4610 Any space allocated via @code{alloca}, variable-length arrays, or related
4611 constructs is included by the compiler when determining whether or not to
4612 issue a warning.
4614 The message is in keeping with the output of @option{-fstack-usage}.
4616 @itemize
4617 @item
4618 If the stack usage is fully static but exceeds the specified amount, it's:
4620 @smallexample
4621   warning: stack usage is 1120 bytes
4622 @end smallexample
4623 @item
4624 If the stack usage is (partly) dynamic but bounded, it's:
4626 @smallexample
4627   warning: stack usage might be 1648 bytes
4628 @end smallexample
4629 @item
4630 If the stack usage is (partly) dynamic and not bounded, it's:
4632 @smallexample
4633   warning: stack usage might be unbounded
4634 @end smallexample
4635 @end itemize
4637 @item -Wunsafe-loop-optimizations
4638 @opindex Wunsafe-loop-optimizations
4639 @opindex Wno-unsafe-loop-optimizations
4640 Warn if the loop cannot be optimized because the compiler cannot
4641 assume anything on the bounds of the loop indices.  With
4642 @option{-funsafe-loop-optimizations} warn if the compiler makes
4643 such assumptions.
4645 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4646 @opindex Wno-pedantic-ms-format
4647 @opindex Wpedantic-ms-format
4648 When used in combination with @option{-Wformat}
4649 and @option{-pedantic} without GNU extensions, this option
4650 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4651 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4652 which depend on the MS runtime.
4654 @item -Wpointer-arith
4655 @opindex Wpointer-arith
4656 @opindex Wno-pointer-arith
4657 Warn about anything that depends on the ``size of'' a function type or
4658 of @code{void}.  GNU C assigns these types a size of 1, for
4659 convenience in calculations with @code{void *} pointers and pointers
4660 to functions.  In C++, warn also when an arithmetic operation involves
4661 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4663 @item -Wtype-limits
4664 @opindex Wtype-limits
4665 @opindex Wno-type-limits
4666 Warn if a comparison is always true or always false due to the limited
4667 range of the data type, but do not warn for constant expressions.  For
4668 example, warn if an unsigned variable is compared against zero with
4669 @code{<} or @code{>=}.  This warning is also enabled by
4670 @option{-Wextra}.
4672 @item -Wbad-function-cast @r{(C and Objective-C only)}
4673 @opindex Wbad-function-cast
4674 @opindex Wno-bad-function-cast
4675 Warn when a function call is cast to a non-matching type.
4676 For example, warn if a call to a function returning an integer type 
4677 is cast to a pointer type.
4679 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4680 @opindex Wc90-c99-compat
4681 @opindex Wno-c90-c99-compat
4682 Warn about features not present in ISO C90, but present in ISO C99.
4683 For instance, warn about use of variable length arrays, @code{long long}
4684 type, @code{bool} type, compound literals, designated initializers, and so
4685 on.  This option is independent of the standards mode.  Warnings are disabled
4686 in the expression that follows @code{__extension__}.
4688 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4689 @opindex Wc99-c11-compat
4690 @opindex Wno-c99-c11-compat
4691 Warn about features not present in ISO C99, but present in ISO C11.
4692 For instance, warn about use of anonymous structures and unions,
4693 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4694 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4695 and so on.  This option is independent of the standards mode.  Warnings are
4696 disabled in the expression that follows @code{__extension__}.
4698 @item -Wc++-compat @r{(C and Objective-C only)}
4699 @opindex Wc++-compat
4700 Warn about ISO C constructs that are outside of the common subset of
4701 ISO C and ISO C++, e.g.@: request for implicit conversion from
4702 @code{void *} to a pointer to non-@code{void} type.
4704 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4705 @opindex Wc++11-compat
4706 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4707 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4708 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4709 enabled by @option{-Wall}.
4711 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4712 @opindex Wc++14-compat
4713 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4714 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4716 @item -Wcast-qual
4717 @opindex Wcast-qual
4718 @opindex Wno-cast-qual
4719 Warn whenever a pointer is cast so as to remove a type qualifier from
4720 the target type.  For example, warn if a @code{const char *} is cast
4721 to an ordinary @code{char *}.
4723 Also warn when making a cast that introduces a type qualifier in an
4724 unsafe way.  For example, casting @code{char **} to @code{const char **}
4725 is unsafe, as in this example:
4727 @smallexample
4728   /* p is char ** value.  */
4729   const char **q = (const char **) p;
4730   /* Assignment of readonly string to const char * is OK.  */
4731   *q = "string";
4732   /* Now char** pointer points to read-only memory.  */
4733   **p = 'b';
4734 @end smallexample
4736 @item -Wcast-align
4737 @opindex Wcast-align
4738 @opindex Wno-cast-align
4739 Warn whenever a pointer is cast such that the required alignment of the
4740 target is increased.  For example, warn if a @code{char *} is cast to
4741 an @code{int *} on machines where integers can only be accessed at
4742 two- or four-byte boundaries.
4744 @item -Wwrite-strings
4745 @opindex Wwrite-strings
4746 @opindex Wno-write-strings
4747 When compiling C, give string constants the type @code{const
4748 char[@var{length}]} so that copying the address of one into a
4749 non-@code{const} @code{char *} pointer produces a warning.  These
4750 warnings help you find at compile time code that can try to write
4751 into a string constant, but only if you have been very careful about
4752 using @code{const} in declarations and prototypes.  Otherwise, it is
4753 just a nuisance. This is why we did not make @option{-Wall} request
4754 these warnings.
4756 When compiling C++, warn about the deprecated conversion from string
4757 literals to @code{char *}.  This warning is enabled by default for C++
4758 programs.
4760 @item -Wclobbered
4761 @opindex Wclobbered
4762 @opindex Wno-clobbered
4763 Warn for variables that might be changed by @code{longjmp} or
4764 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
4766 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4767 @opindex Wconditionally-supported
4768 @opindex Wno-conditionally-supported
4769 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4771 @item -Wconversion
4772 @opindex Wconversion
4773 @opindex Wno-conversion
4774 Warn for implicit conversions that may alter a value. This includes
4775 conversions between real and integer, like @code{abs (x)} when
4776 @code{x} is @code{double}; conversions between signed and unsigned,
4777 like @code{unsigned ui = -1}; and conversions to smaller types, like
4778 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4779 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4780 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4781 conversions between signed and unsigned integers can be disabled by
4782 using @option{-Wno-sign-conversion}.
4784 For C++, also warn for confusing overload resolution for user-defined
4785 conversions; and conversions that never use a type conversion
4786 operator: conversions to @code{void}, the same type, a base class or a
4787 reference to them. Warnings about conversions between signed and
4788 unsigned integers are disabled by default in C++ unless
4789 @option{-Wsign-conversion} is explicitly enabled.
4791 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4792 @opindex Wconversion-null
4793 @opindex Wno-conversion-null
4794 Do not warn for conversions between @code{NULL} and non-pointer
4795 types. @option{-Wconversion-null} is enabled by default.
4797 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4798 @opindex Wzero-as-null-pointer-constant
4799 @opindex Wno-zero-as-null-pointer-constant
4800 Warn when a literal '0' is used as null pointer constant.  This can
4801 be useful to facilitate the conversion to @code{nullptr} in C++11.
4803 @item -Wdate-time
4804 @opindex Wdate-time
4805 @opindex Wno-date-time
4806 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4807 are encountered as they might prevent bit-wise-identical reproducible
4808 compilations.
4810 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4811 @opindex Wdelete-incomplete
4812 @opindex Wno-delete-incomplete
4813 Warn when deleting a pointer to incomplete type, which may cause
4814 undefined behavior at runtime.  This warning is enabled by default.
4816 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4817 @opindex Wuseless-cast
4818 @opindex Wno-useless-cast
4819 Warn when an expression is casted to its own type.
4821 @item -Wempty-body
4822 @opindex Wempty-body
4823 @opindex Wno-empty-body
4824 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
4825 while} statement.  This warning is also enabled by @option{-Wextra}.
4827 @item -Wenum-compare
4828 @opindex Wenum-compare
4829 @opindex Wno-enum-compare
4830 Warn about a comparison between values of different enumerated types.
4831 In C++ enumeral mismatches in conditional expressions are also
4832 diagnosed and the warning is enabled by default.  In C this warning is 
4833 enabled by @option{-Wall}.
4835 @item -Wjump-misses-init @r{(C, Objective-C only)}
4836 @opindex Wjump-misses-init
4837 @opindex Wno-jump-misses-init
4838 Warn if a @code{goto} statement or a @code{switch} statement jumps
4839 forward across the initialization of a variable, or jumps backward to a
4840 label after the variable has been initialized.  This only warns about
4841 variables that are initialized when they are declared.  This warning is
4842 only supported for C and Objective-C; in C++ this sort of branch is an
4843 error in any case.
4845 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4846 can be disabled with the @option{-Wno-jump-misses-init} option.
4848 @item -Wsign-compare
4849 @opindex Wsign-compare
4850 @opindex Wno-sign-compare
4851 @cindex warning for comparison of signed and unsigned values
4852 @cindex comparison of signed and unsigned values, warning
4853 @cindex signed and unsigned values, comparison warning
4854 Warn when a comparison between signed and unsigned values could produce
4855 an incorrect result when the signed value is converted to unsigned.
4856 This warning is also enabled by @option{-Wextra}; to get the other warnings
4857 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4859 @item -Wsign-conversion
4860 @opindex Wsign-conversion
4861 @opindex Wno-sign-conversion
4862 Warn for implicit conversions that may change the sign of an integer
4863 value, like assigning a signed integer expression to an unsigned
4864 integer variable. An explicit cast silences the warning. In C, this
4865 option is enabled also by @option{-Wconversion}.
4867 @item -Wfloat-conversion
4868 @opindex Wfloat-conversion
4869 @opindex Wno-float-conversion
4870 Warn for implicit conversions that reduce the precision of a real value.
4871 This includes conversions from real to integer, and from higher precision
4872 real to lower precision real values.  This option is also enabled by
4873 @option{-Wconversion}.
4875 @item -Wno-scalar-storage-order
4876 @opindex -Wno-scalar-storage-order
4877 @opindex -Wscalar-storage-order
4878 Do not warn on suspicious constructs involving reverse scalar storage order.
4880 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4881 @opindex Wsized-deallocation
4882 @opindex Wno-sized-deallocation
4883 Warn about a definition of an unsized deallocation function
4884 @smallexample
4885 void operator delete (void *) noexcept;
4886 void operator delete[] (void *) noexcept;
4887 @end smallexample
4888 without a definition of the corresponding sized deallocation function
4889 @smallexample
4890 void operator delete (void *, std::size_t) noexcept;
4891 void operator delete[] (void *, std::size_t) noexcept;
4892 @end smallexample
4893 or vice versa.  Enabled by @option{-Wextra} along with
4894 @option{-fsized-deallocation}.
4896 @item -Wsizeof-pointer-memaccess
4897 @opindex Wsizeof-pointer-memaccess
4898 @opindex Wno-sizeof-pointer-memaccess
4899 Warn for suspicious length parameters to certain string and memory built-in
4900 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4901 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4902 but a pointer, and suggests a possible fix, or about
4903 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4904 @option{-Wall}.
4906 @item -Wsizeof-array-argument
4907 @opindex Wsizeof-array-argument
4908 @opindex Wno-sizeof-array-argument
4909 Warn when the @code{sizeof} operator is applied to a parameter that is
4910 declared as an array in a function definition.  This warning is enabled by
4911 default for C and C++ programs.
4913 @item -Wmemset-transposed-args
4914 @opindex Wmemset-transposed-args
4915 @opindex Wno-memset-transposed-args
4916 Warn for suspicious calls to the @code{memset} built-in function, if the
4917 second argument is not zero and the third argument is zero.  This warns e.g.@
4918 about @code{memset (buf, sizeof buf, 0)} where most probably
4919 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4920 is only emitted if the third argument is literal zero.  If it is some
4921 expression that is folded to zero, a cast of zero to some type, etc., 
4922 it is far less likely that the user has mistakenly exchanged the arguments 
4923 and no warning is emitted.  This warning is enabled by @option{-Wall}.
4925 @item -Waddress
4926 @opindex Waddress
4927 @opindex Wno-address
4928 Warn about suspicious uses of memory addresses. These include using
4929 the address of a function in a conditional expression, such as
4930 @code{void func(void); if (func)}, and comparisons against the memory
4931 address of a string literal, such as @code{if (x == "abc")}.  Such
4932 uses typically indicate a programmer error: the address of a function
4933 always evaluates to true, so their use in a conditional usually
4934 indicate that the programmer forgot the parentheses in a function
4935 call; and comparisons against string literals result in unspecified
4936 behavior and are not portable in C, so they usually indicate that the
4937 programmer intended to use @code{strcmp}.  This warning is enabled by
4938 @option{-Wall}.
4940 @item -Wlogical-op
4941 @opindex Wlogical-op
4942 @opindex Wno-logical-op
4943 Warn about suspicious uses of logical operators in expressions.
4944 This includes using logical operators in contexts where a
4945 bit-wise operator is likely to be expected.  Also warns when
4946 the operands of a logical operator are the same:
4947 @smallexample
4948 extern int a;
4949 if (a < 0 && a < 0) @{ @dots{} @}
4950 @end smallexample
4952 @item -Wlogical-not-parentheses
4953 @opindex Wlogical-not-parentheses
4954 @opindex Wno-logical-not-parentheses
4955 Warn about logical not used on the left hand side operand of a comparison.
4956 This option does not warn if the RHS operand is of a boolean type.  Its
4957 purpose is to detect suspicious code like the following:
4958 @smallexample
4959 int a;
4960 @dots{}
4961 if (!a > 1) @{ @dots{} @}
4962 @end smallexample
4964 It is possible to suppress the warning by wrapping the LHS into
4965 parentheses:
4966 @smallexample
4967 if ((!a) > 1) @{ @dots{} @}
4968 @end smallexample
4970 This warning is enabled by @option{-Wall}.
4972 @item -Waggregate-return
4973 @opindex Waggregate-return
4974 @opindex Wno-aggregate-return
4975 Warn if any functions that return structures or unions are defined or
4976 called.  (In languages where you can return an array, this also elicits
4977 a warning.)
4979 @item -Wno-aggressive-loop-optimizations
4980 @opindex Wno-aggressive-loop-optimizations
4981 @opindex Waggressive-loop-optimizations
4982 Warn if in a loop with constant number of iterations the compiler detects
4983 undefined behavior in some statement during one or more of the iterations.
4985 @item -Wno-attributes
4986 @opindex Wno-attributes
4987 @opindex Wattributes
4988 Do not warn if an unexpected @code{__attribute__} is used, such as
4989 unrecognized attributes, function attributes applied to variables,
4990 etc.  This does not stop errors for incorrect use of supported
4991 attributes.
4993 @item -Wno-builtin-macro-redefined
4994 @opindex Wno-builtin-macro-redefined
4995 @opindex Wbuiltin-macro-redefined
4996 Do not warn if certain built-in macros are redefined.  This suppresses
4997 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4998 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5000 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5001 @opindex Wstrict-prototypes
5002 @opindex Wno-strict-prototypes
5003 Warn if a function is declared or defined without specifying the
5004 argument types.  (An old-style function definition is permitted without
5005 a warning if preceded by a declaration that specifies the argument
5006 types.)
5008 @item -Wold-style-declaration @r{(C and Objective-C only)}
5009 @opindex Wold-style-declaration
5010 @opindex Wno-old-style-declaration
5011 Warn for obsolescent usages, according to the C Standard, in a
5012 declaration. For example, warn if storage-class specifiers like
5013 @code{static} are not the first things in a declaration.  This warning
5014 is also enabled by @option{-Wextra}.
5016 @item -Wold-style-definition @r{(C and Objective-C only)}
5017 @opindex Wold-style-definition
5018 @opindex Wno-old-style-definition
5019 Warn if an old-style function definition is used.  A warning is given
5020 even if there is a previous prototype.
5022 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5023 @opindex Wmissing-parameter-type
5024 @opindex Wno-missing-parameter-type
5025 A function parameter is declared without a type specifier in K&R-style
5026 functions:
5028 @smallexample
5029 void foo(bar) @{ @}
5030 @end smallexample
5032 This warning is also enabled by @option{-Wextra}.
5034 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5035 @opindex Wmissing-prototypes
5036 @opindex Wno-missing-prototypes
5037 Warn if a global function is defined without a previous prototype
5038 declaration.  This warning is issued even if the definition itself
5039 provides a prototype.  Use this option to detect global functions
5040 that do not have a matching prototype declaration in a header file.
5041 This option is not valid for C++ because all function declarations
5042 provide prototypes and a non-matching declaration declares an
5043 overload rather than conflict with an earlier declaration.
5044 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5046 @item -Wmissing-declarations
5047 @opindex Wmissing-declarations
5048 @opindex Wno-missing-declarations
5049 Warn if a global function is defined without a previous declaration.
5050 Do so even if the definition itself provides a prototype.
5051 Use this option to detect global functions that are not declared in
5052 header files.  In C, no warnings are issued for functions with previous
5053 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5054 missing prototypes.  In C++, no warnings are issued for function templates,
5055 or for inline functions, or for functions in anonymous namespaces.
5057 @item -Wmissing-field-initializers
5058 @opindex Wmissing-field-initializers
5059 @opindex Wno-missing-field-initializers
5060 @opindex W
5061 @opindex Wextra
5062 @opindex Wno-extra
5063 Warn if a structure's initializer has some fields missing.  For
5064 example, the following code causes such a warning, because
5065 @code{x.h} is implicitly zero:
5067 @smallexample
5068 struct s @{ int f, g, h; @};
5069 struct s x = @{ 3, 4 @};
5070 @end smallexample
5072 This option does not warn about designated initializers, so the following
5073 modification does not trigger a warning:
5075 @smallexample
5076 struct s @{ int f, g, h; @};
5077 struct s x = @{ .f = 3, .g = 4 @};
5078 @end smallexample
5080 In C++ this option does not warn either about the empty @{ @}
5081 initializer, for example:
5083 @smallexample
5084 struct s @{ int f, g, h; @};
5085 s x = @{ @};
5086 @end smallexample
5088 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5089 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5091 @item -Wno-multichar
5092 @opindex Wno-multichar
5093 @opindex Wmultichar
5094 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5095 Usually they indicate a typo in the user's code, as they have
5096 implementation-defined values, and should not be used in portable code.
5098 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5099 @opindex Wnormalized=
5100 @opindex Wnormalized
5101 @opindex Wno-normalized
5102 @cindex NFC
5103 @cindex NFKC
5104 @cindex character set, input normalization
5105 In ISO C and ISO C++, two identifiers are different if they are
5106 different sequences of characters.  However, sometimes when characters
5107 outside the basic ASCII character set are used, you can have two
5108 different character sequences that look the same.  To avoid confusion,
5109 the ISO 10646 standard sets out some @dfn{normalization rules} which
5110 when applied ensure that two sequences that look the same are turned into
5111 the same sequence.  GCC can warn you if you are using identifiers that
5112 have not been normalized; this option controls that warning.
5114 There are four levels of warning supported by GCC@.  The default is
5115 @option{-Wnormalized=nfc}, which warns about any identifier that is
5116 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5117 recommended form for most uses.  It is equivalent to
5118 @option{-Wnormalized}.
5120 Unfortunately, there are some characters allowed in identifiers by
5121 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5122 identifiers.  That is, there's no way to use these symbols in portable
5123 ISO C or C++ and have all your identifiers in NFC@.
5124 @option{-Wnormalized=id} suppresses the warning for these characters.
5125 It is hoped that future versions of the standards involved will correct
5126 this, which is why this option is not the default.
5128 You can switch the warning off for all characters by writing
5129 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5130 only do this if you are using some other normalization scheme (like
5131 ``D''), because otherwise you can easily create bugs that are
5132 literally impossible to see.
5134 Some characters in ISO 10646 have distinct meanings but look identical
5135 in some fonts or display methodologies, especially once formatting has
5136 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5137 LETTER N'', displays just like a regular @code{n} that has been
5138 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5139 normalization scheme to convert all these into a standard form as
5140 well, and GCC warns if your code is not in NFKC if you use
5141 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5142 about every identifier that contains the letter O because it might be
5143 confused with the digit 0, and so is not the default, but may be
5144 useful as a local coding convention if the programming environment 
5145 cannot be fixed to display these characters distinctly.
5147 @item -Wno-deprecated
5148 @opindex Wno-deprecated
5149 @opindex Wdeprecated
5150 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5152 @item -Wno-deprecated-declarations
5153 @opindex Wno-deprecated-declarations
5154 @opindex Wdeprecated-declarations
5155 Do not warn about uses of functions (@pxref{Function Attributes}),
5156 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5157 Attributes}) marked as deprecated by using the @code{deprecated}
5158 attribute.
5160 @item -Wno-overflow
5161 @opindex Wno-overflow
5162 @opindex Woverflow
5163 Do not warn about compile-time overflow in constant expressions.
5165 @item -Wno-odr
5166 @opindex Wno-odr
5167 @opindex Wodr
5168 Warn about One Definition Rule violations during link-time optimization.
5169 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5171 @item -Wopenmp-simd
5172 @opindex Wopenm-simd
5173 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5174 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5175 option can be used to relax the cost model.
5177 @item -Woverride-init @r{(C and Objective-C only)}
5178 @opindex Woverride-init
5179 @opindex Wno-override-init
5180 @opindex W
5181 @opindex Wextra
5182 @opindex Wno-extra
5183 Warn if an initialized field without side effects is overridden when
5184 using designated initializers (@pxref{Designated Inits, , Designated
5185 Initializers}).
5187 This warning is included in @option{-Wextra}.  To get other
5188 @option{-Wextra} warnings without this one, use @option{-Wextra
5189 -Wno-override-init}.
5191 @item -Wpacked
5192 @opindex Wpacked
5193 @opindex Wno-packed
5194 Warn if a structure is given the packed attribute, but the packed
5195 attribute has no effect on the layout or size of the structure.
5196 Such structures may be mis-aligned for little benefit.  For
5197 instance, in this code, the variable @code{f.x} in @code{struct bar}
5198 is misaligned even though @code{struct bar} does not itself
5199 have the packed attribute:
5201 @smallexample
5202 @group
5203 struct foo @{
5204   int x;
5205   char a, b, c, d;
5206 @} __attribute__((packed));
5207 struct bar @{
5208   char z;
5209   struct foo f;
5211 @end group
5212 @end smallexample
5214 @item -Wpacked-bitfield-compat
5215 @opindex Wpacked-bitfield-compat
5216 @opindex Wno-packed-bitfield-compat
5217 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5218 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5219 the change can lead to differences in the structure layout.  GCC
5220 informs you when the offset of such a field has changed in GCC 4.4.
5221 For example there is no longer a 4-bit padding between field @code{a}
5222 and @code{b} in this structure:
5224 @smallexample
5225 struct foo
5227   char a:4;
5228   char b:8;
5229 @} __attribute__ ((packed));
5230 @end smallexample
5232 This warning is enabled by default.  Use
5233 @option{-Wno-packed-bitfield-compat} to disable this warning.
5235 @item -Wpadded
5236 @opindex Wpadded
5237 @opindex Wno-padded
5238 Warn if padding is included in a structure, either to align an element
5239 of the structure or to align the whole structure.  Sometimes when this
5240 happens it is possible to rearrange the fields of the structure to
5241 reduce the padding and so make the structure smaller.
5243 @item -Wredundant-decls
5244 @opindex Wredundant-decls
5245 @opindex Wno-redundant-decls
5246 Warn if anything is declared more than once in the same scope, even in
5247 cases where multiple declaration is valid and changes nothing.
5249 @item -Wnested-externs @r{(C and Objective-C only)}
5250 @opindex Wnested-externs
5251 @opindex Wno-nested-externs
5252 Warn if an @code{extern} declaration is encountered within a function.
5254 @item -Wno-inherited-variadic-ctor
5255 @opindex Winherited-variadic-ctor
5256 @opindex Wno-inherited-variadic-ctor
5257 Suppress warnings about use of C++11 inheriting constructors when the
5258 base class inherited from has a C variadic constructor; the warning is
5259 on by default because the ellipsis is not inherited.
5261 @item -Winline
5262 @opindex Winline
5263 @opindex Wno-inline
5264 Warn if a function that is declared as inline cannot be inlined.
5265 Even with this option, the compiler does not warn about failures to
5266 inline functions declared in system headers.
5268 The compiler uses a variety of heuristics to determine whether or not
5269 to inline a function.  For example, the compiler takes into account
5270 the size of the function being inlined and the amount of inlining
5271 that has already been done in the current function.  Therefore,
5272 seemingly insignificant changes in the source program can cause the
5273 warnings produced by @option{-Winline} to appear or disappear.
5275 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5276 @opindex Wno-invalid-offsetof
5277 @opindex Winvalid-offsetof
5278 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5279 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5280 to a non-standard-layout type is undefined.  In existing C++ implementations,
5281 however, @code{offsetof} typically gives meaningful results.
5282 This flag is for users who are aware that they are
5283 writing nonportable code and who have deliberately chosen to ignore the
5284 warning about it.
5286 The restrictions on @code{offsetof} may be relaxed in a future version
5287 of the C++ standard.
5289 @item -Wno-int-to-pointer-cast
5290 @opindex Wno-int-to-pointer-cast
5291 @opindex Wint-to-pointer-cast
5292 Suppress warnings from casts to pointer type of an integer of a
5293 different size. In C++, casting to a pointer type of smaller size is
5294 an error. @option{Wint-to-pointer-cast} is enabled by default.
5297 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5298 @opindex Wno-pointer-to-int-cast
5299 @opindex Wpointer-to-int-cast
5300 Suppress warnings from casts from a pointer to an integer type of a
5301 different size.
5303 @item -Winvalid-pch
5304 @opindex Winvalid-pch
5305 @opindex Wno-invalid-pch
5306 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5307 the search path but can't be used.
5309 @item -Wlong-long
5310 @opindex Wlong-long
5311 @opindex Wno-long-long
5312 Warn if @code{long long} type is used.  This is enabled by either
5313 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5314 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5316 @item -Wvariadic-macros
5317 @opindex Wvariadic-macros
5318 @opindex Wno-variadic-macros
5319 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5320 alternate syntax is used in ISO C99 mode.  This is enabled by either
5321 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5322 messages, use @option{-Wno-variadic-macros}.
5324 @item -Wvarargs
5325 @opindex Wvarargs
5326 @opindex Wno-varargs
5327 Warn upon questionable usage of the macros used to handle variable
5328 arguments like @code{va_start}.  This is default.  To inhibit the
5329 warning messages, use @option{-Wno-varargs}.
5331 @item -Wvector-operation-performance
5332 @opindex Wvector-operation-performance
5333 @opindex Wno-vector-operation-performance
5334 Warn if vector operation is not implemented via SIMD capabilities of the
5335 architecture.  Mainly useful for the performance tuning.
5336 Vector operation can be implemented @code{piecewise}, which means that the
5337 scalar operation is performed on every vector element; 
5338 @code{in parallel}, which means that the vector operation is implemented
5339 using scalars of wider type, which normally is more performance efficient;
5340 and @code{as a single scalar}, which means that vector fits into a
5341 scalar type.
5343 @item -Wno-virtual-move-assign
5344 @opindex Wvirtual-move-assign
5345 @opindex Wno-virtual-move-assign
5346 Suppress warnings about inheriting from a virtual base with a
5347 non-trivial C++11 move assignment operator.  This is dangerous because
5348 if the virtual base is reachable along more than one path, it is
5349 moved multiple times, which can mean both objects end up in the
5350 moved-from state.  If the move assignment operator is written to avoid
5351 moving from a moved-from object, this warning can be disabled.
5353 @item -Wvla
5354 @opindex Wvla
5355 @opindex Wno-vla
5356 Warn if variable length array is used in the code.
5357 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5358 the variable length array.
5360 @item -Wvolatile-register-var
5361 @opindex Wvolatile-register-var
5362 @opindex Wno-volatile-register-var
5363 Warn if a register variable is declared volatile.  The volatile
5364 modifier does not inhibit all optimizations that may eliminate reads
5365 and/or writes to register variables.  This warning is enabled by
5366 @option{-Wall}.
5368 @item -Wdisabled-optimization
5369 @opindex Wdisabled-optimization
5370 @opindex Wno-disabled-optimization
5371 Warn if a requested optimization pass is disabled.  This warning does
5372 not generally indicate that there is anything wrong with your code; it
5373 merely indicates that GCC's optimizers are unable to handle the code
5374 effectively.  Often, the problem is that your code is too big or too
5375 complex; GCC refuses to optimize programs when the optimization
5376 itself is likely to take inordinate amounts of time.
5378 @item -Wpointer-sign @r{(C and Objective-C only)}
5379 @opindex Wpointer-sign
5380 @opindex Wno-pointer-sign
5381 Warn for pointer argument passing or assignment with different signedness.
5382 This option is only supported for C and Objective-C@.  It is implied by
5383 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5384 @option{-Wno-pointer-sign}.
5386 @item -Wstack-protector
5387 @opindex Wstack-protector
5388 @opindex Wno-stack-protector
5389 This option is only active when @option{-fstack-protector} is active.  It
5390 warns about functions that are not protected against stack smashing.
5392 @item -Woverlength-strings
5393 @opindex Woverlength-strings
5394 @opindex Wno-overlength-strings
5395 Warn about string constants that are longer than the ``minimum
5396 maximum'' length specified in the C standard.  Modern compilers
5397 generally allow string constants that are much longer than the
5398 standard's minimum limit, but very portable programs should avoid
5399 using longer strings.
5401 The limit applies @emph{after} string constant concatenation, and does
5402 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5403 C99, it was raised to 4095.  C++98 does not specify a normative
5404 minimum maximum, so we do not diagnose overlength strings in C++@.
5406 This option is implied by @option{-Wpedantic}, and can be disabled with
5407 @option{-Wno-overlength-strings}.
5409 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5410 @opindex Wunsuffixed-float-constants
5412 Issue a warning for any floating constant that does not have
5413 a suffix.  When used together with @option{-Wsystem-headers} it
5414 warns about such constants in system header files.  This can be useful
5415 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5416 from the decimal floating-point extension to C99.
5418 @item -Wno-designated-init @r{(C and Objective-C only)}
5419 Suppress warnings when a positional initializer is used to initialize
5420 a structure that has been marked with the @code{designated_init}
5421 attribute.
5423 @end table
5425 @node Debugging Options
5426 @section Options for Debugging Your Program or GCC
5427 @cindex options, debugging
5428 @cindex debugging information options
5430 GCC has various special options that are used for debugging
5431 either your program or GCC:
5433 @table @gcctabopt
5434 @item -g
5435 @opindex g
5436 Produce debugging information in the operating system's native format
5437 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5438 information.
5440 On most systems that use stabs format, @option{-g} enables use of extra
5441 debugging information that only GDB can use; this extra information
5442 makes debugging work better in GDB but probably makes other debuggers
5443 crash or
5444 refuse to read the program.  If you want to control for certain whether
5445 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5446 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5448 GCC allows you to use @option{-g} with
5449 @option{-O}.  The shortcuts taken by optimized code may occasionally
5450 produce surprising results: some variables you declared may not exist
5451 at all; flow of control may briefly move where you did not expect it;
5452 some statements may not be executed because they compute constant
5453 results or their values are already at hand; some statements may
5454 execute in different places because they have been moved out of loops.
5456 Nevertheless it proves possible to debug optimized output.  This makes
5457 it reasonable to use the optimizer for programs that might have bugs.
5459 The following options are useful when GCC is generated with the
5460 capability for more than one debugging format.
5462 @item -gsplit-dwarf
5463 @opindex gsplit-dwarf
5464 Separate as much dwarf debugging information as possible into a
5465 separate output file with the extension .dwo.  This option allows
5466 the build system to avoid linking files with debug information.  To
5467 be useful, this option requires a debugger capable of reading .dwo
5468 files.
5470 @item -ggdb
5471 @opindex ggdb
5472 Produce debugging information for use by GDB@.  This means to use the
5473 most expressive format available (DWARF 2, stabs, or the native format
5474 if neither of those are supported), including GDB extensions if at all
5475 possible.
5477 @item -gpubnames
5478 @opindex gpubnames
5479 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5481 @item -ggnu-pubnames
5482 @opindex ggnu-pubnames
5483 Generate .debug_pubnames and .debug_pubtypes sections in a format
5484 suitable for conversion into a GDB@ index.  This option is only useful
5485 with a linker that can produce GDB@ index version 7.
5487 @item -gstabs
5488 @opindex gstabs
5489 Produce debugging information in stabs format (if that is supported),
5490 without GDB extensions.  This is the format used by DBX on most BSD
5491 systems.  On MIPS, Alpha and System V Release 4 systems this option
5492 produces stabs debugging output that is not understood by DBX or SDB@.
5493 On System V Release 4 systems this option requires the GNU assembler.
5495 @item -feliminate-unused-debug-symbols
5496 @opindex feliminate-unused-debug-symbols
5497 Produce debugging information in stabs format (if that is supported),
5498 for only symbols that are actually used.
5500 @item -femit-class-debug-always
5501 @opindex femit-class-debug-always
5502 Instead of emitting debugging information for a C++ class in only one
5503 object file, emit it in all object files using the class.  This option
5504 should be used only with debuggers that are unable to handle the way GCC
5505 normally emits debugging information for classes because using this
5506 option increases the size of debugging information by as much as a
5507 factor of two.
5509 @item -fdebug-types-section
5510 @opindex fdebug-types-section
5511 @opindex fno-debug-types-section
5512 When using DWARF Version 4 or higher, type DIEs can be put into
5513 their own @code{.debug_types} section instead of making them part of the
5514 @code{.debug_info} section.  It is more efficient to put them in a separate
5515 comdat sections since the linker can then remove duplicates.
5516 But not all DWARF consumers support @code{.debug_types} sections yet
5517 and on some objects @code{.debug_types} produces larger instead of smaller
5518 debugging information.
5520 @item -gstabs+
5521 @opindex gstabs+
5522 Produce debugging information in stabs format (if that is supported),
5523 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5524 use of these extensions is likely to make other debuggers crash or
5525 refuse to read the program.
5527 @item -gcoff
5528 @opindex gcoff
5529 Produce debugging information in COFF format (if that is supported).
5530 This is the format used by SDB on most System V systems prior to
5531 System V Release 4.
5533 @item -gxcoff
5534 @opindex gxcoff
5535 Produce debugging information in XCOFF format (if that is supported).
5536 This is the format used by the DBX debugger on IBM RS/6000 systems.
5538 @item -gxcoff+
5539 @opindex gxcoff+
5540 Produce debugging information in XCOFF format (if that is supported),
5541 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5542 use of these extensions is likely to make other debuggers crash or
5543 refuse to read the program, and may cause assemblers other than the GNU
5544 assembler (GAS) to fail with an error.
5546 @item -gdwarf-@var{version}
5547 @opindex gdwarf-@var{version}
5548 Produce debugging information in DWARF format (if that is supported).
5549 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5550 for most targets is 4.  DWARF Version 5 is only experimental.
5552 Note that with DWARF Version 2, some ports require and always
5553 use some non-conflicting DWARF 3 extensions in the unwind tables.
5555 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5556 for maximum benefit.
5558 @item -grecord-gcc-switches
5559 @opindex grecord-gcc-switches
5560 This switch causes the command-line options used to invoke the
5561 compiler that may affect code generation to be appended to the
5562 DW_AT_producer attribute in DWARF debugging information.  The options
5563 are concatenated with spaces separating them from each other and from
5564 the compiler version.  See also @option{-frecord-gcc-switches} for another
5565 way of storing compiler options into the object file.  This is the default.
5567 @item -gno-record-gcc-switches
5568 @opindex gno-record-gcc-switches
5569 Disallow appending command-line options to the DW_AT_producer attribute
5570 in DWARF debugging information.
5572 @item -gstrict-dwarf
5573 @opindex gstrict-dwarf
5574 Disallow using extensions of later DWARF standard version than selected
5575 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5576 DWARF extensions from later standard versions is allowed.
5578 @item -gno-strict-dwarf
5579 @opindex gno-strict-dwarf
5580 Allow using extensions of later DWARF standard version than selected with
5581 @option{-gdwarf-@var{version}}.
5583 @item -gz@r{[}=@var{type}@r{]}
5584 @opindex gz
5585 Produce compressed debug sections in DWARF format, if that is supported.
5586 If @var{type} is not given, the default type depends on the capabilities
5587 of the assembler and linker used.  @var{type} may be one of
5588 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
5589 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
5590 compression in traditional GNU format).  If the linker doesn't support
5591 writing compressed debug sections, the option is rejected.  Otherwise,
5592 if the assembler does not support them, @option{-gz} is silently ignored
5593 when producing object files.
5595 @item -gvms
5596 @opindex gvms
5597 Produce debugging information in Alpha/VMS debug format (if that is
5598 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5600 @item -g@var{level}
5601 @itemx -ggdb@var{level}
5602 @itemx -gstabs@var{level}
5603 @itemx -gcoff@var{level}
5604 @itemx -gxcoff@var{level}
5605 @itemx -gvms@var{level}
5606 Request debugging information and also use @var{level} to specify how
5607 much information.  The default level is 2.
5609 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5610 @option{-g}.
5612 Level 1 produces minimal information, enough for making backtraces in
5613 parts of the program that you don't plan to debug.  This includes
5614 descriptions of functions and external variables, and line number
5615 tables, but no information about local variables.
5617 Level 3 includes extra information, such as all the macro definitions
5618 present in the program.  Some debuggers support macro expansion when
5619 you use @option{-g3}.
5621 @option{-gdwarf-2} does not accept a concatenated debug level, because
5622 GCC used to support an option @option{-gdwarf} that meant to generate
5623 debug information in version 1 of the DWARF format (which is very
5624 different from version 2), and it would have been too confusing.  That
5625 debug format is long obsolete, but the option cannot be changed now.
5626 Instead use an additional @option{-g@var{level}} option to change the
5627 debug level for DWARF.
5629 @item -gtoggle
5630 @opindex gtoggle
5631 Turn off generation of debug info, if leaving out this option
5632 generates it, or turn it on at level 2 otherwise.  The position of this
5633 argument in the command line does not matter; it takes effect after all
5634 other options are processed, and it does so only once, no matter how
5635 many times it is given.  This is mainly intended to be used with
5636 @option{-fcompare-debug}.
5638 @item -fsanitize=address
5639 @opindex fsanitize=address
5640 Enable AddressSanitizer, a fast memory error detector.
5641 Memory access instructions are instrumented to detect
5642 out-of-bounds and use-after-free bugs.
5643 See @uref{http://code.google.com/p/address-sanitizer/} for
5644 more details.  The run-time behavior can be influenced using the
5645 @env{ASAN_OPTIONS} environment variable; see
5646 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5647 a list of supported options.
5649 @item -fsanitize=kernel-address
5650 @opindex fsanitize=kernel-address
5651 Enable AddressSanitizer for Linux kernel.
5652 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5654 @item -fsanitize=thread
5655 @opindex fsanitize=thread
5656 Enable ThreadSanitizer, a fast data race detector.
5657 Memory access instructions are instrumented to detect
5658 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5659 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5660 environment variable; see
5661 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5662 supported options.
5664 @item -fsanitize=leak
5665 @opindex fsanitize=leak
5666 Enable LeakSanitizer, a memory leak detector.
5667 This option only matters for linking of executables and if neither
5668 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5669 case the executable is linked against a library that overrides @code{malloc}
5670 and other allocator functions.  See
5671 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5672 details.  The run-time behavior can be influenced using the
5673 @env{LSAN_OPTIONS} environment variable.
5675 @item -fsanitize=undefined
5676 @opindex fsanitize=undefined
5677 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5678 Various computations are instrumented to detect undefined behavior
5679 at runtime.  Current suboptions are:
5681 @table @gcctabopt
5683 @item -fsanitize=shift
5684 @opindex fsanitize=shift
5685 This option enables checking that the result of a shift operation is
5686 not undefined.  Note that what exactly is considered undefined differs
5687 slightly between C and C++, as well as between ISO C90 and C99, etc.
5689 @item -fsanitize=integer-divide-by-zero
5690 @opindex fsanitize=integer-divide-by-zero
5691 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5693 @item -fsanitize=unreachable
5694 @opindex fsanitize=unreachable
5695 With this option, the compiler turns the @code{__builtin_unreachable}
5696 call into a diagnostics message call instead.  When reaching the
5697 @code{__builtin_unreachable} call, the behavior is undefined.
5699 @item -fsanitize=vla-bound
5700 @opindex fsanitize=vla-bound
5701 This option instructs the compiler to check that the size of a variable
5702 length array is positive.
5704 @item -fsanitize=null
5705 @opindex fsanitize=null
5706 This option enables pointer checking.  Particularly, the application
5707 built with this option turned on will issue an error message when it
5708 tries to dereference a NULL pointer, or if a reference (possibly an
5709 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5710 on an object pointed by a NULL pointer.
5712 @item -fsanitize=return
5713 @opindex fsanitize=return
5714 This option enables return statement checking.  Programs
5715 built with this option turned on will issue an error message
5716 when the end of a non-void function is reached without actually
5717 returning a value.  This option works in C++ only.
5719 @item -fsanitize=signed-integer-overflow
5720 @opindex fsanitize=signed-integer-overflow
5721 This option enables signed integer overflow checking.  We check that
5722 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5723 does not overflow in the signed arithmetics.  Note, integer promotion
5724 rules must be taken into account.  That is, the following is not an
5725 overflow:
5726 @smallexample
5727 signed char a = SCHAR_MAX;
5728 a++;
5729 @end smallexample
5731 @item -fsanitize=bounds
5732 @opindex fsanitize=bounds
5733 This option enables instrumentation of array bounds.  Various out of bounds
5734 accesses are detected.  Flexible array members, flexible array member-like
5735 arrays, and initializers of variables with static storage are not instrumented.
5737 @item -fsanitize=alignment
5738 @opindex fsanitize=alignment
5740 This option enables checking of alignment of pointers when they are
5741 dereferenced, or when a reference is bound to insufficiently aligned target,
5742 or when a method or constructor is invoked on insufficiently aligned object.
5744 @item -fsanitize=object-size
5745 @opindex fsanitize=object-size
5746 This option enables instrumentation of memory references using the
5747 @code{__builtin_object_size} function.  Various out of bounds pointer
5748 accesses are detected.
5750 @item -fsanitize=float-divide-by-zero
5751 @opindex fsanitize=float-divide-by-zero
5752 Detect floating-point division by zero.  Unlike other similar options,
5753 @option{-fsanitize=float-divide-by-zero} is not enabled by
5754 @option{-fsanitize=undefined}, since floating-point division by zero can
5755 be a legitimate way of obtaining infinities and NaNs.
5757 @item -fsanitize=float-cast-overflow
5758 @opindex fsanitize=float-cast-overflow
5759 This option enables floating-point type to integer conversion checking.
5760 We check that the result of the conversion does not overflow.
5761 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
5762 not enabled by @option{-fsanitize=undefined}.
5763 This option does not work well with @code{FE_INVALID} exceptions enabled.
5765 @item -fsanitize=nonnull-attribute
5766 @opindex fsanitize=nonnull-attribute
5768 This option enables instrumentation of calls, checking whether null values
5769 are not passed to arguments marked as requiring a non-null value by the
5770 @code{nonnull} function attribute.
5772 @item -fsanitize=returns-nonnull-attribute
5773 @opindex fsanitize=returns-nonnull-attribute
5775 This option enables instrumentation of return statements in functions
5776 marked with @code{returns_nonnull} function attribute, to detect returning
5777 of null values from such functions.
5779 @item -fsanitize=bool
5780 @opindex fsanitize=bool
5782 This option enables instrumentation of loads from bool.  If a value other
5783 than 0/1 is loaded, a run-time error is issued.
5785 @item -fsanitize=enum
5786 @opindex fsanitize=enum
5788 This option enables instrumentation of loads from an enum type.  If
5789 a value outside the range of values for the enum type is loaded,
5790 a run-time error is issued.
5792 @item -fsanitize=vptr
5793 @opindex fsanitize=vptr
5795 This option enables instrumentation of C++ member function calls, member
5796 accesses and some conversions between pointers to base and derived classes,
5797 to verify the referenced object has the correct dynamic type.
5799 @end table
5801 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5802 @option{-fsanitize=undefined} gives a diagnostic message.
5803 This currently works only for the C family of languages.
5805 @item -fno-sanitize=all
5806 @opindex fno-sanitize=all
5808 This option disables all previously enabled sanitizers.
5809 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
5810 together.
5812 @item -fasan-shadow-offset=@var{number}
5813 @opindex fasan-shadow-offset
5814 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5815 It is useful for experimenting with different shadow memory layouts in
5816 Kernel AddressSanitizer.
5818 @item -fsanitize-sections=@var{s1,s2,...}
5819 @opindex fsanitize-sections
5820 Sanitize global variables in selected user-defined sections.  @var{si} may
5821 contain wildcards.
5823 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5824 @opindex fsanitize-recover
5825 @opindex fno-sanitize-recover
5826 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5827 mentioned in comma-separated list of @var{opts}.  Enabling this option
5828 for a sanitizer component causes it to attempt to continue
5829 running the program as if no error happened.  This means multiple
5830 runtime errors can be reported in a single program run, and the exit
5831 code of the program may indicate success even when errors
5832 have been reported.  The @option{-fno-sanitize-recover=} option
5833 can be used to alter
5834 this behavior: only the first detected error is reported
5835 and program then exits with a non-zero exit code.
5837 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5838 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5839 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5840 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5841 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
5842 accepted, the former enables recovery for all sanitizers that support it,
5843 the latter disables recovery for all sanitizers that support it.
5845 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5846 @smallexample
5847 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5848 @end smallexample
5849 @noindent
5850 Similarly @option{-fno-sanitize-recover} is equivalent to
5851 @smallexample
5852 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
5853 @end smallexample
5855 @item -fsanitize-undefined-trap-on-error
5856 @opindex fsanitize-undefined-trap-on-error
5857 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
5858 report undefined behavior using @code{__builtin_trap} rather than
5859 a @code{libubsan} library routine.  The advantage of this is that the
5860 @code{libubsan} library is not needed and is not linked in, so this
5861 is usable even in freestanding environments.
5863 @item -fcheck-pointer-bounds
5864 @opindex fcheck-pointer-bounds
5865 @opindex fno-check-pointer-bounds
5866 @cindex Pointer Bounds Checker options
5867 Enable Pointer Bounds Checker instrumentation.  Each memory reference
5868 is instrumented with checks of the pointer used for memory access against
5869 bounds associated with that pointer.  
5871 Currently there
5872 is only an implementation for Intel MPX available, thus x86 target
5873 and @option{-mmpx} are required to enable this feature.  
5874 MPX-based instrumentation requires
5875 a runtime library to enable MPX in hardware and handle bounds
5876 violation signals.  By default when @option{-fcheck-pointer-bounds}
5877 and @option{-mmpx} options are used to link a program, the GCC driver
5878 links against the @file{libmpx} runtime library and @file{libmpxwrappers}
5879 library.  It also passes '-z bndplt' to a linker in case it supports this
5880 option (which is checked on libmpx configuration).  Note that old versions
5881 of linker may ignore option.  Gold linker doesn't support '-z bndplt'
5882 option.  With no '-z bndplt' support in linker all calls to dynamic libraries
5883 lose passed bounds reducing overall protection level.  It's highly
5884 recommended to use linker with '-z bndplt' support.  In case such linker
5885 is not available it is adviced to always use @option{-static-libmpxwrappers}
5886 for better protection level or use @option{-static} to completely avoid
5887 external calls to dynamic libraries.  MPX-based instrumentation
5888 may be used for debugging and also may be included in production code
5889 to increase program security.  Depending on usage, you may
5890 have different requirements for the runtime library.  The current version
5891 of the MPX runtime library is more oriented for use as a debugging
5892 tool.  MPX runtime library usage implies @option{-lpthread}.  See
5893 also @option{-static-libmpx}.  The runtime library  behavior can be
5894 influenced using various @env{CHKP_RT_*} environment variables.  See
5895 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
5896 for more details.
5898 Generated instrumentation may be controlled by various
5899 @option{-fchkp-*} options and by the @code{bnd_variable_size}
5900 structure field attribute (@pxref{Type Attributes}) and
5901 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
5902 (@pxref{Function Attributes}).  GCC also provides a number of built-in
5903 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
5904 Bounds Checker builtins}, for more information.
5906 @item -fchkp-check-incomplete-type
5907 @opindex fchkp-check-incomplete-type
5908 @opindex fno-chkp-check-incomplete-type
5909 Generate pointer bounds checks for variables with incomplete type.
5910 Enabled by default.
5912 @item -fchkp-narrow-bounds
5913 @opindex fchkp-narrow-bounds
5914 @opindex fno-chkp-narrow-bounds
5915 Controls bounds used by Pointer Bounds Checker for pointers to object
5916 fields.  If narrowing is enabled then field bounds are used.  Otherwise
5917 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
5918 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
5920 @item -fchkp-first-field-has-own-bounds
5921 @opindex fchkp-first-field-has-own-bounds
5922 @opindex fno-chkp-first-field-has-own-bounds
5923 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
5924 first field in the structure.  By default a pointer to the first field has
5925 the same bounds as a pointer to the whole structure.
5927 @item -fchkp-narrow-to-innermost-array
5928 @opindex fchkp-narrow-to-innermost-array
5929 @opindex fno-chkp-narrow-to-innermost-array
5930 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
5931 case of nested static array access.  By default this option is disabled and
5932 bounds of the outermost array are used.
5934 @item -fchkp-optimize
5935 @opindex fchkp-optimize
5936 @opindex fno-chkp-optimize
5937 Enables Pointer Bounds Checker optimizations.  Enabled by default at
5938 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
5940 @item -fchkp-use-fast-string-functions
5941 @opindex fchkp-use-fast-string-functions
5942 @opindex fno-chkp-use-fast-string-functions
5943 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
5944 by Pointer Bounds Checker.  Disabled by default.
5946 @item -fchkp-use-nochk-string-functions
5947 @opindex fchkp-use-nochk-string-functions
5948 @opindex fno-chkp-use-nochk-string-functions
5949 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
5950 by Pointer Bounds Checker.  Disabled by default.
5952 @item -fchkp-use-static-bounds
5953 @opindex fchkp-use-static-bounds
5954 @opindex fno-chkp-use-static-bounds
5955 Allow Pointer Bounds Checker to generate static bounds holding
5956 bounds of static variables.  Enabled by default.
5958 @item -fchkp-use-static-const-bounds
5959 @opindex fchkp-use-static-const-bounds
5960 @opindex fno-chkp-use-static-const-bounds
5961 Use statically-initialized bounds for constant bounds instead of
5962 generating them each time they are required.  By default enabled when
5963 @option{-fchkp-use-static-bounds} is enabled.
5965 @item -fchkp-treat-zero-dynamic-size-as-infinite
5966 @opindex fchkp-treat-zero-dynamic-size-as-infinite
5967 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
5968 With this option, objects with incomplete type whose
5969 dynamically-obtained size is zero are treated as having infinite size
5970 instead by Pointer Bounds
5971 Checker.  This option may be helpful if a program is linked with a library
5972 missing size information for some symbols.  Disabled by default.
5974 @item -fchkp-check-read
5975 @opindex fchkp-check-read
5976 @opindex fno-chkp-check-read
5977 Instructs Pointer Bounds Checker to generate checks for all read
5978 accesses to memory.  Enabled by default.
5980 @item -fchkp-check-write
5981 @opindex fchkp-check-write
5982 @opindex fno-chkp-check-write
5983 Instructs Pointer Bounds Checker to generate checks for all write
5984 accesses to memory.  Enabled by default.
5986 @item -fchkp-store-bounds
5987 @opindex fchkp-store-bounds
5988 @opindex fno-chkp-store-bounds
5989 Instructs Pointer Bounds Checker to generate bounds stores for
5990 pointer writes.  Enabled by default.
5992 @item -fchkp-instrument-calls
5993 @opindex fchkp-instrument-calls
5994 @opindex fno-chkp-instrument-calls
5995 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
5996 Enabled by default.
5998 @item -fchkp-instrument-marked-only
5999 @opindex fchkp-instrument-marked-only
6000 @opindex fno-chkp-instrument-marked-only
6001 Instructs Pointer Bounds Checker to instrument only functions
6002 marked with the @code{bnd_instrument} attribute
6003 (@pxref{Function Attributes}).  Disabled by default.
6005 @item -fchkp-use-wrappers
6006 @opindex fchkp-use-wrappers
6007 @opindex fno-chkp-use-wrappers
6008 Allows Pointer Bounds Checker to replace calls to built-in functions
6009 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
6010 is used to link a program, the GCC driver automatically links
6011 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
6012 Enabled by default.
6014 @item -fdump-final-insns@r{[}=@var{file}@r{]}
6015 @opindex fdump-final-insns
6016 Dump the final internal representation (RTL) to @var{file}.  If the
6017 optional argument is omitted (or if @var{file} is @code{.}), the name
6018 of the dump file is determined by appending @code{.gkd} to the
6019 compilation output file name.
6021 @item -fcompare-debug@r{[}=@var{opts}@r{]}
6022 @opindex fcompare-debug
6023 @opindex fno-compare-debug
6024 If no error occurs during compilation, run the compiler a second time,
6025 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
6026 passed to the second compilation.  Dump the final internal
6027 representation in both compilations, and print an error if they differ.
6029 If the equal sign is omitted, the default @option{-gtoggle} is used.
6031 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
6032 and nonzero, implicitly enables @option{-fcompare-debug}.  If
6033 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
6034 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
6035 is used.
6037 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
6038 is equivalent to @option{-fno-compare-debug}, which disables the dumping
6039 of the final representation and the second compilation, preventing even
6040 @env{GCC_COMPARE_DEBUG} from taking effect.
6042 To verify full coverage during @option{-fcompare-debug} testing, set
6043 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
6044 which GCC rejects as an invalid option in any actual compilation
6045 (rather than preprocessing, assembly or linking).  To get just a
6046 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
6047 not overridden} will do.
6049 @item -fcompare-debug-second
6050 @opindex fcompare-debug-second
6051 This option is implicitly passed to the compiler for the second
6052 compilation requested by @option{-fcompare-debug}, along with options to
6053 silence warnings, and omitting other options that would cause
6054 side-effect compiler outputs to files or to the standard output.  Dump
6055 files and preserved temporary files are renamed so as to contain the
6056 @code{.gk} additional extension during the second compilation, to avoid
6057 overwriting those generated by the first.
6059 When this option is passed to the compiler driver, it causes the
6060 @emph{first} compilation to be skipped, which makes it useful for little
6061 other than debugging the compiler proper.
6063 @item -feliminate-dwarf2-dups
6064 @opindex feliminate-dwarf2-dups
6065 Compress DWARF 2 debugging information by eliminating duplicated
6066 information about each symbol.  This option only makes sense when
6067 generating DWARF 2 debugging information with @option{-gdwarf-2}.
6069 @item -femit-struct-debug-baseonly
6070 @opindex femit-struct-debug-baseonly
6071 Emit debug information for struct-like types
6072 only when the base name of the compilation source file
6073 matches the base name of file in which the struct is defined.
6075 This option substantially reduces the size of debugging information,
6076 but at significant potential loss in type information to the debugger.
6077 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6078 See @option{-femit-struct-debug-detailed} for more detailed control.
6080 This option works only with DWARF 2.
6082 @item -femit-struct-debug-reduced
6083 @opindex femit-struct-debug-reduced
6084 Emit debug information for struct-like types
6085 only when the base name of the compilation source file
6086 matches the base name of file in which the type is defined,
6087 unless the struct is a template or defined in a system header.
6089 This option significantly reduces the size of debugging information,
6090 with some potential loss in type information to the debugger.
6091 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6092 See @option{-femit-struct-debug-detailed} for more detailed control.
6094 This option works only with DWARF 2.
6096 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6097 @opindex femit-struct-debug-detailed
6098 Specify the struct-like types
6099 for which the compiler generates debug information.
6100 The intent is to reduce duplicate struct debug information
6101 between different object files within the same program.
6103 This option is a detailed version of
6104 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6105 which serves for most needs.
6107 A specification has the syntax@*
6108 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6110 The optional first word limits the specification to
6111 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6112 A struct type is used directly when it is the type of a variable, member.
6113 Indirect uses arise through pointers to structs.
6114 That is, when use of an incomplete struct is valid, the use is indirect.
6115 An example is
6116 @samp{struct one direct; struct two * indirect;}.
6118 The optional second word limits the specification to
6119 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6120 Generic structs are a bit complicated to explain.
6121 For C++, these are non-explicit specializations of template classes,
6122 or non-template classes within the above.
6123 Other programming languages have generics,
6124 but @option{-femit-struct-debug-detailed} does not yet implement them.
6126 The third word specifies the source files for those
6127 structs for which the compiler should emit debug information.
6128 The values @samp{none} and @samp{any} have the normal meaning.
6129 The value @samp{base} means that
6130 the base of name of the file in which the type declaration appears
6131 must match the base of the name of the main compilation file.
6132 In practice, this means that when compiling @file{foo.c}, debug information
6133 is generated for types declared in that file and @file{foo.h},
6134 but not other header files.
6135 The value @samp{sys} means those types satisfying @samp{base}
6136 or declared in system or compiler headers.
6138 You may need to experiment to determine the best settings for your application.
6140 The default is @option{-femit-struct-debug-detailed=all}.
6142 This option works only with DWARF 2.
6144 @item -fno-merge-debug-strings
6145 @opindex fmerge-debug-strings
6146 @opindex fno-merge-debug-strings
6147 Direct the linker to not merge together strings in the debugging
6148 information that are identical in different object files.  Merging is
6149 not supported by all assemblers or linkers.  Merging decreases the size
6150 of the debug information in the output file at the cost of increasing
6151 link processing time.  Merging is enabled by default.
6153 @item -fdebug-prefix-map=@var{old}=@var{new}
6154 @opindex fdebug-prefix-map
6155 When compiling files in directory @file{@var{old}}, record debugging
6156 information describing them as in @file{@var{new}} instead.
6158 @item -fno-dwarf2-cfi-asm
6159 @opindex fdwarf2-cfi-asm
6160 @opindex fno-dwarf2-cfi-asm
6161 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
6162 instead of using GAS @code{.cfi_*} directives.
6164 @cindex @command{prof}
6165 @item -p
6166 @opindex p
6167 Generate extra code to write profile information suitable for the
6168 analysis program @command{prof}.  You must use this option when compiling
6169 the source files you want data about, and you must also use it when
6170 linking.
6172 @cindex @command{gprof}
6173 @item -pg
6174 @opindex pg
6175 Generate extra code to write profile information suitable for the
6176 analysis program @command{gprof}.  You must use this option when compiling
6177 the source files you want data about, and you must also use it when
6178 linking.
6180 @item -Q
6181 @opindex Q
6182 Makes the compiler print out each function name as it is compiled, and
6183 print some statistics about each pass when it finishes.
6185 @item -ftime-report
6186 @opindex ftime-report
6187 Makes the compiler print some statistics about the time consumed by each
6188 pass when it finishes.
6190 @item -fmem-report
6191 @opindex fmem-report
6192 Makes the compiler print some statistics about permanent memory
6193 allocation when it finishes.
6195 @item -fmem-report-wpa
6196 @opindex fmem-report-wpa
6197 Makes the compiler print some statistics about permanent memory
6198 allocation for the WPA phase only.
6200 @item -fpre-ipa-mem-report
6201 @opindex fpre-ipa-mem-report
6202 @item -fpost-ipa-mem-report
6203 @opindex fpost-ipa-mem-report
6204 Makes the compiler print some statistics about permanent memory
6205 allocation before or after interprocedural optimization.
6207 @item -fprofile-report
6208 @opindex fprofile-report
6209 Makes the compiler print some statistics about consistency of the
6210 (estimated) profile and effect of individual passes.
6212 @item -fstack-usage
6213 @opindex fstack-usage
6214 Makes the compiler output stack usage information for the program, on a
6215 per-function basis.  The filename for the dump is made by appending
6216 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
6217 the output file, if explicitly specified and it is not an executable,
6218 otherwise it is the basename of the source file.  An entry is made up
6219 of three fields:
6221 @itemize
6222 @item
6223 The name of the function.
6224 @item
6225 A number of bytes.
6226 @item
6227 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
6228 @end itemize
6230 The qualifier @code{static} means that the function manipulates the stack
6231 statically: a fixed number of bytes are allocated for the frame on function
6232 entry and released on function exit; no stack adjustments are otherwise made
6233 in the function.  The second field is this fixed number of bytes.
6235 The qualifier @code{dynamic} means that the function manipulates the stack
6236 dynamically: in addition to the static allocation described above, stack
6237 adjustments are made in the body of the function, for example to push/pop
6238 arguments around function calls.  If the qualifier @code{bounded} is also
6239 present, the amount of these adjustments is bounded at compile time and
6240 the second field is an upper bound of the total amount of stack used by
6241 the function.  If it is not present, the amount of these adjustments is
6242 not bounded at compile time and the second field only represents the
6243 bounded part.
6245 @item -fprofile-arcs
6246 @opindex fprofile-arcs
6247 Add code so that program flow @dfn{arcs} are instrumented.  During
6248 execution the program records how many times each branch and call is
6249 executed and how many times it is taken or returns.  When the compiled
6250 program exits it saves this data to a file called
6251 @file{@var{auxname}.gcda} for each source file.  The data may be used for
6252 profile-directed optimizations (@option{-fbranch-probabilities}), or for
6253 test coverage analysis (@option{-ftest-coverage}).  Each object file's
6254 @var{auxname} is generated from the name of the output file, if
6255 explicitly specified and it is not the final executable, otherwise it is
6256 the basename of the source file.  In both cases any suffix is removed
6257 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
6258 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
6259 @xref{Cross-profiling}.
6261 @cindex @command{gcov}
6262 @item --coverage
6263 @opindex coverage
6265 This option is used to compile and link code instrumented for coverage
6266 analysis.  The option is a synonym for @option{-fprofile-arcs}
6267 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6268 linking).  See the documentation for those options for more details.
6270 @itemize
6272 @item
6273 Compile the source files with @option{-fprofile-arcs} plus optimization
6274 and code generation options.  For test coverage analysis, use the
6275 additional @option{-ftest-coverage} option.  You do not need to profile
6276 every source file in a program.
6278 @item
6279 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6280 (the latter implies the former).
6282 @item
6283 Run the program on a representative workload to generate the arc profile
6284 information.  This may be repeated any number of times.  You can run
6285 concurrent instances of your program, and provided that the file system
6286 supports locking, the data files will be correctly updated.  Also
6287 @code{fork} calls are detected and correctly handled (double counting
6288 will not happen).
6290 @item
6291 For profile-directed optimizations, compile the source files again with
6292 the same optimization and code generation options plus
6293 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6294 Control Optimization}).
6296 @item
6297 For test coverage analysis, use @command{gcov} to produce human readable
6298 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6299 @command{gcov} documentation for further information.
6301 @end itemize
6303 With @option{-fprofile-arcs}, for each function of your program GCC
6304 creates a program flow graph, then finds a spanning tree for the graph.
6305 Only arcs that are not on the spanning tree have to be instrumented: the
6306 compiler adds code to count the number of times that these arcs are
6307 executed.  When an arc is the only exit or only entrance to a block, the
6308 instrumentation code can be added to the block; otherwise, a new basic
6309 block must be created to hold the instrumentation code.
6311 @need 2000
6312 @item -ftest-coverage
6313 @opindex ftest-coverage
6314 Produce a notes file that the @command{gcov} code-coverage utility
6315 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6316 show program coverage.  Each source file's note file is called
6317 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6318 above for a description of @var{auxname} and instructions on how to
6319 generate test coverage data.  Coverage data matches the source files
6320 more closely if you do not optimize.
6322 @item -fdbg-cnt-list
6323 @opindex fdbg-cnt-list
6324 Print the name and the counter upper bound for all debug counters.
6327 @item -fdbg-cnt=@var{counter-value-list}
6328 @opindex fdbg-cnt
6329 Set the internal debug counter upper bound.  @var{counter-value-list}
6330 is a comma-separated list of @var{name}:@var{value} pairs
6331 which sets the upper bound of each debug counter @var{name} to @var{value}.
6332 All debug counters have the initial upper bound of @code{UINT_MAX};
6333 thus @code{dbg_cnt} returns true always unless the upper bound
6334 is set by this option.
6335 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6336 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6338 @item -fenable-@var{kind}-@var{pass}
6339 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6340 @opindex fdisable-
6341 @opindex fenable-
6343 This is a set of options that are used to explicitly disable/enable
6344 optimization passes.  These options are intended for use for debugging GCC.
6345 Compiler users should use regular options for enabling/disabling
6346 passes instead.
6348 @table @gcctabopt
6350 @item -fdisable-ipa-@var{pass}
6351 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6352 statically invoked in the compiler multiple times, the pass name should be
6353 appended with a sequential number starting from 1.
6355 @item -fdisable-rtl-@var{pass}
6356 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6357 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6358 statically invoked in the compiler multiple times, the pass name should be
6359 appended with a sequential number starting from 1.  @var{range-list} is a 
6360 comma-separated list of function ranges or assembler names.  Each range is a number
6361 pair separated by a colon.  The range is inclusive in both ends.  If the range
6362 is trivial, the number pair can be simplified as a single number.  If the
6363 function's call graph node's @var{uid} falls within one of the specified ranges,
6364 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6365 function header of a dump file, and the pass names can be dumped by using
6366 option @option{-fdump-passes}.
6368 @item -fdisable-tree-@var{pass}
6369 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6370 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6371 option arguments.
6373 @item -fenable-ipa-@var{pass}
6374 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6375 statically invoked in the compiler multiple times, the pass name should be
6376 appended with a sequential number starting from 1.
6378 @item -fenable-rtl-@var{pass}
6379 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6380 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6381 description and examples.
6383 @item -fenable-tree-@var{pass}
6384 @itemx -fenable-tree-@var{pass}=@var{range-list}
6385 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6386 of option arguments.
6388 @end table
6390 Here are some examples showing uses of these options.
6392 @smallexample
6394 # disable ccp1 for all functions
6395    -fdisable-tree-ccp1
6396 # disable complete unroll for function whose cgraph node uid is 1
6397    -fenable-tree-cunroll=1
6398 # disable gcse2 for functions at the following ranges [1,1],
6399 # [300,400], and [400,1000]
6400 # disable gcse2 for functions foo and foo2
6401    -fdisable-rtl-gcse2=foo,foo2
6402 # disable early inlining
6403    -fdisable-tree-einline
6404 # disable ipa inlining
6405    -fdisable-ipa-inline
6406 # enable tree full unroll
6407    -fenable-tree-unroll
6409 @end smallexample
6411 @item -d@var{letters}
6412 @itemx -fdump-rtl-@var{pass}
6413 @itemx -fdump-rtl-@var{pass}=@var{filename}
6414 @opindex d
6415 @opindex fdump-rtl-@var{pass}
6416 Says to make debugging dumps during compilation at times specified by
6417 @var{letters}.  This is used for debugging the RTL-based passes of the
6418 compiler.  The file names for most of the dumps are made by appending
6419 a pass number and a word to the @var{dumpname}, and the files are
6420 created in the directory of the output file. In case of
6421 @option{=@var{filename}} option, the dump is output on the given file
6422 instead of the pass numbered dump files. Note that the pass number is
6423 computed statically as passes get registered into the pass manager.
6424 Thus the numbering is not related to the dynamic order of execution of
6425 passes.  In particular, a pass installed by a plugin could have a
6426 number over 200 even if it executed quite early.  @var{dumpname} is
6427 generated from the name of the output file, if explicitly specified
6428 and it is not an executable, otherwise it is the basename of the
6429 source file. These switches may have different effects when
6430 @option{-E} is used for preprocessing.
6432 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6433 @option{-d} option @var{letters}.  Here are the possible
6434 letters for use in @var{pass} and @var{letters}, and their meanings:
6436 @table @gcctabopt
6438 @item -fdump-rtl-alignments
6439 @opindex fdump-rtl-alignments
6440 Dump after branch alignments have been computed.
6442 @item -fdump-rtl-asmcons
6443 @opindex fdump-rtl-asmcons
6444 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6446 @item -fdump-rtl-auto_inc_dec
6447 @opindex fdump-rtl-auto_inc_dec
6448 Dump after auto-inc-dec discovery.  This pass is only run on
6449 architectures that have auto inc or auto dec instructions.
6451 @item -fdump-rtl-barriers
6452 @opindex fdump-rtl-barriers
6453 Dump after cleaning up the barrier instructions.
6455 @item -fdump-rtl-bbpart
6456 @opindex fdump-rtl-bbpart
6457 Dump after partitioning hot and cold basic blocks.
6459 @item -fdump-rtl-bbro
6460 @opindex fdump-rtl-bbro
6461 Dump after block reordering.
6463 @item -fdump-rtl-btl1
6464 @itemx -fdump-rtl-btl2
6465 @opindex fdump-rtl-btl2
6466 @opindex fdump-rtl-btl2
6467 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6468 after the two branch
6469 target load optimization passes.
6471 @item -fdump-rtl-bypass
6472 @opindex fdump-rtl-bypass
6473 Dump after jump bypassing and control flow optimizations.
6475 @item -fdump-rtl-combine
6476 @opindex fdump-rtl-combine
6477 Dump after the RTL instruction combination pass.
6479 @item -fdump-rtl-compgotos
6480 @opindex fdump-rtl-compgotos
6481 Dump after duplicating the computed gotos.
6483 @item -fdump-rtl-ce1
6484 @itemx -fdump-rtl-ce2
6485 @itemx -fdump-rtl-ce3
6486 @opindex fdump-rtl-ce1
6487 @opindex fdump-rtl-ce2
6488 @opindex fdump-rtl-ce3
6489 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6490 @option{-fdump-rtl-ce3} enable dumping after the three
6491 if conversion passes.
6493 @item -fdump-rtl-cprop_hardreg
6494 @opindex fdump-rtl-cprop_hardreg
6495 Dump after hard register copy propagation.
6497 @item -fdump-rtl-csa
6498 @opindex fdump-rtl-csa
6499 Dump after combining stack adjustments.
6501 @item -fdump-rtl-cse1
6502 @itemx -fdump-rtl-cse2
6503 @opindex fdump-rtl-cse1
6504 @opindex fdump-rtl-cse2
6505 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6506 the two common subexpression elimination passes.
6508 @item -fdump-rtl-dce
6509 @opindex fdump-rtl-dce
6510 Dump after the standalone dead code elimination passes.
6512 @item -fdump-rtl-dbr
6513 @opindex fdump-rtl-dbr
6514 Dump after delayed branch scheduling.
6516 @item -fdump-rtl-dce1
6517 @itemx -fdump-rtl-dce2
6518 @opindex fdump-rtl-dce1
6519 @opindex fdump-rtl-dce2
6520 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6521 the two dead store elimination passes.
6523 @item -fdump-rtl-eh
6524 @opindex fdump-rtl-eh
6525 Dump after finalization of EH handling code.
6527 @item -fdump-rtl-eh_ranges
6528 @opindex fdump-rtl-eh_ranges
6529 Dump after conversion of EH handling range regions.
6531 @item -fdump-rtl-expand
6532 @opindex fdump-rtl-expand
6533 Dump after RTL generation.
6535 @item -fdump-rtl-fwprop1
6536 @itemx -fdump-rtl-fwprop2
6537 @opindex fdump-rtl-fwprop1
6538 @opindex fdump-rtl-fwprop2
6539 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6540 dumping after the two forward propagation passes.
6542 @item -fdump-rtl-gcse1
6543 @itemx -fdump-rtl-gcse2
6544 @opindex fdump-rtl-gcse1
6545 @opindex fdump-rtl-gcse2
6546 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6547 after global common subexpression elimination.
6549 @item -fdump-rtl-init-regs
6550 @opindex fdump-rtl-init-regs
6551 Dump after the initialization of the registers.
6553 @item -fdump-rtl-initvals
6554 @opindex fdump-rtl-initvals
6555 Dump after the computation of the initial value sets.
6557 @item -fdump-rtl-into_cfglayout
6558 @opindex fdump-rtl-into_cfglayout
6559 Dump after converting to cfglayout mode.
6561 @item -fdump-rtl-ira
6562 @opindex fdump-rtl-ira
6563 Dump after iterated register allocation.
6565 @item -fdump-rtl-jump
6566 @opindex fdump-rtl-jump
6567 Dump after the second jump optimization.
6569 @item -fdump-rtl-loop2
6570 @opindex fdump-rtl-loop2
6571 @option{-fdump-rtl-loop2} enables dumping after the rtl
6572 loop optimization passes.
6574 @item -fdump-rtl-mach
6575 @opindex fdump-rtl-mach
6576 Dump after performing the machine dependent reorganization pass, if that
6577 pass exists.
6579 @item -fdump-rtl-mode_sw
6580 @opindex fdump-rtl-mode_sw
6581 Dump after removing redundant mode switches.
6583 @item -fdump-rtl-rnreg
6584 @opindex fdump-rtl-rnreg
6585 Dump after register renumbering.
6587 @item -fdump-rtl-outof_cfglayout
6588 @opindex fdump-rtl-outof_cfglayout
6589 Dump after converting from cfglayout mode.
6591 @item -fdump-rtl-peephole2
6592 @opindex fdump-rtl-peephole2
6593 Dump after the peephole pass.
6595 @item -fdump-rtl-postreload
6596 @opindex fdump-rtl-postreload
6597 Dump after post-reload optimizations.
6599 @item -fdump-rtl-pro_and_epilogue
6600 @opindex fdump-rtl-pro_and_epilogue
6601 Dump after generating the function prologues and epilogues.
6603 @item -fdump-rtl-sched1
6604 @itemx -fdump-rtl-sched2
6605 @opindex fdump-rtl-sched1
6606 @opindex fdump-rtl-sched2
6607 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6608 after the basic block scheduling passes.
6610 @item -fdump-rtl-ree
6611 @opindex fdump-rtl-ree
6612 Dump after sign/zero extension elimination.
6614 @item -fdump-rtl-seqabstr
6615 @opindex fdump-rtl-seqabstr
6616 Dump after common sequence discovery.
6618 @item -fdump-rtl-shorten
6619 @opindex fdump-rtl-shorten
6620 Dump after shortening branches.
6622 @item -fdump-rtl-sibling
6623 @opindex fdump-rtl-sibling
6624 Dump after sibling call optimizations.
6626 @item -fdump-rtl-split1
6627 @itemx -fdump-rtl-split2
6628 @itemx -fdump-rtl-split3
6629 @itemx -fdump-rtl-split4
6630 @itemx -fdump-rtl-split5
6631 @opindex fdump-rtl-split1
6632 @opindex fdump-rtl-split2
6633 @opindex fdump-rtl-split3
6634 @opindex fdump-rtl-split4
6635 @opindex fdump-rtl-split5
6636 These options enable dumping after five rounds of
6637 instruction splitting.
6639 @item -fdump-rtl-sms
6640 @opindex fdump-rtl-sms
6641 Dump after modulo scheduling.  This pass is only run on some
6642 architectures.
6644 @item -fdump-rtl-stack
6645 @opindex fdump-rtl-stack
6646 Dump after conversion from GCC's ``flat register file'' registers to the
6647 x87's stack-like registers.  This pass is only run on x86 variants.
6649 @item -fdump-rtl-subreg1
6650 @itemx -fdump-rtl-subreg2
6651 @opindex fdump-rtl-subreg1
6652 @opindex fdump-rtl-subreg2
6653 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6654 the two subreg expansion passes.
6656 @item -fdump-rtl-unshare
6657 @opindex fdump-rtl-unshare
6658 Dump after all rtl has been unshared.
6660 @item -fdump-rtl-vartrack
6661 @opindex fdump-rtl-vartrack
6662 Dump after variable tracking.
6664 @item -fdump-rtl-vregs
6665 @opindex fdump-rtl-vregs
6666 Dump after converting virtual registers to hard registers.
6668 @item -fdump-rtl-web
6669 @opindex fdump-rtl-web
6670 Dump after live range splitting.
6672 @item -fdump-rtl-regclass
6673 @itemx -fdump-rtl-subregs_of_mode_init
6674 @itemx -fdump-rtl-subregs_of_mode_finish
6675 @itemx -fdump-rtl-dfinit
6676 @itemx -fdump-rtl-dfinish
6677 @opindex fdump-rtl-regclass
6678 @opindex fdump-rtl-subregs_of_mode_init
6679 @opindex fdump-rtl-subregs_of_mode_finish
6680 @opindex fdump-rtl-dfinit
6681 @opindex fdump-rtl-dfinish
6682 These dumps are defined but always produce empty files.
6684 @item -da
6685 @itemx -fdump-rtl-all
6686 @opindex da
6687 @opindex fdump-rtl-all
6688 Produce all the dumps listed above.
6690 @item -dA
6691 @opindex dA
6692 Annotate the assembler output with miscellaneous debugging information.
6694 @item -dD
6695 @opindex dD
6696 Dump all macro definitions, at the end of preprocessing, in addition to
6697 normal output.
6699 @item -dH
6700 @opindex dH
6701 Produce a core dump whenever an error occurs.
6703 @item -dp
6704 @opindex dp
6705 Annotate the assembler output with a comment indicating which
6706 pattern and alternative is used.  The length of each instruction is
6707 also printed.
6709 @item -dP
6710 @opindex dP
6711 Dump the RTL in the assembler output as a comment before each instruction.
6712 Also turns on @option{-dp} annotation.
6714 @item -dx
6715 @opindex dx
6716 Just generate RTL for a function instead of compiling it.  Usually used
6717 with @option{-fdump-rtl-expand}.
6718 @end table
6720 @item -fdump-noaddr
6721 @opindex fdump-noaddr
6722 When doing debugging dumps, suppress address output.  This makes it more
6723 feasible to use diff on debugging dumps for compiler invocations with
6724 different compiler binaries and/or different
6725 text / bss / data / heap / stack / dso start locations.
6727 @item -freport-bug
6728 @opindex freport-bug
6729 Collect and dump debug information into temporary file if ICE in C/C++
6730 compiler occured.
6732 @item -fdump-unnumbered
6733 @opindex fdump-unnumbered
6734 When doing debugging dumps, suppress instruction numbers and address output.
6735 This makes it more feasible to use diff on debugging dumps for compiler
6736 invocations with different options, in particular with and without
6737 @option{-g}.
6739 @item -fdump-unnumbered-links
6740 @opindex fdump-unnumbered-links
6741 When doing debugging dumps (see @option{-d} option above), suppress
6742 instruction numbers for the links to the previous and next instructions
6743 in a sequence.
6745 @item -fdump-translation-unit @r{(C++ only)}
6746 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6747 @opindex fdump-translation-unit
6748 Dump a representation of the tree structure for the entire translation
6749 unit to a file.  The file name is made by appending @file{.tu} to the
6750 source file name, and the file is created in the same directory as the
6751 output file.  If the @samp{-@var{options}} form is used, @var{options}
6752 controls the details of the dump as described for the
6753 @option{-fdump-tree} options.
6755 @item -fdump-class-hierarchy @r{(C++ only)}
6756 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6757 @opindex fdump-class-hierarchy
6758 Dump a representation of each class's hierarchy and virtual function
6759 table layout to a file.  The file name is made by appending
6760 @file{.class} to the source file name, and the file is created in the
6761 same directory as the output file.  If the @samp{-@var{options}} form
6762 is used, @var{options} controls the details of the dump as described
6763 for the @option{-fdump-tree} options.
6765 @item -fdump-ipa-@var{switch}
6766 @opindex fdump-ipa
6767 Control the dumping at various stages of inter-procedural analysis
6768 language tree to a file.  The file name is generated by appending a
6769 switch specific suffix to the source file name, and the file is created
6770 in the same directory as the output file.  The following dumps are
6771 possible:
6773 @table @samp
6774 @item all
6775 Enables all inter-procedural analysis dumps.
6777 @item cgraph
6778 Dumps information about call-graph optimization, unused function removal,
6779 and inlining decisions.
6781 @item inline
6782 Dump after function inlining.
6784 @end table
6786 @item -fdump-passes
6787 @opindex fdump-passes
6788 Dump the list of optimization passes that are turned on and off by
6789 the current command-line options.
6791 @item -fdump-statistics-@var{option}
6792 @opindex fdump-statistics
6793 Enable and control dumping of pass statistics in a separate file.  The
6794 file name is generated by appending a suffix ending in
6795 @samp{.statistics} to the source file name, and the file is created in
6796 the same directory as the output file.  If the @samp{-@var{option}}
6797 form is used, @samp{-stats} causes counters to be summed over the
6798 whole compilation unit while @samp{-details} dumps every event as
6799 the passes generate them.  The default with no option is to sum
6800 counters for each function compiled.
6802 @item -fdump-tree-@var{switch}
6803 @itemx -fdump-tree-@var{switch}-@var{options}
6804 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6805 @opindex fdump-tree
6806 Control the dumping at various stages of processing the intermediate
6807 language tree to a file.  The file name is generated by appending a
6808 switch-specific suffix to the source file name, and the file is
6809 created in the same directory as the output file. In case of
6810 @option{=@var{filename}} option, the dump is output on the given file
6811 instead of the auto named dump files.  If the @samp{-@var{options}}
6812 form is used, @var{options} is a list of @samp{-} separated options
6813 which control the details of the dump.  Not all options are applicable
6814 to all dumps; those that are not meaningful are ignored.  The
6815 following options are available
6817 @table @samp
6818 @item address
6819 Print the address of each node.  Usually this is not meaningful as it
6820 changes according to the environment and source file.  Its primary use
6821 is for tying up a dump file with a debug environment.
6822 @item asmname
6823 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6824 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6825 use working backward from mangled names in the assembly file.
6826 @item slim
6827 When dumping front-end intermediate representations, inhibit dumping
6828 of members of a scope or body of a function merely because that scope
6829 has been reached.  Only dump such items when they are directly reachable
6830 by some other path.
6832 When dumping pretty-printed trees, this option inhibits dumping the
6833 bodies of control structures.
6835 When dumping RTL, print the RTL in slim (condensed) form instead of
6836 the default LISP-like representation.
6837 @item raw
6838 Print a raw representation of the tree.  By default, trees are
6839 pretty-printed into a C-like representation.
6840 @item details
6841 Enable more detailed dumps (not honored by every dump option). Also
6842 include information from the optimization passes.
6843 @item stats
6844 Enable dumping various statistics about the pass (not honored by every dump
6845 option).
6846 @item blocks
6847 Enable showing basic block boundaries (disabled in raw dumps).
6848 @item graph
6849 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6850 dump a representation of the control flow graph suitable for viewing with
6851 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6852 the file is pretty-printed as a subgraph, so that GraphViz can render them
6853 all in a single plot.
6855 This option currently only works for RTL dumps, and the RTL is always
6856 dumped in slim form.
6857 @item vops
6858 Enable showing virtual operands for every statement.
6859 @item lineno
6860 Enable showing line numbers for statements.
6861 @item uid
6862 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6863 @item verbose
6864 Enable showing the tree dump for each statement.
6865 @item eh
6866 Enable showing the EH region number holding each statement.
6867 @item scev
6868 Enable showing scalar evolution analysis details.
6869 @item optimized
6870 Enable showing optimization information (only available in certain
6871 passes).
6872 @item missed
6873 Enable showing missed optimization information (only available in certain
6874 passes).
6875 @item note
6876 Enable other detailed optimization information (only available in
6877 certain passes).
6878 @item =@var{filename}
6879 Instead of an auto named dump file, output into the given file
6880 name. The file names @file{stdout} and @file{stderr} are treated
6881 specially and are considered already open standard streams. For
6882 example,
6884 @smallexample
6885 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6886      -fdump-tree-pre=stderr file.c
6887 @end smallexample
6889 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6890 output on to @file{stderr}. If two conflicting dump filenames are
6891 given for the same pass, then the latter option overrides the earlier
6892 one.
6894 @item all
6895 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6896 and @option{lineno}.
6898 @item optall
6899 Turn on all optimization options, i.e., @option{optimized},
6900 @option{missed}, and @option{note}.
6901 @end table
6903 The following tree dumps are possible:
6904 @table @samp
6906 @item original
6907 @opindex fdump-tree-original
6908 Dump before any tree based optimization, to @file{@var{file}.original}.
6910 @item optimized
6911 @opindex fdump-tree-optimized
6912 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6914 @item gimple
6915 @opindex fdump-tree-gimple
6916 Dump each function before and after the gimplification pass to a file.  The
6917 file name is made by appending @file{.gimple} to the source file name.
6919 @item cfg
6920 @opindex fdump-tree-cfg
6921 Dump the control flow graph of each function to a file.  The file name is
6922 made by appending @file{.cfg} to the source file name.
6924 @item ch
6925 @opindex fdump-tree-ch
6926 Dump each function after copying loop headers.  The file name is made by
6927 appending @file{.ch} to the source file name.
6929 @item ssa
6930 @opindex fdump-tree-ssa
6931 Dump SSA related information to a file.  The file name is made by appending
6932 @file{.ssa} to the source file name.
6934 @item alias
6935 @opindex fdump-tree-alias
6936 Dump aliasing information for each function.  The file name is made by
6937 appending @file{.alias} to the source file name.
6939 @item ccp
6940 @opindex fdump-tree-ccp
6941 Dump each function after CCP@.  The file name is made by appending
6942 @file{.ccp} to the source file name.
6944 @item storeccp
6945 @opindex fdump-tree-storeccp
6946 Dump each function after STORE-CCP@.  The file name is made by appending
6947 @file{.storeccp} to the source file name.
6949 @item pre
6950 @opindex fdump-tree-pre
6951 Dump trees after partial redundancy elimination.  The file name is made
6952 by appending @file{.pre} to the source file name.
6954 @item fre
6955 @opindex fdump-tree-fre
6956 Dump trees after full redundancy elimination.  The file name is made
6957 by appending @file{.fre} to the source file name.
6959 @item copyprop
6960 @opindex fdump-tree-copyprop
6961 Dump trees after copy propagation.  The file name is made
6962 by appending @file{.copyprop} to the source file name.
6964 @item store_copyprop
6965 @opindex fdump-tree-store_copyprop
6966 Dump trees after store copy-propagation.  The file name is made
6967 by appending @file{.store_copyprop} to the source file name.
6969 @item dce
6970 @opindex fdump-tree-dce
6971 Dump each function after dead code elimination.  The file name is made by
6972 appending @file{.dce} to the source file name.
6974 @item sra
6975 @opindex fdump-tree-sra
6976 Dump each function after performing scalar replacement of aggregates.  The
6977 file name is made by appending @file{.sra} to the source file name.
6979 @item sink
6980 @opindex fdump-tree-sink
6981 Dump each function after performing code sinking.  The file name is made
6982 by appending @file{.sink} to the source file name.
6984 @item dom
6985 @opindex fdump-tree-dom
6986 Dump each function after applying dominator tree optimizations.  The file
6987 name is made by appending @file{.dom} to the source file name.
6989 @item dse
6990 @opindex fdump-tree-dse
6991 Dump each function after applying dead store elimination.  The file
6992 name is made by appending @file{.dse} to the source file name.
6994 @item phiopt
6995 @opindex fdump-tree-phiopt
6996 Dump each function after optimizing PHI nodes into straightline code.  The file
6997 name is made by appending @file{.phiopt} to the source file name.
6999 @item forwprop
7000 @opindex fdump-tree-forwprop
7001 Dump each function after forward propagating single use variables.  The file
7002 name is made by appending @file{.forwprop} to the source file name.
7004 @item copyrename
7005 @opindex fdump-tree-copyrename
7006 Dump each function after applying the copy rename optimization.  The file
7007 name is made by appending @file{.copyrename} to the source file name.
7009 @item nrv
7010 @opindex fdump-tree-nrv
7011 Dump each function after applying the named return value optimization on
7012 generic trees.  The file name is made by appending @file{.nrv} to the source
7013 file name.
7015 @item vect
7016 @opindex fdump-tree-vect
7017 Dump each function after applying vectorization of loops.  The file name is
7018 made by appending @file{.vect} to the source file name.
7020 @item slp
7021 @opindex fdump-tree-slp
7022 Dump each function after applying vectorization of basic blocks.  The file name
7023 is made by appending @file{.slp} to the source file name.
7025 @item vrp
7026 @opindex fdump-tree-vrp
7027 Dump each function after Value Range Propagation (VRP).  The file name
7028 is made by appending @file{.vrp} to the source file name.
7030 @item all
7031 @opindex fdump-tree-all
7032 Enable all the available tree dumps with the flags provided in this option.
7033 @end table
7035 @item -fopt-info
7036 @itemx -fopt-info-@var{options}
7037 @itemx -fopt-info-@var{options}=@var{filename}
7038 @opindex fopt-info
7039 Controls optimization dumps from various optimization passes. If the
7040 @samp{-@var{options}} form is used, @var{options} is a list of
7041 @samp{-} separated option keywords to select the dump details and
7042 optimizations.  
7044 The @var{options} can be divided into two groups: options describing the
7045 verbosity of the dump, and options describing which optimizations
7046 should be included. The options from both the groups can be freely
7047 mixed as they are non-overlapping. However, in case of any conflicts,
7048 the later options override the earlier options on the command
7049 line. 
7051 The following options control the dump verbosity:
7053 @table @samp
7054 @item optimized
7055 Print information when an optimization is successfully applied. It is
7056 up to a pass to decide which information is relevant. For example, the
7057 vectorizer passes print the source location of loops which are
7058 successfully vectorized.
7059 @item missed
7060 Print information about missed optimizations. Individual passes
7061 control which information to include in the output. 
7062 @item note
7063 Print verbose information about optimizations, such as certain
7064 transformations, more detailed messages about decisions etc.
7065 @item all
7066 Print detailed optimization information. This includes
7067 @samp{optimized}, @samp{missed}, and @samp{note}.
7068 @end table
7070 One or more of the following option keywords can be used to describe a
7071 group of optimizations:
7073 @table @samp
7074 @item ipa
7075 Enable dumps from all interprocedural optimizations.
7076 @item loop
7077 Enable dumps from all loop optimizations.
7078 @item inline
7079 Enable dumps from all inlining optimizations.
7080 @item vec
7081 Enable dumps from all vectorization optimizations.
7082 @item optall
7083 Enable dumps from all optimizations. This is a superset of
7084 the optimization groups listed above.
7085 @end table
7087 If @var{options} is
7088 omitted, it defaults to @samp{optimized-optall}, which means to dump all
7089 info about successful optimizations from all the passes.  
7091 If the @var{filename} is provided, then the dumps from all the
7092 applicable optimizations are concatenated into the @var{filename}.
7093 Otherwise the dump is output onto @file{stderr}. Though multiple
7094 @option{-fopt-info} options are accepted, only one of them can include
7095 a @var{filename}. If other filenames are provided then all but the
7096 first such option are ignored.
7098 Note that the output @var{filename} is overwritten
7099 in case of multiple translation units. If a combined output from
7100 multiple translation units is desired, @file{stderr} should be used
7101 instead.
7103 In the following example, the optimization info is output to
7104 @file{stderr}:
7106 @smallexample
7107 gcc -O3 -fopt-info
7108 @end smallexample
7110 This example:
7111 @smallexample
7112 gcc -O3 -fopt-info-missed=missed.all
7113 @end smallexample
7115 @noindent
7116 outputs missed optimization report from all the passes into
7117 @file{missed.all}, and this one:
7119 @smallexample
7120 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
7121 @end smallexample
7123 @noindent
7124 prints information about missed optimization opportunities from
7125 vectorization passes on @file{stderr}.  
7126 Note that @option{-fopt-info-vec-missed} is equivalent to 
7127 @option{-fopt-info-missed-vec}.
7129 As another example,
7130 @smallexample
7131 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
7132 @end smallexample
7134 @noindent
7135 outputs information about missed optimizations as well as
7136 optimized locations from all the inlining passes into
7137 @file{inline.txt}.
7139 Finally, consider:
7141 @smallexample
7142 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
7143 @end smallexample
7145 @noindent
7146 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
7147 in conflict since only one output file is allowed. In this case, only
7148 the first option takes effect and the subsequent options are
7149 ignored. Thus only @file{vec.miss} is produced which contains
7150 dumps from the vectorizer about missed opportunities.
7152 @item -frandom-seed=@var{number}
7153 @opindex frandom-seed
7154 This option provides a seed that GCC uses in place of
7155 random numbers in generating certain symbol names
7156 that have to be different in every compiled file.  It is also used to
7157 place unique stamps in coverage data files and the object files that
7158 produce them.  You can use the @option{-frandom-seed} option to produce
7159 reproducibly identical object files.
7161 The @var{number} should be different for every file you compile.
7163 @item -fsched-verbose=@var{n}
7164 @opindex fsched-verbose
7165 On targets that use instruction scheduling, this option controls the
7166 amount of debugging output the scheduler prints.  This information is
7167 written to standard error, unless @option{-fdump-rtl-sched1} or
7168 @option{-fdump-rtl-sched2} is specified, in which case it is output
7169 to the usual dump listing file, @file{.sched1} or @file{.sched2}
7170 respectively.  However for @var{n} greater than nine, the output is
7171 always printed to standard error.
7173 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
7174 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
7175 For @var{n} greater than one, it also output basic block probabilities,
7176 detailed ready list information and unit/insn info.  For @var{n} greater
7177 than two, it includes RTL at abort point, control-flow and regions info.
7178 And for @var{n} over four, @option{-fsched-verbose} also includes
7179 dependence info.
7181 @item -save-temps
7182 @itemx -save-temps=cwd
7183 @opindex save-temps
7184 Store the usual ``temporary'' intermediate files permanently; place them
7185 in the current directory and name them based on the source file.  Thus,
7186 compiling @file{foo.c} with @option{-c -save-temps} produces files
7187 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
7188 preprocessed @file{foo.i} output file even though the compiler now
7189 normally uses an integrated preprocessor.
7191 When used in combination with the @option{-x} command-line option,
7192 @option{-save-temps} is sensible enough to avoid over writing an
7193 input source file with the same extension as an intermediate file.
7194 The corresponding intermediate file may be obtained by renaming the
7195 source file before using @option{-save-temps}.
7197 If you invoke GCC in parallel, compiling several different source
7198 files that share a common base name in different subdirectories or the
7199 same source file compiled for multiple output destinations, it is
7200 likely that the different parallel compilers will interfere with each
7201 other, and overwrite the temporary files.  For instance:
7203 @smallexample
7204 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
7205 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
7206 @end smallexample
7208 may result in @file{foo.i} and @file{foo.o} being written to
7209 simultaneously by both compilers.
7211 @item -save-temps=obj
7212 @opindex save-temps=obj
7213 Store the usual ``temporary'' intermediate files permanently.  If the
7214 @option{-o} option is used, the temporary files are based on the
7215 object file.  If the @option{-o} option is not used, the
7216 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
7218 For example:
7220 @smallexample
7221 gcc -save-temps=obj -c foo.c
7222 gcc -save-temps=obj -c bar.c -o dir/xbar.o
7223 gcc -save-temps=obj foobar.c -o dir2/yfoobar
7224 @end smallexample
7226 @noindent
7227 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
7228 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
7229 @file{dir2/yfoobar.o}.
7231 @item -time@r{[}=@var{file}@r{]}
7232 @opindex time
7233 Report the CPU time taken by each subprocess in the compilation
7234 sequence.  For C source files, this is the compiler proper and assembler
7235 (plus the linker if linking is done).
7237 Without the specification of an output file, the output looks like this:
7239 @smallexample
7240 # cc1 0.12 0.01
7241 # as 0.00 0.01
7242 @end smallexample
7244 The first number on each line is the ``user time'', that is time spent
7245 executing the program itself.  The second number is ``system time'',
7246 time spent executing operating system routines on behalf of the program.
7247 Both numbers are in seconds.
7249 With the specification of an output file, the output is appended to the
7250 named file, and it looks like this:
7252 @smallexample
7253 0.12 0.01 cc1 @var{options}
7254 0.00 0.01 as @var{options}
7255 @end smallexample
7257 The ``user time'' and the ``system time'' are moved before the program
7258 name, and the options passed to the program are displayed, so that one
7259 can later tell what file was being compiled, and with which options.
7261 @item -fvar-tracking
7262 @opindex fvar-tracking
7263 Run variable tracking pass.  It computes where variables are stored at each
7264 position in code.  Better debugging information is then generated
7265 (if the debugging information format supports this information).
7267 It is enabled by default when compiling with optimization (@option{-Os},
7268 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7269 the debug info format supports it.
7271 @item -fvar-tracking-assignments
7272 @opindex fvar-tracking-assignments
7273 @opindex fno-var-tracking-assignments
7274 Annotate assignments to user variables early in the compilation and
7275 attempt to carry the annotations over throughout the compilation all the
7276 way to the end, in an attempt to improve debug information while
7277 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7279 It can be enabled even if var-tracking is disabled, in which case
7280 annotations are created and maintained, but discarded at the end.
7281 By default, this flag is enabled together with @option{-fvar-tracking},
7282 except when selective scheduling is enabled.
7284 @item -fvar-tracking-assignments-toggle
7285 @opindex fvar-tracking-assignments-toggle
7286 @opindex fno-var-tracking-assignments-toggle
7287 Toggle @option{-fvar-tracking-assignments}, in the same way that
7288 @option{-gtoggle} toggles @option{-g}.
7290 @item -print-file-name=@var{library}
7291 @opindex print-file-name
7292 Print the full absolute name of the library file @var{library} that
7293 would be used when linking---and don't do anything else.  With this
7294 option, GCC does not compile or link anything; it just prints the
7295 file name.
7297 @item -print-multi-directory
7298 @opindex print-multi-directory
7299 Print the directory name corresponding to the multilib selected by any
7300 other switches present in the command line.  This directory is supposed
7301 to exist in @env{GCC_EXEC_PREFIX}.
7303 @item -print-multi-lib
7304 @opindex print-multi-lib
7305 Print the mapping from multilib directory names to compiler switches
7306 that enable them.  The directory name is separated from the switches by
7307 @samp{;}, and each switch starts with an @samp{@@} instead of the
7308 @samp{-}, without spaces between multiple switches.  This is supposed to
7309 ease shell processing.
7311 @item -print-multi-os-directory
7312 @opindex print-multi-os-directory
7313 Print the path to OS libraries for the selected
7314 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7315 present in the @file{lib} subdirectory and no multilibs are used, this is
7316 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7317 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7318 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7319 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7321 @item -print-multiarch
7322 @opindex print-multiarch
7323 Print the path to OS libraries for the selected multiarch,
7324 relative to some @file{lib} subdirectory.
7326 @item -print-prog-name=@var{program}
7327 @opindex print-prog-name
7328 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
7330 @item -print-libgcc-file-name
7331 @opindex print-libgcc-file-name
7332 Same as @option{-print-file-name=libgcc.a}.
7334 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7335 but you do want to link with @file{libgcc.a}.  You can do:
7337 @smallexample
7338 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7339 @end smallexample
7341 @item -print-search-dirs
7342 @opindex print-search-dirs
7343 Print the name of the configured installation directory and a list of
7344 program and library directories @command{gcc} searches---and don't do anything else.
7346 This is useful when @command{gcc} prints the error message
7347 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7348 To resolve this you either need to put @file{cpp0} and the other compiler
7349 components where @command{gcc} expects to find them, or you can set the environment
7350 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7351 Don't forget the trailing @samp{/}.
7352 @xref{Environment Variables}.
7354 @item -print-sysroot
7355 @opindex print-sysroot
7356 Print the target sysroot directory that is used during
7357 compilation.  This is the target sysroot specified either at configure
7358 time or using the @option{--sysroot} option, possibly with an extra
7359 suffix that depends on compilation options.  If no target sysroot is
7360 specified, the option prints nothing.
7362 @item -print-sysroot-headers-suffix
7363 @opindex print-sysroot-headers-suffix
7364 Print the suffix added to the target sysroot when searching for
7365 headers, or give an error if the compiler is not configured with such
7366 a suffix---and don't do anything else.
7368 @item -dumpmachine
7369 @opindex dumpmachine
7370 Print the compiler's target machine (for example,
7371 @samp{i686-pc-linux-gnu})---and don't do anything else.
7373 @item -dumpversion
7374 @opindex dumpversion
7375 Print the compiler version (for example, @code{3.0})---and don't do
7376 anything else.
7378 @item -dumpspecs
7379 @opindex dumpspecs
7380 Print the compiler's built-in specs---and don't do anything else.  (This
7381 is used when GCC itself is being built.)  @xref{Spec Files}.
7383 @item -fno-eliminate-unused-debug-types
7384 @opindex feliminate-unused-debug-types
7385 @opindex fno-eliminate-unused-debug-types
7386 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7387 output for types that are nowhere used in the source file being compiled.
7388 Sometimes it is useful to have GCC emit debugging
7389 information for all types declared in a compilation
7390 unit, regardless of whether or not they are actually used
7391 in that compilation unit, for example 
7392 if, in the debugger, you want to cast a value to a type that is
7393 not actually used in your program (but is declared).  More often,
7394 however, this results in a significant amount of wasted space.
7395 @end table
7397 @node Optimize Options
7398 @section Options That Control Optimization
7399 @cindex optimize options
7400 @cindex options, optimization
7402 These options control various sorts of optimizations.
7404 Without any optimization option, the compiler's goal is to reduce the
7405 cost of compilation and to make debugging produce the expected
7406 results.  Statements are independent: if you stop the program with a
7407 breakpoint between statements, you can then assign a new value to any
7408 variable or change the program counter to any other statement in the
7409 function and get exactly the results you expect from the source
7410 code.
7412 Turning on optimization flags makes the compiler attempt to improve
7413 the performance and/or code size at the expense of compilation time
7414 and possibly the ability to debug the program.
7416 The compiler performs optimization based on the knowledge it has of the
7417 program.  Compiling multiple files at once to a single output file mode allows
7418 the compiler to use information gained from all of the files when compiling
7419 each of them.
7421 Not all optimizations are controlled directly by a flag.  Only
7422 optimizations that have a flag are listed in this section.
7424 Most optimizations are only enabled if an @option{-O} level is set on
7425 the command line.  Otherwise they are disabled, even if individual
7426 optimization flags are specified.
7428 Depending on the target and how GCC was configured, a slightly different
7429 set of optimizations may be enabled at each @option{-O} level than
7430 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7431 to find out the exact set of optimizations that are enabled at each level.
7432 @xref{Overall Options}, for examples.
7434 @table @gcctabopt
7435 @item -O
7436 @itemx -O1
7437 @opindex O
7438 @opindex O1
7439 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7440 more memory for a large function.
7442 With @option{-O}, the compiler tries to reduce code size and execution
7443 time, without performing any optimizations that take a great deal of
7444 compilation time.
7446 @option{-O} turns on the following optimization flags:
7447 @gccoptlist{
7448 -fauto-inc-dec @gol
7449 -fbranch-count-reg @gol
7450 -fcombine-stack-adjustments @gol
7451 -fcompare-elim @gol
7452 -fcprop-registers @gol
7453 -fdce @gol
7454 -fdefer-pop @gol
7455 -fdelayed-branch @gol
7456 -fdse @gol
7457 -fforward-propagate @gol
7458 -fguess-branch-probability @gol
7459 -fif-conversion2 @gol
7460 -fif-conversion @gol
7461 -finline-functions-called-once @gol
7462 -fipa-pure-const @gol
7463 -fipa-profile @gol
7464 -fipa-reference @gol
7465 -fmerge-constants @gol
7466 -fmove-loop-invariants @gol
7467 -fshrink-wrap @gol
7468 -fsplit-wide-types @gol
7469 -ftree-bit-ccp @gol
7470 -ftree-ccp @gol
7471 -fssa-phiopt @gol
7472 -ftree-ch @gol
7473 -ftree-copy-prop @gol
7474 -ftree-copyrename @gol
7475 -ftree-dce @gol
7476 -ftree-dominator-opts @gol
7477 -ftree-dse @gol
7478 -ftree-forwprop @gol
7479 -ftree-fre @gol
7480 -ftree-phiprop @gol
7481 -ftree-sink @gol
7482 -ftree-slsr @gol
7483 -ftree-sra @gol
7484 -ftree-pta @gol
7485 -ftree-ter @gol
7486 -funit-at-a-time}
7488 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7489 where doing so does not interfere with debugging.
7491 @item -O2
7492 @opindex O2
7493 Optimize even more.  GCC performs nearly all supported optimizations
7494 that do not involve a space-speed tradeoff.
7495 As compared to @option{-O}, this option increases both compilation time
7496 and the performance of the generated code.
7498 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7499 also turns on the following optimization flags:
7500 @gccoptlist{-fthread-jumps @gol
7501 -falign-functions  -falign-jumps @gol
7502 -falign-loops  -falign-labels @gol
7503 -fcaller-saves @gol
7504 -fcrossjumping @gol
7505 -fcse-follow-jumps  -fcse-skip-blocks @gol
7506 -fdelete-null-pointer-checks @gol
7507 -fdevirtualize -fdevirtualize-speculatively @gol
7508 -fexpensive-optimizations @gol
7509 -fgcse  -fgcse-lm  @gol
7510 -fhoist-adjacent-loads @gol
7511 -finline-small-functions @gol
7512 -findirect-inlining @gol
7513 -fipa-cp @gol
7514 -fipa-cp-alignment @gol
7515 -fipa-sra @gol
7516 -fipa-icf @gol
7517 -fisolate-erroneous-paths-dereference @gol
7518 -flra-remat @gol
7519 -foptimize-sibling-calls @gol
7520 -foptimize-strlen @gol
7521 -fpartial-inlining @gol
7522 -fpeephole2 @gol
7523 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7524 -frerun-cse-after-loop  @gol
7525 -fsched-interblock  -fsched-spec @gol
7526 -fschedule-insns  -fschedule-insns2 @gol
7527 -fstrict-aliasing -fstrict-overflow @gol
7528 -ftree-builtin-call-dce @gol
7529 -ftree-switch-conversion -ftree-tail-merge @gol
7530 -ftree-pre @gol
7531 -ftree-vrp @gol
7532 -fipa-ra}
7534 Please note the warning under @option{-fgcse} about
7535 invoking @option{-O2} on programs that use computed gotos.
7537 @item -O3
7538 @opindex O3
7539 Optimize yet more.  @option{-O3} turns on all optimizations specified
7540 by @option{-O2} and also turns on the @option{-finline-functions},
7541 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7542 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7543 @option{-ftree-loop-distribute-patterns},
7544 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7545 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7547 @item -O0
7548 @opindex O0
7549 Reduce compilation time and make debugging produce the expected
7550 results.  This is the default.
7552 @item -Os
7553 @opindex Os
7554 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7555 do not typically increase code size.  It also performs further
7556 optimizations designed to reduce code size.
7558 @option{-Os} disables the following optimization flags:
7559 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7560 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7561 -fprefetch-loop-arrays}
7563 @item -Ofast
7564 @opindex Ofast
7565 Disregard strict standards compliance.  @option{-Ofast} enables all
7566 @option{-O3} optimizations.  It also enables optimizations that are not
7567 valid for all standard-compliant programs.
7568 It turns on @option{-ffast-math} and the Fortran-specific
7569 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7571 @item -Og
7572 @opindex Og
7573 Optimize debugging experience.  @option{-Og} enables optimizations
7574 that do not interfere with debugging. It should be the optimization
7575 level of choice for the standard edit-compile-debug cycle, offering
7576 a reasonable level of optimization while maintaining fast compilation
7577 and a good debugging experience.
7579 If you use multiple @option{-O} options, with or without level numbers,
7580 the last such option is the one that is effective.
7581 @end table
7583 Options of the form @option{-f@var{flag}} specify machine-independent
7584 flags.  Most flags have both positive and negative forms; the negative
7585 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7586 below, only one of the forms is listed---the one you typically 
7587 use.  You can figure out the other form by either removing @samp{no-}
7588 or adding it.
7590 The following options control specific optimizations.  They are either
7591 activated by @option{-O} options or are related to ones that are.  You
7592 can use the following flags in the rare cases when ``fine-tuning'' of
7593 optimizations to be performed is desired.
7595 @table @gcctabopt
7596 @item -fno-defer-pop
7597 @opindex fno-defer-pop
7598 Always pop the arguments to each function call as soon as that function
7599 returns.  For machines that must pop arguments after a function call,
7600 the compiler normally lets arguments accumulate on the stack for several
7601 function calls and pops them all at once.
7603 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7605 @item -fforward-propagate
7606 @opindex fforward-propagate
7607 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7608 instructions and checks if the result can be simplified.  If loop unrolling
7609 is active, two passes are performed and the second is scheduled after
7610 loop unrolling.
7612 This option is enabled by default at optimization levels @option{-O},
7613 @option{-O2}, @option{-O3}, @option{-Os}.
7615 @item -ffp-contract=@var{style}
7616 @opindex ffp-contract
7617 @option{-ffp-contract=off} disables floating-point expression contraction.
7618 @option{-ffp-contract=fast} enables floating-point expression contraction
7619 such as forming of fused multiply-add operations if the target has
7620 native support for them.
7621 @option{-ffp-contract=on} enables floating-point expression contraction
7622 if allowed by the language standard.  This is currently not implemented
7623 and treated equal to @option{-ffp-contract=off}.
7625 The default is @option{-ffp-contract=fast}.
7627 @item -fomit-frame-pointer
7628 @opindex fomit-frame-pointer
7629 Don't keep the frame pointer in a register for functions that
7630 don't need one.  This avoids the instructions to save, set up and
7631 restore frame pointers; it also makes an extra register available
7632 in many functions.  @strong{It also makes debugging impossible on
7633 some machines.}
7635 On some machines, such as the VAX, this flag has no effect, because
7636 the standard calling sequence automatically handles the frame pointer
7637 and nothing is saved by pretending it doesn't exist.  The
7638 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7639 whether a target machine supports this flag.  @xref{Registers,,Register
7640 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7642 The default setting (when not optimizing for
7643 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7644 @option{-fomit-frame-pointer}.  You can configure GCC with the
7645 @option{--enable-frame-pointer} configure option to change the default.
7647 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7649 @item -foptimize-sibling-calls
7650 @opindex foptimize-sibling-calls
7651 Optimize sibling and tail recursive calls.
7653 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7655 @item -foptimize-strlen
7656 @opindex foptimize-strlen
7657 Optimize various standard C string functions (e.g. @code{strlen},
7658 @code{strchr} or @code{strcpy}) and
7659 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7661 Enabled at levels @option{-O2}, @option{-O3}.
7663 @item -fno-inline
7664 @opindex fno-inline
7665 Do not expand any functions inline apart from those marked with
7666 the @code{always_inline} attribute.  This is the default when not
7667 optimizing.
7669 Single functions can be exempted from inlining by marking them
7670 with the @code{noinline} attribute.
7672 @item -finline-small-functions
7673 @opindex finline-small-functions
7674 Integrate functions into their callers when their body is smaller than expected
7675 function call code (so overall size of program gets smaller).  The compiler
7676 heuristically decides which functions are simple enough to be worth integrating
7677 in this way.  This inlining applies to all functions, even those not declared
7678 inline.
7680 Enabled at level @option{-O2}.
7682 @item -findirect-inlining
7683 @opindex findirect-inlining
7684 Inline also indirect calls that are discovered to be known at compile
7685 time thanks to previous inlining.  This option has any effect only
7686 when inlining itself is turned on by the @option{-finline-functions}
7687 or @option{-finline-small-functions} options.
7689 Enabled at level @option{-O2}.
7691 @item -finline-functions
7692 @opindex finline-functions
7693 Consider all functions for inlining, even if they are not declared inline.
7694 The compiler heuristically decides which functions are worth integrating
7695 in this way.
7697 If all calls to a given function are integrated, and the function is
7698 declared @code{static}, then the function is normally not output as
7699 assembler code in its own right.
7701 Enabled at level @option{-O3}.
7703 @item -finline-functions-called-once
7704 @opindex finline-functions-called-once
7705 Consider all @code{static} functions called once for inlining into their
7706 caller even if they are not marked @code{inline}.  If a call to a given
7707 function is integrated, then the function is not output as assembler code
7708 in its own right.
7710 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7712 @item -fearly-inlining
7713 @opindex fearly-inlining
7714 Inline functions marked by @code{always_inline} and functions whose body seems
7715 smaller than the function call overhead early before doing
7716 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7717 makes profiling significantly cheaper and usually inlining faster on programs
7718 having large chains of nested wrapper functions.
7720 Enabled by default.
7722 @item -fipa-sra
7723 @opindex fipa-sra
7724 Perform interprocedural scalar replacement of aggregates, removal of
7725 unused parameters and replacement of parameters passed by reference
7726 by parameters passed by value.
7728 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7730 @item -finline-limit=@var{n}
7731 @opindex finline-limit
7732 By default, GCC limits the size of functions that can be inlined.  This flag
7733 allows coarse control of this limit.  @var{n} is the size of functions that
7734 can be inlined in number of pseudo instructions.
7736 Inlining is actually controlled by a number of parameters, which may be
7737 specified individually by using @option{--param @var{name}=@var{value}}.
7738 The @option{-finline-limit=@var{n}} option sets some of these parameters
7739 as follows:
7741 @table @gcctabopt
7742 @item max-inline-insns-single
7743 is set to @var{n}/2.
7744 @item max-inline-insns-auto
7745 is set to @var{n}/2.
7746 @end table
7748 See below for a documentation of the individual
7749 parameters controlling inlining and for the defaults of these parameters.
7751 @emph{Note:} there may be no value to @option{-finline-limit} that results
7752 in default behavior.
7754 @emph{Note:} pseudo instruction represents, in this particular context, an
7755 abstract measurement of function's size.  In no way does it represent a count
7756 of assembly instructions and as such its exact meaning might change from one
7757 release to an another.
7759 @item -fno-keep-inline-dllexport
7760 @opindex fno-keep-inline-dllexport
7761 This is a more fine-grained version of @option{-fkeep-inline-functions},
7762 which applies only to functions that are declared using the @code{dllexport}
7763 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7764 Functions}.)
7766 @item -fkeep-inline-functions
7767 @opindex fkeep-inline-functions
7768 In C, emit @code{static} functions that are declared @code{inline}
7769 into the object file, even if the function has been inlined into all
7770 of its callers.  This switch does not affect functions using the
7771 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7772 inline functions into the object file.
7774 @item -fkeep-static-consts
7775 @opindex fkeep-static-consts
7776 Emit variables declared @code{static const} when optimization isn't turned
7777 on, even if the variables aren't referenced.
7779 GCC enables this option by default.  If you want to force the compiler to
7780 check if a variable is referenced, regardless of whether or not
7781 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7783 @item -fmerge-constants
7784 @opindex fmerge-constants
7785 Attempt to merge identical constants (string constants and floating-point
7786 constants) across compilation units.
7788 This option is the default for optimized compilation if the assembler and
7789 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7790 behavior.
7792 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7794 @item -fmerge-all-constants
7795 @opindex fmerge-all-constants
7796 Attempt to merge identical constants and identical variables.
7798 This option implies @option{-fmerge-constants}.  In addition to
7799 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7800 arrays or initialized constant variables with integral or floating-point
7801 types.  Languages like C or C++ require each variable, including multiple
7802 instances of the same variable in recursive calls, to have distinct locations,
7803 so using this option results in non-conforming
7804 behavior.
7806 @item -fmodulo-sched
7807 @opindex fmodulo-sched
7808 Perform swing modulo scheduling immediately before the first scheduling
7809 pass.  This pass looks at innermost loops and reorders their
7810 instructions by overlapping different iterations.
7812 @item -fmodulo-sched-allow-regmoves
7813 @opindex fmodulo-sched-allow-regmoves
7814 Perform more aggressive SMS-based modulo scheduling with register moves
7815 allowed.  By setting this flag certain anti-dependences edges are
7816 deleted, which triggers the generation of reg-moves based on the
7817 life-range analysis.  This option is effective only with
7818 @option{-fmodulo-sched} enabled.
7820 @item -fno-branch-count-reg
7821 @opindex fno-branch-count-reg
7822 Do not use ``decrement and branch'' instructions on a count register,
7823 but instead generate a sequence of instructions that decrement a
7824 register, compare it against zero, then branch based upon the result.
7825 This option is only meaningful on architectures that support such
7826 instructions, which include x86, PowerPC, IA-64 and S/390.
7828 Enabled by default at @option{-O1} and higher.
7830 The default is @option{-fbranch-count-reg}.
7832 @item -fno-function-cse
7833 @opindex fno-function-cse
7834 Do not put function addresses in registers; make each instruction that
7835 calls a constant function contain the function's address explicitly.
7837 This option results in less efficient code, but some strange hacks
7838 that alter the assembler output may be confused by the optimizations
7839 performed when this option is not used.
7841 The default is @option{-ffunction-cse}
7843 @item -fno-zero-initialized-in-bss
7844 @opindex fno-zero-initialized-in-bss
7845 If the target supports a BSS section, GCC by default puts variables that
7846 are initialized to zero into BSS@.  This can save space in the resulting
7847 code.
7849 This option turns off this behavior because some programs explicitly
7850 rely on variables going to the data section---e.g., so that the
7851 resulting executable can find the beginning of that section and/or make
7852 assumptions based on that.
7854 The default is @option{-fzero-initialized-in-bss}.
7856 @item -fthread-jumps
7857 @opindex fthread-jumps
7858 Perform optimizations that check to see if a jump branches to a
7859 location where another comparison subsumed by the first is found.  If
7860 so, the first branch is redirected to either the destination of the
7861 second branch or a point immediately following it, depending on whether
7862 the condition is known to be true or false.
7864 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7866 @item -fsplit-wide-types
7867 @opindex fsplit-wide-types
7868 When using a type that occupies multiple registers, such as @code{long
7869 long} on a 32-bit system, split the registers apart and allocate them
7870 independently.  This normally generates better code for those types,
7871 but may make debugging more difficult.
7873 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7874 @option{-Os}.
7876 @item -fcse-follow-jumps
7877 @opindex fcse-follow-jumps
7878 In common subexpression elimination (CSE), scan through jump instructions
7879 when the target of the jump is not reached by any other path.  For
7880 example, when CSE encounters an @code{if} statement with an
7881 @code{else} clause, CSE follows the jump when the condition
7882 tested is false.
7884 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7886 @item -fcse-skip-blocks
7887 @opindex fcse-skip-blocks
7888 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7889 follow jumps that conditionally skip over blocks.  When CSE
7890 encounters a simple @code{if} statement with no else clause,
7891 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7892 body of the @code{if}.
7894 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7896 @item -frerun-cse-after-loop
7897 @opindex frerun-cse-after-loop
7898 Re-run common subexpression elimination after loop optimizations are
7899 performed.
7901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7903 @item -fgcse
7904 @opindex fgcse
7905 Perform a global common subexpression elimination pass.
7906 This pass also performs global constant and copy propagation.
7908 @emph{Note:} When compiling a program using computed gotos, a GCC
7909 extension, you may get better run-time performance if you disable
7910 the global common subexpression elimination pass by adding
7911 @option{-fno-gcse} to the command line.
7913 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7915 @item -fgcse-lm
7916 @opindex fgcse-lm
7917 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7918 attempts to move loads that are only killed by stores into themselves.  This
7919 allows a loop containing a load/store sequence to be changed to a load outside
7920 the loop, and a copy/store within the loop.
7922 Enabled by default when @option{-fgcse} is enabled.
7924 @item -fgcse-sm
7925 @opindex fgcse-sm
7926 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7927 global common subexpression elimination.  This pass attempts to move
7928 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7929 loops containing a load/store sequence can be changed to a load before
7930 the loop and a store after the loop.
7932 Not enabled at any optimization level.
7934 @item -fgcse-las
7935 @opindex fgcse-las
7936 When @option{-fgcse-las} is enabled, the global common subexpression
7937 elimination pass eliminates redundant loads that come after stores to the
7938 same memory location (both partial and full redundancies).
7940 Not enabled at any optimization level.
7942 @item -fgcse-after-reload
7943 @opindex fgcse-after-reload
7944 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7945 pass is performed after reload.  The purpose of this pass is to clean up
7946 redundant spilling.
7948 @item -faggressive-loop-optimizations
7949 @opindex faggressive-loop-optimizations
7950 This option tells the loop optimizer to use language constraints to
7951 derive bounds for the number of iterations of a loop.  This assumes that
7952 loop code does not invoke undefined behavior by for example causing signed
7953 integer overflows or out-of-bound array accesses.  The bounds for the
7954 number of iterations of a loop are used to guide loop unrolling and peeling
7955 and loop exit test optimizations.
7956 This option is enabled by default.
7958 @item -funsafe-loop-optimizations
7959 @opindex funsafe-loop-optimizations
7960 This option tells the loop optimizer to assume that loop indices do not
7961 overflow, and that loops with nontrivial exit condition are not
7962 infinite.  This enables a wider range of loop optimizations even if
7963 the loop optimizer itself cannot prove that these assumptions are valid.
7964 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7965 if it finds this kind of loop.
7967 @item -fcrossjumping
7968 @opindex fcrossjumping
7969 Perform cross-jumping transformation.
7970 This transformation unifies equivalent code and saves code size.  The
7971 resulting code may or may not perform better than without cross-jumping.
7973 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7975 @item -fauto-inc-dec
7976 @opindex fauto-inc-dec
7977 Combine increments or decrements of addresses with memory accesses.
7978 This pass is always skipped on architectures that do not have
7979 instructions to support this.  Enabled by default at @option{-O} and
7980 higher on architectures that support this.
7982 @item -fdce
7983 @opindex fdce
7984 Perform dead code elimination (DCE) on RTL@.
7985 Enabled by default at @option{-O} and higher.
7987 @item -fdse
7988 @opindex fdse
7989 Perform dead store elimination (DSE) on RTL@.
7990 Enabled by default at @option{-O} and higher.
7992 @item -fif-conversion
7993 @opindex fif-conversion
7994 Attempt to transform conditional jumps into branch-less equivalents.  This
7995 includes use of conditional moves, min, max, set flags and abs instructions, and
7996 some tricks doable by standard arithmetics.  The use of conditional execution
7997 on chips where it is available is controlled by @option{-fif-conversion2}.
7999 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8001 @item -fif-conversion2
8002 @opindex fif-conversion2
8003 Use conditional execution (where available) to transform conditional jumps into
8004 branch-less equivalents.
8006 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8008 @item -fdeclone-ctor-dtor
8009 @opindex fdeclone-ctor-dtor
8010 The C++ ABI requires multiple entry points for constructors and
8011 destructors: one for a base subobject, one for a complete object, and
8012 one for a virtual destructor that calls operator delete afterwards.
8013 For a hierarchy with virtual bases, the base and complete variants are
8014 clones, which means two copies of the function.  With this option, the
8015 base and complete variants are changed to be thunks that call a common
8016 implementation.
8018 Enabled by @option{-Os}.
8020 @item -fdelete-null-pointer-checks
8021 @opindex fdelete-null-pointer-checks
8022 Assume that programs cannot safely dereference null pointers, and that
8023 no code or data element resides there.  This enables simple constant
8024 folding optimizations at all optimization levels.  In addition, other
8025 optimization passes in GCC use this flag to control global dataflow
8026 analyses that eliminate useless checks for null pointers; these assume
8027 that if a pointer is checked after it has already been dereferenced,
8028 it cannot be null.
8030 Note however that in some environments this assumption is not true.
8031 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8032 for programs that depend on that behavior.
8034 Some targets, especially embedded ones, disable this option at all levels.
8035 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
8036 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
8037 are enabled independently at different optimization levels.
8039 @item -fdevirtualize
8040 @opindex fdevirtualize
8041 Attempt to convert calls to virtual functions to direct calls.  This
8042 is done both within a procedure and interprocedurally as part of
8043 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8044 propagation (@option{-fipa-cp}).
8045 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8047 @item -fdevirtualize-speculatively
8048 @opindex fdevirtualize-speculatively
8049 Attempt to convert calls to virtual functions to speculative direct calls.
8050 Based on the analysis of the type inheritance graph, determine for a given call
8051 the set of likely targets. If the set is small, preferably of size 1, change
8052 the call into a conditional deciding between direct and indirect calls.  The
8053 speculative calls enable more optimizations, such as inlining.  When they seem
8054 useless after further optimization, they are converted back into original form.
8056 @item -fdevirtualize-at-ltrans
8057 @opindex fdevirtualize-at-ltrans
8058 Stream extra information needed for aggressive devirtualization when running
8059 the link-time optimizer in local transformation mode.  
8060 This option enables more devirtualization but
8061 significantly increases the size of streamed data. For this reason it is
8062 disabled by default.
8064 @item -fexpensive-optimizations
8065 @opindex fexpensive-optimizations
8066 Perform a number of minor optimizations that are relatively expensive.
8068 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8070 @item -free
8071 @opindex free
8072 Attempt to remove redundant extension instructions.  This is especially
8073 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8074 registers after writing to their lower 32-bit half.
8076 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8077 @option{-O3}, @option{-Os}.
8079 @item -fno-lifetime-dse
8080 @opindex fno-lifetime-dse
8081 In C++ the value of an object is only affected by changes within its
8082 lifetime: when the constructor begins, the object has an indeterminate
8083 value, and any changes during the lifetime of the object are dead when
8084 the object is destroyed.  Normally dead store elimination will take
8085 advantage of this; if your code relies on the value of the object
8086 storage persisting beyond the lifetime of the object, you can use this
8087 flag to disable this optimization.
8089 @item -flive-range-shrinkage
8090 @opindex flive-range-shrinkage
8091 Attempt to decrease register pressure through register live range
8092 shrinkage.  This is helpful for fast processors with small or moderate
8093 size register sets.
8095 @item -fira-algorithm=@var{algorithm}
8096 @opindex fira-algorithm
8097 Use the specified coloring algorithm for the integrated register
8098 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8099 specifies Chow's priority coloring, or @samp{CB}, which specifies
8100 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8101 for all architectures, but for those targets that do support it, it is
8102 the default because it generates better code.
8104 @item -fira-region=@var{region}
8105 @opindex fira-region
8106 Use specified regions for the integrated register allocator.  The
8107 @var{region} argument should be one of the following:
8109 @table @samp
8111 @item all
8112 Use all loops as register allocation regions.
8113 This can give the best results for machines with a small and/or
8114 irregular register set.
8116 @item mixed
8117 Use all loops except for loops with small register pressure 
8118 as the regions.  This value usually gives
8119 the best results in most cases and for most architectures,
8120 and is enabled by default when compiling with optimization for speed
8121 (@option{-O}, @option{-O2}, @dots{}).
8123 @item one
8124 Use all functions as a single region.  
8125 This typically results in the smallest code size, and is enabled by default for
8126 @option{-Os} or @option{-O0}.
8128 @end table
8130 @item -fira-hoist-pressure
8131 @opindex fira-hoist-pressure
8132 Use IRA to evaluate register pressure in the code hoisting pass for
8133 decisions to hoist expressions.  This option usually results in smaller
8134 code, but it can slow the compiler down.
8136 This option is enabled at level @option{-Os} for all targets.
8138 @item -fira-loop-pressure
8139 @opindex fira-loop-pressure
8140 Use IRA to evaluate register pressure in loops for decisions to move
8141 loop invariants.  This option usually results in generation
8142 of faster and smaller code on machines with large register files (>= 32
8143 registers), but it can slow the compiler down.
8145 This option is enabled at level @option{-O3} for some targets.
8147 @item -fno-ira-share-save-slots
8148 @opindex fno-ira-share-save-slots
8149 Disable sharing of stack slots used for saving call-used hard
8150 registers living through a call.  Each hard register gets a
8151 separate stack slot, and as a result function stack frames are
8152 larger.
8154 @item -fno-ira-share-spill-slots
8155 @opindex fno-ira-share-spill-slots
8156 Disable sharing of stack slots allocated for pseudo-registers.  Each
8157 pseudo-register that does not get a hard register gets a separate
8158 stack slot, and as a result function stack frames are larger.
8160 @item -fira-verbose=@var{n}
8161 @opindex fira-verbose
8162 Control the verbosity of the dump file for the integrated register allocator.
8163 The default value is 5.  If the value @var{n} is greater or equal to 10,
8164 the dump output is sent to stderr using the same format as @var{n} minus 10.
8166 @item -flra-remat
8167 @opindex flra-remat
8168 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8169 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8170 values if it is profitable.
8172 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8174 @item -fdelayed-branch
8175 @opindex fdelayed-branch
8176 If supported for the target machine, attempt to reorder instructions
8177 to exploit instruction slots available after delayed branch
8178 instructions.
8180 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8182 @item -fschedule-insns
8183 @opindex fschedule-insns
8184 If supported for the target machine, attempt to reorder instructions to
8185 eliminate execution stalls due to required data being unavailable.  This
8186 helps machines that have slow floating point or memory load instructions
8187 by allowing other instructions to be issued until the result of the load
8188 or floating-point instruction is required.
8190 Enabled at levels @option{-O2}, @option{-O3}.
8192 @item -fschedule-insns2
8193 @opindex fschedule-insns2
8194 Similar to @option{-fschedule-insns}, but requests an additional pass of
8195 instruction scheduling after register allocation has been done.  This is
8196 especially useful on machines with a relatively small number of
8197 registers and where memory load instructions take more than one cycle.
8199 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8201 @item -fno-sched-interblock
8202 @opindex fno-sched-interblock
8203 Don't schedule instructions across basic blocks.  This is normally
8204 enabled by default when scheduling before register allocation, i.e.@:
8205 with @option{-fschedule-insns} or at @option{-O2} or higher.
8207 @item -fno-sched-spec
8208 @opindex fno-sched-spec
8209 Don't allow speculative motion of non-load instructions.  This is normally
8210 enabled by default when scheduling before register allocation, i.e.@:
8211 with @option{-fschedule-insns} or at @option{-O2} or higher.
8213 @item -fsched-pressure
8214 @opindex fsched-pressure
8215 Enable register pressure sensitive insn scheduling before register
8216 allocation.  This only makes sense when scheduling before register
8217 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8218 @option{-O2} or higher.  Usage of this option can improve the
8219 generated code and decrease its size by preventing register pressure
8220 increase above the number of available hard registers and subsequent
8221 spills in register allocation.
8223 @item -fsched-spec-load
8224 @opindex fsched-spec-load
8225 Allow speculative motion of some load instructions.  This only makes
8226 sense when scheduling before register allocation, i.e.@: with
8227 @option{-fschedule-insns} or at @option{-O2} or higher.
8229 @item -fsched-spec-load-dangerous
8230 @opindex fsched-spec-load-dangerous
8231 Allow speculative motion of more load instructions.  This only makes
8232 sense when scheduling before register allocation, i.e.@: with
8233 @option{-fschedule-insns} or at @option{-O2} or higher.
8235 @item -fsched-stalled-insns
8236 @itemx -fsched-stalled-insns=@var{n}
8237 @opindex fsched-stalled-insns
8238 Define how many insns (if any) can be moved prematurely from the queue
8239 of stalled insns into the ready list during the second scheduling pass.
8240 @option{-fno-sched-stalled-insns} means that no insns are moved
8241 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8242 on how many queued insns can be moved prematurely.
8243 @option{-fsched-stalled-insns} without a value is equivalent to
8244 @option{-fsched-stalled-insns=1}.
8246 @item -fsched-stalled-insns-dep
8247 @itemx -fsched-stalled-insns-dep=@var{n}
8248 @opindex fsched-stalled-insns-dep
8249 Define how many insn groups (cycles) are examined for a dependency
8250 on a stalled insn that is a candidate for premature removal from the queue
8251 of stalled insns.  This has an effect only during the second scheduling pass,
8252 and only if @option{-fsched-stalled-insns} is used.
8253 @option{-fno-sched-stalled-insns-dep} is equivalent to
8254 @option{-fsched-stalled-insns-dep=0}.
8255 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8256 @option{-fsched-stalled-insns-dep=1}.
8258 @item -fsched2-use-superblocks
8259 @opindex fsched2-use-superblocks
8260 When scheduling after register allocation, use superblock scheduling.
8261 This allows motion across basic block boundaries,
8262 resulting in faster schedules.  This option is experimental, as not all machine
8263 descriptions used by GCC model the CPU closely enough to avoid unreliable
8264 results from the algorithm.
8266 This only makes sense when scheduling after register allocation, i.e.@: with
8267 @option{-fschedule-insns2} or at @option{-O2} or higher.
8269 @item -fsched-group-heuristic
8270 @opindex fsched-group-heuristic
8271 Enable the group heuristic in the scheduler.  This heuristic favors
8272 the instruction that belongs to a schedule group.  This is enabled
8273 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8274 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8276 @item -fsched-critical-path-heuristic
8277 @opindex fsched-critical-path-heuristic
8278 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8279 instructions on the critical path.  This is enabled by default when
8280 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8281 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8283 @item -fsched-spec-insn-heuristic
8284 @opindex fsched-spec-insn-heuristic
8285 Enable the speculative instruction heuristic in the scheduler.  This
8286 heuristic favors speculative instructions with greater dependency weakness.
8287 This is enabled by default when scheduling is enabled, i.e.@:
8288 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8289 or at @option{-O2} or higher.
8291 @item -fsched-rank-heuristic
8292 @opindex fsched-rank-heuristic
8293 Enable the rank heuristic in the scheduler.  This heuristic favors
8294 the instruction belonging to a basic block with greater size or frequency.
8295 This is enabled by default when scheduling is enabled, i.e.@:
8296 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8297 at @option{-O2} or higher.
8299 @item -fsched-last-insn-heuristic
8300 @opindex fsched-last-insn-heuristic
8301 Enable the last-instruction heuristic in the scheduler.  This heuristic
8302 favors the instruction that is less dependent on the last instruction
8303 scheduled.  This is enabled by default when scheduling is enabled,
8304 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8305 at @option{-O2} or higher.
8307 @item -fsched-dep-count-heuristic
8308 @opindex fsched-dep-count-heuristic
8309 Enable the dependent-count heuristic in the scheduler.  This heuristic
8310 favors the instruction that has more instructions depending on it.
8311 This is enabled by default when scheduling is enabled, i.e.@:
8312 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8313 at @option{-O2} or higher.
8315 @item -freschedule-modulo-scheduled-loops
8316 @opindex freschedule-modulo-scheduled-loops
8317 Modulo scheduling is performed before traditional scheduling.  If a loop
8318 is modulo scheduled, later scheduling passes may change its schedule.  
8319 Use this option to control that behavior.
8321 @item -fselective-scheduling
8322 @opindex fselective-scheduling
8323 Schedule instructions using selective scheduling algorithm.  Selective
8324 scheduling runs instead of the first scheduler pass.
8326 @item -fselective-scheduling2
8327 @opindex fselective-scheduling2
8328 Schedule instructions using selective scheduling algorithm.  Selective
8329 scheduling runs instead of the second scheduler pass.
8331 @item -fsel-sched-pipelining
8332 @opindex fsel-sched-pipelining
8333 Enable software pipelining of innermost loops during selective scheduling.
8334 This option has no effect unless one of @option{-fselective-scheduling} or
8335 @option{-fselective-scheduling2} is turned on.
8337 @item -fsel-sched-pipelining-outer-loops
8338 @opindex fsel-sched-pipelining-outer-loops
8339 When pipelining loops during selective scheduling, also pipeline outer loops.
8340 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8342 @item -fsemantic-interposition
8343 @opindex fsemantic-interposition
8344 Some object formats, like ELF, allow interposing of symbols by the 
8345 dynamic linker.
8346 This means that for symbols exported from the DSO, the compiler cannot perform
8347 interprocedural propagation, inlining and other optimizations in anticipation
8348 that the function or variable in question may change. While this feature is
8349 useful, for example, to rewrite memory allocation functions by a debugging
8350 implementation, it is expensive in the terms of code quality.
8351 With @option{-fno-semantic-interposition} the compiler assumes that 
8352 if interposition happens for functions the overwriting function will have 
8353 precisely the same semantics (and side effects). 
8354 Similarly if interposition happens
8355 for variables, the constructor of the variable will be the same. The flag
8356 has no effect for functions explicitly declared inline 
8357 (where it is never allowed for interposition to change semantics) 
8358 and for symbols explicitly declared weak.
8360 @item -fshrink-wrap
8361 @opindex fshrink-wrap
8362 Emit function prologues only before parts of the function that need it,
8363 rather than at the top of the function.  This flag is enabled by default at
8364 @option{-O} and higher.
8366 @item -fcaller-saves
8367 @opindex fcaller-saves
8368 Enable allocation of values to registers that are clobbered by
8369 function calls, by emitting extra instructions to save and restore the
8370 registers around such calls.  Such allocation is done only when it
8371 seems to result in better code.
8373 This option is always enabled by default on certain machines, usually
8374 those which have no call-preserved registers to use instead.
8376 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8378 @item -fcombine-stack-adjustments
8379 @opindex fcombine-stack-adjustments
8380 Tracks stack adjustments (pushes and pops) and stack memory references
8381 and then tries to find ways to combine them.
8383 Enabled by default at @option{-O1} and higher.
8385 @item -fipa-ra
8386 @opindex fipa-ra
8387 Use caller save registers for allocation if those registers are not used by
8388 any called function.  In that case it is not necessary to save and restore
8389 them around calls.  This is only possible if called functions are part of
8390 same compilation unit as current function and they are compiled before it.
8392 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8394 @item -fconserve-stack
8395 @opindex fconserve-stack
8396 Attempt to minimize stack usage.  The compiler attempts to use less
8397 stack space, even if that makes the program slower.  This option
8398 implies setting the @option{large-stack-frame} parameter to 100
8399 and the @option{large-stack-frame-growth} parameter to 400.
8401 @item -ftree-reassoc
8402 @opindex ftree-reassoc
8403 Perform reassociation on trees.  This flag is enabled by default
8404 at @option{-O} and higher.
8406 @item -ftree-pre
8407 @opindex ftree-pre
8408 Perform partial redundancy elimination (PRE) on trees.  This flag is
8409 enabled by default at @option{-O2} and @option{-O3}.
8411 @item -ftree-partial-pre
8412 @opindex ftree-partial-pre
8413 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8414 enabled by default at @option{-O3}.
8416 @item -ftree-forwprop
8417 @opindex ftree-forwprop
8418 Perform forward propagation on trees.  This flag is enabled by default
8419 at @option{-O} and higher.
8421 @item -ftree-fre
8422 @opindex ftree-fre
8423 Perform full redundancy elimination (FRE) on trees.  The difference
8424 between FRE and PRE is that FRE only considers expressions
8425 that are computed on all paths leading to the redundant computation.
8426 This analysis is faster than PRE, though it exposes fewer redundancies.
8427 This flag is enabled by default at @option{-O} and higher.
8429 @item -ftree-phiprop
8430 @opindex ftree-phiprop
8431 Perform hoisting of loads from conditional pointers on trees.  This
8432 pass is enabled by default at @option{-O} and higher.
8434 @item -fhoist-adjacent-loads
8435 @opindex fhoist-adjacent-loads
8436 Speculatively hoist loads from both branches of an if-then-else if the
8437 loads are from adjacent locations in the same structure and the target
8438 architecture has a conditional move instruction.  This flag is enabled
8439 by default at @option{-O2} and higher.
8441 @item -ftree-copy-prop
8442 @opindex ftree-copy-prop
8443 Perform copy propagation on trees.  This pass eliminates unnecessary
8444 copy operations.  This flag is enabled by default at @option{-O} and
8445 higher.
8447 @item -fipa-pure-const
8448 @opindex fipa-pure-const
8449 Discover which functions are pure or constant.
8450 Enabled by default at @option{-O} and higher.
8452 @item -fipa-reference
8453 @opindex fipa-reference
8454 Discover which static variables do not escape the
8455 compilation unit.
8456 Enabled by default at @option{-O} and higher.
8458 @item -fipa-pta
8459 @opindex fipa-pta
8460 Perform interprocedural pointer analysis and interprocedural modification
8461 and reference analysis.  This option can cause excessive memory and
8462 compile-time usage on large compilation units.  It is not enabled by
8463 default at any optimization level.
8465 @item -fipa-profile
8466 @opindex fipa-profile
8467 Perform interprocedural profile propagation.  The functions called only from
8468 cold functions are marked as cold. Also functions executed once (such as
8469 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8470 functions and loop less parts of functions executed once are then optimized for
8471 size.
8472 Enabled by default at @option{-O} and higher.
8474 @item -fipa-cp
8475 @opindex fipa-cp
8476 Perform interprocedural constant propagation.
8477 This optimization analyzes the program to determine when values passed
8478 to functions are constants and then optimizes accordingly.
8479 This optimization can substantially increase performance
8480 if the application has constants passed to functions.
8481 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8483 @item -fipa-cp-clone
8484 @opindex fipa-cp-clone
8485 Perform function cloning to make interprocedural constant propagation stronger.
8486 When enabled, interprocedural constant propagation performs function cloning
8487 when externally visible function can be called with constant arguments.
8488 Because this optimization can create multiple copies of functions,
8489 it may significantly increase code size
8490 (see @option{--param ipcp-unit-growth=@var{value}}).
8491 This flag is enabled by default at @option{-O3}.
8493 @item -fipa-cp-alignment
8494 @opindex -fipa-cp-alignment
8495 When enabled, this optimization propagates alignment of function
8496 parameters to support better vectorization and string operations.
8498 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8499 requires that @option{-fipa-cp} is enabled.
8501 @item -fipa-icf
8502 @opindex fipa-icf
8503 Perform Identical Code Folding for functions and read-only variables.
8504 The optimization reduces code size and may disturb unwind stacks by replacing
8505 a function by equivalent one with a different name. The optimization works
8506 more effectively with link time optimization enabled.
8508 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8509 works on different levels and thus the optimizations are not same - there are
8510 equivalences that are found only by GCC and equivalences found only by Gold.
8512 This flag is enabled by default at @option{-O2} and @option{-Os}.
8514 @item -fisolate-erroneous-paths-dereference
8515 @opindex fisolate-erroneous-paths-dereference
8516 Detect paths that trigger erroneous or undefined behavior due to
8517 dereferencing a null pointer.  Isolate those paths from the main control
8518 flow and turn the statement with erroneous or undefined behavior into a trap.
8519 This flag is enabled by default at @option{-O2} and higher.
8521 @item -fisolate-erroneous-paths-attribute
8522 @opindex fisolate-erroneous-paths-attribute
8523 Detect paths that trigger erroneous or undefined behavior due a null value
8524 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8525 attribute.  Isolate those paths from the main control flow and turn the
8526 statement with erroneous or undefined behavior into a trap.  This is not
8527 currently enabled, but may be enabled by @option{-O2} in the future.
8529 @item -ftree-sink
8530 @opindex ftree-sink
8531 Perform forward store motion  on trees.  This flag is
8532 enabled by default at @option{-O} and higher.
8534 @item -ftree-bit-ccp
8535 @opindex ftree-bit-ccp
8536 Perform sparse conditional bit constant propagation on trees and propagate
8537 pointer alignment information.
8538 This pass only operates on local scalar variables and is enabled by default
8539 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8541 @item -ftree-ccp
8542 @opindex ftree-ccp
8543 Perform sparse conditional constant propagation (CCP) on trees.  This
8544 pass only operates on local scalar variables and is enabled by default
8545 at @option{-O} and higher.
8547 @item -fssa-phiopt
8548 @opindex fssa-phiopt
8549 Perform pattern matching on SSA PHI nodes to optimize conditional
8550 code.  This pass is enabled by default at @option{-O} and higher.
8552 @item -ftree-switch-conversion
8553 @opindex ftree-switch-conversion
8554 Perform conversion of simple initializations in a switch to
8555 initializations from a scalar array.  This flag is enabled by default
8556 at @option{-O2} and higher.
8558 @item -ftree-tail-merge
8559 @opindex ftree-tail-merge
8560 Look for identical code sequences.  When found, replace one with a jump to the
8561 other.  This optimization is known as tail merging or cross jumping.  This flag
8562 is enabled by default at @option{-O2} and higher.  The compilation time
8563 in this pass can
8564 be limited using @option{max-tail-merge-comparisons} parameter and
8565 @option{max-tail-merge-iterations} parameter.
8567 @item -ftree-dce
8568 @opindex ftree-dce
8569 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8570 default at @option{-O} and higher.
8572 @item -ftree-builtin-call-dce
8573 @opindex ftree-builtin-call-dce
8574 Perform conditional dead code elimination (DCE) for calls to built-in functions
8575 that may set @code{errno} but are otherwise side-effect free.  This flag is
8576 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8577 specified.
8579 @item -ftree-dominator-opts
8580 @opindex ftree-dominator-opts
8581 Perform a variety of simple scalar cleanups (constant/copy
8582 propagation, redundancy elimination, range propagation and expression
8583 simplification) based on a dominator tree traversal.  This also
8584 performs jump threading (to reduce jumps to jumps). This flag is
8585 enabled by default at @option{-O} and higher.
8587 @item -ftree-dse
8588 @opindex ftree-dse
8589 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8590 a memory location that is later overwritten by another store without
8591 any intervening loads.  In this case the earlier store can be deleted.  This
8592 flag is enabled by default at @option{-O} and higher.
8594 @item -ftree-ch
8595 @opindex ftree-ch
8596 Perform loop header copying on trees.  This is beneficial since it increases
8597 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8598 is enabled by default at @option{-O} and higher.  It is not enabled
8599 for @option{-Os}, since it usually increases code size.
8601 @item -ftree-loop-optimize
8602 @opindex ftree-loop-optimize
8603 Perform loop optimizations on trees.  This flag is enabled by default
8604 at @option{-O} and higher.
8606 @item -ftree-loop-linear
8607 @opindex ftree-loop-linear
8608 Perform loop interchange transformations on tree.  Same as
8609 @option{-floop-interchange}.  To use this code transformation, GCC has
8610 to be configured with @option{--with-isl} to enable the Graphite loop
8611 transformation infrastructure.
8613 @item -floop-interchange
8614 @opindex floop-interchange
8615 Perform loop interchange transformations on loops.  Interchanging two
8616 nested loops switches the inner and outer loops.  For example, given a
8617 loop like:
8618 @smallexample
8619 DO J = 1, M
8620   DO I = 1, N
8621     A(J, I) = A(J, I) * C
8622   ENDDO
8623 ENDDO
8624 @end smallexample
8625 @noindent
8626 loop interchange transforms the loop as if it were written:
8627 @smallexample
8628 DO I = 1, N
8629   DO J = 1, M
8630     A(J, I) = A(J, I) * C
8631   ENDDO
8632 ENDDO
8633 @end smallexample
8634 which can be beneficial when @code{N} is larger than the caches,
8635 because in Fortran, the elements of an array are stored in memory
8636 contiguously by column, and the original loop iterates over rows,
8637 potentially creating at each access a cache miss.  This optimization
8638 applies to all the languages supported by GCC and is not limited to
8639 Fortran.  To use this code transformation, GCC has to be configured
8640 with @option{--with-isl} to enable the Graphite loop transformation
8641 infrastructure.
8643 @item -floop-strip-mine
8644 @opindex floop-strip-mine
8645 Perform loop strip mining transformations on loops.  Strip mining
8646 splits a loop into two nested loops.  The outer loop has strides
8647 equal to the strip size and the inner loop has strides of the
8648 original loop within a strip.  The strip length can be changed
8649 using the @option{loop-block-tile-size} parameter.  For example,
8650 given a loop like:
8651 @smallexample
8652 DO I = 1, N
8653   A(I) = A(I) + C
8654 ENDDO
8655 @end smallexample
8656 @noindent
8657 loop strip mining transforms the loop as if it were written:
8658 @smallexample
8659 DO II = 1, N, 51
8660   DO I = II, min (II + 50, N)
8661     A(I) = A(I) + C
8662   ENDDO
8663 ENDDO
8664 @end smallexample
8665 This optimization applies to all the languages supported by GCC and is
8666 not limited to Fortran.  To use this code transformation, GCC has to
8667 be configured with @option{--with-isl} to enable the Graphite loop
8668 transformation infrastructure.
8670 @item -floop-block
8671 @opindex floop-block
8672 Perform loop blocking transformations on loops.  Blocking strip mines
8673 each loop in the loop nest such that the memory accesses of the
8674 element loops fit inside caches.  The strip length can be changed
8675 using the @option{loop-block-tile-size} parameter.  For example, given
8676 a loop like:
8677 @smallexample
8678 DO I = 1, N
8679   DO J = 1, M
8680     A(J, I) = B(I) + C(J)
8681   ENDDO
8682 ENDDO
8683 @end smallexample
8684 @noindent
8685 loop blocking transforms the loop as if it were written:
8686 @smallexample
8687 DO II = 1, N, 51
8688   DO JJ = 1, M, 51
8689     DO I = II, min (II + 50, N)
8690       DO J = JJ, min (JJ + 50, M)
8691         A(J, I) = B(I) + C(J)
8692       ENDDO
8693     ENDDO
8694   ENDDO
8695 ENDDO
8696 @end smallexample
8697 which can be beneficial when @code{M} is larger than the caches,
8698 because the innermost loop iterates over a smaller amount of data
8699 which can be kept in the caches.  This optimization applies to all the
8700 languages supported by GCC and is not limited to Fortran.  To use this
8701 code transformation, GCC has to be configured with @option{--with-isl}
8702 to enable the Graphite loop transformation infrastructure.
8704 @item -fgraphite-identity
8705 @opindex fgraphite-identity
8706 Enable the identity transformation for graphite.  For every SCoP we generate
8707 the polyhedral representation and transform it back to gimple.  Using
8708 @option{-fgraphite-identity} we can check the costs or benefits of the
8709 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8710 are also performed by the code generator ISL, like index splitting and
8711 dead code elimination in loops.
8713 @item -floop-nest-optimize
8714 @opindex floop-nest-optimize
8715 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8716 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8717 structure optimized for data-locality and parallelism.  This option
8718 is experimental.
8720 @item -floop-unroll-and-jam
8721 @opindex floop-unroll-and-jam
8722 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8723 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8724 The unrolled dimension (counting from the most inner one) can be changed 
8725 using the @option{loop-unroll-jam-depth} parameter.                 .
8727 @item -floop-parallelize-all
8728 @opindex floop-parallelize-all
8729 Use the Graphite data dependence analysis to identify loops that can
8730 be parallelized.  Parallelize all the loops that can be analyzed to
8731 not contain loop carried dependences without checking that it is
8732 profitable to parallelize the loops.
8734 @item -fcheck-data-deps
8735 @opindex fcheck-data-deps
8736 Compare the results of several data dependence analyzers.  This option
8737 is used for debugging the data dependence analyzers.
8739 @item -ftree-loop-if-convert
8740 @opindex ftree-loop-if-convert
8741 Attempt to transform conditional jumps in the innermost loops to
8742 branch-less equivalents.  The intent is to remove control-flow from
8743 the innermost loops in order to improve the ability of the
8744 vectorization pass to handle these loops.  This is enabled by default
8745 if vectorization is enabled.
8747 @item -ftree-loop-if-convert-stores
8748 @opindex ftree-loop-if-convert-stores
8749 Attempt to also if-convert conditional jumps containing memory writes.
8750 This transformation can be unsafe for multi-threaded programs as it
8751 transforms conditional memory writes into unconditional memory writes.
8752 For example,
8753 @smallexample
8754 for (i = 0; i < N; i++)
8755   if (cond)
8756     A[i] = expr;
8757 @end smallexample
8758 is transformed to
8759 @smallexample
8760 for (i = 0; i < N; i++)
8761   A[i] = cond ? expr : A[i];
8762 @end smallexample
8763 potentially producing data races.
8765 @item -ftree-loop-distribution
8766 @opindex ftree-loop-distribution
8767 Perform loop distribution.  This flag can improve cache performance on
8768 big loop bodies and allow further loop optimizations, like
8769 parallelization or vectorization, to take place.  For example, the loop
8770 @smallexample
8771 DO I = 1, N
8772   A(I) = B(I) + C
8773   D(I) = E(I) * F
8774 ENDDO
8775 @end smallexample
8776 is transformed to
8777 @smallexample
8778 DO I = 1, N
8779    A(I) = B(I) + C
8780 ENDDO
8781 DO I = 1, N
8782    D(I) = E(I) * F
8783 ENDDO
8784 @end smallexample
8786 @item -ftree-loop-distribute-patterns
8787 @opindex ftree-loop-distribute-patterns
8788 Perform loop distribution of patterns that can be code generated with
8789 calls to a library.  This flag is enabled by default at @option{-O3}.
8791 This pass distributes the initialization loops and generates a call to
8792 memset zero.  For example, the loop
8793 @smallexample
8794 DO I = 1, N
8795   A(I) = 0
8796   B(I) = A(I) + I
8797 ENDDO
8798 @end smallexample
8799 is transformed to
8800 @smallexample
8801 DO I = 1, N
8802    A(I) = 0
8803 ENDDO
8804 DO I = 1, N
8805    B(I) = A(I) + I
8806 ENDDO
8807 @end smallexample
8808 and the initialization loop is transformed into a call to memset zero.
8810 @item -ftree-loop-im
8811 @opindex ftree-loop-im
8812 Perform loop invariant motion on trees.  This pass moves only invariants that
8813 are hard to handle at RTL level (function calls, operations that expand to
8814 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8815 operands of conditions that are invariant out of the loop, so that we can use
8816 just trivial invariantness analysis in loop unswitching.  The pass also includes
8817 store motion.
8819 @item -ftree-loop-ivcanon
8820 @opindex ftree-loop-ivcanon
8821 Create a canonical counter for number of iterations in loops for which
8822 determining number of iterations requires complicated analysis.  Later
8823 optimizations then may determine the number easily.  Useful especially
8824 in connection with unrolling.
8826 @item -fivopts
8827 @opindex fivopts
8828 Perform induction variable optimizations (strength reduction, induction
8829 variable merging and induction variable elimination) on trees.
8831 @item -ftree-parallelize-loops=n
8832 @opindex ftree-parallelize-loops
8833 Parallelize loops, i.e., split their iteration space to run in n threads.
8834 This is only possible for loops whose iterations are independent
8835 and can be arbitrarily reordered.  The optimization is only
8836 profitable on multiprocessor machines, for loops that are CPU-intensive,
8837 rather than constrained e.g.@: by memory bandwidth.  This option
8838 implies @option{-pthread}, and thus is only supported on targets
8839 that have support for @option{-pthread}.
8841 @item -ftree-pta
8842 @opindex ftree-pta
8843 Perform function-local points-to analysis on trees.  This flag is
8844 enabled by default at @option{-O} and higher.
8846 @item -ftree-sra
8847 @opindex ftree-sra
8848 Perform scalar replacement of aggregates.  This pass replaces structure
8849 references with scalars to prevent committing structures to memory too
8850 early.  This flag is enabled by default at @option{-O} and higher.
8852 @item -ftree-copyrename
8853 @opindex ftree-copyrename
8854 Perform copy renaming on trees.  This pass attempts to rename compiler
8855 temporaries to other variables at copy locations, usually resulting in
8856 variable names which more closely resemble the original variables.  This flag
8857 is enabled by default at @option{-O} and higher.
8859 @item -ftree-coalesce-inlined-vars
8860 @opindex ftree-coalesce-inlined-vars
8861 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8862 combine small user-defined variables too, but only if they are inlined
8863 from other functions.  It is a more limited form of
8864 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8865 inlined variables, but it keeps variables of the inlined-into
8866 function apart from each other, such that they are more likely to
8867 contain the expected values in a debugging session.
8869 @item -ftree-coalesce-vars
8870 @opindex ftree-coalesce-vars
8871 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8872 combine small user-defined variables too, instead of just compiler
8873 temporaries.  This may severely limit the ability to debug an optimized
8874 program compiled with @option{-fno-var-tracking-assignments}.  In the
8875 negated form, this flag prevents SSA coalescing of user variables,
8876 including inlined ones.  This option is enabled by default.
8878 @item -ftree-ter
8879 @opindex ftree-ter
8880 Perform temporary expression replacement during the SSA->normal phase.  Single
8881 use/single def temporaries are replaced at their use location with their
8882 defining expression.  This results in non-GIMPLE code, but gives the expanders
8883 much more complex trees to work on resulting in better RTL generation.  This is
8884 enabled by default at @option{-O} and higher.
8886 @item -ftree-slsr
8887 @opindex ftree-slsr
8888 Perform straight-line strength reduction on trees.  This recognizes related
8889 expressions involving multiplications and replaces them by less expensive
8890 calculations when possible.  This is enabled by default at @option{-O} and
8891 higher.
8893 @item -ftree-vectorize
8894 @opindex ftree-vectorize
8895 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8896 and @option{-ftree-slp-vectorize} if not explicitly specified.
8898 @item -ftree-loop-vectorize
8899 @opindex ftree-loop-vectorize
8900 Perform loop vectorization on trees. This flag is enabled by default at
8901 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8903 @item -ftree-slp-vectorize
8904 @opindex ftree-slp-vectorize
8905 Perform basic block vectorization on trees. This flag is enabled by default at
8906 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8908 @item -fvect-cost-model=@var{model}
8909 @opindex fvect-cost-model
8910 Alter the cost model used for vectorization.  The @var{model} argument
8911 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8912 With the @samp{unlimited} model the vectorized code-path is assumed
8913 to be profitable while with the @samp{dynamic} model a runtime check
8914 guards the vectorized code-path to enable it only for iteration
8915 counts that will likely execute faster than when executing the original
8916 scalar loop.  The @samp{cheap} model disables vectorization of
8917 loops where doing so would be cost prohibitive for example due to
8918 required runtime checks for data dependence or alignment but otherwise
8919 is equal to the @samp{dynamic} model.
8920 The default cost model depends on other optimization flags and is
8921 either @samp{dynamic} or @samp{cheap}.
8923 @item -fsimd-cost-model=@var{model}
8924 @opindex fsimd-cost-model
8925 Alter the cost model used for vectorization of loops marked with the OpenMP
8926 or Cilk Plus simd directive.  The @var{model} argument should be one of
8927 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8928 have the same meaning as described in @option{-fvect-cost-model} and by
8929 default a cost model defined with @option{-fvect-cost-model} is used.
8931 @item -ftree-vrp
8932 @opindex ftree-vrp
8933 Perform Value Range Propagation on trees.  This is similar to the
8934 constant propagation pass, but instead of values, ranges of values are
8935 propagated.  This allows the optimizers to remove unnecessary range
8936 checks like array bound checks and null pointer checks.  This is
8937 enabled by default at @option{-O2} and higher.  Null pointer check
8938 elimination is only done if @option{-fdelete-null-pointer-checks} is
8939 enabled.
8941 @item -fsplit-ivs-in-unroller
8942 @opindex fsplit-ivs-in-unroller
8943 Enables expression of values of induction variables in later iterations
8944 of the unrolled loop using the value in the first iteration.  This breaks
8945 long dependency chains, thus improving efficiency of the scheduling passes.
8947 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8948 same effect.  However, that is not reliable in cases where the loop body
8949 is more complicated than a single basic block.  It also does not work at all
8950 on some architectures due to restrictions in the CSE pass.
8952 This optimization is enabled by default.
8954 @item -fvariable-expansion-in-unroller
8955 @opindex fvariable-expansion-in-unroller
8956 With this option, the compiler creates multiple copies of some
8957 local variables when unrolling a loop, which can result in superior code.
8959 @item -fpartial-inlining
8960 @opindex fpartial-inlining
8961 Inline parts of functions.  This option has any effect only
8962 when inlining itself is turned on by the @option{-finline-functions}
8963 or @option{-finline-small-functions} options.
8965 Enabled at level @option{-O2}.
8967 @item -fpredictive-commoning
8968 @opindex fpredictive-commoning
8969 Perform predictive commoning optimization, i.e., reusing computations
8970 (especially memory loads and stores) performed in previous
8971 iterations of loops.
8973 This option is enabled at level @option{-O3}.
8975 @item -fprefetch-loop-arrays
8976 @opindex fprefetch-loop-arrays
8977 If supported by the target machine, generate instructions to prefetch
8978 memory to improve the performance of loops that access large arrays.
8980 This option may generate better or worse code; results are highly
8981 dependent on the structure of loops within the source code.
8983 Disabled at level @option{-Os}.
8985 @item -fno-peephole
8986 @itemx -fno-peephole2
8987 @opindex fno-peephole
8988 @opindex fno-peephole2
8989 Disable any machine-specific peephole optimizations.  The difference
8990 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8991 are implemented in the compiler; some targets use one, some use the
8992 other, a few use both.
8994 @option{-fpeephole} is enabled by default.
8995 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8997 @item -fno-guess-branch-probability
8998 @opindex fno-guess-branch-probability
8999 Do not guess branch probabilities using heuristics.
9001 GCC uses heuristics to guess branch probabilities if they are
9002 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9003 heuristics are based on the control flow graph.  If some branch probabilities
9004 are specified by @code{__builtin_expect}, then the heuristics are
9005 used to guess branch probabilities for the rest of the control flow graph,
9006 taking the @code{__builtin_expect} info into account.  The interactions
9007 between the heuristics and @code{__builtin_expect} can be complex, and in
9008 some cases, it may be useful to disable the heuristics so that the effects
9009 of @code{__builtin_expect} are easier to understand.
9011 The default is @option{-fguess-branch-probability} at levels
9012 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9014 @item -freorder-blocks
9015 @opindex freorder-blocks
9016 Reorder basic blocks in the compiled function in order to reduce number of
9017 taken branches and improve code locality.
9019 Enabled at levels @option{-O2}, @option{-O3}.
9021 @item -freorder-blocks-and-partition
9022 @opindex freorder-blocks-and-partition
9023 In addition to reordering basic blocks in the compiled function, in order
9024 to reduce number of taken branches, partitions hot and cold basic blocks
9025 into separate sections of the assembly and .o files, to improve
9026 paging and cache locality performance.
9028 This optimization is automatically turned off in the presence of
9029 exception handling, for linkonce sections, for functions with a user-defined
9030 section attribute and on any architecture that does not support named
9031 sections.
9033 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9035 @item -freorder-functions
9036 @opindex freorder-functions
9037 Reorder functions in the object file in order to
9038 improve code locality.  This is implemented by using special
9039 subsections @code{.text.hot} for most frequently executed functions and
9040 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9041 the linker so object file format must support named sections and linker must
9042 place them in a reasonable way.
9044 Also profile feedback must be available to make this option effective.  See
9045 @option{-fprofile-arcs} for details.
9047 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9049 @item -fstrict-aliasing
9050 @opindex fstrict-aliasing
9051 Allow the compiler to assume the strictest aliasing rules applicable to
9052 the language being compiled.  For C (and C++), this activates
9053 optimizations based on the type of expressions.  In particular, an
9054 object of one type is assumed never to reside at the same address as an
9055 object of a different type, unless the types are almost the same.  For
9056 example, an @code{unsigned int} can alias an @code{int}, but not a
9057 @code{void*} or a @code{double}.  A character type may alias any other
9058 type.
9060 @anchor{Type-punning}Pay special attention to code like this:
9061 @smallexample
9062 union a_union @{
9063   int i;
9064   double d;
9067 int f() @{
9068   union a_union t;
9069   t.d = 3.0;
9070   return t.i;
9072 @end smallexample
9073 The practice of reading from a different union member than the one most
9074 recently written to (called ``type-punning'') is common.  Even with
9075 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9076 is accessed through the union type.  So, the code above works as
9077 expected.  @xref{Structures unions enumerations and bit-fields
9078 implementation}.  However, this code might not:
9079 @smallexample
9080 int f() @{
9081   union a_union t;
9082   int* ip;
9083   t.d = 3.0;
9084   ip = &t.i;
9085   return *ip;
9087 @end smallexample
9089 Similarly, access by taking the address, casting the resulting pointer
9090 and dereferencing the result has undefined behavior, even if the cast
9091 uses a union type, e.g.:
9092 @smallexample
9093 int f() @{
9094   double d = 3.0;
9095   return ((union a_union *) &d)->i;
9097 @end smallexample
9099 The @option{-fstrict-aliasing} option is enabled at levels
9100 @option{-O2}, @option{-O3}, @option{-Os}.
9102 @item -fstrict-overflow
9103 @opindex fstrict-overflow
9104 Allow the compiler to assume strict signed overflow rules, depending
9105 on the language being compiled.  For C (and C++) this means that
9106 overflow when doing arithmetic with signed numbers is undefined, which
9107 means that the compiler may assume that it does not happen.  This
9108 permits various optimizations.  For example, the compiler assumes
9109 that an expression like @code{i + 10 > i} is always true for
9110 signed @code{i}.  This assumption is only valid if signed overflow is
9111 undefined, as the expression is false if @code{i + 10} overflows when
9112 using twos complement arithmetic.  When this option is in effect any
9113 attempt to determine whether an operation on signed numbers 
9114 overflows must be written carefully to not actually involve overflow.
9116 This option also allows the compiler to assume strict pointer
9117 semantics: given a pointer to an object, if adding an offset to that
9118 pointer does not produce a pointer to the same object, the addition is
9119 undefined.  This permits the compiler to conclude that @code{p + u >
9120 p} is always true for a pointer @code{p} and unsigned integer
9121 @code{u}.  This assumption is only valid because pointer wraparound is
9122 undefined, as the expression is false if @code{p + u} overflows using
9123 twos complement arithmetic.
9125 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
9126 that integer signed overflow is fully defined: it wraps.  When
9127 @option{-fwrapv} is used, there is no difference between
9128 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
9129 integers.  With @option{-fwrapv} certain types of overflow are
9130 permitted.  For example, if the compiler gets an overflow when doing
9131 arithmetic on constants, the overflowed value can still be used with
9132 @option{-fwrapv}, but not otherwise.
9134 The @option{-fstrict-overflow} option is enabled at levels
9135 @option{-O2}, @option{-O3}, @option{-Os}.
9137 @item -falign-functions
9138 @itemx -falign-functions=@var{n}
9139 @opindex falign-functions
9140 Align the start of functions to the next power-of-two greater than
9141 @var{n}, skipping up to @var{n} bytes.  For instance,
9142 @option{-falign-functions=32} aligns functions to the next 32-byte
9143 boundary, but @option{-falign-functions=24} aligns to the next
9144 32-byte boundary only if this can be done by skipping 23 bytes or less.
9146 @option{-fno-align-functions} and @option{-falign-functions=1} are
9147 equivalent and mean that functions are not aligned.
9149 Some assemblers only support this flag when @var{n} is a power of two;
9150 in that case, it is rounded up.
9152 If @var{n} is not specified or is zero, use a machine-dependent default.
9154 Enabled at levels @option{-O2}, @option{-O3}.
9156 @item -falign-labels
9157 @itemx -falign-labels=@var{n}
9158 @opindex falign-labels
9159 Align all branch targets to a power-of-two boundary, skipping up to
9160 @var{n} bytes like @option{-falign-functions}.  This option can easily
9161 make code slower, because it must insert dummy operations for when the
9162 branch target is reached in the usual flow of the code.
9164 @option{-fno-align-labels} and @option{-falign-labels=1} are
9165 equivalent and mean that labels are not aligned.
9167 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9168 are greater than this value, then their values are used instead.
9170 If @var{n} is not specified or is zero, use a machine-dependent default
9171 which is very likely to be @samp{1}, meaning no alignment.
9173 Enabled at levels @option{-O2}, @option{-O3}.
9175 @item -falign-loops
9176 @itemx -falign-loops=@var{n}
9177 @opindex falign-loops
9178 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9179 like @option{-falign-functions}.  If the loops are
9180 executed many times, this makes up for any execution of the dummy
9181 operations.
9183 @option{-fno-align-loops} and @option{-falign-loops=1} are
9184 equivalent and mean that loops are not aligned.
9186 If @var{n} is not specified or is zero, use a machine-dependent default.
9188 Enabled at levels @option{-O2}, @option{-O3}.
9190 @item -falign-jumps
9191 @itemx -falign-jumps=@var{n}
9192 @opindex falign-jumps
9193 Align branch targets to a power-of-two boundary, for branch targets
9194 where the targets can only be reached by jumping, skipping up to @var{n}
9195 bytes like @option{-falign-functions}.  In this case, no dummy operations
9196 need be executed.
9198 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9199 equivalent and mean that loops are not aligned.
9201 If @var{n} is not specified or is zero, use a machine-dependent default.
9203 Enabled at levels @option{-O2}, @option{-O3}.
9205 @item -funit-at-a-time
9206 @opindex funit-at-a-time
9207 This option is left for compatibility reasons. @option{-funit-at-a-time}
9208 has no effect, while @option{-fno-unit-at-a-time} implies
9209 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9211 Enabled by default.
9213 @item -fno-toplevel-reorder
9214 @opindex fno-toplevel-reorder
9215 Do not reorder top-level functions, variables, and @code{asm}
9216 statements.  Output them in the same order that they appear in the
9217 input file.  When this option is used, unreferenced static variables
9218 are not removed.  This option is intended to support existing code
9219 that relies on a particular ordering.  For new code, it is better to
9220 use attributes when possible.
9222 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9223 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9224 targets.
9226 @item -fweb
9227 @opindex fweb
9228 Constructs webs as commonly used for register allocation purposes and assign
9229 each web individual pseudo register.  This allows the register allocation pass
9230 to operate on pseudos directly, but also strengthens several other optimization
9231 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9232 however, make debugging impossible, since variables no longer stay in a
9233 ``home register''.
9235 Enabled by default with @option{-funroll-loops}.
9237 @item -fwhole-program
9238 @opindex fwhole-program
9239 Assume that the current compilation unit represents the whole program being
9240 compiled.  All public functions and variables with the exception of @code{main}
9241 and those merged by attribute @code{externally_visible} become static functions
9242 and in effect are optimized more aggressively by interprocedural optimizers.
9244 This option should not be used in combination with @option{-flto}.
9245 Instead relying on a linker plugin should provide safer and more precise
9246 information.
9248 @item -flto[=@var{n}]
9249 @opindex flto
9250 This option runs the standard link-time optimizer.  When invoked
9251 with source code, it generates GIMPLE (one of GCC's internal
9252 representations) and writes it to special ELF sections in the object
9253 file.  When the object files are linked together, all the function
9254 bodies are read from these ELF sections and instantiated as if they
9255 had been part of the same translation unit.
9257 To use the link-time optimizer, @option{-flto} and optimization
9258 options should be specified at compile time and during the final link.
9259 For example:
9261 @smallexample
9262 gcc -c -O2 -flto foo.c
9263 gcc -c -O2 -flto bar.c
9264 gcc -o myprog -flto -O2 foo.o bar.o
9265 @end smallexample
9267 The first two invocations to GCC save a bytecode representation
9268 of GIMPLE into special ELF sections inside @file{foo.o} and
9269 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9270 @file{foo.o} and @file{bar.o}, merges the two files into a single
9271 internal image, and compiles the result as usual.  Since both
9272 @file{foo.o} and @file{bar.o} are merged into a single image, this
9273 causes all the interprocedural analyses and optimizations in GCC to
9274 work across the two files as if they were a single one.  This means,
9275 for example, that the inliner is able to inline functions in
9276 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9278 Another (simpler) way to enable link-time optimization is:
9280 @smallexample
9281 gcc -o myprog -flto -O2 foo.c bar.c
9282 @end smallexample
9284 The above generates bytecode for @file{foo.c} and @file{bar.c},
9285 merges them together into a single GIMPLE representation and optimizes
9286 them as usual to produce @file{myprog}.
9288 The only important thing to keep in mind is that to enable link-time
9289 optimizations you need to use the GCC driver to perform the link-step.
9290 GCC then automatically performs link-time optimization if any of the
9291 objects involved were compiled with the @option{-flto} command-line option.  
9292 You generally
9293 should specify the optimization options to be used for link-time
9294 optimization though GCC tries to be clever at guessing an
9295 optimization level to use from the options used at compile-time
9296 if you fail to specify one at link-time.  You can always override
9297 the automatic decision to do link-time optimization at link-time
9298 by passing @option{-fno-lto} to the link command.
9300 To make whole program optimization effective, it is necessary to make
9301 certain whole program assumptions.  The compiler needs to know
9302 what functions and variables can be accessed by libraries and runtime
9303 outside of the link-time optimized unit.  When supported by the linker,
9304 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9305 to the compiler about used and externally visible symbols.  When
9306 the linker plugin is not available, @option{-fwhole-program} should be
9307 used to allow the compiler to make these assumptions, which leads
9308 to more aggressive optimization decisions.
9310 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9311 compiled with @option{-flto}, the generated object file is larger than
9312 a regular object file because it contains GIMPLE bytecodes and the usual
9313 final code (see @option{-ffat-lto-objects}.  This means that
9314 object files with LTO information can be linked as normal object
9315 files; if @option{-fno-lto} is passed to the linker, no
9316 interprocedural optimizations are applied.  Note that when
9317 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9318 but you cannot perform a regular, non-LTO link on them.
9320 Additionally, the optimization flags used to compile individual files
9321 are not necessarily related to those used at link time.  For instance,
9323 @smallexample
9324 gcc -c -O0 -ffat-lto-objects -flto foo.c
9325 gcc -c -O0 -ffat-lto-objects -flto bar.c
9326 gcc -o myprog -O3 foo.o bar.o
9327 @end smallexample
9329 This produces individual object files with unoptimized assembler
9330 code, but the resulting binary @file{myprog} is optimized at
9331 @option{-O3}.  If, instead, the final binary is generated with
9332 @option{-fno-lto}, then @file{myprog} is not optimized.
9334 When producing the final binary, GCC only
9335 applies link-time optimizations to those files that contain bytecode.
9336 Therefore, you can mix and match object files and libraries with
9337 GIMPLE bytecodes and final object code.  GCC automatically selects
9338 which files to optimize in LTO mode and which files to link without
9339 further processing.
9341 There are some code generation flags preserved by GCC when
9342 generating bytecodes, as they need to be used during the final link
9343 stage.  Generally options specified at link-time override those
9344 specified at compile-time.
9346 If you do not specify an optimization level option @option{-O} at
9347 link-time then GCC computes one based on the optimization levels
9348 used when compiling the object files.  The highest optimization
9349 level wins here.
9351 Currently, the following options and their setting are take from
9352 the first object file that explicitely specified it: 
9353 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9354 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9355 and all the @option{-m} target flags.
9357 Certain ABI changing flags are required to match in all compilation-units
9358 and trying to override this at link-time with a conflicting value
9359 is ignored.  This includes options such as @option{-freg-struct-return}
9360 and @option{-fpcc-struct-return}. 
9362 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9363 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9364 are passed through to the link stage and merged conservatively for
9365 conflicting translation units.  Specifically
9366 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9367 precedence and for example @option{-ffp-contract=off} takes precedence
9368 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9370 It is recommended that you compile all the files participating in the
9371 same link with the same options and also specify those options at
9372 link time.
9374 If LTO encounters objects with C linkage declared with incompatible
9375 types in separate translation units to be linked together (undefined
9376 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9377 issued.  The behavior is still undefined at run time.  Similar
9378 diagnostics may be raised for other languages.
9380 Another feature of LTO is that it is possible to apply interprocedural
9381 optimizations on files written in different languages:
9383 @smallexample
9384 gcc -c -flto foo.c
9385 g++ -c -flto bar.cc
9386 gfortran -c -flto baz.f90
9387 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9388 @end smallexample
9390 Notice that the final link is done with @command{g++} to get the C++
9391 runtime libraries and @option{-lgfortran} is added to get the Fortran
9392 runtime libraries.  In general, when mixing languages in LTO mode, you
9393 should use the same link command options as when mixing languages in a
9394 regular (non-LTO) compilation.
9396 If object files containing GIMPLE bytecode are stored in a library archive, say
9397 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9398 are using a linker with plugin support.  To create static libraries suitable
9399 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9400 and @command{ranlib}; 
9401 to show the symbols of object files with GIMPLE bytecode, use
9402 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9403 and @command{nm} have been compiled with plugin support.  At link time, use the the
9404 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9405 the LTO optimization process:
9407 @smallexample
9408 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9409 @end smallexample
9411 With the linker plugin enabled, the linker extracts the needed
9412 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9413 to make them part of the aggregated GIMPLE image to be optimized.
9415 If you are not using a linker with plugin support and/or do not
9416 enable the linker plugin, then the objects inside @file{libfoo.a}
9417 are extracted and linked as usual, but they do not participate
9418 in the LTO optimization process.  In order to make a static library suitable
9419 for both LTO optimization and usual linkage, compile its object files with
9420 @option{-flto} @option{-ffat-lto-objects}.
9422 Link-time optimizations do not require the presence of the whole program to
9423 operate.  If the program does not require any symbols to be exported, it is
9424 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9425 the interprocedural optimizers to use more aggressive assumptions which may
9426 lead to improved optimization opportunities.
9427 Use of @option{-fwhole-program} is not needed when linker plugin is
9428 active (see @option{-fuse-linker-plugin}).
9430 The current implementation of LTO makes no
9431 attempt to generate bytecode that is portable between different
9432 types of hosts.  The bytecode files are versioned and there is a
9433 strict version check, so bytecode files generated in one version of
9434 GCC do not work with an older or newer version of GCC.
9436 Link-time optimization does not work well with generation of debugging
9437 information.  Combining @option{-flto} with
9438 @option{-g} is currently experimental and expected to produce unexpected
9439 results.
9441 If you specify the optional @var{n}, the optimization and code
9442 generation done at link time is executed in parallel using @var{n}
9443 parallel jobs by utilizing an installed @command{make} program.  The
9444 environment variable @env{MAKE} may be used to override the program
9445 used.  The default value for @var{n} is 1.
9447 You can also specify @option{-flto=jobserver} to use GNU make's
9448 job server mode to determine the number of parallel jobs. This
9449 is useful when the Makefile calling GCC is already executing in parallel.
9450 You must prepend a @samp{+} to the command recipe in the parent Makefile
9451 for this to work.  This option likely only works if @env{MAKE} is
9452 GNU make.
9454 @item -flto-partition=@var{alg}
9455 @opindex flto-partition
9456 Specify the partitioning algorithm used by the link-time optimizer.
9457 The value is either @samp{1to1} to specify a partitioning mirroring
9458 the original source files or @samp{balanced} to specify partitioning
9459 into equally sized chunks (whenever possible) or @samp{max} to create
9460 new partition for every symbol where possible.  Specifying @samp{none}
9461 as an algorithm disables partitioning and streaming completely. 
9462 The default value is @samp{balanced}. While @samp{1to1} can be used
9463 as an workaround for various code ordering issues, the @samp{max}
9464 partitioning is intended for internal testing only.
9465 The value @samp{one} specifies that exactly one partition should be
9466 used while the value @samp{none} bypasses partitioning and executes
9467 the link-time optimization step directly from the WPA phase.
9469 @item -flto-odr-type-merging
9470 @opindex flto-odr-type-merging
9471 Enable streaming of mangled types names of C++ types and their unification
9472 at linktime.  This increases size of LTO object files, but enable
9473 diagnostics about One Definition Rule violations.
9475 @item -flto-compression-level=@var{n}
9476 @opindex flto-compression-level
9477 This option specifies the level of compression used for intermediate
9478 language written to LTO object files, and is only meaningful in
9479 conjunction with LTO mode (@option{-flto}).  Valid
9480 values are 0 (no compression) to 9 (maximum compression).  Values
9481 outside this range are clamped to either 0 or 9.  If the option is not
9482 given, a default balanced compression setting is used.
9484 @item -flto-report
9485 @opindex flto-report
9486 Prints a report with internal details on the workings of the link-time
9487 optimizer.  The contents of this report vary from version to version.
9488 It is meant to be useful to GCC developers when processing object
9489 files in LTO mode (via @option{-flto}).
9491 Disabled by default.
9493 @item -flto-report-wpa
9494 @opindex flto-report-wpa
9495 Like @option{-flto-report}, but only print for the WPA phase of Link
9496 Time Optimization.
9498 @item -fuse-linker-plugin
9499 @opindex fuse-linker-plugin
9500 Enables the use of a linker plugin during link-time optimization.  This
9501 option relies on plugin support in the linker, which is available in gold
9502 or in GNU ld 2.21 or newer.
9504 This option enables the extraction of object files with GIMPLE bytecode out
9505 of library archives. This improves the quality of optimization by exposing
9506 more code to the link-time optimizer.  This information specifies what
9507 symbols can be accessed externally (by non-LTO object or during dynamic
9508 linking).  Resulting code quality improvements on binaries (and shared
9509 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9510 See @option{-flto} for a description of the effect of this flag and how to
9511 use it.
9513 This option is enabled by default when LTO support in GCC is enabled
9514 and GCC was configured for use with
9515 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9517 @item -ffat-lto-objects
9518 @opindex ffat-lto-objects
9519 Fat LTO objects are object files that contain both the intermediate language
9520 and the object code. This makes them usable for both LTO linking and normal
9521 linking. This option is effective only when compiling with @option{-flto}
9522 and is ignored at link time.
9524 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9525 requires the complete toolchain to be aware of LTO. It requires a linker with
9526 linker plugin support for basic functionality.  Additionally,
9527 @command{nm}, @command{ar} and @command{ranlib}
9528 need to support linker plugins to allow a full-featured build environment
9529 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9530 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9531 to these tools. With non fat LTO makefiles need to be modified to use them.
9533 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9534 support.
9536 @item -fcompare-elim
9537 @opindex fcompare-elim
9538 After register allocation and post-register allocation instruction splitting,
9539 identify arithmetic instructions that compute processor flags similar to a
9540 comparison operation based on that arithmetic.  If possible, eliminate the
9541 explicit comparison operation.
9543 This pass only applies to certain targets that cannot explicitly represent
9544 the comparison operation before register allocation is complete.
9546 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9548 @item -fcprop-registers
9549 @opindex fcprop-registers
9550 After register allocation and post-register allocation instruction splitting,
9551 perform a copy-propagation pass to try to reduce scheduling dependencies
9552 and occasionally eliminate the copy.
9554 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9556 @item -fprofile-correction
9557 @opindex fprofile-correction
9558 Profiles collected using an instrumented binary for multi-threaded programs may
9559 be inconsistent due to missed counter updates. When this option is specified,
9560 GCC uses heuristics to correct or smooth out such inconsistencies. By
9561 default, GCC emits an error message when an inconsistent profile is detected.
9563 @item -fprofile-dir=@var{path}
9564 @opindex fprofile-dir
9566 Set the directory to search for the profile data files in to @var{path}.
9567 This option affects only the profile data generated by
9568 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9569 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9570 and its related options.  Both absolute and relative paths can be used.
9571 By default, GCC uses the current directory as @var{path}, thus the
9572 profile data file appears in the same directory as the object file.
9574 @item -fprofile-generate
9575 @itemx -fprofile-generate=@var{path}
9576 @opindex fprofile-generate
9578 Enable options usually used for instrumenting application to produce
9579 profile useful for later recompilation with profile feedback based
9580 optimization.  You must use @option{-fprofile-generate} both when
9581 compiling and when linking your program.
9583 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9585 If @var{path} is specified, GCC looks at the @var{path} to find
9586 the profile feedback data files. See @option{-fprofile-dir}.
9588 @item -fprofile-use
9589 @itemx -fprofile-use=@var{path}
9590 @opindex fprofile-use
9591 Enable profile feedback-directed optimizations, 
9592 and the following optimizations
9593 which are generally profitable only with profile feedback available:
9594 @option{-fbranch-probabilities}, @option{-fvpt},
9595 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9596 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9598 By default, GCC emits an error message if the feedback profiles do not
9599 match the source code.  This error can be turned into a warning by using
9600 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9601 code.
9603 If @var{path} is specified, GCC looks at the @var{path} to find
9604 the profile feedback data files. See @option{-fprofile-dir}.
9606 @item -fauto-profile
9607 @itemx -fauto-profile=@var{path}
9608 @opindex fauto-profile
9609 Enable sampling-based feedback-directed optimizations, 
9610 and the following optimizations
9611 which are generally profitable only with profile feedback available:
9612 @option{-fbranch-probabilities}, @option{-fvpt},
9613 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9614 @option{-ftree-vectorize},
9615 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9616 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9617 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9619 @var{path} is the name of a file containing AutoFDO profile information.
9620 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9622 Producing an AutoFDO profile data file requires running your program
9623 with the @command{perf} utility on a supported GNU/Linux target system.
9624 For more information, see @uref{https://perf.wiki.kernel.org/}.
9626 E.g.
9627 @smallexample
9628 perf record -e br_inst_retired:near_taken -b -o perf.data \
9629     -- your_program
9630 @end smallexample
9632 Then use the @command{create_gcov} tool to convert the raw profile data
9633 to a format that can be used by GCC.@  You must also supply the 
9634 unstripped binary for your program to this tool.  
9635 See @uref{https://github.com/google/autofdo}.
9637 E.g.
9638 @smallexample
9639 create_gcov --binary=your_program.unstripped --profile=perf.data \
9640     --gcov=profile.afdo
9641 @end smallexample
9642 @end table
9644 The following options control compiler behavior regarding floating-point 
9645 arithmetic.  These options trade off between speed and
9646 correctness.  All must be specifically enabled.
9648 @table @gcctabopt
9649 @item -ffloat-store
9650 @opindex ffloat-store
9651 Do not store floating-point variables in registers, and inhibit other
9652 options that might change whether a floating-point value is taken from a
9653 register or memory.
9655 @cindex floating-point precision
9656 This option prevents undesirable excess precision on machines such as
9657 the 68000 where the floating registers (of the 68881) keep more
9658 precision than a @code{double} is supposed to have.  Similarly for the
9659 x86 architecture.  For most programs, the excess precision does only
9660 good, but a few programs rely on the precise definition of IEEE floating
9661 point.  Use @option{-ffloat-store} for such programs, after modifying
9662 them to store all pertinent intermediate computations into variables.
9664 @item -fexcess-precision=@var{style}
9665 @opindex fexcess-precision
9666 This option allows further control over excess precision on machines
9667 where floating-point registers have more precision than the IEEE
9668 @code{float} and @code{double} types and the processor does not
9669 support operations rounding to those types.  By default,
9670 @option{-fexcess-precision=fast} is in effect; this means that
9671 operations are carried out in the precision of the registers and that
9672 it is unpredictable when rounding to the types specified in the source
9673 code takes place.  When compiling C, if
9674 @option{-fexcess-precision=standard} is specified then excess
9675 precision follows the rules specified in ISO C99; in particular,
9676 both casts and assignments cause values to be rounded to their
9677 semantic types (whereas @option{-ffloat-store} only affects
9678 assignments).  This option is enabled by default for C if a strict
9679 conformance option such as @option{-std=c99} is used.
9681 @opindex mfpmath
9682 @option{-fexcess-precision=standard} is not implemented for languages
9683 other than C, and has no effect if
9684 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9685 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9686 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9687 semantics apply without excess precision, and in the latter, rounding
9688 is unpredictable.
9690 @item -ffast-math
9691 @opindex ffast-math
9692 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9693 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9694 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9696 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9698 This option is not turned on by any @option{-O} option besides
9699 @option{-Ofast} since it can result in incorrect output for programs
9700 that depend on an exact implementation of IEEE or ISO rules/specifications
9701 for math functions. It may, however, yield faster code for programs
9702 that do not require the guarantees of these specifications.
9704 @item -fno-math-errno
9705 @opindex fno-math-errno
9706 Do not set @code{errno} after calling math functions that are executed
9707 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9708 IEEE exceptions for math error handling may want to use this flag
9709 for speed while maintaining IEEE arithmetic compatibility.
9711 This option is not turned on by any @option{-O} option since
9712 it can result in incorrect output for programs that depend on
9713 an exact implementation of IEEE or ISO rules/specifications for
9714 math functions. It may, however, yield faster code for programs
9715 that do not require the guarantees of these specifications.
9717 The default is @option{-fmath-errno}.
9719 On Darwin systems, the math library never sets @code{errno}.  There is
9720 therefore no reason for the compiler to consider the possibility that
9721 it might, and @option{-fno-math-errno} is the default.
9723 @item -funsafe-math-optimizations
9724 @opindex funsafe-math-optimizations
9726 Allow optimizations for floating-point arithmetic that (a) assume
9727 that arguments and results are valid and (b) may violate IEEE or
9728 ANSI standards.  When used at link-time, it may include libraries
9729 or startup files that change the default FPU control word or other
9730 similar optimizations.
9732 This option is not turned on by any @option{-O} option since
9733 it can result in incorrect output for programs that depend on
9734 an exact implementation of IEEE or ISO rules/specifications for
9735 math functions. It may, however, yield faster code for programs
9736 that do not require the guarantees of these specifications.
9737 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9738 @option{-fassociative-math} and @option{-freciprocal-math}.
9740 The default is @option{-fno-unsafe-math-optimizations}.
9742 @item -fassociative-math
9743 @opindex fassociative-math
9745 Allow re-association of operands in series of floating-point operations.
9746 This violates the ISO C and C++ language standard by possibly changing
9747 computation result.  NOTE: re-ordering may change the sign of zero as
9748 well as ignore NaNs and inhibit or create underflow or overflow (and
9749 thus cannot be used on code that relies on rounding behavior like
9750 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9751 and thus may not be used when ordered comparisons are required.
9752 This option requires that both @option{-fno-signed-zeros} and
9753 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9754 much sense with @option{-frounding-math}. For Fortran the option
9755 is automatically enabled when both @option{-fno-signed-zeros} and
9756 @option{-fno-trapping-math} are in effect.
9758 The default is @option{-fno-associative-math}.
9760 @item -freciprocal-math
9761 @opindex freciprocal-math
9763 Allow the reciprocal of a value to be used instead of dividing by
9764 the value if this enables optimizations.  For example @code{x / y}
9765 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9766 is subject to common subexpression elimination.  Note that this loses
9767 precision and increases the number of flops operating on the value.
9769 The default is @option{-fno-reciprocal-math}.
9771 @item -ffinite-math-only
9772 @opindex ffinite-math-only
9773 Allow optimizations for floating-point arithmetic that assume
9774 that arguments and results are not NaNs or +-Infs.
9776 This option is not turned on by any @option{-O} option since
9777 it can result in incorrect output for programs that depend on
9778 an exact implementation of IEEE or ISO rules/specifications for
9779 math functions. It may, however, yield faster code for programs
9780 that do not require the guarantees of these specifications.
9782 The default is @option{-fno-finite-math-only}.
9784 @item -fno-signed-zeros
9785 @opindex fno-signed-zeros
9786 Allow optimizations for floating-point arithmetic that ignore the
9787 signedness of zero.  IEEE arithmetic specifies the behavior of
9788 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9789 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9790 This option implies that the sign of a zero result isn't significant.
9792 The default is @option{-fsigned-zeros}.
9794 @item -fno-trapping-math
9795 @opindex fno-trapping-math
9796 Compile code assuming that floating-point operations cannot generate
9797 user-visible traps.  These traps include division by zero, overflow,
9798 underflow, inexact result and invalid operation.  This option requires
9799 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9800 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9802 This option should never be turned on by any @option{-O} option since
9803 it can result in incorrect output for programs that depend on
9804 an exact implementation of IEEE or ISO rules/specifications for
9805 math functions.
9807 The default is @option{-ftrapping-math}.
9809 @item -frounding-math
9810 @opindex frounding-math
9811 Disable transformations and optimizations that assume default floating-point
9812 rounding behavior.  This is round-to-zero for all floating point
9813 to integer conversions, and round-to-nearest for all other arithmetic
9814 truncations.  This option should be specified for programs that change
9815 the FP rounding mode dynamically, or that may be executed with a
9816 non-default rounding mode.  This option disables constant folding of
9817 floating-point expressions at compile time (which may be affected by
9818 rounding mode) and arithmetic transformations that are unsafe in the
9819 presence of sign-dependent rounding modes.
9821 The default is @option{-fno-rounding-math}.
9823 This option is experimental and does not currently guarantee to
9824 disable all GCC optimizations that are affected by rounding mode.
9825 Future versions of GCC may provide finer control of this setting
9826 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9827 will be used to specify the default state for @code{FENV_ACCESS}.
9829 @item -fsignaling-nans
9830 @opindex fsignaling-nans
9831 Compile code assuming that IEEE signaling NaNs may generate user-visible
9832 traps during floating-point operations.  Setting this option disables
9833 optimizations that may change the number of exceptions visible with
9834 signaling NaNs.  This option implies @option{-ftrapping-math}.
9836 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9837 be defined.
9839 The default is @option{-fno-signaling-nans}.
9841 This option is experimental and does not currently guarantee to
9842 disable all GCC optimizations that affect signaling NaN behavior.
9844 @item -fsingle-precision-constant
9845 @opindex fsingle-precision-constant
9846 Treat floating-point constants as single precision instead of
9847 implicitly converting them to double-precision constants.
9849 @item -fcx-limited-range
9850 @opindex fcx-limited-range
9851 When enabled, this option states that a range reduction step is not
9852 needed when performing complex division.  Also, there is no checking
9853 whether the result of a complex multiplication or division is @code{NaN
9854 + I*NaN}, with an attempt to rescue the situation in that case.  The
9855 default is @option{-fno-cx-limited-range}, but is enabled by
9856 @option{-ffast-math}.
9858 This option controls the default setting of the ISO C99
9859 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9860 all languages.
9862 @item -fcx-fortran-rules
9863 @opindex fcx-fortran-rules
9864 Complex multiplication and division follow Fortran rules.  Range
9865 reduction is done as part of complex division, but there is no checking
9866 whether the result of a complex multiplication or division is @code{NaN
9867 + I*NaN}, with an attempt to rescue the situation in that case.
9869 The default is @option{-fno-cx-fortran-rules}.
9871 @end table
9873 The following options control optimizations that may improve
9874 performance, but are not enabled by any @option{-O} options.  This
9875 section includes experimental options that may produce broken code.
9877 @table @gcctabopt
9878 @item -fbranch-probabilities
9879 @opindex fbranch-probabilities
9880 After running a program compiled with @option{-fprofile-arcs}
9881 (@pxref{Debugging Options,, Options for Debugging Your Program or
9882 @command{gcc}}), you can compile it a second time using
9883 @option{-fbranch-probabilities}, to improve optimizations based on
9884 the number of times each branch was taken.  When a program
9885 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9886 counts to a file called @file{@var{sourcename}.gcda} for each source
9887 file.  The information in this data file is very dependent on the
9888 structure of the generated code, so you must use the same source code
9889 and the same optimization options for both compilations.
9891 With @option{-fbranch-probabilities}, GCC puts a
9892 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9893 These can be used to improve optimization.  Currently, they are only
9894 used in one place: in @file{reorg.c}, instead of guessing which path a
9895 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9896 exactly determine which path is taken more often.
9898 @item -fprofile-values
9899 @opindex fprofile-values
9900 If combined with @option{-fprofile-arcs}, it adds code so that some
9901 data about values of expressions in the program is gathered.
9903 With @option{-fbranch-probabilities}, it reads back the data gathered
9904 from profiling values of expressions for usage in optimizations.
9906 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9908 @item -fprofile-reorder-functions
9909 @opindex fprofile-reorder-functions
9910 Function reordering based on profile instrumentation collects
9911 first time of execution of a function and orders these functions
9912 in ascending order.
9914 Enabled with @option{-fprofile-use}.
9916 @item -fvpt
9917 @opindex fvpt
9918 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9919 to add code to gather information about values of expressions.
9921 With @option{-fbranch-probabilities}, it reads back the data gathered
9922 and actually performs the optimizations based on them.
9923 Currently the optimizations include specialization of division operations
9924 using the knowledge about the value of the denominator.
9926 @item -frename-registers
9927 @opindex frename-registers
9928 Attempt to avoid false dependencies in scheduled code by making use
9929 of registers left over after register allocation.  This optimization
9930 most benefits processors with lots of registers.  Depending on the
9931 debug information format adopted by the target, however, it can
9932 make debugging impossible, since variables no longer stay in
9933 a ``home register''.
9935 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9937 @item -fschedule-fusion
9938 @opindex fschedule-fusion
9939 Performs a target dependent pass over the instruction stream to schedule
9940 instructions of same type together because target machine can execute them
9941 more efficiently if they are adjacent to each other in the instruction flow.
9943 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9945 @item -ftracer
9946 @opindex ftracer
9947 Perform tail duplication to enlarge superblock size.  This transformation
9948 simplifies the control flow of the function allowing other optimizations to do
9949 a better job.
9951 Enabled with @option{-fprofile-use}.
9953 @item -funroll-loops
9954 @opindex funroll-loops
9955 Unroll loops whose number of iterations can be determined at compile time or
9956 upon entry to the loop.  @option{-funroll-loops} implies
9957 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9958 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9959 a small constant number of iterations).  This option makes code larger, and may
9960 or may not make it run faster.
9962 Enabled with @option{-fprofile-use}.
9964 @item -funroll-all-loops
9965 @opindex funroll-all-loops
9966 Unroll all loops, even if their number of iterations is uncertain when
9967 the loop is entered.  This usually makes programs run more slowly.
9968 @option{-funroll-all-loops} implies the same options as
9969 @option{-funroll-loops}.
9971 @item -fpeel-loops
9972 @opindex fpeel-loops
9973 Peels loops for which there is enough information that they do not
9974 roll much (from profile feedback).  It also turns on complete loop peeling
9975 (i.e.@: complete removal of loops with small constant number of iterations).
9977 Enabled with @option{-fprofile-use}.
9979 @item -fmove-loop-invariants
9980 @opindex fmove-loop-invariants
9981 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9982 at level @option{-O1}
9984 @item -funswitch-loops
9985 @opindex funswitch-loops
9986 Move branches with loop invariant conditions out of the loop, with duplicates
9987 of the loop on both branches (modified according to result of the condition).
9989 @item -ffunction-sections
9990 @itemx -fdata-sections
9991 @opindex ffunction-sections
9992 @opindex fdata-sections
9993 Place each function or data item into its own section in the output
9994 file if the target supports arbitrary sections.  The name of the
9995 function or the name of the data item determines the section's name
9996 in the output file.
9998 Use these options on systems where the linker can perform optimizations
9999 to improve locality of reference in the instruction space.  Most systems
10000 using the ELF object format and SPARC processors running Solaris 2 have
10001 linkers with such optimizations.  AIX may have these optimizations in
10002 the future.
10004 Only use these options when there are significant benefits from doing
10005 so.  When you specify these options, the assembler and linker
10006 create larger object and executable files and are also slower.
10007 You cannot use @command{gprof} on all systems if you
10008 specify this option, and you may have problems with debugging if
10009 you specify both this option and @option{-g}.
10011 @item -fbranch-target-load-optimize
10012 @opindex fbranch-target-load-optimize
10013 Perform branch target register load optimization before prologue / epilogue
10014 threading.
10015 The use of target registers can typically be exposed only during reload,
10016 thus hoisting loads out of loops and doing inter-block scheduling needs
10017 a separate optimization pass.
10019 @item -fbranch-target-load-optimize2
10020 @opindex fbranch-target-load-optimize2
10021 Perform branch target register load optimization after prologue / epilogue
10022 threading.
10024 @item -fbtr-bb-exclusive
10025 @opindex fbtr-bb-exclusive
10026 When performing branch target register load optimization, don't reuse
10027 branch target registers within any basic block.
10029 @item -fstack-protector
10030 @opindex fstack-protector
10031 Emit extra code to check for buffer overflows, such as stack smashing
10032 attacks.  This is done by adding a guard variable to functions with
10033 vulnerable objects.  This includes functions that call @code{alloca}, and
10034 functions with buffers larger than 8 bytes.  The guards are initialized
10035 when a function is entered and then checked when the function exits.
10036 If a guard check fails, an error message is printed and the program exits.
10038 @item -fstack-protector-all
10039 @opindex fstack-protector-all
10040 Like @option{-fstack-protector} except that all functions are protected.
10042 @item -fstack-protector-strong
10043 @opindex fstack-protector-strong
10044 Like @option{-fstack-protector} but includes additional functions to
10045 be protected --- those that have local array definitions, or have
10046 references to local frame addresses.
10048 @item -fstack-protector-explicit
10049 @opindex fstack-protector-explicit
10050 Like @option{-fstack-protector} but only protects those functions which
10051 have the @code{stack_protect} attribute
10053 @item -fstdarg-opt
10054 @opindex fstdarg-opt
10055 Optimize the prologue of variadic argument functions with respect to usage of
10056 those arguments.
10058 @item -fsection-anchors
10059 @opindex fsection-anchors
10060 Try to reduce the number of symbolic address calculations by using
10061 shared ``anchor'' symbols to address nearby objects.  This transformation
10062 can help to reduce the number of GOT entries and GOT accesses on some
10063 targets.
10065 For example, the implementation of the following function @code{foo}:
10067 @smallexample
10068 static int a, b, c;
10069 int foo (void) @{ return a + b + c; @}
10070 @end smallexample
10072 @noindent
10073 usually calculates the addresses of all three variables, but if you
10074 compile it with @option{-fsection-anchors}, it accesses the variables
10075 from a common anchor point instead.  The effect is similar to the
10076 following pseudocode (which isn't valid C):
10078 @smallexample
10079 int foo (void)
10081   register int *xr = &x;
10082   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10084 @end smallexample
10086 Not all targets support this option.
10088 @item --param @var{name}=@var{value}
10089 @opindex param
10090 In some places, GCC uses various constants to control the amount of
10091 optimization that is done.  For example, GCC does not inline functions
10092 that contain more than a certain number of instructions.  You can
10093 control some of these constants on the command line using the
10094 @option{--param} option.
10096 The names of specific parameters, and the meaning of the values, are
10097 tied to the internals of the compiler, and are subject to change
10098 without notice in future releases.
10100 In each case, the @var{value} is an integer.  The allowable choices for
10101 @var{name} are:
10103 @table @gcctabopt
10104 @item predictable-branch-outcome
10105 When branch is predicted to be taken with probability lower than this threshold
10106 (in percent), then it is considered well predictable. The default is 10.
10108 @item max-crossjump-edges
10109 The maximum number of incoming edges to consider for cross-jumping.
10110 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10111 the number of edges incoming to each block.  Increasing values mean
10112 more aggressive optimization, making the compilation time increase with
10113 probably small improvement in executable size.
10115 @item min-crossjump-insns
10116 The minimum number of instructions that must be matched at the end
10117 of two blocks before cross-jumping is performed on them.  This
10118 value is ignored in the case where all instructions in the block being
10119 cross-jumped from are matched.  The default value is 5.
10121 @item max-grow-copy-bb-insns
10122 The maximum code size expansion factor when copying basic blocks
10123 instead of jumping.  The expansion is relative to a jump instruction.
10124 The default value is 8.
10126 @item max-goto-duplication-insns
10127 The maximum number of instructions to duplicate to a block that jumps
10128 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10129 passes, GCC factors computed gotos early in the compilation process,
10130 and unfactors them as late as possible.  Only computed jumps at the
10131 end of a basic blocks with no more than max-goto-duplication-insns are
10132 unfactored.  The default value is 8.
10134 @item max-delay-slot-insn-search
10135 The maximum number of instructions to consider when looking for an
10136 instruction to fill a delay slot.  If more than this arbitrary number of
10137 instructions are searched, the time savings from filling the delay slot
10138 are minimal, so stop searching.  Increasing values mean more
10139 aggressive optimization, making the compilation time increase with probably
10140 small improvement in execution time.
10142 @item max-delay-slot-live-search
10143 When trying to fill delay slots, the maximum number of instructions to
10144 consider when searching for a block with valid live register
10145 information.  Increasing this arbitrarily chosen value means more
10146 aggressive optimization, increasing the compilation time.  This parameter
10147 should be removed when the delay slot code is rewritten to maintain the
10148 control-flow graph.
10150 @item max-gcse-memory
10151 The approximate maximum amount of memory that can be allocated in
10152 order to perform the global common subexpression elimination
10153 optimization.  If more memory than specified is required, the
10154 optimization is not done.
10156 @item max-gcse-insertion-ratio
10157 If the ratio of expression insertions to deletions is larger than this value
10158 for any expression, then RTL PRE inserts or removes the expression and thus
10159 leaves partially redundant computations in the instruction stream.  The default value is 20.
10161 @item max-pending-list-length
10162 The maximum number of pending dependencies scheduling allows
10163 before flushing the current state and starting over.  Large functions
10164 with few branches or calls can create excessively large lists which
10165 needlessly consume memory and resources.
10167 @item max-modulo-backtrack-attempts
10168 The maximum number of backtrack attempts the scheduler should make
10169 when modulo scheduling a loop.  Larger values can exponentially increase
10170 compilation time.
10172 @item max-inline-insns-single
10173 Several parameters control the tree inliner used in GCC@.
10174 This number sets the maximum number of instructions (counted in GCC's
10175 internal representation) in a single function that the tree inliner
10176 considers for inlining.  This only affects functions declared
10177 inline and methods implemented in a class declaration (C++).
10178 The default value is 400.
10180 @item max-inline-insns-auto
10181 When you use @option{-finline-functions} (included in @option{-O3}),
10182 a lot of functions that would otherwise not be considered for inlining
10183 by the compiler are investigated.  To those functions, a different
10184 (more restrictive) limit compared to functions declared inline can
10185 be applied.
10186 The default value is 40.
10188 @item inline-min-speedup
10189 When estimated performance improvement of caller + callee runtime exceeds this
10190 threshold (in precent), the function can be inlined regardless the limit on
10191 @option{--param max-inline-insns-single} and @option{--param
10192 max-inline-insns-auto}.
10194 @item large-function-insns
10195 The limit specifying really large functions.  For functions larger than this
10196 limit after inlining, inlining is constrained by
10197 @option{--param large-function-growth}.  This parameter is useful primarily
10198 to avoid extreme compilation time caused by non-linear algorithms used by the
10199 back end.
10200 The default value is 2700.
10202 @item large-function-growth
10203 Specifies maximal growth of large function caused by inlining in percents.
10204 The default value is 100 which limits large function growth to 2.0 times
10205 the original size.
10207 @item large-unit-insns
10208 The limit specifying large translation unit.  Growth caused by inlining of
10209 units larger than this limit is limited by @option{--param inline-unit-growth}.
10210 For small units this might be too tight.
10211 For example, consider a unit consisting of function A
10212 that is inline and B that just calls A three times.  If B is small relative to
10213 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10214 large units consisting of small inlineable functions, however, the overall unit
10215 growth limit is needed to avoid exponential explosion of code size.  Thus for
10216 smaller units, the size is increased to @option{--param large-unit-insns}
10217 before applying @option{--param inline-unit-growth}.  The default is 10000.
10219 @item inline-unit-growth
10220 Specifies maximal overall growth of the compilation unit caused by inlining.
10221 The default value is 20 which limits unit growth to 1.2 times the original
10222 size. Cold functions (either marked cold via an attribute or by profile
10223 feedback) are not accounted into the unit size.
10225 @item ipcp-unit-growth
10226 Specifies maximal overall growth of the compilation unit caused by
10227 interprocedural constant propagation.  The default value is 10 which limits
10228 unit growth to 1.1 times the original size.
10230 @item large-stack-frame
10231 The limit specifying large stack frames.  While inlining the algorithm is trying
10232 to not grow past this limit too much.  The default value is 256 bytes.
10234 @item large-stack-frame-growth
10235 Specifies maximal growth of large stack frames caused by inlining in percents.
10236 The default value is 1000 which limits large stack frame growth to 11 times
10237 the original size.
10239 @item max-inline-insns-recursive
10240 @itemx max-inline-insns-recursive-auto
10241 Specifies the maximum number of instructions an out-of-line copy of a
10242 self-recursive inline
10243 function can grow into by performing recursive inlining.
10245 @option{--param max-inline-insns-recursive} applies to functions
10246 declared inline.
10247 For functions not declared inline, recursive inlining
10248 happens only when @option{-finline-functions} (included in @option{-O3}) is
10249 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10250 default value is 450.
10252 @item max-inline-recursive-depth
10253 @itemx max-inline-recursive-depth-auto
10254 Specifies the maximum recursion depth used for recursive inlining.
10256 @option{--param max-inline-recursive-depth} applies to functions
10257 declared inline.  For functions not declared inline, recursive inlining
10258 happens only when @option{-finline-functions} (included in @option{-O3}) is
10259 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10260 default value is 8.
10262 @item min-inline-recursive-probability
10263 Recursive inlining is profitable only for function having deep recursion
10264 in average and can hurt for function having little recursion depth by
10265 increasing the prologue size or complexity of function body to other
10266 optimizers.
10268 When profile feedback is available (see @option{-fprofile-generate}) the actual
10269 recursion depth can be guessed from probability that function recurses via a
10270 given call expression.  This parameter limits inlining only to call expressions
10271 whose probability exceeds the given threshold (in percents).
10272 The default value is 10.
10274 @item early-inlining-insns
10275 Specify growth that the early inliner can make.  In effect it increases
10276 the amount of inlining for code having a large abstraction penalty.
10277 The default value is 14.
10279 @item max-early-inliner-iterations
10280 Limit of iterations of the early inliner.  This basically bounds
10281 the number of nested indirect calls the early inliner can resolve.
10282 Deeper chains are still handled by late inlining.
10284 @item comdat-sharing-probability
10285 Probability (in percent) that C++ inline function with comdat visibility
10286 are shared across multiple compilation units.  The default value is 20.
10288 @item profile-func-internal-id
10289 A parameter to control whether to use function internal id in profile
10290 database lookup. If the value is 0, the compiler uses an id that
10291 is based on function assembler name and filename, which makes old profile
10292 data more tolerant to source changes such as function reordering etc.
10293 The default value is 0.
10295 @item min-vect-loop-bound
10296 The minimum number of iterations under which loops are not vectorized
10297 when @option{-ftree-vectorize} is used.  The number of iterations after
10298 vectorization needs to be greater than the value specified by this option
10299 to allow vectorization.  The default value is 0.
10301 @item gcse-cost-distance-ratio
10302 Scaling factor in calculation of maximum distance an expression
10303 can be moved by GCSE optimizations.  This is currently supported only in the
10304 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10305 is with simple expressions, i.e., the expressions that have cost
10306 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10307 hoisting of simple expressions.  The default value is 10.
10309 @item gcse-unrestricted-cost
10310 Cost, roughly measured as the cost of a single typical machine
10311 instruction, at which GCSE optimizations do not constrain
10312 the distance an expression can travel.  This is currently
10313 supported only in the code hoisting pass.  The lesser the cost,
10314 the more aggressive code hoisting is.  Specifying 0 
10315 allows all expressions to travel unrestricted distances.
10316 The default value is 3.
10318 @item max-hoist-depth
10319 The depth of search in the dominator tree for expressions to hoist.
10320 This is used to avoid quadratic behavior in hoisting algorithm.
10321 The value of 0 does not limit on the search, but may slow down compilation
10322 of huge functions.  The default value is 30.
10324 @item max-tail-merge-comparisons
10325 The maximum amount of similar bbs to compare a bb with.  This is used to
10326 avoid quadratic behavior in tree tail merging.  The default value is 10.
10328 @item max-tail-merge-iterations
10329 The maximum amount of iterations of the pass over the function.  This is used to
10330 limit compilation time in tree tail merging.  The default value is 2.
10332 @item max-unrolled-insns
10333 The maximum number of instructions that a loop may have to be unrolled.
10334 If a loop is unrolled, this parameter also determines how many times
10335 the loop code is unrolled.
10337 @item max-average-unrolled-insns
10338 The maximum number of instructions biased by probabilities of their execution
10339 that a loop may have to be unrolled.  If a loop is unrolled,
10340 this parameter also determines how many times the loop code is unrolled.
10342 @item max-unroll-times
10343 The maximum number of unrollings of a single loop.
10345 @item max-peeled-insns
10346 The maximum number of instructions that a loop may have to be peeled.
10347 If a loop is peeled, this parameter also determines how many times
10348 the loop code is peeled.
10350 @item max-peel-times
10351 The maximum number of peelings of a single loop.
10353 @item max-peel-branches
10354 The maximum number of branches on the hot path through the peeled sequence.
10356 @item max-completely-peeled-insns
10357 The maximum number of insns of a completely peeled loop.
10359 @item max-completely-peel-times
10360 The maximum number of iterations of a loop to be suitable for complete peeling.
10362 @item max-completely-peel-loop-nest-depth
10363 The maximum depth of a loop nest suitable for complete peeling.
10365 @item max-unswitch-insns
10366 The maximum number of insns of an unswitched loop.
10368 @item max-unswitch-level
10369 The maximum number of branches unswitched in a single loop.
10371 @item lim-expensive
10372 The minimum cost of an expensive expression in the loop invariant motion.
10374 @item iv-consider-all-candidates-bound
10375 Bound on number of candidates for induction variables, below which
10376 all candidates are considered for each use in induction variable
10377 optimizations.  If there are more candidates than this,
10378 only the most relevant ones are considered to avoid quadratic time complexity.
10380 @item iv-max-considered-uses
10381 The induction variable optimizations give up on loops that contain more
10382 induction variable uses.
10384 @item iv-always-prune-cand-set-bound
10385 If the number of candidates in the set is smaller than this value,
10386 always try to remove unnecessary ivs from the set
10387 when adding a new one.
10389 @item scev-max-expr-size
10390 Bound on size of expressions used in the scalar evolutions analyzer.
10391 Large expressions slow the analyzer.
10393 @item scev-max-expr-complexity
10394 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10395 Complex expressions slow the analyzer.
10397 @item omega-max-vars
10398 The maximum number of variables in an Omega constraint system.
10399 The default value is 128.
10401 @item omega-max-geqs
10402 The maximum number of inequalities in an Omega constraint system.
10403 The default value is 256.
10405 @item omega-max-eqs
10406 The maximum number of equalities in an Omega constraint system.
10407 The default value is 128.
10409 @item omega-max-wild-cards
10410 The maximum number of wildcard variables that the Omega solver is
10411 able to insert.  The default value is 18.
10413 @item omega-hash-table-size
10414 The size of the hash table in the Omega solver.  The default value is
10415 550.
10417 @item omega-max-keys
10418 The maximal number of keys used by the Omega solver.  The default
10419 value is 500.
10421 @item omega-eliminate-redundant-constraints
10422 When set to 1, use expensive methods to eliminate all redundant
10423 constraints.  The default value is 0.
10425 @item vect-max-version-for-alignment-checks
10426 The maximum number of run-time checks that can be performed when
10427 doing loop versioning for alignment in the vectorizer.
10429 @item vect-max-version-for-alias-checks
10430 The maximum number of run-time checks that can be performed when
10431 doing loop versioning for alias in the vectorizer.
10433 @item vect-max-peeling-for-alignment
10434 The maximum number of loop peels to enhance access alignment
10435 for vectorizer. Value -1 means 'no limit'.
10437 @item max-iterations-to-track
10438 The maximum number of iterations of a loop the brute-force algorithm
10439 for analysis of the number of iterations of the loop tries to evaluate.
10441 @item hot-bb-count-ws-permille
10442 A basic block profile count is considered hot if it contributes to 
10443 the given permillage (i.e. 0...1000) of the entire profiled execution.
10445 @item hot-bb-frequency-fraction
10446 Select fraction of the entry block frequency of executions of basic block in
10447 function given basic block needs to have to be considered hot.
10449 @item max-predicted-iterations
10450 The maximum number of loop iterations we predict statically.  This is useful
10451 in cases where a function contains a single loop with known bound and
10452 another loop with unknown bound.
10453 The known number of iterations is predicted correctly, while
10454 the unknown number of iterations average to roughly 10.  This means that the
10455 loop without bounds appears artificially cold relative to the other one.
10457 @item builtin-expect-probability
10458 Control the probability of the expression having the specified value. This
10459 parameter takes a percentage (i.e. 0 ... 100) as input.
10460 The default probability of 90 is obtained empirically.
10462 @item align-threshold
10464 Select fraction of the maximal frequency of executions of a basic block in
10465 a function to align the basic block.
10467 @item align-loop-iterations
10469 A loop expected to iterate at least the selected number of iterations is
10470 aligned.
10472 @item tracer-dynamic-coverage
10473 @itemx tracer-dynamic-coverage-feedback
10475 This value is used to limit superblock formation once the given percentage of
10476 executed instructions is covered.  This limits unnecessary code size
10477 expansion.
10479 The @option{tracer-dynamic-coverage-feedback} parameter
10480 is used only when profile
10481 feedback is available.  The real profiles (as opposed to statically estimated
10482 ones) are much less balanced allowing the threshold to be larger value.
10484 @item tracer-max-code-growth
10485 Stop tail duplication once code growth has reached given percentage.  This is
10486 a rather artificial limit, as most of the duplicates are eliminated later in
10487 cross jumping, so it may be set to much higher values than is the desired code
10488 growth.
10490 @item tracer-min-branch-ratio
10492 Stop reverse growth when the reverse probability of best edge is less than this
10493 threshold (in percent).
10495 @item tracer-min-branch-ratio
10496 @itemx tracer-min-branch-ratio-feedback
10498 Stop forward growth if the best edge has probability lower than this
10499 threshold.
10501 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10502 compilation for profile feedback and one for compilation without.  The value
10503 for compilation with profile feedback needs to be more conservative (higher) in
10504 order to make tracer effective.
10506 @item max-cse-path-length
10508 The maximum number of basic blocks on path that CSE considers.
10509 The default is 10.
10511 @item max-cse-insns
10512 The maximum number of instructions CSE processes before flushing.
10513 The default is 1000.
10515 @item ggc-min-expand
10517 GCC uses a garbage collector to manage its own memory allocation.  This
10518 parameter specifies the minimum percentage by which the garbage
10519 collector's heap should be allowed to expand between collections.
10520 Tuning this may improve compilation speed; it has no effect on code
10521 generation.
10523 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10524 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10525 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10526 GCC is not able to calculate RAM on a particular platform, the lower
10527 bound of 30% is used.  Setting this parameter and
10528 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10529 every opportunity.  This is extremely slow, but can be useful for
10530 debugging.
10532 @item ggc-min-heapsize
10534 Minimum size of the garbage collector's heap before it begins bothering
10535 to collect garbage.  The first collection occurs after the heap expands
10536 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10537 tuning this may improve compilation speed, and has no effect on code
10538 generation.
10540 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10541 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10542 with a lower bound of 4096 (four megabytes) and an upper bound of
10543 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10544 particular platform, the lower bound is used.  Setting this parameter
10545 very large effectively disables garbage collection.  Setting this
10546 parameter and @option{ggc-min-expand} to zero causes a full collection
10547 to occur at every opportunity.
10549 @item max-reload-search-insns
10550 The maximum number of instruction reload should look backward for equivalent
10551 register.  Increasing values mean more aggressive optimization, making the
10552 compilation time increase with probably slightly better performance.
10553 The default value is 100.
10555 @item max-cselib-memory-locations
10556 The maximum number of memory locations cselib should take into account.
10557 Increasing values mean more aggressive optimization, making the compilation time
10558 increase with probably slightly better performance.  The default value is 500.
10560 @item reorder-blocks-duplicate
10561 @itemx reorder-blocks-duplicate-feedback
10563 Used by the basic block reordering pass to decide whether to use unconditional
10564 branch or duplicate the code on its destination.  Code is duplicated when its
10565 estimated size is smaller than this value multiplied by the estimated size of
10566 unconditional jump in the hot spots of the program.
10568 The @option{reorder-block-duplicate-feedback} parameter
10569 is used only when profile
10570 feedback is available.  It may be set to higher values than
10571 @option{reorder-block-duplicate} since information about the hot spots is more
10572 accurate.
10574 @item max-sched-ready-insns
10575 The maximum number of instructions ready to be issued the scheduler should
10576 consider at any given time during the first scheduling pass.  Increasing
10577 values mean more thorough searches, making the compilation time increase
10578 with probably little benefit.  The default value is 100.
10580 @item max-sched-region-blocks
10581 The maximum number of blocks in a region to be considered for
10582 interblock scheduling.  The default value is 10.
10584 @item max-pipeline-region-blocks
10585 The maximum number of blocks in a region to be considered for
10586 pipelining in the selective scheduler.  The default value is 15.
10588 @item max-sched-region-insns
10589 The maximum number of insns in a region to be considered for
10590 interblock scheduling.  The default value is 100.
10592 @item max-pipeline-region-insns
10593 The maximum number of insns in a region to be considered for
10594 pipelining in the selective scheduler.  The default value is 200.
10596 @item min-spec-prob
10597 The minimum probability (in percents) of reaching a source block
10598 for interblock speculative scheduling.  The default value is 40.
10600 @item max-sched-extend-regions-iters
10601 The maximum number of iterations through CFG to extend regions.
10602 A value of 0 (the default) disables region extensions.
10604 @item max-sched-insn-conflict-delay
10605 The maximum conflict delay for an insn to be considered for speculative motion.
10606 The default value is 3.
10608 @item sched-spec-prob-cutoff
10609 The minimal probability of speculation success (in percents), so that
10610 speculative insns are scheduled.
10611 The default value is 40.
10613 @item sched-spec-state-edge-prob-cutoff
10614 The minimum probability an edge must have for the scheduler to save its
10615 state across it.
10616 The default value is 10.
10618 @item sched-mem-true-dep-cost
10619 Minimal distance (in CPU cycles) between store and load targeting same
10620 memory locations.  The default value is 1.
10622 @item selsched-max-lookahead
10623 The maximum size of the lookahead window of selective scheduling.  It is a
10624 depth of search for available instructions.
10625 The default value is 50.
10627 @item selsched-max-sched-times
10628 The maximum number of times that an instruction is scheduled during
10629 selective scheduling.  This is the limit on the number of iterations
10630 through which the instruction may be pipelined.  The default value is 2.
10632 @item selsched-max-insns-to-rename
10633 The maximum number of best instructions in the ready list that are considered
10634 for renaming in the selective scheduler.  The default value is 2.
10636 @item sms-min-sc
10637 The minimum value of stage count that swing modulo scheduler
10638 generates.  The default value is 2.
10640 @item max-last-value-rtl
10641 The maximum size measured as number of RTLs that can be recorded in an expression
10642 in combiner for a pseudo register as last known value of that register.  The default
10643 is 10000.
10645 @item max-combine-insns
10646 The maximum number of instructions the RTL combiner tries to combine.
10647 The default value is 2 at @option{-Og} and 4 otherwise.
10649 @item integer-share-limit
10650 Small integer constants can use a shared data structure, reducing the
10651 compiler's memory usage and increasing its speed.  This sets the maximum
10652 value of a shared integer constant.  The default value is 256.
10654 @item ssp-buffer-size
10655 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10656 protection when @option{-fstack-protection} is used.
10658 @item min-size-for-stack-sharing
10659 The minimum size of variables taking part in stack slot sharing when not
10660 optimizing. The default value is 32.
10662 @item max-jump-thread-duplication-stmts
10663 Maximum number of statements allowed in a block that needs to be
10664 duplicated when threading jumps.
10666 @item max-fields-for-field-sensitive
10667 Maximum number of fields in a structure treated in
10668 a field sensitive manner during pointer analysis.  The default is zero
10669 for @option{-O0} and @option{-O1},
10670 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10672 @item prefetch-latency
10673 Estimate on average number of instructions that are executed before
10674 prefetch finishes.  The distance prefetched ahead is proportional
10675 to this constant.  Increasing this number may also lead to less
10676 streams being prefetched (see @option{simultaneous-prefetches}).
10678 @item simultaneous-prefetches
10679 Maximum number of prefetches that can run at the same time.
10681 @item l1-cache-line-size
10682 The size of cache line in L1 cache, in bytes.
10684 @item l1-cache-size
10685 The size of L1 cache, in kilobytes.
10687 @item l2-cache-size
10688 The size of L2 cache, in kilobytes.
10690 @item min-insn-to-prefetch-ratio
10691 The minimum ratio between the number of instructions and the
10692 number of prefetches to enable prefetching in a loop.
10694 @item prefetch-min-insn-to-mem-ratio
10695 The minimum ratio between the number of instructions and the
10696 number of memory references to enable prefetching in a loop.
10698 @item use-canonical-types
10699 Whether the compiler should use the ``canonical'' type system.  By
10700 default, this should always be 1, which uses a more efficient internal
10701 mechanism for comparing types in C++ and Objective-C++.  However, if
10702 bugs in the canonical type system are causing compilation failures,
10703 set this value to 0 to disable canonical types.
10705 @item switch-conversion-max-branch-ratio
10706 Switch initialization conversion refuses to create arrays that are
10707 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10708 branches in the switch.
10710 @item max-partial-antic-length
10711 Maximum length of the partial antic set computed during the tree
10712 partial redundancy elimination optimization (@option{-ftree-pre}) when
10713 optimizing at @option{-O3} and above.  For some sorts of source code
10714 the enhanced partial redundancy elimination optimization can run away,
10715 consuming all of the memory available on the host machine.  This
10716 parameter sets a limit on the length of the sets that are computed,
10717 which prevents the runaway behavior.  Setting a value of 0 for
10718 this parameter allows an unlimited set length.
10720 @item sccvn-max-scc-size
10721 Maximum size of a strongly connected component (SCC) during SCCVN
10722 processing.  If this limit is hit, SCCVN processing for the whole
10723 function is not done and optimizations depending on it are
10724 disabled.  The default maximum SCC size is 10000.
10726 @item sccvn-max-alias-queries-per-access
10727 Maximum number of alias-oracle queries we perform when looking for
10728 redundancies for loads and stores.  If this limit is hit the search
10729 is aborted and the load or store is not considered redundant.  The
10730 number of queries is algorithmically limited to the number of
10731 stores on all paths from the load to the function entry.
10732 The default maxmimum number of queries is 1000.
10734 @item ira-max-loops-num
10735 IRA uses regional register allocation by default.  If a function
10736 contains more loops than the number given by this parameter, only at most
10737 the given number of the most frequently-executed loops form regions
10738 for regional register allocation.  The default value of the
10739 parameter is 100.
10741 @item ira-max-conflict-table-size 
10742 Although IRA uses a sophisticated algorithm to compress the conflict
10743 table, the table can still require excessive amounts of memory for
10744 huge functions.  If the conflict table for a function could be more
10745 than the size in MB given by this parameter, the register allocator
10746 instead uses a faster, simpler, and lower-quality
10747 algorithm that does not require building a pseudo-register conflict table.  
10748 The default value of the parameter is 2000.
10750 @item ira-loop-reserved-regs
10751 IRA can be used to evaluate more accurate register pressure in loops
10752 for decisions to move loop invariants (see @option{-O3}).  The number
10753 of available registers reserved for some other purposes is given
10754 by this parameter.  The default value of the parameter is 2, which is
10755 the minimal number of registers needed by typical instructions.
10756 This value is the best found from numerous experiments.
10758 @item lra-inheritance-ebb-probability-cutoff
10759 LRA tries to reuse values reloaded in registers in subsequent insns.
10760 This optimization is called inheritance.  EBB is used as a region to
10761 do this optimization.  The parameter defines a minimal fall-through
10762 edge probability in percentage used to add BB to inheritance EBB in
10763 LRA.  The default value of the parameter is 40.  The value was chosen
10764 from numerous runs of SPEC2000 on x86-64.
10766 @item loop-invariant-max-bbs-in-loop
10767 Loop invariant motion can be very expensive, both in compilation time and
10768 in amount of needed compile-time memory, with very large loops.  Loops
10769 with more basic blocks than this parameter won't have loop invariant
10770 motion optimization performed on them.  The default value of the
10771 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10773 @item loop-max-datarefs-for-datadeps
10774 Building data dapendencies is expensive for very large loops.  This
10775 parameter limits the number of data references in loops that are
10776 considered for data dependence analysis.  These large loops are no
10777 handled by the optimizations using loop data dependencies.
10778 The default value is 1000.
10780 @item max-vartrack-size
10781 Sets a maximum number of hash table slots to use during variable
10782 tracking dataflow analysis of any function.  If this limit is exceeded
10783 with variable tracking at assignments enabled, analysis for that
10784 function is retried without it, after removing all debug insns from
10785 the function.  If the limit is exceeded even without debug insns, var
10786 tracking analysis is completely disabled for the function.  Setting
10787 the parameter to zero makes it unlimited.
10789 @item max-vartrack-expr-depth
10790 Sets a maximum number of recursion levels when attempting to map
10791 variable names or debug temporaries to value expressions.  This trades
10792 compilation time for more complete debug information.  If this is set too
10793 low, value expressions that are available and could be represented in
10794 debug information may end up not being used; setting this higher may
10795 enable the compiler to find more complex debug expressions, but compile
10796 time and memory use may grow.  The default is 12.
10798 @item min-nondebug-insn-uid
10799 Use uids starting at this parameter for nondebug insns.  The range below
10800 the parameter is reserved exclusively for debug insns created by
10801 @option{-fvar-tracking-assignments}, but debug insns may get
10802 (non-overlapping) uids above it if the reserved range is exhausted.
10804 @item ipa-sra-ptr-growth-factor
10805 IPA-SRA replaces a pointer to an aggregate with one or more new
10806 parameters only when their cumulative size is less or equal to
10807 @option{ipa-sra-ptr-growth-factor} times the size of the original
10808 pointer parameter.
10810 @item sra-max-scalarization-size-Ospeed
10811 @item sra-max-scalarization-size-Osize
10812 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10813 replace scalar parts of aggregates with uses of independent scalar
10814 variables.  These parameters control the maximum size, in storage units,
10815 of aggregate which is considered for replacement when compiling for
10816 speed
10817 (@option{sra-max-scalarization-size-Ospeed}) or size
10818 (@option{sra-max-scalarization-size-Osize}) respectively.
10820 @item tm-max-aggregate-size
10821 When making copies of thread-local variables in a transaction, this
10822 parameter specifies the size in bytes after which variables are
10823 saved with the logging functions as opposed to save/restore code
10824 sequence pairs.  This option only applies when using
10825 @option{-fgnu-tm}.
10827 @item graphite-max-nb-scop-params
10828 To avoid exponential effects in the Graphite loop transforms, the
10829 number of parameters in a Static Control Part (SCoP) is bounded.  The
10830 default value is 10 parameters.  A variable whose value is unknown at
10831 compilation time and defined outside a SCoP is a parameter of the SCoP.
10833 @item graphite-max-bbs-per-function
10834 To avoid exponential effects in the detection of SCoPs, the size of
10835 the functions analyzed by Graphite is bounded.  The default value is
10836 100 basic blocks.
10838 @item loop-block-tile-size
10839 Loop blocking or strip mining transforms, enabled with
10840 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10841 loop in the loop nest by a given number of iterations.  The strip
10842 length can be changed using the @option{loop-block-tile-size}
10843 parameter.  The default value is 51 iterations.
10845 @item loop-unroll-jam-size
10846 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10847 default value is 4.
10849 @item loop-unroll-jam-depth
10850 Specify the dimension to be unrolled (counting from the most inner loop)
10851 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10853 @item ipa-cp-value-list-size
10854 IPA-CP attempts to track all possible values and types passed to a function's
10855 parameter in order to propagate them and perform devirtualization.
10856 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10857 stores per one formal parameter of a function.
10859 @item ipa-cp-eval-threshold
10860 IPA-CP calculates its own score of cloning profitability heuristics
10861 and performs those cloning opportunities with scores that exceed
10862 @option{ipa-cp-eval-threshold}.
10864 @item ipa-cp-recursion-penalty
10865 Percentage penalty the recursive functions will receive when they
10866 are evaluated for cloning.
10868 @item ipa-cp-single-call-penalty
10869 Percentage penalty functions containg a single call to another
10870 function will receive when they are evaluated for cloning.
10873 @item ipa-max-agg-items
10874 IPA-CP is also capable to propagate a number of scalar values passed
10875 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10876 number of such values per one parameter.
10878 @item ipa-cp-loop-hint-bonus
10879 When IPA-CP determines that a cloning candidate would make the number
10880 of iterations of a loop known, it adds a bonus of
10881 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10882 the candidate.
10884 @item ipa-cp-array-index-hint-bonus
10885 When IPA-CP determines that a cloning candidate would make the index of
10886 an array access known, it adds a bonus of
10887 @option{ipa-cp-array-index-hint-bonus} to the profitability
10888 score of the candidate.
10890 @item ipa-max-aa-steps
10891 During its analysis of function bodies, IPA-CP employs alias analysis
10892 in order to track values pointed to by function parameters.  In order
10893 not spend too much time analyzing huge functions, it gives up and
10894 consider all memory clobbered after examining
10895 @option{ipa-max-aa-steps} statements modifying memory.
10897 @item lto-partitions
10898 Specify desired number of partitions produced during WHOPR compilation.
10899 The number of partitions should exceed the number of CPUs used for compilation.
10900 The default value is 32.
10902 @item lto-minpartition
10903 Size of minimal partition for WHOPR (in estimated instructions).
10904 This prevents expenses of splitting very small programs into too many
10905 partitions.
10907 @item cxx-max-namespaces-for-diagnostic-help
10908 The maximum number of namespaces to consult for suggestions when C++
10909 name lookup fails for an identifier.  The default is 1000.
10911 @item sink-frequency-threshold
10912 The maximum relative execution frequency (in percents) of the target block
10913 relative to a statement's original block to allow statement sinking of a
10914 statement.  Larger numbers result in more aggressive statement sinking.
10915 The default value is 75.  A small positive adjustment is applied for
10916 statements with memory operands as those are even more profitable so sink.
10918 @item max-stores-to-sink
10919 The maximum number of conditional stores paires that can be sunk.  Set to 0
10920 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10921 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10923 @item allow-store-data-races
10924 Allow optimizers to introduce new data races on stores.
10925 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10926 at optimization level @option{-Ofast}.
10928 @item case-values-threshold
10929 The smallest number of different values for which it is best to use a
10930 jump-table instead of a tree of conditional branches.  If the value is
10931 0, use the default for the machine.  The default is 0.
10933 @item tree-reassoc-width
10934 Set the maximum number of instructions executed in parallel in
10935 reassociated tree. This parameter overrides target dependent
10936 heuristics used by default if has non zero value.
10938 @item sched-pressure-algorithm
10939 Choose between the two available implementations of
10940 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10941 and is the more likely to prevent instructions from being reordered.
10942 Algorithm 2 was designed to be a compromise between the relatively
10943 conservative approach taken by algorithm 1 and the rather aggressive
10944 approach taken by the default scheduler.  It relies more heavily on
10945 having a regular register file and accurate register pressure classes.
10946 See @file{haifa-sched.c} in the GCC sources for more details.
10948 The default choice depends on the target.
10950 @item max-slsr-cand-scan
10951 Set the maximum number of existing candidates that are considered when
10952 seeking a basis for a new straight-line strength reduction candidate.
10954 @item asan-globals
10955 Enable buffer overflow detection for global objects.  This kind
10956 of protection is enabled by default if you are using
10957 @option{-fsanitize=address} option.
10958 To disable global objects protection use @option{--param asan-globals=0}.
10960 @item asan-stack
10961 Enable buffer overflow detection for stack objects.  This kind of
10962 protection is enabled by default when using@option{-fsanitize=address}.
10963 To disable stack protection use @option{--param asan-stack=0} option.
10965 @item asan-instrument-reads
10966 Enable buffer overflow detection for memory reads.  This kind of
10967 protection is enabled by default when using @option{-fsanitize=address}.
10968 To disable memory reads protection use
10969 @option{--param asan-instrument-reads=0}.
10971 @item asan-instrument-writes
10972 Enable buffer overflow detection for memory writes.  This kind of
10973 protection is enabled by default when using @option{-fsanitize=address}.
10974 To disable memory writes protection use
10975 @option{--param asan-instrument-writes=0} option.
10977 @item asan-memintrin
10978 Enable detection for built-in functions.  This kind of protection
10979 is enabled by default when using @option{-fsanitize=address}.
10980 To disable built-in functions protection use
10981 @option{--param asan-memintrin=0}.
10983 @item asan-use-after-return
10984 Enable detection of use-after-return.  This kind of protection
10985 is enabled by default when using @option{-fsanitize=address} option.
10986 To disable use-after-return detection use 
10987 @option{--param asan-use-after-return=0}.
10989 @item asan-instrumentation-with-call-threshold
10990 If number of memory accesses in function being instrumented
10991 is greater or equal to this number, use callbacks instead of inline checks.
10992 E.g. to disable inline code use
10993 @option{--param asan-instrumentation-with-call-threshold=0}.
10995 @item chkp-max-ctor-size
10996 Static constructors generated by Pointer Bounds Checker may become very
10997 large and significantly increase compile time at optimization level
10998 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10999 in a single generated constructor.  Default value is 5000.
11001 @item max-fsm-thread-path-insns
11002 Maximum number of instructions to copy when duplicating blocks on a
11003 finite state automaton jump thread path.  The default is 100.
11005 @item max-fsm-thread-length
11006 Maximum number of basic blocks on a finite state automaton jump thread
11007 path.  The default is 10.
11009 @item max-fsm-thread-paths
11010 Maximum number of new jump thread paths to create for a finite state
11011 automaton.  The default is 50.
11013 @end table
11014 @end table
11016 @node Preprocessor Options
11017 @section Options Controlling the Preprocessor
11018 @cindex preprocessor options
11019 @cindex options, preprocessor
11021 These options control the C preprocessor, which is run on each C source
11022 file before actual compilation.
11024 If you use the @option{-E} option, nothing is done except preprocessing.
11025 Some of these options make sense only together with @option{-E} because
11026 they cause the preprocessor output to be unsuitable for actual
11027 compilation.
11029 @table @gcctabopt
11030 @item -Wp,@var{option}
11031 @opindex Wp
11032 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11033 and pass @var{option} directly through to the preprocessor.  If
11034 @var{option} contains commas, it is split into multiple options at the
11035 commas.  However, many options are modified, translated or interpreted
11036 by the compiler driver before being passed to the preprocessor, and
11037 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11038 interface is undocumented and subject to change, so whenever possible
11039 you should avoid using @option{-Wp} and let the driver handle the
11040 options instead.
11042 @item -Xpreprocessor @var{option}
11043 @opindex Xpreprocessor
11044 Pass @var{option} as an option to the preprocessor.  You can use this to
11045 supply system-specific preprocessor options that GCC does not 
11046 recognize.
11048 If you want to pass an option that takes an argument, you must use
11049 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11051 @item -no-integrated-cpp
11052 @opindex no-integrated-cpp
11053 Perform preprocessing as a separate pass before compilation.
11054 By default, GCC performs preprocessing as an integrated part of
11055 input tokenization and parsing.
11056 If this option is provided, the appropriate language front end
11057 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11058 and Objective-C, respectively) is instead invoked twice,
11059 once for preprocessing only and once for actual compilation
11060 of the preprocessed input.
11061 This option may be useful in conjunction with the @option{-B} or
11062 @option{-wrapper} options to specify an alternate preprocessor or
11063 perform additional processing of the program source between
11064 normal preprocessing and compilation.
11065 @end table
11067 @include cppopts.texi
11069 @node Assembler Options
11070 @section Passing Options to the Assembler
11072 @c prevent bad page break with this line
11073 You can pass options to the assembler.
11075 @table @gcctabopt
11076 @item -Wa,@var{option}
11077 @opindex Wa
11078 Pass @var{option} as an option to the assembler.  If @var{option}
11079 contains commas, it is split into multiple options at the commas.
11081 @item -Xassembler @var{option}
11082 @opindex Xassembler
11083 Pass @var{option} as an option to the assembler.  You can use this to
11084 supply system-specific assembler options that GCC does not
11085 recognize.
11087 If you want to pass an option that takes an argument, you must use
11088 @option{-Xassembler} twice, once for the option and once for the argument.
11090 @end table
11092 @node Link Options
11093 @section Options for Linking
11094 @cindex link options
11095 @cindex options, linking
11097 These options come into play when the compiler links object files into
11098 an executable output file.  They are meaningless if the compiler is
11099 not doing a link step.
11101 @table @gcctabopt
11102 @cindex file names
11103 @item @var{object-file-name}
11104 A file name that does not end in a special recognized suffix is
11105 considered to name an object file or library.  (Object files are
11106 distinguished from libraries by the linker according to the file
11107 contents.)  If linking is done, these object files are used as input
11108 to the linker.
11110 @item -c
11111 @itemx -S
11112 @itemx -E
11113 @opindex c
11114 @opindex S
11115 @opindex E
11116 If any of these options is used, then the linker is not run, and
11117 object file names should not be used as arguments.  @xref{Overall
11118 Options}.
11120 @item -fuse-ld=bfd
11121 @opindex fuse-ld=bfd
11122 Use the @command{bfd} linker instead of the default linker.
11124 @item -fuse-ld=gold
11125 @opindex fuse-ld=gold
11126 Use the @command{gold} linker instead of the default linker.
11128 @cindex Libraries
11129 @item -l@var{library}
11130 @itemx -l @var{library}
11131 @opindex l
11132 Search the library named @var{library} when linking.  (The second
11133 alternative with the library as a separate argument is only for
11134 POSIX compliance and is not recommended.)
11136 It makes a difference where in the command you write this option; the
11137 linker searches and processes libraries and object files in the order they
11138 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11139 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11140 to functions in @samp{z}, those functions may not be loaded.
11142 The linker searches a standard list of directories for the library,
11143 which is actually a file named @file{lib@var{library}.a}.  The linker
11144 then uses this file as if it had been specified precisely by name.
11146 The directories searched include several standard system directories
11147 plus any that you specify with @option{-L}.
11149 Normally the files found this way are library files---archive files
11150 whose members are object files.  The linker handles an archive file by
11151 scanning through it for members which define symbols that have so far
11152 been referenced but not defined.  But if the file that is found is an
11153 ordinary object file, it is linked in the usual fashion.  The only
11154 difference between using an @option{-l} option and specifying a file name
11155 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11156 and searches several directories.
11158 @item -lobjc
11159 @opindex lobjc
11160 You need this special case of the @option{-l} option in order to
11161 link an Objective-C or Objective-C++ program.
11163 @item -nostartfiles
11164 @opindex nostartfiles
11165 Do not use the standard system startup files when linking.
11166 The standard system libraries are used normally, unless @option{-nostdlib}
11167 or @option{-nodefaultlibs} is used.
11169 @item -nodefaultlibs
11170 @opindex nodefaultlibs
11171 Do not use the standard system libraries when linking.
11172 Only the libraries you specify are passed to the linker, and options
11173 specifying linkage of the system libraries, such as @option{-static-libgcc}
11174 or @option{-shared-libgcc}, are ignored.  
11175 The standard startup files are used normally, unless @option{-nostartfiles}
11176 is used.  
11178 The compiler may generate calls to @code{memcmp},
11179 @code{memset}, @code{memcpy} and @code{memmove}.
11180 These entries are usually resolved by entries in
11181 libc.  These entry points should be supplied through some other
11182 mechanism when this option is specified.
11184 @item -nostdlib
11185 @opindex nostdlib
11186 Do not use the standard system startup files or libraries when linking.
11187 No startup files and only the libraries you specify are passed to
11188 the linker, and options specifying linkage of the system libraries, such as
11189 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11191 The compiler may generate calls to @code{memcmp}, @code{memset},
11192 @code{memcpy} and @code{memmove}.
11193 These entries are usually resolved by entries in
11194 libc.  These entry points should be supplied through some other
11195 mechanism when this option is specified.
11197 @cindex @option{-lgcc}, use with @option{-nostdlib}
11198 @cindex @option{-nostdlib} and unresolved references
11199 @cindex unresolved references and @option{-nostdlib}
11200 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11201 @cindex @option{-nodefaultlibs} and unresolved references
11202 @cindex unresolved references and @option{-nodefaultlibs}
11203 One of the standard libraries bypassed by @option{-nostdlib} and
11204 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11205 which GCC uses to overcome shortcomings of particular machines, or special
11206 needs for some languages.
11207 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11208 Collection (GCC) Internals},
11209 for more discussion of @file{libgcc.a}.)
11210 In most cases, you need @file{libgcc.a} even when you want to avoid
11211 other standard libraries.  In other words, when you specify @option{-nostdlib}
11212 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11213 This ensures that you have no unresolved references to internal GCC
11214 library subroutines.
11215 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11216 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11217 GNU Compiler Collection (GCC) Internals}.)
11219 @item -pie
11220 @opindex pie
11221 Produce a position independent executable on targets that support it.
11222 For predictable results, you must also specify the same set of options
11223 used for compilation (@option{-fpie}, @option{-fPIE},
11224 or model suboptions) when you specify this linker option.
11226 @item -rdynamic
11227 @opindex rdynamic
11228 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11229 that support it. This instructs the linker to add all symbols, not
11230 only used ones, to the dynamic symbol table. This option is needed
11231 for some uses of @code{dlopen} or to allow obtaining backtraces
11232 from within a program.
11234 @item -s
11235 @opindex s
11236 Remove all symbol table and relocation information from the executable.
11238 @item -static
11239 @opindex static
11240 On systems that support dynamic linking, this prevents linking with the shared
11241 libraries.  On other systems, this option has no effect.
11243 @item -shared
11244 @opindex shared
11245 Produce a shared object which can then be linked with other objects to
11246 form an executable.  Not all systems support this option.  For predictable
11247 results, you must also specify the same set of options used for compilation
11248 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11249 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11250 needs to build supplementary stub code for constructors to work.  On
11251 multi-libbed systems, @samp{gcc -shared} must select the correct support
11252 libraries to link against.  Failing to supply the correct flags may lead
11253 to subtle defects.  Supplying them in cases where they are not necessary
11254 is innocuous.}
11256 @item -shared-libgcc
11257 @itemx -static-libgcc
11258 @opindex shared-libgcc
11259 @opindex static-libgcc
11260 On systems that provide @file{libgcc} as a shared library, these options
11261 force the use of either the shared or static version, respectively.
11262 If no shared version of @file{libgcc} was built when the compiler was
11263 configured, these options have no effect.
11265 There are several situations in which an application should use the
11266 shared @file{libgcc} instead of the static version.  The most common
11267 of these is when the application wishes to throw and catch exceptions
11268 across different shared libraries.  In that case, each of the libraries
11269 as well as the application itself should use the shared @file{libgcc}.
11271 Therefore, the G++ and GCJ drivers automatically add
11272 @option{-shared-libgcc} whenever you build a shared library or a main
11273 executable, because C++ and Java programs typically use exceptions, so
11274 this is the right thing to do.
11276 If, instead, you use the GCC driver to create shared libraries, you may
11277 find that they are not always linked with the shared @file{libgcc}.
11278 If GCC finds, at its configuration time, that you have a non-GNU linker
11279 or a GNU linker that does not support option @option{--eh-frame-hdr},
11280 it links the shared version of @file{libgcc} into shared libraries
11281 by default.  Otherwise, it takes advantage of the linker and optimizes
11282 away the linking with the shared version of @file{libgcc}, linking with
11283 the static version of libgcc by default.  This allows exceptions to
11284 propagate through such shared libraries, without incurring relocation
11285 costs at library load time.
11287 However, if a library or main executable is supposed to throw or catch
11288 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11289 for the languages used in the program, or using the option
11290 @option{-shared-libgcc}, such that it is linked with the shared
11291 @file{libgcc}.
11293 @item -static-libasan
11294 @opindex static-libasan
11295 When the @option{-fsanitize=address} option is used to link a program,
11296 the GCC driver automatically links against @option{libasan}.  If
11297 @file{libasan} is available as a shared library, and the @option{-static}
11298 option is not used, then this links against the shared version of
11299 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11300 driver to link @file{libasan} statically, without necessarily linking
11301 other libraries statically.
11303 @item -static-libtsan
11304 @opindex static-libtsan
11305 When the @option{-fsanitize=thread} option is used to link a program,
11306 the GCC driver automatically links against @option{libtsan}.  If
11307 @file{libtsan} is available as a shared library, and the @option{-static}
11308 option is not used, then this links against the shared version of
11309 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11310 driver to link @file{libtsan} statically, without necessarily linking
11311 other libraries statically.
11313 @item -static-liblsan
11314 @opindex static-liblsan
11315 When the @option{-fsanitize=leak} option is used to link a program,
11316 the GCC driver automatically links against @option{liblsan}.  If
11317 @file{liblsan} is available as a shared library, and the @option{-static}
11318 option is not used, then this links against the shared version of
11319 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11320 driver to link @file{liblsan} statically, without necessarily linking
11321 other libraries statically.
11323 @item -static-libubsan
11324 @opindex static-libubsan
11325 When the @option{-fsanitize=undefined} option is used to link a program,
11326 the GCC driver automatically links against @option{libubsan}.  If
11327 @file{libubsan} is available as a shared library, and the @option{-static}
11328 option is not used, then this links against the shared version of
11329 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11330 driver to link @file{libubsan} statically, without necessarily linking
11331 other libraries statically.
11333 @item -static-libmpx
11334 @opindex static-libmpx
11335 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11336 used to link a program, the GCC driver automatically links against
11337 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11338 and the @option{-static} option is not used, then this links against
11339 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11340 option directs the GCC driver to link @file{libmpx} statically,
11341 without necessarily linking other libraries statically.
11343 @item -static-libmpxwrappers
11344 @opindex static-libmpxwrappers
11345 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11346 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11347 GCC driver automatically links against @file{libmpxwrappers}.  If
11348 @file{libmpxwrappers} is available as a shared library, and the
11349 @option{-static} option is not used, then this links against the shared
11350 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11351 option directs the GCC driver to link @file{libmpxwrappers} statically,
11352 without necessarily linking other libraries statically.
11354 @item -static-libstdc++
11355 @opindex static-libstdc++
11356 When the @command{g++} program is used to link a C++ program, it
11357 normally automatically links against @option{libstdc++}.  If
11358 @file{libstdc++} is available as a shared library, and the
11359 @option{-static} option is not used, then this links against the
11360 shared version of @file{libstdc++}.  That is normally fine.  However, it
11361 is sometimes useful to freeze the version of @file{libstdc++} used by
11362 the program without going all the way to a fully static link.  The
11363 @option{-static-libstdc++} option directs the @command{g++} driver to
11364 link @file{libstdc++} statically, without necessarily linking other
11365 libraries statically.
11367 @item -symbolic
11368 @opindex symbolic
11369 Bind references to global symbols when building a shared object.  Warn
11370 about any unresolved references (unless overridden by the link editor
11371 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11372 this option.
11374 @item -T @var{script}
11375 @opindex T
11376 @cindex linker script
11377 Use @var{script} as the linker script.  This option is supported by most
11378 systems using the GNU linker.  On some targets, such as bare-board
11379 targets without an operating system, the @option{-T} option may be required
11380 when linking to avoid references to undefined symbols.
11382 @item -Xlinker @var{option}
11383 @opindex Xlinker
11384 Pass @var{option} as an option to the linker.  You can use this to
11385 supply system-specific linker options that GCC does not recognize.
11387 If you want to pass an option that takes a separate argument, you must use
11388 @option{-Xlinker} twice, once for the option and once for the argument.
11389 For example, to pass @option{-assert definitions}, you must write
11390 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11391 @option{-Xlinker "-assert definitions"}, because this passes the entire
11392 string as a single argument, which is not what the linker expects.
11394 When using the GNU linker, it is usually more convenient to pass
11395 arguments to linker options using the @option{@var{option}=@var{value}}
11396 syntax than as separate arguments.  For example, you can specify
11397 @option{-Xlinker -Map=output.map} rather than
11398 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11399 this syntax for command-line options.
11401 @item -Wl,@var{option}
11402 @opindex Wl
11403 Pass @var{option} as an option to the linker.  If @var{option} contains
11404 commas, it is split into multiple options at the commas.  You can use this
11405 syntax to pass an argument to the option.
11406 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11407 linker.  When using the GNU linker, you can also get the same effect with
11408 @option{-Wl,-Map=output.map}.
11410 @item -u @var{symbol}
11411 @opindex u
11412 Pretend the symbol @var{symbol} is undefined, to force linking of
11413 library modules to define it.  You can use @option{-u} multiple times with
11414 different symbols to force loading of additional library modules.
11416 @item -z @var{keyword}
11417 @opindex z
11418 @option{-z} is passed directly on to the linker along with the keyword
11419 @var{keyword}. See the section in the documentation of your linker for
11420 permitted values and their meanings.
11421 @end table
11423 @node Directory Options
11424 @section Options for Directory Search
11425 @cindex directory options
11426 @cindex options, directory search
11427 @cindex search path
11429 These options specify directories to search for header files, for
11430 libraries and for parts of the compiler:
11432 @table @gcctabopt
11433 @item -I@var{dir}
11434 @opindex I
11435 Add the directory @var{dir} to the head of the list of directories to be
11436 searched for header files.  This can be used to override a system header
11437 file, substituting your own version, since these directories are
11438 searched before the system header file directories.  However, you should
11439 not use this option to add directories that contain vendor-supplied
11440 system header files (use @option{-isystem} for that).  If you use more than
11441 one @option{-I} option, the directories are scanned in left-to-right
11442 order; the standard system directories come after.
11444 If a standard system include directory, or a directory specified with
11445 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11446 option is ignored.  The directory is still searched but as a
11447 system directory at its normal position in the system include chain.
11448 This is to ensure that GCC's procedure to fix buggy system headers and
11449 the ordering for the @code{include_next} directive are not inadvertently changed.
11450 If you really need to change the search order for system directories,
11451 use the @option{-nostdinc} and/or @option{-isystem} options.
11453 @item -iplugindir=@var{dir}
11454 @opindex iplugindir=
11455 Set the directory to search for plugins that are passed
11456 by @option{-fplugin=@var{name}} instead of
11457 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11458 to be used by the user, but only passed by the driver.
11460 @item -iquote@var{dir}
11461 @opindex iquote
11462 Add the directory @var{dir} to the head of the list of directories to
11463 be searched for header files only for the case of @code{#include
11464 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11465 otherwise just like @option{-I}.
11467 @item -L@var{dir}
11468 @opindex L
11469 Add directory @var{dir} to the list of directories to be searched
11470 for @option{-l}.
11472 @item -B@var{prefix}
11473 @opindex B
11474 This option specifies where to find the executables, libraries,
11475 include files, and data files of the compiler itself.
11477 The compiler driver program runs one or more of the subprograms
11478 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11479 @var{prefix} as a prefix for each program it tries to run, both with and
11480 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11482 For each subprogram to be run, the compiler driver first tries the
11483 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11484 is not specified, the driver tries two standard prefixes, 
11485 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11486 those results in a file name that is found, the unmodified program
11487 name is searched for using the directories specified in your
11488 @env{PATH} environment variable.
11490 The compiler checks to see if the path provided by @option{-B}
11491 refers to a directory, and if necessary it adds a directory
11492 separator character at the end of the path.
11494 @option{-B} prefixes that effectively specify directory names also apply
11495 to libraries in the linker, because the compiler translates these
11496 options into @option{-L} options for the linker.  They also apply to
11497 include files in the preprocessor, because the compiler translates these
11498 options into @option{-isystem} options for the preprocessor.  In this case,
11499 the compiler appends @samp{include} to the prefix.
11501 The runtime support file @file{libgcc.a} can also be searched for using
11502 the @option{-B} prefix, if needed.  If it is not found there, the two
11503 standard prefixes above are tried, and that is all.  The file is left
11504 out of the link if it is not found by those means.
11506 Another way to specify a prefix much like the @option{-B} prefix is to use
11507 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11508 Variables}.
11510 As a special kludge, if the path provided by @option{-B} is
11511 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11512 9, then it is replaced by @file{[dir/]include}.  This is to help
11513 with boot-strapping the compiler.
11515 @item -specs=@var{file}
11516 @opindex specs
11517 Process @var{file} after the compiler reads in the standard @file{specs}
11518 file, in order to override the defaults which the @command{gcc} driver
11519 program uses when determining what switches to pass to @command{cc1},
11520 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11521 @option{-specs=@var{file}} can be specified on the command line, and they
11522 are processed in order, from left to right.
11524 @item --sysroot=@var{dir}
11525 @opindex sysroot
11526 Use @var{dir} as the logical root directory for headers and libraries.
11527 For example, if the compiler normally searches for headers in
11528 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11529 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11531 If you use both this option and the @option{-isysroot} option, then
11532 the @option{--sysroot} option applies to libraries, but the
11533 @option{-isysroot} option applies to header files.
11535 The GNU linker (beginning with version 2.16) has the necessary support
11536 for this option.  If your linker does not support this option, the
11537 header file aspect of @option{--sysroot} still works, but the
11538 library aspect does not.
11540 @item --no-sysroot-suffix
11541 @opindex no-sysroot-suffix
11542 For some targets, a suffix is added to the root directory specified
11543 with @option{--sysroot}, depending on the other options used, so that
11544 headers may for example be found in
11545 @file{@var{dir}/@var{suffix}/usr/include} instead of
11546 @file{@var{dir}/usr/include}.  This option disables the addition of
11547 such a suffix.
11549 @item -I-
11550 @opindex I-
11551 This option has been deprecated.  Please use @option{-iquote} instead for
11552 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11553 option.
11554 Any directories you specify with @option{-I} options before the @option{-I-}
11555 option are searched only for the case of @code{#include "@var{file}"};
11556 they are not searched for @code{#include <@var{file}>}.
11558 If additional directories are specified with @option{-I} options after
11559 the @option{-I-} option, these directories are searched for all @code{#include}
11560 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11561 this way.)
11563 In addition, the @option{-I-} option inhibits the use of the current
11564 directory (where the current input file came from) as the first search
11565 directory for @code{#include "@var{file}"}.  There is no way to
11566 override this effect of @option{-I-}.  With @option{-I.} you can specify
11567 searching the directory that is current when the compiler is
11568 invoked.  That is not exactly the same as what the preprocessor does
11569 by default, but it is often satisfactory.
11571 @option{-I-} does not inhibit the use of the standard system directories
11572 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11573 independent.
11574 @end table
11576 @c man end
11578 @node Spec Files
11579 @section Specifying Subprocesses and the Switches to Pass to Them
11580 @cindex Spec Files
11582 @command{gcc} is a driver program.  It performs its job by invoking a
11583 sequence of other programs to do the work of compiling, assembling and
11584 linking.  GCC interprets its command-line parameters and uses these to
11585 deduce which programs it should invoke, and which command-line options
11586 it ought to place on their command lines.  This behavior is controlled
11587 by @dfn{spec strings}.  In most cases there is one spec string for each
11588 program that GCC can invoke, but a few programs have multiple spec
11589 strings to control their behavior.  The spec strings built into GCC can
11590 be overridden by using the @option{-specs=} command-line switch to specify
11591 a spec file.
11593 @dfn{Spec files} are plaintext files that are used to construct spec
11594 strings.  They consist of a sequence of directives separated by blank
11595 lines.  The type of directive is determined by the first non-whitespace
11596 character on the line, which can be one of the following:
11598 @table @code
11599 @item %@var{command}
11600 Issues a @var{command} to the spec file processor.  The commands that can
11601 appear here are:
11603 @table @code
11604 @item %include <@var{file}>
11605 @cindex @code{%include}
11606 Search for @var{file} and insert its text at the current point in the
11607 specs file.
11609 @item %include_noerr <@var{file}>
11610 @cindex @code{%include_noerr}
11611 Just like @samp{%include}, but do not generate an error message if the include
11612 file cannot be found.
11614 @item %rename @var{old_name} @var{new_name}
11615 @cindex @code{%rename}
11616 Rename the spec string @var{old_name} to @var{new_name}.
11618 @end table
11620 @item *[@var{spec_name}]:
11621 This tells the compiler to create, override or delete the named spec
11622 string.  All lines after this directive up to the next directive or
11623 blank line are considered to be the text for the spec string.  If this
11624 results in an empty string then the spec is deleted.  (Or, if the
11625 spec did not exist, then nothing happens.)  Otherwise, if the spec
11626 does not currently exist a new spec is created.  If the spec does
11627 exist then its contents are overridden by the text of this
11628 directive, unless the first character of that text is the @samp{+}
11629 character, in which case the text is appended to the spec.
11631 @item [@var{suffix}]:
11632 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11633 and up to the next directive or blank line are considered to make up the
11634 spec string for the indicated suffix.  When the compiler encounters an
11635 input file with the named suffix, it processes the spec string in
11636 order to work out how to compile that file.  For example:
11638 @smallexample
11639 .ZZ:
11640 z-compile -input %i
11641 @end smallexample
11643 This says that any input file whose name ends in @samp{.ZZ} should be
11644 passed to the program @samp{z-compile}, which should be invoked with the
11645 command-line switch @option{-input} and with the result of performing the
11646 @samp{%i} substitution.  (See below.)
11648 As an alternative to providing a spec string, the text following a
11649 suffix directive can be one of the following:
11651 @table @code
11652 @item @@@var{language}
11653 This says that the suffix is an alias for a known @var{language}.  This is
11654 similar to using the @option{-x} command-line switch to GCC to specify a
11655 language explicitly.  For example:
11657 @smallexample
11658 .ZZ:
11659 @@c++
11660 @end smallexample
11662 Says that .ZZ files are, in fact, C++ source files.
11664 @item #@var{name}
11665 This causes an error messages saying:
11667 @smallexample
11668 @var{name} compiler not installed on this system.
11669 @end smallexample
11670 @end table
11672 GCC already has an extensive list of suffixes built into it.
11673 This directive adds an entry to the end of the list of suffixes, but
11674 since the list is searched from the end backwards, it is effectively
11675 possible to override earlier entries using this technique.
11677 @end table
11679 GCC has the following spec strings built into it.  Spec files can
11680 override these strings or create their own.  Note that individual
11681 targets can also add their own spec strings to this list.
11683 @smallexample
11684 asm          Options to pass to the assembler
11685 asm_final    Options to pass to the assembler post-processor
11686 cpp          Options to pass to the C preprocessor
11687 cc1          Options to pass to the C compiler
11688 cc1plus      Options to pass to the C++ compiler
11689 endfile      Object files to include at the end of the link
11690 link         Options to pass to the linker
11691 lib          Libraries to include on the command line to the linker
11692 libgcc       Decides which GCC support library to pass to the linker
11693 linker       Sets the name of the linker
11694 predefines   Defines to be passed to the C preprocessor
11695 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11696              by default
11697 startfile    Object files to include at the start of the link
11698 @end smallexample
11700 Here is a small example of a spec file:
11702 @smallexample
11703 %rename lib                 old_lib
11705 *lib:
11706 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11707 @end smallexample
11709 This example renames the spec called @samp{lib} to @samp{old_lib} and
11710 then overrides the previous definition of @samp{lib} with a new one.
11711 The new definition adds in some extra command-line options before
11712 including the text of the old definition.
11714 @dfn{Spec strings} are a list of command-line options to be passed to their
11715 corresponding program.  In addition, the spec strings can contain
11716 @samp{%}-prefixed sequences to substitute variable text or to
11717 conditionally insert text into the command line.  Using these constructs
11718 it is possible to generate quite complex command lines.
11720 Here is a table of all defined @samp{%}-sequences for spec
11721 strings.  Note that spaces are not generated automatically around the
11722 results of expanding these sequences.  Therefore you can concatenate them
11723 together or combine them with constant text in a single argument.
11725 @table @code
11726 @item %%
11727 Substitute one @samp{%} into the program name or argument.
11729 @item %i
11730 Substitute the name of the input file being processed.
11732 @item %b
11733 Substitute the basename of the input file being processed.
11734 This is the substring up to (and not including) the last period
11735 and not including the directory.
11737 @item %B
11738 This is the same as @samp{%b}, but include the file suffix (text after
11739 the last period).
11741 @item %d
11742 Marks the argument containing or following the @samp{%d} as a
11743 temporary file name, so that that file is deleted if GCC exits
11744 successfully.  Unlike @samp{%g}, this contributes no text to the
11745 argument.
11747 @item %g@var{suffix}
11748 Substitute a file name that has suffix @var{suffix} and is chosen
11749 once per compilation, and mark the argument in the same way as
11750 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11751 name is now chosen in a way that is hard to predict even when previously
11752 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11753 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11754 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11755 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11756 was simply substituted with a file name chosen once per compilation,
11757 without regard to any appended suffix (which was therefore treated
11758 just like ordinary text), making such attacks more likely to succeed.
11760 @item %u@var{suffix}
11761 Like @samp{%g}, but generates a new temporary file name
11762 each time it appears instead of once per compilation.
11764 @item %U@var{suffix}
11765 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11766 new one if there is no such last file name.  In the absence of any
11767 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11768 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11769 involves the generation of two distinct file names, one
11770 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11771 simply substituted with a file name chosen for the previous @samp{%u},
11772 without regard to any appended suffix.
11774 @item %j@var{suffix}
11775 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11776 writable, and if @option{-save-temps} is not used; 
11777 otherwise, substitute the name
11778 of a temporary file, just like @samp{%u}.  This temporary file is not
11779 meant for communication between processes, but rather as a junk
11780 disposal mechanism.
11782 @item %|@var{suffix}
11783 @itemx %m@var{suffix}
11784 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11785 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11786 all.  These are the two most common ways to instruct a program that it
11787 should read from standard input or write to standard output.  If you
11788 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11789 construct: see for example @file{f/lang-specs.h}.
11791 @item %.@var{SUFFIX}
11792 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11793 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11794 terminated by the next space or %.
11796 @item %w
11797 Marks the argument containing or following the @samp{%w} as the
11798 designated output file of this compilation.  This puts the argument
11799 into the sequence of arguments that @samp{%o} substitutes.
11801 @item %o
11802 Substitutes the names of all the output files, with spaces
11803 automatically placed around them.  You should write spaces
11804 around the @samp{%o} as well or the results are undefined.
11805 @samp{%o} is for use in the specs for running the linker.
11806 Input files whose names have no recognized suffix are not compiled
11807 at all, but they are included among the output files, so they are
11808 linked.
11810 @item %O
11811 Substitutes the suffix for object files.  Note that this is
11812 handled specially when it immediately follows @samp{%g, %u, or %U},
11813 because of the need for those to form complete file names.  The
11814 handling is such that @samp{%O} is treated exactly as if it had already
11815 been substituted, except that @samp{%g, %u, and %U} do not currently
11816 support additional @var{suffix} characters following @samp{%O} as they do
11817 following, for example, @samp{.o}.
11819 @item %p
11820 Substitutes the standard macro predefinitions for the
11821 current target machine.  Use this when running @command{cpp}.
11823 @item %P
11824 Like @samp{%p}, but puts @samp{__} before and after the name of each
11825 predefined macro, except for macros that start with @samp{__} or with
11826 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11829 @item %I
11830 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11831 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11832 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11833 and @option{-imultilib} as necessary.
11835 @item %s
11836 Current argument is the name of a library or startup file of some sort.
11837 Search for that file in a standard list of directories and substitute
11838 the full name found.  The current working directory is included in the
11839 list of directories scanned.
11841 @item %T
11842 Current argument is the name of a linker script.  Search for that file
11843 in the current list of directories to scan for libraries. If the file
11844 is located insert a @option{--script} option into the command line
11845 followed by the full path name found.  If the file is not found then
11846 generate an error message.  Note: the current working directory is not
11847 searched.
11849 @item %e@var{str}
11850 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11851 Use this when inconsistent options are detected.
11853 @item %(@var{name})
11854 Substitute the contents of spec string @var{name} at this point.
11856 @item %x@{@var{option}@}
11857 Accumulate an option for @samp{%X}.
11859 @item %X
11860 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11861 spec string.
11863 @item %Y
11864 Output the accumulated assembler options specified by @option{-Wa}.
11866 @item %Z
11867 Output the accumulated preprocessor options specified by @option{-Wp}.
11869 @item %a
11870 Process the @code{asm} spec.  This is used to compute the
11871 switches to be passed to the assembler.
11873 @item %A
11874 Process the @code{asm_final} spec.  This is a spec string for
11875 passing switches to an assembler post-processor, if such a program is
11876 needed.
11878 @item %l
11879 Process the @code{link} spec.  This is the spec for computing the
11880 command line passed to the linker.  Typically it makes use of the
11881 @samp{%L %G %S %D and %E} sequences.
11883 @item %D
11884 Dump out a @option{-L} option for each directory that GCC believes might
11885 contain startup files.  If the target supports multilibs then the
11886 current multilib directory is prepended to each of these paths.
11888 @item %L
11889 Process the @code{lib} spec.  This is a spec string for deciding which
11890 libraries are included on the command line to the linker.
11892 @item %G
11893 Process the @code{libgcc} spec.  This is a spec string for deciding
11894 which GCC support library is included on the command line to the linker.
11896 @item %S
11897 Process the @code{startfile} spec.  This is a spec for deciding which
11898 object files are the first ones passed to the linker.  Typically
11899 this might be a file named @file{crt0.o}.
11901 @item %E
11902 Process the @code{endfile} spec.  This is a spec string that specifies
11903 the last object files that are passed to the linker.
11905 @item %C
11906 Process the @code{cpp} spec.  This is used to construct the arguments
11907 to be passed to the C preprocessor.
11909 @item %1
11910 Process the @code{cc1} spec.  This is used to construct the options to be
11911 passed to the actual C compiler (@command{cc1}).
11913 @item %2
11914 Process the @code{cc1plus} spec.  This is used to construct the options to be
11915 passed to the actual C++ compiler (@command{cc1plus}).
11917 @item %*
11918 Substitute the variable part of a matched option.  See below.
11919 Note that each comma in the substituted string is replaced by
11920 a single space.
11922 @item %<@code{S}
11923 Remove all occurrences of @code{-S} from the command line.  Note---this
11924 command is position dependent.  @samp{%} commands in the spec string
11925 before this one see @code{-S}, @samp{%} commands in the spec string
11926 after this one do not.
11928 @item %:@var{function}(@var{args})
11929 Call the named function @var{function}, passing it @var{args}.
11930 @var{args} is first processed as a nested spec string, then split
11931 into an argument vector in the usual fashion.  The function returns
11932 a string which is processed as if it had appeared literally as part
11933 of the current spec.
11935 The following built-in spec functions are provided:
11937 @table @code
11938 @item @code{getenv}
11939 The @code{getenv} spec function takes two arguments: an environment
11940 variable name and a string.  If the environment variable is not
11941 defined, a fatal error is issued.  Otherwise, the return value is the
11942 value of the environment variable concatenated with the string.  For
11943 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11945 @smallexample
11946 %:getenv(TOPDIR /include)
11947 @end smallexample
11949 expands to @file{/path/to/top/include}.
11951 @item @code{if-exists}
11952 The @code{if-exists} spec function takes one argument, an absolute
11953 pathname to a file.  If the file exists, @code{if-exists} returns the
11954 pathname.  Here is a small example of its usage:
11956 @smallexample
11957 *startfile:
11958 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11959 @end smallexample
11961 @item @code{if-exists-else}
11962 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11963 spec function, except that it takes two arguments.  The first argument is
11964 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11965 returns the pathname.  If it does not exist, it returns the second argument.
11966 This way, @code{if-exists-else} can be used to select one file or another,
11967 based on the existence of the first.  Here is a small example of its usage:
11969 @smallexample
11970 *startfile:
11971 crt0%O%s %:if-exists(crti%O%s) \
11972 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11973 @end smallexample
11975 @item @code{replace-outfile}
11976 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11977 first argument in the outfiles array and replaces it with the second argument.  Here
11978 is a small example of its usage:
11980 @smallexample
11981 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11982 @end smallexample
11984 @item @code{remove-outfile}
11985 The @code{remove-outfile} spec function takes one argument.  It looks for the
11986 first argument in the outfiles array and removes it.  Here is a small example
11987 its usage:
11989 @smallexample
11990 %:remove-outfile(-lm)
11991 @end smallexample
11993 @item @code{pass-through-libs}
11994 The @code{pass-through-libs} spec function takes any number of arguments.  It
11995 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11996 assumes are the names of linker input library archive files) and returns a
11997 result containing all the found arguments each prepended by
11998 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11999 intended to be passed to the LTO linker plugin.
12001 @smallexample
12002 %:pass-through-libs(%G %L %G)
12003 @end smallexample
12005 @item @code{print-asm-header}
12006 The @code{print-asm-header} function takes no arguments and simply
12007 prints a banner like:
12009 @smallexample
12010 Assembler options
12011 =================
12013 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
12014 @end smallexample
12016 It is used to separate compiler options from assembler options
12017 in the @option{--target-help} output.
12018 @end table
12020 @item %@{@code{S}@}
12021 Substitutes the @code{-S} switch, if that switch is given to GCC@.
12022 If that switch is not specified, this substitutes nothing.  Note that
12023 the leading dash is omitted when specifying this option, and it is
12024 automatically inserted if the substitution is performed.  Thus the spec
12025 string @samp{%@{foo@}} matches the command-line option @option{-foo}
12026 and outputs the command-line option @option{-foo}.
12028 @item %W@{@code{S}@}
12029 Like %@{@code{S}@} but mark last argument supplied within as a file to be
12030 deleted on failure.
12032 @item %@{@code{S}*@}
12033 Substitutes all the switches specified to GCC whose names start
12034 with @code{-S}, but which also take an argument.  This is used for
12035 switches like @option{-o}, @option{-D}, @option{-I}, etc.
12036 GCC considers @option{-o foo} as being
12037 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
12038 text, including the space.  Thus two arguments are generated.
12040 @item %@{@code{S}*&@code{T}*@}
12041 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
12042 (the order of @code{S} and @code{T} in the spec is not significant).
12043 There can be any number of ampersand-separated variables; for each the
12044 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
12046 @item %@{@code{S}:@code{X}@}
12047 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
12049 @item %@{!@code{S}:@code{X}@}
12050 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
12052 @item %@{@code{S}*:@code{X}@}
12053 Substitutes @code{X} if one or more switches whose names start with
12054 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
12055 once, no matter how many such switches appeared.  However, if @code{%*}
12056 appears somewhere in @code{X}, then @code{X} is substituted once
12057 for each matching switch, with the @code{%*} replaced by the part of
12058 that switch matching the @code{*}.
12060 If @code{%*} appears as the last part of a spec sequence then a space
12061 is added after the end of the last substitution.  If there is more
12062 text in the sequence, however, then a space is not generated.  This
12063 allows the @code{%*} substitution to be used as part of a larger
12064 string.  For example, a spec string like this:
12066 @smallexample
12067 %@{mcu=*:--script=%*/memory.ld@}
12068 @end smallexample
12070 @noindent
12071 when matching an option like @option{-mcu=newchip} produces:
12073 @smallexample
12074 --script=newchip/memory.ld
12075 @end smallexample
12077 @item %@{.@code{S}:@code{X}@}
12078 Substitutes @code{X}, if processing a file with suffix @code{S}.
12080 @item %@{!.@code{S}:@code{X}@}
12081 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
12083 @item %@{,@code{S}:@code{X}@}
12084 Substitutes @code{X}, if processing a file for language @code{S}.
12086 @item %@{!,@code{S}:@code{X}@}
12087 Substitutes @code{X}, if not processing a file for language @code{S}.
12089 @item %@{@code{S}|@code{P}:@code{X}@}
12090 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
12091 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
12092 @code{*} sequences as well, although they have a stronger binding than
12093 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
12094 alternatives must be starred, and only the first matching alternative
12095 is substituted.
12097 For example, a spec string like this:
12099 @smallexample
12100 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
12101 @end smallexample
12103 @noindent
12104 outputs the following command-line options from the following input
12105 command-line options:
12107 @smallexample
12108 fred.c        -foo -baz
12109 jim.d         -bar -boggle
12110 -d fred.c     -foo -baz -boggle
12111 -d jim.d      -bar -baz -boggle
12112 @end smallexample
12114 @item %@{S:X; T:Y; :D@}
12116 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
12117 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
12118 be as many clauses as you need.  This may be combined with @code{.},
12119 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
12122 @end table
12124 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
12125 construct may contain other nested @samp{%} constructs or spaces, or
12126 even newlines.  They are processed as usual, as described above.
12127 Trailing white space in @code{X} is ignored.  White space may also
12128 appear anywhere on the left side of the colon in these constructs,
12129 except between @code{.} or @code{*} and the corresponding word.
12131 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
12132 handled specifically in these constructs.  If another value of
12133 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
12134 @option{-W} switch is found later in the command line, the earlier
12135 switch value is ignored, except with @{@code{S}*@} where @code{S} is
12136 just one letter, which passes all matching options.
12138 The character @samp{|} at the beginning of the predicate text is used to
12139 indicate that a command should be piped to the following command, but
12140 only if @option{-pipe} is specified.
12142 It is built into GCC which switches take arguments and which do not.
12143 (You might think it would be useful to generalize this to allow each
12144 compiler's spec to say which switches take arguments.  But this cannot
12145 be done in a consistent fashion.  GCC cannot even decide which input
12146 files have been specified without knowing which switches take arguments,
12147 and it must know which input files to compile in order to tell which
12148 compilers to run).
12150 GCC also knows implicitly that arguments starting in @option{-l} are to be
12151 treated as compiler output files, and passed to the linker in their
12152 proper position among the other output files.
12154 @c man begin OPTIONS
12156 @node Target Options
12157 @section Specifying Target Machine and Compiler Version
12158 @cindex target options
12159 @cindex cross compiling
12160 @cindex specifying machine version
12161 @cindex specifying compiler version and target machine
12162 @cindex compiler version, specifying
12163 @cindex target machine, specifying
12165 The usual way to run GCC is to run the executable called @command{gcc}, or
12166 @command{@var{machine}-gcc} when cross-compiling, or
12167 @command{@var{machine}-gcc-@var{version}} to run a version other than the
12168 one that was installed last.
12170 @node Submodel Options
12171 @section Hardware Models and Configurations
12172 @cindex submodel options
12173 @cindex specifying hardware config
12174 @cindex hardware models and configurations, specifying
12175 @cindex machine dependent options
12177 Each target machine types can have its own
12178 special options, starting with @samp{-m}, to choose among various
12179 hardware models or configurations---for example, 68010 vs 68020,
12180 floating coprocessor or none.  A single installed version of the
12181 compiler can compile for any model or configuration, according to the
12182 options specified.
12184 Some configurations of the compiler also support additional special
12185 options, usually for compatibility with other compilers on the same
12186 platform.
12188 @c This list is ordered alphanumerically by subsection name.
12189 @c It should be the same order and spelling as these options are listed
12190 @c in Machine Dependent Options
12192 @menu
12193 * AArch64 Options::
12194 * Adapteva Epiphany Options::
12195 * ARC Options::
12196 * ARM Options::
12197 * AVR Options::
12198 * Blackfin Options::
12199 * C6X Options::
12200 * CRIS Options::
12201 * CR16 Options::
12202 * Darwin Options::
12203 * DEC Alpha Options::
12204 * FR30 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 registers.
12280 @item -mlittle-endian
12281 @opindex mlittle-endian
12282 Generate little-endian code.  This is the default when GCC is configured for an
12283 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12285 @item -mcmodel=tiny
12286 @opindex mcmodel=tiny
12287 Generate code for the tiny code model.  The program and its statically defined
12288 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
12289 be statically or dynamically linked.  This model is not fully implemented and
12290 mostly treated as @samp{small}.
12292 @item -mcmodel=small
12293 @opindex mcmodel=small
12294 Generate code for the small code model.  The program and its statically defined
12295 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
12296 be statically or dynamically linked.  This is the default code model.
12298 @item -mcmodel=large
12299 @opindex mcmodel=large
12300 Generate code for the large code model.  This makes no assumptions about
12301 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
12302 statically linked only.
12304 @item -mstrict-align
12305 @opindex mstrict-align
12306 Do not assume that unaligned memory references are handled by the system.
12308 @item -momit-leaf-frame-pointer
12309 @itemx -mno-omit-leaf-frame-pointer
12310 @opindex momit-leaf-frame-pointer
12311 @opindex mno-omit-leaf-frame-pointer
12312 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
12313 default.
12315 @item -mtls-dialect=desc
12316 @opindex mtls-dialect=desc
12317 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12318 of TLS variables.  This is the default.
12320 @item -mtls-dialect=traditional
12321 @opindex mtls-dialect=traditional
12322 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12323 of TLS variables.
12325 @item -mfix-cortex-a53-835769
12326 @itemx -mno-fix-cortex-a53-835769
12327 @opindex mfix-cortex-a53-835769
12328 @opindex mno-fix-cortex-a53-835769
12329 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12330 This involves inserting a NOP instruction between memory instructions and
12331 64-bit integer multiply-accumulate instructions.
12333 @item -march=@var{name}
12334 @opindex march
12335 Specify the name of the target architecture, optionally suffixed by one or
12336 more feature modifiers.  This option has the form
12337 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12338 only permissible value for @var{arch} is @samp{armv8-a}.
12339 The permissible values for @var{feature} are documented in the sub-section
12340 below.  Additionally on native AArch64 GNU/Linux systems the value
12341 @samp{native} is available.  This option causes the compiler to pick the
12342 architecture of the host system.  If the compiler is unable to recognize the
12343 architecture of the host system this option has no effect.
12345 Where conflicting feature modifiers are specified, the right-most feature is
12346 used.
12348 GCC uses this name to determine what kind of instructions it can emit when
12349 generating assembly code.
12351 Where @option{-march} is specified without either of @option{-mtune}
12352 or @option{-mcpu} also being specified, the code is tuned to perform
12353 well across a range of target processors implementing the target
12354 architecture.
12356 @item -mtune=@var{name}
12357 @opindex mtune
12358 Specify the name of the target processor for which GCC should tune the
12359 performance of the code.  Permissible values for this option are:
12360 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
12361 @samp{exynos-m1}, @samp{thunderx}, @samp{xgene1}.
12363 Additionally, this option can specify that GCC should tune the performance
12364 of the code for a big.LITTLE system.  Permissible values for this
12365 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
12367 Additionally on native AArch64 GNU/Linux systems the value @samp{native}
12368 is available.
12369 This option causes the compiler to pick the architecture of and tune the
12370 performance of the code for the processor of the host system.
12371 If the compiler is unable to recognize the processor of the host system
12372 this option has no effect.
12374 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12375 are specified, the code is tuned to perform well across a range
12376 of target processors.
12378 This option cannot be suffixed by feature modifiers.
12380 @item -mcpu=@var{name}
12381 @opindex mcpu
12382 Specify the name of the target processor, optionally suffixed by one or more
12383 feature modifiers.  This option has the form
12384 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12385 permissible values for @var{cpu} are the same as those available for
12386 @option{-mtune}.  Additionally on native AArch64 GNU/Linux systems the
12387 value @samp{native} is available.
12388 This option causes the compiler to tune the performance of the code for the
12389 processor of the host system.  If the compiler is unable to recognize the
12390 processor of the host system this option has no effect.
12392 The permissible values for @var{feature} are documented in the sub-section
12393 below.
12395 Where conflicting feature modifiers are specified, the right-most feature is
12396 used.
12398 GCC uses this name to determine what kind of instructions it can emit when
12399 generating assembly code (as if by @option{-march}) and to determine
12400 the target processor for which to tune for performance (as if
12401 by @option{-mtune}).  Where this option is used in conjunction
12402 with @option{-march} or @option{-mtune}, those options take precedence
12403 over the appropriate part of this option.
12404 @end table
12406 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
12407 @cindex @option{-march} feature modifiers
12408 @cindex @option{-mcpu} feature modifiers
12409 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
12410 the following:
12412 @table @samp
12413 @item crc
12414 Enable CRC extension.
12415 @item crypto
12416 Enable Crypto extension.  This implies Advanced SIMD is enabled.
12417 @item fp
12418 Enable floating-point instructions.
12419 @item simd
12420 Enable Advanced SIMD instructions.  This implies floating-point instructions
12421 are enabled.  This is the default for all current possible values for options
12422 @option{-march} and @option{-mcpu=}.
12423 @end table
12425 @node Adapteva Epiphany Options
12426 @subsection Adapteva Epiphany Options
12428 These @samp{-m} options are defined for Adapteva Epiphany:
12430 @table @gcctabopt
12431 @item -mhalf-reg-file
12432 @opindex mhalf-reg-file
12433 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12434 That allows code to run on hardware variants that lack these registers.
12436 @item -mprefer-short-insn-regs
12437 @opindex mprefer-short-insn-regs
12438 Preferrentially allocate registers that allow short instruction generation.
12439 This can result in increased instruction count, so this may either reduce or
12440 increase overall code size.
12442 @item -mbranch-cost=@var{num}
12443 @opindex mbranch-cost
12444 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12445 This cost is only a heuristic and is not guaranteed to produce
12446 consistent results across releases.
12448 @item -mcmove
12449 @opindex mcmove
12450 Enable the generation of conditional moves.
12452 @item -mnops=@var{num}
12453 @opindex mnops
12454 Emit @var{num} NOPs before every other generated instruction.
12456 @item -mno-soft-cmpsf
12457 @opindex mno-soft-cmpsf
12458 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12459 and test the flags.  This is faster than a software comparison, but can
12460 get incorrect results in the presence of NaNs, or when two different small
12461 numbers are compared such that their difference is calculated as zero.
12462 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12463 software comparisons.
12465 @item -mstack-offset=@var{num}
12466 @opindex mstack-offset
12467 Set the offset between the top of the stack and the stack pointer.
12468 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12469 can be used by leaf functions without stack allocation.
12470 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12471 Note also that this option changes the ABI; compiling a program with a
12472 different stack offset than the libraries have been compiled with
12473 generally does not work.
12474 This option can be useful if you want to evaluate if a different stack
12475 offset would give you better code, but to actually use a different stack
12476 offset to build working programs, it is recommended to configure the
12477 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12479 @item -mno-round-nearest
12480 @opindex mno-round-nearest
12481 Make the scheduler assume that the rounding mode has been set to
12482 truncating.  The default is @option{-mround-nearest}.
12484 @item -mlong-calls
12485 @opindex mlong-calls
12486 If not otherwise specified by an attribute, assume all calls might be beyond
12487 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12488 function address into a register before performing a (otherwise direct) call.
12489 This is the default.
12491 @item -mshort-calls
12492 @opindex short-calls
12493 If not otherwise specified by an attribute, assume all direct calls are
12494 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12495 for direct calls.  The default is @option{-mlong-calls}.
12497 @item -msmall16
12498 @opindex msmall16
12499 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12500 apply to function addresses for which @option{-mlong-calls} semantics
12501 are in effect.
12503 @item -mfp-mode=@var{mode}
12504 @opindex mfp-mode
12505 Set the prevailing mode of the floating-point unit.
12506 This determines the floating-point mode that is provided and expected
12507 at function call and return time.  Making this mode match the mode you
12508 predominantly need at function start can make your programs smaller and
12509 faster by avoiding unnecessary mode switches.
12511 @var{mode} can be set to one the following values:
12513 @table @samp
12514 @item caller
12515 Any mode at function entry is valid, and retained or restored when
12516 the function returns, and when it calls other functions.
12517 This mode is useful for compiling libraries or other compilation units
12518 you might want to incorporate into different programs with different
12519 prevailing FPU modes, and the convenience of being able to use a single
12520 object file outweighs the size and speed overhead for any extra
12521 mode switching that might be needed, compared with what would be needed
12522 with a more specific choice of prevailing FPU mode.
12524 @item truncate
12525 This is the mode used for floating-point calculations with
12526 truncating (i.e.@: round towards zero) rounding mode.  That includes
12527 conversion from floating point to integer.
12529 @item round-nearest
12530 This is the mode used for floating-point calculations with
12531 round-to-nearest-or-even rounding mode.
12533 @item int
12534 This is the mode used to perform integer calculations in the FPU, e.g.@:
12535 integer multiply, or integer multiply-and-accumulate.
12536 @end table
12538 The default is @option{-mfp-mode=caller}
12540 @item -mnosplit-lohi
12541 @itemx -mno-postinc
12542 @itemx -mno-postmodify
12543 @opindex mnosplit-lohi
12544 @opindex mno-postinc
12545 @opindex mno-postmodify
12546 Code generation tweaks that disable, respectively, splitting of 32-bit
12547 loads, generation of post-increment addresses, and generation of
12548 post-modify addresses.  The defaults are @option{msplit-lohi},
12549 @option{-mpost-inc}, and @option{-mpost-modify}.
12551 @item -mnovect-double
12552 @opindex mno-vect-double
12553 Change the preferred SIMD mode to SImode.  The default is
12554 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12556 @item -max-vect-align=@var{num}
12557 @opindex max-vect-align
12558 The maximum alignment for SIMD vector mode types.
12559 @var{num} may be 4 or 8.  The default is 8.
12560 Note that this is an ABI change, even though many library function
12561 interfaces are unaffected if they don't use SIMD vector modes
12562 in places that affect size and/or alignment of relevant types.
12564 @item -msplit-vecmove-early
12565 @opindex msplit-vecmove-early
12566 Split vector moves into single word moves before reload.  In theory this
12567 can give better register allocation, but so far the reverse seems to be
12568 generally the case.
12570 @item -m1reg-@var{reg}
12571 @opindex m1reg-
12572 Specify a register to hold the constant @minus{}1, which makes loading small negative
12573 constants and certain bitmasks faster.
12574 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12575 which specify use of that register as a fixed register,
12576 and @samp{none}, which means that no register is used for this
12577 purpose.  The default is @option{-m1reg-none}.
12579 @end table
12581 @node ARC Options
12582 @subsection ARC Options
12583 @cindex ARC options
12585 The following options control the architecture variant for which code
12586 is being compiled:
12588 @c architecture variants
12589 @table @gcctabopt
12591 @item -mbarrel-shifter
12592 @opindex mbarrel-shifter
12593 Generate instructions supported by barrel shifter.  This is the default
12594 unless @option{-mcpu=ARC601} is in effect.
12596 @item -mcpu=@var{cpu}
12597 @opindex mcpu
12598 Set architecture type, register usage, and instruction scheduling
12599 parameters for @var{cpu}.  There are also shortcut alias options
12600 available for backward compatibility and convenience.  Supported
12601 values for @var{cpu} are
12603 @table @samp
12604 @opindex mA6
12605 @opindex mARC600
12606 @item ARC600
12607 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12609 @item ARC601
12610 @opindex mARC601
12611 Compile for ARC601.  Alias: @option{-mARC601}.
12613 @item ARC700
12614 @opindex mA7
12615 @opindex mARC700
12616 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12617 This is the default when configured with @option{--with-cpu=arc700}@.
12618 @end table
12620 @item -mdpfp
12621 @opindex mdpfp
12622 @itemx -mdpfp-compact
12623 @opindex mdpfp-compact
12624 FPX: Generate Double Precision FPX instructions, tuned for the compact
12625 implementation.
12627 @item -mdpfp-fast
12628 @opindex mdpfp-fast
12629 FPX: Generate Double Precision FPX instructions, tuned for the fast
12630 implementation.
12632 @item -mno-dpfp-lrsr
12633 @opindex mno-dpfp-lrsr
12634 Disable LR and SR instructions from using FPX extension aux registers.
12636 @item -mea
12637 @opindex mea
12638 Generate Extended arithmetic instructions.  Currently only
12639 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12640 supported.  This is always enabled for @option{-mcpu=ARC700}.
12642 @item -mno-mpy
12643 @opindex mno-mpy
12644 Do not generate mpy instructions for ARC700.
12646 @item -mmul32x16
12647 @opindex mmul32x16
12648 Generate 32x16 bit multiply and mac instructions.
12650 @item -mmul64
12651 @opindex mmul64
12652 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
12654 @item -mnorm
12655 @opindex mnorm
12656 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
12657 is in effect.
12659 @item -mspfp
12660 @opindex mspfp
12661 @itemx -mspfp-compact
12662 @opindex mspfp-compact
12663 FPX: Generate Single Precision FPX instructions, tuned for the compact
12664 implementation.
12666 @item -mspfp-fast
12667 @opindex mspfp-fast
12668 FPX: Generate Single Precision FPX instructions, tuned for the fast
12669 implementation.
12671 @item -msimd
12672 @opindex msimd
12673 Enable generation of ARC SIMD instructions via target-specific
12674 builtins.  Only valid for @option{-mcpu=ARC700}.
12676 @item -msoft-float
12677 @opindex msoft-float
12678 This option ignored; it is provided for compatibility purposes only.
12679 Software floating point code is emitted by default, and this default
12680 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12681 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12682 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12684 @item -mswap
12685 @opindex mswap
12686 Generate swap instructions.
12688 @end table
12690 The following options are passed through to the assembler, and also
12691 define preprocessor macro symbols.
12693 @c Flags used by the assembler, but for which we define preprocessor
12694 @c macro symbols as well.
12695 @table @gcctabopt
12696 @item -mdsp-packa
12697 @opindex mdsp-packa
12698 Passed down to the assembler to enable the DSP Pack A extensions.
12699 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12701 @item -mdvbf
12702 @opindex mdvbf
12703 Passed down to the assembler to enable the dual viterbi butterfly
12704 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12706 @c ARC700 4.10 extension instruction
12707 @item -mlock
12708 @opindex mlock
12709 Passed down to the assembler to enable the Locked Load/Store
12710 Conditional extension.  Also sets the preprocessor symbol
12711 @code{__Xlock}.
12713 @item -mmac-d16
12714 @opindex mmac-d16
12715 Passed down to the assembler.  Also sets the preprocessor symbol
12716 @code{__Xxmac_d16}.
12718 @item -mmac-24
12719 @opindex mmac-24
12720 Passed down to the assembler.  Also sets the preprocessor symbol
12721 @code{__Xxmac_24}.
12723 @c ARC700 4.10 extension instruction
12724 @item -mrtsc
12725 @opindex mrtsc
12726 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12727 extension instruction.  Also sets the preprocessor symbol
12728 @code{__Xrtsc}.
12730 @c ARC700 4.10 extension instruction
12731 @item -mswape
12732 @opindex mswape
12733 Passed down to the assembler to enable the swap byte ordering
12734 extension instruction.  Also sets the preprocessor symbol
12735 @code{__Xswape}.
12737 @item -mtelephony
12738 @opindex mtelephony
12739 Passed down to the assembler to enable dual and single operand
12740 instructions for telephony.  Also sets the preprocessor symbol
12741 @code{__Xtelephony}.
12743 @item -mxy
12744 @opindex mxy
12745 Passed down to the assembler to enable the XY Memory extension.  Also
12746 sets the preprocessor symbol @code{__Xxy}.
12748 @end table
12750 The following options control how the assembly code is annotated:
12752 @c Assembly annotation options
12753 @table @gcctabopt
12754 @item -misize
12755 @opindex misize
12756 Annotate assembler instructions with estimated addresses.
12758 @item -mannotate-align
12759 @opindex mannotate-align
12760 Explain what alignment considerations lead to the decision to make an
12761 instruction short or long.
12763 @end table
12765 The following options are passed through to the linker:
12767 @c options passed through to the linker
12768 @table @gcctabopt
12769 @item -marclinux
12770 @opindex marclinux
12771 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12772 This option is enabled by default in tool chains built for
12773 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12774 when profiling is not requested.
12776 @item -marclinux_prof
12777 @opindex marclinux_prof
12778 Passed through to the linker, to specify use of the
12779 @code{arclinux_prof} emulation.  This option is enabled by default in
12780 tool chains built for @w{@code{arc-linux-uclibc}} and
12781 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12783 @end table
12785 The following options control the semantics of generated code:
12787 @c semantically relevant code generation options
12788 @table @gcctabopt
12789 @item -mepilogue-cfi
12790 @opindex mepilogue-cfi
12791 Enable generation of call frame information for epilogues.
12793 @item -mno-epilogue-cfi
12794 @opindex mno-epilogue-cfi
12795 Disable generation of call frame information for epilogues.
12797 @item -mlong-calls
12798 @opindex mlong-calls
12799 Generate call insns as register indirect calls, thus providing access
12800 to the full 32-bit address range.
12802 @item -mmedium-calls
12803 @opindex mmedium-calls
12804 Don't use less than 25 bit addressing range for calls, which is the
12805 offset available for an unconditional branch-and-link
12806 instruction.  Conditional execution of function calls is suppressed, to
12807 allow use of the 25-bit range, rather than the 21-bit range with
12808 conditional branch-and-link.  This is the default for tool chains built
12809 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12811 @item -mno-sdata
12812 @opindex mno-sdata
12813 Do not generate sdata references.  This is the default for tool chains
12814 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12815 targets.
12817 @item -mucb-mcount
12818 @opindex mucb-mcount
12819 Instrument with mcount calls as used in UCB code.  I.e. do the
12820 counting in the callee, not the caller.  By default ARC instrumentation
12821 counts in the caller.
12823 @item -mvolatile-cache
12824 @opindex mvolatile-cache
12825 Use ordinarily cached memory accesses for volatile references.  This is the
12826 default.
12828 @item -mno-volatile-cache
12829 @opindex mno-volatile-cache
12830 Enable cache bypass for volatile references.
12832 @end table
12834 The following options fine tune code generation:
12835 @c code generation tuning options
12836 @table @gcctabopt
12837 @item -malign-call
12838 @opindex malign-call
12839 Do alignment optimizations for call instructions.
12841 @item -mauto-modify-reg
12842 @opindex mauto-modify-reg
12843 Enable the use of pre/post modify with register displacement.
12845 @item -mbbit-peephole
12846 @opindex mbbit-peephole
12847 Enable bbit peephole2.
12849 @item -mno-brcc
12850 @opindex mno-brcc
12851 This option disables a target-specific pass in @file{arc_reorg} to
12852 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12853 generation driven by the combiner pass.
12855 @item -mcase-vector-pcrel
12856 @opindex mcase-vector-pcrel
12857 Use pc-relative switch case tables - this enables case table shortening.
12858 This is the default for @option{-Os}.
12860 @item -mcompact-casesi
12861 @opindex mcompact-casesi
12862 Enable compact casesi pattern.
12863 This is the default for @option{-Os}.
12865 @item -mno-cond-exec
12866 @opindex mno-cond-exec
12867 Disable ARCompact specific pass to generate conditional execution instructions.
12868 Due to delay slot scheduling and interactions between operand numbers,
12869 literal sizes, instruction lengths, and the support for conditional execution,
12870 the target-independent pass to generate conditional execution is often lacking,
12871 so the ARC port has kept a special pass around that tries to find more
12872 conditional execution generating opportunities after register allocation,
12873 branch shortening, and delay slot scheduling have been done.  This pass
12874 generally, but not always, improves performance and code size, at the cost of
12875 extra compilation time, which is why there is an option to switch it off.
12876 If you have a problem with call instructions exceeding their allowable
12877 offset range because they are conditionalized, you should consider using
12878 @option{-mmedium-calls} instead.
12880 @item -mearly-cbranchsi
12881 @opindex mearly-cbranchsi
12882 Enable pre-reload use of the cbranchsi pattern.
12884 @item -mexpand-adddi
12885 @opindex mexpand-adddi
12886 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12887 @code{add.f}, @code{adc} etc.
12889 @item -mindexed-loads
12890 @opindex mindexed-loads
12891 Enable the use of indexed loads.  This can be problematic because some
12892 optimizers then assume that indexed stores exist, which is not
12893 the case.
12895 @item -mlra
12896 @opindex mlra
12897 Enable Local Register Allocation.  This is still experimental for ARC,
12898 so by default the compiler uses standard reload
12899 (i.e. @option{-mno-lra}).
12901 @item -mlra-priority-none
12902 @opindex mlra-priority-none
12903 Don't indicate any priority for target registers.
12905 @item -mlra-priority-compact
12906 @opindex mlra-priority-compact
12907 Indicate target register priority for r0..r3 / r12..r15.
12909 @item -mlra-priority-noncompact
12910 @opindex mlra-priority-noncompact
12911 Reduce target regsiter priority for r0..r3 / r12..r15.
12913 @item -mno-millicode
12914 @opindex mno-millicode
12915 When optimizing for size (using @option{-Os}), prologues and epilogues
12916 that have to save or restore a large number of registers are often
12917 shortened by using call to a special function in libgcc; this is
12918 referred to as a @emph{millicode} call.  As these calls can pose
12919 performance issues, and/or cause linking issues when linking in a
12920 nonstandard way, this option is provided to turn off millicode call
12921 generation.
12923 @item -mmixed-code
12924 @opindex mmixed-code
12925 Tweak register allocation to help 16-bit instruction generation.
12926 This generally has the effect of decreasing the average instruction size
12927 while increasing the instruction count.
12929 @item -mq-class
12930 @opindex mq-class
12931 Enable 'q' instruction alternatives.
12932 This is the default for @option{-Os}.
12934 @item -mRcq
12935 @opindex mRcq
12936 Enable Rcq constraint handling - most short code generation depends on this.
12937 This is the default.
12939 @item -mRcw
12940 @opindex mRcw
12941 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12942 This is the default.
12944 @item -msize-level=@var{level}
12945 @opindex msize-level
12946 Fine-tune size optimization with regards to instruction lengths and alignment.
12947 The recognized values for @var{level} are:
12948 @table @samp
12949 @item 0
12950 No size optimization.  This level is deprecated and treated like @samp{1}.
12952 @item 1
12953 Short instructions are used opportunistically.
12955 @item 2
12956 In addition, alignment of loops and of code after barriers are dropped.
12958 @item 3
12959 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12961 @end table
12963 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12964 the behavior when this is not set is equivalent to level @samp{1}.
12966 @item -mtune=@var{cpu}
12967 @opindex mtune
12968 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12969 by @option{-mcpu=}.
12971 Supported values for @var{cpu} are
12973 @table @samp
12974 @item ARC600
12975 Tune for ARC600 cpu.
12977 @item ARC601
12978 Tune for ARC601 cpu.
12980 @item ARC700
12981 Tune for ARC700 cpu with standard multiplier block.
12983 @item ARC700-xmac
12984 Tune for ARC700 cpu with XMAC block.
12986 @item ARC725D
12987 Tune for ARC725D cpu.
12989 @item ARC750D
12990 Tune for ARC750D cpu.
12992 @end table
12994 @item -mmultcost=@var{num}
12995 @opindex mmultcost
12996 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12997 normal instruction.
12999 @item -munalign-prob-threshold=@var{probability}
13000 @opindex munalign-prob-threshold
13001 Set probability threshold for unaligning branches.
13002 When tuning for @samp{ARC700} and optimizing for speed, branches without
13003 filled delay slot are preferably emitted unaligned and long, unless
13004 profiling indicates that the probability for the branch to be taken
13005 is below @var{probability}.  @xref{Cross-profiling}.
13006 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13008 @end table
13010 The following options are maintained for backward compatibility, but
13011 are now deprecated and will be removed in a future release:
13013 @c Deprecated options
13014 @table @gcctabopt
13016 @item -margonaut
13017 @opindex margonaut
13018 Obsolete FPX.
13020 @item -mbig-endian
13021 @opindex mbig-endian
13022 @itemx -EB
13023 @opindex EB
13024 Compile code for big endian targets.  Use of these options is now
13025 deprecated.  Users wanting big-endian code, should use the
13026 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13027 building the tool chain, for which big-endian is the default.
13029 @item -mlittle-endian
13030 @opindex mlittle-endian
13031 @itemx -EL
13032 @opindex EL
13033 Compile code for little endian targets.  Use of these options is now
13034 deprecated.  Users wanting little-endian code should use the
13035 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13036 building the tool chain, for which little-endian is the default.
13038 @item -mbarrel_shifter
13039 @opindex mbarrel_shifter
13040 Replaced by @option{-mbarrel-shifter}.
13042 @item -mdpfp_compact
13043 @opindex mdpfp_compact
13044 Replaced by @option{-mdpfp-compact}.
13046 @item -mdpfp_fast
13047 @opindex mdpfp_fast
13048 Replaced by @option{-mdpfp-fast}.
13050 @item -mdsp_packa
13051 @opindex mdsp_packa
13052 Replaced by @option{-mdsp-packa}.
13054 @item -mEA
13055 @opindex mEA
13056 Replaced by @option{-mea}.
13058 @item -mmac_24
13059 @opindex mmac_24
13060 Replaced by @option{-mmac-24}.
13062 @item -mmac_d16
13063 @opindex mmac_d16
13064 Replaced by @option{-mmac-d16}.
13066 @item -mspfp_compact
13067 @opindex mspfp_compact
13068 Replaced by @option{-mspfp-compact}.
13070 @item -mspfp_fast
13071 @opindex mspfp_fast
13072 Replaced by @option{-mspfp-fast}.
13074 @item -mtune=@var{cpu}
13075 @opindex mtune
13076 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13077 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13078 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13080 @item -multcost=@var{num}
13081 @opindex multcost
13082 Replaced by @option{-mmultcost}.
13084 @end table
13086 @node ARM Options
13087 @subsection ARM Options
13088 @cindex ARM options
13090 These @samp{-m} options are defined for the ARM port:
13092 @table @gcctabopt
13093 @item -mabi=@var{name}
13094 @opindex mabi
13095 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13096 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13098 @item -mapcs-frame
13099 @opindex mapcs-frame
13100 Generate a stack frame that is compliant with the ARM Procedure Call
13101 Standard for all functions, even if this is not strictly necessary for
13102 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13103 with this option causes the stack frames not to be generated for
13104 leaf functions.  The default is @option{-mno-apcs-frame}.
13105 This option is deprecated.
13107 @item -mapcs
13108 @opindex mapcs
13109 This is a synonym for @option{-mapcs-frame} and is deprecated.
13111 @ignore
13112 @c not currently implemented
13113 @item -mapcs-stack-check
13114 @opindex mapcs-stack-check
13115 Generate code to check the amount of stack space available upon entry to
13116 every function (that actually uses some stack space).  If there is
13117 insufficient space available then either the function
13118 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13119 called, depending upon the amount of stack space required.  The runtime
13120 system is required to provide these functions.  The default is
13121 @option{-mno-apcs-stack-check}, since this produces smaller code.
13123 @c not currently implemented
13124 @item -mapcs-float
13125 @opindex mapcs-float
13126 Pass floating-point arguments using the floating-point registers.  This is
13127 one of the variants of the APCS@.  This option is recommended if the
13128 target hardware has a floating-point unit or if a lot of floating-point
13129 arithmetic is going to be performed by the code.  The default is
13130 @option{-mno-apcs-float}, since the size of integer-only code is 
13131 slightly increased if @option{-mapcs-float} is used.
13133 @c not currently implemented
13134 @item -mapcs-reentrant
13135 @opindex mapcs-reentrant
13136 Generate reentrant, position-independent code.  The default is
13137 @option{-mno-apcs-reentrant}.
13138 @end ignore
13140 @item -mthumb-interwork
13141 @opindex mthumb-interwork
13142 Generate code that supports calling between the ARM and Thumb
13143 instruction sets.  Without this option, on pre-v5 architectures, the
13144 two instruction sets cannot be reliably used inside one program.  The
13145 default is @option{-mno-thumb-interwork}, since slightly larger code
13146 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13147 configurations this option is meaningless.
13149 @item -mno-sched-prolog
13150 @opindex mno-sched-prolog
13151 Prevent the reordering of instructions in the function prologue, or the
13152 merging of those instruction with the instructions in the function's
13153 body.  This means that all functions start with a recognizable set
13154 of instructions (or in fact one of a choice from a small set of
13155 different function prologues), and this information can be used to
13156 locate the start of functions inside an executable piece of code.  The
13157 default is @option{-msched-prolog}.
13159 @item -mfloat-abi=@var{name}
13160 @opindex mfloat-abi
13161 Specifies which floating-point ABI to use.  Permissible values
13162 are: @samp{soft}, @samp{softfp} and @samp{hard}.
13164 Specifying @samp{soft} causes GCC to generate output containing
13165 library calls for floating-point operations.
13166 @samp{softfp} allows the generation of code using hardware floating-point
13167 instructions, but still uses the soft-float calling conventions.
13168 @samp{hard} allows generation of floating-point instructions
13169 and uses FPU-specific calling conventions.
13171 The default depends on the specific target configuration.  Note that
13172 the hard-float and soft-float ABIs are not link-compatible; you must
13173 compile your entire program with the same ABI, and link with a
13174 compatible set of libraries.
13176 @item -mlittle-endian
13177 @opindex mlittle-endian
13178 Generate code for a processor running in little-endian mode.  This is
13179 the default for all standard configurations.
13181 @item -mbig-endian
13182 @opindex mbig-endian
13183 Generate code for a processor running in big-endian mode; the default is
13184 to compile code for a little-endian processor.
13186 @item -march=@var{name}
13187 @opindex march
13188 This specifies the name of the target ARM architecture.  GCC uses this
13189 name to determine what kind of instructions it can emit when generating
13190 assembly code.  This option can be used in conjunction with or instead
13191 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
13192 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
13193 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
13194 @samp{armv6}, @samp{armv6j},
13195 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
13196 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
13197 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
13198 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
13200 @option{-march=armv7ve} is the armv7-a architecture with virtualization
13201 extensions.
13203 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
13204 architecture together with the optional CRC32 extensions.
13206 @option{-march=native} causes the compiler to auto-detect the architecture
13207 of the build computer.  At present, this feature is only supported on
13208 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13209 is unsuccessful the option has no effect.
13211 @item -mtune=@var{name}
13212 @opindex mtune
13213 This option specifies the name of the target ARM processor for
13214 which GCC should tune the performance of the code.
13215 For some ARM implementations better performance can be obtained by using
13216 this option.
13217 Permissible names are: @samp{arm2}, @samp{arm250},
13218 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
13219 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
13220 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
13221 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
13222 @samp{arm720},
13223 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
13224 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
13225 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
13226 @samp{strongarm1110},
13227 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
13228 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
13229 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
13230 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
13231 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
13232 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
13233 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
13234 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
13235 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53},
13236 @samp{cortex-a57}, @samp{cortex-a72},
13237 @samp{cortex-r4},
13238 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
13239 @samp{cortex-m4},
13240 @samp{cortex-m3},
13241 @samp{cortex-m1},
13242 @samp{cortex-m0},
13243 @samp{cortex-m0plus},
13244 @samp{cortex-m1.small-multiply},
13245 @samp{cortex-m0.small-multiply},
13246 @samp{cortex-m0plus.small-multiply},
13247 @samp{exynos-m1},
13248 @samp{marvell-pj4},
13249 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
13250 @samp{fa526}, @samp{fa626},
13251 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
13252 @samp{xgene1}.
13254 Additionally, this option can specify that GCC should tune the performance
13255 of the code for a big.LITTLE system.  Permissible names are:
13256 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53},
13257 @samp{cortex-a72.cortex-a53}.
13259 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
13260 performance for a blend of processors within architecture @var{arch}.
13261 The aim is to generate code that run well on the current most popular
13262 processors, balancing between optimizations that benefit some CPUs in the
13263 range, and avoiding performance pitfalls of other CPUs.  The effects of
13264 this option may change in future GCC versions as CPU models come and go.
13266 @option{-mtune=native} causes the compiler to auto-detect the CPU
13267 of the build computer.  At present, this feature is only supported on
13268 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
13269 unsuccessful the option has no effect.
13271 @item -mcpu=@var{name}
13272 @opindex mcpu
13273 This specifies the name of the target ARM processor.  GCC uses this name
13274 to derive the name of the target ARM architecture (as if specified
13275 by @option{-march}) and the ARM processor type for which to tune for
13276 performance (as if specified by @option{-mtune}).  Where this option
13277 is used in conjunction with @option{-march} or @option{-mtune},
13278 those options take precedence over the appropriate part of this option.
13280 Permissible names for this option are the same as those for
13281 @option{-mtune}.
13283 @option{-mcpu=generic-@var{arch}} is also permissible, and is
13284 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
13285 See @option{-mtune} for more information.
13287 @option{-mcpu=native} causes the compiler to auto-detect the CPU
13288 of the build computer.  At present, this feature is only supported on
13289 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13290 is unsuccessful the option has no effect.
13292 @item -mfpu=@var{name}
13293 @opindex mfpu
13294 This specifies what floating-point hardware (or hardware emulation) is
13295 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
13296 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
13297 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
13298 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
13299 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
13300 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
13302 If @option{-msoft-float} is specified this specifies the format of
13303 floating-point values.
13305 If the selected floating-point hardware includes the NEON extension
13306 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
13307 operations are not generated by GCC's auto-vectorization pass unless
13308 @option{-funsafe-math-optimizations} is also specified.  This is
13309 because NEON hardware does not fully implement the IEEE 754 standard for
13310 floating-point arithmetic (in particular denormal values are treated as
13311 zero), so the use of NEON instructions may lead to a loss of precision.
13313 @item -mfp16-format=@var{name}
13314 @opindex mfp16-format
13315 Specify the format of the @code{__fp16} half-precision floating-point type.
13316 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
13317 the default is @samp{none}, in which case the @code{__fp16} type is not
13318 defined.  @xref{Half-Precision}, for more information.
13320 @item -mstructure-size-boundary=@var{n}
13321 @opindex mstructure-size-boundary
13322 The sizes of all structures and unions are rounded up to a multiple
13323 of the number of bits set by this option.  Permissible values are 8, 32
13324 and 64.  The default value varies for different toolchains.  For the COFF
13325 targeted toolchain the default value is 8.  A value of 64 is only allowed
13326 if the underlying ABI supports it.
13328 Specifying a larger number can produce faster, more efficient code, but
13329 can also increase the size of the program.  Different values are potentially
13330 incompatible.  Code compiled with one value cannot necessarily expect to
13331 work with code or libraries compiled with another value, if they exchange
13332 information using structures or unions.
13334 @item -mabort-on-noreturn
13335 @opindex mabort-on-noreturn
13336 Generate a call to the function @code{abort} at the end of a
13337 @code{noreturn} function.  It is executed if the function tries to
13338 return.
13340 @item -mlong-calls
13341 @itemx -mno-long-calls
13342 @opindex mlong-calls
13343 @opindex mno-long-calls
13344 Tells the compiler to perform function calls by first loading the
13345 address of the function into a register and then performing a subroutine
13346 call on this register.  This switch is needed if the target function
13347 lies outside of the 64-megabyte addressing range of the offset-based
13348 version of subroutine call instruction.
13350 Even if this switch is enabled, not all function calls are turned
13351 into long calls.  The heuristic is that static functions, functions
13352 that have the @code{short_call} attribute, functions that are inside
13353 the scope of a @code{#pragma no_long_calls} directive, and functions whose
13354 definitions have already been compiled within the current compilation
13355 unit are not turned into long calls.  The exceptions to this rule are
13356 that weak function definitions, functions with the @code{long_call}
13357 attribute or the @code{section} attribute, and functions that are within
13358 the scope of a @code{#pragma long_calls} directive are always
13359 turned into long calls.
13361 This feature is not enabled by default.  Specifying
13362 @option{-mno-long-calls} restores the default behavior, as does
13363 placing the function calls within the scope of a @code{#pragma
13364 long_calls_off} directive.  Note these switches have no effect on how
13365 the compiler generates code to handle function calls via function
13366 pointers.
13368 @item -msingle-pic-base
13369 @opindex msingle-pic-base
13370 Treat the register used for PIC addressing as read-only, rather than
13371 loading it in the prologue for each function.  The runtime system is
13372 responsible for initializing this register with an appropriate value
13373 before execution begins.
13375 @item -mpic-register=@var{reg}
13376 @opindex mpic-register
13377 Specify the register to be used for PIC addressing.
13378 For standard PIC base case, the default is any suitable register
13379 determined by compiler.  For single PIC base case, the default is
13380 @samp{R9} if target is EABI based or stack-checking is enabled,
13381 otherwise the default is @samp{R10}.
13383 @item -mpic-data-is-text-relative
13384 @opindex mpic-data-is-text-relative
13385 Assume that each data segments are relative to text segment at load time.
13386 Therefore, it permits addressing data using PC-relative operations.
13387 This option is on by default for targets other than VxWorks RTP.
13389 @item -mpoke-function-name
13390 @opindex mpoke-function-name
13391 Write the name of each function into the text section, directly
13392 preceding the function prologue.  The generated code is similar to this:
13394 @smallexample
13395      t0
13396          .ascii "arm_poke_function_name", 0
13397          .align
13398      t1
13399          .word 0xff000000 + (t1 - t0)
13400      arm_poke_function_name
13401          mov     ip, sp
13402          stmfd   sp!, @{fp, ip, lr, pc@}
13403          sub     fp, ip, #4
13404 @end smallexample
13406 When performing a stack backtrace, code can inspect the value of
13407 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13408 location @code{pc - 12} and the top 8 bits are set, then we know that
13409 there is a function name embedded immediately preceding this location
13410 and has length @code{((pc[-3]) & 0xff000000)}.
13412 @item -mthumb
13413 @itemx -marm
13414 @opindex marm
13415 @opindex mthumb
13417 Select between generating code that executes in ARM and Thumb
13418 states.  The default for most configurations is to generate code
13419 that executes in ARM state, but the default can be changed by
13420 configuring GCC with the @option{--with-mode=}@var{state}
13421 configure option.
13423 @item -mtpcs-frame
13424 @opindex mtpcs-frame
13425 Generate a stack frame that is compliant with the Thumb Procedure Call
13426 Standard for all non-leaf functions.  (A leaf function is one that does
13427 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13429 @item -mtpcs-leaf-frame
13430 @opindex mtpcs-leaf-frame
13431 Generate a stack frame that is compliant with the Thumb Procedure Call
13432 Standard for all leaf functions.  (A leaf function is one that does
13433 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13435 @item -mcallee-super-interworking
13436 @opindex mcallee-super-interworking
13437 Gives all externally visible functions in the file being compiled an ARM
13438 instruction set header which switches to Thumb mode before executing the
13439 rest of the function.  This allows these functions to be called from
13440 non-interworking code.  This option is not valid in AAPCS configurations
13441 because interworking is enabled by default.
13443 @item -mcaller-super-interworking
13444 @opindex mcaller-super-interworking
13445 Allows calls via function pointers (including virtual functions) to
13446 execute correctly regardless of whether the target code has been
13447 compiled for interworking or not.  There is a small overhead in the cost
13448 of executing a function pointer if this option is enabled.  This option
13449 is not valid in AAPCS configurations because interworking is enabled
13450 by default.
13452 @item -mtp=@var{name}
13453 @opindex mtp
13454 Specify the access model for the thread local storage pointer.  The valid
13455 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
13456 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
13457 (supported in the arm6k architecture), and @samp{auto}, which uses the
13458 best available method for the selected processor.  The default setting is
13459 @samp{auto}.
13461 @item -mtls-dialect=@var{dialect}
13462 @opindex mtls-dialect
13463 Specify the dialect to use for accessing thread local storage.  Two
13464 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13465 @samp{gnu} dialect selects the original GNU scheme for supporting
13466 local and global dynamic TLS models.  The @samp{gnu2} dialect
13467 selects the GNU descriptor scheme, which provides better performance
13468 for shared libraries.  The GNU descriptor scheme is compatible with
13469 the original scheme, but does require new assembler, linker and
13470 library support.  Initial and local exec TLS models are unaffected by
13471 this option and always use the original scheme.
13473 @item -mword-relocations
13474 @opindex mword-relocations
13475 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13476 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13477 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13478 is specified.
13480 @item -mfix-cortex-m3-ldrd
13481 @opindex mfix-cortex-m3-ldrd
13482 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13483 with overlapping destination and base registers are used.  This option avoids
13484 generating these instructions.  This option is enabled by default when
13485 @option{-mcpu=cortex-m3} is specified.
13487 @item -munaligned-access
13488 @itemx -mno-unaligned-access
13489 @opindex munaligned-access
13490 @opindex mno-unaligned-access
13491 Enables (or disables) reading and writing of 16- and 32- bit values
13492 from addresses that are not 16- or 32- bit aligned.  By default
13493 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13494 architectures, and enabled for all other architectures.  If unaligned
13495 access is not enabled then words in packed data structures are
13496 accessed a byte at a time.
13498 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
13499 generated object file to either true or false, depending upon the
13500 setting of this option.  If unaligned access is enabled then the
13501 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
13502 defined.
13504 @item -mneon-for-64bits
13505 @opindex mneon-for-64bits
13506 Enables using Neon to handle scalar 64-bits operations. This is
13507 disabled by default since the cost of moving data from core registers
13508 to Neon is high.
13510 @item -mslow-flash-data
13511 @opindex mslow-flash-data
13512 Assume loading data from flash is slower than fetching instruction.
13513 Therefore literal load is minimized for better performance.
13514 This option is only supported when compiling for ARMv7 M-profile and
13515 off by default.
13517 @item -masm-syntax-unified
13518 @opindex masm-syntax-unified
13519 Assume inline assembler is using unified asm syntax.  The default is
13520 currently off which implies divided syntax.  Currently this option is
13521 available only for Thumb1 and has no effect on ARM state and Thumb2.
13522 However, this may change in future releases of GCC.  Divided syntax
13523 should be considered deprecated.
13525 @item -mrestrict-it
13526 @opindex mrestrict-it
13527 Restricts generation of IT blocks to conform to the rules of ARMv8.
13528 IT blocks can only contain a single 16-bit instruction from a select
13529 set of instructions. This option is on by default for ARMv8 Thumb mode.
13531 @item -mprint-tune-info
13532 @opindex mprint-tune-info
13533 Print CPU tuning information as comment in assembler file.  This is
13534 an option used only for regression testing of the compiler and not
13535 intended for ordinary use in compiling code.  This option is disabled
13536 by default.
13537 @end table
13539 @node AVR Options
13540 @subsection AVR Options
13541 @cindex AVR Options
13543 These options are defined for AVR implementations:
13545 @table @gcctabopt
13546 @item -mmcu=@var{mcu}
13547 @opindex mmcu
13548 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13550 The default for this option is@tie{}@samp{avr2}.
13552 GCC supports the following AVR devices and ISAs:
13554 @include avr-mmcu.texi
13556 @item -maccumulate-args
13557 @opindex maccumulate-args
13558 Accumulate outgoing function arguments and acquire/release the needed
13559 stack space for outgoing function arguments once in function
13560 prologue/epilogue.  Without this option, outgoing arguments are pushed
13561 before calling a function and popped afterwards.
13563 Popping the arguments after the function call can be expensive on
13564 AVR so that accumulating the stack space might lead to smaller
13565 executables because arguments need not to be removed from the
13566 stack after such a function call.
13568 This option can lead to reduced code size for functions that perform
13569 several calls to functions that get their arguments on the stack like
13570 calls to printf-like functions.
13572 @item -mbranch-cost=@var{cost}
13573 @opindex mbranch-cost
13574 Set the branch costs for conditional branch instructions to
13575 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13576 integers. The default branch cost is 0.
13578 @item -mcall-prologues
13579 @opindex mcall-prologues
13580 Functions prologues/epilogues are expanded as calls to appropriate
13581 subroutines.  Code size is smaller.
13583 @item -mint8
13584 @opindex mint8
13585 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13586 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13587 and @code{long long} is 4 bytes.  Please note that this option does not
13588 conform to the C standards, but it results in smaller code
13589 size.
13591 @item -mn-flash=@var{num}
13592 @opindex mn-flash
13593 Assume that the flash memory has a size of 
13594 @var{num} times 64@tie{}KiB.
13596 @item -mno-interrupts
13597 @opindex mno-interrupts
13598 Generated code is not compatible with hardware interrupts.
13599 Code size is smaller.
13601 @item -mrelax
13602 @opindex mrelax
13603 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13604 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13605 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
13606 the assembler's command line and the @option{--relax} option to the
13607 linker's command line.
13609 Jump relaxing is performed by the linker because jump offsets are not
13610 known before code is located. Therefore, the assembler code generated by the
13611 compiler is the same, but the instructions in the executable may
13612 differ from instructions in the assembler code.
13614 Relaxing must be turned on if linker stubs are needed, see the
13615 section on @code{EIND} and linker stubs below.
13617 @item -mrmw
13618 @opindex mrmw
13619 Assume that the device supports the Read-Modify-Write
13620 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
13622 @item -msp8
13623 @opindex msp8
13624 Treat the stack pointer register as an 8-bit register,
13625 i.e.@: assume the high byte of the stack pointer is zero.
13626 In general, you don't need to set this option by hand.
13628 This option is used internally by the compiler to select and
13629 build multilibs for architectures @code{avr2} and @code{avr25}.
13630 These architectures mix devices with and without @code{SPH}.
13631 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
13632 the compiler driver adds or removes this option from the compiler
13633 proper's command line, because the compiler then knows if the device
13634 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13635 register or not.
13637 @item -mstrict-X
13638 @opindex mstrict-X
13639 Use address register @code{X} in a way proposed by the hardware.  This means
13640 that @code{X} is only used in indirect, post-increment or
13641 pre-decrement addressing.
13643 Without this option, the @code{X} register may be used in the same way
13644 as @code{Y} or @code{Z} which then is emulated by additional
13645 instructions.  
13646 For example, loading a value with @code{X+const} addressing with a
13647 small non-negative @code{const < 64} to a register @var{Rn} is
13648 performed as
13650 @example
13651 adiw r26, const   ; X += const
13652 ld   @var{Rn}, X        ; @var{Rn} = *X
13653 sbiw r26, const   ; X -= const
13654 @end example
13656 @item -mtiny-stack
13657 @opindex mtiny-stack
13658 Only change the lower 8@tie{}bits of the stack pointer.
13660 @item -nodevicelib
13661 @opindex nodevicelib
13662 Don't link against AVR-LibC's device specific library @code{libdev.a}.
13664 @item -Waddr-space-convert
13665 @opindex Waddr-space-convert
13666 Warn about conversions between address spaces in the case where the
13667 resulting address space is not contained in the incoming address space.
13668 @end table
13670 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
13671 @cindex @code{EIND}
13672 Pointers in the implementation are 16@tie{}bits wide.
13673 The address of a function or label is represented as word address so
13674 that indirect jumps and calls can target any code address in the
13675 range of 64@tie{}Ki words.
13677 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13678 bytes of program memory space, there is a special function register called
13679 @code{EIND} that serves as most significant part of the target address
13680 when @code{EICALL} or @code{EIJMP} instructions are used.
13682 Indirect jumps and calls on these devices are handled as follows by
13683 the compiler and are subject to some limitations:
13685 @itemize @bullet
13687 @item
13688 The compiler never sets @code{EIND}.
13690 @item
13691 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13692 instructions or might read @code{EIND} directly in order to emulate an
13693 indirect call/jump by means of a @code{RET} instruction.
13695 @item
13696 The compiler assumes that @code{EIND} never changes during the startup
13697 code or during the application. In particular, @code{EIND} is not
13698 saved/restored in function or interrupt service routine
13699 prologue/epilogue.
13701 @item
13702 For indirect calls to functions and computed goto, the linker
13703 generates @emph{stubs}. Stubs are jump pads sometimes also called
13704 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13705 The stub contains a direct jump to the desired address.
13707 @item
13708 Linker relaxation must be turned on so that the linker generates
13709 the stubs correctly in all situations. See the compiler option
13710 @option{-mrelax} and the linker option @option{--relax}.
13711 There are corner cases where the linker is supposed to generate stubs
13712 but aborts without relaxation and without a helpful error message.
13714 @item
13715 The default linker script is arranged for code with @code{EIND = 0}.
13716 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13717 linker script has to be used in order to place the sections whose
13718 name start with @code{.trampolines} into the segment where @code{EIND}
13719 points to.
13721 @item
13722 The startup code from libgcc never sets @code{EIND}.
13723 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13724 For the impact of AVR-LibC on @code{EIND}, see the
13725 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13727 @item
13728 It is legitimate for user-specific startup code to set up @code{EIND}
13729 early, for example by means of initialization code located in
13730 section @code{.init3}. Such code runs prior to general startup code
13731 that initializes RAM and calls constructors, but after the bit
13732 of startup code from AVR-LibC that sets @code{EIND} to the segment
13733 where the vector table is located.
13734 @example
13735 #include <avr/io.h>
13737 static void
13738 __attribute__((section(".init3"),naked,used,no_instrument_function))
13739 init3_set_eind (void)
13741   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13742                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13744 @end example
13746 @noindent
13747 The @code{__trampolines_start} symbol is defined in the linker script.
13749 @item
13750 Stubs are generated automatically by the linker if
13751 the following two conditions are met:
13752 @itemize @minus
13754 @item The address of a label is taken by means of the @code{gs} modifier
13755 (short for @emph{generate stubs}) like so:
13756 @example
13757 LDI r24, lo8(gs(@var{func}))
13758 LDI r25, hi8(gs(@var{func}))
13759 @end example
13760 @item The final location of that label is in a code segment
13761 @emph{outside} the segment where the stubs are located.
13762 @end itemize
13764 @item
13765 The compiler emits such @code{gs} modifiers for code labels in the
13766 following situations:
13767 @itemize @minus
13768 @item Taking address of a function or code label.
13769 @item Computed goto.
13770 @item If prologue-save function is used, see @option{-mcall-prologues}
13771 command-line option.
13772 @item Switch/case dispatch tables. If you do not want such dispatch
13773 tables you can specify the @option{-fno-jump-tables} command-line option.
13774 @item C and C++ constructors/destructors called during startup/shutdown.
13775 @item If the tools hit a @code{gs()} modifier explained above.
13776 @end itemize
13778 @item
13779 Jumping to non-symbolic addresses like so is @emph{not} supported:
13781 @example
13782 int main (void)
13784     /* Call function at word address 0x2 */
13785     return ((int(*)(void)) 0x2)();
13787 @end example
13789 Instead, a stub has to be set up, i.e.@: the function has to be called
13790 through a symbol (@code{func_4} in the example):
13792 @example
13793 int main (void)
13795     extern int func_4 (void);
13797     /* Call function at byte address 0x4 */
13798     return func_4();
13800 @end example
13802 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
13803 Alternatively, @code{func_4} can be defined in the linker script.
13804 @end itemize
13806 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13807 @cindex @code{RAMPD}
13808 @cindex @code{RAMPX}
13809 @cindex @code{RAMPY}
13810 @cindex @code{RAMPZ}
13811 Some AVR devices support memories larger than the 64@tie{}KiB range
13812 that can be accessed with 16-bit pointers.  To access memory locations
13813 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13814 register is used as high part of the address:
13815 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13816 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13817 register, respectively, to get a wide address. Similarly,
13818 @code{RAMPD} is used together with direct addressing.
13820 @itemize
13821 @item
13822 The startup code initializes the @code{RAMP} special function
13823 registers with zero.
13825 @item
13826 If a @ref{AVR Named Address Spaces,named address space} other than
13827 generic or @code{__flash} is used, then @code{RAMPZ} is set
13828 as needed before the operation.
13830 @item
13831 If the device supports RAM larger than 64@tie{}KiB and the compiler
13832 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13833 is reset to zero after the operation.
13835 @item
13836 If the device comes with a specific @code{RAMP} register, the ISR
13837 prologue/epilogue saves/restores that SFR and initializes it with
13838 zero in case the ISR code might (implicitly) use it.
13840 @item
13841 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13842 If you use inline assembler to read from locations outside the
13843 16-bit address range and change one of the @code{RAMP} registers,
13844 you must reset it to zero after the access.
13846 @end itemize
13848 @subsubsection AVR Built-in Macros
13850 GCC defines several built-in macros so that the user code can test
13851 for the presence or absence of features.  Almost any of the following
13852 built-in macros are deduced from device capabilities and thus
13853 triggered by the @option{-mmcu=} command-line option.
13855 For even more AVR-specific built-in macros see
13856 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13858 @table @code
13860 @item __AVR_ARCH__
13861 Build-in macro that resolves to a decimal number that identifies the
13862 architecture and depends on the @option{-mmcu=@var{mcu}} option.
13863 Possible values are:
13865 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13866 @code{4}, @code{5}, @code{51}, @code{6}
13868 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
13869 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
13871 respectively and
13873 @code{100}, @code{102}, @code{104},
13874 @code{105}, @code{106}, @code{107}
13876 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
13877 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
13878 If @var{mcu} specifies a device, this built-in macro is set
13879 accordingly. For example, with @option{-mmcu=atmega8} the macro is
13880 defined to @code{4}.
13882 @item __AVR_@var{Device}__
13883 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
13884 the device's name. For example, @option{-mmcu=atmega8} defines the
13885 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
13886 @code{__AVR_ATtiny261A__}, etc.
13888 The built-in macros' names follow
13889 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13890 the device name as from the AVR user manual. The difference between
13891 @var{Device} in the built-in macro and @var{device} in
13892 @option{-mmcu=@var{device}} is that the latter is always lowercase.
13894 If @var{device} is not a device but only a core architecture like
13895 @samp{avr51}, this macro is not defined.
13897 @item __AVR_DEVICE_NAME__
13898 Setting @option{-mmcu=@var{device}} defines this built-in macro to
13899 the device's name. For example, with @option{-mmcu=atmega8} the macro
13900 is defined to @code{atmega8}.
13902 If @var{device} is not a device but only a core architecture like
13903 @samp{avr51}, this macro is not defined.
13905 @item __AVR_XMEGA__
13906 The device / architecture belongs to the XMEGA family of devices.
13908 @item __AVR_HAVE_ELPM__
13909 The device has the the @code{ELPM} instruction.
13911 @item __AVR_HAVE_ELPMX__
13912 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13913 R@var{n},Z+} instructions.
13915 @item __AVR_HAVE_MOVW__
13916 The device has the @code{MOVW} instruction to perform 16-bit
13917 register-register moves.
13919 @item __AVR_HAVE_LPMX__
13920 The device has the @code{LPM R@var{n},Z} and
13921 @code{LPM R@var{n},Z+} instructions.
13923 @item __AVR_HAVE_MUL__
13924 The device has a hardware multiplier. 
13926 @item __AVR_HAVE_JMP_CALL__
13927 The device has the @code{JMP} and @code{CALL} instructions.
13928 This is the case for devices with at least 16@tie{}KiB of program
13929 memory.
13931 @item __AVR_HAVE_EIJMP_EICALL__
13932 @itemx __AVR_3_BYTE_PC__
13933 The device has the @code{EIJMP} and @code{EICALL} instructions.
13934 This is the case for devices with more than 128@tie{}KiB of program memory.
13935 This also means that the program counter
13936 (PC) is 3@tie{}bytes wide.
13938 @item __AVR_2_BYTE_PC__
13939 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13940 with up to 128@tie{}KiB of program memory.
13942 @item __AVR_HAVE_8BIT_SP__
13943 @itemx __AVR_HAVE_16BIT_SP__
13944 The stack pointer (SP) register is treated as 8-bit respectively
13945 16-bit register by the compiler.
13946 The definition of these macros is affected by @option{-mtiny-stack}.
13948 @item __AVR_HAVE_SPH__
13949 @itemx __AVR_SP8__
13950 The device has the SPH (high part of stack pointer) special function
13951 register or has an 8-bit stack pointer, respectively.
13952 The definition of these macros is affected by @option{-mmcu=} and
13953 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
13954 by @option{-msp8}.
13956 @item __AVR_HAVE_RAMPD__
13957 @itemx __AVR_HAVE_RAMPX__
13958 @itemx __AVR_HAVE_RAMPY__
13959 @itemx __AVR_HAVE_RAMPZ__
13960 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13961 @code{RAMPZ} special function register, respectively.
13963 @item __NO_INTERRUPTS__
13964 This macro reflects the @option{-mno-interrupts} command-line option.
13966 @item __AVR_ERRATA_SKIP__
13967 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13968 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13969 instructions because of a hardware erratum.  Skip instructions are
13970 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13971 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13972 set.
13974 @item __AVR_ISA_RMW__
13975 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13977 @item __AVR_SFR_OFFSET__=@var{offset}
13978 Instructions that can address I/O special function registers directly
13979 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13980 address as if addressed by an instruction to access RAM like @code{LD}
13981 or @code{STS}. This offset depends on the device architecture and has
13982 to be subtracted from the RAM address in order to get the
13983 respective I/O@tie{}address.
13985 @item __WITH_AVRLIBC__
13986 The compiler is configured to be used together with AVR-Libc.
13987 See the @option{--with-avrlibc} configure option.
13989 @end table
13991 @node Blackfin Options
13992 @subsection Blackfin Options
13993 @cindex Blackfin Options
13995 @table @gcctabopt
13996 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13997 @opindex mcpu=
13998 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13999 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14000 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14001 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14002 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14003 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14004 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14005 @samp{bf561}, @samp{bf592}.
14007 The optional @var{sirevision} specifies the silicon revision of the target
14008 Blackfin processor.  Any workarounds available for the targeted silicon revision
14009 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14010 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14011 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14012 hexadecimal digits representing the major and minor numbers in the silicon
14013 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14014 is not defined.  If @var{sirevision} is @samp{any}, the
14015 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14016 If this optional @var{sirevision} is not used, GCC assumes the latest known
14017 silicon revision of the targeted Blackfin processor.
14019 GCC defines a preprocessor macro for the specified @var{cpu}.
14020 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14021 provided by libgloss to be linked in if @option{-msim} is not given.
14023 Without this option, @samp{bf532} is used as the processor by default.
14025 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14026 only the preprocessor macro is defined.
14028 @item -msim
14029 @opindex msim
14030 Specifies that the program will be run on the simulator.  This causes
14031 the simulator BSP provided by libgloss to be linked in.  This option
14032 has effect only for @samp{bfin-elf} toolchain.
14033 Certain other options, such as @option{-mid-shared-library} and
14034 @option{-mfdpic}, imply @option{-msim}.
14036 @item -momit-leaf-frame-pointer
14037 @opindex momit-leaf-frame-pointer
14038 Don't keep the frame pointer in a register for leaf functions.  This
14039 avoids the instructions to save, set up and restore frame pointers and
14040 makes an extra register available in leaf functions.  The option
14041 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14042 which might make debugging harder.
14044 @item -mspecld-anomaly
14045 @opindex mspecld-anomaly
14046 When enabled, the compiler ensures that the generated code does not
14047 contain speculative loads after jump instructions. If this option is used,
14048 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14050 @item -mno-specld-anomaly
14051 @opindex mno-specld-anomaly
14052 Don't generate extra code to prevent speculative loads from occurring.
14054 @item -mcsync-anomaly
14055 @opindex mcsync-anomaly
14056 When enabled, the compiler ensures that the generated code does not
14057 contain CSYNC or SSYNC instructions too soon after conditional branches.
14058 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14060 @item -mno-csync-anomaly
14061 @opindex mno-csync-anomaly
14062 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14063 occurring too soon after a conditional branch.
14065 @item -mlow-64k
14066 @opindex mlow-64k
14067 When enabled, the compiler is free to take advantage of the knowledge that
14068 the entire program fits into the low 64k of memory.
14070 @item -mno-low-64k
14071 @opindex mno-low-64k
14072 Assume that the program is arbitrarily large.  This is the default.
14074 @item -mstack-check-l1
14075 @opindex mstack-check-l1
14076 Do stack checking using information placed into L1 scratchpad memory by the
14077 uClinux kernel.
14079 @item -mid-shared-library
14080 @opindex mid-shared-library
14081 Generate code that supports shared libraries via the library ID method.
14082 This allows for execute in place and shared libraries in an environment
14083 without virtual memory management.  This option implies @option{-fPIC}.
14084 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14086 @item -mno-id-shared-library
14087 @opindex mno-id-shared-library
14088 Generate code that doesn't assume ID-based shared libraries are being used.
14089 This is the default.
14091 @item -mleaf-id-shared-library
14092 @opindex mleaf-id-shared-library
14093 Generate code that supports shared libraries via the library ID method,
14094 but assumes that this library or executable won't link against any other
14095 ID shared libraries.  That allows the compiler to use faster code for jumps
14096 and calls.
14098 @item -mno-leaf-id-shared-library
14099 @opindex mno-leaf-id-shared-library
14100 Do not assume that the code being compiled won't link against any ID shared
14101 libraries.  Slower code is generated for jump and call insns.
14103 @item -mshared-library-id=n
14104 @opindex mshared-library-id
14105 Specifies the identification number of the ID-based shared library being
14106 compiled.  Specifying a value of 0 generates more compact code; specifying
14107 other values forces the allocation of that number to the current
14108 library but is no more space- or time-efficient than omitting this option.
14110 @item -msep-data
14111 @opindex msep-data
14112 Generate code that allows the data segment to be located in a different
14113 area of memory from the text segment.  This allows for execute in place in
14114 an environment without virtual memory management by eliminating relocations
14115 against the text section.
14117 @item -mno-sep-data
14118 @opindex mno-sep-data
14119 Generate code that assumes that the data segment follows the text segment.
14120 This is the default.
14122 @item -mlong-calls
14123 @itemx -mno-long-calls
14124 @opindex mlong-calls
14125 @opindex mno-long-calls
14126 Tells the compiler to perform function calls by first loading the
14127 address of the function into a register and then performing a subroutine
14128 call on this register.  This switch is needed if the target function
14129 lies outside of the 24-bit addressing range of the offset-based
14130 version of subroutine call instruction.
14132 This feature is not enabled by default.  Specifying
14133 @option{-mno-long-calls} restores the default behavior.  Note these
14134 switches have no effect on how the compiler generates code to handle
14135 function calls via function pointers.
14137 @item -mfast-fp
14138 @opindex mfast-fp
14139 Link with the fast floating-point library. This library relaxes some of
14140 the IEEE floating-point standard's rules for checking inputs against
14141 Not-a-Number (NAN), in the interest of performance.
14143 @item -minline-plt
14144 @opindex minline-plt
14145 Enable inlining of PLT entries in function calls to functions that are
14146 not known to bind locally.  It has no effect without @option{-mfdpic}.
14148 @item -mmulticore
14149 @opindex mmulticore
14150 Build a standalone application for multicore Blackfin processors. 
14151 This option causes proper start files and link scripts supporting 
14152 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
14153 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
14155 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
14156 selects the one-application-per-core programming model.  Without
14157 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
14158 programming model is used. In this model, the main function of Core B
14159 should be named as @code{coreb_main}.
14161 If this option is not used, the single-core application programming
14162 model is used.
14164 @item -mcorea
14165 @opindex mcorea
14166 Build a standalone application for Core A of BF561 when using
14167 the one-application-per-core programming model. Proper start files
14168 and link scripts are used to support Core A, and the macro
14169 @code{__BFIN_COREA} is defined.
14170 This option can only be used in conjunction with @option{-mmulticore}.
14172 @item -mcoreb
14173 @opindex mcoreb
14174 Build a standalone application for Core B of BF561 when using
14175 the one-application-per-core programming model. Proper start files
14176 and link scripts are used to support Core B, and the macro
14177 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
14178 should be used instead of @code{main}. 
14179 This option can only be used in conjunction with @option{-mmulticore}.
14181 @item -msdram
14182 @opindex msdram
14183 Build a standalone application for SDRAM. Proper start files and
14184 link scripts are used to put the application into SDRAM, and the macro
14185 @code{__BFIN_SDRAM} is defined.
14186 The loader should initialize SDRAM before loading the application.
14188 @item -micplb
14189 @opindex micplb
14190 Assume that ICPLBs are enabled at run time.  This has an effect on certain
14191 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
14192 are enabled; for standalone applications the default is off.
14193 @end table
14195 @node C6X Options
14196 @subsection C6X Options
14197 @cindex C6X Options
14199 @table @gcctabopt
14200 @item -march=@var{name}
14201 @opindex march
14202 This specifies the name of the target architecture.  GCC uses this
14203 name to determine what kind of instructions it can emit when generating
14204 assembly code.  Permissible names are: @samp{c62x},
14205 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
14207 @item -mbig-endian
14208 @opindex mbig-endian
14209 Generate code for a big-endian target.
14211 @item -mlittle-endian
14212 @opindex mlittle-endian
14213 Generate code for a little-endian target.  This is the default.
14215 @item -msim
14216 @opindex msim
14217 Choose startup files and linker script suitable for the simulator.
14219 @item -msdata=default
14220 @opindex msdata=default
14221 Put small global and static data in the @code{.neardata} section,
14222 which is pointed to by register @code{B14}.  Put small uninitialized
14223 global and static data in the @code{.bss} section, which is adjacent
14224 to the @code{.neardata} section.  Put small read-only data into the
14225 @code{.rodata} section.  The corresponding sections used for large
14226 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
14228 @item -msdata=all
14229 @opindex msdata=all
14230 Put all data, not just small objects, into the sections reserved for
14231 small data, and use addressing relative to the @code{B14} register to
14232 access them.
14234 @item -msdata=none
14235 @opindex msdata=none
14236 Make no use of the sections reserved for small data, and use absolute
14237 addresses to access all data.  Put all initialized global and static
14238 data in the @code{.fardata} section, and all uninitialized data in the
14239 @code{.far} section.  Put all constant data into the @code{.const}
14240 section.
14241 @end table
14243 @node CRIS Options
14244 @subsection CRIS Options
14245 @cindex CRIS Options
14247 These options are defined specifically for the CRIS ports.
14249 @table @gcctabopt
14250 @item -march=@var{architecture-type}
14251 @itemx -mcpu=@var{architecture-type}
14252 @opindex march
14253 @opindex mcpu
14254 Generate code for the specified architecture.  The choices for
14255 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
14256 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
14257 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
14258 @samp{v10}.
14260 @item -mtune=@var{architecture-type}
14261 @opindex mtune
14262 Tune to @var{architecture-type} everything applicable about the generated
14263 code, except for the ABI and the set of available instructions.  The
14264 choices for @var{architecture-type} are the same as for
14265 @option{-march=@var{architecture-type}}.
14267 @item -mmax-stack-frame=@var{n}
14268 @opindex mmax-stack-frame
14269 Warn when the stack frame of a function exceeds @var{n} bytes.
14271 @item -metrax4
14272 @itemx -metrax100
14273 @opindex metrax4
14274 @opindex metrax100
14275 The options @option{-metrax4} and @option{-metrax100} are synonyms for
14276 @option{-march=v3} and @option{-march=v8} respectively.
14278 @item -mmul-bug-workaround
14279 @itemx -mno-mul-bug-workaround
14280 @opindex mmul-bug-workaround
14281 @opindex mno-mul-bug-workaround
14282 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
14283 models where it applies.  This option is active by default.
14285 @item -mpdebug
14286 @opindex mpdebug
14287 Enable CRIS-specific verbose debug-related information in the assembly
14288 code.  This option also has the effect of turning off the @samp{#NO_APP}
14289 formatted-code indicator to the assembler at the beginning of the
14290 assembly file.
14292 @item -mcc-init
14293 @opindex mcc-init
14294 Do not use condition-code results from previous instruction; always emit
14295 compare and test instructions before use of condition codes.
14297 @item -mno-side-effects
14298 @opindex mno-side-effects
14299 Do not emit instructions with side effects in addressing modes other than
14300 post-increment.
14302 @item -mstack-align
14303 @itemx -mno-stack-align
14304 @itemx -mdata-align
14305 @itemx -mno-data-align
14306 @itemx -mconst-align
14307 @itemx -mno-const-align
14308 @opindex mstack-align
14309 @opindex mno-stack-align
14310 @opindex mdata-align
14311 @opindex mno-data-align
14312 @opindex mconst-align
14313 @opindex mno-const-align
14314 These options (@samp{no-} options) arrange (eliminate arrangements) for the
14315 stack frame, individual data and constants to be aligned for the maximum
14316 single data access size for the chosen CPU model.  The default is to
14317 arrange for 32-bit alignment.  ABI details such as structure layout are
14318 not affected by these options.
14320 @item -m32-bit
14321 @itemx -m16-bit
14322 @itemx -m8-bit
14323 @opindex m32-bit
14324 @opindex m16-bit
14325 @opindex m8-bit
14326 Similar to the stack- data- and const-align options above, these options
14327 arrange for stack frame, writable data and constants to all be 32-bit,
14328 16-bit or 8-bit aligned.  The default is 32-bit alignment.
14330 @item -mno-prologue-epilogue
14331 @itemx -mprologue-epilogue
14332 @opindex mno-prologue-epilogue
14333 @opindex mprologue-epilogue
14334 With @option{-mno-prologue-epilogue}, the normal function prologue and
14335 epilogue which set up the stack frame are omitted and no return
14336 instructions or return sequences are generated in the code.  Use this
14337 option only together with visual inspection of the compiled code: no
14338 warnings or errors are generated when call-saved registers must be saved,
14339 or storage for local variables needs to be allocated.
14341 @item -mno-gotplt
14342 @itemx -mgotplt
14343 @opindex mno-gotplt
14344 @opindex mgotplt
14345 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
14346 instruction sequences that load addresses for functions from the PLT part
14347 of the GOT rather than (traditional on other architectures) calls to the
14348 PLT@.  The default is @option{-mgotplt}.
14350 @item -melf
14351 @opindex melf
14352 Legacy no-op option only recognized with the cris-axis-elf and
14353 cris-axis-linux-gnu targets.
14355 @item -mlinux
14356 @opindex mlinux
14357 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
14359 @item -sim
14360 @opindex sim
14361 This option, recognized for the cris-axis-elf, arranges
14362 to link with input-output functions from a simulator library.  Code,
14363 initialized data and zero-initialized data are allocated consecutively.
14365 @item -sim2
14366 @opindex sim2
14367 Like @option{-sim}, but pass linker options to locate initialized data at
14368 0x40000000 and zero-initialized data at 0x80000000.
14369 @end table
14371 @node CR16 Options
14372 @subsection CR16 Options
14373 @cindex CR16 Options
14375 These options are defined specifically for the CR16 ports.
14377 @table @gcctabopt
14379 @item -mmac
14380 @opindex mmac
14381 Enable the use of multiply-accumulate instructions. Disabled by default.
14383 @item -mcr16cplus
14384 @itemx -mcr16c
14385 @opindex mcr16cplus
14386 @opindex mcr16c
14387 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14388 is default.
14390 @item -msim
14391 @opindex msim
14392 Links the library libsim.a which is in compatible with simulator. Applicable
14393 to ELF compiler only.
14395 @item -mint32
14396 @opindex mint32
14397 Choose integer type as 32-bit wide.
14399 @item -mbit-ops
14400 @opindex mbit-ops
14401 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14403 @item -mdata-model=@var{model}
14404 @opindex mdata-model
14405 Choose a data model. The choices for @var{model} are @samp{near},
14406 @samp{far} or @samp{medium}. @samp{medium} is default.
14407 However, @samp{far} is not valid with @option{-mcr16c}, as the
14408 CR16C architecture does not support the far data model.
14409 @end table
14411 @node Darwin Options
14412 @subsection Darwin Options
14413 @cindex Darwin options
14415 These options are defined for all architectures running the Darwin operating
14416 system.
14418 FSF GCC on Darwin does not create ``fat'' object files; it creates
14419 an object file for the single architecture that GCC was built to
14420 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14421 @option{-arch} options are used; it does so by running the compiler or
14422 linker multiple times and joining the results together with
14423 @file{lipo}.
14425 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14426 @samp{i686}) is determined by the flags that specify the ISA
14427 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14428 @option{-force_cpusubtype_ALL} option can be used to override this.
14430 The Darwin tools vary in their behavior when presented with an ISA
14431 mismatch.  The assembler, @file{as}, only permits instructions to
14432 be used that are valid for the subtype of the file it is generating,
14433 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14434 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14435 and prints an error if asked to create a shared library with a less
14436 restrictive subtype than its input files (for instance, trying to put
14437 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14438 for executables, @command{ld}, quietly gives the executable the most
14439 restrictive subtype of any of its input files.
14441 @table @gcctabopt
14442 @item -F@var{dir}
14443 @opindex F
14444 Add the framework directory @var{dir} to the head of the list of
14445 directories to be searched for header files.  These directories are
14446 interleaved with those specified by @option{-I} options and are
14447 scanned in a left-to-right order.
14449 A framework directory is a directory with frameworks in it.  A
14450 framework is a directory with a @file{Headers} and/or
14451 @file{PrivateHeaders} directory contained directly in it that ends
14452 in @file{.framework}.  The name of a framework is the name of this
14453 directory excluding the @file{.framework}.  Headers associated with
14454 the framework are found in one of those two directories, with
14455 @file{Headers} being searched first.  A subframework is a framework
14456 directory that is in a framework's @file{Frameworks} directory.
14457 Includes of subframework headers can only appear in a header of a
14458 framework that contains the subframework, or in a sibling subframework
14459 header.  Two subframeworks are siblings if they occur in the same
14460 framework.  A subframework should not have the same name as a
14461 framework; a warning is issued if this is violated.  Currently a
14462 subframework cannot have subframeworks; in the future, the mechanism
14463 may be extended to support this.  The standard frameworks can be found
14464 in @file{/System/Library/Frameworks} and
14465 @file{/Library/Frameworks}.  An example include looks like
14466 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14467 the name of the framework and @file{header.h} is found in the
14468 @file{PrivateHeaders} or @file{Headers} directory.
14470 @item -iframework@var{dir}
14471 @opindex iframework
14472 Like @option{-F} except the directory is a treated as a system
14473 directory.  The main difference between this @option{-iframework} and
14474 @option{-F} is that with @option{-iframework} the compiler does not
14475 warn about constructs contained within header files found via
14476 @var{dir}.  This option is valid only for the C family of languages.
14478 @item -gused
14479 @opindex gused
14480 Emit debugging information for symbols that are used.  For stabs
14481 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14482 This is by default ON@.
14484 @item -gfull
14485 @opindex gfull
14486 Emit debugging information for all symbols and types.
14488 @item -mmacosx-version-min=@var{version}
14489 The earliest version of MacOS X that this executable will run on
14490 is @var{version}.  Typical values of @var{version} include @code{10.1},
14491 @code{10.2}, and @code{10.3.9}.
14493 If the compiler was built to use the system's headers by default,
14494 then the default for this option is the system version on which the
14495 compiler is running, otherwise the default is to make choices that
14496 are compatible with as many systems and code bases as possible.
14498 @item -mkernel
14499 @opindex mkernel
14500 Enable kernel development mode.  The @option{-mkernel} option sets
14501 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14502 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14503 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14504 applicable.  This mode also sets @option{-mno-altivec},
14505 @option{-msoft-float}, @option{-fno-builtin} and
14506 @option{-mlong-branch} for PowerPC targets.
14508 @item -mone-byte-bool
14509 @opindex mone-byte-bool
14510 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
14511 By default @code{sizeof(bool)} is @code{4} when compiling for
14512 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
14513 option has no effect on x86.
14515 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14516 to generate code that is not binary compatible with code generated
14517 without that switch.  Using this switch may require recompiling all
14518 other modules in a program, including system libraries.  Use this
14519 switch to conform to a non-default data model.
14521 @item -mfix-and-continue
14522 @itemx -ffix-and-continue
14523 @itemx -findirect-data
14524 @opindex mfix-and-continue
14525 @opindex ffix-and-continue
14526 @opindex findirect-data
14527 Generate code suitable for fast turnaround development, such as to
14528 allow GDB to dynamically load @file{.o} files into already-running
14529 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14530 are provided for backwards compatibility.
14532 @item -all_load
14533 @opindex all_load
14534 Loads all members of static archive libraries.
14535 See man ld(1) for more information.
14537 @item -arch_errors_fatal
14538 @opindex arch_errors_fatal
14539 Cause the errors having to do with files that have the wrong architecture
14540 to be fatal.
14542 @item -bind_at_load
14543 @opindex bind_at_load
14544 Causes the output file to be marked such that the dynamic linker will
14545 bind all undefined references when the file is loaded or launched.
14547 @item -bundle
14548 @opindex bundle
14549 Produce a Mach-o bundle format file.
14550 See man ld(1) for more information.
14552 @item -bundle_loader @var{executable}
14553 @opindex bundle_loader
14554 This option specifies the @var{executable} that will load the build
14555 output file being linked.  See man ld(1) for more information.
14557 @item -dynamiclib
14558 @opindex dynamiclib
14559 When passed this option, GCC produces a dynamic library instead of
14560 an executable when linking, using the Darwin @file{libtool} command.
14562 @item -force_cpusubtype_ALL
14563 @opindex force_cpusubtype_ALL
14564 This causes GCC's output file to have the @samp{ALL} subtype, instead of
14565 one controlled by the @option{-mcpu} or @option{-march} option.
14567 @item -allowable_client  @var{client_name}
14568 @itemx -client_name
14569 @itemx -compatibility_version
14570 @itemx -current_version
14571 @itemx -dead_strip
14572 @itemx -dependency-file
14573 @itemx -dylib_file
14574 @itemx -dylinker_install_name
14575 @itemx -dynamic
14576 @itemx -exported_symbols_list
14577 @itemx -filelist
14578 @need 800
14579 @itemx -flat_namespace
14580 @itemx -force_flat_namespace
14581 @itemx -headerpad_max_install_names
14582 @itemx -image_base
14583 @itemx -init
14584 @itemx -install_name
14585 @itemx -keep_private_externs
14586 @itemx -multi_module
14587 @itemx -multiply_defined
14588 @itemx -multiply_defined_unused
14589 @need 800
14590 @itemx -noall_load
14591 @itemx -no_dead_strip_inits_and_terms
14592 @itemx -nofixprebinding
14593 @itemx -nomultidefs
14594 @itemx -noprebind
14595 @itemx -noseglinkedit
14596 @itemx -pagezero_size
14597 @itemx -prebind
14598 @itemx -prebind_all_twolevel_modules
14599 @itemx -private_bundle
14600 @need 800
14601 @itemx -read_only_relocs
14602 @itemx -sectalign
14603 @itemx -sectobjectsymbols
14604 @itemx -whyload
14605 @itemx -seg1addr
14606 @itemx -sectcreate
14607 @itemx -sectobjectsymbols
14608 @itemx -sectorder
14609 @itemx -segaddr
14610 @itemx -segs_read_only_addr
14611 @need 800
14612 @itemx -segs_read_write_addr
14613 @itemx -seg_addr_table
14614 @itemx -seg_addr_table_filename
14615 @itemx -seglinkedit
14616 @itemx -segprot
14617 @itemx -segs_read_only_addr
14618 @itemx -segs_read_write_addr
14619 @itemx -single_module
14620 @itemx -static
14621 @itemx -sub_library
14622 @need 800
14623 @itemx -sub_umbrella
14624 @itemx -twolevel_namespace
14625 @itemx -umbrella
14626 @itemx -undefined
14627 @itemx -unexported_symbols_list
14628 @itemx -weak_reference_mismatches
14629 @itemx -whatsloaded
14630 @opindex allowable_client
14631 @opindex client_name
14632 @opindex compatibility_version
14633 @opindex current_version
14634 @opindex dead_strip
14635 @opindex dependency-file
14636 @opindex dylib_file
14637 @opindex dylinker_install_name
14638 @opindex dynamic
14639 @opindex exported_symbols_list
14640 @opindex filelist
14641 @opindex flat_namespace
14642 @opindex force_flat_namespace
14643 @opindex headerpad_max_install_names
14644 @opindex image_base
14645 @opindex init
14646 @opindex install_name
14647 @opindex keep_private_externs
14648 @opindex multi_module
14649 @opindex multiply_defined
14650 @opindex multiply_defined_unused
14651 @opindex noall_load
14652 @opindex no_dead_strip_inits_and_terms
14653 @opindex nofixprebinding
14654 @opindex nomultidefs
14655 @opindex noprebind
14656 @opindex noseglinkedit
14657 @opindex pagezero_size
14658 @opindex prebind
14659 @opindex prebind_all_twolevel_modules
14660 @opindex private_bundle
14661 @opindex read_only_relocs
14662 @opindex sectalign
14663 @opindex sectobjectsymbols
14664 @opindex whyload
14665 @opindex seg1addr
14666 @opindex sectcreate
14667 @opindex sectobjectsymbols
14668 @opindex sectorder
14669 @opindex segaddr
14670 @opindex segs_read_only_addr
14671 @opindex segs_read_write_addr
14672 @opindex seg_addr_table
14673 @opindex seg_addr_table_filename
14674 @opindex seglinkedit
14675 @opindex segprot
14676 @opindex segs_read_only_addr
14677 @opindex segs_read_write_addr
14678 @opindex single_module
14679 @opindex static
14680 @opindex sub_library
14681 @opindex sub_umbrella
14682 @opindex twolevel_namespace
14683 @opindex umbrella
14684 @opindex undefined
14685 @opindex unexported_symbols_list
14686 @opindex weak_reference_mismatches
14687 @opindex whatsloaded
14688 These options are passed to the Darwin linker.  The Darwin linker man page
14689 describes them in detail.
14690 @end table
14692 @node DEC Alpha Options
14693 @subsection DEC Alpha Options
14695 These @samp{-m} options are defined for the DEC Alpha implementations:
14697 @table @gcctabopt
14698 @item -mno-soft-float
14699 @itemx -msoft-float
14700 @opindex mno-soft-float
14701 @opindex msoft-float
14702 Use (do not use) the hardware floating-point instructions for
14703 floating-point operations.  When @option{-msoft-float} is specified,
14704 functions in @file{libgcc.a} are used to perform floating-point
14705 operations.  Unless they are replaced by routines that emulate the
14706 floating-point operations, or compiled in such a way as to call such
14707 emulations routines, these routines issue floating-point
14708 operations.   If you are compiling for an Alpha without floating-point
14709 operations, you must ensure that the library is built so as not to call
14710 them.
14712 Note that Alpha implementations without floating-point operations are
14713 required to have floating-point registers.
14715 @item -mfp-reg
14716 @itemx -mno-fp-regs
14717 @opindex mfp-reg
14718 @opindex mno-fp-regs
14719 Generate code that uses (does not use) the floating-point register set.
14720 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14721 register set is not used, floating-point operands are passed in integer
14722 registers as if they were integers and floating-point results are passed
14723 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14724 so any function with a floating-point argument or return value called by code
14725 compiled with @option{-mno-fp-regs} must also be compiled with that
14726 option.
14728 A typical use of this option is building a kernel that does not use,
14729 and hence need not save and restore, any floating-point registers.
14731 @item -mieee
14732 @opindex mieee
14733 The Alpha architecture implements floating-point hardware optimized for
14734 maximum performance.  It is mostly compliant with the IEEE floating-point
14735 standard.  However, for full compliance, software assistance is
14736 required.  This option generates code fully IEEE-compliant code
14737 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14738 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14739 defined during compilation.  The resulting code is less efficient but is
14740 able to correctly support denormalized numbers and exceptional IEEE
14741 values such as not-a-number and plus/minus infinity.  Other Alpha
14742 compilers call this option @option{-ieee_with_no_inexact}.
14744 @item -mieee-with-inexact
14745 @opindex mieee-with-inexact
14746 This is like @option{-mieee} except the generated code also maintains
14747 the IEEE @var{inexact-flag}.  Turning on this option causes the
14748 generated code to implement fully-compliant IEEE math.  In addition to
14749 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14750 macro.  On some Alpha implementations the resulting code may execute
14751 significantly slower than the code generated by default.  Since there is
14752 very little code that depends on the @var{inexact-flag}, you should
14753 normally not specify this option.  Other Alpha compilers call this
14754 option @option{-ieee_with_inexact}.
14756 @item -mfp-trap-mode=@var{trap-mode}
14757 @opindex mfp-trap-mode
14758 This option controls what floating-point related traps are enabled.
14759 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14760 The trap mode can be set to one of four values:
14762 @table @samp
14763 @item n
14764 This is the default (normal) setting.  The only traps that are enabled
14765 are the ones that cannot be disabled in software (e.g., division by zero
14766 trap).
14768 @item u
14769 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14770 as well.
14772 @item su
14773 Like @samp{u}, but the instructions are marked to be safe for software
14774 completion (see Alpha architecture manual for details).
14776 @item sui
14777 Like @samp{su}, but inexact traps are enabled as well.
14778 @end table
14780 @item -mfp-rounding-mode=@var{rounding-mode}
14781 @opindex mfp-rounding-mode
14782 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14783 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14786 @table @samp
14787 @item n
14788 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14789 the nearest machine number or towards the even machine number in case
14790 of a tie.
14792 @item m
14793 Round towards minus infinity.
14795 @item c
14796 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14798 @item d
14799 Dynamic rounding mode.  A field in the floating-point control register
14800 (@var{fpcr}, see Alpha architecture reference manual) controls the
14801 rounding mode in effect.  The C library initializes this register for
14802 rounding towards plus infinity.  Thus, unless your program modifies the
14803 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14804 @end table
14806 @item -mtrap-precision=@var{trap-precision}
14807 @opindex mtrap-precision
14808 In the Alpha architecture, floating-point traps are imprecise.  This
14809 means without software assistance it is impossible to recover from a
14810 floating trap and program execution normally needs to be terminated.
14811 GCC can generate code that can assist operating system trap handlers
14812 in determining the exact location that caused a floating-point trap.
14813 Depending on the requirements of an application, different levels of
14814 precisions can be selected:
14816 @table @samp
14817 @item p
14818 Program precision.  This option is the default and means a trap handler
14819 can only identify which program caused a floating-point exception.
14821 @item f
14822 Function precision.  The trap handler can determine the function that
14823 caused a floating-point exception.
14825 @item i
14826 Instruction precision.  The trap handler can determine the exact
14827 instruction that caused a floating-point exception.
14828 @end table
14830 Other Alpha compilers provide the equivalent options called
14831 @option{-scope_safe} and @option{-resumption_safe}.
14833 @item -mieee-conformant
14834 @opindex mieee-conformant
14835 This option marks the generated code as IEEE conformant.  You must not
14836 use this option unless you also specify @option{-mtrap-precision=i} and either
14837 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14838 is to emit the line @samp{.eflag 48} in the function prologue of the
14839 generated assembly file.
14841 @item -mbuild-constants
14842 @opindex mbuild-constants
14843 Normally GCC examines a 32- or 64-bit integer constant to
14844 see if it can construct it from smaller constants in two or three
14845 instructions.  If it cannot, it outputs the constant as a literal and
14846 generates code to load it from the data segment at run time.
14848 Use this option to require GCC to construct @emph{all} integer constants
14849 using code, even if it takes more instructions (the maximum is six).
14851 You typically use this option to build a shared library dynamic
14852 loader.  Itself a shared library, it must relocate itself in memory
14853 before it can find the variables and constants in its own data segment.
14855 @item -mbwx
14856 @itemx -mno-bwx
14857 @itemx -mcix
14858 @itemx -mno-cix
14859 @itemx -mfix
14860 @itemx -mno-fix
14861 @itemx -mmax
14862 @itemx -mno-max
14863 @opindex mbwx
14864 @opindex mno-bwx
14865 @opindex mcix
14866 @opindex mno-cix
14867 @opindex mfix
14868 @opindex mno-fix
14869 @opindex mmax
14870 @opindex mno-max
14871 Indicate whether GCC should generate code to use the optional BWX,
14872 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14873 sets supported by the CPU type specified via @option{-mcpu=} option or that
14874 of the CPU on which GCC was built if none is specified.
14876 @item -mfloat-vax
14877 @itemx -mfloat-ieee
14878 @opindex mfloat-vax
14879 @opindex mfloat-ieee
14880 Generate code that uses (does not use) VAX F and G floating-point
14881 arithmetic instead of IEEE single and double precision.
14883 @item -mexplicit-relocs
14884 @itemx -mno-explicit-relocs
14885 @opindex mexplicit-relocs
14886 @opindex mno-explicit-relocs
14887 Older Alpha assemblers provided no way to generate symbol relocations
14888 except via assembler macros.  Use of these macros does not allow
14889 optimal instruction scheduling.  GNU binutils as of version 2.12
14890 supports a new syntax that allows the compiler to explicitly mark
14891 which relocations should apply to which instructions.  This option
14892 is mostly useful for debugging, as GCC detects the capabilities of
14893 the assembler when it is built and sets the default accordingly.
14895 @item -msmall-data
14896 @itemx -mlarge-data
14897 @opindex msmall-data
14898 @opindex mlarge-data
14899 When @option{-mexplicit-relocs} is in effect, static data is
14900 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14901 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14902 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14903 16-bit relocations off of the @code{$gp} register.  This limits the
14904 size of the small data area to 64KB, but allows the variables to be
14905 directly accessed via a single instruction.
14907 The default is @option{-mlarge-data}.  With this option the data area
14908 is limited to just below 2GB@.  Programs that require more than 2GB of
14909 data must use @code{malloc} or @code{mmap} to allocate the data in the
14910 heap instead of in the program's data segment.
14912 When generating code for shared libraries, @option{-fpic} implies
14913 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14915 @item -msmall-text
14916 @itemx -mlarge-text
14917 @opindex msmall-text
14918 @opindex mlarge-text
14919 When @option{-msmall-text} is used, the compiler assumes that the
14920 code of the entire program (or shared library) fits in 4MB, and is
14921 thus reachable with a branch instruction.  When @option{-msmall-data}
14922 is used, the compiler can assume that all local symbols share the
14923 same @code{$gp} value, and thus reduce the number of instructions
14924 required for a function call from 4 to 1.
14926 The default is @option{-mlarge-text}.
14928 @item -mcpu=@var{cpu_type}
14929 @opindex mcpu
14930 Set the instruction set and instruction scheduling parameters for
14931 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14932 style name or the corresponding chip number.  GCC supports scheduling
14933 parameters for the EV4, EV5 and EV6 family of processors and
14934 chooses the default values for the instruction set from the processor
14935 you specify.  If you do not specify a processor type, GCC defaults
14936 to the processor on which the compiler was built.
14938 Supported values for @var{cpu_type} are
14940 @table @samp
14941 @item ev4
14942 @itemx ev45
14943 @itemx 21064
14944 Schedules as an EV4 and has no instruction set extensions.
14946 @item ev5
14947 @itemx 21164
14948 Schedules as an EV5 and has no instruction set extensions.
14950 @item ev56
14951 @itemx 21164a
14952 Schedules as an EV5 and supports the BWX extension.
14954 @item pca56
14955 @itemx 21164pc
14956 @itemx 21164PC
14957 Schedules as an EV5 and supports the BWX and MAX extensions.
14959 @item ev6
14960 @itemx 21264
14961 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14963 @item ev67
14964 @itemx 21264a
14965 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14966 @end table
14968 Native toolchains also support the value @samp{native},
14969 which selects the best architecture option for the host processor.
14970 @option{-mcpu=native} has no effect if GCC does not recognize
14971 the processor.
14973 @item -mtune=@var{cpu_type}
14974 @opindex mtune
14975 Set only the instruction scheduling parameters for machine type
14976 @var{cpu_type}.  The instruction set is not changed.
14978 Native toolchains also support the value @samp{native},
14979 which selects the best architecture option for the host processor.
14980 @option{-mtune=native} has no effect if GCC does not recognize
14981 the processor.
14983 @item -mmemory-latency=@var{time}
14984 @opindex mmemory-latency
14985 Sets the latency the scheduler should assume for typical memory
14986 references as seen by the application.  This number is highly
14987 dependent on the memory access patterns used by the application
14988 and the size of the external cache on the machine.
14990 Valid options for @var{time} are
14992 @table @samp
14993 @item @var{number}
14994 A decimal number representing clock cycles.
14996 @item L1
14997 @itemx L2
14998 @itemx L3
14999 @itemx main
15000 The compiler contains estimates of the number of clock cycles for
15001 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15002 (also called Dcache, Scache, and Bcache), as well as to main memory.
15003 Note that L3 is only valid for EV5.
15005 @end table
15006 @end table
15008 @node FR30 Options
15009 @subsection FR30 Options
15010 @cindex FR30 Options
15012 These options are defined specifically for the FR30 port.
15014 @table @gcctabopt
15016 @item -msmall-model
15017 @opindex msmall-model
15018 Use the small address space model.  This can produce smaller code, but
15019 it does assume that all symbolic values and addresses fit into a
15020 20-bit range.
15022 @item -mno-lsim
15023 @opindex mno-lsim
15024 Assume that runtime support has been provided and so there is no need
15025 to include the simulator library (@file{libsim.a}) on the linker
15026 command line.
15028 @end table
15030 @node FRV Options
15031 @subsection FRV Options
15032 @cindex FRV Options
15034 @table @gcctabopt
15035 @item -mgpr-32
15036 @opindex mgpr-32
15038 Only use the first 32 general-purpose registers.
15040 @item -mgpr-64
15041 @opindex mgpr-64
15043 Use all 64 general-purpose registers.
15045 @item -mfpr-32
15046 @opindex mfpr-32
15048 Use only the first 32 floating-point registers.
15050 @item -mfpr-64
15051 @opindex mfpr-64
15053 Use all 64 floating-point registers.
15055 @item -mhard-float
15056 @opindex mhard-float
15058 Use hardware instructions for floating-point operations.
15060 @item -msoft-float
15061 @opindex msoft-float
15063 Use library routines for floating-point operations.
15065 @item -malloc-cc
15066 @opindex malloc-cc
15068 Dynamically allocate condition code registers.
15070 @item -mfixed-cc
15071 @opindex mfixed-cc
15073 Do not try to dynamically allocate condition code registers, only
15074 use @code{icc0} and @code{fcc0}.
15076 @item -mdword
15077 @opindex mdword
15079 Change ABI to use double word insns.
15081 @item -mno-dword
15082 @opindex mno-dword
15084 Do not use double word instructions.
15086 @item -mdouble
15087 @opindex mdouble
15089 Use floating-point double instructions.
15091 @item -mno-double
15092 @opindex mno-double
15094 Do not use floating-point double instructions.
15096 @item -mmedia
15097 @opindex mmedia
15099 Use media instructions.
15101 @item -mno-media
15102 @opindex mno-media
15104 Do not use media instructions.
15106 @item -mmuladd
15107 @opindex mmuladd
15109 Use multiply and add/subtract instructions.
15111 @item -mno-muladd
15112 @opindex mno-muladd
15114 Do not use multiply and add/subtract instructions.
15116 @item -mfdpic
15117 @opindex mfdpic
15119 Select the FDPIC ABI, which uses function descriptors to represent
15120 pointers to functions.  Without any PIC/PIE-related options, it
15121 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
15122 assumes GOT entries and small data are within a 12-bit range from the
15123 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
15124 are computed with 32 bits.
15125 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15127 @item -minline-plt
15128 @opindex minline-plt
15130 Enable inlining of PLT entries in function calls to functions that are
15131 not known to bind locally.  It has no effect without @option{-mfdpic}.
15132 It's enabled by default if optimizing for speed and compiling for
15133 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
15134 optimization option such as @option{-O3} or above is present in the
15135 command line.
15137 @item -mTLS
15138 @opindex mTLS
15140 Assume a large TLS segment when generating thread-local code.
15142 @item -mtls
15143 @opindex mtls
15145 Do not assume a large TLS segment when generating thread-local code.
15147 @item -mgprel-ro
15148 @opindex mgprel-ro
15150 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
15151 that is known to be in read-only sections.  It's enabled by default,
15152 except for @option{-fpic} or @option{-fpie}: even though it may help
15153 make the global offset table smaller, it trades 1 instruction for 4.
15154 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
15155 one of which may be shared by multiple symbols, and it avoids the need
15156 for a GOT entry for the referenced symbol, so it's more likely to be a
15157 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
15159 @item -multilib-library-pic
15160 @opindex multilib-library-pic
15162 Link with the (library, not FD) pic libraries.  It's implied by
15163 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
15164 @option{-fpic} without @option{-mfdpic}.  You should never have to use
15165 it explicitly.
15167 @item -mlinked-fp
15168 @opindex mlinked-fp
15170 Follow the EABI requirement of always creating a frame pointer whenever
15171 a stack frame is allocated.  This option is enabled by default and can
15172 be disabled with @option{-mno-linked-fp}.
15174 @item -mlong-calls
15175 @opindex mlong-calls
15177 Use indirect addressing to call functions outside the current
15178 compilation unit.  This allows the functions to be placed anywhere
15179 within the 32-bit address space.
15181 @item -malign-labels
15182 @opindex malign-labels
15184 Try to align labels to an 8-byte boundary by inserting NOPs into the
15185 previous packet.  This option only has an effect when VLIW packing
15186 is enabled.  It doesn't create new packets; it merely adds NOPs to
15187 existing ones.
15189 @item -mlibrary-pic
15190 @opindex mlibrary-pic
15192 Generate position-independent EABI code.
15194 @item -macc-4
15195 @opindex macc-4
15197 Use only the first four media accumulator registers.
15199 @item -macc-8
15200 @opindex macc-8
15202 Use all eight media accumulator registers.
15204 @item -mpack
15205 @opindex mpack
15207 Pack VLIW instructions.
15209 @item -mno-pack
15210 @opindex mno-pack
15212 Do not pack VLIW instructions.
15214 @item -mno-eflags
15215 @opindex mno-eflags
15217 Do not mark ABI switches in e_flags.
15219 @item -mcond-move
15220 @opindex mcond-move
15222 Enable the use of conditional-move instructions (default).
15224 This switch is mainly for debugging the compiler and will likely be removed
15225 in a future version.
15227 @item -mno-cond-move
15228 @opindex mno-cond-move
15230 Disable the use of conditional-move instructions.
15232 This switch is mainly for debugging the compiler and will likely be removed
15233 in a future version.
15235 @item -mscc
15236 @opindex mscc
15238 Enable the use of conditional set instructions (default).
15240 This switch is mainly for debugging the compiler and will likely be removed
15241 in a future version.
15243 @item -mno-scc
15244 @opindex mno-scc
15246 Disable the use of conditional set instructions.
15248 This switch is mainly for debugging the compiler and will likely be removed
15249 in a future version.
15251 @item -mcond-exec
15252 @opindex mcond-exec
15254 Enable the use of conditional execution (default).
15256 This switch is mainly for debugging the compiler and will likely be removed
15257 in a future version.
15259 @item -mno-cond-exec
15260 @opindex mno-cond-exec
15262 Disable the use of conditional execution.
15264 This switch is mainly for debugging the compiler and will likely be removed
15265 in a future version.
15267 @item -mvliw-branch
15268 @opindex mvliw-branch
15270 Run a pass to pack branches into VLIW instructions (default).
15272 This switch is mainly for debugging the compiler and will likely be removed
15273 in a future version.
15275 @item -mno-vliw-branch
15276 @opindex mno-vliw-branch
15278 Do not run a pass to pack branches into VLIW instructions.
15280 This switch is mainly for debugging the compiler and will likely be removed
15281 in a future version.
15283 @item -mmulti-cond-exec
15284 @opindex mmulti-cond-exec
15286 Enable optimization of @code{&&} and @code{||} in conditional execution
15287 (default).
15289 This switch is mainly for debugging the compiler and will likely be removed
15290 in a future version.
15292 @item -mno-multi-cond-exec
15293 @opindex mno-multi-cond-exec
15295 Disable optimization of @code{&&} and @code{||} in conditional execution.
15297 This switch is mainly for debugging the compiler and will likely be removed
15298 in a future version.
15300 @item -mnested-cond-exec
15301 @opindex mnested-cond-exec
15303 Enable nested conditional execution optimizations (default).
15305 This switch is mainly for debugging the compiler and will likely be removed
15306 in a future version.
15308 @item -mno-nested-cond-exec
15309 @opindex mno-nested-cond-exec
15311 Disable nested conditional execution optimizations.
15313 This switch is mainly for debugging the compiler and will likely be removed
15314 in a future version.
15316 @item -moptimize-membar
15317 @opindex moptimize-membar
15319 This switch removes redundant @code{membar} instructions from the
15320 compiler-generated code.  It is enabled by default.
15322 @item -mno-optimize-membar
15323 @opindex mno-optimize-membar
15325 This switch disables the automatic removal of redundant @code{membar}
15326 instructions from the generated code.
15328 @item -mtomcat-stats
15329 @opindex mtomcat-stats
15331 Cause gas to print out tomcat statistics.
15333 @item -mcpu=@var{cpu}
15334 @opindex mcpu
15336 Select the processor type for which to generate code.  Possible values are
15337 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
15338 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
15340 @end table
15342 @node GNU/Linux Options
15343 @subsection GNU/Linux Options
15345 These @samp{-m} options are defined for GNU/Linux targets:
15347 @table @gcctabopt
15348 @item -mglibc
15349 @opindex mglibc
15350 Use the GNU C library.  This is the default except
15351 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
15353 @item -muclibc
15354 @opindex muclibc
15355 Use uClibc C library.  This is the default on
15356 @samp{*-*-linux-*uclibc*} targets.
15358 @item -mbionic
15359 @opindex mbionic
15360 Use Bionic C library.  This is the default on
15361 @samp{*-*-linux-*android*} targets.
15363 @item -mandroid
15364 @opindex mandroid
15365 Compile code compatible with Android platform.  This is the default on
15366 @samp{*-*-linux-*android*} targets.
15368 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15369 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15370 this option makes the GCC driver pass Android-specific options to the linker.
15371 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15372 to be defined.
15374 @item -tno-android-cc
15375 @opindex tno-android-cc
15376 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15377 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15378 @option{-fno-rtti} by default.
15380 @item -tno-android-ld
15381 @opindex tno-android-ld
15382 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15383 linking options to the linker.
15385 @end table
15387 @node H8/300 Options
15388 @subsection H8/300 Options
15390 These @samp{-m} options are defined for the H8/300 implementations:
15392 @table @gcctabopt
15393 @item -mrelax
15394 @opindex mrelax
15395 Shorten some address references at link time, when possible; uses the
15396 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15397 ld, Using ld}, for a fuller description.
15399 @item -mh
15400 @opindex mh
15401 Generate code for the H8/300H@.
15403 @item -ms
15404 @opindex ms
15405 Generate code for the H8S@.
15407 @item -mn
15408 @opindex mn
15409 Generate code for the H8S and H8/300H in the normal mode.  This switch
15410 must be used either with @option{-mh} or @option{-ms}.
15412 @item -ms2600
15413 @opindex ms2600
15414 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15416 @item -mexr
15417 @opindex mexr
15418 Extended registers are stored on stack before execution of function
15419 with monitor attribute. Default option is @option{-mexr}.
15420 This option is valid only for H8S targets.
15422 @item -mno-exr
15423 @opindex mno-exr
15424 Extended registers are not stored on stack before execution of function 
15425 with monitor attribute. Default option is @option{-mno-exr}. 
15426 This option is valid only for H8S targets.
15428 @item -mint32
15429 @opindex mint32
15430 Make @code{int} data 32 bits by default.
15432 @item -malign-300
15433 @opindex malign-300
15434 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15435 The default for the H8/300H and H8S is to align longs and floats on
15436 4-byte boundaries.
15437 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15438 This option has no effect on the H8/300.
15439 @end table
15441 @node HPPA Options
15442 @subsection HPPA Options
15443 @cindex HPPA Options
15445 These @samp{-m} options are defined for the HPPA family of computers:
15447 @table @gcctabopt
15448 @item -march=@var{architecture-type}
15449 @opindex march
15450 Generate code for the specified architecture.  The choices for
15451 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15452 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15453 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15454 architecture option for your machine.  Code compiled for lower numbered
15455 architectures runs on higher numbered architectures, but not the
15456 other way around.
15458 @item -mpa-risc-1-0
15459 @itemx -mpa-risc-1-1
15460 @itemx -mpa-risc-2-0
15461 @opindex mpa-risc-1-0
15462 @opindex mpa-risc-1-1
15463 @opindex mpa-risc-2-0
15464 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15466 @item -mjump-in-delay
15467 @opindex mjump-in-delay
15468 This option is ignored and provided for compatibility purposes only.
15470 @item -mdisable-fpregs
15471 @opindex mdisable-fpregs
15472 Prevent floating-point registers from being used in any manner.  This is
15473 necessary for compiling kernels that perform lazy context switching of
15474 floating-point registers.  If you use this option and attempt to perform
15475 floating-point operations, the compiler aborts.
15477 @item -mdisable-indexing
15478 @opindex mdisable-indexing
15479 Prevent the compiler from using indexing address modes.  This avoids some
15480 rather obscure problems when compiling MIG generated code under MACH@.
15482 @item -mno-space-regs
15483 @opindex mno-space-regs
15484 Generate code that assumes the target has no space registers.  This allows
15485 GCC to generate faster indirect calls and use unscaled index address modes.
15487 Such code is suitable for level 0 PA systems and kernels.
15489 @item -mfast-indirect-calls
15490 @opindex mfast-indirect-calls
15491 Generate code that assumes calls never cross space boundaries.  This
15492 allows GCC to emit code that performs faster indirect calls.
15494 This option does not work in the presence of shared libraries or nested
15495 functions.
15497 @item -mfixed-range=@var{register-range}
15498 @opindex mfixed-range
15499 Generate code treating the given register range as fixed registers.
15500 A fixed register is one that the register allocator cannot use.  This is
15501 useful when compiling kernel code.  A register range is specified as
15502 two registers separated by a dash.  Multiple register ranges can be
15503 specified separated by a comma.
15505 @item -mlong-load-store
15506 @opindex mlong-load-store
15507 Generate 3-instruction load and store sequences as sometimes required by
15508 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15509 the HP compilers.
15511 @item -mportable-runtime
15512 @opindex mportable-runtime
15513 Use the portable calling conventions proposed by HP for ELF systems.
15515 @item -mgas
15516 @opindex mgas
15517 Enable the use of assembler directives only GAS understands.
15519 @item -mschedule=@var{cpu-type}
15520 @opindex mschedule
15521 Schedule code according to the constraints for the machine type
15522 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15523 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15524 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15525 proper scheduling option for your machine.  The default scheduling is
15526 @samp{8000}.
15528 @item -mlinker-opt
15529 @opindex mlinker-opt
15530 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15531 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15532 linkers in which they give bogus error messages when linking some programs.
15534 @item -msoft-float
15535 @opindex msoft-float
15536 Generate output containing library calls for floating point.
15537 @strong{Warning:} the requisite libraries are not available for all HPPA
15538 targets.  Normally the facilities of the machine's usual C compiler are
15539 used, but this cannot be done directly in cross-compilation.  You must make
15540 your own arrangements to provide suitable library functions for
15541 cross-compilation.
15543 @option{-msoft-float} changes the calling convention in the output file;
15544 therefore, it is only useful if you compile @emph{all} of a program with
15545 this option.  In particular, you need to compile @file{libgcc.a}, the
15546 library that comes with GCC, with @option{-msoft-float} in order for
15547 this to work.
15549 @item -msio
15550 @opindex msio
15551 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15552 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15553 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15554 options are available under HP-UX and HI-UX@.
15556 @item -mgnu-ld
15557 @opindex mgnu-ld
15558 Use options specific to GNU @command{ld}.
15559 This passes @option{-shared} to @command{ld} when
15560 building a shared library.  It is the default when GCC is configured,
15561 explicitly or implicitly, with the GNU linker.  This option does not
15562 affect which @command{ld} is called; it only changes what parameters
15563 are passed to that @command{ld}.
15564 The @command{ld} that is called is determined by the
15565 @option{--with-ld} configure option, GCC's program search path, and
15566 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15567 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15568 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15570 @item -mhp-ld
15571 @opindex mhp-ld
15572 Use options specific to HP @command{ld}.
15573 This passes @option{-b} to @command{ld} when building
15574 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15575 links.  It is the default when GCC is configured, explicitly or
15576 implicitly, with the HP linker.  This option does not affect
15577 which @command{ld} is called; it only changes what parameters are passed to that
15578 @command{ld}.
15579 The @command{ld} that is called is determined by the @option{--with-ld}
15580 configure option, GCC's program search path, and finally by the user's
15581 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15582 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15583 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15585 @item -mlong-calls
15586 @opindex mno-long-calls
15587 Generate code that uses long call sequences.  This ensures that a call
15588 is always able to reach linker generated stubs.  The default is to generate
15589 long calls only when the distance from the call site to the beginning
15590 of the function or translation unit, as the case may be, exceeds a
15591 predefined limit set by the branch type being used.  The limits for
15592 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15593 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15594 240,000 bytes.
15596 Distances are measured from the beginning of functions when using the
15597 @option{-ffunction-sections} option, or when using the @option{-mgas}
15598 and @option{-mno-portable-runtime} options together under HP-UX with
15599 the SOM linker.
15601 It is normally not desirable to use this option as it degrades
15602 performance.  However, it may be useful in large applications,
15603 particularly when partial linking is used to build the application.
15605 The types of long calls used depends on the capabilities of the
15606 assembler and linker, and the type of code being generated.  The
15607 impact on systems that support long absolute calls, and long pic
15608 symbol-difference or pc-relative calls should be relatively small.
15609 However, an indirect call is used on 32-bit ELF systems in pic code
15610 and it is quite long.
15612 @item -munix=@var{unix-std}
15613 @opindex march
15614 Generate compiler predefines and select a startfile for the specified
15615 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15616 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15617 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15618 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15619 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15620 and later.
15622 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15623 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15624 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15625 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15626 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15627 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15629 It is @emph{important} to note that this option changes the interfaces
15630 for various library routines.  It also affects the operational behavior
15631 of the C library.  Thus, @emph{extreme} care is needed in using this
15632 option.
15634 Library code that is intended to operate with more than one UNIX
15635 standard must test, set and restore the variable @code{__xpg4_extended_mask}
15636 as appropriate.  Most GNU software doesn't provide this capability.
15638 @item -nolibdld
15639 @opindex nolibdld
15640 Suppress the generation of link options to search libdld.sl when the
15641 @option{-static} option is specified on HP-UX 10 and later.
15643 @item -static
15644 @opindex static
15645 The HP-UX implementation of setlocale in libc has a dependency on
15646 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15647 when the @option{-static} option is specified, special link options
15648 are needed to resolve this dependency.
15650 On HP-UX 10 and later, the GCC driver adds the necessary options to
15651 link with libdld.sl when the @option{-static} option is specified.
15652 This causes the resulting binary to be dynamic.  On the 64-bit port,
15653 the linkers generate dynamic binaries by default in any case.  The
15654 @option{-nolibdld} option can be used to prevent the GCC driver from
15655 adding these link options.
15657 @item -threads
15658 @opindex threads
15659 Add support for multithreading with the @dfn{dce thread} library
15660 under HP-UX@.  This option sets flags for both the preprocessor and
15661 linker.
15662 @end table
15664 @node IA-64 Options
15665 @subsection IA-64 Options
15666 @cindex IA-64 Options
15668 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15670 @table @gcctabopt
15671 @item -mbig-endian
15672 @opindex mbig-endian
15673 Generate code for a big-endian target.  This is the default for HP-UX@.
15675 @item -mlittle-endian
15676 @opindex mlittle-endian
15677 Generate code for a little-endian target.  This is the default for AIX5
15678 and GNU/Linux.
15680 @item -mgnu-as
15681 @itemx -mno-gnu-as
15682 @opindex mgnu-as
15683 @opindex mno-gnu-as
15684 Generate (or don't) code for the GNU assembler.  This is the default.
15685 @c Also, this is the default if the configure option @option{--with-gnu-as}
15686 @c is used.
15688 @item -mgnu-ld
15689 @itemx -mno-gnu-ld
15690 @opindex mgnu-ld
15691 @opindex mno-gnu-ld
15692 Generate (or don't) code for the GNU linker.  This is the default.
15693 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15694 @c is used.
15696 @item -mno-pic
15697 @opindex mno-pic
15698 Generate code that does not use a global pointer register.  The result
15699 is not position independent code, and violates the IA-64 ABI@.
15701 @item -mvolatile-asm-stop
15702 @itemx -mno-volatile-asm-stop
15703 @opindex mvolatile-asm-stop
15704 @opindex mno-volatile-asm-stop
15705 Generate (or don't) a stop bit immediately before and after volatile asm
15706 statements.
15708 @item -mregister-names
15709 @itemx -mno-register-names
15710 @opindex mregister-names
15711 @opindex mno-register-names
15712 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15713 the stacked registers.  This may make assembler output more readable.
15715 @item -mno-sdata
15716 @itemx -msdata
15717 @opindex mno-sdata
15718 @opindex msdata
15719 Disable (or enable) optimizations that use the small data section.  This may
15720 be useful for working around optimizer bugs.
15722 @item -mconstant-gp
15723 @opindex mconstant-gp
15724 Generate code that uses a single constant global pointer value.  This is
15725 useful when compiling kernel code.
15727 @item -mauto-pic
15728 @opindex mauto-pic
15729 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15730 This is useful when compiling firmware code.
15732 @item -minline-float-divide-min-latency
15733 @opindex minline-float-divide-min-latency
15734 Generate code for inline divides of floating-point values
15735 using the minimum latency algorithm.
15737 @item -minline-float-divide-max-throughput
15738 @opindex minline-float-divide-max-throughput
15739 Generate code for inline divides of floating-point values
15740 using the maximum throughput algorithm.
15742 @item -mno-inline-float-divide
15743 @opindex mno-inline-float-divide
15744 Do not generate inline code for divides of floating-point values.
15746 @item -minline-int-divide-min-latency
15747 @opindex minline-int-divide-min-latency
15748 Generate code for inline divides of integer values
15749 using the minimum latency algorithm.
15751 @item -minline-int-divide-max-throughput
15752 @opindex minline-int-divide-max-throughput
15753 Generate code for inline divides of integer values
15754 using the maximum throughput algorithm.
15756 @item -mno-inline-int-divide
15757 @opindex mno-inline-int-divide
15758 Do not generate inline code for divides of integer values.
15760 @item -minline-sqrt-min-latency
15761 @opindex minline-sqrt-min-latency
15762 Generate code for inline square roots
15763 using the minimum latency algorithm.
15765 @item -minline-sqrt-max-throughput
15766 @opindex minline-sqrt-max-throughput
15767 Generate code for inline square roots
15768 using the maximum throughput algorithm.
15770 @item -mno-inline-sqrt
15771 @opindex mno-inline-sqrt
15772 Do not generate inline code for @code{sqrt}.
15774 @item -mfused-madd
15775 @itemx -mno-fused-madd
15776 @opindex mfused-madd
15777 @opindex mno-fused-madd
15778 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
15779 instructions.  The default is to use these instructions.
15781 @item -mno-dwarf2-asm
15782 @itemx -mdwarf2-asm
15783 @opindex mno-dwarf2-asm
15784 @opindex mdwarf2-asm
15785 Don't (or do) generate assembler code for the DWARF 2 line number debugging
15786 info.  This may be useful when not using the GNU assembler.
15788 @item -mearly-stop-bits
15789 @itemx -mno-early-stop-bits
15790 @opindex mearly-stop-bits
15791 @opindex mno-early-stop-bits
15792 Allow stop bits to be placed earlier than immediately preceding the
15793 instruction that triggered the stop bit.  This can improve instruction
15794 scheduling, but does not always do so.
15796 @item -mfixed-range=@var{register-range}
15797 @opindex mfixed-range
15798 Generate code treating the given register range as fixed registers.
15799 A fixed register is one that the register allocator cannot use.  This is
15800 useful when compiling kernel code.  A register range is specified as
15801 two registers separated by a dash.  Multiple register ranges can be
15802 specified separated by a comma.
15804 @item -mtls-size=@var{tls-size}
15805 @opindex mtls-size
15806 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
15809 @item -mtune=@var{cpu-type}
15810 @opindex mtune
15811 Tune the instruction scheduling for a particular CPU, Valid values are
15812 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15813 and @samp{mckinley}.
15815 @item -milp32
15816 @itemx -mlp64
15817 @opindex milp32
15818 @opindex mlp64
15819 Generate code for a 32-bit or 64-bit environment.
15820 The 32-bit environment sets int, long and pointer to 32 bits.
15821 The 64-bit environment sets int to 32 bits and long and pointer
15822 to 64 bits.  These are HP-UX specific flags.
15824 @item -mno-sched-br-data-spec
15825 @itemx -msched-br-data-spec
15826 @opindex mno-sched-br-data-spec
15827 @opindex msched-br-data-spec
15828 (Dis/En)able data speculative scheduling before reload.
15829 This results in generation of @code{ld.a} instructions and
15830 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15831 The default is 'disable'.
15833 @item -msched-ar-data-spec
15834 @itemx -mno-sched-ar-data-spec
15835 @opindex msched-ar-data-spec
15836 @opindex mno-sched-ar-data-spec
15837 (En/Dis)able data speculative scheduling after reload.
15838 This results in generation of @code{ld.a} instructions and
15839 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15840 The default is 'enable'.
15842 @item -mno-sched-control-spec
15843 @itemx -msched-control-spec
15844 @opindex mno-sched-control-spec
15845 @opindex msched-control-spec
15846 (Dis/En)able control speculative scheduling.  This feature is
15847 available only during region scheduling (i.e.@: before reload).
15848 This results in generation of the @code{ld.s} instructions and
15849 the corresponding check instructions @code{chk.s}.
15850 The default is 'disable'.
15852 @item -msched-br-in-data-spec
15853 @itemx -mno-sched-br-in-data-spec
15854 @opindex msched-br-in-data-spec
15855 @opindex mno-sched-br-in-data-spec
15856 (En/Dis)able speculative scheduling of the instructions that
15857 are dependent on the data speculative loads before reload.
15858 This is effective only with @option{-msched-br-data-spec} enabled.
15859 The default is 'enable'.
15861 @item -msched-ar-in-data-spec
15862 @itemx -mno-sched-ar-in-data-spec
15863 @opindex msched-ar-in-data-spec
15864 @opindex mno-sched-ar-in-data-spec
15865 (En/Dis)able speculative scheduling of the instructions that
15866 are dependent on the data speculative loads after reload.
15867 This is effective only with @option{-msched-ar-data-spec} enabled.
15868 The default is 'enable'.
15870 @item -msched-in-control-spec
15871 @itemx -mno-sched-in-control-spec
15872 @opindex msched-in-control-spec
15873 @opindex mno-sched-in-control-spec
15874 (En/Dis)able speculative scheduling of the instructions that
15875 are dependent on the control speculative loads.
15876 This is effective only with @option{-msched-control-spec} enabled.
15877 The default is 'enable'.
15879 @item -mno-sched-prefer-non-data-spec-insns
15880 @itemx -msched-prefer-non-data-spec-insns
15881 @opindex mno-sched-prefer-non-data-spec-insns
15882 @opindex msched-prefer-non-data-spec-insns
15883 If enabled, data-speculative instructions are chosen for schedule
15884 only if there are no other choices at the moment.  This makes
15885 the use of the data speculation much more conservative.
15886 The default is 'disable'.
15888 @item -mno-sched-prefer-non-control-spec-insns
15889 @itemx -msched-prefer-non-control-spec-insns
15890 @opindex mno-sched-prefer-non-control-spec-insns
15891 @opindex msched-prefer-non-control-spec-insns
15892 If enabled, control-speculative instructions are chosen for schedule
15893 only if there are no other choices at the moment.  This makes
15894 the use of the control speculation much more conservative.
15895 The default is 'disable'.
15897 @item -mno-sched-count-spec-in-critical-path
15898 @itemx -msched-count-spec-in-critical-path
15899 @opindex mno-sched-count-spec-in-critical-path
15900 @opindex msched-count-spec-in-critical-path
15901 If enabled, speculative dependencies are considered during
15902 computation of the instructions priorities.  This makes the use of the
15903 speculation a bit more conservative.
15904 The default is 'disable'.
15906 @item -msched-spec-ldc
15907 @opindex msched-spec-ldc
15908 Use a simple data speculation check.  This option is on by default.
15910 @item -msched-control-spec-ldc
15911 @opindex msched-spec-ldc
15912 Use a simple check for control speculation.  This option is on by default.
15914 @item -msched-stop-bits-after-every-cycle
15915 @opindex msched-stop-bits-after-every-cycle
15916 Place a stop bit after every cycle when scheduling.  This option is on
15917 by default.
15919 @item -msched-fp-mem-deps-zero-cost
15920 @opindex msched-fp-mem-deps-zero-cost
15921 Assume that floating-point stores and loads are not likely to cause a conflict
15922 when placed into the same instruction group.  This option is disabled by
15923 default.
15925 @item -msel-sched-dont-check-control-spec
15926 @opindex msel-sched-dont-check-control-spec
15927 Generate checks for control speculation in selective scheduling.
15928 This flag is disabled by default.
15930 @item -msched-max-memory-insns=@var{max-insns}
15931 @opindex msched-max-memory-insns
15932 Limit on the number of memory insns per instruction group, giving lower
15933 priority to subsequent memory insns attempting to schedule in the same
15934 instruction group. Frequently useful to prevent cache bank conflicts.
15935 The default value is 1.
15937 @item -msched-max-memory-insns-hard-limit
15938 @opindex msched-max-memory-insns-hard-limit
15939 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
15940 disallowing more than that number in an instruction group.
15941 Otherwise, the limit is ``soft'', meaning that non-memory operations
15942 are preferred when the limit is reached, but memory operations may still
15943 be scheduled.
15945 @end table
15947 @node LM32 Options
15948 @subsection LM32 Options
15949 @cindex LM32 options
15951 These @option{-m} options are defined for the LatticeMico32 architecture:
15953 @table @gcctabopt
15954 @item -mbarrel-shift-enabled
15955 @opindex mbarrel-shift-enabled
15956 Enable barrel-shift instructions.
15958 @item -mdivide-enabled
15959 @opindex mdivide-enabled
15960 Enable divide and modulus instructions.
15962 @item -mmultiply-enabled
15963 @opindex multiply-enabled
15964 Enable multiply instructions.
15966 @item -msign-extend-enabled
15967 @opindex msign-extend-enabled
15968 Enable sign extend instructions.
15970 @item -muser-enabled
15971 @opindex muser-enabled
15972 Enable user-defined instructions.
15974 @end table
15976 @node M32C Options
15977 @subsection M32C Options
15978 @cindex M32C options
15980 @table @gcctabopt
15981 @item -mcpu=@var{name}
15982 @opindex mcpu=
15983 Select the CPU for which code is generated.  @var{name} may be one of
15984 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
15985 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
15986 the M32C/80 series.
15988 @item -msim
15989 @opindex msim
15990 Specifies that the program will be run on the simulator.  This causes
15991 an alternate runtime library to be linked in which supports, for
15992 example, file I/O@.  You must not use this option when generating
15993 programs that will run on real hardware; you must provide your own
15994 runtime library for whatever I/O functions are needed.
15996 @item -memregs=@var{number}
15997 @opindex memregs=
15998 Specifies the number of memory-based pseudo-registers GCC uses
15999 during code generation.  These pseudo-registers are used like real
16000 registers, so there is a tradeoff between GCC's ability to fit the
16001 code into available registers, and the performance penalty of using
16002 memory instead of registers.  Note that all modules in a program must
16003 be compiled with the same value for this option.  Because of that, you
16004 must not use this option with GCC's default runtime libraries.
16006 @end table
16008 @node M32R/D Options
16009 @subsection M32R/D Options
16010 @cindex M32R/D options
16012 These @option{-m} options are defined for Renesas M32R/D architectures:
16014 @table @gcctabopt
16015 @item -m32r2
16016 @opindex m32r2
16017 Generate code for the M32R/2@.
16019 @item -m32rx
16020 @opindex m32rx
16021 Generate code for the M32R/X@.
16023 @item -m32r
16024 @opindex m32r
16025 Generate code for the M32R@.  This is the default.
16027 @item -mmodel=small
16028 @opindex mmodel=small
16029 Assume all objects live in the lower 16MB of memory (so that their addresses
16030 can be loaded with the @code{ld24} instruction), and assume all subroutines
16031 are reachable with the @code{bl} instruction.
16032 This is the default.
16034 The addressability of a particular object can be set with the
16035 @code{model} attribute.
16037 @item -mmodel=medium
16038 @opindex mmodel=medium
16039 Assume objects may be anywhere in the 32-bit address space (the compiler
16040 generates @code{seth/add3} instructions to load their addresses), and
16041 assume all subroutines are reachable with the @code{bl} instruction.
16043 @item -mmodel=large
16044 @opindex mmodel=large
16045 Assume objects may be anywhere in the 32-bit address space (the compiler
16046 generates @code{seth/add3} instructions to load their addresses), and
16047 assume subroutines may not be reachable with the @code{bl} instruction
16048 (the compiler generates the much slower @code{seth/add3/jl}
16049 instruction sequence).
16051 @item -msdata=none
16052 @opindex msdata=none
16053 Disable use of the small data area.  Variables are put into
16054 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16055 @code{section} attribute has been specified).
16056 This is the default.
16058 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16059 Objects may be explicitly put in the small data area with the
16060 @code{section} attribute using one of these sections.
16062 @item -msdata=sdata
16063 @opindex msdata=sdata
16064 Put small global and static data in the small data area, but do not
16065 generate special code to reference them.
16067 @item -msdata=use
16068 @opindex msdata=use
16069 Put small global and static data in the small data area, and generate
16070 special instructions to reference them.
16072 @item -G @var{num}
16073 @opindex G
16074 @cindex smaller data references
16075 Put global and static objects less than or equal to @var{num} bytes
16076 into the small data or BSS sections instead of the normal data or BSS
16077 sections.  The default value of @var{num} is 8.
16078 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16079 for this option to have any effect.
16081 All modules should be compiled with the same @option{-G @var{num}} value.
16082 Compiling with different values of @var{num} may or may not work; if it
16083 doesn't the linker gives an error message---incorrect code is not
16084 generated.
16086 @item -mdebug
16087 @opindex mdebug
16088 Makes the M32R-specific code in the compiler display some statistics
16089 that might help in debugging programs.
16091 @item -malign-loops
16092 @opindex malign-loops
16093 Align all loops to a 32-byte boundary.
16095 @item -mno-align-loops
16096 @opindex mno-align-loops
16097 Do not enforce a 32-byte alignment for loops.  This is the default.
16099 @item -missue-rate=@var{number}
16100 @opindex missue-rate=@var{number}
16101 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16102 or 2.
16104 @item -mbranch-cost=@var{number}
16105 @opindex mbranch-cost=@var{number}
16106 @var{number} can only be 1 or 2.  If it is 1 then branches are
16107 preferred over conditional code, if it is 2, then the opposite applies.
16109 @item -mflush-trap=@var{number}
16110 @opindex mflush-trap=@var{number}
16111 Specifies the trap number to use to flush the cache.  The default is
16112 12.  Valid numbers are between 0 and 15 inclusive.
16114 @item -mno-flush-trap
16115 @opindex mno-flush-trap
16116 Specifies that the cache cannot be flushed by using a trap.
16118 @item -mflush-func=@var{name}
16119 @opindex mflush-func=@var{name}
16120 Specifies the name of the operating system function to call to flush
16121 the cache.  The default is @samp{_flush_cache}, but a function call
16122 is only used if a trap is not available.
16124 @item -mno-flush-func
16125 @opindex mno-flush-func
16126 Indicates that there is no OS function for flushing the cache.
16128 @end table
16130 @node M680x0 Options
16131 @subsection M680x0 Options
16132 @cindex M680x0 options
16134 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16135 The default settings depend on which architecture was selected when
16136 the compiler was configured; the defaults for the most common choices
16137 are given below.
16139 @table @gcctabopt
16140 @item -march=@var{arch}
16141 @opindex march
16142 Generate code for a specific M680x0 or ColdFire instruction set
16143 architecture.  Permissible values of @var{arch} for M680x0
16144 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16145 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16146 architectures are selected according to Freescale's ISA classification
16147 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16148 @samp{isab} and @samp{isac}.
16150 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
16151 code for a ColdFire target.  The @var{arch} in this macro is one of the
16152 @option{-march} arguments given above.
16154 When used together, @option{-march} and @option{-mtune} select code
16155 that runs on a family of similar processors but that is optimized
16156 for a particular microarchitecture.
16158 @item -mcpu=@var{cpu}
16159 @opindex mcpu
16160 Generate code for a specific M680x0 or ColdFire processor.
16161 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16162 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16163 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16164 below, which also classifies the CPUs into families:
16166 @multitable @columnfractions 0.20 0.80
16167 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16168 @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}
16169 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16170 @item @samp{5206e} @tab @samp{5206e}
16171 @item @samp{5208} @tab @samp{5207} @samp{5208}
16172 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16173 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16174 @item @samp{5216} @tab @samp{5214} @samp{5216}
16175 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16176 @item @samp{5225} @tab @samp{5224} @samp{5225}
16177 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16178 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16179 @item @samp{5249} @tab @samp{5249}
16180 @item @samp{5250} @tab @samp{5250}
16181 @item @samp{5271} @tab @samp{5270} @samp{5271}
16182 @item @samp{5272} @tab @samp{5272}
16183 @item @samp{5275} @tab @samp{5274} @samp{5275}
16184 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16185 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16186 @item @samp{5307} @tab @samp{5307}
16187 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16188 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16189 @item @samp{5407} @tab @samp{5407}
16190 @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}
16191 @end multitable
16193 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16194 @var{arch} is compatible with @var{cpu}.  Other combinations of
16195 @option{-mcpu} and @option{-march} are rejected.
16197 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
16198 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
16199 where the value of @var{family} is given by the table above.
16201 @item -mtune=@var{tune}
16202 @opindex mtune
16203 Tune the code for a particular microarchitecture within the
16204 constraints set by @option{-march} and @option{-mcpu}.
16205 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16206 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16207 and @samp{cpu32}.  The ColdFire microarchitectures
16208 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16210 You can also use @option{-mtune=68020-40} for code that needs
16211 to run relatively well on 68020, 68030 and 68040 targets.
16212 @option{-mtune=68020-60} is similar but includes 68060 targets
16213 as well.  These two options select the same tuning decisions as
16214 @option{-m68020-40} and @option{-m68020-60} respectively.
16216 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
16217 when tuning for 680x0 architecture @var{arch}.  It also defines
16218 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16219 option is used.  If GCC is tuning for a range of architectures,
16220 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16221 it defines the macros for every architecture in the range.
16223 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
16224 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16225 of the arguments given above.
16227 @item -m68000
16228 @itemx -mc68000
16229 @opindex m68000
16230 @opindex mc68000
16231 Generate output for a 68000.  This is the default
16232 when the compiler is configured for 68000-based systems.
16233 It is equivalent to @option{-march=68000}.
16235 Use this option for microcontrollers with a 68000 or EC000 core,
16236 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16238 @item -m68010
16239 @opindex m68010
16240 Generate output for a 68010.  This is the default
16241 when the compiler is configured for 68010-based systems.
16242 It is equivalent to @option{-march=68010}.
16244 @item -m68020
16245 @itemx -mc68020
16246 @opindex m68020
16247 @opindex mc68020
16248 Generate output for a 68020.  This is the default
16249 when the compiler is configured for 68020-based systems.
16250 It is equivalent to @option{-march=68020}.
16252 @item -m68030
16253 @opindex m68030
16254 Generate output for a 68030.  This is the default when the compiler is
16255 configured for 68030-based systems.  It is equivalent to
16256 @option{-march=68030}.
16258 @item -m68040
16259 @opindex m68040
16260 Generate output for a 68040.  This is the default when the compiler is
16261 configured for 68040-based systems.  It is equivalent to
16262 @option{-march=68040}.
16264 This option inhibits the use of 68881/68882 instructions that have to be
16265 emulated by software on the 68040.  Use this option if your 68040 does not
16266 have code to emulate those instructions.
16268 @item -m68060
16269 @opindex m68060
16270 Generate output for a 68060.  This is the default when the compiler is
16271 configured for 68060-based systems.  It is equivalent to
16272 @option{-march=68060}.
16274 This option inhibits the use of 68020 and 68881/68882 instructions that
16275 have to be emulated by software on the 68060.  Use this option if your 68060
16276 does not have code to emulate those instructions.
16278 @item -mcpu32
16279 @opindex mcpu32
16280 Generate output for a CPU32.  This is the default
16281 when the compiler is configured for CPU32-based systems.
16282 It is equivalent to @option{-march=cpu32}.
16284 Use this option for microcontrollers with a
16285 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16286 68336, 68340, 68341, 68349 and 68360.
16288 @item -m5200
16289 @opindex m5200
16290 Generate output for a 520X ColdFire CPU@.  This is the default
16291 when the compiler is configured for 520X-based systems.
16292 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16293 in favor of that option.
16295 Use this option for microcontroller with a 5200 core, including
16296 the MCF5202, MCF5203, MCF5204 and MCF5206.
16298 @item -m5206e
16299 @opindex m5206e
16300 Generate output for a 5206e ColdFire CPU@.  The option is now
16301 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16303 @item -m528x
16304 @opindex m528x
16305 Generate output for a member of the ColdFire 528X family.
16306 The option is now deprecated in favor of the equivalent
16307 @option{-mcpu=528x}.
16309 @item -m5307
16310 @opindex m5307
16311 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16312 in favor of the equivalent @option{-mcpu=5307}.
16314 @item -m5407
16315 @opindex m5407
16316 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16317 in favor of the equivalent @option{-mcpu=5407}.
16319 @item -mcfv4e
16320 @opindex mcfv4e
16321 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16322 This includes use of hardware floating-point instructions.
16323 The option is equivalent to @option{-mcpu=547x}, and is now
16324 deprecated in favor of that option.
16326 @item -m68020-40
16327 @opindex m68020-40
16328 Generate output for a 68040, without using any of the new instructions.
16329 This results in code that can run relatively efficiently on either a
16330 68020/68881 or a 68030 or a 68040.  The generated code does use the
16331 68881 instructions that are emulated on the 68040.
16333 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16335 @item -m68020-60
16336 @opindex m68020-60
16337 Generate output for a 68060, without using any of the new instructions.
16338 This results in code that can run relatively efficiently on either a
16339 68020/68881 or a 68030 or a 68040.  The generated code does use the
16340 68881 instructions that are emulated on the 68060.
16342 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16344 @item -mhard-float
16345 @itemx -m68881
16346 @opindex mhard-float
16347 @opindex m68881
16348 Generate floating-point instructions.  This is the default for 68020
16349 and above, and for ColdFire devices that have an FPU@.  It defines the
16350 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
16351 on ColdFire targets.
16353 @item -msoft-float
16354 @opindex msoft-float
16355 Do not generate floating-point instructions; use library calls instead.
16356 This is the default for 68000, 68010, and 68832 targets.  It is also
16357 the default for ColdFire devices that have no FPU.
16359 @item -mdiv
16360 @itemx -mno-div
16361 @opindex mdiv
16362 @opindex mno-div
16363 Generate (do not generate) ColdFire hardware divide and remainder
16364 instructions.  If @option{-march} is used without @option{-mcpu},
16365 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16366 architectures.  Otherwise, the default is taken from the target CPU
16367 (either the default CPU, or the one specified by @option{-mcpu}).  For
16368 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16369 @option{-mcpu=5206e}.
16371 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
16373 @item -mshort
16374 @opindex mshort
16375 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16376 Additionally, parameters passed on the stack are also aligned to a
16377 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16379 @item -mno-short
16380 @opindex mno-short
16381 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16383 @item -mnobitfield
16384 @itemx -mno-bitfield
16385 @opindex mnobitfield
16386 @opindex mno-bitfield
16387 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16388 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16390 @item -mbitfield
16391 @opindex mbitfield
16392 Do use the bit-field instructions.  The @option{-m68020} option implies
16393 @option{-mbitfield}.  This is the default if you use a configuration
16394 designed for a 68020.
16396 @item -mrtd
16397 @opindex mrtd
16398 Use a different function-calling convention, in which functions
16399 that take a fixed number of arguments return with the @code{rtd}
16400 instruction, which pops their arguments while returning.  This
16401 saves one instruction in the caller since there is no need to pop
16402 the arguments there.
16404 This calling convention is incompatible with the one normally
16405 used on Unix, so you cannot use it if you need to call libraries
16406 compiled with the Unix compiler.
16408 Also, you must provide function prototypes for all functions that
16409 take variable numbers of arguments (including @code{printf});
16410 otherwise incorrect code is generated for calls to those
16411 functions.
16413 In addition, seriously incorrect code results if you call a
16414 function with too many arguments.  (Normally, extra arguments are
16415 harmlessly ignored.)
16417 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16418 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16420 @item -mno-rtd
16421 @opindex mno-rtd
16422 Do not use the calling conventions selected by @option{-mrtd}.
16423 This is the default.
16425 @item -malign-int
16426 @itemx -mno-align-int
16427 @opindex malign-int
16428 @opindex mno-align-int
16429 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16430 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16431 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16432 Aligning variables on 32-bit boundaries produces code that runs somewhat
16433 faster on processors with 32-bit busses at the expense of more memory.
16435 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16436 aligns structures containing the above types differently than
16437 most published application binary interface specifications for the m68k.
16439 @item -mpcrel
16440 @opindex mpcrel
16441 Use the pc-relative addressing mode of the 68000 directly, instead of
16442 using a global offset table.  At present, this option implies @option{-fpic},
16443 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16444 not presently supported with @option{-mpcrel}, though this could be supported for
16445 68020 and higher processors.
16447 @item -mno-strict-align
16448 @itemx -mstrict-align
16449 @opindex mno-strict-align
16450 @opindex mstrict-align
16451 Do not (do) assume that unaligned memory references are handled by
16452 the system.
16454 @item -msep-data
16455 Generate code that allows the data segment to be located in a different
16456 area of memory from the text segment.  This allows for execute-in-place in
16457 an environment without virtual memory management.  This option implies
16458 @option{-fPIC}.
16460 @item -mno-sep-data
16461 Generate code that assumes that the data segment follows the text segment.
16462 This is the default.
16464 @item -mid-shared-library
16465 Generate code that supports shared libraries via the library ID method.
16466 This allows for execute-in-place and shared libraries in an environment
16467 without virtual memory management.  This option implies @option{-fPIC}.
16469 @item -mno-id-shared-library
16470 Generate code that doesn't assume ID-based shared libraries are being used.
16471 This is the default.
16473 @item -mshared-library-id=n
16474 Specifies the identification number of the ID-based shared library being
16475 compiled.  Specifying a value of 0 generates more compact code; specifying
16476 other values forces the allocation of that number to the current
16477 library, but is no more space- or time-efficient than omitting this option.
16479 @item -mxgot
16480 @itemx -mno-xgot
16481 @opindex mxgot
16482 @opindex mno-xgot
16483 When generating position-independent code for ColdFire, generate code
16484 that works if the GOT has more than 8192 entries.  This code is
16485 larger and slower than code generated without this option.  On M680x0
16486 processors, this option is not needed; @option{-fPIC} suffices.
16488 GCC normally uses a single instruction to load values from the GOT@.
16489 While this is relatively efficient, it only works if the GOT
16490 is smaller than about 64k.  Anything larger causes the linker
16491 to report an error such as:
16493 @cindex relocation truncated to fit (ColdFire)
16494 @smallexample
16495 relocation truncated to fit: R_68K_GOT16O foobar
16496 @end smallexample
16498 If this happens, you should recompile your code with @option{-mxgot}.
16499 It should then work with very large GOTs.  However, code generated with
16500 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16501 the value of a global symbol.
16503 Note that some linkers, including newer versions of the GNU linker,
16504 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16505 you should only need to use @option{-mxgot} when compiling a single
16506 object file that accesses more than 8192 GOT entries.  Very few do.
16508 These options have no effect unless GCC is generating
16509 position-independent code.
16511 @end table
16513 @node MCore Options
16514 @subsection MCore Options
16515 @cindex MCore options
16517 These are the @samp{-m} options defined for the Motorola M*Core
16518 processors.
16520 @table @gcctabopt
16522 @item -mhardlit
16523 @itemx -mno-hardlit
16524 @opindex mhardlit
16525 @opindex mno-hardlit
16526 Inline constants into the code stream if it can be done in two
16527 instructions or less.
16529 @item -mdiv
16530 @itemx -mno-div
16531 @opindex mdiv
16532 @opindex mno-div
16533 Use the divide instruction.  (Enabled by default).
16535 @item -mrelax-immediate
16536 @itemx -mno-relax-immediate
16537 @opindex mrelax-immediate
16538 @opindex mno-relax-immediate
16539 Allow arbitrary-sized immediates in bit operations.
16541 @item -mwide-bitfields
16542 @itemx -mno-wide-bitfields
16543 @opindex mwide-bitfields
16544 @opindex mno-wide-bitfields
16545 Always treat bit-fields as @code{int}-sized.
16547 @item -m4byte-functions
16548 @itemx -mno-4byte-functions
16549 @opindex m4byte-functions
16550 @opindex mno-4byte-functions
16551 Force all functions to be aligned to a 4-byte boundary.
16553 @item -mcallgraph-data
16554 @itemx -mno-callgraph-data
16555 @opindex mcallgraph-data
16556 @opindex mno-callgraph-data
16557 Emit callgraph information.
16559 @item -mslow-bytes
16560 @itemx -mno-slow-bytes
16561 @opindex mslow-bytes
16562 @opindex mno-slow-bytes
16563 Prefer word access when reading byte quantities.
16565 @item -mlittle-endian
16566 @itemx -mbig-endian
16567 @opindex mlittle-endian
16568 @opindex mbig-endian
16569 Generate code for a little-endian target.
16571 @item -m210
16572 @itemx -m340
16573 @opindex m210
16574 @opindex m340
16575 Generate code for the 210 processor.
16577 @item -mno-lsim
16578 @opindex mno-lsim
16579 Assume that runtime support has been provided and so omit the
16580 simulator library (@file{libsim.a)} from the linker command line.
16582 @item -mstack-increment=@var{size}
16583 @opindex mstack-increment
16584 Set the maximum amount for a single stack increment operation.  Large
16585 values can increase the speed of programs that contain functions
16586 that need a large amount of stack space, but they can also trigger a
16587 segmentation fault if the stack is extended too much.  The default
16588 value is 0x1000.
16590 @end table
16592 @node MeP Options
16593 @subsection MeP Options
16594 @cindex MeP options
16596 @table @gcctabopt
16598 @item -mabsdiff
16599 @opindex mabsdiff
16600 Enables the @code{abs} instruction, which is the absolute difference
16601 between two registers.
16603 @item -mall-opts
16604 @opindex mall-opts
16605 Enables all the optional instructions---average, multiply, divide, bit
16606 operations, leading zero, absolute difference, min/max, clip, and
16607 saturation.
16610 @item -maverage
16611 @opindex maverage
16612 Enables the @code{ave} instruction, which computes the average of two
16613 registers.
16615 @item -mbased=@var{n}
16616 @opindex mbased=
16617 Variables of size @var{n} bytes or smaller are placed in the
16618 @code{.based} section by default.  Based variables use the @code{$tp}
16619 register as a base register, and there is a 128-byte limit to the
16620 @code{.based} section.
16622 @item -mbitops
16623 @opindex mbitops
16624 Enables the bit operation instructions---bit test (@code{btstm}), set
16625 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16626 test-and-set (@code{tas}).
16628 @item -mc=@var{name}
16629 @opindex mc=
16630 Selects which section constant data is placed in.  @var{name} may
16631 be @samp{tiny}, @samp{near}, or @samp{far}.
16633 @item -mclip
16634 @opindex mclip
16635 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
16636 useful unless you also provide @option{-mminmax}.
16638 @item -mconfig=@var{name}
16639 @opindex mconfig=
16640 Selects one of the built-in core configurations.  Each MeP chip has
16641 one or more modules in it; each module has a core CPU and a variety of
16642 coprocessors, optional instructions, and peripherals.  The
16643 @code{MeP-Integrator} tool, not part of GCC, provides these
16644 configurations through this option; using this option is the same as
16645 using all the corresponding command-line options.  The default
16646 configuration is @samp{default}.
16648 @item -mcop
16649 @opindex mcop
16650 Enables the coprocessor instructions.  By default, this is a 32-bit
16651 coprocessor.  Note that the coprocessor is normally enabled via the
16652 @option{-mconfig=} option.
16654 @item -mcop32
16655 @opindex mcop32
16656 Enables the 32-bit coprocessor's instructions.
16658 @item -mcop64
16659 @opindex mcop64
16660 Enables the 64-bit coprocessor's instructions.
16662 @item -mivc2
16663 @opindex mivc2
16664 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16666 @item -mdc
16667 @opindex mdc
16668 Causes constant variables to be placed in the @code{.near} section.
16670 @item -mdiv
16671 @opindex mdiv
16672 Enables the @code{div} and @code{divu} instructions.
16674 @item -meb
16675 @opindex meb
16676 Generate big-endian code.
16678 @item -mel
16679 @opindex mel
16680 Generate little-endian code.
16682 @item -mio-volatile
16683 @opindex mio-volatile
16684 Tells the compiler that any variable marked with the @code{io}
16685 attribute is to be considered volatile.
16687 @item -ml
16688 @opindex ml
16689 Causes variables to be assigned to the @code{.far} section by default.
16691 @item -mleadz
16692 @opindex mleadz
16693 Enables the @code{leadz} (leading zero) instruction.
16695 @item -mm
16696 @opindex mm
16697 Causes variables to be assigned to the @code{.near} section by default.
16699 @item -mminmax
16700 @opindex mminmax
16701 Enables the @code{min} and @code{max} instructions.
16703 @item -mmult
16704 @opindex mmult
16705 Enables the multiplication and multiply-accumulate instructions.
16707 @item -mno-opts
16708 @opindex mno-opts
16709 Disables all the optional instructions enabled by @option{-mall-opts}.
16711 @item -mrepeat
16712 @opindex mrepeat
16713 Enables the @code{repeat} and @code{erepeat} instructions, used for
16714 low-overhead looping.
16716 @item -ms
16717 @opindex ms
16718 Causes all variables to default to the @code{.tiny} section.  Note
16719 that there is a 65536-byte limit to this section.  Accesses to these
16720 variables use the @code{%gp} base register.
16722 @item -msatur
16723 @opindex msatur
16724 Enables the saturation instructions.  Note that the compiler does not
16725 currently generate these itself, but this option is included for
16726 compatibility with other tools, like @code{as}.
16728 @item -msdram
16729 @opindex msdram
16730 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16732 @item -msim
16733 @opindex msim
16734 Link the simulator run-time libraries.
16736 @item -msimnovec
16737 @opindex msimnovec
16738 Link the simulator runtime libraries, excluding built-in support
16739 for reset and exception vectors and tables.
16741 @item -mtf
16742 @opindex mtf
16743 Causes all functions to default to the @code{.far} section.  Without
16744 this option, functions default to the @code{.near} section.
16746 @item -mtiny=@var{n}
16747 @opindex mtiny=
16748 Variables that are @var{n} bytes or smaller are allocated to the
16749 @code{.tiny} section.  These variables use the @code{$gp} base
16750 register.  The default for this option is 4, but note that there's a
16751 65536-byte limit to the @code{.tiny} section.
16753 @end table
16755 @node MicroBlaze Options
16756 @subsection MicroBlaze Options
16757 @cindex MicroBlaze Options
16759 @table @gcctabopt
16761 @item -msoft-float
16762 @opindex msoft-float
16763 Use software emulation for floating point (default).
16765 @item -mhard-float
16766 @opindex mhard-float
16767 Use hardware floating-point instructions.
16769 @item -mmemcpy
16770 @opindex mmemcpy
16771 Do not optimize block moves, use @code{memcpy}.
16773 @item -mno-clearbss
16774 @opindex mno-clearbss
16775 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
16777 @item -mcpu=@var{cpu-type}
16778 @opindex mcpu=
16779 Use features of, and schedule code for, the given CPU.
16780 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
16781 where @var{X} is a major version, @var{YY} is the minor version, and
16782 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
16783 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
16785 @item -mxl-soft-mul
16786 @opindex mxl-soft-mul
16787 Use software multiply emulation (default).
16789 @item -mxl-soft-div
16790 @opindex mxl-soft-div
16791 Use software emulation for divides (default).
16793 @item -mxl-barrel-shift
16794 @opindex mxl-barrel-shift
16795 Use the hardware barrel shifter.
16797 @item -mxl-pattern-compare
16798 @opindex mxl-pattern-compare
16799 Use pattern compare instructions.
16801 @item -msmall-divides
16802 @opindex msmall-divides
16803 Use table lookup optimization for small signed integer divisions.
16805 @item -mxl-stack-check
16806 @opindex mxl-stack-check
16807 This option is deprecated.  Use @option{-fstack-check} instead.
16809 @item -mxl-gp-opt
16810 @opindex mxl-gp-opt
16811 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16813 @item -mxl-multiply-high
16814 @opindex mxl-multiply-high
16815 Use multiply high instructions for high part of 32x32 multiply.
16817 @item -mxl-float-convert
16818 @opindex mxl-float-convert
16819 Use hardware floating-point conversion instructions.
16821 @item -mxl-float-sqrt
16822 @opindex mxl-float-sqrt
16823 Use hardware floating-point square root instruction.
16825 @item -mbig-endian
16826 @opindex mbig-endian
16827 Generate code for a big-endian target.
16829 @item -mlittle-endian
16830 @opindex mlittle-endian
16831 Generate code for a little-endian target.
16833 @item -mxl-reorder
16834 @opindex mxl-reorder
16835 Use reorder instructions (swap and byte reversed load/store).
16837 @item -mxl-mode-@var{app-model}
16838 Select application model @var{app-model}.  Valid models are
16839 @table @samp
16840 @item executable
16841 normal executable (default), uses startup code @file{crt0.o}.
16843 @item xmdstub
16844 for use with Xilinx Microprocessor Debugger (XMD) based
16845 software intrusive debug agent called xmdstub. This uses startup file
16846 @file{crt1.o} and sets the start address of the program to 0x800.
16848 @item bootstrap
16849 for applications that are loaded using a bootloader.
16850 This model uses startup file @file{crt2.o} which does not contain a processor
16851 reset vector handler. This is suitable for transferring control on a
16852 processor reset to the bootloader rather than the application.
16854 @item novectors
16855 for applications that do not require any of the
16856 MicroBlaze vectors. This option may be useful for applications running
16857 within a monitoring application. This model uses @file{crt3.o} as a startup file.
16858 @end table
16860 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
16861 @option{-mxl-mode-@var{app-model}}.
16863 @end table
16865 @node MIPS Options
16866 @subsection MIPS Options
16867 @cindex MIPS options
16869 @table @gcctabopt
16871 @item -EB
16872 @opindex EB
16873 Generate big-endian code.
16875 @item -EL
16876 @opindex EL
16877 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
16878 configurations.
16880 @item -march=@var{arch}
16881 @opindex march
16882 Generate code that runs on @var{arch}, which can be the name of a
16883 generic MIPS ISA, or the name of a particular processor.
16884 The ISA names are:
16885 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
16886 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
16887 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
16888 @samp{mips64r5} and @samp{mips64r6}.
16889 The processor names are:
16890 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
16891 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
16892 @samp{5kc}, @samp{5kf},
16893 @samp{20kc},
16894 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
16895 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
16896 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
16897 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
16898 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
16899 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
16900 @samp{m4k},
16901 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
16902 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
16903 @samp{orion},
16904 @samp{p5600},
16905 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
16906 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
16907 @samp{rm7000}, @samp{rm9000},
16908 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
16909 @samp{sb1},
16910 @samp{sr71000},
16911 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
16912 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
16913 @samp{xlr} and @samp{xlp}.
16914 The special value @samp{from-abi} selects the
16915 most compatible architecture for the selected ABI (that is,
16916 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
16918 The native Linux/GNU toolchain also supports the value @samp{native},
16919 which selects the best architecture option for the host processor.
16920 @option{-march=native} has no effect if GCC does not recognize
16921 the processor.
16923 In processor names, a final @samp{000} can be abbreviated as @samp{k}
16924 (for example, @option{-march=r2k}).  Prefixes are optional, and
16925 @samp{vr} may be written @samp{r}.
16927 Names of the form @samp{@var{n}f2_1} refer to processors with
16928 FPUs clocked at half the rate of the core, names of the form
16929 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
16930 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
16931 processors with FPUs clocked a ratio of 3:2 with respect to the core.
16932 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
16933 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
16934 accepted as synonyms for @samp{@var{n}f1_1}.
16936 GCC defines two macros based on the value of this option.  The first
16937 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
16938 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
16939 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
16940 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
16941 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
16943 Note that the @code{_MIPS_ARCH} macro uses the processor names given
16944 above.  In other words, it has the full prefix and does not
16945 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
16946 the macro names the resolved architecture (either @code{"mips1"} or
16947 @code{"mips3"}).  It names the default architecture when no
16948 @option{-march} option is given.
16950 @item -mtune=@var{arch}
16951 @opindex mtune
16952 Optimize for @var{arch}.  Among other things, this option controls
16953 the way instructions are scheduled, and the perceived cost of arithmetic
16954 operations.  The list of @var{arch} values is the same as for
16955 @option{-march}.
16957 When this option is not used, GCC optimizes for the processor
16958 specified by @option{-march}.  By using @option{-march} and
16959 @option{-mtune} together, it is possible to generate code that
16960 runs on a family of processors, but optimize the code for one
16961 particular member of that family.
16963 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
16964 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
16965 @option{-march} ones described above.
16967 @item -mips1
16968 @opindex mips1
16969 Equivalent to @option{-march=mips1}.
16971 @item -mips2
16972 @opindex mips2
16973 Equivalent to @option{-march=mips2}.
16975 @item -mips3
16976 @opindex mips3
16977 Equivalent to @option{-march=mips3}.
16979 @item -mips4
16980 @opindex mips4
16981 Equivalent to @option{-march=mips4}.
16983 @item -mips32
16984 @opindex mips32
16985 Equivalent to @option{-march=mips32}.
16987 @item -mips32r3
16988 @opindex mips32r3
16989 Equivalent to @option{-march=mips32r3}.
16991 @item -mips32r5
16992 @opindex mips32r5
16993 Equivalent to @option{-march=mips32r5}.
16995 @item -mips32r6
16996 @opindex mips32r6
16997 Equivalent to @option{-march=mips32r6}.
16999 @item -mips64
17000 @opindex mips64
17001 Equivalent to @option{-march=mips64}.
17003 @item -mips64r2
17004 @opindex mips64r2
17005 Equivalent to @option{-march=mips64r2}.
17007 @item -mips64r3
17008 @opindex mips64r3
17009 Equivalent to @option{-march=mips64r3}.
17011 @item -mips64r5
17012 @opindex mips64r5
17013 Equivalent to @option{-march=mips64r5}.
17015 @item -mips64r6
17016 @opindex mips64r6
17017 Equivalent to @option{-march=mips64r6}.
17019 @item -mips16
17020 @itemx -mno-mips16
17021 @opindex mips16
17022 @opindex mno-mips16
17023 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17024 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17026 MIPS16 code generation can also be controlled on a per-function basis
17027 by means of @code{mips16} and @code{nomips16} attributes.
17028 @xref{Function Attributes}, for more information.
17030 @item -mflip-mips16
17031 @opindex mflip-mips16
17032 Generate MIPS16 code on alternating functions.  This option is provided
17033 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17034 not intended for ordinary use in compiling user code.
17036 @item -minterlink-compressed
17037 @item -mno-interlink-compressed
17038 @opindex minterlink-compressed
17039 @opindex mno-interlink-compressed
17040 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17041 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17043 For example, code using the standard ISA encoding cannot jump directly
17044 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17045 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17046 knows that the target of the jump is not compressed.
17048 @item -minterlink-mips16
17049 @itemx -mno-interlink-mips16
17050 @opindex minterlink-mips16
17051 @opindex mno-interlink-mips16
17052 Aliases of @option{-minterlink-compressed} and
17053 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17054 and are retained for backwards compatibility.
17056 @item -mabi=32
17057 @itemx -mabi=o64
17058 @itemx -mabi=n32
17059 @itemx -mabi=64
17060 @itemx -mabi=eabi
17061 @opindex mabi=32
17062 @opindex mabi=o64
17063 @opindex mabi=n32
17064 @opindex mabi=64
17065 @opindex mabi=eabi
17066 Generate code for the given ABI@.
17068 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17069 generates 64-bit code when you select a 64-bit architecture, but you
17070 can use @option{-mgp32} to get 32-bit code instead.
17072 For information about the O64 ABI, see
17073 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17075 GCC supports a variant of the o32 ABI in which floating-point registers
17076 are 64 rather than 32 bits wide.  You can select this combination with
17077 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17078 and @code{mfhc1} instructions and is therefore only supported for
17079 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17081 The register assignments for arguments and return values remain the
17082 same, but each scalar value is passed in a single 64-bit register
17083 rather than a pair of 32-bit registers.  For example, scalar
17084 floating-point values are returned in @samp{$f0} only, not a
17085 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17086 remains the same in that the even-numbered double-precision registers
17087 are saved.
17089 Two additional variants of the o32 ABI are supported to enable
17090 a transition from 32-bit to 64-bit registers.  These are FPXX
17091 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17092 The FPXX extension mandates that all code must execute correctly
17093 when run using 32-bit or 64-bit registers.  The code can be interlinked
17094 with either FP32 or FP64, but not both.
17095 The FP64A extension is similar to the FP64 extension but forbids the
17096 use of odd-numbered single-precision registers.  This can be used
17097 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17098 processors and allows both FP32 and FP64A code to interlink and
17099 run in the same process without changing FPU modes.
17101 @item -mabicalls
17102 @itemx -mno-abicalls
17103 @opindex mabicalls
17104 @opindex mno-abicalls
17105 Generate (do not generate) code that is suitable for SVR4-style
17106 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17107 systems.
17109 @item -mshared
17110 @itemx -mno-shared
17111 Generate (do not generate) code that is fully position-independent,
17112 and that can therefore be linked into shared libraries.  This option
17113 only affects @option{-mabicalls}.
17115 All @option{-mabicalls} code has traditionally been position-independent,
17116 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17117 as an extension, the GNU toolchain allows executables to use absolute
17118 accesses for locally-binding symbols.  It can also use shorter GP
17119 initialization sequences and generate direct calls to locally-defined
17120 functions.  This mode is selected by @option{-mno-shared}.
17122 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17123 objects that can only be linked by the GNU linker.  However, the option
17124 does not affect the ABI of the final executable; it only affects the ABI
17125 of relocatable objects.  Using @option{-mno-shared} generally makes
17126 executables both smaller and quicker.
17128 @option{-mshared} is the default.
17130 @item -mplt
17131 @itemx -mno-plt
17132 @opindex mplt
17133 @opindex mno-plt
17134 Assume (do not assume) that the static and dynamic linkers
17135 support PLTs and copy relocations.  This option only affects
17136 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17137 has no effect without @option{-msym32}.
17139 You can make @option{-mplt} the default by configuring
17140 GCC with @option{--with-mips-plt}.  The default is
17141 @option{-mno-plt} otherwise.
17143 @item -mxgot
17144 @itemx -mno-xgot
17145 @opindex mxgot
17146 @opindex mno-xgot
17147 Lift (do not lift) the usual restrictions on the size of the global
17148 offset table.
17150 GCC normally uses a single instruction to load values from the GOT@.
17151 While this is relatively efficient, it only works if the GOT
17152 is smaller than about 64k.  Anything larger causes the linker
17153 to report an error such as:
17155 @cindex relocation truncated to fit (MIPS)
17156 @smallexample
17157 relocation truncated to fit: R_MIPS_GOT16 foobar
17158 @end smallexample
17160 If this happens, you should recompile your code with @option{-mxgot}.
17161 This works with very large GOTs, although the code is also
17162 less efficient, since it takes three instructions to fetch the
17163 value of a global symbol.
17165 Note that some linkers can create multiple GOTs.  If you have such a
17166 linker, you should only need to use @option{-mxgot} when a single object
17167 file accesses more than 64k's worth of GOT entries.  Very few do.
17169 These options have no effect unless GCC is generating position
17170 independent code.
17172 @item -mgp32
17173 @opindex mgp32
17174 Assume that general-purpose registers are 32 bits wide.
17176 @item -mgp64
17177 @opindex mgp64
17178 Assume that general-purpose registers are 64 bits wide.
17180 @item -mfp32
17181 @opindex mfp32
17182 Assume that floating-point registers are 32 bits wide.
17184 @item -mfp64
17185 @opindex mfp64
17186 Assume that floating-point registers are 64 bits wide.
17188 @item -mfpxx
17189 @opindex mfpxx
17190 Do not assume the width of floating-point registers.
17192 @item -mhard-float
17193 @opindex mhard-float
17194 Use floating-point coprocessor instructions.
17196 @item -msoft-float
17197 @opindex msoft-float
17198 Do not use floating-point coprocessor instructions.  Implement
17199 floating-point calculations using library calls instead.
17201 @item -mno-float
17202 @opindex mno-float
17203 Equivalent to @option{-msoft-float}, but additionally asserts that the
17204 program being compiled does not perform any floating-point operations.
17205 This option is presently supported only by some bare-metal MIPS
17206 configurations, where it may select a special set of libraries
17207 that lack all floating-point support (including, for example, the
17208 floating-point @code{printf} formats).  
17209 If code compiled with @option{-mno-float} accidentally contains
17210 floating-point operations, it is likely to suffer a link-time
17211 or run-time failure.
17213 @item -msingle-float
17214 @opindex msingle-float
17215 Assume that the floating-point coprocessor only supports single-precision
17216 operations.
17218 @item -mdouble-float
17219 @opindex mdouble-float
17220 Assume that the floating-point coprocessor supports double-precision
17221 operations.  This is the default.
17223 @item -modd-spreg
17224 @itemx -mno-odd-spreg
17225 @opindex modd-spreg
17226 @opindex mno-odd-spreg
17227 Enable the use of odd-numbered single-precision floating-point registers
17228 for the o32 ABI.  This is the default for processors that are known to
17229 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
17230 is set by default.
17232 @item -mabs=2008
17233 @itemx -mabs=legacy
17234 @opindex mabs=2008
17235 @opindex mabs=legacy
17236 These options control the treatment of the special not-a-number (NaN)
17237 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17238 @code{neg.@i{fmt}} machine instructions.
17240 By default or when @option{-mabs=legacy} is used the legacy
17241 treatment is selected.  In this case these instructions are considered
17242 arithmetic and avoided where correct operation is required and the
17243 input operand might be a NaN.  A longer sequence of instructions that
17244 manipulate the sign bit of floating-point datum manually is used
17245 instead unless the @option{-ffinite-math-only} option has also been
17246 specified.
17248 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17249 this case these instructions are considered non-arithmetic and therefore
17250 operating correctly in all cases, including in particular where the
17251 input operand is a NaN.  These instructions are therefore always used
17252 for the respective operations.
17254 @item -mnan=2008
17255 @itemx -mnan=legacy
17256 @opindex mnan=2008
17257 @opindex mnan=legacy
17258 These options control the encoding of the special not-a-number (NaN)
17259 IEEE 754 floating-point data.
17261 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17262 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17263 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17264 by the first bit of their trailing significand field being 1.
17266 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17267 this case qNaNs are denoted by the first bit of their trailing
17268 significand field being 1, whereas sNaNs are denoted by the first bit of
17269 their trailing significand field being 0.
17271 The default is @option{-mnan=legacy} unless GCC has been configured with
17272 @option{--with-nan=2008}.
17274 @item -mllsc
17275 @itemx -mno-llsc
17276 @opindex mllsc
17277 @opindex mno-llsc
17278 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17279 implement atomic memory built-in functions.  When neither option is
17280 specified, GCC uses the instructions if the target architecture
17281 supports them.
17283 @option{-mllsc} is useful if the runtime environment can emulate the
17284 instructions and @option{-mno-llsc} can be useful when compiling for
17285 nonstandard ISAs.  You can make either option the default by
17286 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17287 respectively.  @option{--with-llsc} is the default for some
17288 configurations; see the installation documentation for details.
17290 @item -mdsp
17291 @itemx -mno-dsp
17292 @opindex mdsp
17293 @opindex mno-dsp
17294 Use (do not use) revision 1 of the MIPS DSP ASE@.
17295 @xref{MIPS DSP Built-in Functions}.  This option defines the
17296 preprocessor macro @code{__mips_dsp}.  It also defines
17297 @code{__mips_dsp_rev} to 1.
17299 @item -mdspr2
17300 @itemx -mno-dspr2
17301 @opindex mdspr2
17302 @opindex mno-dspr2
17303 Use (do not use) revision 2 of the MIPS DSP ASE@.
17304 @xref{MIPS DSP Built-in Functions}.  This option defines the
17305 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
17306 It also defines @code{__mips_dsp_rev} to 2.
17308 @item -msmartmips
17309 @itemx -mno-smartmips
17310 @opindex msmartmips
17311 @opindex mno-smartmips
17312 Use (do not use) the MIPS SmartMIPS ASE.
17314 @item -mpaired-single
17315 @itemx -mno-paired-single
17316 @opindex mpaired-single
17317 @opindex mno-paired-single
17318 Use (do not use) paired-single floating-point instructions.
17319 @xref{MIPS Paired-Single Support}.  This option requires
17320 hardware floating-point support to be enabled.
17322 @item -mdmx
17323 @itemx -mno-mdmx
17324 @opindex mdmx
17325 @opindex mno-mdmx
17326 Use (do not use) MIPS Digital Media Extension instructions.
17327 This option can only be used when generating 64-bit code and requires
17328 hardware floating-point support to be enabled.
17330 @item -mips3d
17331 @itemx -mno-mips3d
17332 @opindex mips3d
17333 @opindex mno-mips3d
17334 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17335 The option @option{-mips3d} implies @option{-mpaired-single}.
17337 @item -mmicromips
17338 @itemx -mno-micromips
17339 @opindex mmicromips
17340 @opindex mno-mmicromips
17341 Generate (do not generate) microMIPS code.
17343 MicroMIPS code generation can also be controlled on a per-function basis
17344 by means of @code{micromips} and @code{nomicromips} attributes.
17345 @xref{Function Attributes}, for more information.
17347 @item -mmt
17348 @itemx -mno-mt
17349 @opindex mmt
17350 @opindex mno-mt
17351 Use (do not use) MT Multithreading instructions.
17353 @item -mmcu
17354 @itemx -mno-mcu
17355 @opindex mmcu
17356 @opindex mno-mcu
17357 Use (do not use) the MIPS MCU ASE instructions.
17359 @item -meva
17360 @itemx -mno-eva
17361 @opindex meva
17362 @opindex mno-eva
17363 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17365 @item -mvirt
17366 @itemx -mno-virt
17367 @opindex mvirt
17368 @opindex mno-virt
17369 Use (do not use) the MIPS Virtualization Application Specific instructions.
17371 @item -mxpa
17372 @itemx -mno-xpa
17373 @opindex mxpa
17374 @opindex mno-xpa
17375 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17377 @item -mlong64
17378 @opindex mlong64
17379 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17380 an explanation of the default and the way that the pointer size is
17381 determined.
17383 @item -mlong32
17384 @opindex mlong32
17385 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17387 The default size of @code{int}s, @code{long}s and pointers depends on
17388 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17389 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17390 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17391 or the same size as integer registers, whichever is smaller.
17393 @item -msym32
17394 @itemx -mno-sym32
17395 @opindex msym32
17396 @opindex mno-sym32
17397 Assume (do not assume) that all symbols have 32-bit values, regardless
17398 of the selected ABI@.  This option is useful in combination with
17399 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17400 to generate shorter and faster references to symbolic addresses.
17402 @item -G @var{num}
17403 @opindex G
17404 Put definitions of externally-visible data in a small data section
17405 if that data is no bigger than @var{num} bytes.  GCC can then generate
17406 more efficient accesses to the data; see @option{-mgpopt} for details.
17408 The default @option{-G} option depends on the configuration.
17410 @item -mlocal-sdata
17411 @itemx -mno-local-sdata
17412 @opindex mlocal-sdata
17413 @opindex mno-local-sdata
17414 Extend (do not extend) the @option{-G} behavior to local data too,
17415 such as to static variables in C@.  @option{-mlocal-sdata} is the
17416 default for all configurations.
17418 If the linker complains that an application is using too much small data,
17419 you might want to try rebuilding the less performance-critical parts with
17420 @option{-mno-local-sdata}.  You might also want to build large
17421 libraries with @option{-mno-local-sdata}, so that the libraries leave
17422 more room for the main program.
17424 @item -mextern-sdata
17425 @itemx -mno-extern-sdata
17426 @opindex mextern-sdata
17427 @opindex mno-extern-sdata
17428 Assume (do not assume) that externally-defined data is in
17429 a small data section if the size of that data is within the @option{-G} limit.
17430 @option{-mextern-sdata} is the default for all configurations.
17432 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17433 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17434 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17435 is placed in a small data section.  If @var{Var} is defined by another
17436 module, you must either compile that module with a high-enough
17437 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17438 definition.  If @var{Var} is common, you must link the application
17439 with a high-enough @option{-G} setting.
17441 The easiest way of satisfying these restrictions is to compile
17442 and link every module with the same @option{-G} option.  However,
17443 you may wish to build a library that supports several different
17444 small data limits.  You can do this by compiling the library with
17445 the highest supported @option{-G} setting and additionally using
17446 @option{-mno-extern-sdata} to stop the library from making assumptions
17447 about externally-defined data.
17449 @item -mgpopt
17450 @itemx -mno-gpopt
17451 @opindex mgpopt
17452 @opindex mno-gpopt
17453 Use (do not use) GP-relative accesses for symbols that are known to be
17454 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17455 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17456 configurations.
17458 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17459 might not hold the value of @code{_gp}.  For example, if the code is
17460 part of a library that might be used in a boot monitor, programs that
17461 call boot monitor routines pass an unknown value in @code{$gp}.
17462 (In such situations, the boot monitor itself is usually compiled
17463 with @option{-G0}.)
17465 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17466 @option{-mno-extern-sdata}.
17468 @item -membedded-data
17469 @itemx -mno-embedded-data
17470 @opindex membedded-data
17471 @opindex mno-embedded-data
17472 Allocate variables to the read-only data section first if possible, then
17473 next in the small data section if possible, otherwise in data.  This gives
17474 slightly slower code than the default, but reduces the amount of RAM required
17475 when executing, and thus may be preferred for some embedded systems.
17477 @item -muninit-const-in-rodata
17478 @itemx -mno-uninit-const-in-rodata
17479 @opindex muninit-const-in-rodata
17480 @opindex mno-uninit-const-in-rodata
17481 Put uninitialized @code{const} variables in the read-only data section.
17482 This option is only meaningful in conjunction with @option{-membedded-data}.
17484 @item -mcode-readable=@var{setting}
17485 @opindex mcode-readable
17486 Specify whether GCC may generate code that reads from executable sections.
17487 There are three possible settings:
17489 @table @gcctabopt
17490 @item -mcode-readable=yes
17491 Instructions may freely access executable sections.  This is the
17492 default setting.
17494 @item -mcode-readable=pcrel
17495 MIPS16 PC-relative load instructions can access executable sections,
17496 but other instructions must not do so.  This option is useful on 4KSc
17497 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17498 It is also useful on processors that can be configured to have a dual
17499 instruction/data SRAM interface and that, like the M4K, automatically
17500 redirect PC-relative loads to the instruction RAM.
17502 @item -mcode-readable=no
17503 Instructions must not access executable sections.  This option can be
17504 useful on targets that are configured to have a dual instruction/data
17505 SRAM interface but that (unlike the M4K) do not automatically redirect
17506 PC-relative loads to the instruction RAM.
17507 @end table
17509 @item -msplit-addresses
17510 @itemx -mno-split-addresses
17511 @opindex msplit-addresses
17512 @opindex mno-split-addresses
17513 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17514 relocation operators.  This option has been superseded by
17515 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17517 @item -mexplicit-relocs
17518 @itemx -mno-explicit-relocs
17519 @opindex mexplicit-relocs
17520 @opindex mno-explicit-relocs
17521 Use (do not use) assembler relocation operators when dealing with symbolic
17522 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17523 is to use assembler macros instead.
17525 @option{-mexplicit-relocs} is the default if GCC was configured
17526 to use an assembler that supports relocation operators.
17528 @item -mcheck-zero-division
17529 @itemx -mno-check-zero-division
17530 @opindex mcheck-zero-division
17531 @opindex mno-check-zero-division
17532 Trap (do not trap) on integer division by zero.
17534 The default is @option{-mcheck-zero-division}.
17536 @item -mdivide-traps
17537 @itemx -mdivide-breaks
17538 @opindex mdivide-traps
17539 @opindex mdivide-breaks
17540 MIPS systems check for division by zero by generating either a
17541 conditional trap or a break instruction.  Using traps results in
17542 smaller code, but is only supported on MIPS II and later.  Also, some
17543 versions of the Linux kernel have a bug that prevents trap from
17544 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17545 allow conditional traps on architectures that support them and
17546 @option{-mdivide-breaks} to force the use of breaks.
17548 The default is usually @option{-mdivide-traps}, but this can be
17549 overridden at configure time using @option{--with-divide=breaks}.
17550 Divide-by-zero checks can be completely disabled using
17551 @option{-mno-check-zero-division}.
17553 @item -mmemcpy
17554 @itemx -mno-memcpy
17555 @opindex mmemcpy
17556 @opindex mno-memcpy
17557 Force (do not force) the use of @code{memcpy} for non-trivial block
17558 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17559 most constant-sized copies.
17561 @item -mlong-calls
17562 @itemx -mno-long-calls
17563 @opindex mlong-calls
17564 @opindex mno-long-calls
17565 Disable (do not disable) use of the @code{jal} instruction.  Calling
17566 functions using @code{jal} is more efficient but requires the caller
17567 and callee to be in the same 256 megabyte segment.
17569 This option has no effect on abicalls code.  The default is
17570 @option{-mno-long-calls}.
17572 @item -mmad
17573 @itemx -mno-mad
17574 @opindex mmad
17575 @opindex mno-mad
17576 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17577 instructions, as provided by the R4650 ISA@.
17579 @item -mimadd
17580 @itemx -mno-imadd
17581 @opindex mimadd
17582 @opindex mno-imadd
17583 Enable (disable) use of the @code{madd} and @code{msub} integer
17584 instructions.  The default is @option{-mimadd} on architectures
17585 that support @code{madd} and @code{msub} except for the 74k 
17586 architecture where it was found to generate slower code.
17588 @item -mfused-madd
17589 @itemx -mno-fused-madd
17590 @opindex mfused-madd
17591 @opindex mno-fused-madd
17592 Enable (disable) use of the floating-point multiply-accumulate
17593 instructions, when they are available.  The default is
17594 @option{-mfused-madd}.
17596 On the R8000 CPU when multiply-accumulate instructions are used,
17597 the intermediate product is calculated to infinite precision
17598 and is not subject to the FCSR Flush to Zero bit.  This may be
17599 undesirable in some circumstances.  On other processors the result
17600 is numerically identical to the equivalent computation using
17601 separate multiply, add, subtract and negate instructions.
17603 @item -nocpp
17604 @opindex nocpp
17605 Tell the MIPS assembler to not run its preprocessor over user
17606 assembler files (with a @samp{.s} suffix) when assembling them.
17608 @item -mfix-24k
17609 @item -mno-fix-24k
17610 @opindex mfix-24k
17611 @opindex mno-fix-24k
17612 Work around the 24K E48 (lost data on stores during refill) errata.
17613 The workarounds are implemented by the assembler rather than by GCC@.
17615 @item -mfix-r4000
17616 @itemx -mno-fix-r4000
17617 @opindex mfix-r4000
17618 @opindex mno-fix-r4000
17619 Work around certain R4000 CPU errata:
17620 @itemize @minus
17621 @item
17622 A double-word or a variable shift may give an incorrect result if executed
17623 immediately after starting an integer division.
17624 @item
17625 A double-word or a variable shift may give an incorrect result if executed
17626 while an integer multiplication is in progress.
17627 @item
17628 An integer division may give an incorrect result if started in a delay slot
17629 of a taken branch or a jump.
17630 @end itemize
17632 @item -mfix-r4400
17633 @itemx -mno-fix-r4400
17634 @opindex mfix-r4400
17635 @opindex mno-fix-r4400
17636 Work around certain R4400 CPU errata:
17637 @itemize @minus
17638 @item
17639 A double-word or a variable shift may give an incorrect result if executed
17640 immediately after starting an integer division.
17641 @end itemize
17643 @item -mfix-r10000
17644 @itemx -mno-fix-r10000
17645 @opindex mfix-r10000
17646 @opindex mno-fix-r10000
17647 Work around certain R10000 errata:
17648 @itemize @minus
17649 @item
17650 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17651 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17652 @end itemize
17654 This option can only be used if the target architecture supports
17655 branch-likely instructions.  @option{-mfix-r10000} is the default when
17656 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17657 otherwise.
17659 @item -mfix-rm7000
17660 @itemx -mno-fix-rm7000
17661 @opindex mfix-rm7000
17662 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17663 workarounds are implemented by the assembler rather than by GCC@.
17665 @item -mfix-vr4120
17666 @itemx -mno-fix-vr4120
17667 @opindex mfix-vr4120
17668 Work around certain VR4120 errata:
17669 @itemize @minus
17670 @item
17671 @code{dmultu} does not always produce the correct result.
17672 @item
17673 @code{div} and @code{ddiv} do not always produce the correct result if one
17674 of the operands is negative.
17675 @end itemize
17676 The workarounds for the division errata rely on special functions in
17677 @file{libgcc.a}.  At present, these functions are only provided by
17678 the @code{mips64vr*-elf} configurations.
17680 Other VR4120 errata require a NOP to be inserted between certain pairs of
17681 instructions.  These errata are handled by the assembler, not by GCC itself.
17683 @item -mfix-vr4130
17684 @opindex mfix-vr4130
17685 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17686 workarounds are implemented by the assembler rather than by GCC,
17687 although GCC avoids using @code{mflo} and @code{mfhi} if the
17688 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17689 instructions are available instead.
17691 @item -mfix-sb1
17692 @itemx -mno-fix-sb1
17693 @opindex mfix-sb1
17694 Work around certain SB-1 CPU core errata.
17695 (This flag currently works around the SB-1 revision 2
17696 ``F1'' and ``F2'' floating-point errata.)
17698 @item -mr10k-cache-barrier=@var{setting}
17699 @opindex mr10k-cache-barrier
17700 Specify whether GCC should insert cache barriers to avoid the
17701 side-effects of speculation on R10K processors.
17703 In common with many processors, the R10K tries to predict the outcome
17704 of a conditional branch and speculatively executes instructions from
17705 the ``taken'' branch.  It later aborts these instructions if the
17706 predicted outcome is wrong.  However, on the R10K, even aborted
17707 instructions can have side effects.
17709 This problem only affects kernel stores and, depending on the system,
17710 kernel loads.  As an example, a speculatively-executed store may load
17711 the target memory into cache and mark the cache line as dirty, even if
17712 the store itself is later aborted.  If a DMA operation writes to the
17713 same area of memory before the ``dirty'' line is flushed, the cached
17714 data overwrites the DMA-ed data.  See the R10K processor manual
17715 for a full description, including other potential problems.
17717 One workaround is to insert cache barrier instructions before every memory
17718 access that might be speculatively executed and that might have side
17719 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17720 controls GCC's implementation of this workaround.  It assumes that
17721 aborted accesses to any byte in the following regions does not have
17722 side effects:
17724 @enumerate
17725 @item
17726 the memory occupied by the current function's stack frame;
17728 @item
17729 the memory occupied by an incoming stack argument;
17731 @item
17732 the memory occupied by an object with a link-time-constant address.
17733 @end enumerate
17735 It is the kernel's responsibility to ensure that speculative
17736 accesses to these regions are indeed safe.
17738 If the input program contains a function declaration such as:
17740 @smallexample
17741 void foo (void);
17742 @end smallexample
17744 then the implementation of @code{foo} must allow @code{j foo} and
17745 @code{jal foo} to be executed speculatively.  GCC honors this
17746 restriction for functions it compiles itself.  It expects non-GCC
17747 functions (such as hand-written assembly code) to do the same.
17749 The option has three forms:
17751 @table @gcctabopt
17752 @item -mr10k-cache-barrier=load-store
17753 Insert a cache barrier before a load or store that might be
17754 speculatively executed and that might have side effects even
17755 if aborted.
17757 @item -mr10k-cache-barrier=store
17758 Insert a cache barrier before a store that might be speculatively
17759 executed and that might have side effects even if aborted.
17761 @item -mr10k-cache-barrier=none
17762 Disable the insertion of cache barriers.  This is the default setting.
17763 @end table
17765 @item -mflush-func=@var{func}
17766 @itemx -mno-flush-func
17767 @opindex mflush-func
17768 Specifies the function to call to flush the I and D caches, or to not
17769 call any such function.  If called, the function must take the same
17770 arguments as the common @code{_flush_func}, that is, the address of the
17771 memory range for which the cache is being flushed, the size of the
17772 memory range, and the number 3 (to flush both caches).  The default
17773 depends on the target GCC was configured for, but commonly is either
17774 @code{_flush_func} or @code{__cpu_flush}.
17776 @item mbranch-cost=@var{num}
17777 @opindex mbranch-cost
17778 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17779 This cost is only a heuristic and is not guaranteed to produce
17780 consistent results across releases.  A zero cost redundantly selects
17781 the default, which is based on the @option{-mtune} setting.
17783 @item -mbranch-likely
17784 @itemx -mno-branch-likely
17785 @opindex mbranch-likely
17786 @opindex mno-branch-likely
17787 Enable or disable use of Branch Likely instructions, regardless of the
17788 default for the selected architecture.  By default, Branch Likely
17789 instructions may be generated if they are supported by the selected
17790 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17791 and processors that implement those architectures; for those, Branch
17792 Likely instructions are not be generated by default because the MIPS32
17793 and MIPS64 architectures specifically deprecate their use.
17795 @item -mfp-exceptions
17796 @itemx -mno-fp-exceptions
17797 @opindex mfp-exceptions
17798 Specifies whether FP exceptions are enabled.  This affects how
17799 FP instructions are scheduled for some processors.
17800 The default is that FP exceptions are
17801 enabled.
17803 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17804 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17805 FP pipe.
17807 @item -mvr4130-align
17808 @itemx -mno-vr4130-align
17809 @opindex mvr4130-align
17810 The VR4130 pipeline is two-way superscalar, but can only issue two
17811 instructions together if the first one is 8-byte aligned.  When this
17812 option is enabled, GCC aligns pairs of instructions that it
17813 thinks should execute in parallel.
17815 This option only has an effect when optimizing for the VR4130.
17816 It normally makes code faster, but at the expense of making it bigger.
17817 It is enabled by default at optimization level @option{-O3}.
17819 @item -msynci
17820 @itemx -mno-synci
17821 @opindex msynci
17822 Enable (disable) generation of @code{synci} instructions on
17823 architectures that support it.  The @code{synci} instructions (if
17824 enabled) are generated when @code{__builtin___clear_cache} is
17825 compiled.
17827 This option defaults to @option{-mno-synci}, but the default can be
17828 overridden by configuring GCC with @option{--with-synci}.
17830 When compiling code for single processor systems, it is generally safe
17831 to use @code{synci}.  However, on many multi-core (SMP) systems, it
17832 does not invalidate the instruction caches on all cores and may lead
17833 to undefined behavior.
17835 @item -mrelax-pic-calls
17836 @itemx -mno-relax-pic-calls
17837 @opindex mrelax-pic-calls
17838 Try to turn PIC calls that are normally dispatched via register
17839 @code{$25} into direct calls.  This is only possible if the linker can
17840 resolve the destination at link-time and if the destination is within
17841 range for a direct call.
17843 @option{-mrelax-pic-calls} is the default if GCC was configured to use
17844 an assembler and a linker that support the @code{.reloc} assembly
17845 directive and @option{-mexplicit-relocs} is in effect.  With
17846 @option{-mno-explicit-relocs}, this optimization can be performed by the
17847 assembler and the linker alone without help from the compiler.
17849 @item -mmcount-ra-address
17850 @itemx -mno-mcount-ra-address
17851 @opindex mmcount-ra-address
17852 @opindex mno-mcount-ra-address
17853 Emit (do not emit) code that allows @code{_mcount} to modify the
17854 calling function's return address.  When enabled, this option extends
17855 the usual @code{_mcount} interface with a new @var{ra-address}
17856 parameter, which has type @code{intptr_t *} and is passed in register
17857 @code{$12}.  @code{_mcount} can then modify the return address by
17858 doing both of the following:
17859 @itemize
17860 @item
17861 Returning the new address in register @code{$31}.
17862 @item
17863 Storing the new address in @code{*@var{ra-address}},
17864 if @var{ra-address} is nonnull.
17865 @end itemize
17867 The default is @option{-mno-mcount-ra-address}.
17869 @end table
17871 @node MMIX Options
17872 @subsection MMIX Options
17873 @cindex MMIX Options
17875 These options are defined for the MMIX:
17877 @table @gcctabopt
17878 @item -mlibfuncs
17879 @itemx -mno-libfuncs
17880 @opindex mlibfuncs
17881 @opindex mno-libfuncs
17882 Specify that intrinsic library functions are being compiled, passing all
17883 values in registers, no matter the size.
17885 @item -mepsilon
17886 @itemx -mno-epsilon
17887 @opindex mepsilon
17888 @opindex mno-epsilon
17889 Generate floating-point comparison instructions that compare with respect
17890 to the @code{rE} epsilon register.
17892 @item -mabi=mmixware
17893 @itemx -mabi=gnu
17894 @opindex mabi=mmixware
17895 @opindex mabi=gnu
17896 Generate code that passes function parameters and return values that (in
17897 the called function) are seen as registers @code{$0} and up, as opposed to
17898 the GNU ABI which uses global registers @code{$231} and up.
17900 @item -mzero-extend
17901 @itemx -mno-zero-extend
17902 @opindex mzero-extend
17903 @opindex mno-zero-extend
17904 When reading data from memory in sizes shorter than 64 bits, use (do not
17905 use) zero-extending load instructions by default, rather than
17906 sign-extending ones.
17908 @item -mknuthdiv
17909 @itemx -mno-knuthdiv
17910 @opindex mknuthdiv
17911 @opindex mno-knuthdiv
17912 Make the result of a division yielding a remainder have the same sign as
17913 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
17914 remainder follows the sign of the dividend.  Both methods are
17915 arithmetically valid, the latter being almost exclusively used.
17917 @item -mtoplevel-symbols
17918 @itemx -mno-toplevel-symbols
17919 @opindex mtoplevel-symbols
17920 @opindex mno-toplevel-symbols
17921 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
17922 code can be used with the @code{PREFIX} assembly directive.
17924 @item -melf
17925 @opindex melf
17926 Generate an executable in the ELF format, rather than the default
17927 @samp{mmo} format used by the @command{mmix} simulator.
17929 @item -mbranch-predict
17930 @itemx -mno-branch-predict
17931 @opindex mbranch-predict
17932 @opindex mno-branch-predict
17933 Use (do not use) the probable-branch instructions, when static branch
17934 prediction indicates a probable branch.
17936 @item -mbase-addresses
17937 @itemx -mno-base-addresses
17938 @opindex mbase-addresses
17939 @opindex mno-base-addresses
17940 Generate (do not generate) code that uses @emph{base addresses}.  Using a
17941 base address automatically generates a request (handled by the assembler
17942 and the linker) for a constant to be set up in a global register.  The
17943 register is used for one or more base address requests within the range 0
17944 to 255 from the value held in the register.  The generally leads to short
17945 and fast code, but the number of different data items that can be
17946 addressed is limited.  This means that a program that uses lots of static
17947 data may require @option{-mno-base-addresses}.
17949 @item -msingle-exit
17950 @itemx -mno-single-exit
17951 @opindex msingle-exit
17952 @opindex mno-single-exit
17953 Force (do not force) generated code to have a single exit point in each
17954 function.
17955 @end table
17957 @node MN10300 Options
17958 @subsection MN10300 Options
17959 @cindex MN10300 options
17961 These @option{-m} options are defined for Matsushita MN10300 architectures:
17963 @table @gcctabopt
17964 @item -mmult-bug
17965 @opindex mmult-bug
17966 Generate code to avoid bugs in the multiply instructions for the MN10300
17967 processors.  This is the default.
17969 @item -mno-mult-bug
17970 @opindex mno-mult-bug
17971 Do not generate code to avoid bugs in the multiply instructions for the
17972 MN10300 processors.
17974 @item -mam33
17975 @opindex mam33
17976 Generate code using features specific to the AM33 processor.
17978 @item -mno-am33
17979 @opindex mno-am33
17980 Do not generate code using features specific to the AM33 processor.  This
17981 is the default.
17983 @item -mam33-2
17984 @opindex mam33-2
17985 Generate code using features specific to the AM33/2.0 processor.
17987 @item -mam34
17988 @opindex mam34
17989 Generate code using features specific to the AM34 processor.
17991 @item -mtune=@var{cpu-type}
17992 @opindex mtune
17993 Use the timing characteristics of the indicated CPU type when
17994 scheduling instructions.  This does not change the targeted processor
17995 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
17996 @samp{am33-2} or @samp{am34}.
17998 @item -mreturn-pointer-on-d0
17999 @opindex mreturn-pointer-on-d0
18000 When generating a function that returns a pointer, return the pointer
18001 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18002 only in @code{a0}, and attempts to call such functions without a prototype
18003 result in errors.  Note that this option is on by default; use
18004 @option{-mno-return-pointer-on-d0} to disable it.
18006 @item -mno-crt0
18007 @opindex mno-crt0
18008 Do not link in the C run-time initialization object file.
18010 @item -mrelax
18011 @opindex mrelax
18012 Indicate to the linker that it should perform a relaxation optimization pass
18013 to shorten branches, calls and absolute memory addresses.  This option only
18014 has an effect when used on the command line for the final link step.
18016 This option makes symbolic debugging impossible.
18018 @item -mliw
18019 @opindex mliw
18020 Allow the compiler to generate @emph{Long Instruction Word}
18021 instructions if the target is the @samp{AM33} or later.  This is the
18022 default.  This option defines the preprocessor macro @code{__LIW__}.
18024 @item -mnoliw
18025 @opindex mnoliw
18026 Do not allow the compiler to generate @emph{Long Instruction Word}
18027 instructions.  This option defines the preprocessor macro
18028 @code{__NO_LIW__}.
18030 @item -msetlb
18031 @opindex msetlb
18032 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18033 instructions if the target is the @samp{AM33} or later.  This is the
18034 default.  This option defines the preprocessor macro @code{__SETLB__}.
18036 @item -mnosetlb
18037 @opindex mnosetlb
18038 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18039 instructions.  This option defines the preprocessor macro
18040 @code{__NO_SETLB__}.
18042 @end table
18044 @node Moxie Options
18045 @subsection Moxie Options
18046 @cindex Moxie Options
18048 @table @gcctabopt
18050 @item -meb
18051 @opindex meb
18052 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18053 configurations.
18055 @item -mel
18056 @opindex mel
18057 Generate little-endian code.
18059 @item -mmul.x
18060 @opindex mmul.x
18061 Generate mul.x and umul.x instructions.  This is the default for
18062 @samp{moxiebox-*-*} configurations.
18064 @item -mno-crt0
18065 @opindex mno-crt0
18066 Do not link in the C run-time initialization object file.
18068 @end table
18070 @node MSP430 Options
18071 @subsection MSP430 Options
18072 @cindex MSP430 Options
18074 These options are defined for the MSP430:
18076 @table @gcctabopt
18078 @item -masm-hex
18079 @opindex masm-hex
18080 Force assembly output to always use hex constants.  Normally such
18081 constants are signed decimals, but this option is available for
18082 testsuite and/or aesthetic purposes.
18084 @item -mmcu=
18085 @opindex mmcu=
18086 Select the MCU to target.  This is used to create a C preprocessor
18087 symbol based upon the MCU name, converted to upper case and pre- and
18088 post-fixed with @samp{__}.  This in turn is used by the
18089 @file{msp430.h} header file to select an MCU-specific supplementary
18090 header file.
18092 The option also sets the ISA to use.  If the MCU name is one that is
18093 known to only support the 430 ISA then that is selected, otherwise the
18094 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
18095 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
18096 name selects the 430X ISA.
18098 In addition an MCU-specific linker script is added to the linker
18099 command line.  The script's name is the name of the MCU with
18100 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
18101 command line defines the C preprocessor symbol @code{__XXX__} and
18102 cause the linker to search for a script called @file{xxx.ld}.
18104 This option is also passed on to the assembler.
18106 @item -mcpu=
18107 @opindex mcpu=
18108 Specifies the ISA to use.  Accepted values are @samp{msp430},
18109 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
18110 @option{-mmcu=} option should be used to select the ISA.
18112 @item -msim
18113 @opindex msim
18114 Link to the simulator runtime libraries and linker script.  Overrides
18115 any scripts that would be selected by the @option{-mmcu=} option.
18117 @item -mlarge
18118 @opindex mlarge
18119 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18121 @item -msmall
18122 @opindex msmall
18123 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18125 @item -mrelax
18126 @opindex mrelax
18127 This option is passed to the assembler and linker, and allows the
18128 linker to perform certain optimizations that cannot be done until
18129 the final link.
18131 @item mhwmult=
18132 @opindex mhwmult=
18133 Describes the type of hardware multiply supported by the target.
18134 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
18135 for the original 16-bit-only multiply supported by early MCUs.
18136 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
18137 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18138 A value of @samp{auto} can also be given.  This tells GCC to deduce
18139 the hardware multiply support based upon the MCU name provided by the
18140 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18141 @samp{32bit} hardware multiply support is assumed.  @samp{auto} is the
18142 default setting.
18144 Hardware multiplies are normally performed by calling a library
18145 routine.  This saves space in the generated code.  When compiling at
18146 @option{-O3} or higher however the hardware multiplier is invoked
18147 inline.  This makes for bigger, but faster code.
18149 The hardware multiply routines disable interrupts whilst running and
18150 restore the previous interrupt state when they finish.  This makes
18151 them safe to use inside interrupt handlers as well as in normal code.
18153 @item -minrt
18154 @opindex minrt
18155 Enable the use of a minimum runtime environment - no static
18156 initializers or constructors.  This is intended for memory-constrained
18157 devices.  The compiler includes special symbols in some objects
18158 that tell the linker and runtime which code fragments are required.
18160 @end table
18162 @node NDS32 Options
18163 @subsection NDS32 Options
18164 @cindex NDS32 Options
18166 These options are defined for NDS32 implementations:
18168 @table @gcctabopt
18170 @item -mbig-endian
18171 @opindex mbig-endian
18172 Generate code in big-endian mode.
18174 @item -mlittle-endian
18175 @opindex mlittle-endian
18176 Generate code in little-endian mode.
18178 @item -mreduced-regs
18179 @opindex mreduced-regs
18180 Use reduced-set registers for register allocation.
18182 @item -mfull-regs
18183 @opindex mfull-regs
18184 Use full-set registers for register allocation.
18186 @item -mcmov
18187 @opindex mcmov
18188 Generate conditional move instructions.
18190 @item -mno-cmov
18191 @opindex mno-cmov
18192 Do not generate conditional move instructions.
18194 @item -mperf-ext
18195 @opindex mperf-ext
18196 Generate performance extension instructions.
18198 @item -mno-perf-ext
18199 @opindex mno-perf-ext
18200 Do not generate performance extension instructions.
18202 @item -mv3push
18203 @opindex mv3push
18204 Generate v3 push25/pop25 instructions.
18206 @item -mno-v3push
18207 @opindex mno-v3push
18208 Do not generate v3 push25/pop25 instructions.
18210 @item -m16-bit
18211 @opindex m16-bit
18212 Generate 16-bit instructions.
18214 @item -mno-16-bit
18215 @opindex mno-16-bit
18216 Do not generate 16-bit instructions.
18218 @item -misr-vector-size=@var{num}
18219 @opindex misr-vector-size
18220 Specify the size of each interrupt vector, which must be 4 or 16.
18222 @item -mcache-block-size=@var{num}
18223 @opindex mcache-block-size
18224 Specify the size of each cache block,
18225 which must be a power of 2 between 4 and 512.
18227 @item -march=@var{arch}
18228 @opindex march
18229 Specify the name of the target architecture.
18231 @item -mcmodel=@var{code-model}
18232 @opindex mcmodel
18233 Set the code model to one of
18234 @table @asis
18235 @item @samp{small}
18236 All the data and read-only data segments must be within 512KB addressing space.
18237 The text segment must be within 16MB addressing space.
18238 @item @samp{medium}
18239 The data segment must be within 512KB while the read-only data segment can be
18240 within 4GB addressing space.  The text segment should be still within 16MB
18241 addressing space.
18242 @item @samp{large}
18243 All the text and data segments can be within 4GB addressing space.
18244 @end table
18246 @item -mctor-dtor
18247 @opindex mctor-dtor
18248 Enable constructor/destructor feature.
18250 @item -mrelax
18251 @opindex mrelax
18252 Guide linker to relax instructions.
18254 @end table
18256 @node Nios II Options
18257 @subsection Nios II Options
18258 @cindex Nios II options
18259 @cindex Altera Nios II options
18261 These are the options defined for the Altera Nios II processor.
18263 @table @gcctabopt
18265 @item -G @var{num}
18266 @opindex G
18267 @cindex smaller data references
18268 Put global and static objects less than or equal to @var{num} bytes
18269 into the small data or BSS sections instead of the normal data or BSS
18270 sections.  The default value of @var{num} is 8.
18272 @item -mgpopt=@var{option}
18273 @item -mgpopt
18274 @itemx -mno-gpopt
18275 @opindex mgpopt
18276 @opindex mno-gpopt
18277 Generate (do not generate) GP-relative accesses.  The following 
18278 @var{option} names are recognized:
18280 @table @samp
18282 @item none
18283 Do not generate GP-relative accesses.
18285 @item local
18286 Generate GP-relative accesses for small data objects that are not 
18287 external or weak.  Also use GP-relative addressing for objects that
18288 have been explicitly placed in a small data section via a @code{section}
18289 attribute.
18291 @item global
18292 As for @samp{local}, but also generate GP-relative accesses for
18293 small data objects that are external or weak.  If you use this option,
18294 you must ensure that all parts of your program (including libraries) are
18295 compiled with the same @option{-G} setting.
18297 @item data
18298 Generate GP-relative accesses for all data objects in the program.  If you
18299 use this option, the entire data and BSS segments
18300 of your program must fit in 64K of memory and you must use an appropriate
18301 linker script to allocate them within the addressible range of the
18302 global pointer.
18304 @item all
18305 Generate GP-relative addresses for function pointers as well as data
18306 pointers.  If you use this option, the entire text, data, and BSS segments
18307 of your program must fit in 64K of memory and you must use an appropriate
18308 linker script to allocate them within the addressible range of the
18309 global pointer.
18311 @end table
18313 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
18314 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
18316 The default is @option{-mgpopt} except when @option{-fpic} or
18317 @option{-fPIC} is specified to generate position-independent code.
18318 Note that the Nios II ABI does not permit GP-relative accesses from
18319 shared libraries.
18321 You may need to specify @option{-mno-gpopt} explicitly when building
18322 programs that include large amounts of small data, including large
18323 GOT data sections.  In this case, the 16-bit offset for GP-relative
18324 addressing may not be large enough to allow access to the entire 
18325 small data section.
18327 @item -mel
18328 @itemx -meb
18329 @opindex mel
18330 @opindex meb
18331 Generate little-endian (default) or big-endian (experimental) code,
18332 respectively.
18334 @item -mbypass-cache
18335 @itemx -mno-bypass-cache
18336 @opindex mno-bypass-cache
18337 @opindex mbypass-cache
18338 Force all load and store instructions to always bypass cache by 
18339 using I/O variants of the instructions. The default is not to
18340 bypass the cache.
18342 @item -mno-cache-volatile 
18343 @itemx -mcache-volatile       
18344 @opindex mcache-volatile 
18345 @opindex mno-cache-volatile
18346 Volatile memory access bypass the cache using the I/O variants of 
18347 the load and store instructions. The default is not to bypass the cache.
18349 @item -mno-fast-sw-div
18350 @itemx -mfast-sw-div
18351 @opindex mno-fast-sw-div
18352 @opindex mfast-sw-div
18353 Do not use table-based fast divide for small numbers. The default 
18354 is to use the fast divide at @option{-O3} and above.
18356 @item -mno-hw-mul
18357 @itemx -mhw-mul
18358 @itemx -mno-hw-mulx
18359 @itemx -mhw-mulx
18360 @itemx -mno-hw-div
18361 @itemx -mhw-div
18362 @opindex mno-hw-mul
18363 @opindex mhw-mul
18364 @opindex mno-hw-mulx
18365 @opindex mhw-mulx
18366 @opindex mno-hw-div
18367 @opindex mhw-div
18368 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18369 instructions by the compiler. The default is to emit @code{mul}
18370 and not emit @code{div} and @code{mulx}.
18372 @item -mcustom-@var{insn}=@var{N}
18373 @itemx -mno-custom-@var{insn}
18374 @opindex mcustom-@var{insn}
18375 @opindex mno-custom-@var{insn}
18376 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18377 custom instruction with encoding @var{N} when generating code that uses 
18378 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
18379 instruction 253 for single-precision floating-point add operations instead
18380 of the default behavior of using a library call.
18382 The following values of @var{insn} are supported.  Except as otherwise
18383 noted, floating-point operations are expected to be implemented with
18384 normal IEEE 754 semantics and correspond directly to the C operators or the
18385 equivalent GCC built-in functions (@pxref{Other Builtins}).
18387 Single-precision floating point:
18388 @table @asis
18390 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18391 Binary arithmetic operations.
18393 @item @samp{fnegs}
18394 Unary negation.
18396 @item @samp{fabss}
18397 Unary absolute value.
18399 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18400 Comparison operations.
18402 @item @samp{fmins}, @samp{fmaxs}
18403 Floating-point minimum and maximum.  These instructions are only
18404 generated if @option{-ffinite-math-only} is specified.
18406 @item @samp{fsqrts}
18407 Unary square root operation.
18409 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18410 Floating-point trigonometric and exponential functions.  These instructions
18411 are only generated if @option{-funsafe-math-optimizations} is also specified.
18413 @end table
18415 Double-precision floating point:
18416 @table @asis
18418 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18419 Binary arithmetic operations.
18421 @item @samp{fnegd}
18422 Unary negation.
18424 @item @samp{fabsd}
18425 Unary absolute value.
18427 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18428 Comparison operations.
18430 @item @samp{fmind}, @samp{fmaxd}
18431 Double-precision minimum and maximum.  These instructions are only
18432 generated if @option{-ffinite-math-only} is specified.
18434 @item @samp{fsqrtd}
18435 Unary square root operation.
18437 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18438 Double-precision trigonometric and exponential functions.  These instructions
18439 are only generated if @option{-funsafe-math-optimizations} is also specified.
18441 @end table
18443 Conversions:
18444 @table @asis
18445 @item @samp{fextsd}
18446 Conversion from single precision to double precision.
18448 @item @samp{ftruncds}
18449 Conversion from double precision to single precision.
18451 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18452 Conversion from floating point to signed or unsigned integer types, with
18453 truncation towards zero.
18455 @item @samp{round}
18456 Conversion from single-precision floating point to signed integer,
18457 rounding to the nearest integer and ties away from zero.
18458 This corresponds to the @code{__builtin_lroundf} function when
18459 @option{-fno-math-errno} is used.
18461 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18462 Conversion from signed or unsigned integer types to floating-point types.
18464 @end table
18466 In addition, all of the following transfer instructions for internal
18467 registers X and Y must be provided to use any of the double-precision
18468 floating-point instructions.  Custom instructions taking two
18469 double-precision source operands expect the first operand in the
18470 64-bit register X.  The other operand (or only operand of a unary
18471 operation) is given to the custom arithmetic instruction with the
18472 least significant half in source register @var{src1} and the most
18473 significant half in @var{src2}.  A custom instruction that returns a
18474 double-precision result returns the most significant 32 bits in the
18475 destination register and the other half in 32-bit register Y.  
18476 GCC automatically generates the necessary code sequences to write
18477 register X and/or read register Y when double-precision floating-point
18478 instructions are used.
18480 @table @asis
18482 @item @samp{fwrx}
18483 Write @var{src1} into the least significant half of X and @var{src2} into
18484 the most significant half of X.
18486 @item @samp{fwry}
18487 Write @var{src1} into Y.
18489 @item @samp{frdxhi}, @samp{frdxlo}
18490 Read the most or least (respectively) significant half of X and store it in
18491 @var{dest}.
18493 @item @samp{frdy}
18494 Read the value of Y and store it into @var{dest}.
18495 @end table
18497 Note that you can gain more local control over generation of Nios II custom
18498 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18499 and @code{target("no-custom-@var{insn}")} function attributes
18500 (@pxref{Function Attributes})
18501 or pragmas (@pxref{Function Specific Option Pragmas}).
18503 @item -mcustom-fpu-cfg=@var{name}
18504 @opindex mcustom-fpu-cfg
18506 This option enables a predefined, named set of custom instruction encodings
18507 (see @option{-mcustom-@var{insn}} above).  
18508 Currently, the following sets are defined:
18510 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18511 @gccoptlist{-mcustom-fmuls=252 @gol
18512 -mcustom-fadds=253 @gol
18513 -mcustom-fsubs=254 @gol
18514 -fsingle-precision-constant}
18516 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18517 @gccoptlist{-mcustom-fmuls=252 @gol
18518 -mcustom-fadds=253 @gol
18519 -mcustom-fsubs=254 @gol
18520 -mcustom-fdivs=255 @gol
18521 -fsingle-precision-constant}
18523 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18524 @gccoptlist{-mcustom-floatus=243 @gol
18525 -mcustom-fixsi=244 @gol
18526 -mcustom-floatis=245 @gol
18527 -mcustom-fcmpgts=246 @gol
18528 -mcustom-fcmples=249 @gol
18529 -mcustom-fcmpeqs=250 @gol
18530 -mcustom-fcmpnes=251 @gol
18531 -mcustom-fmuls=252 @gol
18532 -mcustom-fadds=253 @gol
18533 -mcustom-fsubs=254 @gol
18534 -mcustom-fdivs=255 @gol
18535 -fsingle-precision-constant}
18537 Custom instruction assignments given by individual
18538 @option{-mcustom-@var{insn}=} options override those given by
18539 @option{-mcustom-fpu-cfg=}, regardless of the
18540 order of the options on the command line.
18542 Note that you can gain more local control over selection of a FPU
18543 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18544 function attribute (@pxref{Function Attributes})
18545 or pragma (@pxref{Function Specific Option Pragmas}).
18547 @end table
18549 These additional @samp{-m} options are available for the Altera Nios II
18550 ELF (bare-metal) target:
18552 @table @gcctabopt
18554 @item -mhal
18555 @opindex mhal
18556 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18557 startup and termination code, and is typically used in conjunction with
18558 @option{-msys-crt0=} to specify the location of the alternate startup code
18559 provided by the HAL BSP.
18561 @item -msmallc
18562 @opindex msmallc
18563 Link with a limited version of the C library, @option{-lsmallc}, rather than
18564 Newlib.
18566 @item -msys-crt0=@var{startfile}
18567 @opindex msys-crt0
18568 @var{startfile} is the file name of the startfile (crt0) to use 
18569 when linking.  This option is only useful in conjunction with @option{-mhal}.
18571 @item -msys-lib=@var{systemlib}
18572 @opindex msys-lib
18573 @var{systemlib} is the library name of the library that provides
18574 low-level system calls required by the C library,
18575 e.g. @code{read} and @code{write}.
18576 This option is typically used to link with a library provided by a HAL BSP.
18578 @end table
18580 @node Nvidia PTX Options
18581 @subsection Nvidia PTX Options
18582 @cindex Nvidia PTX options
18583 @cindex nvptx options
18585 These options are defined for Nvidia PTX:
18587 @table @gcctabopt
18589 @item -m32
18590 @itemx -m64
18591 @opindex m32
18592 @opindex m64
18593 Generate code for 32-bit or 64-bit ABI.
18595 @item -mmainkernel
18596 @opindex mmainkernel
18597 Link in code for a __main kernel.  This is for stand-alone instead of
18598 offloading execution.
18600 @end table
18602 @node PDP-11 Options
18603 @subsection PDP-11 Options
18604 @cindex PDP-11 Options
18606 These options are defined for the PDP-11:
18608 @table @gcctabopt
18609 @item -mfpu
18610 @opindex mfpu
18611 Use hardware FPP floating point.  This is the default.  (FIS floating
18612 point on the PDP-11/40 is not supported.)
18614 @item -msoft-float
18615 @opindex msoft-float
18616 Do not use hardware floating point.
18618 @item -mac0
18619 @opindex mac0
18620 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18622 @item -mno-ac0
18623 @opindex mno-ac0
18624 Return floating-point results in memory.  This is the default.
18626 @item -m40
18627 @opindex m40
18628 Generate code for a PDP-11/40.
18630 @item -m45
18631 @opindex m45
18632 Generate code for a PDP-11/45.  This is the default.
18634 @item -m10
18635 @opindex m10
18636 Generate code for a PDP-11/10.
18638 @item -mbcopy-builtin
18639 @opindex mbcopy-builtin
18640 Use inline @code{movmemhi} patterns for copying memory.  This is the
18641 default.
18643 @item -mbcopy
18644 @opindex mbcopy
18645 Do not use inline @code{movmemhi} patterns for copying memory.
18647 @item -mint16
18648 @itemx -mno-int32
18649 @opindex mint16
18650 @opindex mno-int32
18651 Use 16-bit @code{int}.  This is the default.
18653 @item -mint32
18654 @itemx -mno-int16
18655 @opindex mint32
18656 @opindex mno-int16
18657 Use 32-bit @code{int}.
18659 @item -mfloat64
18660 @itemx -mno-float32
18661 @opindex mfloat64
18662 @opindex mno-float32
18663 Use 64-bit @code{float}.  This is the default.
18665 @item -mfloat32
18666 @itemx -mno-float64
18667 @opindex mfloat32
18668 @opindex mno-float64
18669 Use 32-bit @code{float}.
18671 @item -mabshi
18672 @opindex mabshi
18673 Use @code{abshi2} pattern.  This is the default.
18675 @item -mno-abshi
18676 @opindex mno-abshi
18677 Do not use @code{abshi2} pattern.
18679 @item -mbranch-expensive
18680 @opindex mbranch-expensive
18681 Pretend that branches are expensive.  This is for experimenting with
18682 code generation only.
18684 @item -mbranch-cheap
18685 @opindex mbranch-cheap
18686 Do not pretend that branches are expensive.  This is the default.
18688 @item -munix-asm
18689 @opindex munix-asm
18690 Use Unix assembler syntax.  This is the default when configured for
18691 @samp{pdp11-*-bsd}.
18693 @item -mdec-asm
18694 @opindex mdec-asm
18695 Use DEC assembler syntax.  This is the default when configured for any
18696 PDP-11 target other than @samp{pdp11-*-bsd}.
18697 @end table
18699 @node picoChip Options
18700 @subsection picoChip Options
18701 @cindex picoChip options
18703 These @samp{-m} options are defined for picoChip implementations:
18705 @table @gcctabopt
18707 @item -mae=@var{ae_type}
18708 @opindex mcpu
18709 Set the instruction set, register set, and instruction scheduling
18710 parameters for array element type @var{ae_type}.  Supported values
18711 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18713 @option{-mae=ANY} selects a completely generic AE type.  Code
18714 generated with this option runs on any of the other AE types.  The
18715 code is not as efficient as it would be if compiled for a specific
18716 AE type, and some types of operation (e.g., multiplication) do not
18717 work properly on all types of AE.
18719 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18720 for compiled code, and is the default.
18722 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18723 option may suffer from poor performance of byte (char) manipulation,
18724 since the DSP AE does not provide hardware support for byte load/stores.
18726 @item -msymbol-as-address
18727 Enable the compiler to directly use a symbol name as an address in a
18728 load/store instruction, without first loading it into a
18729 register.  Typically, the use of this option generates larger
18730 programs, which run faster than when the option isn't used.  However, the
18731 results vary from program to program, so it is left as a user option,
18732 rather than being permanently enabled.
18734 @item -mno-inefficient-warnings
18735 Disables warnings about the generation of inefficient code.  These
18736 warnings can be generated, for example, when compiling code that
18737 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18738 no hardware support for byte-level memory operations, so all byte
18739 load/stores must be synthesized from word load/store operations.  This is
18740 inefficient and a warning is generated to indicate
18741 that you should rewrite the code to avoid byte operations, or to target
18742 an AE type that has the necessary hardware support.  This option disables
18743 these warnings.
18745 @end table
18747 @node PowerPC Options
18748 @subsection PowerPC Options
18749 @cindex PowerPC options
18751 These are listed under @xref{RS/6000 and PowerPC Options}.
18753 @node RL78 Options
18754 @subsection RL78 Options
18755 @cindex RL78 Options
18757 @table @gcctabopt
18759 @item -msim
18760 @opindex msim
18761 Links in additional target libraries to support operation within a
18762 simulator.
18764 @item -mmul=none
18765 @itemx -mmul=g10
18766 @itemx -mmul=g13
18767 @itemx -mmul=g14
18768 @itemx -mmul=rl78
18769 @opindex mmul
18770 Specifies the type of hardware multiplication and division support to
18771 be used.  The simplest is @code{none}, which uses software for both
18772 multiplication and division.  This is the default.  The @code{g13}
18773 value is for the hardware multiply/divide peripheral found on the
18774 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
18775 the multiplication and division instructions supported by the RL78/G14
18776 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
18777 the value @code{mg10} is an alias for @code{none}.
18779 In addition a C preprocessor macro is defined, based upon the setting
18780 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
18781 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
18783 @item -mcpu=g10
18784 @itemx -mcpu=g13
18785 @itemx -mcpu=g14
18786 @itemx -mcpu=rl78
18787 @opindex mcpu
18788 Specifies the RL78 core to target.  The default is the G14 core, also
18789 known as an S3 core or just RL78.  The G13 or S2 core does not have
18790 multiply or divide instructions, instead it uses a hardware peripheral
18791 for these operations.  The G10 or S1 core does not have register
18792 banks, so it uses a different calling convention.
18794 If this option is set it also selects the type of hardware multiply
18795 support to use, unless this is overridden by an explicit
18796 @option{-mmul=none} option on the command line.  Thus specifying
18797 @option{-mcpu=g13} enables the use of the G13 hardware multiply
18798 peripheral and specifying @option{-mcpu=g10} disables the use of
18799 hardware multipications altogether.
18801 Note, although the RL78/G14 core is the default target, specifying
18802 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
18803 change the behaviour of the toolchain since it also enables G14
18804 hardware multiply support.  If these options are not specified on the
18805 command line then software multiplication routines will be used even
18806 though the code targets the RL78 core.  This is for backwards
18807 compatibility with older toolchains which did not have hardware
18808 multiply and divide support.
18810 In addition a C preprocessor macro is defined, based upon the setting
18811 of this option.  Possible values are: @code{__RL78_G10__},
18812 @code{__RL78_G13__} or @code{__RL78_G14__}.
18814 @item -mg10
18815 @itemx -mg13
18816 @itemx -mg14
18817 @itemx -mrl78
18818 @opindex mg10
18819 @opindex mg13
18820 @opindex mg14
18821 @opindex mrl78
18822 These are aliases for the corresponding @option{-mcpu=} option.  They
18823 are provided for backwards compatibility.
18825 @item -mallregs
18826 @opindex mallregs
18827 Allow the compiler to use all of the available registers.  By default
18828 registers @code{r24..r31} are reserved for use in interrupt handlers.
18829 With this option enabled these registers can be used in ordinary
18830 functions as well.
18832 @item -m64bit-doubles
18833 @itemx -m32bit-doubles
18834 @opindex m64bit-doubles
18835 @opindex m32bit-doubles
18836 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18837 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18838 @option{-m32bit-doubles}.
18840 @end table
18842 @node RS/6000 and PowerPC Options
18843 @subsection IBM RS/6000 and PowerPC Options
18844 @cindex RS/6000 and PowerPC Options
18845 @cindex IBM RS/6000 and PowerPC Options
18847 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18848 @table @gcctabopt
18849 @item -mpowerpc-gpopt
18850 @itemx -mno-powerpc-gpopt
18851 @itemx -mpowerpc-gfxopt
18852 @itemx -mno-powerpc-gfxopt
18853 @need 800
18854 @itemx -mpowerpc64
18855 @itemx -mno-powerpc64
18856 @itemx -mmfcrf
18857 @itemx -mno-mfcrf
18858 @itemx -mpopcntb
18859 @itemx -mno-popcntb
18860 @itemx -mpopcntd
18861 @itemx -mno-popcntd
18862 @itemx -mfprnd
18863 @itemx -mno-fprnd
18864 @need 800
18865 @itemx -mcmpb
18866 @itemx -mno-cmpb
18867 @itemx -mmfpgpr
18868 @itemx -mno-mfpgpr
18869 @itemx -mhard-dfp
18870 @itemx -mno-hard-dfp
18871 @opindex mpowerpc-gpopt
18872 @opindex mno-powerpc-gpopt
18873 @opindex mpowerpc-gfxopt
18874 @opindex mno-powerpc-gfxopt
18875 @opindex mpowerpc64
18876 @opindex mno-powerpc64
18877 @opindex mmfcrf
18878 @opindex mno-mfcrf
18879 @opindex mpopcntb
18880 @opindex mno-popcntb
18881 @opindex mpopcntd
18882 @opindex mno-popcntd
18883 @opindex mfprnd
18884 @opindex mno-fprnd
18885 @opindex mcmpb
18886 @opindex mno-cmpb
18887 @opindex mmfpgpr
18888 @opindex mno-mfpgpr
18889 @opindex mhard-dfp
18890 @opindex mno-hard-dfp
18891 You use these options to specify which instructions are available on the
18892 processor you are using.  The default value of these options is
18893 determined when configuring GCC@.  Specifying the
18894 @option{-mcpu=@var{cpu_type}} overrides the specification of these
18895 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
18896 rather than the options listed above.
18898 Specifying @option{-mpowerpc-gpopt} allows
18899 GCC to use the optional PowerPC architecture instructions in the
18900 General Purpose group, including floating-point square root.  Specifying
18901 @option{-mpowerpc-gfxopt} allows GCC to
18902 use the optional PowerPC architecture instructions in the Graphics
18903 group, including floating-point select.
18905 The @option{-mmfcrf} option allows GCC to generate the move from
18906 condition register field instruction implemented on the POWER4
18907 processor and other processors that support the PowerPC V2.01
18908 architecture.
18909 The @option{-mpopcntb} option allows GCC to generate the popcount and
18910 double-precision FP reciprocal estimate instruction implemented on the
18911 POWER5 processor and other processors that support the PowerPC V2.02
18912 architecture.
18913 The @option{-mpopcntd} option allows GCC to generate the popcount
18914 instruction implemented on the POWER7 processor and other processors
18915 that support the PowerPC V2.06 architecture.
18916 The @option{-mfprnd} option allows GCC to generate the FP round to
18917 integer instructions implemented on the POWER5+ processor and other
18918 processors that support the PowerPC V2.03 architecture.
18919 The @option{-mcmpb} option allows GCC to generate the compare bytes
18920 instruction implemented on the POWER6 processor and other processors
18921 that support the PowerPC V2.05 architecture.
18922 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
18923 general-purpose register instructions implemented on the POWER6X
18924 processor and other processors that support the extended PowerPC V2.05
18925 architecture.
18926 The @option{-mhard-dfp} option allows GCC to generate the decimal
18927 floating-point instructions implemented on some POWER processors.
18929 The @option{-mpowerpc64} option allows GCC to generate the additional
18930 64-bit instructions that are found in the full PowerPC64 architecture
18931 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
18932 @option{-mno-powerpc64}.
18934 @item -mcpu=@var{cpu_type}
18935 @opindex mcpu
18936 Set architecture type, register usage, and
18937 instruction scheduling parameters for machine type @var{cpu_type}.
18938 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
18939 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
18940 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
18941 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
18942 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
18943 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
18944 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
18945 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
18946 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
18947 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
18948 @samp{powerpc64}, @samp{powerpc64le}, and @samp{rs64}.
18950 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
18951 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
18952 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
18953 architecture machine types, with an appropriate, generic processor
18954 model assumed for scheduling purposes.
18956 The other options specify a specific processor.  Code generated under
18957 those options runs best on that processor, and may not run at all on
18958 others.
18960 The @option{-mcpu} options automatically enable or disable the
18961 following options:
18963 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
18964 -mpopcntb -mpopcntd  -mpowerpc64 @gol
18965 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
18966 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
18967 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
18968 -mquad-memory -mquad-memory-atomic}
18970 The particular options set for any particular CPU varies between
18971 compiler versions, depending on what setting seems to produce optimal
18972 code for that CPU; it doesn't necessarily reflect the actual hardware's
18973 capabilities.  If you wish to set an individual option to a particular
18974 value, you may specify it after the @option{-mcpu} option, like
18975 @option{-mcpu=970 -mno-altivec}.
18977 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
18978 not enabled or disabled by the @option{-mcpu} option at present because
18979 AIX does not have full support for these options.  You may still
18980 enable or disable them individually if you're sure it'll work in your
18981 environment.
18983 @item -mtune=@var{cpu_type}
18984 @opindex mtune
18985 Set the instruction scheduling parameters for machine type
18986 @var{cpu_type}, but do not set the architecture type or register usage,
18987 as @option{-mcpu=@var{cpu_type}} does.  The same
18988 values for @var{cpu_type} are used for @option{-mtune} as for
18989 @option{-mcpu}.  If both are specified, the code generated uses the
18990 architecture and registers set by @option{-mcpu}, but the
18991 scheduling parameters set by @option{-mtune}.
18993 @item -mcmodel=small
18994 @opindex mcmodel=small
18995 Generate PowerPC64 code for the small model: The TOC is limited to
18996 64k.
18998 @item -mcmodel=medium
18999 @opindex mcmodel=medium
19000 Generate PowerPC64 code for the medium model: The TOC and other static
19001 data may be up to a total of 4G in size.
19003 @item -mcmodel=large
19004 @opindex mcmodel=large
19005 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19006 in size.  Other data and code is only limited by the 64-bit address
19007 space.
19009 @item -maltivec
19010 @itemx -mno-altivec
19011 @opindex maltivec
19012 @opindex mno-altivec
19013 Generate code that uses (does not use) AltiVec instructions, and also
19014 enable the use of built-in functions that allow more direct access to
19015 the AltiVec instruction set.  You may also need to set
19016 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19017 enhancements.
19019 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19020 @option{-maltivec=be}, the element order for Altivec intrinsics such
19021 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
19022 match array element order corresponding to the endianness of the
19023 target.  That is, element zero identifies the leftmost element in a
19024 vector register when targeting a big-endian platform, and identifies
19025 the rightmost element in a vector register when targeting a
19026 little-endian platform.
19028 @item -maltivec=be
19029 @opindex maltivec=be
19030 Generate Altivec instructions using big-endian element order,
19031 regardless of whether the target is big- or little-endian.  This is
19032 the default when targeting a big-endian platform.
19034 The element order is used to interpret element numbers in Altivec
19035 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19036 @code{vec_insert}.  By default, these match array element order
19037 corresponding to the endianness for the target.
19039 @item -maltivec=le
19040 @opindex maltivec=le
19041 Generate Altivec instructions using little-endian element order,
19042 regardless of whether the target is big- or little-endian.  This is
19043 the default when targeting a little-endian platform.  This option is
19044 currently ignored when targeting a big-endian platform.
19046 The element order is used to interpret element numbers in Altivec
19047 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19048 @code{vec_insert}.  By default, these match array element order
19049 corresponding to the endianness for the target.
19051 @item -mvrsave
19052 @itemx -mno-vrsave
19053 @opindex mvrsave
19054 @opindex mno-vrsave
19055 Generate VRSAVE instructions when generating AltiVec code.
19057 @item -mgen-cell-microcode
19058 @opindex mgen-cell-microcode
19059 Generate Cell microcode instructions.
19061 @item -mwarn-cell-microcode
19062 @opindex mwarn-cell-microcode
19063 Warn when a Cell microcode instruction is emitted.  An example
19064 of a Cell microcode instruction is a variable shift.
19066 @item -msecure-plt
19067 @opindex msecure-plt
19068 Generate code that allows @command{ld} and @command{ld.so}
19069 to build executables and shared
19070 libraries with non-executable @code{.plt} and @code{.got} sections.
19071 This is a PowerPC
19072 32-bit SYSV ABI option.
19074 @item -mbss-plt
19075 @opindex mbss-plt
19076 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19077 fills in, and
19078 requires @code{.plt} and @code{.got}
19079 sections that are both writable and executable.
19080 This is a PowerPC 32-bit SYSV ABI option.
19082 @item -misel
19083 @itemx -mno-isel
19084 @opindex misel
19085 @opindex mno-isel
19086 This switch enables or disables the generation of ISEL instructions.
19088 @item -misel=@var{yes/no}
19089 This switch has been deprecated.  Use @option{-misel} and
19090 @option{-mno-isel} instead.
19092 @item -mspe
19093 @itemx -mno-spe
19094 @opindex mspe
19095 @opindex mno-spe
19096 This switch enables or disables the generation of SPE simd
19097 instructions.
19099 @item -mpaired
19100 @itemx -mno-paired
19101 @opindex mpaired
19102 @opindex mno-paired
19103 This switch enables or disables the generation of PAIRED simd
19104 instructions.
19106 @item -mspe=@var{yes/no}
19107 This option has been deprecated.  Use @option{-mspe} and
19108 @option{-mno-spe} instead.
19110 @item -mvsx
19111 @itemx -mno-vsx
19112 @opindex mvsx
19113 @opindex mno-vsx
19114 Generate code that uses (does not use) vector/scalar (VSX)
19115 instructions, and also enable the use of built-in functions that allow
19116 more direct access to the VSX instruction set.
19118 @item -mcrypto
19119 @itemx -mno-crypto
19120 @opindex mcrypto
19121 @opindex mno-crypto
19122 Enable the use (disable) of the built-in functions that allow direct
19123 access to the cryptographic instructions that were added in version
19124 2.07 of the PowerPC ISA.
19126 @item -mdirect-move
19127 @itemx -mno-direct-move
19128 @opindex mdirect-move
19129 @opindex mno-direct-move
19130 Generate code that uses (does not use) the instructions to move data
19131 between the general purpose registers and the vector/scalar (VSX)
19132 registers that were added in version 2.07 of the PowerPC ISA.
19134 @item -mpower8-fusion
19135 @itemx -mno-power8-fusion
19136 @opindex mpower8-fusion
19137 @opindex mno-power8-fusion
19138 Generate code that keeps (does not keeps) some integer operations
19139 adjacent so that the instructions can be fused together on power8 and
19140 later processors.
19142 @item -mpower8-vector
19143 @itemx -mno-power8-vector
19144 @opindex mpower8-vector
19145 @opindex mno-power8-vector
19146 Generate code that uses (does not use) the vector and scalar
19147 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19148 enable the use of built-in functions that allow more direct access to
19149 the vector instructions.
19151 @item -mquad-memory
19152 @itemx -mno-quad-memory
19153 @opindex mquad-memory
19154 @opindex mno-quad-memory
19155 Generate code that uses (does not use) the non-atomic quad word memory
19156 instructions.  The @option{-mquad-memory} option requires use of
19157 64-bit mode.
19159 @item -mquad-memory-atomic
19160 @itemx -mno-quad-memory-atomic
19161 @opindex mquad-memory-atomic
19162 @opindex mno-quad-memory-atomic
19163 Generate code that uses (does not use) the atomic quad word memory
19164 instructions.  The @option{-mquad-memory-atomic} option requires use of
19165 64-bit mode.
19167 @item -mupper-regs-df
19168 @itemx -mno-upper-regs-df
19169 @opindex mupper-regs-df
19170 @opindex mno-upper-regs-df
19171 Generate code that uses (does not use) the scalar double precision
19172 instructions that target all 64 registers in the vector/scalar
19173 floating point register set that were added in version 2.06 of the
19174 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
19175 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19176 @option{-mvsx} options.
19178 @item -mupper-regs-sf
19179 @itemx -mno-upper-regs-sf
19180 @opindex mupper-regs-sf
19181 @opindex mno-upper-regs-sf
19182 Generate code that uses (does not use) the scalar single precision
19183 instructions that target all 64 registers in the vector/scalar
19184 floating point register set that were added in version 2.07 of the
19185 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
19186 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
19187 options.
19189 @item -mupper-regs
19190 @itemx -mno-upper-regs
19191 @opindex mupper-regs
19192 @opindex mno-upper-regs
19193 Generate code that uses (does not use) the scalar
19194 instructions that target all 64 registers in the vector/scalar
19195 floating point register set, depending on the model of the machine.
19197 If the @option{-mno-upper-regs} option is used, it turns off both
19198 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19200 @item -mfloat-gprs=@var{yes/single/double/no}
19201 @itemx -mfloat-gprs
19202 @opindex mfloat-gprs
19203 This switch enables or disables the generation of floating-point
19204 operations on the general-purpose registers for architectures that
19205 support it.
19207 The argument @samp{yes} or @samp{single} enables the use of
19208 single-precision floating-point operations.
19210 The argument @samp{double} enables the use of single and
19211 double-precision floating-point operations.
19213 The argument @samp{no} disables floating-point operations on the
19214 general-purpose registers.
19216 This option is currently only available on the MPC854x.
19218 @item -m32
19219 @itemx -m64
19220 @opindex m32
19221 @opindex m64
19222 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19223 targets (including GNU/Linux).  The 32-bit environment sets int, long
19224 and pointer to 32 bits and generates code that runs on any PowerPC
19225 variant.  The 64-bit environment sets int to 32 bits and long and
19226 pointer to 64 bits, and generates code for PowerPC64, as for
19227 @option{-mpowerpc64}.
19229 @item -mfull-toc
19230 @itemx -mno-fp-in-toc
19231 @itemx -mno-sum-in-toc
19232 @itemx -mminimal-toc
19233 @opindex mfull-toc
19234 @opindex mno-fp-in-toc
19235 @opindex mno-sum-in-toc
19236 @opindex mminimal-toc
19237 Modify generation of the TOC (Table Of Contents), which is created for
19238 every executable file.  The @option{-mfull-toc} option is selected by
19239 default.  In that case, GCC allocates at least one TOC entry for
19240 each unique non-automatic variable reference in your program.  GCC
19241 also places floating-point constants in the TOC@.  However, only
19242 16,384 entries are available in the TOC@.
19244 If you receive a linker error message that saying you have overflowed
19245 the available TOC space, you can reduce the amount of TOC space used
19246 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19247 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19248 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19249 generate code to calculate the sum of an address and a constant at
19250 run time instead of putting that sum into the TOC@.  You may specify one
19251 or both of these options.  Each causes GCC to produce very slightly
19252 slower and larger code at the expense of conserving TOC space.
19254 If you still run out of space in the TOC even when you specify both of
19255 these options, specify @option{-mminimal-toc} instead.  This option causes
19256 GCC to make only one TOC entry for every file.  When you specify this
19257 option, GCC produces code that is slower and larger but which
19258 uses extremely little TOC space.  You may wish to use this option
19259 only on files that contain less frequently-executed code.
19261 @item -maix64
19262 @itemx -maix32
19263 @opindex maix64
19264 @opindex maix32
19265 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19266 @code{long} type, and the infrastructure needed to support them.
19267 Specifying @option{-maix64} implies @option{-mpowerpc64},
19268 while @option{-maix32} disables the 64-bit ABI and
19269 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19271 @item -mxl-compat
19272 @itemx -mno-xl-compat
19273 @opindex mxl-compat
19274 @opindex mno-xl-compat
19275 Produce code that conforms more closely to IBM XL compiler semantics
19276 when using AIX-compatible ABI@.  Pass floating-point arguments to
19277 prototyped functions beyond the register save area (RSA) on the stack
19278 in addition to argument FPRs.  Do not assume that most significant
19279 double in 128-bit long double value is properly rounded when comparing
19280 values and converting to double.  Use XL symbol names for long double
19281 support routines.
19283 The AIX calling convention was extended but not initially documented to
19284 handle an obscure K&R C case of calling a function that takes the
19285 address of its arguments with fewer arguments than declared.  IBM XL
19286 compilers access floating-point arguments that do not fit in the
19287 RSA from the stack when a subroutine is compiled without
19288 optimization.  Because always storing floating-point arguments on the
19289 stack is inefficient and rarely needed, this option is not enabled by
19290 default and only is necessary when calling subroutines compiled by IBM
19291 XL compilers without optimization.
19293 @item -mpe
19294 @opindex mpe
19295 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19296 application written to use message passing with special startup code to
19297 enable the application to run.  The system must have PE installed in the
19298 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19299 must be overridden with the @option{-specs=} option to specify the
19300 appropriate directory location.  The Parallel Environment does not
19301 support threads, so the @option{-mpe} option and the @option{-pthread}
19302 option are incompatible.
19304 @item -malign-natural
19305 @itemx -malign-power
19306 @opindex malign-natural
19307 @opindex malign-power
19308 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19309 @option{-malign-natural} overrides the ABI-defined alignment of larger
19310 types, such as floating-point doubles, on their natural size-based boundary.
19311 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19312 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19314 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19315 is not supported.
19317 @item -msoft-float
19318 @itemx -mhard-float
19319 @opindex msoft-float
19320 @opindex mhard-float
19321 Generate code that does not use (uses) the floating-point register set.
19322 Software floating-point emulation is provided if you use the
19323 @option{-msoft-float} option, and pass the option to GCC when linking.
19325 @item -msingle-float
19326 @itemx -mdouble-float
19327 @opindex msingle-float
19328 @opindex mdouble-float
19329 Generate code for single- or double-precision floating-point operations.
19330 @option{-mdouble-float} implies @option{-msingle-float}.
19332 @item -msimple-fpu
19333 @opindex msimple-fpu
19334 Do not generate @code{sqrt} and @code{div} instructions for hardware
19335 floating-point unit.
19337 @item -mfpu=@var{name}
19338 @opindex mfpu
19339 Specify type of floating-point unit.  Valid values for @var{name} are
19340 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19341 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19342 @samp{sp_full} (equivalent to @option{-msingle-float}),
19343 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19345 @item -mxilinx-fpu
19346 @opindex mxilinx-fpu
19347 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19349 @item -mmultiple
19350 @itemx -mno-multiple
19351 @opindex mmultiple
19352 @opindex mno-multiple
19353 Generate code that uses (does not use) the load multiple word
19354 instructions and the store multiple word instructions.  These
19355 instructions are generated by default on POWER systems, and not
19356 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19357 PowerPC systems, since those instructions do not work when the
19358 processor is in little-endian mode.  The exceptions are PPC740 and
19359 PPC750 which permit these instructions in little-endian mode.
19361 @item -mstring
19362 @itemx -mno-string
19363 @opindex mstring
19364 @opindex mno-string
19365 Generate code that uses (does not use) the load string instructions
19366 and the store string word instructions to save multiple registers and
19367 do small block moves.  These instructions are generated by default on
19368 POWER systems, and not generated on PowerPC systems.  Do not use
19369 @option{-mstring} on little-endian PowerPC systems, since those
19370 instructions do not work when the processor is in little-endian mode.
19371 The exceptions are PPC740 and PPC750 which permit these instructions
19372 in little-endian mode.
19374 @item -mupdate
19375 @itemx -mno-update
19376 @opindex mupdate
19377 @opindex mno-update
19378 Generate code that uses (does not use) the load or store instructions
19379 that update the base register to the address of the calculated memory
19380 location.  These instructions are generated by default.  If you use
19381 @option{-mno-update}, there is a small window between the time that the
19382 stack pointer is updated and the address of the previous frame is
19383 stored, which means code that walks the stack frame across interrupts or
19384 signals may get corrupted data.
19386 @item -mavoid-indexed-addresses
19387 @itemx -mno-avoid-indexed-addresses
19388 @opindex mavoid-indexed-addresses
19389 @opindex mno-avoid-indexed-addresses
19390 Generate code that tries to avoid (not avoid) the use of indexed load
19391 or store instructions. These instructions can incur a performance
19392 penalty on Power6 processors in certain situations, such as when
19393 stepping through large arrays that cross a 16M boundary.  This option
19394 is enabled by default when targeting Power6 and disabled otherwise.
19396 @item -mfused-madd
19397 @itemx -mno-fused-madd
19398 @opindex mfused-madd
19399 @opindex mno-fused-madd
19400 Generate code that uses (does not use) the floating-point multiply and
19401 accumulate instructions.  These instructions are generated by default
19402 if hardware floating point is used.  The machine-dependent
19403 @option{-mfused-madd} option is now mapped to the machine-independent
19404 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19405 mapped to @option{-ffp-contract=off}.
19407 @item -mmulhw
19408 @itemx -mno-mulhw
19409 @opindex mmulhw
19410 @opindex mno-mulhw
19411 Generate code that uses (does not use) the half-word multiply and
19412 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19413 These instructions are generated by default when targeting those
19414 processors.
19416 @item -mdlmzb
19417 @itemx -mno-dlmzb
19418 @opindex mdlmzb
19419 @opindex mno-dlmzb
19420 Generate code that uses (does not use) the string-search @samp{dlmzb}
19421 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19422 generated by default when targeting those processors.
19424 @item -mno-bit-align
19425 @itemx -mbit-align
19426 @opindex mno-bit-align
19427 @opindex mbit-align
19428 On System V.4 and embedded PowerPC systems do not (do) force structures
19429 and unions that contain bit-fields to be aligned to the base type of the
19430 bit-field.
19432 For example, by default a structure containing nothing but 8
19433 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19434 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19435 the structure is aligned to a 1-byte boundary and is 1 byte in
19436 size.
19438 @item -mno-strict-align
19439 @itemx -mstrict-align
19440 @opindex mno-strict-align
19441 @opindex mstrict-align
19442 On System V.4 and embedded PowerPC systems do not (do) assume that
19443 unaligned memory references are handled by the system.
19445 @item -mrelocatable
19446 @itemx -mno-relocatable
19447 @opindex mrelocatable
19448 @opindex mno-relocatable
19449 Generate code that allows (does not allow) a static executable to be
19450 relocated to a different address at run time.  A simple embedded
19451 PowerPC system loader should relocate the entire contents of
19452 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19453 a table of 32-bit addresses generated by this option.  For this to
19454 work, all objects linked together must be compiled with
19455 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19456 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19458 @item -mrelocatable-lib
19459 @itemx -mno-relocatable-lib
19460 @opindex mrelocatable-lib
19461 @opindex mno-relocatable-lib
19462 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19463 @code{.fixup} section to allow static executables to be relocated at
19464 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19465 alignment of @option{-mrelocatable}.  Objects compiled with
19466 @option{-mrelocatable-lib} may be linked with objects compiled with
19467 any combination of the @option{-mrelocatable} options.
19469 @item -mno-toc
19470 @itemx -mtoc
19471 @opindex mno-toc
19472 @opindex mtoc
19473 On System V.4 and embedded PowerPC systems do not (do) assume that
19474 register 2 contains a pointer to a global area pointing to the addresses
19475 used in the program.
19477 @item -mlittle
19478 @itemx -mlittle-endian
19479 @opindex mlittle
19480 @opindex mlittle-endian
19481 On System V.4 and embedded PowerPC systems compile code for the
19482 processor in little-endian mode.  The @option{-mlittle-endian} option is
19483 the same as @option{-mlittle}.
19485 @item -mbig
19486 @itemx -mbig-endian
19487 @opindex mbig
19488 @opindex mbig-endian
19489 On System V.4 and embedded PowerPC systems compile code for the
19490 processor in big-endian mode.  The @option{-mbig-endian} option is
19491 the same as @option{-mbig}.
19493 @item -mdynamic-no-pic
19494 @opindex mdynamic-no-pic
19495 On Darwin and Mac OS X systems, compile code so that it is not
19496 relocatable, but that its external references are relocatable.  The
19497 resulting code is suitable for applications, but not shared
19498 libraries.
19500 @item -msingle-pic-base
19501 @opindex msingle-pic-base
19502 Treat the register used for PIC addressing as read-only, rather than
19503 loading it in the prologue for each function.  The runtime system is
19504 responsible for initializing this register with an appropriate value
19505 before execution begins.
19507 @item -mprioritize-restricted-insns=@var{priority}
19508 @opindex mprioritize-restricted-insns
19509 This option controls the priority that is assigned to
19510 dispatch-slot restricted instructions during the second scheduling
19511 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19512 or @samp{2} to assign no, highest, or second-highest (respectively) 
19513 priority to dispatch-slot restricted
19514 instructions.
19516 @item -msched-costly-dep=@var{dependence_type}
19517 @opindex msched-costly-dep
19518 This option controls which dependences are considered costly
19519 by the target during instruction scheduling.  The argument
19520 @var{dependence_type} takes one of the following values:
19522 @table @asis
19523 @item @samp{no}
19524 No dependence is costly.
19526 @item @samp{all}
19527 All dependences are costly.
19529 @item @samp{true_store_to_load}
19530 A true dependence from store to load is costly.
19532 @item @samp{store_to_load}
19533 Any dependence from store to load is costly.
19535 @item @var{number}
19536 Any dependence for which the latency is greater than or equal to 
19537 @var{number} is costly.
19538 @end table
19540 @item -minsert-sched-nops=@var{scheme}
19541 @opindex minsert-sched-nops
19542 This option controls which NOP insertion scheme is used during
19543 the second scheduling pass.  The argument @var{scheme} takes one of the
19544 following values:
19546 @table @asis
19547 @item @samp{no}
19548 Don't insert NOPs.
19550 @item @samp{pad}
19551 Pad with NOPs any dispatch group that has vacant issue slots,
19552 according to the scheduler's grouping.
19554 @item @samp{regroup_exact}
19555 Insert NOPs to force costly dependent insns into
19556 separate groups.  Insert exactly as many NOPs as needed to force an insn
19557 to a new group, according to the estimated processor grouping.
19559 @item @var{number}
19560 Insert NOPs to force costly dependent insns into
19561 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19562 @end table
19564 @item -mcall-sysv
19565 @opindex mcall-sysv
19566 On System V.4 and embedded PowerPC systems compile code using calling
19567 conventions that adhere to the March 1995 draft of the System V
19568 Application Binary Interface, PowerPC processor supplement.  This is the
19569 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19571 @item -mcall-sysv-eabi
19572 @itemx -mcall-eabi
19573 @opindex mcall-sysv-eabi
19574 @opindex mcall-eabi
19575 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19577 @item -mcall-sysv-noeabi
19578 @opindex mcall-sysv-noeabi
19579 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19581 @item -mcall-aixdesc
19582 @opindex m
19583 On System V.4 and embedded PowerPC systems compile code for the AIX
19584 operating system.
19586 @item -mcall-linux
19587 @opindex mcall-linux
19588 On System V.4 and embedded PowerPC systems compile code for the
19589 Linux-based GNU system.
19591 @item -mcall-freebsd
19592 @opindex mcall-freebsd
19593 On System V.4 and embedded PowerPC systems compile code for the
19594 FreeBSD operating system.
19596 @item -mcall-netbsd
19597 @opindex mcall-netbsd
19598 On System V.4 and embedded PowerPC systems compile code for the
19599 NetBSD operating system.
19601 @item -mcall-openbsd
19602 @opindex mcall-netbsd
19603 On System V.4 and embedded PowerPC systems compile code for the
19604 OpenBSD operating system.
19606 @item -maix-struct-return
19607 @opindex maix-struct-return
19608 Return all structures in memory (as specified by the AIX ABI)@.
19610 @item -msvr4-struct-return
19611 @opindex msvr4-struct-return
19612 Return structures smaller than 8 bytes in registers (as specified by the
19613 SVR4 ABI)@.
19615 @item -mabi=@var{abi-type}
19616 @opindex mabi
19617 Extend the current ABI with a particular extension, or remove such extension.
19618 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
19619 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
19620 @samp{elfv1}, @samp{elfv2}@.
19622 @item -mabi=spe
19623 @opindex mabi=spe
19624 Extend the current ABI with SPE ABI extensions.  This does not change
19625 the default ABI, instead it adds the SPE ABI extensions to the current
19626 ABI@.
19628 @item -mabi=no-spe
19629 @opindex mabi=no-spe
19630 Disable Book-E SPE ABI extensions for the current ABI@.
19632 @item -mabi=ibmlongdouble
19633 @opindex mabi=ibmlongdouble
19634 Change the current ABI to use IBM extended-precision long double.
19635 This is a PowerPC 32-bit SYSV ABI option.
19637 @item -mabi=ieeelongdouble
19638 @opindex mabi=ieeelongdouble
19639 Change the current ABI to use IEEE extended-precision long double.
19640 This is a PowerPC 32-bit Linux ABI option.
19642 @item -mabi=elfv1
19643 @opindex mabi=elfv1
19644 Change the current ABI to use the ELFv1 ABI.
19645 This is the default ABI for big-endian PowerPC 64-bit Linux.
19646 Overriding the default ABI requires special system support and is
19647 likely to fail in spectacular ways.
19649 @item -mabi=elfv2
19650 @opindex mabi=elfv2
19651 Change the current ABI to use the ELFv2 ABI.
19652 This is the default ABI for little-endian PowerPC 64-bit Linux.
19653 Overriding the default ABI requires special system support and is
19654 likely to fail in spectacular ways.
19656 @item -mprototype
19657 @itemx -mno-prototype
19658 @opindex mprototype
19659 @opindex mno-prototype
19660 On System V.4 and embedded PowerPC systems assume that all calls to
19661 variable argument functions are properly prototyped.  Otherwise, the
19662 compiler must insert an instruction before every non-prototyped call to
19663 set or clear bit 6 of the condition code register (@code{CR}) to
19664 indicate whether floating-point values are passed in the floating-point
19665 registers in case the function takes variable arguments.  With
19666 @option{-mprototype}, only calls to prototyped variable argument functions
19667 set or clear the bit.
19669 @item -msim
19670 @opindex msim
19671 On embedded PowerPC systems, assume that the startup module is called
19672 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19673 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19674 configurations.
19676 @item -mmvme
19677 @opindex mmvme
19678 On embedded PowerPC systems, assume that the startup module is called
19679 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19680 @file{libc.a}.
19682 @item -mads
19683 @opindex mads
19684 On embedded PowerPC systems, assume that the startup module is called
19685 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19686 @file{libc.a}.
19688 @item -myellowknife
19689 @opindex myellowknife
19690 On embedded PowerPC systems, assume that the startup module is called
19691 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19692 @file{libc.a}.
19694 @item -mvxworks
19695 @opindex mvxworks
19696 On System V.4 and embedded PowerPC systems, specify that you are
19697 compiling for a VxWorks system.
19699 @item -memb
19700 @opindex memb
19701 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
19702 header to indicate that @samp{eabi} extended relocations are used.
19704 @item -meabi
19705 @itemx -mno-eabi
19706 @opindex meabi
19707 @opindex mno-eabi
19708 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19709 Embedded Applications Binary Interface (EABI), which is a set of
19710 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19711 means that the stack is aligned to an 8-byte boundary, a function
19712 @code{__eabi} is called from @code{main} to set up the EABI
19713 environment, and the @option{-msdata} option can use both @code{r2} and
19714 @code{r13} to point to two separate small data areas.  Selecting
19715 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19716 no EABI initialization function is called from @code{main}, and the
19717 @option{-msdata} option only uses @code{r13} to point to a single
19718 small data area.  The @option{-meabi} option is on by default if you
19719 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19721 @item -msdata=eabi
19722 @opindex msdata=eabi
19723 On System V.4 and embedded PowerPC systems, put small initialized
19724 @code{const} global and static data in the @code{.sdata2} section, which
19725 is pointed to by register @code{r2}.  Put small initialized
19726 non-@code{const} global and static data in the @code{.sdata} section,
19727 which is pointed to by register @code{r13}.  Put small uninitialized
19728 global and static data in the @code{.sbss} section, which is adjacent to
19729 the @code{.sdata} section.  The @option{-msdata=eabi} option is
19730 incompatible with the @option{-mrelocatable} option.  The
19731 @option{-msdata=eabi} option also sets the @option{-memb} option.
19733 @item -msdata=sysv
19734 @opindex msdata=sysv
19735 On System V.4 and embedded PowerPC systems, put small global and static
19736 data in the @code{.sdata} section, which is pointed to by register
19737 @code{r13}.  Put small uninitialized global and static data in the
19738 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
19739 The @option{-msdata=sysv} option is incompatible with the
19740 @option{-mrelocatable} option.
19742 @item -msdata=default
19743 @itemx -msdata
19744 @opindex msdata=default
19745 @opindex msdata
19746 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19747 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19748 same as @option{-msdata=sysv}.
19750 @item -msdata=data
19751 @opindex msdata=data
19752 On System V.4 and embedded PowerPC systems, put small global
19753 data in the @code{.sdata} section.  Put small uninitialized global
19754 data in the @code{.sbss} section.  Do not use register @code{r13}
19755 to address small data however.  This is the default behavior unless
19756 other @option{-msdata} options are used.
19758 @item -msdata=none
19759 @itemx -mno-sdata
19760 @opindex msdata=none
19761 @opindex mno-sdata
19762 On embedded PowerPC systems, put all initialized global and static data
19763 in the @code{.data} section, and all uninitialized data in the
19764 @code{.bss} section.
19766 @item -mblock-move-inline-limit=@var{num}
19767 @opindex mblock-move-inline-limit
19768 Inline all block moves (such as calls to @code{memcpy} or structure
19769 copies) less than or equal to @var{num} bytes.  The minimum value for
19770 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19771 targets.  The default value is target-specific.
19773 @item -G @var{num}
19774 @opindex G
19775 @cindex smaller data references (PowerPC)
19776 @cindex .sdata/.sdata2 references (PowerPC)
19777 On embedded PowerPC systems, put global and static items less than or
19778 equal to @var{num} bytes into the small data or BSS sections instead of
19779 the normal data or BSS section.  By default, @var{num} is 8.  The
19780 @option{-G @var{num}} switch is also passed to the linker.
19781 All modules should be compiled with the same @option{-G @var{num}} value.
19783 @item -mregnames
19784 @itemx -mno-regnames
19785 @opindex mregnames
19786 @opindex mno-regnames
19787 On System V.4 and embedded PowerPC systems do (do not) emit register
19788 names in the assembly language output using symbolic forms.
19790 @item -mlongcall
19791 @itemx -mno-longcall
19792 @opindex mlongcall
19793 @opindex mno-longcall
19794 By default assume that all calls are far away so that a longer and more
19795 expensive calling sequence is required.  This is required for calls
19796 farther than 32 megabytes (33,554,432 bytes) from the current location.
19797 A short call is generated if the compiler knows
19798 the call cannot be that far away.  This setting can be overridden by
19799 the @code{shortcall} function attribute, or by @code{#pragma
19800 longcall(0)}.
19802 Some linkers are capable of detecting out-of-range calls and generating
19803 glue code on the fly.  On these systems, long calls are unnecessary and
19804 generate slower code.  As of this writing, the AIX linker can do this,
19805 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19806 to the GNU linker for 32-bit PowerPC systems as well.
19808 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19809 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19810 addresses represent the callee and the branch island.  The
19811 Darwin/PPC linker prefers the first address and generates a @code{bl
19812 callee} if the PPC @code{bl} instruction reaches the callee directly;
19813 otherwise, the linker generates @code{bl L42} to call the branch
19814 island.  The branch island is appended to the body of the
19815 calling function; it computes the full 32-bit address of the callee
19816 and jumps to it.
19818 On Mach-O (Darwin) systems, this option directs the compiler emit to
19819 the glue for every direct call, and the Darwin linker decides whether
19820 to use or discard it.
19822 In the future, GCC may ignore all longcall specifications
19823 when the linker is known to generate glue.
19825 @item -mtls-markers
19826 @itemx -mno-tls-markers
19827 @opindex mtls-markers
19828 @opindex mno-tls-markers
19829 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19830 specifying the function argument.  The relocation allows the linker to
19831 reliably associate function call with argument setup instructions for
19832 TLS optimization, which in turn allows GCC to better schedule the
19833 sequence.
19835 @item -pthread
19836 @opindex pthread
19837 Adds support for multithreading with the @dfn{pthreads} library.
19838 This option sets flags for both the preprocessor and linker.
19840 @item -mrecip
19841 @itemx -mno-recip
19842 @opindex mrecip
19843 This option enables use of the reciprocal estimate and
19844 reciprocal square root estimate instructions with additional
19845 Newton-Raphson steps to increase precision instead of doing a divide or
19846 square root and divide for floating-point arguments.  You should use
19847 the @option{-ffast-math} option when using @option{-mrecip} (or at
19848 least @option{-funsafe-math-optimizations},
19849 @option{-finite-math-only}, @option{-freciprocal-math} and
19850 @option{-fno-trapping-math}).  Note that while the throughput of the
19851 sequence is generally higher than the throughput of the non-reciprocal
19852 instruction, the precision of the sequence can be decreased by up to 2
19853 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19854 roots.
19856 @item -mrecip=@var{opt}
19857 @opindex mrecip=opt
19858 This option controls which reciprocal estimate instructions
19859 may be used.  @var{opt} is a comma-separated list of options, which may
19860 be preceded by a @code{!} to invert the option:
19862 @table @samp
19864 @item all
19865 Enable all estimate instructions.
19867 @item default 
19868 Enable the default instructions, equivalent to @option{-mrecip}.
19870 @item none 
19871 Disable all estimate instructions, equivalent to @option{-mno-recip}.
19873 @item div 
19874 Enable the reciprocal approximation instructions for both 
19875 single and double precision.
19877 @item divf 
19878 Enable the single-precision reciprocal approximation instructions.
19880 @item divd 
19881 Enable the double-precision reciprocal approximation instructions.
19883 @item rsqrt 
19884 Enable the reciprocal square root approximation instructions for both
19885 single and double precision.
19887 @item rsqrtf 
19888 Enable the single-precision reciprocal square root approximation instructions.
19890 @item rsqrtd 
19891 Enable the double-precision reciprocal square root approximation instructions.
19893 @end table
19895 So, for example, @option{-mrecip=all,!rsqrtd} enables
19896 all of the reciprocal estimate instructions, except for the
19897 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
19898 which handle the double-precision reciprocal square root calculations.
19900 @item -mrecip-precision
19901 @itemx -mno-recip-precision
19902 @opindex mrecip-precision
19903 Assume (do not assume) that the reciprocal estimate instructions
19904 provide higher-precision estimates than is mandated by the PowerPC
19905 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
19906 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
19907 The double-precision square root estimate instructions are not generated by
19908 default on low-precision machines, since they do not provide an
19909 estimate that converges after three steps.
19911 @item -mveclibabi=@var{type}
19912 @opindex mveclibabi
19913 Specifies the ABI type to use for vectorizing intrinsics using an
19914 external library.  The only type supported at present is @samp{mass},
19915 which specifies to use IBM's Mathematical Acceleration Subsystem
19916 (MASS) libraries for vectorizing intrinsics using external libraries.
19917 GCC currently emits calls to @code{acosd2}, @code{acosf4},
19918 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
19919 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
19920 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
19921 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
19922 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
19923 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
19924 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
19925 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
19926 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
19927 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
19928 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
19929 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
19930 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
19931 for power7.  Both @option{-ftree-vectorize} and
19932 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
19933 libraries must be specified at link time.
19935 @item -mfriz
19936 @itemx -mno-friz
19937 @opindex mfriz
19938 Generate (do not generate) the @code{friz} instruction when the
19939 @option{-funsafe-math-optimizations} option is used to optimize
19940 rounding of floating-point values to 64-bit integer and back to floating
19941 point.  The @code{friz} instruction does not return the same value if
19942 the floating-point number is too large to fit in an integer.
19944 @item -mpointers-to-nested-functions
19945 @itemx -mno-pointers-to-nested-functions
19946 @opindex mpointers-to-nested-functions
19947 Generate (do not generate) code to load up the static chain register
19948 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
19949 systems where a function pointer points to a 3-word descriptor giving
19950 the function address, TOC value to be loaded in register @code{r2}, and
19951 static chain value to be loaded in register @code{r11}.  The
19952 @option{-mpointers-to-nested-functions} is on by default.  You cannot
19953 call through pointers to nested functions or pointers
19954 to functions compiled in other languages that use the static chain if
19955 you use @option{-mno-pointers-to-nested-functions}.
19957 @item -msave-toc-indirect
19958 @itemx -mno-save-toc-indirect
19959 @opindex msave-toc-indirect
19960 Generate (do not generate) code to save the TOC value in the reserved
19961 stack location in the function prologue if the function calls through
19962 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
19963 saved in the prologue, it is saved just before the call through the
19964 pointer.  The @option{-mno-save-toc-indirect} option is the default.
19966 @item -mcompat-align-parm
19967 @itemx -mno-compat-align-parm
19968 @opindex mcompat-align-parm
19969 Generate (do not generate) code to pass structure parameters with a
19970 maximum alignment of 64 bits, for compatibility with older versions
19971 of GCC.
19973 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
19974 structure parameter on a 128-bit boundary when that structure contained
19975 a member requiring 128-bit alignment.  This is corrected in more
19976 recent versions of GCC.  This option may be used to generate code
19977 that is compatible with functions compiled with older versions of
19978 GCC.
19980 The @option{-mno-compat-align-parm} option is the default.
19981 @end table
19983 @node RX Options
19984 @subsection RX Options
19985 @cindex RX Options
19987 These command-line options are defined for RX targets:
19989 @table @gcctabopt
19990 @item -m64bit-doubles
19991 @itemx -m32bit-doubles
19992 @opindex m64bit-doubles
19993 @opindex m32bit-doubles
19994 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19995 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19996 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
19997 works on 32-bit values, which is why the default is
19998 @option{-m32bit-doubles}.
20000 @item -fpu
20001 @itemx -nofpu
20002 @opindex fpu
20003 @opindex nofpu
20004 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20005 floating-point hardware.  The default is enabled for the RX600
20006 series and disabled for the RX200 series.
20008 Floating-point instructions are only generated for 32-bit floating-point 
20009 values, however, so the FPU hardware is not used for doubles if the
20010 @option{-m64bit-doubles} option is used.
20012 @emph{Note} If the @option{-fpu} option is enabled then
20013 @option{-funsafe-math-optimizations} is also enabled automatically.
20014 This is because the RX FPU instructions are themselves unsafe.
20016 @item -mcpu=@var{name}
20017 @opindex mcpu
20018 Selects the type of RX CPU to be targeted.  Currently three types are
20019 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
20020 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
20022 The only difference between @samp{RX600} and @samp{RX610} is that the
20023 @samp{RX610} does not support the @code{MVTIPL} instruction.
20025 The @samp{RX200} series does not have a hardware floating-point unit
20026 and so @option{-nofpu} is enabled by default when this type is
20027 selected.
20029 @item -mbig-endian-data
20030 @itemx -mlittle-endian-data
20031 @opindex mbig-endian-data
20032 @opindex mlittle-endian-data
20033 Store data (but not code) in the big-endian format.  The default is
20034 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20035 format.
20037 @item -msmall-data-limit=@var{N}
20038 @opindex msmall-data-limit
20039 Specifies the maximum size in bytes of global and static variables
20040 which can be placed into the small data area.  Using the small data
20041 area can lead to smaller and faster code, but the size of area is
20042 limited and it is up to the programmer to ensure that the area does
20043 not overflow.  Also when the small data area is used one of the RX's
20044 registers (usually @code{r13}) is reserved for use pointing to this
20045 area, so it is no longer available for use by the compiler.  This
20046 could result in slower and/or larger code if variables are pushed onto
20047 the stack instead of being held in this register.
20049 Note, common variables (variables that have not been initialized) and
20050 constants are not placed into the small data area as they are assigned
20051 to other sections in the output executable.
20053 The default value is zero, which disables this feature.  Note, this
20054 feature is not enabled by default with higher optimization levels
20055 (@option{-O2} etc) because of the potentially detrimental effects of
20056 reserving a register.  It is up to the programmer to experiment and
20057 discover whether this feature is of benefit to their program.  See the
20058 description of the @option{-mpid} option for a description of how the
20059 actual register to hold the small data area pointer is chosen.
20061 @item -msim
20062 @itemx -mno-sim
20063 @opindex msim
20064 @opindex mno-sim
20065 Use the simulator runtime.  The default is to use the libgloss
20066 board-specific runtime.
20068 @item -mas100-syntax
20069 @itemx -mno-as100-syntax
20070 @opindex mas100-syntax
20071 @opindex mno-as100-syntax
20072 When generating assembler output use a syntax that is compatible with
20073 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20074 assembler, but it has some restrictions so it is not generated by default.
20076 @item -mmax-constant-size=@var{N}
20077 @opindex mmax-constant-size
20078 Specifies the maximum size, in bytes, of a constant that can be used as
20079 an operand in a RX instruction.  Although the RX instruction set does
20080 allow constants of up to 4 bytes in length to be used in instructions,
20081 a longer value equates to a longer instruction.  Thus in some
20082 circumstances it can be beneficial to restrict the size of constants
20083 that are used in instructions.  Constants that are too big are instead
20084 placed into a constant pool and referenced via register indirection.
20086 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20087 or 4 means that constants of any size are allowed.
20089 @item -mrelax
20090 @opindex mrelax
20091 Enable linker relaxation.  Linker relaxation is a process whereby the
20092 linker attempts to reduce the size of a program by finding shorter
20093 versions of various instructions.  Disabled by default.
20095 @item -mint-register=@var{N}
20096 @opindex mint-register
20097 Specify the number of registers to reserve for fast interrupt handler
20098 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20099 means that register @code{r13} is reserved for the exclusive use
20100 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20101 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20102 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20103 A value of 0, the default, does not reserve any registers.
20105 @item -msave-acc-in-interrupts
20106 @opindex msave-acc-in-interrupts
20107 Specifies that interrupt handler functions should preserve the
20108 accumulator register.  This is only necessary if normal code might use
20109 the accumulator register, for example because it performs 64-bit
20110 multiplications.  The default is to ignore the accumulator as this
20111 makes the interrupt handlers faster.
20113 @item -mpid
20114 @itemx -mno-pid
20115 @opindex mpid
20116 @opindex mno-pid
20117 Enables the generation of position independent data.  When enabled any
20118 access to constant data is done via an offset from a base address
20119 held in a register.  This allows the location of constant data to be
20120 determined at run time without requiring the executable to be
20121 relocated, which is a benefit to embedded applications with tight
20122 memory constraints.  Data that can be modified is not affected by this
20123 option.
20125 Note, using this feature reserves a register, usually @code{r13}, for
20126 the constant data base address.  This can result in slower and/or
20127 larger code, especially in complicated functions.
20129 The actual register chosen to hold the constant data base address
20130 depends upon whether the @option{-msmall-data-limit} and/or the
20131 @option{-mint-register} command-line options are enabled.  Starting
20132 with register @code{r13} and proceeding downwards, registers are
20133 allocated first to satisfy the requirements of @option{-mint-register},
20134 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20135 is possible for the small data area register to be @code{r8} if both
20136 @option{-mint-register=4} and @option{-mpid} are specified on the
20137 command line.
20139 By default this feature is not enabled.  The default can be restored
20140 via the @option{-mno-pid} command-line option.
20142 @item -mno-warn-multiple-fast-interrupts
20143 @itemx -mwarn-multiple-fast-interrupts
20144 @opindex mno-warn-multiple-fast-interrupts
20145 @opindex mwarn-multiple-fast-interrupts
20146 Prevents GCC from issuing a warning message if it finds more than one
20147 fast interrupt handler when it is compiling a file.  The default is to
20148 issue a warning for each extra fast interrupt handler found, as the RX
20149 only supports one such interrupt.
20151 @item -mallow-string-insns
20152 @itemx -mno-allow-string-insns
20153 @opindex mallow-string-insns
20154 @opindex mno-allow-string-insns
20155 Enables or disables the use of the string manipulation instructions
20156 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
20157 @code{SWHILE} and also the @code{RMPA} instruction.  These
20158 instructions may prefetch data, which is not safe to do if accessing
20159 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
20160 for more information).
20162 The default is to allow these instructions, but it is not possible for
20163 GCC to reliably detect all circumstances where a string instruction
20164 might be used to access an I/O register, so their use cannot be
20165 disabled automatically.  Instead it is reliant upon the programmer to
20166 use the @option{-mno-allow-string-insns} option if their program
20167 accesses I/O space.
20169 When the instructions are enabled GCC defines the C preprocessor
20170 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
20171 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
20172 @end table
20174 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20175 has special significance to the RX port when used with the
20176 @code{interrupt} function attribute.  This attribute indicates a
20177 function intended to process fast interrupts.  GCC ensures
20178 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20179 and/or @code{r13} and only provided that the normal use of the
20180 corresponding registers have been restricted via the
20181 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20182 options.
20184 @node S/390 and zSeries Options
20185 @subsection S/390 and zSeries Options
20186 @cindex S/390 and zSeries Options
20188 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20190 @table @gcctabopt
20191 @item -mhard-float
20192 @itemx -msoft-float
20193 @opindex mhard-float
20194 @opindex msoft-float
20195 Use (do not use) the hardware floating-point instructions and registers
20196 for floating-point operations.  When @option{-msoft-float} is specified,
20197 functions in @file{libgcc.a} are used to perform floating-point
20198 operations.  When @option{-mhard-float} is specified, the compiler
20199 generates IEEE floating-point instructions.  This is the default.
20201 @item -mhard-dfp
20202 @itemx -mno-hard-dfp
20203 @opindex mhard-dfp
20204 @opindex mno-hard-dfp
20205 Use (do not use) the hardware decimal-floating-point instructions for
20206 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20207 specified, functions in @file{libgcc.a} are used to perform
20208 decimal-floating-point operations.  When @option{-mhard-dfp} is
20209 specified, the compiler generates decimal-floating-point hardware
20210 instructions.  This is the default for @option{-march=z9-ec} or higher.
20212 @item -mlong-double-64
20213 @itemx -mlong-double-128
20214 @opindex mlong-double-64
20215 @opindex mlong-double-128
20216 These switches control the size of @code{long double} type. A size
20217 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20218 type. This is the default.
20220 @item -mbackchain
20221 @itemx -mno-backchain
20222 @opindex mbackchain
20223 @opindex mno-backchain
20224 Store (do not store) the address of the caller's frame as backchain pointer
20225 into the callee's stack frame.
20226 A backchain may be needed to allow debugging using tools that do not understand
20227 DWARF 2 call frame information.
20228 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20229 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20230 the backchain is placed into the topmost word of the 96/160 byte register
20231 save area.
20233 In general, code compiled with @option{-mbackchain} is call-compatible with
20234 code compiled with @option{-mmo-backchain}; however, use of the backchain
20235 for debugging purposes usually requires that the whole binary is built with
20236 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20237 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20238 to build a linux kernel use @option{-msoft-float}.
20240 The default is to not maintain the backchain.
20242 @item -mpacked-stack
20243 @itemx -mno-packed-stack
20244 @opindex mpacked-stack
20245 @opindex mno-packed-stack
20246 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20247 specified, the compiler uses the all fields of the 96/160 byte register save
20248 area only for their default purpose; unused fields still take up stack space.
20249 When @option{-mpacked-stack} is specified, register save slots are densely
20250 packed at the top of the register save area; unused space is reused for other
20251 purposes, allowing for more efficient use of the available stack space.
20252 However, when @option{-mbackchain} is also in effect, the topmost word of
20253 the save area is always used to store the backchain, and the return address
20254 register is always saved two words below the backchain.
20256 As long as the stack frame backchain is not used, code generated with
20257 @option{-mpacked-stack} is call-compatible with code generated with
20258 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20259 S/390 or zSeries generated code that uses the stack frame backchain at run
20260 time, not just for debugging purposes.  Such code is not call-compatible
20261 with code compiled with @option{-mpacked-stack}.  Also, note that the
20262 combination of @option{-mbackchain},
20263 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20264 to build a linux kernel use @option{-msoft-float}.
20266 The default is to not use the packed stack layout.
20268 @item -msmall-exec
20269 @itemx -mno-small-exec
20270 @opindex msmall-exec
20271 @opindex mno-small-exec
20272 Generate (or do not generate) code using the @code{bras} instruction
20273 to do subroutine calls.
20274 This only works reliably if the total executable size does not
20275 exceed 64k.  The default is to use the @code{basr} instruction instead,
20276 which does not have this limitation.
20278 @item -m64
20279 @itemx -m31
20280 @opindex m64
20281 @opindex m31
20282 When @option{-m31} is specified, generate code compliant to the
20283 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20284 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20285 particular to generate 64-bit instructions.  For the @samp{s390}
20286 targets, the default is @option{-m31}, while the @samp{s390x}
20287 targets default to @option{-m64}.
20289 @item -mzarch
20290 @itemx -mesa
20291 @opindex mzarch
20292 @opindex mesa
20293 When @option{-mzarch} is specified, generate code using the
20294 instructions available on z/Architecture.
20295 When @option{-mesa} is specified, generate code using the
20296 instructions available on ESA/390.  Note that @option{-mesa} is
20297 not possible with @option{-m64}.
20298 When generating code compliant to the GNU/Linux for S/390 ABI,
20299 the default is @option{-mesa}.  When generating code compliant
20300 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20302 @item -mmvcle
20303 @itemx -mno-mvcle
20304 @opindex mmvcle
20305 @opindex mno-mvcle
20306 Generate (or do not generate) code using the @code{mvcle} instruction
20307 to perform block moves.  When @option{-mno-mvcle} is specified,
20308 use a @code{mvc} loop instead.  This is the default unless optimizing for
20309 size.
20311 @item -mdebug
20312 @itemx -mno-debug
20313 @opindex mdebug
20314 @opindex mno-debug
20315 Print (or do not print) additional debug information when compiling.
20316 The default is to not print debug information.
20318 @item -march=@var{cpu-type}
20319 @opindex march
20320 Generate code that runs on @var{cpu-type}, which is the name of a system
20321 representing a certain processor type.  Possible values for
20322 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20323 @samp{z9-109}, @samp{z9-ec}, @samp{z10},  @samp{z196}, and @samp{zEC12}.
20324 When generating code using the instructions available on z/Architecture,
20325 the default is @option{-march=z900}.  Otherwise, the default is
20326 @option{-march=g5}.
20328 @item -mtune=@var{cpu-type}
20329 @opindex mtune
20330 Tune to @var{cpu-type} everything applicable about the generated code,
20331 except for the ABI and the set of available instructions.
20332 The list of @var{cpu-type} values is the same as for @option{-march}.
20333 The default is the value used for @option{-march}.
20335 @item -mtpf-trace
20336 @itemx -mno-tpf-trace
20337 @opindex mtpf-trace
20338 @opindex mno-tpf-trace
20339 Generate code that adds (does not add) in TPF OS specific branches to trace
20340 routines in the operating system.  This option is off by default, even
20341 when compiling for the TPF OS@.
20343 @item -mfused-madd
20344 @itemx -mno-fused-madd
20345 @opindex mfused-madd
20346 @opindex mno-fused-madd
20347 Generate code that uses (does not use) the floating-point multiply and
20348 accumulate instructions.  These instructions are generated by default if
20349 hardware floating point is used.
20351 @item -mwarn-framesize=@var{framesize}
20352 @opindex mwarn-framesize
20353 Emit a warning if the current function exceeds the given frame size.  Because
20354 this is a compile-time check it doesn't need to be a real problem when the program
20355 runs.  It is intended to identify functions that most probably cause
20356 a stack overflow.  It is useful to be used in an environment with limited stack
20357 size e.g.@: the linux kernel.
20359 @item -mwarn-dynamicstack
20360 @opindex mwarn-dynamicstack
20361 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20362 arrays.  This is generally a bad idea with a limited stack size.
20364 @item -mstack-guard=@var{stack-guard}
20365 @itemx -mstack-size=@var{stack-size}
20366 @opindex mstack-guard
20367 @opindex mstack-size
20368 If these options are provided the S/390 back end emits additional instructions in
20369 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20370 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20371 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20372 the frame size of the compiled function is chosen.
20373 These options are intended to be used to help debugging stack overflow problems.
20374 The additionally emitted code causes only little overhead and hence can also be
20375 used in production-like systems without greater performance degradation.  The given
20376 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20377 @var{stack-guard} without exceeding 64k.
20378 In order to be efficient the extra code makes the assumption that the stack starts
20379 at an address aligned to the value given by @var{stack-size}.
20380 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20382 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20383 @opindex mhotpatch
20384 If the hotpatch option is enabled, a ``hot-patching'' function
20385 prologue is generated for all functions in the compilation unit.
20386 The funtion label is prepended with the given number of two-byte
20387 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20388 the label, 2 * @var{post-halfwords} bytes are appended, using the
20389 largest NOP like instructions the architecture allows (maximum
20390 1000000).
20392 If both arguments are zero, hotpatching is disabled.
20394 This option can be overridden for individual functions with the
20395 @code{hotpatch} attribute.
20396 @end table
20398 @node Score Options
20399 @subsection Score Options
20400 @cindex Score Options
20402 These options are defined for Score implementations:
20404 @table @gcctabopt
20405 @item -meb
20406 @opindex meb
20407 Compile code for big-endian mode.  This is the default.
20409 @item -mel
20410 @opindex mel
20411 Compile code for little-endian mode.
20413 @item -mnhwloop
20414 @opindex mnhwloop
20415 Disable generation of @code{bcnz} instructions.
20417 @item -muls
20418 @opindex muls
20419 Enable generation of unaligned load and store instructions.
20421 @item -mmac
20422 @opindex mmac
20423 Enable the use of multiply-accumulate instructions. Disabled by default.
20425 @item -mscore5
20426 @opindex mscore5
20427 Specify the SCORE5 as the target architecture.
20429 @item -mscore5u
20430 @opindex mscore5u
20431 Specify the SCORE5U of the target architecture.
20433 @item -mscore7
20434 @opindex mscore7
20435 Specify the SCORE7 as the target architecture. This is the default.
20437 @item -mscore7d
20438 @opindex mscore7d
20439 Specify the SCORE7D as the target architecture.
20440 @end table
20442 @node SH Options
20443 @subsection SH Options
20445 These @samp{-m} options are defined for the SH implementations:
20447 @table @gcctabopt
20448 @item -m1
20449 @opindex m1
20450 Generate code for the SH1.
20452 @item -m2
20453 @opindex m2
20454 Generate code for the SH2.
20456 @item -m2e
20457 Generate code for the SH2e.
20459 @item -m2a-nofpu
20460 @opindex m2a-nofpu
20461 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20462 that the floating-point unit is not used.
20464 @item -m2a-single-only
20465 @opindex m2a-single-only
20466 Generate code for the SH2a-FPU, in such a way that no double-precision
20467 floating-point operations are used.
20469 @item -m2a-single
20470 @opindex m2a-single
20471 Generate code for the SH2a-FPU assuming the floating-point unit is in
20472 single-precision mode by default.
20474 @item -m2a
20475 @opindex m2a
20476 Generate code for the SH2a-FPU assuming the floating-point unit is in
20477 double-precision mode by default.
20479 @item -m3
20480 @opindex m3
20481 Generate code for the SH3.
20483 @item -m3e
20484 @opindex m3e
20485 Generate code for the SH3e.
20487 @item -m4-nofpu
20488 @opindex m4-nofpu
20489 Generate code for the SH4 without a floating-point unit.
20491 @item -m4-single-only
20492 @opindex m4-single-only
20493 Generate code for the SH4 with a floating-point unit that only
20494 supports single-precision arithmetic.
20496 @item -m4-single
20497 @opindex m4-single
20498 Generate code for the SH4 assuming the floating-point unit is in
20499 single-precision mode by default.
20501 @item -m4
20502 @opindex m4
20503 Generate code for the SH4.
20505 @item -m4-100
20506 @opindex m4-100
20507 Generate code for SH4-100.
20509 @item -m4-100-nofpu
20510 @opindex m4-100-nofpu
20511 Generate code for SH4-100 in such a way that the
20512 floating-point unit is not used.
20514 @item -m4-100-single
20515 @opindex m4-100-single
20516 Generate code for SH4-100 assuming the floating-point unit is in
20517 single-precision mode by default.
20519 @item -m4-100-single-only
20520 @opindex m4-100-single-only
20521 Generate code for SH4-100 in such a way that no double-precision
20522 floating-point operations are used.
20524 @item -m4-200
20525 @opindex m4-200
20526 Generate code for SH4-200.
20528 @item -m4-200-nofpu
20529 @opindex m4-200-nofpu
20530 Generate code for SH4-200 without in such a way that the
20531 floating-point unit is not used.
20533 @item -m4-200-single
20534 @opindex m4-200-single
20535 Generate code for SH4-200 assuming the floating-point unit is in
20536 single-precision mode by default.
20538 @item -m4-200-single-only
20539 @opindex m4-200-single-only
20540 Generate code for SH4-200 in such a way that no double-precision
20541 floating-point operations are used.
20543 @item -m4-300
20544 @opindex m4-300
20545 Generate code for SH4-300.
20547 @item -m4-300-nofpu
20548 @opindex m4-300-nofpu
20549 Generate code for SH4-300 without in such a way that the
20550 floating-point unit is not used.
20552 @item -m4-300-single
20553 @opindex m4-300-single
20554 Generate code for SH4-300 in such a way that no double-precision
20555 floating-point operations are used.
20557 @item -m4-300-single-only
20558 @opindex m4-300-single-only
20559 Generate code for SH4-300 in such a way that no double-precision
20560 floating-point operations are used.
20562 @item -m4-340
20563 @opindex m4-340
20564 Generate code for SH4-340 (no MMU, no FPU).
20566 @item -m4-500
20567 @opindex m4-500
20568 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20569 assembler.
20571 @item -m4a-nofpu
20572 @opindex m4a-nofpu
20573 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20574 floating-point unit is not used.
20576 @item -m4a-single-only
20577 @opindex m4a-single-only
20578 Generate code for the SH4a, in such a way that no double-precision
20579 floating-point operations are used.
20581 @item -m4a-single
20582 @opindex m4a-single
20583 Generate code for the SH4a assuming the floating-point unit is in
20584 single-precision mode by default.
20586 @item -m4a
20587 @opindex m4a
20588 Generate code for the SH4a.
20590 @item -m4al
20591 @opindex m4al
20592 Same as @option{-m4a-nofpu}, except that it implicitly passes
20593 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20594 instructions at the moment.
20596 @item -m5-32media
20597 @opindex m5-32media
20598 Generate 32-bit code for SHmedia.
20600 @item -m5-32media-nofpu
20601 @opindex m5-32media-nofpu
20602 Generate 32-bit code for SHmedia in such a way that the
20603 floating-point unit is not used.
20605 @item -m5-64media
20606 @opindex m5-64media
20607 Generate 64-bit code for SHmedia.
20609 @item -m5-64media-nofpu
20610 @opindex m5-64media-nofpu
20611 Generate 64-bit code for SHmedia in such a way that the
20612 floating-point unit is not used.
20614 @item -m5-compact
20615 @opindex m5-compact
20616 Generate code for SHcompact.
20618 @item -m5-compact-nofpu
20619 @opindex m5-compact-nofpu
20620 Generate code for SHcompact in such a way that the
20621 floating-point unit is not used.
20623 @item -mb
20624 @opindex mb
20625 Compile code for the processor in big-endian mode.
20627 @item -ml
20628 @opindex ml
20629 Compile code for the processor in little-endian mode.
20631 @item -mdalign
20632 @opindex mdalign
20633 Align doubles at 64-bit boundaries.  Note that this changes the calling
20634 conventions, and thus some functions from the standard C library do
20635 not work unless you recompile it first with @option{-mdalign}.
20637 @item -mrelax
20638 @opindex mrelax
20639 Shorten some address references at link time, when possible; uses the
20640 linker option @option{-relax}.
20642 @item -mbigtable
20643 @opindex mbigtable
20644 Use 32-bit offsets in @code{switch} tables.  The default is to use
20645 16-bit offsets.
20647 @item -mbitops
20648 @opindex mbitops
20649 Enable the use of bit manipulation instructions on SH2A.
20651 @item -mfmovd
20652 @opindex mfmovd
20653 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20654 alignment constraints.
20656 @item -mrenesas
20657 @opindex mrenesas
20658 Comply with the calling conventions defined by Renesas.
20660 @item -mno-renesas
20661 @opindex mno-renesas
20662 Comply with the calling conventions defined for GCC before the Renesas
20663 conventions were available.  This option is the default for all
20664 targets of the SH toolchain.
20666 @item -mnomacsave
20667 @opindex mnomacsave
20668 Mark the @code{MAC} register as call-clobbered, even if
20669 @option{-mrenesas} is given.
20671 @item -mieee
20672 @itemx -mno-ieee
20673 @opindex mieee
20674 @opindex mno-ieee
20675 Control the IEEE compliance of floating-point comparisons, which affects the
20676 handling of cases where the result of a comparison is unordered.  By default
20677 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20678 enabled @option{-mno-ieee} is implicitly set, which results in faster
20679 floating-point greater-equal and less-equal comparisons.  The implcit settings
20680 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20682 @item -minline-ic_invalidate
20683 @opindex minline-ic_invalidate
20684 Inline code to invalidate instruction cache entries after setting up
20685 nested function trampolines.
20686 This option has no effect if @option{-musermode} is in effect and the selected
20687 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20688 instruction.
20689 If the selected code generation option does not allow the use of the @code{icbi}
20690 instruction, and @option{-musermode} is not in effect, the inlined code
20691 manipulates the instruction cache address array directly with an associative
20692 write.  This not only requires privileged mode at run time, but it also
20693 fails if the cache line had been mapped via the TLB and has become unmapped.
20695 @item -misize
20696 @opindex misize
20697 Dump instruction size and location in the assembly code.
20699 @item -mpadstruct
20700 @opindex mpadstruct
20701 This option is deprecated.  It pads structures to multiple of 4 bytes,
20702 which is incompatible with the SH ABI@.
20704 @item -matomic-model=@var{model}
20705 @opindex matomic-model=@var{model}
20706 Sets the model of atomic operations and additional parameters as a comma
20707 separated list.  For details on the atomic built-in functions see
20708 @ref{__atomic Builtins}.  The following models and parameters are supported:
20710 @table @samp
20712 @item none
20713 Disable compiler generated atomic sequences and emit library calls for atomic
20714 operations.  This is the default if the target is not @code{sh*-*-linux*}.
20716 @item soft-gusa
20717 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20718 built-in functions.  The generated atomic sequences require additional support
20719 from the interrupt/exception handling code of the system and are only suitable
20720 for SH3* and SH4* single-core systems.  This option is enabled by default when
20721 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20722 this option also partially utilizes the hardware atomic instructions
20723 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20724 @samp{strict} is specified.  
20726 @item soft-tcb
20727 Generate software atomic sequences that use a variable in the thread control
20728 block.  This is a variation of the gUSA sequences which can also be used on
20729 SH1* and SH2* targets.  The generated atomic sequences require additional
20730 support from the interrupt/exception handling code of the system and are only
20731 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20732 parameter has to be specified as well.
20734 @item soft-imask
20735 Generate software atomic sequences that temporarily disable interrupts by
20736 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20737 in privileged mode and is only suitable for single-core systems.  Additional
20738 support from the interrupt/exception handling code of the system is not
20739 required.  This model is enabled by default when the target is
20740 @code{sh*-*-linux*} and SH1* or SH2*.
20742 @item hard-llcs
20743 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20744 instructions only.  This is only available on SH4A and is suitable for
20745 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20746 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20747 Code compiled with this option is also compatible with other software
20748 atomic model interrupt/exception handling systems if executed on an SH4A
20749 system.  Additional support from the interrupt/exception handling code of the
20750 system is not required for this model.
20752 @item gbr-offset=
20753 This parameter specifies the offset in bytes of the variable in the thread
20754 control block structure that should be used by the generated atomic sequences
20755 when the @samp{soft-tcb} model has been selected.  For other models this
20756 parameter is ignored.  The specified value must be an integer multiple of four
20757 and in the range 0-1020.
20759 @item strict
20760 This parameter prevents mixed usage of multiple atomic models, even if they
20761 are compatible, and makes the compiler generate atomic sequences of the
20762 specified model only.
20764 @end table
20766 @item -mtas
20767 @opindex mtas
20768 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20769 Notice that depending on the particular hardware and software configuration
20770 this can degrade overall performance due to the operand cache line flushes
20771 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20772 processors the @code{tas.b} instruction must be used with caution since it
20773 can result in data corruption for certain cache configurations.
20775 @item -mprefergot
20776 @opindex mprefergot
20777 When generating position-independent code, emit function calls using
20778 the Global Offset Table instead of the Procedure Linkage Table.
20780 @item -musermode
20781 @itemx -mno-usermode
20782 @opindex musermode
20783 @opindex mno-usermode
20784 Don't allow (allow) the compiler generating privileged mode code.  Specifying
20785 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
20786 inlined code would not work in user mode.  @option{-musermode} is the default
20787 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
20788 @option{-musermode} has no effect, since there is no user mode.
20790 @item -multcost=@var{number}
20791 @opindex multcost=@var{number}
20792 Set the cost to assume for a multiply insn.
20794 @item -mdiv=@var{strategy}
20795 @opindex mdiv=@var{strategy}
20796 Set the division strategy to be used for integer division operations.
20797 For SHmedia @var{strategy} can be one of: 
20799 @table @samp
20801 @item fp 
20802 Performs the operation in floating point.  This has a very high latency,
20803 but needs only a few instructions, so it might be a good choice if
20804 your code has enough easily-exploitable ILP to allow the compiler to
20805 schedule the floating-point instructions together with other instructions.
20806 Division by zero causes a floating-point exception.
20808 @item inv
20809 Uses integer operations to calculate the inverse of the divisor,
20810 and then multiplies the dividend with the inverse.  This strategy allows
20811 CSE and hoisting of the inverse calculation.  Division by zero calculates
20812 an unspecified result, but does not trap.
20814 @item inv:minlat
20815 A variant of @samp{inv} where, if no CSE or hoisting opportunities
20816 have been found, or if the entire operation has been hoisted to the same
20817 place, the last stages of the inverse calculation are intertwined with the
20818 final multiply to reduce the overall latency, at the expense of using a few
20819 more instructions, and thus offering fewer scheduling opportunities with
20820 other code.
20822 @item call
20823 Calls a library function that usually implements the @samp{inv:minlat}
20824 strategy.
20825 This gives high code density for @code{m5-*media-nofpu} compilations.
20827 @item call2
20828 Uses a different entry point of the same library function, where it
20829 assumes that a pointer to a lookup table has already been set up, which
20830 exposes the pointer load to CSE and code hoisting optimizations.
20832 @item inv:call
20833 @itemx inv:call2
20834 @itemx inv:fp
20835 Use the @samp{inv} algorithm for initial
20836 code generation, but if the code stays unoptimized, revert to the @samp{call},
20837 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
20838 potentially-trapping side effect of division by zero is carried by a
20839 separate instruction, so it is possible that all the integer instructions
20840 are hoisted out, but the marker for the side effect stays where it is.
20841 A recombination to floating-point operations or a call is not possible
20842 in that case.
20844 @item inv20u
20845 @itemx inv20l
20846 Variants of the @samp{inv:minlat} strategy.  In the case
20847 that the inverse calculation is not separated from the multiply, they speed
20848 up division where the dividend fits into 20 bits (plus sign where applicable)
20849 by inserting a test to skip a number of operations in this case; this test
20850 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
20851 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
20853 @end table
20855 For targets other than SHmedia @var{strategy} can be one of:
20857 @table @samp
20859 @item call-div1
20860 Calls a library function that uses the single-step division instruction
20861 @code{div1} to perform the operation.  Division by zero calculates an
20862 unspecified result and does not trap.  This is the default except for SH4,
20863 SH2A and SHcompact.
20865 @item call-fp
20866 Calls a library function that performs the operation in double precision
20867 floating point.  Division by zero causes a floating-point exception.  This is
20868 the default for SHcompact with FPU.  Specifying this for targets that do not
20869 have a double precision FPU defaults to @code{call-div1}.
20871 @item call-table
20872 Calls a library function that uses a lookup table for small divisors and
20873 the @code{div1} instruction with case distinction for larger divisors.  Division
20874 by zero calculates an unspecified result and does not trap.  This is the default
20875 for SH4.  Specifying this for targets that do not have dynamic shift
20876 instructions defaults to @code{call-div1}.
20878 @end table
20880 When a division strategy has not been specified the default strategy is
20881 selected based on the current target.  For SH2A the default strategy is to
20882 use the @code{divs} and @code{divu} instructions instead of library function
20883 calls.
20885 @item -maccumulate-outgoing-args
20886 @opindex maccumulate-outgoing-args
20887 Reserve space once for outgoing arguments in the function prologue rather
20888 than around each call.  Generally beneficial for performance and size.  Also
20889 needed for unwinding to avoid changing the stack frame around conditional code.
20891 @item -mdivsi3_libfunc=@var{name}
20892 @opindex mdivsi3_libfunc=@var{name}
20893 Set the name of the library function used for 32-bit signed division to
20894 @var{name}.
20895 This only affects the name used in the @samp{call} and @samp{inv:call}
20896 division strategies, and the compiler still expects the same
20897 sets of input/output/clobbered registers as if this option were not present.
20899 @item -mfixed-range=@var{register-range}
20900 @opindex mfixed-range
20901 Generate code treating the given register range as fixed registers.
20902 A fixed register is one that the register allocator can not use.  This is
20903 useful when compiling kernel code.  A register range is specified as
20904 two registers separated by a dash.  Multiple register ranges can be
20905 specified separated by a comma.
20907 @item -mindexed-addressing
20908 @opindex mindexed-addressing
20909 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
20910 This is only safe if the hardware and/or OS implement 32-bit wrap-around
20911 semantics for the indexed addressing mode.  The architecture allows the
20912 implementation of processors with 64-bit MMU, which the OS could use to
20913 get 32-bit addressing, but since no current hardware implementation supports
20914 this or any other way to make the indexed addressing mode safe to use in
20915 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
20917 @item -mgettrcost=@var{number}
20918 @opindex mgettrcost=@var{number}
20919 Set the cost assumed for the @code{gettr} instruction to @var{number}.
20920 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
20922 @item -mpt-fixed
20923 @opindex mpt-fixed
20924 Assume @code{pt*} instructions won't trap.  This generally generates
20925 better-scheduled code, but is unsafe on current hardware.
20926 The current architecture
20927 definition says that @code{ptabs} and @code{ptrel} trap when the target 
20928 anded with 3 is 3.
20929 This has the unintentional effect of making it unsafe to schedule these
20930 instructions before a branch, or hoist them out of a loop.  For example,
20931 @code{__do_global_ctors}, a part of @file{libgcc}
20932 that runs constructors at program
20933 startup, calls functions in a list which is delimited by @minus{}1.  With the
20934 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
20935 That means that all the constructors run a bit more quickly, but when
20936 the loop comes to the end of the list, the program crashes because @code{ptabs}
20937 loads @minus{}1 into a target register.  
20939 Since this option is unsafe for any
20940 hardware implementing the current architecture specification, the default
20941 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
20942 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
20943 this deters register allocation from using target registers for storing
20944 ordinary integers.
20946 @item -minvalid-symbols
20947 @opindex minvalid-symbols
20948 Assume symbols might be invalid.  Ordinary function symbols generated by
20949 the compiler are always valid to load with
20950 @code{movi}/@code{shori}/@code{ptabs} or
20951 @code{movi}/@code{shori}/@code{ptrel},
20952 but with assembler and/or linker tricks it is possible
20953 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
20954 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
20955 It prevents cross-basic-block CSE, hoisting and most scheduling
20956 of symbol loads.  The default is @option{-mno-invalid-symbols}.
20958 @item -mbranch-cost=@var{num}
20959 @opindex mbranch-cost=@var{num}
20960 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
20961 make the compiler try to generate more branch-free code if possible.  
20962 If not specified the value is selected depending on the processor type that
20963 is being compiled for.
20965 @item -mzdcbranch
20966 @itemx -mno-zdcbranch
20967 @opindex mzdcbranch
20968 @opindex mno-zdcbranch
20969 Assume (do not assume) that zero displacement conditional branch instructions
20970 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
20971 compiler prefers zero displacement branch code sequences.  This is
20972 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
20973 disabled by specifying @option{-mno-zdcbranch}.
20975 @item -mcbranch-force-delay-slot
20976 @opindex mcbranch-force-delay-slot
20977 Force the usage of delay slots for conditional branches, which stuffs the delay
20978 slot with a @code{nop} if a suitable instruction can't be found.  By default
20979 this option is disabled.  It can be enabled to work around hardware bugs as
20980 found in the original SH7055.
20982 @item -mfused-madd
20983 @itemx -mno-fused-madd
20984 @opindex mfused-madd
20985 @opindex mno-fused-madd
20986 Generate code that uses (does not use) the floating-point multiply and
20987 accumulate instructions.  These instructions are generated by default
20988 if hardware floating point is used.  The machine-dependent
20989 @option{-mfused-madd} option is now mapped to the machine-independent
20990 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20991 mapped to @option{-ffp-contract=off}.
20993 @item -mfsca
20994 @itemx -mno-fsca
20995 @opindex mfsca
20996 @opindex mno-fsca
20997 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
20998 and cosine approximations.  The option @option{-mfsca} must be used in
20999 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21000 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21001 approximations even if @option{-funsafe-math-optimizations} is in effect.
21003 @item -mfsrra
21004 @itemx -mno-fsrra
21005 @opindex mfsrra
21006 @opindex mno-fsrra
21007 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21008 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21009 in combination with @option{-funsafe-math-optimizations} and
21010 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21011 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21012 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21013 in effect.
21015 @item -mpretend-cmove
21016 @opindex mpretend-cmove
21017 Prefer zero-displacement conditional branches for conditional move instruction
21018 patterns.  This can result in faster code on the SH4 processor.
21020 @end table
21022 @node Solaris 2 Options
21023 @subsection Solaris 2 Options
21024 @cindex Solaris 2 options
21026 These @samp{-m} options are supported on Solaris 2:
21028 @table @gcctabopt
21029 @item -mclear-hwcap
21030 @opindex mclear-hwcap
21031 @option{-mclear-hwcap} tells the compiler to remove the hardware
21032 capabilities generated by the Solaris assembler.  This is only necessary
21033 when object files use ISA extensions not supported by the current
21034 machine, but check at runtime whether or not to use them.
21036 @item -mimpure-text
21037 @opindex mimpure-text
21038 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21039 the compiler to not pass @option{-z text} to the linker when linking a
21040 shared object.  Using this option, you can link position-dependent
21041 code into a shared object.
21043 @option{-mimpure-text} suppresses the ``relocations remain against
21044 allocatable but non-writable sections'' linker error message.
21045 However, the necessary relocations trigger copy-on-write, and the
21046 shared object is not actually shared across processes.  Instead of
21047 using @option{-mimpure-text}, you should compile all source code with
21048 @option{-fpic} or @option{-fPIC}.
21050 @end table
21052 These switches are supported in addition to the above on Solaris 2:
21054 @table @gcctabopt
21055 @item -pthreads
21056 @opindex pthreads
21057 Add support for multithreading using the POSIX threads library.  This
21058 option sets flags for both the preprocessor and linker.  This option does
21059 not affect the thread safety of object code produced  by the compiler or
21060 that of libraries supplied with it.
21062 @item -pthread
21063 @opindex pthread
21064 This is a synonym for @option{-pthreads}.
21065 @end table
21067 @node SPARC Options
21068 @subsection SPARC Options
21069 @cindex SPARC options
21071 These @samp{-m} options are supported on the SPARC:
21073 @table @gcctabopt
21074 @item -mno-app-regs
21075 @itemx -mapp-regs
21076 @opindex mno-app-regs
21077 @opindex mapp-regs
21078 Specify @option{-mapp-regs} to generate output using the global registers
21079 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21080 global register 1, each global register 2 through 4 is then treated as an
21081 allocable register that is clobbered by function calls.  This is the default.
21083 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21084 specify @option{-mno-app-regs}.  You should compile libraries and system
21085 software with this option.
21087 @item -mflat
21088 @itemx -mno-flat
21089 @opindex mflat
21090 @opindex mno-flat
21091 With @option{-mflat}, the compiler does not generate save/restore instructions
21092 and uses a ``flat'' or single register window model.  This model is compatible
21093 with the regular register window model.  The local registers and the input
21094 registers (0--5) are still treated as ``call-saved'' registers and are
21095 saved on the stack as needed.
21097 With @option{-mno-flat} (the default), the compiler generates save/restore
21098 instructions (except for leaf functions).  This is the normal operating mode.
21100 @item -mfpu
21101 @itemx -mhard-float
21102 @opindex mfpu
21103 @opindex mhard-float
21104 Generate output containing floating-point instructions.  This is the
21105 default.
21107 @item -mno-fpu
21108 @itemx -msoft-float
21109 @opindex mno-fpu
21110 @opindex msoft-float
21111 Generate output containing library calls for floating point.
21112 @strong{Warning:} the requisite libraries are not available for all SPARC
21113 targets.  Normally the facilities of the machine's usual C compiler are
21114 used, but this cannot be done directly in cross-compilation.  You must make
21115 your own arrangements to provide suitable library functions for
21116 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21117 @samp{sparclite-*-*} do provide software floating-point support.
21119 @option{-msoft-float} changes the calling convention in the output file;
21120 therefore, it is only useful if you compile @emph{all} of a program with
21121 this option.  In particular, you need to compile @file{libgcc.a}, the
21122 library that comes with GCC, with @option{-msoft-float} in order for
21123 this to work.
21125 @item -mhard-quad-float
21126 @opindex mhard-quad-float
21127 Generate output containing quad-word (long double) floating-point
21128 instructions.
21130 @item -msoft-quad-float
21131 @opindex msoft-quad-float
21132 Generate output containing library calls for quad-word (long double)
21133 floating-point instructions.  The functions called are those specified
21134 in the SPARC ABI@.  This is the default.
21136 As of this writing, there are no SPARC implementations that have hardware
21137 support for the quad-word floating-point instructions.  They all invoke
21138 a trap handler for one of these instructions, and then the trap handler
21139 emulates the effect of the instruction.  Because of the trap handler overhead,
21140 this is much slower than calling the ABI library routines.  Thus the
21141 @option{-msoft-quad-float} option is the default.
21143 @item -mno-unaligned-doubles
21144 @itemx -munaligned-doubles
21145 @opindex mno-unaligned-doubles
21146 @opindex munaligned-doubles
21147 Assume that doubles have 8-byte alignment.  This is the default.
21149 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21150 alignment only if they are contained in another type, or if they have an
21151 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21152 Specifying this option avoids some rare compatibility problems with code
21153 generated by other compilers.  It is not the default because it results
21154 in a performance loss, especially for floating-point code.
21156 @item -muser-mode
21157 @itemx -mno-user-mode
21158 @opindex muser-mode
21159 @opindex mno-user-mode
21160 Do not generate code that can only run in supervisor mode.  This is relevant
21161 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21162 default is @option{-mno-user-mode}.
21164 @item -mno-faster-structs
21165 @itemx -mfaster-structs
21166 @opindex mno-faster-structs
21167 @opindex mfaster-structs
21168 With @option{-mfaster-structs}, the compiler assumes that structures
21169 should have 8-byte alignment.  This enables the use of pairs of
21170 @code{ldd} and @code{std} instructions for copies in structure
21171 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21172 However, the use of this changed alignment directly violates the SPARC
21173 ABI@.  Thus, it's intended only for use on targets where the developer
21174 acknowledges that their resulting code is not directly in line with
21175 the rules of the ABI@.
21177 @item -mcpu=@var{cpu_type}
21178 @opindex mcpu
21179 Set the instruction set, register set, and instruction scheduling parameters
21180 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21181 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21182 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21183 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21184 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21185 @samp{niagara3} and @samp{niagara4}.
21187 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21188 which selects the best architecture option for the host processor.
21189 @option{-mcpu=native} has no effect if GCC does not recognize
21190 the processor.
21192 Default instruction scheduling parameters are used for values that select
21193 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21194 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21196 Here is a list of each supported architecture and their supported
21197 implementations.
21199 @table @asis
21200 @item v7
21201 cypress, leon3v7
21203 @item v8
21204 supersparc, hypersparc, leon, leon3
21206 @item sparclite
21207 f930, f934, sparclite86x
21209 @item sparclet
21210 tsc701
21212 @item v9
21213 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21214 @end table
21216 By default (unless configured otherwise), GCC generates code for the V7
21217 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21218 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21219 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21220 SPARCStation 1, 2, IPX etc.
21222 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21223 architecture.  The only difference from V7 code is that the compiler emits
21224 the integer multiply and integer divide instructions which exist in SPARC-V8
21225 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21226 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21227 2000 series.
21229 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21230 the SPARC architecture.  This adds the integer multiply, integer divide step
21231 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21232 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21233 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21234 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21235 MB86934 chip, which is the more recent SPARClite with FPU@.
21237 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21238 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21239 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21240 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21241 optimizes it for the TEMIC SPARClet chip.
21243 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21244 architecture.  This adds 64-bit integer and floating-point move instructions,
21245 3 additional floating-point condition code registers and conditional move
21246 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21247 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21248 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21249 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21250 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21251 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21252 additionally optimizes it for Sun UltraSPARC T2 chips. With
21253 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21254 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21255 additionally optimizes it for Sun UltraSPARC T4 chips.
21257 @item -mtune=@var{cpu_type}
21258 @opindex mtune
21259 Set the instruction scheduling parameters for machine type
21260 @var{cpu_type}, but do not set the instruction set or register set that the
21261 option @option{-mcpu=@var{cpu_type}} does.
21263 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21264 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21265 that select a particular CPU implementation.  Those are @samp{cypress},
21266 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21267 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21268 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21269 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21270 toolchains, @samp{native} can also be used.
21272 @item -mv8plus
21273 @itemx -mno-v8plus
21274 @opindex mv8plus
21275 @opindex mno-v8plus
21276 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21277 difference from the V8 ABI is that the global and out registers are
21278 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21279 mode for all SPARC-V9 processors.
21281 @item -mvis
21282 @itemx -mno-vis
21283 @opindex mvis
21284 @opindex mno-vis
21285 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21286 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21288 @item -mvis2
21289 @itemx -mno-vis2
21290 @opindex mvis2
21291 @opindex mno-vis2
21292 With @option{-mvis2}, GCC generates code that takes advantage of
21293 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21294 default is @option{-mvis2} when targeting a cpu that supports such
21295 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21296 also sets @option{-mvis}.
21298 @item -mvis3
21299 @itemx -mno-vis3
21300 @opindex mvis3
21301 @opindex mno-vis3
21302 With @option{-mvis3}, GCC generates code that takes advantage of
21303 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21304 default is @option{-mvis3} when targeting a cpu that supports such
21305 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21306 also sets @option{-mvis2} and @option{-mvis}.
21308 @item -mcbcond
21309 @itemx -mno-cbcond
21310 @opindex mcbcond
21311 @opindex mno-cbcond
21312 With @option{-mcbcond}, GCC generates code that takes advantage of
21313 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21314 The default is @option{-mcbcond} when targeting a cpu that supports such
21315 instructions, such as niagara-4 and later.
21317 @item -mpopc
21318 @itemx -mno-popc
21319 @opindex mpopc
21320 @opindex mno-popc
21321 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21322 population count instruction.  The default is @option{-mpopc}
21323 when targeting a cpu that supports such instructions, such as Niagara-2 and
21324 later.
21326 @item -mfmaf
21327 @itemx -mno-fmaf
21328 @opindex mfmaf
21329 @opindex mno-fmaf
21330 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21331 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21332 when targeting a cpu that supports such instructions, such as Niagara-3 and
21333 later.
21335 @item -mfix-at697f
21336 @opindex mfix-at697f
21337 Enable the documented workaround for the single erratum of the Atmel AT697F
21338 processor (which corresponds to erratum #13 of the AT697E processor).
21340 @item -mfix-ut699
21341 @opindex mfix-ut699
21342 Enable the documented workarounds for the floating-point errata and the data
21343 cache nullify errata of the UT699 processor.
21344 @end table
21346 These @samp{-m} options are supported in addition to the above
21347 on SPARC-V9 processors in 64-bit environments:
21349 @table @gcctabopt
21350 @item -m32
21351 @itemx -m64
21352 @opindex m32
21353 @opindex m64
21354 Generate code for a 32-bit or 64-bit environment.
21355 The 32-bit environment sets int, long and pointer to 32 bits.
21356 The 64-bit environment sets int to 32 bits and long and pointer
21357 to 64 bits.
21359 @item -mcmodel=@var{which}
21360 @opindex mcmodel
21361 Set the code model to one of
21363 @table @samp
21364 @item medlow
21365 The Medium/Low code model: 64-bit addresses, programs
21366 must be linked in the low 32 bits of memory.  Programs can be statically
21367 or dynamically linked.
21369 @item medmid
21370 The Medium/Middle code model: 64-bit addresses, programs
21371 must be linked in the low 44 bits of memory, the text and data segments must
21372 be less than 2GB in size and the data segment must be located within 2GB of
21373 the text segment.
21375 @item medany
21376 The Medium/Anywhere code model: 64-bit addresses, programs
21377 may be linked anywhere in memory, the text and data segments must be less
21378 than 2GB in size and the data segment must be located within 2GB of the
21379 text segment.
21381 @item embmedany
21382 The Medium/Anywhere code model for embedded systems:
21383 64-bit addresses, the text and data segments must be less than 2GB in
21384 size, both starting anywhere in memory (determined at link time).  The
21385 global register %g4 points to the base of the data segment.  Programs
21386 are statically linked and PIC is not supported.
21387 @end table
21389 @item -mmemory-model=@var{mem-model}
21390 @opindex mmemory-model
21391 Set the memory model in force on the processor to one of
21393 @table @samp
21394 @item default
21395 The default memory model for the processor and operating system.
21397 @item rmo
21398 Relaxed Memory Order
21400 @item pso
21401 Partial Store Order
21403 @item tso
21404 Total Store Order
21406 @item sc
21407 Sequential Consistency
21408 @end table
21410 These memory models are formally defined in Appendix D of the Sparc V9
21411 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21413 @item -mstack-bias
21414 @itemx -mno-stack-bias
21415 @opindex mstack-bias
21416 @opindex mno-stack-bias
21417 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21418 frame pointer if present, are offset by @minus{}2047 which must be added back
21419 when making stack frame references.  This is the default in 64-bit mode.
21420 Otherwise, assume no such offset is present.
21421 @end table
21423 @node SPU Options
21424 @subsection SPU Options
21425 @cindex SPU options
21427 These @samp{-m} options are supported on the SPU:
21429 @table @gcctabopt
21430 @item -mwarn-reloc
21431 @itemx -merror-reloc
21432 @opindex mwarn-reloc
21433 @opindex merror-reloc
21435 The loader for SPU does not handle dynamic relocations.  By default, GCC
21436 gives an error when it generates code that requires a dynamic
21437 relocation.  @option{-mno-error-reloc} disables the error,
21438 @option{-mwarn-reloc} generates a warning instead.
21440 @item -msafe-dma
21441 @itemx -munsafe-dma
21442 @opindex msafe-dma
21443 @opindex munsafe-dma
21445 Instructions that initiate or test completion of DMA must not be
21446 reordered with respect to loads and stores of the memory that is being
21447 accessed.
21448 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21449 memory accesses, but that can lead to inefficient code in places where the
21450 memory is known to not change.  Rather than mark the memory as volatile,
21451 you can use @option{-msafe-dma} to tell the compiler to treat
21452 the DMA instructions as potentially affecting all memory.  
21454 @item -mbranch-hints
21455 @opindex mbranch-hints
21457 By default, GCC generates a branch hint instruction to avoid
21458 pipeline stalls for always-taken or probably-taken branches.  A hint
21459 is not generated closer than 8 instructions away from its branch.
21460 There is little reason to disable them, except for debugging purposes,
21461 or to make an object a little bit smaller.
21463 @item -msmall-mem
21464 @itemx -mlarge-mem
21465 @opindex msmall-mem
21466 @opindex mlarge-mem
21468 By default, GCC generates code assuming that addresses are never larger
21469 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21470 a full 32-bit address.
21472 @item -mstdmain
21473 @opindex mstdmain
21475 By default, GCC links against startup code that assumes the SPU-style
21476 main function interface (which has an unconventional parameter list).
21477 With @option{-mstdmain}, GCC links your program against startup
21478 code that assumes a C99-style interface to @code{main}, including a
21479 local copy of @code{argv} strings.
21481 @item -mfixed-range=@var{register-range}
21482 @opindex mfixed-range
21483 Generate code treating the given register range as fixed registers.
21484 A fixed register is one that the register allocator cannot use.  This is
21485 useful when compiling kernel code.  A register range is specified as
21486 two registers separated by a dash.  Multiple register ranges can be
21487 specified separated by a comma.
21489 @item -mea32
21490 @itemx -mea64
21491 @opindex mea32
21492 @opindex mea64
21493 Compile code assuming that pointers to the PPU address space accessed
21494 via the @code{__ea} named address space qualifier are either 32 or 64
21495 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21496 all object code in an executable must be compiled with the same setting.
21498 @item -maddress-space-conversion
21499 @itemx -mno-address-space-conversion
21500 @opindex maddress-space-conversion
21501 @opindex mno-address-space-conversion
21502 Allow/disallow treating the @code{__ea} address space as superset
21503 of the generic address space.  This enables explicit type casts
21504 between @code{__ea} and generic pointer as well as implicit
21505 conversions of generic pointers to @code{__ea} pointers.  The
21506 default is to allow address space pointer conversions.
21508 @item -mcache-size=@var{cache-size}
21509 @opindex mcache-size
21510 This option controls the version of libgcc that the compiler links to an
21511 executable and selects a software-managed cache for accessing variables
21512 in the @code{__ea} address space with a particular cache size.  Possible
21513 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21514 and @samp{128}.  The default cache size is 64KB.
21516 @item -matomic-updates
21517 @itemx -mno-atomic-updates
21518 @opindex matomic-updates
21519 @opindex mno-atomic-updates
21520 This option controls the version of libgcc that the compiler links to an
21521 executable and selects whether atomic updates to the software-managed
21522 cache of PPU-side variables are used.  If you use atomic updates, changes
21523 to a PPU variable from SPU code using the @code{__ea} named address space
21524 qualifier do not interfere with changes to other PPU variables residing
21525 in the same cache line from PPU code.  If you do not use atomic updates,
21526 such interference may occur; however, writing back cache lines is
21527 more efficient.  The default behavior is to use atomic updates.
21529 @item -mdual-nops
21530 @itemx -mdual-nops=@var{n}
21531 @opindex mdual-nops
21532 By default, GCC inserts nops to increase dual issue when it expects
21533 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21534 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21535 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21537 @item -mhint-max-nops=@var{n}
21538 @opindex mhint-max-nops
21539 Maximum number of nops to insert for a branch hint.  A branch hint must
21540 be at least 8 instructions away from the branch it is affecting.  GCC
21541 inserts up to @var{n} nops to enforce this, otherwise it does not
21542 generate the branch hint.
21544 @item -mhint-max-distance=@var{n}
21545 @opindex mhint-max-distance
21546 The encoding of the branch hint instruction limits the hint to be within
21547 256 instructions of the branch it is affecting.  By default, GCC makes
21548 sure it is within 125.
21550 @item -msafe-hints
21551 @opindex msafe-hints
21552 Work around a hardware bug that causes the SPU to stall indefinitely.
21553 By default, GCC inserts the @code{hbrp} instruction to make sure
21554 this stall won't happen.
21556 @end table
21558 @node System V Options
21559 @subsection Options for System V
21561 These additional options are available on System V Release 4 for
21562 compatibility with other compilers on those systems:
21564 @table @gcctabopt
21565 @item -G
21566 @opindex G
21567 Create a shared object.
21568 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21570 @item -Qy
21571 @opindex Qy
21572 Identify the versions of each tool used by the compiler, in a
21573 @code{.ident} assembler directive in the output.
21575 @item -Qn
21576 @opindex Qn
21577 Refrain from adding @code{.ident} directives to the output file (this is
21578 the default).
21580 @item -YP,@var{dirs}
21581 @opindex YP
21582 Search the directories @var{dirs}, and no others, for libraries
21583 specified with @option{-l}.
21585 @item -Ym,@var{dir}
21586 @opindex Ym
21587 Look in the directory @var{dir} to find the M4 preprocessor.
21588 The assembler uses this option.
21589 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21590 @c the generic assembler that comes with Solaris takes just -Ym.
21591 @end table
21593 @node TILE-Gx Options
21594 @subsection TILE-Gx Options
21595 @cindex TILE-Gx options
21597 These @samp{-m} options are supported on the TILE-Gx:
21599 @table @gcctabopt
21600 @item -mcmodel=small
21601 @opindex mcmodel=small
21602 Generate code for the small model.  The distance for direct calls is
21603 limited to 500M in either direction.  PC-relative addresses are 32
21604 bits.  Absolute addresses support the full address range.
21606 @item -mcmodel=large
21607 @opindex mcmodel=large
21608 Generate code for the large model.  There is no limitation on call
21609 distance, pc-relative addresses, or absolute addresses.
21611 @item -mcpu=@var{name}
21612 @opindex mcpu
21613 Selects the type of CPU to be targeted.  Currently the only supported
21614 type is @samp{tilegx}.
21616 @item -m32
21617 @itemx -m64
21618 @opindex m32
21619 @opindex m64
21620 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21621 environment sets int, long, and pointer to 32 bits.  The 64-bit
21622 environment sets int to 32 bits and long and pointer to 64 bits.
21624 @item -mbig-endian
21625 @itemx -mlittle-endian
21626 @opindex mbig-endian
21627 @opindex mlittle-endian
21628 Generate code in big/little endian mode, respectively.
21629 @end table
21631 @node TILEPro Options
21632 @subsection TILEPro Options
21633 @cindex TILEPro options
21635 These @samp{-m} options are supported on the TILEPro:
21637 @table @gcctabopt
21638 @item -mcpu=@var{name}
21639 @opindex mcpu
21640 Selects the type of CPU to be targeted.  Currently the only supported
21641 type is @samp{tilepro}.
21643 @item -m32
21644 @opindex m32
21645 Generate code for a 32-bit environment, which sets int, long, and
21646 pointer to 32 bits.  This is the only supported behavior so the flag
21647 is essentially ignored.
21648 @end table
21650 @node V850 Options
21651 @subsection V850 Options
21652 @cindex V850 Options
21654 These @samp{-m} options are defined for V850 implementations:
21656 @table @gcctabopt
21657 @item -mlong-calls
21658 @itemx -mno-long-calls
21659 @opindex mlong-calls
21660 @opindex mno-long-calls
21661 Treat all calls as being far away (near).  If calls are assumed to be
21662 far away, the compiler always loads the function's address into a
21663 register, and calls indirect through the pointer.
21665 @item -mno-ep
21666 @itemx -mep
21667 @opindex mno-ep
21668 @opindex mep
21669 Do not optimize (do optimize) basic blocks that use the same index
21670 pointer 4 or more times to copy pointer into the @code{ep} register, and
21671 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21672 option is on by default if you optimize.
21674 @item -mno-prolog-function
21675 @itemx -mprolog-function
21676 @opindex mno-prolog-function
21677 @opindex mprolog-function
21678 Do not use (do use) external functions to save and restore registers
21679 at the prologue and epilogue of a function.  The external functions
21680 are slower, but use less code space if more than one function saves
21681 the same number of registers.  The @option{-mprolog-function} option
21682 is on by default if you optimize.
21684 @item -mspace
21685 @opindex mspace
21686 Try to make the code as small as possible.  At present, this just turns
21687 on the @option{-mep} and @option{-mprolog-function} options.
21689 @item -mtda=@var{n}
21690 @opindex mtda
21691 Put static or global variables whose size is @var{n} bytes or less into
21692 the tiny data area that register @code{ep} points to.  The tiny data
21693 area can hold up to 256 bytes in total (128 bytes for byte references).
21695 @item -msda=@var{n}
21696 @opindex msda
21697 Put static or global variables whose size is @var{n} bytes or less into
21698 the small data area that register @code{gp} points to.  The small data
21699 area can hold up to 64 kilobytes.
21701 @item -mzda=@var{n}
21702 @opindex mzda
21703 Put static or global variables whose size is @var{n} bytes or less into
21704 the first 32 kilobytes of memory.
21706 @item -mv850
21707 @opindex mv850
21708 Specify that the target processor is the V850.
21710 @item -mv850e3v5
21711 @opindex mv850e3v5
21712 Specify that the target processor is the V850E3V5.  The preprocessor
21713 constant @code{__v850e3v5__} is defined if this option is used.
21715 @item -mv850e2v4
21716 @opindex mv850e2v4
21717 Specify that the target processor is the V850E3V5.  This is an alias for
21718 the @option{-mv850e3v5} option.
21720 @item -mv850e2v3
21721 @opindex mv850e2v3
21722 Specify that the target processor is the V850E2V3.  The preprocessor
21723 constant @code{__v850e2v3__} is defined if this option is used.
21725 @item -mv850e2
21726 @opindex mv850e2
21727 Specify that the target processor is the V850E2.  The preprocessor
21728 constant @code{__v850e2__} is defined if this option is used.
21730 @item -mv850e1
21731 @opindex mv850e1
21732 Specify that the target processor is the V850E1.  The preprocessor
21733 constants @code{__v850e1__} and @code{__v850e__} are defined if
21734 this option is used.
21736 @item -mv850es
21737 @opindex mv850es
21738 Specify that the target processor is the V850ES.  This is an alias for
21739 the @option{-mv850e1} option.
21741 @item -mv850e
21742 @opindex mv850e
21743 Specify that the target processor is the V850E@.  The preprocessor
21744 constant @code{__v850e__} is defined if this option is used.
21746 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21747 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21748 are defined then a default target processor is chosen and the
21749 relevant @samp{__v850*__} preprocessor constant is defined.
21751 The preprocessor constants @code{__v850} and @code{__v851__} are always
21752 defined, regardless of which processor variant is the target.
21754 @item -mdisable-callt
21755 @itemx -mno-disable-callt
21756 @opindex mdisable-callt
21757 @opindex mno-disable-callt
21758 This option suppresses generation of the @code{CALLT} instruction for the
21759 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21760 architecture.
21762 This option is enabled by default when the RH850 ABI is
21763 in use (see @option{-mrh850-abi}), and disabled by default when the
21764 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21765 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
21767 @item -mrelax
21768 @itemx -mno-relax
21769 @opindex mrelax
21770 @opindex mno-relax
21771 Pass on (or do not pass on) the @option{-mrelax} command-line option
21772 to the assembler.
21774 @item -mlong-jumps
21775 @itemx -mno-long-jumps
21776 @opindex mlong-jumps
21777 @opindex mno-long-jumps
21778 Disable (or re-enable) the generation of PC-relative jump instructions.
21780 @item -msoft-float
21781 @itemx -mhard-float
21782 @opindex msoft-float
21783 @opindex mhard-float
21784 Disable (or re-enable) the generation of hardware floating point
21785 instructions.  This option is only significant when the target
21786 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21787 instructions are being generated then the C preprocessor symbol
21788 @code{__FPU_OK__} is defined, otherwise the symbol
21789 @code{__NO_FPU__} is defined.
21791 @item -mloop
21792 @opindex mloop
21793 Enables the use of the e3v5 LOOP instruction.  The use of this
21794 instruction is not enabled by default when the e3v5 architecture is
21795 selected because its use is still experimental.
21797 @item -mrh850-abi
21798 @itemx -mghs
21799 @opindex mrh850-abi
21800 @opindex mghs
21801 Enables support for the RH850 version of the V850 ABI.  This is the
21802 default.  With this version of the ABI the following rules apply:
21804 @itemize
21805 @item
21806 Integer sized structures and unions are returned via a memory pointer
21807 rather than a register.
21809 @item
21810 Large structures and unions (more than 8 bytes in size) are passed by
21811 value.
21813 @item
21814 Functions are aligned to 16-bit boundaries.
21816 @item
21817 The @option{-m8byte-align} command-line option is supported.
21819 @item
21820 The @option{-mdisable-callt} command-line option is enabled by
21821 default.  The @option{-mno-disable-callt} command-line option is not
21822 supported.
21823 @end itemize
21825 When this version of the ABI is enabled the C preprocessor symbol
21826 @code{__V850_RH850_ABI__} is defined.
21828 @item -mgcc-abi
21829 @opindex mgcc-abi
21830 Enables support for the old GCC version of the V850 ABI.  With this
21831 version of the ABI the following rules apply:
21833 @itemize
21834 @item
21835 Integer sized structures and unions are returned in register @code{r10}.
21837 @item
21838 Large structures and unions (more than 8 bytes in size) are passed by
21839 reference.
21841 @item
21842 Functions are aligned to 32-bit boundaries, unless optimizing for
21843 size.
21845 @item
21846 The @option{-m8byte-align} command-line option is not supported.
21848 @item
21849 The @option{-mdisable-callt} command-line option is supported but not
21850 enabled by default.
21851 @end itemize
21853 When this version of the ABI is enabled the C preprocessor symbol
21854 @code{__V850_GCC_ABI__} is defined.
21856 @item -m8byte-align
21857 @itemx -mno-8byte-align
21858 @opindex m8byte-align
21859 @opindex mno-8byte-align
21860 Enables support for @code{double} and @code{long long} types to be
21861 aligned on 8-byte boundaries.  The default is to restrict the
21862 alignment of all objects to at most 4-bytes.  When
21863 @option{-m8byte-align} is in effect the C preprocessor symbol
21864 @code{__V850_8BYTE_ALIGN__} is defined.
21866 @item -mbig-switch
21867 @opindex mbig-switch
21868 Generate code suitable for big switch tables.  Use this option only if
21869 the assembler/linker complain about out of range branches within a switch
21870 table.
21872 @item -mapp-regs
21873 @opindex mapp-regs
21874 This option causes r2 and r5 to be used in the code generated by
21875 the compiler.  This setting is the default.
21877 @item -mno-app-regs
21878 @opindex mno-app-regs
21879 This option causes r2 and r5 to be treated as fixed registers.
21881 @end table
21883 @node VAX Options
21884 @subsection VAX Options
21885 @cindex VAX options
21887 These @samp{-m} options are defined for the VAX:
21889 @table @gcctabopt
21890 @item -munix
21891 @opindex munix
21892 Do not output certain jump instructions (@code{aobleq} and so on)
21893 that the Unix assembler for the VAX cannot handle across long
21894 ranges.
21896 @item -mgnu
21897 @opindex mgnu
21898 Do output those jump instructions, on the assumption that the
21899 GNU assembler is being used.
21901 @item -mg
21902 @opindex mg
21903 Output code for G-format floating-point numbers instead of D-format.
21904 @end table
21906 @node Visium Options
21907 @subsection Visium Options
21908 @cindex Visium options
21910 @table @gcctabopt
21912 @item -mdebug
21913 @opindex mdebug
21914 A program which performs file I/O and is destined to run on an MCM target
21915 should be linked with this option.  It causes the libraries libc.a and
21916 libdebug.a to be linked.  The program should be run on the target under
21917 the control of the GDB remote debugging stub.
21919 @item -msim
21920 @opindex msim
21921 A program which performs file I/O and is destined to run on the simulator
21922 should be linked with option.  This causes libraries libc.a and libsim.a to
21923 be linked.
21925 @item -mfpu
21926 @itemx -mhard-float
21927 @opindex mfpu
21928 @opindex mhard-float
21929 Generate code containing floating-point instructions.  This is the
21930 default.
21932 @item -mno-fpu
21933 @itemx -msoft-float
21934 @opindex mno-fpu
21935 @opindex msoft-float
21936 Generate code containing library calls for floating-point.
21938 @option{-msoft-float} changes the calling convention in the output file;
21939 therefore, it is only useful if you compile @emph{all} of a program with
21940 this option.  In particular, you need to compile @file{libgcc.a}, the
21941 library that comes with GCC, with @option{-msoft-float} in order for
21942 this to work.
21944 @item -mcpu=@var{cpu_type}
21945 @opindex mcpu
21946 Set the instruction set, register set, and instruction scheduling parameters
21947 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21948 @samp{mcm}, @samp{gr5} and @samp{gr6}.
21950 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
21952 By default (unless configured otherwise), GCC generates code for the GR5
21953 variant of the Visium architecture.  
21955 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
21956 architecture.  The only difference from GR5 code is that the compiler will
21957 generate block move instructions.
21959 @item -mtune=@var{cpu_type}
21960 @opindex mtune
21961 Set the instruction scheduling parameters for machine type @var{cpu_type},
21962 but do not set the instruction set or register set that the option
21963 @option{-mcpu=@var{cpu_type}} would.
21965 @item -msv-mode
21966 @opindex msv-mode
21967 Generate code for the supervisor mode, where there are no restrictions on
21968 the access to general registers.  This is the default.
21970 @item -muser-mode
21971 @opindex muser-mode
21972 Generate code for the user mode, where the access to some general registers
21973 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
21974 mode; on the GR6, only registers r29 to r31 are affected.
21975 @end table
21977 @node VMS Options
21978 @subsection VMS Options
21980 These @samp{-m} options are defined for the VMS implementations:
21982 @table @gcctabopt
21983 @item -mvms-return-codes
21984 @opindex mvms-return-codes
21985 Return VMS condition codes from @code{main}. The default is to return POSIX-style
21986 condition (e.g.@ error) codes.
21988 @item -mdebug-main=@var{prefix}
21989 @opindex mdebug-main=@var{prefix}
21990 Flag the first routine whose name starts with @var{prefix} as the main
21991 routine for the debugger.
21993 @item -mmalloc64
21994 @opindex mmalloc64
21995 Default to 64-bit memory allocation routines.
21997 @item -mpointer-size=@var{size}
21998 @opindex mpointer-size=@var{size}
21999 Set the default size of pointers. Possible options for @var{size} are
22000 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22001 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22002 The later option disables @code{pragma pointer_size}.
22003 @end table
22005 @node VxWorks Options
22006 @subsection VxWorks Options
22007 @cindex VxWorks Options
22009 The options in this section are defined for all VxWorks targets.
22010 Options specific to the target hardware are listed with the other
22011 options for that target.
22013 @table @gcctabopt
22014 @item -mrtp
22015 @opindex mrtp
22016 GCC can generate code for both VxWorks kernels and real time processes
22017 (RTPs).  This option switches from the former to the latter.  It also
22018 defines the preprocessor macro @code{__RTP__}.
22020 @item -non-static
22021 @opindex non-static
22022 Link an RTP executable against shared libraries rather than static
22023 libraries.  The options @option{-static} and @option{-shared} can
22024 also be used for RTPs (@pxref{Link Options}); @option{-static}
22025 is the default.
22027 @item -Bstatic
22028 @itemx -Bdynamic
22029 @opindex Bstatic
22030 @opindex Bdynamic
22031 These options are passed down to the linker.  They are defined for
22032 compatibility with Diab.
22034 @item -Xbind-lazy
22035 @opindex Xbind-lazy
22036 Enable lazy binding of function calls.  This option is equivalent to
22037 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22039 @item -Xbind-now
22040 @opindex Xbind-now
22041 Disable lazy binding of function calls.  This option is the default and
22042 is defined for compatibility with Diab.
22043 @end table
22045 @node x86 Options
22046 @subsection x86 Options
22047 @cindex x86 Options
22049 These @samp{-m} options are defined for the x86 family of computers.
22051 @table @gcctabopt
22053 @item -march=@var{cpu-type}
22054 @opindex march
22055 Generate instructions for the machine type @var{cpu-type}.  In contrast to
22056 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
22057 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
22058 to generate code that may not run at all on processors other than the one
22059 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
22060 @option{-mtune=@var{cpu-type}}.
22062 The choices for @var{cpu-type} are:
22064 @table @samp
22065 @item native
22066 This selects the CPU to generate code for at compilation time by determining
22067 the processor type of the compiling machine.  Using @option{-march=native}
22068 enables all instruction subsets supported by the local machine (hence
22069 the result might not run on different machines).  Using @option{-mtune=native}
22070 produces code optimized for the local machine under the constraints
22071 of the selected instruction set.  
22073 @item i386
22074 Original Intel i386 CPU@.
22076 @item i486
22077 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
22079 @item i586
22080 @itemx pentium
22081 Intel Pentium CPU with no MMX support.
22083 @item pentium-mmx
22084 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
22086 @item pentiumpro
22087 Intel Pentium Pro CPU@.
22089 @item i686
22090 When used with @option{-march}, the Pentium Pro
22091 instruction set is used, so the code runs on all i686 family chips.
22092 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
22094 @item pentium2
22095 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
22096 support.
22098 @item pentium3
22099 @itemx pentium3m
22100 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
22101 set support.
22103 @item pentium-m
22104 Intel Pentium M; low-power version of Intel Pentium III CPU
22105 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
22107 @item pentium4
22108 @itemx pentium4m
22109 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
22111 @item prescott
22112 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
22113 set support.
22115 @item nocona
22116 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
22117 SSE2 and SSE3 instruction set support.
22119 @item core2
22120 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
22121 instruction set support.
22123 @item nehalem
22124 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22125 SSE4.1, SSE4.2 and POPCNT instruction set support.
22127 @item westmere
22128 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22129 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
22131 @item sandybridge
22132 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22133 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
22135 @item ivybridge
22136 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22137 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
22138 instruction set support.
22140 @item haswell
22141 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22142 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22143 BMI, BMI2 and F16C instruction set support.
22145 @item broadwell
22146 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22147 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22148 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
22150 @item bonnell
22151 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
22152 instruction set support.
22154 @item silvermont
22155 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22156 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
22158 @item knl
22159 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22160 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22161 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
22162 AVX512CD instruction set support.
22164 @item k6
22165 AMD K6 CPU with MMX instruction set support.
22167 @item k6-2
22168 @itemx k6-3
22169 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
22171 @item athlon
22172 @itemx athlon-tbird
22173 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
22174 support.
22176 @item athlon-4
22177 @itemx athlon-xp
22178 @itemx athlon-mp
22179 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
22180 instruction set support.
22182 @item k8
22183 @itemx opteron
22184 @itemx athlon64
22185 @itemx athlon-fx
22186 Processors based on the AMD K8 core with x86-64 instruction set support,
22187 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
22188 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
22189 instruction set extensions.)
22191 @item k8-sse3
22192 @itemx opteron-sse3
22193 @itemx athlon64-sse3
22194 Improved versions of AMD K8 cores with SSE3 instruction set support.
22196 @item amdfam10
22197 @itemx barcelona
22198 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
22199 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
22200 instruction set extensions.)
22202 @item bdver1
22203 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
22204 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
22205 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
22206 @item bdver2
22207 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22208 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
22209 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
22210 extensions.)
22211 @item bdver3
22212 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22213 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
22214 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
22215 64-bit instruction set extensions.
22216 @item bdver4
22217 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22218 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
22219 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
22220 SSE4.2, ABM and 64-bit instruction set extensions.
22222 @item btver1
22223 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
22224 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
22225 instruction set extensions.)
22227 @item btver2
22228 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
22229 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
22230 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
22232 @item winchip-c6
22233 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
22234 set support.
22236 @item winchip2
22237 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
22238 instruction set support.
22240 @item c3
22241 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
22242 implemented for this chip.)
22244 @item c3-2
22245 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
22246 (No scheduling is
22247 implemented for this chip.)
22249 @item geode
22250 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
22251 @end table
22253 @item -mtune=@var{cpu-type}
22254 @opindex mtune
22255 Tune to @var{cpu-type} everything applicable about the generated code, except
22256 for the ABI and the set of available instructions.  
22257 While picking a specific @var{cpu-type} schedules things appropriately
22258 for that particular chip, the compiler does not generate any code that
22259 cannot run on the default machine type unless you use a
22260 @option{-march=@var{cpu-type}} option.
22261 For example, if GCC is configured for i686-pc-linux-gnu
22262 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
22263 but still runs on i686 machines.
22265 The choices for @var{cpu-type} are the same as for @option{-march}.
22266 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
22268 @table @samp
22269 @item generic
22270 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
22271 If you know the CPU on which your code will run, then you should use
22272 the corresponding @option{-mtune} or @option{-march} option instead of
22273 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
22274 of your application will have, then you should use this option.
22276 As new processors are deployed in the marketplace, the behavior of this
22277 option will change.  Therefore, if you upgrade to a newer version of
22278 GCC, code generation controlled by this option will change to reflect
22279 the processors
22280 that are most common at the time that version of GCC is released.
22282 There is no @option{-march=generic} option because @option{-march}
22283 indicates the instruction set the compiler can use, and there is no
22284 generic instruction set applicable to all processors.  In contrast,
22285 @option{-mtune} indicates the processor (or, in this case, collection of
22286 processors) for which the code is optimized.
22288 @item intel
22289 Produce code optimized for the most current Intel processors, which are
22290 Haswell and Silvermont for this version of GCC.  If you know the CPU
22291 on which your code will run, then you should use the corresponding
22292 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
22293 But, if you want your application performs better on both Haswell and
22294 Silvermont, then you should use this option.
22296 As new Intel processors are deployed in the marketplace, the behavior of
22297 this option will change.  Therefore, if you upgrade to a newer version of
22298 GCC, code generation controlled by this option will change to reflect
22299 the most current Intel processors at the time that version of GCC is
22300 released.
22302 There is no @option{-march=intel} option because @option{-march} indicates
22303 the instruction set the compiler can use, and there is no common
22304 instruction set applicable to all processors.  In contrast,
22305 @option{-mtune} indicates the processor (or, in this case, collection of
22306 processors) for which the code is optimized.
22307 @end table
22309 @item -mcpu=@var{cpu-type}
22310 @opindex mcpu
22311 A deprecated synonym for @option{-mtune}.
22313 @item -mfpmath=@var{unit}
22314 @opindex mfpmath
22315 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
22316 for @var{unit} are:
22318 @table @samp
22319 @item 387
22320 Use the standard 387 floating-point coprocessor present on the majority of chips and
22321 emulated otherwise.  Code compiled with this option runs almost everywhere.
22322 The temporary results are computed in 80-bit precision instead of the precision
22323 specified by the type, resulting in slightly different results compared to most
22324 of other chips.  See @option{-ffloat-store} for more detailed description.
22326 This is the default choice for x86-32 targets.
22328 @item sse
22329 Use scalar floating-point instructions present in the SSE instruction set.
22330 This instruction set is supported by Pentium III and newer chips,
22331 and in the AMD line
22332 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
22333 instruction set supports only single-precision arithmetic, thus the double and
22334 extended-precision arithmetic are still done using 387.  A later version, present
22335 only in Pentium 4 and AMD x86-64 chips, supports double-precision
22336 arithmetic too.
22338 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
22339 or @option{-msse2} switches to enable SSE extensions and make this option
22340 effective.  For the x86-64 compiler, these extensions are enabled by default.
22342 The resulting code should be considerably faster in the majority of cases and avoid
22343 the numerical instability problems of 387 code, but may break some existing
22344 code that expects temporaries to be 80 bits.
22346 This is the default choice for the x86-64 compiler.
22348 @item sse,387
22349 @itemx sse+387
22350 @itemx both
22351 Attempt to utilize both instruction sets at once.  This effectively doubles the
22352 amount of available registers, and on chips with separate execution units for
22353 387 and SSE the execution resources too.  Use this option with care, as it is
22354 still experimental, because the GCC register allocator does not model separate
22355 functional units well, resulting in unstable performance.
22356 @end table
22358 @item -masm=@var{dialect}
22359 @opindex masm=@var{dialect}
22360 Output assembly instructions using selected @var{dialect}.  Also affects
22361 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
22362 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
22363 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
22364 not support @samp{intel}.
22366 @item -mieee-fp
22367 @itemx -mno-ieee-fp
22368 @opindex mieee-fp
22369 @opindex mno-ieee-fp
22370 Control whether or not the compiler uses IEEE floating-point
22371 comparisons.  These correctly handle the case where the result of a
22372 comparison is unordered.
22374 @item -msoft-float
22375 @opindex msoft-float
22376 Generate output containing library calls for floating point.
22378 @strong{Warning:} the requisite libraries are not part of GCC@.
22379 Normally the facilities of the machine's usual C compiler are used, but
22380 this can't be done directly in cross-compilation.  You must make your
22381 own arrangements to provide suitable library functions for
22382 cross-compilation.
22384 On machines where a function returns floating-point results in the 80387
22385 register stack, some floating-point opcodes may be emitted even if
22386 @option{-msoft-float} is used.
22388 @item -mno-fp-ret-in-387
22389 @opindex mno-fp-ret-in-387
22390 Do not use the FPU registers for return values of functions.
22392 The usual calling convention has functions return values of types
22393 @code{float} and @code{double} in an FPU register, even if there
22394 is no FPU@.  The idea is that the operating system should emulate
22395 an FPU@.
22397 The option @option{-mno-fp-ret-in-387} causes such values to be returned
22398 in ordinary CPU registers instead.
22400 @item -mno-fancy-math-387
22401 @opindex mno-fancy-math-387
22402 Some 387 emulators do not support the @code{sin}, @code{cos} and
22403 @code{sqrt} instructions for the 387.  Specify this option to avoid
22404 generating those instructions.  This option is the default on FreeBSD,
22405 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
22406 indicates that the target CPU always has an FPU and so the
22407 instruction does not need emulation.  These
22408 instructions are not generated unless you also use the
22409 @option{-funsafe-math-optimizations} switch.
22411 @item -malign-double
22412 @itemx -mno-align-double
22413 @opindex malign-double
22414 @opindex mno-align-double
22415 Control whether GCC aligns @code{double}, @code{long double}, and
22416 @code{long long} variables on a two-word boundary or a one-word
22417 boundary.  Aligning @code{double} variables on a two-word boundary
22418 produces code that runs somewhat faster on a Pentium at the
22419 expense of more memory.
22421 On x86-64, @option{-malign-double} is enabled by default.
22423 @strong{Warning:} if you use the @option{-malign-double} switch,
22424 structures containing the above types are aligned differently than
22425 the published application binary interface specifications for the x86-32
22426 and are not binary compatible with structures in code compiled
22427 without that switch.
22429 @item -m96bit-long-double
22430 @itemx -m128bit-long-double
22431 @opindex m96bit-long-double
22432 @opindex m128bit-long-double
22433 These switches control the size of @code{long double} type.  The x86-32
22434 application binary interface specifies the size to be 96 bits,
22435 so @option{-m96bit-long-double} is the default in 32-bit mode.
22437 Modern architectures (Pentium and newer) prefer @code{long double}
22438 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
22439 conforming to the ABI, this is not possible.  So specifying
22440 @option{-m128bit-long-double} aligns @code{long double}
22441 to a 16-byte boundary by padding the @code{long double} with an additional
22442 32-bit zero.
22444 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
22445 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
22447 Notice that neither of these options enable any extra precision over the x87
22448 standard of 80 bits for a @code{long double}.
22450 @strong{Warning:} if you override the default value for your target ABI, this
22451 changes the size of 
22452 structures and arrays containing @code{long double} variables,
22453 as well as modifying the function calling convention for functions taking
22454 @code{long double}.  Hence they are not binary-compatible
22455 with code compiled without that switch.
22457 @item -mlong-double-64
22458 @itemx -mlong-double-80
22459 @itemx -mlong-double-128
22460 @opindex mlong-double-64
22461 @opindex mlong-double-80
22462 @opindex mlong-double-128
22463 These switches control the size of @code{long double} type. A size
22464 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22465 type. This is the default for 32-bit Bionic C library.  A size
22466 of 128 bits makes the @code{long double} type equivalent to the
22467 @code{__float128} type. This is the default for 64-bit Bionic C library.
22469 @strong{Warning:} if you override the default value for your target ABI, this
22470 changes the size of
22471 structures and arrays containing @code{long double} variables,
22472 as well as modifying the function calling convention for functions taking
22473 @code{long double}.  Hence they are not binary-compatible
22474 with code compiled without that switch.
22476 @item -malign-data=@var{type}
22477 @opindex malign-data
22478 Control how GCC aligns variables.  Supported values for @var{type} are
22479 @samp{compat} uses increased alignment value compatible uses GCC 4.8
22480 and earlier, @samp{abi} uses alignment value as specified by the
22481 psABI, and @samp{cacheline} uses increased alignment value to match
22482 the cache line size.  @samp{compat} is the default.
22484 @item -mlarge-data-threshold=@var{threshold}
22485 @opindex mlarge-data-threshold
22486 When @option{-mcmodel=medium} is specified, data objects larger than
22487 @var{threshold} are placed in the large data section.  This value must be the
22488 same across all objects linked into the binary, and defaults to 65535.
22490 @item -mrtd
22491 @opindex mrtd
22492 Use a different function-calling convention, in which functions that
22493 take a fixed number of arguments return with the @code{ret @var{num}}
22494 instruction, which pops their arguments while returning.  This saves one
22495 instruction in the caller since there is no need to pop the arguments
22496 there.
22498 You can specify that an individual function is called with this calling
22499 sequence with the function attribute @code{stdcall}.  You can also
22500 override the @option{-mrtd} option by using the function attribute
22501 @code{cdecl}.  @xref{Function Attributes}.
22503 @strong{Warning:} this calling convention is incompatible with the one
22504 normally used on Unix, so you cannot use it if you need to call
22505 libraries compiled with the Unix compiler.
22507 Also, you must provide function prototypes for all functions that
22508 take variable numbers of arguments (including @code{printf});
22509 otherwise incorrect code is generated for calls to those
22510 functions.
22512 In addition, seriously incorrect code results if you call a
22513 function with too many arguments.  (Normally, extra arguments are
22514 harmlessly ignored.)
22516 @item -mregparm=@var{num}
22517 @opindex mregparm
22518 Control how many registers are used to pass integer arguments.  By
22519 default, no registers are used to pass arguments, and at most 3
22520 registers can be used.  You can control this behavior for a specific
22521 function by using the function attribute @code{regparm}.
22522 @xref{Function Attributes}.
22524 @strong{Warning:} if you use this switch, and
22525 @var{num} is nonzero, then you must build all modules with the same
22526 value, including any libraries.  This includes the system libraries and
22527 startup modules.
22529 @item -msseregparm
22530 @opindex msseregparm
22531 Use SSE register passing conventions for float and double arguments
22532 and return values.  You can control this behavior for a specific
22533 function by using the function attribute @code{sseregparm}.
22534 @xref{Function Attributes}.
22536 @strong{Warning:} if you use this switch then you must build all
22537 modules with the same value, including any libraries.  This includes
22538 the system libraries and startup modules.
22540 @item -mvect8-ret-in-mem
22541 @opindex mvect8-ret-in-mem
22542 Return 8-byte vectors in memory instead of MMX registers.  This is the
22543 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
22544 Studio compilers until version 12.  Later compiler versions (starting
22545 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
22546 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
22547 you need to remain compatible with existing code produced by those
22548 previous compiler versions or older versions of GCC@.
22550 @item -mpc32
22551 @itemx -mpc64
22552 @itemx -mpc80
22553 @opindex mpc32
22554 @opindex mpc64
22555 @opindex mpc80
22557 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
22558 is specified, the significands of results of floating-point operations are
22559 rounded to 24 bits (single precision); @option{-mpc64} rounds the
22560 significands of results of floating-point operations to 53 bits (double
22561 precision) and @option{-mpc80} rounds the significands of results of
22562 floating-point operations to 64 bits (extended double precision), which is
22563 the default.  When this option is used, floating-point operations in higher
22564 precisions are not available to the programmer without setting the FPU
22565 control word explicitly.
22567 Setting the rounding of floating-point operations to less than the default
22568 80 bits can speed some programs by 2% or more.  Note that some mathematical
22569 libraries assume that extended-precision (80-bit) floating-point operations
22570 are enabled by default; routines in such libraries could suffer significant
22571 loss of accuracy, typically through so-called ``catastrophic cancellation'',
22572 when this option is used to set the precision to less than extended precision.
22574 @item -mstackrealign
22575 @opindex mstackrealign
22576 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
22577 option generates an alternate prologue and epilogue that realigns the
22578 run-time stack if necessary.  This supports mixing legacy codes that keep
22579 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
22580 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
22581 applicable to individual functions.
22583 @item -mpreferred-stack-boundary=@var{num}
22584 @opindex mpreferred-stack-boundary
22585 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
22586 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
22587 the default is 4 (16 bytes or 128 bits).
22589 @strong{Warning:} When generating code for the x86-64 architecture with
22590 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
22591 used to keep the stack boundary aligned to 8 byte boundary.  Since
22592 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
22593 intended to be used in controlled environment where stack space is
22594 important limitation.  This option leads to wrong code when functions
22595 compiled with 16 byte stack alignment (such as functions from a standard
22596 library) are called with misaligned stack.  In this case, SSE
22597 instructions may lead to misaligned memory access traps.  In addition,
22598 variable arguments are handled incorrectly for 16 byte aligned
22599 objects (including x87 long double and __int128), leading to wrong
22600 results.  You must build all modules with
22601 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
22602 includes the system libraries and startup modules.
22604 @item -mincoming-stack-boundary=@var{num}
22605 @opindex mincoming-stack-boundary
22606 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
22607 boundary.  If @option{-mincoming-stack-boundary} is not specified,
22608 the one specified by @option{-mpreferred-stack-boundary} is used.
22610 On Pentium and Pentium Pro, @code{double} and @code{long double} values
22611 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
22612 suffer significant run time performance penalties.  On Pentium III, the
22613 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
22614 properly if it is not 16-byte aligned.
22616 To ensure proper alignment of this values on the stack, the stack boundary
22617 must be as aligned as that required by any value stored on the stack.
22618 Further, every function must be generated such that it keeps the stack
22619 aligned.  Thus calling a function compiled with a higher preferred
22620 stack boundary from a function compiled with a lower preferred stack
22621 boundary most likely misaligns the stack.  It is recommended that
22622 libraries that use callbacks always use the default setting.
22624 This extra alignment does consume extra stack space, and generally
22625 increases code size.  Code that is sensitive to stack space usage, such
22626 as embedded systems and operating system kernels, may want to reduce the
22627 preferred alignment to @option{-mpreferred-stack-boundary=2}.
22629 @need 200
22630 @item -mmmx
22631 @opindex mmmx
22632 @need 200
22633 @itemx -msse
22634 @opindex msse
22635 @need 200
22636 @itemx -msse2
22637 @need 200
22638 @itemx -msse3
22639 @need 200
22640 @itemx -mssse3
22641 @need 200
22642 @itemx -msse4
22643 @need 200
22644 @itemx -msse4a
22645 @need 200
22646 @itemx -msse4.1
22647 @need 200
22648 @itemx -msse4.2
22649 @need 200
22650 @itemx -mavx
22651 @opindex mavx
22652 @need 200
22653 @itemx -mavx2
22654 @need 200
22655 @itemx -mavx512f
22656 @need 200
22657 @itemx -mavx512pf
22658 @need 200
22659 @itemx -mavx512er
22660 @need 200
22661 @itemx -mavx512cd
22662 @need 200
22663 @itemx -msha
22664 @opindex msha
22665 @need 200
22666 @itemx -maes
22667 @opindex maes
22668 @need 200
22669 @itemx -mpclmul
22670 @opindex mpclmul
22671 @need 200
22672 @itemx -mclfushopt
22673 @opindex mclfushopt
22674 @need 200
22675 @itemx -mfsgsbase
22676 @opindex mfsgsbase
22677 @need 200
22678 @itemx -mrdrnd
22679 @opindex mrdrnd
22680 @need 200
22681 @itemx -mf16c
22682 @opindex mf16c
22683 @need 200
22684 @itemx -mfma
22685 @opindex mfma
22686 @need 200
22687 @itemx -mfma4
22688 @need 200
22689 @itemx -mno-fma4
22690 @need 200
22691 @itemx -mprefetchwt1
22692 @opindex mprefetchwt1
22693 @need 200
22694 @itemx -mxop
22695 @opindex mxop
22696 @need 200
22697 @itemx -mlwp
22698 @opindex mlwp
22699 @need 200
22700 @itemx -m3dnow
22701 @opindex m3dnow
22702 @need 200
22703 @itemx -mpopcnt
22704 @opindex mpopcnt
22705 @need 200
22706 @itemx -mabm
22707 @opindex mabm
22708 @need 200
22709 @itemx -mbmi
22710 @opindex mbmi
22711 @need 200
22712 @itemx -mbmi2
22713 @need 200
22714 @itemx -mlzcnt
22715 @opindex mlzcnt
22716 @need 200
22717 @itemx -mfxsr
22718 @opindex mfxsr
22719 @need 200
22720 @itemx -mxsave
22721 @opindex mxsave
22722 @need 200
22723 @itemx -mxsaveopt
22724 @opindex mxsaveopt
22725 @need 200
22726 @itemx -mxsavec
22727 @opindex mxsavec
22728 @need 200
22729 @itemx -mxsaves
22730 @opindex mxsaves
22731 @need 200
22732 @itemx -mrtm
22733 @opindex mrtm
22734 @need 200
22735 @itemx -mtbm
22736 @opindex mtbm
22737 @need 200
22738 @itemx -mmpx
22739 @opindex mmpx
22740 These switches enable the use of instructions in the MMX, SSE,
22741 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
22742 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
22743 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
22744 extended instruction sets.  Each has a corresponding @option{-mno-} option
22745 to disable use of these instructions.
22747 These extensions are also available as built-in functions: see
22748 @ref{x86 Built-in Functions}, for details of the functions enabled and
22749 disabled by these switches.
22751 To generate SSE/SSE2 instructions automatically from floating-point
22752 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
22754 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
22755 generates new AVX instructions or AVX equivalence for all SSEx instructions
22756 when needed.
22758 These options enable GCC to use these extended instructions in
22759 generated code, even without @option{-mfpmath=sse}.  Applications that
22760 perform run-time CPU detection must compile separate files for each
22761 supported architecture, using the appropriate flags.  In particular,
22762 the file containing the CPU detection code should be compiled without
22763 these options.
22765 @item -mdump-tune-features
22766 @opindex mdump-tune-features
22767 This option instructs GCC to dump the names of the x86 performance 
22768 tuning features and default settings. The names can be used in 
22769 @option{-mtune-ctrl=@var{feature-list}}.
22771 @item -mtune-ctrl=@var{feature-list}
22772 @opindex mtune-ctrl=@var{feature-list}
22773 This option is used to do fine grain control of x86 code generation features.
22774 @var{feature-list} is a comma separated list of @var{feature} names. See also
22775 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
22776 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
22777 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
22778 developers. Using it may lead to code paths not covered by testing and can
22779 potentially result in compiler ICEs or runtime errors.
22781 @item -mno-default
22782 @opindex mno-default
22783 This option instructs GCC to turn off all tunable features. See also 
22784 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
22786 @item -mcld
22787 @opindex mcld
22788 This option instructs GCC to emit a @code{cld} instruction in the prologue
22789 of functions that use string instructions.  String instructions depend on
22790 the DF flag to select between autoincrement or autodecrement mode.  While the
22791 ABI specifies the DF flag to be cleared on function entry, some operating
22792 systems violate this specification by not clearing the DF flag in their
22793 exception dispatchers.  The exception handler can be invoked with the DF flag
22794 set, which leads to wrong direction mode when string instructions are used.
22795 This option can be enabled by default on 32-bit x86 targets by configuring
22796 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
22797 instructions can be suppressed with the @option{-mno-cld} compiler option
22798 in this case.
22800 @item -mvzeroupper
22801 @opindex mvzeroupper
22802 This option instructs GCC to emit a @code{vzeroupper} instruction
22803 before a transfer of control flow out of the function to minimize
22804 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
22805 intrinsics.
22807 @item -mprefer-avx128
22808 @opindex mprefer-avx128
22809 This option instructs GCC to use 128-bit AVX instructions instead of
22810 256-bit AVX instructions in the auto-vectorizer.
22812 @item -mcx16
22813 @opindex mcx16
22814 This option enables GCC to generate @code{CMPXCHG16B} instructions.
22815 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
22816 (or oword) data types.  
22817 This is useful for high-resolution counters that can be updated
22818 by multiple processors (or cores).  This instruction is generated as part of
22819 atomic built-in functions: see @ref{__sync Builtins} or
22820 @ref{__atomic Builtins} for details.
22822 @item -msahf
22823 @opindex msahf
22824 This option enables generation of @code{SAHF} instructions in 64-bit code.
22825 Early Intel Pentium 4 CPUs with Intel 64 support,
22826 prior to the introduction of Pentium 4 G1 step in December 2005,
22827 lacked the @code{LAHF} and @code{SAHF} instructions
22828 which are supported by AMD64.
22829 These are load and store instructions, respectively, for certain status flags.
22830 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
22831 @code{drem}, and @code{remainder} built-in functions;
22832 see @ref{Other Builtins} for details.
22834 @item -mmovbe
22835 @opindex mmovbe
22836 This option enables use of the @code{movbe} instruction to implement
22837 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
22839 @item -mcrc32
22840 @opindex mcrc32
22841 This option enables built-in functions @code{__builtin_ia32_crc32qi},
22842 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
22843 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
22845 @item -mrecip
22846 @opindex mrecip
22847 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
22848 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
22849 with an additional Newton-Raphson step
22850 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
22851 (and their vectorized
22852 variants) for single-precision floating-point arguments.  These instructions
22853 are generated only when @option{-funsafe-math-optimizations} is enabled
22854 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
22855 Note that while the throughput of the sequence is higher than the throughput
22856 of the non-reciprocal instruction, the precision of the sequence can be
22857 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
22859 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
22860 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
22861 combination), and doesn't need @option{-mrecip}.
22863 Also note that GCC emits the above sequence with additional Newton-Raphson step
22864 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
22865 already with @option{-ffast-math} (or the above option combination), and
22866 doesn't need @option{-mrecip}.
22868 @item -mrecip=@var{opt}
22869 @opindex mrecip=opt
22870 This option controls which reciprocal estimate instructions
22871 may be used.  @var{opt} is a comma-separated list of options, which may
22872 be preceded by a @samp{!} to invert the option:
22874 @table @samp
22875 @item all
22876 Enable all estimate instructions.
22878 @item default
22879 Enable the default instructions, equivalent to @option{-mrecip}.
22881 @item none
22882 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22884 @item div
22885 Enable the approximation for scalar division.
22887 @item vec-div
22888 Enable the approximation for vectorized division.
22890 @item sqrt
22891 Enable the approximation for scalar square root.
22893 @item vec-sqrt
22894 Enable the approximation for vectorized square root.
22895 @end table
22897 So, for example, @option{-mrecip=all,!sqrt} enables
22898 all of the reciprocal approximations, except for square root.
22900 @item -mveclibabi=@var{type}
22901 @opindex mveclibabi
22902 Specifies the ABI type to use for vectorizing intrinsics using an
22903 external library.  Supported values for @var{type} are @samp{svml} 
22904 for the Intel short
22905 vector math library and @samp{acml} for the AMD math core library.
22906 To use this option, both @option{-ftree-vectorize} and
22907 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
22908 ABI-compatible library must be specified at link time.
22910 GCC currently emits calls to @code{vmldExp2},
22911 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
22912 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
22913 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
22914 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
22915 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
22916 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
22917 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
22918 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
22919 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
22920 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
22921 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
22922 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
22923 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
22924 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
22925 when @option{-mveclibabi=acml} is used.  
22927 @item -mabi=@var{name}
22928 @opindex mabi
22929 Generate code for the specified calling convention.  Permissible values
22930 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
22931 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
22932 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
22933 You can control this behavior for specific functions by
22934 using the function attributes @code{ms_abi} and @code{sysv_abi}.
22935 @xref{Function Attributes}.
22937 @item -mtls-dialect=@var{type}
22938 @opindex mtls-dialect
22939 Generate code to access thread-local storage using the @samp{gnu} or
22940 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
22941 @samp{gnu2} is more efficient, but it may add compile- and run-time
22942 requirements that cannot be satisfied on all systems.
22944 @item -mpush-args
22945 @itemx -mno-push-args
22946 @opindex mpush-args
22947 @opindex mno-push-args
22948 Use PUSH operations to store outgoing parameters.  This method is shorter
22949 and usually equally fast as method using SUB/MOV operations and is enabled
22950 by default.  In some cases disabling it may improve performance because of
22951 improved scheduling and reduced dependencies.
22953 @item -maccumulate-outgoing-args
22954 @opindex maccumulate-outgoing-args
22955 If enabled, the maximum amount of space required for outgoing arguments is
22956 computed in the function prologue.  This is faster on most modern CPUs
22957 because of reduced dependencies, improved scheduling and reduced stack usage
22958 when the preferred stack boundary is not equal to 2.  The drawback is a notable
22959 increase in code size.  This switch implies @option{-mno-push-args}.
22961 @item -mthreads
22962 @opindex mthreads
22963 Support thread-safe exception handling on MinGW.  Programs that rely
22964 on thread-safe exception handling must compile and link all code with the
22965 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
22966 @option{-D_MT}; when linking, it links in a special thread helper library
22967 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
22969 @item -mno-align-stringops
22970 @opindex mno-align-stringops
22971 Do not align the destination of inlined string operations.  This switch reduces
22972 code size and improves performance in case the destination is already aligned,
22973 but GCC doesn't know about it.
22975 @item -minline-all-stringops
22976 @opindex minline-all-stringops
22977 By default GCC inlines string operations only when the destination is 
22978 known to be aligned to least a 4-byte boundary.  
22979 This enables more inlining and increases code
22980 size, but may improve performance of code that depends on fast
22981 @code{memcpy}, @code{strlen},
22982 and @code{memset} for short lengths.
22984 @item -minline-stringops-dynamically
22985 @opindex minline-stringops-dynamically
22986 For string operations of unknown size, use run-time checks with
22987 inline code for small blocks and a library call for large blocks.
22989 @item -mstringop-strategy=@var{alg}
22990 @opindex mstringop-strategy=@var{alg}
22991 Override the internal decision heuristic for the particular algorithm to use
22992 for inlining string operations.  The allowed values for @var{alg} are:
22994 @table @samp
22995 @item rep_byte
22996 @itemx rep_4byte
22997 @itemx rep_8byte
22998 Expand using i386 @code{rep} prefix of the specified size.
23000 @item byte_loop
23001 @itemx loop
23002 @itemx unrolled_loop
23003 Expand into an inline loop.
23005 @item libcall
23006 Always use a library call.
23007 @end table
23009 @item -mmemcpy-strategy=@var{strategy}
23010 @opindex mmemcpy-strategy=@var{strategy}
23011 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
23012 should be inlined and what inline algorithm to use when the expected size
23013 of the copy operation is known. @var{strategy} 
23014 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
23015 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
23016 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
23017 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
23018 in the list must be specified in increasing order.  The minimal byte size for 
23019 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
23020 preceding range.
23022 @item -mmemset-strategy=@var{strategy}
23023 @opindex mmemset-strategy=@var{strategy}
23024 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
23025 @code{__builtin_memset} expansion.
23027 @item -momit-leaf-frame-pointer
23028 @opindex momit-leaf-frame-pointer
23029 Don't keep the frame pointer in a register for leaf functions.  This
23030 avoids the instructions to save, set up, and restore frame pointers and
23031 makes an extra register available in leaf functions.  The option
23032 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
23033 which might make debugging harder.
23035 @item -mtls-direct-seg-refs
23036 @itemx -mno-tls-direct-seg-refs
23037 @opindex mtls-direct-seg-refs
23038 Controls whether TLS variables may be accessed with offsets from the
23039 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
23040 or whether the thread base pointer must be added.  Whether or not this
23041 is valid depends on the operating system, and whether it maps the
23042 segment to cover the entire TLS area.
23044 For systems that use the GNU C Library, the default is on.
23046 @item -msse2avx
23047 @itemx -mno-sse2avx
23048 @opindex msse2avx
23049 Specify that the assembler should encode SSE instructions with VEX
23050 prefix.  The option @option{-mavx} turns this on by default.
23052 @item -mfentry
23053 @itemx -mno-fentry
23054 @opindex mfentry
23055 If profiling is active (@option{-pg}), put the profiling
23056 counter call before the prologue.
23057 Note: On x86 architectures the attribute @code{ms_hook_prologue}
23058 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
23060 @item -mrecord-mcount
23061 @itemx -mno-record-mcount
23062 @opindex mrecord-mcount
23063 If profiling is active (@option{-pg}), generate a __mcount_loc section
23064 that contains pointers to each profiling call. This is useful for
23065 automatically patching and out calls.
23067 @item -mnop-mcount
23068 @itemx -mno-nop-mcount
23069 @opindex mnop-mcount
23070 If profiling is active (@option{-pg}), generate the calls to
23071 the profiling functions as nops. This is useful when they
23072 should be patched in later dynamically. This is likely only
23073 useful together with @option{-mrecord-mcount}.
23075 @item -mskip-rax-setup
23076 @itemx -mno-skip-rax-setup
23077 @opindex mskip-rax-setup
23078 When generating code for the x86-64 architecture with SSE extensions
23079 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
23080 register when there are no variable arguments passed in vector registers.
23082 @strong{Warning:} Since RAX register is used to avoid unnecessarily
23083 saving vector registers on stack when passing variable arguments, the
23084 impacts of this option are callees may waste some stack space,
23085 misbehave or jump to a random location.  GCC 4.4 or newer don't have
23086 those issues, regardless the RAX register value.
23088 @item -m8bit-idiv
23089 @itemx -mno-8bit-idiv
23090 @opindex m8bit-idiv
23091 On some processors, like Intel Atom, 8-bit unsigned integer divide is
23092 much faster than 32-bit/64-bit integer divide.  This option generates a
23093 run-time check.  If both dividend and divisor are within range of 0
23094 to 255, 8-bit unsigned integer divide is used instead of
23095 32-bit/64-bit integer divide.
23097 @item -mavx256-split-unaligned-load
23098 @itemx -mavx256-split-unaligned-store
23099 @opindex mavx256-split-unaligned-load
23100 @opindex mavx256-split-unaligned-store
23101 Split 32-byte AVX unaligned load and store.
23103 @item -mstack-protector-guard=@var{guard}
23104 @opindex mstack-protector-guard=@var{guard}
23105 Generate stack protection code using canary at @var{guard}.  Supported
23106 locations are @samp{global} for global canary or @samp{tls} for per-thread
23107 canary in the TLS block (the default).  This option has effect only when
23108 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
23110 @end table
23112 These @samp{-m} switches are supported in addition to the above
23113 on x86-64 processors in 64-bit environments.
23115 @table @gcctabopt
23116 @item -m32
23117 @itemx -m64
23118 @itemx -mx32
23119 @itemx -m16
23120 @opindex m32
23121 @opindex m64
23122 @opindex mx32
23123 @opindex m16
23124 Generate code for a 16-bit, 32-bit or 64-bit environment.
23125 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
23126 to 32 bits, and
23127 generates code that runs on any i386 system.
23129 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
23130 types to 64 bits, and generates code for the x86-64 architecture.
23131 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
23132 and @option{-mdynamic-no-pic} options.
23134 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
23135 to 32 bits, and
23136 generates code for the x86-64 architecture.
23138 The @option{-m16} option is the same as @option{-m32}, except for that
23139 it outputs the @code{.code16gcc} assembly directive at the beginning of
23140 the assembly output so that the binary can run in 16-bit mode.
23142 @item -mno-red-zone
23143 @opindex mno-red-zone
23144 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
23145 by the x86-64 ABI; it is a 128-byte area beyond the location of the
23146 stack pointer that is not modified by signal or interrupt handlers
23147 and therefore can be used for temporary data without adjusting the stack
23148 pointer.  The flag @option{-mno-red-zone} disables this red zone.
23150 @item -mcmodel=small
23151 @opindex mcmodel=small
23152 Generate code for the small code model: the program and its symbols must
23153 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
23154 Programs can be statically or dynamically linked.  This is the default
23155 code model.
23157 @item -mcmodel=kernel
23158 @opindex mcmodel=kernel
23159 Generate code for the kernel code model.  The kernel runs in the
23160 negative 2 GB of the address space.
23161 This model has to be used for Linux kernel code.
23163 @item -mcmodel=medium
23164 @opindex mcmodel=medium
23165 Generate code for the medium model: the program is linked in the lower 2
23166 GB of the address space.  Small symbols are also placed there.  Symbols
23167 with sizes larger than @option{-mlarge-data-threshold} are put into
23168 large data or BSS sections and can be located above 2GB.  Programs can
23169 be statically or dynamically linked.
23171 @item -mcmodel=large
23172 @opindex mcmodel=large
23173 Generate code for the large model.  This model makes no assumptions
23174 about addresses and sizes of sections.
23176 @item -maddress-mode=long
23177 @opindex maddress-mode=long
23178 Generate code for long address mode.  This is only supported for 64-bit
23179 and x32 environments.  It is the default address mode for 64-bit
23180 environments.
23182 @item -maddress-mode=short
23183 @opindex maddress-mode=short
23184 Generate code for short address mode.  This is only supported for 32-bit
23185 and x32 environments.  It is the default address mode for 32-bit and
23186 x32 environments.
23187 @end table
23189 @node x86 Windows Options
23190 @subsection x86 Windows Options
23191 @cindex x86 Windows Options
23192 @cindex Windows Options for x86
23194 These additional options are available for Microsoft Windows targets:
23196 @table @gcctabopt
23197 @item -mconsole
23198 @opindex mconsole
23199 This option
23200 specifies that a console application is to be generated, by
23201 instructing the linker to set the PE header subsystem type
23202 required for console applications.
23203 This option is available for Cygwin and MinGW targets and is
23204 enabled by default on those targets.
23206 @item -mdll
23207 @opindex mdll
23208 This option is available for Cygwin and MinGW targets.  It
23209 specifies that a DLL---a dynamic link library---is to be
23210 generated, enabling the selection of the required runtime
23211 startup object and entry point.
23213 @item -mnop-fun-dllimport
23214 @opindex mnop-fun-dllimport
23215 This option is available for Cygwin and MinGW targets.  It
23216 specifies that the @code{dllimport} attribute should be ignored.
23218 @item -mthread
23219 @opindex mthread
23220 This option is available for MinGW targets. It specifies
23221 that MinGW-specific thread support is to be used.
23223 @item -municode
23224 @opindex municode
23225 This option is available for MinGW-w64 targets.  It causes
23226 the @code{UNICODE} preprocessor macro to be predefined, and
23227 chooses Unicode-capable runtime startup code.
23229 @item -mwin32
23230 @opindex mwin32
23231 This option is available for Cygwin and MinGW targets.  It
23232 specifies that the typical Microsoft Windows predefined macros are to
23233 be set in the pre-processor, but does not influence the choice
23234 of runtime library/startup code.
23236 @item -mwindows
23237 @opindex mwindows
23238 This option is available for Cygwin and MinGW targets.  It
23239 specifies that a GUI application is to be generated by
23240 instructing the linker to set the PE header subsystem type
23241 appropriately.
23243 @item -fno-set-stack-executable
23244 @opindex fno-set-stack-executable
23245 This option is available for MinGW targets. It specifies that
23246 the executable flag for the stack used by nested functions isn't
23247 set. This is necessary for binaries running in kernel mode of
23248 Microsoft Windows, as there the User32 API, which is used to set executable
23249 privileges, isn't available.
23251 @item -fwritable-relocated-rdata
23252 @opindex fno-writable-relocated-rdata
23253 This option is available for MinGW and Cygwin targets.  It specifies
23254 that relocated-data in read-only section is put into .data
23255 section.  This is a necessary for older runtimes not supporting
23256 modification of .rdata sections for pseudo-relocation.
23258 @item -mpe-aligned-commons
23259 @opindex mpe-aligned-commons
23260 This option is available for Cygwin and MinGW targets.  It
23261 specifies that the GNU extension to the PE file format that
23262 permits the correct alignment of COMMON variables should be
23263 used when generating code.  It is enabled by default if
23264 GCC detects that the target assembler found during configuration
23265 supports the feature.
23266 @end table
23268 See also under @ref{x86 Options} for standard options.
23270 @node Xstormy16 Options
23271 @subsection Xstormy16 Options
23272 @cindex Xstormy16 Options
23274 These options are defined for Xstormy16:
23276 @table @gcctabopt
23277 @item -msim
23278 @opindex msim
23279 Choose startup files and linker script suitable for the simulator.
23280 @end table
23282 @node Xtensa Options
23283 @subsection Xtensa Options
23284 @cindex Xtensa Options
23286 These options are supported for Xtensa targets:
23288 @table @gcctabopt
23289 @item -mconst16
23290 @itemx -mno-const16
23291 @opindex mconst16
23292 @opindex mno-const16
23293 Enable or disable use of @code{CONST16} instructions for loading
23294 constant values.  The @code{CONST16} instruction is currently not a
23295 standard option from Tensilica.  When enabled, @code{CONST16}
23296 instructions are always used in place of the standard @code{L32R}
23297 instructions.  The use of @code{CONST16} is enabled by default only if
23298 the @code{L32R} instruction is not available.
23300 @item -mfused-madd
23301 @itemx -mno-fused-madd
23302 @opindex mfused-madd
23303 @opindex mno-fused-madd
23304 Enable or disable use of fused multiply/add and multiply/subtract
23305 instructions in the floating-point option.  This has no effect if the
23306 floating-point option is not also enabled.  Disabling fused multiply/add
23307 and multiply/subtract instructions forces the compiler to use separate
23308 instructions for the multiply and add/subtract operations.  This may be
23309 desirable in some cases where strict IEEE 754-compliant results are
23310 required: the fused multiply add/subtract instructions do not round the
23311 intermediate result, thereby producing results with @emph{more} bits of
23312 precision than specified by the IEEE standard.  Disabling fused multiply
23313 add/subtract instructions also ensures that the program output is not
23314 sensitive to the compiler's ability to combine multiply and add/subtract
23315 operations.
23317 @item -mserialize-volatile
23318 @itemx -mno-serialize-volatile
23319 @opindex mserialize-volatile
23320 @opindex mno-serialize-volatile
23321 When this option is enabled, GCC inserts @code{MEMW} instructions before
23322 @code{volatile} memory references to guarantee sequential consistency.
23323 The default is @option{-mserialize-volatile}.  Use
23324 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
23326 @item -mforce-no-pic
23327 @opindex mforce-no-pic
23328 For targets, like GNU/Linux, where all user-mode Xtensa code must be
23329 position-independent code (PIC), this option disables PIC for compiling
23330 kernel code.
23332 @item -mtext-section-literals
23333 @itemx -mno-text-section-literals
23334 @opindex mtext-section-literals
23335 @opindex mno-text-section-literals
23336 These options control the treatment of literal pools.  The default is
23337 @option{-mno-text-section-literals}, which places literals in a separate
23338 section in the output file.  This allows the literal pool to be placed
23339 in a data RAM/ROM, and it also allows the linker to combine literal
23340 pools from separate object files to remove redundant literals and
23341 improve code size.  With @option{-mtext-section-literals}, the literals
23342 are interspersed in the text section in order to keep them as close as
23343 possible to their references.  This may be necessary for large assembly
23344 files.
23346 @item -mtarget-align
23347 @itemx -mno-target-align
23348 @opindex mtarget-align
23349 @opindex mno-target-align
23350 When this option is enabled, GCC instructs the assembler to
23351 automatically align instructions to reduce branch penalties at the
23352 expense of some code density.  The assembler attempts to widen density
23353 instructions to align branch targets and the instructions following call
23354 instructions.  If there are not enough preceding safe density
23355 instructions to align a target, no widening is performed.  The
23356 default is @option{-mtarget-align}.  These options do not affect the
23357 treatment of auto-aligned instructions like @code{LOOP}, which the
23358 assembler always aligns, either by widening density instructions or
23359 by inserting NOP instructions.
23361 @item -mlongcalls
23362 @itemx -mno-longcalls
23363 @opindex mlongcalls
23364 @opindex mno-longcalls
23365 When this option is enabled, GCC instructs the assembler to translate
23366 direct calls to indirect calls unless it can determine that the target
23367 of a direct call is in the range allowed by the call instruction.  This
23368 translation typically occurs for calls to functions in other source
23369 files.  Specifically, the assembler translates a direct @code{CALL}
23370 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
23371 The default is @option{-mno-longcalls}.  This option should be used in
23372 programs where the call target can potentially be out of range.  This
23373 option is implemented in the assembler, not the compiler, so the
23374 assembly code generated by GCC still shows direct call
23375 instructions---look at the disassembled object code to see the actual
23376 instructions.  Note that the assembler uses an indirect call for
23377 every cross-file call, not just those that really are out of range.
23378 @end table
23380 @node zSeries Options
23381 @subsection zSeries Options
23382 @cindex zSeries options
23384 These are listed under @xref{S/390 and zSeries Options}.
23386 @node Code Gen Options
23387 @section Options for Code Generation Conventions
23388 @cindex code generation conventions
23389 @cindex options, code generation
23390 @cindex run-time options
23392 These machine-independent options control the interface conventions
23393 used in code generation.
23395 Most of them have both positive and negative forms; the negative form
23396 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
23397 one of the forms is listed---the one that is not the default.  You
23398 can figure out the other form by either removing @samp{no-} or adding
23401 @table @gcctabopt
23402 @item -fbounds-check
23403 @opindex fbounds-check
23404 For front ends that support it, generate additional code to check that
23405 indices used to access arrays are within the declared range.  This is
23406 currently only supported by the Java and Fortran front ends, where
23407 this option defaults to true and false respectively.
23409 @item -fstack-reuse=@var{reuse-level}
23410 @opindex fstack_reuse
23411 This option controls stack space reuse for user declared local/auto variables
23412 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
23413 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
23414 local variables and temporaries, @samp{named_vars} enables the reuse only for
23415 user defined local variables with names, and @samp{none} disables stack reuse
23416 completely. The default value is @samp{all}. The option is needed when the
23417 program extends the lifetime of a scoped local variable or a compiler generated
23418 temporary beyond the end point defined by the language.  When a lifetime of
23419 a variable ends, and if the variable lives in memory, the optimizing compiler
23420 has the freedom to reuse its stack space with other temporaries or scoped
23421 local variables whose live range does not overlap with it. Legacy code extending
23422 local lifetime is likely to break with the stack reuse optimization.
23424 For example,
23426 @smallexample
23427    int *p;
23428    @{
23429      int local1;
23431      p = &local1;
23432      local1 = 10;
23433      ....
23434    @}
23435    @{
23436       int local2;
23437       local2 = 20;
23438       ...
23439    @}
23441    if (*p == 10)  // out of scope use of local1
23442      @{
23444      @}
23445 @end smallexample
23447 Another example:
23448 @smallexample
23450    struct A
23451    @{
23452        A(int k) : i(k), j(k) @{ @}
23453        int i;
23454        int j;
23455    @};
23457    A *ap;
23459    void foo(const A& ar)
23460    @{
23461       ap = &ar;
23462    @}
23464    void bar()
23465    @{
23466       foo(A(10)); // temp object's lifetime ends when foo returns
23468       @{
23469         A a(20);
23470         ....
23471       @}
23472       ap->i+= 10;  // ap references out of scope temp whose space
23473                    // is reused with a. What is the value of ap->i?
23474    @}
23476 @end smallexample
23478 The lifetime of a compiler generated temporary is well defined by the C++
23479 standard. When a lifetime of a temporary ends, and if the temporary lives
23480 in memory, the optimizing compiler has the freedom to reuse its stack
23481 space with other temporaries or scoped local variables whose live range
23482 does not overlap with it. However some of the legacy code relies on
23483 the behavior of older compilers in which temporaries' stack space is
23484 not reused, the aggressive stack reuse can lead to runtime errors. This
23485 option is used to control the temporary stack reuse optimization.
23487 @item -ftrapv
23488 @opindex ftrapv
23489 This option generates traps for signed overflow on addition, subtraction,
23490 multiplication operations.
23492 @item -fwrapv
23493 @opindex fwrapv
23494 This option instructs the compiler to assume that signed arithmetic
23495 overflow of addition, subtraction and multiplication wraps around
23496 using twos-complement representation.  This flag enables some optimizations
23497 and disables others.  This option is enabled by default for the Java
23498 front end, as required by the Java language specification.
23500 @item -fexceptions
23501 @opindex fexceptions
23502 Enable exception handling.  Generates extra code needed to propagate
23503 exceptions.  For some targets, this implies GCC generates frame
23504 unwind information for all functions, which can produce significant data
23505 size overhead, although it does not affect execution.  If you do not
23506 specify this option, GCC enables it by default for languages like
23507 C++ that normally require exception handling, and disables it for
23508 languages like C that do not normally require it.  However, you may need
23509 to enable this option when compiling C code that needs to interoperate
23510 properly with exception handlers written in C++.  You may also wish to
23511 disable this option if you are compiling older C++ programs that don't
23512 use exception handling.
23514 @item -fnon-call-exceptions
23515 @opindex fnon-call-exceptions
23516 Generate code that allows trapping instructions to throw exceptions.
23517 Note that this requires platform-specific runtime support that does
23518 not exist everywhere.  Moreover, it only allows @emph{trapping}
23519 instructions to throw exceptions, i.e.@: memory references or floating-point
23520 instructions.  It does not allow exceptions to be thrown from
23521 arbitrary signal handlers such as @code{SIGALRM}.
23523 @item -fdelete-dead-exceptions
23524 @opindex fdelete-dead-exceptions
23525 Consider that instructions that may throw exceptions but don't otherwise
23526 contribute to the execution of the program can be optimized away.
23527 This option is enabled by default for the Ada front end, as permitted by
23528 the Ada language specification.
23529 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
23531 @item -funwind-tables
23532 @opindex funwind-tables
23533 Similar to @option{-fexceptions}, except that it just generates any needed
23534 static data, but does not affect the generated code in any other way.
23535 You normally do not need to enable this option; instead, a language processor
23536 that needs this handling enables it on your behalf.
23538 @item -fasynchronous-unwind-tables
23539 @opindex fasynchronous-unwind-tables
23540 Generate unwind table in DWARF 2 format, if supported by target machine.  The
23541 table is exact at each instruction boundary, so it can be used for stack
23542 unwinding from asynchronous events (such as debugger or garbage collector).
23544 @item -fno-gnu-unique
23545 @opindex fno-gnu-unique
23546 On systems with recent GNU assembler and C library, the C++ compiler
23547 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
23548 of template static data members and static local variables in inline
23549 functions are unique even in the presence of @code{RTLD_LOCAL}; this
23550 is necessary to avoid problems with a library used by two different
23551 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
23552 therefore disagreeing with the other one about the binding of the
23553 symbol.  But this causes @code{dlclose} to be ignored for affected
23554 DSOs; if your program relies on reinitialization of a DSO via
23555 @code{dlclose} and @code{dlopen}, you can use
23556 @option{-fno-gnu-unique}.
23558 @item -fpcc-struct-return
23559 @opindex fpcc-struct-return
23560 Return ``short'' @code{struct} and @code{union} values in memory like
23561 longer ones, rather than in registers.  This convention is less
23562 efficient, but it has the advantage of allowing intercallability between
23563 GCC-compiled files and files compiled with other compilers, particularly
23564 the Portable C Compiler (pcc).
23566 The precise convention for returning structures in memory depends
23567 on the target configuration macros.
23569 Short structures and unions are those whose size and alignment match
23570 that of some integer type.
23572 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
23573 switch is not binary compatible with code compiled with the
23574 @option{-freg-struct-return} switch.
23575 Use it to conform to a non-default application binary interface.
23577 @item -freg-struct-return
23578 @opindex freg-struct-return
23579 Return @code{struct} and @code{union} values in registers when possible.
23580 This is more efficient for small structures than
23581 @option{-fpcc-struct-return}.
23583 If you specify neither @option{-fpcc-struct-return} nor
23584 @option{-freg-struct-return}, GCC defaults to whichever convention is
23585 standard for the target.  If there is no standard convention, GCC
23586 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
23587 the principal compiler.  In those cases, we can choose the standard, and
23588 we chose the more efficient register return alternative.
23590 @strong{Warning:} code compiled with the @option{-freg-struct-return}
23591 switch is not binary compatible with code compiled with the
23592 @option{-fpcc-struct-return} switch.
23593 Use it to conform to a non-default application binary interface.
23595 @item -fshort-enums
23596 @opindex fshort-enums
23597 Allocate to an @code{enum} type only as many bytes as it needs for the
23598 declared range of possible values.  Specifically, the @code{enum} type
23599 is equivalent to the smallest integer type that has enough room.
23601 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
23602 code that is not binary compatible with code generated without that switch.
23603 Use it to conform to a non-default application binary interface.
23605 @item -fshort-double
23606 @opindex fshort-double
23607 Use the same size for @code{double} as for @code{float}.
23609 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
23610 code that is not binary compatible with code generated without that switch.
23611 Use it to conform to a non-default application binary interface.
23613 @item -fshort-wchar
23614 @opindex fshort-wchar
23615 Override the underlying type for @code{wchar_t} to be @code{short
23616 unsigned int} instead of the default for the target.  This option is
23617 useful for building programs to run under WINE@.
23619 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
23620 code that is not binary compatible with code generated without that switch.
23621 Use it to conform to a non-default application binary interface.
23623 @item -fno-common
23624 @opindex fno-common
23625 In C code, controls the placement of uninitialized global variables.
23626 Unix C compilers have traditionally permitted multiple definitions of
23627 such variables in different compilation units by placing the variables
23628 in a common block.
23629 This is the behavior specified by @option{-fcommon}, and is the default
23630 for GCC on most targets.
23631 On the other hand, this behavior is not required by ISO C, and on some
23632 targets may carry a speed or code size penalty on variable references.
23633 The @option{-fno-common} option specifies that the compiler should place
23634 uninitialized global variables in the data section of the object file,
23635 rather than generating them as common blocks.
23636 This has the effect that if the same variable is declared
23637 (without @code{extern}) in two different compilations,
23638 you get a multiple-definition error when you link them.
23639 In this case, you must compile with @option{-fcommon} instead.
23640 Compiling with @option{-fno-common} is useful on targets for which
23641 it provides better performance, or if you wish to verify that the
23642 program will work on other systems that always treat uninitialized
23643 variable declarations this way.
23645 @item -fno-ident
23646 @opindex fno-ident
23647 Ignore the @code{#ident} directive.
23649 @item -finhibit-size-directive
23650 @opindex finhibit-size-directive
23651 Don't output a @code{.size} assembler directive, or anything else that
23652 would cause trouble if the function is split in the middle, and the
23653 two halves are placed at locations far apart in memory.  This option is
23654 used when compiling @file{crtstuff.c}; you should not need to use it
23655 for anything else.
23657 @item -fverbose-asm
23658 @opindex fverbose-asm
23659 Put extra commentary information in the generated assembly code to
23660 make it more readable.  This option is generally only of use to those
23661 who actually need to read the generated assembly code (perhaps while
23662 debugging the compiler itself).
23664 @option{-fno-verbose-asm}, the default, causes the
23665 extra information to be omitted and is useful when comparing two assembler
23666 files.
23668 @item -frecord-gcc-switches
23669 @opindex frecord-gcc-switches
23670 This switch causes the command line used to invoke the
23671 compiler to be recorded into the object file that is being created.
23672 This switch is only implemented on some targets and the exact format
23673 of the recording is target and binary file format dependent, but it
23674 usually takes the form of a section containing ASCII text.  This
23675 switch is related to the @option{-fverbose-asm} switch, but that
23676 switch only records information in the assembler output file as
23677 comments, so it never reaches the object file.
23678 See also @option{-grecord-gcc-switches} for another
23679 way of storing compiler options into the object file.
23681 @item -fpic
23682 @opindex fpic
23683 @cindex global offset table
23684 @cindex PIC
23685 Generate position-independent code (PIC) suitable for use in a shared
23686 library, if supported for the target machine.  Such code accesses all
23687 constant addresses through a global offset table (GOT)@.  The dynamic
23688 loader resolves the GOT entries when the program starts (the dynamic
23689 loader is not part of GCC; it is part of the operating system).  If
23690 the GOT size for the linked executable exceeds a machine-specific
23691 maximum size, you get an error message from the linker indicating that
23692 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23693 instead.  (These maximums are 8k on the SPARC and 32k
23694 on the m68k and RS/6000.  The x86 has no such limit.)
23696 Position-independent code requires special support, and therefore works
23697 only on certain machines.  For the x86, GCC supports PIC for System V
23698 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23699 position-independent.
23701 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23702 are defined to 1.
23704 @item -fPIC
23705 @opindex fPIC
23706 If supported for the target machine, emit position-independent code,
23707 suitable for dynamic linking and avoiding any limit on the size of the
23708 global offset table.  This option makes a difference on the m68k,
23709 PowerPC and SPARC@.
23711 Position-independent code requires special support, and therefore works
23712 only on certain machines.
23714 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23715 are defined to 2.
23717 @item -fpie
23718 @itemx -fPIE
23719 @opindex fpie
23720 @opindex fPIE
23721 These options are similar to @option{-fpic} and @option{-fPIC}, but
23722 generated position independent code can be only linked into executables.
23723 Usually these options are used when @option{-pie} GCC option is
23724 used during linking.
23726 @option{-fpie} and @option{-fPIE} both define the macros
23727 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23728 for @option{-fpie} and 2 for @option{-fPIE}.
23730 @item -fno-jump-tables
23731 @opindex fno-jump-tables
23732 Do not use jump tables for switch statements even where it would be
23733 more efficient than other code generation strategies.  This option is
23734 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23735 building code that forms part of a dynamic linker and cannot
23736 reference the address of a jump table.  On some targets, jump tables
23737 do not require a GOT and this option is not needed.
23739 @item -ffixed-@var{reg}
23740 @opindex ffixed
23741 Treat the register named @var{reg} as a fixed register; generated code
23742 should never refer to it (except perhaps as a stack pointer, frame
23743 pointer or in some other fixed role).
23745 @var{reg} must be the name of a register.  The register names accepted
23746 are machine-specific and are defined in the @code{REGISTER_NAMES}
23747 macro in the machine description macro file.
23749 This flag does not have a negative form, because it specifies a
23750 three-way choice.
23752 @item -fcall-used-@var{reg}
23753 @opindex fcall-used
23754 Treat the register named @var{reg} as an allocable register that is
23755 clobbered by function calls.  It may be allocated for temporaries or
23756 variables that do not live across a call.  Functions compiled this way
23757 do not save and restore the register @var{reg}.
23759 It is an error to use this flag with the frame pointer or stack pointer.
23760 Use of this flag for other registers that have fixed pervasive roles in
23761 the machine's execution model produces disastrous results.
23763 This flag does not have a negative form, because it specifies a
23764 three-way choice.
23766 @item -fcall-saved-@var{reg}
23767 @opindex fcall-saved
23768 Treat the register named @var{reg} as an allocable register saved by
23769 functions.  It may be allocated even for temporaries or variables that
23770 live across a call.  Functions compiled this way save and restore
23771 the register @var{reg} if they use it.
23773 It is an error to use this flag with the frame pointer or stack pointer.
23774 Use of this flag for other registers that have fixed pervasive roles in
23775 the machine's execution model produces disastrous results.
23777 A different sort of disaster results from the use of this flag for
23778 a register in which function values may be returned.
23780 This flag does not have a negative form, because it specifies a
23781 three-way choice.
23783 @item -fpack-struct[=@var{n}]
23784 @opindex fpack-struct
23785 Without a value specified, pack all structure members together without
23786 holes.  When a value is specified (which must be a small power of two), pack
23787 structure members according to this value, representing the maximum
23788 alignment (that is, objects with default alignment requirements larger than
23789 this are output potentially unaligned at the next fitting location.
23791 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23792 code that is not binary compatible with code generated without that switch.
23793 Additionally, it makes the code suboptimal.
23794 Use it to conform to a non-default application binary interface.
23796 @item -finstrument-functions
23797 @opindex finstrument-functions
23798 Generate instrumentation calls for entry and exit to functions.  Just
23799 after function entry and just before function exit, the following
23800 profiling functions are called with the address of the current
23801 function and its call site.  (On some platforms,
23802 @code{__builtin_return_address} does not work beyond the current
23803 function, so the call site information may not be available to the
23804 profiling functions otherwise.)
23806 @smallexample
23807 void __cyg_profile_func_enter (void *this_fn,
23808                                void *call_site);
23809 void __cyg_profile_func_exit  (void *this_fn,
23810                                void *call_site);
23811 @end smallexample
23813 The first argument is the address of the start of the current function,
23814 which may be looked up exactly in the symbol table.
23816 This instrumentation is also done for functions expanded inline in other
23817 functions.  The profiling calls indicate where, conceptually, the
23818 inline function is entered and exited.  This means that addressable
23819 versions of such functions must be available.  If all your uses of a
23820 function are expanded inline, this may mean an additional expansion of
23821 code size.  If you use @code{extern inline} in your C code, an
23822 addressable version of such functions must be provided.  (This is
23823 normally the case anyway, but if you get lucky and the optimizer always
23824 expands the functions inline, you might have gotten away without
23825 providing static copies.)
23827 A function may be given the attribute @code{no_instrument_function}, in
23828 which case this instrumentation is not done.  This can be used, for
23829 example, for the profiling functions listed above, high-priority
23830 interrupt routines, and any functions from which the profiling functions
23831 cannot safely be called (perhaps signal handlers, if the profiling
23832 routines generate output or allocate memory).
23834 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
23835 @opindex finstrument-functions-exclude-file-list
23837 Set the list of functions that are excluded from instrumentation (see
23838 the description of @option{-finstrument-functions}).  If the file that
23839 contains a function definition matches with one of @var{file}, then
23840 that function is not instrumented.  The match is done on substrings:
23841 if the @var{file} parameter is a substring of the file name, it is
23842 considered to be a match.
23844 For example:
23846 @smallexample
23847 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
23848 @end smallexample
23850 @noindent
23851 excludes any inline function defined in files whose pathnames
23852 contain @file{/bits/stl} or @file{include/sys}.
23854 If, for some reason, you want to include letter @samp{,} in one of
23855 @var{sym}, write @samp{\,}. For example,
23856 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
23857 (note the single quote surrounding the option).
23859 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
23860 @opindex finstrument-functions-exclude-function-list
23862 This is similar to @option{-finstrument-functions-exclude-file-list},
23863 but this option sets the list of function names to be excluded from
23864 instrumentation.  The function name to be matched is its user-visible
23865 name, such as @code{vector<int> blah(const vector<int> &)}, not the
23866 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
23867 match is done on substrings: if the @var{sym} parameter is a substring
23868 of the function name, it is considered to be a match.  For C99 and C++
23869 extended identifiers, the function name must be given in UTF-8, not
23870 using universal character names.
23872 @item -fstack-check
23873 @opindex fstack-check
23874 Generate code to verify that you do not go beyond the boundary of the
23875 stack.  You should specify this flag if you are running in an
23876 environment with multiple threads, but you only rarely need to specify it in
23877 a single-threaded environment since stack overflow is automatically
23878 detected on nearly all systems if there is only one stack.
23880 Note that this switch does not actually cause checking to be done; the
23881 operating system or the language runtime must do that.  The switch causes
23882 generation of code to ensure that they see the stack being extended.
23884 You can additionally specify a string parameter: @samp{no} means no
23885 checking, @samp{generic} means force the use of old-style checking,
23886 @samp{specific} means use the best checking method and is equivalent
23887 to bare @option{-fstack-check}.
23889 Old-style checking is a generic mechanism that requires no specific
23890 target support in the compiler but comes with the following drawbacks:
23892 @enumerate
23893 @item
23894 Modified allocation strategy for large objects: they are always
23895 allocated dynamically if their size exceeds a fixed threshold.
23897 @item
23898 Fixed limit on the size of the static frame of functions: when it is
23899 topped by a particular function, stack checking is not reliable and
23900 a warning is issued by the compiler.
23902 @item
23903 Inefficiency: because of both the modified allocation strategy and the
23904 generic implementation, code performance is hampered.
23905 @end enumerate
23907 Note that old-style stack checking is also the fallback method for
23908 @samp{specific} if no target support has been added in the compiler.
23910 @item -fstack-limit-register=@var{reg}
23911 @itemx -fstack-limit-symbol=@var{sym}
23912 @itemx -fno-stack-limit
23913 @opindex fstack-limit-register
23914 @opindex fstack-limit-symbol
23915 @opindex fno-stack-limit
23916 Generate code to ensure that the stack does not grow beyond a certain value,
23917 either the value of a register or the address of a symbol.  If a larger
23918 stack is required, a signal is raised at run time.  For most targets,
23919 the signal is raised before the stack overruns the boundary, so
23920 it is possible to catch the signal without taking special precautions.
23922 For instance, if the stack starts at absolute address @samp{0x80000000}
23923 and grows downwards, you can use the flags
23924 @option{-fstack-limit-symbol=__stack_limit} and
23925 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
23926 of 128KB@.  Note that this may only work with the GNU linker.
23928 @item -fsplit-stack
23929 @opindex fsplit-stack
23930 Generate code to automatically split the stack before it overflows.
23931 The resulting program has a discontiguous stack which can only
23932 overflow if the program is unable to allocate any more memory.  This
23933 is most useful when running threaded programs, as it is no longer
23934 necessary to calculate a good stack size to use for each thread.  This
23935 is currently only implemented for the x86 targets running
23936 GNU/Linux.
23938 When code compiled with @option{-fsplit-stack} calls code compiled
23939 without @option{-fsplit-stack}, there may not be much stack space
23940 available for the latter code to run.  If compiling all code,
23941 including library code, with @option{-fsplit-stack} is not an option,
23942 then the linker can fix up these calls so that the code compiled
23943 without @option{-fsplit-stack} always has a large stack.  Support for
23944 this is implemented in the gold linker in GNU binutils release 2.21
23945 and later.
23947 @item -fleading-underscore
23948 @opindex fleading-underscore
23949 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
23950 change the way C symbols are represented in the object file.  One use
23951 is to help link with legacy assembly code.
23953 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
23954 generate code that is not binary compatible with code generated without that
23955 switch.  Use it to conform to a non-default application binary interface.
23956 Not all targets provide complete support for this switch.
23958 @item -ftls-model=@var{model}
23959 @opindex ftls-model
23960 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
23961 The @var{model} argument should be one of @samp{global-dynamic},
23962 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
23963 Note that the choice is subject to optimization: the compiler may use
23964 a more efficient model for symbols not visible outside of the translation
23965 unit, or if @option{-fpic} is not given on the command line.
23967 The default without @option{-fpic} is @samp{initial-exec}; with
23968 @option{-fpic} the default is @samp{global-dynamic}.
23970 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
23971 @opindex fvisibility
23972 Set the default ELF image symbol visibility to the specified option---all
23973 symbols are marked with this unless overridden within the code.
23974 Using this feature can very substantially improve linking and
23975 load times of shared object libraries, produce more optimized
23976 code, provide near-perfect API export and prevent symbol clashes.
23977 It is @strong{strongly} recommended that you use this in any shared objects
23978 you distribute.
23980 Despite the nomenclature, @samp{default} always means public; i.e.,
23981 available to be linked against from outside the shared object.
23982 @samp{protected} and @samp{internal} are pretty useless in real-world
23983 usage so the only other commonly used option is @samp{hidden}.
23984 The default if @option{-fvisibility} isn't specified is
23985 @samp{default}, i.e., make every symbol public.
23987 A good explanation of the benefits offered by ensuring ELF
23988 symbols have the correct visibility is given by ``How To Write
23989 Shared Libraries'' by Ulrich Drepper (which can be found at
23990 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
23991 solution made possible by this option to marking things hidden when
23992 the default is public is to make the default hidden and mark things
23993 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
23994 and @code{__attribute__ ((visibility("default")))} instead of
23995 @code{__declspec(dllexport)} you get almost identical semantics with
23996 identical syntax.  This is a great boon to those working with
23997 cross-platform projects.
23999 For those adding visibility support to existing code, you may find
24000 @code{#pragma GCC visibility} of use.  This works by you enclosing
24001 the declarations you wish to set visibility for with (for example)
24002 @code{#pragma GCC visibility push(hidden)} and
24003 @code{#pragma GCC visibility pop}.
24004 Bear in mind that symbol visibility should be viewed @strong{as
24005 part of the API interface contract} and thus all new code should
24006 always specify visibility when it is not the default; i.e., declarations
24007 only for use within the local DSO should @strong{always} be marked explicitly
24008 as hidden as so to avoid PLT indirection overheads---making this
24009 abundantly clear also aids readability and self-documentation of the code.
24010 Note that due to ISO C++ specification requirements, @code{operator new} and
24011 @code{operator delete} must always be of default visibility.
24013 Be aware that headers from outside your project, in particular system
24014 headers and headers from any other library you use, may not be
24015 expecting to be compiled with visibility other than the default.  You
24016 may need to explicitly say @code{#pragma GCC visibility push(default)}
24017 before including any such headers.
24019 @code{extern} declarations are not affected by @option{-fvisibility}, so
24020 a lot of code can be recompiled with @option{-fvisibility=hidden} with
24021 no modifications.  However, this means that calls to @code{extern}
24022 functions with no explicit visibility use the PLT, so it is more
24023 effective to use @code{__attribute ((visibility))} and/or
24024 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
24025 declarations should be treated as hidden.
24027 Note that @option{-fvisibility} does affect C++ vague linkage
24028 entities. This means that, for instance, an exception class that is
24029 be thrown between DSOs must be explicitly marked with default
24030 visibility so that the @samp{type_info} nodes are unified between
24031 the DSOs.
24033 An overview of these techniques, their benefits and how to use them
24034 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
24036 @item -fstrict-volatile-bitfields
24037 @opindex fstrict-volatile-bitfields
24038 This option should be used if accesses to volatile bit-fields (or other
24039 structure fields, although the compiler usually honors those types
24040 anyway) should use a single access of the width of the
24041 field's type, aligned to a natural alignment if possible.  For
24042 example, targets with memory-mapped peripheral registers might require
24043 all such accesses to be 16 bits wide; with this flag you can
24044 declare all peripheral bit-fields as @code{unsigned short} (assuming short
24045 is 16 bits on these targets) to force GCC to use 16-bit accesses
24046 instead of, perhaps, a more efficient 32-bit access.
24048 If this option is disabled, the compiler uses the most efficient
24049 instruction.  In the previous example, that might be a 32-bit load
24050 instruction, even though that accesses bytes that do not contain
24051 any portion of the bit-field, or memory-mapped registers unrelated to
24052 the one being updated.
24054 In some cases, such as when the @code{packed} attribute is applied to a 
24055 structure field, it may not be possible to access the field with a single
24056 read or write that is correctly aligned for the target machine.  In this
24057 case GCC falls back to generating multiple accesses rather than code that 
24058 will fault or truncate the result at run time.
24060 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
24061 not allowed to touch non bit-field members.  It is therefore recommended
24062 to define all bits of the field's type as bit-field members.
24064 The default value of this option is determined by the application binary
24065 interface for the target processor.
24067 @item -fsync-libcalls
24068 @opindex fsync-libcalls
24069 This option controls whether any out-of-line instance of the @code{__sync}
24070 family of functions may be used to implement the C++11 @code{__atomic}
24071 family of functions.
24073 The default value of this option is enabled, thus the only useful form
24074 of the option is @option{-fno-sync-libcalls}.  This option is used in
24075 the implementation of the @file{libatomic} runtime library.
24077 @end table
24079 @c man end
24081 @node Environment Variables
24082 @section Environment Variables Affecting GCC
24083 @cindex environment variables
24085 @c man begin ENVIRONMENT
24086 This section describes several environment variables that affect how GCC
24087 operates.  Some of them work by specifying directories or prefixes to use
24088 when searching for various kinds of files.  Some are used to specify other
24089 aspects of the compilation environment.
24091 Note that you can also specify places to search using options such as
24092 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
24093 take precedence over places specified using environment variables, which
24094 in turn take precedence over those specified by the configuration of GCC@.
24095 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
24096 GNU Compiler Collection (GCC) Internals}.
24098 @table @env
24099 @item LANG
24100 @itemx LC_CTYPE
24101 @c @itemx LC_COLLATE
24102 @itemx LC_MESSAGES
24103 @c @itemx LC_MONETARY
24104 @c @itemx LC_NUMERIC
24105 @c @itemx LC_TIME
24106 @itemx LC_ALL
24107 @findex LANG
24108 @findex LC_CTYPE
24109 @c @findex LC_COLLATE
24110 @findex LC_MESSAGES
24111 @c @findex LC_MONETARY
24112 @c @findex LC_NUMERIC
24113 @c @findex LC_TIME
24114 @findex LC_ALL
24115 @cindex locale
24116 These environment variables control the way that GCC uses
24117 localization information which allows GCC to work with different
24118 national conventions.  GCC inspects the locale categories
24119 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
24120 so.  These locale categories can be set to any value supported by your
24121 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
24122 Kingdom encoded in UTF-8.
24124 The @env{LC_CTYPE} environment variable specifies character
24125 classification.  GCC uses it to determine the character boundaries in
24126 a string; this is needed for some multibyte encodings that contain quote
24127 and escape characters that are otherwise interpreted as a string
24128 end or escape.
24130 The @env{LC_MESSAGES} environment variable specifies the language to
24131 use in diagnostic messages.
24133 If the @env{LC_ALL} environment variable is set, it overrides the value
24134 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
24135 and @env{LC_MESSAGES} default to the value of the @env{LANG}
24136 environment variable.  If none of these variables are set, GCC
24137 defaults to traditional C English behavior.
24139 @item TMPDIR
24140 @findex TMPDIR
24141 If @env{TMPDIR} is set, it specifies the directory to use for temporary
24142 files.  GCC uses temporary files to hold the output of one stage of
24143 compilation which is to be used as input to the next stage: for example,
24144 the output of the preprocessor, which is the input to the compiler
24145 proper.
24147 @item GCC_COMPARE_DEBUG
24148 @findex GCC_COMPARE_DEBUG
24149 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
24150 @option{-fcompare-debug} to the compiler driver.  See the documentation
24151 of this option for more details.
24153 @item GCC_EXEC_PREFIX
24154 @findex GCC_EXEC_PREFIX
24155 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
24156 names of the subprograms executed by the compiler.  No slash is added
24157 when this prefix is combined with the name of a subprogram, but you can
24158 specify a prefix that ends with a slash if you wish.
24160 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
24161 an appropriate prefix to use based on the pathname it is invoked with.
24163 If GCC cannot find the subprogram using the specified prefix, it
24164 tries looking in the usual places for the subprogram.
24166 The default value of @env{GCC_EXEC_PREFIX} is
24167 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
24168 the installed compiler. In many cases @var{prefix} is the value
24169 of @code{prefix} when you ran the @file{configure} script.
24171 Other prefixes specified with @option{-B} take precedence over this prefix.
24173 This prefix is also used for finding files such as @file{crt0.o} that are
24174 used for linking.
24176 In addition, the prefix is used in an unusual way in finding the
24177 directories to search for header files.  For each of the standard
24178 directories whose name normally begins with @samp{/usr/local/lib/gcc}
24179 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
24180 replacing that beginning with the specified prefix to produce an
24181 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
24182 @file{foo/bar} just before it searches the standard directory 
24183 @file{/usr/local/lib/bar}.
24184 If a standard directory begins with the configured
24185 @var{prefix} then the value of @var{prefix} is replaced by
24186 @env{GCC_EXEC_PREFIX} when looking for header files.
24188 @item COMPILER_PATH
24189 @findex COMPILER_PATH
24190 The value of @env{COMPILER_PATH} is a colon-separated list of
24191 directories, much like @env{PATH}.  GCC tries the directories thus
24192 specified when searching for subprograms, if it can't find the
24193 subprograms using @env{GCC_EXEC_PREFIX}.
24195 @item LIBRARY_PATH
24196 @findex LIBRARY_PATH
24197 The value of @env{LIBRARY_PATH} is a colon-separated list of
24198 directories, much like @env{PATH}.  When configured as a native compiler,
24199 GCC tries the directories thus specified when searching for special
24200 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
24201 using GCC also uses these directories when searching for ordinary
24202 libraries for the @option{-l} option (but directories specified with
24203 @option{-L} come first).
24205 @item LANG
24206 @findex LANG
24207 @cindex locale definition
24208 This variable is used to pass locale information to the compiler.  One way in
24209 which this information is used is to determine the character set to be used
24210 when character literals, string literals and comments are parsed in C and C++.
24211 When the compiler is configured to allow multibyte characters,
24212 the following values for @env{LANG} are recognized:
24214 @table @samp
24215 @item C-JIS
24216 Recognize JIS characters.
24217 @item C-SJIS
24218 Recognize SJIS characters.
24219 @item C-EUCJP
24220 Recognize EUCJP characters.
24221 @end table
24223 If @env{LANG} is not defined, or if it has some other value, then the
24224 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
24225 recognize and translate multibyte characters.
24226 @end table
24228 @noindent
24229 Some additional environment variables affect the behavior of the
24230 preprocessor.
24232 @include cppenv.texi
24234 @c man end
24236 @node Precompiled Headers
24237 @section Using Precompiled Headers
24238 @cindex precompiled headers
24239 @cindex speed of compilation
24241 Often large projects have many header files that are included in every
24242 source file.  The time the compiler takes to process these header files
24243 over and over again can account for nearly all of the time required to
24244 build the project.  To make builds faster, GCC allows you to
24245 @dfn{precompile} a header file.
24247 To create a precompiled header file, simply compile it as you would any
24248 other file, if necessary using the @option{-x} option to make the driver
24249 treat it as a C or C++ header file.  You may want to use a
24250 tool like @command{make} to keep the precompiled header up-to-date when
24251 the headers it contains change.
24253 A precompiled header file is searched for when @code{#include} is
24254 seen in the compilation.  As it searches for the included file
24255 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
24256 compiler looks for a precompiled header in each directory just before it
24257 looks for the include file in that directory.  The name searched for is
24258 the name specified in the @code{#include} with @samp{.gch} appended.  If
24259 the precompiled header file can't be used, it is ignored.
24261 For instance, if you have @code{#include "all.h"}, and you have
24262 @file{all.h.gch} in the same directory as @file{all.h}, then the
24263 precompiled header file is used if possible, and the original
24264 header is used otherwise.
24266 Alternatively, you might decide to put the precompiled header file in a
24267 directory and use @option{-I} to ensure that directory is searched
24268 before (or instead of) the directory containing the original header.
24269 Then, if you want to check that the precompiled header file is always
24270 used, you can put a file of the same name as the original header in this
24271 directory containing an @code{#error} command.
24273 This also works with @option{-include}.  So yet another way to use
24274 precompiled headers, good for projects not designed with precompiled
24275 header files in mind, is to simply take most of the header files used by
24276 a project, include them from another header file, precompile that header
24277 file, and @option{-include} the precompiled header.  If the header files
24278 have guards against multiple inclusion, they are skipped because
24279 they've already been included (in the precompiled header).
24281 If you need to precompile the same header file for different
24282 languages, targets, or compiler options, you can instead make a
24283 @emph{directory} named like @file{all.h.gch}, and put each precompiled
24284 header in the directory, perhaps using @option{-o}.  It doesn't matter
24285 what you call the files in the directory; every precompiled header in
24286 the directory is considered.  The first precompiled header
24287 encountered in the directory that is valid for this compilation is
24288 used; they're searched in no particular order.
24290 There are many other possibilities, limited only by your imagination,
24291 good sense, and the constraints of your build system.
24293 A precompiled header file can be used only when these conditions apply:
24295 @itemize
24296 @item
24297 Only one precompiled header can be used in a particular compilation.
24299 @item
24300 A precompiled header can't be used once the first C token is seen.  You
24301 can have preprocessor directives before a precompiled header; you cannot
24302 include a precompiled header from inside another header.
24304 @item
24305 The precompiled header file must be produced for the same language as
24306 the current compilation.  You can't use a C precompiled header for a C++
24307 compilation.
24309 @item
24310 The precompiled header file must have been produced by the same compiler
24311 binary as the current compilation is using.
24313 @item
24314 Any macros defined before the precompiled header is included must
24315 either be defined in the same way as when the precompiled header was
24316 generated, or must not affect the precompiled header, which usually
24317 means that they don't appear in the precompiled header at all.
24319 The @option{-D} option is one way to define a macro before a
24320 precompiled header is included; using a @code{#define} can also do it.
24321 There are also some options that define macros implicitly, like
24322 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
24323 defined this way.
24325 @item If debugging information is output when using the precompiled
24326 header, using @option{-g} or similar, the same kind of debugging information
24327 must have been output when building the precompiled header.  However,
24328 a precompiled header built using @option{-g} can be used in a compilation
24329 when no debugging information is being output.
24331 @item The same @option{-m} options must generally be used when building
24332 and using the precompiled header.  @xref{Submodel Options},
24333 for any cases where this rule is relaxed.
24335 @item Each of the following options must be the same when building and using
24336 the precompiled header:
24338 @gccoptlist{-fexceptions}
24340 @item
24341 Some other command-line options starting with @option{-f},
24342 @option{-p}, or @option{-O} must be defined in the same way as when
24343 the precompiled header was generated.  At present, it's not clear
24344 which options are safe to change and which are not; the safest choice
24345 is to use exactly the same options when generating and using the
24346 precompiled header.  The following are known to be safe:
24348 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
24349 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
24350 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
24351 -pedantic-errors}
24353 @end itemize
24355 For all of these except the last, the compiler automatically
24356 ignores the precompiled header if the conditions aren't met.  If you
24357 find an option combination that doesn't work and doesn't cause the
24358 precompiled header to be ignored, please consider filing a bug report,
24359 see @ref{Bugs}.
24361 If you do use differing options when generating and using the
24362 precompiled header, the actual behavior is a mixture of the
24363 behavior for the options.  For instance, if you use @option{-g} to
24364 generate the precompiled header but not when using it, you may or may
24365 not get debugging information for routines in the precompiled header.