2014-02-01 Christophe Lyon <christophe.lyon@linaro.org>
[official-gcc.git] / gcc-4_8-branch / gcc / doc / invoke.texi
blobe0ed853720cebccca3cc8eb1d026c725c05b2a45
1 @c Copyright (C) 1988-2013 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-2013 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.  @samp{g++} accepts mostly the same options as @samp{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 -fopenmp -fms-extensions -fplan9-extensions @gol
172 -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  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
191 -ftemplate-depth=@var{n} @gol
192 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
193 -fno-default-inline  -fvisibility-inlines-hidden @gol
194 -fvisibility-ms-compat @gol
195 -fext-numeric-literals @gol
196 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
197 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
198 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
199 -Weffc++  -Wstrict-null-sentinel @gol
200 -Wno-non-template-friend  -Wold-style-cast @gol
201 -Woverloaded-virtual  -Wno-pmf-conversions @gol
202 -Wsign-promo}
204 @item Objective-C and Objective-C++ Language Options
205 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
206 Objective-C and Objective-C++ Dialects}.
207 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
208 -fgnu-runtime  -fnext-runtime @gol
209 -fno-nil-receivers @gol
210 -fobjc-abi-version=@var{n} @gol
211 -fobjc-call-cxx-cdtors @gol
212 -fobjc-direct-dispatch @gol
213 -fobjc-exceptions @gol
214 -fobjc-gc @gol
215 -fobjc-nilcheck @gol
216 -fobjc-std=objc1 @gol
217 -freplace-objc-classes @gol
218 -fzero-link @gol
219 -gen-decls @gol
220 -Wassign-intercept @gol
221 -Wno-protocol  -Wselector @gol
222 -Wstrict-selector-match @gol
223 -Wundeclared-selector}
225 @item Language Independent Options
226 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
227 @gccoptlist{-fmessage-length=@var{n}  @gol
228 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
229 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
231 @item Warning Options
232 @xref{Warning Options,,Options to Request or Suppress Warnings}.
233 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
234 -pedantic-errors @gol
235 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
236 -Waggressive-loop-optimizations -Warray-bounds @gol
237 -Wno-attributes -Wno-builtin-macro-redefined @gol
238 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
239 -Wchar-subscripts -Wclobbered  -Wcomment @gol
240 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
241 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
242 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
243 -Wno-endif-labels -Werror  -Werror=* @gol
244 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
245 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
246 -Wformat-security  -Wformat-y2k @gol
247 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
248 -Wignored-qualifiers @gol
249 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
250 -Winit-self  -Winline -Wmaybe-uninitialized @gol
251 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
252 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
253 -Wlogical-op -Wlong-long @gol
254 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
255 -Wmissing-include-dirs @gol
256 -Wno-mudflap @gol
257 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
258 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
259 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
260 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
261 -Wredundant-decls  -Wno-return-local-addr @gol
262 -Wreturn-type  -Wsequence-point  -Wshadow @gol
263 -Wsign-compare  -Wsign-conversion  -Wsizeof-pointer-memaccess @gol
264 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
265 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
266 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
267 -Wmissing-format-attribute @gol
268 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
269 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
270 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
271 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
272 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
273 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
274 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
275 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
276 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
278 @item C and Objective-C-only Warning Options
279 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
280 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
281 -Wold-style-declaration  -Wold-style-definition @gol
282 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
283 -Wdeclaration-after-statement -Wpointer-sign}
285 @item Debugging Options
286 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
287 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
288 -fsanitize=@var{style} @gol
289 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
290 -fdisable-ipa-@var{pass_name} @gol
291 -fdisable-rtl-@var{pass_name} @gol
292 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
293 -fdisable-tree-@var{pass_name} @gol
294 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
295 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
296 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
297 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
298 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
299 -fdump-passes @gol
300 -fdump-statistics @gol
301 -fdump-tree-all @gol
302 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
303 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
304 -fdump-tree-cfg -fdump-tree-alias @gol
305 -fdump-tree-ch @gol
306 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
308 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-nrv -fdump-tree-vect @gol
316 -fdump-tree-sink @gol
317 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
319 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
321 -ftree-vectorizer-verbose=@var{n} @gol
322 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
323 -fdump-final-insns=@var{file} @gol
324 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
325 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
326 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
327 -fenable-@var{kind}-@var{pass} @gol
328 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
329 -fdebug-types-section -fmem-report-wpa @gol
330 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
331 -fopt-info @gol
332 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
333 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
334 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
335 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
336 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
337 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
338 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
339 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
340 -gvms  -gxcoff  -gxcoff+ @gol
341 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
342 -fdebug-prefix-map=@var{old}=@var{new} @gol
343 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
344 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
345 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
346 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
347 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
348 -print-sysroot -print-sysroot-headers-suffix @gol
349 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
351 @item Optimization Options
352 @xref{Optimize Options,,Options that Control Optimization}.
353 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
354 -falign-jumps[=@var{n}] @gol
355 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
356 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
357 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
358 -fbtr-bb-exclusive -fcaller-saves @gol
359 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
360 -fcompare-elim -fcprop-registers -fcrossjumping @gol
361 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
362 -fcx-limited-range @gol
363 -fdata-sections -fdce -fdelayed-branch @gol
364 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
365 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
366 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
367 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
368 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
369 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
370 -fif-conversion2 -findirect-inlining @gol
371 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
372 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
373 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
374 -fira-algorithm=@var{algorithm} @gol
375 -fira-region=@var{region} -fira-hoist-pressure @gol
376 -fira-loop-pressure -fno-ira-share-save-slots @gol
377 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
378 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
379 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
380 -floop-parallelize-all -flto -flto-compression-level @gol
381 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
382 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
383 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
384 -fno-default-inline @gol
385 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
386 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
387 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
388 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
389 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
390 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
391 -fprefetch-loop-arrays -fprofile-report @gol
392 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
393 -fprofile-generate=@var{path} @gol
394 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
395 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
396 -freorder-blocks-and-partition -freorder-functions @gol
397 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
398 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
399 -fsched-spec-load -fsched-spec-load-dangerous @gol
400 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
401 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
402 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
403 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
404 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
405 -fselective-scheduling -fselective-scheduling2 @gol
406 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
407 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
408 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
409 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
410 -fthread-jumps -ftracer -ftree-bit-ccp @gol
411 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
412 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
413 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
414 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
415 -ftree-loop-if-convert-stores -ftree-loop-im @gol
416 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
417 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
418 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
419 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
420 -ftree-switch-conversion -ftree-tail-merge @gol
421 -ftree-ter -ftree-vectorize -ftree-vrp @gol
422 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
423 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
424 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
425 -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
426 --param @var{name}=@var{value}
427 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
429 @item Preprocessor Options
430 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
431 @gccoptlist{-A@var{question}=@var{answer} @gol
432 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
433 -C  -dD  -dI  -dM  -dN @gol
434 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
435 -idirafter @var{dir} @gol
436 -include @var{file}  -imacros @var{file} @gol
437 -iprefix @var{file}  -iwithprefix @var{dir} @gol
438 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
439 -imultilib @var{dir} -isysroot @var{dir} @gol
440 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
441 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
442 -remap -trigraphs  -undef  -U@var{macro}  @gol
443 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
445 @item Assembler Option
446 @xref{Assembler Options,,Passing Options to the Assembler}.
447 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
449 @item Linker Options
450 @xref{Link Options,,Options for Linking}.
451 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
452 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
453 -s  -static -static-libgcc -static-libstdc++ @gol
454 -static-libasan -static-libtsan @gol
455 -shared -shared-libgcc  -symbolic @gol
456 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
457 -u @var{symbol}}
459 @item Directory Options
460 @xref{Directory Options,,Options for Directory Search}.
461 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
462 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
463 --sysroot=@var{dir} --no-sysroot-suffix}
465 @item Machine Dependent Options
466 @xref{Submodel Options,,Hardware Models and Configurations}.
467 @c This list is ordered alphanumerically by subsection name.
468 @c Try and put the significant identifier (CPU or system) first,
469 @c so users have a clue at guessing where the ones they want will be.
471 @emph{AArch64 Options}
472 @gccoptlist{-mbig-endian  -mlittle-endian @gol
473 -mgeneral-regs-only @gol
474 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
475 -mstrict-align @gol
476 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
477 -mtls-dialect=desc  -mtls-dialect=traditional @gol
478 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
480 @emph{Adapteva Epiphany Options}
481 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
482 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
483 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
484 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
485 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
486 -msplit-vecmove-early -m1reg-@var{reg}}
488 @emph{ARM Options}
489 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
490 -mabi=@var{name} @gol
491 -mapcs-stack-check  -mno-apcs-stack-check @gol
492 -mapcs-float  -mno-apcs-float @gol
493 -mapcs-reentrant  -mno-apcs-reentrant @gol
494 -msched-prolog  -mno-sched-prolog @gol
495 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
496 -mfloat-abi=@var{name} @gol
497 -mfp16-format=@var{name}
498 -mthumb-interwork  -mno-thumb-interwork @gol
499 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
500 -mstructure-size-boundary=@var{n} @gol
501 -mabort-on-noreturn @gol
502 -mlong-calls  -mno-long-calls @gol
503 -msingle-pic-base  -mno-single-pic-base @gol
504 -mpic-register=@var{reg} @gol
505 -mnop-fun-dllimport @gol
506 -mpoke-function-name @gol
507 -mthumb  -marm @gol
508 -mtpcs-frame  -mtpcs-leaf-frame @gol
509 -mcaller-super-interworking  -mcallee-super-interworking @gol
510 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
511 -mword-relocations @gol
512 -mfix-cortex-m3-ldrd @gol
513 -munaligned-access @gol
514 -mneon-for-64bits @gol
515 -mrestrict-it}
517 @emph{AVR Options}
518 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
519 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
520 -mstrict-X -mtiny-stack -Waddr-space-convert}
522 @emph{Blackfin Options}
523 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
524 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
525 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
526 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
527 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
528 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
529 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
530 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
531 -micplb}
533 @emph{C6X Options}
534 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
535 -msim -msdata=@var{sdata-type}}
537 @emph{CRIS Options}
538 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
539 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
540 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
541 -mstack-align  -mdata-align  -mconst-align @gol
542 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
543 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
544 -mmul-bug-workaround  -mno-mul-bug-workaround}
546 @emph{CR16 Options}
547 @gccoptlist{-mmac @gol
548 -mcr16cplus -mcr16c @gol
549 -msim -mint32 -mbit-ops
550 -mdata-model=@var{model}}
552 @emph{Darwin Options}
553 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
554 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
555 -client_name  -compatibility_version  -current_version @gol
556 -dead_strip @gol
557 -dependency-file  -dylib_file  -dylinker_install_name @gol
558 -dynamic  -dynamiclib  -exported_symbols_list @gol
559 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
560 -force_flat_namespace  -headerpad_max_install_names @gol
561 -iframework @gol
562 -image_base  -init  -install_name  -keep_private_externs @gol
563 -multi_module  -multiply_defined  -multiply_defined_unused @gol
564 -noall_load   -no_dead_strip_inits_and_terms @gol
565 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
566 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
567 -private_bundle  -read_only_relocs  -sectalign @gol
568 -sectobjectsymbols  -whyload  -seg1addr @gol
569 -sectcreate  -sectobjectsymbols  -sectorder @gol
570 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
571 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
572 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
573 -single_module  -static  -sub_library  -sub_umbrella @gol
574 -twolevel_namespace  -umbrella  -undefined @gol
575 -unexported_symbols_list  -weak_reference_mismatches @gol
576 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
577 -mkernel -mone-byte-bool}
579 @emph{DEC Alpha Options}
580 @gccoptlist{-mno-fp-regs  -msoft-float @gol
581 -mieee  -mieee-with-inexact  -mieee-conformant @gol
582 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
583 -mtrap-precision=@var{mode}  -mbuild-constants @gol
584 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
585 -mbwx  -mmax  -mfix  -mcix @gol
586 -mfloat-vax  -mfloat-ieee @gol
587 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
588 -msmall-text  -mlarge-text @gol
589 -mmemory-latency=@var{time}}
591 @emph{FR30 Options}
592 @gccoptlist{-msmall-model -mno-lsim}
594 @emph{FRV Options}
595 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
596 -mhard-float  -msoft-float @gol
597 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
598 -mdouble  -mno-double @gol
599 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
600 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
601 -mlinked-fp  -mlong-calls  -malign-labels @gol
602 -mlibrary-pic  -macc-4  -macc-8 @gol
603 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
604 -moptimize-membar -mno-optimize-membar @gol
605 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
606 -mvliw-branch  -mno-vliw-branch @gol
607 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
608 -mno-nested-cond-exec  -mtomcat-stats @gol
609 -mTLS -mtls @gol
610 -mcpu=@var{cpu}}
612 @emph{GNU/Linux Options}
613 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
614 -tno-android-cc -tno-android-ld}
616 @emph{H8/300 Options}
617 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
619 @emph{HPPA Options}
620 @gccoptlist{-march=@var{architecture-type} @gol
621 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
622 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
623 -mfixed-range=@var{register-range} @gol
624 -mjump-in-delay -mlinker-opt -mlong-calls @gol
625 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
626 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
627 -mno-jump-in-delay  -mno-long-load-store @gol
628 -mno-portable-runtime  -mno-soft-float @gol
629 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
630 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
631 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
632 -munix=@var{unix-std}  -nolibdld  -static  -threads}
634 @emph{i386 and x86-64 Options}
635 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
636 -mfpmath=@var{unit} @gol
637 -masm=@var{dialect}  -mno-fancy-math-387 @gol
638 -mno-fp-ret-in-387  -msoft-float @gol
639 -mno-wide-multiply  -mrtd  -malign-double @gol
640 -mpreferred-stack-boundary=@var{num} @gol
641 -mincoming-stack-boundary=@var{num} @gol
642 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
643 -mrecip -mrecip=@var{opt} @gol
644 -mvzeroupper -mprefer-avx128 @gol
645 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
646 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
647 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
648 -mbmi2 -mrtm -mlwp -mthreads @gol
649 -mno-align-stringops  -minline-all-stringops @gol
650 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
651 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
652 -m96bit-long-double -mlong-double-64 -mlong-double-80 @gol
653 -mregparm=@var{num}  -msseregparm @gol
654 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
655 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
656 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
657 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
658 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
659 -msse2avx -mfentry -m8bit-idiv @gol
660 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
662 @emph{i386 and x86-64 Windows Options}
663 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
664 -mnop-fun-dllimport -mthread @gol
665 -municode -mwin32 -mwindows -fno-set-stack-executable}
667 @emph{IA-64 Options}
668 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
669 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
670 -mconstant-gp  -mauto-pic  -mfused-madd @gol
671 -minline-float-divide-min-latency @gol
672 -minline-float-divide-max-throughput @gol
673 -mno-inline-float-divide @gol
674 -minline-int-divide-min-latency @gol
675 -minline-int-divide-max-throughput  @gol
676 -mno-inline-int-divide @gol
677 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
678 -mno-inline-sqrt @gol
679 -mdwarf2-asm -mearly-stop-bits @gol
680 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
681 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
682 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
683 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
684 -msched-spec-ldc -msched-spec-control-ldc @gol
685 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
686 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
687 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
688 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
690 @emph{LM32 Options}
691 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
692 -msign-extend-enabled -muser-enabled}
694 @emph{M32R/D Options}
695 @gccoptlist{-m32r2 -m32rx -m32r @gol
696 -mdebug @gol
697 -malign-loops -mno-align-loops @gol
698 -missue-rate=@var{number} @gol
699 -mbranch-cost=@var{number} @gol
700 -mmodel=@var{code-size-model-type} @gol
701 -msdata=@var{sdata-type} @gol
702 -mno-flush-func -mflush-func=@var{name} @gol
703 -mno-flush-trap -mflush-trap=@var{number} @gol
704 -G @var{num}}
706 @emph{M32C Options}
707 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
709 @emph{M680x0 Options}
710 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
711 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
712 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
713 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
714 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
715 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
716 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
717 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
718 -mxgot -mno-xgot}
720 @emph{MCore Options}
721 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
722 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
723 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
724 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
725 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
727 @emph{MeP Options}
728 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
729 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
730 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
731 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
732 -mtiny=@var{n}}
734 @emph{MicroBlaze Options}
735 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
736 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
737 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
738 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
739 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
741 @emph{MIPS Options}
742 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
743 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
744 -mips64  -mips64r2 @gol
745 -mips16  -mno-mips16  -mflip-mips16 @gol
746 -minterlink-mips16  -mno-interlink-mips16 @gol
747 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
748 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
749 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
750 -mno-float -msingle-float  -mdouble-float  @gol
751 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
752 -mmcu -mmno-mcu @gol
753 -mfpu=@var{fpu-type} @gol
754 -msmartmips  -mno-smartmips @gol
755 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
756 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
757 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
758 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
759 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
760 -membedded-data  -mno-embedded-data @gol
761 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
762 -mcode-readable=@var{setting} @gol
763 -msplit-addresses  -mno-split-addresses @gol
764 -mexplicit-relocs  -mno-explicit-relocs @gol
765 -mcheck-zero-division  -mno-check-zero-division @gol
766 -mdivide-traps  -mdivide-breaks @gol
767 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
768 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
769 -mfix-24k -mno-fix-24k @gol
770 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
771 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
772 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
773 -mflush-func=@var{func}  -mno-flush-func @gol
774 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
775 -mfp-exceptions -mno-fp-exceptions @gol
776 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
777 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
779 @emph{MMIX Options}
780 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
781 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
782 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
783 -mno-base-addresses  -msingle-exit  -mno-single-exit}
785 @emph{MN10300 Options}
786 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
787 -mno-am33 -mam33 -mam33-2 -mam34 @gol
788 -mtune=@var{cpu-type} @gol
789 -mreturn-pointer-on-d0 @gol
790 -mno-crt0  -mrelax -mliw -msetlb}
792 @emph{Moxie Options}
793 @gccoptlist{-meb -mel -mno-crt0}
795 @emph{PDP-11 Options}
796 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
797 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
798 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
799 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
800 -mbranch-expensive  -mbranch-cheap @gol
801 -munix-asm  -mdec-asm}
803 @emph{picoChip Options}
804 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
805 -msymbol-as-address -mno-inefficient-warnings}
807 @emph{PowerPC Options}
808 See RS/6000 and PowerPC Options.
810 @emph{RL78 Options}
811 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
813 @emph{RS/6000 and PowerPC Options}
814 @gccoptlist{-mcpu=@var{cpu-type} @gol
815 -mtune=@var{cpu-type} @gol
816 -mcmodel=@var{code-model} @gol
817 -mpowerpc64 @gol
818 -maltivec  -mno-altivec @gol
819 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
820 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
821 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
822 -mfprnd  -mno-fprnd @gol
823 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
824 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
825 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
826 -malign-power  -malign-natural @gol
827 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
828 -msingle-float -mdouble-float -msimple-fpu @gol
829 -mstring  -mno-string  -mupdate  -mno-update @gol
830 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
831 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
832 -mstrict-align  -mno-strict-align  -mrelocatable @gol
833 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
834 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
835 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
836 -mprioritize-restricted-insns=@var{priority} @gol
837 -msched-costly-dep=@var{dependence_type} @gol
838 -minsert-sched-nops=@var{scheme} @gol
839 -mcall-sysv  -mcall-netbsd @gol
840 -maix-struct-return  -msvr4-struct-return @gol
841 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
842 -mblock-move-inline-limit=@var{num} @gol
843 -misel -mno-isel @gol
844 -misel=yes  -misel=no @gol
845 -mspe -mno-spe @gol
846 -mspe=yes  -mspe=no @gol
847 -mpaired @gol
848 -mgen-cell-microcode -mwarn-cell-microcode @gol
849 -mvrsave -mno-vrsave @gol
850 -mmulhw -mno-mulhw @gol
851 -mdlmzb -mno-dlmzb @gol
852 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
853 -mprototype  -mno-prototype @gol
854 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
855 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
856 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
857 -mno-recip-precision @gol
858 -mveclibabi=@var{type} -mfriz -mno-friz @gol
859 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
860 -msave-toc-indirect -mno-save-toc-indirect}
862 @emph{RX Options}
863 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
864 -mcpu=@gol
865 -mbig-endian-data -mlittle-endian-data @gol
866 -msmall-data @gol
867 -msim  -mno-sim@gol
868 -mas100-syntax -mno-as100-syntax@gol
869 -mrelax@gol
870 -mmax-constant-size=@gol
871 -mint-register=@gol
872 -mpid@gol
873 -mno-warn-multiple-fast-interrupts@gol
874 -msave-acc-in-interrupts}
876 @emph{S/390 and zSeries Options}
877 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
878 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
879 -mlong-double-64 -mlong-double-128 @gol
880 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
881 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
882 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
883 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
884 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
885 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
887 @emph{Score Options}
888 @gccoptlist{-meb -mel @gol
889 -mnhwloop @gol
890 -muls @gol
891 -mmac @gol
892 -mscore5 -mscore5u -mscore7 -mscore7d}
894 @emph{SH Options}
895 @gccoptlist{-m1  -m2  -m2e @gol
896 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
897 -m3  -m3e @gol
898 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
899 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
900 -m5-64media  -m5-64media-nofpu @gol
901 -m5-32media  -m5-32media-nofpu @gol
902 -m5-compact  -m5-compact-nofpu @gol
903 -mb  -ml  -mdalign  -mrelax @gol
904 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
905 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
906 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
907 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
908 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
909 -maccumulate-outgoing-args -minvalid-symbols @gol
910 -matomic-model=@var{atomic-model} @gol
911 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
912 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
913 -mpretend-cmove -mtas}
915 @emph{Solaris 2 Options}
916 @gccoptlist{-mimpure-text  -mno-impure-text @gol
917 -pthreads -pthread}
919 @emph{SPARC Options}
920 @gccoptlist{-mcpu=@var{cpu-type} @gol
921 -mtune=@var{cpu-type} @gol
922 -mcmodel=@var{code-model} @gol
923 -mmemory-model=@var{mem-model} @gol
924 -m32  -m64  -mapp-regs  -mno-app-regs @gol
925 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
926 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
927 -mhard-quad-float  -msoft-quad-float @gol
928 -mstack-bias  -mno-stack-bias @gol
929 -munaligned-doubles  -mno-unaligned-doubles @gol
930 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
931 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
932 -mcbcond -mno-cbcond @gol
933 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
934 -mfix-at697f -mfix-ut699}
936 @emph{SPU Options}
937 @gccoptlist{-mwarn-reloc -merror-reloc @gol
938 -msafe-dma -munsafe-dma @gol
939 -mbranch-hints @gol
940 -msmall-mem -mlarge-mem -mstdmain @gol
941 -mfixed-range=@var{register-range} @gol
942 -mea32 -mea64 @gol
943 -maddress-space-conversion -mno-address-space-conversion @gol
944 -mcache-size=@var{cache-size} @gol
945 -matomic-updates -mno-atomic-updates}
947 @emph{System V Options}
948 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
950 @emph{TILE-Gx Options}
951 @gccoptlist{-mcpu=@var{cpu} -m32 -m64 -mcmodel=@var{code-model}}
953 @emph{TILEPro Options}
954 @gccoptlist{-mcpu=@var{cpu} -m32}
956 @emph{V850 Options}
957 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
958 -mprolog-function  -mno-prolog-function  -mspace @gol
959 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
960 -mapp-regs  -mno-app-regs @gol
961 -mdisable-callt  -mno-disable-callt @gol
962 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
963 -mv850e -mv850 -mv850e3v5 @gol
964 -mloop @gol
965 -mrelax @gol
966 -mlong-jumps @gol
967 -msoft-float @gol
968 -mhard-float @gol
969 -mgcc-abi @gol
970 -mrh850-abi @gol
971 -mbig-switch}
973 @emph{VAX Options}
974 @gccoptlist{-mg  -mgnu  -munix}
976 @emph{VMS Options}
977 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
978 -mpointer-size=@var{size}}
980 @emph{VxWorks Options}
981 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
982 -Xbind-lazy  -Xbind-now}
984 @emph{x86-64 Options}
985 See i386 and x86-64 Options.
987 @emph{Xstormy16 Options}
988 @gccoptlist{-msim}
990 @emph{Xtensa Options}
991 @gccoptlist{-mconst16 -mno-const16 @gol
992 -mfused-madd  -mno-fused-madd @gol
993 -mforce-no-pic @gol
994 -mserialize-volatile  -mno-serialize-volatile @gol
995 -mtext-section-literals  -mno-text-section-literals @gol
996 -mtarget-align  -mno-target-align @gol
997 -mlongcalls  -mno-longcalls}
999 @emph{zSeries Options}
1000 See S/390 and zSeries Options.
1002 @item Code Generation Options
1003 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1004 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1005 -ffixed-@var{reg}  -fexceptions @gol
1006 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1007 -fasynchronous-unwind-tables @gol
1008 -finhibit-size-directive  -finstrument-functions @gol
1009 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1010 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1011 -fno-common  -fno-ident @gol
1012 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1013 -fno-jump-tables @gol
1014 -frecord-gcc-switches @gol
1015 -freg-struct-return  -fshort-enums @gol
1016 -fshort-double  -fshort-wchar @gol
1017 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1018 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1019 -fno-stack-limit -fsplit-stack @gol
1020 -fleading-underscore  -ftls-model=@var{model} @gol
1021 -fstack-reuse=@var{reuse_level} @gol
1022 -ftrapv  -fwrapv  -fbounds-check @gol
1023 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1024 @end table
1026 @menu
1027 * Overall Options::     Controlling the kind of output:
1028                         an executable, object files, assembler files,
1029                         or preprocessed source.
1030 * C Dialect Options::   Controlling the variant of C language compiled.
1031 * C++ Dialect Options:: Variations on C++.
1032 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1033                         and Objective-C++.
1034 * Language Independent Options:: Controlling how diagnostics should be
1035                         formatted.
1036 * Warning Options::     How picky should the compiler be?
1037 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1038 * Optimize Options::    How much optimization?
1039 * Preprocessor Options:: Controlling header files and macro definitions.
1040                          Also, getting dependency information for Make.
1041 * Assembler Options::   Passing options to the assembler.
1042 * Link Options::        Specifying libraries and so on.
1043 * Directory Options::   Where to find header files and libraries.
1044                         Where to find the compiler executable files.
1045 * Spec Files::          How to pass switches to sub-processes.
1046 * Target Options::      Running a cross-compiler, or an old version of GCC.
1047 @end menu
1049 @node Overall Options
1050 @section Options Controlling the Kind of Output
1052 Compilation can involve up to four stages: preprocessing, compilation
1053 proper, assembly and linking, always in that order.  GCC is capable of
1054 preprocessing and compiling several files either into several
1055 assembler input files, or into one assembler input file; then each
1056 assembler input file produces an object file, and linking combines all
1057 the object files (those newly compiled, and those specified as input)
1058 into an executable file.
1060 @cindex file name suffix
1061 For any given input file, the file name suffix determines what kind of
1062 compilation is done:
1064 @table @gcctabopt
1065 @item @var{file}.c
1066 C source code that must be preprocessed.
1068 @item @var{file}.i
1069 C source code that should not be preprocessed.
1071 @item @var{file}.ii
1072 C++ source code that should not be preprocessed.
1074 @item @var{file}.m
1075 Objective-C source code.  Note that you must link with the @file{libobjc}
1076 library to make an Objective-C program work.
1078 @item @var{file}.mi
1079 Objective-C source code that should not be preprocessed.
1081 @item @var{file}.mm
1082 @itemx @var{file}.M
1083 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1084 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1085 to a literal capital M@.
1087 @item @var{file}.mii
1088 Objective-C++ source code that should not be preprocessed.
1090 @item @var{file}.h
1091 C, C++, Objective-C or Objective-C++ header file to be turned into a
1092 precompiled header (default), or C, C++ header file to be turned into an
1093 Ada spec (via the @option{-fdump-ada-spec} switch).
1095 @item @var{file}.cc
1096 @itemx @var{file}.cp
1097 @itemx @var{file}.cxx
1098 @itemx @var{file}.cpp
1099 @itemx @var{file}.CPP
1100 @itemx @var{file}.c++
1101 @itemx @var{file}.C
1102 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1103 the last two letters must both be literally @samp{x}.  Likewise,
1104 @samp{.C} refers to a literal capital C@.
1106 @item @var{file}.mm
1107 @itemx @var{file}.M
1108 Objective-C++ source code that must be preprocessed.
1110 @item @var{file}.mii
1111 Objective-C++ source code that should not be preprocessed.
1113 @item @var{file}.hh
1114 @itemx @var{file}.H
1115 @itemx @var{file}.hp
1116 @itemx @var{file}.hxx
1117 @itemx @var{file}.hpp
1118 @itemx @var{file}.HPP
1119 @itemx @var{file}.h++
1120 @itemx @var{file}.tcc
1121 C++ header file to be turned into a precompiled header or Ada spec.
1123 @item @var{file}.f
1124 @itemx @var{file}.for
1125 @itemx @var{file}.ftn
1126 Fixed form Fortran source code that should not be preprocessed.
1128 @item @var{file}.F
1129 @itemx @var{file}.FOR
1130 @itemx @var{file}.fpp
1131 @itemx @var{file}.FPP
1132 @itemx @var{file}.FTN
1133 Fixed form Fortran source code that must be preprocessed (with the traditional
1134 preprocessor).
1136 @item @var{file}.f90
1137 @itemx @var{file}.f95
1138 @itemx @var{file}.f03
1139 @itemx @var{file}.f08
1140 Free form Fortran source code that should not be preprocessed.
1142 @item @var{file}.F90
1143 @itemx @var{file}.F95
1144 @itemx @var{file}.F03
1145 @itemx @var{file}.F08
1146 Free form Fortran source code that must be preprocessed (with the
1147 traditional preprocessor).
1149 @item @var{file}.go
1150 Go source code.
1152 @c FIXME: Descriptions of Java file types.
1153 @c @var{file}.java
1154 @c @var{file}.class
1155 @c @var{file}.zip
1156 @c @var{file}.jar
1158 @item @var{file}.ads
1159 Ada source code file that contains a library unit declaration (a
1160 declaration of a package, subprogram, or generic, or a generic
1161 instantiation), or a library unit renaming declaration (a package,
1162 generic, or subprogram renaming declaration).  Such files are also
1163 called @dfn{specs}.
1165 @item @var{file}.adb
1166 Ada source code file containing a library unit body (a subprogram or
1167 package body).  Such files are also called @dfn{bodies}.
1169 @c GCC also knows about some suffixes for languages not yet included:
1170 @c Pascal:
1171 @c @var{file}.p
1172 @c @var{file}.pas
1173 @c Ratfor:
1174 @c @var{file}.r
1176 @item @var{file}.s
1177 Assembler code.
1179 @item @var{file}.S
1180 @itemx @var{file}.sx
1181 Assembler code that must be preprocessed.
1183 @item @var{other}
1184 An object file to be fed straight into linking.
1185 Any file name with no recognized suffix is treated this way.
1186 @end table
1188 @opindex x
1189 You can specify the input language explicitly with the @option{-x} option:
1191 @table @gcctabopt
1192 @item -x @var{language}
1193 Specify explicitly the @var{language} for the following input files
1194 (rather than letting the compiler choose a default based on the file
1195 name suffix).  This option applies to all following input files until
1196 the next @option{-x} option.  Possible values for @var{language} are:
1197 @smallexample
1198 c  c-header  cpp-output
1199 c++  c++-header  c++-cpp-output
1200 objective-c  objective-c-header  objective-c-cpp-output
1201 objective-c++ objective-c++-header objective-c++-cpp-output
1202 assembler  assembler-with-cpp
1204 f77  f77-cpp-input f95  f95-cpp-input
1206 java
1207 @end smallexample
1209 @item -x none
1210 Turn off any specification of a language, so that subsequent files are
1211 handled according to their file name suffixes (as they are if @option{-x}
1212 has not been used at all).
1214 @item -pass-exit-codes
1215 @opindex pass-exit-codes
1216 Normally the @command{gcc} program exits with the code of 1 if any
1217 phase of the compiler returns a non-success return code.  If you specify
1218 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1219 the numerically highest error produced by any phase returning an error
1220 indication.  The C, C++, and Fortran front ends return 4 if an internal
1221 compiler error is encountered.
1222 @end table
1224 If you only want some of the stages of compilation, you can use
1225 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1226 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1227 @command{gcc} is to stop.  Note that some combinations (for example,
1228 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1230 @table @gcctabopt
1231 @item -c
1232 @opindex c
1233 Compile or assemble the source files, but do not link.  The linking
1234 stage simply is not done.  The ultimate output is in the form of an
1235 object file for each source file.
1237 By default, the object file name for a source file is made by replacing
1238 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1240 Unrecognized input files, not requiring compilation or assembly, are
1241 ignored.
1243 @item -S
1244 @opindex S
1245 Stop after the stage of compilation proper; do not assemble.  The output
1246 is in the form of an assembler code file for each non-assembler input
1247 file specified.
1249 By default, the assembler file name for a source file is made by
1250 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1252 Input files that don't require compilation are ignored.
1254 @item -E
1255 @opindex E
1256 Stop after the preprocessing stage; do not run the compiler proper.  The
1257 output is in the form of preprocessed source code, which is sent to the
1258 standard output.
1260 Input files that don't require preprocessing are ignored.
1262 @cindex output file option
1263 @item -o @var{file}
1264 @opindex o
1265 Place output in file @var{file}.  This applies to whatever
1266 sort of output is being produced, whether it be an executable file,
1267 an object file, an assembler file or preprocessed C code.
1269 If @option{-o} is not specified, the default is to put an executable
1270 file in @file{a.out}, the object file for
1271 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1272 assembler file in @file{@var{source}.s}, a precompiled header file in
1273 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1274 standard output.
1276 @item -v
1277 @opindex v
1278 Print (on standard error output) the commands executed to run the stages
1279 of compilation.  Also print the version number of the compiler driver
1280 program and of the preprocessor and the compiler proper.
1282 @item -###
1283 @opindex ###
1284 Like @option{-v} except the commands are not executed and arguments
1285 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1286 This is useful for shell scripts to capture the driver-generated command lines.
1288 @item -pipe
1289 @opindex pipe
1290 Use pipes rather than temporary files for communication between the
1291 various stages of compilation.  This fails to work on some systems where
1292 the assembler is unable to read from a pipe; but the GNU assembler has
1293 no trouble.
1295 @item --help
1296 @opindex help
1297 Print (on the standard output) a description of the command-line options
1298 understood by @command{gcc}.  If the @option{-v} option is also specified
1299 then @option{--help} is also passed on to the various processes
1300 invoked by @command{gcc}, so that they can display the command-line options
1301 they accept.  If the @option{-Wextra} option has also been specified
1302 (prior to the @option{--help} option), then command-line options that
1303 have no documentation associated with them are also displayed.
1305 @item --target-help
1306 @opindex target-help
1307 Print (on the standard output) a description of target-specific command-line
1308 options for each tool.  For some targets extra target-specific
1309 information may also be printed.
1311 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1312 Print (on the standard output) a description of the command-line
1313 options understood by the compiler that fit into all specified classes
1314 and qualifiers.  These are the supported classes:
1316 @table @asis
1317 @item @samp{optimizers}
1318 Display all of the optimization options supported by the
1319 compiler.
1321 @item @samp{warnings}
1322 Display all of the options controlling warning messages
1323 produced by the compiler.
1325 @item @samp{target}
1326 Display target-specific options.  Unlike the
1327 @option{--target-help} option however, target-specific options of the
1328 linker and assembler are not displayed.  This is because those
1329 tools do not currently support the extended @option{--help=} syntax.
1331 @item @samp{params}
1332 Display the values recognized by the @option{--param}
1333 option.
1335 @item @var{language}
1336 Display the options supported for @var{language}, where
1337 @var{language} is the name of one of the languages supported in this
1338 version of GCC@.
1340 @item @samp{common}
1341 Display the options that are common to all languages.
1342 @end table
1344 These are the supported qualifiers:
1346 @table @asis
1347 @item @samp{undocumented}
1348 Display only those options that are undocumented.
1350 @item @samp{joined}
1351 Display options taking an argument that appears after an equal
1352 sign in the same continuous piece of text, such as:
1353 @samp{--help=target}.
1355 @item @samp{separate}
1356 Display options taking an argument that appears as a separate word
1357 following the original option, such as: @samp{-o output-file}.
1358 @end table
1360 Thus for example to display all the undocumented target-specific
1361 switches supported by the compiler, use:
1363 @smallexample
1364 --help=target,undocumented
1365 @end smallexample
1367 The sense of a qualifier can be inverted by prefixing it with the
1368 @samp{^} character, so for example to display all binary warning
1369 options (i.e., ones that are either on or off and that do not take an
1370 argument) that have a description, use:
1372 @smallexample
1373 --help=warnings,^joined,^undocumented
1374 @end smallexample
1376 The argument to @option{--help=} should not consist solely of inverted
1377 qualifiers.
1379 Combining several classes is possible, although this usually
1380 restricts the output so much that there is nothing to display.  One
1381 case where it does work, however, is when one of the classes is
1382 @var{target}.  For example, to display all the target-specific
1383 optimization options, use:
1385 @smallexample
1386 --help=target,optimizers
1387 @end smallexample
1389 The @option{--help=} option can be repeated on the command line.  Each
1390 successive use displays its requested class of options, skipping
1391 those that have already been displayed.
1393 If the @option{-Q} option appears on the command line before the
1394 @option{--help=} option, then the descriptive text displayed by
1395 @option{--help=} is changed.  Instead of describing the displayed
1396 options, an indication is given as to whether the option is enabled,
1397 disabled or set to a specific value (assuming that the compiler
1398 knows this at the point where the @option{--help=} option is used).
1400 Here is a truncated example from the ARM port of @command{gcc}:
1402 @smallexample
1403   % gcc -Q -mabi=2 --help=target -c
1404   The following options are target specific:
1405   -mabi=                                2
1406   -mabort-on-noreturn                   [disabled]
1407   -mapcs                                [disabled]
1408 @end smallexample
1410 The output is sensitive to the effects of previous command-line
1411 options, so for example it is possible to find out which optimizations
1412 are enabled at @option{-O2} by using:
1414 @smallexample
1415 -Q -O2 --help=optimizers
1416 @end smallexample
1418 Alternatively you can discover which binary optimizations are enabled
1419 by @option{-O3} by using:
1421 @smallexample
1422 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1423 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1424 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1425 @end smallexample
1427 @item -no-canonical-prefixes
1428 @opindex no-canonical-prefixes
1429 Do not expand any symbolic links, resolve references to @samp{/../}
1430 or @samp{/./}, or make the path absolute when generating a relative
1431 prefix.
1433 @item --version
1434 @opindex version
1435 Display the version number and copyrights of the invoked GCC@.
1437 @item -wrapper
1438 @opindex wrapper
1439 Invoke all subcommands under a wrapper program.  The name of the
1440 wrapper program and its parameters are passed as a comma separated
1441 list.
1443 @smallexample
1444 gcc -c t.c -wrapper gdb,--args
1445 @end smallexample
1447 @noindent
1448 This invokes all subprograms of @command{gcc} under
1449 @samp{gdb --args}, thus the invocation of @command{cc1} is
1450 @samp{gdb --args cc1 @dots{}}.
1452 @item -fplugin=@var{name}.so
1453 Load the plugin code in file @var{name}.so, assumed to be a
1454 shared object to be dlopen'd by the compiler.  The base name of
1455 the shared object file is used to identify the plugin for the
1456 purposes of argument parsing (See
1457 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1458 Each plugin should define the callback functions specified in the
1459 Plugins API.
1461 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1462 Define an argument called @var{key} with a value of @var{value}
1463 for the plugin called @var{name}.
1465 @item -fdump-ada-spec@r{[}-slim@r{]}
1466 @opindex fdump-ada-spec
1467 For C and C++ source and include files, generate corresponding Ada specs.
1468 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1469 GNAT User's Guide}, which provides detailed documentation on this feature.
1471 @item -fada-spec-parent=@var{unit}
1472 @opindex fada-spec-parent
1473 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1474 Ada specs as child units of parent @var{unit}.
1476 @item -fdump-go-spec=@var{file}
1477 @opindex fdump-go-spec
1478 For input files in any language, generate corresponding Go
1479 declarations in @var{file}.  This generates Go @code{const},
1480 @code{type}, @code{var}, and @code{func} declarations which may be a
1481 useful way to start writing a Go interface to code written in some
1482 other language.
1484 @include @value{srcdir}/../libiberty/at-file.texi
1485 @end table
1487 @node Invoking G++
1488 @section Compiling C++ Programs
1490 @cindex suffixes for C++ source
1491 @cindex C++ source file suffixes
1492 C++ source files conventionally use one of the suffixes @samp{.C},
1493 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1494 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1495 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1496 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1497 files with these names and compiles them as C++ programs even if you
1498 call the compiler the same way as for compiling C programs (usually
1499 with the name @command{gcc}).
1501 @findex g++
1502 @findex c++
1503 However, the use of @command{gcc} does not add the C++ library.
1504 @command{g++} is a program that calls GCC and automatically specifies linking
1505 against the C++ library.  It treats @samp{.c},
1506 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1507 files unless @option{-x} is used.  This program is also useful when
1508 precompiling a C header file with a @samp{.h} extension for use in C++
1509 compilations.  On many systems, @command{g++} is also installed with
1510 the name @command{c++}.
1512 @cindex invoking @command{g++}
1513 When you compile C++ programs, you may specify many of the same
1514 command-line options that you use for compiling programs in any
1515 language; or command-line options meaningful for C and related
1516 languages; or options that are meaningful only for C++ programs.
1517 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1518 explanations of options for languages related to C@.
1519 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1520 explanations of options that are meaningful only for C++ programs.
1522 @node C Dialect Options
1523 @section Options Controlling C Dialect
1524 @cindex dialect options
1525 @cindex language dialect options
1526 @cindex options, dialect
1528 The following options control the dialect of C (or languages derived
1529 from C, such as C++, Objective-C and Objective-C++) that the compiler
1530 accepts:
1532 @table @gcctabopt
1533 @cindex ANSI support
1534 @cindex ISO support
1535 @item -ansi
1536 @opindex ansi
1537 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1538 equivalent to @option{-std=c++98}.
1540 This turns off certain features of GCC that are incompatible with ISO
1541 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1542 such as the @code{asm} and @code{typeof} keywords, and
1543 predefined macros such as @code{unix} and @code{vax} that identify the
1544 type of system you are using.  It also enables the undesirable and
1545 rarely used ISO trigraph feature.  For the C compiler,
1546 it disables recognition of C++ style @samp{//} comments as well as
1547 the @code{inline} keyword.
1549 The alternate keywords @code{__asm__}, @code{__extension__},
1550 @code{__inline__} and @code{__typeof__} continue to work despite
1551 @option{-ansi}.  You would not want to use them in an ISO C program, of
1552 course, but it is useful to put them in header files that might be included
1553 in compilations done with @option{-ansi}.  Alternate predefined macros
1554 such as @code{__unix__} and @code{__vax__} are also available, with or
1555 without @option{-ansi}.
1557 The @option{-ansi} option does not cause non-ISO programs to be
1558 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1559 addition to @option{-ansi}.  @xref{Warning Options}.
1561 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1562 option is used.  Some header files may notice this macro and refrain
1563 from declaring certain functions or defining certain macros that the
1564 ISO standard doesn't call for; this is to avoid interfering with any
1565 programs that might use these names for other things.
1567 Functions that are normally built in but do not have semantics
1568 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1569 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1570 built-in functions provided by GCC}, for details of the functions
1571 affected.
1573 @item -std=
1574 @opindex std
1575 Determine the language standard. @xref{Standards,,Language Standards
1576 Supported by GCC}, for details of these standard versions.  This option
1577 is currently only supported when compiling C or C++.
1579 The compiler can accept several base standards, such as @samp{c90} or
1580 @samp{c++98}, and GNU dialects of those standards, such as
1581 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1582 compiler accepts all programs following that standard plus those
1583 using GNU extensions that do not contradict it.  For example,
1584 @option{-std=c90} turns off certain features of GCC that are
1585 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1586 keywords, but not other GNU extensions that do not have a meaning in
1587 ISO C90, such as omitting the middle term of a @code{?:}
1588 expression. On the other hand, when a GNU dialect of a standard is
1589 specified, all features supported by the compiler are enabled, even when
1590 those features change the meaning of the base standard.  As a result, some
1591 strict-conforming programs may be rejected.  The particular standard
1592 is used by @option{-Wpedantic} to identify which features are GNU
1593 extensions given that version of the standard. For example
1594 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1595 comments, while @option{-std=gnu99 -Wpedantic} does not.
1597 A value for this option must be provided; possible values are
1599 @table @samp
1600 @item c90
1601 @itemx c89
1602 @itemx iso9899:1990
1603 Support all ISO C90 programs (certain GNU extensions that conflict
1604 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1606 @item iso9899:199409
1607 ISO C90 as modified in amendment 1.
1609 @item c99
1610 @itemx c9x
1611 @itemx iso9899:1999
1612 @itemx iso9899:199x
1613 ISO C99.  Note that this standard is not yet fully supported; see
1614 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1615 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1617 @item c11
1618 @itemx c1x
1619 @itemx iso9899:2011
1620 ISO C11, the 2011 revision of the ISO C standard.
1621 Support is incomplete and experimental.  The name @samp{c1x} is
1622 deprecated.
1624 @item gnu90
1625 @itemx gnu89
1626 GNU dialect of ISO C90 (including some C99 features). This
1627 is the default for C code.
1629 @item gnu99
1630 @itemx gnu9x
1631 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1632 this will become the default.  The name @samp{gnu9x} is deprecated.
1634 @item gnu11
1635 @itemx gnu1x
1636 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1637 name @samp{gnu1x} is deprecated.
1639 @item c++98
1640 @itemx c++03
1641 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1642 additional defect reports. Same as @option{-ansi} for C++ code.
1644 @item gnu++98
1645 @itemx gnu++03
1646 GNU dialect of @option{-std=c++98}.  This is the default for
1647 C++ code.
1649 @item c++11
1650 @itemx c++0x
1651 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1652 experimental, and may change in incompatible ways in future releases.
1653 The name @samp{c++0x} is deprecated.
1655 @item gnu++11
1656 @itemx gnu++0x
1657 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1658 experimental, and may change in incompatible ways in future releases.
1659 The name @samp{gnu++0x} is deprecated.
1661 @item c++1y
1662 The next revision of the ISO C++ standard, tentatively planned for
1663 2017.  Support is highly experimental, and will almost certainly
1664 change in incompatible ways in future releases.
1666 @item gnu++1y
1667 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1668 and will almost certainly change in incompatible ways in future
1669 releases.
1670 @end table
1672 @item -fgnu89-inline
1673 @opindex fgnu89-inline
1674 The option @option{-fgnu89-inline} tells GCC to use the traditional
1675 GNU semantics for @code{inline} functions when in C99 mode.
1676 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1677 is accepted and ignored by GCC versions 4.1.3 up to but not including
1678 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1679 C99 mode.  Using this option is roughly equivalent to adding the
1680 @code{gnu_inline} function attribute to all inline functions
1681 (@pxref{Function Attributes}).
1683 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1684 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1685 specifies the default behavior).  This option was first supported in
1686 GCC 4.3.  This option is not supported in @option{-std=c90} or
1687 @option{-std=gnu90} mode.
1689 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1690 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1691 in effect for @code{inline} functions.  @xref{Common Predefined
1692 Macros,,,cpp,The C Preprocessor}.
1694 @item -aux-info @var{filename}
1695 @opindex aux-info
1696 Output to the given filename prototyped declarations for all functions
1697 declared and/or defined in a translation unit, including those in header
1698 files.  This option is silently ignored in any language other than C@.
1700 Besides declarations, the file indicates, in comments, the origin of
1701 each declaration (source file and line), whether the declaration was
1702 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1703 @samp{O} for old, respectively, in the first character after the line
1704 number and the colon), and whether it came from a declaration or a
1705 definition (@samp{C} or @samp{F}, respectively, in the following
1706 character).  In the case of function definitions, a K&R-style list of
1707 arguments followed by their declarations is also provided, inside
1708 comments, after the declaration.
1710 @item -fallow-parameterless-variadic-functions
1711 Accept variadic functions without named parameters.
1713 Although it is possible to define such a function, this is not very
1714 useful as it is not possible to read the arguments.  This is only
1715 supported for C as this construct is allowed by C++.
1717 @item -fno-asm
1718 @opindex fno-asm
1719 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1720 keyword, so that code can use these words as identifiers.  You can use
1721 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1722 instead.  @option{-ansi} implies @option{-fno-asm}.
1724 In C++, this switch only affects the @code{typeof} keyword, since
1725 @code{asm} and @code{inline} are standard keywords.  You may want to
1726 use the @option{-fno-gnu-keywords} flag instead, which has the same
1727 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1728 switch only affects the @code{asm} and @code{typeof} keywords, since
1729 @code{inline} is a standard keyword in ISO C99.
1731 @item -fno-builtin
1732 @itemx -fno-builtin-@var{function}
1733 @opindex fno-builtin
1734 @cindex built-in functions
1735 Don't recognize built-in functions that do not begin with
1736 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1737 functions provided by GCC}, for details of the functions affected,
1738 including those which are not built-in functions when @option{-ansi} or
1739 @option{-std} options for strict ISO C conformance are used because they
1740 do not have an ISO standard meaning.
1742 GCC normally generates special code to handle certain built-in functions
1743 more efficiently; for instance, calls to @code{alloca} may become single
1744 instructions which adjust the stack directly, and calls to @code{memcpy}
1745 may become inline copy loops.  The resulting code is often both smaller
1746 and faster, but since the function calls no longer appear as such, you
1747 cannot set a breakpoint on those calls, nor can you change the behavior
1748 of the functions by linking with a different library.  In addition,
1749 when a function is recognized as a built-in function, GCC may use
1750 information about that function to warn about problems with calls to
1751 that function, or to generate more efficient code, even if the
1752 resulting code still contains calls to that function.  For example,
1753 warnings are given with @option{-Wformat} for bad calls to
1754 @code{printf} when @code{printf} is built in and @code{strlen} is
1755 known not to modify global memory.
1757 With the @option{-fno-builtin-@var{function}} option
1758 only the built-in function @var{function} is
1759 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1760 function is named that is not built-in in this version of GCC, this
1761 option is ignored.  There is no corresponding
1762 @option{-fbuiltin-@var{function}} option; if you wish to enable
1763 built-in functions selectively when using @option{-fno-builtin} or
1764 @option{-ffreestanding}, you may define macros such as:
1766 @smallexample
1767 #define abs(n)          __builtin_abs ((n))
1768 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1769 @end smallexample
1771 @item -fhosted
1772 @opindex fhosted
1773 @cindex hosted environment
1775 Assert that compilation targets a hosted environment.  This implies
1776 @option{-fbuiltin}.  A hosted environment is one in which the
1777 entire standard library is available, and in which @code{main} has a return
1778 type of @code{int}.  Examples are nearly everything except a kernel.
1779 This is equivalent to @option{-fno-freestanding}.
1781 @item -ffreestanding
1782 @opindex ffreestanding
1783 @cindex hosted environment
1785 Assert that compilation targets a freestanding environment.  This
1786 implies @option{-fno-builtin}.  A freestanding environment
1787 is one in which the standard library may not exist, and program startup may
1788 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1789 This is equivalent to @option{-fno-hosted}.
1791 @xref{Standards,,Language Standards Supported by GCC}, for details of
1792 freestanding and hosted environments.
1794 @item -fopenmp
1795 @opindex fopenmp
1796 @cindex OpenMP parallel
1797 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1798 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1799 compiler generates parallel code according to the OpenMP Application
1800 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1801 implies @option{-pthread}, and thus is only supported on targets that
1802 have support for @option{-pthread}.
1804 @item -fgnu-tm
1805 @opindex fgnu-tm
1806 When the option @option{-fgnu-tm} is specified, the compiler
1807 generates code for the Linux variant of Intel's current Transactional
1808 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1809 an experimental feature whose interface may change in future versions
1810 of GCC, as the official specification changes.  Please note that not
1811 all architectures are supported for this feature.
1813 For more information on GCC's support for transactional memory,
1814 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1815 Transactional Memory Library}.
1817 Note that the transactional memory feature is not supported with
1818 non-call exceptions (@option{-fnon-call-exceptions}).
1820 @item -fms-extensions
1821 @opindex fms-extensions
1822 Accept some non-standard constructs used in Microsoft header files.
1824 In C++ code, this allows member names in structures to be similar
1825 to previous types declarations.
1827 @smallexample
1828 typedef int UOW;
1829 struct ABC @{
1830   UOW UOW;
1832 @end smallexample
1834 Some cases of unnamed fields in structures and unions are only
1835 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1836 fields within structs/unions}, for details.
1838 @item -fplan9-extensions
1839 Accept some non-standard constructs used in Plan 9 code.
1841 This enables @option{-fms-extensions}, permits passing pointers to
1842 structures with anonymous fields to functions that expect pointers to
1843 elements of the type of the field, and permits referring to anonymous
1844 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1845 struct/union fields within structs/unions}, for details.  This is only
1846 supported for C, not C++.
1848 @item -trigraphs
1849 @opindex trigraphs
1850 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1851 options for strict ISO C conformance) implies @option{-trigraphs}.
1853 @cindex traditional C language
1854 @cindex C language, traditional
1855 @item -traditional
1856 @itemx -traditional-cpp
1857 @opindex traditional-cpp
1858 @opindex traditional
1859 Formerly, these options caused GCC to attempt to emulate a pre-standard
1860 C compiler.  They are now only supported with the @option{-E} switch.
1861 The preprocessor continues to support a pre-standard mode.  See the GNU
1862 CPP manual for details.
1864 @item -fcond-mismatch
1865 @opindex fcond-mismatch
1866 Allow conditional expressions with mismatched types in the second and
1867 third arguments.  The value of such an expression is void.  This option
1868 is not supported for C++.
1870 @item -flax-vector-conversions
1871 @opindex flax-vector-conversions
1872 Allow implicit conversions between vectors with differing numbers of
1873 elements and/or incompatible element types.  This option should not be
1874 used for new code.
1876 @item -funsigned-char
1877 @opindex funsigned-char
1878 Let the type @code{char} be unsigned, like @code{unsigned char}.
1880 Each kind of machine has a default for what @code{char} should
1881 be.  It is either like @code{unsigned char} by default or like
1882 @code{signed char} by default.
1884 Ideally, a portable program should always use @code{signed char} or
1885 @code{unsigned char} when it depends on the signedness of an object.
1886 But many programs have been written to use plain @code{char} and
1887 expect it to be signed, or expect it to be unsigned, depending on the
1888 machines they were written for.  This option, and its inverse, let you
1889 make such a program work with the opposite default.
1891 The type @code{char} is always a distinct type from each of
1892 @code{signed char} or @code{unsigned char}, even though its behavior
1893 is always just like one of those two.
1895 @item -fsigned-char
1896 @opindex fsigned-char
1897 Let the type @code{char} be signed, like @code{signed char}.
1899 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1900 the negative form of @option{-funsigned-char}.  Likewise, the option
1901 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1903 @item -fsigned-bitfields
1904 @itemx -funsigned-bitfields
1905 @itemx -fno-signed-bitfields
1906 @itemx -fno-unsigned-bitfields
1907 @opindex fsigned-bitfields
1908 @opindex funsigned-bitfields
1909 @opindex fno-signed-bitfields
1910 @opindex fno-unsigned-bitfields
1911 These options control whether a bit-field is signed or unsigned, when the
1912 declaration does not use either @code{signed} or @code{unsigned}.  By
1913 default, such a bit-field is signed, because this is consistent: the
1914 basic integer types such as @code{int} are signed types.
1915 @end table
1917 @node C++ Dialect Options
1918 @section Options Controlling C++ Dialect
1920 @cindex compiler options, C++
1921 @cindex C++ options, command-line
1922 @cindex options, C++
1923 This section describes the command-line options that are only meaningful
1924 for C++ programs.  You can also use most of the GNU compiler options
1925 regardless of what language your program is in.  For example, you
1926 might compile a file @code{firstClass.C} like this:
1928 @smallexample
1929 g++ -g -frepo -O -c firstClass.C
1930 @end smallexample
1932 @noindent
1933 In this example, only @option{-frepo} is an option meant
1934 only for C++ programs; you can use the other options with any
1935 language supported by GCC@.
1937 Here is a list of options that are @emph{only} for compiling C++ programs:
1939 @table @gcctabopt
1941 @item -fabi-version=@var{n}
1942 @opindex fabi-version
1943 Use version @var{n} of the C++ ABI@.  The default is version 2.
1945 Version 0 refers to the version conforming most closely to
1946 the C++ ABI specification.  Therefore, the ABI obtained using version 0
1947 will change in different versions of G++ as ABI bugs are fixed.
1949 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
1951 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.  
1953 Version 3 corrects an error in mangling a constant address as a
1954 template argument.
1956 Version 4, which first appeared in G++ 4.5, implements a standard
1957 mangling for vector types.
1959 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1960 attribute const/volatile on function pointer types, decltype of a
1961 plain decl, and use of a function parameter in the declaration of
1962 another parameter.
1964 Version 6, which first appeared in G++ 4.7, corrects the promotion
1965 behavior of C++11 scoped enums and the mangling of template argument
1966 packs, const/static_cast, prefix ++ and --, and a class scope function
1967 used as a template argument.
1969 See also @option{-Wabi}.
1971 @item -fno-access-control
1972 @opindex fno-access-control
1973 Turn off all access checking.  This switch is mainly useful for working
1974 around bugs in the access control code.
1976 @item -fcheck-new
1977 @opindex fcheck-new
1978 Check that the pointer returned by @code{operator new} is non-null
1979 before attempting to modify the storage allocated.  This check is
1980 normally unnecessary because the C++ standard specifies that
1981 @code{operator new} only returns @code{0} if it is declared
1982 @samp{throw()}, in which case the compiler always checks the
1983 return value even without this option.  In all other cases, when
1984 @code{operator new} has a non-empty exception specification, memory
1985 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1986 @samp{new (nothrow)}.
1988 @item -fconstexpr-depth=@var{n}
1989 @opindex fconstexpr-depth
1990 Set the maximum nested evaluation depth for C++11 constexpr functions
1991 to @var{n}.  A limit is needed to detect endless recursion during
1992 constant expression evaluation.  The minimum specified by the standard
1993 is 512.
1995 @item -fdeduce-init-list
1996 @opindex fdeduce-init-list
1997 Enable deduction of a template type parameter as
1998 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2000 @smallexample
2001 template <class T> auto forward(T t) -> decltype (realfn (t))
2003   return realfn (t);
2006 void f()
2008   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2010 @end smallexample
2012 This deduction was implemented as a possible extension to the
2013 originally proposed semantics for the C++11 standard, but was not part
2014 of the final standard, so it is disabled by default.  This option is
2015 deprecated, and may be removed in a future version of G++.
2017 @item -ffriend-injection
2018 @opindex ffriend-injection
2019 Inject friend functions into the enclosing namespace, so that they are
2020 visible outside the scope of the class in which they are declared.
2021 Friend functions were documented to work this way in the old Annotated
2022 C++ Reference Manual, and versions of G++ before 4.1 always worked
2023 that way.  However, in ISO C++ a friend function that is not declared
2024 in an enclosing scope can only be found using argument dependent
2025 lookup.  This option causes friends to be injected as they were in
2026 earlier releases.
2028 This option is for compatibility, and may be removed in a future
2029 release of G++.
2031 @item -fno-elide-constructors
2032 @opindex fno-elide-constructors
2033 The C++ standard allows an implementation to omit creating a temporary
2034 that is only used to initialize another object of the same type.
2035 Specifying this option disables that optimization, and forces G++ to
2036 call the copy constructor in all cases.
2038 @item -fno-enforce-eh-specs
2039 @opindex fno-enforce-eh-specs
2040 Don't generate code to check for violation of exception specifications
2041 at run time.  This option violates the C++ standard, but may be useful
2042 for reducing code size in production builds, much like defining
2043 @samp{NDEBUG}.  This does not give user code permission to throw
2044 exceptions in violation of the exception specifications; the compiler
2045 still optimizes based on the specifications, so throwing an
2046 unexpected exception results in undefined behavior at run time.
2048 @item -fextern-tls-init
2049 @itemx -fno-extern-tls-init
2050 @opindex fextern-tls-init
2051 @opindex fno-extern-tls-init
2052 The C++11 and OpenMP standards allow @samp{thread_local} and
2053 @samp{threadprivate} variables to have dynamic (runtime)
2054 initialization.  To support this, any use of such a variable goes
2055 through a wrapper function that performs any necessary initialization.
2056 When the use and definition of the variable are in the same
2057 translation unit, this overhead can be optimized away, but when the
2058 use is in a different translation unit there is significant overhead
2059 even if the variable doesn't actually need dynamic initialization.  If
2060 the programmer can be sure that no use of the variable in a
2061 non-defining TU needs to trigger dynamic initialization (either
2062 because the variable is statically initialized, or a use of the
2063 variable in the defining TU will be executed before any uses in
2064 another TU), they can avoid this overhead with the
2065 @option{-fno-extern-tls-init} option.
2067 On targets that support symbol aliases, the default is
2068 @option{-fextern-tls-init}.  On targets that do not support symbol
2069 aliases, the default is @option{-fno-extern-tls-init}.
2071 @item -ffor-scope
2072 @itemx -fno-for-scope
2073 @opindex ffor-scope
2074 @opindex fno-for-scope
2075 If @option{-ffor-scope} is specified, the scope of variables declared in
2076 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2077 as specified by the C++ standard.
2078 If @option{-fno-for-scope} is specified, the scope of variables declared in
2079 a @i{for-init-statement} extends to the end of the enclosing scope,
2080 as was the case in old versions of G++, and other (traditional)
2081 implementations of C++.
2083 If neither flag is given, the default is to follow the standard,
2084 but to allow and give a warning for old-style code that would
2085 otherwise be invalid, or have different behavior.
2087 @item -fno-gnu-keywords
2088 @opindex fno-gnu-keywords
2089 Do not recognize @code{typeof} as a keyword, so that code can use this
2090 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2091 @option{-ansi} implies @option{-fno-gnu-keywords}.
2093 @item -fno-implicit-templates
2094 @opindex fno-implicit-templates
2095 Never emit code for non-inline templates that are instantiated
2096 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2097 @xref{Template Instantiation}, for more information.
2099 @item -fno-implicit-inline-templates
2100 @opindex fno-implicit-inline-templates
2101 Don't emit code for implicit instantiations of inline templates, either.
2102 The default is to handle inlines differently so that compiles with and
2103 without optimization need the same set of explicit instantiations.
2105 @item -fno-implement-inlines
2106 @opindex fno-implement-inlines
2107 To save space, do not emit out-of-line copies of inline functions
2108 controlled by @samp{#pragma implementation}.  This causes linker
2109 errors if these functions are not inlined everywhere they are called.
2111 @item -fms-extensions
2112 @opindex fms-extensions
2113 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2114 int and getting a pointer to member function via non-standard syntax.
2116 @item -fno-nonansi-builtins
2117 @opindex fno-nonansi-builtins
2118 Disable built-in declarations of functions that are not mandated by
2119 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2120 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2122 @item -fnothrow-opt
2123 @opindex fnothrow-opt
2124 Treat a @code{throw()} exception specification as if it were a
2125 @code{noexcept} specification to reduce or eliminate the text size
2126 overhead relative to a function with no exception specification.  If
2127 the function has local variables of types with non-trivial
2128 destructors, the exception specification actually makes the
2129 function smaller because the EH cleanups for those variables can be
2130 optimized away.  The semantic effect is that an exception thrown out of
2131 a function with such an exception specification results in a call
2132 to @code{terminate} rather than @code{unexpected}.
2134 @item -fno-operator-names
2135 @opindex fno-operator-names
2136 Do not treat the operator name keywords @code{and}, @code{bitand},
2137 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2138 synonyms as keywords.
2140 @item -fno-optional-diags
2141 @opindex fno-optional-diags
2142 Disable diagnostics that the standard says a compiler does not need to
2143 issue.  Currently, the only such diagnostic issued by G++ is the one for
2144 a name having multiple meanings within a class.
2146 @item -fpermissive
2147 @opindex fpermissive
2148 Downgrade some diagnostics about nonconformant code from errors to
2149 warnings.  Thus, using @option{-fpermissive} allows some
2150 nonconforming code to compile.
2152 @item -fno-pretty-templates
2153 @opindex fno-pretty-templates
2154 When an error message refers to a specialization of a function
2155 template, the compiler normally prints the signature of the
2156 template followed by the template arguments and any typedefs or
2157 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2158 rather than @code{void f(int)}) so that it's clear which template is
2159 involved.  When an error message refers to a specialization of a class
2160 template, the compiler omits any template arguments that match
2161 the default template arguments for that template.  If either of these
2162 behaviors make it harder to understand the error message rather than
2163 easier, you can use @option{-fno-pretty-templates} to disable them.
2165 @item -frepo
2166 @opindex frepo
2167 Enable automatic template instantiation at link time.  This option also
2168 implies @option{-fno-implicit-templates}.  @xref{Template
2169 Instantiation}, for more information.
2171 @item -fno-rtti
2172 @opindex fno-rtti
2173 Disable generation of information about every class with virtual
2174 functions for use by the C++ run-time type identification features
2175 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2176 of the language, you can save some space by using this flag.  Note that
2177 exception handling uses the same information, but G++ generates it as
2178 needed. The @samp{dynamic_cast} operator can still be used for casts that
2179 do not require run-time type information, i.e.@: casts to @code{void *} or to
2180 unambiguous base classes.
2182 @item -fstats
2183 @opindex fstats
2184 Emit statistics about front-end processing at the end of the compilation.
2185 This information is generally only useful to the G++ development team.
2187 @item -fstrict-enums
2188 @opindex fstrict-enums
2189 Allow the compiler to optimize using the assumption that a value of
2190 enumerated type can only be one of the values of the enumeration (as
2191 defined in the C++ standard; basically, a value that can be
2192 represented in the minimum number of bits needed to represent all the
2193 enumerators).  This assumption may not be valid if the program uses a
2194 cast to convert an arbitrary integer value to the enumerated type.
2196 @item -ftemplate-backtrace-limit=@var{n}
2197 @opindex ftemplate-backtrace-limit
2198 Set the maximum number of template instantiation notes for a single
2199 warning or error to @var{n}.  The default value is 10.
2201 @item -ftemplate-depth=@var{n}
2202 @opindex ftemplate-depth
2203 Set the maximum instantiation depth for template classes to @var{n}.
2204 A limit on the template instantiation depth is needed to detect
2205 endless recursions during template class instantiation.  ANSI/ISO C++
2206 conforming programs must not rely on a maximum depth greater than 17
2207 (changed to 1024 in C++11).  The default value is 900, as the compiler
2208 can run out of stack space before hitting 1024 in some situations.
2210 @item -fno-threadsafe-statics
2211 @opindex fno-threadsafe-statics
2212 Do not emit the extra code to use the routines specified in the C++
2213 ABI for thread-safe initialization of local statics.  You can use this
2214 option to reduce code size slightly in code that doesn't need to be
2215 thread-safe.
2217 @item -fuse-cxa-atexit
2218 @opindex fuse-cxa-atexit
2219 Register destructors for objects with static storage duration with the
2220 @code{__cxa_atexit} function rather than the @code{atexit} function.
2221 This option is required for fully standards-compliant handling of static
2222 destructors, but only works if your C library supports
2223 @code{__cxa_atexit}.
2225 @item -fno-use-cxa-get-exception-ptr
2226 @opindex fno-use-cxa-get-exception-ptr
2227 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2228 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2229 if the runtime routine is not available.
2231 @item -fvisibility-inlines-hidden
2232 @opindex fvisibility-inlines-hidden
2233 This switch declares that the user does not attempt to compare
2234 pointers to inline functions or methods where the addresses of the two functions
2235 are taken in different shared objects.
2237 The effect of this is that GCC may, effectively, mark inline methods with
2238 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2239 appear in the export table of a DSO and do not require a PLT indirection
2240 when used within the DSO@.  Enabling this option can have a dramatic effect
2241 on load and link times of a DSO as it massively reduces the size of the
2242 dynamic export table when the library makes heavy use of templates.
2244 The behavior of this switch is not quite the same as marking the
2245 methods as hidden directly, because it does not affect static variables
2246 local to the function or cause the compiler to deduce that
2247 the function is defined in only one shared object.
2249 You may mark a method as having a visibility explicitly to negate the
2250 effect of the switch for that method.  For example, if you do want to
2251 compare pointers to a particular inline method, you might mark it as
2252 having default visibility.  Marking the enclosing class with explicit
2253 visibility has no effect.
2255 Explicitly instantiated inline methods are unaffected by this option
2256 as their linkage might otherwise cross a shared library boundary.
2257 @xref{Template Instantiation}.
2259 @item -fvisibility-ms-compat
2260 @opindex fvisibility-ms-compat
2261 This flag attempts to use visibility settings to make GCC's C++
2262 linkage model compatible with that of Microsoft Visual Studio.
2264 The flag makes these changes to GCC's linkage model:
2266 @enumerate
2267 @item
2268 It sets the default visibility to @code{hidden}, like
2269 @option{-fvisibility=hidden}.
2271 @item
2272 Types, but not their members, are not hidden by default.
2274 @item
2275 The One Definition Rule is relaxed for types without explicit
2276 visibility specifications that are defined in more than one
2277 shared object: those declarations are permitted if they are
2278 permitted when this option is not used.
2279 @end enumerate
2281 In new code it is better to use @option{-fvisibility=hidden} and
2282 export those classes that are intended to be externally visible.
2283 Unfortunately it is possible for code to rely, perhaps accidentally,
2284 on the Visual Studio behavior.
2286 Among the consequences of these changes are that static data members
2287 of the same type with the same name but defined in different shared
2288 objects are different, so changing one does not change the other;
2289 and that pointers to function members defined in different shared
2290 objects may not compare equal.  When this flag is given, it is a
2291 violation of the ODR to define types with the same name differently.
2293 @item -fno-weak
2294 @opindex fno-weak
2295 Do not use weak symbol support, even if it is provided by the linker.
2296 By default, G++ uses weak symbols if they are available.  This
2297 option exists only for testing, and should not be used by end-users;
2298 it results in inferior code and has no benefits.  This option may
2299 be removed in a future release of G++.
2301 @item -nostdinc++
2302 @opindex nostdinc++
2303 Do not search for header files in the standard directories specific to
2304 C++, but do still search the other standard directories.  (This option
2305 is used when building the C++ library.)
2306 @end table
2308 In addition, these optimization, warning, and code generation options
2309 have meanings only for C++ programs:
2311 @table @gcctabopt
2312 @item -fno-default-inline
2313 @opindex fno-default-inline
2314 Do not assume @samp{inline} for functions defined inside a class scope.
2315 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2316 functions have linkage like inline functions; they just aren't
2317 inlined by default.
2319 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2320 @opindex Wabi
2321 @opindex Wno-abi
2322 Warn when G++ generates code that is probably not compatible with the
2323 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2324 all such cases, there are probably some cases that are not warned about,
2325 even though G++ is generating incompatible code.  There may also be
2326 cases where warnings are emitted even though the code that is generated
2327 is compatible.
2329 You should rewrite your code to avoid these warnings if you are
2330 concerned about the fact that code generated by G++ may not be binary
2331 compatible with code generated by other compilers.
2333 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2335 @itemize @bullet
2337 @item
2338 A template with a non-type template parameter of reference type is
2339 mangled incorrectly:
2340 @smallexample
2341 extern int N;
2342 template <int &> struct S @{@};
2343 void n (S<N>) @{2@}
2344 @end smallexample
2346 This is fixed in @option{-fabi-version=3}.
2348 @item
2349 SIMD vector types declared using @code{__attribute ((vector_size))} are
2350 mangled in a non-standard way that does not allow for overloading of
2351 functions taking vectors of different sizes.
2353 The mangling is changed in @option{-fabi-version=4}.
2354 @end itemize
2356 The known incompatibilities in @option{-fabi-version=1} include:
2358 @itemize @bullet
2360 @item
2361 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2362 pack data into the same byte as a base class.  For example:
2364 @smallexample
2365 struct A @{ virtual void f(); int f1 : 1; @};
2366 struct B : public A @{ int f2 : 1; @};
2367 @end smallexample
2369 @noindent
2370 In this case, G++ places @code{B::f2} into the same byte
2371 as @code{A::f1}; other compilers do not.  You can avoid this problem
2372 by explicitly padding @code{A} so that its size is a multiple of the
2373 byte size on your platform; that causes G++ and other compilers to
2374 lay out @code{B} identically.
2376 @item
2377 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2378 tail padding when laying out virtual bases.  For example:
2380 @smallexample
2381 struct A @{ virtual void f(); char c1; @};
2382 struct B @{ B(); char c2; @};
2383 struct C : public A, public virtual B @{@};
2384 @end smallexample
2386 @noindent
2387 In this case, G++ does not place @code{B} into the tail-padding for
2388 @code{A}; other compilers do.  You can avoid this problem by
2389 explicitly padding @code{A} so that its size is a multiple of its
2390 alignment (ignoring virtual base classes); that causes G++ and other
2391 compilers to lay out @code{C} identically.
2393 @item
2394 Incorrect handling of bit-fields with declared widths greater than that
2395 of their underlying types, when the bit-fields appear in a union.  For
2396 example:
2398 @smallexample
2399 union U @{ int i : 4096; @};
2400 @end smallexample
2402 @noindent
2403 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2404 union too small by the number of bits in an @code{int}.
2406 @item
2407 Empty classes can be placed at incorrect offsets.  For example:
2409 @smallexample
2410 struct A @{@};
2412 struct B @{
2413   A a;
2414   virtual void f ();
2417 struct C : public B, public A @{@};
2418 @end smallexample
2420 @noindent
2421 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2422 it should be placed at offset zero.  G++ mistakenly believes that the
2423 @code{A} data member of @code{B} is already at offset zero.
2425 @item
2426 Names of template functions whose types involve @code{typename} or
2427 template template parameters can be mangled incorrectly.
2429 @smallexample
2430 template <typename Q>
2431 void f(typename Q::X) @{@}
2433 template <template <typename> class Q>
2434 void f(typename Q<int>::X) @{@}
2435 @end smallexample
2437 @noindent
2438 Instantiations of these templates may be mangled incorrectly.
2440 @end itemize
2442 It also warns about psABI-related changes.  The known psABI changes at this
2443 point include:
2445 @itemize @bullet
2447 @item
2448 For SysV/x86-64, unions with @code{long double} members are 
2449 passed in memory as specified in psABI.  For example:
2451 @smallexample
2452 union U @{
2453   long double ld;
2454   int i;
2456 @end smallexample
2458 @noindent
2459 @code{union U} is always passed in memory.
2461 @end itemize
2463 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2464 @opindex Wctor-dtor-privacy
2465 @opindex Wno-ctor-dtor-privacy
2466 Warn when a class seems unusable because all the constructors or
2467 destructors in that class are private, and it has neither friends nor
2468 public static member functions.  Also warn if there are no non-private
2469 methods, and there's at least one private member function that isn't
2470 a constructor or destructor.
2472 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2473 @opindex Wdelete-non-virtual-dtor
2474 @opindex Wno-delete-non-virtual-dtor
2475 Warn when @samp{delete} is used to destroy an instance of a class that
2476 has virtual functions and non-virtual destructor. It is unsafe to delete
2477 an instance of a derived class through a pointer to a base class if the
2478 base class does not have a virtual destructor.  This warning is enabled
2479 by @option{-Wall}.
2481 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2482 @opindex Wliteral-suffix
2483 @opindex Wno-literal-suffix
2484 Warn when a string or character literal is followed by a ud-suffix which does
2485 not begin with an underscore.  As a conforming extension, GCC treats such
2486 suffixes as separate preprocessing tokens in order to maintain backwards
2487 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2488 For example:
2490 @smallexample
2491 #define __STDC_FORMAT_MACROS
2492 #include <inttypes.h>
2493 #include <stdio.h>
2495 int main() @{
2496   int64_t i64 = 123;
2497   printf("My int64: %"PRId64"\n", i64);
2499 @end smallexample
2501 In this case, @code{PRId64} is treated as a separate preprocessing token.
2503 This warning is enabled by default.
2505 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2506 @opindex Wnarrowing
2507 @opindex Wno-narrowing
2508 Warn when a narrowing conversion prohibited by C++11 occurs within
2509 @samp{@{ @}}, e.g.
2511 @smallexample
2512 int i = @{ 2.2 @}; // error: narrowing from double to int
2513 @end smallexample
2515 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2517 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2518 required by the standard.  Note that this does not affect the meaning
2519 of well-formed code; narrowing conversions are still considered
2520 ill-formed in SFINAE context.
2522 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2523 @opindex Wnoexcept
2524 @opindex Wno-noexcept
2525 Warn when a noexcept-expression evaluates to false because of a call
2526 to a function that does not have a non-throwing exception
2527 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2528 the compiler to never throw an exception.
2530 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2531 @opindex Wnon-virtual-dtor
2532 @opindex Wno-non-virtual-dtor
2533 Warn when a class has virtual functions and an accessible non-virtual
2534 destructor, in which case it is possible but unsafe to delete
2535 an instance of a derived class through a pointer to the base class.
2536 This warning is also enabled if @option{-Weffc++} is specified.
2538 @item -Wreorder @r{(C++ and Objective-C++ only)}
2539 @opindex Wreorder
2540 @opindex Wno-reorder
2541 @cindex reordering, warning
2542 @cindex warning for reordering of member initializers
2543 Warn when the order of member initializers given in the code does not
2544 match the order in which they must be executed.  For instance:
2546 @smallexample
2547 struct A @{
2548   int i;
2549   int j;
2550   A(): j (0), i (1) @{ @}
2552 @end smallexample
2554 @noindent
2555 The compiler rearranges the member initializers for @samp{i}
2556 and @samp{j} to match the declaration order of the members, emitting
2557 a warning to that effect.  This warning is enabled by @option{-Wall}.
2559 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2560 @opindex fext-numeric-literals
2561 @opindex fno-ext-numeric-literals
2562 Accept imaginary, fixed-point, or machine-defined
2563 literal number suffixes as GNU extensions.
2564 When this option is turned off these suffixes are treated
2565 as C++11 user-defined literal numeric suffixes.
2566 This is on by default for all pre-C++11 dialects and all GNU dialects:
2567 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2568 @option{-std=gnu++1y}.
2569 This option is off by default
2570 for ISO C++11 onwards (@option{-std=c++11}, ...).
2571 @end table
2573 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2575 @table @gcctabopt
2576 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2577 @opindex Weffc++
2578 @opindex Wno-effc++
2579 Warn about violations of the following style guidelines from Scott Meyers'
2580 @cite{Effective C++, Second Edition} book:
2582 @itemize @bullet
2583 @item
2584 Item 11:  Define a copy constructor and an assignment operator for classes
2585 with dynamically-allocated memory.
2587 @item
2588 Item 12:  Prefer initialization to assignment in constructors.
2590 @item
2591 Item 14:  Make destructors virtual in base classes.
2593 @item
2594 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2596 @item
2597 Item 23:  Don't try to return a reference when you must return an object.
2599 @end itemize
2601 Also warn about violations of the following style guidelines from
2602 Scott Meyers' @cite{More Effective C++} book:
2604 @itemize @bullet
2605 @item
2606 Item 6:  Distinguish between prefix and postfix forms of increment and
2607 decrement operators.
2609 @item
2610 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2612 @end itemize
2614 When selecting this option, be aware that the standard library
2615 headers do not obey all of these guidelines; use @samp{grep -v}
2616 to filter out those warnings.
2618 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2619 @opindex Wstrict-null-sentinel
2620 @opindex Wno-strict-null-sentinel
2621 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2622 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2623 to @code{__null}.  Although it is a null pointer constant rather than a
2624 null pointer, it is guaranteed to be of the same size as a pointer.
2625 But this use is not portable across different compilers.
2627 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2628 @opindex Wno-non-template-friend
2629 @opindex Wnon-template-friend
2630 Disable warnings when non-templatized friend functions are declared
2631 within a template.  Since the advent of explicit template specification
2632 support in G++, if the name of the friend is an unqualified-id (i.e.,
2633 @samp{friend foo(int)}), the C++ language specification demands that the
2634 friend declare or define an ordinary, nontemplate function.  (Section
2635 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2636 could be interpreted as a particular specialization of a templatized
2637 function.  Because this non-conforming behavior is no longer the default
2638 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2639 check existing code for potential trouble spots and is on by default.
2640 This new compiler behavior can be turned off with
2641 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2642 but disables the helpful warning.
2644 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2645 @opindex Wold-style-cast
2646 @opindex Wno-old-style-cast
2647 Warn if an old-style (C-style) cast to a non-void type is used within
2648 a C++ program.  The new-style casts (@samp{dynamic_cast},
2649 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2650 less vulnerable to unintended effects and much easier to search for.
2652 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2653 @opindex Woverloaded-virtual
2654 @opindex Wno-overloaded-virtual
2655 @cindex overloaded virtual function, warning
2656 @cindex warning for overloaded virtual function
2657 Warn when a function declaration hides virtual functions from a
2658 base class.  For example, in:
2660 @smallexample
2661 struct A @{
2662   virtual void f();
2665 struct B: public A @{
2666   void f(int);
2668 @end smallexample
2670 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2671 like:
2673 @smallexample
2674 B* b;
2675 b->f();
2676 @end smallexample
2678 @noindent
2679 fails to compile.
2681 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2682 @opindex Wno-pmf-conversions
2683 @opindex Wpmf-conversions
2684 Disable the diagnostic for converting a bound pointer to member function
2685 to a plain pointer.
2687 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2688 @opindex Wsign-promo
2689 @opindex Wno-sign-promo
2690 Warn when overload resolution chooses a promotion from unsigned or
2691 enumerated type to a signed type, over a conversion to an unsigned type of
2692 the same size.  Previous versions of G++ tried to preserve
2693 unsignedness, but the standard mandates the current behavior.
2694 @end table
2696 @node Objective-C and Objective-C++ Dialect Options
2697 @section Options Controlling Objective-C and Objective-C++ Dialects
2699 @cindex compiler options, Objective-C and Objective-C++
2700 @cindex Objective-C and Objective-C++ options, command-line
2701 @cindex options, Objective-C and Objective-C++
2702 (NOTE: This manual does not describe the Objective-C and Objective-C++
2703 languages themselves.  @xref{Standards,,Language Standards
2704 Supported by GCC}, for references.)
2706 This section describes the command-line options that are only meaningful
2707 for Objective-C and Objective-C++ programs.  You can also use most of
2708 the language-independent GNU compiler options.
2709 For example, you might compile a file @code{some_class.m} like this:
2711 @smallexample
2712 gcc -g -fgnu-runtime -O -c some_class.m
2713 @end smallexample
2715 @noindent
2716 In this example, @option{-fgnu-runtime} is an option meant only for
2717 Objective-C and Objective-C++ programs; you can use the other options with
2718 any language supported by GCC@.
2720 Note that since Objective-C is an extension of the C language, Objective-C
2721 compilations may also use options specific to the C front-end (e.g.,
2722 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2723 C++-specific options (e.g., @option{-Wabi}).
2725 Here is a list of options that are @emph{only} for compiling Objective-C
2726 and Objective-C++ programs:
2728 @table @gcctabopt
2729 @item -fconstant-string-class=@var{class-name}
2730 @opindex fconstant-string-class
2731 Use @var{class-name} as the name of the class to instantiate for each
2732 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2733 class name is @code{NXConstantString} if the GNU runtime is being used, and
2734 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2735 @option{-fconstant-cfstrings} option, if also present, overrides the
2736 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2737 to be laid out as constant CoreFoundation strings.
2739 @item -fgnu-runtime
2740 @opindex fgnu-runtime
2741 Generate object code compatible with the standard GNU Objective-C
2742 runtime.  This is the default for most types of systems.
2744 @item -fnext-runtime
2745 @opindex fnext-runtime
2746 Generate output compatible with the NeXT runtime.  This is the default
2747 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2748 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2749 used.
2751 @item -fno-nil-receivers
2752 @opindex fno-nil-receivers
2753 Assume that all Objective-C message dispatches (@code{[receiver
2754 message:arg]}) in this translation unit ensure that the receiver is
2755 not @code{nil}.  This allows for more efficient entry points in the
2756 runtime to be used.  This option is only available in conjunction with
2757 the NeXT runtime and ABI version 0 or 1.
2759 @item -fobjc-abi-version=@var{n}
2760 @opindex fobjc-abi-version
2761 Use version @var{n} of the Objective-C ABI for the selected runtime.
2762 This option is currently supported only for the NeXT runtime.  In that
2763 case, Version 0 is the traditional (32-bit) ABI without support for
2764 properties and other Objective-C 2.0 additions.  Version 1 is the
2765 traditional (32-bit) ABI with support for properties and other
2766 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2767 nothing is specified, the default is Version 0 on 32-bit target
2768 machines, and Version 2 on 64-bit target machines.
2770 @item -fobjc-call-cxx-cdtors
2771 @opindex fobjc-call-cxx-cdtors
2772 For each Objective-C class, check if any of its instance variables is a
2773 C++ object with a non-trivial default constructor.  If so, synthesize a
2774 special @code{- (id) .cxx_construct} instance method which runs
2775 non-trivial default constructors on any such instance variables, in order,
2776 and then return @code{self}.  Similarly, check if any instance variable
2777 is a C++ object with a non-trivial destructor, and if so, synthesize a
2778 special @code{- (void) .cxx_destruct} method which runs
2779 all such default destructors, in reverse order.
2781 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2782 methods thusly generated only operate on instance variables
2783 declared in the current Objective-C class, and not those inherited
2784 from superclasses.  It is the responsibility of the Objective-C
2785 runtime to invoke all such methods in an object's inheritance
2786 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2787 by the runtime immediately after a new object instance is allocated;
2788 the @code{- (void) .cxx_destruct} methods are invoked immediately
2789 before the runtime deallocates an object instance.
2791 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2792 support for invoking the @code{- (id) .cxx_construct} and
2793 @code{- (void) .cxx_destruct} methods.
2795 @item -fobjc-direct-dispatch
2796 @opindex fobjc-direct-dispatch
2797 Allow fast jumps to the message dispatcher.  On Darwin this is
2798 accomplished via the comm page.
2800 @item -fobjc-exceptions
2801 @opindex fobjc-exceptions
2802 Enable syntactic support for structured exception handling in
2803 Objective-C, similar to what is offered by C++ and Java.  This option
2804 is required to use the Objective-C keywords @code{@@try},
2805 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2806 @code{@@synchronized}.  This option is available with both the GNU
2807 runtime and the NeXT runtime (but not available in conjunction with
2808 the NeXT runtime on Mac OS X 10.2 and earlier).
2810 @item -fobjc-gc
2811 @opindex fobjc-gc
2812 Enable garbage collection (GC) in Objective-C and Objective-C++
2813 programs.  This option is only available with the NeXT runtime; the
2814 GNU runtime has a different garbage collection implementation that
2815 does not require special compiler flags.
2817 @item -fobjc-nilcheck
2818 @opindex fobjc-nilcheck
2819 For the NeXT runtime with version 2 of the ABI, check for a nil
2820 receiver in method invocations before doing the actual method call.
2821 This is the default and can be disabled using
2822 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2823 checked for nil in this way no matter what this flag is set to.
2824 Currently this flag does nothing when the GNU runtime, or an older
2825 version of the NeXT runtime ABI, is used.
2827 @item -fobjc-std=objc1
2828 @opindex fobjc-std
2829 Conform to the language syntax of Objective-C 1.0, the language
2830 recognized by GCC 4.0.  This only affects the Objective-C additions to
2831 the C/C++ language; it does not affect conformance to C/C++ standards,
2832 which is controlled by the separate C/C++ dialect option flags.  When
2833 this option is used with the Objective-C or Objective-C++ compiler,
2834 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2835 This is useful if you need to make sure that your Objective-C code can
2836 be compiled with older versions of GCC@.
2838 @item -freplace-objc-classes
2839 @opindex freplace-objc-classes
2840 Emit a special marker instructing @command{ld(1)} not to statically link in
2841 the resulting object file, and allow @command{dyld(1)} to load it in at
2842 run time instead.  This is used in conjunction with the Fix-and-Continue
2843 debugging mode, where the object file in question may be recompiled and
2844 dynamically reloaded in the course of program execution, without the need
2845 to restart the program itself.  Currently, Fix-and-Continue functionality
2846 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2847 and later.
2849 @item -fzero-link
2850 @opindex fzero-link
2851 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2852 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2853 compile time) with static class references that get initialized at load time,
2854 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2855 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2856 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2857 for individual class implementations to be modified during program execution.
2858 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2859 regardless of command-line options.
2861 @item -gen-decls
2862 @opindex gen-decls
2863 Dump interface declarations for all classes seen in the source file to a
2864 file named @file{@var{sourcename}.decl}.
2866 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2867 @opindex Wassign-intercept
2868 @opindex Wno-assign-intercept
2869 Warn whenever an Objective-C assignment is being intercepted by the
2870 garbage collector.
2872 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2873 @opindex Wno-protocol
2874 @opindex Wprotocol
2875 If a class is declared to implement a protocol, a warning is issued for
2876 every method in the protocol that is not implemented by the class.  The
2877 default behavior is to issue a warning for every method not explicitly
2878 implemented in the class, even if a method implementation is inherited
2879 from the superclass.  If you use the @option{-Wno-protocol} option, then
2880 methods inherited from the superclass are considered to be implemented,
2881 and no warning is issued for them.
2883 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2884 @opindex Wselector
2885 @opindex Wno-selector
2886 Warn if multiple methods of different types for the same selector are
2887 found during compilation.  The check is performed on the list of methods
2888 in the final stage of compilation.  Additionally, a check is performed
2889 for each selector appearing in a @code{@@selector(@dots{})}
2890 expression, and a corresponding method for that selector has been found
2891 during compilation.  Because these checks scan the method table only at
2892 the end of compilation, these warnings are not produced if the final
2893 stage of compilation is not reached, for example because an error is
2894 found during compilation, or because the @option{-fsyntax-only} option is
2895 being used.
2897 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2898 @opindex Wstrict-selector-match
2899 @opindex Wno-strict-selector-match
2900 Warn if multiple methods with differing argument and/or return types are
2901 found for a given selector when attempting to send a message using this
2902 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2903 is off (which is the default behavior), the compiler omits such warnings
2904 if any differences found are confined to types that share the same size
2905 and alignment.
2907 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2908 @opindex Wundeclared-selector
2909 @opindex Wno-undeclared-selector
2910 Warn if a @code{@@selector(@dots{})} expression referring to an
2911 undeclared selector is found.  A selector is considered undeclared if no
2912 method with that name has been declared before the
2913 @code{@@selector(@dots{})} expression, either explicitly in an
2914 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2915 an @code{@@implementation} section.  This option always performs its
2916 checks as soon as a @code{@@selector(@dots{})} expression is found,
2917 while @option{-Wselector} only performs its checks in the final stage of
2918 compilation.  This also enforces the coding style convention
2919 that methods and selectors must be declared before being used.
2921 @item -print-objc-runtime-info
2922 @opindex print-objc-runtime-info
2923 Generate C header describing the largest structure that is passed by
2924 value, if any.
2926 @end table
2928 @node Language Independent Options
2929 @section Options to Control Diagnostic Messages Formatting
2930 @cindex options to control diagnostics formatting
2931 @cindex diagnostic messages
2932 @cindex message formatting
2934 Traditionally, diagnostic messages have been formatted irrespective of
2935 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
2936 options described below
2937 to control the formatting algorithm for diagnostic messages, 
2938 e.g.@: how many characters per line, how often source location
2939 information should be reported.  Note that some language front ends may not
2940 honor these options.
2942 @table @gcctabopt
2943 @item -fmessage-length=@var{n}
2944 @opindex fmessage-length
2945 Try to format error messages so that they fit on lines of about @var{n}
2946 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2947 the front ends supported by GCC@.  If @var{n} is zero, then no
2948 line-wrapping is done; each error message appears on a single
2949 line.
2951 @item -fdiagnostics-show-location=once
2952 @opindex fdiagnostics-show-location
2953 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2954 reporter to emit source location information @emph{once}; that is, in
2955 case the message is too long to fit on a single physical line and has to
2956 be wrapped, the source location won't be emitted (as prefix) again,
2957 over and over, in subsequent continuation lines.  This is the default
2958 behavior.
2960 @item -fdiagnostics-show-location=every-line
2961 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2962 messages reporter to emit the same source location information (as
2963 prefix) for physical lines that result from the process of breaking
2964 a message which is too long to fit on a single line.
2966 @item -fno-diagnostics-show-option
2967 @opindex fno-diagnostics-show-option
2968 @opindex fdiagnostics-show-option
2969 By default, each diagnostic emitted includes text indicating the
2970 command-line option that directly controls the diagnostic (if such an
2971 option is known to the diagnostic machinery).  Specifying the
2972 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2974 @item -fno-diagnostics-show-caret
2975 @opindex fno-diagnostics-show-caret
2976 @opindex fdiagnostics-show-caret
2977 By default, each diagnostic emitted includes the original source line
2978 and a caret '^' indicating the column.  This option suppresses this
2979 information.
2981 @end table
2983 @node Warning Options
2984 @section Options to Request or Suppress Warnings
2985 @cindex options to control warnings
2986 @cindex warning messages
2987 @cindex messages, warning
2988 @cindex suppressing warnings
2990 Warnings are diagnostic messages that report constructions that
2991 are not inherently erroneous but that are risky or suggest there
2992 may have been an error.
2994 The following language-independent options do not enable specific
2995 warnings but control the kinds of diagnostics produced by GCC@.
2997 @table @gcctabopt
2998 @cindex syntax checking
2999 @item -fsyntax-only
3000 @opindex fsyntax-only
3001 Check the code for syntax errors, but don't do anything beyond that.
3003 @item -fmax-errors=@var{n}
3004 @opindex fmax-errors
3005 Limits the maximum number of error messages to @var{n}, at which point
3006 GCC bails out rather than attempting to continue processing the source
3007 code.  If @var{n} is 0 (the default), there is no limit on the number
3008 of error messages produced.  If @option{-Wfatal-errors} is also
3009 specified, then @option{-Wfatal-errors} takes precedence over this
3010 option.
3012 @item -w
3013 @opindex w
3014 Inhibit all warning messages.
3016 @item -Werror
3017 @opindex Werror
3018 @opindex Wno-error
3019 Make all warnings into errors.
3021 @item -Werror=
3022 @opindex Werror=
3023 @opindex Wno-error=
3024 Make the specified warning into an error.  The specifier for a warning
3025 is appended; for example @option{-Werror=switch} turns the warnings
3026 controlled by @option{-Wswitch} into errors.  This switch takes a
3027 negative form, to be used to negate @option{-Werror} for specific
3028 warnings; for example @option{-Wno-error=switch} makes
3029 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3030 is in effect.
3032 The warning message for each controllable warning includes the
3033 option that controls the warning.  That option can then be used with
3034 @option{-Werror=} and @option{-Wno-error=} as described above.
3035 (Printing of the option in the warning message can be disabled using the
3036 @option{-fno-diagnostics-show-option} flag.)
3038 Note that specifying @option{-Werror=}@var{foo} automatically implies
3039 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3040 imply anything.
3042 @item -Wfatal-errors
3043 @opindex Wfatal-errors
3044 @opindex Wno-fatal-errors
3045 This option causes the compiler to abort compilation on the first error
3046 occurred rather than trying to keep going and printing further error
3047 messages.
3049 @end table
3051 You can request many specific warnings with options beginning with
3052 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3053 implicit declarations.  Each of these specific warning options also
3054 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3055 example, @option{-Wno-implicit}.  This manual lists only one of the
3056 two forms, whichever is not the default.  For further
3057 language-specific options also refer to @ref{C++ Dialect Options} and
3058 @ref{Objective-C and Objective-C++ Dialect Options}.
3060 When an unrecognized warning option is requested (e.g.,
3061 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3062 that the option is not recognized.  However, if the @option{-Wno-} form
3063 is used, the behavior is slightly different: no diagnostic is
3064 produced for @option{-Wno-unknown-warning} unless other diagnostics
3065 are being produced.  This allows the use of new @option{-Wno-} options
3066 with old compilers, but if something goes wrong, the compiler
3067 warns that an unrecognized option is present.
3069 @table @gcctabopt
3070 @item -Wpedantic
3071 @itemx -pedantic
3072 @opindex pedantic
3073 @opindex Wpedantic
3074 Issue all the warnings demanded by strict ISO C and ISO C++;
3075 reject all programs that use forbidden extensions, and some other
3076 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3077 version of the ISO C standard specified by any @option{-std} option used.
3079 Valid ISO C and ISO C++ programs should compile properly with or without
3080 this option (though a rare few require @option{-ansi} or a
3081 @option{-std} option specifying the required version of ISO C)@.  However,
3082 without this option, certain GNU extensions and traditional C and C++
3083 features are supported as well.  With this option, they are rejected.
3085 @option{-Wpedantic} does not cause warning messages for use of the
3086 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3087 warnings are also disabled in the expression that follows
3088 @code{__extension__}.  However, only system header files should use
3089 these escape routes; application programs should avoid them.
3090 @xref{Alternate Keywords}.
3092 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3093 C conformance.  They soon find that it does not do quite what they want:
3094 it finds some non-ISO practices, but not all---only those for which
3095 ISO C @emph{requires} a diagnostic, and some others for which
3096 diagnostics have been added.
3098 A feature to report any failure to conform to ISO C might be useful in
3099 some instances, but would require considerable additional work and would
3100 be quite different from @option{-Wpedantic}.  We don't have plans to
3101 support such a feature in the near future.
3103 Where the standard specified with @option{-std} represents a GNU
3104 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3105 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3106 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3107 where they are required by the base standard.  (It does not make sense
3108 for such warnings to be given only for features not in the specified GNU
3109 C dialect, since by definition the GNU dialects of C include all
3110 features the compiler supports with the given option, and there would be
3111 nothing to warn about.)
3113 @item -pedantic-errors
3114 @opindex pedantic-errors
3115 Like @option{-Wpedantic}, except that errors are produced rather than
3116 warnings.
3118 @item -Wall
3119 @opindex Wall
3120 @opindex Wno-all
3121 This enables all the warnings about constructions that some users
3122 consider questionable, and that are easy to avoid (or modify to
3123 prevent the warning), even in conjunction with macros.  This also
3124 enables some language-specific warnings described in @ref{C++ Dialect
3125 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3127 @option{-Wall} turns on the following warning flags:
3129 @gccoptlist{-Waddress   @gol
3130 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3131 -Wc++11-compat  @gol
3132 -Wchar-subscripts  @gol
3133 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3134 -Wimplicit-int @r{(C and Objective-C only)} @gol
3135 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3136 -Wcomment  @gol
3137 -Wformat   @gol
3138 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3139 -Wmaybe-uninitialized @gol
3140 -Wmissing-braces @r{(only for C/ObjC)} @gol
3141 -Wnonnull  @gol
3142 -Wparentheses  @gol
3143 -Wpointer-sign  @gol
3144 -Wreorder   @gol
3145 -Wreturn-type  @gol
3146 -Wsequence-point  @gol
3147 -Wsign-compare @r{(only in C++)}  @gol
3148 -Wstrict-aliasing  @gol
3149 -Wstrict-overflow=1  @gol
3150 -Wswitch  @gol
3151 -Wtrigraphs  @gol
3152 -Wuninitialized  @gol
3153 -Wunknown-pragmas  @gol
3154 -Wunused-function  @gol
3155 -Wunused-label     @gol
3156 -Wunused-value     @gol
3157 -Wunused-variable  @gol
3158 -Wvolatile-register-var @gol
3161 Note that some warning flags are not implied by @option{-Wall}.  Some of
3162 them warn about constructions that users generally do not consider
3163 questionable, but which occasionally you might wish to check for;
3164 others warn about constructions that are necessary or hard to avoid in
3165 some cases, and there is no simple way to modify the code to suppress
3166 the warning. Some of them are enabled by @option{-Wextra} but many of
3167 them must be enabled individually.
3169 @item -Wextra
3170 @opindex W
3171 @opindex Wextra
3172 @opindex Wno-extra
3173 This enables some extra warning flags that are not enabled by
3174 @option{-Wall}. (This option used to be called @option{-W}.  The older
3175 name is still supported, but the newer name is more descriptive.)
3177 @gccoptlist{-Wclobbered  @gol
3178 -Wempty-body  @gol
3179 -Wignored-qualifiers @gol
3180 -Wmissing-field-initializers  @gol
3181 -Wmissing-parameter-type @r{(C only)}  @gol
3182 -Wold-style-declaration @r{(C only)}  @gol
3183 -Woverride-init  @gol
3184 -Wsign-compare  @gol
3185 -Wtype-limits  @gol
3186 -Wuninitialized  @gol
3187 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3188 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3191 The option @option{-Wextra} also prints warning messages for the
3192 following cases:
3194 @itemize @bullet
3196 @item
3197 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3198 @samp{>}, or @samp{>=}.
3200 @item
3201 (C++ only) An enumerator and a non-enumerator both appear in a
3202 conditional expression.
3204 @item
3205 (C++ only) Ambiguous virtual bases.
3207 @item
3208 (C++ only) Subscripting an array that has been declared @samp{register}.
3210 @item
3211 (C++ only) Taking the address of a variable that has been declared
3212 @samp{register}.
3214 @item
3215 (C++ only) A base class is not initialized in a derived class's copy
3216 constructor.
3218 @end itemize
3220 @item -Wchar-subscripts
3221 @opindex Wchar-subscripts
3222 @opindex Wno-char-subscripts
3223 Warn if an array subscript has type @code{char}.  This is a common cause
3224 of error, as programmers often forget that this type is signed on some
3225 machines.
3226 This warning is enabled by @option{-Wall}.
3228 @item -Wcomment
3229 @opindex Wcomment
3230 @opindex Wno-comment
3231 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3232 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3233 This warning is enabled by @option{-Wall}.
3235 @item -Wno-coverage-mismatch
3236 @opindex Wno-coverage-mismatch
3237 Warn if feedback profiles do not match when using the
3238 @option{-fprofile-use} option.
3239 If a source file is changed between compiling with @option{-fprofile-gen} and
3240 with @option{-fprofile-use}, the files with the profile feedback can fail
3241 to match the source file and GCC cannot use the profile feedback
3242 information.  By default, this warning is enabled and is treated as an
3243 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3244 warning or @option{-Wno-error=coverage-mismatch} can be used to
3245 disable the error.  Disabling the error for this warning can result in
3246 poorly optimized code and is useful only in the
3247 case of very minor changes such as bug fixes to an existing code-base.
3248 Completely disabling the warning is not recommended.
3250 @item -Wno-cpp
3251 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3253 Suppress warning messages emitted by @code{#warning} directives.
3255 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3256 @opindex Wdouble-promotion
3257 @opindex Wno-double-promotion
3258 Give a warning when a value of type @code{float} is implicitly
3259 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3260 floating-point unit implement @code{float} in hardware, but emulate
3261 @code{double} in software.  On such a machine, doing computations
3262 using @code{double} values is much more expensive because of the
3263 overhead required for software emulation.
3265 It is easy to accidentally do computations with @code{double} because
3266 floating-point literals are implicitly of type @code{double}.  For
3267 example, in:
3268 @smallexample
3269 @group
3270 float area(float radius)
3272    return 3.14159 * radius * radius;
3274 @end group
3275 @end smallexample
3276 the compiler performs the entire computation with @code{double}
3277 because the floating-point literal is a @code{double}.
3279 @item -Wformat
3280 @itemx -Wformat=@var{n}
3281 @opindex Wformat
3282 @opindex Wno-format
3283 @opindex ffreestanding
3284 @opindex fno-builtin
3285 @opindex Wformat=
3286 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3287 the arguments supplied have types appropriate to the format string
3288 specified, and that the conversions specified in the format string make
3289 sense.  This includes standard functions, and others specified by format
3290 attributes (@pxref{Function Attributes}), in the @code{printf},
3291 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3292 not in the C standard) families (or other target-specific families).
3293 Which functions are checked without format attributes having been
3294 specified depends on the standard version selected, and such checks of
3295 functions without the attribute specified are disabled by
3296 @option{-ffreestanding} or @option{-fno-builtin}.
3298 The formats are checked against the format features supported by GNU
3299 libc version 2.2.  These include all ISO C90 and C99 features, as well
3300 as features from the Single Unix Specification and some BSD and GNU
3301 extensions.  Other library implementations may not support all these
3302 features; GCC does not support warning about features that go beyond a
3303 particular library's limitations.  However, if @option{-Wpedantic} is used
3304 with @option{-Wformat}, warnings are given about format features not
3305 in the selected standard version (but not for @code{strfmon} formats,
3306 since those are not in any version of the C standard).  @xref{C Dialect
3307 Options,,Options Controlling C Dialect}.
3309 @table @gcctabopt
3310 @item -Wformat=1
3311 @itemx -Wformat
3312 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3313 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3314 @option{-Wformat} also checks for null format arguments for several
3315 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3316 aspects of this level of format checking can be disabled by the
3317 options: @option{-Wno-format-contains-nul},
3318 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3319 @option{-Wformat} is enabled by @option{-Wall}.
3321 @item -Wno-format-contains-nul
3322 @opindex Wno-format-contains-nul
3323 @opindex Wformat-contains-nul
3324 If @option{-Wformat} is specified, do not warn about format strings that
3325 contain NUL bytes.
3327 @item -Wno-format-extra-args
3328 @opindex Wno-format-extra-args
3329 @opindex Wformat-extra-args
3330 If @option{-Wformat} is specified, do not warn about excess arguments to a
3331 @code{printf} or @code{scanf} format function.  The C standard specifies
3332 that such arguments are ignored.
3334 Where the unused arguments lie between used arguments that are
3335 specified with @samp{$} operand number specifications, normally
3336 warnings are still given, since the implementation could not know what
3337 type to pass to @code{va_arg} to skip the unused arguments.  However,
3338 in the case of @code{scanf} formats, this option suppresses the
3339 warning if the unused arguments are all pointers, since the Single
3340 Unix Specification says that such unused arguments are allowed.
3342 @item -Wno-format-zero-length
3343 @opindex Wno-format-zero-length
3344 @opindex Wformat-zero-length
3345 If @option{-Wformat} is specified, do not warn about zero-length formats.
3346 The C standard specifies that zero-length formats are allowed.
3349 @item -Wformat=2
3350 Enable @option{-Wformat} plus additional format checks.  Currently
3351 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3352 -Wformat-y2k}.
3354 @item -Wformat-nonliteral
3355 @opindex Wformat-nonliteral
3356 @opindex Wno-format-nonliteral
3357 If @option{-Wformat} is specified, also warn if the format string is not a
3358 string literal and so cannot be checked, unless the format function
3359 takes its format arguments as a @code{va_list}.
3361 @item -Wformat-security
3362 @opindex Wformat-security
3363 @opindex Wno-format-security
3364 If @option{-Wformat} is specified, also warn about uses of format
3365 functions that represent possible security problems.  At present, this
3366 warns about calls to @code{printf} and @code{scanf} functions where the
3367 format string is not a string literal and there are no format arguments,
3368 as in @code{printf (foo);}.  This may be a security hole if the format
3369 string came from untrusted input and contains @samp{%n}.  (This is
3370 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3371 in future warnings may be added to @option{-Wformat-security} that are not
3372 included in @option{-Wformat-nonliteral}.)
3374 @item -Wformat-y2k
3375 @opindex Wformat-y2k
3376 @opindex Wno-format-y2k
3377 If @option{-Wformat} is specified, also warn about @code{strftime}
3378 formats that may yield only a two-digit year.
3379 @end table
3381 @item -Wnonnull
3382 @opindex Wnonnull
3383 @opindex Wno-nonnull
3384 Warn about passing a null pointer for arguments marked as
3385 requiring a non-null value by the @code{nonnull} function attribute.
3387 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3388 can be disabled with the @option{-Wno-nonnull} option.
3390 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3391 @opindex Winit-self
3392 @opindex Wno-init-self
3393 Warn about uninitialized variables that are initialized with themselves.
3394 Note this option can only be used with the @option{-Wuninitialized} option.
3396 For example, GCC warns about @code{i} being uninitialized in the
3397 following snippet only when @option{-Winit-self} has been specified:
3398 @smallexample
3399 @group
3400 int f()
3402   int i = i;
3403   return i;
3405 @end group
3406 @end smallexample
3408 This warning is enabled by @option{-Wall} in C++.
3410 @item -Wimplicit-int @r{(C and Objective-C only)}
3411 @opindex Wimplicit-int
3412 @opindex Wno-implicit-int
3413 Warn when a declaration does not specify a type.
3414 This warning is enabled by @option{-Wall}.
3416 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3417 @opindex Wimplicit-function-declaration
3418 @opindex Wno-implicit-function-declaration
3419 Give a warning whenever a function is used before being declared. In
3420 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3421 enabled by default and it is made into an error by
3422 @option{-pedantic-errors}. This warning is also enabled by
3423 @option{-Wall}.
3425 @item -Wimplicit @r{(C and Objective-C only)}
3426 @opindex Wimplicit
3427 @opindex Wno-implicit
3428 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3429 This warning is enabled by @option{-Wall}.
3431 @item -Wignored-qualifiers @r{(C and C++ only)}
3432 @opindex Wignored-qualifiers
3433 @opindex Wno-ignored-qualifiers
3434 Warn if the return type of a function has a type qualifier
3435 such as @code{const}.  For ISO C such a type qualifier has no effect,
3436 since the value returned by a function is not an lvalue.
3437 For C++, the warning is only emitted for scalar types or @code{void}.
3438 ISO C prohibits qualified @code{void} return types on function
3439 definitions, so such return types always receive a warning
3440 even without this option.
3442 This warning is also enabled by @option{-Wextra}.
3444 @item -Wmain
3445 @opindex Wmain
3446 @opindex Wno-main
3447 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3448 a function with external linkage, returning int, taking either zero
3449 arguments, two, or three arguments of appropriate types.  This warning
3450 is enabled by default in C++ and is enabled by either @option{-Wall}
3451 or @option{-Wpedantic}.
3453 @item -Wmissing-braces
3454 @opindex Wmissing-braces
3455 @opindex Wno-missing-braces
3456 Warn if an aggregate or union initializer is not fully bracketed.  In
3457 the following example, the initializer for @samp{a} is not fully
3458 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3459 enabled by @option{-Wall} in C.
3461 @smallexample
3462 int a[2][2] = @{ 0, 1, 2, 3 @};
3463 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3464 @end smallexample
3466 This warning is enabled by @option{-Wall}.
3468 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3469 @opindex Wmissing-include-dirs
3470 @opindex Wno-missing-include-dirs
3471 Warn if a user-supplied include directory does not exist.
3473 @item -Wparentheses
3474 @opindex Wparentheses
3475 @opindex Wno-parentheses
3476 Warn if parentheses are omitted in certain contexts, such
3477 as when there is an assignment in a context where a truth value
3478 is expected, or when operators are nested whose precedence people
3479 often get confused about.
3481 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3482 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3483 interpretation from that of ordinary mathematical notation.
3485 Also warn about constructions where there may be confusion to which
3486 @code{if} statement an @code{else} branch belongs.  Here is an example of
3487 such a case:
3489 @smallexample
3490 @group
3492   if (a)
3493     if (b)
3494       foo ();
3495   else
3496     bar ();
3498 @end group
3499 @end smallexample
3501 In C/C++, every @code{else} branch belongs to the innermost possible
3502 @code{if} statement, which in this example is @code{if (b)}.  This is
3503 often not what the programmer expected, as illustrated in the above
3504 example by indentation the programmer chose.  When there is the
3505 potential for this confusion, GCC issues a warning when this flag
3506 is specified.  To eliminate the warning, add explicit braces around
3507 the innermost @code{if} statement so there is no way the @code{else}
3508 can belong to the enclosing @code{if}.  The resulting code
3509 looks like this:
3511 @smallexample
3512 @group
3514   if (a)
3515     @{
3516       if (b)
3517         foo ();
3518       else
3519         bar ();
3520     @}
3522 @end group
3523 @end smallexample
3525 Also warn for dangerous uses of the GNU extension to
3526 @code{?:} with omitted middle operand. When the condition
3527 in the @code{?}: operator is a boolean expression, the omitted value is
3528 always 1.  Often programmers expect it to be a value computed
3529 inside the conditional expression instead.
3531 This warning is enabled by @option{-Wall}.
3533 @item -Wsequence-point
3534 @opindex Wsequence-point
3535 @opindex Wno-sequence-point
3536 Warn about code that may have undefined semantics because of violations
3537 of sequence point rules in the C and C++ standards.
3539 The C and C++ standards define the order in which expressions in a C/C++
3540 program are evaluated in terms of @dfn{sequence points}, which represent
3541 a partial ordering between the execution of parts of the program: those
3542 executed before the sequence point, and those executed after it.  These
3543 occur after the evaluation of a full expression (one which is not part
3544 of a larger expression), after the evaluation of the first operand of a
3545 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3546 function is called (but after the evaluation of its arguments and the
3547 expression denoting the called function), and in certain other places.
3548 Other than as expressed by the sequence point rules, the order of
3549 evaluation of subexpressions of an expression is not specified.  All
3550 these rules describe only a partial order rather than a total order,
3551 since, for example, if two functions are called within one expression
3552 with no sequence point between them, the order in which the functions
3553 are called is not specified.  However, the standards committee have
3554 ruled that function calls do not overlap.
3556 It is not specified when between sequence points modifications to the
3557 values of objects take effect.  Programs whose behavior depends on this
3558 have undefined behavior; the C and C++ standards specify that ``Between
3559 the previous and next sequence point an object shall have its stored
3560 value modified at most once by the evaluation of an expression.
3561 Furthermore, the prior value shall be read only to determine the value
3562 to be stored.''.  If a program breaks these rules, the results on any
3563 particular implementation are entirely unpredictable.
3565 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3566 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3567 diagnosed by this option, and it may give an occasional false positive
3568 result, but in general it has been found fairly effective at detecting
3569 this sort of problem in programs.
3571 The standard is worded confusingly, therefore there is some debate
3572 over the precise meaning of the sequence point rules in subtle cases.
3573 Links to discussions of the problem, including proposed formal
3574 definitions, may be found on the GCC readings page, at
3575 @uref{http://gcc.gnu.org/@/readings.html}.
3577 This warning is enabled by @option{-Wall} for C and C++.
3579 @item -Wno-return-local-addr
3580 @opindex Wno-return-local-addr
3581 @opindex Wreturn-local-addr
3582 Do not warn about returning a pointer (or in C++, a reference) to a
3583 variable that goes out of scope after the function returns.
3585 @item -Wreturn-type
3586 @opindex Wreturn-type
3587 @opindex Wno-return-type
3588 Warn whenever a function is defined with a return type that defaults
3589 to @code{int}.  Also warn about any @code{return} statement with no
3590 return value in a function whose return type is not @code{void}
3591 (falling off the end of the function body is considered returning
3592 without a value), and about a @code{return} statement with an
3593 expression in a function whose return type is @code{void}.
3595 For C++, a function without return type always produces a diagnostic
3596 message, even when @option{-Wno-return-type} is specified.  The only
3597 exceptions are @samp{main} and functions defined in system headers.
3599 This warning is enabled by @option{-Wall}.
3601 @item -Wswitch
3602 @opindex Wswitch
3603 @opindex Wno-switch
3604 Warn whenever a @code{switch} statement has an index of enumerated type
3605 and lacks a @code{case} for one or more of the named codes of that
3606 enumeration.  (The presence of a @code{default} label prevents this
3607 warning.)  @code{case} labels outside the enumeration range also
3608 provoke warnings when this option is used (even if there is a
3609 @code{default} label).
3610 This warning is enabled by @option{-Wall}.
3612 @item -Wswitch-default
3613 @opindex Wswitch-default
3614 @opindex Wno-switch-default
3615 Warn whenever a @code{switch} statement does not have a @code{default}
3616 case.
3618 @item -Wswitch-enum
3619 @opindex Wswitch-enum
3620 @opindex Wno-switch-enum
3621 Warn whenever a @code{switch} statement has an index of enumerated type
3622 and lacks a @code{case} for one or more of the named codes of that
3623 enumeration.  @code{case} labels outside the enumeration range also
3624 provoke warnings when this option is used.  The only difference
3625 between @option{-Wswitch} and this option is that this option gives a
3626 warning about an omitted enumeration code even if there is a
3627 @code{default} label.
3629 @item -Wsync-nand @r{(C and C++ only)}
3630 @opindex Wsync-nand
3631 @opindex Wno-sync-nand
3632 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3633 built-in functions are used.  These functions changed semantics in GCC 4.4.
3635 @item -Wtrigraphs
3636 @opindex Wtrigraphs
3637 @opindex Wno-trigraphs
3638 Warn if any trigraphs are encountered that might change the meaning of
3639 the program (trigraphs within comments are not warned about).
3640 This warning is enabled by @option{-Wall}.
3642 @item -Wunused-but-set-parameter
3643 @opindex Wunused-but-set-parameter
3644 @opindex Wno-unused-but-set-parameter
3645 Warn whenever a function parameter is assigned to, but otherwise unused
3646 (aside from its declaration).
3648 To suppress this warning use the @samp{unused} attribute
3649 (@pxref{Variable Attributes}).
3651 This warning is also enabled by @option{-Wunused} together with
3652 @option{-Wextra}.
3654 @item -Wunused-but-set-variable
3655 @opindex Wunused-but-set-variable
3656 @opindex Wno-unused-but-set-variable
3657 Warn whenever a local variable is assigned to, but otherwise unused
3658 (aside from its declaration).
3659 This warning is enabled by @option{-Wall}.
3661 To suppress this warning use the @samp{unused} attribute
3662 (@pxref{Variable Attributes}).
3664 This warning is also enabled by @option{-Wunused}, which is enabled
3665 by @option{-Wall}.
3667 @item -Wunused-function
3668 @opindex Wunused-function
3669 @opindex Wno-unused-function
3670 Warn whenever a static function is declared but not defined or a
3671 non-inline static function is unused.
3672 This warning is enabled by @option{-Wall}.
3674 @item -Wunused-label
3675 @opindex Wunused-label
3676 @opindex Wno-unused-label
3677 Warn whenever a label is declared but not used.
3678 This warning is enabled by @option{-Wall}.
3680 To suppress this warning use the @samp{unused} attribute
3681 (@pxref{Variable Attributes}).
3683 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3684 @opindex Wunused-local-typedefs
3685 Warn when a typedef locally defined in a function is not used.
3686 This warning is enabled by @option{-Wall}.
3688 @item -Wunused-parameter
3689 @opindex Wunused-parameter
3690 @opindex Wno-unused-parameter
3691 Warn whenever a function parameter is unused aside from its declaration.
3693 To suppress this warning use the @samp{unused} attribute
3694 (@pxref{Variable Attributes}).
3696 @item -Wno-unused-result
3697 @opindex Wunused-result
3698 @opindex Wno-unused-result
3699 Do not warn if a caller of a function marked with attribute
3700 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3701 its return value. The default is @option{-Wunused-result}.
3703 @item -Wunused-variable
3704 @opindex Wunused-variable
3705 @opindex Wno-unused-variable
3706 Warn whenever a local variable or non-constant static variable is unused
3707 aside from its declaration.
3708 This warning is enabled by @option{-Wall}.
3710 To suppress this warning use the @samp{unused} attribute
3711 (@pxref{Variable Attributes}).
3713 @item -Wunused-value
3714 @opindex Wunused-value
3715 @opindex Wno-unused-value
3716 Warn whenever a statement computes a result that is explicitly not
3717 used. To suppress this warning cast the unused expression to
3718 @samp{void}. This includes an expression-statement or the left-hand
3719 side of a comma expression that contains no side effects. For example,
3720 an expression such as @samp{x[i,j]} causes a warning, while
3721 @samp{x[(void)i,j]} does not.
3723 This warning is enabled by @option{-Wall}.
3725 @item -Wunused
3726 @opindex Wunused
3727 @opindex Wno-unused
3728 All the above @option{-Wunused} options combined.
3730 In order to get a warning about an unused function parameter, you must
3731 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3732 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3734 @item -Wuninitialized
3735 @opindex Wuninitialized
3736 @opindex Wno-uninitialized
3737 Warn if an automatic variable is used without first being initialized
3738 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3739 warn if a non-static reference or non-static @samp{const} member
3740 appears in a class without constructors.
3742 If you want to warn about code that uses the uninitialized value of the
3743 variable in its own initializer, use the @option{-Winit-self} option.
3745 These warnings occur for individual uninitialized or clobbered
3746 elements of structure, union or array variables as well as for
3747 variables that are uninitialized or clobbered as a whole.  They do
3748 not occur for variables or elements declared @code{volatile}.  Because
3749 these warnings depend on optimization, the exact variables or elements
3750 for which there are warnings depends on the precise optimization
3751 options and version of GCC used.
3753 Note that there may be no warning about a variable that is used only
3754 to compute a value that itself is never used, because such
3755 computations may be deleted by data flow analysis before the warnings
3756 are printed.
3758 @item -Wmaybe-uninitialized
3759 @opindex Wmaybe-uninitialized
3760 @opindex Wno-maybe-uninitialized
3761 For an automatic variable, if there exists a path from the function
3762 entry to a use of the variable that is initialized, but there exist
3763 some other paths for which the variable is not initialized, the compiler
3764 emits a warning if it cannot prove the uninitialized paths are not
3765 executed at run time. These warnings are made optional because GCC is
3766 not smart enough to see all the reasons why the code might be correct
3767 in spite of appearing to have an error.  Here is one example of how
3768 this can happen:
3770 @smallexample
3771 @group
3773   int x;
3774   switch (y)
3775     @{
3776     case 1: x = 1;
3777       break;
3778     case 2: x = 4;
3779       break;
3780     case 3: x = 5;
3781     @}
3782   foo (x);
3784 @end group
3785 @end smallexample
3787 @noindent
3788 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3789 always initialized, but GCC doesn't know this. To suppress the
3790 warning, you need to provide a default case with assert(0) or
3791 similar code.
3793 @cindex @code{longjmp} warnings
3794 This option also warns when a non-volatile automatic variable might be
3795 changed by a call to @code{longjmp}.  These warnings as well are possible
3796 only in optimizing compilation.
3798 The compiler sees only the calls to @code{setjmp}.  It cannot know
3799 where @code{longjmp} will be called; in fact, a signal handler could
3800 call it at any point in the code.  As a result, you may get a warning
3801 even when there is in fact no problem because @code{longjmp} cannot
3802 in fact be called at the place that would cause a problem.
3804 Some spurious warnings can be avoided if you declare all the functions
3805 you use that never return as @code{noreturn}.  @xref{Function
3806 Attributes}.
3808 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3810 @item -Wunknown-pragmas
3811 @opindex Wunknown-pragmas
3812 @opindex Wno-unknown-pragmas
3813 @cindex warning for unknown pragmas
3814 @cindex unknown pragmas, warning
3815 @cindex pragmas, warning of unknown
3816 Warn when a @code{#pragma} directive is encountered that is not understood by 
3817 GCC@.  If this command-line option is used, warnings are even issued
3818 for unknown pragmas in system header files.  This is not the case if
3819 the warnings are only enabled by the @option{-Wall} command-line option.
3821 @item -Wno-pragmas
3822 @opindex Wno-pragmas
3823 @opindex Wpragmas
3824 Do not warn about misuses of pragmas, such as incorrect parameters,
3825 invalid syntax, or conflicts between pragmas.  See also
3826 @option{-Wunknown-pragmas}.
3828 @item -Wstrict-aliasing
3829 @opindex Wstrict-aliasing
3830 @opindex Wno-strict-aliasing
3831 This option is only active when @option{-fstrict-aliasing} is active.
3832 It warns about code that might break the strict aliasing rules that the
3833 compiler is using for optimization.  The warning does not catch all
3834 cases, but does attempt to catch the more common pitfalls.  It is
3835 included in @option{-Wall}.
3836 It is equivalent to @option{-Wstrict-aliasing=3}
3838 @item -Wstrict-aliasing=n
3839 @opindex Wstrict-aliasing=n
3840 This option is only active when @option{-fstrict-aliasing} is active.
3841 It warns about code that might break the strict aliasing rules that the
3842 compiler is using for optimization.
3843 Higher levels correspond to higher accuracy (fewer false positives).
3844 Higher levels also correspond to more effort, similar to the way @option{-O} 
3845 works.
3846 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3848 Level 1: Most aggressive, quick, least accurate.
3849 Possibly useful when higher levels
3850 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3851 false negatives.  However, it has many false positives.
3852 Warns for all pointer conversions between possibly incompatible types,
3853 even if never dereferenced.  Runs in the front end only.
3855 Level 2: Aggressive, quick, not too precise.
3856 May still have many false positives (not as many as level 1 though),
3857 and few false negatives (but possibly more than level 1).
3858 Unlike level 1, it only warns when an address is taken.  Warns about
3859 incomplete types.  Runs in the front end only.
3861 Level 3 (default for @option{-Wstrict-aliasing}):
3862 Should have very few false positives and few false
3863 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3864 Takes care of the common pun+dereference pattern in the front end:
3865 @code{*(int*)&some_float}.
3866 If optimization is enabled, it also runs in the back end, where it deals
3867 with multiple statement cases using flow-sensitive points-to information.
3868 Only warns when the converted pointer is dereferenced.
3869 Does not warn about incomplete types.
3871 @item -Wstrict-overflow
3872 @itemx -Wstrict-overflow=@var{n}
3873 @opindex Wstrict-overflow
3874 @opindex Wno-strict-overflow
3875 This option is only active when @option{-fstrict-overflow} is active.
3876 It warns about cases where the compiler optimizes based on the
3877 assumption that signed overflow does not occur.  Note that it does not
3878 warn about all cases where the code might overflow: it only warns
3879 about cases where the compiler implements some optimization.  Thus
3880 this warning depends on the optimization level.
3882 An optimization that assumes that signed overflow does not occur is
3883 perfectly safe if the values of the variables involved are such that
3884 overflow never does, in fact, occur.  Therefore this warning can
3885 easily give a false positive: a warning about code that is not
3886 actually a problem.  To help focus on important issues, several
3887 warning levels are defined.  No warnings are issued for the use of
3888 undefined signed overflow when estimating how many iterations a loop
3889 requires, in particular when determining whether a loop will be
3890 executed at all.
3892 @table @gcctabopt
3893 @item -Wstrict-overflow=1
3894 Warn about cases that are both questionable and easy to avoid.  For
3895 example,  with @option{-fstrict-overflow}, the compiler simplifies
3896 @code{x + 1 > x} to @code{1}.  This level of
3897 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3898 are not, and must be explicitly requested.
3900 @item -Wstrict-overflow=2
3901 Also warn about other cases where a comparison is simplified to a
3902 constant.  For example: @code{abs (x) >= 0}.  This can only be
3903 simplified when @option{-fstrict-overflow} is in effect, because
3904 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3905 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3906 @option{-Wstrict-overflow=2}.
3908 @item -Wstrict-overflow=3
3909 Also warn about other cases where a comparison is simplified.  For
3910 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3912 @item -Wstrict-overflow=4
3913 Also warn about other simplifications not covered by the above cases.
3914 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3916 @item -Wstrict-overflow=5
3917 Also warn about cases where the compiler reduces the magnitude of a
3918 constant involved in a comparison.  For example: @code{x + 2 > y} is
3919 simplified to @code{x + 1 >= y}.  This is reported only at the
3920 highest warning level because this simplification applies to many
3921 comparisons, so this warning level gives a very large number of
3922 false positives.
3923 @end table
3925 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3926 @opindex Wsuggest-attribute=
3927 @opindex Wno-suggest-attribute=
3928 Warn for cases where adding an attribute may be beneficial. The
3929 attributes currently supported are listed below.
3931 @table @gcctabopt
3932 @item -Wsuggest-attribute=pure
3933 @itemx -Wsuggest-attribute=const
3934 @itemx -Wsuggest-attribute=noreturn
3935 @opindex Wsuggest-attribute=pure
3936 @opindex Wno-suggest-attribute=pure
3937 @opindex Wsuggest-attribute=const
3938 @opindex Wno-suggest-attribute=const
3939 @opindex Wsuggest-attribute=noreturn
3940 @opindex Wno-suggest-attribute=noreturn
3942 Warn about functions that might be candidates for attributes
3943 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3944 functions visible in other compilation units or (in the case of @code{pure} and
3945 @code{const}) if it cannot prove that the function returns normally. A function
3946 returns normally if it doesn't contain an infinite loop or return abnormally
3947 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3948 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3949 higher.  Higher optimization levels improve the accuracy of the analysis.
3951 @item -Wsuggest-attribute=format
3952 @itemx -Wmissing-format-attribute
3953 @opindex Wsuggest-attribute=format
3954 @opindex Wmissing-format-attribute
3955 @opindex Wno-suggest-attribute=format
3956 @opindex Wno-missing-format-attribute
3957 @opindex Wformat
3958 @opindex Wno-format
3960 Warn about function pointers that might be candidates for @code{format}
3961 attributes.  Note these are only possible candidates, not absolute ones.
3962 GCC guesses that function pointers with @code{format} attributes that
3963 are used in assignment, initialization, parameter passing or return
3964 statements should have a corresponding @code{format} attribute in the
3965 resulting type.  I.e.@: the left-hand side of the assignment or
3966 initialization, the type of the parameter variable, or the return type
3967 of the containing function respectively should also have a @code{format}
3968 attribute to avoid the warning.
3970 GCC also warns about function definitions that might be
3971 candidates for @code{format} attributes.  Again, these are only
3972 possible candidates.  GCC guesses that @code{format} attributes
3973 might be appropriate for any function that calls a function like
3974 @code{vprintf} or @code{vscanf}, but this might not always be the
3975 case, and some functions for which @code{format} attributes are
3976 appropriate may not be detected.
3977 @end table
3979 @item -Warray-bounds
3980 @opindex Wno-array-bounds
3981 @opindex Warray-bounds
3982 This option is only active when @option{-ftree-vrp} is active
3983 (default for @option{-O2} and above). It warns about subscripts to arrays
3984 that are always out of bounds. This warning is enabled by @option{-Wall}.
3986 @item -Wno-div-by-zero
3987 @opindex Wno-div-by-zero
3988 @opindex Wdiv-by-zero
3989 Do not warn about compile-time integer division by zero.  Floating-point
3990 division by zero is not warned about, as it can be a legitimate way of
3991 obtaining infinities and NaNs.
3993 @item -Wsystem-headers
3994 @opindex Wsystem-headers
3995 @opindex Wno-system-headers
3996 @cindex warnings from system headers
3997 @cindex system headers, warnings from
3998 Print warning messages for constructs found in system header files.
3999 Warnings from system headers are normally suppressed, on the assumption
4000 that they usually do not indicate real problems and would only make the
4001 compiler output harder to read.  Using this command-line option tells
4002 GCC to emit warnings from system headers as if they occurred in user
4003 code.  However, note that using @option{-Wall} in conjunction with this
4004 option does @emph{not} warn about unknown pragmas in system
4005 headers---for that, @option{-Wunknown-pragmas} must also be used.
4007 @item -Wtrampolines
4008 @opindex Wtrampolines
4009 @opindex Wno-trampolines
4010  Warn about trampolines generated for pointers to nested functions.
4012  A trampoline is a small piece of data or code that is created at run
4013  time on the stack when the address of a nested function is taken, and
4014  is used to call the nested function indirectly.  For some targets, it
4015  is made up of data only and thus requires no special treatment.  But,
4016  for most targets, it is made up of code and thus requires the stack
4017  to be made executable in order for the program to work properly.
4019 @item -Wfloat-equal
4020 @opindex Wfloat-equal
4021 @opindex Wno-float-equal
4022 Warn if floating-point values are used in equality comparisons.
4024 The idea behind this is that sometimes it is convenient (for the
4025 programmer) to consider floating-point values as approximations to
4026 infinitely precise real numbers.  If you are doing this, then you need
4027 to compute (by analyzing the code, or in some other way) the maximum or
4028 likely maximum error that the computation introduces, and allow for it
4029 when performing comparisons (and when producing output, but that's a
4030 different problem).  In particular, instead of testing for equality, you
4031 should check to see whether the two values have ranges that overlap; and
4032 this is done with the relational operators, so equality comparisons are
4033 probably mistaken.
4035 @item -Wtraditional @r{(C and Objective-C only)}
4036 @opindex Wtraditional
4037 @opindex Wno-traditional
4038 Warn about certain constructs that behave differently in traditional and
4039 ISO C@.  Also warn about ISO C constructs that have no traditional C
4040 equivalent, and/or problematic constructs that should be avoided.
4042 @itemize @bullet
4043 @item
4044 Macro parameters that appear within string literals in the macro body.
4045 In traditional C macro replacement takes place within string literals,
4046 but in ISO C it does not.
4048 @item
4049 In traditional C, some preprocessor directives did not exist.
4050 Traditional preprocessors only considered a line to be a directive
4051 if the @samp{#} appeared in column 1 on the line.  Therefore
4052 @option{-Wtraditional} warns about directives that traditional C
4053 understands but ignores because the @samp{#} does not appear as the
4054 first character on the line.  It also suggests you hide directives like
4055 @samp{#pragma} not understood by traditional C by indenting them.  Some
4056 traditional implementations do not recognize @samp{#elif}, so this option
4057 suggests avoiding it altogether.
4059 @item
4060 A function-like macro that appears without arguments.
4062 @item
4063 The unary plus operator.
4065 @item
4066 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4067 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4068 constants.)  Note, these suffixes appear in macros defined in the system
4069 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4070 Use of these macros in user code might normally lead to spurious
4071 warnings, however GCC's integrated preprocessor has enough context to
4072 avoid warning in these cases.
4074 @item
4075 A function declared external in one block and then used after the end of
4076 the block.
4078 @item
4079 A @code{switch} statement has an operand of type @code{long}.
4081 @item
4082 A non-@code{static} function declaration follows a @code{static} one.
4083 This construct is not accepted by some traditional C compilers.
4085 @item
4086 The ISO type of an integer constant has a different width or
4087 signedness from its traditional type.  This warning is only issued if
4088 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4089 typically represent bit patterns, are not warned about.
4091 @item
4092 Usage of ISO string concatenation is detected.
4094 @item
4095 Initialization of automatic aggregates.
4097 @item
4098 Identifier conflicts with labels.  Traditional C lacks a separate
4099 namespace for labels.
4101 @item
4102 Initialization of unions.  If the initializer is zero, the warning is
4103 omitted.  This is done under the assumption that the zero initializer in
4104 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4105 initializer warnings and relies on default initialization to zero in the
4106 traditional C case.
4108 @item
4109 Conversions by prototypes between fixed/floating-point values and vice
4110 versa.  The absence of these prototypes when compiling with traditional
4111 C causes serious problems.  This is a subset of the possible
4112 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4114 @item
4115 Use of ISO C style function definitions.  This warning intentionally is
4116 @emph{not} issued for prototype declarations or variadic functions
4117 because these ISO C features appear in your code when using
4118 libiberty's traditional C compatibility macros, @code{PARAMS} and
4119 @code{VPARAMS}.  This warning is also bypassed for nested functions
4120 because that feature is already a GCC extension and thus not relevant to
4121 traditional C compatibility.
4122 @end itemize
4124 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4125 @opindex Wtraditional-conversion
4126 @opindex Wno-traditional-conversion
4127 Warn if a prototype causes a type conversion that is different from what
4128 would happen to the same argument in the absence of a prototype.  This
4129 includes conversions of fixed point to floating and vice versa, and
4130 conversions changing the width or signedness of a fixed-point argument
4131 except when the same as the default promotion.
4133 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4134 @opindex Wdeclaration-after-statement
4135 @opindex Wno-declaration-after-statement
4136 Warn when a declaration is found after a statement in a block.  This
4137 construct, known from C++, was introduced with ISO C99 and is by default
4138 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4139 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4141 @item -Wundef
4142 @opindex Wundef
4143 @opindex Wno-undef
4144 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4146 @item -Wno-endif-labels
4147 @opindex Wno-endif-labels
4148 @opindex Wendif-labels
4149 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4151 @item -Wshadow
4152 @opindex Wshadow
4153 @opindex Wno-shadow
4154 Warn whenever a local variable or type declaration shadows another variable,
4155 parameter, type, or class member (in C++), or whenever a built-in function
4156 is shadowed. Note that in C++, the compiler warns if a local variable
4157 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4159 @item -Wlarger-than=@var{len}
4160 @opindex Wlarger-than=@var{len}
4161 @opindex Wlarger-than-@var{len}
4162 Warn whenever an object of larger than @var{len} bytes is defined.
4164 @item -Wframe-larger-than=@var{len}
4165 @opindex Wframe-larger-than
4166 Warn if the size of a function frame is larger than @var{len} bytes.
4167 The computation done to determine the stack frame size is approximate
4168 and not conservative.
4169 The actual requirements may be somewhat greater than @var{len}
4170 even if you do not get a warning.  In addition, any space allocated
4171 via @code{alloca}, variable-length arrays, or related constructs
4172 is not included by the compiler when determining
4173 whether or not to issue a warning.
4175 @item -Wno-free-nonheap-object
4176 @opindex Wno-free-nonheap-object
4177 @opindex Wfree-nonheap-object
4178 Do not warn when attempting to free an object that was not allocated
4179 on the heap.
4181 @item -Wstack-usage=@var{len}
4182 @opindex Wstack-usage
4183 Warn if the stack usage of a function might be larger than @var{len} bytes.
4184 The computation done to determine the stack usage is conservative.
4185 Any space allocated via @code{alloca}, variable-length arrays, or related
4186 constructs is included by the compiler when determining whether or not to
4187 issue a warning.
4189 The message is in keeping with the output of @option{-fstack-usage}.
4191 @itemize
4192 @item
4193 If the stack usage is fully static but exceeds the specified amount, it's:
4195 @smallexample
4196   warning: stack usage is 1120 bytes
4197 @end smallexample
4198 @item
4199 If the stack usage is (partly) dynamic but bounded, it's:
4201 @smallexample
4202   warning: stack usage might be 1648 bytes
4203 @end smallexample
4204 @item
4205 If the stack usage is (partly) dynamic and not bounded, it's:
4207 @smallexample
4208   warning: stack usage might be unbounded
4209 @end smallexample
4210 @end itemize
4212 @item -Wunsafe-loop-optimizations
4213 @opindex Wunsafe-loop-optimizations
4214 @opindex Wno-unsafe-loop-optimizations
4215 Warn if the loop cannot be optimized because the compiler cannot
4216 assume anything on the bounds of the loop indices.  With
4217 @option{-funsafe-loop-optimizations} warn if the compiler makes
4218 such assumptions.
4220 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4221 @opindex Wno-pedantic-ms-format
4222 @opindex Wpedantic-ms-format
4223 When used in combination with @option{-Wformat}
4224 and @option{-pedantic} without GNU extensions, this option
4225 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4226 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4227 which depend on the MS runtime.
4229 @item -Wpointer-arith
4230 @opindex Wpointer-arith
4231 @opindex Wno-pointer-arith
4232 Warn about anything that depends on the ``size of'' a function type or
4233 of @code{void}.  GNU C assigns these types a size of 1, for
4234 convenience in calculations with @code{void *} pointers and pointers
4235 to functions.  In C++, warn also when an arithmetic operation involves
4236 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4238 @item -Wtype-limits
4239 @opindex Wtype-limits
4240 @opindex Wno-type-limits
4241 Warn if a comparison is always true or always false due to the limited
4242 range of the data type, but do not warn for constant expressions.  For
4243 example, warn if an unsigned variable is compared against zero with
4244 @samp{<} or @samp{>=}.  This warning is also enabled by
4245 @option{-Wextra}.
4247 @item -Wbad-function-cast @r{(C and Objective-C only)}
4248 @opindex Wbad-function-cast
4249 @opindex Wno-bad-function-cast
4250 Warn whenever a function call is cast to a non-matching type.
4251 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4253 @item -Wc++-compat @r{(C and Objective-C only)}
4254 Warn about ISO C constructs that are outside of the common subset of
4255 ISO C and ISO C++, e.g.@: request for implicit conversion from
4256 @code{void *} to a pointer to non-@code{void} type.
4258 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4259 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4260 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4261 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4262 enabled by @option{-Wall}.
4264 @item -Wcast-qual
4265 @opindex Wcast-qual
4266 @opindex Wno-cast-qual
4267 Warn whenever a pointer is cast so as to remove a type qualifier from
4268 the target type.  For example, warn if a @code{const char *} is cast
4269 to an ordinary @code{char *}.
4271 Also warn when making a cast that introduces a type qualifier in an
4272 unsafe way.  For example, casting @code{char **} to @code{const char **}
4273 is unsafe, as in this example:
4275 @smallexample
4276   /* p is char ** value.  */
4277   const char **q = (const char **) p;
4278   /* Assignment of readonly string to const char * is OK.  */
4279   *q = "string";
4280   /* Now char** pointer points to read-only memory.  */
4281   **p = 'b';
4282 @end smallexample
4284 @item -Wcast-align
4285 @opindex Wcast-align
4286 @opindex Wno-cast-align
4287 Warn whenever a pointer is cast such that the required alignment of the
4288 target is increased.  For example, warn if a @code{char *} is cast to
4289 an @code{int *} on machines where integers can only be accessed at
4290 two- or four-byte boundaries.
4292 @item -Wwrite-strings
4293 @opindex Wwrite-strings
4294 @opindex Wno-write-strings
4295 When compiling C, give string constants the type @code{const
4296 char[@var{length}]} so that copying the address of one into a
4297 non-@code{const} @code{char *} pointer produces a warning.  These
4298 warnings help you find at compile time code that can try to write
4299 into a string constant, but only if you have been very careful about
4300 using @code{const} in declarations and prototypes.  Otherwise, it is
4301 just a nuisance. This is why we did not make @option{-Wall} request
4302 these warnings.
4304 When compiling C++, warn about the deprecated conversion from string
4305 literals to @code{char *}.  This warning is enabled by default for C++
4306 programs.
4308 @item -Wclobbered
4309 @opindex Wclobbered
4310 @opindex Wno-clobbered
4311 Warn for variables that might be changed by @samp{longjmp} or
4312 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4314 @item -Wconversion
4315 @opindex Wconversion
4316 @opindex Wno-conversion
4317 Warn for implicit conversions that may alter a value. This includes
4318 conversions between real and integer, like @code{abs (x)} when
4319 @code{x} is @code{double}; conversions between signed and unsigned,
4320 like @code{unsigned ui = -1}; and conversions to smaller types, like
4321 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4322 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4323 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4324 conversions between signed and unsigned integers can be disabled by
4325 using @option{-Wno-sign-conversion}.
4327 For C++, also warn for confusing overload resolution for user-defined
4328 conversions; and conversions that never use a type conversion
4329 operator: conversions to @code{void}, the same type, a base class or a
4330 reference to them. Warnings about conversions between signed and
4331 unsigned integers are disabled by default in C++ unless
4332 @option{-Wsign-conversion} is explicitly enabled.
4334 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4335 @opindex Wconversion-null
4336 @opindex Wno-conversion-null
4337 Do not warn for conversions between @code{NULL} and non-pointer
4338 types. @option{-Wconversion-null} is enabled by default.
4340 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4341 @opindex Wzero-as-null-pointer-constant
4342 @opindex Wno-zero-as-null-pointer-constant
4343 Warn when a literal '0' is used as null pointer constant.  This can
4344 be useful to facilitate the conversion to @code{nullptr} in C++11.
4346 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4347 @opindex Wuseless-cast
4348 @opindex Wno-useless-cast
4349 Warn when an expression is casted to its own type.
4351 @item -Wempty-body
4352 @opindex Wempty-body
4353 @opindex Wno-empty-body
4354 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4355 while} statement.  This warning is also enabled by @option{-Wextra}.
4357 @item -Wenum-compare
4358 @opindex Wenum-compare
4359 @opindex Wno-enum-compare
4360 Warn about a comparison between values of different enumerated types.
4361 In C++ enumeral mismatches in conditional expressions are also
4362 diagnosed and the warning is enabled by default.  In C this warning is 
4363 enabled by @option{-Wall}.
4365 @item -Wjump-misses-init @r{(C, Objective-C only)}
4366 @opindex Wjump-misses-init
4367 @opindex Wno-jump-misses-init
4368 Warn if a @code{goto} statement or a @code{switch} statement jumps
4369 forward across the initialization of a variable, or jumps backward to a
4370 label after the variable has been initialized.  This only warns about
4371 variables that are initialized when they are declared.  This warning is
4372 only supported for C and Objective-C; in C++ this sort of branch is an
4373 error in any case.
4375 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4376 can be disabled with the @option{-Wno-jump-misses-init} option.
4378 @item -Wsign-compare
4379 @opindex Wsign-compare
4380 @opindex Wno-sign-compare
4381 @cindex warning for comparison of signed and unsigned values
4382 @cindex comparison of signed and unsigned values, warning
4383 @cindex signed and unsigned values, comparison warning
4384 Warn when a comparison between signed and unsigned values could produce
4385 an incorrect result when the signed value is converted to unsigned.
4386 This warning is also enabled by @option{-Wextra}; to get the other warnings
4387 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4389 @item -Wsign-conversion
4390 @opindex Wsign-conversion
4391 @opindex Wno-sign-conversion
4392 Warn for implicit conversions that may change the sign of an integer
4393 value, like assigning a signed integer expression to an unsigned
4394 integer variable. An explicit cast silences the warning. In C, this
4395 option is enabled also by @option{-Wconversion}.
4397 @item -Wsizeof-pointer-memaccess
4398 @opindex Wsizeof-pointer-memaccess
4399 @opindex Wno-sizeof-pointer-memaccess
4400 Warn for suspicious length parameters to certain string and memory built-in
4401 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4402 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4403 but a pointer, and suggests a possible fix, or about
4404 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4405 @option{-Wall}.
4407 @item -Waddress
4408 @opindex Waddress
4409 @opindex Wno-address
4410 Warn about suspicious uses of memory addresses. These include using
4411 the address of a function in a conditional expression, such as
4412 @code{void func(void); if (func)}, and comparisons against the memory
4413 address of a string literal, such as @code{if (x == "abc")}.  Such
4414 uses typically indicate a programmer error: the address of a function
4415 always evaluates to true, so their use in a conditional usually
4416 indicate that the programmer forgot the parentheses in a function
4417 call; and comparisons against string literals result in unspecified
4418 behavior and are not portable in C, so they usually indicate that the
4419 programmer intended to use @code{strcmp}.  This warning is enabled by
4420 @option{-Wall}.
4422 @item -Wlogical-op
4423 @opindex Wlogical-op
4424 @opindex Wno-logical-op
4425 Warn about suspicious uses of logical operators in expressions.
4426 This includes using logical operators in contexts where a
4427 bit-wise operator is likely to be expected.
4429 @item -Waggregate-return
4430 @opindex Waggregate-return
4431 @opindex Wno-aggregate-return
4432 Warn if any functions that return structures or unions are defined or
4433 called.  (In languages where you can return an array, this also elicits
4434 a warning.)
4436 @item -Wno-aggressive-loop-optimizations
4437 @opindex Wno-aggressive-loop-optimizations
4438 @opindex Waggressive-loop-optimizations
4439 Warn if in a loop with constant number of iterations the compiler detects
4440 undefined behavior in some statement during one or more of the iterations.
4442 @item -Wno-attributes
4443 @opindex Wno-attributes
4444 @opindex Wattributes
4445 Do not warn if an unexpected @code{__attribute__} is used, such as
4446 unrecognized attributes, function attributes applied to variables,
4447 etc.  This does not stop errors for incorrect use of supported
4448 attributes.
4450 @item -Wno-builtin-macro-redefined
4451 @opindex Wno-builtin-macro-redefined
4452 @opindex Wbuiltin-macro-redefined
4453 Do not warn if certain built-in macros are redefined.  This suppresses
4454 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4455 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4457 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4458 @opindex Wstrict-prototypes
4459 @opindex Wno-strict-prototypes
4460 Warn if a function is declared or defined without specifying the
4461 argument types.  (An old-style function definition is permitted without
4462 a warning if preceded by a declaration that specifies the argument
4463 types.)
4465 @item -Wold-style-declaration @r{(C and Objective-C only)}
4466 @opindex Wold-style-declaration
4467 @opindex Wno-old-style-declaration
4468 Warn for obsolescent usages, according to the C Standard, in a
4469 declaration. For example, warn if storage-class specifiers like
4470 @code{static} are not the first things in a declaration.  This warning
4471 is also enabled by @option{-Wextra}.
4473 @item -Wold-style-definition @r{(C and Objective-C only)}
4474 @opindex Wold-style-definition
4475 @opindex Wno-old-style-definition
4476 Warn if an old-style function definition is used.  A warning is given
4477 even if there is a previous prototype.
4479 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4480 @opindex Wmissing-parameter-type
4481 @opindex Wno-missing-parameter-type
4482 A function parameter is declared without a type specifier in K&R-style
4483 functions:
4485 @smallexample
4486 void foo(bar) @{ @}
4487 @end smallexample
4489 This warning is also enabled by @option{-Wextra}.
4491 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4492 @opindex Wmissing-prototypes
4493 @opindex Wno-missing-prototypes
4494 Warn if a global function is defined without a previous prototype
4495 declaration.  This warning is issued even if the definition itself
4496 provides a prototype.  Use this option to detect global functions
4497 that do not have a matching prototype declaration in a header file.
4498 This option is not valid for C++ because all function declarations
4499 provide prototypes and a non-matching declaration will declare an
4500 overload rather than conflict with an earlier declaration.
4501 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4503 @item -Wmissing-declarations
4504 @opindex Wmissing-declarations
4505 @opindex Wno-missing-declarations
4506 Warn if a global function is defined without a previous declaration.
4507 Do so even if the definition itself provides a prototype.
4508 Use this option to detect global functions that are not declared in
4509 header files.  In C, no warnings are issued for functions with previous
4510 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4511 missing prototypes.  In C++, no warnings are issued for function templates,
4512 or for inline functions, or for functions in anonymous namespaces.
4514 @item -Wmissing-field-initializers
4515 @opindex Wmissing-field-initializers
4516 @opindex Wno-missing-field-initializers
4517 @opindex W
4518 @opindex Wextra
4519 @opindex Wno-extra
4520 Warn if a structure's initializer has some fields missing.  For
4521 example, the following code causes such a warning, because
4522 @code{x.h} is implicitly zero:
4524 @smallexample
4525 struct s @{ int f, g, h; @};
4526 struct s x = @{ 3, 4 @};
4527 @end smallexample
4529 This option does not warn about designated initializers, so the following
4530 modification does not trigger a warning:
4532 @smallexample
4533 struct s @{ int f, g, h; @};
4534 struct s x = @{ .f = 3, .g = 4 @};
4535 @end smallexample
4537 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4538 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4540 @item -Wno-multichar
4541 @opindex Wno-multichar
4542 @opindex Wmultichar
4543 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4544 Usually they indicate a typo in the user's code, as they have
4545 implementation-defined values, and should not be used in portable code.
4547 @item -Wnormalized=<none|id|nfc|nfkc>
4548 @opindex Wnormalized=
4549 @cindex NFC
4550 @cindex NFKC
4551 @cindex character set, input normalization
4552 In ISO C and ISO C++, two identifiers are different if they are
4553 different sequences of characters.  However, sometimes when characters
4554 outside the basic ASCII character set are used, you can have two
4555 different character sequences that look the same.  To avoid confusion,
4556 the ISO 10646 standard sets out some @dfn{normalization rules} which
4557 when applied ensure that two sequences that look the same are turned into
4558 the same sequence.  GCC can warn you if you are using identifiers that
4559 have not been normalized; this option controls that warning.
4561 There are four levels of warning supported by GCC@.  The default is
4562 @option{-Wnormalized=nfc}, which warns about any identifier that is
4563 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4564 recommended form for most uses.
4566 Unfortunately, there are some characters allowed in identifiers by
4567 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4568 identifiers.  That is, there's no way to use these symbols in portable
4569 ISO C or C++ and have all your identifiers in NFC@.
4570 @option{-Wnormalized=id} suppresses the warning for these characters.
4571 It is hoped that future versions of the standards involved will correct
4572 this, which is why this option is not the default.
4574 You can switch the warning off for all characters by writing
4575 @option{-Wnormalized=none}.  You should only do this if you
4576 are using some other normalization scheme (like ``D''), because
4577 otherwise you can easily create bugs that are literally impossible to see.
4579 Some characters in ISO 10646 have distinct meanings but look identical
4580 in some fonts or display methodologies, especially once formatting has
4581 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4582 LETTER N'', displays just like a regular @code{n} that has been
4583 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4584 normalization scheme to convert all these into a standard form as
4585 well, and GCC warns if your code is not in NFKC if you use
4586 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4587 about every identifier that contains the letter O because it might be
4588 confused with the digit 0, and so is not the default, but may be
4589 useful as a local coding convention if the programming environment 
4590 cannot be fixed to display these characters distinctly.
4592 @item -Wno-deprecated
4593 @opindex Wno-deprecated
4594 @opindex Wdeprecated
4595 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4597 @item -Wno-deprecated-declarations
4598 @opindex Wno-deprecated-declarations
4599 @opindex Wdeprecated-declarations
4600 Do not warn about uses of functions (@pxref{Function Attributes}),
4601 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4602 Attributes}) marked as deprecated by using the @code{deprecated}
4603 attribute.
4605 @item -Wno-overflow
4606 @opindex Wno-overflow
4607 @opindex Woverflow
4608 Do not warn about compile-time overflow in constant expressions.
4610 @item -Woverride-init @r{(C and Objective-C only)}
4611 @opindex Woverride-init
4612 @opindex Wno-override-init
4613 @opindex W
4614 @opindex Wextra
4615 @opindex Wno-extra
4616 Warn if an initialized field without side effects is overridden when
4617 using designated initializers (@pxref{Designated Inits, , Designated
4618 Initializers}).
4620 This warning is included in @option{-Wextra}.  To get other
4621 @option{-Wextra} warnings without this one, use @option{-Wextra
4622 -Wno-override-init}.
4624 @item -Wpacked
4625 @opindex Wpacked
4626 @opindex Wno-packed
4627 Warn if a structure is given the packed attribute, but the packed
4628 attribute has no effect on the layout or size of the structure.
4629 Such structures may be mis-aligned for little benefit.  For
4630 instance, in this code, the variable @code{f.x} in @code{struct bar}
4631 is misaligned even though @code{struct bar} does not itself
4632 have the packed attribute:
4634 @smallexample
4635 @group
4636 struct foo @{
4637   int x;
4638   char a, b, c, d;
4639 @} __attribute__((packed));
4640 struct bar @{
4641   char z;
4642   struct foo f;
4644 @end group
4645 @end smallexample
4647 @item -Wpacked-bitfield-compat
4648 @opindex Wpacked-bitfield-compat
4649 @opindex Wno-packed-bitfield-compat
4650 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4651 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4652 the change can lead to differences in the structure layout.  GCC
4653 informs you when the offset of such a field has changed in GCC 4.4.
4654 For example there is no longer a 4-bit padding between field @code{a}
4655 and @code{b} in this structure:
4657 @smallexample
4658 struct foo
4660   char a:4;
4661   char b:8;
4662 @} __attribute__ ((packed));
4663 @end smallexample
4665 This warning is enabled by default.  Use
4666 @option{-Wno-packed-bitfield-compat} to disable this warning.
4668 @item -Wpadded
4669 @opindex Wpadded
4670 @opindex Wno-padded
4671 Warn if padding is included in a structure, either to align an element
4672 of the structure or to align the whole structure.  Sometimes when this
4673 happens it is possible to rearrange the fields of the structure to
4674 reduce the padding and so make the structure smaller.
4676 @item -Wredundant-decls
4677 @opindex Wredundant-decls
4678 @opindex Wno-redundant-decls
4679 Warn if anything is declared more than once in the same scope, even in
4680 cases where multiple declaration is valid and changes nothing.
4682 @item -Wnested-externs @r{(C and Objective-C only)}
4683 @opindex Wnested-externs
4684 @opindex Wno-nested-externs
4685 Warn if an @code{extern} declaration is encountered within a function.
4687 @item -Wno-inherited-variadic-ctor
4688 @opindex Winherited-variadic-ctor
4689 @opindex Wno-inherited-variadic-ctor
4690 Suppress warnings about use of C++11 inheriting constructors when the
4691 base class inherited from has a C variadic constructor; the warning is
4692 on by default because the ellipsis is not inherited.
4694 @item -Winline
4695 @opindex Winline
4696 @opindex Wno-inline
4697 Warn if a function that is declared as inline cannot be inlined.
4698 Even with this option, the compiler does not warn about failures to
4699 inline functions declared in system headers.
4701 The compiler uses a variety of heuristics to determine whether or not
4702 to inline a function.  For example, the compiler takes into account
4703 the size of the function being inlined and the amount of inlining
4704 that has already been done in the current function.  Therefore,
4705 seemingly insignificant changes in the source program can cause the
4706 warnings produced by @option{-Winline} to appear or disappear.
4708 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4709 @opindex Wno-invalid-offsetof
4710 @opindex Winvalid-offsetof
4711 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4712 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4713 to a non-POD type is undefined.  In existing C++ implementations,
4714 however, @samp{offsetof} typically gives meaningful results even when
4715 applied to certain kinds of non-POD types (such as a simple
4716 @samp{struct} that fails to be a POD type only by virtue of having a
4717 constructor).  This flag is for users who are aware that they are
4718 writing nonportable code and who have deliberately chosen to ignore the
4719 warning about it.
4721 The restrictions on @samp{offsetof} may be relaxed in a future version
4722 of the C++ standard.
4724 @item -Wno-int-to-pointer-cast
4725 @opindex Wno-int-to-pointer-cast
4726 @opindex Wint-to-pointer-cast
4727 Suppress warnings from casts to pointer type of an integer of a
4728 different size. In C++, casting to a pointer type of smaller size is
4729 an error. @option{Wint-to-pointer-cast} is enabled by default.
4732 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4733 @opindex Wno-pointer-to-int-cast
4734 @opindex Wpointer-to-int-cast
4735 Suppress warnings from casts from a pointer to an integer type of a
4736 different size.
4738 @item -Winvalid-pch
4739 @opindex Winvalid-pch
4740 @opindex Wno-invalid-pch
4741 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4742 the search path but can't be used.
4744 @item -Wlong-long
4745 @opindex Wlong-long
4746 @opindex Wno-long-long
4747 Warn if @samp{long long} type is used.  This is enabled by either
4748 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4749 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4751 @item -Wvariadic-macros
4752 @opindex Wvariadic-macros
4753 @opindex Wno-variadic-macros
4754 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4755 alternate syntax when in pedantic ISO C99 mode.  This is default.
4756 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4758 @item -Wvarargs
4759 @opindex Wvarargs
4760 @opindex Wno-varargs
4761 Warn upon questionable usage of the macros used to handle variable
4762 arguments like @samp{va_start}.  This is default.  To inhibit the
4763 warning messages, use @option{-Wno-varargs}.
4765 @item -Wvector-operation-performance
4766 @opindex Wvector-operation-performance
4767 @opindex Wno-vector-operation-performance
4768 Warn if vector operation is not implemented via SIMD capabilities of the
4769 architecture.  Mainly useful for the performance tuning.
4770 Vector operation can be implemented @code{piecewise}, which means that the
4771 scalar operation is performed on every vector element; 
4772 @code{in parallel}, which means that the vector operation is implemented
4773 using scalars of wider type, which normally is more performance efficient;
4774 and @code{as a single scalar}, which means that vector fits into a
4775 scalar type.
4777 @item -Wno-virtual-move-assign
4778 @opindex Wvirtual-move-assign
4779 @opindex Wno-virtual-move-assign
4780 Suppress warnings about inheriting from a virtual base with a
4781 non-trivial C++11 move assignment operator.  This is dangerous because
4782 if the virtual base is reachable along more than one path, it will be
4783 moved multiple times, which can mean both objects end up in the
4784 moved-from state.  If the move assignment operator is written to avoid
4785 moving from a moved-from object, this warning can be disabled.
4787 @item -Wvla
4788 @opindex Wvla
4789 @opindex Wno-vla
4790 Warn if variable length array is used in the code.
4791 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4792 the variable length array.
4794 @item -Wvolatile-register-var
4795 @opindex Wvolatile-register-var
4796 @opindex Wno-volatile-register-var
4797 Warn if a register variable is declared volatile.  The volatile
4798 modifier does not inhibit all optimizations that may eliminate reads
4799 and/or writes to register variables.  This warning is enabled by
4800 @option{-Wall}.
4802 @item -Wdisabled-optimization
4803 @opindex Wdisabled-optimization
4804 @opindex Wno-disabled-optimization
4805 Warn if a requested optimization pass is disabled.  This warning does
4806 not generally indicate that there is anything wrong with your code; it
4807 merely indicates that GCC's optimizers are unable to handle the code
4808 effectively.  Often, the problem is that your code is too big or too
4809 complex; GCC refuses to optimize programs when the optimization
4810 itself is likely to take inordinate amounts of time.
4812 @item -Wpointer-sign @r{(C and Objective-C only)}
4813 @opindex Wpointer-sign
4814 @opindex Wno-pointer-sign
4815 Warn for pointer argument passing or assignment with different signedness.
4816 This option is only supported for C and Objective-C@.  It is implied by
4817 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4818 @option{-Wno-pointer-sign}.
4820 @item -Wstack-protector
4821 @opindex Wstack-protector
4822 @opindex Wno-stack-protector
4823 This option is only active when @option{-fstack-protector} is active.  It
4824 warns about functions that are not protected against stack smashing.
4826 @item -Wno-mudflap
4827 @opindex Wno-mudflap
4828 Suppress warnings about constructs that cannot be instrumented by
4829 @option{-fmudflap}.
4831 @item -Woverlength-strings
4832 @opindex Woverlength-strings
4833 @opindex Wno-overlength-strings
4834 Warn about string constants that are longer than the ``minimum
4835 maximum'' length specified in the C standard.  Modern compilers
4836 generally allow string constants that are much longer than the
4837 standard's minimum limit, but very portable programs should avoid
4838 using longer strings.
4840 The limit applies @emph{after} string constant concatenation, and does
4841 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4842 C99, it was raised to 4095.  C++98 does not specify a normative
4843 minimum maximum, so we do not diagnose overlength strings in C++@.
4845 This option is implied by @option{-Wpedantic}, and can be disabled with
4846 @option{-Wno-overlength-strings}.
4848 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4849 @opindex Wunsuffixed-float-constants
4851 Issue a warning for any floating constant that does not have
4852 a suffix.  When used together with @option{-Wsystem-headers} it
4853 warns about such constants in system header files.  This can be useful
4854 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4855 from the decimal floating-point extension to C99.
4856 @end table
4858 @node Debugging Options
4859 @section Options for Debugging Your Program or GCC
4860 @cindex options, debugging
4861 @cindex debugging information options
4863 GCC has various special options that are used for debugging
4864 either your program or GCC:
4866 @table @gcctabopt
4867 @item -g
4868 @opindex g
4869 Produce debugging information in the operating system's native format
4870 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4871 information.
4873 On most systems that use stabs format, @option{-g} enables use of extra
4874 debugging information that only GDB can use; this extra information
4875 makes debugging work better in GDB but probably makes other debuggers
4876 crash or
4877 refuse to read the program.  If you want to control for certain whether
4878 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4879 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4881 GCC allows you to use @option{-g} with
4882 @option{-O}.  The shortcuts taken by optimized code may occasionally
4883 produce surprising results: some variables you declared may not exist
4884 at all; flow of control may briefly move where you did not expect it;
4885 some statements may not be executed because they compute constant
4886 results or their values are already at hand; some statements may
4887 execute in different places because they have been moved out of loops.
4889 Nevertheless it proves possible to debug optimized output.  This makes
4890 it reasonable to use the optimizer for programs that might have bugs.
4892 The following options are useful when GCC is generated with the
4893 capability for more than one debugging format.
4895 @item -gsplit-dwarf
4896 @opindex gsplit-dwarf
4897 Separate as much dwarf debugging information as possible into a
4898 separate output file with the extension .dwo.  This option allows
4899 the build system to avoid linking files with debug information.  To
4900 be useful, this option requires a debugger capable of reading .dwo
4901 files.
4903 @item -ggdb
4904 @opindex ggdb
4905 Produce debugging information for use by GDB@.  This means to use the
4906 most expressive format available (DWARF 2, stabs, or the native format
4907 if neither of those are supported), including GDB extensions if at all
4908 possible.
4910 @item -gpubnames
4911 @opindex gpubnames
4912 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4914 @item -gstabs
4915 @opindex gstabs
4916 Produce debugging information in stabs format (if that is supported),
4917 without GDB extensions.  This is the format used by DBX on most BSD
4918 systems.  On MIPS, Alpha and System V Release 4 systems this option
4919 produces stabs debugging output that is not understood by DBX or SDB@.
4920 On System V Release 4 systems this option requires the GNU assembler.
4922 @item -feliminate-unused-debug-symbols
4923 @opindex feliminate-unused-debug-symbols
4924 Produce debugging information in stabs format (if that is supported),
4925 for only symbols that are actually used.
4927 @item -femit-class-debug-always
4928 Instead of emitting debugging information for a C++ class in only one
4929 object file, emit it in all object files using the class.  This option
4930 should be used only with debuggers that are unable to handle the way GCC
4931 normally emits debugging information for classes because using this
4932 option increases the size of debugging information by as much as a
4933 factor of two.
4935 @item -fdebug-types-section
4936 @opindex fdebug-types-section
4937 @opindex fno-debug-types-section
4938 When using DWARF Version 4 or higher, type DIEs can be put into
4939 their own @code{.debug_types} section instead of making them part of the
4940 @code{.debug_info} section.  It is more efficient to put them in a separate
4941 comdat sections since the linker can then remove duplicates.
4942 But not all DWARF consumers support @code{.debug_types} sections yet
4943 and on some objects @code{.debug_types} produces larger instead of smaller
4944 debugging information.
4946 @item -gstabs+
4947 @opindex gstabs+
4948 Produce debugging information in stabs format (if that is supported),
4949 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4950 use of these extensions is likely to make other debuggers crash or
4951 refuse to read the program.
4953 @item -gcoff
4954 @opindex gcoff
4955 Produce debugging information in COFF format (if that is supported).
4956 This is the format used by SDB on most System V systems prior to
4957 System V Release 4.
4959 @item -gxcoff
4960 @opindex gxcoff
4961 Produce debugging information in XCOFF format (if that is supported).
4962 This is the format used by the DBX debugger on IBM RS/6000 systems.
4964 @item -gxcoff+
4965 @opindex gxcoff+
4966 Produce debugging information in XCOFF format (if that is supported),
4967 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4968 use of these extensions is likely to make other debuggers crash or
4969 refuse to read the program, and may cause assemblers other than the GNU
4970 assembler (GAS) to fail with an error.
4972 @item -gdwarf-@var{version}
4973 @opindex gdwarf-@var{version}
4974 Produce debugging information in DWARF format (if that is supported).
4975 The value of @var{version} may be either 2, 3 or 4; the default version
4976 for most targets is 4.
4978 Note that with DWARF Version 2, some ports require and always
4979 use some non-conflicting DWARF 3 extensions in the unwind tables.
4981 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4982 for maximum benefit.
4984 @item -grecord-gcc-switches
4985 @opindex grecord-gcc-switches
4986 This switch causes the command-line options used to invoke the
4987 compiler that may affect code generation to be appended to the
4988 DW_AT_producer attribute in DWARF debugging information.  The options
4989 are concatenated with spaces separating them from each other and from
4990 the compiler version.  See also @option{-frecord-gcc-switches} for another
4991 way of storing compiler options into the object file.  This is the default.
4993 @item -gno-record-gcc-switches
4994 @opindex gno-record-gcc-switches
4995 Disallow appending command-line options to the DW_AT_producer attribute
4996 in DWARF debugging information.
4998 @item -gstrict-dwarf
4999 @opindex gstrict-dwarf
5000 Disallow using extensions of later DWARF standard version than selected
5001 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5002 DWARF extensions from later standard versions is allowed.
5004 @item -gno-strict-dwarf
5005 @opindex gno-strict-dwarf
5006 Allow using extensions of later DWARF standard version than selected with
5007 @option{-gdwarf-@var{version}}.
5009 @item -gvms
5010 @opindex gvms
5011 Produce debugging information in Alpha/VMS debug format (if that is
5012 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5014 @item -g@var{level}
5015 @itemx -ggdb@var{level}
5016 @itemx -gstabs@var{level}
5017 @itemx -gcoff@var{level}
5018 @itemx -gxcoff@var{level}
5019 @itemx -gvms@var{level}
5020 Request debugging information and also use @var{level} to specify how
5021 much information.  The default level is 2.
5023 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5024 @option{-g}.
5026 Level 1 produces minimal information, enough for making backtraces in
5027 parts of the program that you don't plan to debug.  This includes
5028 descriptions of functions and external variables, but no information
5029 about local variables and no line numbers.
5031 Level 3 includes extra information, such as all the macro definitions
5032 present in the program.  Some debuggers support macro expansion when
5033 you use @option{-g3}.
5035 @option{-gdwarf-2} does not accept a concatenated debug level, because
5036 GCC used to support an option @option{-gdwarf} that meant to generate
5037 debug information in version 1 of the DWARF format (which is very
5038 different from version 2), and it would have been too confusing.  That
5039 debug format is long obsolete, but the option cannot be changed now.
5040 Instead use an additional @option{-g@var{level}} option to change the
5041 debug level for DWARF.
5043 @item -gtoggle
5044 @opindex gtoggle
5045 Turn off generation of debug info, if leaving out this option
5046 generates it, or turn it on at level 2 otherwise.  The position of this
5047 argument in the command line does not matter; it takes effect after all
5048 other options are processed, and it does so only once, no matter how
5049 many times it is given.  This is mainly intended to be used with
5050 @option{-fcompare-debug}.
5052 @item -fsanitize=address
5053 Enable AddressSanitizer, a fast memory error detector.
5054 Memory access instructions will be instrumented to detect
5055 out-of-bounds and use-after-free bugs.
5056 See @uref{http://code.google.com/p/address-sanitizer/} for more details.
5058 @item -fsanitize=thread
5059 Enable ThreadSanitizer, a fast data race detector.
5060 Memory access instructions will be instrumented to detect
5061 data race bugs.
5062 See @uref{http://code.google.com/p/data-race-test/wiki/ThreadSanitizer} for more details.
5064 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5065 @opindex fdump-final-insns
5066 Dump the final internal representation (RTL) to @var{file}.  If the
5067 optional argument is omitted (or if @var{file} is @code{.}), the name
5068 of the dump file is determined by appending @code{.gkd} to the
5069 compilation output file name.
5071 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5072 @opindex fcompare-debug
5073 @opindex fno-compare-debug
5074 If no error occurs during compilation, run the compiler a second time,
5075 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5076 passed to the second compilation.  Dump the final internal
5077 representation in both compilations, and print an error if they differ.
5079 If the equal sign is omitted, the default @option{-gtoggle} is used.
5081 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5082 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5083 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5084 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5085 is used.
5087 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5088 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5089 of the final representation and the second compilation, preventing even
5090 @env{GCC_COMPARE_DEBUG} from taking effect.
5092 To verify full coverage during @option{-fcompare-debug} testing, set
5093 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5094 which GCC rejects as an invalid option in any actual compilation
5095 (rather than preprocessing, assembly or linking).  To get just a
5096 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5097 not overridden} will do.
5099 @item -fcompare-debug-second
5100 @opindex fcompare-debug-second
5101 This option is implicitly passed to the compiler for the second
5102 compilation requested by @option{-fcompare-debug}, along with options to
5103 silence warnings, and omitting other options that would cause
5104 side-effect compiler outputs to files or to the standard output.  Dump
5105 files and preserved temporary files are renamed so as to contain the
5106 @code{.gk} additional extension during the second compilation, to avoid
5107 overwriting those generated by the first.
5109 When this option is passed to the compiler driver, it causes the
5110 @emph{first} compilation to be skipped, which makes it useful for little
5111 other than debugging the compiler proper.
5113 @item -feliminate-dwarf2-dups
5114 @opindex feliminate-dwarf2-dups
5115 Compress DWARF 2 debugging information by eliminating duplicated
5116 information about each symbol.  This option only makes sense when
5117 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5119 @item -femit-struct-debug-baseonly
5120 Emit debug information for struct-like types
5121 only when the base name of the compilation source file
5122 matches the base name of file in which the struct is defined.
5124 This option substantially reduces the size of debugging information,
5125 but at significant potential loss in type information to the debugger.
5126 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5127 See @option{-femit-struct-debug-detailed} for more detailed control.
5129 This option works only with DWARF 2.
5131 @item -femit-struct-debug-reduced
5132 Emit debug information for struct-like types
5133 only when the base name of the compilation source file
5134 matches the base name of file in which the type is defined,
5135 unless the struct is a template or defined in a system header.
5137 This option significantly reduces the size of debugging information,
5138 with some potential loss in type information to the debugger.
5139 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5140 See @option{-femit-struct-debug-detailed} for more detailed control.
5142 This option works only with DWARF 2.
5144 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5145 Specify the struct-like types
5146 for which the compiler generates debug information.
5147 The intent is to reduce duplicate struct debug information
5148 between different object files within the same program.
5150 This option is a detailed version of
5151 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5152 which serves for most needs.
5154 A specification has the syntax@*
5155 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5157 The optional first word limits the specification to
5158 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5159 A struct type is used directly when it is the type of a variable, member.
5160 Indirect uses arise through pointers to structs.
5161 That is, when use of an incomplete struct is valid, the use is indirect.
5162 An example is
5163 @samp{struct one direct; struct two * indirect;}.
5165 The optional second word limits the specification to
5166 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5167 Generic structs are a bit complicated to explain.
5168 For C++, these are non-explicit specializations of template classes,
5169 or non-template classes within the above.
5170 Other programming languages have generics,
5171 but @option{-femit-struct-debug-detailed} does not yet implement them.
5173 The third word specifies the source files for those
5174 structs for which the compiler should emit debug information.
5175 The values @samp{none} and @samp{any} have the normal meaning.
5176 The value @samp{base} means that
5177 the base of name of the file in which the type declaration appears
5178 must match the base of the name of the main compilation file.
5179 In practice, this means that when compiling @file{foo.c}, debug information
5180 is generated for types declared in that file and @file{foo.h},
5181 but not other header files.
5182 The value @samp{sys} means those types satisfying @samp{base}
5183 or declared in system or compiler headers.
5185 You may need to experiment to determine the best settings for your application.
5187 The default is @option{-femit-struct-debug-detailed=all}.
5189 This option works only with DWARF 2.
5191 @item -fno-merge-debug-strings
5192 @opindex fmerge-debug-strings
5193 @opindex fno-merge-debug-strings
5194 Direct the linker to not merge together strings in the debugging
5195 information that are identical in different object files.  Merging is
5196 not supported by all assemblers or linkers.  Merging decreases the size
5197 of the debug information in the output file at the cost of increasing
5198 link processing time.  Merging is enabled by default.
5200 @item -fdebug-prefix-map=@var{old}=@var{new}
5201 @opindex fdebug-prefix-map
5202 When compiling files in directory @file{@var{old}}, record debugging
5203 information describing them as in @file{@var{new}} instead.
5205 @item -fno-dwarf2-cfi-asm
5206 @opindex fdwarf2-cfi-asm
5207 @opindex fno-dwarf2-cfi-asm
5208 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5209 instead of using GAS @code{.cfi_*} directives.
5211 @cindex @command{prof}
5212 @item -p
5213 @opindex p
5214 Generate extra code to write profile information suitable for the
5215 analysis program @command{prof}.  You must use this option when compiling
5216 the source files you want data about, and you must also use it when
5217 linking.
5219 @cindex @command{gprof}
5220 @item -pg
5221 @opindex pg
5222 Generate extra code to write profile information suitable for the
5223 analysis program @command{gprof}.  You must use this option when compiling
5224 the source files you want data about, and you must also use it when
5225 linking.
5227 @item -Q
5228 @opindex Q
5229 Makes the compiler print out each function name as it is compiled, and
5230 print some statistics about each pass when it finishes.
5232 @item -ftime-report
5233 @opindex ftime-report
5234 Makes the compiler print some statistics about the time consumed by each
5235 pass when it finishes.
5237 @item -fmem-report
5238 @opindex fmem-report
5239 Makes the compiler print some statistics about permanent memory
5240 allocation when it finishes.
5242 @item -fmem-report-wpa
5243 @opindex fmem-report-wpa
5244 Makes the compiler print some statistics about permanent memory
5245 allocation for the WPA phase only.
5247 @item -fpre-ipa-mem-report
5248 @opindex fpre-ipa-mem-report
5249 @item -fpost-ipa-mem-report
5250 @opindex fpost-ipa-mem-report
5251 Makes the compiler print some statistics about permanent memory
5252 allocation before or after interprocedural optimization.
5254 @item -fprofile-report
5255 @opindex fprofile-report
5256 Makes the compiler print some statistics about consistency of the
5257 (estimated) profile and effect of individual passes.
5259 @item -fstack-usage
5260 @opindex fstack-usage
5261 Makes the compiler output stack usage information for the program, on a
5262 per-function basis.  The filename for the dump is made by appending
5263 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5264 the output file, if explicitly specified and it is not an executable,
5265 otherwise it is the basename of the source file.  An entry is made up
5266 of three fields:
5268 @itemize
5269 @item
5270 The name of the function.
5271 @item
5272 A number of bytes.
5273 @item
5274 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5275 @end itemize
5277 The qualifier @code{static} means that the function manipulates the stack
5278 statically: a fixed number of bytes are allocated for the frame on function
5279 entry and released on function exit; no stack adjustments are otherwise made
5280 in the function.  The second field is this fixed number of bytes.
5282 The qualifier @code{dynamic} means that the function manipulates the stack
5283 dynamically: in addition to the static allocation described above, stack
5284 adjustments are made in the body of the function, for example to push/pop
5285 arguments around function calls.  If the qualifier @code{bounded} is also
5286 present, the amount of these adjustments is bounded at compile time and
5287 the second field is an upper bound of the total amount of stack used by
5288 the function.  If it is not present, the amount of these adjustments is
5289 not bounded at compile time and the second field only represents the
5290 bounded part.
5292 @item -fprofile-arcs
5293 @opindex fprofile-arcs
5294 Add code so that program flow @dfn{arcs} are instrumented.  During
5295 execution the program records how many times each branch and call is
5296 executed and how many times it is taken or returns.  When the compiled
5297 program exits it saves this data to a file called
5298 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5299 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5300 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5301 @var{auxname} is generated from the name of the output file, if
5302 explicitly specified and it is not the final executable, otherwise it is
5303 the basename of the source file.  In both cases any suffix is removed
5304 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5305 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5306 @xref{Cross-profiling}.
5308 @cindex @command{gcov}
5309 @item --coverage
5310 @opindex coverage
5312 This option is used to compile and link code instrumented for coverage
5313 analysis.  The option is a synonym for @option{-fprofile-arcs}
5314 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5315 linking).  See the documentation for those options for more details.
5317 @itemize
5319 @item
5320 Compile the source files with @option{-fprofile-arcs} plus optimization
5321 and code generation options.  For test coverage analysis, use the
5322 additional @option{-ftest-coverage} option.  You do not need to profile
5323 every source file in a program.
5325 @item
5326 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5327 (the latter implies the former).
5329 @item
5330 Run the program on a representative workload to generate the arc profile
5331 information.  This may be repeated any number of times.  You can run
5332 concurrent instances of your program, and provided that the file system
5333 supports locking, the data files will be correctly updated.  Also
5334 @code{fork} calls are detected and correctly handled (double counting
5335 will not happen).
5337 @item
5338 For profile-directed optimizations, compile the source files again with
5339 the same optimization and code generation options plus
5340 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5341 Control Optimization}).
5343 @item
5344 For test coverage analysis, use @command{gcov} to produce human readable
5345 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5346 @command{gcov} documentation for further information.
5348 @end itemize
5350 With @option{-fprofile-arcs}, for each function of your program GCC
5351 creates a program flow graph, then finds a spanning tree for the graph.
5352 Only arcs that are not on the spanning tree have to be instrumented: the
5353 compiler adds code to count the number of times that these arcs are
5354 executed.  When an arc is the only exit or only entrance to a block, the
5355 instrumentation code can be added to the block; otherwise, a new basic
5356 block must be created to hold the instrumentation code.
5358 @need 2000
5359 @item -ftest-coverage
5360 @opindex ftest-coverage
5361 Produce a notes file that the @command{gcov} code-coverage utility
5362 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5363 show program coverage.  Each source file's note file is called
5364 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5365 above for a description of @var{auxname} and instructions on how to
5366 generate test coverage data.  Coverage data matches the source files
5367 more closely if you do not optimize.
5369 @item -fdbg-cnt-list
5370 @opindex fdbg-cnt-list
5371 Print the name and the counter upper bound for all debug counters.
5374 @item -fdbg-cnt=@var{counter-value-list}
5375 @opindex fdbg-cnt
5376 Set the internal debug counter upper bound.  @var{counter-value-list}
5377 is a comma-separated list of @var{name}:@var{value} pairs
5378 which sets the upper bound of each debug counter @var{name} to @var{value}.
5379 All debug counters have the initial upper bound of @code{UINT_MAX};
5380 thus @code{dbg_cnt()} returns true always unless the upper bound
5381 is set by this option.
5382 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5383 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5385 @item -fenable-@var{kind}-@var{pass}
5386 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5387 @opindex fdisable-
5388 @opindex fenable-
5390 This is a set of options that are used to explicitly disable/enable
5391 optimization passes.  These options are intended for use for debugging GCC.
5392 Compiler users should use regular options for enabling/disabling
5393 passes instead.
5395 @table @gcctabopt
5397 @item -fdisable-ipa-@var{pass}
5398 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5399 statically invoked in the compiler multiple times, the pass name should be
5400 appended with a sequential number starting from 1.
5402 @item -fdisable-rtl-@var{pass}
5403 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5404 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5405 statically invoked in the compiler multiple times, the pass name should be
5406 appended with a sequential number starting from 1.  @var{range-list} is a 
5407 comma-separated list of function ranges or assembler names.  Each range is a number
5408 pair separated by a colon.  The range is inclusive in both ends.  If the range
5409 is trivial, the number pair can be simplified as a single number.  If the
5410 function's call graph node's @var{uid} falls within one of the specified ranges,
5411 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5412 function header of a dump file, and the pass names can be dumped by using
5413 option @option{-fdump-passes}.
5415 @item -fdisable-tree-@var{pass}
5416 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5417 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5418 option arguments.
5420 @item -fenable-ipa-@var{pass}
5421 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5422 statically invoked in the compiler multiple times, the pass name should be
5423 appended with a sequential number starting from 1.
5425 @item -fenable-rtl-@var{pass}
5426 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5427 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5428 description and examples.
5430 @item -fenable-tree-@var{pass}
5431 @itemx -fenable-tree-@var{pass}=@var{range-list}
5432 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5433 of option arguments.
5435 @end table
5437 Here are some examples showing uses of these options.
5439 @smallexample
5441 # disable ccp1 for all functions
5442    -fdisable-tree-ccp1
5443 # disable complete unroll for function whose cgraph node uid is 1
5444    -fenable-tree-cunroll=1
5445 # disable gcse2 for functions at the following ranges [1,1],
5446 # [300,400], and [400,1000]
5447 # disable gcse2 for functions foo and foo2
5448    -fdisable-rtl-gcse2=foo,foo2
5449 # disable early inlining
5450    -fdisable-tree-einline
5451 # disable ipa inlining
5452    -fdisable-ipa-inline
5453 # enable tree full unroll
5454    -fenable-tree-unroll
5456 @end smallexample
5458 @item -d@var{letters}
5459 @itemx -fdump-rtl-@var{pass}
5460 @itemx -fdump-rtl-@var{pass}=@var{filename}
5461 @opindex d
5462 Says to make debugging dumps during compilation at times specified by
5463 @var{letters}.  This is used for debugging the RTL-based passes of the
5464 compiler.  The file names for most of the dumps are made by appending
5465 a pass number and a word to the @var{dumpname}, and the files are
5466 created in the directory of the output file. In case of
5467 @option{=@var{filename}} option, the dump is output on the given file
5468 instead of the pass numbered dump files. Note that the pass number is
5469 computed statically as passes get registered into the pass manager.
5470 Thus the numbering is not related to the dynamic order of execution of
5471 passes.  In particular, a pass installed by a plugin could have a
5472 number over 200 even if it executed quite early.  @var{dumpname} is
5473 generated from the name of the output file, if explicitly specified
5474 and it is not an executable, otherwise it is the basename of the
5475 source file. These switches may have different effects when
5476 @option{-E} is used for preprocessing.
5478 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5479 @option{-d} option @var{letters}.  Here are the possible
5480 letters for use in @var{pass} and @var{letters}, and their meanings:
5482 @table @gcctabopt
5484 @item -fdump-rtl-alignments
5485 @opindex fdump-rtl-alignments
5486 Dump after branch alignments have been computed.
5488 @item -fdump-rtl-asmcons
5489 @opindex fdump-rtl-asmcons
5490 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5492 @item -fdump-rtl-auto_inc_dec
5493 @opindex fdump-rtl-auto_inc_dec
5494 Dump after auto-inc-dec discovery.  This pass is only run on
5495 architectures that have auto inc or auto dec instructions.
5497 @item -fdump-rtl-barriers
5498 @opindex fdump-rtl-barriers
5499 Dump after cleaning up the barrier instructions.
5501 @item -fdump-rtl-bbpart
5502 @opindex fdump-rtl-bbpart
5503 Dump after partitioning hot and cold basic blocks.
5505 @item -fdump-rtl-bbro
5506 @opindex fdump-rtl-bbro
5507 Dump after block reordering.
5509 @item -fdump-rtl-btl1
5510 @itemx -fdump-rtl-btl2
5511 @opindex fdump-rtl-btl2
5512 @opindex fdump-rtl-btl2
5513 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5514 after the two branch
5515 target load optimization passes.
5517 @item -fdump-rtl-bypass
5518 @opindex fdump-rtl-bypass
5519 Dump after jump bypassing and control flow optimizations.
5521 @item -fdump-rtl-combine
5522 @opindex fdump-rtl-combine
5523 Dump after the RTL instruction combination pass.
5525 @item -fdump-rtl-compgotos
5526 @opindex fdump-rtl-compgotos
5527 Dump after duplicating the computed gotos.
5529 @item -fdump-rtl-ce1
5530 @itemx -fdump-rtl-ce2
5531 @itemx -fdump-rtl-ce3
5532 @opindex fdump-rtl-ce1
5533 @opindex fdump-rtl-ce2
5534 @opindex fdump-rtl-ce3
5535 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5536 @option{-fdump-rtl-ce3} enable dumping after the three
5537 if conversion passes.
5539 @item -fdump-rtl-cprop_hardreg
5540 @opindex fdump-rtl-cprop_hardreg
5541 Dump after hard register copy propagation.
5543 @item -fdump-rtl-csa
5544 @opindex fdump-rtl-csa
5545 Dump after combining stack adjustments.
5547 @item -fdump-rtl-cse1
5548 @itemx -fdump-rtl-cse2
5549 @opindex fdump-rtl-cse1
5550 @opindex fdump-rtl-cse2
5551 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5552 the two common subexpression elimination passes.
5554 @item -fdump-rtl-dce
5555 @opindex fdump-rtl-dce
5556 Dump after the standalone dead code elimination passes.
5558 @item -fdump-rtl-dbr
5559 @opindex fdump-rtl-dbr
5560 Dump after delayed branch scheduling.
5562 @item -fdump-rtl-dce1
5563 @itemx -fdump-rtl-dce2
5564 @opindex fdump-rtl-dce1
5565 @opindex fdump-rtl-dce2
5566 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5567 the two dead store elimination passes.
5569 @item -fdump-rtl-eh
5570 @opindex fdump-rtl-eh
5571 Dump after finalization of EH handling code.
5573 @item -fdump-rtl-eh_ranges
5574 @opindex fdump-rtl-eh_ranges
5575 Dump after conversion of EH handling range regions.
5577 @item -fdump-rtl-expand
5578 @opindex fdump-rtl-expand
5579 Dump after RTL generation.
5581 @item -fdump-rtl-fwprop1
5582 @itemx -fdump-rtl-fwprop2
5583 @opindex fdump-rtl-fwprop1
5584 @opindex fdump-rtl-fwprop2
5585 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5586 dumping after the two forward propagation passes.
5588 @item -fdump-rtl-gcse1
5589 @itemx -fdump-rtl-gcse2
5590 @opindex fdump-rtl-gcse1
5591 @opindex fdump-rtl-gcse2
5592 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5593 after global common subexpression elimination.
5595 @item -fdump-rtl-init-regs
5596 @opindex fdump-rtl-init-regs
5597 Dump after the initialization of the registers.
5599 @item -fdump-rtl-initvals
5600 @opindex fdump-rtl-initvals
5601 Dump after the computation of the initial value sets.
5603 @item -fdump-rtl-into_cfglayout
5604 @opindex fdump-rtl-into_cfglayout
5605 Dump after converting to cfglayout mode.
5607 @item -fdump-rtl-ira
5608 @opindex fdump-rtl-ira
5609 Dump after iterated register allocation.
5611 @item -fdump-rtl-jump
5612 @opindex fdump-rtl-jump
5613 Dump after the second jump optimization.
5615 @item -fdump-rtl-loop2
5616 @opindex fdump-rtl-loop2
5617 @option{-fdump-rtl-loop2} enables dumping after the rtl
5618 loop optimization passes.
5620 @item -fdump-rtl-mach
5621 @opindex fdump-rtl-mach
5622 Dump after performing the machine dependent reorganization pass, if that
5623 pass exists.
5625 @item -fdump-rtl-mode_sw
5626 @opindex fdump-rtl-mode_sw
5627 Dump after removing redundant mode switches.
5629 @item -fdump-rtl-rnreg
5630 @opindex fdump-rtl-rnreg
5631 Dump after register renumbering.
5633 @item -fdump-rtl-outof_cfglayout
5634 @opindex fdump-rtl-outof_cfglayout
5635 Dump after converting from cfglayout mode.
5637 @item -fdump-rtl-peephole2
5638 @opindex fdump-rtl-peephole2
5639 Dump after the peephole pass.
5641 @item -fdump-rtl-postreload
5642 @opindex fdump-rtl-postreload
5643 Dump after post-reload optimizations.
5645 @item -fdump-rtl-pro_and_epilogue
5646 @opindex fdump-rtl-pro_and_epilogue
5647 Dump after generating the function prologues and epilogues.
5649 @item -fdump-rtl-regmove
5650 @opindex fdump-rtl-regmove
5651 Dump after the register move pass.
5653 @item -fdump-rtl-sched1
5654 @itemx -fdump-rtl-sched2
5655 @opindex fdump-rtl-sched1
5656 @opindex fdump-rtl-sched2
5657 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5658 after the basic block scheduling passes.
5660 @item -fdump-rtl-see
5661 @opindex fdump-rtl-see
5662 Dump after sign extension elimination.
5664 @item -fdump-rtl-seqabstr
5665 @opindex fdump-rtl-seqabstr
5666 Dump after common sequence discovery.
5668 @item -fdump-rtl-shorten
5669 @opindex fdump-rtl-shorten
5670 Dump after shortening branches.
5672 @item -fdump-rtl-sibling
5673 @opindex fdump-rtl-sibling
5674 Dump after sibling call optimizations.
5676 @item -fdump-rtl-split1
5677 @itemx -fdump-rtl-split2
5678 @itemx -fdump-rtl-split3
5679 @itemx -fdump-rtl-split4
5680 @itemx -fdump-rtl-split5
5681 @opindex fdump-rtl-split1
5682 @opindex fdump-rtl-split2
5683 @opindex fdump-rtl-split3
5684 @opindex fdump-rtl-split4
5685 @opindex fdump-rtl-split5
5686 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5687 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5688 @option{-fdump-rtl-split5} enable dumping after five rounds of
5689 instruction splitting.
5691 @item -fdump-rtl-sms
5692 @opindex fdump-rtl-sms
5693 Dump after modulo scheduling.  This pass is only run on some
5694 architectures.
5696 @item -fdump-rtl-stack
5697 @opindex fdump-rtl-stack
5698 Dump after conversion from GCC's ``flat register file'' registers to the
5699 x87's stack-like registers.  This pass is only run on x86 variants.
5701 @item -fdump-rtl-subreg1
5702 @itemx -fdump-rtl-subreg2
5703 @opindex fdump-rtl-subreg1
5704 @opindex fdump-rtl-subreg2
5705 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5706 the two subreg expansion passes.
5708 @item -fdump-rtl-unshare
5709 @opindex fdump-rtl-unshare
5710 Dump after all rtl has been unshared.
5712 @item -fdump-rtl-vartrack
5713 @opindex fdump-rtl-vartrack
5714 Dump after variable tracking.
5716 @item -fdump-rtl-vregs
5717 @opindex fdump-rtl-vregs
5718 Dump after converting virtual registers to hard registers.
5720 @item -fdump-rtl-web
5721 @opindex fdump-rtl-web
5722 Dump after live range splitting.
5724 @item -fdump-rtl-regclass
5725 @itemx -fdump-rtl-subregs_of_mode_init
5726 @itemx -fdump-rtl-subregs_of_mode_finish
5727 @itemx -fdump-rtl-dfinit
5728 @itemx -fdump-rtl-dfinish
5729 @opindex fdump-rtl-regclass
5730 @opindex fdump-rtl-subregs_of_mode_init
5731 @opindex fdump-rtl-subregs_of_mode_finish
5732 @opindex fdump-rtl-dfinit
5733 @opindex fdump-rtl-dfinish
5734 These dumps are defined but always produce empty files.
5736 @item -da
5737 @itemx -fdump-rtl-all
5738 @opindex da
5739 @opindex fdump-rtl-all
5740 Produce all the dumps listed above.
5742 @item -dA
5743 @opindex dA
5744 Annotate the assembler output with miscellaneous debugging information.
5746 @item -dD
5747 @opindex dD
5748 Dump all macro definitions, at the end of preprocessing, in addition to
5749 normal output.
5751 @item -dH
5752 @opindex dH
5753 Produce a core dump whenever an error occurs.
5755 @item -dp
5756 @opindex dp
5757 Annotate the assembler output with a comment indicating which
5758 pattern and alternative is used.  The length of each instruction is
5759 also printed.
5761 @item -dP
5762 @opindex dP
5763 Dump the RTL in the assembler output as a comment before each instruction.
5764 Also turns on @option{-dp} annotation.
5766 @item -dx
5767 @opindex dx
5768 Just generate RTL for a function instead of compiling it.  Usually used
5769 with @option{-fdump-rtl-expand}.
5770 @end table
5772 @item -fdump-noaddr
5773 @opindex fdump-noaddr
5774 When doing debugging dumps, suppress address output.  This makes it more
5775 feasible to use diff on debugging dumps for compiler invocations with
5776 different compiler binaries and/or different
5777 text / bss / data / heap / stack / dso start locations.
5779 @item -fdump-unnumbered
5780 @opindex fdump-unnumbered
5781 When doing debugging dumps, suppress instruction numbers and address output.
5782 This makes it more feasible to use diff on debugging dumps for compiler
5783 invocations with different options, in particular with and without
5784 @option{-g}.
5786 @item -fdump-unnumbered-links
5787 @opindex fdump-unnumbered-links
5788 When doing debugging dumps (see @option{-d} option above), suppress
5789 instruction numbers for the links to the previous and next instructions
5790 in a sequence.
5792 @item -fdump-translation-unit @r{(C++ only)}
5793 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5794 @opindex fdump-translation-unit
5795 Dump a representation of the tree structure for the entire translation
5796 unit to a file.  The file name is made by appending @file{.tu} to the
5797 source file name, and the file is created in the same directory as the
5798 output file.  If the @samp{-@var{options}} form is used, @var{options}
5799 controls the details of the dump as described for the
5800 @option{-fdump-tree} options.
5802 @item -fdump-class-hierarchy @r{(C++ only)}
5803 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5804 @opindex fdump-class-hierarchy
5805 Dump a representation of each class's hierarchy and virtual function
5806 table layout to a file.  The file name is made by appending
5807 @file{.class} to the source file name, and the file is created in the
5808 same directory as the output file.  If the @samp{-@var{options}} form
5809 is used, @var{options} controls the details of the dump as described
5810 for the @option{-fdump-tree} options.
5812 @item -fdump-ipa-@var{switch}
5813 @opindex fdump-ipa
5814 Control the dumping at various stages of inter-procedural analysis
5815 language tree to a file.  The file name is generated by appending a
5816 switch specific suffix to the source file name, and the file is created
5817 in the same directory as the output file.  The following dumps are
5818 possible:
5820 @table @samp
5821 @item all
5822 Enables all inter-procedural analysis dumps.
5824 @item cgraph
5825 Dumps information about call-graph optimization, unused function removal,
5826 and inlining decisions.
5828 @item inline
5829 Dump after function inlining.
5831 @end table
5833 @item -fdump-passes
5834 @opindex fdump-passes
5835 Dump the list of optimization passes that are turned on and off by
5836 the current command-line options.
5838 @item -fdump-statistics-@var{option}
5839 @opindex fdump-statistics
5840 Enable and control dumping of pass statistics in a separate file.  The
5841 file name is generated by appending a suffix ending in
5842 @samp{.statistics} to the source file name, and the file is created in
5843 the same directory as the output file.  If the @samp{-@var{option}}
5844 form is used, @samp{-stats} causes counters to be summed over the
5845 whole compilation unit while @samp{-details} dumps every event as
5846 the passes generate them.  The default with no option is to sum
5847 counters for each function compiled.
5849 @item -fdump-tree-@var{switch}
5850 @itemx -fdump-tree-@var{switch}-@var{options}
5851 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
5852 @opindex fdump-tree
5853 Control the dumping at various stages of processing the intermediate
5854 language tree to a file.  The file name is generated by appending a
5855 switch-specific suffix to the source file name, and the file is
5856 created in the same directory as the output file. In case of
5857 @option{=@var{filename}} option, the dump is output on the given file
5858 instead of the auto named dump files.  If the @samp{-@var{options}}
5859 form is used, @var{options} is a list of @samp{-} separated options
5860 which control the details of the dump.  Not all options are applicable
5861 to all dumps; those that are not meaningful are ignored.  The
5862 following options are available
5864 @table @samp
5865 @item address
5866 Print the address of each node.  Usually this is not meaningful as it
5867 changes according to the environment and source file.  Its primary use
5868 is for tying up a dump file with a debug environment.
5869 @item asmname
5870 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5871 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5872 use working backward from mangled names in the assembly file.
5873 @item slim
5874 When dumping front-end intermediate representations, inhibit dumping
5875 of members of a scope or body of a function merely because that scope
5876 has been reached.  Only dump such items when they are directly reachable
5877 by some other path.
5879 When dumping pretty-printed trees, this option inhibits dumping the
5880 bodies of control structures.
5882 When dumping RTL, print the RTL in slim (condensed) form instead of
5883 the default LISP-like representation.
5884 @item raw
5885 Print a raw representation of the tree.  By default, trees are
5886 pretty-printed into a C-like representation.
5887 @item details
5888 Enable more detailed dumps (not honored by every dump option). Also
5889 include information from the optimization passes.
5890 @item stats
5891 Enable dumping various statistics about the pass (not honored by every dump
5892 option).
5893 @item blocks
5894 Enable showing basic block boundaries (disabled in raw dumps).
5895 @item graph
5896 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5897 dump a representation of the control flow graph suitable for viewing with
5898 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
5899 the file is pretty-printed as a subgraph, so that GraphViz can render them
5900 all in a single plot.
5902 This option currently only works for RTL dumps, and the RTL is always
5903 dumped in slim form.
5904 @item vops
5905 Enable showing virtual operands for every statement.
5906 @item lineno
5907 Enable showing line numbers for statements.
5908 @item uid
5909 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5910 @item verbose
5911 Enable showing the tree dump for each statement.
5912 @item eh
5913 Enable showing the EH region number holding each statement.
5914 @item scev
5915 Enable showing scalar evolution analysis details.
5916 @item optimized
5917 Enable showing optimization information (only available in certain
5918 passes).
5919 @item missed
5920 Enable showing missed optimization information (only available in certain
5921 passes).
5922 @item notes
5923 Enable other detailed optimization information (only available in
5924 certain passes).
5925 @item =@var{filename}
5926 Instead of an auto named dump file, output into the given file
5927 name. The file names @file{stdout} and @file{stderr} are treated
5928 specially and are considered already open standard streams. For
5929 example,
5931 @smallexample
5932 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
5933      -fdump-tree-pre=stderr file.c
5934 @end smallexample
5936 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
5937 output on to @file{stderr}. If two conflicting dump filenames are
5938 given for the same pass, then the latter option overrides the earlier
5939 one.
5941 @item all
5942 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5943 and @option{lineno}.
5945 @item optall
5946 Turn on all optimization options, i.e., @option{optimized},
5947 @option{missed}, and @option{note}.
5948 @end table
5950 The following tree dumps are possible:
5951 @table @samp
5953 @item original
5954 @opindex fdump-tree-original
5955 Dump before any tree based optimization, to @file{@var{file}.original}.
5957 @item optimized
5958 @opindex fdump-tree-optimized
5959 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5961 @item gimple
5962 @opindex fdump-tree-gimple
5963 Dump each function before and after the gimplification pass to a file.  The
5964 file name is made by appending @file{.gimple} to the source file name.
5966 @item cfg
5967 @opindex fdump-tree-cfg
5968 Dump the control flow graph of each function to a file.  The file name is
5969 made by appending @file{.cfg} to the source file name.
5971 @item ch
5972 @opindex fdump-tree-ch
5973 Dump each function after copying loop headers.  The file name is made by
5974 appending @file{.ch} to the source file name.
5976 @item ssa
5977 @opindex fdump-tree-ssa
5978 Dump SSA related information to a file.  The file name is made by appending
5979 @file{.ssa} to the source file name.
5981 @item alias
5982 @opindex fdump-tree-alias
5983 Dump aliasing information for each function.  The file name is made by
5984 appending @file{.alias} to the source file name.
5986 @item ccp
5987 @opindex fdump-tree-ccp
5988 Dump each function after CCP@.  The file name is made by appending
5989 @file{.ccp} to the source file name.
5991 @item storeccp
5992 @opindex fdump-tree-storeccp
5993 Dump each function after STORE-CCP@.  The file name is made by appending
5994 @file{.storeccp} to the source file name.
5996 @item pre
5997 @opindex fdump-tree-pre
5998 Dump trees after partial redundancy elimination.  The file name is made
5999 by appending @file{.pre} to the source file name.
6001 @item fre
6002 @opindex fdump-tree-fre
6003 Dump trees after full redundancy elimination.  The file name is made
6004 by appending @file{.fre} to the source file name.
6006 @item copyprop
6007 @opindex fdump-tree-copyprop
6008 Dump trees after copy propagation.  The file name is made
6009 by appending @file{.copyprop} to the source file name.
6011 @item store_copyprop
6012 @opindex fdump-tree-store_copyprop
6013 Dump trees after store copy-propagation.  The file name is made
6014 by appending @file{.store_copyprop} to the source file name.
6016 @item dce
6017 @opindex fdump-tree-dce
6018 Dump each function after dead code elimination.  The file name is made by
6019 appending @file{.dce} to the source file name.
6021 @item mudflap
6022 @opindex fdump-tree-mudflap
6023 Dump each function after adding mudflap instrumentation.  The file name is
6024 made by appending @file{.mudflap} to the source file name.
6026 @item sra
6027 @opindex fdump-tree-sra
6028 Dump each function after performing scalar replacement of aggregates.  The
6029 file name is made by appending @file{.sra} to the source file name.
6031 @item sink
6032 @opindex fdump-tree-sink
6033 Dump each function after performing code sinking.  The file name is made
6034 by appending @file{.sink} to the source file name.
6036 @item dom
6037 @opindex fdump-tree-dom
6038 Dump each function after applying dominator tree optimizations.  The file
6039 name is made by appending @file{.dom} to the source file name.
6041 @item dse
6042 @opindex fdump-tree-dse
6043 Dump each function after applying dead store elimination.  The file
6044 name is made by appending @file{.dse} to the source file name.
6046 @item phiopt
6047 @opindex fdump-tree-phiopt
6048 Dump each function after optimizing PHI nodes into straightline code.  The file
6049 name is made by appending @file{.phiopt} to the source file name.
6051 @item forwprop
6052 @opindex fdump-tree-forwprop
6053 Dump each function after forward propagating single use variables.  The file
6054 name is made by appending @file{.forwprop} to the source file name.
6056 @item copyrename
6057 @opindex fdump-tree-copyrename
6058 Dump each function after applying the copy rename optimization.  The file
6059 name is made by appending @file{.copyrename} to the source file name.
6061 @item nrv
6062 @opindex fdump-tree-nrv
6063 Dump each function after applying the named return value optimization on
6064 generic trees.  The file name is made by appending @file{.nrv} to the source
6065 file name.
6067 @item vect
6068 @opindex fdump-tree-vect
6069 Dump each function after applying vectorization of loops.  The file name is
6070 made by appending @file{.vect} to the source file name.
6072 @item slp
6073 @opindex fdump-tree-slp
6074 Dump each function after applying vectorization of basic blocks.  The file name
6075 is made by appending @file{.slp} to the source file name.
6077 @item vrp
6078 @opindex fdump-tree-vrp
6079 Dump each function after Value Range Propagation (VRP).  The file name
6080 is made by appending @file{.vrp} to the source file name.
6082 @item all
6083 @opindex fdump-tree-all
6084 Enable all the available tree dumps with the flags provided in this option.
6085 @end table
6087 @item -fopt-info
6088 @itemx -fopt-info-@var{options}
6089 @itemx -fopt-info-@var{options}=@var{filename}
6090 @opindex fopt-info
6091 Controls optimization dumps from various optimization passes. If the
6092 @samp{-@var{options}} form is used, @var{options} is a list of
6093 @samp{-} separated options to select the dump details and
6094 optimizations.  If @var{options} is not specified, it defaults to
6095 @option{all} for details and @option{optall} for optimization
6096 groups. If the @var{filename} is not specified, it defaults to
6097 @file{stderr}. Note that the output @var{filename} will be overwritten
6098 in case of multiple translation units. If a combined output from
6099 multiple translation units is desired, @file{stderr} should be used
6100 instead.
6102 The options can be divided into two groups, 1) options describing the
6103 verbosity of the dump, and 2) options describing which optimizations
6104 should be included. The options from both the groups can be freely
6105 mixed as they are non-overlapping. However, in case of any conflicts,
6106 the latter options override the earlier options on the command
6107 line. Though multiple -fopt-info options are accepted, only one of
6108 them can have @option{=filename}. If other filenames are provided then
6109 all but the first one are ignored.
6111 The dump verbosity has the following options
6113 @table @samp
6114 @item optimized
6115 Print information when an optimization is successfully applied. It is
6116 up to a pass to decide which information is relevant. For example, the
6117 vectorizer passes print the source location of loops which got
6118 successfully vectorized.
6119 @item missed
6120 Print information about missed optimizations. Individual passes
6121 control which information to include in the output. For example,
6123 @smallexample
6124 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6125 @end smallexample
6127 will print information about missed optimization opportunities from
6128 vectorization passes on stderr.
6129 @item note
6130 Print verbose information about optimizations, such as certain
6131 transformations, more detailed messages about decisions etc.
6132 @item all
6133 Print detailed optimization information. This includes
6134 @var{optimized}, @var{missed}, and @var{note}.
6135 @end table
6137 The second set of options describes a group of optimizations and may
6138 include one or more of the following.
6140 @table @samp
6141 @item ipa
6142 Enable dumps from all interprocedural optimizations.
6143 @item loop
6144 Enable dumps from all loop optimizations.
6145 @item inline
6146 Enable dumps from all inlining optimizations.
6147 @item vec
6148 Enable dumps from all vectorization optimizations.
6149 @end table
6151 For example,
6152 @smallexample
6153 gcc -O3 -fopt-info-missed=missed.all
6154 @end smallexample
6156 outputs missed optimization report from all the passes into
6157 @file{missed.all}.
6159 As another example,
6160 @smallexample
6161 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6162 @end smallexample
6164 will output information about missed optimizations as well as
6165 optimized locations from all the inlining passes into
6166 @file{inline.txt}.
6168 If the @var{filename} is provided, then the dumps from all the
6169 applicable optimizations are concatenated into the @file{filename}.
6170 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6171 omitted, it defaults to @option{all-optall}, which means dump all
6172 available optimization info from all the passes. In the following
6173 example, all optimization info is output on to @file{stderr}.
6175 @smallexample
6176 gcc -O3 -fopt-info
6177 @end smallexample
6179 Note that @option{-fopt-info-vec-missed} behaves the same as
6180 @option{-fopt-info-missed-vec}.
6182 As another example, consider
6184 @smallexample
6185 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6186 @end smallexample
6188 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6189 in conflict since only one output file is allowed. In this case, only
6190 the first option takes effect and the subsequent options are
6191 ignored. Thus only the @file{vec.miss} is produced which cotaints
6192 dumps from the vectorizer about missed opportunities.
6194 @item -ftree-vectorizer-verbose=@var{n}
6195 @opindex ftree-vectorizer-verbose
6196 This option is deprecated and is implemented in terms of
6197 @option{-fopt-info}. Please use @option{-fopt-info-@var{kind}} form
6198 instead, where @var{kind} is one of the valid opt-info options. It
6199 prints additional optimization information.  For @var{n}=0 no
6200 diagnostic information is reported.  If @var{n}=1 the vectorizer
6201 reports each loop that got vectorized, and the total number of loops
6202 that got vectorized.  If @var{n}=2 the vectorizer reports locations
6203 which could not be vectorized and the reasons for those. For any
6204 higher verbosity levels all the analysis and transformation
6205 information from the vectorizer is reported.
6207 Note that the information output by @option{-ftree-vectorizer-verbose}
6208 option is sent to @file{stderr}. If the equivalent form
6209 @option{-fopt-info-@var{options}=@var{filename}} is used then the
6210 output is sent into @var{filename} instead.
6212 @item -frandom-seed=@var{string}
6213 @opindex frandom-seed
6214 This option provides a seed that GCC uses in place of
6215 random numbers in generating certain symbol names
6216 that have to be different in every compiled file.  It is also used to
6217 place unique stamps in coverage data files and the object files that
6218 produce them.  You can use the @option{-frandom-seed} option to produce
6219 reproducibly identical object files.
6221 The @var{string} should be different for every file you compile.
6223 @item -fsched-verbose=@var{n}
6224 @opindex fsched-verbose
6225 On targets that use instruction scheduling, this option controls the
6226 amount of debugging output the scheduler prints.  This information is
6227 written to standard error, unless @option{-fdump-rtl-sched1} or
6228 @option{-fdump-rtl-sched2} is specified, in which case it is output
6229 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6230 respectively.  However for @var{n} greater than nine, the output is
6231 always printed to standard error.
6233 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6234 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6235 For @var{n} greater than one, it also output basic block probabilities,
6236 detailed ready list information and unit/insn info.  For @var{n} greater
6237 than two, it includes RTL at abort point, control-flow and regions info.
6238 And for @var{n} over four, @option{-fsched-verbose} also includes
6239 dependence info.
6241 @item -save-temps
6242 @itemx -save-temps=cwd
6243 @opindex save-temps
6244 Store the usual ``temporary'' intermediate files permanently; place them
6245 in the current directory and name them based on the source file.  Thus,
6246 compiling @file{foo.c} with @option{-c -save-temps} produces files
6247 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6248 preprocessed @file{foo.i} output file even though the compiler now
6249 normally uses an integrated preprocessor.
6251 When used in combination with the @option{-x} command-line option,
6252 @option{-save-temps} is sensible enough to avoid over writing an
6253 input source file with the same extension as an intermediate file.
6254 The corresponding intermediate file may be obtained by renaming the
6255 source file before using @option{-save-temps}.
6257 If you invoke GCC in parallel, compiling several different source
6258 files that share a common base name in different subdirectories or the
6259 same source file compiled for multiple output destinations, it is
6260 likely that the different parallel compilers will interfere with each
6261 other, and overwrite the temporary files.  For instance:
6263 @smallexample
6264 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6265 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6266 @end smallexample
6268 may result in @file{foo.i} and @file{foo.o} being written to
6269 simultaneously by both compilers.
6271 @item -save-temps=obj
6272 @opindex save-temps=obj
6273 Store the usual ``temporary'' intermediate files permanently.  If the
6274 @option{-o} option is used, the temporary files are based on the
6275 object file.  If the @option{-o} option is not used, the
6276 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6278 For example:
6280 @smallexample
6281 gcc -save-temps=obj -c foo.c
6282 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6283 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6284 @end smallexample
6286 @noindent
6287 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6288 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6289 @file{dir2/yfoobar.o}.
6291 @item -time@r{[}=@var{file}@r{]}
6292 @opindex time
6293 Report the CPU time taken by each subprocess in the compilation
6294 sequence.  For C source files, this is the compiler proper and assembler
6295 (plus the linker if linking is done).
6297 Without the specification of an output file, the output looks like this:
6299 @smallexample
6300 # cc1 0.12 0.01
6301 # as 0.00 0.01
6302 @end smallexample
6304 The first number on each line is the ``user time'', that is time spent
6305 executing the program itself.  The second number is ``system time'',
6306 time spent executing operating system routines on behalf of the program.
6307 Both numbers are in seconds.
6309 With the specification of an output file, the output is appended to the
6310 named file, and it looks like this:
6312 @smallexample
6313 0.12 0.01 cc1 @var{options}
6314 0.00 0.01 as @var{options}
6315 @end smallexample
6317 The ``user time'' and the ``system time'' are moved before the program
6318 name, and the options passed to the program are displayed, so that one
6319 can later tell what file was being compiled, and with which options.
6321 @item -fvar-tracking
6322 @opindex fvar-tracking
6323 Run variable tracking pass.  It computes where variables are stored at each
6324 position in code.  Better debugging information is then generated
6325 (if the debugging information format supports this information).
6327 It is enabled by default when compiling with optimization (@option{-Os},
6328 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6329 the debug info format supports it.
6331 @item -fvar-tracking-assignments
6332 @opindex fvar-tracking-assignments
6333 @opindex fno-var-tracking-assignments
6334 Annotate assignments to user variables early in the compilation and
6335 attempt to carry the annotations over throughout the compilation all the
6336 way to the end, in an attempt to improve debug information while
6337 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6339 It can be enabled even if var-tracking is disabled, in which case
6340 annotations are created and maintained, but discarded at the end.
6342 @item -fvar-tracking-assignments-toggle
6343 @opindex fvar-tracking-assignments-toggle
6344 @opindex fno-var-tracking-assignments-toggle
6345 Toggle @option{-fvar-tracking-assignments}, in the same way that
6346 @option{-gtoggle} toggles @option{-g}.
6348 @item -print-file-name=@var{library}
6349 @opindex print-file-name
6350 Print the full absolute name of the library file @var{library} that
6351 would be used when linking---and don't do anything else.  With this
6352 option, GCC does not compile or link anything; it just prints the
6353 file name.
6355 @item -print-multi-directory
6356 @opindex print-multi-directory
6357 Print the directory name corresponding to the multilib selected by any
6358 other switches present in the command line.  This directory is supposed
6359 to exist in @env{GCC_EXEC_PREFIX}.
6361 @item -print-multi-lib
6362 @opindex print-multi-lib
6363 Print the mapping from multilib directory names to compiler switches
6364 that enable them.  The directory name is separated from the switches by
6365 @samp{;}, and each switch starts with an @samp{@@} instead of the
6366 @samp{-}, without spaces between multiple switches.  This is supposed to
6367 ease shell processing.
6369 @item -print-multi-os-directory
6370 @opindex print-multi-os-directory
6371 Print the path to OS libraries for the selected
6372 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6373 present in the @file{lib} subdirectory and no multilibs are used, this is
6374 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6375 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6376 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6377 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6379 @item -print-multiarch
6380 @opindex print-multiarch
6381 Print the path to OS libraries for the selected multiarch,
6382 relative to some @file{lib} subdirectory.
6384 @item -print-prog-name=@var{program}
6385 @opindex print-prog-name
6386 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6388 @item -print-libgcc-file-name
6389 @opindex print-libgcc-file-name
6390 Same as @option{-print-file-name=libgcc.a}.
6392 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6393 but you do want to link with @file{libgcc.a}.  You can do:
6395 @smallexample
6396 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6397 @end smallexample
6399 @item -print-search-dirs
6400 @opindex print-search-dirs
6401 Print the name of the configured installation directory and a list of
6402 program and library directories @command{gcc} searches---and don't do anything else.
6404 This is useful when @command{gcc} prints the error message
6405 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6406 To resolve this you either need to put @file{cpp0} and the other compiler
6407 components where @command{gcc} expects to find them, or you can set the environment
6408 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6409 Don't forget the trailing @samp{/}.
6410 @xref{Environment Variables}.
6412 @item -print-sysroot
6413 @opindex print-sysroot
6414 Print the target sysroot directory that is used during
6415 compilation.  This is the target sysroot specified either at configure
6416 time or using the @option{--sysroot} option, possibly with an extra
6417 suffix that depends on compilation options.  If no target sysroot is
6418 specified, the option prints nothing.
6420 @item -print-sysroot-headers-suffix
6421 @opindex print-sysroot-headers-suffix
6422 Print the suffix added to the target sysroot when searching for
6423 headers, or give an error if the compiler is not configured with such
6424 a suffix---and don't do anything else.
6426 @item -dumpmachine
6427 @opindex dumpmachine
6428 Print the compiler's target machine (for example,
6429 @samp{i686-pc-linux-gnu})---and don't do anything else.
6431 @item -dumpversion
6432 @opindex dumpversion
6433 Print the compiler version (for example, @samp{3.0})---and don't do
6434 anything else.
6436 @item -dumpspecs
6437 @opindex dumpspecs
6438 Print the compiler's built-in specs---and don't do anything else.  (This
6439 is used when GCC itself is being built.)  @xref{Spec Files}.
6441 @item -fno-eliminate-unused-debug-types
6442 @opindex feliminate-unused-debug-types
6443 @opindex fno-eliminate-unused-debug-types
6444 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6445 output for types that are nowhere used in the source file being compiled.
6446 Sometimes it is useful to have GCC emit debugging
6447 information for all types declared in a compilation
6448 unit, regardless of whether or not they are actually used
6449 in that compilation unit, for example 
6450 if, in the debugger, you want to cast a value to a type that is
6451 not actually used in your program (but is declared).  More often,
6452 however, this results in a significant amount of wasted space.
6453 @end table
6455 @node Optimize Options
6456 @section Options That Control Optimization
6457 @cindex optimize options
6458 @cindex options, optimization
6460 These options control various sorts of optimizations.
6462 Without any optimization option, the compiler's goal is to reduce the
6463 cost of compilation and to make debugging produce the expected
6464 results.  Statements are independent: if you stop the program with a
6465 breakpoint between statements, you can then assign a new value to any
6466 variable or change the program counter to any other statement in the
6467 function and get exactly the results you expect from the source
6468 code.
6470 Turning on optimization flags makes the compiler attempt to improve
6471 the performance and/or code size at the expense of compilation time
6472 and possibly the ability to debug the program.
6474 The compiler performs optimization based on the knowledge it has of the
6475 program.  Compiling multiple files at once to a single output file mode allows
6476 the compiler to use information gained from all of the files when compiling
6477 each of them.
6479 Not all optimizations are controlled directly by a flag.  Only
6480 optimizations that have a flag are listed in this section.
6482 Most optimizations are only enabled if an @option{-O} level is set on
6483 the command line.  Otherwise they are disabled, even if individual
6484 optimization flags are specified.
6486 Depending on the target and how GCC was configured, a slightly different
6487 set of optimizations may be enabled at each @option{-O} level than
6488 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6489 to find out the exact set of optimizations that are enabled at each level.
6490 @xref{Overall Options}, for examples.
6492 @table @gcctabopt
6493 @item -O
6494 @itemx -O1
6495 @opindex O
6496 @opindex O1
6497 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6498 more memory for a large function.
6500 With @option{-O}, the compiler tries to reduce code size and execution
6501 time, without performing any optimizations that take a great deal of
6502 compilation time.
6504 @option{-O} turns on the following optimization flags:
6505 @gccoptlist{
6506 -fauto-inc-dec @gol
6507 -fcompare-elim @gol
6508 -fcprop-registers @gol
6509 -fdce @gol
6510 -fdefer-pop @gol
6511 -fdelayed-branch @gol
6512 -fdse @gol
6513 -fguess-branch-probability @gol
6514 -fif-conversion2 @gol
6515 -fif-conversion @gol
6516 -fipa-pure-const @gol
6517 -fipa-profile @gol
6518 -fipa-reference @gol
6519 -fmerge-constants
6520 -fsplit-wide-types @gol
6521 -ftree-bit-ccp @gol
6522 -ftree-builtin-call-dce @gol
6523 -ftree-ccp @gol
6524 -ftree-ch @gol
6525 -ftree-copyrename @gol
6526 -ftree-dce @gol
6527 -ftree-dominator-opts @gol
6528 -ftree-dse @gol
6529 -ftree-forwprop @gol
6530 -ftree-fre @gol
6531 -ftree-phiprop @gol
6532 -ftree-slsr @gol
6533 -ftree-sra @gol
6534 -ftree-pta @gol
6535 -ftree-ter @gol
6536 -funit-at-a-time}
6538 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6539 where doing so does not interfere with debugging.
6541 @item -O2
6542 @opindex O2
6543 Optimize even more.  GCC performs nearly all supported optimizations
6544 that do not involve a space-speed tradeoff.
6545 As compared to @option{-O}, this option increases both compilation time
6546 and the performance of the generated code.
6548 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6549 also turns on the following optimization flags:
6550 @gccoptlist{-fthread-jumps @gol
6551 -falign-functions  -falign-jumps @gol
6552 -falign-loops  -falign-labels @gol
6553 -fcaller-saves @gol
6554 -fcrossjumping @gol
6555 -fcse-follow-jumps  -fcse-skip-blocks @gol
6556 -fdelete-null-pointer-checks @gol
6557 -fdevirtualize @gol
6558 -fexpensive-optimizations @gol
6559 -fgcse  -fgcse-lm  @gol
6560 -fhoist-adjacent-loads @gol
6561 -finline-small-functions @gol
6562 -findirect-inlining @gol
6563 -fipa-sra @gol
6564 -foptimize-sibling-calls @gol
6565 -fpartial-inlining @gol
6566 -fpeephole2 @gol
6567 -fregmove @gol
6568 -freorder-blocks  -freorder-functions @gol
6569 -frerun-cse-after-loop  @gol
6570 -fsched-interblock  -fsched-spec @gol
6571 -fschedule-insns  -fschedule-insns2 @gol
6572 -fstrict-aliasing -fstrict-overflow @gol
6573 -ftree-switch-conversion -ftree-tail-merge @gol
6574 -ftree-pre @gol
6575 -ftree-vrp}
6577 Please note the warning under @option{-fgcse} about
6578 invoking @option{-O2} on programs that use computed gotos.
6580 @item -O3
6581 @opindex O3
6582 Optimize yet more.  @option{-O3} turns on all optimizations specified
6583 by @option{-O2} and also turns on the @option{-finline-functions},
6584 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6585 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6586 @option{-fvect-cost-model},
6587 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6589 @item -O0
6590 @opindex O0
6591 Reduce compilation time and make debugging produce the expected
6592 results.  This is the default.
6594 @item -Os
6595 @opindex Os
6596 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6597 do not typically increase code size.  It also performs further
6598 optimizations designed to reduce code size.
6600 @option{-Os} disables the following optimization flags:
6601 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6602 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6603 -fprefetch-loop-arrays}
6605 @item -Ofast
6606 @opindex Ofast
6607 Disregard strict standards compliance.  @option{-Ofast} enables all
6608 @option{-O3} optimizations.  It also enables optimizations that are not
6609 valid for all standard-compliant programs.
6610 It turns on @option{-ffast-math} and the Fortran-specific
6611 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6613 @item -Og
6614 @opindex Og
6615 Optimize debugging experience.  @option{-Og} enables optimizations
6616 that do not interfere with debugging. It should be the optimization
6617 level of choice for the standard edit-compile-debug cycle, offering
6618 a reasonable level of optimization while maintaining fast compilation
6619 and a good debugging experience.
6621 If you use multiple @option{-O} options, with or without level numbers,
6622 the last such option is the one that is effective.
6623 @end table
6625 Options of the form @option{-f@var{flag}} specify machine-independent
6626 flags.  Most flags have both positive and negative forms; the negative
6627 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6628 below, only one of the forms is listed---the one you typically 
6629 use.  You can figure out the other form by either removing @samp{no-}
6630 or adding it.
6632 The following options control specific optimizations.  They are either
6633 activated by @option{-O} options or are related to ones that are.  You
6634 can use the following flags in the rare cases when ``fine-tuning'' of
6635 optimizations to be performed is desired.
6637 @table @gcctabopt
6638 @item -fno-default-inline
6639 @opindex fno-default-inline
6640 Do not make member functions inline by default merely because they are
6641 defined inside the class scope (C++ only).  Otherwise, when you specify
6642 @w{@option{-O}}, member functions defined inside class scope are compiled
6643 inline by default; i.e., you don't need to add @samp{inline} in front of
6644 the member function name.
6646 @item -fno-defer-pop
6647 @opindex fno-defer-pop
6648 Always pop the arguments to each function call as soon as that function
6649 returns.  For machines that must pop arguments after a function call,
6650 the compiler normally lets arguments accumulate on the stack for several
6651 function calls and pops them all at once.
6653 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6655 @item -fforward-propagate
6656 @opindex fforward-propagate
6657 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6658 instructions and checks if the result can be simplified.  If loop unrolling
6659 is active, two passes are performed and the second is scheduled after
6660 loop unrolling.
6662 This option is enabled by default at optimization levels @option{-O},
6663 @option{-O2}, @option{-O3}, @option{-Os}.
6665 @item -ffp-contract=@var{style}
6666 @opindex ffp-contract
6667 @option{-ffp-contract=off} disables floating-point expression contraction.
6668 @option{-ffp-contract=fast} enables floating-point expression contraction
6669 such as forming of fused multiply-add operations if the target has
6670 native support for them.
6671 @option{-ffp-contract=on} enables floating-point expression contraction
6672 if allowed by the language standard.  This is currently not implemented
6673 and treated equal to @option{-ffp-contract=off}.
6675 The default is @option{-ffp-contract=fast}.
6677 @item -fomit-frame-pointer
6678 @opindex fomit-frame-pointer
6679 Don't keep the frame pointer in a register for functions that
6680 don't need one.  This avoids the instructions to save, set up and
6681 restore frame pointers; it also makes an extra register available
6682 in many functions.  @strong{It also makes debugging impossible on
6683 some machines.}
6685 On some machines, such as the VAX, this flag has no effect, because
6686 the standard calling sequence automatically handles the frame pointer
6687 and nothing is saved by pretending it doesn't exist.  The
6688 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6689 whether a target machine supports this flag.  @xref{Registers,,Register
6690 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6692 Starting with GCC version 4.6, the default setting (when not optimizing for
6693 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6694 @option{-fomit-frame-pointer}.  The default can be reverted to
6695 @option{-fno-omit-frame-pointer} by configuring GCC with the
6696 @option{--enable-frame-pointer} configure option.
6698 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6700 @item -foptimize-sibling-calls
6701 @opindex foptimize-sibling-calls
6702 Optimize sibling and tail recursive calls.
6704 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6706 @item -fno-inline
6707 @opindex fno-inline
6708 Do not expand any functions inline apart from those marked with
6709 the @code{always_inline} attribute.  This is the default when not
6710 optimizing.
6712 Single functions can be exempted from inlining by marking them
6713 with the @code{noinline} attribute.
6715 @item -finline-small-functions
6716 @opindex finline-small-functions
6717 Integrate functions into their callers when their body is smaller than expected
6718 function call code (so overall size of program gets smaller).  The compiler
6719 heuristically decides which functions are simple enough to be worth integrating
6720 in this way.  This inlining applies to all functions, even those not declared
6721 inline.
6723 Enabled at level @option{-O2}.
6725 @item -findirect-inlining
6726 @opindex findirect-inlining
6727 Inline also indirect calls that are discovered to be known at compile
6728 time thanks to previous inlining.  This option has any effect only
6729 when inlining itself is turned on by the @option{-finline-functions}
6730 or @option{-finline-small-functions} options.
6732 Enabled at level @option{-O2}.
6734 @item -finline-functions
6735 @opindex finline-functions
6736 Consider all functions for inlining, even if they are not declared inline.
6737 The compiler heuristically decides which functions are worth integrating
6738 in this way.
6740 If all calls to a given function are integrated, and the function is
6741 declared @code{static}, then the function is normally not output as
6742 assembler code in its own right.
6744 Enabled at level @option{-O3}.
6746 @item -finline-functions-called-once
6747 @opindex finline-functions-called-once
6748 Consider all @code{static} functions called once for inlining into their
6749 caller even if they are not marked @code{inline}.  If a call to a given
6750 function is integrated, then the function is not output as assembler code
6751 in its own right.
6753 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6755 @item -fearly-inlining
6756 @opindex fearly-inlining
6757 Inline functions marked by @code{always_inline} and functions whose body seems
6758 smaller than the function call overhead early before doing
6759 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6760 makes profiling significantly cheaper and usually inlining faster on programs
6761 having large chains of nested wrapper functions.
6763 Enabled by default.
6765 @item -fipa-sra
6766 @opindex fipa-sra
6767 Perform interprocedural scalar replacement of aggregates, removal of
6768 unused parameters and replacement of parameters passed by reference
6769 by parameters passed by value.
6771 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6773 @item -finline-limit=@var{n}
6774 @opindex finline-limit
6775 By default, GCC limits the size of functions that can be inlined.  This flag
6776 allows coarse control of this limit.  @var{n} is the size of functions that
6777 can be inlined in number of pseudo instructions.
6779 Inlining is actually controlled by a number of parameters, which may be
6780 specified individually by using @option{--param @var{name}=@var{value}}.
6781 The @option{-finline-limit=@var{n}} option sets some of these parameters
6782 as follows:
6784 @table @gcctabopt
6785 @item max-inline-insns-single
6786 is set to @var{n}/2.
6787 @item max-inline-insns-auto
6788 is set to @var{n}/2.
6789 @end table
6791 See below for a documentation of the individual
6792 parameters controlling inlining and for the defaults of these parameters.
6794 @emph{Note:} there may be no value to @option{-finline-limit} that results
6795 in default behavior.
6797 @emph{Note:} pseudo instruction represents, in this particular context, an
6798 abstract measurement of function's size.  In no way does it represent a count
6799 of assembly instructions and as such its exact meaning might change from one
6800 release to an another.
6802 @item -fno-keep-inline-dllexport
6803 @opindex -fno-keep-inline-dllexport
6804 This is a more fine-grained version of @option{-fkeep-inline-functions},
6805 which applies only to functions that are declared using the @code{dllexport}
6806 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6807 Functions}.)
6809 @item -fkeep-inline-functions
6810 @opindex fkeep-inline-functions
6811 In C, emit @code{static} functions that are declared @code{inline}
6812 into the object file, even if the function has been inlined into all
6813 of its callers.  This switch does not affect functions using the
6814 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6815 inline functions into the object file.
6817 @item -fkeep-static-consts
6818 @opindex fkeep-static-consts
6819 Emit variables declared @code{static const} when optimization isn't turned
6820 on, even if the variables aren't referenced.
6822 GCC enables this option by default.  If you want to force the compiler to
6823 check if a variable is referenced, regardless of whether or not
6824 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6826 @item -fmerge-constants
6827 @opindex fmerge-constants
6828 Attempt to merge identical constants (string constants and floating-point
6829 constants) across compilation units.
6831 This option is the default for optimized compilation if the assembler and
6832 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6833 behavior.
6835 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6837 @item -fmerge-all-constants
6838 @opindex fmerge-all-constants
6839 Attempt to merge identical constants and identical variables.
6841 This option implies @option{-fmerge-constants}.  In addition to
6842 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6843 arrays or initialized constant variables with integral or floating-point
6844 types.  Languages like C or C++ require each variable, including multiple
6845 instances of the same variable in recursive calls, to have distinct locations,
6846 so using this option results in non-conforming
6847 behavior.
6849 @item -fmodulo-sched
6850 @opindex fmodulo-sched
6851 Perform swing modulo scheduling immediately before the first scheduling
6852 pass.  This pass looks at innermost loops and reorders their
6853 instructions by overlapping different iterations.
6855 @item -fmodulo-sched-allow-regmoves
6856 @opindex fmodulo-sched-allow-regmoves
6857 Perform more aggressive SMS-based modulo scheduling with register moves
6858 allowed.  By setting this flag certain anti-dependences edges are
6859 deleted, which triggers the generation of reg-moves based on the
6860 life-range analysis.  This option is effective only with
6861 @option{-fmodulo-sched} enabled.
6863 @item -fno-branch-count-reg
6864 @opindex fno-branch-count-reg
6865 Do not use ``decrement and branch'' instructions on a count register,
6866 but instead generate a sequence of instructions that decrement a
6867 register, compare it against zero, then branch based upon the result.
6868 This option is only meaningful on architectures that support such
6869 instructions, which include x86, PowerPC, IA-64 and S/390.
6871 The default is @option{-fbranch-count-reg}.
6873 @item -fno-function-cse
6874 @opindex fno-function-cse
6875 Do not put function addresses in registers; make each instruction that
6876 calls a constant function contain the function's address explicitly.
6878 This option results in less efficient code, but some strange hacks
6879 that alter the assembler output may be confused by the optimizations
6880 performed when this option is not used.
6882 The default is @option{-ffunction-cse}
6884 @item -fno-zero-initialized-in-bss
6885 @opindex fno-zero-initialized-in-bss
6886 If the target supports a BSS section, GCC by default puts variables that
6887 are initialized to zero into BSS@.  This can save space in the resulting
6888 code.
6890 This option turns off this behavior because some programs explicitly
6891 rely on variables going to the data section---e.g., so that the
6892 resulting executable can find the beginning of that section and/or make
6893 assumptions based on that.
6895 The default is @option{-fzero-initialized-in-bss}.
6897 @item -fmudflap -fmudflapth -fmudflapir
6898 @opindex fmudflap
6899 @opindex fmudflapth
6900 @opindex fmudflapir
6901 @cindex bounds checking
6902 @cindex mudflap
6903 For front-ends that support it (C and C++), instrument all risky
6904 pointer/array dereferencing operations, some standard library
6905 string/heap functions, and some other associated constructs with
6906 range/validity tests.  Modules so instrumented should be immune to
6907 buffer overflows, invalid heap use, and some other classes of C/C++
6908 programming errors.  The instrumentation relies on a separate runtime
6909 library (@file{libmudflap}), which is linked into a program if
6910 @option{-fmudflap} is given at link time.  Run-time behavior of the
6911 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6912 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6913 for its options.
6915 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6916 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6917 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6918 instrumentation should ignore pointer reads.  This produces less
6919 instrumentation (and therefore faster execution) and still provides
6920 some protection against outright memory corrupting writes, but allows
6921 erroneously read data to propagate within a program.
6923 @item -fthread-jumps
6924 @opindex fthread-jumps
6925 Perform optimizations that check to see if a jump branches to a
6926 location where another comparison subsumed by the first is found.  If
6927 so, the first branch is redirected to either the destination of the
6928 second branch or a point immediately following it, depending on whether
6929 the condition is known to be true or false.
6931 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6933 @item -fsplit-wide-types
6934 @opindex fsplit-wide-types
6935 When using a type that occupies multiple registers, such as @code{long
6936 long} on a 32-bit system, split the registers apart and allocate them
6937 independently.  This normally generates better code for those types,
6938 but may make debugging more difficult.
6940 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6941 @option{-Os}.
6943 @item -fcse-follow-jumps
6944 @opindex fcse-follow-jumps
6945 In common subexpression elimination (CSE), scan through jump instructions
6946 when the target of the jump is not reached by any other path.  For
6947 example, when CSE encounters an @code{if} statement with an
6948 @code{else} clause, CSE follows the jump when the condition
6949 tested is false.
6951 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6953 @item -fcse-skip-blocks
6954 @opindex fcse-skip-blocks
6955 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6956 follow jumps that conditionally skip over blocks.  When CSE
6957 encounters a simple @code{if} statement with no else clause,
6958 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6959 body of the @code{if}.
6961 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6963 @item -frerun-cse-after-loop
6964 @opindex frerun-cse-after-loop
6965 Re-run common subexpression elimination after loop optimizations are
6966 performed.
6968 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6970 @item -fgcse
6971 @opindex fgcse
6972 Perform a global common subexpression elimination pass.
6973 This pass also performs global constant and copy propagation.
6975 @emph{Note:} When compiling a program using computed gotos, a GCC
6976 extension, you may get better run-time performance if you disable
6977 the global common subexpression elimination pass by adding
6978 @option{-fno-gcse} to the command line.
6980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6982 @item -fgcse-lm
6983 @opindex fgcse-lm
6984 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6985 attempts to move loads that are only killed by stores into themselves.  This
6986 allows a loop containing a load/store sequence to be changed to a load outside
6987 the loop, and a copy/store within the loop.
6989 Enabled by default when @option{-fgcse} is enabled.
6991 @item -fgcse-sm
6992 @opindex fgcse-sm
6993 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6994 global common subexpression elimination.  This pass attempts to move
6995 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6996 loops containing a load/store sequence can be changed to a load before
6997 the loop and a store after the loop.
6999 Not enabled at any optimization level.
7001 @item -fgcse-las
7002 @opindex fgcse-las
7003 When @option{-fgcse-las} is enabled, the global common subexpression
7004 elimination pass eliminates redundant loads that come after stores to the
7005 same memory location (both partial and full redundancies).
7007 Not enabled at any optimization level.
7009 @item -fgcse-after-reload
7010 @opindex fgcse-after-reload
7011 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7012 pass is performed after reload.  The purpose of this pass is to clean up
7013 redundant spilling.
7015 @item -faggressive-loop-optimizations
7016 @opindex faggressive-loop-optimizations
7017 This option tells the loop optimizer to use language constraints to
7018 derive bounds for the number of iterations of a loop.  This assumes that
7019 loop code does not invoke undefined behavior by for example causing signed
7020 integer overflows or out-of-bound array accesses.  The bounds for the
7021 number of iterations of a loop are used to guide loop unrolling and peeling
7022 and loop exit test optimizations.
7023 This option is enabled by default.
7025 @item -funsafe-loop-optimizations
7026 @opindex funsafe-loop-optimizations
7027 This option tells the loop optimizer to assume that loop indices do not
7028 overflow, and that loops with nontrivial exit condition are not
7029 infinite.  This enables a wider range of loop optimizations even if
7030 the loop optimizer itself cannot prove that these assumptions are valid.
7031 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7032 if it finds this kind of loop.
7034 @item -fcrossjumping
7035 @opindex fcrossjumping
7036 Perform cross-jumping transformation.
7037 This transformation unifies equivalent code and saves code size.  The
7038 resulting code may or may not perform better than without cross-jumping.
7040 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7042 @item -fauto-inc-dec
7043 @opindex fauto-inc-dec
7044 Combine increments or decrements of addresses with memory accesses.
7045 This pass is always skipped on architectures that do not have
7046 instructions to support this.  Enabled by default at @option{-O} and
7047 higher on architectures that support this.
7049 @item -fdce
7050 @opindex fdce
7051 Perform dead code elimination (DCE) on RTL@.
7052 Enabled by default at @option{-O} and higher.
7054 @item -fdse
7055 @opindex fdse
7056 Perform dead store elimination (DSE) on RTL@.
7057 Enabled by default at @option{-O} and higher.
7059 @item -fif-conversion
7060 @opindex fif-conversion
7061 Attempt to transform conditional jumps into branch-less equivalents.  This
7062 includes use of conditional moves, min, max, set flags and abs instructions, and
7063 some tricks doable by standard arithmetics.  The use of conditional execution
7064 on chips where it is available is controlled by @code{if-conversion2}.
7066 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7068 @item -fif-conversion2
7069 @opindex fif-conversion2
7070 Use conditional execution (where available) to transform conditional jumps into
7071 branch-less equivalents.
7073 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7075 @item -fdelete-null-pointer-checks
7076 @opindex fdelete-null-pointer-checks
7077 Assume that programs cannot safely dereference null pointers, and that
7078 no code or data element resides there.  This enables simple constant
7079 folding optimizations at all optimization levels.  In addition, other
7080 optimization passes in GCC use this flag to control global dataflow
7081 analyses that eliminate useless checks for null pointers; these assume
7082 that if a pointer is checked after it has already been dereferenced,
7083 it cannot be null.
7085 Note however that in some environments this assumption is not true.
7086 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7087 for programs that depend on that behavior.
7089 Some targets, especially embedded ones, disable this option at all levels.
7090 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7091 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7092 are enabled independently at different optimization levels.
7094 @item -fdevirtualize
7095 @opindex fdevirtualize
7096 Attempt to convert calls to virtual functions to direct calls.  This
7097 is done both within a procedure and interprocedurally as part of
7098 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7099 propagation (@option{-fipa-cp}).
7100 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7102 @item -fexpensive-optimizations
7103 @opindex fexpensive-optimizations
7104 Perform a number of minor optimizations that are relatively expensive.
7106 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7108 @item -free
7109 @opindex free
7110 Attempt to remove redundant extension instructions.  This is especially
7111 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7112 registers after writing to their lower 32-bit half.
7114 Enabled for x86 at levels @option{-O2}, @option{-O3}.
7116 @item -foptimize-register-move
7117 @itemx -fregmove
7118 @opindex foptimize-register-move
7119 @opindex fregmove
7120 Attempt to reassign register numbers in move instructions and as
7121 operands of other simple instructions in order to maximize the amount of
7122 register tying.  This is especially helpful on machines with two-operand
7123 instructions.
7125 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
7126 optimization.
7128 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7130 @item -fira-algorithm=@var{algorithm}
7131 Use the specified coloring algorithm for the integrated register
7132 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7133 specifies Chow's priority coloring, or @samp{CB}, which specifies
7134 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7135 for all architectures, but for those targets that do support it, it is
7136 the default because it generates better code.
7138 @item -fira-region=@var{region}
7139 Use specified regions for the integrated register allocator.  The
7140 @var{region} argument should be one of the following:
7142 @table @samp
7144 @item all
7145 Use all loops as register allocation regions.
7146 This can give the best results for machines with a small and/or
7147 irregular register set.
7149 @item mixed
7150 Use all loops except for loops with small register pressure 
7151 as the regions.  This value usually gives
7152 the best results in most cases and for most architectures,
7153 and is enabled by default when compiling with optimization for speed
7154 (@option{-O}, @option{-O2}, @dots{}).
7156 @item one
7157 Use all functions as a single region.  
7158 This typically results in the smallest code size, and is enabled by default for
7159 @option{-Os} or @option{-O0}.
7161 @end table
7163 @item -fira-hoist-pressure
7164 @opindex fira-hoist-pressure
7165 Use IRA to evaluate register pressure in the code hoisting pass for
7166 decisions to hoist expressions.  This option usually results in smaller
7167 code, but it can slow the compiler down.
7169 This option is enabled at level @option{-Os} for all targets.
7171 @item -fira-loop-pressure
7172 @opindex fira-loop-pressure
7173 Use IRA to evaluate register pressure in loops for decisions to move
7174 loop invariants.  This option usually results in generation
7175 of faster and smaller code on machines with large register files (>= 32
7176 registers), but it can slow the compiler down.
7178 This option is enabled at level @option{-O3} for some targets.
7180 @item -fno-ira-share-save-slots
7181 @opindex fno-ira-share-save-slots
7182 Disable sharing of stack slots used for saving call-used hard
7183 registers living through a call.  Each hard register gets a
7184 separate stack slot, and as a result function stack frames are
7185 larger.
7187 @item -fno-ira-share-spill-slots
7188 @opindex fno-ira-share-spill-slots
7189 Disable sharing of stack slots allocated for pseudo-registers.  Each
7190 pseudo-register that does not get a hard register gets a separate
7191 stack slot, and as a result function stack frames are larger.
7193 @item -fira-verbose=@var{n}
7194 @opindex fira-verbose
7195 Control the verbosity of the dump file for the integrated register allocator.
7196 The default value is 5.  If the value @var{n} is greater or equal to 10,
7197 the dump output is sent to stderr using the same format as @var{n} minus 10.
7199 @item -fdelayed-branch
7200 @opindex fdelayed-branch
7201 If supported for the target machine, attempt to reorder instructions
7202 to exploit instruction slots available after delayed branch
7203 instructions.
7205 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7207 @item -fschedule-insns
7208 @opindex fschedule-insns
7209 If supported for the target machine, attempt to reorder instructions to
7210 eliminate execution stalls due to required data being unavailable.  This
7211 helps machines that have slow floating point or memory load instructions
7212 by allowing other instructions to be issued until the result of the load
7213 or floating-point instruction is required.
7215 Enabled at levels @option{-O2}, @option{-O3}.
7217 @item -fschedule-insns2
7218 @opindex fschedule-insns2
7219 Similar to @option{-fschedule-insns}, but requests an additional pass of
7220 instruction scheduling after register allocation has been done.  This is
7221 especially useful on machines with a relatively small number of
7222 registers and where memory load instructions take more than one cycle.
7224 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7226 @item -fno-sched-interblock
7227 @opindex fno-sched-interblock
7228 Don't schedule instructions across basic blocks.  This is normally
7229 enabled by default when scheduling before register allocation, i.e.@:
7230 with @option{-fschedule-insns} or at @option{-O2} or higher.
7232 @item -fno-sched-spec
7233 @opindex fno-sched-spec
7234 Don't allow speculative motion of non-load instructions.  This is normally
7235 enabled by default when scheduling before register allocation, i.e.@:
7236 with @option{-fschedule-insns} or at @option{-O2} or higher.
7238 @item -fsched-pressure
7239 @opindex fsched-pressure
7240 Enable register pressure sensitive insn scheduling before register
7241 allocation.  This only makes sense when scheduling before register
7242 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7243 @option{-O2} or higher.  Usage of this option can improve the
7244 generated code and decrease its size by preventing register pressure
7245 increase above the number of available hard registers and subsequent
7246 spills in register allocation.
7248 @item -fsched-spec-load
7249 @opindex fsched-spec-load
7250 Allow speculative motion of some load instructions.  This only makes
7251 sense when scheduling before register allocation, i.e.@: with
7252 @option{-fschedule-insns} or at @option{-O2} or higher.
7254 @item -fsched-spec-load-dangerous
7255 @opindex fsched-spec-load-dangerous
7256 Allow speculative motion of more load instructions.  This only makes
7257 sense when scheduling before register allocation, i.e.@: with
7258 @option{-fschedule-insns} or at @option{-O2} or higher.
7260 @item -fsched-stalled-insns
7261 @itemx -fsched-stalled-insns=@var{n}
7262 @opindex fsched-stalled-insns
7263 Define how many insns (if any) can be moved prematurely from the queue
7264 of stalled insns into the ready list during the second scheduling pass.
7265 @option{-fno-sched-stalled-insns} means that no insns are moved
7266 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7267 on how many queued insns can be moved prematurely.
7268 @option{-fsched-stalled-insns} without a value is equivalent to
7269 @option{-fsched-stalled-insns=1}.
7271 @item -fsched-stalled-insns-dep
7272 @itemx -fsched-stalled-insns-dep=@var{n}
7273 @opindex fsched-stalled-insns-dep
7274 Define how many insn groups (cycles) are examined for a dependency
7275 on a stalled insn that is a candidate for premature removal from the queue
7276 of stalled insns.  This has an effect only during the second scheduling pass,
7277 and only if @option{-fsched-stalled-insns} is used.
7278 @option{-fno-sched-stalled-insns-dep} is equivalent to
7279 @option{-fsched-stalled-insns-dep=0}.
7280 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7281 @option{-fsched-stalled-insns-dep=1}.
7283 @item -fsched2-use-superblocks
7284 @opindex fsched2-use-superblocks
7285 When scheduling after register allocation, use superblock scheduling.
7286 This allows motion across basic block boundaries,
7287 resulting in faster schedules.  This option is experimental, as not all machine
7288 descriptions used by GCC model the CPU closely enough to avoid unreliable
7289 results from the algorithm.
7291 This only makes sense when scheduling after register allocation, i.e.@: with
7292 @option{-fschedule-insns2} or at @option{-O2} or higher.
7294 @item -fsched-group-heuristic
7295 @opindex fsched-group-heuristic
7296 Enable the group heuristic in the scheduler.  This heuristic favors
7297 the instruction that belongs to a schedule group.  This is enabled
7298 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7299 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7301 @item -fsched-critical-path-heuristic
7302 @opindex fsched-critical-path-heuristic
7303 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7304 instructions on the critical path.  This is enabled by default when
7305 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7306 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7308 @item -fsched-spec-insn-heuristic
7309 @opindex fsched-spec-insn-heuristic
7310 Enable the speculative instruction heuristic in the scheduler.  This
7311 heuristic favors speculative instructions with greater dependency weakness.
7312 This is enabled by default when scheduling is enabled, i.e.@:
7313 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7314 or at @option{-O2} or higher.
7316 @item -fsched-rank-heuristic
7317 @opindex fsched-rank-heuristic
7318 Enable the rank heuristic in the scheduler.  This heuristic favors
7319 the instruction belonging to a basic block with greater size or frequency.
7320 This is enabled by default when scheduling is enabled, i.e.@:
7321 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7322 at @option{-O2} or higher.
7324 @item -fsched-last-insn-heuristic
7325 @opindex fsched-last-insn-heuristic
7326 Enable the last-instruction heuristic in the scheduler.  This heuristic
7327 favors the instruction that is less dependent on the last instruction
7328 scheduled.  This is enabled by default when scheduling is enabled,
7329 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7330 at @option{-O2} or higher.
7332 @item -fsched-dep-count-heuristic
7333 @opindex fsched-dep-count-heuristic
7334 Enable the dependent-count heuristic in the scheduler.  This heuristic
7335 favors the instruction that has more instructions depending on it.
7336 This is enabled by default when scheduling is enabled, i.e.@:
7337 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7338 at @option{-O2} or higher.
7340 @item -freschedule-modulo-scheduled-loops
7341 @opindex freschedule-modulo-scheduled-loops
7342 Modulo scheduling is performed before traditional scheduling.  If a loop
7343 is modulo scheduled, later scheduling passes may change its schedule.  
7344 Use this option to control that behavior.
7346 @item -fselective-scheduling
7347 @opindex fselective-scheduling
7348 Schedule instructions using selective scheduling algorithm.  Selective
7349 scheduling runs instead of the first scheduler pass.
7351 @item -fselective-scheduling2
7352 @opindex fselective-scheduling2
7353 Schedule instructions using selective scheduling algorithm.  Selective
7354 scheduling runs instead of the second scheduler pass.
7356 @item -fsel-sched-pipelining
7357 @opindex fsel-sched-pipelining
7358 Enable software pipelining of innermost loops during selective scheduling.
7359 This option has no effect unless one of @option{-fselective-scheduling} or
7360 @option{-fselective-scheduling2} is turned on.
7362 @item -fsel-sched-pipelining-outer-loops
7363 @opindex fsel-sched-pipelining-outer-loops
7364 When pipelining loops during selective scheduling, also pipeline outer loops.
7365 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7367 @item -fshrink-wrap
7368 @opindex fshrink-wrap
7369 Emit function prologues only before parts of the function that need it,
7370 rather than at the top of the function.  This flag is enabled by default at
7371 @option{-O} and higher.
7373 @item -fcaller-saves
7374 @opindex fcaller-saves
7375 Enable allocation of values to registers that are clobbered by
7376 function calls, by emitting extra instructions to save and restore the
7377 registers around such calls.  Such allocation is done only when it
7378 seems to result in better code.
7380 This option is always enabled by default on certain machines, usually
7381 those which have no call-preserved registers to use instead.
7383 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7385 @item -fcombine-stack-adjustments
7386 @opindex fcombine-stack-adjustments
7387 Tracks stack adjustments (pushes and pops) and stack memory references
7388 and then tries to find ways to combine them.
7390 Enabled by default at @option{-O1} and higher.
7392 @item -fconserve-stack
7393 @opindex fconserve-stack
7394 Attempt to minimize stack usage.  The compiler attempts to use less
7395 stack space, even if that makes the program slower.  This option
7396 implies setting the @option{large-stack-frame} parameter to 100
7397 and the @option{large-stack-frame-growth} parameter to 400.
7399 @item -ftree-reassoc
7400 @opindex ftree-reassoc
7401 Perform reassociation on trees.  This flag is enabled by default
7402 at @option{-O} and higher.
7404 @item -ftree-pre
7405 @opindex ftree-pre
7406 Perform partial redundancy elimination (PRE) on trees.  This flag is
7407 enabled by default at @option{-O2} and @option{-O3}.
7409 @item -ftree-partial-pre
7410 @opindex ftree-partial-pre
7411 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7412 enabled by default at @option{-O3}.
7414 @item -ftree-forwprop
7415 @opindex ftree-forwprop
7416 Perform forward propagation on trees.  This flag is enabled by default
7417 at @option{-O} and higher.
7419 @item -ftree-fre
7420 @opindex ftree-fre
7421 Perform full redundancy elimination (FRE) on trees.  The difference
7422 between FRE and PRE is that FRE only considers expressions
7423 that are computed on all paths leading to the redundant computation.
7424 This analysis is faster than PRE, though it exposes fewer redundancies.
7425 This flag is enabled by default at @option{-O} and higher.
7427 @item -ftree-phiprop
7428 @opindex ftree-phiprop
7429 Perform hoisting of loads from conditional pointers on trees.  This
7430 pass is enabled by default at @option{-O} and higher.
7432 @item -fhoist-adjacent-loads
7433 @opindex hoist-adjacent-loads
7434 Speculatively hoist loads from both branches of an if-then-else if the
7435 loads are from adjacent locations in the same structure and the target
7436 architecture has a conditional move instruction.  This flag is enabled
7437 by default at @option{-O2} and higher.
7439 @item -ftree-copy-prop
7440 @opindex ftree-copy-prop
7441 Perform copy propagation on trees.  This pass eliminates unnecessary
7442 copy operations.  This flag is enabled by default at @option{-O} and
7443 higher.
7445 @item -fipa-pure-const
7446 @opindex fipa-pure-const
7447 Discover which functions are pure or constant.
7448 Enabled by default at @option{-O} and higher.
7450 @item -fipa-reference
7451 @opindex fipa-reference
7452 Discover which static variables do not escape the
7453 compilation unit.
7454 Enabled by default at @option{-O} and higher.
7456 @item -fipa-pta
7457 @opindex fipa-pta
7458 Perform interprocedural pointer analysis and interprocedural modification
7459 and reference analysis.  This option can cause excessive memory and
7460 compile-time usage on large compilation units.  It is not enabled by
7461 default at any optimization level.
7463 @item -fipa-profile
7464 @opindex fipa-profile
7465 Perform interprocedural profile propagation.  The functions called only from
7466 cold functions are marked as cold. Also functions executed once (such as
7467 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7468 functions and loop less parts of functions executed once are then optimized for
7469 size.
7470 Enabled by default at @option{-O} and higher.
7472 @item -fipa-cp
7473 @opindex fipa-cp
7474 Perform interprocedural constant propagation.
7475 This optimization analyzes the program to determine when values passed
7476 to functions are constants and then optimizes accordingly.
7477 This optimization can substantially increase performance
7478 if the application has constants passed to functions.
7479 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7481 @item -fipa-cp-clone
7482 @opindex fipa-cp-clone
7483 Perform function cloning to make interprocedural constant propagation stronger.
7484 When enabled, interprocedural constant propagation performs function cloning
7485 when externally visible function can be called with constant arguments.
7486 Because this optimization can create multiple copies of functions,
7487 it may significantly increase code size
7488 (see @option{--param ipcp-unit-growth=@var{value}}).
7489 This flag is enabled by default at @option{-O3}.
7491 @item -ftree-sink
7492 @opindex ftree-sink
7493 Perform forward store motion  on trees.  This flag is
7494 enabled by default at @option{-O} and higher.
7496 @item -ftree-bit-ccp
7497 @opindex ftree-bit-ccp
7498 Perform sparse conditional bit constant propagation on trees and propagate
7499 pointer alignment information.
7500 This pass only operates on local scalar variables and is enabled by default
7501 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7503 @item -ftree-ccp
7504 @opindex ftree-ccp
7505 Perform sparse conditional constant propagation (CCP) on trees.  This
7506 pass only operates on local scalar variables and is enabled by default
7507 at @option{-O} and higher.
7509 @item -ftree-switch-conversion
7510 Perform conversion of simple initializations in a switch to
7511 initializations from a scalar array.  This flag is enabled by default
7512 at @option{-O2} and higher.
7514 @item -ftree-tail-merge
7515 Look for identical code sequences.  When found, replace one with a jump to the
7516 other.  This optimization is known as tail merging or cross jumping.  This flag
7517 is enabled by default at @option{-O2} and higher.  The compilation time
7518 in this pass can
7519 be limited using @option{max-tail-merge-comparisons} parameter and
7520 @option{max-tail-merge-iterations} parameter.
7522 @item -ftree-dce
7523 @opindex ftree-dce
7524 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7525 default at @option{-O} and higher.
7527 @item -ftree-builtin-call-dce
7528 @opindex ftree-builtin-call-dce
7529 Perform conditional dead code elimination (DCE) for calls to built-in functions
7530 that may set @code{errno} but are otherwise side-effect free.  This flag is
7531 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7532 specified.
7534 @item -ftree-dominator-opts
7535 @opindex ftree-dominator-opts
7536 Perform a variety of simple scalar cleanups (constant/copy
7537 propagation, redundancy elimination, range propagation and expression
7538 simplification) based on a dominator tree traversal.  This also
7539 performs jump threading (to reduce jumps to jumps). This flag is
7540 enabled by default at @option{-O} and higher.
7542 @item -ftree-dse
7543 @opindex ftree-dse
7544 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7545 a memory location that is later overwritten by another store without
7546 any intervening loads.  In this case the earlier store can be deleted.  This
7547 flag is enabled by default at @option{-O} and higher.
7549 @item -ftree-ch
7550 @opindex ftree-ch
7551 Perform loop header copying on trees.  This is beneficial since it increases
7552 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7553 is enabled by default at @option{-O} and higher.  It is not enabled
7554 for @option{-Os}, since it usually increases code size.
7556 @item -ftree-loop-optimize
7557 @opindex ftree-loop-optimize
7558 Perform loop optimizations on trees.  This flag is enabled by default
7559 at @option{-O} and higher.
7561 @item -ftree-loop-linear
7562 @opindex ftree-loop-linear
7563 Perform loop interchange transformations on tree.  Same as
7564 @option{-floop-interchange}.  To use this code transformation, GCC has
7565 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7566 enable the Graphite loop transformation infrastructure.
7568 @item -floop-interchange
7569 @opindex floop-interchange
7570 Perform loop interchange transformations on loops.  Interchanging two
7571 nested loops switches the inner and outer loops.  For example, given a
7572 loop like:
7573 @smallexample
7574 DO J = 1, M
7575   DO I = 1, N
7576     A(J, I) = A(J, I) * C
7577   ENDDO
7578 ENDDO
7579 @end smallexample
7580 loop interchange transforms the loop as if it were written:
7581 @smallexample
7582 DO I = 1, N
7583   DO J = 1, M
7584     A(J, I) = A(J, I) * C
7585   ENDDO
7586 ENDDO
7587 @end smallexample
7588 which can be beneficial when @code{N} is larger than the caches,
7589 because in Fortran, the elements of an array are stored in memory
7590 contiguously by column, and the original loop iterates over rows,
7591 potentially creating at each access a cache miss.  This optimization
7592 applies to all the languages supported by GCC and is not limited to
7593 Fortran.  To use this code transformation, GCC has to be configured
7594 with @option{--with-ppl} and @option{--with-cloog} to enable the
7595 Graphite loop transformation infrastructure.
7597 @item -floop-strip-mine
7598 @opindex floop-strip-mine
7599 Perform loop strip mining transformations on loops.  Strip mining
7600 splits a loop into two nested loops.  The outer loop has strides
7601 equal to the strip size and the inner loop has strides of the
7602 original loop within a strip.  The strip length can be changed
7603 using the @option{loop-block-tile-size} parameter.  For example,
7604 given a loop like:
7605 @smallexample
7606 DO I = 1, N
7607   A(I) = A(I) + C
7608 ENDDO
7609 @end smallexample
7610 loop strip mining transforms the loop as if it were written:
7611 @smallexample
7612 DO II = 1, N, 51
7613   DO I = II, min (II + 50, N)
7614     A(I) = A(I) + C
7615   ENDDO
7616 ENDDO
7617 @end smallexample
7618 This optimization applies to all the languages supported by GCC and is
7619 not limited to Fortran.  To use this code transformation, GCC has to
7620 be configured with @option{--with-ppl} and @option{--with-cloog} to
7621 enable the Graphite loop transformation infrastructure.
7623 @item -floop-block
7624 @opindex floop-block
7625 Perform loop blocking transformations on loops.  Blocking strip mines
7626 each loop in the loop nest such that the memory accesses of the
7627 element loops fit inside caches.  The strip length can be changed
7628 using the @option{loop-block-tile-size} parameter.  For example, given
7629 a loop like:
7630 @smallexample
7631 DO I = 1, N
7632   DO J = 1, M
7633     A(J, I) = B(I) + C(J)
7634   ENDDO
7635 ENDDO
7636 @end smallexample
7637 loop blocking transforms the loop as if it were written:
7638 @smallexample
7639 DO II = 1, N, 51
7640   DO JJ = 1, M, 51
7641     DO I = II, min (II + 50, N)
7642       DO J = JJ, min (JJ + 50, M)
7643         A(J, I) = B(I) + C(J)
7644       ENDDO
7645     ENDDO
7646   ENDDO
7647 ENDDO
7648 @end smallexample
7649 which can be beneficial when @code{M} is larger than the caches,
7650 because the innermost loop iterates over a smaller amount of data
7651 which can be kept in the caches.  This optimization applies to all the
7652 languages supported by GCC and is not limited to Fortran.  To use this
7653 code transformation, GCC has to be configured with @option{--with-ppl}
7654 and @option{--with-cloog} to enable the Graphite loop transformation
7655 infrastructure.
7657 @item -fgraphite-identity
7658 @opindex fgraphite-identity
7659 Enable the identity transformation for graphite.  For every SCoP we generate
7660 the polyhedral representation and transform it back to gimple.  Using
7661 @option{-fgraphite-identity} we can check the costs or benefits of the
7662 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7663 are also performed by the code generator CLooG, like index splitting and
7664 dead code elimination in loops.
7666 @item -floop-nest-optimize
7667 @opindex floop-nest-optimize
7668 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7669 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7670 structure optimized for data-locality and parallelism.  This option
7671 is experimental.
7673 @item -floop-parallelize-all
7674 @opindex floop-parallelize-all
7675 Use the Graphite data dependence analysis to identify loops that can
7676 be parallelized.  Parallelize all the loops that can be analyzed to
7677 not contain loop carried dependences without checking that it is
7678 profitable to parallelize the loops.
7680 @item -fcheck-data-deps
7681 @opindex fcheck-data-deps
7682 Compare the results of several data dependence analyzers.  This option
7683 is used for debugging the data dependence analyzers.
7685 @item -ftree-loop-if-convert
7686 Attempt to transform conditional jumps in the innermost loops to
7687 branch-less equivalents.  The intent is to remove control-flow from
7688 the innermost loops in order to improve the ability of the
7689 vectorization pass to handle these loops.  This is enabled by default
7690 if vectorization is enabled.
7692 @item -ftree-loop-if-convert-stores
7693 Attempt to also if-convert conditional jumps containing memory writes.
7694 This transformation can be unsafe for multi-threaded programs as it
7695 transforms conditional memory writes into unconditional memory writes.
7696 For example,
7697 @smallexample
7698 for (i = 0; i < N; i++)
7699   if (cond)
7700     A[i] = expr;
7701 @end smallexample
7702 is transformed to
7703 @smallexample
7704 for (i = 0; i < N; i++)
7705   A[i] = cond ? expr : A[i];
7706 @end smallexample
7707 potentially producing data races.
7709 @item -ftree-loop-distribution
7710 Perform loop distribution.  This flag can improve cache performance on
7711 big loop bodies and allow further loop optimizations, like
7712 parallelization or vectorization, to take place.  For example, the loop
7713 @smallexample
7714 DO I = 1, N
7715   A(I) = B(I) + C
7716   D(I) = E(I) * F
7717 ENDDO
7718 @end smallexample
7719 is transformed to
7720 @smallexample
7721 DO I = 1, N
7722    A(I) = B(I) + C
7723 ENDDO
7724 DO I = 1, N
7725    D(I) = E(I) * F
7726 ENDDO
7727 @end smallexample
7729 @item -ftree-loop-distribute-patterns
7730 Perform loop distribution of patterns that can be code generated with
7731 calls to a library.  This flag is enabled by default at @option{-O3}.
7733 This pass distributes the initialization loops and generates a call to
7734 memset zero.  For example, the loop
7735 @smallexample
7736 DO I = 1, N
7737   A(I) = 0
7738   B(I) = A(I) + I
7739 ENDDO
7740 @end smallexample
7741 is transformed to
7742 @smallexample
7743 DO I = 1, N
7744    A(I) = 0
7745 ENDDO
7746 DO I = 1, N
7747    B(I) = A(I) + I
7748 ENDDO
7749 @end smallexample
7750 and the initialization loop is transformed into a call to memset zero.
7752 @item -ftree-loop-im
7753 @opindex ftree-loop-im
7754 Perform loop invariant motion on trees.  This pass moves only invariants that
7755 are hard to handle at RTL level (function calls, operations that expand to
7756 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7757 operands of conditions that are invariant out of the loop, so that we can use
7758 just trivial invariantness analysis in loop unswitching.  The pass also includes
7759 store motion.
7761 @item -ftree-loop-ivcanon
7762 @opindex ftree-loop-ivcanon
7763 Create a canonical counter for number of iterations in loops for which
7764 determining number of iterations requires complicated analysis.  Later
7765 optimizations then may determine the number easily.  Useful especially
7766 in connection with unrolling.
7768 @item -fivopts
7769 @opindex fivopts
7770 Perform induction variable optimizations (strength reduction, induction
7771 variable merging and induction variable elimination) on trees.
7773 @item -ftree-parallelize-loops=n
7774 @opindex ftree-parallelize-loops
7775 Parallelize loops, i.e., split their iteration space to run in n threads.
7776 This is only possible for loops whose iterations are independent
7777 and can be arbitrarily reordered.  The optimization is only
7778 profitable on multiprocessor machines, for loops that are CPU-intensive,
7779 rather than constrained e.g.@: by memory bandwidth.  This option
7780 implies @option{-pthread}, and thus is only supported on targets
7781 that have support for @option{-pthread}.
7783 @item -ftree-pta
7784 @opindex ftree-pta
7785 Perform function-local points-to analysis on trees.  This flag is
7786 enabled by default at @option{-O} and higher.
7788 @item -ftree-sra
7789 @opindex ftree-sra
7790 Perform scalar replacement of aggregates.  This pass replaces structure
7791 references with scalars to prevent committing structures to memory too
7792 early.  This flag is enabled by default at @option{-O} and higher.
7794 @item -ftree-copyrename
7795 @opindex ftree-copyrename
7796 Perform copy renaming on trees.  This pass attempts to rename compiler
7797 temporaries to other variables at copy locations, usually resulting in
7798 variable names which more closely resemble the original variables.  This flag
7799 is enabled by default at @option{-O} and higher.
7801 @item -ftree-coalesce-inlined-vars
7802 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7803 combine small user-defined variables too, but only if they were inlined
7804 from other functions.  It is a more limited form of
7805 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7806 inlined variables, but it will keep variables of the inlined-into
7807 function apart from each other, such that they are more likely to
7808 contain the expected values in a debugging session.  This was the
7809 default in GCC versions older than 4.7.
7811 @item -ftree-coalesce-vars
7812 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7813 combine small user-defined variables too, instead of just compiler
7814 temporaries.  This may severely limit the ability to debug an optimized
7815 program compiled with @option{-fno-var-tracking-assignments}.  In the
7816 negated form, this flag prevents SSA coalescing of user variables,
7817 including inlined ones.  This option is enabled by default.
7819 @item -ftree-ter
7820 @opindex ftree-ter
7821 Perform temporary expression replacement during the SSA->normal phase.  Single
7822 use/single def temporaries are replaced at their use location with their
7823 defining expression.  This results in non-GIMPLE code, but gives the expanders
7824 much more complex trees to work on resulting in better RTL generation.  This is
7825 enabled by default at @option{-O} and higher.
7827 @item -ftree-slsr
7828 @opindex ftree-slsr
7829 Perform straight-line strength reduction on trees.  This recognizes related
7830 expressions involving multiplications and replaces them by less expensive
7831 calculations when possible.  This is enabled by default at @option{-O} and
7832 higher.
7834 @item -ftree-vectorize
7835 @opindex ftree-vectorize
7836 Perform loop vectorization on trees. This flag is enabled by default at
7837 @option{-O3}.
7839 @item -ftree-slp-vectorize
7840 @opindex ftree-slp-vectorize
7841 Perform basic block vectorization on trees. This flag is enabled by default at
7842 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7844 @item -fvect-cost-model=@var{model}
7845 @opindex fvect-cost-model
7846 Alter the cost model used for vectorization.  The @var{model} argument
7847 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
7848 With the @code{unlimited} model the vectorized code-path is assumed
7849 to be profitable while with the @code{dynamic} model a runtime check
7850 will guard the vectorized code-path to enable it only for iteration
7851 counts that will likely execute faster than when executing the original
7852 scalar loop.  The @code{cheap} model will disable vectorization of
7853 loops where doing so would be cost prohibitive for example due to
7854 required runtime checks for data dependence or alignment but otherwise
7855 is equal to the @code{dynamic} model.
7856 The default cost model depends on other optimization flags and is
7857 either @code{dynamic} or @code{cheap}.
7859 @item -ftree-vrp
7860 @opindex ftree-vrp
7861 Perform Value Range Propagation on trees.  This is similar to the
7862 constant propagation pass, but instead of values, ranges of values are
7863 propagated.  This allows the optimizers to remove unnecessary range
7864 checks like array bound checks and null pointer checks.  This is
7865 enabled by default at @option{-O2} and higher.  Null pointer check
7866 elimination is only done if @option{-fdelete-null-pointer-checks} is
7867 enabled.
7869 @item -ftracer
7870 @opindex ftracer
7871 Perform tail duplication to enlarge superblock size.  This transformation
7872 simplifies the control flow of the function allowing other optimizations to do
7873 a better job.
7875 @item -funroll-loops
7876 @opindex funroll-loops
7877 Unroll loops whose number of iterations can be determined at compile
7878 time or upon entry to the loop.  @option{-funroll-loops} implies
7879 @option{-frerun-cse-after-loop}.  This option makes code larger,
7880 and may or may not make it run faster.
7882 @item -funroll-all-loops
7883 @opindex funroll-all-loops
7884 Unroll all loops, even if their number of iterations is uncertain when
7885 the loop is entered.  This usually makes programs run more slowly.
7886 @option{-funroll-all-loops} implies the same options as
7887 @option{-funroll-loops},
7889 @item -fsplit-ivs-in-unroller
7890 @opindex fsplit-ivs-in-unroller
7891 Enables expression of values of induction variables in later iterations
7892 of the unrolled loop using the value in the first iteration.  This breaks
7893 long dependency chains, thus improving efficiency of the scheduling passes.
7895 A combination of @option{-fweb} and CSE is often sufficient to obtain the
7896 same effect.  However, that is not reliable in cases where the loop body
7897 is more complicated than a single basic block.  It also does not work at all
7898 on some architectures due to restrictions in the CSE pass.
7900 This optimization is enabled by default.
7902 @item -fvariable-expansion-in-unroller
7903 @opindex fvariable-expansion-in-unroller
7904 With this option, the compiler creates multiple copies of some
7905 local variables when unrolling a loop, which can result in superior code.
7907 @item -fpartial-inlining
7908 @opindex fpartial-inlining
7909 Inline parts of functions.  This option has any effect only
7910 when inlining itself is turned on by the @option{-finline-functions}
7911 or @option{-finline-small-functions} options.
7913 Enabled at level @option{-O2}.
7915 @item -fpredictive-commoning
7916 @opindex fpredictive-commoning
7917 Perform predictive commoning optimization, i.e., reusing computations
7918 (especially memory loads and stores) performed in previous
7919 iterations of loops.
7921 This option is enabled at level @option{-O3}.
7923 @item -fprefetch-loop-arrays
7924 @opindex fprefetch-loop-arrays
7925 If supported by the target machine, generate instructions to prefetch
7926 memory to improve the performance of loops that access large arrays.
7928 This option may generate better or worse code; results are highly
7929 dependent on the structure of loops within the source code.
7931 Disabled at level @option{-Os}.
7933 @item -fno-peephole
7934 @itemx -fno-peephole2
7935 @opindex fno-peephole
7936 @opindex fno-peephole2
7937 Disable any machine-specific peephole optimizations.  The difference
7938 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7939 are implemented in the compiler; some targets use one, some use the
7940 other, a few use both.
7942 @option{-fpeephole} is enabled by default.
7943 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7945 @item -fno-guess-branch-probability
7946 @opindex fno-guess-branch-probability
7947 Do not guess branch probabilities using heuristics.
7949 GCC uses heuristics to guess branch probabilities if they are
7950 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7951 heuristics are based on the control flow graph.  If some branch probabilities
7952 are specified by @samp{__builtin_expect}, then the heuristics are
7953 used to guess branch probabilities for the rest of the control flow graph,
7954 taking the @samp{__builtin_expect} info into account.  The interactions
7955 between the heuristics and @samp{__builtin_expect} can be complex, and in
7956 some cases, it may be useful to disable the heuristics so that the effects
7957 of @samp{__builtin_expect} are easier to understand.
7959 The default is @option{-fguess-branch-probability} at levels
7960 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7962 @item -freorder-blocks
7963 @opindex freorder-blocks
7964 Reorder basic blocks in the compiled function in order to reduce number of
7965 taken branches and improve code locality.
7967 Enabled at levels @option{-O2}, @option{-O3}.
7969 @item -freorder-blocks-and-partition
7970 @opindex freorder-blocks-and-partition
7971 In addition to reordering basic blocks in the compiled function, in order
7972 to reduce number of taken branches, partitions hot and cold basic blocks
7973 into separate sections of the assembly and .o files, to improve
7974 paging and cache locality performance.
7976 This optimization is automatically turned off in the presence of
7977 exception handling, for linkonce sections, for functions with a user-defined
7978 section attribute and on any architecture that does not support named
7979 sections.
7981 @item -freorder-functions
7982 @opindex freorder-functions
7983 Reorder functions in the object file in order to
7984 improve code locality.  This is implemented by using special
7985 subsections @code{.text.hot} for most frequently executed functions and
7986 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7987 the linker so object file format must support named sections and linker must
7988 place them in a reasonable way.
7990 Also profile feedback must be available to make this option effective.  See
7991 @option{-fprofile-arcs} for details.
7993 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7995 @item -fstrict-aliasing
7996 @opindex fstrict-aliasing
7997 Allow the compiler to assume the strictest aliasing rules applicable to
7998 the language being compiled.  For C (and C++), this activates
7999 optimizations based on the type of expressions.  In particular, an
8000 object of one type is assumed never to reside at the same address as an
8001 object of a different type, unless the types are almost the same.  For
8002 example, an @code{unsigned int} can alias an @code{int}, but not a
8003 @code{void*} or a @code{double}.  A character type may alias any other
8004 type.
8006 @anchor{Type-punning}Pay special attention to code like this:
8007 @smallexample
8008 union a_union @{
8009   int i;
8010   double d;
8013 int f() @{
8014   union a_union t;
8015   t.d = 3.0;
8016   return t.i;
8018 @end smallexample
8019 The practice of reading from a different union member than the one most
8020 recently written to (called ``type-punning'') is common.  Even with
8021 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8022 is accessed through the union type.  So, the code above works as
8023 expected.  @xref{Structures unions enumerations and bit-fields
8024 implementation}.  However, this code might not:
8025 @smallexample
8026 int f() @{
8027   union a_union t;
8028   int* ip;
8029   t.d = 3.0;
8030   ip = &t.i;
8031   return *ip;
8033 @end smallexample
8035 Similarly, access by taking the address, casting the resulting pointer
8036 and dereferencing the result has undefined behavior, even if the cast
8037 uses a union type, e.g.:
8038 @smallexample
8039 int f() @{
8040   double d = 3.0;
8041   return ((union a_union *) &d)->i;
8043 @end smallexample
8045 The @option{-fstrict-aliasing} option is enabled at levels
8046 @option{-O2}, @option{-O3}, @option{-Os}.
8048 @item -fstrict-overflow
8049 @opindex fstrict-overflow
8050 Allow the compiler to assume strict signed overflow rules, depending
8051 on the language being compiled.  For C (and C++) this means that
8052 overflow when doing arithmetic with signed numbers is undefined, which
8053 means that the compiler may assume that it does not happen.  This
8054 permits various optimizations.  For example, the compiler assumes
8055 that an expression like @code{i + 10 > i} is always true for
8056 signed @code{i}.  This assumption is only valid if signed overflow is
8057 undefined, as the expression is false if @code{i + 10} overflows when
8058 using twos complement arithmetic.  When this option is in effect any
8059 attempt to determine whether an operation on signed numbers 
8060 overflows must be written carefully to not actually involve overflow.
8062 This option also allows the compiler to assume strict pointer
8063 semantics: given a pointer to an object, if adding an offset to that
8064 pointer does not produce a pointer to the same object, the addition is
8065 undefined.  This permits the compiler to conclude that @code{p + u >
8066 p} is always true for a pointer @code{p} and unsigned integer
8067 @code{u}.  This assumption is only valid because pointer wraparound is
8068 undefined, as the expression is false if @code{p + u} overflows using
8069 twos complement arithmetic.
8071 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8072 that integer signed overflow is fully defined: it wraps.  When
8073 @option{-fwrapv} is used, there is no difference between
8074 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8075 integers.  With @option{-fwrapv} certain types of overflow are
8076 permitted.  For example, if the compiler gets an overflow when doing
8077 arithmetic on constants, the overflowed value can still be used with
8078 @option{-fwrapv}, but not otherwise.
8080 The @option{-fstrict-overflow} option is enabled at levels
8081 @option{-O2}, @option{-O3}, @option{-Os}.
8083 @item -falign-functions
8084 @itemx -falign-functions=@var{n}
8085 @opindex falign-functions
8086 Align the start of functions to the next power-of-two greater than
8087 @var{n}, skipping up to @var{n} bytes.  For instance,
8088 @option{-falign-functions=32} aligns functions to the next 32-byte
8089 boundary, but @option{-falign-functions=24} aligns to the next
8090 32-byte boundary only if this can be done by skipping 23 bytes or less.
8092 @option{-fno-align-functions} and @option{-falign-functions=1} are
8093 equivalent and mean that functions are not aligned.
8095 Some assemblers only support this flag when @var{n} is a power of two;
8096 in that case, it is rounded up.
8098 If @var{n} is not specified or is zero, use a machine-dependent default.
8100 Enabled at levels @option{-O2}, @option{-O3}.
8102 @item -falign-labels
8103 @itemx -falign-labels=@var{n}
8104 @opindex falign-labels
8105 Align all branch targets to a power-of-two boundary, skipping up to
8106 @var{n} bytes like @option{-falign-functions}.  This option can easily
8107 make code slower, because it must insert dummy operations for when the
8108 branch target is reached in the usual flow of the code.
8110 @option{-fno-align-labels} and @option{-falign-labels=1} are
8111 equivalent and mean that labels are not aligned.
8113 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8114 are greater than this value, then their values are used instead.
8116 If @var{n} is not specified or is zero, use a machine-dependent default
8117 which is very likely to be @samp{1}, meaning no alignment.
8119 Enabled at levels @option{-O2}, @option{-O3}.
8121 @item -falign-loops
8122 @itemx -falign-loops=@var{n}
8123 @opindex falign-loops
8124 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8125 like @option{-falign-functions}.  If the loops are
8126 executed many times, this makes up for any execution of the dummy
8127 operations.
8129 @option{-fno-align-loops} and @option{-falign-loops=1} are
8130 equivalent and mean that loops are not aligned.
8132 If @var{n} is not specified or is zero, use a machine-dependent default.
8134 Enabled at levels @option{-O2}, @option{-O3}.
8136 @item -falign-jumps
8137 @itemx -falign-jumps=@var{n}
8138 @opindex falign-jumps
8139 Align branch targets to a power-of-two boundary, for branch targets
8140 where the targets can only be reached by jumping, skipping up to @var{n}
8141 bytes like @option{-falign-functions}.  In this case, no dummy operations
8142 need be executed.
8144 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8145 equivalent and mean that loops are not aligned.
8147 If @var{n} is not specified or is zero, use a machine-dependent default.
8149 Enabled at levels @option{-O2}, @option{-O3}.
8151 @item -funit-at-a-time
8152 @opindex funit-at-a-time
8153 This option is left for compatibility reasons. @option{-funit-at-a-time}
8154 has no effect, while @option{-fno-unit-at-a-time} implies
8155 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8157 Enabled by default.
8159 @item -fno-toplevel-reorder
8160 @opindex fno-toplevel-reorder
8161 Do not reorder top-level functions, variables, and @code{asm}
8162 statements.  Output them in the same order that they appear in the
8163 input file.  When this option is used, unreferenced static variables
8164 are not removed.  This option is intended to support existing code
8165 that relies on a particular ordering.  For new code, it is better to
8166 use attributes.
8168 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8169 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8170 targets.
8172 @item -fweb
8173 @opindex fweb
8174 Constructs webs as commonly used for register allocation purposes and assign
8175 each web individual pseudo register.  This allows the register allocation pass
8176 to operate on pseudos directly, but also strengthens several other optimization
8177 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8178 however, make debugging impossible, since variables no longer stay in a
8179 ``home register''.
8181 Enabled by default with @option{-funroll-loops}.
8183 @item -fwhole-program
8184 @opindex fwhole-program
8185 Assume that the current compilation unit represents the whole program being
8186 compiled.  All public functions and variables with the exception of @code{main}
8187 and those merged by attribute @code{externally_visible} become static functions
8188 and in effect are optimized more aggressively by interprocedural optimizers.
8190 This option should not be used in combination with @code{-flto}.
8191 Instead relying on a linker plugin should provide safer and more precise
8192 information.
8194 @item -flto[=@var{n}]
8195 @opindex flto
8196 This option runs the standard link-time optimizer.  When invoked
8197 with source code, it generates GIMPLE (one of GCC's internal
8198 representations) and writes it to special ELF sections in the object
8199 file.  When the object files are linked together, all the function
8200 bodies are read from these ELF sections and instantiated as if they
8201 had been part of the same translation unit.
8203 To use the link-time optimizer, @option{-flto} needs to be specified at
8204 compile time and during the final link.  For example:
8206 @smallexample
8207 gcc -c -O2 -flto foo.c
8208 gcc -c -O2 -flto bar.c
8209 gcc -o myprog -flto -O2 foo.o bar.o
8210 @end smallexample
8212 The first two invocations to GCC save a bytecode representation
8213 of GIMPLE into special ELF sections inside @file{foo.o} and
8214 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8215 @file{foo.o} and @file{bar.o}, merges the two files into a single
8216 internal image, and compiles the result as usual.  Since both
8217 @file{foo.o} and @file{bar.o} are merged into a single image, this
8218 causes all the interprocedural analyses and optimizations in GCC to
8219 work across the two files as if they were a single one.  This means,
8220 for example, that the inliner is able to inline functions in
8221 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8223 Another (simpler) way to enable link-time optimization is:
8225 @smallexample
8226 gcc -o myprog -flto -O2 foo.c bar.c
8227 @end smallexample
8229 The above generates bytecode for @file{foo.c} and @file{bar.c},
8230 merges them together into a single GIMPLE representation and optimizes
8231 them as usual to produce @file{myprog}.
8233 The only important thing to keep in mind is that to enable link-time
8234 optimizations the @option{-flto} flag needs to be passed to both the
8235 compile and the link commands.
8237 To make whole program optimization effective, it is necessary to make
8238 certain whole program assumptions.  The compiler needs to know
8239 what functions and variables can be accessed by libraries and runtime
8240 outside of the link-time optimized unit.  When supported by the linker,
8241 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8242 to the compiler about used and externally visible symbols.  When
8243 the linker plugin is not available, @option{-fwhole-program} should be
8244 used to allow the compiler to make these assumptions, which leads
8245 to more aggressive optimization decisions.
8247 Note that when a file is compiled with @option{-flto}, the generated
8248 object file is larger than a regular object file because it 
8249 contains GIMPLE bytecodes and the usual final code.  This means that
8250 object files with LTO information can be linked as normal object
8251 files; if @option{-flto} is not passed to the linker, no
8252 interprocedural optimizations are applied.
8254 Additionally, the optimization flags used to compile individual files
8255 are not necessarily related to those used at link time.  For instance,
8257 @smallexample
8258 gcc -c -O0 -flto foo.c
8259 gcc -c -O0 -flto bar.c
8260 gcc -o myprog -flto -O3 foo.o bar.o
8261 @end smallexample
8263 This produces individual object files with unoptimized assembler
8264 code, but the resulting binary @file{myprog} is optimized at
8265 @option{-O3}.  If, instead, the final binary is generated without
8266 @option{-flto}, then @file{myprog} is not optimized.
8268 When producing the final binary with @option{-flto}, GCC only
8269 applies link-time optimizations to those files that contain bytecode.
8270 Therefore, you can mix and match object files and libraries with
8271 GIMPLE bytecodes and final object code.  GCC automatically selects
8272 which files to optimize in LTO mode and which files to link without
8273 further processing.
8275 There are some code generation flags preserved by GCC when
8276 generating bytecodes, as they need to be used during the final link
8277 stage.  Currently, the following options are saved into the GIMPLE
8278 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
8279 @option{-m} target flags.
8281 At link time, these options are read in and reapplied.  Note that the
8282 current implementation makes no attempt to recognize conflicting
8283 values for these options.  If different files have conflicting option
8284 values (e.g., one file is compiled with @option{-fPIC} and another
8285 isn't), the compiler simply uses the last value read from the
8286 bytecode files.  It is recommended, then, that you compile all the files
8287 participating in the same link with the same options.
8289 If LTO encounters objects with C linkage declared with incompatible
8290 types in separate translation units to be linked together (undefined
8291 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8292 issued.  The behavior is still undefined at run time.
8294 Another feature of LTO is that it is possible to apply interprocedural
8295 optimizations on files written in different languages.  This requires
8296 support in the language front end.  Currently, the C, C++ and
8297 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8298 something like this should work:
8300 @smallexample
8301 gcc -c -flto foo.c
8302 g++ -c -flto bar.cc
8303 gfortran -c -flto baz.f90
8304 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8305 @end smallexample
8307 Notice that the final link is done with @command{g++} to get the C++
8308 runtime libraries and @option{-lgfortran} is added to get the Fortran
8309 runtime libraries.  In general, when mixing languages in LTO mode, you
8310 should use the same link command options as when mixing languages in a
8311 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8312 all the compile and link commands.
8314 If object files containing GIMPLE bytecode are stored in a library archive, say
8315 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8316 are using a linker with plugin support.  To enable this feature, use
8317 the flag @option{-fuse-linker-plugin} at link time:
8319 @smallexample
8320 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8321 @end smallexample
8323 With the linker plugin enabled, the linker extracts the needed
8324 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8325 to make them part of the aggregated GIMPLE image to be optimized.
8327 If you are not using a linker with plugin support and/or do not
8328 enable the linker plugin, then the objects inside @file{libfoo.a}
8329 are extracted and linked as usual, but they do not participate
8330 in the LTO optimization process.
8332 Link-time optimizations do not require the presence of the whole program to
8333 operate.  If the program does not require any symbols to be exported, it is
8334 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8335 the interprocedural optimizers to use more aggressive assumptions which may
8336 lead to improved optimization opportunities.
8337 Use of @option{-fwhole-program} is not needed when linker plugin is
8338 active (see @option{-fuse-linker-plugin}).
8340 The current implementation of LTO makes no
8341 attempt to generate bytecode that is portable between different
8342 types of hosts.  The bytecode files are versioned and there is a
8343 strict version check, so bytecode files generated in one version of
8344 GCC will not work with an older/newer version of GCC@.
8346 Link-time optimization does not work well with generation of debugging
8347 information.  Combining @option{-flto} with
8348 @option{-g} is currently experimental and expected to produce wrong
8349 results.
8351 If you specify the optional @var{n}, the optimization and code
8352 generation done at link time is executed in parallel using @var{n}
8353 parallel jobs by utilizing an installed @command{make} program.  The
8354 environment variable @env{MAKE} may be used to override the program
8355 used.  The default value for @var{n} is 1.
8357 You can also specify @option{-flto=jobserver} to use GNU make's
8358 job server mode to determine the number of parallel jobs. This
8359 is useful when the Makefile calling GCC is already executing in parallel.
8360 You must prepend a @samp{+} to the command recipe in the parent Makefile
8361 for this to work.  This option likely only works if @env{MAKE} is
8362 GNU make.
8364 This option is disabled by default.
8366 @item -flto-partition=@var{alg}
8367 @opindex flto-partition
8368 Specify the partitioning algorithm used by the link-time optimizer.
8369 The value is either @code{1to1} to specify a partitioning mirroring
8370 the original source files or @code{balanced} to specify partitioning
8371 into equally sized chunks (whenever possible) or @code{max} to create
8372 new partition for every symbol where possible.  Specifying @code{none}
8373 as an algorithm disables partitioning and streaming completely. 
8374 The default value is @code{balanced}. While @code{1to1} can be used
8375 as an workaround for various code ordering issues, the @code{max}
8376 partitioning is intended for internal testing only.
8378 @item -flto-compression-level=@var{n}
8379 This option specifies the level of compression used for intermediate
8380 language written to LTO object files, and is only meaningful in
8381 conjunction with LTO mode (@option{-flto}).  Valid
8382 values are 0 (no compression) to 9 (maximum compression).  Values
8383 outside this range are clamped to either 0 or 9.  If the option is not
8384 given, a default balanced compression setting is used.
8386 @item -flto-report
8387 Prints a report with internal details on the workings of the link-time
8388 optimizer.  The contents of this report vary from version to version.
8389 It is meant to be useful to GCC developers when processing object
8390 files in LTO mode (via @option{-flto}).
8392 Disabled by default.
8394 @item -fuse-linker-plugin
8395 Enables the use of a linker plugin during link-time optimization.  This
8396 option relies on plugin support in the linker, which is available in gold
8397 or in GNU ld 2.21 or newer.
8399 This option enables the extraction of object files with GIMPLE bytecode out
8400 of library archives. This improves the quality of optimization by exposing
8401 more code to the link-time optimizer.  This information specifies what
8402 symbols can be accessed externally (by non-LTO object or during dynamic
8403 linking).  Resulting code quality improvements on binaries (and shared
8404 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8405 See @option{-flto} for a description of the effect of this flag and how to
8406 use it.
8408 This option is enabled by default when LTO support in GCC is enabled
8409 and GCC was configured for use with
8410 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8412 @item -ffat-lto-objects
8413 @opindex ffat-lto-objects
8414 Fat LTO objects are object files that contain both the intermediate language
8415 and the object code. This makes them usable for both LTO linking and normal
8416 linking. This option is effective only when compiling with @option{-flto}
8417 and is ignored at link time.
8419 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8420 requires the complete toolchain to be aware of LTO. It requires a linker with
8421 linker plugin support for basic functionality.  Additionally,
8422 @command{nm}, @command{ar} and @command{ranlib}
8423 need to support linker plugins to allow a full-featured build environment
8424 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8425 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8426 to these tools. With non fat LTO makefiles need to be modified to use them.
8428 The default is @option{-ffat-lto-objects} but this default is intended to
8429 change in future releases when linker plugin enabled environments become more
8430 common.
8432 @item -fcompare-elim
8433 @opindex fcompare-elim
8434 After register allocation and post-register allocation instruction splitting,
8435 identify arithmetic instructions that compute processor flags similar to a
8436 comparison operation based on that arithmetic.  If possible, eliminate the
8437 explicit comparison operation.
8439 This pass only applies to certain targets that cannot explicitly represent
8440 the comparison operation before register allocation is complete.
8442 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8444 @item -fuse-ld=bfd
8445 Use the @command{bfd} linker instead of the default linker.
8447 @item -fuse-ld=gold
8448 Use the @command{gold} linker instead of the default linker.
8450 @item -fcprop-registers
8451 @opindex fcprop-registers
8452 After register allocation and post-register allocation instruction splitting,
8453 perform a copy-propagation pass to try to reduce scheduling dependencies
8454 and occasionally eliminate the copy.
8456 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8458 @item -fprofile-correction
8459 @opindex fprofile-correction
8460 Profiles collected using an instrumented binary for multi-threaded programs may
8461 be inconsistent due to missed counter updates. When this option is specified,
8462 GCC uses heuristics to correct or smooth out such inconsistencies. By
8463 default, GCC emits an error message when an inconsistent profile is detected.
8465 @item -fprofile-dir=@var{path}
8466 @opindex fprofile-dir
8468 Set the directory to search for the profile data files in to @var{path}.
8469 This option affects only the profile data generated by
8470 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8471 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8472 and its related options.  Both absolute and relative paths can be used.
8473 By default, GCC uses the current directory as @var{path}, thus the
8474 profile data file appears in the same directory as the object file.
8476 @item -fprofile-generate
8477 @itemx -fprofile-generate=@var{path}
8478 @opindex fprofile-generate
8480 Enable options usually used for instrumenting application to produce
8481 profile useful for later recompilation with profile feedback based
8482 optimization.  You must use @option{-fprofile-generate} both when
8483 compiling and when linking your program.
8485 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8487 If @var{path} is specified, GCC looks at the @var{path} to find
8488 the profile feedback data files. See @option{-fprofile-dir}.
8490 @item -fprofile-use
8491 @itemx -fprofile-use=@var{path}
8492 @opindex fprofile-use
8493 Enable profile feedback directed optimizations, and optimizations
8494 generally profitable only with profile feedback available.
8496 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8497 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8498 @code{ftree-loop-distribute-patterns}
8500 By default, GCC emits an error message if the feedback profiles do not
8501 match the source code.  This error can be turned into a warning by using
8502 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8503 code.
8505 If @var{path} is specified, GCC looks at the @var{path} to find
8506 the profile feedback data files. See @option{-fprofile-dir}.
8507 @end table
8509 The following options control compiler behavior regarding floating-point 
8510 arithmetic.  These options trade off between speed and
8511 correctness.  All must be specifically enabled.
8513 @table @gcctabopt
8514 @item -ffloat-store
8515 @opindex ffloat-store
8516 Do not store floating-point variables in registers, and inhibit other
8517 options that might change whether a floating-point value is taken from a
8518 register or memory.
8520 @cindex floating-point precision
8521 This option prevents undesirable excess precision on machines such as
8522 the 68000 where the floating registers (of the 68881) keep more
8523 precision than a @code{double} is supposed to have.  Similarly for the
8524 x86 architecture.  For most programs, the excess precision does only
8525 good, but a few programs rely on the precise definition of IEEE floating
8526 point.  Use @option{-ffloat-store} for such programs, after modifying
8527 them to store all pertinent intermediate computations into variables.
8529 @item -fexcess-precision=@var{style}
8530 @opindex fexcess-precision
8531 This option allows further control over excess precision on machines
8532 where floating-point registers have more precision than the IEEE
8533 @code{float} and @code{double} types and the processor does not
8534 support operations rounding to those types.  By default,
8535 @option{-fexcess-precision=fast} is in effect; this means that
8536 operations are carried out in the precision of the registers and that
8537 it is unpredictable when rounding to the types specified in the source
8538 code takes place.  When compiling C, if
8539 @option{-fexcess-precision=standard} is specified then excess
8540 precision follows the rules specified in ISO C99; in particular,
8541 both casts and assignments cause values to be rounded to their
8542 semantic types (whereas @option{-ffloat-store} only affects
8543 assignments).  This option is enabled by default for C if a strict
8544 conformance option such as @option{-std=c99} is used.
8546 @opindex mfpmath
8547 @option{-fexcess-precision=standard} is not implemented for languages
8548 other than C, and has no effect if
8549 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8550 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8551 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8552 semantics apply without excess precision, and in the latter, rounding
8553 is unpredictable.
8555 @item -ffast-math
8556 @opindex ffast-math
8557 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8558 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8559 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8561 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8563 This option is not turned on by any @option{-O} option besides
8564 @option{-Ofast} since it can result in incorrect output for programs
8565 that depend on an exact implementation of IEEE or ISO rules/specifications
8566 for math functions. It may, however, yield faster code for programs
8567 that do not require the guarantees of these specifications.
8569 @item -fno-math-errno
8570 @opindex fno-math-errno
8571 Do not set @code{errno} after calling math functions that are executed
8572 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8573 IEEE exceptions for math error handling may want to use this flag
8574 for speed while maintaining IEEE arithmetic compatibility.
8576 This option is not turned on by any @option{-O} option since
8577 it can result in incorrect output for programs that depend on
8578 an exact implementation of IEEE or ISO rules/specifications for
8579 math functions. It may, however, yield faster code for programs
8580 that do not require the guarantees of these specifications.
8582 The default is @option{-fmath-errno}.
8584 On Darwin systems, the math library never sets @code{errno}.  There is
8585 therefore no reason for the compiler to consider the possibility that
8586 it might, and @option{-fno-math-errno} is the default.
8588 @item -funsafe-math-optimizations
8589 @opindex funsafe-math-optimizations
8591 Allow optimizations for floating-point arithmetic that (a) assume
8592 that arguments and results are valid and (b) may violate IEEE or
8593 ANSI standards.  When used at link-time, it may include libraries
8594 or startup files that change the default FPU control word or other
8595 similar optimizations.
8597 This option is not turned on by any @option{-O} option since
8598 it can result in incorrect output for programs that depend on
8599 an exact implementation of IEEE or ISO rules/specifications for
8600 math functions. It may, however, yield faster code for programs
8601 that do not require the guarantees of these specifications.
8602 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8603 @option{-fassociative-math} and @option{-freciprocal-math}.
8605 The default is @option{-fno-unsafe-math-optimizations}.
8607 @item -fassociative-math
8608 @opindex fassociative-math
8610 Allow re-association of operands in series of floating-point operations.
8611 This violates the ISO C and C++ language standard by possibly changing
8612 computation result.  NOTE: re-ordering may change the sign of zero as
8613 well as ignore NaNs and inhibit or create underflow or overflow (and
8614 thus cannot be used on code that relies on rounding behavior like
8615 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8616 and thus may not be used when ordered comparisons are required.
8617 This option requires that both @option{-fno-signed-zeros} and
8618 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8619 much sense with @option{-frounding-math}. For Fortran the option
8620 is automatically enabled when both @option{-fno-signed-zeros} and
8621 @option{-fno-trapping-math} are in effect.
8623 The default is @option{-fno-associative-math}.
8625 @item -freciprocal-math
8626 @opindex freciprocal-math
8628 Allow the reciprocal of a value to be used instead of dividing by
8629 the value if this enables optimizations.  For example @code{x / y}
8630 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8631 is subject to common subexpression elimination.  Note that this loses
8632 precision and increases the number of flops operating on the value.
8634 The default is @option{-fno-reciprocal-math}.
8636 @item -ffinite-math-only
8637 @opindex ffinite-math-only
8638 Allow optimizations for floating-point arithmetic that assume
8639 that arguments and results are not NaNs or +-Infs.
8641 This option is not turned on by any @option{-O} option since
8642 it can result in incorrect output for programs that depend on
8643 an exact implementation of IEEE or ISO rules/specifications for
8644 math functions. It may, however, yield faster code for programs
8645 that do not require the guarantees of these specifications.
8647 The default is @option{-fno-finite-math-only}.
8649 @item -fno-signed-zeros
8650 @opindex fno-signed-zeros
8651 Allow optimizations for floating-point arithmetic that ignore the
8652 signedness of zero.  IEEE arithmetic specifies the behavior of
8653 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8654 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8655 This option implies that the sign of a zero result isn't significant.
8657 The default is @option{-fsigned-zeros}.
8659 @item -fno-trapping-math
8660 @opindex fno-trapping-math
8661 Compile code assuming that floating-point operations cannot generate
8662 user-visible traps.  These traps include division by zero, overflow,
8663 underflow, inexact result and invalid operation.  This option requires
8664 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8665 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8667 This option should never be turned on by any @option{-O} option since
8668 it can result in incorrect output for programs that depend on
8669 an exact implementation of IEEE or ISO rules/specifications for
8670 math functions.
8672 The default is @option{-ftrapping-math}.
8674 @item -frounding-math
8675 @opindex frounding-math
8676 Disable transformations and optimizations that assume default floating-point
8677 rounding behavior.  This is round-to-zero for all floating point
8678 to integer conversions, and round-to-nearest for all other arithmetic
8679 truncations.  This option should be specified for programs that change
8680 the FP rounding mode dynamically, or that may be executed with a
8681 non-default rounding mode.  This option disables constant folding of
8682 floating-point expressions at compile time (which may be affected by
8683 rounding mode) and arithmetic transformations that are unsafe in the
8684 presence of sign-dependent rounding modes.
8686 The default is @option{-fno-rounding-math}.
8688 This option is experimental and does not currently guarantee to
8689 disable all GCC optimizations that are affected by rounding mode.
8690 Future versions of GCC may provide finer control of this setting
8691 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8692 will be used to specify the default state for @code{FENV_ACCESS}.
8694 @item -fsignaling-nans
8695 @opindex fsignaling-nans
8696 Compile code assuming that IEEE signaling NaNs may generate user-visible
8697 traps during floating-point operations.  Setting this option disables
8698 optimizations that may change the number of exceptions visible with
8699 signaling NaNs.  This option implies @option{-ftrapping-math}.
8701 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8702 be defined.
8704 The default is @option{-fno-signaling-nans}.
8706 This option is experimental and does not currently guarantee to
8707 disable all GCC optimizations that affect signaling NaN behavior.
8709 @item -fsingle-precision-constant
8710 @opindex fsingle-precision-constant
8711 Treat floating-point constants as single precision instead of
8712 implicitly converting them to double-precision constants.
8714 @item -fcx-limited-range
8715 @opindex fcx-limited-range
8716 When enabled, this option states that a range reduction step is not
8717 needed when performing complex division.  Also, there is no checking
8718 whether the result of a complex multiplication or division is @code{NaN
8719 + I*NaN}, with an attempt to rescue the situation in that case.  The
8720 default is @option{-fno-cx-limited-range}, but is enabled by
8721 @option{-ffast-math}.
8723 This option controls the default setting of the ISO C99
8724 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8725 all languages.
8727 @item -fcx-fortran-rules
8728 @opindex fcx-fortran-rules
8729 Complex multiplication and division follow Fortran rules.  Range
8730 reduction is done as part of complex division, but there is no checking
8731 whether the result of a complex multiplication or division is @code{NaN
8732 + I*NaN}, with an attempt to rescue the situation in that case.
8734 The default is @option{-fno-cx-fortran-rules}.
8736 @end table
8738 The following options control optimizations that may improve
8739 performance, but are not enabled by any @option{-O} options.  This
8740 section includes experimental options that may produce broken code.
8742 @table @gcctabopt
8743 @item -fbranch-probabilities
8744 @opindex fbranch-probabilities
8745 After running a program compiled with @option{-fprofile-arcs}
8746 (@pxref{Debugging Options,, Options for Debugging Your Program or
8747 @command{gcc}}), you can compile it a second time using
8748 @option{-fbranch-probabilities}, to improve optimizations based on
8749 the number of times each branch was taken.  When a program
8750 compiled with @option{-fprofile-arcs} exits, it saves arc execution
8751 counts to a file called @file{@var{sourcename}.gcda} for each source
8752 file.  The information in this data file is very dependent on the
8753 structure of the generated code, so you must use the same source code
8754 and the same optimization options for both compilations.
8756 With @option{-fbranch-probabilities}, GCC puts a
8757 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8758 These can be used to improve optimization.  Currently, they are only
8759 used in one place: in @file{reorg.c}, instead of guessing which path a
8760 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8761 exactly determine which path is taken more often.
8763 @item -fprofile-values
8764 @opindex fprofile-values
8765 If combined with @option{-fprofile-arcs}, it adds code so that some
8766 data about values of expressions in the program is gathered.
8768 With @option{-fbranch-probabilities}, it reads back the data gathered
8769 from profiling values of expressions for usage in optimizations.
8771 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8773 @item -fvpt
8774 @opindex fvpt
8775 If combined with @option{-fprofile-arcs}, this option instructs the compiler
8776 to add code to gather information about values of expressions.
8778 With @option{-fbranch-probabilities}, it reads back the data gathered
8779 and actually performs the optimizations based on them.
8780 Currently the optimizations include specialization of division operations
8781 using the knowledge about the value of the denominator.
8783 @item -frename-registers
8784 @opindex frename-registers
8785 Attempt to avoid false dependencies in scheduled code by making use
8786 of registers left over after register allocation.  This optimization
8787 most benefits processors with lots of registers.  Depending on the
8788 debug information format adopted by the target, however, it can
8789 make debugging impossible, since variables no longer stay in
8790 a ``home register''.
8792 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8794 @item -ftracer
8795 @opindex ftracer
8796 Perform tail duplication to enlarge superblock size.  This transformation
8797 simplifies the control flow of the function allowing other optimizations to do
8798 a better job.
8800 Enabled with @option{-fprofile-use}.
8802 @item -funroll-loops
8803 @opindex funroll-loops
8804 Unroll loops whose number of iterations can be determined at compile time or
8805 upon entry to the loop.  @option{-funroll-loops} implies
8806 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8807 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8808 a small constant number of iterations).  This option makes code larger, and may
8809 or may not make it run faster.
8811 Enabled with @option{-fprofile-use}.
8813 @item -funroll-all-loops
8814 @opindex funroll-all-loops
8815 Unroll all loops, even if their number of iterations is uncertain when
8816 the loop is entered.  This usually makes programs run more slowly.
8817 @option{-funroll-all-loops} implies the same options as
8818 @option{-funroll-loops}.
8820 @item -fpeel-loops
8821 @opindex fpeel-loops
8822 Peels loops for which there is enough information that they do not
8823 roll much (from profile feedback).  It also turns on complete loop peeling
8824 (i.e.@: complete removal of loops with small constant number of iterations).
8826 Enabled with @option{-fprofile-use}.
8828 @item -fmove-loop-invariants
8829 @opindex fmove-loop-invariants
8830 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8831 at level @option{-O1}
8833 @item -funswitch-loops
8834 @opindex funswitch-loops
8835 Move branches with loop invariant conditions out of the loop, with duplicates
8836 of the loop on both branches (modified according to result of the condition).
8838 @item -ffunction-sections
8839 @itemx -fdata-sections
8840 @opindex ffunction-sections
8841 @opindex fdata-sections
8842 Place each function or data item into its own section in the output
8843 file if the target supports arbitrary sections.  The name of the
8844 function or the name of the data item determines the section's name
8845 in the output file.
8847 Use these options on systems where the linker can perform optimizations
8848 to improve locality of reference in the instruction space.  Most systems
8849 using the ELF object format and SPARC processors running Solaris 2 have
8850 linkers with such optimizations.  AIX may have these optimizations in
8851 the future.
8853 Only use these options when there are significant benefits from doing
8854 so.  When you specify these options, the assembler and linker
8855 create larger object and executable files and are also slower.
8856 You cannot use @code{gprof} on all systems if you
8857 specify this option, and you may have problems with debugging if
8858 you specify both this option and @option{-g}.
8860 @item -fbranch-target-load-optimize
8861 @opindex fbranch-target-load-optimize
8862 Perform branch target register load optimization before prologue / epilogue
8863 threading.
8864 The use of target registers can typically be exposed only during reload,
8865 thus hoisting loads out of loops and doing inter-block scheduling needs
8866 a separate optimization pass.
8868 @item -fbranch-target-load-optimize2
8869 @opindex fbranch-target-load-optimize2
8870 Perform branch target register load optimization after prologue / epilogue
8871 threading.
8873 @item -fbtr-bb-exclusive
8874 @opindex fbtr-bb-exclusive
8875 When performing branch target register load optimization, don't reuse
8876 branch target registers within any basic block.
8878 @item -fstack-protector
8879 @opindex fstack-protector
8880 Emit extra code to check for buffer overflows, such as stack smashing
8881 attacks.  This is done by adding a guard variable to functions with
8882 vulnerable objects.  This includes functions that call @code{alloca}, and
8883 functions with buffers larger than 8 bytes.  The guards are initialized
8884 when a function is entered and then checked when the function exits.
8885 If a guard check fails, an error message is printed and the program exits.
8887 @item -fstack-protector-all
8888 @opindex fstack-protector-all
8889 Like @option{-fstack-protector} except that all functions are protected.
8891 @item -fsection-anchors
8892 @opindex fsection-anchors
8893 Try to reduce the number of symbolic address calculations by using
8894 shared ``anchor'' symbols to address nearby objects.  This transformation
8895 can help to reduce the number of GOT entries and GOT accesses on some
8896 targets.
8898 For example, the implementation of the following function @code{foo}:
8900 @smallexample
8901 static int a, b, c;
8902 int foo (void) @{ return a + b + c; @}
8903 @end smallexample
8905 @noindent
8906 usually calculates the addresses of all three variables, but if you
8907 compile it with @option{-fsection-anchors}, it accesses the variables
8908 from a common anchor point instead.  The effect is similar to the
8909 following pseudocode (which isn't valid C):
8911 @smallexample
8912 int foo (void)
8914   register int *xr = &x;
8915   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8917 @end smallexample
8919 Not all targets support this option.
8921 @item --param @var{name}=@var{value}
8922 @opindex param
8923 In some places, GCC uses various constants to control the amount of
8924 optimization that is done.  For example, GCC does not inline functions
8925 that contain more than a certain number of instructions.  You can
8926 control some of these constants on the command line using the
8927 @option{--param} option.
8929 The names of specific parameters, and the meaning of the values, are
8930 tied to the internals of the compiler, and are subject to change
8931 without notice in future releases.
8933 In each case, the @var{value} is an integer.  The allowable choices for
8934 @var{name} are:
8936 @table @gcctabopt
8937 @item predictable-branch-outcome
8938 When branch is predicted to be taken with probability lower than this threshold
8939 (in percent), then it is considered well predictable. The default is 10.
8941 @item max-crossjump-edges
8942 The maximum number of incoming edges to consider for cross-jumping.
8943 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8944 the number of edges incoming to each block.  Increasing values mean
8945 more aggressive optimization, making the compilation time increase with
8946 probably small improvement in executable size.
8948 @item min-crossjump-insns
8949 The minimum number of instructions that must be matched at the end
8950 of two blocks before cross-jumping is performed on them.  This
8951 value is ignored in the case where all instructions in the block being
8952 cross-jumped from are matched.  The default value is 5.
8954 @item max-grow-copy-bb-insns
8955 The maximum code size expansion factor when copying basic blocks
8956 instead of jumping.  The expansion is relative to a jump instruction.
8957 The default value is 8.
8959 @item max-goto-duplication-insns
8960 The maximum number of instructions to duplicate to a block that jumps
8961 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8962 passes, GCC factors computed gotos early in the compilation process,
8963 and unfactors them as late as possible.  Only computed jumps at the
8964 end of a basic blocks with no more than max-goto-duplication-insns are
8965 unfactored.  The default value is 8.
8967 @item max-delay-slot-insn-search
8968 The maximum number of instructions to consider when looking for an
8969 instruction to fill a delay slot.  If more than this arbitrary number of
8970 instructions are searched, the time savings from filling the delay slot
8971 are minimal, so stop searching.  Increasing values mean more
8972 aggressive optimization, making the compilation time increase with probably
8973 small improvement in execution time.
8975 @item max-delay-slot-live-search
8976 When trying to fill delay slots, the maximum number of instructions to
8977 consider when searching for a block with valid live register
8978 information.  Increasing this arbitrarily chosen value means more
8979 aggressive optimization, increasing the compilation time.  This parameter
8980 should be removed when the delay slot code is rewritten to maintain the
8981 control-flow graph.
8983 @item max-gcse-memory
8984 The approximate maximum amount of memory that can be allocated in
8985 order to perform the global common subexpression elimination
8986 optimization.  If more memory than specified is required, the
8987 optimization is not done.
8989 @item max-gcse-insertion-ratio
8990 If the ratio of expression insertions to deletions is larger than this value
8991 for any expression, then RTL PRE inserts or removes the expression and thus
8992 leaves partially redundant computations in the instruction stream.  The default value is 20.
8994 @item max-pending-list-length
8995 The maximum number of pending dependencies scheduling allows
8996 before flushing the current state and starting over.  Large functions
8997 with few branches or calls can create excessively large lists which
8998 needlessly consume memory and resources.
9000 @item max-modulo-backtrack-attempts
9001 The maximum number of backtrack attempts the scheduler should make
9002 when modulo scheduling a loop.  Larger values can exponentially increase
9003 compilation time.
9005 @item max-inline-insns-single
9006 Several parameters control the tree inliner used in GCC@.
9007 This number sets the maximum number of instructions (counted in GCC's
9008 internal representation) in a single function that the tree inliner
9009 considers for inlining.  This only affects functions declared
9010 inline and methods implemented in a class declaration (C++).
9011 The default value is 400.
9013 @item max-inline-insns-auto
9014 When you use @option{-finline-functions} (included in @option{-O3}),
9015 a lot of functions that would otherwise not be considered for inlining
9016 by the compiler are investigated.  To those functions, a different
9017 (more restrictive) limit compared to functions declared inline can
9018 be applied.
9019 The default value is 40.
9021 @item inline-min-speedup
9022 When estimated performance improvement of caller + callee runtime exceeds this
9023 threshold (in precent), the function can be inlined regardless the limit on
9024 @option{--param max-inline-insns-single} and @option{--param
9025 max-inline-insns-auto}.
9027 @item large-function-insns
9028 The limit specifying really large functions.  For functions larger than this
9029 limit after inlining, inlining is constrained by
9030 @option{--param large-function-growth}.  This parameter is useful primarily
9031 to avoid extreme compilation time caused by non-linear algorithms used by the
9032 back end.
9033 The default value is 2700.
9035 @item large-function-growth
9036 Specifies maximal growth of large function caused by inlining in percents.
9037 The default value is 100 which limits large function growth to 2.0 times
9038 the original size.
9040 @item large-unit-insns
9041 The limit specifying large translation unit.  Growth caused by inlining of
9042 units larger than this limit is limited by @option{--param inline-unit-growth}.
9043 For small units this might be too tight.
9044 For example, consider a unit consisting of function A
9045 that is inline and B that just calls A three times.  If B is small relative to
9046 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9047 large units consisting of small inlineable functions, however, the overall unit
9048 growth limit is needed to avoid exponential explosion of code size.  Thus for
9049 smaller units, the size is increased to @option{--param large-unit-insns}
9050 before applying @option{--param inline-unit-growth}.  The default is 10000.
9052 @item inline-unit-growth
9053 Specifies maximal overall growth of the compilation unit caused by inlining.
9054 The default value is 30 which limits unit growth to 1.3 times the original
9055 size.
9057 @item ipcp-unit-growth
9058 Specifies maximal overall growth of the compilation unit caused by
9059 interprocedural constant propagation.  The default value is 10 which limits
9060 unit growth to 1.1 times the original size.
9062 @item large-stack-frame
9063 The limit specifying large stack frames.  While inlining the algorithm is trying
9064 to not grow past this limit too much.  The default value is 256 bytes.
9066 @item large-stack-frame-growth
9067 Specifies maximal growth of large stack frames caused by inlining in percents.
9068 The default value is 1000 which limits large stack frame growth to 11 times
9069 the original size.
9071 @item max-inline-insns-recursive
9072 @itemx max-inline-insns-recursive-auto
9073 Specifies the maximum number of instructions an out-of-line copy of a
9074 self-recursive inline
9075 function can grow into by performing recursive inlining.
9077 For functions declared inline, @option{--param max-inline-insns-recursive} is
9078 taken into account.  For functions not declared inline, recursive inlining
9079 happens only when @option{-finline-functions} (included in @option{-O3}) is
9080 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9081 default value is 450.
9083 @item max-inline-recursive-depth
9084 @itemx max-inline-recursive-depth-auto
9085 Specifies the maximum recursion depth used for recursive inlining.
9087 For functions declared inline, @option{--param max-inline-recursive-depth} is
9088 taken into account.  For functions not declared inline, recursive inlining
9089 happens only when @option{-finline-functions} (included in @option{-O3}) is
9090 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9091 default value is 8.
9093 @item min-inline-recursive-probability
9094 Recursive inlining is profitable only for function having deep recursion
9095 in average and can hurt for function having little recursion depth by
9096 increasing the prologue size or complexity of function body to other
9097 optimizers.
9099 When profile feedback is available (see @option{-fprofile-generate}) the actual
9100 recursion depth can be guessed from probability that function recurses via a
9101 given call expression.  This parameter limits inlining only to call expressions
9102 whose probability exceeds the given threshold (in percents).
9103 The default value is 10.
9105 @item early-inlining-insns
9106 Specify growth that the early inliner can make.  In effect it increases
9107 the amount of inlining for code having a large abstraction penalty.
9108 The default value is 10.
9110 @item max-early-inliner-iterations
9111 @itemx max-early-inliner-iterations
9112 Limit of iterations of the early inliner.  This basically bounds
9113 the number of nested indirect calls the early inliner can resolve.
9114 Deeper chains are still handled by late inlining.
9116 @item comdat-sharing-probability
9117 @itemx comdat-sharing-probability
9118 Probability (in percent) that C++ inline function with comdat visibility
9119 are shared across multiple compilation units.  The default value is 20.
9121 @item min-vect-loop-bound
9122 The minimum number of iterations under which loops are not vectorized
9123 when @option{-ftree-vectorize} is used.  The number of iterations after
9124 vectorization needs to be greater than the value specified by this option
9125 to allow vectorization.  The default value is 0.
9127 @item gcse-cost-distance-ratio
9128 Scaling factor in calculation of maximum distance an expression
9129 can be moved by GCSE optimizations.  This is currently supported only in the
9130 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9131 is with simple expressions, i.e., the expressions that have cost
9132 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9133 hoisting of simple expressions.  The default value is 10.
9135 @item gcse-unrestricted-cost
9136 Cost, roughly measured as the cost of a single typical machine
9137 instruction, at which GCSE optimizations do not constrain
9138 the distance an expression can travel.  This is currently
9139 supported only in the code hoisting pass.  The lesser the cost,
9140 the more aggressive code hoisting is.  Specifying 0 
9141 allows all expressions to travel unrestricted distances.
9142 The default value is 3.
9144 @item max-hoist-depth
9145 The depth of search in the dominator tree for expressions to hoist.
9146 This is used to avoid quadratic behavior in hoisting algorithm.
9147 The value of 0 does not limit on the search, but may slow down compilation
9148 of huge functions.  The default value is 30.
9150 @item max-tail-merge-comparisons
9151 The maximum amount of similar bbs to compare a bb with.  This is used to
9152 avoid quadratic behavior in tree tail merging.  The default value is 10.
9154 @item max-tail-merge-iterations
9155 The maximum amount of iterations of the pass over the function.  This is used to
9156 limit compilation time in tree tail merging.  The default value is 2.
9158 @item max-unrolled-insns
9159 The maximum number of instructions that a loop may have to be unrolled.
9160 If a loop is unrolled, this parameter also determines how many times
9161 the loop code is unrolled.
9163 @item max-average-unrolled-insns
9164 The maximum number of instructions biased by probabilities of their execution
9165 that a loop may have to be unrolled.  If a loop is unrolled,
9166 this parameter also determines how many times the loop code is unrolled.
9168 @item max-unroll-times
9169 The maximum number of unrollings of a single loop.
9171 @item max-peeled-insns
9172 The maximum number of instructions that a loop may have to be peeled.
9173 If a loop is peeled, this parameter also determines how many times
9174 the loop code is peeled.
9176 @item max-peel-times
9177 The maximum number of peelings of a single loop.
9179 @item max-peel-branches
9180 The maximum number of branches on the hot path through the peeled sequence.
9182 @item max-completely-peeled-insns
9183 The maximum number of insns of a completely peeled loop.
9185 @item max-completely-peel-times
9186 The maximum number of iterations of a loop to be suitable for complete peeling.
9188 @item max-completely-peel-loop-nest-depth
9189 The maximum depth of a loop nest suitable for complete peeling.
9191 @item max-unswitch-insns
9192 The maximum number of insns of an unswitched loop.
9194 @item max-unswitch-level
9195 The maximum number of branches unswitched in a single loop.
9197 @item lim-expensive
9198 The minimum cost of an expensive expression in the loop invariant motion.
9200 @item iv-consider-all-candidates-bound
9201 Bound on number of candidates for induction variables, below which
9202 all candidates are considered for each use in induction variable
9203 optimizations.  If there are more candidates than this,
9204 only the most relevant ones are considered to avoid quadratic time complexity.
9206 @item iv-max-considered-uses
9207 The induction variable optimizations give up on loops that contain more
9208 induction variable uses.
9210 @item iv-always-prune-cand-set-bound
9211 If the number of candidates in the set is smaller than this value,
9212 always try to remove unnecessary ivs from the set
9213 when adding a new one.
9215 @item scev-max-expr-size
9216 Bound on size of expressions used in the scalar evolutions analyzer.
9217 Large expressions slow the analyzer.
9219 @item scev-max-expr-complexity
9220 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9221 Complex expressions slow the analyzer.
9223 @item omega-max-vars
9224 The maximum number of variables in an Omega constraint system.
9225 The default value is 128.
9227 @item omega-max-geqs
9228 The maximum number of inequalities in an Omega constraint system.
9229 The default value is 256.
9231 @item omega-max-eqs
9232 The maximum number of equalities in an Omega constraint system.
9233 The default value is 128.
9235 @item omega-max-wild-cards
9236 The maximum number of wildcard variables that the Omega solver is
9237 able to insert.  The default value is 18.
9239 @item omega-hash-table-size
9240 The size of the hash table in the Omega solver.  The default value is
9241 550.
9243 @item omega-max-keys
9244 The maximal number of keys used by the Omega solver.  The default
9245 value is 500.
9247 @item omega-eliminate-redundant-constraints
9248 When set to 1, use expensive methods to eliminate all redundant
9249 constraints.  The default value is 0.
9251 @item vect-max-version-for-alignment-checks
9252 The maximum number of run-time checks that can be performed when
9253 doing loop versioning for alignment in the vectorizer. 
9255 @item vect-max-version-for-alias-checks
9256 The maximum number of run-time checks that can be performed when
9257 doing loop versioning for alias in the vectorizer. 
9259 @item vect-max-peeling-for-alignment
9260 The maximum number of loop peels to enhance access alignment
9261 for vectorizer. Value -1 means 'no limit'.
9263 @item max-iterations-to-track
9264 The maximum number of iterations of a loop the brute-force algorithm
9265 for analysis of the number of iterations of the loop tries to evaluate.
9267 @item hot-bb-count-ws-permille
9268 A basic block profile count is considered hot if it contributes to 
9269 the given permillage (i.e. 0...1000) of the entire profiled execution.
9271 @item hot-bb-frequency-fraction
9272 Select fraction of the entry block frequency of executions of basic block in
9273 function given basic block needs to have to be considered hot.
9275 @item max-predicted-iterations
9276 The maximum number of loop iterations we predict statically.  This is useful
9277 in cases where a function contains a single loop with known bound and
9278 another loop with unknown bound.
9279 The known number of iterations is predicted correctly, while
9280 the unknown number of iterations average to roughly 10.  This means that the
9281 loop without bounds appears artificially cold relative to the other one.
9283 @item align-threshold
9285 Select fraction of the maximal frequency of executions of a basic block in
9286 a function to align the basic block.
9288 @item align-loop-iterations
9290 A loop expected to iterate at least the selected number of iterations is
9291 aligned.
9293 @item tracer-dynamic-coverage
9294 @itemx tracer-dynamic-coverage-feedback
9296 This value is used to limit superblock formation once the given percentage of
9297 executed instructions is covered.  This limits unnecessary code size
9298 expansion.
9300 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9301 feedback is available.  The real profiles (as opposed to statically estimated
9302 ones) are much less balanced allowing the threshold to be larger value.
9304 @item tracer-max-code-growth
9305 Stop tail duplication once code growth has reached given percentage.  This is
9306 a rather artificial limit, as most of the duplicates are eliminated later in
9307 cross jumping, so it may be set to much higher values than is the desired code
9308 growth.
9310 @item tracer-min-branch-ratio
9312 Stop reverse growth when the reverse probability of best edge is less than this
9313 threshold (in percent).
9315 @item tracer-min-branch-ratio
9316 @itemx tracer-min-branch-ratio-feedback
9318 Stop forward growth if the best edge has probability lower than this
9319 threshold.
9321 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9322 compilation for profile feedback and one for compilation without.  The value
9323 for compilation with profile feedback needs to be more conservative (higher) in
9324 order to make tracer effective.
9326 @item max-cse-path-length
9328 The maximum number of basic blocks on path that CSE considers.
9329 The default is 10.
9331 @item max-cse-insns
9332 The maximum number of instructions CSE processes before flushing.
9333 The default is 1000.
9335 @item ggc-min-expand
9337 GCC uses a garbage collector to manage its own memory allocation.  This
9338 parameter specifies the minimum percentage by which the garbage
9339 collector's heap should be allowed to expand between collections.
9340 Tuning this may improve compilation speed; it has no effect on code
9341 generation.
9343 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9344 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9345 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9346 GCC is not able to calculate RAM on a particular platform, the lower
9347 bound of 30% is used.  Setting this parameter and
9348 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9349 every opportunity.  This is extremely slow, but can be useful for
9350 debugging.
9352 @item ggc-min-heapsize
9354 Minimum size of the garbage collector's heap before it begins bothering
9355 to collect garbage.  The first collection occurs after the heap expands
9356 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9357 tuning this may improve compilation speed, and has no effect on code
9358 generation.
9360 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9361 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9362 with a lower bound of 4096 (four megabytes) and an upper bound of
9363 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9364 particular platform, the lower bound is used.  Setting this parameter
9365 very large effectively disables garbage collection.  Setting this
9366 parameter and @option{ggc-min-expand} to zero causes a full collection
9367 to occur at every opportunity.
9369 @item max-reload-search-insns
9370 The maximum number of instruction reload should look backward for equivalent
9371 register.  Increasing values mean more aggressive optimization, making the
9372 compilation time increase with probably slightly better performance.
9373 The default value is 100.
9375 @item max-cselib-memory-locations
9376 The maximum number of memory locations cselib should take into account.
9377 Increasing values mean more aggressive optimization, making the compilation time
9378 increase with probably slightly better performance.  The default value is 500.
9380 @item reorder-blocks-duplicate
9381 @itemx reorder-blocks-duplicate-feedback
9383 Used by the basic block reordering pass to decide whether to use unconditional
9384 branch or duplicate the code on its destination.  Code is duplicated when its
9385 estimated size is smaller than this value multiplied by the estimated size of
9386 unconditional jump in the hot spots of the program.
9388 The @option{reorder-block-duplicate-feedback} is used only when profile
9389 feedback is available.  It may be set to higher values than
9390 @option{reorder-block-duplicate} since information about the hot spots is more
9391 accurate.
9393 @item max-sched-ready-insns
9394 The maximum number of instructions ready to be issued the scheduler should
9395 consider at any given time during the first scheduling pass.  Increasing
9396 values mean more thorough searches, making the compilation time increase
9397 with probably little benefit.  The default value is 100.
9399 @item max-sched-region-blocks
9400 The maximum number of blocks in a region to be considered for
9401 interblock scheduling.  The default value is 10.
9403 @item max-pipeline-region-blocks
9404 The maximum number of blocks in a region to be considered for
9405 pipelining in the selective scheduler.  The default value is 15.
9407 @item max-sched-region-insns
9408 The maximum number of insns in a region to be considered for
9409 interblock scheduling.  The default value is 100.
9411 @item max-pipeline-region-insns
9412 The maximum number of insns in a region to be considered for
9413 pipelining in the selective scheduler.  The default value is 200.
9415 @item min-spec-prob
9416 The minimum probability (in percents) of reaching a source block
9417 for interblock speculative scheduling.  The default value is 40.
9419 @item max-sched-extend-regions-iters
9420 The maximum number of iterations through CFG to extend regions.
9421 A value of 0 (the default) disables region extensions.
9423 @item max-sched-insn-conflict-delay
9424 The maximum conflict delay for an insn to be considered for speculative motion.
9425 The default value is 3.
9427 @item sched-spec-prob-cutoff
9428 The minimal probability of speculation success (in percents), so that
9429 speculative insns are scheduled.
9430 The default value is 40.
9432 @item sched-spec-state-edge-prob-cutoff
9433 The minimum probability an edge must have for the scheduler to save its
9434 state across it.
9435 The default value is 10.
9437 @item sched-mem-true-dep-cost
9438 Minimal distance (in CPU cycles) between store and load targeting same
9439 memory locations.  The default value is 1.
9441 @item selsched-max-lookahead
9442 The maximum size of the lookahead window of selective scheduling.  It is a
9443 depth of search for available instructions.
9444 The default value is 50.
9446 @item selsched-max-sched-times
9447 The maximum number of times that an instruction is scheduled during
9448 selective scheduling.  This is the limit on the number of iterations
9449 through which the instruction may be pipelined.  The default value is 2.
9451 @item selsched-max-insns-to-rename
9452 The maximum number of best instructions in the ready list that are considered
9453 for renaming in the selective scheduler.  The default value is 2.
9455 @item sms-min-sc
9456 The minimum value of stage count that swing modulo scheduler
9457 generates.  The default value is 2.
9459 @item max-last-value-rtl
9460 The maximum size measured as number of RTLs that can be recorded in an expression
9461 in combiner for a pseudo register as last known value of that register.  The default
9462 is 10000.
9464 @item integer-share-limit
9465 Small integer constants can use a shared data structure, reducing the
9466 compiler's memory usage and increasing its speed.  This sets the maximum
9467 value of a shared integer constant.  The default value is 256.
9469 @item ssp-buffer-size
9470 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9471 protection when @option{-fstack-protection} is used.
9473 @item max-jump-thread-duplication-stmts
9474 Maximum number of statements allowed in a block that needs to be
9475 duplicated when threading jumps.
9477 @item max-fields-for-field-sensitive
9478 Maximum number of fields in a structure treated in
9479 a field sensitive manner during pointer analysis.  The default is zero
9480 for @option{-O0} and @option{-O1},
9481 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9483 @item prefetch-latency
9484 Estimate on average number of instructions that are executed before
9485 prefetch finishes.  The distance prefetched ahead is proportional
9486 to this constant.  Increasing this number may also lead to less
9487 streams being prefetched (see @option{simultaneous-prefetches}).
9489 @item simultaneous-prefetches
9490 Maximum number of prefetches that can run at the same time.
9492 @item l1-cache-line-size
9493 The size of cache line in L1 cache, in bytes.
9495 @item l1-cache-size
9496 The size of L1 cache, in kilobytes.
9498 @item l2-cache-size
9499 The size of L2 cache, in kilobytes.
9501 @item min-insn-to-prefetch-ratio
9502 The minimum ratio between the number of instructions and the
9503 number of prefetches to enable prefetching in a loop.
9505 @item prefetch-min-insn-to-mem-ratio
9506 The minimum ratio between the number of instructions and the
9507 number of memory references to enable prefetching in a loop.
9509 @item use-canonical-types
9510 Whether the compiler should use the ``canonical'' type system.  By
9511 default, this should always be 1, which uses a more efficient internal
9512 mechanism for comparing types in C++ and Objective-C++.  However, if
9513 bugs in the canonical type system are causing compilation failures,
9514 set this value to 0 to disable canonical types.
9516 @item switch-conversion-max-branch-ratio
9517 Switch initialization conversion refuses to create arrays that are
9518 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9519 branches in the switch.
9521 @item max-partial-antic-length
9522 Maximum length of the partial antic set computed during the tree
9523 partial redundancy elimination optimization (@option{-ftree-pre}) when
9524 optimizing at @option{-O3} and above.  For some sorts of source code
9525 the enhanced partial redundancy elimination optimization can run away,
9526 consuming all of the memory available on the host machine.  This
9527 parameter sets a limit on the length of the sets that are computed,
9528 which prevents the runaway behavior.  Setting a value of 0 for
9529 this parameter allows an unlimited set length.
9531 @item sccvn-max-scc-size
9532 Maximum size of a strongly connected component (SCC) during SCCVN
9533 processing.  If this limit is hit, SCCVN processing for the whole
9534 function is not done and optimizations depending on it are
9535 disabled.  The default maximum SCC size is 10000.
9537 @item sccvn-max-alias-queries-per-access
9538 Maximum number of alias-oracle queries we perform when looking for
9539 redundancies for loads and stores.  If this limit is hit the search
9540 is aborted and the load or store is not considered redundant.  The
9541 number of queries is algorithmically limited to the number of
9542 stores on all paths from the load to the function entry.
9543 The default maxmimum number of queries is 1000.
9545 @item ira-max-loops-num
9546 IRA uses regional register allocation by default.  If a function
9547 contains more loops than the number given by this parameter, only at most
9548 the given number of the most frequently-executed loops form regions
9549 for regional register allocation.  The default value of the
9550 parameter is 100.
9552 @item ira-max-conflict-table-size 
9553 Although IRA uses a sophisticated algorithm to compress the conflict
9554 table, the table can still require excessive amounts of memory for
9555 huge functions.  If the conflict table for a function could be more
9556 than the size in MB given by this parameter, the register allocator
9557 instead uses a faster, simpler, and lower-quality
9558 algorithm that does not require building a pseudo-register conflict table.  
9559 The default value of the parameter is 2000.
9561 @item ira-loop-reserved-regs
9562 IRA can be used to evaluate more accurate register pressure in loops
9563 for decisions to move loop invariants (see @option{-O3}).  The number
9564 of available registers reserved for some other purposes is given
9565 by this parameter.  The default value of the parameter is 2, which is
9566 the minimal number of registers needed by typical instructions.
9567 This value is the best found from numerous experiments.
9569 @item loop-invariant-max-bbs-in-loop
9570 Loop invariant motion can be very expensive, both in compilation time and
9571 in amount of needed compile-time memory, with very large loops.  Loops
9572 with more basic blocks than this parameter won't have loop invariant
9573 motion optimization performed on them.  The default value of the
9574 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9576 @item loop-max-datarefs-for-datadeps
9577 Building data dapendencies is expensive for very large loops.  This
9578 parameter limits the number of data references in loops that are
9579 considered for data dependence analysis.  These large loops are no
9580 handled by the optimizations using loop data dependencies.
9581 The default value is 1000.
9583 @item max-vartrack-size
9584 Sets a maximum number of hash table slots to use during variable
9585 tracking dataflow analysis of any function.  If this limit is exceeded
9586 with variable tracking at assignments enabled, analysis for that
9587 function is retried without it, after removing all debug insns from
9588 the function.  If the limit is exceeded even without debug insns, var
9589 tracking analysis is completely disabled for the function.  Setting
9590 the parameter to zero makes it unlimited.
9592 @item max-vartrack-expr-depth
9593 Sets a maximum number of recursion levels when attempting to map
9594 variable names or debug temporaries to value expressions.  This trades
9595 compilation time for more complete debug information.  If this is set too
9596 low, value expressions that are available and could be represented in
9597 debug information may end up not being used; setting this higher may
9598 enable the compiler to find more complex debug expressions, but compile
9599 time and memory use may grow.  The default is 12.
9601 @item min-nondebug-insn-uid
9602 Use uids starting at this parameter for nondebug insns.  The range below
9603 the parameter is reserved exclusively for debug insns created by
9604 @option{-fvar-tracking-assignments}, but debug insns may get
9605 (non-overlapping) uids above it if the reserved range is exhausted.
9607 @item ipa-sra-ptr-growth-factor
9608 IPA-SRA replaces a pointer to an aggregate with one or more new
9609 parameters only when their cumulative size is less or equal to
9610 @option{ipa-sra-ptr-growth-factor} times the size of the original
9611 pointer parameter.
9613 @item tm-max-aggregate-size
9614 When making copies of thread-local variables in a transaction, this
9615 parameter specifies the size in bytes after which variables are
9616 saved with the logging functions as opposed to save/restore code
9617 sequence pairs.  This option only applies when using
9618 @option{-fgnu-tm}.
9620 @item graphite-max-nb-scop-params
9621 To avoid exponential effects in the Graphite loop transforms, the
9622 number of parameters in a Static Control Part (SCoP) is bounded.  The
9623 default value is 10 parameters.  A variable whose value is unknown at
9624 compilation time and defined outside a SCoP is a parameter of the SCoP.
9626 @item graphite-max-bbs-per-function
9627 To avoid exponential effects in the detection of SCoPs, the size of
9628 the functions analyzed by Graphite is bounded.  The default value is
9629 100 basic blocks.
9631 @item loop-block-tile-size
9632 Loop blocking or strip mining transforms, enabled with
9633 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9634 loop in the loop nest by a given number of iterations.  The strip
9635 length can be changed using the @option{loop-block-tile-size}
9636 parameter.  The default value is 51 iterations.
9638 @item ipa-cp-value-list-size
9639 IPA-CP attempts to track all possible values and types passed to a function's
9640 parameter in order to propagate them and perform devirtualization.
9641 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9642 stores per one formal parameter of a function.
9644 @item lto-partitions
9645 Specify desired number of partitions produced during WHOPR compilation.
9646 The number of partitions should exceed the number of CPUs used for compilation.
9647 The default value is 32.
9649 @item lto-minpartition
9650 Size of minimal partition for WHOPR (in estimated instructions).
9651 This prevents expenses of splitting very small programs into too many
9652 partitions.
9654 @item cxx-max-namespaces-for-diagnostic-help
9655 The maximum number of namespaces to consult for suggestions when C++
9656 name lookup fails for an identifier.  The default is 1000.
9658 @item sink-frequency-threshold
9659 The maximum relative execution frequency (in percents) of the target block
9660 relative to a statement's original block to allow statement sinking of a
9661 statement.  Larger numbers result in more aggressive statement sinking.
9662 The default value is 75.  A small positive adjustment is applied for
9663 statements with memory operands as those are even more profitable so sink.
9665 @item max-stores-to-sink
9666 The maximum number of conditional stores paires that can be sunk.  Set to 0
9667 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9668 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9670 @item allow-load-data-races
9671 Allow optimizers to introduce new data races on loads.
9672 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9673 unless implicitly set by the @option{-fmemory-model=} option.
9675 @item allow-store-data-races
9676 Allow optimizers to introduce new data races on stores.
9677 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9678 unless implicitly set by the @option{-fmemory-model=} option.
9680 @item allow-packed-load-data-races
9681 Allow optimizers to introduce new data races on packed data loads.
9682 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9683 unless implicitly set by the @option{-fmemory-model=} option.
9685 @item allow-packed-store-data-races
9686 Allow optimizers to introduce new data races on packed data stores.
9687 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9688 unless implicitly set by the @option{-fmemory-model=} option.
9690 @item case-values-threshold
9691 The smallest number of different values for which it is best to use a
9692 jump-table instead of a tree of conditional branches.  If the value is
9693 0, use the default for the machine.  The default is 0.
9695 @item tree-reassoc-width
9696 Set the maximum number of instructions executed in parallel in
9697 reassociated tree. This parameter overrides target dependent
9698 heuristics used by default if has non zero value.
9700 @item sched-pressure-algorithm
9701 Choose between the two available implementations of
9702 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9703 and is the more likely to prevent instructions from being reordered.
9704 Algorithm 2 was designed to be a compromise between the relatively
9705 conservative approach taken by algorithm 1 and the rather aggressive
9706 approach taken by the default scheduler.  It relies more heavily on
9707 having a regular register file and accurate register pressure classes.
9708 See @file{haifa-sched.c} in the GCC sources for more details.
9710 The default choice depends on the target.
9712 @item max-slsr-cand-scan
9713 Set the maximum number of existing candidates that will be considered when
9714 seeking a basis for a new straight-line strength reduction candidate.
9716 @end table
9717 @end table
9719 @node Preprocessor Options
9720 @section Options Controlling the Preprocessor
9721 @cindex preprocessor options
9722 @cindex options, preprocessor
9724 These options control the C preprocessor, which is run on each C source
9725 file before actual compilation.
9727 If you use the @option{-E} option, nothing is done except preprocessing.
9728 Some of these options make sense only together with @option{-E} because
9729 they cause the preprocessor output to be unsuitable for actual
9730 compilation.
9732 @table @gcctabopt
9733 @item -Wp,@var{option}
9734 @opindex Wp
9735 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9736 and pass @var{option} directly through to the preprocessor.  If
9737 @var{option} contains commas, it is split into multiple options at the
9738 commas.  However, many options are modified, translated or interpreted
9739 by the compiler driver before being passed to the preprocessor, and
9740 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9741 interface is undocumented and subject to change, so whenever possible
9742 you should avoid using @option{-Wp} and let the driver handle the
9743 options instead.
9745 @item -Xpreprocessor @var{option}
9746 @opindex Xpreprocessor
9747 Pass @var{option} as an option to the preprocessor.  You can use this to
9748 supply system-specific preprocessor options that GCC does not 
9749 recognize.
9751 If you want to pass an option that takes an argument, you must use
9752 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9754 @item -no-integrated-cpp
9755 @opindex no-integrated-cpp
9756 Perform preprocessing as a separate pass before compilation.
9757 By default, GCC performs preprocessing as an integrated part of
9758 input tokenization and parsing.
9759 If this option is provided, the appropriate language front end
9760 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9761 and Objective-C, respectively) is instead invoked twice,
9762 once for preprocessing only and once for actual compilation
9763 of the preprocessed input.
9764 This option may be useful in conjunction with the @option{-B} or
9765 @option{-wrapper} options to specify an alternate preprocessor or
9766 perform additional processing of the program source between
9767 normal preprocessing and compilation.
9768 @end table
9770 @include cppopts.texi
9772 @node Assembler Options
9773 @section Passing Options to the Assembler
9775 @c prevent bad page break with this line
9776 You can pass options to the assembler.
9778 @table @gcctabopt
9779 @item -Wa,@var{option}
9780 @opindex Wa
9781 Pass @var{option} as an option to the assembler.  If @var{option}
9782 contains commas, it is split into multiple options at the commas.
9784 @item -Xassembler @var{option}
9785 @opindex Xassembler
9786 Pass @var{option} as an option to the assembler.  You can use this to
9787 supply system-specific assembler options that GCC does not
9788 recognize.
9790 If you want to pass an option that takes an argument, you must use
9791 @option{-Xassembler} twice, once for the option and once for the argument.
9793 @end table
9795 @node Link Options
9796 @section Options for Linking
9797 @cindex link options
9798 @cindex options, linking
9800 These options come into play when the compiler links object files into
9801 an executable output file.  They are meaningless if the compiler is
9802 not doing a link step.
9804 @table @gcctabopt
9805 @cindex file names
9806 @item @var{object-file-name}
9807 A file name that does not end in a special recognized suffix is
9808 considered to name an object file or library.  (Object files are
9809 distinguished from libraries by the linker according to the file
9810 contents.)  If linking is done, these object files are used as input
9811 to the linker.
9813 @item -c
9814 @itemx -S
9815 @itemx -E
9816 @opindex c
9817 @opindex S
9818 @opindex E
9819 If any of these options is used, then the linker is not run, and
9820 object file names should not be used as arguments.  @xref{Overall
9821 Options}.
9823 @cindex Libraries
9824 @item -l@var{library}
9825 @itemx -l @var{library}
9826 @opindex l
9827 Search the library named @var{library} when linking.  (The second
9828 alternative with the library as a separate argument is only for
9829 POSIX compliance and is not recommended.)
9831 It makes a difference where in the command you write this option; the
9832 linker searches and processes libraries and object files in the order they
9833 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9834 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9835 to functions in @samp{z}, those functions may not be loaded.
9837 The linker searches a standard list of directories for the library,
9838 which is actually a file named @file{lib@var{library}.a}.  The linker
9839 then uses this file as if it had been specified precisely by name.
9841 The directories searched include several standard system directories
9842 plus any that you specify with @option{-L}.
9844 Normally the files found this way are library files---archive files
9845 whose members are object files.  The linker handles an archive file by
9846 scanning through it for members which define symbols that have so far
9847 been referenced but not defined.  But if the file that is found is an
9848 ordinary object file, it is linked in the usual fashion.  The only
9849 difference between using an @option{-l} option and specifying a file name
9850 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9851 and searches several directories.
9853 @item -lobjc
9854 @opindex lobjc
9855 You need this special case of the @option{-l} option in order to
9856 link an Objective-C or Objective-C++ program.
9858 @item -nostartfiles
9859 @opindex nostartfiles
9860 Do not use the standard system startup files when linking.
9861 The standard system libraries are used normally, unless @option{-nostdlib}
9862 or @option{-nodefaultlibs} is used.
9864 @item -nodefaultlibs
9865 @opindex nodefaultlibs
9866 Do not use the standard system libraries when linking.
9867 Only the libraries you specify are passed to the linker, and options
9868 specifying linkage of the system libraries, such as @code{-static-libgcc}
9869 or @code{-shared-libgcc}, are ignored.  
9870 The standard startup files are used normally, unless @option{-nostartfiles}
9871 is used.  
9873 The compiler may generate calls to @code{memcmp},
9874 @code{memset}, @code{memcpy} and @code{memmove}.
9875 These entries are usually resolved by entries in
9876 libc.  These entry points should be supplied through some other
9877 mechanism when this option is specified.
9879 @item -nostdlib
9880 @opindex nostdlib
9881 Do not use the standard system startup files or libraries when linking.
9882 No startup files and only the libraries you specify are passed to
9883 the linker, and options specifying linkage of the system libraries, such as
9884 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9886 The compiler may generate calls to @code{memcmp}, @code{memset},
9887 @code{memcpy} and @code{memmove}.
9888 These entries are usually resolved by entries in
9889 libc.  These entry points should be supplied through some other
9890 mechanism when this option is specified.
9892 @cindex @option{-lgcc}, use with @option{-nostdlib}
9893 @cindex @option{-nostdlib} and unresolved references
9894 @cindex unresolved references and @option{-nostdlib}
9895 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9896 @cindex @option{-nodefaultlibs} and unresolved references
9897 @cindex unresolved references and @option{-nodefaultlibs}
9898 One of the standard libraries bypassed by @option{-nostdlib} and
9899 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9900 which GCC uses to overcome shortcomings of particular machines, or special
9901 needs for some languages.
9902 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9903 Collection (GCC) Internals},
9904 for more discussion of @file{libgcc.a}.)
9905 In most cases, you need @file{libgcc.a} even when you want to avoid
9906 other standard libraries.  In other words, when you specify @option{-nostdlib}
9907 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9908 This ensures that you have no unresolved references to internal GCC
9909 library subroutines.
9910 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9911 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9912 GNU Compiler Collection (GCC) Internals}.)
9914 @item -pie
9915 @opindex pie
9916 Produce a position independent executable on targets that support it.
9917 For predictable results, you must also specify the same set of options
9918 used for compilation (@option{-fpie}, @option{-fPIE},
9919 or model suboptions) when you specify this linker option.
9921 @item -rdynamic
9922 @opindex rdynamic
9923 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9924 that support it. This instructs the linker to add all symbols, not
9925 only used ones, to the dynamic symbol table. This option is needed
9926 for some uses of @code{dlopen} or to allow obtaining backtraces
9927 from within a program.
9929 @item -s
9930 @opindex s
9931 Remove all symbol table and relocation information from the executable.
9933 @item -static
9934 @opindex static
9935 On systems that support dynamic linking, this prevents linking with the shared
9936 libraries.  On other systems, this option has no effect.
9938 @item -shared
9939 @opindex shared
9940 Produce a shared object which can then be linked with other objects to
9941 form an executable.  Not all systems support this option.  For predictable
9942 results, you must also specify the same set of options used for compilation
9943 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9944 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9945 needs to build supplementary stub code for constructors to work.  On
9946 multi-libbed systems, @samp{gcc -shared} must select the correct support
9947 libraries to link against.  Failing to supply the correct flags may lead
9948 to subtle defects.  Supplying them in cases where they are not necessary
9949 is innocuous.}
9951 @item -shared-libgcc
9952 @itemx -static-libgcc
9953 @opindex shared-libgcc
9954 @opindex static-libgcc
9955 On systems that provide @file{libgcc} as a shared library, these options
9956 force the use of either the shared or static version, respectively.
9957 If no shared version of @file{libgcc} was built when the compiler was
9958 configured, these options have no effect.
9960 There are several situations in which an application should use the
9961 shared @file{libgcc} instead of the static version.  The most common
9962 of these is when the application wishes to throw and catch exceptions
9963 across different shared libraries.  In that case, each of the libraries
9964 as well as the application itself should use the shared @file{libgcc}.
9966 Therefore, the G++ and GCJ drivers automatically add
9967 @option{-shared-libgcc} whenever you build a shared library or a main
9968 executable, because C++ and Java programs typically use exceptions, so
9969 this is the right thing to do.
9971 If, instead, you use the GCC driver to create shared libraries, you may
9972 find that they are not always linked with the shared @file{libgcc}.
9973 If GCC finds, at its configuration time, that you have a non-GNU linker
9974 or a GNU linker that does not support option @option{--eh-frame-hdr},
9975 it links the shared version of @file{libgcc} into shared libraries
9976 by default.  Otherwise, it takes advantage of the linker and optimizes
9977 away the linking with the shared version of @file{libgcc}, linking with
9978 the static version of libgcc by default.  This allows exceptions to
9979 propagate through such shared libraries, without incurring relocation
9980 costs at library load time.
9982 However, if a library or main executable is supposed to throw or catch
9983 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9984 for the languages used in the program, or using the option
9985 @option{-shared-libgcc}, such that it is linked with the shared
9986 @file{libgcc}.
9988 @item -static-libasan
9989 When the @option{-fsanitize=address} option is used to link a program,
9990 the GCC driver automatically links against @option{libasan}.  If
9991 @file{libasan} is available as a shared library, and the @option{-static}
9992 option is not used, then this links against the shared version of
9993 @file{libasan}.  The @option{-static-libasan} option directs the GCC
9994 driver to link @file{libasan} statically, without necessarily linking
9995 other libraries statically.
9997 @item -static-libtsan
9998 When the @option{-fsanitize=thread} option is used to link a program,
9999 the GCC driver automatically links against @option{libtsan}.  If
10000 @file{libtsan} is available as a shared library, and the @option{-static}
10001 option is not used, then this links against the shared version of
10002 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10003 driver to link @file{libtsan} statically, without necessarily linking
10004 other libraries statically.
10006 @item -static-libstdc++
10007 When the @command{g++} program is used to link a C++ program, it
10008 normally automatically links against @option{libstdc++}.  If
10009 @file{libstdc++} is available as a shared library, and the
10010 @option{-static} option is not used, then this links against the
10011 shared version of @file{libstdc++}.  That is normally fine.  However, it
10012 is sometimes useful to freeze the version of @file{libstdc++} used by
10013 the program without going all the way to a fully static link.  The
10014 @option{-static-libstdc++} option directs the @command{g++} driver to
10015 link @file{libstdc++} statically, without necessarily linking other
10016 libraries statically.
10018 @item -symbolic
10019 @opindex symbolic
10020 Bind references to global symbols when building a shared object.  Warn
10021 about any unresolved references (unless overridden by the link editor
10022 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10023 this option.
10025 @item -T @var{script}
10026 @opindex T
10027 @cindex linker script
10028 Use @var{script} as the linker script.  This option is supported by most
10029 systems using the GNU linker.  On some targets, such as bare-board
10030 targets without an operating system, the @option{-T} option may be required
10031 when linking to avoid references to undefined symbols.
10033 @item -Xlinker @var{option}
10034 @opindex Xlinker
10035 Pass @var{option} as an option to the linker.  You can use this to
10036 supply system-specific linker options that GCC does not recognize.
10038 If you want to pass an option that takes a separate argument, you must use
10039 @option{-Xlinker} twice, once for the option and once for the argument.
10040 For example, to pass @option{-assert definitions}, you must write
10041 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10042 @option{-Xlinker "-assert definitions"}, because this passes the entire
10043 string as a single argument, which is not what the linker expects.
10045 When using the GNU linker, it is usually more convenient to pass
10046 arguments to linker options using the @option{@var{option}=@var{value}}
10047 syntax than as separate arguments.  For example, you can specify
10048 @option{-Xlinker -Map=output.map} rather than
10049 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10050 this syntax for command-line options.
10052 @item -Wl,@var{option}
10053 @opindex Wl
10054 Pass @var{option} as an option to the linker.  If @var{option} contains
10055 commas, it is split into multiple options at the commas.  You can use this
10056 syntax to pass an argument to the option.
10057 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10058 linker.  When using the GNU linker, you can also get the same effect with
10059 @option{-Wl,-Map=output.map}.
10061 @item -u @var{symbol}
10062 @opindex u
10063 Pretend the symbol @var{symbol} is undefined, to force linking of
10064 library modules to define it.  You can use @option{-u} multiple times with
10065 different symbols to force loading of additional library modules.
10066 @end table
10068 @node Directory Options
10069 @section Options for Directory Search
10070 @cindex directory options
10071 @cindex options, directory search
10072 @cindex search path
10074 These options specify directories to search for header files, for
10075 libraries and for parts of the compiler:
10077 @table @gcctabopt
10078 @item -I@var{dir}
10079 @opindex I
10080 Add the directory @var{dir} to the head of the list of directories to be
10081 searched for header files.  This can be used to override a system header
10082 file, substituting your own version, since these directories are
10083 searched before the system header file directories.  However, you should
10084 not use this option to add directories that contain vendor-supplied
10085 system header files (use @option{-isystem} for that).  If you use more than
10086 one @option{-I} option, the directories are scanned in left-to-right
10087 order; the standard system directories come after.
10089 If a standard system include directory, or a directory specified with
10090 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10091 option is ignored.  The directory is still searched but as a
10092 system directory at its normal position in the system include chain.
10093 This is to ensure that GCC's procedure to fix buggy system headers and
10094 the ordering for the @code{include_next} directive are not inadvertently changed.
10095 If you really need to change the search order for system directories,
10096 use the @option{-nostdinc} and/or @option{-isystem} options.
10098 @item -iplugindir=@var{dir}
10099 Set the directory to search for plugins that are passed
10100 by @option{-fplugin=@var{name}} instead of
10101 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10102 to be used by the user, but only passed by the driver.
10104 @item -iquote@var{dir}
10105 @opindex iquote
10106 Add the directory @var{dir} to the head of the list of directories to
10107 be searched for header files only for the case of @samp{#include
10108 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10109 otherwise just like @option{-I}.
10111 @item -L@var{dir}
10112 @opindex L
10113 Add directory @var{dir} to the list of directories to be searched
10114 for @option{-l}.
10116 @item -B@var{prefix}
10117 @opindex B
10118 This option specifies where to find the executables, libraries,
10119 include files, and data files of the compiler itself.
10121 The compiler driver program runs one or more of the subprograms
10122 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10123 @var{prefix} as a prefix for each program it tries to run, both with and
10124 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10126 For each subprogram to be run, the compiler driver first tries the
10127 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10128 is not specified, the driver tries two standard prefixes, 
10129 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10130 those results in a file name that is found, the unmodified program
10131 name is searched for using the directories specified in your
10132 @env{PATH} environment variable.
10134 The compiler checks to see if the path provided by the @option{-B}
10135 refers to a directory, and if necessary it adds a directory
10136 separator character at the end of the path.
10138 @option{-B} prefixes that effectively specify directory names also apply
10139 to libraries in the linker, because the compiler translates these
10140 options into @option{-L} options for the linker.  They also apply to
10141 includes files in the preprocessor, because the compiler translates these
10142 options into @option{-isystem} options for the preprocessor.  In this case,
10143 the compiler appends @samp{include} to the prefix.
10145 The runtime support file @file{libgcc.a} can also be searched for using
10146 the @option{-B} prefix, if needed.  If it is not found there, the two
10147 standard prefixes above are tried, and that is all.  The file is left
10148 out of the link if it is not found by those means.
10150 Another way to specify a prefix much like the @option{-B} prefix is to use
10151 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10152 Variables}.
10154 As a special kludge, if the path provided by @option{-B} is
10155 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10156 9, then it is replaced by @file{[dir/]include}.  This is to help
10157 with boot-strapping the compiler.
10159 @item -specs=@var{file}
10160 @opindex specs
10161 Process @var{file} after the compiler reads in the standard @file{specs}
10162 file, in order to override the defaults which the @command{gcc} driver
10163 program uses when determining what switches to pass to @command{cc1},
10164 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10165 @option{-specs=@var{file}} can be specified on the command line, and they
10166 are processed in order, from left to right.
10168 @item --sysroot=@var{dir}
10169 @opindex sysroot
10170 Use @var{dir} as the logical root directory for headers and libraries.
10171 For example, if the compiler normally searches for headers in
10172 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10173 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10175 If you use both this option and the @option{-isysroot} option, then
10176 the @option{--sysroot} option applies to libraries, but the
10177 @option{-isysroot} option applies to header files.
10179 The GNU linker (beginning with version 2.16) has the necessary support
10180 for this option.  If your linker does not support this option, the
10181 header file aspect of @option{--sysroot} still works, but the
10182 library aspect does not.
10184 @item --no-sysroot-suffix
10185 @opindex no-sysroot-suffix
10186 For some targets, a suffix is added to the root directory specified
10187 with @option{--sysroot}, depending on the other options used, so that
10188 headers may for example be found in
10189 @file{@var{dir}/@var{suffix}/usr/include} instead of
10190 @file{@var{dir}/usr/include}.  This option disables the addition of
10191 such a suffix.
10193 @item -I-
10194 @opindex I-
10195 This option has been deprecated.  Please use @option{-iquote} instead for
10196 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10197 Any directories you specify with @option{-I} options before the @option{-I-}
10198 option are searched only for the case of @samp{#include "@var{file}"};
10199 they are not searched for @samp{#include <@var{file}>}.
10201 If additional directories are specified with @option{-I} options after
10202 the @option{-I-}, these directories are searched for all @samp{#include}
10203 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10204 this way.)
10206 In addition, the @option{-I-} option inhibits the use of the current
10207 directory (where the current input file came from) as the first search
10208 directory for @samp{#include "@var{file}"}.  There is no way to
10209 override this effect of @option{-I-}.  With @option{-I.} you can specify
10210 searching the directory that is current when the compiler is
10211 invoked.  That is not exactly the same as what the preprocessor does
10212 by default, but it is often satisfactory.
10214 @option{-I-} does not inhibit the use of the standard system directories
10215 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10216 independent.
10217 @end table
10219 @c man end
10221 @node Spec Files
10222 @section Specifying subprocesses and the switches to pass to them
10223 @cindex Spec Files
10225 @command{gcc} is a driver program.  It performs its job by invoking a
10226 sequence of other programs to do the work of compiling, assembling and
10227 linking.  GCC interprets its command-line parameters and uses these to
10228 deduce which programs it should invoke, and which command-line options
10229 it ought to place on their command lines.  This behavior is controlled
10230 by @dfn{spec strings}.  In most cases there is one spec string for each
10231 program that GCC can invoke, but a few programs have multiple spec
10232 strings to control their behavior.  The spec strings built into GCC can
10233 be overridden by using the @option{-specs=} command-line switch to specify
10234 a spec file.
10236 @dfn{Spec files} are plaintext files that are used to construct spec
10237 strings.  They consist of a sequence of directives separated by blank
10238 lines.  The type of directive is determined by the first non-whitespace
10239 character on the line, which can be one of the following:
10241 @table @code
10242 @item %@var{command}
10243 Issues a @var{command} to the spec file processor.  The commands that can
10244 appear here are:
10246 @table @code
10247 @item %include <@var{file}>
10248 @cindex @code{%include}
10249 Search for @var{file} and insert its text at the current point in the
10250 specs file.
10252 @item %include_noerr <@var{file}>
10253 @cindex @code{%include_noerr}
10254 Just like @samp{%include}, but do not generate an error message if the include
10255 file cannot be found.
10257 @item %rename @var{old_name} @var{new_name}
10258 @cindex @code{%rename}
10259 Rename the spec string @var{old_name} to @var{new_name}.
10261 @end table
10263 @item *[@var{spec_name}]:
10264 This tells the compiler to create, override or delete the named spec
10265 string.  All lines after this directive up to the next directive or
10266 blank line are considered to be the text for the spec string.  If this
10267 results in an empty string then the spec is deleted.  (Or, if the
10268 spec did not exist, then nothing happens.)  Otherwise, if the spec
10269 does not currently exist a new spec is created.  If the spec does
10270 exist then its contents are overridden by the text of this
10271 directive, unless the first character of that text is the @samp{+}
10272 character, in which case the text is appended to the spec.
10274 @item [@var{suffix}]:
10275 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10276 and up to the next directive or blank line are considered to make up the
10277 spec string for the indicated suffix.  When the compiler encounters an
10278 input file with the named suffix, it processes the spec string in
10279 order to work out how to compile that file.  For example:
10281 @smallexample
10282 .ZZ:
10283 z-compile -input %i
10284 @end smallexample
10286 This says that any input file whose name ends in @samp{.ZZ} should be
10287 passed to the program @samp{z-compile}, which should be invoked with the
10288 command-line switch @option{-input} and with the result of performing the
10289 @samp{%i} substitution.  (See below.)
10291 As an alternative to providing a spec string, the text following a
10292 suffix directive can be one of the following:
10294 @table @code
10295 @item @@@var{language}
10296 This says that the suffix is an alias for a known @var{language}.  This is
10297 similar to using the @option{-x} command-line switch to GCC to specify a
10298 language explicitly.  For example:
10300 @smallexample
10301 .ZZ:
10302 @@c++
10303 @end smallexample
10305 Says that .ZZ files are, in fact, C++ source files.
10307 @item #@var{name}
10308 This causes an error messages saying:
10310 @smallexample
10311 @var{name} compiler not installed on this system.
10312 @end smallexample
10313 @end table
10315 GCC already has an extensive list of suffixes built into it.
10316 This directive adds an entry to the end of the list of suffixes, but
10317 since the list is searched from the end backwards, it is effectively
10318 possible to override earlier entries using this technique.
10320 @end table
10322 GCC has the following spec strings built into it.  Spec files can
10323 override these strings or create their own.  Note that individual
10324 targets can also add their own spec strings to this list.
10326 @smallexample
10327 asm          Options to pass to the assembler
10328 asm_final    Options to pass to the assembler post-processor
10329 cpp          Options to pass to the C preprocessor
10330 cc1          Options to pass to the C compiler
10331 cc1plus      Options to pass to the C++ compiler
10332 endfile      Object files to include at the end of the link
10333 link         Options to pass to the linker
10334 lib          Libraries to include on the command line to the linker
10335 libgcc       Decides which GCC support library to pass to the linker
10336 linker       Sets the name of the linker
10337 predefines   Defines to be passed to the C preprocessor
10338 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10339              by default
10340 startfile    Object files to include at the start of the link
10341 @end smallexample
10343 Here is a small example of a spec file:
10345 @smallexample
10346 %rename lib                 old_lib
10348 *lib:
10349 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10350 @end smallexample
10352 This example renames the spec called @samp{lib} to @samp{old_lib} and
10353 then overrides the previous definition of @samp{lib} with a new one.
10354 The new definition adds in some extra command-line options before
10355 including the text of the old definition.
10357 @dfn{Spec strings} are a list of command-line options to be passed to their
10358 corresponding program.  In addition, the spec strings can contain
10359 @samp{%}-prefixed sequences to substitute variable text or to
10360 conditionally insert text into the command line.  Using these constructs
10361 it is possible to generate quite complex command lines.
10363 Here is a table of all defined @samp{%}-sequences for spec
10364 strings.  Note that spaces are not generated automatically around the
10365 results of expanding these sequences.  Therefore you can concatenate them
10366 together or combine them with constant text in a single argument.
10368 @table @code
10369 @item %%
10370 Substitute one @samp{%} into the program name or argument.
10372 @item %i
10373 Substitute the name of the input file being processed.
10375 @item %b
10376 Substitute the basename of the input file being processed.
10377 This is the substring up to (and not including) the last period
10378 and not including the directory.
10380 @item %B
10381 This is the same as @samp{%b}, but include the file suffix (text after
10382 the last period).
10384 @item %d
10385 Marks the argument containing or following the @samp{%d} as a
10386 temporary file name, so that that file is deleted if GCC exits
10387 successfully.  Unlike @samp{%g}, this contributes no text to the
10388 argument.
10390 @item %g@var{suffix}
10391 Substitute a file name that has suffix @var{suffix} and is chosen
10392 once per compilation, and mark the argument in the same way as
10393 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10394 name is now chosen in a way that is hard to predict even when previously
10395 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10396 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10397 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10398 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10399 was simply substituted with a file name chosen once per compilation,
10400 without regard to any appended suffix (which was therefore treated
10401 just like ordinary text), making such attacks more likely to succeed.
10403 @item %u@var{suffix}
10404 Like @samp{%g}, but generates a new temporary file name
10405 each time it appears instead of once per compilation.
10407 @item %U@var{suffix}
10408 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10409 new one if there is no such last file name.  In the absence of any
10410 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10411 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10412 involves the generation of two distinct file names, one
10413 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10414 simply substituted with a file name chosen for the previous @samp{%u},
10415 without regard to any appended suffix.
10417 @item %j@var{suffix}
10418 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10419 writable, and if @option{-save-temps} is not used; 
10420 otherwise, substitute the name
10421 of a temporary file, just like @samp{%u}.  This temporary file is not
10422 meant for communication between processes, but rather as a junk
10423 disposal mechanism.
10425 @item %|@var{suffix}
10426 @itemx %m@var{suffix}
10427 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10428 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10429 all.  These are the two most common ways to instruct a program that it
10430 should read from standard input or write to standard output.  If you
10431 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10432 construct: see for example @file{f/lang-specs.h}.
10434 @item %.@var{SUFFIX}
10435 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10436 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10437 terminated by the next space or %.
10439 @item %w
10440 Marks the argument containing or following the @samp{%w} as the
10441 designated output file of this compilation.  This puts the argument
10442 into the sequence of arguments that @samp{%o} substitutes.
10444 @item %o
10445 Substitutes the names of all the output files, with spaces
10446 automatically placed around them.  You should write spaces
10447 around the @samp{%o} as well or the results are undefined.
10448 @samp{%o} is for use in the specs for running the linker.
10449 Input files whose names have no recognized suffix are not compiled
10450 at all, but they are included among the output files, so they are
10451 linked.
10453 @item %O
10454 Substitutes the suffix for object files.  Note that this is
10455 handled specially when it immediately follows @samp{%g, %u, or %U},
10456 because of the need for those to form complete file names.  The
10457 handling is such that @samp{%O} is treated exactly as if it had already
10458 been substituted, except that @samp{%g, %u, and %U} do not currently
10459 support additional @var{suffix} characters following @samp{%O} as they do
10460 following, for example, @samp{.o}.
10462 @item %p
10463 Substitutes the standard macro predefinitions for the
10464 current target machine.  Use this when running @code{cpp}.
10466 @item %P
10467 Like @samp{%p}, but puts @samp{__} before and after the name of each
10468 predefined macro, except for macros that start with @samp{__} or with
10469 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10472 @item %I
10473 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10474 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10475 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10476 and @option{-imultilib} as necessary.
10478 @item %s
10479 Current argument is the name of a library or startup file of some sort.
10480 Search for that file in a standard list of directories and substitute
10481 the full name found.  The current working directory is included in the
10482 list of directories scanned.
10484 @item %T
10485 Current argument is the name of a linker script.  Search for that file
10486 in the current list of directories to scan for libraries. If the file
10487 is located insert a @option{--script} option into the command line
10488 followed by the full path name found.  If the file is not found then
10489 generate an error message.  Note: the current working directory is not
10490 searched.
10492 @item %e@var{str}
10493 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10494 Use this when inconsistent options are detected.
10496 @item %(@var{name})
10497 Substitute the contents of spec string @var{name} at this point.
10499 @item %x@{@var{option}@}
10500 Accumulate an option for @samp{%X}.
10502 @item %X
10503 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10504 spec string.
10506 @item %Y
10507 Output the accumulated assembler options specified by @option{-Wa}.
10509 @item %Z
10510 Output the accumulated preprocessor options specified by @option{-Wp}.
10512 @item %a
10513 Process the @code{asm} spec.  This is used to compute the
10514 switches to be passed to the assembler.
10516 @item %A
10517 Process the @code{asm_final} spec.  This is a spec string for
10518 passing switches to an assembler post-processor, if such a program is
10519 needed.
10521 @item %l
10522 Process the @code{link} spec.  This is the spec for computing the
10523 command line passed to the linker.  Typically it makes use of the
10524 @samp{%L %G %S %D and %E} sequences.
10526 @item %D
10527 Dump out a @option{-L} option for each directory that GCC believes might
10528 contain startup files.  If the target supports multilibs then the
10529 current multilib directory is prepended to each of these paths.
10531 @item %L
10532 Process the @code{lib} spec.  This is a spec string for deciding which
10533 libraries are included on the command line to the linker.
10535 @item %G
10536 Process the @code{libgcc} spec.  This is a spec string for deciding
10537 which GCC support library is included on the command line to the linker.
10539 @item %S
10540 Process the @code{startfile} spec.  This is a spec for deciding which
10541 object files are the first ones passed to the linker.  Typically
10542 this might be a file named @file{crt0.o}.
10544 @item %E
10545 Process the @code{endfile} spec.  This is a spec string that specifies
10546 the last object files that are passed to the linker.
10548 @item %C
10549 Process the @code{cpp} spec.  This is used to construct the arguments
10550 to be passed to the C preprocessor.
10552 @item %1
10553 Process the @code{cc1} spec.  This is used to construct the options to be
10554 passed to the actual C compiler (@samp{cc1}).
10556 @item %2
10557 Process the @code{cc1plus} spec.  This is used to construct the options to be
10558 passed to the actual C++ compiler (@samp{cc1plus}).
10560 @item %*
10561 Substitute the variable part of a matched option.  See below.
10562 Note that each comma in the substituted string is replaced by
10563 a single space.
10565 @item %<@code{S}
10566 Remove all occurrences of @code{-S} from the command line.  Note---this
10567 command is position dependent.  @samp{%} commands in the spec string
10568 before this one see @code{-S}, @samp{%} commands in the spec string
10569 after this one do not.
10571 @item %:@var{function}(@var{args})
10572 Call the named function @var{function}, passing it @var{args}.
10573 @var{args} is first processed as a nested spec string, then split
10574 into an argument vector in the usual fashion.  The function returns
10575 a string which is processed as if it had appeared literally as part
10576 of the current spec.
10578 The following built-in spec functions are provided:
10580 @table @code
10581 @item @code{getenv}
10582 The @code{getenv} spec function takes two arguments: an environment
10583 variable name and a string.  If the environment variable is not
10584 defined, a fatal error is issued.  Otherwise, the return value is the
10585 value of the environment variable concatenated with the string.  For
10586 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10588 @smallexample
10589 %:getenv(TOPDIR /include)
10590 @end smallexample
10592 expands to @file{/path/to/top/include}.
10594 @item @code{if-exists}
10595 The @code{if-exists} spec function takes one argument, an absolute
10596 pathname to a file.  If the file exists, @code{if-exists} returns the
10597 pathname.  Here is a small example of its usage:
10599 @smallexample
10600 *startfile:
10601 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10602 @end smallexample
10604 @item @code{if-exists-else}
10605 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10606 spec function, except that it takes two arguments.  The first argument is
10607 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10608 returns the pathname.  If it does not exist, it returns the second argument.
10609 This way, @code{if-exists-else} can be used to select one file or another,
10610 based on the existence of the first.  Here is a small example of its usage:
10612 @smallexample
10613 *startfile:
10614 crt0%O%s %:if-exists(crti%O%s) \
10615 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10616 @end smallexample
10618 @item @code{replace-outfile}
10619 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10620 first argument in the outfiles array and replaces it with the second argument.  Here
10621 is a small example of its usage:
10623 @smallexample
10624 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10625 @end smallexample
10627 @item @code{remove-outfile}
10628 The @code{remove-outfile} spec function takes one argument.  It looks for the
10629 first argument in the outfiles array and removes it.  Here is a small example
10630 its usage:
10632 @smallexample
10633 %:remove-outfile(-lm)
10634 @end smallexample
10636 @item @code{pass-through-libs}
10637 The @code{pass-through-libs} spec function takes any number of arguments.  It
10638 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10639 assumes are the names of linker input library archive files) and returns a
10640 result containing all the found arguments each prepended by
10641 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10642 intended to be passed to the LTO linker plugin.
10644 @smallexample
10645 %:pass-through-libs(%G %L %G)
10646 @end smallexample
10648 @item @code{print-asm-header}
10649 The @code{print-asm-header} function takes no arguments and simply
10650 prints a banner like:
10652 @smallexample
10653 Assembler options
10654 =================
10656 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10657 @end smallexample
10659 It is used to separate compiler options from assembler options
10660 in the @option{--target-help} output.
10661 @end table
10663 @item %@{@code{S}@}
10664 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10665 If that switch is not specified, this substitutes nothing.  Note that
10666 the leading dash is omitted when specifying this option, and it is
10667 automatically inserted if the substitution is performed.  Thus the spec
10668 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10669 and outputs the command-line option @option{-foo}.
10671 @item %W@{@code{S}@}
10672 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10673 deleted on failure.
10675 @item %@{@code{S}*@}
10676 Substitutes all the switches specified to GCC whose names start
10677 with @code{-S}, but which also take an argument.  This is used for
10678 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10679 GCC considers @option{-o foo} as being
10680 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10681 text, including the space.  Thus two arguments are generated.
10683 @item %@{@code{S}*&@code{T}*@}
10684 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10685 (the order of @code{S} and @code{T} in the spec is not significant).
10686 There can be any number of ampersand-separated variables; for each the
10687 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10689 @item %@{@code{S}:@code{X}@}
10690 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10692 @item %@{!@code{S}:@code{X}@}
10693 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10695 @item %@{@code{S}*:@code{X}@}
10696 Substitutes @code{X} if one or more switches whose names start with
10697 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10698 once, no matter how many such switches appeared.  However, if @code{%*}
10699 appears somewhere in @code{X}, then @code{X} is substituted once
10700 for each matching switch, with the @code{%*} replaced by the part of
10701 that switch matching the @code{*}.
10703 @item %@{.@code{S}:@code{X}@}
10704 Substitutes @code{X}, if processing a file with suffix @code{S}.
10706 @item %@{!.@code{S}:@code{X}@}
10707 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10709 @item %@{,@code{S}:@code{X}@}
10710 Substitutes @code{X}, if processing a file for language @code{S}.
10712 @item %@{!,@code{S}:@code{X}@}
10713 Substitutes @code{X}, if not processing a file for language @code{S}.
10715 @item %@{@code{S}|@code{P}:@code{X}@}
10716 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10717 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10718 @code{*} sequences as well, although they have a stronger binding than
10719 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10720 alternatives must be starred, and only the first matching alternative
10721 is substituted.
10723 For example, a spec string like this:
10725 @smallexample
10726 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10727 @end smallexample
10729 @noindent
10730 outputs the following command-line options from the following input
10731 command-line options:
10733 @smallexample
10734 fred.c        -foo -baz
10735 jim.d         -bar -boggle
10736 -d fred.c     -foo -baz -boggle
10737 -d jim.d      -bar -baz -boggle
10738 @end smallexample
10740 @item %@{S:X; T:Y; :D@}
10742 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10743 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10744 be as many clauses as you need.  This may be combined with @code{.},
10745 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10748 @end table
10750 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10751 construct may contain other nested @samp{%} constructs or spaces, or
10752 even newlines.  They are processed as usual, as described above.
10753 Trailing white space in @code{X} is ignored.  White space may also
10754 appear anywhere on the left side of the colon in these constructs,
10755 except between @code{.} or @code{*} and the corresponding word.
10757 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10758 handled specifically in these constructs.  If another value of
10759 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10760 @option{-W} switch is found later in the command line, the earlier
10761 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10762 just one letter, which passes all matching options.
10764 The character @samp{|} at the beginning of the predicate text is used to
10765 indicate that a command should be piped to the following command, but
10766 only if @option{-pipe} is specified.
10768 It is built into GCC which switches take arguments and which do not.
10769 (You might think it would be useful to generalize this to allow each
10770 compiler's spec to say which switches take arguments.  But this cannot
10771 be done in a consistent fashion.  GCC cannot even decide which input
10772 files have been specified without knowing which switches take arguments,
10773 and it must know which input files to compile in order to tell which
10774 compilers to run).
10776 GCC also knows implicitly that arguments starting in @option{-l} are to be
10777 treated as compiler output files, and passed to the linker in their
10778 proper position among the other output files.
10780 @c man begin OPTIONS
10782 @node Target Options
10783 @section Specifying Target Machine and Compiler Version
10784 @cindex target options
10785 @cindex cross compiling
10786 @cindex specifying machine version
10787 @cindex specifying compiler version and target machine
10788 @cindex compiler version, specifying
10789 @cindex target machine, specifying
10791 The usual way to run GCC is to run the executable called @command{gcc}, or
10792 @command{@var{machine}-gcc} when cross-compiling, or
10793 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10794 one that was installed last.
10796 @node Submodel Options
10797 @section Hardware Models and Configurations
10798 @cindex submodel options
10799 @cindex specifying hardware config
10800 @cindex hardware models and configurations, specifying
10801 @cindex machine dependent options
10803 Each target machine types can have its own
10804 special options, starting with @samp{-m}, to choose among various
10805 hardware models or configurations---for example, 68010 vs 68020,
10806 floating coprocessor or none.  A single installed version of the
10807 compiler can compile for any model or configuration, according to the
10808 options specified.
10810 Some configurations of the compiler also support additional special
10811 options, usually for compatibility with other compilers on the same
10812 platform.
10814 @c This list is ordered alphanumerically by subsection name.
10815 @c It should be the same order and spelling as these options are listed
10816 @c in Machine Dependent Options
10818 @menu
10819 * AArch64 Options::
10820 * Adapteva Epiphany Options::
10821 * ARM Options::
10822 * AVR Options::
10823 * Blackfin Options::
10824 * C6X Options::
10825 * CRIS Options::
10826 * CR16 Options::
10827 * Darwin Options::
10828 * DEC Alpha Options::
10829 * FR30 Options::
10830 * FRV Options::
10831 * GNU/Linux Options::
10832 * H8/300 Options::
10833 * HPPA Options::
10834 * i386 and x86-64 Options::
10835 * i386 and x86-64 Windows Options::
10836 * IA-64 Options::
10837 * LM32 Options::
10838 * M32C Options::
10839 * M32R/D Options::
10840 * M680x0 Options::
10841 * MCore Options::
10842 * MeP Options::
10843 * MicroBlaze Options::
10844 * MIPS Options::
10845 * MMIX Options::
10846 * MN10300 Options::
10847 * Moxie Options::
10848 * PDP-11 Options::
10849 * picoChip Options::
10850 * PowerPC Options::
10851 * RL78 Options::
10852 * RS/6000 and PowerPC Options::
10853 * RX Options::
10854 * S/390 and zSeries Options::
10855 * Score Options::
10856 * SH Options::
10857 * Solaris 2 Options::
10858 * SPARC Options::
10859 * SPU Options::
10860 * System V Options::
10861 * TILE-Gx Options::
10862 * TILEPro Options::
10863 * V850 Options::
10864 * VAX Options::
10865 * VMS Options::
10866 * VxWorks Options::
10867 * x86-64 Options::
10868 * Xstormy16 Options::
10869 * Xtensa Options::
10870 * zSeries Options::
10871 @end menu
10873 @node AArch64 Options
10874 @subsection AArch64 Options
10875 @cindex AArch64 Options
10877 These options are defined for AArch64 implementations:
10879 @table @gcctabopt
10881 @item -mbig-endian
10882 @opindex mbig-endian
10883 Generate big-endian code.  This is the default when GCC is configured for an
10884 @samp{aarch64_be-*-*} target.
10886 @item -mgeneral-regs-only
10887 @opindex mgeneral-regs-only
10888 Generate code which uses only the general registers.
10890 @item -mlittle-endian
10891 @opindex mlittle-endian
10892 Generate little-endian code.  This is the default when GCC is configured for an
10893 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
10895 @item -mcmodel=tiny
10896 @opindex mcmodel=tiny
10897 Generate code for the tiny code model.  The program and its statically defined
10898 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
10899 be statically or dynamically linked.  This model is not fully implemented and
10900 mostly treated as @samp{small}.
10902 @item -mcmodel=small
10903 @opindex mcmodel=small
10904 Generate code for the small code model.  The program and its statically defined
10905 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
10906 be statically or dynamically linked.  This is the default code model.
10908 @item -mcmodel=large
10909 @opindex mcmodel=large
10910 Generate code for the large code model.  This makes no assumptions about
10911 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
10912 statically linked only.
10914 @item -mstrict-align
10915 @opindex mstrict-align
10916 Do not assume that unaligned memory references will be handled by the system.
10918 @item -momit-leaf-frame-pointer
10919 @itemx -mno-omit-leaf-frame-pointer
10920 @opindex momit-leaf-frame-pointer
10921 @opindex mno-omit-leaf-frame-pointer
10922 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
10923 default.
10925 @item -mtls-dialect=desc
10926 @opindex mtls-dialect=desc
10927 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
10928 of TLS variables.  This is the default.
10930 @item -mtls-dialect=traditional
10931 @opindex mtls-dialect=traditional
10932 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
10933 of TLS variables.
10935 @item -march=@var{name}
10936 @opindex march
10937 Specify the name of the target architecture, optionally suffixed by one or
10938 more feature modifiers.  This option has the form
10939 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
10940 only value for @var{arch} is @samp{armv8-a}.  The possible values for
10941 @var{feature} are documented in the sub-section below.
10943 Where conflicting feature modifiers are specified, the right-most feature is
10944 used.
10946 GCC uses this name to determine what kind of instructions it can emit when
10947 generating assembly code.  This option can be used in conjunction with or
10948 instead of the @option{-mcpu=} option.
10950 @item -mcpu=@var{name}
10951 @opindex mcpu
10952 Specify the name of the target processor, optionally suffixed by one or more
10953 feature modifiers.  This option has the form
10954 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
10955 possible values for @var{cpu} are @samp{generic}, @samp{large}.  The
10956 possible values for @var{feature} are documented in the sub-section
10957 below.
10959 Where conflicting feature modifiers are specified, the right-most feature is
10960 used.
10962 GCC uses this name to determine what kind of instructions it can emit when
10963 generating assembly code.
10965 @item -mtune=@var{name}
10966 @opindex mtune
10967 Specify the name of the processor to tune the performance for.  The code will
10968 be tuned as if the target processor were of the type specified in this option,
10969 but still using instructions compatible with the target processor specified
10970 by a @option{-mcpu=} option.  This option cannot be suffixed by feature
10971 modifiers.
10973 @end table
10975 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
10976 @cindex @option{-march} feature modifiers
10977 @cindex @option{-mcpu} feature modifiers
10978 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
10979 the following:
10981 @table @samp
10982 @item crc
10983 Enable CRC extension.
10984 @item crypto
10985 Enable Crypto extension.  This implies Advanced SIMD is enabled.
10986 @item fp
10987 Enable floating-point instructions.
10988 @item simd
10989 Enable Advanced SIMD instructions.  This implies floating-point instructions
10990 are enabled.  This is the default for all current possible values for options
10991 @option{-march} and @option{-mcpu=}.
10992 @end table
10994 @node Adapteva Epiphany Options
10995 @subsection Adapteva Epiphany Options
10997 These @samp{-m} options are defined for Adapteva Epiphany:
10999 @table @gcctabopt
11000 @item -mhalf-reg-file
11001 @opindex mhalf-reg-file
11002 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11003 That allows code to run on hardware variants that lack these registers.
11005 @item -mprefer-short-insn-regs
11006 @opindex mprefer-short-insn-regs
11007 Preferrentially allocate registers that allow short instruction generation.
11008 This can result in increased instruction count, so this may either reduce or
11009 increase overall code size.
11011 @item -mbranch-cost=@var{num}
11012 @opindex mbranch-cost
11013 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11014 This cost is only a heuristic and is not guaranteed to produce
11015 consistent results across releases.
11017 @item -mcmove
11018 @opindex mcmove
11019 Enable the generation of conditional moves.
11021 @item -mnops=@var{num}
11022 @opindex mnops
11023 Emit @var{num} NOPs before every other generated instruction.
11025 @item -mno-soft-cmpsf
11026 @opindex mno-soft-cmpsf
11027 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11028 and test the flags.  This is faster than a software comparison, but can
11029 get incorrect results in the presence of NaNs, or when two different small
11030 numbers are compared such that their difference is calculated as zero.
11031 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11032 software comparisons.
11034 @item -mstack-offset=@var{num}
11035 @opindex mstack-offset
11036 Set the offset between the top of the stack and the stack pointer.
11037 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11038 can be used by leaf functions without stack allocation.
11039 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11040 Note also that this option changes the ABI; compiling a program with a
11041 different stack offset than the libraries have been compiled with
11042 generally does not work.
11043 This option can be useful if you want to evaluate if a different stack
11044 offset would give you better code, but to actually use a different stack
11045 offset to build working programs, it is recommended to configure the
11046 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11048 @item -mno-round-nearest
11049 @opindex mno-round-nearest
11050 Make the scheduler assume that the rounding mode has been set to
11051 truncating.  The default is @option{-mround-nearest}.
11053 @item -mlong-calls
11054 @opindex mlong-calls
11055 If not otherwise specified by an attribute, assume all calls might be beyond
11056 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11057 function address into a register before performing a (otherwise direct) call.
11058 This is the default.
11060 @item -mshort-calls
11061 @opindex short-calls
11062 If not otherwise specified by an attribute, assume all direct calls are
11063 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11064 for direct calls.  The default is @option{-mlong-calls}.
11066 @item -msmall16
11067 @opindex msmall16
11068 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11069 apply to function addresses for which @option{-mlong-calls} semantics
11070 are in effect.
11072 @item -mfp-mode=@var{mode}
11073 @opindex mfp-mode
11074 Set the prevailing mode of the floating-point unit.
11075 This determines the floating-point mode that is provided and expected
11076 at function call and return time.  Making this mode match the mode you
11077 predominantly need at function start can make your programs smaller and
11078 faster by avoiding unnecessary mode switches.
11080 @var{mode} can be set to one the following values:
11082 @table @samp
11083 @item caller
11084 Any mode at function entry is valid, and retained or restored when
11085 the function returns, and when it calls other functions.
11086 This mode is useful for compiling libraries or other compilation units
11087 you might want to incorporate into different programs with different
11088 prevailing FPU modes, and the convenience of being able to use a single
11089 object file outweighs the size and speed overhead for any extra
11090 mode switching that might be needed, compared with what would be needed
11091 with a more specific choice of prevailing FPU mode.
11093 @item truncate
11094 This is the mode used for floating-point calculations with
11095 truncating (i.e.@: round towards zero) rounding mode.  That includes
11096 conversion from floating point to integer.
11098 @item round-nearest
11099 This is the mode used for floating-point calculations with
11100 round-to-nearest-or-even rounding mode.
11102 @item int
11103 This is the mode used to perform integer calculations in the FPU, e.g.@:
11104 integer multiply, or integer multiply-and-accumulate.
11105 @end table
11107 The default is @option{-mfp-mode=caller}
11109 @item -mnosplit-lohi
11110 @itemx -mno-postinc
11111 @itemx -mno-postmodify
11112 @opindex mnosplit-lohi
11113 @opindex mno-postinc
11114 @opindex mno-postmodify
11115 Code generation tweaks that disable, respectively, splitting of 32-bit
11116 loads, generation of post-increment addresses, and generation of
11117 post-modify addresses.  The defaults are @option{msplit-lohi},
11118 @option{-mpost-inc}, and @option{-mpost-modify}.
11120 @item -mnovect-double
11121 @opindex mno-vect-double
11122 Change the preferred SIMD mode to SImode.  The default is
11123 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11125 @item -max-vect-align=@var{num}
11126 @opindex max-vect-align
11127 The maximum alignment for SIMD vector mode types.
11128 @var{num} may be 4 or 8.  The default is 8.
11129 Note that this is an ABI change, even though many library function
11130 interfaces are unaffected if they don't use SIMD vector modes
11131 in places that affect size and/or alignment of relevant types.
11133 @item -msplit-vecmove-early
11134 @opindex msplit-vecmove-early
11135 Split vector moves into single word moves before reload.  In theory this
11136 can give better register allocation, but so far the reverse seems to be
11137 generally the case.
11139 @item -m1reg-@var{reg}
11140 @opindex m1reg-
11141 Specify a register to hold the constant @minus{}1, which makes loading small negative
11142 constants and certain bitmasks faster.
11143 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11144 which specify use of that register as a fixed register,
11145 and @samp{none}, which means that no register is used for this
11146 purpose.  The default is @option{-m1reg-none}.
11148 @end table
11150 @node ARM Options
11151 @subsection ARM Options
11152 @cindex ARM options
11154 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
11155 architectures:
11157 @table @gcctabopt
11158 @item -mabi=@var{name}
11159 @opindex mabi
11160 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
11161 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
11163 @item -mapcs-frame
11164 @opindex mapcs-frame
11165 Generate a stack frame that is compliant with the ARM Procedure Call
11166 Standard for all functions, even if this is not strictly necessary for
11167 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
11168 with this option causes the stack frames not to be generated for
11169 leaf functions.  The default is @option{-mno-apcs-frame}.
11171 @item -mapcs
11172 @opindex mapcs
11173 This is a synonym for @option{-mapcs-frame}.
11175 @ignore
11176 @c not currently implemented
11177 @item -mapcs-stack-check
11178 @opindex mapcs-stack-check
11179 Generate code to check the amount of stack space available upon entry to
11180 every function (that actually uses some stack space).  If there is
11181 insufficient space available then either the function
11182 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
11183 called, depending upon the amount of stack space required.  The runtime
11184 system is required to provide these functions.  The default is
11185 @option{-mno-apcs-stack-check}, since this produces smaller code.
11187 @c not currently implemented
11188 @item -mapcs-float
11189 @opindex mapcs-float
11190 Pass floating-point arguments using the floating-point registers.  This is
11191 one of the variants of the APCS@.  This option is recommended if the
11192 target hardware has a floating-point unit or if a lot of floating-point
11193 arithmetic is going to be performed by the code.  The default is
11194 @option{-mno-apcs-float}, since the size of integer-only code is 
11195 slightly increased if @option{-mapcs-float} is used.
11197 @c not currently implemented
11198 @item -mapcs-reentrant
11199 @opindex mapcs-reentrant
11200 Generate reentrant, position-independent code.  The default is
11201 @option{-mno-apcs-reentrant}.
11202 @end ignore
11204 @item -mthumb-interwork
11205 @opindex mthumb-interwork
11206 Generate code that supports calling between the ARM and Thumb
11207 instruction sets.  Without this option, on pre-v5 architectures, the
11208 two instruction sets cannot be reliably used inside one program.  The
11209 default is @option{-mno-thumb-interwork}, since slightly larger code
11210 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
11211 configurations this option is meaningless.
11213 @item -mno-sched-prolog
11214 @opindex mno-sched-prolog
11215 Prevent the reordering of instructions in the function prologue, or the
11216 merging of those instruction with the instructions in the function's
11217 body.  This means that all functions start with a recognizable set
11218 of instructions (or in fact one of a choice from a small set of
11219 different function prologues), and this information can be used to
11220 locate the start of functions inside an executable piece of code.  The
11221 default is @option{-msched-prolog}.
11223 @item -mfloat-abi=@var{name}
11224 @opindex mfloat-abi
11225 Specifies which floating-point ABI to use.  Permissible values
11226 are: @samp{soft}, @samp{softfp} and @samp{hard}.
11228 Specifying @samp{soft} causes GCC to generate output containing
11229 library calls for floating-point operations.
11230 @samp{softfp} allows the generation of code using hardware floating-point
11231 instructions, but still uses the soft-float calling conventions.
11232 @samp{hard} allows generation of floating-point instructions
11233 and uses FPU-specific calling conventions.
11235 The default depends on the specific target configuration.  Note that
11236 the hard-float and soft-float ABIs are not link-compatible; you must
11237 compile your entire program with the same ABI, and link with a
11238 compatible set of libraries.
11240 @item -mlittle-endian
11241 @opindex mlittle-endian
11242 Generate code for a processor running in little-endian mode.  This is
11243 the default for all standard configurations.
11245 @item -mbig-endian
11246 @opindex mbig-endian
11247 Generate code for a processor running in big-endian mode; the default is
11248 to compile code for a little-endian processor.
11250 @item -mwords-little-endian
11251 @opindex mwords-little-endian
11252 This option only applies when generating code for big-endian processors.
11253 Generate code for a little-endian word order but a big-endian byte
11254 order.  That is, a byte order of the form @samp{32107654}.  Note: this
11255 option should only be used if you require compatibility with code for
11256 big-endian ARM processors generated by versions of the compiler prior to
11257 2.8.  This option is now deprecated.
11259 @item -mcpu=@var{name}
11260 @opindex mcpu
11261 This specifies the name of the target ARM processor.  GCC uses this name
11262 to determine what kind of instructions it can emit when generating
11263 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
11264 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
11265 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
11266 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
11267 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
11268 @samp{arm720},
11269 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
11270 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
11271 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
11272 @samp{strongarm1110},
11273 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
11274 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
11275 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
11276 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
11277 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
11278 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
11279 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
11280 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
11281 @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-r4}, @samp{cortex-r4f},
11282 @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m4}, @samp{cortex-m3},
11283 @samp{cortex-m1},
11284 @samp{cortex-m0},
11285 @samp{cortex-m0plus},
11286 @samp{marvell-pj4},
11287 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
11288 @samp{fa526}, @samp{fa626},
11289 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
11292 @option{-mcpu=generic-@var{arch}} is also permissible, and is
11293 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
11294 See @option{-mtune} for more information.
11296 @option{-mcpu=native} causes the compiler to auto-detect the CPU
11297 of the build computer.  At present, this feature is only supported on
11298 Linux, and not all architectures are recognized.  If the auto-detect is
11299 unsuccessful the option has no effect.
11301 @item -mtune=@var{name}
11302 @opindex mtune
11303 This option is very similar to the @option{-mcpu=} option, except that
11304 instead of specifying the actual target processor type, and hence
11305 restricting which instructions can be used, it specifies that GCC should
11306 tune the performance of the code as if the target were of the type
11307 specified in this option, but still choosing the instructions it
11308 generates based on the CPU specified by a @option{-mcpu=} option.
11309 For some ARM implementations better performance can be obtained by using
11310 this option.
11312 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
11313 performance for a blend of processors within architecture @var{arch}.
11314 The aim is to generate code that run well on the current most popular
11315 processors, balancing between optimizations that benefit some CPUs in the
11316 range, and avoiding performance pitfalls of other CPUs.  The effects of
11317 this option may change in future GCC versions as CPU models come and go.
11319 @option{-mtune=native} causes the compiler to auto-detect the CPU
11320 of the build computer.  At present, this feature is only supported on
11321 Linux, and not all architectures are recognized.  If the auto-detect is
11322 unsuccessful the option has no effect.
11324 @item -march=@var{name}
11325 @opindex march
11326 This specifies the name of the target ARM architecture.  GCC uses this
11327 name to determine what kind of instructions it can emit when generating
11328 assembly code.  This option can be used in conjunction with or instead
11329 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
11330 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
11331 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
11332 @samp{armv6}, @samp{armv6j},
11333 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
11334 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
11335 @samp{armv8-a},
11336 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
11338 @option{-march=native} causes the compiler to auto-detect the architecture
11339 of the build computer.  At present, this feature is only supported on
11340 Linux, and not all architectures are recognized.  If the auto-detect is
11341 unsuccessful the option has no effect.
11343 @item -mfpu=@var{name}
11344 @opindex mfpu
11345 This specifies what floating-point hardware (or hardware emulation) is
11346 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
11347 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
11348 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
11349 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
11350 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
11352 If @option{-msoft-float} is specified this specifies the format of
11353 floating-point values.
11355 If the selected floating-point hardware includes the NEON extension
11356 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
11357 operations are not generated by GCC's auto-vectorization pass unless
11358 @option{-funsafe-math-optimizations} is also specified.  This is
11359 because NEON hardware does not fully implement the IEEE 754 standard for
11360 floating-point arithmetic (in particular denormal values are treated as
11361 zero), so the use of NEON instructions may lead to a loss of precision.
11363 @item -mfp16-format=@var{name}
11364 @opindex mfp16-format
11365 Specify the format of the @code{__fp16} half-precision floating-point type.
11366 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
11367 the default is @samp{none}, in which case the @code{__fp16} type is not
11368 defined.  @xref{Half-Precision}, for more information.
11370 @item -mstructure-size-boundary=@var{n}
11371 @opindex mstructure-size-boundary
11372 The sizes of all structures and unions are rounded up to a multiple
11373 of the number of bits set by this option.  Permissible values are 8, 32
11374 and 64.  The default value varies for different toolchains.  For the COFF
11375 targeted toolchain the default value is 8.  A value of 64 is only allowed
11376 if the underlying ABI supports it.
11378 Specifying a larger number can produce faster, more efficient code, but
11379 can also increase the size of the program.  Different values are potentially
11380 incompatible.  Code compiled with one value cannot necessarily expect to
11381 work with code or libraries compiled with another value, if they exchange
11382 information using structures or unions.
11384 @item -mabort-on-noreturn
11385 @opindex mabort-on-noreturn
11386 Generate a call to the function @code{abort} at the end of a
11387 @code{noreturn} function.  It is executed if the function tries to
11388 return.
11390 @item -mlong-calls
11391 @itemx -mno-long-calls
11392 @opindex mlong-calls
11393 @opindex mno-long-calls
11394 Tells the compiler to perform function calls by first loading the
11395 address of the function into a register and then performing a subroutine
11396 call on this register.  This switch is needed if the target function
11397 lies outside of the 64-megabyte addressing range of the offset-based
11398 version of subroutine call instruction.
11400 Even if this switch is enabled, not all function calls are turned
11401 into long calls.  The heuristic is that static functions, functions
11402 that have the @samp{short-call} attribute, functions that are inside
11403 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
11404 definitions have already been compiled within the current compilation
11405 unit are not turned into long calls.  The exceptions to this rule are
11406 that weak function definitions, functions with the @samp{long-call}
11407 attribute or the @samp{section} attribute, and functions that are within
11408 the scope of a @samp{#pragma long_calls} directive are always
11409 turned into long calls.
11411 This feature is not enabled by default.  Specifying
11412 @option{-mno-long-calls} restores the default behavior, as does
11413 placing the function calls within the scope of a @samp{#pragma
11414 long_calls_off} directive.  Note these switches have no effect on how
11415 the compiler generates code to handle function calls via function
11416 pointers.
11418 @item -msingle-pic-base
11419 @opindex msingle-pic-base
11420 Treat the register used for PIC addressing as read-only, rather than
11421 loading it in the prologue for each function.  The runtime system is
11422 responsible for initializing this register with an appropriate value
11423 before execution begins.
11425 @item -mpic-register=@var{reg}
11426 @opindex mpic-register
11427 Specify the register to be used for PIC addressing.
11428 For standard PIC base case, the default will be any suitable register
11429 determined by compiler.  For single PIC base case, the default is
11430 @samp{R9} if target is EABI based or stack-checking is enabled,
11431 otherwise the default is @samp{R10}.
11433 @item -mpoke-function-name
11434 @opindex mpoke-function-name
11435 Write the name of each function into the text section, directly
11436 preceding the function prologue.  The generated code is similar to this:
11438 @smallexample
11439      t0
11440          .ascii "arm_poke_function_name", 0
11441          .align
11442      t1
11443          .word 0xff000000 + (t1 - t0)
11444      arm_poke_function_name
11445          mov     ip, sp
11446          stmfd   sp!, @{fp, ip, lr, pc@}
11447          sub     fp, ip, #4
11448 @end smallexample
11450 When performing a stack backtrace, code can inspect the value of
11451 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
11452 location @code{pc - 12} and the top 8 bits are set, then we know that
11453 there is a function name embedded immediately preceding this location
11454 and has length @code{((pc[-3]) & 0xff000000)}.
11456 @item -mthumb
11457 @itemx -marm
11458 @opindex marm
11459 @opindex mthumb
11461 Select between generating code that executes in ARM and Thumb
11462 states.  The default for most configurations is to generate code
11463 that executes in ARM state, but the default can be changed by
11464 configuring GCC with the @option{--with-mode=}@var{state}
11465 configure option.
11467 @item -mtpcs-frame
11468 @opindex mtpcs-frame
11469 Generate a stack frame that is compliant with the Thumb Procedure Call
11470 Standard for all non-leaf functions.  (A leaf function is one that does
11471 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
11473 @item -mtpcs-leaf-frame
11474 @opindex mtpcs-leaf-frame
11475 Generate a stack frame that is compliant with the Thumb Procedure Call
11476 Standard for all leaf functions.  (A leaf function is one that does
11477 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
11479 @item -mcallee-super-interworking
11480 @opindex mcallee-super-interworking
11481 Gives all externally visible functions in the file being compiled an ARM
11482 instruction set header which switches to Thumb mode before executing the
11483 rest of the function.  This allows these functions to be called from
11484 non-interworking code.  This option is not valid in AAPCS configurations
11485 because interworking is enabled by default.
11487 @item -mcaller-super-interworking
11488 @opindex mcaller-super-interworking
11489 Allows calls via function pointers (including virtual functions) to
11490 execute correctly regardless of whether the target code has been
11491 compiled for interworking or not.  There is a small overhead in the cost
11492 of executing a function pointer if this option is enabled.  This option
11493 is not valid in AAPCS configurations because interworking is enabled
11494 by default.
11496 @item -mtp=@var{name}
11497 @opindex mtp
11498 Specify the access model for the thread local storage pointer.  The valid
11499 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11500 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11501 (supported in the arm6k architecture), and @option{auto}, which uses the
11502 best available method for the selected processor.  The default setting is
11503 @option{auto}.
11505 @item -mtls-dialect=@var{dialect}
11506 @opindex mtls-dialect
11507 Specify the dialect to use for accessing thread local storage.  Two
11508 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
11509 @samp{gnu} dialect selects the original GNU scheme for supporting
11510 local and global dynamic TLS models.  The @samp{gnu2} dialect
11511 selects the GNU descriptor scheme, which provides better performance
11512 for shared libraries.  The GNU descriptor scheme is compatible with
11513 the original scheme, but does require new assembler, linker and
11514 library support.  Initial and local exec TLS models are unaffected by
11515 this option and always use the original scheme.
11517 @item -mword-relocations
11518 @opindex mword-relocations
11519 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11520 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11521 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11522 is specified.
11524 @item -mfix-cortex-m3-ldrd
11525 @opindex mfix-cortex-m3-ldrd
11526 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11527 with overlapping destination and base registers are used.  This option avoids
11528 generating these instructions.  This option is enabled by default when
11529 @option{-mcpu=cortex-m3} is specified.
11531 @item -munaligned-access
11532 @itemx -mno-unaligned-access
11533 @opindex munaligned-access
11534 @opindex mno-unaligned-access
11535 Enables (or disables) reading and writing of 16- and 32- bit values
11536 from addresses that are not 16- or 32- bit aligned.  By default
11537 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11538 architectures, and enabled for all other architectures.  If unaligned
11539 access is not enabled then words in packed data structures will be
11540 accessed a byte at a time.
11542 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11543 generated object file to either true or false, depending upon the
11544 setting of this option.  If unaligned access is enabled then the
11545 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11546 defined.
11548 @item -mneon-for-64bits
11549 @opindex mneon-for-64bits
11550 Enables using Neon to handle scalar 64-bits operations. This is
11551 disabled by default since the cost of moving data from core registers
11552 to Neon is high.
11554 @item -mrestrict-it
11555 @opindex mrestrict-it
11556 Restricts generation of IT blocks to conform to the rules of ARMv8.
11557 IT blocks can only contain a single 16-bit instruction from a select
11558 set of instructions. This option is on by default for ARMv8 Thumb mode.
11559 @end table
11561 @node AVR Options
11562 @subsection AVR Options
11563 @cindex AVR Options
11565 These options are defined for AVR implementations:
11567 @table @gcctabopt
11568 @item -mmcu=@var{mcu}
11569 @opindex mmcu
11570 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11572 The default for this option is@tie{}@code{avr2}.
11574 GCC supports the following AVR devices and ISAs:
11576 @include avr-mmcu.texi
11578 @item -maccumulate-args
11579 @opindex maccumulate-args
11580 Accumulate outgoing function arguments and acquire/release the needed
11581 stack space for outgoing function arguments once in function
11582 prologue/epilogue.  Without this option, outgoing arguments are pushed
11583 before calling a function and popped afterwards.
11585 Popping the arguments after the function call can be expensive on
11586 AVR so that accumulating the stack space might lead to smaller
11587 executables because arguments need not to be removed from the
11588 stack after such a function call.
11590 This option can lead to reduced code size for functions that perform
11591 several calls to functions that get their arguments on the stack like
11592 calls to printf-like functions.
11594 @item -mbranch-cost=@var{cost}
11595 @opindex mbranch-cost
11596 Set the branch costs for conditional branch instructions to
11597 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11598 integers. The default branch cost is 0.
11600 @item -mcall-prologues
11601 @opindex mcall-prologues
11602 Functions prologues/epilogues are expanded as calls to appropriate
11603 subroutines.  Code size is smaller.
11605 @item -mint8
11606 @opindex mint8
11607 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
11608 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11609 and @code{long long} is 4 bytes.  Please note that this option does not
11610 conform to the C standards, but it results in smaller code
11611 size.
11613 @item -mno-interrupts
11614 @opindex mno-interrupts
11615 Generated code is not compatible with hardware interrupts.
11616 Code size is smaller.
11618 @item -mrelax
11619 @opindex mrelax
11620 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11621 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11622 Setting @code{-mrelax} just adds the @code{--relax} option to the
11623 linker command line when the linker is called.
11625 Jump relaxing is performed by the linker because jump offsets are not
11626 known before code is located. Therefore, the assembler code generated by the
11627 compiler is the same, but the instructions in the executable may
11628 differ from instructions in the assembler code.
11630 Relaxing must be turned on if linker stubs are needed, see the
11631 section on @code{EIND} and linker stubs below.
11633 @item -msp8
11634 @opindex msp8
11635 Treat the stack pointer register as an 8-bit register,
11636 i.e.@: assume the high byte of the stack pointer is zero.
11637 In general, you don't need to set this option by hand.
11639 This option is used internally by the compiler to select and
11640 build multilibs for architectures @code{avr2} and @code{avr25}.
11641 These architectures mix devices with and without @code{SPH}.
11642 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11643 the compiler driver will add or remove this option from the compiler
11644 proper's command line, because the compiler then knows if the device
11645 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11646 register or not.
11648 @item -mstrict-X
11649 @opindex mstrict-X
11650 Use address register @code{X} in a way proposed by the hardware.  This means
11651 that @code{X} is only used in indirect, post-increment or
11652 pre-decrement addressing.
11654 Without this option, the @code{X} register may be used in the same way
11655 as @code{Y} or @code{Z} which then is emulated by additional
11656 instructions.  
11657 For example, loading a value with @code{X+const} addressing with a
11658 small non-negative @code{const < 64} to a register @var{Rn} is
11659 performed as
11661 @example
11662 adiw r26, const   ; X += const
11663 ld   @var{Rn}, X        ; @var{Rn} = *X
11664 sbiw r26, const   ; X -= const
11665 @end example
11667 @item -mtiny-stack
11668 @opindex mtiny-stack
11669 Only change the lower 8@tie{}bits of the stack pointer.
11671 @item -Waddr-space-convert
11672 @opindex Waddr-space-convert
11673 Warn about conversions between address spaces in the case where the
11674 resulting address space is not contained in the incoming address space.
11675 @end table
11677 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11678 @cindex @code{EIND}
11679 Pointers in the implementation are 16@tie{}bits wide.
11680 The address of a function or label is represented as word address so
11681 that indirect jumps and calls can target any code address in the
11682 range of 64@tie{}Ki words.
11684 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11685 bytes of program memory space, there is a special function register called
11686 @code{EIND} that serves as most significant part of the target address
11687 when @code{EICALL} or @code{EIJMP} instructions are used.
11689 Indirect jumps and calls on these devices are handled as follows by
11690 the compiler and are subject to some limitations:
11692 @itemize @bullet
11694 @item
11695 The compiler never sets @code{EIND}.
11697 @item
11698 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11699 instructions or might read @code{EIND} directly in order to emulate an
11700 indirect call/jump by means of a @code{RET} instruction.
11702 @item
11703 The compiler assumes that @code{EIND} never changes during the startup
11704 code or during the application. In particular, @code{EIND} is not
11705 saved/restored in function or interrupt service routine
11706 prologue/epilogue.
11708 @item
11709 For indirect calls to functions and computed goto, the linker
11710 generates @emph{stubs}. Stubs are jump pads sometimes also called
11711 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11712 The stub contains a direct jump to the desired address.
11714 @item
11715 Linker relaxation must be turned on so that the linker will generate
11716 the stubs correctly an all situaltion. See the compiler option
11717 @code{-mrelax} and the linler option @code{--relax}.
11718 There are corner cases where the linker is supposed to generate stubs
11719 but aborts without relaxation and without a helpful error message.
11721 @item
11722 The default linker script is arranged for code with @code{EIND = 0}.
11723 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11724 linker script has to be used in order to place the sections whose
11725 name start with @code{.trampolines} into the segment where @code{EIND}
11726 points to.
11728 @item
11729 The startup code from libgcc never sets @code{EIND}.
11730 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11731 For the impact of AVR-LibC on @code{EIND}, see the
11732 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
11734 @item
11735 It is legitimate for user-specific startup code to set up @code{EIND}
11736 early, for example by means of initialization code located in
11737 section @code{.init3}. Such code runs prior to general startup code
11738 that initializes RAM and calls constructors, but after the bit
11739 of startup code from AVR-LibC that sets @code{EIND} to the segment
11740 where the vector table is located.
11741 @example
11742 #include <avr/io.h>
11744 static void
11745 __attribute__((section(".init3"),naked,used,no_instrument_function))
11746 init3_set_eind (void)
11748   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11749                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11751 @end example
11753 @noindent
11754 The @code{__trampolines_start} symbol is defined in the linker script.
11756 @item
11757 Stubs are generated automatically by the linker if
11758 the following two conditions are met:
11759 @itemize @minus
11761 @item The address of a label is taken by means of the @code{gs} modifier
11762 (short for @emph{generate stubs}) like so:
11763 @example
11764 LDI r24, lo8(gs(@var{func}))
11765 LDI r25, hi8(gs(@var{func}))
11766 @end example
11767 @item The final location of that label is in a code segment
11768 @emph{outside} the segment where the stubs are located.
11769 @end itemize
11771 @item
11772 The compiler emits such @code{gs} modifiers for code labels in the
11773 following situations:
11774 @itemize @minus
11775 @item Taking address of a function or code label.
11776 @item Computed goto.
11777 @item If prologue-save function is used, see @option{-mcall-prologues}
11778 command-line option.
11779 @item Switch/case dispatch tables. If you do not want such dispatch
11780 tables you can specify the @option{-fno-jump-tables} command-line option.
11781 @item C and C++ constructors/destructors called during startup/shutdown.
11782 @item If the tools hit a @code{gs()} modifier explained above.
11783 @end itemize
11785 @item
11786 Jumping to non-symbolic addresses like so is @emph{not} supported:
11788 @example
11789 int main (void)
11791     /* Call function at word address 0x2 */
11792     return ((int(*)(void)) 0x2)();
11794 @end example
11796 Instead, a stub has to be set up, i.e.@: the function has to be called
11797 through a symbol (@code{func_4} in the example):
11799 @example
11800 int main (void)
11802     extern int func_4 (void);
11804     /* Call function at byte address 0x4 */
11805     return func_4();
11807 @end example
11809 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11810 Alternatively, @code{func_4} can be defined in the linker script.
11811 @end itemize
11813 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11814 @cindex @code{RAMPD}
11815 @cindex @code{RAMPX}
11816 @cindex @code{RAMPY}
11817 @cindex @code{RAMPZ}
11818 Some AVR devices support memories larger than the 64@tie{}KiB range
11819 that can be accessed with 16-bit pointers.  To access memory locations
11820 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11821 register is used as high part of the address:
11822 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11823 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11824 register, respectively, to get a wide address. Similarly,
11825 @code{RAMPD} is used together with direct addressing.
11827 @itemize
11828 @item
11829 The startup code initializes the @code{RAMP} special function
11830 registers with zero.
11832 @item
11833 If a @ref{AVR Named Address Spaces,named address space} other than
11834 generic or @code{__flash} is used, then @code{RAMPZ} is set
11835 as needed before the operation.
11837 @item
11838 If the device supports RAM larger than 64@tie{KiB} and the compiler
11839 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11840 is reset to zero after the operation.
11842 @item
11843 If the device comes with a specific @code{RAMP} register, the ISR
11844 prologue/epilogue saves/restores that SFR and initializes it with
11845 zero in case the ISR code might (implicitly) use it.
11847 @item
11848 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11849 If you use inline assembler to read from locations outside the
11850 16-bit address range and change one of the @code{RAMP} registers,
11851 you must reset it to zero after the access.
11853 @end itemize
11855 @subsubsection AVR Built-in Macros
11857 GCC defines several built-in macros so that the user code can test
11858 for the presence or absence of features.  Almost any of the following
11859 built-in macros are deduced from device capabilities and thus
11860 triggered by the @code{-mmcu=} command-line option.
11862 For even more AVR-specific built-in macros see
11863 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11865 @table @code
11867 @item __AVR_ARCH__
11868 Build-in macro that resolves to a decimal number that identifies the
11869 architecture and depends on the @code{-mmcu=@var{mcu}} option.
11870 Possible values are:
11872 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
11873 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
11874 @code{105}, @code{106}, @code{107}
11876 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
11877 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
11878 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
11879 @code{avrxmega6}, @code{avrxmega7}, respectively.
11880 If @var{mcu} specifies a device, this built-in macro is set
11881 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
11882 defined to @code{4}.
11884 @item __AVR_@var{Device}__
11885 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11886 the device's name. For example, @code{-mmcu=atmega8} defines the
11887 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11888 @code{__AVR_ATtiny261A__}, etc.
11890 The built-in macros' names follow
11891 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11892 the device name as from the AVR user manual. The difference between
11893 @var{Device} in the built-in macro and @var{device} in
11894 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11896 If @var{device} is not a device but only a core architecture like
11897 @code{avr51}, this macro will not be defined.
11899 @item __AVR_XMEGA__
11900 The device / architecture belongs to the XMEGA family of devices.
11902 @item __AVR_HAVE_ELPM__
11903 The device has the the @code{ELPM} instruction.
11905 @item __AVR_HAVE_ELPMX__
11906 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11907 R@var{n},Z+} instructions.
11909 @item __AVR_HAVE_MOVW__
11910 The device has the @code{MOVW} instruction to perform 16-bit
11911 register-register moves.
11913 @item __AVR_HAVE_LPMX__
11914 The device has the @code{LPM R@var{n},Z} and
11915 @code{LPM R@var{n},Z+} instructions.
11917 @item __AVR_HAVE_MUL__
11918 The device has a hardware multiplier. 
11920 @item __AVR_HAVE_JMP_CALL__
11921 The device has the @code{JMP} and @code{CALL} instructions.
11922 This is the case for devices with at least 16@tie{}KiB of program
11923 memory.
11925 @item __AVR_HAVE_EIJMP_EICALL__
11926 @itemx __AVR_3_BYTE_PC__
11927 The device has the @code{EIJMP} and @code{EICALL} instructions.
11928 This is the case for devices with more than 128@tie{}KiB of program memory.
11929 This also means that the program counter
11930 (PC) is 3@tie{}bytes wide.
11932 @item __AVR_2_BYTE_PC__
11933 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11934 with up to 128@tie{}KiB of program memory.
11936 @item __AVR_HAVE_8BIT_SP__
11937 @itemx __AVR_HAVE_16BIT_SP__
11938 The stack pointer (SP) register is treated as 8-bit respectively
11939 16-bit register by the compiler.
11940 The definition of these macros is affected by @code{-mtiny-stack}.
11942 @item __AVR_HAVE_SPH__
11943 @itemx __AVR_SP8__
11944 The device has the SPH (high part of stack pointer) special function
11945 register or has an 8-bit stack pointer, respectively.
11946 The definition of these macros is affected by @code{-mmcu=} and
11947 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11948 by @code{-msp8}.
11950 @item __AVR_HAVE_RAMPD__
11951 @itemx __AVR_HAVE_RAMPX__
11952 @itemx __AVR_HAVE_RAMPY__
11953 @itemx __AVR_HAVE_RAMPZ__
11954 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11955 @code{RAMPZ} special function register, respectively.
11957 @item __NO_INTERRUPTS__
11958 This macro reflects the @code{-mno-interrupts} command line option.
11960 @item __AVR_ERRATA_SKIP__
11961 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
11962 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11963 instructions because of a hardware erratum.  Skip instructions are
11964 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11965 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11966 set.
11968 @item __AVR_SFR_OFFSET__=@var{offset}
11969 Instructions that can address I/O special function registers directly
11970 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11971 address as if addressed by an instruction to access RAM like @code{LD}
11972 or @code{STS}. This offset depends on the device architecture and has
11973 to be subtracted from the RAM address in order to get the
11974 respective I/O@tie{}address.
11976 @item __WITH_AVRLIBC__
11977 The compiler is configured to be used together with AVR-Libc.
11978 See the @code{--with-avrlibc} configure option.
11980 @end table
11982 @node Blackfin Options
11983 @subsection Blackfin Options
11984 @cindex Blackfin Options
11986 @table @gcctabopt
11987 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11988 @opindex mcpu=
11989 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11990 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11991 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11992 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11993 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11994 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11995 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11996 @samp{bf561}, @samp{bf592}.
11998 The optional @var{sirevision} specifies the silicon revision of the target
11999 Blackfin processor.  Any workarounds available for the targeted silicon revision
12000 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
12001 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
12002 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
12003 hexadecimal digits representing the major and minor numbers in the silicon
12004 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
12005 is not defined.  If @var{sirevision} is @samp{any}, the
12006 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
12007 If this optional @var{sirevision} is not used, GCC assumes the latest known
12008 silicon revision of the targeted Blackfin processor.
12010 GCC defines a preprocessor macro for the specified @var{cpu}.
12011 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
12012 provided by libgloss to be linked in if @option{-msim} is not given.
12014 Without this option, @samp{bf532} is used as the processor by default.
12016 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
12017 only the preprocessor macro is defined.
12019 @item -msim
12020 @opindex msim
12021 Specifies that the program will be run on the simulator.  This causes
12022 the simulator BSP provided by libgloss to be linked in.  This option
12023 has effect only for @samp{bfin-elf} toolchain.
12024 Certain other options, such as @option{-mid-shared-library} and
12025 @option{-mfdpic}, imply @option{-msim}.
12027 @item -momit-leaf-frame-pointer
12028 @opindex momit-leaf-frame-pointer
12029 Don't keep the frame pointer in a register for leaf functions.  This
12030 avoids the instructions to save, set up and restore frame pointers and
12031 makes an extra register available in leaf functions.  The option
12032 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
12033 which might make debugging harder.
12035 @item -mspecld-anomaly
12036 @opindex mspecld-anomaly
12037 When enabled, the compiler ensures that the generated code does not
12038 contain speculative loads after jump instructions. If this option is used,
12039 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
12041 @item -mno-specld-anomaly
12042 @opindex mno-specld-anomaly
12043 Don't generate extra code to prevent speculative loads from occurring.
12045 @item -mcsync-anomaly
12046 @opindex mcsync-anomaly
12047 When enabled, the compiler ensures that the generated code does not
12048 contain CSYNC or SSYNC instructions too soon after conditional branches.
12049 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
12051 @item -mno-csync-anomaly
12052 @opindex mno-csync-anomaly
12053 Don't generate extra code to prevent CSYNC or SSYNC instructions from
12054 occurring too soon after a conditional branch.
12056 @item -mlow-64k
12057 @opindex mlow-64k
12058 When enabled, the compiler is free to take advantage of the knowledge that
12059 the entire program fits into the low 64k of memory.
12061 @item -mno-low-64k
12062 @opindex mno-low-64k
12063 Assume that the program is arbitrarily large.  This is the default.
12065 @item -mstack-check-l1
12066 @opindex mstack-check-l1
12067 Do stack checking using information placed into L1 scratchpad memory by the
12068 uClinux kernel.
12070 @item -mid-shared-library
12071 @opindex mid-shared-library
12072 Generate code that supports shared libraries via the library ID method.
12073 This allows for execute in place and shared libraries in an environment
12074 without virtual memory management.  This option implies @option{-fPIC}.
12075 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12077 @item -mno-id-shared-library
12078 @opindex mno-id-shared-library
12079 Generate code that doesn't assume ID-based shared libraries are being used.
12080 This is the default.
12082 @item -mleaf-id-shared-library
12083 @opindex mleaf-id-shared-library
12084 Generate code that supports shared libraries via the library ID method,
12085 but assumes that this library or executable won't link against any other
12086 ID shared libraries.  That allows the compiler to use faster code for jumps
12087 and calls.
12089 @item -mno-leaf-id-shared-library
12090 @opindex mno-leaf-id-shared-library
12091 Do not assume that the code being compiled won't link against any ID shared
12092 libraries.  Slower code is generated for jump and call insns.
12094 @item -mshared-library-id=n
12095 @opindex mshared-library-id
12096 Specifies the identification number of the ID-based shared library being
12097 compiled.  Specifying a value of 0 generates more compact code; specifying
12098 other values forces the allocation of that number to the current
12099 library but is no more space- or time-efficient than omitting this option.
12101 @item -msep-data
12102 @opindex msep-data
12103 Generate code that allows the data segment to be located in a different
12104 area of memory from the text segment.  This allows for execute in place in
12105 an environment without virtual memory management by eliminating relocations
12106 against the text section.
12108 @item -mno-sep-data
12109 @opindex mno-sep-data
12110 Generate code that assumes that the data segment follows the text segment.
12111 This is the default.
12113 @item -mlong-calls
12114 @itemx -mno-long-calls
12115 @opindex mlong-calls
12116 @opindex mno-long-calls
12117 Tells the compiler to perform function calls by first loading the
12118 address of the function into a register and then performing a subroutine
12119 call on this register.  This switch is needed if the target function
12120 lies outside of the 24-bit addressing range of the offset-based
12121 version of subroutine call instruction.
12123 This feature is not enabled by default.  Specifying
12124 @option{-mno-long-calls} restores the default behavior.  Note these
12125 switches have no effect on how the compiler generates code to handle
12126 function calls via function pointers.
12128 @item -mfast-fp
12129 @opindex mfast-fp
12130 Link with the fast floating-point library. This library relaxes some of
12131 the IEEE floating-point standard's rules for checking inputs against
12132 Not-a-Number (NAN), in the interest of performance.
12134 @item -minline-plt
12135 @opindex minline-plt
12136 Enable inlining of PLT entries in function calls to functions that are
12137 not known to bind locally.  It has no effect without @option{-mfdpic}.
12139 @item -mmulticore
12140 @opindex mmulticore
12141 Build a standalone application for multicore Blackfin processors. 
12142 This option causes proper start files and link scripts supporting 
12143 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
12144 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
12146 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
12147 selects the one-application-per-core programming model.  Without
12148 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
12149 programming model is used. In this model, the main function of Core B
12150 should be named as @code{coreb_main}.
12152 If this option is not used, the single-core application programming
12153 model is used.
12155 @item -mcorea
12156 @opindex mcorea
12157 Build a standalone application for Core A of BF561 when using
12158 the one-application-per-core programming model. Proper start files
12159 and link scripts are used to support Core A, and the macro
12160 @code{__BFIN_COREA} is defined.
12161 This option can only be used in conjunction with @option{-mmulticore}.
12163 @item -mcoreb
12164 @opindex mcoreb
12165 Build a standalone application for Core B of BF561 when using
12166 the one-application-per-core programming model. Proper start files
12167 and link scripts are used to support Core B, and the macro
12168 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
12169 should be used instead of @code{main}. 
12170 This option can only be used in conjunction with @option{-mmulticore}.
12172 @item -msdram
12173 @opindex msdram
12174 Build a standalone application for SDRAM. Proper start files and
12175 link scripts are used to put the application into SDRAM, and the macro
12176 @code{__BFIN_SDRAM} is defined.
12177 The loader should initialize SDRAM before loading the application.
12179 @item -micplb
12180 @opindex micplb
12181 Assume that ICPLBs are enabled at run time.  This has an effect on certain
12182 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
12183 are enabled; for standalone applications the default is off.
12184 @end table
12186 @node C6X Options
12187 @subsection C6X Options
12188 @cindex C6X Options
12190 @table @gcctabopt
12191 @item -march=@var{name}
12192 @opindex march
12193 This specifies the name of the target architecture.  GCC uses this
12194 name to determine what kind of instructions it can emit when generating
12195 assembly code.  Permissible names are: @samp{c62x},
12196 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
12198 @item -mbig-endian
12199 @opindex mbig-endian
12200 Generate code for a big-endian target.
12202 @item -mlittle-endian
12203 @opindex mlittle-endian
12204 Generate code for a little-endian target.  This is the default.
12206 @item -msim
12207 @opindex msim
12208 Choose startup files and linker script suitable for the simulator.
12210 @item -msdata=default
12211 @opindex msdata=default
12212 Put small global and static data in the @samp{.neardata} section,
12213 which is pointed to by register @code{B14}.  Put small uninitialized
12214 global and static data in the @samp{.bss} section, which is adjacent
12215 to the @samp{.neardata} section.  Put small read-only data into the
12216 @samp{.rodata} section.  The corresponding sections used for large
12217 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
12219 @item -msdata=all
12220 @opindex msdata=all
12221 Put all data, not just small objects, into the sections reserved for
12222 small data, and use addressing relative to the @code{B14} register to
12223 access them.
12225 @item -msdata=none
12226 @opindex msdata=none
12227 Make no use of the sections reserved for small data, and use absolute
12228 addresses to access all data.  Put all initialized global and static
12229 data in the @samp{.fardata} section, and all uninitialized data in the
12230 @samp{.far} section.  Put all constant data into the @samp{.const}
12231 section.
12232 @end table
12234 @node CRIS Options
12235 @subsection CRIS Options
12236 @cindex CRIS Options
12238 These options are defined specifically for the CRIS ports.
12240 @table @gcctabopt
12241 @item -march=@var{architecture-type}
12242 @itemx -mcpu=@var{architecture-type}
12243 @opindex march
12244 @opindex mcpu
12245 Generate code for the specified architecture.  The choices for
12246 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
12247 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
12248 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
12249 @samp{v10}.
12251 @item -mtune=@var{architecture-type}
12252 @opindex mtune
12253 Tune to @var{architecture-type} everything applicable about the generated
12254 code, except for the ABI and the set of available instructions.  The
12255 choices for @var{architecture-type} are the same as for
12256 @option{-march=@var{architecture-type}}.
12258 @item -mmax-stack-frame=@var{n}
12259 @opindex mmax-stack-frame
12260 Warn when the stack frame of a function exceeds @var{n} bytes.
12262 @item -metrax4
12263 @itemx -metrax100
12264 @opindex metrax4
12265 @opindex metrax100
12266 The options @option{-metrax4} and @option{-metrax100} are synonyms for
12267 @option{-march=v3} and @option{-march=v8} respectively.
12269 @item -mmul-bug-workaround
12270 @itemx -mno-mul-bug-workaround
12271 @opindex mmul-bug-workaround
12272 @opindex mno-mul-bug-workaround
12273 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
12274 models where it applies.  This option is active by default.
12276 @item -mpdebug
12277 @opindex mpdebug
12278 Enable CRIS-specific verbose debug-related information in the assembly
12279 code.  This option also has the effect of turning off the @samp{#NO_APP}
12280 formatted-code indicator to the assembler at the beginning of the
12281 assembly file.
12283 @item -mcc-init
12284 @opindex mcc-init
12285 Do not use condition-code results from previous instruction; always emit
12286 compare and test instructions before use of condition codes.
12288 @item -mno-side-effects
12289 @opindex mno-side-effects
12290 Do not emit instructions with side effects in addressing modes other than
12291 post-increment.
12293 @item -mstack-align
12294 @itemx -mno-stack-align
12295 @itemx -mdata-align
12296 @itemx -mno-data-align
12297 @itemx -mconst-align
12298 @itemx -mno-const-align
12299 @opindex mstack-align
12300 @opindex mno-stack-align
12301 @opindex mdata-align
12302 @opindex mno-data-align
12303 @opindex mconst-align
12304 @opindex mno-const-align
12305 These options (@samp{no-} options) arrange (eliminate arrangements) for the
12306 stack frame, individual data and constants to be aligned for the maximum
12307 single data access size for the chosen CPU model.  The default is to
12308 arrange for 32-bit alignment.  ABI details such as structure layout are
12309 not affected by these options.
12311 @item -m32-bit
12312 @itemx -m16-bit
12313 @itemx -m8-bit
12314 @opindex m32-bit
12315 @opindex m16-bit
12316 @opindex m8-bit
12317 Similar to the stack- data- and const-align options above, these options
12318 arrange for stack frame, writable data and constants to all be 32-bit,
12319 16-bit or 8-bit aligned.  The default is 32-bit alignment.
12321 @item -mno-prologue-epilogue
12322 @itemx -mprologue-epilogue
12323 @opindex mno-prologue-epilogue
12324 @opindex mprologue-epilogue
12325 With @option{-mno-prologue-epilogue}, the normal function prologue and
12326 epilogue which set up the stack frame are omitted and no return
12327 instructions or return sequences are generated in the code.  Use this
12328 option only together with visual inspection of the compiled code: no
12329 warnings or errors are generated when call-saved registers must be saved,
12330 or storage for local variables needs to be allocated.
12332 @item -mno-gotplt
12333 @itemx -mgotplt
12334 @opindex mno-gotplt
12335 @opindex mgotplt
12336 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
12337 instruction sequences that load addresses for functions from the PLT part
12338 of the GOT rather than (traditional on other architectures) calls to the
12339 PLT@.  The default is @option{-mgotplt}.
12341 @item -melf
12342 @opindex melf
12343 Legacy no-op option only recognized with the cris-axis-elf and
12344 cris-axis-linux-gnu targets.
12346 @item -mlinux
12347 @opindex mlinux
12348 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
12350 @item -sim
12351 @opindex sim
12352 This option, recognized for the cris-axis-elf, arranges
12353 to link with input-output functions from a simulator library.  Code,
12354 initialized data and zero-initialized data are allocated consecutively.
12356 @item -sim2
12357 @opindex sim2
12358 Like @option{-sim}, but pass linker options to locate initialized data at
12359 0x40000000 and zero-initialized data at 0x80000000.
12360 @end table
12362 @node CR16 Options
12363 @subsection CR16 Options
12364 @cindex CR16 Options
12366 These options are defined specifically for the CR16 ports.
12368 @table @gcctabopt
12370 @item -mmac
12371 @opindex mmac
12372 Enable the use of multiply-accumulate instructions. Disabled by default.
12374 @item -mcr16cplus
12375 @itemx -mcr16c
12376 @opindex mcr16cplus
12377 @opindex mcr16c
12378 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
12379 is default.
12381 @item -msim
12382 @opindex msim
12383 Links the library libsim.a which is in compatible with simulator. Applicable
12384 to ELF compiler only.
12386 @item -mint32
12387 @opindex mint32
12388 Choose integer type as 32-bit wide.
12390 @item -mbit-ops
12391 @opindex mbit-ops
12392 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
12394 @item -mdata-model=@var{model}
12395 @opindex mdata-model
12396 Choose a data model. The choices for @var{model} are @samp{near},
12397 @samp{far} or @samp{medium}. @samp{medium} is default.
12398 However, @samp{far} is not valid with @option{-mcr16c}, as the
12399 CR16C architecture does not support the far data model.
12400 @end table
12402 @node Darwin Options
12403 @subsection Darwin Options
12404 @cindex Darwin options
12406 These options are defined for all architectures running the Darwin operating
12407 system.
12409 FSF GCC on Darwin does not create ``fat'' object files; it creates
12410 an object file for the single architecture that GCC was built to
12411 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
12412 @option{-arch} options are used; it does so by running the compiler or
12413 linker multiple times and joining the results together with
12414 @file{lipo}.
12416 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
12417 @samp{i686}) is determined by the flags that specify the ISA
12418 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
12419 @option{-force_cpusubtype_ALL} option can be used to override this.
12421 The Darwin tools vary in their behavior when presented with an ISA
12422 mismatch.  The assembler, @file{as}, only permits instructions to
12423 be used that are valid for the subtype of the file it is generating,
12424 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
12425 The linker for shared libraries, @file{/usr/bin/libtool}, fails
12426 and prints an error if asked to create a shared library with a less
12427 restrictive subtype than its input files (for instance, trying to put
12428 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
12429 for executables, @command{ld}, quietly gives the executable the most
12430 restrictive subtype of any of its input files.
12432 @table @gcctabopt
12433 @item -F@var{dir}
12434 @opindex F
12435 Add the framework directory @var{dir} to the head of the list of
12436 directories to be searched for header files.  These directories are
12437 interleaved with those specified by @option{-I} options and are
12438 scanned in a left-to-right order.
12440 A framework directory is a directory with frameworks in it.  A
12441 framework is a directory with a @file{Headers} and/or
12442 @file{PrivateHeaders} directory contained directly in it that ends
12443 in @file{.framework}.  The name of a framework is the name of this
12444 directory excluding the @file{.framework}.  Headers associated with
12445 the framework are found in one of those two directories, with
12446 @file{Headers} being searched first.  A subframework is a framework
12447 directory that is in a framework's @file{Frameworks} directory.
12448 Includes of subframework headers can only appear in a header of a
12449 framework that contains the subframework, or in a sibling subframework
12450 header.  Two subframeworks are siblings if they occur in the same
12451 framework.  A subframework should not have the same name as a
12452 framework; a warning is issued if this is violated.  Currently a
12453 subframework cannot have subframeworks; in the future, the mechanism
12454 may be extended to support this.  The standard frameworks can be found
12455 in @file{/System/Library/Frameworks} and
12456 @file{/Library/Frameworks}.  An example include looks like
12457 @code{#include <Framework/header.h>}, where @file{Framework} denotes
12458 the name of the framework and @file{header.h} is found in the
12459 @file{PrivateHeaders} or @file{Headers} directory.
12461 @item -iframework@var{dir}
12462 @opindex iframework
12463 Like @option{-F} except the directory is a treated as a system
12464 directory.  The main difference between this @option{-iframework} and
12465 @option{-F} is that with @option{-iframework} the compiler does not
12466 warn about constructs contained within header files found via
12467 @var{dir}.  This option is valid only for the C family of languages.
12469 @item -gused
12470 @opindex gused
12471 Emit debugging information for symbols that are used.  For stabs
12472 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
12473 This is by default ON@.
12475 @item -gfull
12476 @opindex gfull
12477 Emit debugging information for all symbols and types.
12479 @item -mmacosx-version-min=@var{version}
12480 The earliest version of MacOS X that this executable will run on
12481 is @var{version}.  Typical values of @var{version} include @code{10.1},
12482 @code{10.2}, and @code{10.3.9}.
12484 If the compiler was built to use the system's headers by default,
12485 then the default for this option is the system version on which the
12486 compiler is running, otherwise the default is to make choices that
12487 are compatible with as many systems and code bases as possible.
12489 @item -mkernel
12490 @opindex mkernel
12491 Enable kernel development mode.  The @option{-mkernel} option sets
12492 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
12493 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
12494 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
12495 applicable.  This mode also sets @option{-mno-altivec},
12496 @option{-msoft-float}, @option{-fno-builtin} and
12497 @option{-mlong-branch} for PowerPC targets.
12499 @item -mone-byte-bool
12500 @opindex mone-byte-bool
12501 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
12502 By default @samp{sizeof(bool)} is @samp{4} when compiling for
12503 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
12504 option has no effect on x86.
12506 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
12507 to generate code that is not binary compatible with code generated
12508 without that switch.  Using this switch may require recompiling all
12509 other modules in a program, including system libraries.  Use this
12510 switch to conform to a non-default data model.
12512 @item -mfix-and-continue
12513 @itemx -ffix-and-continue
12514 @itemx -findirect-data
12515 @opindex mfix-and-continue
12516 @opindex ffix-and-continue
12517 @opindex findirect-data
12518 Generate code suitable for fast turnaround development, such as to
12519 allow GDB to dynamically load @code{.o} files into already-running
12520 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
12521 are provided for backwards compatibility.
12523 @item -all_load
12524 @opindex all_load
12525 Loads all members of static archive libraries.
12526 See man ld(1) for more information.
12528 @item -arch_errors_fatal
12529 @opindex arch_errors_fatal
12530 Cause the errors having to do with files that have the wrong architecture
12531 to be fatal.
12533 @item -bind_at_load
12534 @opindex bind_at_load
12535 Causes the output file to be marked such that the dynamic linker will
12536 bind all undefined references when the file is loaded or launched.
12538 @item -bundle
12539 @opindex bundle
12540 Produce a Mach-o bundle format file.
12541 See man ld(1) for more information.
12543 @item -bundle_loader @var{executable}
12544 @opindex bundle_loader
12545 This option specifies the @var{executable} that will load the build
12546 output file being linked.  See man ld(1) for more information.
12548 @item -dynamiclib
12549 @opindex dynamiclib
12550 When passed this option, GCC produces a dynamic library instead of
12551 an executable when linking, using the Darwin @file{libtool} command.
12553 @item -force_cpusubtype_ALL
12554 @opindex force_cpusubtype_ALL
12555 This causes GCC's output file to have the @var{ALL} subtype, instead of
12556 one controlled by the @option{-mcpu} or @option{-march} option.
12558 @item -allowable_client  @var{client_name}
12559 @itemx -client_name
12560 @itemx -compatibility_version
12561 @itemx -current_version
12562 @itemx -dead_strip
12563 @itemx -dependency-file
12564 @itemx -dylib_file
12565 @itemx -dylinker_install_name
12566 @itemx -dynamic
12567 @itemx -exported_symbols_list
12568 @itemx -filelist
12569 @need 800
12570 @itemx -flat_namespace
12571 @itemx -force_flat_namespace
12572 @itemx -headerpad_max_install_names
12573 @itemx -image_base
12574 @itemx -init
12575 @itemx -install_name
12576 @itemx -keep_private_externs
12577 @itemx -multi_module
12578 @itemx -multiply_defined
12579 @itemx -multiply_defined_unused
12580 @need 800
12581 @itemx -noall_load
12582 @itemx -no_dead_strip_inits_and_terms
12583 @itemx -nofixprebinding
12584 @itemx -nomultidefs
12585 @itemx -noprebind
12586 @itemx -noseglinkedit
12587 @itemx -pagezero_size
12588 @itemx -prebind
12589 @itemx -prebind_all_twolevel_modules
12590 @itemx -private_bundle
12591 @need 800
12592 @itemx -read_only_relocs
12593 @itemx -sectalign
12594 @itemx -sectobjectsymbols
12595 @itemx -whyload
12596 @itemx -seg1addr
12597 @itemx -sectcreate
12598 @itemx -sectobjectsymbols
12599 @itemx -sectorder
12600 @itemx -segaddr
12601 @itemx -segs_read_only_addr
12602 @need 800
12603 @itemx -segs_read_write_addr
12604 @itemx -seg_addr_table
12605 @itemx -seg_addr_table_filename
12606 @itemx -seglinkedit
12607 @itemx -segprot
12608 @itemx -segs_read_only_addr
12609 @itemx -segs_read_write_addr
12610 @itemx -single_module
12611 @itemx -static
12612 @itemx -sub_library
12613 @need 800
12614 @itemx -sub_umbrella
12615 @itemx -twolevel_namespace
12616 @itemx -umbrella
12617 @itemx -undefined
12618 @itemx -unexported_symbols_list
12619 @itemx -weak_reference_mismatches
12620 @itemx -whatsloaded
12621 @opindex allowable_client
12622 @opindex client_name
12623 @opindex compatibility_version
12624 @opindex current_version
12625 @opindex dead_strip
12626 @opindex dependency-file
12627 @opindex dylib_file
12628 @opindex dylinker_install_name
12629 @opindex dynamic
12630 @opindex exported_symbols_list
12631 @opindex filelist
12632 @opindex flat_namespace
12633 @opindex force_flat_namespace
12634 @opindex headerpad_max_install_names
12635 @opindex image_base
12636 @opindex init
12637 @opindex install_name
12638 @opindex keep_private_externs
12639 @opindex multi_module
12640 @opindex multiply_defined
12641 @opindex multiply_defined_unused
12642 @opindex noall_load
12643 @opindex no_dead_strip_inits_and_terms
12644 @opindex nofixprebinding
12645 @opindex nomultidefs
12646 @opindex noprebind
12647 @opindex noseglinkedit
12648 @opindex pagezero_size
12649 @opindex prebind
12650 @opindex prebind_all_twolevel_modules
12651 @opindex private_bundle
12652 @opindex read_only_relocs
12653 @opindex sectalign
12654 @opindex sectobjectsymbols
12655 @opindex whyload
12656 @opindex seg1addr
12657 @opindex sectcreate
12658 @opindex sectobjectsymbols
12659 @opindex sectorder
12660 @opindex segaddr
12661 @opindex segs_read_only_addr
12662 @opindex segs_read_write_addr
12663 @opindex seg_addr_table
12664 @opindex seg_addr_table_filename
12665 @opindex seglinkedit
12666 @opindex segprot
12667 @opindex segs_read_only_addr
12668 @opindex segs_read_write_addr
12669 @opindex single_module
12670 @opindex static
12671 @opindex sub_library
12672 @opindex sub_umbrella
12673 @opindex twolevel_namespace
12674 @opindex umbrella
12675 @opindex undefined
12676 @opindex unexported_symbols_list
12677 @opindex weak_reference_mismatches
12678 @opindex whatsloaded
12679 These options are passed to the Darwin linker.  The Darwin linker man page
12680 describes them in detail.
12681 @end table
12683 @node DEC Alpha Options
12684 @subsection DEC Alpha Options
12686 These @samp{-m} options are defined for the DEC Alpha implementations:
12688 @table @gcctabopt
12689 @item -mno-soft-float
12690 @itemx -msoft-float
12691 @opindex mno-soft-float
12692 @opindex msoft-float
12693 Use (do not use) the hardware floating-point instructions for
12694 floating-point operations.  When @option{-msoft-float} is specified,
12695 functions in @file{libgcc.a} are used to perform floating-point
12696 operations.  Unless they are replaced by routines that emulate the
12697 floating-point operations, or compiled in such a way as to call such
12698 emulations routines, these routines issue floating-point
12699 operations.   If you are compiling for an Alpha without floating-point
12700 operations, you must ensure that the library is built so as not to call
12701 them.
12703 Note that Alpha implementations without floating-point operations are
12704 required to have floating-point registers.
12706 @item -mfp-reg
12707 @itemx -mno-fp-regs
12708 @opindex mfp-reg
12709 @opindex mno-fp-regs
12710 Generate code that uses (does not use) the floating-point register set.
12711 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12712 register set is not used, floating-point operands are passed in integer
12713 registers as if they were integers and floating-point results are passed
12714 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12715 so any function with a floating-point argument or return value called by code
12716 compiled with @option{-mno-fp-regs} must also be compiled with that
12717 option.
12719 A typical use of this option is building a kernel that does not use,
12720 and hence need not save and restore, any floating-point registers.
12722 @item -mieee
12723 @opindex mieee
12724 The Alpha architecture implements floating-point hardware optimized for
12725 maximum performance.  It is mostly compliant with the IEEE floating-point
12726 standard.  However, for full compliance, software assistance is
12727 required.  This option generates code fully IEEE-compliant code
12728 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12729 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12730 defined during compilation.  The resulting code is less efficient but is
12731 able to correctly support denormalized numbers and exceptional IEEE
12732 values such as not-a-number and plus/minus infinity.  Other Alpha
12733 compilers call this option @option{-ieee_with_no_inexact}.
12735 @item -mieee-with-inexact
12736 @opindex mieee-with-inexact
12737 This is like @option{-mieee} except the generated code also maintains
12738 the IEEE @var{inexact-flag}.  Turning on this option causes the
12739 generated code to implement fully-compliant IEEE math.  In addition to
12740 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12741 macro.  On some Alpha implementations the resulting code may execute
12742 significantly slower than the code generated by default.  Since there is
12743 very little code that depends on the @var{inexact-flag}, you should
12744 normally not specify this option.  Other Alpha compilers call this
12745 option @option{-ieee_with_inexact}.
12747 @item -mfp-trap-mode=@var{trap-mode}
12748 @opindex mfp-trap-mode
12749 This option controls what floating-point related traps are enabled.
12750 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12751 The trap mode can be set to one of four values:
12753 @table @samp
12754 @item n
12755 This is the default (normal) setting.  The only traps that are enabled
12756 are the ones that cannot be disabled in software (e.g., division by zero
12757 trap).
12759 @item u
12760 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12761 as well.
12763 @item su
12764 Like @samp{u}, but the instructions are marked to be safe for software
12765 completion (see Alpha architecture manual for details).
12767 @item sui
12768 Like @samp{su}, but inexact traps are enabled as well.
12769 @end table
12771 @item -mfp-rounding-mode=@var{rounding-mode}
12772 @opindex mfp-rounding-mode
12773 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12774 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12777 @table @samp
12778 @item n
12779 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12780 the nearest machine number or towards the even machine number in case
12781 of a tie.
12783 @item m
12784 Round towards minus infinity.
12786 @item c
12787 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12789 @item d
12790 Dynamic rounding mode.  A field in the floating-point control register
12791 (@var{fpcr}, see Alpha architecture reference manual) controls the
12792 rounding mode in effect.  The C library initializes this register for
12793 rounding towards plus infinity.  Thus, unless your program modifies the
12794 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12795 @end table
12797 @item -mtrap-precision=@var{trap-precision}
12798 @opindex mtrap-precision
12799 In the Alpha architecture, floating-point traps are imprecise.  This
12800 means without software assistance it is impossible to recover from a
12801 floating trap and program execution normally needs to be terminated.
12802 GCC can generate code that can assist operating system trap handlers
12803 in determining the exact location that caused a floating-point trap.
12804 Depending on the requirements of an application, different levels of
12805 precisions can be selected:
12807 @table @samp
12808 @item p
12809 Program precision.  This option is the default and means a trap handler
12810 can only identify which program caused a floating-point exception.
12812 @item f
12813 Function precision.  The trap handler can determine the function that
12814 caused a floating-point exception.
12816 @item i
12817 Instruction precision.  The trap handler can determine the exact
12818 instruction that caused a floating-point exception.
12819 @end table
12821 Other Alpha compilers provide the equivalent options called
12822 @option{-scope_safe} and @option{-resumption_safe}.
12824 @item -mieee-conformant
12825 @opindex mieee-conformant
12826 This option marks the generated code as IEEE conformant.  You must not
12827 use this option unless you also specify @option{-mtrap-precision=i} and either
12828 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12829 is to emit the line @samp{.eflag 48} in the function prologue of the
12830 generated assembly file.
12832 @item -mbuild-constants
12833 @opindex mbuild-constants
12834 Normally GCC examines a 32- or 64-bit integer constant to
12835 see if it can construct it from smaller constants in two or three
12836 instructions.  If it cannot, it outputs the constant as a literal and
12837 generates code to load it from the data segment at run time.
12839 Use this option to require GCC to construct @emph{all} integer constants
12840 using code, even if it takes more instructions (the maximum is six).
12842 You typically use this option to build a shared library dynamic
12843 loader.  Itself a shared library, it must relocate itself in memory
12844 before it can find the variables and constants in its own data segment.
12846 @item -mbwx
12847 @itemx -mno-bwx
12848 @itemx -mcix
12849 @itemx -mno-cix
12850 @itemx -mfix
12851 @itemx -mno-fix
12852 @itemx -mmax
12853 @itemx -mno-max
12854 @opindex mbwx
12855 @opindex mno-bwx
12856 @opindex mcix
12857 @opindex mno-cix
12858 @opindex mfix
12859 @opindex mno-fix
12860 @opindex mmax
12861 @opindex mno-max
12862 Indicate whether GCC should generate code to use the optional BWX,
12863 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12864 sets supported by the CPU type specified via @option{-mcpu=} option or that
12865 of the CPU on which GCC was built if none is specified.
12867 @item -mfloat-vax
12868 @itemx -mfloat-ieee
12869 @opindex mfloat-vax
12870 @opindex mfloat-ieee
12871 Generate code that uses (does not use) VAX F and G floating-point
12872 arithmetic instead of IEEE single and double precision.
12874 @item -mexplicit-relocs
12875 @itemx -mno-explicit-relocs
12876 @opindex mexplicit-relocs
12877 @opindex mno-explicit-relocs
12878 Older Alpha assemblers provided no way to generate symbol relocations
12879 except via assembler macros.  Use of these macros does not allow
12880 optimal instruction scheduling.  GNU binutils as of version 2.12
12881 supports a new syntax that allows the compiler to explicitly mark
12882 which relocations should apply to which instructions.  This option
12883 is mostly useful for debugging, as GCC detects the capabilities of
12884 the assembler when it is built and sets the default accordingly.
12886 @item -msmall-data
12887 @itemx -mlarge-data
12888 @opindex msmall-data
12889 @opindex mlarge-data
12890 When @option{-mexplicit-relocs} is in effect, static data is
12891 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12892 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12893 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12894 16-bit relocations off of the @code{$gp} register.  This limits the
12895 size of the small data area to 64KB, but allows the variables to be
12896 directly accessed via a single instruction.
12898 The default is @option{-mlarge-data}.  With this option the data area
12899 is limited to just below 2GB@.  Programs that require more than 2GB of
12900 data must use @code{malloc} or @code{mmap} to allocate the data in the
12901 heap instead of in the program's data segment.
12903 When generating code for shared libraries, @option{-fpic} implies
12904 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12906 @item -msmall-text
12907 @itemx -mlarge-text
12908 @opindex msmall-text
12909 @opindex mlarge-text
12910 When @option{-msmall-text} is used, the compiler assumes that the
12911 code of the entire program (or shared library) fits in 4MB, and is
12912 thus reachable with a branch instruction.  When @option{-msmall-data}
12913 is used, the compiler can assume that all local symbols share the
12914 same @code{$gp} value, and thus reduce the number of instructions
12915 required for a function call from 4 to 1.
12917 The default is @option{-mlarge-text}.
12919 @item -mcpu=@var{cpu_type}
12920 @opindex mcpu
12921 Set the instruction set and instruction scheduling parameters for
12922 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12923 style name or the corresponding chip number.  GCC supports scheduling
12924 parameters for the EV4, EV5 and EV6 family of processors and
12925 chooses the default values for the instruction set from the processor
12926 you specify.  If you do not specify a processor type, GCC defaults
12927 to the processor on which the compiler was built.
12929 Supported values for @var{cpu_type} are
12931 @table @samp
12932 @item ev4
12933 @itemx ev45
12934 @itemx 21064
12935 Schedules as an EV4 and has no instruction set extensions.
12937 @item ev5
12938 @itemx 21164
12939 Schedules as an EV5 and has no instruction set extensions.
12941 @item ev56
12942 @itemx 21164a
12943 Schedules as an EV5 and supports the BWX extension.
12945 @item pca56
12946 @itemx 21164pc
12947 @itemx 21164PC
12948 Schedules as an EV5 and supports the BWX and MAX extensions.
12950 @item ev6
12951 @itemx 21264
12952 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12954 @item ev67
12955 @itemx 21264a
12956 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12957 @end table
12959 Native toolchains also support the value @samp{native},
12960 which selects the best architecture option for the host processor.
12961 @option{-mcpu=native} has no effect if GCC does not recognize
12962 the processor.
12964 @item -mtune=@var{cpu_type}
12965 @opindex mtune
12966 Set only the instruction scheduling parameters for machine type
12967 @var{cpu_type}.  The instruction set is not changed.
12969 Native toolchains also support the value @samp{native},
12970 which selects the best architecture option for the host processor.
12971 @option{-mtune=native} has no effect if GCC does not recognize
12972 the processor.
12974 @item -mmemory-latency=@var{time}
12975 @opindex mmemory-latency
12976 Sets the latency the scheduler should assume for typical memory
12977 references as seen by the application.  This number is highly
12978 dependent on the memory access patterns used by the application
12979 and the size of the external cache on the machine.
12981 Valid options for @var{time} are
12983 @table @samp
12984 @item @var{number}
12985 A decimal number representing clock cycles.
12987 @item L1
12988 @itemx L2
12989 @itemx L3
12990 @itemx main
12991 The compiler contains estimates of the number of clock cycles for
12992 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12993 (also called Dcache, Scache, and Bcache), as well as to main memory.
12994 Note that L3 is only valid for EV5.
12996 @end table
12997 @end table
12999 @node FR30 Options
13000 @subsection FR30 Options
13001 @cindex FR30 Options
13003 These options are defined specifically for the FR30 port.
13005 @table @gcctabopt
13007 @item -msmall-model
13008 @opindex msmall-model
13009 Use the small address space model.  This can produce smaller code, but
13010 it does assume that all symbolic values and addresses fit into a
13011 20-bit range.
13013 @item -mno-lsim
13014 @opindex mno-lsim
13015 Assume that runtime support has been provided and so there is no need
13016 to include the simulator library (@file{libsim.a}) on the linker
13017 command line.
13019 @end table
13021 @node FRV Options
13022 @subsection FRV Options
13023 @cindex FRV Options
13025 @table @gcctabopt
13026 @item -mgpr-32
13027 @opindex mgpr-32
13029 Only use the first 32 general-purpose registers.
13031 @item -mgpr-64
13032 @opindex mgpr-64
13034 Use all 64 general-purpose registers.
13036 @item -mfpr-32
13037 @opindex mfpr-32
13039 Use only the first 32 floating-point registers.
13041 @item -mfpr-64
13042 @opindex mfpr-64
13044 Use all 64 floating-point registers.
13046 @item -mhard-float
13047 @opindex mhard-float
13049 Use hardware instructions for floating-point operations.
13051 @item -msoft-float
13052 @opindex msoft-float
13054 Use library routines for floating-point operations.
13056 @item -malloc-cc
13057 @opindex malloc-cc
13059 Dynamically allocate condition code registers.
13061 @item -mfixed-cc
13062 @opindex mfixed-cc
13064 Do not try to dynamically allocate condition code registers, only
13065 use @code{icc0} and @code{fcc0}.
13067 @item -mdword
13068 @opindex mdword
13070 Change ABI to use double word insns.
13072 @item -mno-dword
13073 @opindex mno-dword
13075 Do not use double word instructions.
13077 @item -mdouble
13078 @opindex mdouble
13080 Use floating-point double instructions.
13082 @item -mno-double
13083 @opindex mno-double
13085 Do not use floating-point double instructions.
13087 @item -mmedia
13088 @opindex mmedia
13090 Use media instructions.
13092 @item -mno-media
13093 @opindex mno-media
13095 Do not use media instructions.
13097 @item -mmuladd
13098 @opindex mmuladd
13100 Use multiply and add/subtract instructions.
13102 @item -mno-muladd
13103 @opindex mno-muladd
13105 Do not use multiply and add/subtract instructions.
13107 @item -mfdpic
13108 @opindex mfdpic
13110 Select the FDPIC ABI, which uses function descriptors to represent
13111 pointers to functions.  Without any PIC/PIE-related options, it
13112 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
13113 assumes GOT entries and small data are within a 12-bit range from the
13114 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
13115 are computed with 32 bits.
13116 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13118 @item -minline-plt
13119 @opindex minline-plt
13121 Enable inlining of PLT entries in function calls to functions that are
13122 not known to bind locally.  It has no effect without @option{-mfdpic}.
13123 It's enabled by default if optimizing for speed and compiling for
13124 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
13125 optimization option such as @option{-O3} or above is present in the
13126 command line.
13128 @item -mTLS
13129 @opindex mTLS
13131 Assume a large TLS segment when generating thread-local code.
13133 @item -mtls
13134 @opindex mtls
13136 Do not assume a large TLS segment when generating thread-local code.
13138 @item -mgprel-ro
13139 @opindex mgprel-ro
13141 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
13142 that is known to be in read-only sections.  It's enabled by default,
13143 except for @option{-fpic} or @option{-fpie}: even though it may help
13144 make the global offset table smaller, it trades 1 instruction for 4.
13145 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
13146 one of which may be shared by multiple symbols, and it avoids the need
13147 for a GOT entry for the referenced symbol, so it's more likely to be a
13148 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
13150 @item -multilib-library-pic
13151 @opindex multilib-library-pic
13153 Link with the (library, not FD) pic libraries.  It's implied by
13154 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
13155 @option{-fpic} without @option{-mfdpic}.  You should never have to use
13156 it explicitly.
13158 @item -mlinked-fp
13159 @opindex mlinked-fp
13161 Follow the EABI requirement of always creating a frame pointer whenever
13162 a stack frame is allocated.  This option is enabled by default and can
13163 be disabled with @option{-mno-linked-fp}.
13165 @item -mlong-calls
13166 @opindex mlong-calls
13168 Use indirect addressing to call functions outside the current
13169 compilation unit.  This allows the functions to be placed anywhere
13170 within the 32-bit address space.
13172 @item -malign-labels
13173 @opindex malign-labels
13175 Try to align labels to an 8-byte boundary by inserting NOPs into the
13176 previous packet.  This option only has an effect when VLIW packing
13177 is enabled.  It doesn't create new packets; it merely adds NOPs to
13178 existing ones.
13180 @item -mlibrary-pic
13181 @opindex mlibrary-pic
13183 Generate position-independent EABI code.
13185 @item -macc-4
13186 @opindex macc-4
13188 Use only the first four media accumulator registers.
13190 @item -macc-8
13191 @opindex macc-8
13193 Use all eight media accumulator registers.
13195 @item -mpack
13196 @opindex mpack
13198 Pack VLIW instructions.
13200 @item -mno-pack
13201 @opindex mno-pack
13203 Do not pack VLIW instructions.
13205 @item -mno-eflags
13206 @opindex mno-eflags
13208 Do not mark ABI switches in e_flags.
13210 @item -mcond-move
13211 @opindex mcond-move
13213 Enable the use of conditional-move instructions (default).
13215 This switch is mainly for debugging the compiler and will likely be removed
13216 in a future version.
13218 @item -mno-cond-move
13219 @opindex mno-cond-move
13221 Disable the use of conditional-move instructions.
13223 This switch is mainly for debugging the compiler and will likely be removed
13224 in a future version.
13226 @item -mscc
13227 @opindex mscc
13229 Enable the use of conditional set instructions (default).
13231 This switch is mainly for debugging the compiler and will likely be removed
13232 in a future version.
13234 @item -mno-scc
13235 @opindex mno-scc
13237 Disable the use of conditional set instructions.
13239 This switch is mainly for debugging the compiler and will likely be removed
13240 in a future version.
13242 @item -mcond-exec
13243 @opindex mcond-exec
13245 Enable the use of conditional execution (default).
13247 This switch is mainly for debugging the compiler and will likely be removed
13248 in a future version.
13250 @item -mno-cond-exec
13251 @opindex mno-cond-exec
13253 Disable the use of conditional execution.
13255 This switch is mainly for debugging the compiler and will likely be removed
13256 in a future version.
13258 @item -mvliw-branch
13259 @opindex mvliw-branch
13261 Run a pass to pack branches into VLIW instructions (default).
13263 This switch is mainly for debugging the compiler and will likely be removed
13264 in a future version.
13266 @item -mno-vliw-branch
13267 @opindex mno-vliw-branch
13269 Do not run a pass to pack branches into VLIW instructions.
13271 This switch is mainly for debugging the compiler and will likely be removed
13272 in a future version.
13274 @item -mmulti-cond-exec
13275 @opindex mmulti-cond-exec
13277 Enable optimization of @code{&&} and @code{||} in conditional execution
13278 (default).
13280 This switch is mainly for debugging the compiler and will likely be removed
13281 in a future version.
13283 @item -mno-multi-cond-exec
13284 @opindex mno-multi-cond-exec
13286 Disable optimization of @code{&&} and @code{||} in conditional execution.
13288 This switch is mainly for debugging the compiler and will likely be removed
13289 in a future version.
13291 @item -mnested-cond-exec
13292 @opindex mnested-cond-exec
13294 Enable nested conditional execution optimizations (default).
13296 This switch is mainly for debugging the compiler and will likely be removed
13297 in a future version.
13299 @item -mno-nested-cond-exec
13300 @opindex mno-nested-cond-exec
13302 Disable nested conditional execution optimizations.
13304 This switch is mainly for debugging the compiler and will likely be removed
13305 in a future version.
13307 @item -moptimize-membar
13308 @opindex moptimize-membar
13310 This switch removes redundant @code{membar} instructions from the
13311 compiler-generated code.  It is enabled by default.
13313 @item -mno-optimize-membar
13314 @opindex mno-optimize-membar
13316 This switch disables the automatic removal of redundant @code{membar}
13317 instructions from the generated code.
13319 @item -mtomcat-stats
13320 @opindex mtomcat-stats
13322 Cause gas to print out tomcat statistics.
13324 @item -mcpu=@var{cpu}
13325 @opindex mcpu
13327 Select the processor type for which to generate code.  Possible values are
13328 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
13329 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
13331 @end table
13333 @node GNU/Linux Options
13334 @subsection GNU/Linux Options
13336 These @samp{-m} options are defined for GNU/Linux targets:
13338 @table @gcctabopt
13339 @item -mglibc
13340 @opindex mglibc
13341 Use the GNU C library.  This is the default except
13342 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
13344 @item -muclibc
13345 @opindex muclibc
13346 Use uClibc C library.  This is the default on
13347 @samp{*-*-linux-*uclibc*} targets.
13349 @item -mbionic
13350 @opindex mbionic
13351 Use Bionic C library.  This is the default on
13352 @samp{*-*-linux-*android*} targets.
13354 @item -mandroid
13355 @opindex mandroid
13356 Compile code compatible with Android platform.  This is the default on
13357 @samp{*-*-linux-*android*} targets.
13359 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
13360 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
13361 this option makes the GCC driver pass Android-specific options to the linker.
13362 Finally, this option causes the preprocessor macro @code{__ANDROID__}
13363 to be defined.
13365 @item -tno-android-cc
13366 @opindex tno-android-cc
13367 Disable compilation effects of @option{-mandroid}, i.e., do not enable
13368 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
13369 @option{-fno-rtti} by default.
13371 @item -tno-android-ld
13372 @opindex tno-android-ld
13373 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
13374 linking options to the linker.
13376 @end table
13378 @node H8/300 Options
13379 @subsection H8/300 Options
13381 These @samp{-m} options are defined for the H8/300 implementations:
13383 @table @gcctabopt
13384 @item -mrelax
13385 @opindex mrelax
13386 Shorten some address references at link time, when possible; uses the
13387 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
13388 ld, Using ld}, for a fuller description.
13390 @item -mh
13391 @opindex mh
13392 Generate code for the H8/300H@.
13394 @item -ms
13395 @opindex ms
13396 Generate code for the H8S@.
13398 @item -mn
13399 @opindex mn
13400 Generate code for the H8S and H8/300H in the normal mode.  This switch
13401 must be used either with @option{-mh} or @option{-ms}.
13403 @item -ms2600
13404 @opindex ms2600
13405 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
13407 @item -mexr
13408 @opindex mexr
13409 Extended registers are stored on stack before execution of function
13410 with monitor attribute. Default option is @option{-mexr}.
13411 This option is valid only for H8S targets.
13413 @item -mno-exr
13414 @opindex mno-exr
13415 Extended registers are not stored on stack before execution of function 
13416 with monitor attribute. Default option is @option{-mno-exr}. 
13417 This option is valid only for H8S targets.
13419 @item -mint32
13420 @opindex mint32
13421 Make @code{int} data 32 bits by default.
13423 @item -malign-300
13424 @opindex malign-300
13425 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
13426 The default for the H8/300H and H8S is to align longs and floats on
13427 4-byte boundaries.
13428 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
13429 This option has no effect on the H8/300.
13430 @end table
13432 @node HPPA Options
13433 @subsection HPPA Options
13434 @cindex HPPA Options
13436 These @samp{-m} options are defined for the HPPA family of computers:
13438 @table @gcctabopt
13439 @item -march=@var{architecture-type}
13440 @opindex march
13441 Generate code for the specified architecture.  The choices for
13442 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
13443 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
13444 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
13445 architecture option for your machine.  Code compiled for lower numbered
13446 architectures runs on higher numbered architectures, but not the
13447 other way around.
13449 @item -mpa-risc-1-0
13450 @itemx -mpa-risc-1-1
13451 @itemx -mpa-risc-2-0
13452 @opindex mpa-risc-1-0
13453 @opindex mpa-risc-1-1
13454 @opindex mpa-risc-2-0
13455 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
13457 @item -mbig-switch
13458 @opindex mbig-switch
13459 Generate code suitable for big switch tables.  Use this option only if
13460 the assembler/linker complain about out-of-range branches within a switch
13461 table.
13463 @item -mjump-in-delay
13464 @opindex mjump-in-delay
13465 Fill delay slots of function calls with unconditional jump instructions
13466 by modifying the return pointer for the function call to be the target
13467 of the conditional jump.
13469 @item -mdisable-fpregs
13470 @opindex mdisable-fpregs
13471 Prevent floating-point registers from being used in any manner.  This is
13472 necessary for compiling kernels that perform lazy context switching of
13473 floating-point registers.  If you use this option and attempt to perform
13474 floating-point operations, the compiler aborts.
13476 @item -mdisable-indexing
13477 @opindex mdisable-indexing
13478 Prevent the compiler from using indexing address modes.  This avoids some
13479 rather obscure problems when compiling MIG generated code under MACH@.
13481 @item -mno-space-regs
13482 @opindex mno-space-regs
13483 Generate code that assumes the target has no space registers.  This allows
13484 GCC to generate faster indirect calls and use unscaled index address modes.
13486 Such code is suitable for level 0 PA systems and kernels.
13488 @item -mfast-indirect-calls
13489 @opindex mfast-indirect-calls
13490 Generate code that assumes calls never cross space boundaries.  This
13491 allows GCC to emit code that performs faster indirect calls.
13493 This option does not work in the presence of shared libraries or nested
13494 functions.
13496 @item -mfixed-range=@var{register-range}
13497 @opindex mfixed-range
13498 Generate code treating the given register range as fixed registers.
13499 A fixed register is one that the register allocator cannot use.  This is
13500 useful when compiling kernel code.  A register range is specified as
13501 two registers separated by a dash.  Multiple register ranges can be
13502 specified separated by a comma.
13504 @item -mlong-load-store
13505 @opindex mlong-load-store
13506 Generate 3-instruction load and store sequences as sometimes required by
13507 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
13508 the HP compilers.
13510 @item -mportable-runtime
13511 @opindex mportable-runtime
13512 Use the portable calling conventions proposed by HP for ELF systems.
13514 @item -mgas
13515 @opindex mgas
13516 Enable the use of assembler directives only GAS understands.
13518 @item -mschedule=@var{cpu-type}
13519 @opindex mschedule
13520 Schedule code according to the constraints for the machine type
13521 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
13522 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
13523 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13524 proper scheduling option for your machine.  The default scheduling is
13525 @samp{8000}.
13527 @item -mlinker-opt
13528 @opindex mlinker-opt
13529 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
13530 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
13531 linkers in which they give bogus error messages when linking some programs.
13533 @item -msoft-float
13534 @opindex msoft-float
13535 Generate output containing library calls for floating point.
13536 @strong{Warning:} the requisite libraries are not available for all HPPA
13537 targets.  Normally the facilities of the machine's usual C compiler are
13538 used, but this cannot be done directly in cross-compilation.  You must make
13539 your own arrangements to provide suitable library functions for
13540 cross-compilation.
13542 @option{-msoft-float} changes the calling convention in the output file;
13543 therefore, it is only useful if you compile @emph{all} of a program with
13544 this option.  In particular, you need to compile @file{libgcc.a}, the
13545 library that comes with GCC, with @option{-msoft-float} in order for
13546 this to work.
13548 @item -msio
13549 @opindex msio
13550 Generate the predefine, @code{_SIO}, for server IO@.  The default is
13551 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
13552 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
13553 options are available under HP-UX and HI-UX@.
13555 @item -mgnu-ld
13556 @opindex mgnu-ld
13557 Use options specific to GNU @command{ld}.
13558 This passes @option{-shared} to @command{ld} when
13559 building a shared library.  It is the default when GCC is configured,
13560 explicitly or implicitly, with the GNU linker.  This option does not
13561 affect which @command{ld} is called; it only changes what parameters
13562 are passed to that @command{ld}.
13563 The @command{ld} that is called is determined by the
13564 @option{--with-ld} configure option, GCC's program search path, and
13565 finally by the user's @env{PATH}.  The linker used by GCC can be printed
13566 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
13567 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13569 @item -mhp-ld
13570 @opindex mhp-ld
13571 Use options specific to HP @command{ld}.
13572 This passes @option{-b} to @command{ld} when building
13573 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13574 links.  It is the default when GCC is configured, explicitly or
13575 implicitly, with the HP linker.  This option does not affect
13576 which @command{ld} is called; it only changes what parameters are passed to that
13577 @command{ld}.
13578 The @command{ld} that is called is determined by the @option{--with-ld}
13579 configure option, GCC's program search path, and finally by the user's
13580 @env{PATH}.  The linker used by GCC can be printed using @samp{which
13581 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
13582 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13584 @item -mlong-calls
13585 @opindex mno-long-calls
13586 Generate code that uses long call sequences.  This ensures that a call
13587 is always able to reach linker generated stubs.  The default is to generate
13588 long calls only when the distance from the call site to the beginning
13589 of the function or translation unit, as the case may be, exceeds a
13590 predefined limit set by the branch type being used.  The limits for
13591 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13592 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
13593 240,000 bytes.
13595 Distances are measured from the beginning of functions when using the
13596 @option{-ffunction-sections} option, or when using the @option{-mgas}
13597 and @option{-mno-portable-runtime} options together under HP-UX with
13598 the SOM linker.
13600 It is normally not desirable to use this option as it degrades
13601 performance.  However, it may be useful in large applications,
13602 particularly when partial linking is used to build the application.
13604 The types of long calls used depends on the capabilities of the
13605 assembler and linker, and the type of code being generated.  The
13606 impact on systems that support long absolute calls, and long pic
13607 symbol-difference or pc-relative calls should be relatively small.
13608 However, an indirect call is used on 32-bit ELF systems in pic code
13609 and it is quite long.
13611 @item -munix=@var{unix-std}
13612 @opindex march
13613 Generate compiler predefines and select a startfile for the specified
13614 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
13615 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13616 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13617 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13618 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13619 and later.
13621 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13622 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13623 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13624 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13625 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13626 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13628 It is @emph{important} to note that this option changes the interfaces
13629 for various library routines.  It also affects the operational behavior
13630 of the C library.  Thus, @emph{extreme} care is needed in using this
13631 option.
13633 Library code that is intended to operate with more than one UNIX
13634 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13635 as appropriate.  Most GNU software doesn't provide this capability.
13637 @item -nolibdld
13638 @opindex nolibdld
13639 Suppress the generation of link options to search libdld.sl when the
13640 @option{-static} option is specified on HP-UX 10 and later.
13642 @item -static
13643 @opindex static
13644 The HP-UX implementation of setlocale in libc has a dependency on
13645 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13646 when the @option{-static} option is specified, special link options
13647 are needed to resolve this dependency.
13649 On HP-UX 10 and later, the GCC driver adds the necessary options to
13650 link with libdld.sl when the @option{-static} option is specified.
13651 This causes the resulting binary to be dynamic.  On the 64-bit port,
13652 the linkers generate dynamic binaries by default in any case.  The
13653 @option{-nolibdld} option can be used to prevent the GCC driver from
13654 adding these link options.
13656 @item -threads
13657 @opindex threads
13658 Add support for multithreading with the @dfn{dce thread} library
13659 under HP-UX@.  This option sets flags for both the preprocessor and
13660 linker.
13661 @end table
13663 @node i386 and x86-64 Options
13664 @subsection Intel 386 and AMD x86-64 Options
13665 @cindex i386 Options
13666 @cindex x86-64 Options
13667 @cindex Intel 386 Options
13668 @cindex AMD x86-64 Options
13670 These @samp{-m} options are defined for the i386 and x86-64 family of
13671 computers:
13673 @table @gcctabopt
13675 @item -march=@var{cpu-type}
13676 @opindex march
13677 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13678 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13679 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13680 to generate code that may not run at all on processors other than the one
13681 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13682 @option{-mtune=@var{cpu-type}}.
13684 The choices for @var{cpu-type} are:
13686 @table @samp
13687 @item native
13688 This selects the CPU to generate code for at compilation time by determining
13689 the processor type of the compiling machine.  Using @option{-march=native}
13690 enables all instruction subsets supported by the local machine (hence
13691 the result might not run on different machines).  Using @option{-mtune=native}
13692 produces code optimized for the local machine under the constraints
13693 of the selected instruction set.  
13695 @item i386
13696 Original Intel i386 CPU@.
13698 @item i486
13699 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13701 @item i586
13702 @itemx pentium
13703 Intel Pentium CPU with no MMX support.
13705 @item pentium-mmx
13706 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13708 @item pentiumpro
13709 Intel Pentium Pro CPU@.
13711 @item i686
13712 When used with @option{-march}, the Pentium Pro
13713 instruction set is used, so the code runs on all i686 family chips.
13714 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13716 @item pentium2
13717 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13718 support.
13720 @item pentium3
13721 @itemx pentium3m
13722 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13723 set support.
13725 @item pentium-m
13726 Intel Pentium M; low-power version of Intel Pentium III CPU
13727 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13729 @item pentium4
13730 @itemx pentium4m
13731 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13733 @item prescott
13734 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13735 set support.
13737 @item nocona
13738 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13739 SSE2 and SSE3 instruction set support.
13741 @item core2
13742 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13743 instruction set support.
13745 @item corei7
13746 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13747 and SSE4.2 instruction set support.
13749 @item corei7-avx
13750 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13751 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13753 @item core-avx-i
13754 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13755 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13756 set support.
13758 @item core-avx2
13759 Intel Core CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
13760 SSE4.1, SSE4.2, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2
13761 and F16C instruction set support.
13763 @item atom
13764 Intel Atom CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
13765 instruction set support.
13767 @item k6
13768 AMD K6 CPU with MMX instruction set support.
13770 @item k6-2
13771 @itemx k6-3
13772 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13774 @item athlon
13775 @itemx athlon-tbird
13776 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13777 support.
13779 @item athlon-4
13780 @itemx athlon-xp
13781 @itemx athlon-mp
13782 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13783 instruction set support.
13785 @item k8
13786 @itemx opteron
13787 @itemx athlon64
13788 @itemx athlon-fx
13789 Processors based on the AMD K8 core with x86-64 instruction set support,
13790 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13791 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13792 instruction set extensions.)
13794 @item k8-sse3
13795 @itemx opteron-sse3
13796 @itemx athlon64-sse3
13797 Improved versions of AMD K8 cores with SSE3 instruction set support.
13799 @item amdfam10
13800 @itemx barcelona
13801 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13802 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13803 instruction set extensions.)
13805 @item bdver1
13806 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13807 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13808 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13809 @item bdver2
13810 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13811 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13812 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13813 extensions.)
13814 @item bdver3
13815 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13816 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13817 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13818 extensions.
13820 @item btver1
13821 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13822 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13823 instruction set extensions.)
13825 @item btver2
13826 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
13827 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
13828 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
13830 @item winchip-c6
13831 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13832 set support.
13834 @item winchip2
13835 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13836 instruction set support.
13838 @item c3
13839 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13840 implemented for this chip.)
13842 @item c3-2
13843 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13844 (No scheduling is
13845 implemented for this chip.)
13847 @item geode
13848 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13849 @end table
13851 @item -mtune=@var{cpu-type}
13852 @opindex mtune
13853 Tune to @var{cpu-type} everything applicable about the generated code, except
13854 for the ABI and the set of available instructions.  
13855 While picking a specific @var{cpu-type} schedules things appropriately
13856 for that particular chip, the compiler does not generate any code that
13857 cannot run on the default machine type unless you use a
13858 @option{-march=@var{cpu-type}} option.
13859 For example, if GCC is configured for i686-pc-linux-gnu
13860 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13861 but still runs on i686 machines.
13863 The choices for @var{cpu-type} are the same as for @option{-march}.
13864 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13866 @table @samp
13867 @item generic
13868 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13869 If you know the CPU on which your code will run, then you should use
13870 the corresponding @option{-mtune} or @option{-march} option instead of
13871 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13872 of your application will have, then you should use this option.
13874 As new processors are deployed in the marketplace, the behavior of this
13875 option will change.  Therefore, if you upgrade to a newer version of
13876 GCC, code generation controlled by this option will change to reflect
13877 the processors
13878 that are most common at the time that version of GCC is released.
13880 There is no @option{-march=generic} option because @option{-march}
13881 indicates the instruction set the compiler can use, and there is no
13882 generic instruction set applicable to all processors.  In contrast,
13883 @option{-mtune} indicates the processor (or, in this case, collection of
13884 processors) for which the code is optimized.
13885 @end table
13887 @item -mcpu=@var{cpu-type}
13888 @opindex mcpu
13889 A deprecated synonym for @option{-mtune}.
13891 @item -mfpmath=@var{unit}
13892 @opindex mfpmath
13893 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13894 for @var{unit} are:
13896 @table @samp
13897 @item 387
13898 Use the standard 387 floating-point coprocessor present on the majority of chips and
13899 emulated otherwise.  Code compiled with this option runs almost everywhere.
13900 The temporary results are computed in 80-bit precision instead of the precision
13901 specified by the type, resulting in slightly different results compared to most
13902 of other chips.  See @option{-ffloat-store} for more detailed description.
13904 This is the default choice for i386 compiler.
13906 @item sse
13907 Use scalar floating-point instructions present in the SSE instruction set.
13908 This instruction set is supported by Pentium III and newer chips,
13909 and in the AMD line
13910 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13911 instruction set supports only single-precision arithmetic, thus the double and
13912 extended-precision arithmetic are still done using 387.  A later version, present
13913 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13914 arithmetic too.
13916 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13917 or @option{-msse2} switches to enable SSE extensions and make this option
13918 effective.  For the x86-64 compiler, these extensions are enabled by default.
13920 The resulting code should be considerably faster in the majority of cases and avoid
13921 the numerical instability problems of 387 code, but may break some existing
13922 code that expects temporaries to be 80 bits.
13924 This is the default choice for the x86-64 compiler.
13926 @item sse,387
13927 @itemx sse+387
13928 @itemx both
13929 Attempt to utilize both instruction sets at once.  This effectively doubles the
13930 amount of available registers, and on chips with separate execution units for
13931 387 and SSE the execution resources too.  Use this option with care, as it is
13932 still experimental, because the GCC register allocator does not model separate
13933 functional units well, resulting in unstable performance.
13934 @end table
13936 @item -masm=@var{dialect}
13937 @opindex masm=@var{dialect}
13938 Output assembly instructions using selected @var{dialect}.  Supported
13939 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13940 not support @samp{intel}.
13942 @item -mieee-fp
13943 @itemx -mno-ieee-fp
13944 @opindex mieee-fp
13945 @opindex mno-ieee-fp
13946 Control whether or not the compiler uses IEEE floating-point
13947 comparisons.  These correctly handle the case where the result of a
13948 comparison is unordered.
13950 @item -msoft-float
13951 @opindex msoft-float
13952 Generate output containing library calls for floating point.
13954 @strong{Warning:} the requisite libraries are not part of GCC@.
13955 Normally the facilities of the machine's usual C compiler are used, but
13956 this can't be done directly in cross-compilation.  You must make your
13957 own arrangements to provide suitable library functions for
13958 cross-compilation.
13960 On machines where a function returns floating-point results in the 80387
13961 register stack, some floating-point opcodes may be emitted even if
13962 @option{-msoft-float} is used.
13964 @item -mno-fp-ret-in-387
13965 @opindex mno-fp-ret-in-387
13966 Do not use the FPU registers for return values of functions.
13968 The usual calling convention has functions return values of types
13969 @code{float} and @code{double} in an FPU register, even if there
13970 is no FPU@.  The idea is that the operating system should emulate
13971 an FPU@.
13973 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13974 in ordinary CPU registers instead.
13976 @item -mno-fancy-math-387
13977 @opindex mno-fancy-math-387
13978 Some 387 emulators do not support the @code{sin}, @code{cos} and
13979 @code{sqrt} instructions for the 387.  Specify this option to avoid
13980 generating those instructions.  This option is the default on FreeBSD,
13981 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13982 indicates that the target CPU always has an FPU and so the
13983 instruction does not need emulation.  These
13984 instructions are not generated unless you also use the
13985 @option{-funsafe-math-optimizations} switch.
13987 @item -malign-double
13988 @itemx -mno-align-double
13989 @opindex malign-double
13990 @opindex mno-align-double
13991 Control whether GCC aligns @code{double}, @code{long double}, and
13992 @code{long long} variables on a two-word boundary or a one-word
13993 boundary.  Aligning @code{double} variables on a two-word boundary
13994 produces code that runs somewhat faster on a Pentium at the
13995 expense of more memory.
13997 On x86-64, @option{-malign-double} is enabled by default.
13999 @strong{Warning:} if you use the @option{-malign-double} switch,
14000 structures containing the above types are aligned differently than
14001 the published application binary interface specifications for the 386
14002 and are not binary compatible with structures in code compiled
14003 without that switch.
14005 @item -m96bit-long-double
14006 @itemx -m128bit-long-double
14007 @opindex m96bit-long-double
14008 @opindex m128bit-long-double
14009 These switches control the size of @code{long double} type.  The i386
14010 application binary interface specifies the size to be 96 bits,
14011 so @option{-m96bit-long-double} is the default in 32-bit mode.
14013 Modern architectures (Pentium and newer) prefer @code{long double}
14014 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
14015 conforming to the ABI, this is not possible.  So specifying
14016 @option{-m128bit-long-double} aligns @code{long double}
14017 to a 16-byte boundary by padding the @code{long double} with an additional
14018 32-bit zero.
14020 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
14021 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
14023 Notice that neither of these options enable any extra precision over the x87
14024 standard of 80 bits for a @code{long double}.
14026 @strong{Warning:} if you override the default value for your target ABI, this
14027 changes the size of 
14028 structures and arrays containing @code{long double} variables,
14029 as well as modifying the function calling convention for functions taking
14030 @code{long double}.  Hence they are not binary-compatible
14031 with code compiled without that switch.
14033 @item -mlong-double-64
14034 @itemx -mlong-double-80
14035 @opindex mlong-double-64
14036 @opindex mlong-double-80
14037 These switches control the size of @code{long double} type. A size
14038 of 64 bits makes the @code{long double} type equivalent to the @code{double}
14039 type. This is the default for Bionic C library.
14041 @strong{Warning:} if you override the default value for your target ABI, this
14042 changes the size of
14043 structures and arrays containing @code{long double} variables,
14044 as well as modifying the function calling convention for functions taking
14045 @code{long double}.  Hence they are not binary-compatible
14046 with code compiled without that switch.
14048 @item -mlarge-data-threshold=@var{threshold}
14049 @opindex mlarge-data-threshold
14050 When @option{-mcmodel=medium} is specified, data objects larger than
14051 @var{threshold} are placed in the large data section.  This value must be the
14052 same across all objects linked into the binary, and defaults to 65535.
14054 @item -mrtd
14055 @opindex mrtd
14056 Use a different function-calling convention, in which functions that
14057 take a fixed number of arguments return with the @code{ret @var{num}}
14058 instruction, which pops their arguments while returning.  This saves one
14059 instruction in the caller since there is no need to pop the arguments
14060 there.
14062 You can specify that an individual function is called with this calling
14063 sequence with the function attribute @samp{stdcall}.  You can also
14064 override the @option{-mrtd} option by using the function attribute
14065 @samp{cdecl}.  @xref{Function Attributes}.
14067 @strong{Warning:} this calling convention is incompatible with the one
14068 normally used on Unix, so you cannot use it if you need to call
14069 libraries compiled with the Unix compiler.
14071 Also, you must provide function prototypes for all functions that
14072 take variable numbers of arguments (including @code{printf});
14073 otherwise incorrect code is generated for calls to those
14074 functions.
14076 In addition, seriously incorrect code results if you call a
14077 function with too many arguments.  (Normally, extra arguments are
14078 harmlessly ignored.)
14080 @item -mregparm=@var{num}
14081 @opindex mregparm
14082 Control how many registers are used to pass integer arguments.  By
14083 default, no registers are used to pass arguments, and at most 3
14084 registers can be used.  You can control this behavior for a specific
14085 function by using the function attribute @samp{regparm}.
14086 @xref{Function Attributes}.
14088 @strong{Warning:} if you use this switch, and
14089 @var{num} is nonzero, then you must build all modules with the same
14090 value, including any libraries.  This includes the system libraries and
14091 startup modules.
14093 @item -msseregparm
14094 @opindex msseregparm
14095 Use SSE register passing conventions for float and double arguments
14096 and return values.  You can control this behavior for a specific
14097 function by using the function attribute @samp{sseregparm}.
14098 @xref{Function Attributes}.
14100 @strong{Warning:} if you use this switch then you must build all
14101 modules with the same value, including any libraries.  This includes
14102 the system libraries and startup modules.
14104 @item -mvect8-ret-in-mem
14105 @opindex mvect8-ret-in-mem
14106 Return 8-byte vectors in memory instead of MMX registers.  This is the
14107 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
14108 Studio compilers until version 12.  Later compiler versions (starting
14109 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
14110 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
14111 you need to remain compatible with existing code produced by those
14112 previous compiler versions or older versions of GCC@.
14114 @item -mpc32
14115 @itemx -mpc64
14116 @itemx -mpc80
14117 @opindex mpc32
14118 @opindex mpc64
14119 @opindex mpc80
14121 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
14122 is specified, the significands of results of floating-point operations are
14123 rounded to 24 bits (single precision); @option{-mpc64} rounds the
14124 significands of results of floating-point operations to 53 bits (double
14125 precision) and @option{-mpc80} rounds the significands of results of
14126 floating-point operations to 64 bits (extended double precision), which is
14127 the default.  When this option is used, floating-point operations in higher
14128 precisions are not available to the programmer without setting the FPU
14129 control word explicitly.
14131 Setting the rounding of floating-point operations to less than the default
14132 80 bits can speed some programs by 2% or more.  Note that some mathematical
14133 libraries assume that extended-precision (80-bit) floating-point operations
14134 are enabled by default; routines in such libraries could suffer significant
14135 loss of accuracy, typically through so-called ``catastrophic cancellation'',
14136 when this option is used to set the precision to less than extended precision.
14138 @item -mstackrealign
14139 @opindex mstackrealign
14140 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
14141 option generates an alternate prologue and epilogue that realigns the
14142 run-time stack if necessary.  This supports mixing legacy codes that keep
14143 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
14144 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
14145 applicable to individual functions.
14147 @item -mpreferred-stack-boundary=@var{num}
14148 @opindex mpreferred-stack-boundary
14149 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
14150 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
14151 the default is 4 (16 bytes or 128 bits).
14153 @strong{Warning:} When generating code for the x86-64 architecture with
14154 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
14155 used to keep the stack boundary aligned to 8 byte boundary.  Since
14156 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
14157 intended to be used in controlled environment where stack space is
14158 important limitation.  This option will lead to wrong code when functions
14159 compiled with 16 byte stack alignment (such as functions from a standard
14160 library) are called with misaligned stack.  In this case, SSE
14161 instructions may lead to misaligned memory access traps.  In addition,
14162 variable arguments will be handled incorrectly for 16 byte aligned
14163 objects (including x87 long double and __int128), leading to wrong
14164 results.  You must build all modules with
14165 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
14166 includes the system libraries and startup modules.
14168 @item -mincoming-stack-boundary=@var{num}
14169 @opindex mincoming-stack-boundary
14170 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
14171 boundary.  If @option{-mincoming-stack-boundary} is not specified,
14172 the one specified by @option{-mpreferred-stack-boundary} is used.
14174 On Pentium and Pentium Pro, @code{double} and @code{long double} values
14175 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
14176 suffer significant run time performance penalties.  On Pentium III, the
14177 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
14178 properly if it is not 16-byte aligned.
14180 To ensure proper alignment of this values on the stack, the stack boundary
14181 must be as aligned as that required by any value stored on the stack.
14182 Further, every function must be generated such that it keeps the stack
14183 aligned.  Thus calling a function compiled with a higher preferred
14184 stack boundary from a function compiled with a lower preferred stack
14185 boundary most likely misaligns the stack.  It is recommended that
14186 libraries that use callbacks always use the default setting.
14188 This extra alignment does consume extra stack space, and generally
14189 increases code size.  Code that is sensitive to stack space usage, such
14190 as embedded systems and operating system kernels, may want to reduce the
14191 preferred alignment to @option{-mpreferred-stack-boundary=2}.
14193 @item -mmmx
14194 @itemx -mno-mmx
14195 @itemx -msse
14196 @itemx -mno-sse
14197 @itemx -msse2
14198 @itemx -mno-sse2
14199 @itemx -msse3
14200 @itemx -mno-sse3
14201 @itemx -mssse3
14202 @itemx -mno-ssse3
14203 @itemx -msse4.1
14204 @need 800
14205 @itemx -mno-sse4.1
14206 @itemx -msse4.2
14207 @itemx -mno-sse4.2
14208 @itemx -msse4
14209 @itemx -mno-sse4
14210 @itemx -mavx
14211 @itemx -mno-avx
14212 @itemx -mavx2
14213 @itemx -mno-avx2
14214 @itemx -maes
14215 @itemx -mno-aes
14216 @itemx -mpclmul
14217 @need 800
14218 @itemx -mno-pclmul
14219 @itemx -mfsgsbase
14220 @itemx -mno-fsgsbase
14221 @itemx -mrdrnd
14222 @itemx -mno-rdrnd
14223 @itemx -mf16c
14224 @itemx -mno-f16c
14225 @itemx -mfma
14226 @itemx -mno-fma
14227 @itemx -msse4a
14228 @itemx -mno-sse4a
14229 @itemx -mfma4
14230 @need 800
14231 @itemx -mno-fma4
14232 @itemx -mxop
14233 @itemx -mno-xop
14234 @itemx -mlwp
14235 @itemx -mno-lwp
14236 @itemx -m3dnow
14237 @itemx -mno-3dnow
14238 @itemx -mpopcnt
14239 @itemx -mno-popcnt
14240 @itemx -mabm
14241 @itemx -mno-abm
14242 @itemx -mbmi
14243 @itemx -mbmi2
14244 @itemx -mno-bmi
14245 @itemx -mno-bmi2
14246 @itemx -mlzcnt
14247 @itemx -mno-lzcnt
14248 @itemx -mrtm
14249 @itemx -mtbm
14250 @itemx -mno-tbm
14251 @opindex mmmx
14252 @opindex mno-mmx
14253 @opindex msse
14254 @opindex mno-sse
14255 @opindex m3dnow
14256 @opindex mno-3dnow
14257 These switches enable or disable the use of instructions in the MMX, SSE,
14258 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
14259 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
14260 extended instruction sets.
14261 These extensions are also available as built-in functions: see
14262 @ref{X86 Built-in Functions}, for details of the functions enabled and
14263 disabled by these switches.
14265 To generate SSE/SSE2 instructions automatically from floating-point
14266 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
14268 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
14269 generates new AVX instructions or AVX equivalence for all SSEx instructions
14270 when needed.
14272 These options enable GCC to use these extended instructions in
14273 generated code, even without @option{-mfpmath=sse}.  Applications that
14274 perform run-time CPU detection must compile separate files for each
14275 supported architecture, using the appropriate flags.  In particular,
14276 the file containing the CPU detection code should be compiled without
14277 these options.
14279 @item -mcld
14280 @opindex mcld
14281 This option instructs GCC to emit a @code{cld} instruction in the prologue
14282 of functions that use string instructions.  String instructions depend on
14283 the DF flag to select between autoincrement or autodecrement mode.  While the
14284 ABI specifies the DF flag to be cleared on function entry, some operating
14285 systems violate this specification by not clearing the DF flag in their
14286 exception dispatchers.  The exception handler can be invoked with the DF flag
14287 set, which leads to wrong direction mode when string instructions are used.
14288 This option can be enabled by default on 32-bit x86 targets by configuring
14289 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
14290 instructions can be suppressed with the @option{-mno-cld} compiler option
14291 in this case.
14293 @item -mvzeroupper
14294 @opindex mvzeroupper
14295 This option instructs GCC to emit a @code{vzeroupper} instruction
14296 before a transfer of control flow out of the function to minimize
14297 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
14298 intrinsics.
14300 @item -mprefer-avx128
14301 @opindex mprefer-avx128
14302 This option instructs GCC to use 128-bit AVX instructions instead of
14303 256-bit AVX instructions in the auto-vectorizer.
14305 @item -mcx16
14306 @opindex mcx16
14307 This option enables GCC to generate @code{CMPXCHG16B} instructions.
14308 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
14309 (or oword) data types.  
14310 This is useful for high-resolution counters that can be updated
14311 by multiple processors (or cores).  This instruction is generated as part of
14312 atomic built-in functions: see @ref{__sync Builtins} or
14313 @ref{__atomic Builtins} for details.
14315 @item -msahf
14316 @opindex msahf
14317 This option enables generation of @code{SAHF} instructions in 64-bit code.
14318 Early Intel Pentium 4 CPUs with Intel 64 support,
14319 prior to the introduction of Pentium 4 G1 step in December 2005,
14320 lacked the @code{LAHF} and @code{SAHF} instructions
14321 which were supported by AMD64.
14322 These are load and store instructions, respectively, for certain status flags.
14323 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
14324 @code{drem}, and @code{remainder} built-in functions;
14325 see @ref{Other Builtins} for details.
14327 @item -mmovbe
14328 @opindex mmovbe
14329 This option enables use of the @code{movbe} instruction to implement
14330 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
14332 @item -mcrc32
14333 @opindex mcrc32
14334 This option enables built-in functions @code{__builtin_ia32_crc32qi},
14335 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
14336 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
14338 @item -mrecip
14339 @opindex mrecip
14340 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
14341 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
14342 with an additional Newton-Raphson step
14343 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
14344 (and their vectorized
14345 variants) for single-precision floating-point arguments.  These instructions
14346 are generated only when @option{-funsafe-math-optimizations} is enabled
14347 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
14348 Note that while the throughput of the sequence is higher than the throughput
14349 of the non-reciprocal instruction, the precision of the sequence can be
14350 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
14352 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
14353 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
14354 combination), and doesn't need @option{-mrecip}.
14356 Also note that GCC emits the above sequence with additional Newton-Raphson step
14357 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
14358 already with @option{-ffast-math} (or the above option combination), and
14359 doesn't need @option{-mrecip}.
14361 @item -mrecip=@var{opt}
14362 @opindex mrecip=opt
14363 This option controls which reciprocal estimate instructions
14364 may be used.  @var{opt} is a comma-separated list of options, which may
14365 be preceded by a @samp{!} to invert the option:
14367 @table @samp
14368 @item all
14369 Enable all estimate instructions.
14371 @item default
14372 Enable the default instructions, equivalent to @option{-mrecip}.
14374 @item none
14375 Disable all estimate instructions, equivalent to @option{-mno-recip}.
14377 @item div
14378 Enable the approximation for scalar division.
14380 @item vec-div
14381 Enable the approximation for vectorized division.
14383 @item sqrt
14384 Enable the approximation for scalar square root.
14386 @item vec-sqrt
14387 Enable the approximation for vectorized square root.
14388 @end table
14390 So, for example, @option{-mrecip=all,!sqrt} enables
14391 all of the reciprocal approximations, except for square root.
14393 @item -mveclibabi=@var{type}
14394 @opindex mveclibabi
14395 Specifies the ABI type to use for vectorizing intrinsics using an
14396 external library.  Supported values for @var{type} are @samp{svml} 
14397 for the Intel short
14398 vector math library and @samp{acml} for the AMD math core library.
14399 To use this option, both @option{-ftree-vectorize} and
14400 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
14401 ABI-compatible library must be specified at link time.
14403 GCC currently emits calls to @code{vmldExp2},
14404 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
14405 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
14406 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
14407 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
14408 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
14409 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
14410 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
14411 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
14412 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
14413 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
14414 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
14415 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
14416 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
14417 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
14418 when @option{-mveclibabi=acml} is used.  
14420 @item -mabi=@var{name}
14421 @opindex mabi
14422 Generate code for the specified calling convention.  Permissible values
14423 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
14424 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
14425 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
14426 You can control this behavior for a specific function by
14427 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
14428 @xref{Function Attributes}.
14430 @item -mtls-dialect=@var{type}
14431 @opindex mtls-dialect
14432 Generate code to access thread-local storage using the @samp{gnu} or
14433 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
14434 @samp{gnu2} is more efficient, but it may add compile- and run-time
14435 requirements that cannot be satisfied on all systems.
14437 @item -mpush-args
14438 @itemx -mno-push-args
14439 @opindex mpush-args
14440 @opindex mno-push-args
14441 Use PUSH operations to store outgoing parameters.  This method is shorter
14442 and usually equally fast as method using SUB/MOV operations and is enabled
14443 by default.  In some cases disabling it may improve performance because of
14444 improved scheduling and reduced dependencies.
14446 @item -maccumulate-outgoing-args
14447 @opindex maccumulate-outgoing-args
14448 If enabled, the maximum amount of space required for outgoing arguments is
14449 computed in the function prologue.  This is faster on most modern CPUs
14450 because of reduced dependencies, improved scheduling and reduced stack usage
14451 when the preferred stack boundary is not equal to 2.  The drawback is a notable
14452 increase in code size.  This switch implies @option{-mno-push-args}.
14454 @item -mthreads
14455 @opindex mthreads
14456 Support thread-safe exception handling on MinGW.  Programs that rely
14457 on thread-safe exception handling must compile and link all code with the
14458 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
14459 @code{-D_MT}; when linking, it links in a special thread helper library
14460 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
14462 @item -mno-align-stringops
14463 @opindex mno-align-stringops
14464 Do not align the destination of inlined string operations.  This switch reduces
14465 code size and improves performance in case the destination is already aligned,
14466 but GCC doesn't know about it.
14468 @item -minline-all-stringops
14469 @opindex minline-all-stringops
14470 By default GCC inlines string operations only when the destination is 
14471 known to be aligned to least a 4-byte boundary.  
14472 This enables more inlining and increases code
14473 size, but may improve performance of code that depends on fast
14474 @code{memcpy}, @code{strlen},
14475 and @code{memset} for short lengths.
14477 @item -minline-stringops-dynamically
14478 @opindex minline-stringops-dynamically
14479 For string operations of unknown size, use run-time checks with
14480 inline code for small blocks and a library call for large blocks.
14482 @item -mstringop-strategy=@var{alg}
14483 @opindex mstringop-strategy=@var{alg}
14484 Override the internal decision heuristic for the particular algorithm to use
14485 for inlining string operations.  The allowed values for @var{alg} are:
14487 @table @samp
14488 @item rep_byte
14489 @itemx rep_4byte
14490 @itemx rep_8byte
14491 Expand using i386 @code{rep} prefix of the specified size.
14493 @item byte_loop
14494 @itemx loop
14495 @itemx unrolled_loop
14496 Expand into an inline loop.
14498 @item libcall
14499 Always use a library call.
14500 @end table
14502 @item -momit-leaf-frame-pointer
14503 @opindex momit-leaf-frame-pointer
14504 Don't keep the frame pointer in a register for leaf functions.  This
14505 avoids the instructions to save, set up, and restore frame pointers and
14506 makes an extra register available in leaf functions.  The option
14507 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
14508 which might make debugging harder.
14510 @item -mtls-direct-seg-refs
14511 @itemx -mno-tls-direct-seg-refs
14512 @opindex mtls-direct-seg-refs
14513 Controls whether TLS variables may be accessed with offsets from the
14514 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
14515 or whether the thread base pointer must be added.  Whether or not this
14516 is valid depends on the operating system, and whether it maps the
14517 segment to cover the entire TLS area.
14519 For systems that use the GNU C Library, the default is on.
14521 @item -msse2avx
14522 @itemx -mno-sse2avx
14523 @opindex msse2avx
14524 Specify that the assembler should encode SSE instructions with VEX
14525 prefix.  The option @option{-mavx} turns this on by default.
14527 @item -mfentry
14528 @itemx -mno-fentry
14529 @opindex mfentry
14530 If profiling is active (@option{-pg}), put the profiling
14531 counter call before the prologue.
14532 Note: On x86 architectures the attribute @code{ms_hook_prologue}
14533 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
14535 @item -m8bit-idiv
14536 @itemx -mno-8bit-idiv
14537 @opindex 8bit-idiv
14538 On some processors, like Intel Atom, 8-bit unsigned integer divide is
14539 much faster than 32-bit/64-bit integer divide.  This option generates a
14540 run-time check.  If both dividend and divisor are within range of 0
14541 to 255, 8-bit unsigned integer divide is used instead of
14542 32-bit/64-bit integer divide.
14544 @item -mavx256-split-unaligned-load
14545 @itemx -mavx256-split-unaligned-store
14546 @opindex avx256-split-unaligned-load
14547 @opindex avx256-split-unaligned-store
14548 Split 32-byte AVX unaligned load and store.
14550 @end table
14552 These @samp{-m} switches are supported in addition to the above
14553 on x86-64 processors in 64-bit environments.
14555 @table @gcctabopt
14556 @item -m32
14557 @itemx -m64
14558 @itemx -mx32
14559 @opindex m32
14560 @opindex m64
14561 @opindex mx32
14562 Generate code for a 32-bit or 64-bit environment.
14563 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14564 to 32 bits, and
14565 generates code that runs on any i386 system.
14567 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14568 types to 64 bits, and generates code for the x86-64 architecture.
14569 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14570 and @option{-mdynamic-no-pic} options.
14572 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14573 to 32 bits, and
14574 generates code for the x86-64 architecture.
14576 @item -mno-red-zone
14577 @opindex mno-red-zone
14578 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
14579 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14580 stack pointer that is not modified by signal or interrupt handlers
14581 and therefore can be used for temporary data without adjusting the stack
14582 pointer.  The flag @option{-mno-red-zone} disables this red zone.
14584 @item -mcmodel=small
14585 @opindex mcmodel=small
14586 Generate code for the small code model: the program and its symbols must
14587 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
14588 Programs can be statically or dynamically linked.  This is the default
14589 code model.
14591 @item -mcmodel=kernel
14592 @opindex mcmodel=kernel
14593 Generate code for the kernel code model.  The kernel runs in the
14594 negative 2 GB of the address space.
14595 This model has to be used for Linux kernel code.
14597 @item -mcmodel=medium
14598 @opindex mcmodel=medium
14599 Generate code for the medium model: the program is linked in the lower 2
14600 GB of the address space.  Small symbols are also placed there.  Symbols
14601 with sizes larger than @option{-mlarge-data-threshold} are put into
14602 large data or BSS sections and can be located above 2GB.  Programs can
14603 be statically or dynamically linked.
14605 @item -mcmodel=large
14606 @opindex mcmodel=large
14607 Generate code for the large model.  This model makes no assumptions
14608 about addresses and sizes of sections.
14610 @item -maddress-mode=long
14611 @opindex maddress-mode=long
14612 Generate code for long address mode.  This is only supported for 64-bit
14613 and x32 environments.  It is the default address mode for 64-bit
14614 environments.
14616 @item -maddress-mode=short
14617 @opindex maddress-mode=short
14618 Generate code for short address mode.  This is only supported for 32-bit
14619 and x32 environments.  It is the default address mode for 32-bit and
14620 x32 environments.
14621 @end table
14623 @node i386 and x86-64 Windows Options
14624 @subsection i386 and x86-64 Windows Options
14625 @cindex i386 and x86-64 Windows Options
14627 These additional options are available for Microsoft Windows targets:
14629 @table @gcctabopt
14630 @item -mconsole
14631 @opindex mconsole
14632 This option
14633 specifies that a console application is to be generated, by
14634 instructing the linker to set the PE header subsystem type
14635 required for console applications.
14636 This option is available for Cygwin and MinGW targets and is
14637 enabled by default on those targets.
14639 @item -mdll
14640 @opindex mdll
14641 This option is available for Cygwin and MinGW targets.  It
14642 specifies that a DLL---a dynamic link library---is to be
14643 generated, enabling the selection of the required runtime
14644 startup object and entry point.
14646 @item -mnop-fun-dllimport
14647 @opindex mnop-fun-dllimport
14648 This option is available for Cygwin and MinGW targets.  It
14649 specifies that the @code{dllimport} attribute should be ignored.
14651 @item -mthread
14652 @opindex mthread
14653 This option is available for MinGW targets. It specifies
14654 that MinGW-specific thread support is to be used.
14656 @item -municode
14657 @opindex municode
14658 This option is available for MinGW-w64 targets.  It causes
14659 the @code{UNICODE} preprocessor macro to be predefined, and
14660 chooses Unicode-capable runtime startup code.
14662 @item -mwin32
14663 @opindex mwin32
14664 This option is available for Cygwin and MinGW targets.  It
14665 specifies that the typical Microsoft Windows predefined macros are to
14666 be set in the pre-processor, but does not influence the choice
14667 of runtime library/startup code.
14669 @item -mwindows
14670 @opindex mwindows
14671 This option is available for Cygwin and MinGW targets.  It
14672 specifies that a GUI application is to be generated by
14673 instructing the linker to set the PE header subsystem type
14674 appropriately.
14676 @item -fno-set-stack-executable
14677 @opindex fno-set-stack-executable
14678 This option is available for MinGW targets. It specifies that
14679 the executable flag for the stack used by nested functions isn't
14680 set. This is necessary for binaries running in kernel mode of
14681 Microsoft Windows, as there the User32 API, which is used to set executable
14682 privileges, isn't available.
14684 @item -fwritable-relocated-rdata
14685 @opindex fno-writable-relocated-rdata
14686 This option is available for MinGW and Cygwin targets.  It specifies
14687 that relocated-data in read-only section is put into .data
14688 section.  This is a necessary for older runtimes not supporting
14689 modification of .rdata sections for pseudo-relocation.
14691 @item -mpe-aligned-commons
14692 @opindex mpe-aligned-commons
14693 This option is available for Cygwin and MinGW targets.  It
14694 specifies that the GNU extension to the PE file format that
14695 permits the correct alignment of COMMON variables should be
14696 used when generating code.  It is enabled by default if
14697 GCC detects that the target assembler found during configuration
14698 supports the feature.
14699 @end table
14701 See also under @ref{i386 and x86-64 Options} for standard options.
14703 @node IA-64 Options
14704 @subsection IA-64 Options
14705 @cindex IA-64 Options
14707 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14709 @table @gcctabopt
14710 @item -mbig-endian
14711 @opindex mbig-endian
14712 Generate code for a big-endian target.  This is the default for HP-UX@.
14714 @item -mlittle-endian
14715 @opindex mlittle-endian
14716 Generate code for a little-endian target.  This is the default for AIX5
14717 and GNU/Linux.
14719 @item -mgnu-as
14720 @itemx -mno-gnu-as
14721 @opindex mgnu-as
14722 @opindex mno-gnu-as
14723 Generate (or don't) code for the GNU assembler.  This is the default.
14724 @c Also, this is the default if the configure option @option{--with-gnu-as}
14725 @c is used.
14727 @item -mgnu-ld
14728 @itemx -mno-gnu-ld
14729 @opindex mgnu-ld
14730 @opindex mno-gnu-ld
14731 Generate (or don't) code for the GNU linker.  This is the default.
14732 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14733 @c is used.
14735 @item -mno-pic
14736 @opindex mno-pic
14737 Generate code that does not use a global pointer register.  The result
14738 is not position independent code, and violates the IA-64 ABI@.
14740 @item -mvolatile-asm-stop
14741 @itemx -mno-volatile-asm-stop
14742 @opindex mvolatile-asm-stop
14743 @opindex mno-volatile-asm-stop
14744 Generate (or don't) a stop bit immediately before and after volatile asm
14745 statements.
14747 @item -mregister-names
14748 @itemx -mno-register-names
14749 @opindex mregister-names
14750 @opindex mno-register-names
14751 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14752 the stacked registers.  This may make assembler output more readable.
14754 @item -mno-sdata
14755 @itemx -msdata
14756 @opindex mno-sdata
14757 @opindex msdata
14758 Disable (or enable) optimizations that use the small data section.  This may
14759 be useful for working around optimizer bugs.
14761 @item -mconstant-gp
14762 @opindex mconstant-gp
14763 Generate code that uses a single constant global pointer value.  This is
14764 useful when compiling kernel code.
14766 @item -mauto-pic
14767 @opindex mauto-pic
14768 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14769 This is useful when compiling firmware code.
14771 @item -minline-float-divide-min-latency
14772 @opindex minline-float-divide-min-latency
14773 Generate code for inline divides of floating-point values
14774 using the minimum latency algorithm.
14776 @item -minline-float-divide-max-throughput
14777 @opindex minline-float-divide-max-throughput
14778 Generate code for inline divides of floating-point values
14779 using the maximum throughput algorithm.
14781 @item -mno-inline-float-divide
14782 @opindex mno-inline-float-divide
14783 Do not generate inline code for divides of floating-point values.
14785 @item -minline-int-divide-min-latency
14786 @opindex minline-int-divide-min-latency
14787 Generate code for inline divides of integer values
14788 using the minimum latency algorithm.
14790 @item -minline-int-divide-max-throughput
14791 @opindex minline-int-divide-max-throughput
14792 Generate code for inline divides of integer values
14793 using the maximum throughput algorithm.
14795 @item -mno-inline-int-divide
14796 @opindex mno-inline-int-divide
14797 Do not generate inline code for divides of integer values.
14799 @item -minline-sqrt-min-latency
14800 @opindex minline-sqrt-min-latency
14801 Generate code for inline square roots
14802 using the minimum latency algorithm.
14804 @item -minline-sqrt-max-throughput
14805 @opindex minline-sqrt-max-throughput
14806 Generate code for inline square roots
14807 using the maximum throughput algorithm.
14809 @item -mno-inline-sqrt
14810 @opindex mno-inline-sqrt
14811 Do not generate inline code for @code{sqrt}.
14813 @item -mfused-madd
14814 @itemx -mno-fused-madd
14815 @opindex mfused-madd
14816 @opindex mno-fused-madd
14817 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14818 instructions.  The default is to use these instructions.
14820 @item -mno-dwarf2-asm
14821 @itemx -mdwarf2-asm
14822 @opindex mno-dwarf2-asm
14823 @opindex mdwarf2-asm
14824 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14825 info.  This may be useful when not using the GNU assembler.
14827 @item -mearly-stop-bits
14828 @itemx -mno-early-stop-bits
14829 @opindex mearly-stop-bits
14830 @opindex mno-early-stop-bits
14831 Allow stop bits to be placed earlier than immediately preceding the
14832 instruction that triggered the stop bit.  This can improve instruction
14833 scheduling, but does not always do so.
14835 @item -mfixed-range=@var{register-range}
14836 @opindex mfixed-range
14837 Generate code treating the given register range as fixed registers.
14838 A fixed register is one that the register allocator cannot use.  This is
14839 useful when compiling kernel code.  A register range is specified as
14840 two registers separated by a dash.  Multiple register ranges can be
14841 specified separated by a comma.
14843 @item -mtls-size=@var{tls-size}
14844 @opindex mtls-size
14845 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14848 @item -mtune=@var{cpu-type}
14849 @opindex mtune
14850 Tune the instruction scheduling for a particular CPU, Valid values are
14851 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14852 and @samp{mckinley}.
14854 @item -milp32
14855 @itemx -mlp64
14856 @opindex milp32
14857 @opindex mlp64
14858 Generate code for a 32-bit or 64-bit environment.
14859 The 32-bit environment sets int, long and pointer to 32 bits.
14860 The 64-bit environment sets int to 32 bits and long and pointer
14861 to 64 bits.  These are HP-UX specific flags.
14863 @item -mno-sched-br-data-spec
14864 @itemx -msched-br-data-spec
14865 @opindex mno-sched-br-data-spec
14866 @opindex msched-br-data-spec
14867 (Dis/En)able data speculative scheduling before reload.
14868 This results in generation of @code{ld.a} instructions and
14869 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14870 The default is 'disable'.
14872 @item -msched-ar-data-spec
14873 @itemx -mno-sched-ar-data-spec
14874 @opindex msched-ar-data-spec
14875 @opindex mno-sched-ar-data-spec
14876 (En/Dis)able data speculative scheduling after reload.
14877 This results in generation of @code{ld.a} instructions and
14878 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14879 The default is 'enable'.
14881 @item -mno-sched-control-spec
14882 @itemx -msched-control-spec
14883 @opindex mno-sched-control-spec
14884 @opindex msched-control-spec
14885 (Dis/En)able control speculative scheduling.  This feature is
14886 available only during region scheduling (i.e.@: before reload).
14887 This results in generation of the @code{ld.s} instructions and
14888 the corresponding check instructions @code{chk.s}.
14889 The default is 'disable'.
14891 @item -msched-br-in-data-spec
14892 @itemx -mno-sched-br-in-data-spec
14893 @opindex msched-br-in-data-spec
14894 @opindex mno-sched-br-in-data-spec
14895 (En/Dis)able speculative scheduling of the instructions that
14896 are dependent on the data speculative loads before reload.
14897 This is effective only with @option{-msched-br-data-spec} enabled.
14898 The default is 'enable'.
14900 @item -msched-ar-in-data-spec
14901 @itemx -mno-sched-ar-in-data-spec
14902 @opindex msched-ar-in-data-spec
14903 @opindex mno-sched-ar-in-data-spec
14904 (En/Dis)able speculative scheduling of the instructions that
14905 are dependent on the data speculative loads after reload.
14906 This is effective only with @option{-msched-ar-data-spec} enabled.
14907 The default is 'enable'.
14909 @item -msched-in-control-spec
14910 @itemx -mno-sched-in-control-spec
14911 @opindex msched-in-control-spec
14912 @opindex mno-sched-in-control-spec
14913 (En/Dis)able speculative scheduling of the instructions that
14914 are dependent on the control speculative loads.
14915 This is effective only with @option{-msched-control-spec} enabled.
14916 The default is 'enable'.
14918 @item -mno-sched-prefer-non-data-spec-insns
14919 @itemx -msched-prefer-non-data-spec-insns
14920 @opindex mno-sched-prefer-non-data-spec-insns
14921 @opindex msched-prefer-non-data-spec-insns
14922 If enabled, data-speculative instructions are chosen for schedule
14923 only if there are no other choices at the moment.  This makes
14924 the use of the data speculation much more conservative.
14925 The default is 'disable'.
14927 @item -mno-sched-prefer-non-control-spec-insns
14928 @itemx -msched-prefer-non-control-spec-insns
14929 @opindex mno-sched-prefer-non-control-spec-insns
14930 @opindex msched-prefer-non-control-spec-insns
14931 If enabled, control-speculative instructions are chosen for schedule
14932 only if there are no other choices at the moment.  This makes
14933 the use of the control speculation much more conservative.
14934 The default is 'disable'.
14936 @item -mno-sched-count-spec-in-critical-path
14937 @itemx -msched-count-spec-in-critical-path
14938 @opindex mno-sched-count-spec-in-critical-path
14939 @opindex msched-count-spec-in-critical-path
14940 If enabled, speculative dependencies are considered during
14941 computation of the instructions priorities.  This makes the use of the
14942 speculation a bit more conservative.
14943 The default is 'disable'.
14945 @item -msched-spec-ldc
14946 @opindex msched-spec-ldc
14947 Use a simple data speculation check.  This option is on by default.
14949 @item -msched-control-spec-ldc
14950 @opindex msched-spec-ldc
14951 Use a simple check for control speculation.  This option is on by default.
14953 @item -msched-stop-bits-after-every-cycle
14954 @opindex msched-stop-bits-after-every-cycle
14955 Place a stop bit after every cycle when scheduling.  This option is on
14956 by default.
14958 @item -msched-fp-mem-deps-zero-cost
14959 @opindex msched-fp-mem-deps-zero-cost
14960 Assume that floating-point stores and loads are not likely to cause a conflict
14961 when placed into the same instruction group.  This option is disabled by
14962 default.
14964 @item -msel-sched-dont-check-control-spec
14965 @opindex msel-sched-dont-check-control-spec
14966 Generate checks for control speculation in selective scheduling.
14967 This flag is disabled by default.
14969 @item -msched-max-memory-insns=@var{max-insns}
14970 @opindex msched-max-memory-insns
14971 Limit on the number of memory insns per instruction group, giving lower
14972 priority to subsequent memory insns attempting to schedule in the same
14973 instruction group. Frequently useful to prevent cache bank conflicts.
14974 The default value is 1.
14976 @item -msched-max-memory-insns-hard-limit
14977 @opindex msched-max-memory-insns-hard-limit
14978 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14979 disallowing more than that number in an instruction group.
14980 Otherwise, the limit is ``soft'', meaning that non-memory operations
14981 are preferred when the limit is reached, but memory operations may still
14982 be scheduled.
14984 @end table
14986 @node LM32 Options
14987 @subsection LM32 Options
14988 @cindex LM32 options
14990 These @option{-m} options are defined for the LatticeMico32 architecture:
14992 @table @gcctabopt
14993 @item -mbarrel-shift-enabled
14994 @opindex mbarrel-shift-enabled
14995 Enable barrel-shift instructions.
14997 @item -mdivide-enabled
14998 @opindex mdivide-enabled
14999 Enable divide and modulus instructions.
15001 @item -mmultiply-enabled
15002 @opindex multiply-enabled
15003 Enable multiply instructions.
15005 @item -msign-extend-enabled
15006 @opindex msign-extend-enabled
15007 Enable sign extend instructions.
15009 @item -muser-enabled
15010 @opindex muser-enabled
15011 Enable user-defined instructions.
15013 @end table
15015 @node M32C Options
15016 @subsection M32C Options
15017 @cindex M32C options
15019 @table @gcctabopt
15020 @item -mcpu=@var{name}
15021 @opindex mcpu=
15022 Select the CPU for which code is generated.  @var{name} may be one of
15023 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
15024 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
15025 the M32C/80 series.
15027 @item -msim
15028 @opindex msim
15029 Specifies that the program will be run on the simulator.  This causes
15030 an alternate runtime library to be linked in which supports, for
15031 example, file I/O@.  You must not use this option when generating
15032 programs that will run on real hardware; you must provide your own
15033 runtime library for whatever I/O functions are needed.
15035 @item -memregs=@var{number}
15036 @opindex memregs=
15037 Specifies the number of memory-based pseudo-registers GCC uses
15038 during code generation.  These pseudo-registers are used like real
15039 registers, so there is a tradeoff between GCC's ability to fit the
15040 code into available registers, and the performance penalty of using
15041 memory instead of registers.  Note that all modules in a program must
15042 be compiled with the same value for this option.  Because of that, you
15043 must not use this option with GCC's default runtime libraries.
15045 @end table
15047 @node M32R/D Options
15048 @subsection M32R/D Options
15049 @cindex M32R/D options
15051 These @option{-m} options are defined for Renesas M32R/D architectures:
15053 @table @gcctabopt
15054 @item -m32r2
15055 @opindex m32r2
15056 Generate code for the M32R/2@.
15058 @item -m32rx
15059 @opindex m32rx
15060 Generate code for the M32R/X@.
15062 @item -m32r
15063 @opindex m32r
15064 Generate code for the M32R@.  This is the default.
15066 @item -mmodel=small
15067 @opindex mmodel=small
15068 Assume all objects live in the lower 16MB of memory (so that their addresses
15069 can be loaded with the @code{ld24} instruction), and assume all subroutines
15070 are reachable with the @code{bl} instruction.
15071 This is the default.
15073 The addressability of a particular object can be set with the
15074 @code{model} attribute.
15076 @item -mmodel=medium
15077 @opindex mmodel=medium
15078 Assume objects may be anywhere in the 32-bit address space (the compiler
15079 generates @code{seth/add3} instructions to load their addresses), and
15080 assume all subroutines are reachable with the @code{bl} instruction.
15082 @item -mmodel=large
15083 @opindex mmodel=large
15084 Assume objects may be anywhere in the 32-bit address space (the compiler
15085 generates @code{seth/add3} instructions to load their addresses), and
15086 assume subroutines may not be reachable with the @code{bl} instruction
15087 (the compiler generates the much slower @code{seth/add3/jl}
15088 instruction sequence).
15090 @item -msdata=none
15091 @opindex msdata=none
15092 Disable use of the small data area.  Variables are put into
15093 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
15094 @code{section} attribute has been specified).
15095 This is the default.
15097 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
15098 Objects may be explicitly put in the small data area with the
15099 @code{section} attribute using one of these sections.
15101 @item -msdata=sdata
15102 @opindex msdata=sdata
15103 Put small global and static data in the small data area, but do not
15104 generate special code to reference them.
15106 @item -msdata=use
15107 @opindex msdata=use
15108 Put small global and static data in the small data area, and generate
15109 special instructions to reference them.
15111 @item -G @var{num}
15112 @opindex G
15113 @cindex smaller data references
15114 Put global and static objects less than or equal to @var{num} bytes
15115 into the small data or BSS sections instead of the normal data or BSS
15116 sections.  The default value of @var{num} is 8.
15117 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
15118 for this option to have any effect.
15120 All modules should be compiled with the same @option{-G @var{num}} value.
15121 Compiling with different values of @var{num} may or may not work; if it
15122 doesn't the linker gives an error message---incorrect code is not
15123 generated.
15125 @item -mdebug
15126 @opindex mdebug
15127 Makes the M32R-specific code in the compiler display some statistics
15128 that might help in debugging programs.
15130 @item -malign-loops
15131 @opindex malign-loops
15132 Align all loops to a 32-byte boundary.
15134 @item -mno-align-loops
15135 @opindex mno-align-loops
15136 Do not enforce a 32-byte alignment for loops.  This is the default.
15138 @item -missue-rate=@var{number}
15139 @opindex missue-rate=@var{number}
15140 Issue @var{number} instructions per cycle.  @var{number} can only be 1
15141 or 2.
15143 @item -mbranch-cost=@var{number}
15144 @opindex mbranch-cost=@var{number}
15145 @var{number} can only be 1 or 2.  If it is 1 then branches are
15146 preferred over conditional code, if it is 2, then the opposite applies.
15148 @item -mflush-trap=@var{number}
15149 @opindex mflush-trap=@var{number}
15150 Specifies the trap number to use to flush the cache.  The default is
15151 12.  Valid numbers are between 0 and 15 inclusive.
15153 @item -mno-flush-trap
15154 @opindex mno-flush-trap
15155 Specifies that the cache cannot be flushed by using a trap.
15157 @item -mflush-func=@var{name}
15158 @opindex mflush-func=@var{name}
15159 Specifies the name of the operating system function to call to flush
15160 the cache.  The default is @emph{_flush_cache}, but a function call
15161 is only used if a trap is not available.
15163 @item -mno-flush-func
15164 @opindex mno-flush-func
15165 Indicates that there is no OS function for flushing the cache.
15167 @end table
15169 @node M680x0 Options
15170 @subsection M680x0 Options
15171 @cindex M680x0 options
15173 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
15174 The default settings depend on which architecture was selected when
15175 the compiler was configured; the defaults for the most common choices
15176 are given below.
15178 @table @gcctabopt
15179 @item -march=@var{arch}
15180 @opindex march
15181 Generate code for a specific M680x0 or ColdFire instruction set
15182 architecture.  Permissible values of @var{arch} for M680x0
15183 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
15184 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
15185 architectures are selected according to Freescale's ISA classification
15186 and the permissible values are: @samp{isaa}, @samp{isaaplus},
15187 @samp{isab} and @samp{isac}.
15189 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
15190 code for a ColdFire target.  The @var{arch} in this macro is one of the
15191 @option{-march} arguments given above.
15193 When used together, @option{-march} and @option{-mtune} select code
15194 that runs on a family of similar processors but that is optimized
15195 for a particular microarchitecture.
15197 @item -mcpu=@var{cpu}
15198 @opindex mcpu
15199 Generate code for a specific M680x0 or ColdFire processor.
15200 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
15201 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
15202 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
15203 below, which also classifies the CPUs into families:
15205 @multitable @columnfractions 0.20 0.80
15206 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
15207 @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}
15208 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
15209 @item @samp{5206e} @tab @samp{5206e}
15210 @item @samp{5208} @tab @samp{5207} @samp{5208}
15211 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
15212 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
15213 @item @samp{5216} @tab @samp{5214} @samp{5216}
15214 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
15215 @item @samp{5225} @tab @samp{5224} @samp{5225}
15216 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
15217 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
15218 @item @samp{5249} @tab @samp{5249}
15219 @item @samp{5250} @tab @samp{5250}
15220 @item @samp{5271} @tab @samp{5270} @samp{5271}
15221 @item @samp{5272} @tab @samp{5272}
15222 @item @samp{5275} @tab @samp{5274} @samp{5275}
15223 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
15224 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
15225 @item @samp{5307} @tab @samp{5307}
15226 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
15227 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
15228 @item @samp{5407} @tab @samp{5407}
15229 @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}
15230 @end multitable
15232 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
15233 @var{arch} is compatible with @var{cpu}.  Other combinations of
15234 @option{-mcpu} and @option{-march} are rejected.
15236 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
15237 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
15238 where the value of @var{family} is given by the table above.
15240 @item -mtune=@var{tune}
15241 @opindex mtune
15242 Tune the code for a particular microarchitecture within the
15243 constraints set by @option{-march} and @option{-mcpu}.
15244 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
15245 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
15246 and @samp{cpu32}.  The ColdFire microarchitectures
15247 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
15249 You can also use @option{-mtune=68020-40} for code that needs
15250 to run relatively well on 68020, 68030 and 68040 targets.
15251 @option{-mtune=68020-60} is similar but includes 68060 targets
15252 as well.  These two options select the same tuning decisions as
15253 @option{-m68020-40} and @option{-m68020-60} respectively.
15255 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
15256 when tuning for 680x0 architecture @var{arch}.  It also defines
15257 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
15258 option is used.  If GCC is tuning for a range of architectures,
15259 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
15260 it defines the macros for every architecture in the range.
15262 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
15263 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
15264 of the arguments given above.
15266 @item -m68000
15267 @itemx -mc68000
15268 @opindex m68000
15269 @opindex mc68000
15270 Generate output for a 68000.  This is the default
15271 when the compiler is configured for 68000-based systems.
15272 It is equivalent to @option{-march=68000}.
15274 Use this option for microcontrollers with a 68000 or EC000 core,
15275 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
15277 @item -m68010
15278 @opindex m68010
15279 Generate output for a 68010.  This is the default
15280 when the compiler is configured for 68010-based systems.
15281 It is equivalent to @option{-march=68010}.
15283 @item -m68020
15284 @itemx -mc68020
15285 @opindex m68020
15286 @opindex mc68020
15287 Generate output for a 68020.  This is the default
15288 when the compiler is configured for 68020-based systems.
15289 It is equivalent to @option{-march=68020}.
15291 @item -m68030
15292 @opindex m68030
15293 Generate output for a 68030.  This is the default when the compiler is
15294 configured for 68030-based systems.  It is equivalent to
15295 @option{-march=68030}.
15297 @item -m68040
15298 @opindex m68040
15299 Generate output for a 68040.  This is the default when the compiler is
15300 configured for 68040-based systems.  It is equivalent to
15301 @option{-march=68040}.
15303 This option inhibits the use of 68881/68882 instructions that have to be
15304 emulated by software on the 68040.  Use this option if your 68040 does not
15305 have code to emulate those instructions.
15307 @item -m68060
15308 @opindex m68060
15309 Generate output for a 68060.  This is the default when the compiler is
15310 configured for 68060-based systems.  It is equivalent to
15311 @option{-march=68060}.
15313 This option inhibits the use of 68020 and 68881/68882 instructions that
15314 have to be emulated by software on the 68060.  Use this option if your 68060
15315 does not have code to emulate those instructions.
15317 @item -mcpu32
15318 @opindex mcpu32
15319 Generate output for a CPU32.  This is the default
15320 when the compiler is configured for CPU32-based systems.
15321 It is equivalent to @option{-march=cpu32}.
15323 Use this option for microcontrollers with a
15324 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
15325 68336, 68340, 68341, 68349 and 68360.
15327 @item -m5200
15328 @opindex m5200
15329 Generate output for a 520X ColdFire CPU@.  This is the default
15330 when the compiler is configured for 520X-based systems.
15331 It is equivalent to @option{-mcpu=5206}, and is now deprecated
15332 in favor of that option.
15334 Use this option for microcontroller with a 5200 core, including
15335 the MCF5202, MCF5203, MCF5204 and MCF5206.
15337 @item -m5206e
15338 @opindex m5206e
15339 Generate output for a 5206e ColdFire CPU@.  The option is now
15340 deprecated in favor of the equivalent @option{-mcpu=5206e}.
15342 @item -m528x
15343 @opindex m528x
15344 Generate output for a member of the ColdFire 528X family.
15345 The option is now deprecated in favor of the equivalent
15346 @option{-mcpu=528x}.
15348 @item -m5307
15349 @opindex m5307
15350 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
15351 in favor of the equivalent @option{-mcpu=5307}.
15353 @item -m5407
15354 @opindex m5407
15355 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
15356 in favor of the equivalent @option{-mcpu=5407}.
15358 @item -mcfv4e
15359 @opindex mcfv4e
15360 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
15361 This includes use of hardware floating-point instructions.
15362 The option is equivalent to @option{-mcpu=547x}, and is now
15363 deprecated in favor of that option.
15365 @item -m68020-40
15366 @opindex m68020-40
15367 Generate output for a 68040, without using any of the new instructions.
15368 This results in code that can run relatively efficiently on either a
15369 68020/68881 or a 68030 or a 68040.  The generated code does use the
15370 68881 instructions that are emulated on the 68040.
15372 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
15374 @item -m68020-60
15375 @opindex m68020-60
15376 Generate output for a 68060, without using any of the new instructions.
15377 This results in code that can run relatively efficiently on either a
15378 68020/68881 or a 68030 or a 68040.  The generated code does use the
15379 68881 instructions that are emulated on the 68060.
15381 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
15383 @item -mhard-float
15384 @itemx -m68881
15385 @opindex mhard-float
15386 @opindex m68881
15387 Generate floating-point instructions.  This is the default for 68020
15388 and above, and for ColdFire devices that have an FPU@.  It defines the
15389 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
15390 on ColdFire targets.
15392 @item -msoft-float
15393 @opindex msoft-float
15394 Do not generate floating-point instructions; use library calls instead.
15395 This is the default for 68000, 68010, and 68832 targets.  It is also
15396 the default for ColdFire devices that have no FPU.
15398 @item -mdiv
15399 @itemx -mno-div
15400 @opindex mdiv
15401 @opindex mno-div
15402 Generate (do not generate) ColdFire hardware divide and remainder
15403 instructions.  If @option{-march} is used without @option{-mcpu},
15404 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
15405 architectures.  Otherwise, the default is taken from the target CPU
15406 (either the default CPU, or the one specified by @option{-mcpu}).  For
15407 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
15408 @option{-mcpu=5206e}.
15410 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
15412 @item -mshort
15413 @opindex mshort
15414 Consider type @code{int} to be 16 bits wide, like @code{short int}.
15415 Additionally, parameters passed on the stack are also aligned to a
15416 16-bit boundary even on targets whose API mandates promotion to 32-bit.
15418 @item -mno-short
15419 @opindex mno-short
15420 Do not consider type @code{int} to be 16 bits wide.  This is the default.
15422 @item -mnobitfield
15423 @itemx -mno-bitfield
15424 @opindex mnobitfield
15425 @opindex mno-bitfield
15426 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
15427 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
15429 @item -mbitfield
15430 @opindex mbitfield
15431 Do use the bit-field instructions.  The @option{-m68020} option implies
15432 @option{-mbitfield}.  This is the default if you use a configuration
15433 designed for a 68020.
15435 @item -mrtd
15436 @opindex mrtd
15437 Use a different function-calling convention, in which functions
15438 that take a fixed number of arguments return with the @code{rtd}
15439 instruction, which pops their arguments while returning.  This
15440 saves one instruction in the caller since there is no need to pop
15441 the arguments there.
15443 This calling convention is incompatible with the one normally
15444 used on Unix, so you cannot use it if you need to call libraries
15445 compiled with the Unix compiler.
15447 Also, you must provide function prototypes for all functions that
15448 take variable numbers of arguments (including @code{printf});
15449 otherwise incorrect code is generated for calls to those
15450 functions.
15452 In addition, seriously incorrect code results if you call a
15453 function with too many arguments.  (Normally, extra arguments are
15454 harmlessly ignored.)
15456 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
15457 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
15459 @item -mno-rtd
15460 @opindex mno-rtd
15461 Do not use the calling conventions selected by @option{-mrtd}.
15462 This is the default.
15464 @item -malign-int
15465 @itemx -mno-align-int
15466 @opindex malign-int
15467 @opindex mno-align-int
15468 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
15469 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
15470 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
15471 Aligning variables on 32-bit boundaries produces code that runs somewhat
15472 faster on processors with 32-bit busses at the expense of more memory.
15474 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
15475 aligns structures containing the above types differently than
15476 most published application binary interface specifications for the m68k.
15478 @item -mpcrel
15479 @opindex mpcrel
15480 Use the pc-relative addressing mode of the 68000 directly, instead of
15481 using a global offset table.  At present, this option implies @option{-fpic},
15482 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
15483 not presently supported with @option{-mpcrel}, though this could be supported for
15484 68020 and higher processors.
15486 @item -mno-strict-align
15487 @itemx -mstrict-align
15488 @opindex mno-strict-align
15489 @opindex mstrict-align
15490 Do not (do) assume that unaligned memory references are handled by
15491 the system.
15493 @item -msep-data
15494 Generate code that allows the data segment to be located in a different
15495 area of memory from the text segment.  This allows for execute-in-place in
15496 an environment without virtual memory management.  This option implies
15497 @option{-fPIC}.
15499 @item -mno-sep-data
15500 Generate code that assumes that the data segment follows the text segment.
15501 This is the default.
15503 @item -mid-shared-library
15504 Generate code that supports shared libraries via the library ID method.
15505 This allows for execute-in-place and shared libraries in an environment
15506 without virtual memory management.  This option implies @option{-fPIC}.
15508 @item -mno-id-shared-library
15509 Generate code that doesn't assume ID-based shared libraries are being used.
15510 This is the default.
15512 @item -mshared-library-id=n
15513 Specifies the identification number of the ID-based shared library being
15514 compiled.  Specifying a value of 0 generates more compact code; specifying
15515 other values forces the allocation of that number to the current
15516 library, but is no more space- or time-efficient than omitting this option.
15518 @item -mxgot
15519 @itemx -mno-xgot
15520 @opindex mxgot
15521 @opindex mno-xgot
15522 When generating position-independent code for ColdFire, generate code
15523 that works if the GOT has more than 8192 entries.  This code is
15524 larger and slower than code generated without this option.  On M680x0
15525 processors, this option is not needed; @option{-fPIC} suffices.
15527 GCC normally uses a single instruction to load values from the GOT@.
15528 While this is relatively efficient, it only works if the GOT
15529 is smaller than about 64k.  Anything larger causes the linker
15530 to report an error such as:
15532 @cindex relocation truncated to fit (ColdFire)
15533 @smallexample
15534 relocation truncated to fit: R_68K_GOT16O foobar
15535 @end smallexample
15537 If this happens, you should recompile your code with @option{-mxgot}.
15538 It should then work with very large GOTs.  However, code generated with
15539 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
15540 the value of a global symbol.
15542 Note that some linkers, including newer versions of the GNU linker,
15543 can create multiple GOTs and sort GOT entries.  If you have such a linker,
15544 you should only need to use @option{-mxgot} when compiling a single
15545 object file that accesses more than 8192 GOT entries.  Very few do.
15547 These options have no effect unless GCC is generating
15548 position-independent code.
15550 @end table
15552 @node MCore Options
15553 @subsection MCore Options
15554 @cindex MCore options
15556 These are the @samp{-m} options defined for the Motorola M*Core
15557 processors.
15559 @table @gcctabopt
15561 @item -mhardlit
15562 @itemx -mno-hardlit
15563 @opindex mhardlit
15564 @opindex mno-hardlit
15565 Inline constants into the code stream if it can be done in two
15566 instructions or less.
15568 @item -mdiv
15569 @itemx -mno-div
15570 @opindex mdiv
15571 @opindex mno-div
15572 Use the divide instruction.  (Enabled by default).
15574 @item -mrelax-immediate
15575 @itemx -mno-relax-immediate
15576 @opindex mrelax-immediate
15577 @opindex mno-relax-immediate
15578 Allow arbitrary-sized immediates in bit operations.
15580 @item -mwide-bitfields
15581 @itemx -mno-wide-bitfields
15582 @opindex mwide-bitfields
15583 @opindex mno-wide-bitfields
15584 Always treat bit-fields as @code{int}-sized.
15586 @item -m4byte-functions
15587 @itemx -mno-4byte-functions
15588 @opindex m4byte-functions
15589 @opindex mno-4byte-functions
15590 Force all functions to be aligned to a 4-byte boundary.
15592 @item -mcallgraph-data
15593 @itemx -mno-callgraph-data
15594 @opindex mcallgraph-data
15595 @opindex mno-callgraph-data
15596 Emit callgraph information.
15598 @item -mslow-bytes
15599 @itemx -mno-slow-bytes
15600 @opindex mslow-bytes
15601 @opindex mno-slow-bytes
15602 Prefer word access when reading byte quantities.
15604 @item -mlittle-endian
15605 @itemx -mbig-endian
15606 @opindex mlittle-endian
15607 @opindex mbig-endian
15608 Generate code for a little-endian target.
15610 @item -m210
15611 @itemx -m340
15612 @opindex m210
15613 @opindex m340
15614 Generate code for the 210 processor.
15616 @item -mno-lsim
15617 @opindex mno-lsim
15618 Assume that runtime support has been provided and so omit the
15619 simulator library (@file{libsim.a)} from the linker command line.
15621 @item -mstack-increment=@var{size}
15622 @opindex mstack-increment
15623 Set the maximum amount for a single stack increment operation.  Large
15624 values can increase the speed of programs that contain functions
15625 that need a large amount of stack space, but they can also trigger a
15626 segmentation fault if the stack is extended too much.  The default
15627 value is 0x1000.
15629 @end table
15631 @node MeP Options
15632 @subsection MeP Options
15633 @cindex MeP options
15635 @table @gcctabopt
15637 @item -mabsdiff
15638 @opindex mabsdiff
15639 Enables the @code{abs} instruction, which is the absolute difference
15640 between two registers.
15642 @item -mall-opts
15643 @opindex mall-opts
15644 Enables all the optional instructions---average, multiply, divide, bit
15645 operations, leading zero, absolute difference, min/max, clip, and
15646 saturation.
15649 @item -maverage
15650 @opindex maverage
15651 Enables the @code{ave} instruction, which computes the average of two
15652 registers.
15654 @item -mbased=@var{n}
15655 @opindex mbased=
15656 Variables of size @var{n} bytes or smaller are placed in the
15657 @code{.based} section by default.  Based variables use the @code{$tp}
15658 register as a base register, and there is a 128-byte limit to the
15659 @code{.based} section.
15661 @item -mbitops
15662 @opindex mbitops
15663 Enables the bit operation instructions---bit test (@code{btstm}), set
15664 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15665 test-and-set (@code{tas}).
15667 @item -mc=@var{name}
15668 @opindex mc=
15669 Selects which section constant data is placed in.  @var{name} may
15670 be @code{tiny}, @code{near}, or @code{far}.
15672 @item -mclip
15673 @opindex mclip
15674 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15675 useful unless you also provide @code{-mminmax}.
15677 @item -mconfig=@var{name}
15678 @opindex mconfig=
15679 Selects one of the built-in core configurations.  Each MeP chip has
15680 one or more modules in it; each module has a core CPU and a variety of
15681 coprocessors, optional instructions, and peripherals.  The
15682 @code{MeP-Integrator} tool, not part of GCC, provides these
15683 configurations through this option; using this option is the same as
15684 using all the corresponding command-line options.  The default
15685 configuration is @code{default}.
15687 @item -mcop
15688 @opindex mcop
15689 Enables the coprocessor instructions.  By default, this is a 32-bit
15690 coprocessor.  Note that the coprocessor is normally enabled via the
15691 @code{-mconfig=} option.
15693 @item -mcop32
15694 @opindex mcop32
15695 Enables the 32-bit coprocessor's instructions.
15697 @item -mcop64
15698 @opindex mcop64
15699 Enables the 64-bit coprocessor's instructions.
15701 @item -mivc2
15702 @opindex mivc2
15703 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15705 @item -mdc
15706 @opindex mdc
15707 Causes constant variables to be placed in the @code{.near} section.
15709 @item -mdiv
15710 @opindex mdiv
15711 Enables the @code{div} and @code{divu} instructions.
15713 @item -meb
15714 @opindex meb
15715 Generate big-endian code.
15717 @item -mel
15718 @opindex mel
15719 Generate little-endian code.
15721 @item -mio-volatile
15722 @opindex mio-volatile
15723 Tells the compiler that any variable marked with the @code{io}
15724 attribute is to be considered volatile.
15726 @item -ml
15727 @opindex ml
15728 Causes variables to be assigned to the @code{.far} section by default.
15730 @item -mleadz
15731 @opindex mleadz
15732 Enables the @code{leadz} (leading zero) instruction.
15734 @item -mm
15735 @opindex mm
15736 Causes variables to be assigned to the @code{.near} section by default.
15738 @item -mminmax
15739 @opindex mminmax
15740 Enables the @code{min} and @code{max} instructions.
15742 @item -mmult
15743 @opindex mmult
15744 Enables the multiplication and multiply-accumulate instructions.
15746 @item -mno-opts
15747 @opindex mno-opts
15748 Disables all the optional instructions enabled by @code{-mall-opts}.
15750 @item -mrepeat
15751 @opindex mrepeat
15752 Enables the @code{repeat} and @code{erepeat} instructions, used for
15753 low-overhead looping.
15755 @item -ms
15756 @opindex ms
15757 Causes all variables to default to the @code{.tiny} section.  Note
15758 that there is a 65536-byte limit to this section.  Accesses to these
15759 variables use the @code{%gp} base register.
15761 @item -msatur
15762 @opindex msatur
15763 Enables the saturation instructions.  Note that the compiler does not
15764 currently generate these itself, but this option is included for
15765 compatibility with other tools, like @code{as}.
15767 @item -msdram
15768 @opindex msdram
15769 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15771 @item -msim
15772 @opindex msim
15773 Link the simulator runtime libraries.
15775 @item -msimnovec
15776 @opindex msimnovec
15777 Link the simulator runtime libraries, excluding built-in support
15778 for reset and exception vectors and tables.
15780 @item -mtf
15781 @opindex mtf
15782 Causes all functions to default to the @code{.far} section.  Without
15783 this option, functions default to the @code{.near} section.
15785 @item -mtiny=@var{n}
15786 @opindex mtiny=
15787 Variables that are @var{n} bytes or smaller are allocated to the
15788 @code{.tiny} section.  These variables use the @code{$gp} base
15789 register.  The default for this option is 4, but note that there's a
15790 65536-byte limit to the @code{.tiny} section.
15792 @end table
15794 @node MicroBlaze Options
15795 @subsection MicroBlaze Options
15796 @cindex MicroBlaze Options
15798 @table @gcctabopt
15800 @item -msoft-float
15801 @opindex msoft-float
15802 Use software emulation for floating point (default).
15804 @item -mhard-float
15805 @opindex mhard-float
15806 Use hardware floating-point instructions.
15808 @item -mmemcpy
15809 @opindex mmemcpy
15810 Do not optimize block moves, use @code{memcpy}.
15812 @item -mno-clearbss
15813 @opindex mno-clearbss
15814 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15816 @item -mcpu=@var{cpu-type}
15817 @opindex mcpu=
15818 Use features of, and schedule code for, the given CPU.
15819 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15820 where @var{X} is a major version, @var{YY} is the minor version, and
15821 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15822 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15824 @item -mxl-soft-mul
15825 @opindex mxl-soft-mul
15826 Use software multiply emulation (default).
15828 @item -mxl-soft-div
15829 @opindex mxl-soft-div
15830 Use software emulation for divides (default).
15832 @item -mxl-barrel-shift
15833 @opindex mxl-barrel-shift
15834 Use the hardware barrel shifter.
15836 @item -mxl-pattern-compare
15837 @opindex mxl-pattern-compare
15838 Use pattern compare instructions.
15840 @item -msmall-divides
15841 @opindex msmall-divides
15842 Use table lookup optimization for small signed integer divisions.
15844 @item -mxl-stack-check
15845 @opindex mxl-stack-check
15846 This option is deprecated.  Use @option{-fstack-check} instead.
15848 @item -mxl-gp-opt
15849 @opindex mxl-gp-opt
15850 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15852 @item -mxl-multiply-high
15853 @opindex mxl-multiply-high
15854 Use multiply high instructions for high part of 32x32 multiply.
15856 @item -mxl-float-convert
15857 @opindex mxl-float-convert
15858 Use hardware floating-point conversion instructions.
15860 @item -mxl-float-sqrt
15861 @opindex mxl-float-sqrt
15862 Use hardware floating-point square root instruction.
15864 @item -mbig-endian
15865 @opindex mbig-endian
15866 Generate code for a big-endian target.
15868 @item -mlittle-endian
15869 @opindex mlittle-endian
15870 Generate code for a little-endian target.
15872 @item -mxl-reorder
15873 @opindex mxl-reorder
15874 Use reorder instructions (swap and byte reversed load/store).
15876 @item -mxl-mode-@var{app-model}
15877 Select application model @var{app-model}.  Valid models are
15878 @table @samp
15879 @item executable
15880 normal executable (default), uses startup code @file{crt0.o}.
15882 @item xmdstub
15883 for use with Xilinx Microprocessor Debugger (XMD) based
15884 software intrusive debug agent called xmdstub. This uses startup file
15885 @file{crt1.o} and sets the start address of the program to 0x800.
15887 @item bootstrap
15888 for applications that are loaded using a bootloader.
15889 This model uses startup file @file{crt2.o} which does not contain a processor
15890 reset vector handler. This is suitable for transferring control on a
15891 processor reset to the bootloader rather than the application.
15893 @item novectors
15894 for applications that do not require any of the
15895 MicroBlaze vectors. This option may be useful for applications running
15896 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15897 @end table
15899 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15900 @option{-mxl-mode-@var{app-model}}.
15902 @end table
15904 @node MIPS Options
15905 @subsection MIPS Options
15906 @cindex MIPS options
15908 @table @gcctabopt
15910 @item -EB
15911 @opindex EB
15912 Generate big-endian code.
15914 @item -EL
15915 @opindex EL
15916 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15917 configurations.
15919 @item -march=@var{arch}
15920 @opindex march
15921 Generate code that runs on @var{arch}, which can be the name of a
15922 generic MIPS ISA, or the name of a particular processor.
15923 The ISA names are:
15924 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15925 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15926 The processor names are:
15927 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15928 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15929 @samp{5kc}, @samp{5kf},
15930 @samp{20kc},
15931 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15932 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15933 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
15934 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15935 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15936 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15937 @samp{m4k},
15938 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15939 @samp{orion},
15940 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15941 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
15942 @samp{rm7000}, @samp{rm9000},
15943 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15944 @samp{sb1},
15945 @samp{sr71000},
15946 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15947 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15948 @samp{xlr} and @samp{xlp}.
15949 The special value @samp{from-abi} selects the
15950 most compatible architecture for the selected ABI (that is,
15951 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15953 The native Linux/GNU toolchain also supports the value @samp{native},
15954 which selects the best architecture option for the host processor.
15955 @option{-march=native} has no effect if GCC does not recognize
15956 the processor.
15958 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15959 (for example, @option{-march=r2k}).  Prefixes are optional, and
15960 @samp{vr} may be written @samp{r}.
15962 Names of the form @samp{@var{n}f2_1} refer to processors with
15963 FPUs clocked at half the rate of the core, names of the form
15964 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15965 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15966 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15967 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15968 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15969 accepted as synonyms for @samp{@var{n}f1_1}.
15971 GCC defines two macros based on the value of this option.  The first
15972 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15973 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15974 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15975 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15976 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15978 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15979 above.  In other words, it has the full prefix and does not
15980 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15981 the macro names the resolved architecture (either @samp{"mips1"} or
15982 @samp{"mips3"}).  It names the default architecture when no
15983 @option{-march} option is given.
15985 @item -mtune=@var{arch}
15986 @opindex mtune
15987 Optimize for @var{arch}.  Among other things, this option controls
15988 the way instructions are scheduled, and the perceived cost of arithmetic
15989 operations.  The list of @var{arch} values is the same as for
15990 @option{-march}.
15992 When this option is not used, GCC optimizes for the processor
15993 specified by @option{-march}.  By using @option{-march} and
15994 @option{-mtune} together, it is possible to generate code that
15995 runs on a family of processors, but optimize the code for one
15996 particular member of that family.
15998 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
15999 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
16000 @option{-march} ones described above.
16002 @item -mips1
16003 @opindex mips1
16004 Equivalent to @option{-march=mips1}.
16006 @item -mips2
16007 @opindex mips2
16008 Equivalent to @option{-march=mips2}.
16010 @item -mips3
16011 @opindex mips3
16012 Equivalent to @option{-march=mips3}.
16014 @item -mips4
16015 @opindex mips4
16016 Equivalent to @option{-march=mips4}.
16018 @item -mips32
16019 @opindex mips32
16020 Equivalent to @option{-march=mips32}.
16022 @item -mips32r2
16023 @opindex mips32r2
16024 Equivalent to @option{-march=mips32r2}.
16026 @item -mips64
16027 @opindex mips64
16028 Equivalent to @option{-march=mips64}.
16030 @item -mips64r2
16031 @opindex mips64r2
16032 Equivalent to @option{-march=mips64r2}.
16034 @item -mips16
16035 @itemx -mno-mips16
16036 @opindex mips16
16037 @opindex mno-mips16
16038 Generate (do not generate) MIPS16 code.  If GCC is targeting a
16039 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
16041 MIPS16 code generation can also be controlled on a per-function basis
16042 by means of @code{mips16} and @code{nomips16} attributes.
16043 @xref{Function Attributes}, for more information.
16045 @item -mflip-mips16
16046 @opindex mflip-mips16
16047 Generate MIPS16 code on alternating functions.  This option is provided
16048 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
16049 not intended for ordinary use in compiling user code.
16051 @item -minterlink-mips16
16052 @itemx -mno-interlink-mips16
16053 @opindex minterlink-mips16
16054 @opindex mno-interlink-mips16
16055 Require (do not require) that non-MIPS16 code be link-compatible with
16056 MIPS16 code.
16058 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
16059 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
16060 therefore disables direct jumps unless GCC knows that the target of the
16061 jump is not MIPS16.
16063 @item -mabi=32
16064 @itemx -mabi=o64
16065 @itemx -mabi=n32
16066 @itemx -mabi=64
16067 @itemx -mabi=eabi
16068 @opindex mabi=32
16069 @opindex mabi=o64
16070 @opindex mabi=n32
16071 @opindex mabi=64
16072 @opindex mabi=eabi
16073 Generate code for the given ABI@.
16075 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
16076 generates 64-bit code when you select a 64-bit architecture, but you
16077 can use @option{-mgp32} to get 32-bit code instead.
16079 For information about the O64 ABI, see
16080 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
16082 GCC supports a variant of the o32 ABI in which floating-point registers
16083 are 64 rather than 32 bits wide.  You can select this combination with
16084 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
16085 and @code{mfhc1} instructions and is therefore only supported for
16086 MIPS32R2 processors.
16088 The register assignments for arguments and return values remain the
16089 same, but each scalar value is passed in a single 64-bit register
16090 rather than a pair of 32-bit registers.  For example, scalar
16091 floating-point values are returned in @samp{$f0} only, not a
16092 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
16093 remains the same, but all 64 bits are saved.
16095 @item -mabicalls
16096 @itemx -mno-abicalls
16097 @opindex mabicalls
16098 @opindex mno-abicalls
16099 Generate (do not generate) code that is suitable for SVR4-style
16100 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
16101 systems.
16103 @item -mshared
16104 @itemx -mno-shared
16105 Generate (do not generate) code that is fully position-independent,
16106 and that can therefore be linked into shared libraries.  This option
16107 only affects @option{-mabicalls}.
16109 All @option{-mabicalls} code has traditionally been position-independent,
16110 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
16111 as an extension, the GNU toolchain allows executables to use absolute
16112 accesses for locally-binding symbols.  It can also use shorter GP
16113 initialization sequences and generate direct calls to locally-defined
16114 functions.  This mode is selected by @option{-mno-shared}.
16116 @option{-mno-shared} depends on binutils 2.16 or higher and generates
16117 objects that can only be linked by the GNU linker.  However, the option
16118 does not affect the ABI of the final executable; it only affects the ABI
16119 of relocatable objects.  Using @option{-mno-shared} generally makes
16120 executables both smaller and quicker.
16122 @option{-mshared} is the default.
16124 @item -mplt
16125 @itemx -mno-plt
16126 @opindex mplt
16127 @opindex mno-plt
16128 Assume (do not assume) that the static and dynamic linkers
16129 support PLTs and copy relocations.  This option only affects
16130 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
16131 has no effect without @option{-msym32}.
16133 You can make @option{-mplt} the default by configuring
16134 GCC with @option{--with-mips-plt}.  The default is
16135 @option{-mno-plt} otherwise.
16137 @item -mxgot
16138 @itemx -mno-xgot
16139 @opindex mxgot
16140 @opindex mno-xgot
16141 Lift (do not lift) the usual restrictions on the size of the global
16142 offset table.
16144 GCC normally uses a single instruction to load values from the GOT@.
16145 While this is relatively efficient, it only works if the GOT
16146 is smaller than about 64k.  Anything larger causes the linker
16147 to report an error such as:
16149 @cindex relocation truncated to fit (MIPS)
16150 @smallexample
16151 relocation truncated to fit: R_MIPS_GOT16 foobar
16152 @end smallexample
16154 If this happens, you should recompile your code with @option{-mxgot}.
16155 This works with very large GOTs, although the code is also
16156 less efficient, since it takes three instructions to fetch the
16157 value of a global symbol.
16159 Note that some linkers can create multiple GOTs.  If you have such a
16160 linker, you should only need to use @option{-mxgot} when a single object
16161 file accesses more than 64k's worth of GOT entries.  Very few do.
16163 These options have no effect unless GCC is generating position
16164 independent code.
16166 @item -mgp32
16167 @opindex mgp32
16168 Assume that general-purpose registers are 32 bits wide.
16170 @item -mgp64
16171 @opindex mgp64
16172 Assume that general-purpose registers are 64 bits wide.
16174 @item -mfp32
16175 @opindex mfp32
16176 Assume that floating-point registers are 32 bits wide.
16178 @item -mfp64
16179 @opindex mfp64
16180 Assume that floating-point registers are 64 bits wide.
16182 @item -mhard-float
16183 @opindex mhard-float
16184 Use floating-point coprocessor instructions.
16186 @item -msoft-float
16187 @opindex msoft-float
16188 Do not use floating-point coprocessor instructions.  Implement
16189 floating-point calculations using library calls instead.
16191 @item -mno-float
16192 @opindex mno-float
16193 Equivalent to @option{-msoft-float}, but additionally asserts that the
16194 program being compiled does not perform any floating-point operations.
16195 This option is presently supported only by some bare-metal MIPS
16196 configurations, where it may select a special set of libraries
16197 that lack all floating-point support (including, for example, the
16198 floating-point @code{printf} formats).  
16199 If code compiled with @code{-mno-float} accidentally contains
16200 floating-point operations, it is likely to suffer a link-time
16201 or run-time failure.
16203 @item -msingle-float
16204 @opindex msingle-float
16205 Assume that the floating-point coprocessor only supports single-precision
16206 operations.
16208 @item -mdouble-float
16209 @opindex mdouble-float
16210 Assume that the floating-point coprocessor supports double-precision
16211 operations.  This is the default.
16213 @item -mllsc
16214 @itemx -mno-llsc
16215 @opindex mllsc
16216 @opindex mno-llsc
16217 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
16218 implement atomic memory built-in functions.  When neither option is
16219 specified, GCC uses the instructions if the target architecture
16220 supports them.
16222 @option{-mllsc} is useful if the runtime environment can emulate the
16223 instructions and @option{-mno-llsc} can be useful when compiling for
16224 nonstandard ISAs.  You can make either option the default by
16225 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
16226 respectively.  @option{--with-llsc} is the default for some
16227 configurations; see the installation documentation for details.
16229 @item -mdsp
16230 @itemx -mno-dsp
16231 @opindex mdsp
16232 @opindex mno-dsp
16233 Use (do not use) revision 1 of the MIPS DSP ASE@.
16234 @xref{MIPS DSP Built-in Functions}.  This option defines the
16235 preprocessor macro @samp{__mips_dsp}.  It also defines
16236 @samp{__mips_dsp_rev} to 1.
16238 @item -mdspr2
16239 @itemx -mno-dspr2
16240 @opindex mdspr2
16241 @opindex mno-dspr2
16242 Use (do not use) revision 2 of the MIPS DSP ASE@.
16243 @xref{MIPS DSP Built-in Functions}.  This option defines the
16244 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
16245 It also defines @samp{__mips_dsp_rev} to 2.
16247 @item -msmartmips
16248 @itemx -mno-smartmips
16249 @opindex msmartmips
16250 @opindex mno-smartmips
16251 Use (do not use) the MIPS SmartMIPS ASE.
16253 @item -mpaired-single
16254 @itemx -mno-paired-single
16255 @opindex mpaired-single
16256 @opindex mno-paired-single
16257 Use (do not use) paired-single floating-point instructions.
16258 @xref{MIPS Paired-Single Support}.  This option requires
16259 hardware floating-point support to be enabled.
16261 @item -mdmx
16262 @itemx -mno-mdmx
16263 @opindex mdmx
16264 @opindex mno-mdmx
16265 Use (do not use) MIPS Digital Media Extension instructions.
16266 This option can only be used when generating 64-bit code and requires
16267 hardware floating-point support to be enabled.
16269 @item -mips3d
16270 @itemx -mno-mips3d
16271 @opindex mips3d
16272 @opindex mno-mips3d
16273 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
16274 The option @option{-mips3d} implies @option{-mpaired-single}.
16276 @item -mmt
16277 @itemx -mno-mt
16278 @opindex mmt
16279 @opindex mno-mt
16280 Use (do not use) MT Multithreading instructions.
16282 @item -mmcu
16283 @itemx -mno-mcu
16284 @opindex mmcu
16285 @opindex mno-mcu
16286 Use (do not use) the MIPS MCU ASE instructions.
16288 @item -mlong64
16289 @opindex mlong64
16290 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
16291 an explanation of the default and the way that the pointer size is
16292 determined.
16294 @item -mlong32
16295 @opindex mlong32
16296 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
16298 The default size of @code{int}s, @code{long}s and pointers depends on
16299 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
16300 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
16301 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
16302 or the same size as integer registers, whichever is smaller.
16304 @item -msym32
16305 @itemx -mno-sym32
16306 @opindex msym32
16307 @opindex mno-sym32
16308 Assume (do not assume) that all symbols have 32-bit values, regardless
16309 of the selected ABI@.  This option is useful in combination with
16310 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
16311 to generate shorter and faster references to symbolic addresses.
16313 @item -G @var{num}
16314 @opindex G
16315 Put definitions of externally-visible data in a small data section
16316 if that data is no bigger than @var{num} bytes.  GCC can then generate
16317 more efficient accesses to the data; see @option{-mgpopt} for details.
16319 The default @option{-G} option depends on the configuration.
16321 @item -mlocal-sdata
16322 @itemx -mno-local-sdata
16323 @opindex mlocal-sdata
16324 @opindex mno-local-sdata
16325 Extend (do not extend) the @option{-G} behavior to local data too,
16326 such as to static variables in C@.  @option{-mlocal-sdata} is the
16327 default for all configurations.
16329 If the linker complains that an application is using too much small data,
16330 you might want to try rebuilding the less performance-critical parts with
16331 @option{-mno-local-sdata}.  You might also want to build large
16332 libraries with @option{-mno-local-sdata}, so that the libraries leave
16333 more room for the main program.
16335 @item -mextern-sdata
16336 @itemx -mno-extern-sdata
16337 @opindex mextern-sdata
16338 @opindex mno-extern-sdata
16339 Assume (do not assume) that externally-defined data is in
16340 a small data section if the size of that data is within the @option{-G} limit.
16341 @option{-mextern-sdata} is the default for all configurations.
16343 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
16344 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
16345 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
16346 is placed in a small data section.  If @var{Var} is defined by another
16347 module, you must either compile that module with a high-enough
16348 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
16349 definition.  If @var{Var} is common, you must link the application
16350 with a high-enough @option{-G} setting.
16352 The easiest way of satisfying these restrictions is to compile
16353 and link every module with the same @option{-G} option.  However,
16354 you may wish to build a library that supports several different
16355 small data limits.  You can do this by compiling the library with
16356 the highest supported @option{-G} setting and additionally using
16357 @option{-mno-extern-sdata} to stop the library from making assumptions
16358 about externally-defined data.
16360 @item -mgpopt
16361 @itemx -mno-gpopt
16362 @opindex mgpopt
16363 @opindex mno-gpopt
16364 Use (do not use) GP-relative accesses for symbols that are known to be
16365 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
16366 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
16367 configurations.
16369 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
16370 might not hold the value of @code{_gp}.  For example, if the code is
16371 part of a library that might be used in a boot monitor, programs that
16372 call boot monitor routines pass an unknown value in @code{$gp}.
16373 (In such situations, the boot monitor itself is usually compiled
16374 with @option{-G0}.)
16376 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
16377 @option{-mno-extern-sdata}.
16379 @item -membedded-data
16380 @itemx -mno-embedded-data
16381 @opindex membedded-data
16382 @opindex mno-embedded-data
16383 Allocate variables to the read-only data section first if possible, then
16384 next in the small data section if possible, otherwise in data.  This gives
16385 slightly slower code than the default, but reduces the amount of RAM required
16386 when executing, and thus may be preferred for some embedded systems.
16388 @item -muninit-const-in-rodata
16389 @itemx -mno-uninit-const-in-rodata
16390 @opindex muninit-const-in-rodata
16391 @opindex mno-uninit-const-in-rodata
16392 Put uninitialized @code{const} variables in the read-only data section.
16393 This option is only meaningful in conjunction with @option{-membedded-data}.
16395 @item -mcode-readable=@var{setting}
16396 @opindex mcode-readable
16397 Specify whether GCC may generate code that reads from executable sections.
16398 There are three possible settings:
16400 @table @gcctabopt
16401 @item -mcode-readable=yes
16402 Instructions may freely access executable sections.  This is the
16403 default setting.
16405 @item -mcode-readable=pcrel
16406 MIPS16 PC-relative load instructions can access executable sections,
16407 but other instructions must not do so.  This option is useful on 4KSc
16408 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
16409 It is also useful on processors that can be configured to have a dual
16410 instruction/data SRAM interface and that, like the M4K, automatically
16411 redirect PC-relative loads to the instruction RAM.
16413 @item -mcode-readable=no
16414 Instructions must not access executable sections.  This option can be
16415 useful on targets that are configured to have a dual instruction/data
16416 SRAM interface but that (unlike the M4K) do not automatically redirect
16417 PC-relative loads to the instruction RAM.
16418 @end table
16420 @item -msplit-addresses
16421 @itemx -mno-split-addresses
16422 @opindex msplit-addresses
16423 @opindex mno-split-addresses
16424 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
16425 relocation operators.  This option has been superseded by
16426 @option{-mexplicit-relocs} but is retained for backwards compatibility.
16428 @item -mexplicit-relocs
16429 @itemx -mno-explicit-relocs
16430 @opindex mexplicit-relocs
16431 @opindex mno-explicit-relocs
16432 Use (do not use) assembler relocation operators when dealing with symbolic
16433 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
16434 is to use assembler macros instead.
16436 @option{-mexplicit-relocs} is the default if GCC was configured
16437 to use an assembler that supports relocation operators.
16439 @item -mcheck-zero-division
16440 @itemx -mno-check-zero-division
16441 @opindex mcheck-zero-division
16442 @opindex mno-check-zero-division
16443 Trap (do not trap) on integer division by zero.
16445 The default is @option{-mcheck-zero-division}.
16447 @item -mdivide-traps
16448 @itemx -mdivide-breaks
16449 @opindex mdivide-traps
16450 @opindex mdivide-breaks
16451 MIPS systems check for division by zero by generating either a
16452 conditional trap or a break instruction.  Using traps results in
16453 smaller code, but is only supported on MIPS II and later.  Also, some
16454 versions of the Linux kernel have a bug that prevents trap from
16455 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
16456 allow conditional traps on architectures that support them and
16457 @option{-mdivide-breaks} to force the use of breaks.
16459 The default is usually @option{-mdivide-traps}, but this can be
16460 overridden at configure time using @option{--with-divide=breaks}.
16461 Divide-by-zero checks can be completely disabled using
16462 @option{-mno-check-zero-division}.
16464 @item -mmemcpy
16465 @itemx -mno-memcpy
16466 @opindex mmemcpy
16467 @opindex mno-memcpy
16468 Force (do not force) the use of @code{memcpy()} for non-trivial block
16469 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
16470 most constant-sized copies.
16472 @item -mlong-calls
16473 @itemx -mno-long-calls
16474 @opindex mlong-calls
16475 @opindex mno-long-calls
16476 Disable (do not disable) use of the @code{jal} instruction.  Calling
16477 functions using @code{jal} is more efficient but requires the caller
16478 and callee to be in the same 256 megabyte segment.
16480 This option has no effect on abicalls code.  The default is
16481 @option{-mno-long-calls}.
16483 @item -mmad
16484 @itemx -mno-mad
16485 @opindex mmad
16486 @opindex mno-mad
16487 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
16488 instructions, as provided by the R4650 ISA@.
16490 @item -mfused-madd
16491 @itemx -mno-fused-madd
16492 @opindex mfused-madd
16493 @opindex mno-fused-madd
16494 Enable (disable) use of the floating-point multiply-accumulate
16495 instructions, when they are available.  The default is
16496 @option{-mfused-madd}.
16498 On the R8000 CPU when multiply-accumulate instructions are used,
16499 the intermediate product is calculated to infinite precision
16500 and is not subject to the FCSR Flush to Zero bit.  This may be
16501 undesirable in some circumstances.  On other processors the result
16502 is numerically identical to the equivalent computation using
16503 separate multiply, add, subtract and negate instructions.
16505 @item -nocpp
16506 @opindex nocpp
16507 Tell the MIPS assembler to not run its preprocessor over user
16508 assembler files (with a @samp{.s} suffix) when assembling them.
16510 @item -mfix-24k
16511 @item -mno-fix-24k
16512 @opindex mfix-24k
16513 @opindex mno-fix-24k
16514 Work around the 24K E48 (lost data on stores during refill) errata.
16515 The workarounds are implemented by the assembler rather than by GCC@.
16517 @item -mfix-r4000
16518 @itemx -mno-fix-r4000
16519 @opindex mfix-r4000
16520 @opindex mno-fix-r4000
16521 Work around certain R4000 CPU errata:
16522 @itemize @minus
16523 @item
16524 A double-word or a variable shift may give an incorrect result if executed
16525 immediately after starting an integer division.
16526 @item
16527 A double-word or a variable shift may give an incorrect result if executed
16528 while an integer multiplication is in progress.
16529 @item
16530 An integer division may give an incorrect result if started in a delay slot
16531 of a taken branch or a jump.
16532 @end itemize
16534 @item -mfix-r4400
16535 @itemx -mno-fix-r4400
16536 @opindex mfix-r4400
16537 @opindex mno-fix-r4400
16538 Work around certain R4400 CPU errata:
16539 @itemize @minus
16540 @item
16541 A double-word or a variable shift may give an incorrect result if executed
16542 immediately after starting an integer division.
16543 @end itemize
16545 @item -mfix-r10000
16546 @itemx -mno-fix-r10000
16547 @opindex mfix-r10000
16548 @opindex mno-fix-r10000
16549 Work around certain R10000 errata:
16550 @itemize @minus
16551 @item
16552 @code{ll}/@code{sc} sequences may not behave atomically on revisions
16553 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
16554 @end itemize
16556 This option can only be used if the target architecture supports
16557 branch-likely instructions.  @option{-mfix-r10000} is the default when
16558 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
16559 otherwise.
16561 @item -mfix-vr4120
16562 @itemx -mno-fix-vr4120
16563 @opindex mfix-vr4120
16564 Work around certain VR4120 errata:
16565 @itemize @minus
16566 @item
16567 @code{dmultu} does not always produce the correct result.
16568 @item
16569 @code{div} and @code{ddiv} do not always produce the correct result if one
16570 of the operands is negative.
16571 @end itemize
16572 The workarounds for the division errata rely on special functions in
16573 @file{libgcc.a}.  At present, these functions are only provided by
16574 the @code{mips64vr*-elf} configurations.
16576 Other VR4120 errata require a NOP to be inserted between certain pairs of
16577 instructions.  These errata are handled by the assembler, not by GCC itself.
16579 @item -mfix-vr4130
16580 @opindex mfix-vr4130
16581 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
16582 workarounds are implemented by the assembler rather than by GCC,
16583 although GCC avoids using @code{mflo} and @code{mfhi} if the
16584 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16585 instructions are available instead.
16587 @item -mfix-sb1
16588 @itemx -mno-fix-sb1
16589 @opindex mfix-sb1
16590 Work around certain SB-1 CPU core errata.
16591 (This flag currently works around the SB-1 revision 2
16592 ``F1'' and ``F2'' floating-point errata.)
16594 @item -mr10k-cache-barrier=@var{setting}
16595 @opindex mr10k-cache-barrier
16596 Specify whether GCC should insert cache barriers to avoid the
16597 side-effects of speculation on R10K processors.
16599 In common with many processors, the R10K tries to predict the outcome
16600 of a conditional branch and speculatively executes instructions from
16601 the ``taken'' branch.  It later aborts these instructions if the
16602 predicted outcome is wrong.  However, on the R10K, even aborted
16603 instructions can have side effects.
16605 This problem only affects kernel stores and, depending on the system,
16606 kernel loads.  As an example, a speculatively-executed store may load
16607 the target memory into cache and mark the cache line as dirty, even if
16608 the store itself is later aborted.  If a DMA operation writes to the
16609 same area of memory before the ``dirty'' line is flushed, the cached
16610 data overwrites the DMA-ed data.  See the R10K processor manual
16611 for a full description, including other potential problems.
16613 One workaround is to insert cache barrier instructions before every memory
16614 access that might be speculatively executed and that might have side
16615 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
16616 controls GCC's implementation of this workaround.  It assumes that
16617 aborted accesses to any byte in the following regions does not have
16618 side effects:
16620 @enumerate
16621 @item
16622 the memory occupied by the current function's stack frame;
16624 @item
16625 the memory occupied by an incoming stack argument;
16627 @item
16628 the memory occupied by an object with a link-time-constant address.
16629 @end enumerate
16631 It is the kernel's responsibility to ensure that speculative
16632 accesses to these regions are indeed safe.
16634 If the input program contains a function declaration such as:
16636 @smallexample
16637 void foo (void);
16638 @end smallexample
16640 then the implementation of @code{foo} must allow @code{j foo} and
16641 @code{jal foo} to be executed speculatively.  GCC honors this
16642 restriction for functions it compiles itself.  It expects non-GCC
16643 functions (such as hand-written assembly code) to do the same.
16645 The option has three forms:
16647 @table @gcctabopt
16648 @item -mr10k-cache-barrier=load-store
16649 Insert a cache barrier before a load or store that might be
16650 speculatively executed and that might have side effects even
16651 if aborted.
16653 @item -mr10k-cache-barrier=store
16654 Insert a cache barrier before a store that might be speculatively
16655 executed and that might have side effects even if aborted.
16657 @item -mr10k-cache-barrier=none
16658 Disable the insertion of cache barriers.  This is the default setting.
16659 @end table
16661 @item -mflush-func=@var{func}
16662 @itemx -mno-flush-func
16663 @opindex mflush-func
16664 Specifies the function to call to flush the I and D caches, or to not
16665 call any such function.  If called, the function must take the same
16666 arguments as the common @code{_flush_func()}, that is, the address of the
16667 memory range for which the cache is being flushed, the size of the
16668 memory range, and the number 3 (to flush both caches).  The default
16669 depends on the target GCC was configured for, but commonly is either
16670 @samp{_flush_func} or @samp{__cpu_flush}.
16672 @item mbranch-cost=@var{num}
16673 @opindex mbranch-cost
16674 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16675 This cost is only a heuristic and is not guaranteed to produce
16676 consistent results across releases.  A zero cost redundantly selects
16677 the default, which is based on the @option{-mtune} setting.
16679 @item -mbranch-likely
16680 @itemx -mno-branch-likely
16681 @opindex mbranch-likely
16682 @opindex mno-branch-likely
16683 Enable or disable use of Branch Likely instructions, regardless of the
16684 default for the selected architecture.  By default, Branch Likely
16685 instructions may be generated if they are supported by the selected
16686 architecture.  An exception is for the MIPS32 and MIPS64 architectures
16687 and processors that implement those architectures; for those, Branch
16688 Likely instructions are not be generated by default because the MIPS32
16689 and MIPS64 architectures specifically deprecate their use.
16691 @item -mfp-exceptions
16692 @itemx -mno-fp-exceptions
16693 @opindex mfp-exceptions
16694 Specifies whether FP exceptions are enabled.  This affects how
16695 FP instructions are scheduled for some processors.
16696 The default is that FP exceptions are
16697 enabled.
16699 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16700 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16701 FP pipe.
16703 @item -mvr4130-align
16704 @itemx -mno-vr4130-align
16705 @opindex mvr4130-align
16706 The VR4130 pipeline is two-way superscalar, but can only issue two
16707 instructions together if the first one is 8-byte aligned.  When this
16708 option is enabled, GCC aligns pairs of instructions that it
16709 thinks should execute in parallel.
16711 This option only has an effect when optimizing for the VR4130.
16712 It normally makes code faster, but at the expense of making it bigger.
16713 It is enabled by default at optimization level @option{-O3}.
16715 @item -msynci
16716 @itemx -mno-synci
16717 @opindex msynci
16718 Enable (disable) generation of @code{synci} instructions on
16719 architectures that support it.  The @code{synci} instructions (if
16720 enabled) are generated when @code{__builtin___clear_cache()} is
16721 compiled.
16723 This option defaults to @code{-mno-synci}, but the default can be
16724 overridden by configuring with @code{--with-synci}.
16726 When compiling code for single processor systems, it is generally safe
16727 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16728 does not invalidate the instruction caches on all cores and may lead
16729 to undefined behavior.
16731 @item -mrelax-pic-calls
16732 @itemx -mno-relax-pic-calls
16733 @opindex mrelax-pic-calls
16734 Try to turn PIC calls that are normally dispatched via register
16735 @code{$25} into direct calls.  This is only possible if the linker can
16736 resolve the destination at link-time and if the destination is within
16737 range for a direct call.
16739 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16740 an assembler and a linker that support the @code{.reloc} assembly
16741 directive and @code{-mexplicit-relocs} is in effect.  With
16742 @code{-mno-explicit-relocs}, this optimization can be performed by the
16743 assembler and the linker alone without help from the compiler.
16745 @item -mmcount-ra-address
16746 @itemx -mno-mcount-ra-address
16747 @opindex mmcount-ra-address
16748 @opindex mno-mcount-ra-address
16749 Emit (do not emit) code that allows @code{_mcount} to modify the
16750 calling function's return address.  When enabled, this option extends
16751 the usual @code{_mcount} interface with a new @var{ra-address}
16752 parameter, which has type @code{intptr_t *} and is passed in register
16753 @code{$12}.  @code{_mcount} can then modify the return address by
16754 doing both of the following:
16755 @itemize
16756 @item
16757 Returning the new address in register @code{$31}.
16758 @item
16759 Storing the new address in @code{*@var{ra-address}},
16760 if @var{ra-address} is nonnull.
16761 @end itemize
16763 The default is @option{-mno-mcount-ra-address}.
16765 @end table
16767 @node MMIX Options
16768 @subsection MMIX Options
16769 @cindex MMIX Options
16771 These options are defined for the MMIX:
16773 @table @gcctabopt
16774 @item -mlibfuncs
16775 @itemx -mno-libfuncs
16776 @opindex mlibfuncs
16777 @opindex mno-libfuncs
16778 Specify that intrinsic library functions are being compiled, passing all
16779 values in registers, no matter the size.
16781 @item -mepsilon
16782 @itemx -mno-epsilon
16783 @opindex mepsilon
16784 @opindex mno-epsilon
16785 Generate floating-point comparison instructions that compare with respect
16786 to the @code{rE} epsilon register.
16788 @item -mabi=mmixware
16789 @itemx -mabi=gnu
16790 @opindex mabi=mmixware
16791 @opindex mabi=gnu
16792 Generate code that passes function parameters and return values that (in
16793 the called function) are seen as registers @code{$0} and up, as opposed to
16794 the GNU ABI which uses global registers @code{$231} and up.
16796 @item -mzero-extend
16797 @itemx -mno-zero-extend
16798 @opindex mzero-extend
16799 @opindex mno-zero-extend
16800 When reading data from memory in sizes shorter than 64 bits, use (do not
16801 use) zero-extending load instructions by default, rather than
16802 sign-extending ones.
16804 @item -mknuthdiv
16805 @itemx -mno-knuthdiv
16806 @opindex mknuthdiv
16807 @opindex mno-knuthdiv
16808 Make the result of a division yielding a remainder have the same sign as
16809 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16810 remainder follows the sign of the dividend.  Both methods are
16811 arithmetically valid, the latter being almost exclusively used.
16813 @item -mtoplevel-symbols
16814 @itemx -mno-toplevel-symbols
16815 @opindex mtoplevel-symbols
16816 @opindex mno-toplevel-symbols
16817 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16818 code can be used with the @code{PREFIX} assembly directive.
16820 @item -melf
16821 @opindex melf
16822 Generate an executable in the ELF format, rather than the default
16823 @samp{mmo} format used by the @command{mmix} simulator.
16825 @item -mbranch-predict
16826 @itemx -mno-branch-predict
16827 @opindex mbranch-predict
16828 @opindex mno-branch-predict
16829 Use (do not use) the probable-branch instructions, when static branch
16830 prediction indicates a probable branch.
16832 @item -mbase-addresses
16833 @itemx -mno-base-addresses
16834 @opindex mbase-addresses
16835 @opindex mno-base-addresses
16836 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16837 base address automatically generates a request (handled by the assembler
16838 and the linker) for a constant to be set up in a global register.  The
16839 register is used for one or more base address requests within the range 0
16840 to 255 from the value held in the register.  The generally leads to short
16841 and fast code, but the number of different data items that can be
16842 addressed is limited.  This means that a program that uses lots of static
16843 data may require @option{-mno-base-addresses}.
16845 @item -msingle-exit
16846 @itemx -mno-single-exit
16847 @opindex msingle-exit
16848 @opindex mno-single-exit
16849 Force (do not force) generated code to have a single exit point in each
16850 function.
16851 @end table
16853 @node MN10300 Options
16854 @subsection MN10300 Options
16855 @cindex MN10300 options
16857 These @option{-m} options are defined for Matsushita MN10300 architectures:
16859 @table @gcctabopt
16860 @item -mmult-bug
16861 @opindex mmult-bug
16862 Generate code to avoid bugs in the multiply instructions for the MN10300
16863 processors.  This is the default.
16865 @item -mno-mult-bug
16866 @opindex mno-mult-bug
16867 Do not generate code to avoid bugs in the multiply instructions for the
16868 MN10300 processors.
16870 @item -mam33
16871 @opindex mam33
16872 Generate code using features specific to the AM33 processor.
16874 @item -mno-am33
16875 @opindex mno-am33
16876 Do not generate code using features specific to the AM33 processor.  This
16877 is the default.
16879 @item -mam33-2
16880 @opindex mam33-2
16881 Generate code using features specific to the AM33/2.0 processor.
16883 @item -mam34
16884 @opindex mam34
16885 Generate code using features specific to the AM34 processor.
16887 @item -mtune=@var{cpu-type}
16888 @opindex mtune
16889 Use the timing characteristics of the indicated CPU type when
16890 scheduling instructions.  This does not change the targeted processor
16891 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16892 @samp{am33-2} or @samp{am34}.
16894 @item -mreturn-pointer-on-d0
16895 @opindex mreturn-pointer-on-d0
16896 When generating a function that returns a pointer, return the pointer
16897 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16898 only in @code{a0}, and attempts to call such functions without a prototype
16899 result in errors.  Note that this option is on by default; use
16900 @option{-mno-return-pointer-on-d0} to disable it.
16902 @item -mno-crt0
16903 @opindex mno-crt0
16904 Do not link in the C run-time initialization object file.
16906 @item -mrelax
16907 @opindex mrelax
16908 Indicate to the linker that it should perform a relaxation optimization pass
16909 to shorten branches, calls and absolute memory addresses.  This option only
16910 has an effect when used on the command line for the final link step.
16912 This option makes symbolic debugging impossible.
16914 @item -mliw
16915 @opindex mliw
16916 Allow the compiler to generate @emph{Long Instruction Word}
16917 instructions if the target is the @samp{AM33} or later.  This is the
16918 default.  This option defines the preprocessor macro @samp{__LIW__}.
16920 @item -mnoliw
16921 @opindex mnoliw
16922 Do not allow the compiler to generate @emph{Long Instruction Word}
16923 instructions.  This option defines the preprocessor macro
16924 @samp{__NO_LIW__}.
16926 @item -msetlb
16927 @opindex msetlb
16928 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16929 instructions if the target is the @samp{AM33} or later.  This is the
16930 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16932 @item -mnosetlb
16933 @opindex mnosetlb
16934 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16935 instructions.  This option defines the preprocessor macro
16936 @samp{__NO_SETLB__}.
16938 @end table
16940 @node Moxie Options
16941 @subsection Moxie Options
16942 @cindex Moxie Options
16944 @table @gcctabopt
16946 @item -meb
16947 @opindex meb
16948 Generate big-endian code.  This is the default for @samp{moxie-*-*}
16949 configurations.
16951 @item -mel
16952 @opindex mel
16953 Generate little-endian code.
16955 @item -mno-crt0
16956 @opindex mno-crt0
16957 Do not link in the C run-time initialization object file.
16959 @end table
16961 @node PDP-11 Options
16962 @subsection PDP-11 Options
16963 @cindex PDP-11 Options
16965 These options are defined for the PDP-11:
16967 @table @gcctabopt
16968 @item -mfpu
16969 @opindex mfpu
16970 Use hardware FPP floating point.  This is the default.  (FIS floating
16971 point on the PDP-11/40 is not supported.)
16973 @item -msoft-float
16974 @opindex msoft-float
16975 Do not use hardware floating point.
16977 @item -mac0
16978 @opindex mac0
16979 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16981 @item -mno-ac0
16982 @opindex mno-ac0
16983 Return floating-point results in memory.  This is the default.
16985 @item -m40
16986 @opindex m40
16987 Generate code for a PDP-11/40.
16989 @item -m45
16990 @opindex m45
16991 Generate code for a PDP-11/45.  This is the default.
16993 @item -m10
16994 @opindex m10
16995 Generate code for a PDP-11/10.
16997 @item -mbcopy-builtin
16998 @opindex mbcopy-builtin
16999 Use inline @code{movmemhi} patterns for copying memory.  This is the
17000 default.
17002 @item -mbcopy
17003 @opindex mbcopy
17004 Do not use inline @code{movmemhi} patterns for copying memory.
17006 @item -mint16
17007 @itemx -mno-int32
17008 @opindex mint16
17009 @opindex mno-int32
17010 Use 16-bit @code{int}.  This is the default.
17012 @item -mint32
17013 @itemx -mno-int16
17014 @opindex mint32
17015 @opindex mno-int16
17016 Use 32-bit @code{int}.
17018 @item -mfloat64
17019 @itemx -mno-float32
17020 @opindex mfloat64
17021 @opindex mno-float32
17022 Use 64-bit @code{float}.  This is the default.
17024 @item -mfloat32
17025 @itemx -mno-float64
17026 @opindex mfloat32
17027 @opindex mno-float64
17028 Use 32-bit @code{float}.
17030 @item -mabshi
17031 @opindex mabshi
17032 Use @code{abshi2} pattern.  This is the default.
17034 @item -mno-abshi
17035 @opindex mno-abshi
17036 Do not use @code{abshi2} pattern.
17038 @item -mbranch-expensive
17039 @opindex mbranch-expensive
17040 Pretend that branches are expensive.  This is for experimenting with
17041 code generation only.
17043 @item -mbranch-cheap
17044 @opindex mbranch-cheap
17045 Do not pretend that branches are expensive.  This is the default.
17047 @item -munix-asm
17048 @opindex munix-asm
17049 Use Unix assembler syntax.  This is the default when configured for
17050 @samp{pdp11-*-bsd}.
17052 @item -mdec-asm
17053 @opindex mdec-asm
17054 Use DEC assembler syntax.  This is the default when configured for any
17055 PDP-11 target other than @samp{pdp11-*-bsd}.
17056 @end table
17058 @node picoChip Options
17059 @subsection picoChip Options
17060 @cindex picoChip options
17062 These @samp{-m} options are defined for picoChip implementations:
17064 @table @gcctabopt
17066 @item -mae=@var{ae_type}
17067 @opindex mcpu
17068 Set the instruction set, register set, and instruction scheduling
17069 parameters for array element type @var{ae_type}.  Supported values
17070 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
17072 @option{-mae=ANY} selects a completely generic AE type.  Code
17073 generated with this option runs on any of the other AE types.  The
17074 code is not as efficient as it would be if compiled for a specific
17075 AE type, and some types of operation (e.g., multiplication) do not
17076 work properly on all types of AE.
17078 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
17079 for compiled code, and is the default.
17081 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
17082 option may suffer from poor performance of byte (char) manipulation,
17083 since the DSP AE does not provide hardware support for byte load/stores.
17085 @item -msymbol-as-address
17086 Enable the compiler to directly use a symbol name as an address in a
17087 load/store instruction, without first loading it into a
17088 register.  Typically, the use of this option generates larger
17089 programs, which run faster than when the option isn't used.  However, the
17090 results vary from program to program, so it is left as a user option,
17091 rather than being permanently enabled.
17093 @item -mno-inefficient-warnings
17094 Disables warnings about the generation of inefficient code.  These
17095 warnings can be generated, for example, when compiling code that
17096 performs byte-level memory operations on the MAC AE type.  The MAC AE has
17097 no hardware support for byte-level memory operations, so all byte
17098 load/stores must be synthesized from word load/store operations.  This is
17099 inefficient and a warning is generated to indicate
17100 that you should rewrite the code to avoid byte operations, or to target
17101 an AE type that has the necessary hardware support.  This option disables
17102 these warnings.
17104 @end table
17106 @node PowerPC Options
17107 @subsection PowerPC Options
17108 @cindex PowerPC options
17110 These are listed under @xref{RS/6000 and PowerPC Options}.
17112 @node RL78 Options
17113 @subsection RL78 Options
17114 @cindex RL78 Options
17116 @table @gcctabopt
17118 @item -msim
17119 @opindex msim
17120 Links in additional target libraries to support operation within a
17121 simulator.
17123 @item -mmul=none
17124 @itemx -mmul=g13
17125 @itemx -mmul=rl78
17126 @opindex mmul
17127 Specifies the type of hardware multiplication support to be used.  The
17128 default is @code{none}, which uses software multiplication functions.
17129 The @code{g13} option is for the hardware multiply/divide peripheral
17130 only on the RL78/G13 targets.  The @code{rl78} option is for the
17131 standard hardware multiplication defined in the RL78 software manual.
17133 @end table
17135 @node RS/6000 and PowerPC Options
17136 @subsection IBM RS/6000 and PowerPC Options
17137 @cindex RS/6000 and PowerPC Options
17138 @cindex IBM RS/6000 and PowerPC Options
17140 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
17141 @table @gcctabopt
17142 @item -mpowerpc-gpopt
17143 @itemx -mno-powerpc-gpopt
17144 @itemx -mpowerpc-gfxopt
17145 @itemx -mno-powerpc-gfxopt
17146 @need 800
17147 @itemx -mpowerpc64
17148 @itemx -mno-powerpc64
17149 @itemx -mmfcrf
17150 @itemx -mno-mfcrf
17151 @itemx -mpopcntb
17152 @itemx -mno-popcntb
17153 @itemx -mpopcntd
17154 @itemx -mno-popcntd
17155 @itemx -mfprnd
17156 @itemx -mno-fprnd
17157 @need 800
17158 @itemx -mcmpb
17159 @itemx -mno-cmpb
17160 @itemx -mmfpgpr
17161 @itemx -mno-mfpgpr
17162 @itemx -mhard-dfp
17163 @itemx -mno-hard-dfp
17164 @opindex mpowerpc-gpopt
17165 @opindex mno-powerpc-gpopt
17166 @opindex mpowerpc-gfxopt
17167 @opindex mno-powerpc-gfxopt
17168 @opindex mpowerpc64
17169 @opindex mno-powerpc64
17170 @opindex mmfcrf
17171 @opindex mno-mfcrf
17172 @opindex mpopcntb
17173 @opindex mno-popcntb
17174 @opindex mpopcntd
17175 @opindex mno-popcntd
17176 @opindex mfprnd
17177 @opindex mno-fprnd
17178 @opindex mcmpb
17179 @opindex mno-cmpb
17180 @opindex mmfpgpr
17181 @opindex mno-mfpgpr
17182 @opindex mhard-dfp
17183 @opindex mno-hard-dfp
17184 You use these options to specify which instructions are available on the
17185 processor you are using.  The default value of these options is
17186 determined when configuring GCC@.  Specifying the
17187 @option{-mcpu=@var{cpu_type}} overrides the specification of these
17188 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
17189 rather than the options listed above.
17191 Specifying @option{-mpowerpc-gpopt} allows
17192 GCC to use the optional PowerPC architecture instructions in the
17193 General Purpose group, including floating-point square root.  Specifying
17194 @option{-mpowerpc-gfxopt} allows GCC to
17195 use the optional PowerPC architecture instructions in the Graphics
17196 group, including floating-point select.
17198 The @option{-mmfcrf} option allows GCC to generate the move from
17199 condition register field instruction implemented on the POWER4
17200 processor and other processors that support the PowerPC V2.01
17201 architecture.
17202 The @option{-mpopcntb} option allows GCC to generate the popcount and
17203 double-precision FP reciprocal estimate instruction implemented on the
17204 POWER5 processor and other processors that support the PowerPC V2.02
17205 architecture.
17206 The @option{-mpopcntd} option allows GCC to generate the popcount
17207 instruction implemented on the POWER7 processor and other processors
17208 that support the PowerPC V2.06 architecture.
17209 The @option{-mfprnd} option allows GCC to generate the FP round to
17210 integer instructions implemented on the POWER5+ processor and other
17211 processors that support the PowerPC V2.03 architecture.
17212 The @option{-mcmpb} option allows GCC to generate the compare bytes
17213 instruction implemented on the POWER6 processor and other processors
17214 that support the PowerPC V2.05 architecture.
17215 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
17216 general-purpose register instructions implemented on the POWER6X
17217 processor and other processors that support the extended PowerPC V2.05
17218 architecture.
17219 The @option{-mhard-dfp} option allows GCC to generate the decimal
17220 floating-point instructions implemented on some POWER processors.
17222 The @option{-mpowerpc64} option allows GCC to generate the additional
17223 64-bit instructions that are found in the full PowerPC64 architecture
17224 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
17225 @option{-mno-powerpc64}.
17227 @item -mcpu=@var{cpu_type}
17228 @opindex mcpu
17229 Set architecture type, register usage, and
17230 instruction scheduling parameters for machine type @var{cpu_type}.
17231 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
17232 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
17233 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
17234 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
17235 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
17236 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
17237 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
17238 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
17239 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
17240 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
17241 @samp{powerpc64}, and @samp{rs64}.
17243 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
17244 PowerPC and 64-bit PowerPC architecture machine
17245 types, with an appropriate, generic processor model assumed for
17246 scheduling purposes.
17248 The other options specify a specific processor.  Code generated under
17249 those options runs best on that processor, and may not run at all on
17250 others.
17252 The @option{-mcpu} options automatically enable or disable the
17253 following options:
17255 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
17256 -mpopcntb -mpopcntd  -mpowerpc64 @gol
17257 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
17258 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
17260 The particular options set for any particular CPU varies between
17261 compiler versions, depending on what setting seems to produce optimal
17262 code for that CPU; it doesn't necessarily reflect the actual hardware's
17263 capabilities.  If you wish to set an individual option to a particular
17264 value, you may specify it after the @option{-mcpu} option, like
17265 @option{-mcpu=970 -mno-altivec}.
17267 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
17268 not enabled or disabled by the @option{-mcpu} option at present because
17269 AIX does not have full support for these options.  You may still
17270 enable or disable them individually if you're sure it'll work in your
17271 environment.
17273 @item -mtune=@var{cpu_type}
17274 @opindex mtune
17275 Set the instruction scheduling parameters for machine type
17276 @var{cpu_type}, but do not set the architecture type or register usage,
17277 as @option{-mcpu=@var{cpu_type}} does.  The same
17278 values for @var{cpu_type} are used for @option{-mtune} as for
17279 @option{-mcpu}.  If both are specified, the code generated uses the
17280 architecture and registers set by @option{-mcpu}, but the
17281 scheduling parameters set by @option{-mtune}.
17283 @item -mcmodel=small
17284 @opindex mcmodel=small
17285 Generate PowerPC64 code for the small model: The TOC is limited to
17286 64k.
17288 @item -mcmodel=medium
17289 @opindex mcmodel=medium
17290 Generate PowerPC64 code for the medium model: The TOC and other static
17291 data may be up to a total of 4G in size.
17293 @item -mcmodel=large
17294 @opindex mcmodel=large
17295 Generate PowerPC64 code for the large model: The TOC may be up to 4G
17296 in size.  Other data and code is only limited by the 64-bit address
17297 space.
17299 @item -maltivec
17300 @itemx -mno-altivec
17301 @opindex maltivec
17302 @opindex mno-altivec
17303 Generate code that uses (does not use) AltiVec instructions, and also
17304 enable the use of built-in functions that allow more direct access to
17305 the AltiVec instruction set.  You may also need to set
17306 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
17307 enhancements.
17309 @item -mvrsave
17310 @itemx -mno-vrsave
17311 @opindex mvrsave
17312 @opindex mno-vrsave
17313 Generate VRSAVE instructions when generating AltiVec code.
17315 @item -mgen-cell-microcode
17316 @opindex mgen-cell-microcode
17317 Generate Cell microcode instructions.
17319 @item -mwarn-cell-microcode
17320 @opindex mwarn-cell-microcode
17321 Warn when a Cell microcode instruction is emitted.  An example
17322 of a Cell microcode instruction is a variable shift.
17324 @item -msecure-plt
17325 @opindex msecure-plt
17326 Generate code that allows @command{ld} and @command{ld.so}
17327 to build executables and shared
17328 libraries with non-executable @code{.plt} and @code{.got} sections.
17329 This is a PowerPC
17330 32-bit SYSV ABI option.
17332 @item -mbss-plt
17333 @opindex mbss-plt
17334 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
17335 fills in, and
17336 requires @code{.plt} and @code{.got}
17337 sections that are both writable and executable.
17338 This is a PowerPC 32-bit SYSV ABI option.
17340 @item -misel
17341 @itemx -mno-isel
17342 @opindex misel
17343 @opindex mno-isel
17344 This switch enables or disables the generation of ISEL instructions.
17346 @item -misel=@var{yes/no}
17347 This switch has been deprecated.  Use @option{-misel} and
17348 @option{-mno-isel} instead.
17350 @item -mspe
17351 @itemx -mno-spe
17352 @opindex mspe
17353 @opindex mno-spe
17354 This switch enables or disables the generation of SPE simd
17355 instructions.
17357 @item -mpaired
17358 @itemx -mno-paired
17359 @opindex mpaired
17360 @opindex mno-paired
17361 This switch enables or disables the generation of PAIRED simd
17362 instructions.
17364 @item -mspe=@var{yes/no}
17365 This option has been deprecated.  Use @option{-mspe} and
17366 @option{-mno-spe} instead.
17368 @item -mvsx
17369 @itemx -mno-vsx
17370 @opindex mvsx
17371 @opindex mno-vsx
17372 Generate code that uses (does not use) vector/scalar (VSX)
17373 instructions, and also enable the use of built-in functions that allow
17374 more direct access to the VSX instruction set.
17376 @item -mfloat-gprs=@var{yes/single/double/no}
17377 @itemx -mfloat-gprs
17378 @opindex mfloat-gprs
17379 This switch enables or disables the generation of floating-point
17380 operations on the general-purpose registers for architectures that
17381 support it.
17383 The argument @var{yes} or @var{single} enables the use of
17384 single-precision floating-point operations.
17386 The argument @var{double} enables the use of single and
17387 double-precision floating-point operations.
17389 The argument @var{no} disables floating-point operations on the
17390 general-purpose registers.
17392 This option is currently only available on the MPC854x.
17394 @item -m32
17395 @itemx -m64
17396 @opindex m32
17397 @opindex m64
17398 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
17399 targets (including GNU/Linux).  The 32-bit environment sets int, long
17400 and pointer to 32 bits and generates code that runs on any PowerPC
17401 variant.  The 64-bit environment sets int to 32 bits and long and
17402 pointer to 64 bits, and generates code for PowerPC64, as for
17403 @option{-mpowerpc64}.
17405 @item -mfull-toc
17406 @itemx -mno-fp-in-toc
17407 @itemx -mno-sum-in-toc
17408 @itemx -mminimal-toc
17409 @opindex mfull-toc
17410 @opindex mno-fp-in-toc
17411 @opindex mno-sum-in-toc
17412 @opindex mminimal-toc
17413 Modify generation of the TOC (Table Of Contents), which is created for
17414 every executable file.  The @option{-mfull-toc} option is selected by
17415 default.  In that case, GCC allocates at least one TOC entry for
17416 each unique non-automatic variable reference in your program.  GCC
17417 also places floating-point constants in the TOC@.  However, only
17418 16,384 entries are available in the TOC@.
17420 If you receive a linker error message that saying you have overflowed
17421 the available TOC space, you can reduce the amount of TOC space used
17422 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
17423 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
17424 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
17425 generate code to calculate the sum of an address and a constant at
17426 run time instead of putting that sum into the TOC@.  You may specify one
17427 or both of these options.  Each causes GCC to produce very slightly
17428 slower and larger code at the expense of conserving TOC space.
17430 If you still run out of space in the TOC even when you specify both of
17431 these options, specify @option{-mminimal-toc} instead.  This option causes
17432 GCC to make only one TOC entry for every file.  When you specify this
17433 option, GCC produces code that is slower and larger but which
17434 uses extremely little TOC space.  You may wish to use this option
17435 only on files that contain less frequently-executed code.
17437 @item -maix64
17438 @itemx -maix32
17439 @opindex maix64
17440 @opindex maix32
17441 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
17442 @code{long} type, and the infrastructure needed to support them.
17443 Specifying @option{-maix64} implies @option{-mpowerpc64},
17444 while @option{-maix32} disables the 64-bit ABI and
17445 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
17447 @item -mxl-compat
17448 @itemx -mno-xl-compat
17449 @opindex mxl-compat
17450 @opindex mno-xl-compat
17451 Produce code that conforms more closely to IBM XL compiler semantics
17452 when using AIX-compatible ABI@.  Pass floating-point arguments to
17453 prototyped functions beyond the register save area (RSA) on the stack
17454 in addition to argument FPRs.  Do not assume that most significant
17455 double in 128-bit long double value is properly rounded when comparing
17456 values and converting to double.  Use XL symbol names for long double
17457 support routines.
17459 The AIX calling convention was extended but not initially documented to
17460 handle an obscure K&R C case of calling a function that takes the
17461 address of its arguments with fewer arguments than declared.  IBM XL
17462 compilers access floating-point arguments that do not fit in the
17463 RSA from the stack when a subroutine is compiled without
17464 optimization.  Because always storing floating-point arguments on the
17465 stack is inefficient and rarely needed, this option is not enabled by
17466 default and only is necessary when calling subroutines compiled by IBM
17467 XL compilers without optimization.
17469 @item -mpe
17470 @opindex mpe
17471 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
17472 application written to use message passing with special startup code to
17473 enable the application to run.  The system must have PE installed in the
17474 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
17475 must be overridden with the @option{-specs=} option to specify the
17476 appropriate directory location.  The Parallel Environment does not
17477 support threads, so the @option{-mpe} option and the @option{-pthread}
17478 option are incompatible.
17480 @item -malign-natural
17481 @itemx -malign-power
17482 @opindex malign-natural
17483 @opindex malign-power
17484 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
17485 @option{-malign-natural} overrides the ABI-defined alignment of larger
17486 types, such as floating-point doubles, on their natural size-based boundary.
17487 The option @option{-malign-power} instructs GCC to follow the ABI-specified
17488 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
17490 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
17491 is not supported.
17493 @item -msoft-float
17494 @itemx -mhard-float
17495 @opindex msoft-float
17496 @opindex mhard-float
17497 Generate code that does not use (uses) the floating-point register set.
17498 Software floating-point emulation is provided if you use the
17499 @option{-msoft-float} option, and pass the option to GCC when linking.
17501 @item -msingle-float
17502 @itemx -mdouble-float
17503 @opindex msingle-float
17504 @opindex mdouble-float
17505 Generate code for single- or double-precision floating-point operations.
17506 @option{-mdouble-float} implies @option{-msingle-float}.
17508 @item -msimple-fpu
17509 @opindex msimple-fpu
17510 Do not generate @code{sqrt} and @code{div} instructions for hardware
17511 floating-point unit.
17513 @item -mfpu=@var{name}
17514 @opindex mfpu
17515 Specify type of floating-point unit.  Valid values for @var{name} are
17516 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
17517 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
17518 @samp{sp_full} (equivalent to @option{-msingle-float}),
17519 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
17521 @item -mxilinx-fpu
17522 @opindex mxilinx-fpu
17523 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
17525 @item -mmultiple
17526 @itemx -mno-multiple
17527 @opindex mmultiple
17528 @opindex mno-multiple
17529 Generate code that uses (does not use) the load multiple word
17530 instructions and the store multiple word instructions.  These
17531 instructions are generated by default on POWER systems, and not
17532 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
17533 PowerPC systems, since those instructions do not work when the
17534 processor is in little-endian mode.  The exceptions are PPC740 and
17535 PPC750 which permit these instructions in little-endian mode.
17537 @item -mstring
17538 @itemx -mno-string
17539 @opindex mstring
17540 @opindex mno-string
17541 Generate code that uses (does not use) the load string instructions
17542 and the store string word instructions to save multiple registers and
17543 do small block moves.  These instructions are generated by default on
17544 POWER systems, and not generated on PowerPC systems.  Do not use
17545 @option{-mstring} on little-endian PowerPC systems, since those
17546 instructions do not work when the processor is in little-endian mode.
17547 The exceptions are PPC740 and PPC750 which permit these instructions
17548 in little-endian mode.
17550 @item -mupdate
17551 @itemx -mno-update
17552 @opindex mupdate
17553 @opindex mno-update
17554 Generate code that uses (does not use) the load or store instructions
17555 that update the base register to the address of the calculated memory
17556 location.  These instructions are generated by default.  If you use
17557 @option{-mno-update}, there is a small window between the time that the
17558 stack pointer is updated and the address of the previous frame is
17559 stored, which means code that walks the stack frame across interrupts or
17560 signals may get corrupted data.
17562 @item -mavoid-indexed-addresses
17563 @itemx -mno-avoid-indexed-addresses
17564 @opindex mavoid-indexed-addresses
17565 @opindex mno-avoid-indexed-addresses
17566 Generate code that tries to avoid (not avoid) the use of indexed load
17567 or store instructions. These instructions can incur a performance
17568 penalty on Power6 processors in certain situations, such as when
17569 stepping through large arrays that cross a 16M boundary.  This option
17570 is enabled by default when targeting Power6 and disabled otherwise.
17572 @item -mfused-madd
17573 @itemx -mno-fused-madd
17574 @opindex mfused-madd
17575 @opindex mno-fused-madd
17576 Generate code that uses (does not use) the floating-point multiply and
17577 accumulate instructions.  These instructions are generated by default
17578 if hardware floating point is used.  The machine-dependent
17579 @option{-mfused-madd} option is now mapped to the machine-independent
17580 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17581 mapped to @option{-ffp-contract=off}.
17583 @item -mmulhw
17584 @itemx -mno-mulhw
17585 @opindex mmulhw
17586 @opindex mno-mulhw
17587 Generate code that uses (does not use) the half-word multiply and
17588 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17589 These instructions are generated by default when targeting those
17590 processors.
17592 @item -mdlmzb
17593 @itemx -mno-dlmzb
17594 @opindex mdlmzb
17595 @opindex mno-dlmzb
17596 Generate code that uses (does not use) the string-search @samp{dlmzb}
17597 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
17598 generated by default when targeting those processors.
17600 @item -mno-bit-align
17601 @itemx -mbit-align
17602 @opindex mno-bit-align
17603 @opindex mbit-align
17604 On System V.4 and embedded PowerPC systems do not (do) force structures
17605 and unions that contain bit-fields to be aligned to the base type of the
17606 bit-field.
17608 For example, by default a structure containing nothing but 8
17609 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17610 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
17611 the structure is aligned to a 1-byte boundary and is 1 byte in
17612 size.
17614 @item -mno-strict-align
17615 @itemx -mstrict-align
17616 @opindex mno-strict-align
17617 @opindex mstrict-align
17618 On System V.4 and embedded PowerPC systems do not (do) assume that
17619 unaligned memory references are handled by the system.
17621 @item -mrelocatable
17622 @itemx -mno-relocatable
17623 @opindex mrelocatable
17624 @opindex mno-relocatable
17625 Generate code that allows (does not allow) a static executable to be
17626 relocated to a different address at run time.  A simple embedded
17627 PowerPC system loader should relocate the entire contents of
17628 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17629 a table of 32-bit addresses generated by this option.  For this to
17630 work, all objects linked together must be compiled with
17631 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17632 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17634 @item -mrelocatable-lib
17635 @itemx -mno-relocatable-lib
17636 @opindex mrelocatable-lib
17637 @opindex mno-relocatable-lib
17638 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17639 @code{.fixup} section to allow static executables to be relocated at
17640 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17641 alignment of @option{-mrelocatable}.  Objects compiled with
17642 @option{-mrelocatable-lib} may be linked with objects compiled with
17643 any combination of the @option{-mrelocatable} options.
17645 @item -mno-toc
17646 @itemx -mtoc
17647 @opindex mno-toc
17648 @opindex mtoc
17649 On System V.4 and embedded PowerPC systems do not (do) assume that
17650 register 2 contains a pointer to a global area pointing to the addresses
17651 used in the program.
17653 @item -mlittle
17654 @itemx -mlittle-endian
17655 @opindex mlittle
17656 @opindex mlittle-endian
17657 On System V.4 and embedded PowerPC systems compile code for the
17658 processor in little-endian mode.  The @option{-mlittle-endian} option is
17659 the same as @option{-mlittle}.
17661 @item -mbig
17662 @itemx -mbig-endian
17663 @opindex mbig
17664 @opindex mbig-endian
17665 On System V.4 and embedded PowerPC systems compile code for the
17666 processor in big-endian mode.  The @option{-mbig-endian} option is
17667 the same as @option{-mbig}.
17669 @item -mdynamic-no-pic
17670 @opindex mdynamic-no-pic
17671 On Darwin and Mac OS X systems, compile code so that it is not
17672 relocatable, but that its external references are relocatable.  The
17673 resulting code is suitable for applications, but not shared
17674 libraries.
17676 @item -msingle-pic-base
17677 @opindex msingle-pic-base
17678 Treat the register used for PIC addressing as read-only, rather than
17679 loading it in the prologue for each function.  The runtime system is
17680 responsible for initializing this register with an appropriate value
17681 before execution begins.
17683 @item -mprioritize-restricted-insns=@var{priority}
17684 @opindex mprioritize-restricted-insns
17685 This option controls the priority that is assigned to
17686 dispatch-slot restricted instructions during the second scheduling
17687 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
17688 or @samp{2} to assign no, highest, or second-highest (respectively) 
17689 priority to dispatch-slot restricted
17690 instructions.
17692 @item -msched-costly-dep=@var{dependence_type}
17693 @opindex msched-costly-dep
17694 This option controls which dependences are considered costly
17695 by the target during instruction scheduling.  The argument
17696 @var{dependence_type} takes one of the following values:
17698 @table @asis
17699 @item @samp{no}
17700 No dependence is costly.
17702 @item @samp{all}
17703 All dependences are costly.
17705 @item @samp{true_store_to_load}
17706 A true dependence from store to load is costly.
17708 @item @samp{store_to_load}
17709 Any dependence from store to load is costly.
17711 @item @var{number}
17712 Any dependence for which the latency is greater than or equal to 
17713 @var{number} is costly.
17714 @end table
17716 @item -minsert-sched-nops=@var{scheme}
17717 @opindex minsert-sched-nops
17718 This option controls which NOP insertion scheme is used during
17719 the second scheduling pass.  The argument @var{scheme} takes one of the
17720 following values:
17722 @table @asis
17723 @item @samp{no}
17724 Don't insert NOPs.
17726 @item @samp{pad}
17727 Pad with NOPs any dispatch group that has vacant issue slots,
17728 according to the scheduler's grouping.
17730 @item @samp{regroup_exact}
17731 Insert NOPs to force costly dependent insns into
17732 separate groups.  Insert exactly as many NOPs as needed to force an insn
17733 to a new group, according to the estimated processor grouping.
17735 @item @var{number}
17736 Insert NOPs to force costly dependent insns into
17737 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
17738 @end table
17740 @item -mcall-sysv
17741 @opindex mcall-sysv
17742 On System V.4 and embedded PowerPC systems compile code using calling
17743 conventions that adhere to the March 1995 draft of the System V
17744 Application Binary Interface, PowerPC processor supplement.  This is the
17745 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17747 @item -mcall-sysv-eabi
17748 @itemx -mcall-eabi
17749 @opindex mcall-sysv-eabi
17750 @opindex mcall-eabi
17751 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17753 @item -mcall-sysv-noeabi
17754 @opindex mcall-sysv-noeabi
17755 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17757 @item -mcall-aixdesc
17758 @opindex m
17759 On System V.4 and embedded PowerPC systems compile code for the AIX
17760 operating system.
17762 @item -mcall-linux
17763 @opindex mcall-linux
17764 On System V.4 and embedded PowerPC systems compile code for the
17765 Linux-based GNU system.
17767 @item -mcall-freebsd
17768 @opindex mcall-freebsd
17769 On System V.4 and embedded PowerPC systems compile code for the
17770 FreeBSD operating system.
17772 @item -mcall-netbsd
17773 @opindex mcall-netbsd
17774 On System V.4 and embedded PowerPC systems compile code for the
17775 NetBSD operating system.
17777 @item -mcall-openbsd
17778 @opindex mcall-netbsd
17779 On System V.4 and embedded PowerPC systems compile code for the
17780 OpenBSD operating system.
17782 @item -maix-struct-return
17783 @opindex maix-struct-return
17784 Return all structures in memory (as specified by the AIX ABI)@.
17786 @item -msvr4-struct-return
17787 @opindex msvr4-struct-return
17788 Return structures smaller than 8 bytes in registers (as specified by the
17789 SVR4 ABI)@.
17791 @item -mabi=@var{abi-type}
17792 @opindex mabi
17793 Extend the current ABI with a particular extension, or remove such extension.
17794 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17795 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17797 @item -mabi=spe
17798 @opindex mabi=spe
17799 Extend the current ABI with SPE ABI extensions.  This does not change
17800 the default ABI, instead it adds the SPE ABI extensions to the current
17801 ABI@.
17803 @item -mabi=no-spe
17804 @opindex mabi=no-spe
17805 Disable Book-E SPE ABI extensions for the current ABI@.
17807 @item -mabi=ibmlongdouble
17808 @opindex mabi=ibmlongdouble
17809 Change the current ABI to use IBM extended-precision long double.
17810 This is a PowerPC 32-bit SYSV ABI option.
17812 @item -mabi=ieeelongdouble
17813 @opindex mabi=ieeelongdouble
17814 Change the current ABI to use IEEE extended-precision long double.
17815 This is a PowerPC 32-bit Linux ABI option.
17817 @item -mprototype
17818 @itemx -mno-prototype
17819 @opindex mprototype
17820 @opindex mno-prototype
17821 On System V.4 and embedded PowerPC systems assume that all calls to
17822 variable argument functions are properly prototyped.  Otherwise, the
17823 compiler must insert an instruction before every non-prototyped call to
17824 set or clear bit 6 of the condition code register (@var{CR}) to
17825 indicate whether floating-point values are passed in the floating-point
17826 registers in case the function takes variable arguments.  With
17827 @option{-mprototype}, only calls to prototyped variable argument functions
17828 set or clear the bit.
17830 @item -msim
17831 @opindex msim
17832 On embedded PowerPC systems, assume that the startup module is called
17833 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17834 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17835 configurations.
17837 @item -mmvme
17838 @opindex mmvme
17839 On embedded PowerPC systems, assume that the startup module is called
17840 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17841 @file{libc.a}.
17843 @item -mads
17844 @opindex mads
17845 On embedded PowerPC systems, assume that the startup module is called
17846 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17847 @file{libc.a}.
17849 @item -myellowknife
17850 @opindex myellowknife
17851 On embedded PowerPC systems, assume that the startup module is called
17852 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17853 @file{libc.a}.
17855 @item -mvxworks
17856 @opindex mvxworks
17857 On System V.4 and embedded PowerPC systems, specify that you are
17858 compiling for a VxWorks system.
17860 @item -memb
17861 @opindex memb
17862 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17863 header to indicate that @samp{eabi} extended relocations are used.
17865 @item -meabi
17866 @itemx -mno-eabi
17867 @opindex meabi
17868 @opindex mno-eabi
17869 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17870 Embedded Applications Binary Interface (EABI), which is a set of
17871 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17872 means that the stack is aligned to an 8-byte boundary, a function
17873 @code{__eabi} is called from @code{main} to set up the EABI
17874 environment, and the @option{-msdata} option can use both @code{r2} and
17875 @code{r13} to point to two separate small data areas.  Selecting
17876 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17877 no EABI initialization function is called from @code{main}, and the
17878 @option{-msdata} option only uses @code{r13} to point to a single
17879 small data area.  The @option{-meabi} option is on by default if you
17880 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17882 @item -msdata=eabi
17883 @opindex msdata=eabi
17884 On System V.4 and embedded PowerPC systems, put small initialized
17885 @code{const} global and static data in the @samp{.sdata2} section, which
17886 is pointed to by register @code{r2}.  Put small initialized
17887 non-@code{const} global and static data in the @samp{.sdata} section,
17888 which is pointed to by register @code{r13}.  Put small uninitialized
17889 global and static data in the @samp{.sbss} section, which is adjacent to
17890 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
17891 incompatible with the @option{-mrelocatable} option.  The
17892 @option{-msdata=eabi} option also sets the @option{-memb} option.
17894 @item -msdata=sysv
17895 @opindex msdata=sysv
17896 On System V.4 and embedded PowerPC systems, put small global and static
17897 data in the @samp{.sdata} section, which is pointed to by register
17898 @code{r13}.  Put small uninitialized global and static data in the
17899 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17900 The @option{-msdata=sysv} option is incompatible with the
17901 @option{-mrelocatable} option.
17903 @item -msdata=default
17904 @itemx -msdata
17905 @opindex msdata=default
17906 @opindex msdata
17907 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17908 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17909 same as @option{-msdata=sysv}.
17911 @item -msdata=data
17912 @opindex msdata=data
17913 On System V.4 and embedded PowerPC systems, put small global
17914 data in the @samp{.sdata} section.  Put small uninitialized global
17915 data in the @samp{.sbss} section.  Do not use register @code{r13}
17916 to address small data however.  This is the default behavior unless
17917 other @option{-msdata} options are used.
17919 @item -msdata=none
17920 @itemx -mno-sdata
17921 @opindex msdata=none
17922 @opindex mno-sdata
17923 On embedded PowerPC systems, put all initialized global and static data
17924 in the @samp{.data} section, and all uninitialized data in the
17925 @samp{.bss} section.
17927 @item -mblock-move-inline-limit=@var{num}
17928 @opindex mblock-move-inline-limit
17929 Inline all block moves (such as calls to @code{memcpy} or structure
17930 copies) less than or equal to @var{num} bytes.  The minimum value for
17931 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17932 targets.  The default value is target-specific.
17934 @item -G @var{num}
17935 @opindex G
17936 @cindex smaller data references (PowerPC)
17937 @cindex .sdata/.sdata2 references (PowerPC)
17938 On embedded PowerPC systems, put global and static items less than or
17939 equal to @var{num} bytes into the small data or BSS sections instead of
17940 the normal data or BSS section.  By default, @var{num} is 8.  The
17941 @option{-G @var{num}} switch is also passed to the linker.
17942 All modules should be compiled with the same @option{-G @var{num}} value.
17944 @item -mregnames
17945 @itemx -mno-regnames
17946 @opindex mregnames
17947 @opindex mno-regnames
17948 On System V.4 and embedded PowerPC systems do (do not) emit register
17949 names in the assembly language output using symbolic forms.
17951 @item -mlongcall
17952 @itemx -mno-longcall
17953 @opindex mlongcall
17954 @opindex mno-longcall
17955 By default assume that all calls are far away so that a longer and more
17956 expensive calling sequence is required.  This is required for calls
17957 farther than 32 megabytes (33,554,432 bytes) from the current location.
17958 A short call is generated if the compiler knows
17959 the call cannot be that far away.  This setting can be overridden by
17960 the @code{shortcall} function attribute, or by @code{#pragma
17961 longcall(0)}.
17963 Some linkers are capable of detecting out-of-range calls and generating
17964 glue code on the fly.  On these systems, long calls are unnecessary and
17965 generate slower code.  As of this writing, the AIX linker can do this,
17966 as can the GNU linker for PowerPC/64.  It is planned to add this feature
17967 to the GNU linker for 32-bit PowerPC systems as well.
17969 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
17970 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
17971 addresses represent the callee and the branch island.  The
17972 Darwin/PPC linker prefers the first address and generates a @code{bl
17973 callee} if the PPC @code{bl} instruction reaches the callee directly;
17974 otherwise, the linker generates @code{bl L42} to call the branch
17975 island.  The branch island is appended to the body of the
17976 calling function; it computes the full 32-bit address of the callee
17977 and jumps to it.
17979 On Mach-O (Darwin) systems, this option directs the compiler emit to
17980 the glue for every direct call, and the Darwin linker decides whether
17981 to use or discard it.
17983 In the future, GCC may ignore all longcall specifications
17984 when the linker is known to generate glue.
17986 @item -mtls-markers
17987 @itemx -mno-tls-markers
17988 @opindex mtls-markers
17989 @opindex mno-tls-markers
17990 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17991 specifying the function argument.  The relocation allows the linker to
17992 reliably associate function call with argument setup instructions for
17993 TLS optimization, which in turn allows GCC to better schedule the
17994 sequence.
17996 @item -pthread
17997 @opindex pthread
17998 Adds support for multithreading with the @dfn{pthreads} library.
17999 This option sets flags for both the preprocessor and linker.
18001 @item -mrecip
18002 @itemx -mno-recip
18003 @opindex mrecip
18004 This option enables use of the reciprocal estimate and
18005 reciprocal square root estimate instructions with additional
18006 Newton-Raphson steps to increase precision instead of doing a divide or
18007 square root and divide for floating-point arguments.  You should use
18008 the @option{-ffast-math} option when using @option{-mrecip} (or at
18009 least @option{-funsafe-math-optimizations},
18010 @option{-finite-math-only}, @option{-freciprocal-math} and
18011 @option{-fno-trapping-math}).  Note that while the throughput of the
18012 sequence is generally higher than the throughput of the non-reciprocal
18013 instruction, the precision of the sequence can be decreased by up to 2
18014 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
18015 roots.
18017 @item -mrecip=@var{opt}
18018 @opindex mrecip=opt
18019 This option controls which reciprocal estimate instructions
18020 may be used.  @var{opt} is a comma-separated list of options, which may
18021 be preceded by a @code{!} to invert the option:
18022 @code{all}: enable all estimate instructions,
18023 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
18024 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
18025 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
18026 @code{divf}: enable the single-precision reciprocal approximation instructions;
18027 @code{divd}: enable the double-precision reciprocal approximation instructions;
18028 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
18029 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
18030 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
18032 So, for example, @option{-mrecip=all,!rsqrtd} enables
18033 all of the reciprocal estimate instructions, except for the
18034 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
18035 which handle the double-precision reciprocal square root calculations.
18037 @item -mrecip-precision
18038 @itemx -mno-recip-precision
18039 @opindex mrecip-precision
18040 Assume (do not assume) that the reciprocal estimate instructions
18041 provide higher-precision estimates than is mandated by the PowerPC
18042 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
18043 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
18044 The double-precision square root estimate instructions are not generated by
18045 default on low-precision machines, since they do not provide an
18046 estimate that converges after three steps.
18048 @item -mveclibabi=@var{type}
18049 @opindex mveclibabi
18050 Specifies the ABI type to use for vectorizing intrinsics using an
18051 external library.  The only type supported at present is @code{mass},
18052 which specifies to use IBM's Mathematical Acceleration Subsystem
18053 (MASS) libraries for vectorizing intrinsics using external libraries.
18054 GCC currently emits calls to @code{acosd2}, @code{acosf4},
18055 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
18056 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
18057 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
18058 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
18059 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
18060 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
18061 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
18062 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
18063 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
18064 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
18065 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
18066 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
18067 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
18068 for power7.  Both @option{-ftree-vectorize} and
18069 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
18070 libraries must be specified at link time.
18072 @item -mfriz
18073 @itemx -mno-friz
18074 @opindex mfriz
18075 Generate (do not generate) the @code{friz} instruction when the
18076 @option{-funsafe-math-optimizations} option is used to optimize
18077 rounding of floating-point values to 64-bit integer and back to floating
18078 point.  The @code{friz} instruction does not return the same value if
18079 the floating-point number is too large to fit in an integer.
18081 @item -mpointers-to-nested-functions
18082 @itemx -mno-pointers-to-nested-functions
18083 @opindex mpointers-to-nested-functions
18084 Generate (do not generate) code to load up the static chain register
18085 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
18086 systems where a function pointer points to a 3-word descriptor giving
18087 the function address, TOC value to be loaded in register @var{r2}, and
18088 static chain value to be loaded in register @var{r11}.  The
18089 @option{-mpointers-to-nested-functions} is on by default.  You cannot
18090 call through pointers to nested functions or pointers
18091 to functions compiled in other languages that use the static chain if
18092 you use the @option{-mno-pointers-to-nested-functions}.
18094 @item -msave-toc-indirect
18095 @itemx -mno-save-toc-indirect
18096 @opindex msave-toc-indirect
18097 Generate (do not generate) code to save the TOC value in the reserved
18098 stack location in the function prologue if the function calls through
18099 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
18100 saved in the prologue, it is saved just before the call through the
18101 pointer.  The @option{-mno-save-toc-indirect} option is the default.
18102 @end table
18104 @node RX Options
18105 @subsection RX Options
18106 @cindex RX Options
18108 These command-line options are defined for RX targets:
18110 @table @gcctabopt
18111 @item -m64bit-doubles
18112 @itemx -m32bit-doubles
18113 @opindex m64bit-doubles
18114 @opindex m32bit-doubles
18115 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18116 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18117 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
18118 works on 32-bit values, which is why the default is
18119 @option{-m32bit-doubles}.
18121 @item -fpu
18122 @itemx -nofpu
18123 @opindex fpu
18124 @opindex nofpu
18125 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
18126 floating-point hardware.  The default is enabled for the @var{RX600}
18127 series and disabled for the @var{RX200} series.
18129 Floating-point instructions are only generated for 32-bit floating-point 
18130 values, however, so the FPU hardware is not used for doubles if the
18131 @option{-m64bit-doubles} option is used.
18133 @emph{Note} If the @option{-fpu} option is enabled then
18134 @option{-funsafe-math-optimizations} is also enabled automatically.
18135 This is because the RX FPU instructions are themselves unsafe.
18137 @item -mcpu=@var{name}
18138 @opindex -mcpu
18139 Selects the type of RX CPU to be targeted.  Currently three types are
18140 supported, the generic @var{RX600} and @var{RX200} series hardware and
18141 the specific @var{RX610} CPU.  The default is @var{RX600}.
18143 The only difference between @var{RX600} and @var{RX610} is that the
18144 @var{RX610} does not support the @code{MVTIPL} instruction.
18146 The @var{RX200} series does not have a hardware floating-point unit
18147 and so @option{-nofpu} is enabled by default when this type is
18148 selected.
18150 @item -mbig-endian-data
18151 @itemx -mlittle-endian-data
18152 @opindex mbig-endian-data
18153 @opindex mlittle-endian-data
18154 Store data (but not code) in the big-endian format.  The default is
18155 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
18156 format.
18158 @item -msmall-data-limit=@var{N}
18159 @opindex msmall-data-limit
18160 Specifies the maximum size in bytes of global and static variables
18161 which can be placed into the small data area.  Using the small data
18162 area can lead to smaller and faster code, but the size of area is
18163 limited and it is up to the programmer to ensure that the area does
18164 not overflow.  Also when the small data area is used one of the RX's
18165 registers (usually @code{r13}) is reserved for use pointing to this
18166 area, so it is no longer available for use by the compiler.  This
18167 could result in slower and/or larger code if variables are pushed onto
18168 the stack instead of being held in this register.
18170 Note, common variables (variables that have not been initialized) and
18171 constants are not placed into the small data area as they are assigned
18172 to other sections in the output executable.
18174 The default value is zero, which disables this feature.  Note, this
18175 feature is not enabled by default with higher optimization levels
18176 (@option{-O2} etc) because of the potentially detrimental effects of
18177 reserving a register.  It is up to the programmer to experiment and
18178 discover whether this feature is of benefit to their program.  See the
18179 description of the @option{-mpid} option for a description of how the
18180 actual register to hold the small data area pointer is chosen.
18182 @item -msim
18183 @itemx -mno-sim
18184 @opindex msim
18185 @opindex mno-sim
18186 Use the simulator runtime.  The default is to use the libgloss
18187 board-specific runtime.
18189 @item -mas100-syntax
18190 @itemx -mno-as100-syntax
18191 @opindex mas100-syntax
18192 @opindex mno-as100-syntax
18193 When generating assembler output use a syntax that is compatible with
18194 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
18195 assembler, but it has some restrictions so it is not generated by default.
18197 @item -mmax-constant-size=@var{N}
18198 @opindex mmax-constant-size
18199 Specifies the maximum size, in bytes, of a constant that can be used as
18200 an operand in a RX instruction.  Although the RX instruction set does
18201 allow constants of up to 4 bytes in length to be used in instructions,
18202 a longer value equates to a longer instruction.  Thus in some
18203 circumstances it can be beneficial to restrict the size of constants
18204 that are used in instructions.  Constants that are too big are instead
18205 placed into a constant pool and referenced via register indirection.
18207 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
18208 or 4 means that constants of any size are allowed.
18210 @item -mrelax
18211 @opindex mrelax
18212 Enable linker relaxation.  Linker relaxation is a process whereby the
18213 linker attempts to reduce the size of a program by finding shorter
18214 versions of various instructions.  Disabled by default.
18216 @item -mint-register=@var{N}
18217 @opindex mint-register
18218 Specify the number of registers to reserve for fast interrupt handler
18219 functions.  The value @var{N} can be between 0 and 4.  A value of 1
18220 means that register @code{r13} is reserved for the exclusive use
18221 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
18222 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
18223 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
18224 A value of 0, the default, does not reserve any registers.
18226 @item -msave-acc-in-interrupts
18227 @opindex msave-acc-in-interrupts
18228 Specifies that interrupt handler functions should preserve the
18229 accumulator register.  This is only necessary if normal code might use
18230 the accumulator register, for example because it performs 64-bit
18231 multiplications.  The default is to ignore the accumulator as this
18232 makes the interrupt handlers faster.
18234 @item -mpid
18235 @itemx -mno-pid
18236 @opindex mpid
18237 @opindex mno-pid
18238 Enables the generation of position independent data.  When enabled any
18239 access to constant data is done via an offset from a base address
18240 held in a register.  This allows the location of constant data to be
18241 determined at run time without requiring the executable to be
18242 relocated, which is a benefit to embedded applications with tight
18243 memory constraints.  Data that can be modified is not affected by this
18244 option.
18246 Note, using this feature reserves a register, usually @code{r13}, for
18247 the constant data base address.  This can result in slower and/or
18248 larger code, especially in complicated functions.
18250 The actual register chosen to hold the constant data base address
18251 depends upon whether the @option{-msmall-data-limit} and/or the
18252 @option{-mint-register} command-line options are enabled.  Starting
18253 with register @code{r13} and proceeding downwards, registers are
18254 allocated first to satisfy the requirements of @option{-mint-register},
18255 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
18256 is possible for the small data area register to be @code{r8} if both
18257 @option{-mint-register=4} and @option{-mpid} are specified on the
18258 command line.
18260 By default this feature is not enabled.  The default can be restored
18261 via the @option{-mno-pid} command-line option.
18263 @item -mno-warn-multiple-fast-interrupts
18264 @itemx -mwarn-multiple-fast-interrupts
18265 @opindex mno-warn-multiple-fast-interrupts
18266 @opindex mwarn-multiple-fast-interrupts
18267 Prevents GCC from issuing a warning message if it finds more than one
18268 fast interrupt handler when it is compiling a file.  The default is to
18269 issue a warning for each extra fast interrupt handler found, as the RX
18270 only supports one such interrupt.
18272 @end table
18274 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
18275 has special significance to the RX port when used with the
18276 @code{interrupt} function attribute.  This attribute indicates a
18277 function intended to process fast interrupts.  GCC ensures
18278 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
18279 and/or @code{r13} and only provided that the normal use of the
18280 corresponding registers have been restricted via the
18281 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
18282 options.
18284 @node S/390 and zSeries Options
18285 @subsection S/390 and zSeries Options
18286 @cindex S/390 and zSeries Options
18288 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
18290 @table @gcctabopt
18291 @item -mhard-float
18292 @itemx -msoft-float
18293 @opindex mhard-float
18294 @opindex msoft-float
18295 Use (do not use) the hardware floating-point instructions and registers
18296 for floating-point operations.  When @option{-msoft-float} is specified,
18297 functions in @file{libgcc.a} are used to perform floating-point
18298 operations.  When @option{-mhard-float} is specified, the compiler
18299 generates IEEE floating-point instructions.  This is the default.
18301 @item -mhard-dfp
18302 @itemx -mno-hard-dfp
18303 @opindex mhard-dfp
18304 @opindex mno-hard-dfp
18305 Use (do not use) the hardware decimal-floating-point instructions for
18306 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
18307 specified, functions in @file{libgcc.a} are used to perform
18308 decimal-floating-point operations.  When @option{-mhard-dfp} is
18309 specified, the compiler generates decimal-floating-point hardware
18310 instructions.  This is the default for @option{-march=z9-ec} or higher.
18312 @item -mlong-double-64
18313 @itemx -mlong-double-128
18314 @opindex mlong-double-64
18315 @opindex mlong-double-128
18316 These switches control the size of @code{long double} type. A size
18317 of 64 bits makes the @code{long double} type equivalent to the @code{double}
18318 type. This is the default.
18320 @item -mbackchain
18321 @itemx -mno-backchain
18322 @opindex mbackchain
18323 @opindex mno-backchain
18324 Store (do not store) the address of the caller's frame as backchain pointer
18325 into the callee's stack frame.
18326 A backchain may be needed to allow debugging using tools that do not understand
18327 DWARF 2 call frame information.
18328 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
18329 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
18330 the backchain is placed into the topmost word of the 96/160 byte register
18331 save area.
18333 In general, code compiled with @option{-mbackchain} is call-compatible with
18334 code compiled with @option{-mmo-backchain}; however, use of the backchain
18335 for debugging purposes usually requires that the whole binary is built with
18336 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
18337 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18338 to build a linux kernel use @option{-msoft-float}.
18340 The default is to not maintain the backchain.
18342 @item -mpacked-stack
18343 @itemx -mno-packed-stack
18344 @opindex mpacked-stack
18345 @opindex mno-packed-stack
18346 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
18347 specified, the compiler uses the all fields of the 96/160 byte register save
18348 area only for their default purpose; unused fields still take up stack space.
18349 When @option{-mpacked-stack} is specified, register save slots are densely
18350 packed at the top of the register save area; unused space is reused for other
18351 purposes, allowing for more efficient use of the available stack space.
18352 However, when @option{-mbackchain} is also in effect, the topmost word of
18353 the save area is always used to store the backchain, and the return address
18354 register is always saved two words below the backchain.
18356 As long as the stack frame backchain is not used, code generated with
18357 @option{-mpacked-stack} is call-compatible with code generated with
18358 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
18359 S/390 or zSeries generated code that uses the stack frame backchain at run
18360 time, not just for debugging purposes.  Such code is not call-compatible
18361 with code compiled with @option{-mpacked-stack}.  Also, note that the
18362 combination of @option{-mbackchain},
18363 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18364 to build a linux kernel use @option{-msoft-float}.
18366 The default is to not use the packed stack layout.
18368 @item -msmall-exec
18369 @itemx -mno-small-exec
18370 @opindex msmall-exec
18371 @opindex mno-small-exec
18372 Generate (or do not generate) code using the @code{bras} instruction
18373 to do subroutine calls.
18374 This only works reliably if the total executable size does not
18375 exceed 64k.  The default is to use the @code{basr} instruction instead,
18376 which does not have this limitation.
18378 @item -m64
18379 @itemx -m31
18380 @opindex m64
18381 @opindex m31
18382 When @option{-m31} is specified, generate code compliant to the
18383 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
18384 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
18385 particular to generate 64-bit instructions.  For the @samp{s390}
18386 targets, the default is @option{-m31}, while the @samp{s390x}
18387 targets default to @option{-m64}.
18389 @item -mzarch
18390 @itemx -mesa
18391 @opindex mzarch
18392 @opindex mesa
18393 When @option{-mzarch} is specified, generate code using the
18394 instructions available on z/Architecture.
18395 When @option{-mesa} is specified, generate code using the
18396 instructions available on ESA/390.  Note that @option{-mesa} is
18397 not possible with @option{-m64}.
18398 When generating code compliant to the GNU/Linux for S/390 ABI,
18399 the default is @option{-mesa}.  When generating code compliant
18400 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
18402 @item -mmvcle
18403 @itemx -mno-mvcle
18404 @opindex mmvcle
18405 @opindex mno-mvcle
18406 Generate (or do not generate) code using the @code{mvcle} instruction
18407 to perform block moves.  When @option{-mno-mvcle} is specified,
18408 use a @code{mvc} loop instead.  This is the default unless optimizing for
18409 size.
18411 @item -mdebug
18412 @itemx -mno-debug
18413 @opindex mdebug
18414 @opindex mno-debug
18415 Print (or do not print) additional debug information when compiling.
18416 The default is to not print debug information.
18418 @item -march=@var{cpu-type}
18419 @opindex march
18420 Generate code that runs on @var{cpu-type}, which is the name of a system
18421 representing a certain processor type.  Possible values for
18422 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
18423 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
18424 When generating code using the instructions available on z/Architecture,
18425 the default is @option{-march=z900}.  Otherwise, the default is
18426 @option{-march=g5}.
18428 @item -mtune=@var{cpu-type}
18429 @opindex mtune
18430 Tune to @var{cpu-type} everything applicable about the generated code,
18431 except for the ABI and the set of available instructions.
18432 The list of @var{cpu-type} values is the same as for @option{-march}.
18433 The default is the value used for @option{-march}.
18435 @item -mtpf-trace
18436 @itemx -mno-tpf-trace
18437 @opindex mtpf-trace
18438 @opindex mno-tpf-trace
18439 Generate code that adds (does not add) in TPF OS specific branches to trace
18440 routines in the operating system.  This option is off by default, even
18441 when compiling for the TPF OS@.
18443 @item -mfused-madd
18444 @itemx -mno-fused-madd
18445 @opindex mfused-madd
18446 @opindex mno-fused-madd
18447 Generate code that uses (does not use) the floating-point multiply and
18448 accumulate instructions.  These instructions are generated by default if
18449 hardware floating point is used.
18451 @item -mwarn-framesize=@var{framesize}
18452 @opindex mwarn-framesize
18453 Emit a warning if the current function exceeds the given frame size.  Because
18454 this is a compile-time check it doesn't need to be a real problem when the program
18455 runs.  It is intended to identify functions that most probably cause
18456 a stack overflow.  It is useful to be used in an environment with limited stack
18457 size e.g.@: the linux kernel.
18459 @item -mwarn-dynamicstack
18460 @opindex mwarn-dynamicstack
18461 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
18462 arrays.  This is generally a bad idea with a limited stack size.
18464 @item -mstack-guard=@var{stack-guard}
18465 @itemx -mstack-size=@var{stack-size}
18466 @opindex mstack-guard
18467 @opindex mstack-size
18468 If these options are provided the S/390 back end emits additional instructions in
18469 the function prologue that trigger a trap if the stack size is @var{stack-guard}
18470 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
18471 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
18472 the frame size of the compiled function is chosen.
18473 These options are intended to be used to help debugging stack overflow problems.
18474 The additionally emitted code causes only little overhead and hence can also be
18475 used in production-like systems without greater performance degradation.  The given
18476 values have to be exact powers of 2 and @var{stack-size} has to be greater than
18477 @var{stack-guard} without exceeding 64k.
18478 In order to be efficient the extra code makes the assumption that the stack starts
18479 at an address aligned to the value given by @var{stack-size}.
18480 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
18482 @item -mhotpatch[=@var{halfwords}]
18483 @itemx -mno-hotpatch
18484 @opindex mhotpatch
18485 If the hotpatch option is enabled, a ``hot-patching'' function
18486 prologue is generated for all functions in the compilation unit.
18487 The funtion label is prepended with the given number of two-byte
18488 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
18489 instructions if no argument is present.  Functions with a
18490 hot-patching prologue are never inlined automatically, and a
18491 hot-patching prologue is never generated for functions functions
18492 that are explicitly inline.
18494 This option can be overridden for individual functions with the
18495 @code{hotpatch} attribute.
18496 @end table
18498 @node Score Options
18499 @subsection Score Options
18500 @cindex Score Options
18502 These options are defined for Score implementations:
18504 @table @gcctabopt
18505 @item -meb
18506 @opindex meb
18507 Compile code for big-endian mode.  This is the default.
18509 @item -mel
18510 @opindex mel
18511 Compile code for little-endian mode.
18513 @item -mnhwloop
18514 @opindex mnhwloop
18515 Disable generation of @code{bcnz} instructions.
18517 @item -muls
18518 @opindex muls
18519 Enable generation of unaligned load and store instructions.
18521 @item -mmac
18522 @opindex mmac
18523 Enable the use of multiply-accumulate instructions. Disabled by default.
18525 @item -mscore5
18526 @opindex mscore5
18527 Specify the SCORE5 as the target architecture.
18529 @item -mscore5u
18530 @opindex mscore5u
18531 Specify the SCORE5U of the target architecture.
18533 @item -mscore7
18534 @opindex mscore7
18535 Specify the SCORE7 as the target architecture. This is the default.
18537 @item -mscore7d
18538 @opindex mscore7d
18539 Specify the SCORE7D as the target architecture.
18540 @end table
18542 @node SH Options
18543 @subsection SH Options
18545 These @samp{-m} options are defined for the SH implementations:
18547 @table @gcctabopt
18548 @item -m1
18549 @opindex m1
18550 Generate code for the SH1.
18552 @item -m2
18553 @opindex m2
18554 Generate code for the SH2.
18556 @item -m2e
18557 Generate code for the SH2e.
18559 @item -m2a-nofpu
18560 @opindex m2a-nofpu
18561 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
18562 that the floating-point unit is not used.
18564 @item -m2a-single-only
18565 @opindex m2a-single-only
18566 Generate code for the SH2a-FPU, in such a way that no double-precision
18567 floating-point operations are used.
18569 @item -m2a-single
18570 @opindex m2a-single
18571 Generate code for the SH2a-FPU assuming the floating-point unit is in
18572 single-precision mode by default.
18574 @item -m2a
18575 @opindex m2a
18576 Generate code for the SH2a-FPU assuming the floating-point unit is in
18577 double-precision mode by default.
18579 @item -m3
18580 @opindex m3
18581 Generate code for the SH3.
18583 @item -m3e
18584 @opindex m3e
18585 Generate code for the SH3e.
18587 @item -m4-nofpu
18588 @opindex m4-nofpu
18589 Generate code for the SH4 without a floating-point unit.
18591 @item -m4-single-only
18592 @opindex m4-single-only
18593 Generate code for the SH4 with a floating-point unit that only
18594 supports single-precision arithmetic.
18596 @item -m4-single
18597 @opindex m4-single
18598 Generate code for the SH4 assuming the floating-point unit is in
18599 single-precision mode by default.
18601 @item -m4
18602 @opindex m4
18603 Generate code for the SH4.
18605 @item -m4a-nofpu
18606 @opindex m4a-nofpu
18607 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18608 floating-point unit is not used.
18610 @item -m4a-single-only
18611 @opindex m4a-single-only
18612 Generate code for the SH4a, in such a way that no double-precision
18613 floating-point operations are used.
18615 @item -m4a-single
18616 @opindex m4a-single
18617 Generate code for the SH4a assuming the floating-point unit is in
18618 single-precision mode by default.
18620 @item -m4a
18621 @opindex m4a
18622 Generate code for the SH4a.
18624 @item -m4al
18625 @opindex m4al
18626 Same as @option{-m4a-nofpu}, except that it implicitly passes
18627 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
18628 instructions at the moment.
18630 @item -mb
18631 @opindex mb
18632 Compile code for the processor in big-endian mode.
18634 @item -ml
18635 @opindex ml
18636 Compile code for the processor in little-endian mode.
18638 @item -mdalign
18639 @opindex mdalign
18640 Align doubles at 64-bit boundaries.  Note that this changes the calling
18641 conventions, and thus some functions from the standard C library do
18642 not work unless you recompile it first with @option{-mdalign}.
18644 @item -mrelax
18645 @opindex mrelax
18646 Shorten some address references at link time, when possible; uses the
18647 linker option @option{-relax}.
18649 @item -mbigtable
18650 @opindex mbigtable
18651 Use 32-bit offsets in @code{switch} tables.  The default is to use
18652 16-bit offsets.
18654 @item -mbitops
18655 @opindex mbitops
18656 Enable the use of bit manipulation instructions on SH2A.
18658 @item -mfmovd
18659 @opindex mfmovd
18660 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
18661 alignment constraints.
18663 @item -mhitachi
18664 @opindex mhitachi
18665 Comply with the calling conventions defined by Renesas.
18667 @item -mrenesas
18668 @opindex mhitachi
18669 Comply with the calling conventions defined by Renesas.
18671 @item -mno-renesas
18672 @opindex mhitachi
18673 Comply with the calling conventions defined for GCC before the Renesas
18674 conventions were available.  This option is the default for all
18675 targets of the SH toolchain.
18677 @item -mnomacsave
18678 @opindex mnomacsave
18679 Mark the @code{MAC} register as call-clobbered, even if
18680 @option{-mhitachi} is given.
18682 @item -mieee
18683 @itemx -mno-ieee
18684 @opindex mieee
18685 @opindex mnoieee
18686 Control the IEEE compliance of floating-point comparisons, which affects the
18687 handling of cases where the result of a comparison is unordered.  By default
18688 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
18689 enabled @option{-mno-ieee} is implicitly set, which results in faster
18690 floating-point greater-equal and less-equal comparisons.  The implcit settings
18691 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18693 @item -minline-ic_invalidate
18694 @opindex minline-ic_invalidate
18695 Inline code to invalidate instruction cache entries after setting up
18696 nested function trampolines.
18697 This option has no effect if @option{-musermode} is in effect and the selected
18698 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18699 instruction.
18700 If the selected code generation option does not allow the use of the @code{icbi}
18701 instruction, and @option{-musermode} is not in effect, the inlined code
18702 manipulates the instruction cache address array directly with an associative
18703 write.  This not only requires privileged mode at run time, but it also
18704 fails if the cache line had been mapped via the TLB and has become unmapped.
18706 @item -misize
18707 @opindex misize
18708 Dump instruction size and location in the assembly code.
18710 @item -mpadstruct
18711 @opindex mpadstruct
18712 This option is deprecated.  It pads structures to multiple of 4 bytes,
18713 which is incompatible with the SH ABI@.
18715 @item -matomic-model=@var{model}
18716 @opindex matomic-model=@var{model}
18717 Sets the model of atomic operations and additional parameters as a comma
18718 separated list.  For details on the atomic built-in functions see
18719 @ref{__atomic Builtins}.  The following models and parameters are supported:
18721 @table @samp
18723 @item none
18724 Disable compiler generated atomic sequences and emit library calls for atomic
18725 operations.  This is the default if the target is not @code{sh-*-linux*}.
18727 @item soft-gusa
18728 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18729 built-in functions.  The generated atomic sequences require additional support
18730 from the interrupt/exception handling code of the system and are only suitable
18731 for SH3* and SH4* single-core systems.  This option is enabled by default when
18732 the target is @code{sh-*-linux*} and SH3* or SH4*.  When the target is SH4A,
18733 this option will also partially utilize the hardware atomic instructions
18734 @code{movli.l} and @code{movco.l} to create more efficient code, unless
18735 @samp{strict} is specified.  
18737 @item soft-tcb
18738 Generate software atomic sequences that use a variable in the thread control
18739 block.  This is a variation of the gUSA sequences which can also be used on
18740 SH1* and SH2* targets.  The generated atomic sequences require additional
18741 support from the interrupt/exception handling code of the system and are only
18742 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
18743 parameter has to be specified as well.
18745 @item soft-imask
18746 Generate software atomic sequences that temporarily disable interrupts by
18747 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
18748 in privileged mode and is only suitable for single-core systems.  Additional
18749 support from the interrupt/exception handling code of the system is not
18750 required.  This model is enabled by default when the target is
18751 @code{sh-*-linux*} and SH1* or SH2*.
18753 @item hard-llcs
18754 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
18755 instructions only.  This is only available on SH4A and is suitable for
18756 multi-core systems.  Since the hardware instructions support only 32 bit atomic
18757 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
18758 Code compiled with this option will also be compatible with other software
18759 atomic model interrupt/exception handling systems if executed on an SH4A
18760 system.  Additional support from the interrupt/exception handling code of the
18761 system is not required for this model.
18763 @item gbr-offset=
18764 This parameter specifies the offset in bytes of the variable in the thread
18765 control block structure that should be used by the generated atomic sequences
18766 when the @samp{soft-tcb} model has been selected.  For other models this
18767 parameter is ignored.  The specified value must be an integer multiple of four
18768 and in the range 0-1020.
18770 @item strict
18771 This parameter prevents mixed usage of multiple atomic models, even though they
18772 would be compatible, and will make the compiler generate atomic sequences of the
18773 specified model only.
18775 @end table
18777 @item -mtas
18778 @opindex mtas
18779 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18780 Notice that depending on the particular hardware and software configuration
18781 this can degrade overall performance due to the operand cache line flushes
18782 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
18783 processors the @code{tas.b} instruction must be used with caution since it
18784 can result in data corruption for certain cache configurations.
18786 @item -mspace
18787 @opindex mspace
18788 Optimize for space instead of speed.  Implied by @option{-Os}.
18790 @item -mprefergot
18791 @opindex mprefergot
18792 When generating position-independent code, emit function calls using
18793 the Global Offset Table instead of the Procedure Linkage Table.
18795 @item -musermode
18796 @opindex musermode
18797 Don't generate privileged mode only code.  This option
18798 implies @option{-mno-inline-ic_invalidate}
18799 if the inlined code would not work in user mode.
18800 This is the default when the target is @code{sh-*-linux*}.
18802 @item -multcost=@var{number}
18803 @opindex multcost=@var{number}
18804 Set the cost to assume for a multiply insn.
18806 @item -mdiv=@var{strategy}
18807 @opindex mdiv=@var{strategy}
18808 Set the division strategy to be used for integer division operations.
18809 For SHmedia @var{strategy} can be one of: 
18811 @table @samp
18813 @item fp 
18814 Performs the operation in floating point.  This has a very high latency,
18815 but needs only a few instructions, so it might be a good choice if
18816 your code has enough easily-exploitable ILP to allow the compiler to
18817 schedule the floating-point instructions together with other instructions.
18818 Division by zero causes a floating-point exception.
18820 @item inv
18821 Uses integer operations to calculate the inverse of the divisor,
18822 and then multiplies the dividend with the inverse.  This strategy allows
18823 CSE and hoisting of the inverse calculation.  Division by zero calculates
18824 an unspecified result, but does not trap.
18826 @item inv:minlat
18827 A variant of @samp{inv} where, if no CSE or hoisting opportunities
18828 have been found, or if the entire operation has been hoisted to the same
18829 place, the last stages of the inverse calculation are intertwined with the
18830 final multiply to reduce the overall latency, at the expense of using a few
18831 more instructions, and thus offering fewer scheduling opportunities with
18832 other code.
18834 @item call
18835 Calls a library function that usually implements the @samp{inv:minlat}
18836 strategy.
18837 This gives high code density for @code{m5-*media-nofpu} compilations.
18839 @item call2
18840 Uses a different entry point of the same library function, where it
18841 assumes that a pointer to a lookup table has already been set up, which
18842 exposes the pointer load to CSE and code hoisting optimizations.
18844 @item inv:call
18845 @itemx inv:call2
18846 @itemx inv:fp
18847 Use the @samp{inv} algorithm for initial
18848 code generation, but if the code stays unoptimized, revert to the @samp{call},
18849 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
18850 potentially-trapping side effect of division by zero is carried by a
18851 separate instruction, so it is possible that all the integer instructions
18852 are hoisted out, but the marker for the side effect stays where it is.
18853 A recombination to floating-point operations or a call is not possible
18854 in that case.
18856 @item inv20u
18857 @itemx inv20l
18858 Variants of the @samp{inv:minlat} strategy.  In the case
18859 that the inverse calculation is not separated from the multiply, they speed
18860 up division where the dividend fits into 20 bits (plus sign where applicable)
18861 by inserting a test to skip a number of operations in this case; this test
18862 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
18863 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
18865 @end table
18867 For targets other than SHmedia @var{strategy} can be one of:
18869 @table @samp
18871 @item call-div1
18872 Calls a library function that uses the single-step division instruction
18873 @code{div1} to perform the operation.  Division by zero calculates an
18874 unspecified result and does not trap.  This is the default except for SH4,
18875 SH2A and SHcompact.
18877 @item call-fp
18878 Calls a library function that performs the operation in double precision
18879 floating point.  Division by zero causes a floating-point exception.  This is
18880 the default for SHcompact with FPU.  Specifying this for targets that do not
18881 have a double precision FPU will default to @code{call-div1}.
18883 @item call-table
18884 Calls a library function that uses a lookup table for small divisors and
18885 the @code{div1} instruction with case distinction for larger divisors.  Division
18886 by zero calculates an unspecified result and does not trap.  This is the default
18887 for SH4.  Specifying this for targets that do not have dynamic shift
18888 instructions will default to @code{call-div1}.
18890 @end table
18892 When a division strategy has not been specified the default strategy will be
18893 selected based on the current target.  For SH2A the default strategy is to
18894 use the @code{divs} and @code{divu} instructions instead of library function
18895 calls.
18897 @item -maccumulate-outgoing-args
18898 @opindex maccumulate-outgoing-args
18899 Reserve space once for outgoing arguments in the function prologue rather
18900 than around each call.  Generally beneficial for performance and size.  Also
18901 needed for unwinding to avoid changing the stack frame around conditional code.
18903 @item -mdivsi3_libfunc=@var{name}
18904 @opindex mdivsi3_libfunc=@var{name}
18905 Set the name of the library function used for 32-bit signed division to
18906 @var{name}.
18907 This only affects the name used in the @samp{call} and @samp{inv:call}
18908 division strategies, and the compiler still expects the same
18909 sets of input/output/clobbered registers as if this option were not present.
18911 @item -mfixed-range=@var{register-range}
18912 @opindex mfixed-range
18913 Generate code treating the given register range as fixed registers.
18914 A fixed register is one that the register allocator can not use.  This is
18915 useful when compiling kernel code.  A register range is specified as
18916 two registers separated by a dash.  Multiple register ranges can be
18917 specified separated by a comma.
18919 @item -mindexed-addressing
18920 @opindex mindexed-addressing
18921 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18922 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18923 semantics for the indexed addressing mode.  The architecture allows the
18924 implementation of processors with 64-bit MMU, which the OS could use to
18925 get 32-bit addressing, but since no current hardware implementation supports
18926 this or any other way to make the indexed addressing mode safe to use in
18927 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18929 @item -mgettrcost=@var{number}
18930 @opindex mgettrcost=@var{number}
18931 Set the cost assumed for the @code{gettr} instruction to @var{number}.
18932 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18934 @item -mpt-fixed
18935 @opindex mpt-fixed
18936 Assume @code{pt*} instructions won't trap.  This generally generates
18937 better-scheduled code, but is unsafe on current hardware.
18938 The current architecture
18939 definition says that @code{ptabs} and @code{ptrel} trap when the target 
18940 anded with 3 is 3.
18941 This has the unintentional effect of making it unsafe to schedule these
18942 instructions before a branch, or hoist them out of a loop.  For example,
18943 @code{__do_global_ctors}, a part of @file{libgcc}
18944 that runs constructors at program
18945 startup, calls functions in a list which is delimited by @minus{}1.  With the
18946 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
18947 That means that all the constructors run a bit more quickly, but when
18948 the loop comes to the end of the list, the program crashes because @code{ptabs}
18949 loads @minus{}1 into a target register.  
18951 Since this option is unsafe for any
18952 hardware implementing the current architecture specification, the default
18953 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
18954 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
18955 this deters register allocation from using target registers for storing
18956 ordinary integers.
18958 @item -minvalid-symbols
18959 @opindex minvalid-symbols
18960 Assume symbols might be invalid.  Ordinary function symbols generated by
18961 the compiler are always valid to load with
18962 @code{movi}/@code{shori}/@code{ptabs} or
18963 @code{movi}/@code{shori}/@code{ptrel},
18964 but with assembler and/or linker tricks it is possible
18965 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
18966 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18967 It prevents cross-basic-block CSE, hoisting and most scheduling
18968 of symbol loads.  The default is @option{-mno-invalid-symbols}.
18970 @item -mbranch-cost=@var{num}
18971 @opindex mbranch-cost=@var{num}
18972 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
18973 make the compiler try to generate more branch-free code if possible.  
18974 If not specified the value is selected depending on the processor type that
18975 is being compiled for.
18977 @item -mzdcbranch
18978 @itemx -mno-zdcbranch
18979 @opindex mzdcbranch
18980 @opindex mno-zdcbranch
18981 Assume (do not assume) that zero displacement conditional branch instructions
18982 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
18983 compiler will try to prefer zero displacement branch code sequences.  This is
18984 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
18985 disabled by specifying @option{-mno-zdcbranch}.
18987 @item -mcbranchdi
18988 @opindex mcbranchdi
18989 Enable the @code{cbranchdi4} instruction pattern.
18991 @item -mcmpeqdi
18992 @opindex mcmpeqdi
18993 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18994 is in effect.
18996 @item -mfused-madd
18997 @itemx -mno-fused-madd
18998 @opindex mfused-madd
18999 @opindex mno-fused-madd
19000 Generate code that uses (does not use) the floating-point multiply and
19001 accumulate instructions.  These instructions are generated by default
19002 if hardware floating point is used.  The machine-dependent
19003 @option{-mfused-madd} option is now mapped to the machine-independent
19004 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19005 mapped to @option{-ffp-contract=off}.
19007 @item -mfsca
19008 @itemx -mno-fsca
19009 @opindex mfsca
19010 @opindex mno-fsca
19011 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
19012 and cosine approximations.  The option @code{-mfsca} must be used in
19013 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
19014 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
19015 approximations even if @code{-funsafe-math-optimizations} is in effect.
19017 @item -mfsrra
19018 @itemx -mno-fsrra
19019 @opindex mfsrra
19020 @opindex mno-fsrra
19021 Allow or disallow the compiler to emit the @code{fsrra} instruction for
19022 reciprocal square root approximations.  The option @code{-mfsrra} must be used
19023 in combination with @code{-funsafe-math-optimizations} and
19024 @code{-ffinite-math-only}.  It is enabled by default when generating code for
19025 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
19026 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
19027 in effect.
19029 @item -mpretend-cmove
19030 @opindex mpretend-cmove
19031 Prefer zero-displacement conditional branches for conditional move instruction
19032 patterns.  This can result in faster code on the SH4 processor.
19034 @end table
19036 @node Solaris 2 Options
19037 @subsection Solaris 2 Options
19038 @cindex Solaris 2 options
19040 These @samp{-m} options are supported on Solaris 2:
19042 @table @gcctabopt
19043 @item -mimpure-text
19044 @opindex mimpure-text
19045 @option{-mimpure-text}, used in addition to @option{-shared}, tells
19046 the compiler to not pass @option{-z text} to the linker when linking a
19047 shared object.  Using this option, you can link position-dependent
19048 code into a shared object.
19050 @option{-mimpure-text} suppresses the ``relocations remain against
19051 allocatable but non-writable sections'' linker error message.
19052 However, the necessary relocations trigger copy-on-write, and the
19053 shared object is not actually shared across processes.  Instead of
19054 using @option{-mimpure-text}, you should compile all source code with
19055 @option{-fpic} or @option{-fPIC}.
19057 @end table
19059 These switches are supported in addition to the above on Solaris 2:
19061 @table @gcctabopt
19062 @item -pthreads
19063 @opindex pthreads
19064 Add support for multithreading using the POSIX threads library.  This
19065 option sets flags for both the preprocessor and linker.  This option does
19066 not affect the thread safety of object code produced  by the compiler or
19067 that of libraries supplied with it.
19069 @item -pthread
19070 @opindex pthread
19071 This is a synonym for @option{-pthreads}.
19072 @end table
19074 @node SPARC Options
19075 @subsection SPARC Options
19076 @cindex SPARC options
19078 These @samp{-m} options are supported on the SPARC:
19080 @table @gcctabopt
19081 @item -mno-app-regs
19082 @itemx -mapp-regs
19083 @opindex mno-app-regs
19084 @opindex mapp-regs
19085 Specify @option{-mapp-regs} to generate output using the global registers
19086 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
19087 is the default.
19089 To be fully SVR4 ABI-compliant at the cost of some performance loss,
19090 specify @option{-mno-app-regs}.  You should compile libraries and system
19091 software with this option.
19093 @item -mflat
19094 @itemx -mno-flat
19095 @opindex mflat
19096 @opindex mno-flat
19097 With @option{-mflat}, the compiler does not generate save/restore instructions
19098 and uses a ``flat'' or single register window model.  This model is compatible
19099 with the regular register window model.  The local registers and the input
19100 registers (0--5) are still treated as ``call-saved'' registers and are
19101 saved on the stack as needed.
19103 With @option{-mno-flat} (the default), the compiler generates save/restore
19104 instructions (except for leaf functions).  This is the normal operating mode.
19106 @item -mfpu
19107 @itemx -mhard-float
19108 @opindex mfpu
19109 @opindex mhard-float
19110 Generate output containing floating-point instructions.  This is the
19111 default.
19113 @item -mno-fpu
19114 @itemx -msoft-float
19115 @opindex mno-fpu
19116 @opindex msoft-float
19117 Generate output containing library calls for floating point.
19118 @strong{Warning:} the requisite libraries are not available for all SPARC
19119 targets.  Normally the facilities of the machine's usual C compiler are
19120 used, but this cannot be done directly in cross-compilation.  You must make
19121 your own arrangements to provide suitable library functions for
19122 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
19123 @samp{sparclite-*-*} do provide software floating-point support.
19125 @option{-msoft-float} changes the calling convention in the output file;
19126 therefore, it is only useful if you compile @emph{all} of a program with
19127 this option.  In particular, you need to compile @file{libgcc.a}, the
19128 library that comes with GCC, with @option{-msoft-float} in order for
19129 this to work.
19131 @item -mhard-quad-float
19132 @opindex mhard-quad-float
19133 Generate output containing quad-word (long double) floating-point
19134 instructions.
19136 @item -msoft-quad-float
19137 @opindex msoft-quad-float
19138 Generate output containing library calls for quad-word (long double)
19139 floating-point instructions.  The functions called are those specified
19140 in the SPARC ABI@.  This is the default.
19142 As of this writing, there are no SPARC implementations that have hardware
19143 support for the quad-word floating-point instructions.  They all invoke
19144 a trap handler for one of these instructions, and then the trap handler
19145 emulates the effect of the instruction.  Because of the trap handler overhead,
19146 this is much slower than calling the ABI library routines.  Thus the
19147 @option{-msoft-quad-float} option is the default.
19149 @item -mno-unaligned-doubles
19150 @itemx -munaligned-doubles
19151 @opindex mno-unaligned-doubles
19152 @opindex munaligned-doubles
19153 Assume that doubles have 8-byte alignment.  This is the default.
19155 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
19156 alignment only if they are contained in another type, or if they have an
19157 absolute address.  Otherwise, it assumes they have 4-byte alignment.
19158 Specifying this option avoids some rare compatibility problems with code
19159 generated by other compilers.  It is not the default because it results
19160 in a performance loss, especially for floating-point code.
19162 @item -mno-faster-structs
19163 @itemx -mfaster-structs
19164 @opindex mno-faster-structs
19165 @opindex mfaster-structs
19166 With @option{-mfaster-structs}, the compiler assumes that structures
19167 should have 8-byte alignment.  This enables the use of pairs of
19168 @code{ldd} and @code{std} instructions for copies in structure
19169 assignment, in place of twice as many @code{ld} and @code{st} pairs.
19170 However, the use of this changed alignment directly violates the SPARC
19171 ABI@.  Thus, it's intended only for use on targets where the developer
19172 acknowledges that their resulting code is not directly in line with
19173 the rules of the ABI@.
19175 @item -mcpu=@var{cpu_type}
19176 @opindex mcpu
19177 Set the instruction set, register set, and instruction scheduling parameters
19178 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
19179 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
19180 @samp{leon}, @samp{leon3}, @samp{sparclite}, @samp{f930}, @samp{f934},
19181 @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
19182 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
19183 @samp{niagara3} and @samp{niagara4}.
19185 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
19186 which selects the best architecture option for the host processor.
19187 @option{-mcpu=native} has no effect if GCC does not recognize
19188 the processor.
19190 Default instruction scheduling parameters are used for values that select
19191 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
19192 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
19194 Here is a list of each supported architecture and their supported
19195 implementations.
19197 @table @asis
19198 @item v7
19199 cypress
19201 @item v8
19202 supersparc, hypersparc, leon, leon3
19204 @item sparclite
19205 f930, f934, sparclite86x
19207 @item sparclet
19208 tsc701
19210 @item v9
19211 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
19212 @end table
19214 By default (unless configured otherwise), GCC generates code for the V7
19215 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
19216 additionally optimizes it for the Cypress CY7C602 chip, as used in the
19217 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
19218 SPARCStation 1, 2, IPX etc.
19220 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
19221 architecture.  The only difference from V7 code is that the compiler emits
19222 the integer multiply and integer divide instructions which exist in SPARC-V8
19223 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
19224 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
19225 2000 series.
19227 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
19228 the SPARC architecture.  This adds the integer multiply, integer divide step
19229 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
19230 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
19231 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
19232 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
19233 MB86934 chip, which is the more recent SPARClite with FPU@.
19235 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
19236 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
19237 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
19238 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
19239 optimizes it for the TEMIC SPARClet chip.
19241 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
19242 architecture.  This adds 64-bit integer and floating-point move instructions,
19243 3 additional floating-point condition code registers and conditional move
19244 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
19245 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
19246 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
19247 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
19248 @option{-mcpu=niagara}, the compiler additionally optimizes it for
19249 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
19250 additionally optimizes it for Sun UltraSPARC T2 chips. With
19251 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
19252 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
19253 additionally optimizes it for Sun UltraSPARC T4 chips.
19255 @item -mtune=@var{cpu_type}
19256 @opindex mtune
19257 Set the instruction scheduling parameters for machine type
19258 @var{cpu_type}, but do not set the instruction set or register set that the
19259 option @option{-mcpu=@var{cpu_type}} does.
19261 The same values for @option{-mcpu=@var{cpu_type}} can be used for
19262 @option{-mtune=@var{cpu_type}}, but the only useful values are those
19263 that select a particular CPU implementation.  Those are @samp{cypress},
19264 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3}, @samp{f930},
19265 @samp{f934}, @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
19266 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3} and
19267 @samp{niagara4}.  With native Solaris and GNU/Linux toolchains, @samp{native}
19268 can also be used.
19270 @item -mv8plus
19271 @itemx -mno-v8plus
19272 @opindex mv8plus
19273 @opindex mno-v8plus
19274 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
19275 difference from the V8 ABI is that the global and out registers are
19276 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
19277 mode for all SPARC-V9 processors.
19279 @item -mvis
19280 @itemx -mno-vis
19281 @opindex mvis
19282 @opindex mno-vis
19283 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
19284 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
19286 @item -mvis2
19287 @itemx -mno-vis2
19288 @opindex mvis2
19289 @opindex mno-vis2
19290 With @option{-mvis2}, GCC generates code that takes advantage of
19291 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
19292 default is @option{-mvis2} when targeting a cpu that supports such
19293 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
19294 also sets @option{-mvis}.
19296 @item -mvis3
19297 @itemx -mno-vis3
19298 @opindex mvis3
19299 @opindex mno-vis3
19300 With @option{-mvis3}, GCC generates code that takes advantage of
19301 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
19302 default is @option{-mvis3} when targeting a cpu that supports such
19303 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
19304 also sets @option{-mvis2} and @option{-mvis}.
19306 @item -mcbcond
19307 @itemx -mno-cbcond
19308 @opindex mcbcond
19309 @opindex mno-cbcond
19310 With @option{-mcbcond}, GCC generates code that takes advantage of
19311 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
19312 The default is @option{-mcbcond} when targeting a cpu that supports such
19313 instructions, such as niagara-4 and later.
19315 @item -mpopc
19316 @itemx -mno-popc
19317 @opindex mpopc
19318 @opindex mno-popc
19319 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
19320 population count instruction.  The default is @option{-mpopc}
19321 when targeting a cpu that supports such instructions, such as Niagara-2 and
19322 later.
19324 @item -mfmaf
19325 @itemx -mno-fmaf
19326 @opindex mfmaf
19327 @opindex mno-fmaf
19328 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
19329 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
19330 when targeting a cpu that supports such instructions, such as Niagara-3 and
19331 later.
19333 @item -mfix-at697f
19334 @opindex mfix-at697f
19335 Enable the documented workaround for the single erratum of the Atmel AT697F
19336 processor (which corresponds to erratum #13 of the AT697E processor).
19338 @item -mfix-ut699
19339 @opindex mfix-ut699
19340 Enable the documented workarounds for the floating-point errata and the data
19341 cache nullify errata of the UT699 processor.
19342 @end table
19344 These @samp{-m} options are supported in addition to the above
19345 on SPARC-V9 processors in 64-bit environments:
19347 @table @gcctabopt
19348 @item -m32
19349 @itemx -m64
19350 @opindex m32
19351 @opindex m64
19352 Generate code for a 32-bit or 64-bit environment.
19353 The 32-bit environment sets int, long and pointer to 32 bits.
19354 The 64-bit environment sets int to 32 bits and long and pointer
19355 to 64 bits.
19357 @item -mcmodel=@var{which}
19358 @opindex mcmodel
19359 Set the code model to one of
19361 @table @samp
19362 @item medlow
19363 The Medium/Low code model: 64-bit addresses, programs
19364 must be linked in the low 32 bits of memory.  Programs can be statically
19365 or dynamically linked.
19367 @item medmid
19368 The Medium/Middle code model: 64-bit addresses, programs
19369 must be linked in the low 44 bits of memory, the text and data segments must
19370 be less than 2GB in size and the data segment must be located within 2GB of
19371 the text segment.
19373 @item medany
19374 The Medium/Anywhere code model: 64-bit addresses, programs
19375 may be linked anywhere in memory, the text and data segments must be less
19376 than 2GB in size and the data segment must be located within 2GB of the
19377 text segment.
19379 @item embmedany
19380 The Medium/Anywhere code model for embedded systems:
19381 64-bit addresses, the text and data segments must be less than 2GB in
19382 size, both starting anywhere in memory (determined at link time).  The
19383 global register %g4 points to the base of the data segment.  Programs
19384 are statically linked and PIC is not supported.
19385 @end table
19387 @item -mmemory-model=@var{mem-model}
19388 @opindex mmemory-model
19389 Set the memory model in force on the processor to one of
19391 @table @samp
19392 @item default
19393 The default memory model for the processor and operating system.
19395 @item rmo
19396 Relaxed Memory Order
19398 @item pso
19399 Partial Store Order
19401 @item tso
19402 Total Store Order
19404 @item sc
19405 Sequential Consistency
19406 @end table
19408 These memory models are formally defined in Appendix D of the Sparc V9
19409 architecture manual, as set in the processor's @code{PSTATE.MM} field.
19411 @item -mstack-bias
19412 @itemx -mno-stack-bias
19413 @opindex mstack-bias
19414 @opindex mno-stack-bias
19415 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
19416 frame pointer if present, are offset by @minus{}2047 which must be added back
19417 when making stack frame references.  This is the default in 64-bit mode.
19418 Otherwise, assume no such offset is present.
19419 @end table
19421 @node SPU Options
19422 @subsection SPU Options
19423 @cindex SPU options
19425 These @samp{-m} options are supported on the SPU:
19427 @table @gcctabopt
19428 @item -mwarn-reloc
19429 @itemx -merror-reloc
19430 @opindex mwarn-reloc
19431 @opindex merror-reloc
19433 The loader for SPU does not handle dynamic relocations.  By default, GCC
19434 gives an error when it generates code that requires a dynamic
19435 relocation.  @option{-mno-error-reloc} disables the error,
19436 @option{-mwarn-reloc} generates a warning instead.
19438 @item -msafe-dma
19439 @itemx -munsafe-dma
19440 @opindex msafe-dma
19441 @opindex munsafe-dma
19443 Instructions that initiate or test completion of DMA must not be
19444 reordered with respect to loads and stores of the memory that is being
19445 accessed.
19446 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
19447 memory accesses, but that can lead to inefficient code in places where the
19448 memory is known to not change.  Rather than mark the memory as volatile,
19449 you can use @option{-msafe-dma} to tell the compiler to treat
19450 the DMA instructions as potentially affecting all memory.  
19452 @item -mbranch-hints
19453 @opindex mbranch-hints
19455 By default, GCC generates a branch hint instruction to avoid
19456 pipeline stalls for always-taken or probably-taken branches.  A hint
19457 is not generated closer than 8 instructions away from its branch.
19458 There is little reason to disable them, except for debugging purposes,
19459 or to make an object a little bit smaller.
19461 @item -msmall-mem
19462 @itemx -mlarge-mem
19463 @opindex msmall-mem
19464 @opindex mlarge-mem
19466 By default, GCC generates code assuming that addresses are never larger
19467 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
19468 a full 32-bit address.
19470 @item -mstdmain
19471 @opindex mstdmain
19473 By default, GCC links against startup code that assumes the SPU-style
19474 main function interface (which has an unconventional parameter list).
19475 With @option{-mstdmain}, GCC links your program against startup
19476 code that assumes a C99-style interface to @code{main}, including a
19477 local copy of @code{argv} strings.
19479 @item -mfixed-range=@var{register-range}
19480 @opindex mfixed-range
19481 Generate code treating the given register range as fixed registers.
19482 A fixed register is one that the register allocator cannot use.  This is
19483 useful when compiling kernel code.  A register range is specified as
19484 two registers separated by a dash.  Multiple register ranges can be
19485 specified separated by a comma.
19487 @item -mea32
19488 @itemx -mea64
19489 @opindex mea32
19490 @opindex mea64
19491 Compile code assuming that pointers to the PPU address space accessed
19492 via the @code{__ea} named address space qualifier are either 32 or 64
19493 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
19494 all object code in an executable must be compiled with the same setting.
19496 @item -maddress-space-conversion
19497 @itemx -mno-address-space-conversion
19498 @opindex maddress-space-conversion
19499 @opindex mno-address-space-conversion
19500 Allow/disallow treating the @code{__ea} address space as superset
19501 of the generic address space.  This enables explicit type casts
19502 between @code{__ea} and generic pointer as well as implicit
19503 conversions of generic pointers to @code{__ea} pointers.  The
19504 default is to allow address space pointer conversions.
19506 @item -mcache-size=@var{cache-size}
19507 @opindex mcache-size
19508 This option controls the version of libgcc that the compiler links to an
19509 executable and selects a software-managed cache for accessing variables
19510 in the @code{__ea} address space with a particular cache size.  Possible
19511 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
19512 and @samp{128}.  The default cache size is 64KB.
19514 @item -matomic-updates
19515 @itemx -mno-atomic-updates
19516 @opindex matomic-updates
19517 @opindex mno-atomic-updates
19518 This option controls the version of libgcc that the compiler links to an
19519 executable and selects whether atomic updates to the software-managed
19520 cache of PPU-side variables are used.  If you use atomic updates, changes
19521 to a PPU variable from SPU code using the @code{__ea} named address space
19522 qualifier do not interfere with changes to other PPU variables residing
19523 in the same cache line from PPU code.  If you do not use atomic updates,
19524 such interference may occur; however, writing back cache lines is
19525 more efficient.  The default behavior is to use atomic updates.
19527 @item -mdual-nops
19528 @itemx -mdual-nops=@var{n}
19529 @opindex mdual-nops
19530 By default, GCC inserts nops to increase dual issue when it expects
19531 it to increase performance.  @var{n} can be a value from 0 to 10.  A
19532 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
19533 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
19535 @item -mhint-max-nops=@var{n}
19536 @opindex mhint-max-nops
19537 Maximum number of nops to insert for a branch hint.  A branch hint must
19538 be at least 8 instructions away from the branch it is affecting.  GCC
19539 inserts up to @var{n} nops to enforce this, otherwise it does not
19540 generate the branch hint.
19542 @item -mhint-max-distance=@var{n}
19543 @opindex mhint-max-distance
19544 The encoding of the branch hint instruction limits the hint to be within
19545 256 instructions of the branch it is affecting.  By default, GCC makes
19546 sure it is within 125.
19548 @item -msafe-hints
19549 @opindex msafe-hints
19550 Work around a hardware bug that causes the SPU to stall indefinitely.
19551 By default, GCC inserts the @code{hbrp} instruction to make sure
19552 this stall won't happen.
19554 @end table
19556 @node System V Options
19557 @subsection Options for System V
19559 These additional options are available on System V Release 4 for
19560 compatibility with other compilers on those systems:
19562 @table @gcctabopt
19563 @item -G
19564 @opindex G
19565 Create a shared object.
19566 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
19568 @item -Qy
19569 @opindex Qy
19570 Identify the versions of each tool used by the compiler, in a
19571 @code{.ident} assembler directive in the output.
19573 @item -Qn
19574 @opindex Qn
19575 Refrain from adding @code{.ident} directives to the output file (this is
19576 the default).
19578 @item -YP,@var{dirs}
19579 @opindex YP
19580 Search the directories @var{dirs}, and no others, for libraries
19581 specified with @option{-l}.
19583 @item -Ym,@var{dir}
19584 @opindex Ym
19585 Look in the directory @var{dir} to find the M4 preprocessor.
19586 The assembler uses this option.
19587 @c This is supposed to go with a -Yd for predefined M4 macro files, but
19588 @c the generic assembler that comes with Solaris takes just -Ym.
19589 @end table
19591 @node TILE-Gx Options
19592 @subsection TILE-Gx Options
19593 @cindex TILE-Gx options
19595 These @samp{-m} options are supported on the TILE-Gx:
19597 @table @gcctabopt
19598 @item -mcmodel=small
19599 @opindex mcmodel=small
19600 Generate code for the small model.  The distance for direct calls is
19601 limited to 500M in either direction.  PC-relative addresses are 32
19602 bits.  Absolute addresses support the full address range.
19604 @item -mcmodel=large
19605 @opindex mcmodel=large
19606 Generate code for the large model.  There is no limitation on call
19607 distance, pc-relative addresses, or absolute addresses.
19609 @item -mcpu=@var{name}
19610 @opindex mcpu
19611 Selects the type of CPU to be targeted.  Currently the only supported
19612 type is @samp{tilegx}.
19614 @item -m32
19615 @itemx -m64
19616 @opindex m32
19617 @opindex m64
19618 Generate code for a 32-bit or 64-bit environment.  The 32-bit
19619 environment sets int, long, and pointer to 32 bits.  The 64-bit
19620 environment sets int to 32 bits and long and pointer to 64 bits.
19621 @end table
19623 @node TILEPro Options
19624 @subsection TILEPro Options
19625 @cindex TILEPro options
19627 These @samp{-m} options are supported on the TILEPro:
19629 @table @gcctabopt
19630 @item -mcpu=@var{name}
19631 @opindex mcpu
19632 Selects the type of CPU to be targeted.  Currently the only supported
19633 type is @samp{tilepro}.
19635 @item -m32
19636 @opindex m32
19637 Generate code for a 32-bit environment, which sets int, long, and
19638 pointer to 32 bits.  This is the only supported behavior so the flag
19639 is essentially ignored.
19640 @end table
19642 @node V850 Options
19643 @subsection V850 Options
19644 @cindex V850 Options
19646 These @samp{-m} options are defined for V850 implementations:
19648 @table @gcctabopt
19649 @item -mlong-calls
19650 @itemx -mno-long-calls
19651 @opindex mlong-calls
19652 @opindex mno-long-calls
19653 Treat all calls as being far away (near).  If calls are assumed to be
19654 far away, the compiler always loads the function's address into a
19655 register, and calls indirect through the pointer.
19657 @item -mno-ep
19658 @itemx -mep
19659 @opindex mno-ep
19660 @opindex mep
19661 Do not optimize (do optimize) basic blocks that use the same index
19662 pointer 4 or more times to copy pointer into the @code{ep} register, and
19663 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
19664 option is on by default if you optimize.
19666 @item -mno-prolog-function
19667 @itemx -mprolog-function
19668 @opindex mno-prolog-function
19669 @opindex mprolog-function
19670 Do not use (do use) external functions to save and restore registers
19671 at the prologue and epilogue of a function.  The external functions
19672 are slower, but use less code space if more than one function saves
19673 the same number of registers.  The @option{-mprolog-function} option
19674 is on by default if you optimize.
19676 @item -mspace
19677 @opindex mspace
19678 Try to make the code as small as possible.  At present, this just turns
19679 on the @option{-mep} and @option{-mprolog-function} options.
19681 @item -mtda=@var{n}
19682 @opindex mtda
19683 Put static or global variables whose size is @var{n} bytes or less into
19684 the tiny data area that register @code{ep} points to.  The tiny data
19685 area can hold up to 256 bytes in total (128 bytes for byte references).
19687 @item -msda=@var{n}
19688 @opindex msda
19689 Put static or global variables whose size is @var{n} bytes or less into
19690 the small data area that register @code{gp} points to.  The small data
19691 area can hold up to 64 kilobytes.
19693 @item -mzda=@var{n}
19694 @opindex mzda
19695 Put static or global variables whose size is @var{n} bytes or less into
19696 the first 32 kilobytes of memory.
19698 @item -mv850
19699 @opindex mv850
19700 Specify that the target processor is the V850.
19702 @item -mv850e3v5
19703 @opindex mv850e3v5
19704 Specify that the target processor is the V850E3V5.  The preprocessor
19705 constant @samp{__v850e3v5__} is defined if this option is used.
19707 @item -mv850e2v4
19708 @opindex mv850e2v4
19709 Specify that the target processor is the V850E3V5.  This is an alias for
19710 the @option{-mv850e3v5} option.
19712 @item -mv850e2v3
19713 @opindex mv850e2v3
19714 Specify that the target processor is the V850E2V3.  The preprocessor
19715 constant @samp{__v850e2v3__} is defined if this option is used.
19717 @item -mv850e2
19718 @opindex mv850e2
19719 Specify that the target processor is the V850E2.  The preprocessor
19720 constant @samp{__v850e2__} is defined if this option is used.
19722 @item -mv850e1
19723 @opindex mv850e1
19724 Specify that the target processor is the V850E1.  The preprocessor
19725 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19726 this option is used.
19728 @item -mv850es
19729 @opindex mv850es
19730 Specify that the target processor is the V850ES.  This is an alias for
19731 the @option{-mv850e1} option.
19733 @item -mv850e
19734 @opindex mv850e
19735 Specify that the target processor is the V850E@.  The preprocessor
19736 constant @samp{__v850e__} is defined if this option is used.
19738 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19739 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
19740 are defined then a default target processor is chosen and the
19741 relevant @samp{__v850*__} preprocessor constant is defined.
19743 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19744 defined, regardless of which processor variant is the target.
19746 @item -mdisable-callt
19747 @itemx -mno-disable-callt
19748 @opindex mdisable-callt
19749 @opindex mno-disable-callt
19750 This option suppresses generation of the @code{CALLT} instruction for the
19751 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
19752 architecture.
19754 This option is enabled by default when the RH850 ABI is
19755 in use (see @option{-mrh850-abi}), and disabled by default when the
19756 GCC ABI is in use.  If @code{CALLT} instructions are being generated
19757 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
19759 @item -mrelax
19760 @itemx -mno-relax
19761 @opindex mrelax
19762 @opindex mno-relax
19763 Pass on (or do not pass on) the @option{-mrelax} command line option
19764 to the assembler.
19766 @item -mlong-jumps
19767 @itemx -mno-long-jumps
19768 @opindex mlong-jumps
19769 @opindex mno-long-jumps
19770 Disable (or re-enable) the generation of PC-relative jump instructions.
19772 @item -msoft-float
19773 @itemx -mhard-float
19774 @opindex msoft-float
19775 @opindex mhard-float
19776 Disable (or re-enable) the generation of hardware floating point
19777 instructions.  This option is only significant when the target
19778 architecture is @samp{V850E2V3} or higher.  If hardware floating point
19779 instructions are being generated then the C preprocessor symbol
19780 @code{__FPU_OK__} will be defined, otherwise the symbol
19781 @code{__NO_FPU__} will be defined.
19783 @item -mloop
19784 @opindex mloop
19785 Enables the use of the e3v5 LOOP instruction.  The use of this
19786 instruction is not enabled by default when the e3v5 architecture is
19787 selected because its use is still experimental.
19789 @item -mrh850-abi
19790 @itemx -mghs
19791 @opindex mrh850-abi
19792 @opindex mghs
19793 Enables support for the RH850 version of the V850 ABI.  This is the
19794 default.  With this version of the ABI the following rules apply:
19796 @itemize
19797 @item
19798 Integer sized structures and unions are returned via a memory pointer
19799 rather than a register.
19801 @item
19802 Large structures and unions (more than 8 bytes in size) are passed by
19803 value.
19805 @item
19806 Functions are aligned to 16-bit boundaries.
19808 @item
19809 The @option{-m8byte-align} command line option is supported.
19811 @item
19812 The @option{-mdisable-callt} command line option is enabled by
19813 default.  The @option{-mno-disable-callt} command line option is not
19814 supported.
19815 @end itemize
19817 When this version of the ABI is enabled the C preprocessor symbol
19818 @code{__V850_RH850_ABI__} is defined.
19820 @item -mgcc-abi
19821 @opindex mgcc-abi
19822 Enables support for the old GCC version of the V850 ABI.  With this
19823 version of the ABI the following rules apply:
19825 @itemize
19826 @item
19827 Integer sized structures and unions are returned in register @code{r10}.
19829 @item
19830 Large structures and unions (more than 8 bytes in size) are passed by
19831 reference.
19833 @item
19834 Functions are aligned to 32-bit boundaries, unless optimizing for
19835 size.
19837 @item
19838 The @option{-m8byte-align} command line option is not supported.
19840 @item
19841 The @option{-mdisable-callt} command line option is supported but not
19842 enabled by default.
19843 @end itemize
19845 When this version of the ABI is enabled the C preprocessor symbol
19846 @code{__V850_GCC_ABI__} is defined.
19848 @item -m8byte-align
19849 @itemx -mno-8byte-align
19850 @opindex m8byte-align
19851 @opindex mno-8byte-align
19852 Enables support for @code{doubles} and @code{long long} types to be
19853 aligned on 8-byte boundaries.  The default is to restrict the
19854 alignment of all objects to at most 4-bytes.  When
19855 @option{-m8byte-align} is in effect the C preprocessor symbol
19856 @code{__V850_8BYTE_ALIGN__} will be defined.
19858 @item -mbig-switch
19859 @opindex mbig-switch
19860 Generate code suitable for big switch tables.  Use this option only if
19861 the assembler/linker complain about out of range branches within a switch
19862 table.
19864 @item -mapp-regs
19865 @opindex mapp-regs
19866 This option causes r2 and r5 to be used in the code generated by
19867 the compiler.  This setting is the default.
19869 @item -mno-app-regs
19870 @opindex mno-app-regs
19871 This option causes r2 and r5 to be treated as fixed registers.
19873 @end table
19875 @node VAX Options
19876 @subsection VAX Options
19877 @cindex VAX options
19879 These @samp{-m} options are defined for the VAX:
19881 @table @gcctabopt
19882 @item -munix
19883 @opindex munix
19884 Do not output certain jump instructions (@code{aobleq} and so on)
19885 that the Unix assembler for the VAX cannot handle across long
19886 ranges.
19888 @item -mgnu
19889 @opindex mgnu
19890 Do output those jump instructions, on the assumption that the
19891 GNU assembler is being used.
19893 @item -mg
19894 @opindex mg
19895 Output code for G-format floating-point numbers instead of D-format.
19896 @end table
19898 @node VMS Options
19899 @subsection VMS Options
19901 These @samp{-m} options are defined for the VMS implementations:
19903 @table @gcctabopt
19904 @item -mvms-return-codes
19905 @opindex mvms-return-codes
19906 Return VMS condition codes from @code{main}. The default is to return POSIX-style
19907 condition (e.g.@ error) codes.
19909 @item -mdebug-main=@var{prefix}
19910 @opindex mdebug-main=@var{prefix}
19911 Flag the first routine whose name starts with @var{prefix} as the main
19912 routine for the debugger.
19914 @item -mmalloc64
19915 @opindex mmalloc64
19916 Default to 64-bit memory allocation routines.
19918 @item -mpointer-size=@var{size}
19919 @opindex -mpointer-size=@var{size}
19920 Set the default size of pointers. Possible options for @var{size} are
19921 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
19922 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
19923 The later option disables @code{pragma pointer_size}.
19924 @end table
19926 @node VxWorks Options
19927 @subsection VxWorks Options
19928 @cindex VxWorks Options
19930 The options in this section are defined for all VxWorks targets.
19931 Options specific to the target hardware are listed with the other
19932 options for that target.
19934 @table @gcctabopt
19935 @item -mrtp
19936 @opindex mrtp
19937 GCC can generate code for both VxWorks kernels and real time processes
19938 (RTPs).  This option switches from the former to the latter.  It also
19939 defines the preprocessor macro @code{__RTP__}.
19941 @item -non-static
19942 @opindex non-static
19943 Link an RTP executable against shared libraries rather than static
19944 libraries.  The options @option{-static} and @option{-shared} can
19945 also be used for RTPs (@pxref{Link Options}); @option{-static}
19946 is the default.
19948 @item -Bstatic
19949 @itemx -Bdynamic
19950 @opindex Bstatic
19951 @opindex Bdynamic
19952 These options are passed down to the linker.  They are defined for
19953 compatibility with Diab.
19955 @item -Xbind-lazy
19956 @opindex Xbind-lazy
19957 Enable lazy binding of function calls.  This option is equivalent to
19958 @option{-Wl,-z,now} and is defined for compatibility with Diab.
19960 @item -Xbind-now
19961 @opindex Xbind-now
19962 Disable lazy binding of function calls.  This option is the default and
19963 is defined for compatibility with Diab.
19964 @end table
19966 @node x86-64 Options
19967 @subsection x86-64 Options
19968 @cindex x86-64 options
19970 These are listed under @xref{i386 and x86-64 Options}.
19972 @node Xstormy16 Options
19973 @subsection Xstormy16 Options
19974 @cindex Xstormy16 Options
19976 These options are defined for Xstormy16:
19978 @table @gcctabopt
19979 @item -msim
19980 @opindex msim
19981 Choose startup files and linker script suitable for the simulator.
19982 @end table
19984 @node Xtensa Options
19985 @subsection Xtensa Options
19986 @cindex Xtensa Options
19988 These options are supported for Xtensa targets:
19990 @table @gcctabopt
19991 @item -mconst16
19992 @itemx -mno-const16
19993 @opindex mconst16
19994 @opindex mno-const16
19995 Enable or disable use of @code{CONST16} instructions for loading
19996 constant values.  The @code{CONST16} instruction is currently not a
19997 standard option from Tensilica.  When enabled, @code{CONST16}
19998 instructions are always used in place of the standard @code{L32R}
19999 instructions.  The use of @code{CONST16} is enabled by default only if
20000 the @code{L32R} instruction is not available.
20002 @item -mfused-madd
20003 @itemx -mno-fused-madd
20004 @opindex mfused-madd
20005 @opindex mno-fused-madd
20006 Enable or disable use of fused multiply/add and multiply/subtract
20007 instructions in the floating-point option.  This has no effect if the
20008 floating-point option is not also enabled.  Disabling fused multiply/add
20009 and multiply/subtract instructions forces the compiler to use separate
20010 instructions for the multiply and add/subtract operations.  This may be
20011 desirable in some cases where strict IEEE 754-compliant results are
20012 required: the fused multiply add/subtract instructions do not round the
20013 intermediate result, thereby producing results with @emph{more} bits of
20014 precision than specified by the IEEE standard.  Disabling fused multiply
20015 add/subtract instructions also ensures that the program output is not
20016 sensitive to the compiler's ability to combine multiply and add/subtract
20017 operations.
20019 @item -mserialize-volatile
20020 @itemx -mno-serialize-volatile
20021 @opindex mserialize-volatile
20022 @opindex mno-serialize-volatile
20023 When this option is enabled, GCC inserts @code{MEMW} instructions before
20024 @code{volatile} memory references to guarantee sequential consistency.
20025 The default is @option{-mserialize-volatile}.  Use
20026 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
20028 @item -mforce-no-pic
20029 @opindex mforce-no-pic
20030 For targets, like GNU/Linux, where all user-mode Xtensa code must be
20031 position-independent code (PIC), this option disables PIC for compiling
20032 kernel code.
20034 @item -mtext-section-literals
20035 @itemx -mno-text-section-literals
20036 @opindex mtext-section-literals
20037 @opindex mno-text-section-literals
20038 Control the treatment of literal pools.  The default is
20039 @option{-mno-text-section-literals}, which places literals in a separate
20040 section in the output file.  This allows the literal pool to be placed
20041 in a data RAM/ROM, and it also allows the linker to combine literal
20042 pools from separate object files to remove redundant literals and
20043 improve code size.  With @option{-mtext-section-literals}, the literals
20044 are interspersed in the text section in order to keep them as close as
20045 possible to their references.  This may be necessary for large assembly
20046 files.
20048 @item -mtarget-align
20049 @itemx -mno-target-align
20050 @opindex mtarget-align
20051 @opindex mno-target-align
20052 When this option is enabled, GCC instructs the assembler to
20053 automatically align instructions to reduce branch penalties at the
20054 expense of some code density.  The assembler attempts to widen density
20055 instructions to align branch targets and the instructions following call
20056 instructions.  If there are not enough preceding safe density
20057 instructions to align a target, no widening is performed.  The
20058 default is @option{-mtarget-align}.  These options do not affect the
20059 treatment of auto-aligned instructions like @code{LOOP}, which the
20060 assembler always aligns, either by widening density instructions or
20061 by inserting NOP instructions.
20063 @item -mlongcalls
20064 @itemx -mno-longcalls
20065 @opindex mlongcalls
20066 @opindex mno-longcalls
20067 When this option is enabled, GCC instructs the assembler to translate
20068 direct calls to indirect calls unless it can determine that the target
20069 of a direct call is in the range allowed by the call instruction.  This
20070 translation typically occurs for calls to functions in other source
20071 files.  Specifically, the assembler translates a direct @code{CALL}
20072 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
20073 The default is @option{-mno-longcalls}.  This option should be used in
20074 programs where the call target can potentially be out of range.  This
20075 option is implemented in the assembler, not the compiler, so the
20076 assembly code generated by GCC still shows direct call
20077 instructions---look at the disassembled object code to see the actual
20078 instructions.  Note that the assembler uses an indirect call for
20079 every cross-file call, not just those that really are out of range.
20080 @end table
20082 @node zSeries Options
20083 @subsection zSeries Options
20084 @cindex zSeries options
20086 These are listed under @xref{S/390 and zSeries Options}.
20088 @node Code Gen Options
20089 @section Options for Code Generation Conventions
20090 @cindex code generation conventions
20091 @cindex options, code generation
20092 @cindex run-time options
20094 These machine-independent options control the interface conventions
20095 used in code generation.
20097 Most of them have both positive and negative forms; the negative form
20098 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
20099 one of the forms is listed---the one that is not the default.  You
20100 can figure out the other form by either removing @samp{no-} or adding
20103 @table @gcctabopt
20104 @item -fbounds-check
20105 @opindex fbounds-check
20106 For front ends that support it, generate additional code to check that
20107 indices used to access arrays are within the declared range.  This is
20108 currently only supported by the Java and Fortran front ends, where
20109 this option defaults to true and false respectively.
20111 @item -fstack-reuse=@var{reuse-level}
20112 @opindex fstack_reuse
20113 This option controls stack space reuse for user declared local/auto variables
20114 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
20115 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
20116 local variables and temporaries, @samp{named_vars} enables the reuse only for
20117 user defined local variables with names, and @samp{none} disables stack reuse
20118 completely. The default value is @samp{all}. The option is needed when the
20119 program extends the lifetime of a scoped local variable or a compiler generated
20120 temporary beyond the end point defined by the language.  When a lifetime of
20121 a variable ends, and if the variable lives in memory, the optimizing compiler
20122 has the freedom to reuse its stack space with other temporaries or scoped
20123 local variables whose live range does not overlap with it. Legacy code extending
20124 local lifetime will likely to break with the stack reuse optimization.
20126 For example,
20128 @smallexample
20129    int *p;
20130    @{
20131      int local1;
20133      p = &local1;
20134      local1 = 10;
20135      ....
20136    @}
20137    @{
20138       int local2;
20139       local2 = 20;
20140       ...
20141    @}
20143    if (*p == 10)  // out of scope use of local1
20144      @{
20146      @}
20147 @end smallexample
20149 Another example:
20150 @smallexample
20152    struct A
20153    @{
20154        A(int k) : i(k), j(k) @{ @}
20155        int i;
20156        int j;
20157    @};
20159    A *ap;
20161    void foo(const A& ar)
20162    @{
20163       ap = &ar;
20164    @}
20166    void bar()
20167    @{
20168       foo(A(10)); // temp object's lifetime ends when foo returns
20170       @{
20171         A a(20);
20172         ....
20173       @}
20174       ap->i+= 10;  // ap references out of scope temp whose space
20175                    // is reused with a. What is the value of ap->i?
20176    @}
20178 @end smallexample
20180 The lifetime of a compiler generated temporary is well defined by the C++
20181 standard. When a lifetime of a temporary ends, and if the temporary lives
20182 in memory, the optimizing compiler has the freedom to reuse its stack
20183 space with other temporaries or scoped local variables whose live range
20184 does not overlap with it. However some of the legacy code relies on
20185 the behavior of older compilers in which temporaries' stack space is
20186 not reused, the aggressive stack reuse can lead to runtime errors. This
20187 option is used to control the temporary stack reuse optimization.
20189 @item -ftrapv
20190 @opindex ftrapv
20191 This option generates traps for signed overflow on addition, subtraction,
20192 multiplication operations.
20194 @item -fwrapv
20195 @opindex fwrapv
20196 This option instructs the compiler to assume that signed arithmetic
20197 overflow of addition, subtraction and multiplication wraps around
20198 using twos-complement representation.  This flag enables some optimizations
20199 and disables others.  This option is enabled by default for the Java
20200 front end, as required by the Java language specification.
20202 @item -fexceptions
20203 @opindex fexceptions
20204 Enable exception handling.  Generates extra code needed to propagate
20205 exceptions.  For some targets, this implies GCC generates frame
20206 unwind information for all functions, which can produce significant data
20207 size overhead, although it does not affect execution.  If you do not
20208 specify this option, GCC enables it by default for languages like
20209 C++ that normally require exception handling, and disables it for
20210 languages like C that do not normally require it.  However, you may need
20211 to enable this option when compiling C code that needs to interoperate
20212 properly with exception handlers written in C++.  You may also wish to
20213 disable this option if you are compiling older C++ programs that don't
20214 use exception handling.
20216 @item -fnon-call-exceptions
20217 @opindex fnon-call-exceptions
20218 Generate code that allows trapping instructions to throw exceptions.
20219 Note that this requires platform-specific runtime support that does
20220 not exist everywhere.  Moreover, it only allows @emph{trapping}
20221 instructions to throw exceptions, i.e.@: memory references or floating-point
20222 instructions.  It does not allow exceptions to be thrown from
20223 arbitrary signal handlers such as @code{SIGALRM}.
20225 @item -fdelete-dead-exceptions
20226 @opindex fdelete-dead-exceptions
20227 Consider that instructions that may throw exceptions but don't otherwise
20228 contribute to the execution of the program can be optimized away.
20229 This option is enabled by default for the Ada front end, as permitted by
20230 the Ada language specification.
20231 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
20233 @item -funwind-tables
20234 @opindex funwind-tables
20235 Similar to @option{-fexceptions}, except that it just generates any needed
20236 static data, but does not affect the generated code in any other way.
20237 You normally do not need to enable this option; instead, a language processor
20238 that needs this handling enables it on your behalf.
20240 @item -fasynchronous-unwind-tables
20241 @opindex fasynchronous-unwind-tables
20242 Generate unwind table in DWARF 2 format, if supported by target machine.  The
20243 table is exact at each instruction boundary, so it can be used for stack
20244 unwinding from asynchronous events (such as debugger or garbage collector).
20246 @item -fpcc-struct-return
20247 @opindex fpcc-struct-return
20248 Return ``short'' @code{struct} and @code{union} values in memory like
20249 longer ones, rather than in registers.  This convention is less
20250 efficient, but it has the advantage of allowing intercallability between
20251 GCC-compiled files and files compiled with other compilers, particularly
20252 the Portable C Compiler (pcc).
20254 The precise convention for returning structures in memory depends
20255 on the target configuration macros.
20257 Short structures and unions are those whose size and alignment match
20258 that of some integer type.
20260 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
20261 switch is not binary compatible with code compiled with the
20262 @option{-freg-struct-return} switch.
20263 Use it to conform to a non-default application binary interface.
20265 @item -freg-struct-return
20266 @opindex freg-struct-return
20267 Return @code{struct} and @code{union} values in registers when possible.
20268 This is more efficient for small structures than
20269 @option{-fpcc-struct-return}.
20271 If you specify neither @option{-fpcc-struct-return} nor
20272 @option{-freg-struct-return}, GCC defaults to whichever convention is
20273 standard for the target.  If there is no standard convention, GCC
20274 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
20275 the principal compiler.  In those cases, we can choose the standard, and
20276 we chose the more efficient register return alternative.
20278 @strong{Warning:} code compiled with the @option{-freg-struct-return}
20279 switch is not binary compatible with code compiled with the
20280 @option{-fpcc-struct-return} switch.
20281 Use it to conform to a non-default application binary interface.
20283 @item -fshort-enums
20284 @opindex fshort-enums
20285 Allocate to an @code{enum} type only as many bytes as it needs for the
20286 declared range of possible values.  Specifically, the @code{enum} type
20287 is equivalent to the smallest integer type that has enough room.
20289 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
20290 code that is not binary compatible with code generated without that switch.
20291 Use it to conform to a non-default application binary interface.
20293 @item -fshort-double
20294 @opindex fshort-double
20295 Use the same size for @code{double} as for @code{float}.
20297 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
20298 code that is not binary compatible with code generated without that switch.
20299 Use it to conform to a non-default application binary interface.
20301 @item -fshort-wchar
20302 @opindex fshort-wchar
20303 Override the underlying type for @samp{wchar_t} to be @samp{short
20304 unsigned int} instead of the default for the target.  This option is
20305 useful for building programs to run under WINE@.
20307 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
20308 code that is not binary compatible with code generated without that switch.
20309 Use it to conform to a non-default application binary interface.
20311 @item -fno-common
20312 @opindex fno-common
20313 In C code, controls the placement of uninitialized global variables.
20314 Unix C compilers have traditionally permitted multiple definitions of
20315 such variables in different compilation units by placing the variables
20316 in a common block.
20317 This is the behavior specified by @option{-fcommon}, and is the default
20318 for GCC on most targets.
20319 On the other hand, this behavior is not required by ISO C, and on some
20320 targets may carry a speed or code size penalty on variable references.
20321 The @option{-fno-common} option specifies that the compiler should place
20322 uninitialized global variables in the data section of the object file,
20323 rather than generating them as common blocks.
20324 This has the effect that if the same variable is declared
20325 (without @code{extern}) in two different compilations,
20326 you get a multiple-definition error when you link them.
20327 In this case, you must compile with @option{-fcommon} instead.
20328 Compiling with @option{-fno-common} is useful on targets for which
20329 it provides better performance, or if you wish to verify that the
20330 program will work on other systems that always treat uninitialized
20331 variable declarations this way.
20333 @item -fno-ident
20334 @opindex fno-ident
20335 Ignore the @samp{#ident} directive.
20337 @item -finhibit-size-directive
20338 @opindex finhibit-size-directive
20339 Don't output a @code{.size} assembler directive, or anything else that
20340 would cause trouble if the function is split in the middle, and the
20341 two halves are placed at locations far apart in memory.  This option is
20342 used when compiling @file{crtstuff.c}; you should not need to use it
20343 for anything else.
20345 @item -fverbose-asm
20346 @opindex fverbose-asm
20347 Put extra commentary information in the generated assembly code to
20348 make it more readable.  This option is generally only of use to those
20349 who actually need to read the generated assembly code (perhaps while
20350 debugging the compiler itself).
20352 @option{-fno-verbose-asm}, the default, causes the
20353 extra information to be omitted and is useful when comparing two assembler
20354 files.
20356 @item -frecord-gcc-switches
20357 @opindex frecord-gcc-switches
20358 This switch causes the command line used to invoke the
20359 compiler to be recorded into the object file that is being created.
20360 This switch is only implemented on some targets and the exact format
20361 of the recording is target and binary file format dependent, but it
20362 usually takes the form of a section containing ASCII text.  This
20363 switch is related to the @option{-fverbose-asm} switch, but that
20364 switch only records information in the assembler output file as
20365 comments, so it never reaches the object file.
20366 See also @option{-grecord-gcc-switches} for another
20367 way of storing compiler options into the object file.
20369 @item -fpic
20370 @opindex fpic
20371 @cindex global offset table
20372 @cindex PIC
20373 Generate position-independent code (PIC) suitable for use in a shared
20374 library, if supported for the target machine.  Such code accesses all
20375 constant addresses through a global offset table (GOT)@.  The dynamic
20376 loader resolves the GOT entries when the program starts (the dynamic
20377 loader is not part of GCC; it is part of the operating system).  If
20378 the GOT size for the linked executable exceeds a machine-specific
20379 maximum size, you get an error message from the linker indicating that
20380 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
20381 instead.  (These maximums are 8k on the SPARC and 32k
20382 on the m68k and RS/6000.  The 386 has no such limit.)
20384 Position-independent code requires special support, and therefore works
20385 only on certain machines.  For the 386, GCC supports PIC for System V
20386 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
20387 position-independent.
20389 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20390 are defined to 1.
20392 @item -fPIC
20393 @opindex fPIC
20394 If supported for the target machine, emit position-independent code,
20395 suitable for dynamic linking and avoiding any limit on the size of the
20396 global offset table.  This option makes a difference on the m68k,
20397 PowerPC and SPARC@.
20399 Position-independent code requires special support, and therefore works
20400 only on certain machines.
20402 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20403 are defined to 2.
20405 @item -fpie
20406 @itemx -fPIE
20407 @opindex fpie
20408 @opindex fPIE
20409 These options are similar to @option{-fpic} and @option{-fPIC}, but
20410 generated position independent code can be only linked into executables.
20411 Usually these options are used when @option{-pie} GCC option is
20412 used during linking.
20414 @option{-fpie} and @option{-fPIE} both define the macros
20415 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
20416 for @option{-fpie} and 2 for @option{-fPIE}.
20418 @item -fno-jump-tables
20419 @opindex fno-jump-tables
20420 Do not use jump tables for switch statements even where it would be
20421 more efficient than other code generation strategies.  This option is
20422 of use in conjunction with @option{-fpic} or @option{-fPIC} for
20423 building code that forms part of a dynamic linker and cannot
20424 reference the address of a jump table.  On some targets, jump tables
20425 do not require a GOT and this option is not needed.
20427 @item -ffixed-@var{reg}
20428 @opindex ffixed
20429 Treat the register named @var{reg} as a fixed register; generated code
20430 should never refer to it (except perhaps as a stack pointer, frame
20431 pointer or in some other fixed role).
20433 @var{reg} must be the name of a register.  The register names accepted
20434 are machine-specific and are defined in the @code{REGISTER_NAMES}
20435 macro in the machine description macro file.
20437 This flag does not have a negative form, because it specifies a
20438 three-way choice.
20440 @item -fcall-used-@var{reg}
20441 @opindex fcall-used
20442 Treat the register named @var{reg} as an allocable register that is
20443 clobbered by function calls.  It may be allocated for temporaries or
20444 variables that do not live across a call.  Functions compiled this way
20445 do not save and restore the register @var{reg}.
20447 It is an error to use this flag with the frame pointer or stack pointer.
20448 Use of this flag for other registers that have fixed pervasive roles in
20449 the machine's execution model produces disastrous results.
20451 This flag does not have a negative form, because it specifies a
20452 three-way choice.
20454 @item -fcall-saved-@var{reg}
20455 @opindex fcall-saved
20456 Treat the register named @var{reg} as an allocable register saved by
20457 functions.  It may be allocated even for temporaries or variables that
20458 live across a call.  Functions compiled this way save and restore
20459 the register @var{reg} if they use it.
20461 It is an error to use this flag with the frame pointer or stack pointer.
20462 Use of this flag for other registers that have fixed pervasive roles in
20463 the machine's execution model produces disastrous results.
20465 A different sort of disaster results from the use of this flag for
20466 a register in which function values may be returned.
20468 This flag does not have a negative form, because it specifies a
20469 three-way choice.
20471 @item -fpack-struct[=@var{n}]
20472 @opindex fpack-struct
20473 Without a value specified, pack all structure members together without
20474 holes.  When a value is specified (which must be a small power of two), pack
20475 structure members according to this value, representing the maximum
20476 alignment (that is, objects with default alignment requirements larger than
20477 this are output potentially unaligned at the next fitting location.
20479 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
20480 code that is not binary compatible with code generated without that switch.
20481 Additionally, it makes the code suboptimal.
20482 Use it to conform to a non-default application binary interface.
20484 @item -finstrument-functions
20485 @opindex finstrument-functions
20486 Generate instrumentation calls for entry and exit to functions.  Just
20487 after function entry and just before function exit, the following
20488 profiling functions are called with the address of the current
20489 function and its call site.  (On some platforms,
20490 @code{__builtin_return_address} does not work beyond the current
20491 function, so the call site information may not be available to the
20492 profiling functions otherwise.)
20494 @smallexample
20495 void __cyg_profile_func_enter (void *this_fn,
20496                                void *call_site);
20497 void __cyg_profile_func_exit  (void *this_fn,
20498                                void *call_site);
20499 @end smallexample
20501 The first argument is the address of the start of the current function,
20502 which may be looked up exactly in the symbol table.
20504 This instrumentation is also done for functions expanded inline in other
20505 functions.  The profiling calls indicate where, conceptually, the
20506 inline function is entered and exited.  This means that addressable
20507 versions of such functions must be available.  If all your uses of a
20508 function are expanded inline, this may mean an additional expansion of
20509 code size.  If you use @samp{extern inline} in your C code, an
20510 addressable version of such functions must be provided.  (This is
20511 normally the case anyway, but if you get lucky and the optimizer always
20512 expands the functions inline, you might have gotten away without
20513 providing static copies.)
20515 A function may be given the attribute @code{no_instrument_function}, in
20516 which case this instrumentation is not done.  This can be used, for
20517 example, for the profiling functions listed above, high-priority
20518 interrupt routines, and any functions from which the profiling functions
20519 cannot safely be called (perhaps signal handlers, if the profiling
20520 routines generate output or allocate memory).
20522 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
20523 @opindex finstrument-functions-exclude-file-list
20525 Set the list of functions that are excluded from instrumentation (see
20526 the description of @code{-finstrument-functions}).  If the file that
20527 contains a function definition matches with one of @var{file}, then
20528 that function is not instrumented.  The match is done on substrings:
20529 if the @var{file} parameter is a substring of the file name, it is
20530 considered to be a match.
20532 For example:
20534 @smallexample
20535 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
20536 @end smallexample
20538 @noindent
20539 excludes any inline function defined in files whose pathnames
20540 contain @code{/bits/stl} or @code{include/sys}.
20542 If, for some reason, you want to include letter @code{','} in one of
20543 @var{sym}, write @code{'\,'}. For example,
20544 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
20545 (note the single quote surrounding the option).
20547 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
20548 @opindex finstrument-functions-exclude-function-list
20550 This is similar to @code{-finstrument-functions-exclude-file-list},
20551 but this option sets the list of function names to be excluded from
20552 instrumentation.  The function name to be matched is its user-visible
20553 name, such as @code{vector<int> blah(const vector<int> &)}, not the
20554 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
20555 match is done on substrings: if the @var{sym} parameter is a substring
20556 of the function name, it is considered to be a match.  For C99 and C++
20557 extended identifiers, the function name must be given in UTF-8, not
20558 using universal character names.
20560 @item -fstack-check
20561 @opindex fstack-check
20562 Generate code to verify that you do not go beyond the boundary of the
20563 stack.  You should specify this flag if you are running in an
20564 environment with multiple threads, but you only rarely need to specify it in
20565 a single-threaded environment since stack overflow is automatically
20566 detected on nearly all systems if there is only one stack.
20568 Note that this switch does not actually cause checking to be done; the
20569 operating system or the language runtime must do that.  The switch causes
20570 generation of code to ensure that they see the stack being extended.
20572 You can additionally specify a string parameter: @code{no} means no
20573 checking, @code{generic} means force the use of old-style checking,
20574 @code{specific} means use the best checking method and is equivalent
20575 to bare @option{-fstack-check}.
20577 Old-style checking is a generic mechanism that requires no specific
20578 target support in the compiler but comes with the following drawbacks:
20580 @enumerate
20581 @item
20582 Modified allocation strategy for large objects: they are always
20583 allocated dynamically if their size exceeds a fixed threshold.
20585 @item
20586 Fixed limit on the size of the static frame of functions: when it is
20587 topped by a particular function, stack checking is not reliable and
20588 a warning is issued by the compiler.
20590 @item
20591 Inefficiency: because of both the modified allocation strategy and the
20592 generic implementation, code performance is hampered.
20593 @end enumerate
20595 Note that old-style stack checking is also the fallback method for
20596 @code{specific} if no target support has been added in the compiler.
20598 @item -fstack-limit-register=@var{reg}
20599 @itemx -fstack-limit-symbol=@var{sym}
20600 @itemx -fno-stack-limit
20601 @opindex fstack-limit-register
20602 @opindex fstack-limit-symbol
20603 @opindex fno-stack-limit
20604 Generate code to ensure that the stack does not grow beyond a certain value,
20605 either the value of a register or the address of a symbol.  If a larger
20606 stack is required, a signal is raised at run time.  For most targets,
20607 the signal is raised before the stack overruns the boundary, so
20608 it is possible to catch the signal without taking special precautions.
20610 For instance, if the stack starts at absolute address @samp{0x80000000}
20611 and grows downwards, you can use the flags
20612 @option{-fstack-limit-symbol=__stack_limit} and
20613 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
20614 of 128KB@.  Note that this may only work with the GNU linker.
20616 @item -fsplit-stack
20617 @opindex fsplit-stack
20618 Generate code to automatically split the stack before it overflows.
20619 The resulting program has a discontiguous stack which can only
20620 overflow if the program is unable to allocate any more memory.  This
20621 is most useful when running threaded programs, as it is no longer
20622 necessary to calculate a good stack size to use for each thread.  This
20623 is currently only implemented for the i386 and x86_64 back ends running
20624 GNU/Linux.
20626 When code compiled with @option{-fsplit-stack} calls code compiled
20627 without @option{-fsplit-stack}, there may not be much stack space
20628 available for the latter code to run.  If compiling all code,
20629 including library code, with @option{-fsplit-stack} is not an option,
20630 then the linker can fix up these calls so that the code compiled
20631 without @option{-fsplit-stack} always has a large stack.  Support for
20632 this is implemented in the gold linker in GNU binutils release 2.21
20633 and later.
20635 @item -fleading-underscore
20636 @opindex fleading-underscore
20637 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
20638 change the way C symbols are represented in the object file.  One use
20639 is to help link with legacy assembly code.
20641 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
20642 generate code that is not binary compatible with code generated without that
20643 switch.  Use it to conform to a non-default application binary interface.
20644 Not all targets provide complete support for this switch.
20646 @item -ftls-model=@var{model}
20647 @opindex ftls-model
20648 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
20649 The @var{model} argument should be one of @code{global-dynamic},
20650 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
20652 The default without @option{-fpic} is @code{initial-exec}; with
20653 @option{-fpic} the default is @code{global-dynamic}.
20655 @item -fvisibility=@var{default|internal|hidden|protected}
20656 @opindex fvisibility
20657 Set the default ELF image symbol visibility to the specified option---all
20658 symbols are marked with this unless overridden within the code.
20659 Using this feature can very substantially improve linking and
20660 load times of shared object libraries, produce more optimized
20661 code, provide near-perfect API export and prevent symbol clashes.
20662 It is @strong{strongly} recommended that you use this in any shared objects
20663 you distribute.
20665 Despite the nomenclature, @code{default} always means public; i.e.,
20666 available to be linked against from outside the shared object.
20667 @code{protected} and @code{internal} are pretty useless in real-world
20668 usage so the only other commonly used option is @code{hidden}.
20669 The default if @option{-fvisibility} isn't specified is
20670 @code{default}, i.e., make every
20671 symbol public---this causes the same behavior as previous versions of
20672 GCC@.
20674 A good explanation of the benefits offered by ensuring ELF
20675 symbols have the correct visibility is given by ``How To Write
20676 Shared Libraries'' by Ulrich Drepper (which can be found at
20677 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
20678 solution made possible by this option to marking things hidden when
20679 the default is public is to make the default hidden and mark things
20680 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
20681 and @code{__attribute__ ((visibility("default")))} instead of
20682 @code{__declspec(dllexport)} you get almost identical semantics with
20683 identical syntax.  This is a great boon to those working with
20684 cross-platform projects.
20686 For those adding visibility support to existing code, you may find
20687 @samp{#pragma GCC visibility} of use.  This works by you enclosing
20688 the declarations you wish to set visibility for with (for example)
20689 @samp{#pragma GCC visibility push(hidden)} and
20690 @samp{#pragma GCC visibility pop}.
20691 Bear in mind that symbol visibility should be viewed @strong{as
20692 part of the API interface contract} and thus all new code should
20693 always specify visibility when it is not the default; i.e., declarations
20694 only for use within the local DSO should @strong{always} be marked explicitly
20695 as hidden as so to avoid PLT indirection overheads---making this
20696 abundantly clear also aids readability and self-documentation of the code.
20697 Note that due to ISO C++ specification requirements, @code{operator new} and
20698 @code{operator delete} must always be of default visibility.
20700 Be aware that headers from outside your project, in particular system
20701 headers and headers from any other library you use, may not be
20702 expecting to be compiled with visibility other than the default.  You
20703 may need to explicitly say @samp{#pragma GCC visibility push(default)}
20704 before including any such headers.
20706 @samp{extern} declarations are not affected by @option{-fvisibility}, so
20707 a lot of code can be recompiled with @option{-fvisibility=hidden} with
20708 no modifications.  However, this means that calls to @code{extern}
20709 functions with no explicit visibility use the PLT, so it is more
20710 effective to use @code{__attribute ((visibility))} and/or
20711 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
20712 declarations should be treated as hidden.
20714 Note that @option{-fvisibility} does affect C++ vague linkage
20715 entities. This means that, for instance, an exception class that is
20716 be thrown between DSOs must be explicitly marked with default
20717 visibility so that the @samp{type_info} nodes are unified between
20718 the DSOs.
20720 An overview of these techniques, their benefits and how to use them
20721 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
20723 @item -fstrict-volatile-bitfields
20724 @opindex fstrict-volatile-bitfields
20725 This option should be used if accesses to volatile bit-fields (or other
20726 structure fields, although the compiler usually honors those types
20727 anyway) should use a single access of the width of the
20728 field's type, aligned to a natural alignment if possible.  For
20729 example, targets with memory-mapped peripheral registers might require
20730 all such accesses to be 16 bits wide; with this flag you can
20731 declare all peripheral bit-fields as @code{unsigned short} (assuming short
20732 is 16 bits on these targets) to force GCC to use 16-bit accesses
20733 instead of, perhaps, a more efficient 32-bit access.
20735 If this option is disabled, the compiler uses the most efficient
20736 instruction.  In the previous example, that might be a 32-bit load
20737 instruction, even though that accesses bytes that do not contain
20738 any portion of the bit-field, or memory-mapped registers unrelated to
20739 the one being updated.
20741 If the target requires strict alignment, and honoring the field
20742 type would require violating this alignment, a warning is issued.
20743 If the field has @code{packed} attribute, the access is done without
20744 honoring the field type.  If the field doesn't have @code{packed}
20745 attribute, the access is done honoring the field type.  In both cases,
20746 GCC assumes that the user knows something about the target hardware
20747 that it is unaware of.
20749 The default value of this option is determined by the application binary
20750 interface for the target processor.
20752 @item -fsync-libcalls
20753 @opindex fsync-libcalls
20754 This option controls whether any out-of-line instance of the @code{__sync}
20755 family of functions may be used to implement the C++11 @code{__atomic}
20756 family of functions.
20758 The default value of this option is enabled, thus the only useful form
20759 of the option is @option{-fno-sync-libcalls}.  This option is used in
20760 the implementation of the @file{libatomic} runtime library.
20762 @end table
20764 @c man end
20766 @node Environment Variables
20767 @section Environment Variables Affecting GCC
20768 @cindex environment variables
20770 @c man begin ENVIRONMENT
20771 This section describes several environment variables that affect how GCC
20772 operates.  Some of them work by specifying directories or prefixes to use
20773 when searching for various kinds of files.  Some are used to specify other
20774 aspects of the compilation environment.
20776 Note that you can also specify places to search using options such as
20777 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
20778 take precedence over places specified using environment variables, which
20779 in turn take precedence over those specified by the configuration of GCC@.
20780 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
20781 GNU Compiler Collection (GCC) Internals}.
20783 @table @env
20784 @item LANG
20785 @itemx LC_CTYPE
20786 @c @itemx LC_COLLATE
20787 @itemx LC_MESSAGES
20788 @c @itemx LC_MONETARY
20789 @c @itemx LC_NUMERIC
20790 @c @itemx LC_TIME
20791 @itemx LC_ALL
20792 @findex LANG
20793 @findex LC_CTYPE
20794 @c @findex LC_COLLATE
20795 @findex LC_MESSAGES
20796 @c @findex LC_MONETARY
20797 @c @findex LC_NUMERIC
20798 @c @findex LC_TIME
20799 @findex LC_ALL
20800 @cindex locale
20801 These environment variables control the way that GCC uses
20802 localization information which allows GCC to work with different
20803 national conventions.  GCC inspects the locale categories
20804 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
20805 so.  These locale categories can be set to any value supported by your
20806 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
20807 Kingdom encoded in UTF-8.
20809 The @env{LC_CTYPE} environment variable specifies character
20810 classification.  GCC uses it to determine the character boundaries in
20811 a string; this is needed for some multibyte encodings that contain quote
20812 and escape characters that are otherwise interpreted as a string
20813 end or escape.
20815 The @env{LC_MESSAGES} environment variable specifies the language to
20816 use in diagnostic messages.
20818 If the @env{LC_ALL} environment variable is set, it overrides the value
20819 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
20820 and @env{LC_MESSAGES} default to the value of the @env{LANG}
20821 environment variable.  If none of these variables are set, GCC
20822 defaults to traditional C English behavior.
20824 @item TMPDIR
20825 @findex TMPDIR
20826 If @env{TMPDIR} is set, it specifies the directory to use for temporary
20827 files.  GCC uses temporary files to hold the output of one stage of
20828 compilation which is to be used as input to the next stage: for example,
20829 the output of the preprocessor, which is the input to the compiler
20830 proper.
20832 @item GCC_COMPARE_DEBUG
20833 @findex GCC_COMPARE_DEBUG
20834 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
20835 @option{-fcompare-debug} to the compiler driver.  See the documentation
20836 of this option for more details.
20838 @item GCC_EXEC_PREFIX
20839 @findex GCC_EXEC_PREFIX
20840 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
20841 names of the subprograms executed by the compiler.  No slash is added
20842 when this prefix is combined with the name of a subprogram, but you can
20843 specify a prefix that ends with a slash if you wish.
20845 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
20846 an appropriate prefix to use based on the pathname it is invoked with.
20848 If GCC cannot find the subprogram using the specified prefix, it
20849 tries looking in the usual places for the subprogram.
20851 The default value of @env{GCC_EXEC_PREFIX} is
20852 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
20853 the installed compiler. In many cases @var{prefix} is the value
20854 of @code{prefix} when you ran the @file{configure} script.
20856 Other prefixes specified with @option{-B} take precedence over this prefix.
20858 This prefix is also used for finding files such as @file{crt0.o} that are
20859 used for linking.
20861 In addition, the prefix is used in an unusual way in finding the
20862 directories to search for header files.  For each of the standard
20863 directories whose name normally begins with @samp{/usr/local/lib/gcc}
20864 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
20865 replacing that beginning with the specified prefix to produce an
20866 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
20867 @file{foo/bar} just before it searches the standard directory 
20868 @file{/usr/local/lib/bar}.
20869 If a standard directory begins with the configured
20870 @var{prefix} then the value of @var{prefix} is replaced by
20871 @env{GCC_EXEC_PREFIX} when looking for header files.
20873 @item COMPILER_PATH
20874 @findex COMPILER_PATH
20875 The value of @env{COMPILER_PATH} is a colon-separated list of
20876 directories, much like @env{PATH}.  GCC tries the directories thus
20877 specified when searching for subprograms, if it can't find the
20878 subprograms using @env{GCC_EXEC_PREFIX}.
20880 @item LIBRARY_PATH
20881 @findex LIBRARY_PATH
20882 The value of @env{LIBRARY_PATH} is a colon-separated list of
20883 directories, much like @env{PATH}.  When configured as a native compiler,
20884 GCC tries the directories thus specified when searching for special
20885 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
20886 using GCC also uses these directories when searching for ordinary
20887 libraries for the @option{-l} option (but directories specified with
20888 @option{-L} come first).
20890 @item LANG
20891 @findex LANG
20892 @cindex locale definition
20893 This variable is used to pass locale information to the compiler.  One way in
20894 which this information is used is to determine the character set to be used
20895 when character literals, string literals and comments are parsed in C and C++.
20896 When the compiler is configured to allow multibyte characters,
20897 the following values for @env{LANG} are recognized:
20899 @table @samp
20900 @item C-JIS
20901 Recognize JIS characters.
20902 @item C-SJIS
20903 Recognize SJIS characters.
20904 @item C-EUCJP
20905 Recognize EUCJP characters.
20906 @end table
20908 If @env{LANG} is not defined, or if it has some other value, then the
20909 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
20910 recognize and translate multibyte characters.
20911 @end table
20913 @noindent
20914 Some additional environment variables affect the behavior of the
20915 preprocessor.
20917 @include cppenv.texi
20919 @c man end
20921 @node Precompiled Headers
20922 @section Using Precompiled Headers
20923 @cindex precompiled headers
20924 @cindex speed of compilation
20926 Often large projects have many header files that are included in every
20927 source file.  The time the compiler takes to process these header files
20928 over and over again can account for nearly all of the time required to
20929 build the project.  To make builds faster, GCC allows you to
20930 @dfn{precompile} a header file.
20932 To create a precompiled header file, simply compile it as you would any
20933 other file, if necessary using the @option{-x} option to make the driver
20934 treat it as a C or C++ header file.  You may want to use a
20935 tool like @command{make} to keep the precompiled header up-to-date when
20936 the headers it contains change.
20938 A precompiled header file is searched for when @code{#include} is
20939 seen in the compilation.  As it searches for the included file
20940 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
20941 compiler looks for a precompiled header in each directory just before it
20942 looks for the include file in that directory.  The name searched for is
20943 the name specified in the @code{#include} with @samp{.gch} appended.  If
20944 the precompiled header file can't be used, it is ignored.
20946 For instance, if you have @code{#include "all.h"}, and you have
20947 @file{all.h.gch} in the same directory as @file{all.h}, then the
20948 precompiled header file is used if possible, and the original
20949 header is used otherwise.
20951 Alternatively, you might decide to put the precompiled header file in a
20952 directory and use @option{-I} to ensure that directory is searched
20953 before (or instead of) the directory containing the original header.
20954 Then, if you want to check that the precompiled header file is always
20955 used, you can put a file of the same name as the original header in this
20956 directory containing an @code{#error} command.
20958 This also works with @option{-include}.  So yet another way to use
20959 precompiled headers, good for projects not designed with precompiled
20960 header files in mind, is to simply take most of the header files used by
20961 a project, include them from another header file, precompile that header
20962 file, and @option{-include} the precompiled header.  If the header files
20963 have guards against multiple inclusion, they are skipped because
20964 they've already been included (in the precompiled header).
20966 If you need to precompile the same header file for different
20967 languages, targets, or compiler options, you can instead make a
20968 @emph{directory} named like @file{all.h.gch}, and put each precompiled
20969 header in the directory, perhaps using @option{-o}.  It doesn't matter
20970 what you call the files in the directory; every precompiled header in
20971 the directory is considered.  The first precompiled header
20972 encountered in the directory that is valid for this compilation is
20973 used; they're searched in no particular order.
20975 There are many other possibilities, limited only by your imagination,
20976 good sense, and the constraints of your build system.
20978 A precompiled header file can be used only when these conditions apply:
20980 @itemize
20981 @item
20982 Only one precompiled header can be used in a particular compilation.
20984 @item
20985 A precompiled header can't be used once the first C token is seen.  You
20986 can have preprocessor directives before a precompiled header; you cannot
20987 include a precompiled header from inside another header.
20989 @item
20990 The precompiled header file must be produced for the same language as
20991 the current compilation.  You can't use a C precompiled header for a C++
20992 compilation.
20994 @item
20995 The precompiled header file must have been produced by the same compiler
20996 binary as the current compilation is using.
20998 @item
20999 Any macros defined before the precompiled header is included must
21000 either be defined in the same way as when the precompiled header was
21001 generated, or must not affect the precompiled header, which usually
21002 means that they don't appear in the precompiled header at all.
21004 The @option{-D} option is one way to define a macro before a
21005 precompiled header is included; using a @code{#define} can also do it.
21006 There are also some options that define macros implicitly, like
21007 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
21008 defined this way.
21010 @item If debugging information is output when using the precompiled
21011 header, using @option{-g} or similar, the same kind of debugging information
21012 must have been output when building the precompiled header.  However,
21013 a precompiled header built using @option{-g} can be used in a compilation
21014 when no debugging information is being output.
21016 @item The same @option{-m} options must generally be used when building
21017 and using the precompiled header.  @xref{Submodel Options},
21018 for any cases where this rule is relaxed.
21020 @item Each of the following options must be the same when building and using
21021 the precompiled header:
21023 @gccoptlist{-fexceptions}
21025 @item
21026 Some other command-line options starting with @option{-f},
21027 @option{-p}, or @option{-O} must be defined in the same way as when
21028 the precompiled header was generated.  At present, it's not clear
21029 which options are safe to change and which are not; the safest choice
21030 is to use exactly the same options when generating and using the
21031 precompiled header.  The following are known to be safe:
21033 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
21034 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
21035 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
21036 -pedantic-errors}
21038 @end itemize
21040 For all of these except the last, the compiler automatically
21041 ignores the precompiled header if the conditions aren't met.  If you
21042 find an option combination that doesn't work and doesn't cause the
21043 precompiled header to be ignored, please consider filing a bug report,
21044 see @ref{Bugs}.
21046 If you do use differing options when generating and using the
21047 precompiled header, the actual behavior is a mixture of the
21048 behavior for the options.  For instance, if you use @option{-g} to
21049 generate the precompiled header but not when using it, you may or may
21050 not get debugging information for routines in the precompiled header.