[AArch64] Wire up vqdmullh_laneq_s16 and vqdmullh_laneq_s32
[official-gcc.git] / gcc / doc / invoke.texi
blob5fe7e15b4e9146ddadfd48b7e4da38c708f5405a
1 @c Copyright (C) 1988-2014 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-2014 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 -fopenmp-simd -fms-extensions @gol
172 -fplan9-extensions -trigraphs  -traditional  -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
191 -ftemplate-depth=@var{n} @gol
192 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
193 -fno-weak  -nostdinc++ @gol
194 -fvisibility-inlines-hidden @gol
195 -fvtable-verify=@var{std|preinit|none} @gol
196 -fvtv-counts -fvtv-debug @gol
197 -fvisibility-ms-compat @gol
198 -fext-numeric-literals @gol
199 -Wabi=@var{n}  -Wconversion-null  -Wctor-dtor-privacy @gol
200 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
201 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
202 -Weffc++  -Wstrict-null-sentinel @gol
203 -Wno-non-template-friend  -Wold-style-cast @gol
204 -Woverloaded-virtual  -Wno-pmf-conversions @gol
205 -Wsign-promo}
207 @item Objective-C and Objective-C++ Language Options
208 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
209 Objective-C and Objective-C++ Dialects}.
210 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
211 -fgnu-runtime  -fnext-runtime @gol
212 -fno-nil-receivers @gol
213 -fobjc-abi-version=@var{n} @gol
214 -fobjc-call-cxx-cdtors @gol
215 -fobjc-direct-dispatch @gol
216 -fobjc-exceptions @gol
217 -fobjc-gc @gol
218 -fobjc-nilcheck @gol
219 -fobjc-std=objc1 @gol
220 -fno-local-ivars @gol
221 -fivar-visibility=@var{public|protected|private|package} @gol
222 -freplace-objc-classes @gol
223 -fzero-link @gol
224 -gen-decls @gol
225 -Wassign-intercept @gol
226 -Wno-protocol  -Wselector @gol
227 -Wstrict-selector-match @gol
228 -Wundeclared-selector}
230 @item Language Independent Options
231 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
232 @gccoptlist{-fmessage-length=@var{n}  @gol
233 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
234 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
235 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
237 @item Warning Options
238 @xref{Warning Options,,Options to Request or Suppress Warnings}.
239 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
240 -pedantic-errors @gol
241 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
242 -Waggressive-loop-optimizations -Warray-bounds @gol
243 -Wbool-compare @gol
244 -Wno-attributes -Wno-builtin-macro-redefined @gol
245 -Wc90-c99-compat -Wc99-c11-compat @gol
246 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
247 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
248 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
249 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
250 -Wdisabled-optimization -Wno-discarded-qualifiers @gol
251 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
252 -Wno-endif-labels -Werror  -Werror=* @gol
253 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
254 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
255 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
256 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
257 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
258 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
259 -Winit-self  -Winline  -Wno-int-conversion @gol
260 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
261 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
262 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
263 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args -Wmissing-braces @gol
264 -Wmissing-field-initializers -Wmissing-include-dirs @gol
265 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
266  -Wodr  -Wno-overflow  -Wopenmp-simd @gol
267 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
268 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
269 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
270 -Wredundant-decls  -Wno-return-local-addr @gol
271 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
272 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
273 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
274 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
275 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
276 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
277 -Wsuggest-final-types @gol -Wsuggest-final-methods @gol
278 -Wmissing-format-attribute @gol
279 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
280 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
281 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
282 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
283 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
284 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
285 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
286 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
287 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
289 @item C and Objective-C-only Warning Options
290 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
291 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
292 -Wold-style-declaration  -Wold-style-definition @gol
293 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
294 -Wdeclaration-after-statement -Wpointer-sign}
296 @item Debugging Options
297 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
298 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
299 -fsanitize=@var{style} -fsanitize-recover @gol
300 -fsanitize-undefined-trap-on-error @gol
301 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
302 -fdisable-ipa-@var{pass_name} @gol
303 -fdisable-rtl-@var{pass_name} @gol
304 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
305 -fdisable-tree-@var{pass_name} @gol
306 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
307 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
308 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
309 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
310 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
311 -fdump-passes @gol
312 -fdump-statistics @gol
313 -fdump-tree-all @gol
314 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
315 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-cfg -fdump-tree-alias @gol
317 -fdump-tree-ch @gol
318 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
319 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-gimple@r{[}-raw@r{]} @gol
321 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
323 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
324 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
325 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
326 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
327 -fdump-tree-nrv -fdump-tree-vect @gol
328 -fdump-tree-sink @gol
329 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
330 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
331 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
332 -fdump-tree-vtable-verify @gol
333 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
334 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
335 -fdump-final-insns=@var{file} @gol
336 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
337 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
338 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
339 -fenable-@var{kind}-@var{pass} @gol
340 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
341 -fdebug-types-section -fmem-report-wpa @gol
342 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
343 -fopt-info @gol
344 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
345 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
346 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
347 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
348 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
349 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
350 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
351 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
352 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
353 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
354 -fdebug-prefix-map=@var{old}=@var{new} @gol
355 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
356 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
357 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
358 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
359 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
360 -print-sysroot -print-sysroot-headers-suffix @gol
361 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
363 @item Optimization Options
364 @xref{Optimize Options,,Options that Control Optimization}.
365 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
366 -falign-jumps[=@var{n}] @gol
367 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
368 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
369 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
370 -fbtr-bb-exclusive -fcaller-saves @gol
371 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
372 -fcompare-elim -fcprop-registers -fcrossjumping @gol
373 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
374 -fcx-limited-range @gol
375 -fdata-sections -fdce -fdelayed-branch @gol
376 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively -fdse @gol
377 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
378 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
379 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
380 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
381 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
382 -fif-conversion2 -findirect-inlining @gol
383 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
384 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
385 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
386 -fira-algorithm=@var{algorithm} @gol
387 -fira-region=@var{region} -fira-hoist-pressure @gol
388 -fira-loop-pressure -fno-ira-share-save-slots @gol
389 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
390 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
391 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
392 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
393 -floop-parallelize-all -flto -flto-compression-level @gol
394 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
395 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
396 -fmove-loop-invariants -fno-branch-count-reg @gol
397 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
398 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
399 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
400 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
401 -fomit-frame-pointer -foptimize-sibling-calls @gol
402 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
403 -fprefetch-loop-arrays -fprofile-report @gol
404 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
405 -fprofile-generate=@var{path} @gol
406 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
407 -freciprocal-math -free -frename-registers -freorder-blocks @gol
408 -freorder-blocks-and-partition -freorder-functions @gol
409 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
410 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
411 -fsched-spec-load -fsched-spec-load-dangerous @gol
412 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
413 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
414 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
415 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
416 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
417 -fselective-scheduling -fselective-scheduling2 @gol
418 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
419 -fsemantic-interposition @gol
420 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
421 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt -fstack-protector @gol
422 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
423 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
424 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
425 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
426 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
427 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
428 -ftree-loop-if-convert-stores -ftree-loop-im @gol
429 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
430 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
431 -ftree-loop-vectorize @gol
432 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
433 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
434 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
435 -ftree-vectorize -ftree-vrp @gol
436 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
437 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
438 -fuse-caller-save -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
439 -fweb -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
440 --param @var{name}=@var{value}
441 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
443 @item Preprocessor Options
444 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
445 @gccoptlist{-A@var{question}=@var{answer} @gol
446 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
447 -C  -dD  -dI  -dM  -dN @gol
448 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
449 -idirafter @var{dir} @gol
450 -include @var{file}  -imacros @var{file} @gol
451 -iprefix @var{file}  -iwithprefix @var{dir} @gol
452 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
453 -imultilib @var{dir} -isysroot @var{dir} @gol
454 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
455 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
456 -remap -trigraphs  -undef  -U@var{macro}  @gol
457 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
459 @item Assembler Option
460 @xref{Assembler Options,,Passing Options to the Assembler}.
461 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
463 @item Linker Options
464 @xref{Link Options,,Options for Linking}.
465 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
466 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
467 -s  -static -static-libgcc -static-libstdc++ @gol
468 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
469 -shared -shared-libgcc  -symbolic @gol
470 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
471 -u @var{symbol} -z @var{keyword}}
473 @item Directory Options
474 @xref{Directory Options,,Options for Directory Search}.
475 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
476 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
477 --sysroot=@var{dir} --no-sysroot-suffix}
479 @item Machine Dependent Options
480 @xref{Submodel Options,,Hardware Models and Configurations}.
481 @c This list is ordered alphanumerically by subsection name.
482 @c Try and put the significant identifier (CPU or system) first,
483 @c so users have a clue at guessing where the ones they want will be.
485 @emph{AArch64 Options}
486 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
487 -mgeneral-regs-only @gol
488 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
489 -mstrict-align @gol
490 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
491 -mtls-dialect=desc  -mtls-dialect=traditional @gol
492 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
494 @emph{Adapteva Epiphany Options}
495 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
496 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
497 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
498 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
499 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
500 -msplit-vecmove-early -m1reg-@var{reg}}
502 @emph{ARC Options}
503 @gccoptlist{-mbarrel-shifter @gol
504 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
505 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
506 -mea -mno-mpy -mmul32x16 -mmul64 @gol
507 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
508 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
509 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
510 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
511 -mucb-mcount -mvolatile-cache @gol
512 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
513 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
514 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
515 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
516 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
517 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
519 @emph{ARM Options}
520 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
521 -mabi=@var{name} @gol
522 -mapcs-stack-check  -mno-apcs-stack-check @gol
523 -mapcs-float  -mno-apcs-float @gol
524 -mapcs-reentrant  -mno-apcs-reentrant @gol
525 -msched-prolog  -mno-sched-prolog @gol
526 -mlittle-endian  -mbig-endian @gol
527 -mfloat-abi=@var{name} @gol
528 -mfp16-format=@var{name}
529 -mthumb-interwork  -mno-thumb-interwork @gol
530 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
531 -mstructure-size-boundary=@var{n} @gol
532 -mabort-on-noreturn @gol
533 -mlong-calls  -mno-long-calls @gol
534 -msingle-pic-base  -mno-single-pic-base @gol
535 -mpic-register=@var{reg} @gol
536 -mnop-fun-dllimport @gol
537 -mpoke-function-name @gol
538 -mthumb  -marm @gol
539 -mtpcs-frame  -mtpcs-leaf-frame @gol
540 -mcaller-super-interworking  -mcallee-super-interworking @gol
541 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
542 -mword-relocations @gol
543 -mfix-cortex-m3-ldrd @gol
544 -munaligned-access @gol
545 -mneon-for-64bits @gol
546 -mslow-flash-data @gol
547 -mrestrict-it}
549 @emph{AVR Options}
550 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
551 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
552 -mstrict-X -mtiny-stack -Waddr-space-convert}
554 @emph{Blackfin Options}
555 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
556 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
557 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
558 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
559 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
560 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
561 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
562 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
563 -micplb}
565 @emph{C6X Options}
566 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
567 -msim -msdata=@var{sdata-type}}
569 @emph{CRIS Options}
570 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
571 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
572 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
573 -mstack-align  -mdata-align  -mconst-align @gol
574 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
575 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
576 -mmul-bug-workaround  -mno-mul-bug-workaround}
578 @emph{CR16 Options}
579 @gccoptlist{-mmac @gol
580 -mcr16cplus -mcr16c @gol
581 -msim -mint32 -mbit-ops
582 -mdata-model=@var{model}}
584 @emph{Darwin Options}
585 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
586 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
587 -client_name  -compatibility_version  -current_version @gol
588 -dead_strip @gol
589 -dependency-file  -dylib_file  -dylinker_install_name @gol
590 -dynamic  -dynamiclib  -exported_symbols_list @gol
591 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
592 -force_flat_namespace  -headerpad_max_install_names @gol
593 -iframework @gol
594 -image_base  -init  -install_name  -keep_private_externs @gol
595 -multi_module  -multiply_defined  -multiply_defined_unused @gol
596 -noall_load   -no_dead_strip_inits_and_terms @gol
597 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
598 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
599 -private_bundle  -read_only_relocs  -sectalign @gol
600 -sectobjectsymbols  -whyload  -seg1addr @gol
601 -sectcreate  -sectobjectsymbols  -sectorder @gol
602 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
603 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
604 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
605 -single_module  -static  -sub_library  -sub_umbrella @gol
606 -twolevel_namespace  -umbrella  -undefined @gol
607 -unexported_symbols_list  -weak_reference_mismatches @gol
608 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
609 -mkernel -mone-byte-bool}
611 @emph{DEC Alpha Options}
612 @gccoptlist{-mno-fp-regs  -msoft-float @gol
613 -mieee  -mieee-with-inexact  -mieee-conformant @gol
614 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
615 -mtrap-precision=@var{mode}  -mbuild-constants @gol
616 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
617 -mbwx  -mmax  -mfix  -mcix @gol
618 -mfloat-vax  -mfloat-ieee @gol
619 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
620 -msmall-text  -mlarge-text @gol
621 -mmemory-latency=@var{time}}
623 @emph{FR30 Options}
624 @gccoptlist{-msmall-model -mno-lsim}
626 @emph{FRV Options}
627 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
628 -mhard-float  -msoft-float @gol
629 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
630 -mdouble  -mno-double @gol
631 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
632 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
633 -mlinked-fp  -mlong-calls  -malign-labels @gol
634 -mlibrary-pic  -macc-4  -macc-8 @gol
635 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
636 -moptimize-membar -mno-optimize-membar @gol
637 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
638 -mvliw-branch  -mno-vliw-branch @gol
639 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
640 -mno-nested-cond-exec  -mtomcat-stats @gol
641 -mTLS -mtls @gol
642 -mcpu=@var{cpu}}
644 @emph{GNU/Linux Options}
645 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
646 -tno-android-cc -tno-android-ld}
648 @emph{H8/300 Options}
649 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
651 @emph{HPPA Options}
652 @gccoptlist{-march=@var{architecture-type} @gol
653 -mdisable-fpregs  -mdisable-indexing @gol
654 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
655 -mfixed-range=@var{register-range} @gol
656 -mjump-in-delay -mlinker-opt -mlong-calls @gol
657 -mlong-load-store  -mno-disable-fpregs @gol
658 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
659 -mno-jump-in-delay  -mno-long-load-store @gol
660 -mno-portable-runtime  -mno-soft-float @gol
661 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
662 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
663 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
664 -munix=@var{unix-std}  -nolibdld  -static  -threads}
666 @emph{i386 and x86-64 Options}
667 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
668 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
669 -mfpmath=@var{unit} @gol
670 -masm=@var{dialect}  -mno-fancy-math-387 @gol
671 -mno-fp-ret-in-387  -msoft-float @gol
672 -mno-wide-multiply  -mrtd  -malign-double @gol
673 -mpreferred-stack-boundary=@var{num} @gol
674 -mincoming-stack-boundary=@var{num} @gol
675 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
676 -mrecip -mrecip=@var{opt} @gol
677 -mvzeroupper -mprefer-avx128 @gol
678 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
679 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
680 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
681 -mclflushopt -mxsavec -mxsaves @gol
682 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
683 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mthreads @gol
684 -mno-align-stringops  -minline-all-stringops @gol
685 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
686 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
687 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
688 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
689 -mregparm=@var{num}  -msseregparm @gol
690 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
691 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
692 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
693 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
694 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
695 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
696 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
697 -mstack-protector-guard=@var{guard}}
699 @emph{i386 and x86-64 Windows Options}
700 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
701 -mnop-fun-dllimport -mthread @gol
702 -municode -mwin32 -mwindows -fno-set-stack-executable}
704 @emph{IA-64 Options}
705 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
706 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
707 -mconstant-gp  -mauto-pic  -mfused-madd @gol
708 -minline-float-divide-min-latency @gol
709 -minline-float-divide-max-throughput @gol
710 -mno-inline-float-divide @gol
711 -minline-int-divide-min-latency @gol
712 -minline-int-divide-max-throughput  @gol
713 -mno-inline-int-divide @gol
714 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
715 -mno-inline-sqrt @gol
716 -mdwarf2-asm -mearly-stop-bits @gol
717 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
718 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
719 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
720 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
721 -msched-spec-ldc -msched-spec-control-ldc @gol
722 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
723 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
724 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
725 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
727 @emph{LM32 Options}
728 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
729 -msign-extend-enabled -muser-enabled}
731 @emph{M32R/D Options}
732 @gccoptlist{-m32r2 -m32rx -m32r @gol
733 -mdebug @gol
734 -malign-loops -mno-align-loops @gol
735 -missue-rate=@var{number} @gol
736 -mbranch-cost=@var{number} @gol
737 -mmodel=@var{code-size-model-type} @gol
738 -msdata=@var{sdata-type} @gol
739 -mno-flush-func -mflush-func=@var{name} @gol
740 -mno-flush-trap -mflush-trap=@var{number} @gol
741 -G @var{num}}
743 @emph{M32C Options}
744 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
746 @emph{M680x0 Options}
747 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
748 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
749 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
750 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
751 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
752 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
753 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
754 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
755 -mxgot -mno-xgot}
757 @emph{MCore Options}
758 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
759 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
760 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
761 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
762 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
764 @emph{MeP Options}
765 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
766 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
767 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
768 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
769 -mtiny=@var{n}}
771 @emph{MicroBlaze Options}
772 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
773 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
774 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
775 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
776 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
778 @emph{MIPS Options}
779 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
780 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
781 -mips64  -mips64r2  -mips64r3  -mips64r5 @gol
782 -mips16  -mno-mips16  -mflip-mips16 @gol
783 -minterlink-compressed -mno-interlink-compressed @gol
784 -minterlink-mips16  -mno-interlink-mips16 @gol
785 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
786 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
787 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
788 -mno-float  -msingle-float  -mdouble-float @gol
789 -mabs=@var{mode}  -mnan=@var{encoding} @gol
790 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
791 -mmcu -mmno-mcu @gol
792 -meva -mno-eva @gol
793 -mvirt -mno-virt @gol
794 -mxpa -mno-xpa @gol
795 -mmicromips -mno-micromips @gol
796 -mfpu=@var{fpu-type} @gol
797 -msmartmips  -mno-smartmips @gol
798 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
799 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
800 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
801 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
802 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
803 -membedded-data  -mno-embedded-data @gol
804 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
805 -mcode-readable=@var{setting} @gol
806 -msplit-addresses  -mno-split-addresses @gol
807 -mexplicit-relocs  -mno-explicit-relocs @gol
808 -mcheck-zero-division  -mno-check-zero-division @gol
809 -mdivide-traps  -mdivide-breaks @gol
810 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
811 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
812 -mfix-24k -mno-fix-24k @gol
813 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
814 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
815 -mfix-vr4120  -mno-fix-vr4120 @gol
816 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
817 -mflush-func=@var{func}  -mno-flush-func @gol
818 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
819 -mfp-exceptions -mno-fp-exceptions @gol
820 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
821 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
823 @emph{MMIX Options}
824 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
825 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
826 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
827 -mno-base-addresses  -msingle-exit  -mno-single-exit}
829 @emph{MN10300 Options}
830 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
831 -mno-am33 -mam33 -mam33-2 -mam34 @gol
832 -mtune=@var{cpu-type} @gol
833 -mreturn-pointer-on-d0 @gol
834 -mno-crt0  -mrelax -mliw -msetlb}
836 @emph{Moxie Options}
837 @gccoptlist{-meb -mel -mno-crt0}
839 @emph{MSP430 Options}
840 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
841 -mhwmult= -minrt}
843 @emph{NDS32 Options}
844 @gccoptlist{-mbig-endian -mlittle-endian @gol
845 -mreduced-regs -mfull-regs @gol
846 -mcmov -mno-cmov @gol
847 -mperf-ext -mno-perf-ext @gol
848 -mv3push -mno-v3push @gol
849 -m16bit -mno-16bit @gol
850 -mgp-direct -mno-gp-direct @gol
851 -misr-vector-size=@var{num} @gol
852 -mcache-block-size=@var{num} @gol
853 -march=@var{arch} @gol
854 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
855 -mex9 -mctor-dtor -mrelax}
857 @emph{Nios II Options}
858 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
859 -mno-bypass-cache -mbypass-cache @gol
860 -mno-cache-volatile -mcache-volatile @gol
861 -mno-fast-sw-div -mfast-sw-div @gol
862 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
863 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
864 -mcustom-fpu-cfg=@var{name} @gol
865 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
867 @emph{PDP-11 Options}
868 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
869 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
870 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
871 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
872 -mbranch-expensive  -mbranch-cheap @gol
873 -munix-asm  -mdec-asm}
875 @emph{picoChip Options}
876 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
877 -msymbol-as-address -mno-inefficient-warnings}
879 @emph{PowerPC Options}
880 See RS/6000 and PowerPC Options.
882 @emph{RL78 Options}
883 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78 @gol
884 -m64bit-doubles -m32bit-doubles}
886 @emph{RS/6000 and PowerPC Options}
887 @gccoptlist{-mcpu=@var{cpu-type} @gol
888 -mtune=@var{cpu-type} @gol
889 -mcmodel=@var{code-model} @gol
890 -mpowerpc64 @gol
891 -maltivec  -mno-altivec @gol
892 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
893 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
894 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
895 -mfprnd  -mno-fprnd @gol
896 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
897 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
898 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
899 -malign-power  -malign-natural @gol
900 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
901 -msingle-float -mdouble-float -msimple-fpu @gol
902 -mstring  -mno-string  -mupdate  -mno-update @gol
903 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
904 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
905 -mstrict-align  -mno-strict-align  -mrelocatable @gol
906 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
907 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
908 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
909 -mprioritize-restricted-insns=@var{priority} @gol
910 -msched-costly-dep=@var{dependence_type} @gol
911 -minsert-sched-nops=@var{scheme} @gol
912 -mcall-sysv  -mcall-netbsd @gol
913 -maix-struct-return  -msvr4-struct-return @gol
914 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
915 -mblock-move-inline-limit=@var{num} @gol
916 -misel -mno-isel @gol
917 -misel=yes  -misel=no @gol
918 -mspe -mno-spe @gol
919 -mspe=yes  -mspe=no @gol
920 -mpaired @gol
921 -mgen-cell-microcode -mwarn-cell-microcode @gol
922 -mvrsave -mno-vrsave @gol
923 -mmulhw -mno-mulhw @gol
924 -mdlmzb -mno-dlmzb @gol
925 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
926 -mprototype  -mno-prototype @gol
927 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
928 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
929 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
930 -mno-recip-precision @gol
931 -mveclibabi=@var{type} -mfriz -mno-friz @gol
932 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
933 -msave-toc-indirect -mno-save-toc-indirect @gol
934 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
935 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
936 -mquad-memory -mno-quad-memory @gol
937 -mquad-memory-atomic -mno-quad-memory-atomic @gol
938 -mcompat-align-parm -mno-compat-align-parm}
940 @emph{RX Options}
941 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
942 -mcpu=@gol
943 -mbig-endian-data -mlittle-endian-data @gol
944 -msmall-data @gol
945 -msim  -mno-sim@gol
946 -mas100-syntax -mno-as100-syntax@gol
947 -mrelax@gol
948 -mmax-constant-size=@gol
949 -mint-register=@gol
950 -mpid@gol
951 -mno-warn-multiple-fast-interrupts@gol
952 -msave-acc-in-interrupts}
954 @emph{S/390 and zSeries Options}
955 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
956 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
957 -mlong-double-64 -mlong-double-128 @gol
958 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
959 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
960 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
961 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
962 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
963 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
965 @emph{Score Options}
966 @gccoptlist{-meb -mel @gol
967 -mnhwloop @gol
968 -muls @gol
969 -mmac @gol
970 -mscore5 -mscore5u -mscore7 -mscore7d}
972 @emph{SH Options}
973 @gccoptlist{-m1  -m2  -m2e @gol
974 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
975 -m3  -m3e @gol
976 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
977 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
978 -m5-64media  -m5-64media-nofpu @gol
979 -m5-32media  -m5-32media-nofpu @gol
980 -m5-compact  -m5-compact-nofpu @gol
981 -mb  -ml  -mdalign  -mrelax @gol
982 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
983 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
984 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
985 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
986 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
987 -maccumulate-outgoing-args -minvalid-symbols @gol
988 -matomic-model=@var{atomic-model} @gol
989 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
990 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
991 -mpretend-cmove -mtas}
993 @emph{Solaris 2 Options}
994 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
995 -pthreads -pthread}
997 @emph{SPARC Options}
998 @gccoptlist{-mcpu=@var{cpu-type} @gol
999 -mtune=@var{cpu-type} @gol
1000 -mcmodel=@var{code-model} @gol
1001 -mmemory-model=@var{mem-model} @gol
1002 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1003 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1004 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1005 -mhard-quad-float  -msoft-quad-float @gol
1006 -mstack-bias  -mno-stack-bias @gol
1007 -munaligned-doubles  -mno-unaligned-doubles @gol
1008 -muser-mode  -mno-user-mode @gol
1009 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1010 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1011 -mcbcond -mno-cbcond @gol
1012 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1013 -mfix-at697f -mfix-ut699}
1015 @emph{SPU Options}
1016 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1017 -msafe-dma -munsafe-dma @gol
1018 -mbranch-hints @gol
1019 -msmall-mem -mlarge-mem -mstdmain @gol
1020 -mfixed-range=@var{register-range} @gol
1021 -mea32 -mea64 @gol
1022 -maddress-space-conversion -mno-address-space-conversion @gol
1023 -mcache-size=@var{cache-size} @gol
1024 -matomic-updates -mno-atomic-updates}
1026 @emph{System V Options}
1027 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1029 @emph{TILE-Gx Options}
1030 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1031 -mcmodel=@var{code-model}}
1033 @emph{TILEPro Options}
1034 @gccoptlist{-mcpu=@var{cpu} -m32}
1036 @emph{V850 Options}
1037 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1038 -mprolog-function  -mno-prolog-function  -mspace @gol
1039 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1040 -mapp-regs  -mno-app-regs @gol
1041 -mdisable-callt  -mno-disable-callt @gol
1042 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1043 -mv850e -mv850 -mv850e3v5 @gol
1044 -mloop @gol
1045 -mrelax @gol
1046 -mlong-jumps @gol
1047 -msoft-float @gol
1048 -mhard-float @gol
1049 -mgcc-abi @gol
1050 -mrh850-abi @gol
1051 -mbig-switch}
1053 @emph{VAX Options}
1054 @gccoptlist{-mg  -mgnu  -munix}
1056 @emph{VMS Options}
1057 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1058 -mpointer-size=@var{size}}
1060 @emph{VxWorks Options}
1061 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1062 -Xbind-lazy  -Xbind-now}
1064 @emph{x86-64 Options}
1065 See i386 and x86-64 Options.
1067 @emph{Xstormy16 Options}
1068 @gccoptlist{-msim}
1070 @emph{Xtensa Options}
1071 @gccoptlist{-mconst16 -mno-const16 @gol
1072 -mfused-madd  -mno-fused-madd @gol
1073 -mforce-no-pic @gol
1074 -mserialize-volatile  -mno-serialize-volatile @gol
1075 -mtext-section-literals  -mno-text-section-literals @gol
1076 -mtarget-align  -mno-target-align @gol
1077 -mlongcalls  -mno-longcalls}
1079 @emph{zSeries Options}
1080 See S/390 and zSeries Options.
1082 @item Code Generation Options
1083 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1084 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1085 -ffixed-@var{reg}  -fexceptions @gol
1086 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1087 -fasynchronous-unwind-tables @gol
1088 -fno-gnu-unique @gol
1089 -finhibit-size-directive  -finstrument-functions @gol
1090 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1091 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1092 -fno-common  -fno-ident @gol
1093 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1094 -fno-jump-tables @gol
1095 -frecord-gcc-switches @gol
1096 -freg-struct-return  -fshort-enums @gol
1097 -fshort-double  -fshort-wchar @gol
1098 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1099 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1100 -fno-stack-limit -fsplit-stack @gol
1101 -fleading-underscore  -ftls-model=@var{model} @gol
1102 -fstack-reuse=@var{reuse_level} @gol
1103 -ftrapv  -fwrapv  -fbounds-check @gol
1104 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1105 @end table
1108 @node Overall Options
1109 @section Options Controlling the Kind of Output
1111 Compilation can involve up to four stages: preprocessing, compilation
1112 proper, assembly and linking, always in that order.  GCC is capable of
1113 preprocessing and compiling several files either into several
1114 assembler input files, or into one assembler input file; then each
1115 assembler input file produces an object file, and linking combines all
1116 the object files (those newly compiled, and those specified as input)
1117 into an executable file.
1119 @cindex file name suffix
1120 For any given input file, the file name suffix determines what kind of
1121 compilation is done:
1123 @table @gcctabopt
1124 @item @var{file}.c
1125 C source code that must be preprocessed.
1127 @item @var{file}.i
1128 C source code that should not be preprocessed.
1130 @item @var{file}.ii
1131 C++ source code that should not be preprocessed.
1133 @item @var{file}.m
1134 Objective-C source code.  Note that you must link with the @file{libobjc}
1135 library to make an Objective-C program work.
1137 @item @var{file}.mi
1138 Objective-C source code that should not be preprocessed.
1140 @item @var{file}.mm
1141 @itemx @var{file}.M
1142 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1143 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1144 to a literal capital M@.
1146 @item @var{file}.mii
1147 Objective-C++ source code that should not be preprocessed.
1149 @item @var{file}.h
1150 C, C++, Objective-C or Objective-C++ header file to be turned into a
1151 precompiled header (default), or C, C++ header file to be turned into an
1152 Ada spec (via the @option{-fdump-ada-spec} switch).
1154 @item @var{file}.cc
1155 @itemx @var{file}.cp
1156 @itemx @var{file}.cxx
1157 @itemx @var{file}.cpp
1158 @itemx @var{file}.CPP
1159 @itemx @var{file}.c++
1160 @itemx @var{file}.C
1161 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1162 the last two letters must both be literally @samp{x}.  Likewise,
1163 @samp{.C} refers to a literal capital C@.
1165 @item @var{file}.mm
1166 @itemx @var{file}.M
1167 Objective-C++ source code that must be preprocessed.
1169 @item @var{file}.mii
1170 Objective-C++ source code that should not be preprocessed.
1172 @item @var{file}.hh
1173 @itemx @var{file}.H
1174 @itemx @var{file}.hp
1175 @itemx @var{file}.hxx
1176 @itemx @var{file}.hpp
1177 @itemx @var{file}.HPP
1178 @itemx @var{file}.h++
1179 @itemx @var{file}.tcc
1180 C++ header file to be turned into a precompiled header or Ada spec.
1182 @item @var{file}.f
1183 @itemx @var{file}.for
1184 @itemx @var{file}.ftn
1185 Fixed form Fortran source code that should not be preprocessed.
1187 @item @var{file}.F
1188 @itemx @var{file}.FOR
1189 @itemx @var{file}.fpp
1190 @itemx @var{file}.FPP
1191 @itemx @var{file}.FTN
1192 Fixed form Fortran source code that must be preprocessed (with the traditional
1193 preprocessor).
1195 @item @var{file}.f90
1196 @itemx @var{file}.f95
1197 @itemx @var{file}.f03
1198 @itemx @var{file}.f08
1199 Free form Fortran source code that should not be preprocessed.
1201 @item @var{file}.F90
1202 @itemx @var{file}.F95
1203 @itemx @var{file}.F03
1204 @itemx @var{file}.F08
1205 Free form Fortran source code that must be preprocessed (with the
1206 traditional preprocessor).
1208 @item @var{file}.go
1209 Go source code.
1211 @c FIXME: Descriptions of Java file types.
1212 @c @var{file}.java
1213 @c @var{file}.class
1214 @c @var{file}.zip
1215 @c @var{file}.jar
1217 @item @var{file}.ads
1218 Ada source code file that contains a library unit declaration (a
1219 declaration of a package, subprogram, or generic, or a generic
1220 instantiation), or a library unit renaming declaration (a package,
1221 generic, or subprogram renaming declaration).  Such files are also
1222 called @dfn{specs}.
1224 @item @var{file}.adb
1225 Ada source code file containing a library unit body (a subprogram or
1226 package body).  Such files are also called @dfn{bodies}.
1228 @c GCC also knows about some suffixes for languages not yet included:
1229 @c Pascal:
1230 @c @var{file}.p
1231 @c @var{file}.pas
1232 @c Ratfor:
1233 @c @var{file}.r
1235 @item @var{file}.s
1236 Assembler code.
1238 @item @var{file}.S
1239 @itemx @var{file}.sx
1240 Assembler code that must be preprocessed.
1242 @item @var{other}
1243 An object file to be fed straight into linking.
1244 Any file name with no recognized suffix is treated this way.
1245 @end table
1247 @opindex x
1248 You can specify the input language explicitly with the @option{-x} option:
1250 @table @gcctabopt
1251 @item -x @var{language}
1252 Specify explicitly the @var{language} for the following input files
1253 (rather than letting the compiler choose a default based on the file
1254 name suffix).  This option applies to all following input files until
1255 the next @option{-x} option.  Possible values for @var{language} are:
1256 @smallexample
1257 c  c-header  cpp-output
1258 c++  c++-header  c++-cpp-output
1259 objective-c  objective-c-header  objective-c-cpp-output
1260 objective-c++ objective-c++-header objective-c++-cpp-output
1261 assembler  assembler-with-cpp
1263 f77  f77-cpp-input f95  f95-cpp-input
1265 java
1266 @end smallexample
1268 @item -x none
1269 Turn off any specification of a language, so that subsequent files are
1270 handled according to their file name suffixes (as they are if @option{-x}
1271 has not been used at all).
1273 @item -pass-exit-codes
1274 @opindex pass-exit-codes
1275 Normally the @command{gcc} program exits with the code of 1 if any
1276 phase of the compiler returns a non-success return code.  If you specify
1277 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1278 the numerically highest error produced by any phase returning an error
1279 indication.  The C, C++, and Fortran front ends return 4 if an internal
1280 compiler error is encountered.
1281 @end table
1283 If you only want some of the stages of compilation, you can use
1284 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1285 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1286 @command{gcc} is to stop.  Note that some combinations (for example,
1287 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1289 @table @gcctabopt
1290 @item -c
1291 @opindex c
1292 Compile or assemble the source files, but do not link.  The linking
1293 stage simply is not done.  The ultimate output is in the form of an
1294 object file for each source file.
1296 By default, the object file name for a source file is made by replacing
1297 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1299 Unrecognized input files, not requiring compilation or assembly, are
1300 ignored.
1302 @item -S
1303 @opindex S
1304 Stop after the stage of compilation proper; do not assemble.  The output
1305 is in the form of an assembler code file for each non-assembler input
1306 file specified.
1308 By default, the assembler file name for a source file is made by
1309 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1311 Input files that don't require compilation are ignored.
1313 @item -E
1314 @opindex E
1315 Stop after the preprocessing stage; do not run the compiler proper.  The
1316 output is in the form of preprocessed source code, which is sent to the
1317 standard output.
1319 Input files that don't require preprocessing are ignored.
1321 @cindex output file option
1322 @item -o @var{file}
1323 @opindex o
1324 Place output in file @var{file}.  This applies to whatever
1325 sort of output is being produced, whether it be an executable file,
1326 an object file, an assembler file or preprocessed C code.
1328 If @option{-o} is not specified, the default is to put an executable
1329 file in @file{a.out}, the object file for
1330 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1331 assembler file in @file{@var{source}.s}, a precompiled header file in
1332 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1333 standard output.
1335 @item -v
1336 @opindex v
1337 Print (on standard error output) the commands executed to run the stages
1338 of compilation.  Also print the version number of the compiler driver
1339 program and of the preprocessor and the compiler proper.
1341 @item -###
1342 @opindex ###
1343 Like @option{-v} except the commands are not executed and arguments
1344 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1345 This is useful for shell scripts to capture the driver-generated command lines.
1347 @item -pipe
1348 @opindex pipe
1349 Use pipes rather than temporary files for communication between the
1350 various stages of compilation.  This fails to work on some systems where
1351 the assembler is unable to read from a pipe; but the GNU assembler has
1352 no trouble.
1354 @item --help
1355 @opindex help
1356 Print (on the standard output) a description of the command-line options
1357 understood by @command{gcc}.  If the @option{-v} option is also specified
1358 then @option{--help} is also passed on to the various processes
1359 invoked by @command{gcc}, so that they can display the command-line options
1360 they accept.  If the @option{-Wextra} option has also been specified
1361 (prior to the @option{--help} option), then command-line options that
1362 have no documentation associated with them are also displayed.
1364 @item --target-help
1365 @opindex target-help
1366 Print (on the standard output) a description of target-specific command-line
1367 options for each tool.  For some targets extra target-specific
1368 information may also be printed.
1370 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1371 Print (on the standard output) a description of the command-line
1372 options understood by the compiler that fit into all specified classes
1373 and qualifiers.  These are the supported classes:
1375 @table @asis
1376 @item @samp{optimizers}
1377 Display all of the optimization options supported by the
1378 compiler.
1380 @item @samp{warnings}
1381 Display all of the options controlling warning messages
1382 produced by the compiler.
1384 @item @samp{target}
1385 Display target-specific options.  Unlike the
1386 @option{--target-help} option however, target-specific options of the
1387 linker and assembler are not displayed.  This is because those
1388 tools do not currently support the extended @option{--help=} syntax.
1390 @item @samp{params}
1391 Display the values recognized by the @option{--param}
1392 option.
1394 @item @var{language}
1395 Display the options supported for @var{language}, where
1396 @var{language} is the name of one of the languages supported in this
1397 version of GCC@.
1399 @item @samp{common}
1400 Display the options that are common to all languages.
1401 @end table
1403 These are the supported qualifiers:
1405 @table @asis
1406 @item @samp{undocumented}
1407 Display only those options that are undocumented.
1409 @item @samp{joined}
1410 Display options taking an argument that appears after an equal
1411 sign in the same continuous piece of text, such as:
1412 @samp{--help=target}.
1414 @item @samp{separate}
1415 Display options taking an argument that appears as a separate word
1416 following the original option, such as: @samp{-o output-file}.
1417 @end table
1419 Thus for example to display all the undocumented target-specific
1420 switches supported by the compiler, use:
1422 @smallexample
1423 --help=target,undocumented
1424 @end smallexample
1426 The sense of a qualifier can be inverted by prefixing it with the
1427 @samp{^} character, so for example to display all binary warning
1428 options (i.e., ones that are either on or off and that do not take an
1429 argument) that have a description, use:
1431 @smallexample
1432 --help=warnings,^joined,^undocumented
1433 @end smallexample
1435 The argument to @option{--help=} should not consist solely of inverted
1436 qualifiers.
1438 Combining several classes is possible, although this usually
1439 restricts the output so much that there is nothing to display.  One
1440 case where it does work, however, is when one of the classes is
1441 @var{target}.  For example, to display all the target-specific
1442 optimization options, use:
1444 @smallexample
1445 --help=target,optimizers
1446 @end smallexample
1448 The @option{--help=} option can be repeated on the command line.  Each
1449 successive use displays its requested class of options, skipping
1450 those that have already been displayed.
1452 If the @option{-Q} option appears on the command line before the
1453 @option{--help=} option, then the descriptive text displayed by
1454 @option{--help=} is changed.  Instead of describing the displayed
1455 options, an indication is given as to whether the option is enabled,
1456 disabled or set to a specific value (assuming that the compiler
1457 knows this at the point where the @option{--help=} option is used).
1459 Here is a truncated example from the ARM port of @command{gcc}:
1461 @smallexample
1462   % gcc -Q -mabi=2 --help=target -c
1463   The following options are target specific:
1464   -mabi=                                2
1465   -mabort-on-noreturn                   [disabled]
1466   -mapcs                                [disabled]
1467 @end smallexample
1469 The output is sensitive to the effects of previous command-line
1470 options, so for example it is possible to find out which optimizations
1471 are enabled at @option{-O2} by using:
1473 @smallexample
1474 -Q -O2 --help=optimizers
1475 @end smallexample
1477 Alternatively you can discover which binary optimizations are enabled
1478 by @option{-O3} by using:
1480 @smallexample
1481 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1482 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1483 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1484 @end smallexample
1486 @item -no-canonical-prefixes
1487 @opindex no-canonical-prefixes
1488 Do not expand any symbolic links, resolve references to @samp{/../}
1489 or @samp{/./}, or make the path absolute when generating a relative
1490 prefix.
1492 @item --version
1493 @opindex version
1494 Display the version number and copyrights of the invoked GCC@.
1496 @item -wrapper
1497 @opindex wrapper
1498 Invoke all subcommands under a wrapper program.  The name of the
1499 wrapper program and its parameters are passed as a comma separated
1500 list.
1502 @smallexample
1503 gcc -c t.c -wrapper gdb,--args
1504 @end smallexample
1506 @noindent
1507 This invokes all subprograms of @command{gcc} under
1508 @samp{gdb --args}, thus the invocation of @command{cc1} is
1509 @samp{gdb --args cc1 @dots{}}.
1511 @item -fplugin=@var{name}.so
1512 @opindex fplugin
1513 Load the plugin code in file @var{name}.so, assumed to be a
1514 shared object to be dlopen'd by the compiler.  The base name of
1515 the shared object file is used to identify the plugin for the
1516 purposes of argument parsing (See
1517 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1518 Each plugin should define the callback functions specified in the
1519 Plugins API.
1521 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1522 @opindex fplugin-arg
1523 Define an argument called @var{key} with a value of @var{value}
1524 for the plugin called @var{name}.
1526 @item -fdump-ada-spec@r{[}-slim@r{]}
1527 @opindex fdump-ada-spec
1528 For C and C++ source and include files, generate corresponding Ada specs.
1529 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1530 GNAT User's Guide}, which provides detailed documentation on this feature.
1532 @item -fada-spec-parent=@var{unit}
1533 @opindex fada-spec-parent
1534 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1535 Ada specs as child units of parent @var{unit}.
1537 @item -fdump-go-spec=@var{file}
1538 @opindex fdump-go-spec
1539 For input files in any language, generate corresponding Go
1540 declarations in @var{file}.  This generates Go @code{const},
1541 @code{type}, @code{var}, and @code{func} declarations which may be a
1542 useful way to start writing a Go interface to code written in some
1543 other language.
1545 @include @value{srcdir}/../libiberty/at-file.texi
1546 @end table
1548 @node Invoking G++
1549 @section Compiling C++ Programs
1551 @cindex suffixes for C++ source
1552 @cindex C++ source file suffixes
1553 C++ source files conventionally use one of the suffixes @samp{.C},
1554 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1555 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1556 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1557 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1558 files with these names and compiles them as C++ programs even if you
1559 call the compiler the same way as for compiling C programs (usually
1560 with the name @command{gcc}).
1562 @findex g++
1563 @findex c++
1564 However, the use of @command{gcc} does not add the C++ library.
1565 @command{g++} is a program that calls GCC and automatically specifies linking
1566 against the C++ library.  It treats @samp{.c},
1567 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1568 files unless @option{-x} is used.  This program is also useful when
1569 precompiling a C header file with a @samp{.h} extension for use in C++
1570 compilations.  On many systems, @command{g++} is also installed with
1571 the name @command{c++}.
1573 @cindex invoking @command{g++}
1574 When you compile C++ programs, you may specify many of the same
1575 command-line options that you use for compiling programs in any
1576 language; or command-line options meaningful for C and related
1577 languages; or options that are meaningful only for C++ programs.
1578 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1579 explanations of options for languages related to C@.
1580 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1581 explanations of options that are meaningful only for C++ programs.
1583 @node C Dialect Options
1584 @section Options Controlling C Dialect
1585 @cindex dialect options
1586 @cindex language dialect options
1587 @cindex options, dialect
1589 The following options control the dialect of C (or languages derived
1590 from C, such as C++, Objective-C and Objective-C++) that the compiler
1591 accepts:
1593 @table @gcctabopt
1594 @cindex ANSI support
1595 @cindex ISO support
1596 @item -ansi
1597 @opindex ansi
1598 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1599 equivalent to @option{-std=c++98}.
1601 This turns off certain features of GCC that are incompatible with ISO
1602 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1603 such as the @code{asm} and @code{typeof} keywords, and
1604 predefined macros such as @code{unix} and @code{vax} that identify the
1605 type of system you are using.  It also enables the undesirable and
1606 rarely used ISO trigraph feature.  For the C compiler,
1607 it disables recognition of C++ style @samp{//} comments as well as
1608 the @code{inline} keyword.
1610 The alternate keywords @code{__asm__}, @code{__extension__},
1611 @code{__inline__} and @code{__typeof__} continue to work despite
1612 @option{-ansi}.  You would not want to use them in an ISO C program, of
1613 course, but it is useful to put them in header files that might be included
1614 in compilations done with @option{-ansi}.  Alternate predefined macros
1615 such as @code{__unix__} and @code{__vax__} are also available, with or
1616 without @option{-ansi}.
1618 The @option{-ansi} option does not cause non-ISO programs to be
1619 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1620 addition to @option{-ansi}.  @xref{Warning Options}.
1622 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1623 option is used.  Some header files may notice this macro and refrain
1624 from declaring certain functions or defining certain macros that the
1625 ISO standard doesn't call for; this is to avoid interfering with any
1626 programs that might use these names for other things.
1628 Functions that are normally built in but do not have semantics
1629 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1630 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1631 built-in functions provided by GCC}, for details of the functions
1632 affected.
1634 @item -std=
1635 @opindex std
1636 Determine the language standard. @xref{Standards,,Language Standards
1637 Supported by GCC}, for details of these standard versions.  This option
1638 is currently only supported when compiling C or C++.
1640 The compiler can accept several base standards, such as @samp{c90} or
1641 @samp{c++98}, and GNU dialects of those standards, such as
1642 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1643 compiler accepts all programs following that standard plus those
1644 using GNU extensions that do not contradict it.  For example,
1645 @option{-std=c90} turns off certain features of GCC that are
1646 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1647 keywords, but not other GNU extensions that do not have a meaning in
1648 ISO C90, such as omitting the middle term of a @code{?:}
1649 expression. On the other hand, when a GNU dialect of a standard is
1650 specified, all features supported by the compiler are enabled, even when
1651 those features change the meaning of the base standard.  As a result, some
1652 strict-conforming programs may be rejected.  The particular standard
1653 is used by @option{-Wpedantic} to identify which features are GNU
1654 extensions given that version of the standard. For example
1655 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1656 comments, while @option{-std=gnu99 -Wpedantic} does not.
1658 A value for this option must be provided; possible values are
1660 @table @samp
1661 @item c90
1662 @itemx c89
1663 @itemx iso9899:1990
1664 Support all ISO C90 programs (certain GNU extensions that conflict
1665 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1667 @item iso9899:199409
1668 ISO C90 as modified in amendment 1.
1670 @item c99
1671 @itemx c9x
1672 @itemx iso9899:1999
1673 @itemx iso9899:199x
1674 ISO C99.  This standard is substantially completely supported, modulo
1675 bugs, extended identifiers (supported except for corner cases when
1676 @option{-fextended-identifiers} is used) and floating-point issues
1677 (mainly but not entirely relating to optional C99 features from
1678 Annexes F and G).  See
1679 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1680 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1682 @item c11
1683 @itemx c1x
1684 @itemx iso9899:2011
1685 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1686 substantially completely supported, modulo bugs, extended identifiers
1687 (supported except for corner cases when
1688 @option{-fextended-identifiers} is used), floating-point issues
1689 (mainly but not entirely relating to optional C11 features from
1690 Annexes F and G) and the optional Annexes K (Bounds-checking
1691 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1693 @item gnu90
1694 @itemx gnu89
1695 GNU dialect of ISO C90 (including some C99 features). This
1696 is the default for C code.
1698 @item gnu99
1699 @itemx gnu9x
1700 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1702 @item gnu11
1703 @itemx gnu1x
1704 GNU dialect of ISO C11.  This is intended to become the default in a
1705 future release of GCC.  The name @samp{gnu1x} is deprecated.
1707 @item c++98
1708 @itemx c++03
1709 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1710 additional defect reports. Same as @option{-ansi} for C++ code.
1712 @item gnu++98
1713 @itemx gnu++03
1714 GNU dialect of @option{-std=c++98}.  This is the default for
1715 C++ code.
1717 @item c++11
1718 @itemx c++0x
1719 The 2011 ISO C++ standard plus amendments.
1720 The name @samp{c++0x} is deprecated.
1722 @item gnu++11
1723 @itemx gnu++0x
1724 GNU dialect of @option{-std=c++11}.
1725 The name @samp{gnu++0x} is deprecated.
1727 @item c++14
1728 @itemx c++1y
1729 The 2014 ISO C++ standard plus amendments.
1730 The name @samp{c++1y} is deprecated.
1732 @item gnu++14
1733 @itemx gnu++1y
1734 GNU dialect of @option{-std=c++14}.
1735 The name @samp{gnu++1y} is deprecated.
1737 @item c++1z
1738 The next revision of the ISO C++ standard, tentatively planned for
1739 2017.  Support is highly experimental, and will almost certainly
1740 change in incompatible ways in future releases.
1742 @item gnu++1z
1743 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1744 and will almost certainly change in incompatible ways in future
1745 releases.
1746 @end table
1748 @item -fgnu89-inline
1749 @opindex fgnu89-inline
1750 The option @option{-fgnu89-inline} tells GCC to use the traditional
1751 GNU semantics for @code{inline} functions when in C99 mode.
1752 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1753 is accepted and ignored by GCC versions 4.1.3 up to but not including
1754 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1755 C99 mode.  Using this option is roughly equivalent to adding the
1756 @code{gnu_inline} function attribute to all inline functions
1757 (@pxref{Function Attributes}).
1759 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1760 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1761 specifies the default behavior).  This option was first supported in
1762 GCC 4.3.  This option is not supported in @option{-std=c90} or
1763 @option{-std=gnu90} mode.
1765 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1766 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1767 in effect for @code{inline} functions.  @xref{Common Predefined
1768 Macros,,,cpp,The C Preprocessor}.
1770 @item -aux-info @var{filename}
1771 @opindex aux-info
1772 Output to the given filename prototyped declarations for all functions
1773 declared and/or defined in a translation unit, including those in header
1774 files.  This option is silently ignored in any language other than C@.
1776 Besides declarations, the file indicates, in comments, the origin of
1777 each declaration (source file and line), whether the declaration was
1778 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1779 @samp{O} for old, respectively, in the first character after the line
1780 number and the colon), and whether it came from a declaration or a
1781 definition (@samp{C} or @samp{F}, respectively, in the following
1782 character).  In the case of function definitions, a K&R-style list of
1783 arguments followed by their declarations is also provided, inside
1784 comments, after the declaration.
1786 @item -fallow-parameterless-variadic-functions
1787 @opindex fallow-parameterless-variadic-functions
1788 Accept variadic functions without named parameters.
1790 Although it is possible to define such a function, this is not very
1791 useful as it is not possible to read the arguments.  This is only
1792 supported for C as this construct is allowed by C++.
1794 @item -fno-asm
1795 @opindex fno-asm
1796 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1797 keyword, so that code can use these words as identifiers.  You can use
1798 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1799 instead.  @option{-ansi} implies @option{-fno-asm}.
1801 In C++, this switch only affects the @code{typeof} keyword, since
1802 @code{asm} and @code{inline} are standard keywords.  You may want to
1803 use the @option{-fno-gnu-keywords} flag instead, which has the same
1804 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1805 switch only affects the @code{asm} and @code{typeof} keywords, since
1806 @code{inline} is a standard keyword in ISO C99.
1808 @item -fno-builtin
1809 @itemx -fno-builtin-@var{function}
1810 @opindex fno-builtin
1811 @cindex built-in functions
1812 Don't recognize built-in functions that do not begin with
1813 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1814 functions provided by GCC}, for details of the functions affected,
1815 including those which are not built-in functions when @option{-ansi} or
1816 @option{-std} options for strict ISO C conformance are used because they
1817 do not have an ISO standard meaning.
1819 GCC normally generates special code to handle certain built-in functions
1820 more efficiently; for instance, calls to @code{alloca} may become single
1821 instructions which adjust the stack directly, and calls to @code{memcpy}
1822 may become inline copy loops.  The resulting code is often both smaller
1823 and faster, but since the function calls no longer appear as such, you
1824 cannot set a breakpoint on those calls, nor can you change the behavior
1825 of the functions by linking with a different library.  In addition,
1826 when a function is recognized as a built-in function, GCC may use
1827 information about that function to warn about problems with calls to
1828 that function, or to generate more efficient code, even if the
1829 resulting code still contains calls to that function.  For example,
1830 warnings are given with @option{-Wformat} for bad calls to
1831 @code{printf} when @code{printf} is built in and @code{strlen} is
1832 known not to modify global memory.
1834 With the @option{-fno-builtin-@var{function}} option
1835 only the built-in function @var{function} is
1836 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1837 function is named that is not built-in in this version of GCC, this
1838 option is ignored.  There is no corresponding
1839 @option{-fbuiltin-@var{function}} option; if you wish to enable
1840 built-in functions selectively when using @option{-fno-builtin} or
1841 @option{-ffreestanding}, you may define macros such as:
1843 @smallexample
1844 #define abs(n)          __builtin_abs ((n))
1845 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1846 @end smallexample
1848 @item -fhosted
1849 @opindex fhosted
1850 @cindex hosted environment
1852 Assert that compilation targets a hosted environment.  This implies
1853 @option{-fbuiltin}.  A hosted environment is one in which the
1854 entire standard library is available, and in which @code{main} has a return
1855 type of @code{int}.  Examples are nearly everything except a kernel.
1856 This is equivalent to @option{-fno-freestanding}.
1858 @item -ffreestanding
1859 @opindex ffreestanding
1860 @cindex hosted environment
1862 Assert that compilation targets a freestanding environment.  This
1863 implies @option{-fno-builtin}.  A freestanding environment
1864 is one in which the standard library may not exist, and program startup may
1865 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1866 This is equivalent to @option{-fno-hosted}.
1868 @xref{Standards,,Language Standards Supported by GCC}, for details of
1869 freestanding and hosted environments.
1871 @item -fopenmp
1872 @opindex fopenmp
1873 @cindex OpenMP parallel
1874 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1875 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1876 compiler generates parallel code according to the OpenMP Application
1877 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1878 implies @option{-pthread}, and thus is only supported on targets that
1879 have support for @option{-pthread}. @option{-fopenmp} implies
1880 @option{-fopenmp-simd}.
1882 @item -fopenmp-simd
1883 @opindex fopenmp-simd
1884 @cindex OpenMP SIMD
1885 @cindex SIMD
1886 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1887 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1888 are ignored.
1890 @item -fcilkplus
1891 @opindex fcilkplus
1892 @cindex Enable Cilk Plus
1893 Enable the usage of Cilk Plus language extension features for C/C++.
1894 When the option @option{-fcilkplus} is specified, enable the usage of
1895 the Cilk Plus Language extension features for C/C++.  The present
1896 implementation follows ABI version 1.2.  This is an experimental
1897 feature that is only partially complete, and whose interface may
1898 change in future versions of GCC as the official specification
1899 changes.  Currently, all features but @code{_Cilk_for} have been
1900 implemented.
1902 @item -fgnu-tm
1903 @opindex fgnu-tm
1904 When the option @option{-fgnu-tm} is specified, the compiler
1905 generates code for the Linux variant of Intel's current Transactional
1906 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1907 an experimental feature whose interface may change in future versions
1908 of GCC, as the official specification changes.  Please note that not
1909 all architectures are supported for this feature.
1911 For more information on GCC's support for transactional memory,
1912 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1913 Transactional Memory Library}.
1915 Note that the transactional memory feature is not supported with
1916 non-call exceptions (@option{-fnon-call-exceptions}).
1918 @item -fms-extensions
1919 @opindex fms-extensions
1920 Accept some non-standard constructs used in Microsoft header files.
1922 In C++ code, this allows member names in structures to be similar
1923 to previous types declarations.
1925 @smallexample
1926 typedef int UOW;
1927 struct ABC @{
1928   UOW UOW;
1930 @end smallexample
1932 Some cases of unnamed fields in structures and unions are only
1933 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1934 fields within structs/unions}, for details.
1936 Note that this option is off for all targets but i?86 and x86_64
1937 targets using ms-abi.
1938 @item -fplan9-extensions
1939 Accept some non-standard constructs used in Plan 9 code.
1941 This enables @option{-fms-extensions}, permits passing pointers to
1942 structures with anonymous fields to functions that expect pointers to
1943 elements of the type of the field, and permits referring to anonymous
1944 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1945 struct/union fields within structs/unions}, for details.  This is only
1946 supported for C, not C++.
1948 @item -trigraphs
1949 @opindex trigraphs
1950 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1951 options for strict ISO C conformance) implies @option{-trigraphs}.
1953 @cindex traditional C language
1954 @cindex C language, traditional
1955 @item -traditional
1956 @itemx -traditional-cpp
1957 @opindex traditional-cpp
1958 @opindex traditional
1959 Formerly, these options caused GCC to attempt to emulate a pre-standard
1960 C compiler.  They are now only supported with the @option{-E} switch.
1961 The preprocessor continues to support a pre-standard mode.  See the GNU
1962 CPP manual for details.
1964 @item -fcond-mismatch
1965 @opindex fcond-mismatch
1966 Allow conditional expressions with mismatched types in the second and
1967 third arguments.  The value of such an expression is void.  This option
1968 is not supported for C++.
1970 @item -flax-vector-conversions
1971 @opindex flax-vector-conversions
1972 Allow implicit conversions between vectors with differing numbers of
1973 elements and/or incompatible element types.  This option should not be
1974 used for new code.
1976 @item -funsigned-char
1977 @opindex funsigned-char
1978 Let the type @code{char} be unsigned, like @code{unsigned char}.
1980 Each kind of machine has a default for what @code{char} should
1981 be.  It is either like @code{unsigned char} by default or like
1982 @code{signed char} by default.
1984 Ideally, a portable program should always use @code{signed char} or
1985 @code{unsigned char} when it depends on the signedness of an object.
1986 But many programs have been written to use plain @code{char} and
1987 expect it to be signed, or expect it to be unsigned, depending on the
1988 machines they were written for.  This option, and its inverse, let you
1989 make such a program work with the opposite default.
1991 The type @code{char} is always a distinct type from each of
1992 @code{signed char} or @code{unsigned char}, even though its behavior
1993 is always just like one of those two.
1995 @item -fsigned-char
1996 @opindex fsigned-char
1997 Let the type @code{char} be signed, like @code{signed char}.
1999 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2000 the negative form of @option{-funsigned-char}.  Likewise, the option
2001 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2003 @item -fsigned-bitfields
2004 @itemx -funsigned-bitfields
2005 @itemx -fno-signed-bitfields
2006 @itemx -fno-unsigned-bitfields
2007 @opindex fsigned-bitfields
2008 @opindex funsigned-bitfields
2009 @opindex fno-signed-bitfields
2010 @opindex fno-unsigned-bitfields
2011 These options control whether a bit-field is signed or unsigned, when the
2012 declaration does not use either @code{signed} or @code{unsigned}.  By
2013 default, such a bit-field is signed, because this is consistent: the
2014 basic integer types such as @code{int} are signed types.
2015 @end table
2017 @node C++ Dialect Options
2018 @section Options Controlling C++ Dialect
2020 @cindex compiler options, C++
2021 @cindex C++ options, command-line
2022 @cindex options, C++
2023 This section describes the command-line options that are only meaningful
2024 for C++ programs.  You can also use most of the GNU compiler options
2025 regardless of what language your program is in.  For example, you
2026 might compile a file @code{firstClass.C} like this:
2028 @smallexample
2029 g++ -g -frepo -O -c firstClass.C
2030 @end smallexample
2032 @noindent
2033 In this example, only @option{-frepo} is an option meant
2034 only for C++ programs; you can use the other options with any
2035 language supported by GCC@.
2037 Here is a list of options that are @emph{only} for compiling C++ programs:
2039 @table @gcctabopt
2041 @item -fabi-version=@var{n}
2042 @opindex fabi-version
2043 Use version @var{n} of the C++ ABI@.  The default is version 0.
2045 Version 0 refers to the version conforming most closely to
2046 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2047 will change in different versions of G++ as ABI bugs are fixed.
2049 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2051 Version 2 is the version of the C++ ABI that first appeared in G++
2052 3.4, and was the default through G++ 4.9.
2054 Version 3 corrects an error in mangling a constant address as a
2055 template argument.
2057 Version 4, which first appeared in G++ 4.5, implements a standard
2058 mangling for vector types.
2060 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2061 attribute const/volatile on function pointer types, decltype of a
2062 plain decl, and use of a function parameter in the declaration of
2063 another parameter.
2065 Version 6, which first appeared in G++ 4.7, corrects the promotion
2066 behavior of C++11 scoped enums and the mangling of template argument
2067 packs, const/static_cast, prefix ++ and --, and a class scope function
2068 used as a template argument.
2070 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2071 builtin type and corrects the mangling of lambdas in default argument
2072 scope.
2074 Version 8, which first appeared in G++ 4.9, corrects the substitution
2075 behavior of function types with function-cv-qualifiers.
2077 See also @option{-Wabi}.
2079 @item -fabi-compat-version=@var{n}
2080 @opindex fabi-compat-version
2081 Starting with GCC 4.5, on targets that support strong aliases, G++
2082 works around mangling changes by creating an alias with the correct
2083 mangled name when defining a symbol with an incorrect mangled name.
2084 This switch specifies which ABI version to use for the alias.
2086 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2087 another ABI version is explicitly selected, this defaults to 0.
2089 The compatibility version is also set by @option{-Wabi=@var{n}}.
2091 @item -fno-access-control
2092 @opindex fno-access-control
2093 Turn off all access checking.  This switch is mainly useful for working
2094 around bugs in the access control code.
2096 @item -fcheck-new
2097 @opindex fcheck-new
2098 Check that the pointer returned by @code{operator new} is non-null
2099 before attempting to modify the storage allocated.  This check is
2100 normally unnecessary because the C++ standard specifies that
2101 @code{operator new} only returns @code{0} if it is declared
2102 @samp{throw()}, in which case the compiler always checks the
2103 return value even without this option.  In all other cases, when
2104 @code{operator new} has a non-empty exception specification, memory
2105 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2106 @samp{new (nothrow)}.
2108 @item -fconstexpr-depth=@var{n}
2109 @opindex fconstexpr-depth
2110 Set the maximum nested evaluation depth for C++11 constexpr functions
2111 to @var{n}.  A limit is needed to detect endless recursion during
2112 constant expression evaluation.  The minimum specified by the standard
2113 is 512.
2115 @item -fdeduce-init-list
2116 @opindex fdeduce-init-list
2117 Enable deduction of a template type parameter as
2118 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2120 @smallexample
2121 template <class T> auto forward(T t) -> decltype (realfn (t))
2123   return realfn (t);
2126 void f()
2128   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2130 @end smallexample
2132 This deduction was implemented as a possible extension to the
2133 originally proposed semantics for the C++11 standard, but was not part
2134 of the final standard, so it is disabled by default.  This option is
2135 deprecated, and may be removed in a future version of G++.
2137 @item -ffriend-injection
2138 @opindex ffriend-injection
2139 Inject friend functions into the enclosing namespace, so that they are
2140 visible outside the scope of the class in which they are declared.
2141 Friend functions were documented to work this way in the old Annotated
2142 C++ Reference Manual, and versions of G++ before 4.1 always worked
2143 that way.  However, in ISO C++ a friend function that is not declared
2144 in an enclosing scope can only be found using argument dependent
2145 lookup.  This option causes friends to be injected as they were in
2146 earlier releases.
2148 This option is for compatibility, and may be removed in a future
2149 release of G++.
2151 @item -fno-elide-constructors
2152 @opindex fno-elide-constructors
2153 The C++ standard allows an implementation to omit creating a temporary
2154 that is only used to initialize another object of the same type.
2155 Specifying this option disables that optimization, and forces G++ to
2156 call the copy constructor in all cases.
2158 @item -fno-enforce-eh-specs
2159 @opindex fno-enforce-eh-specs
2160 Don't generate code to check for violation of exception specifications
2161 at run time.  This option violates the C++ standard, but may be useful
2162 for reducing code size in production builds, much like defining
2163 @samp{NDEBUG}.  This does not give user code permission to throw
2164 exceptions in violation of the exception specifications; the compiler
2165 still optimizes based on the specifications, so throwing an
2166 unexpected exception results in undefined behavior at run time.
2168 @item -fextern-tls-init
2169 @itemx -fno-extern-tls-init
2170 @opindex fextern-tls-init
2171 @opindex fno-extern-tls-init
2172 The C++11 and OpenMP standards allow @samp{thread_local} and
2173 @samp{threadprivate} variables to have dynamic (runtime)
2174 initialization.  To support this, any use of such a variable goes
2175 through a wrapper function that performs any necessary initialization.
2176 When the use and definition of the variable are in the same
2177 translation unit, this overhead can be optimized away, but when the
2178 use is in a different translation unit there is significant overhead
2179 even if the variable doesn't actually need dynamic initialization.  If
2180 the programmer can be sure that no use of the variable in a
2181 non-defining TU needs to trigger dynamic initialization (either
2182 because the variable is statically initialized, or a use of the
2183 variable in the defining TU will be executed before any uses in
2184 another TU), they can avoid this overhead with the
2185 @option{-fno-extern-tls-init} option.
2187 On targets that support symbol aliases, the default is
2188 @option{-fextern-tls-init}.  On targets that do not support symbol
2189 aliases, the default is @option{-fno-extern-tls-init}.
2191 @item -ffor-scope
2192 @itemx -fno-for-scope
2193 @opindex ffor-scope
2194 @opindex fno-for-scope
2195 If @option{-ffor-scope} is specified, the scope of variables declared in
2196 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2197 as specified by the C++ standard.
2198 If @option{-fno-for-scope} is specified, the scope of variables declared in
2199 a @i{for-init-statement} extends to the end of the enclosing scope,
2200 as was the case in old versions of G++, and other (traditional)
2201 implementations of C++.
2203 If neither flag is given, the default is to follow the standard,
2204 but to allow and give a warning for old-style code that would
2205 otherwise be invalid, or have different behavior.
2207 @item -fno-gnu-keywords
2208 @opindex fno-gnu-keywords
2209 Do not recognize @code{typeof} as a keyword, so that code can use this
2210 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2211 @option{-ansi} implies @option{-fno-gnu-keywords}.
2213 @item -fno-implicit-templates
2214 @opindex fno-implicit-templates
2215 Never emit code for non-inline templates that are instantiated
2216 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2217 @xref{Template Instantiation}, for more information.
2219 @item -fno-implicit-inline-templates
2220 @opindex fno-implicit-inline-templates
2221 Don't emit code for implicit instantiations of inline templates, either.
2222 The default is to handle inlines differently so that compiles with and
2223 without optimization need the same set of explicit instantiations.
2225 @item -fno-implement-inlines
2226 @opindex fno-implement-inlines
2227 To save space, do not emit out-of-line copies of inline functions
2228 controlled by @samp{#pragma implementation}.  This causes linker
2229 errors if these functions are not inlined everywhere they are called.
2231 @item -fms-extensions
2232 @opindex fms-extensions
2233 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2234 int and getting a pointer to member function via non-standard syntax.
2236 @item -fno-nonansi-builtins
2237 @opindex fno-nonansi-builtins
2238 Disable built-in declarations of functions that are not mandated by
2239 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2240 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2242 @item -fnothrow-opt
2243 @opindex fnothrow-opt
2244 Treat a @code{throw()} exception specification as if it were a
2245 @code{noexcept} specification to reduce or eliminate the text size
2246 overhead relative to a function with no exception specification.  If
2247 the function has local variables of types with non-trivial
2248 destructors, the exception specification actually makes the
2249 function smaller because the EH cleanups for those variables can be
2250 optimized away.  The semantic effect is that an exception thrown out of
2251 a function with such an exception specification results in a call
2252 to @code{terminate} rather than @code{unexpected}.
2254 @item -fno-operator-names
2255 @opindex fno-operator-names
2256 Do not treat the operator name keywords @code{and}, @code{bitand},
2257 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2258 synonyms as keywords.
2260 @item -fno-optional-diags
2261 @opindex fno-optional-diags
2262 Disable diagnostics that the standard says a compiler does not need to
2263 issue.  Currently, the only such diagnostic issued by G++ is the one for
2264 a name having multiple meanings within a class.
2266 @item -fpermissive
2267 @opindex fpermissive
2268 Downgrade some diagnostics about nonconformant code from errors to
2269 warnings.  Thus, using @option{-fpermissive} allows some
2270 nonconforming code to compile.
2272 @item -fno-pretty-templates
2273 @opindex fno-pretty-templates
2274 When an error message refers to a specialization of a function
2275 template, the compiler normally prints the signature of the
2276 template followed by the template arguments and any typedefs or
2277 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2278 rather than @code{void f(int)}) so that it's clear which template is
2279 involved.  When an error message refers to a specialization of a class
2280 template, the compiler omits any template arguments that match
2281 the default template arguments for that template.  If either of these
2282 behaviors make it harder to understand the error message rather than
2283 easier, you can use @option{-fno-pretty-templates} to disable them.
2285 @item -frepo
2286 @opindex frepo
2287 Enable automatic template instantiation at link time.  This option also
2288 implies @option{-fno-implicit-templates}.  @xref{Template
2289 Instantiation}, for more information.
2291 @item -fno-rtti
2292 @opindex fno-rtti
2293 Disable generation of information about every class with virtual
2294 functions for use by the C++ run-time type identification features
2295 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2296 of the language, you can save some space by using this flag.  Note that
2297 exception handling uses the same information, but G++ generates it as
2298 needed. The @samp{dynamic_cast} operator can still be used for casts that
2299 do not require run-time type information, i.e.@: casts to @code{void *} or to
2300 unambiguous base classes.
2302 @item -fstats
2303 @opindex fstats
2304 Emit statistics about front-end processing at the end of the compilation.
2305 This information is generally only useful to the G++ development team.
2307 @item -fstrict-enums
2308 @opindex fstrict-enums
2309 Allow the compiler to optimize using the assumption that a value of
2310 enumerated type can only be one of the values of the enumeration (as
2311 defined in the C++ standard; basically, a value that can be
2312 represented in the minimum number of bits needed to represent all the
2313 enumerators).  This assumption may not be valid if the program uses a
2314 cast to convert an arbitrary integer value to the enumerated type.
2316 @item -ftemplate-backtrace-limit=@var{n}
2317 @opindex ftemplate-backtrace-limit
2318 Set the maximum number of template instantiation notes for a single
2319 warning or error to @var{n}.  The default value is 10.
2321 @item -ftemplate-depth=@var{n}
2322 @opindex ftemplate-depth
2323 Set the maximum instantiation depth for template classes to @var{n}.
2324 A limit on the template instantiation depth is needed to detect
2325 endless recursions during template class instantiation.  ANSI/ISO C++
2326 conforming programs must not rely on a maximum depth greater than 17
2327 (changed to 1024 in C++11).  The default value is 900, as the compiler
2328 can run out of stack space before hitting 1024 in some situations.
2330 @item -fno-threadsafe-statics
2331 @opindex fno-threadsafe-statics
2332 Do not emit the extra code to use the routines specified in the C++
2333 ABI for thread-safe initialization of local statics.  You can use this
2334 option to reduce code size slightly in code that doesn't need to be
2335 thread-safe.
2337 @item -fuse-cxa-atexit
2338 @opindex fuse-cxa-atexit
2339 Register destructors for objects with static storage duration with the
2340 @code{__cxa_atexit} function rather than the @code{atexit} function.
2341 This option is required for fully standards-compliant handling of static
2342 destructors, but only works if your C library supports
2343 @code{__cxa_atexit}.
2345 @item -fno-use-cxa-get-exception-ptr
2346 @opindex fno-use-cxa-get-exception-ptr
2347 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2348 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2349 if the runtime routine is not available.
2351 @item -fvisibility-inlines-hidden
2352 @opindex fvisibility-inlines-hidden
2353 This switch declares that the user does not attempt to compare
2354 pointers to inline functions or methods where the addresses of the two functions
2355 are taken in different shared objects.
2357 The effect of this is that GCC may, effectively, mark inline methods with
2358 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2359 appear in the export table of a DSO and do not require a PLT indirection
2360 when used within the DSO@.  Enabling this option can have a dramatic effect
2361 on load and link times of a DSO as it massively reduces the size of the
2362 dynamic export table when the library makes heavy use of templates.
2364 The behavior of this switch is not quite the same as marking the
2365 methods as hidden directly, because it does not affect static variables
2366 local to the function or cause the compiler to deduce that
2367 the function is defined in only one shared object.
2369 You may mark a method as having a visibility explicitly to negate the
2370 effect of the switch for that method.  For example, if you do want to
2371 compare pointers to a particular inline method, you might mark it as
2372 having default visibility.  Marking the enclosing class with explicit
2373 visibility has no effect.
2375 Explicitly instantiated inline methods are unaffected by this option
2376 as their linkage might otherwise cross a shared library boundary.
2377 @xref{Template Instantiation}.
2379 @item -fvisibility-ms-compat
2380 @opindex fvisibility-ms-compat
2381 This flag attempts to use visibility settings to make GCC's C++
2382 linkage model compatible with that of Microsoft Visual Studio.
2384 The flag makes these changes to GCC's linkage model:
2386 @enumerate
2387 @item
2388 It sets the default visibility to @code{hidden}, like
2389 @option{-fvisibility=hidden}.
2391 @item
2392 Types, but not their members, are not hidden by default.
2394 @item
2395 The One Definition Rule is relaxed for types without explicit
2396 visibility specifications that are defined in more than one
2397 shared object: those declarations are permitted if they are
2398 permitted when this option is not used.
2399 @end enumerate
2401 In new code it is better to use @option{-fvisibility=hidden} and
2402 export those classes that are intended to be externally visible.
2403 Unfortunately it is possible for code to rely, perhaps accidentally,
2404 on the Visual Studio behavior.
2406 Among the consequences of these changes are that static data members
2407 of the same type with the same name but defined in different shared
2408 objects are different, so changing one does not change the other;
2409 and that pointers to function members defined in different shared
2410 objects may not compare equal.  When this flag is given, it is a
2411 violation of the ODR to define types with the same name differently.
2413 @item -fvtable-verify=@var{std|preinit|none}
2414 @opindex fvtable-verify
2415 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2416 feature that verifies at runtime, for every virtual call that is made, that
2417 the vtable pointer through which the call is made is valid for the type of
2418 the object, and has not been corrupted or overwritten.  If an invalid vtable
2419 pointer is detected (at runtime), an error is reported and execution of the
2420 program is immediately halted.
2422 This option causes runtime data structures to be built, at program start up,
2423 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2424 control the timing of when these data structures are built.  In both cases the
2425 data structures are built before execution reaches 'main'.  The
2426 @option{-fvtable-verify=std} causes these data structure to be built after the
2427 shared libraries have been loaded and initialized.
2428 @option{-fvtable-verify=preinit} causes them to be built before the shared
2429 libraries have been loaded and initialized.
2431 If this option appears multiple times in the compiler line, with different
2432 values specified, 'none' will take highest priority over both 'std' and
2433 'preinit'; 'preinit' will take priority over 'std'.
2435 @item -fvtv-debug
2436 @opindex (fvtv-debug)
2437 Causes debug versions of the runtime functions for the vtable verification 
2438 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2439 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2440 compiler to keep track of which vtable pointers it found for each class, and
2441 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2442 file directory on the user's machine.
2444 Note:  This feature APPENDS data to the log file. If you want a fresh log
2445 file, be sure to delete any existing one.
2447 @item -fvtv-counts
2448 @opindex fvtv-counts
2449 This is a debugging flag.  When used in conjunction with
2450 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2451 causes the compiler to keep track of the total number of virtual calls
2452 it encountered and the number of verifications it inserted.  It also
2453 counts the number of calls to certain runtime library functions
2454 that it inserts.  This information, for each compilation unit, is written
2455 to a file named ``vtv_count_data.log'', in the dump_file directory on
2456 the user's machine.   It also counts the size of the vtable pointer sets
2457 for each class, and writes this information to ``vtv_class_set_sizes.log''
2458 in the same directory.
2460 Note:  This feature APPENDS data to the log files.  To get a fresh log
2461 files, be sure to delete any existing ones.
2463 @item -fno-weak
2464 @opindex fno-weak
2465 Do not use weak symbol support, even if it is provided by the linker.
2466 By default, G++ uses weak symbols if they are available.  This
2467 option exists only for testing, and should not be used by end-users;
2468 it results in inferior code and has no benefits.  This option may
2469 be removed in a future release of G++.
2471 @item -nostdinc++
2472 @opindex nostdinc++
2473 Do not search for header files in the standard directories specific to
2474 C++, but do still search the other standard directories.  (This option
2475 is used when building the C++ library.)
2476 @end table
2478 In addition, these optimization, warning, and code generation options
2479 have meanings only for C++ programs:
2481 @table @gcctabopt
2482 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2483 @opindex Wabi
2484 @opindex Wno-abi
2485 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2486 G++ to warn when it generates code that is probably not compatible with the
2487 vendor-neutral C++ ABI@.  Since G++ now defaults to
2488 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2489 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2490 or an older compatibility version is selected (with
2491 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2493 Although an effort has been made to warn about
2494 all such cases, there are probably some cases that are not warned about,
2495 even though G++ is generating incompatible code.  There may also be
2496 cases where warnings are emitted even though the code that is generated
2497 is compatible.
2499 You should rewrite your code to avoid these warnings if you are
2500 concerned about the fact that code generated by G++ may not be binary
2501 compatible with code generated by other compilers.
2503 @option{-Wabi} can also be used with an explicit version number to
2504 warn about compatibility with a particular @option{-fabi-version}
2505 level, e.g. @option{-Wabi=2} to warn about changes relative to
2506 @option{-fabi-version=2}.  Specifying a version number also sets
2507 @option{-fabi-compat-version=@var{n}}.
2509 The known incompatibilities in @option{-fabi-version=2} (which was the
2510 default from GCC 3.4 to 4.9) include:
2512 @itemize @bullet
2514 @item
2515 A template with a non-type template parameter of reference type was
2516 mangled incorrectly:
2517 @smallexample
2518 extern int N;
2519 template <int &> struct S @{@};
2520 void n (S<N>) @{2@}
2521 @end smallexample
2523 This was fixed in @option{-fabi-version=3}.
2525 @item
2526 SIMD vector types declared using @code{__attribute ((vector_size))} were
2527 mangled in a non-standard way that does not allow for overloading of
2528 functions taking vectors of different sizes.
2530 The mangling was changed in @option{-fabi-version=4}.
2532 @item
2533 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2534 qualifiers, and @code{decltype} of a plain declaration was folded away.
2536 These mangling issues were fixed in @option{-fabi-version=5}.
2538 @item
2539 Scoped enumerators passed as arguments to a variadic function are
2540 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2541 On most targets this does not actually affect the parameter passing
2542 ABI, as there is no way to pass an argument smaller than @samp{int}.
2544 Also, the ABI changed the mangling of template argument packs,
2545 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2546 a class scope function used as a template argument.
2548 These issues were corrected in @option{-fabi-version=6}.
2550 @item
2551 Lambdas in default argument scope were mangled incorrectly, and the
2552 ABI changed the mangling of nullptr_t.
2554 These issues were corrected in @option{-fabi-version=7}.
2556 @item
2557 When mangling a function type with function-cv-qualifiers, the
2558 un-qualified function type was incorrectly treated as a substitution
2559 candidate.
2561 This was fixed in @option{-fabi-version=8}.
2562 @end itemize
2564 It also warns about psABI-related changes.  The known psABI changes at this
2565 point include:
2567 @itemize @bullet
2569 @item
2570 For SysV/x86-64, unions with @code{long double} members are 
2571 passed in memory as specified in psABI.  For example:
2573 @smallexample
2574 union U @{
2575   long double ld;
2576   int i;
2578 @end smallexample
2580 @noindent
2581 @code{union U} is always passed in memory.
2583 @end itemize
2585 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2586 @opindex Wctor-dtor-privacy
2587 @opindex Wno-ctor-dtor-privacy
2588 Warn when a class seems unusable because all the constructors or
2589 destructors in that class are private, and it has neither friends nor
2590 public static member functions.  Also warn if there are no non-private
2591 methods, and there's at least one private member function that isn't
2592 a constructor or destructor.
2594 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2595 @opindex Wdelete-non-virtual-dtor
2596 @opindex Wno-delete-non-virtual-dtor
2597 Warn when @samp{delete} is used to destroy an instance of a class that
2598 has virtual functions and non-virtual destructor. It is unsafe to delete
2599 an instance of a derived class through a pointer to a base class if the
2600 base class does not have a virtual destructor.  This warning is enabled
2601 by @option{-Wall}.
2603 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2604 @opindex Wliteral-suffix
2605 @opindex Wno-literal-suffix
2606 Warn when a string or character literal is followed by a ud-suffix which does
2607 not begin with an underscore.  As a conforming extension, GCC treats such
2608 suffixes as separate preprocessing tokens in order to maintain backwards
2609 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2610 For example:
2612 @smallexample
2613 #define __STDC_FORMAT_MACROS
2614 #include <inttypes.h>
2615 #include <stdio.h>
2617 int main() @{
2618   int64_t i64 = 123;
2619   printf("My int64: %"PRId64"\n", i64);
2621 @end smallexample
2623 In this case, @code{PRId64} is treated as a separate preprocessing token.
2625 This warning is enabled by default.
2627 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2628 @opindex Wnarrowing
2629 @opindex Wno-narrowing
2630 Warn when a narrowing conversion prohibited by C++11 occurs within
2631 @samp{@{ @}}, e.g.
2633 @smallexample
2634 int i = @{ 2.2 @}; // error: narrowing from double to int
2635 @end smallexample
2637 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2639 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses for
2640 non-constants the diagnostic required by the standard.  Note that this
2641 does not affect the meaning of well-formed code; narrowing conversions
2642 are still considered ill-formed in SFINAE context.
2644 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2645 @opindex Wnoexcept
2646 @opindex Wno-noexcept
2647 Warn when a noexcept-expression evaluates to false because of a call
2648 to a function that does not have a non-throwing exception
2649 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2650 the compiler to never throw an exception.
2652 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2653 @opindex Wnon-virtual-dtor
2654 @opindex Wno-non-virtual-dtor
2655 Warn when a class has virtual functions and an accessible non-virtual
2656 destructor itself or in an accessible polymorphic base class, in which
2657 case it is possible but unsafe to delete an instance of a derived
2658 class through a pointer to the class itself or base class.  This
2659 warning is automatically enabled if @option{-Weffc++} is specified.
2661 @item -Wreorder @r{(C++ and Objective-C++ only)}
2662 @opindex Wreorder
2663 @opindex Wno-reorder
2664 @cindex reordering, warning
2665 @cindex warning for reordering of member initializers
2666 Warn when the order of member initializers given in the code does not
2667 match the order in which they must be executed.  For instance:
2669 @smallexample
2670 struct A @{
2671   int i;
2672   int j;
2673   A(): j (0), i (1) @{ @}
2675 @end smallexample
2677 @noindent
2678 The compiler rearranges the member initializers for @samp{i}
2679 and @samp{j} to match the declaration order of the members, emitting
2680 a warning to that effect.  This warning is enabled by @option{-Wall}.
2682 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2683 @opindex fext-numeric-literals
2684 @opindex fno-ext-numeric-literals
2685 Accept imaginary, fixed-point, or machine-defined
2686 literal number suffixes as GNU extensions.
2687 When this option is turned off these suffixes are treated
2688 as C++11 user-defined literal numeric suffixes.
2689 This is on by default for all pre-C++11 dialects and all GNU dialects:
2690 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2691 @option{-std=gnu++14}.
2692 This option is off by default
2693 for ISO C++11 onwards (@option{-std=c++11}, ...).
2694 @end table
2696 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2698 @table @gcctabopt
2699 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2700 @opindex Weffc++
2701 @opindex Wno-effc++
2702 Warn about violations of the following style guidelines from Scott Meyers'
2703 @cite{Effective C++} series of books:
2705 @itemize @bullet
2706 @item
2707 Define a copy constructor and an assignment operator for classes
2708 with dynamically-allocated memory.
2710 @item
2711 Prefer initialization to assignment in constructors.
2713 @item
2714 Have @code{operator=} return a reference to @code{*this}.
2716 @item
2717 Don't try to return a reference when you must return an object.
2719 @item
2720 Distinguish between prefix and postfix forms of increment and
2721 decrement operators.
2723 @item
2724 Never overload @code{&&}, @code{||}, or @code{,}.
2726 @end itemize
2728 This option also enables @option{-Wnon-virtual-dtor}, which is also
2729 one of the effective C++ recommendations.  However, the check is
2730 extended to warn about the lack of virtual destructor in accessible
2731 non-polymorphic bases classes too.
2733 When selecting this option, be aware that the standard library
2734 headers do not obey all of these guidelines; use @samp{grep -v}
2735 to filter out those warnings.
2737 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2738 @opindex Wstrict-null-sentinel
2739 @opindex Wno-strict-null-sentinel
2740 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2741 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2742 to @code{__null}.  Although it is a null pointer constant rather than a
2743 null pointer, it is guaranteed to be of the same size as a pointer.
2744 But this use is not portable across different compilers.
2746 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2747 @opindex Wno-non-template-friend
2748 @opindex Wnon-template-friend
2749 Disable warnings when non-templatized friend functions are declared
2750 within a template.  Since the advent of explicit template specification
2751 support in G++, if the name of the friend is an unqualified-id (i.e.,
2752 @samp{friend foo(int)}), the C++ language specification demands that the
2753 friend declare or define an ordinary, nontemplate function.  (Section
2754 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2755 could be interpreted as a particular specialization of a templatized
2756 function.  Because this non-conforming behavior is no longer the default
2757 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2758 check existing code for potential trouble spots and is on by default.
2759 This new compiler behavior can be turned off with
2760 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2761 but disables the helpful warning.
2763 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2764 @opindex Wold-style-cast
2765 @opindex Wno-old-style-cast
2766 Warn if an old-style (C-style) cast to a non-void type is used within
2767 a C++ program.  The new-style casts (@samp{dynamic_cast},
2768 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2769 less vulnerable to unintended effects and much easier to search for.
2771 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2772 @opindex Woverloaded-virtual
2773 @opindex Wno-overloaded-virtual
2774 @cindex overloaded virtual function, warning
2775 @cindex warning for overloaded virtual function
2776 Warn when a function declaration hides virtual functions from a
2777 base class.  For example, in:
2779 @smallexample
2780 struct A @{
2781   virtual void f();
2784 struct B: public A @{
2785   void f(int);
2787 @end smallexample
2789 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2790 like:
2792 @smallexample
2793 B* b;
2794 b->f();
2795 @end smallexample
2797 @noindent
2798 fails to compile.
2800 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2801 @opindex Wno-pmf-conversions
2802 @opindex Wpmf-conversions
2803 Disable the diagnostic for converting a bound pointer to member function
2804 to a plain pointer.
2806 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2807 @opindex Wsign-promo
2808 @opindex Wno-sign-promo
2809 Warn when overload resolution chooses a promotion from unsigned or
2810 enumerated type to a signed type, over a conversion to an unsigned type of
2811 the same size.  Previous versions of G++ tried to preserve
2812 unsignedness, but the standard mandates the current behavior.
2813 @end table
2815 @node Objective-C and Objective-C++ Dialect Options
2816 @section Options Controlling Objective-C and Objective-C++ Dialects
2818 @cindex compiler options, Objective-C and Objective-C++
2819 @cindex Objective-C and Objective-C++ options, command-line
2820 @cindex options, Objective-C and Objective-C++
2821 (NOTE: This manual does not describe the Objective-C and Objective-C++
2822 languages themselves.  @xref{Standards,,Language Standards
2823 Supported by GCC}, for references.)
2825 This section describes the command-line options that are only meaningful
2826 for Objective-C and Objective-C++ programs.  You can also use most of
2827 the language-independent GNU compiler options.
2828 For example, you might compile a file @code{some_class.m} like this:
2830 @smallexample
2831 gcc -g -fgnu-runtime -O -c some_class.m
2832 @end smallexample
2834 @noindent
2835 In this example, @option{-fgnu-runtime} is an option meant only for
2836 Objective-C and Objective-C++ programs; you can use the other options with
2837 any language supported by GCC@.
2839 Note that since Objective-C is an extension of the C language, Objective-C
2840 compilations may also use options specific to the C front-end (e.g.,
2841 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2842 C++-specific options (e.g., @option{-Wabi}).
2844 Here is a list of options that are @emph{only} for compiling Objective-C
2845 and Objective-C++ programs:
2847 @table @gcctabopt
2848 @item -fconstant-string-class=@var{class-name}
2849 @opindex fconstant-string-class
2850 Use @var{class-name} as the name of the class to instantiate for each
2851 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2852 class name is @code{NXConstantString} if the GNU runtime is being used, and
2853 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2854 @option{-fconstant-cfstrings} option, if also present, overrides the
2855 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2856 to be laid out as constant CoreFoundation strings.
2858 @item -fgnu-runtime
2859 @opindex fgnu-runtime
2860 Generate object code compatible with the standard GNU Objective-C
2861 runtime.  This is the default for most types of systems.
2863 @item -fnext-runtime
2864 @opindex fnext-runtime
2865 Generate output compatible with the NeXT runtime.  This is the default
2866 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2867 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2868 used.
2870 @item -fno-nil-receivers
2871 @opindex fno-nil-receivers
2872 Assume that all Objective-C message dispatches (@code{[receiver
2873 message:arg]}) in this translation unit ensure that the receiver is
2874 not @code{nil}.  This allows for more efficient entry points in the
2875 runtime to be used.  This option is only available in conjunction with
2876 the NeXT runtime and ABI version 0 or 1.
2878 @item -fobjc-abi-version=@var{n}
2879 @opindex fobjc-abi-version
2880 Use version @var{n} of the Objective-C ABI for the selected runtime.
2881 This option is currently supported only for the NeXT runtime.  In that
2882 case, Version 0 is the traditional (32-bit) ABI without support for
2883 properties and other Objective-C 2.0 additions.  Version 1 is the
2884 traditional (32-bit) ABI with support for properties and other
2885 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2886 nothing is specified, the default is Version 0 on 32-bit target
2887 machines, and Version 2 on 64-bit target machines.
2889 @item -fobjc-call-cxx-cdtors
2890 @opindex fobjc-call-cxx-cdtors
2891 For each Objective-C class, check if any of its instance variables is a
2892 C++ object with a non-trivial default constructor.  If so, synthesize a
2893 special @code{- (id) .cxx_construct} instance method which runs
2894 non-trivial default constructors on any such instance variables, in order,
2895 and then return @code{self}.  Similarly, check if any instance variable
2896 is a C++ object with a non-trivial destructor, and if so, synthesize a
2897 special @code{- (void) .cxx_destruct} method which runs
2898 all such default destructors, in reverse order.
2900 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2901 methods thusly generated only operate on instance variables
2902 declared in the current Objective-C class, and not those inherited
2903 from superclasses.  It is the responsibility of the Objective-C
2904 runtime to invoke all such methods in an object's inheritance
2905 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2906 by the runtime immediately after a new object instance is allocated;
2907 the @code{- (void) .cxx_destruct} methods are invoked immediately
2908 before the runtime deallocates an object instance.
2910 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2911 support for invoking the @code{- (id) .cxx_construct} and
2912 @code{- (void) .cxx_destruct} methods.
2914 @item -fobjc-direct-dispatch
2915 @opindex fobjc-direct-dispatch
2916 Allow fast jumps to the message dispatcher.  On Darwin this is
2917 accomplished via the comm page.
2919 @item -fobjc-exceptions
2920 @opindex fobjc-exceptions
2921 Enable syntactic support for structured exception handling in
2922 Objective-C, similar to what is offered by C++ and Java.  This option
2923 is required to use the Objective-C keywords @code{@@try},
2924 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2925 @code{@@synchronized}.  This option is available with both the GNU
2926 runtime and the NeXT runtime (but not available in conjunction with
2927 the NeXT runtime on Mac OS X 10.2 and earlier).
2929 @item -fobjc-gc
2930 @opindex fobjc-gc
2931 Enable garbage collection (GC) in Objective-C and Objective-C++
2932 programs.  This option is only available with the NeXT runtime; the
2933 GNU runtime has a different garbage collection implementation that
2934 does not require special compiler flags.
2936 @item -fobjc-nilcheck
2937 @opindex fobjc-nilcheck
2938 For the NeXT runtime with version 2 of the ABI, check for a nil
2939 receiver in method invocations before doing the actual method call.
2940 This is the default and can be disabled using
2941 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2942 checked for nil in this way no matter what this flag is set to.
2943 Currently this flag does nothing when the GNU runtime, or an older
2944 version of the NeXT runtime ABI, is used.
2946 @item -fobjc-std=objc1
2947 @opindex fobjc-std
2948 Conform to the language syntax of Objective-C 1.0, the language
2949 recognized by GCC 4.0.  This only affects the Objective-C additions to
2950 the C/C++ language; it does not affect conformance to C/C++ standards,
2951 which is controlled by the separate C/C++ dialect option flags.  When
2952 this option is used with the Objective-C or Objective-C++ compiler,
2953 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2954 This is useful if you need to make sure that your Objective-C code can
2955 be compiled with older versions of GCC@.
2957 @item -freplace-objc-classes
2958 @opindex freplace-objc-classes
2959 Emit a special marker instructing @command{ld(1)} not to statically link in
2960 the resulting object file, and allow @command{dyld(1)} to load it in at
2961 run time instead.  This is used in conjunction with the Fix-and-Continue
2962 debugging mode, where the object file in question may be recompiled and
2963 dynamically reloaded in the course of program execution, without the need
2964 to restart the program itself.  Currently, Fix-and-Continue functionality
2965 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2966 and later.
2968 @item -fzero-link
2969 @opindex fzero-link
2970 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2971 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2972 compile time) with static class references that get initialized at load time,
2973 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2974 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2975 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2976 for individual class implementations to be modified during program execution.
2977 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2978 regardless of command-line options.
2980 @item -fno-local-ivars
2981 @opindex fno-local-ivars
2982 @opindex flocal-ivars
2983 By default instance variables in Objective-C can be accessed as if
2984 they were local variables from within the methods of the class they're
2985 declared in.  This can lead to shadowing between instance variables
2986 and other variables declared either locally inside a class method or
2987 globally with the same name.  Specifying the @option{-fno-local-ivars}
2988 flag disables this behavior thus avoiding variable shadowing issues.
2990 @item -fivar-visibility=@var{public|protected|private|package}
2991 @opindex fivar-visibility
2992 Set the default instance variable visibility to the specified option
2993 so that instance variables declared outside the scope of any access
2994 modifier directives default to the specified visibility.
2996 @item -gen-decls
2997 @opindex gen-decls
2998 Dump interface declarations for all classes seen in the source file to a
2999 file named @file{@var{sourcename}.decl}.
3001 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3002 @opindex Wassign-intercept
3003 @opindex Wno-assign-intercept
3004 Warn whenever an Objective-C assignment is being intercepted by the
3005 garbage collector.
3007 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3008 @opindex Wno-protocol
3009 @opindex Wprotocol
3010 If a class is declared to implement a protocol, a warning is issued for
3011 every method in the protocol that is not implemented by the class.  The
3012 default behavior is to issue a warning for every method not explicitly
3013 implemented in the class, even if a method implementation is inherited
3014 from the superclass.  If you use the @option{-Wno-protocol} option, then
3015 methods inherited from the superclass are considered to be implemented,
3016 and no warning is issued for them.
3018 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3019 @opindex Wselector
3020 @opindex Wno-selector
3021 Warn if multiple methods of different types for the same selector are
3022 found during compilation.  The check is performed on the list of methods
3023 in the final stage of compilation.  Additionally, a check is performed
3024 for each selector appearing in a @code{@@selector(@dots{})}
3025 expression, and a corresponding method for that selector has been found
3026 during compilation.  Because these checks scan the method table only at
3027 the end of compilation, these warnings are not produced if the final
3028 stage of compilation is not reached, for example because an error is
3029 found during compilation, or because the @option{-fsyntax-only} option is
3030 being used.
3032 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3033 @opindex Wstrict-selector-match
3034 @opindex Wno-strict-selector-match
3035 Warn if multiple methods with differing argument and/or return types are
3036 found for a given selector when attempting to send a message using this
3037 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3038 is off (which is the default behavior), the compiler omits such warnings
3039 if any differences found are confined to types that share the same size
3040 and alignment.
3042 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3043 @opindex Wundeclared-selector
3044 @opindex Wno-undeclared-selector
3045 Warn if a @code{@@selector(@dots{})} expression referring to an
3046 undeclared selector is found.  A selector is considered undeclared if no
3047 method with that name has been declared before the
3048 @code{@@selector(@dots{})} expression, either explicitly in an
3049 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3050 an @code{@@implementation} section.  This option always performs its
3051 checks as soon as a @code{@@selector(@dots{})} expression is found,
3052 while @option{-Wselector} only performs its checks in the final stage of
3053 compilation.  This also enforces the coding style convention
3054 that methods and selectors must be declared before being used.
3056 @item -print-objc-runtime-info
3057 @opindex print-objc-runtime-info
3058 Generate C header describing the largest structure that is passed by
3059 value, if any.
3061 @end table
3063 @node Language Independent Options
3064 @section Options to Control Diagnostic Messages Formatting
3065 @cindex options to control diagnostics formatting
3066 @cindex diagnostic messages
3067 @cindex message formatting
3069 Traditionally, diagnostic messages have been formatted irrespective of
3070 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3071 options described below
3072 to control the formatting algorithm for diagnostic messages, 
3073 e.g.@: how many characters per line, how often source location
3074 information should be reported.  Note that some language front ends may not
3075 honor these options.
3077 @table @gcctabopt
3078 @item -fmessage-length=@var{n}
3079 @opindex fmessage-length
3080 Try to format error messages so that they fit on lines of about @var{n}
3081 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
3082 the front ends supported by GCC@.  If @var{n} is zero, then no
3083 line-wrapping is done; each error message appears on a single
3084 line.
3086 @item -fdiagnostics-show-location=once
3087 @opindex fdiagnostics-show-location
3088 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3089 reporter to emit source location information @emph{once}; that is, in
3090 case the message is too long to fit on a single physical line and has to
3091 be wrapped, the source location won't be emitted (as prefix) again,
3092 over and over, in subsequent continuation lines.  This is the default
3093 behavior.
3095 @item -fdiagnostics-show-location=every-line
3096 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3097 messages reporter to emit the same source location information (as
3098 prefix) for physical lines that result from the process of breaking
3099 a message which is too long to fit on a single line.
3101 @item -fdiagnostics-color[=@var{WHEN}]
3102 @itemx -fno-diagnostics-color
3103 @opindex fdiagnostics-color
3104 @cindex highlight, color, colour
3105 @vindex GCC_COLORS @r{environment variable}
3106 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3107 or @samp{auto}.  The default is @samp{never} if @env{GCC_COLORS} environment
3108 variable isn't present in the environment, and @samp{auto} otherwise.
3109 @samp{auto} means to use color only when the standard error is a terminal.
3110 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3111 aliases for @option{-fdiagnostics-color=always} and
3112 @option{-fdiagnostics-color=never}, respectively.
3114 The colors are defined by the environment variable @env{GCC_COLORS}.
3115 Its value is a colon-separated list of capabilities and Select Graphic
3116 Rendition (SGR) substrings. SGR commands are interpreted by the
3117 terminal or terminal emulator.  (See the section in the documentation
3118 of your text terminal for permitted values and their meanings as
3119 character attributes.)  These substring values are integers in decimal
3120 representation and can be concatenated with semicolons.
3121 Common values to concatenate include
3122 @samp{1} for bold,
3123 @samp{4} for underline,
3124 @samp{5} for blink,
3125 @samp{7} for inverse,
3126 @samp{39} for default foreground color,
3127 @samp{30} to @samp{37} for foreground colors,
3128 @samp{90} to @samp{97} for 16-color mode foreground colors,
3129 @samp{38;5;0} to @samp{38;5;255}
3130 for 88-color and 256-color modes foreground colors,
3131 @samp{49} for default background color,
3132 @samp{40} to @samp{47} for background colors,
3133 @samp{100} to @samp{107} for 16-color mode background colors,
3134 and @samp{48;5;0} to @samp{48;5;255}
3135 for 88-color and 256-color modes background colors.
3137 The default @env{GCC_COLORS} is
3138 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3139 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3140 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3141 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3142 string disables colors.
3143 Supported capabilities are as follows.
3145 @table @code
3146 @item error=
3147 @vindex error GCC_COLORS @r{capability}
3148 SGR substring for error: markers.
3150 @item warning=
3151 @vindex warning GCC_COLORS @r{capability}
3152 SGR substring for warning: markers.
3154 @item note=
3155 @vindex note GCC_COLORS @r{capability}
3156 SGR substring for note: markers.
3158 @item caret=
3159 @vindex caret GCC_COLORS @r{capability}
3160 SGR substring for caret line.
3162 @item locus=
3163 @vindex locus GCC_COLORS @r{capability}
3164 SGR substring for location information, @samp{file:line} or
3165 @samp{file:line:column} etc.
3167 @item quote=
3168 @vindex quote GCC_COLORS @r{capability}
3169 SGR substring for information printed within quotes.
3170 @end table
3172 @item -fno-diagnostics-show-option
3173 @opindex fno-diagnostics-show-option
3174 @opindex fdiagnostics-show-option
3175 By default, each diagnostic emitted includes text indicating the
3176 command-line option that directly controls the diagnostic (if such an
3177 option is known to the diagnostic machinery).  Specifying the
3178 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3180 @item -fno-diagnostics-show-caret
3181 @opindex fno-diagnostics-show-caret
3182 @opindex fdiagnostics-show-caret
3183 By default, each diagnostic emitted includes the original source line
3184 and a caret '^' indicating the column.  This option suppresses this
3185 information.
3187 @end table
3189 @node Warning Options
3190 @section Options to Request or Suppress Warnings
3191 @cindex options to control warnings
3192 @cindex warning messages
3193 @cindex messages, warning
3194 @cindex suppressing warnings
3196 Warnings are diagnostic messages that report constructions that
3197 are not inherently erroneous but that are risky or suggest there
3198 may have been an error.
3200 The following language-independent options do not enable specific
3201 warnings but control the kinds of diagnostics produced by GCC@.
3203 @table @gcctabopt
3204 @cindex syntax checking
3205 @item -fsyntax-only
3206 @opindex fsyntax-only
3207 Check the code for syntax errors, but don't do anything beyond that.
3209 @item -fmax-errors=@var{n}
3210 @opindex fmax-errors
3211 Limits the maximum number of error messages to @var{n}, at which point
3212 GCC bails out rather than attempting to continue processing the source
3213 code.  If @var{n} is 0 (the default), there is no limit on the number
3214 of error messages produced.  If @option{-Wfatal-errors} is also
3215 specified, then @option{-Wfatal-errors} takes precedence over this
3216 option.
3218 @item -w
3219 @opindex w
3220 Inhibit all warning messages.
3222 @item -Werror
3223 @opindex Werror
3224 @opindex Wno-error
3225 Make all warnings into errors.
3227 @item -Werror=
3228 @opindex Werror=
3229 @opindex Wno-error=
3230 Make the specified warning into an error.  The specifier for a warning
3231 is appended; for example @option{-Werror=switch} turns the warnings
3232 controlled by @option{-Wswitch} into errors.  This switch takes a
3233 negative form, to be used to negate @option{-Werror} for specific
3234 warnings; for example @option{-Wno-error=switch} makes
3235 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3236 is in effect.
3238 The warning message for each controllable warning includes the
3239 option that controls the warning.  That option can then be used with
3240 @option{-Werror=} and @option{-Wno-error=} as described above.
3241 (Printing of the option in the warning message can be disabled using the
3242 @option{-fno-diagnostics-show-option} flag.)
3244 Note that specifying @option{-Werror=}@var{foo} automatically implies
3245 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3246 imply anything.
3248 @item -Wfatal-errors
3249 @opindex Wfatal-errors
3250 @opindex Wno-fatal-errors
3251 This option causes the compiler to abort compilation on the first error
3252 occurred rather than trying to keep going and printing further error
3253 messages.
3255 @end table
3257 You can request many specific warnings with options beginning with
3258 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3259 implicit declarations.  Each of these specific warning options also
3260 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3261 example, @option{-Wno-implicit}.  This manual lists only one of the
3262 two forms, whichever is not the default.  For further
3263 language-specific options also refer to @ref{C++ Dialect Options} and
3264 @ref{Objective-C and Objective-C++ Dialect Options}.
3266 When an unrecognized warning option is requested (e.g.,
3267 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3268 that the option is not recognized.  However, if the @option{-Wno-} form
3269 is used, the behavior is slightly different: no diagnostic is
3270 produced for @option{-Wno-unknown-warning} unless other diagnostics
3271 are being produced.  This allows the use of new @option{-Wno-} options
3272 with old compilers, but if something goes wrong, the compiler
3273 warns that an unrecognized option is present.
3275 @table @gcctabopt
3276 @item -Wpedantic
3277 @itemx -pedantic
3278 @opindex pedantic
3279 @opindex Wpedantic
3280 Issue all the warnings demanded by strict ISO C and ISO C++;
3281 reject all programs that use forbidden extensions, and some other
3282 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3283 version of the ISO C standard specified by any @option{-std} option used.
3285 Valid ISO C and ISO C++ programs should compile properly with or without
3286 this option (though a rare few require @option{-ansi} or a
3287 @option{-std} option specifying the required version of ISO C)@.  However,
3288 without this option, certain GNU extensions and traditional C and C++
3289 features are supported as well.  With this option, they are rejected.
3291 @option{-Wpedantic} does not cause warning messages for use of the
3292 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3293 warnings are also disabled in the expression that follows
3294 @code{__extension__}.  However, only system header files should use
3295 these escape routes; application programs should avoid them.
3296 @xref{Alternate Keywords}.
3298 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3299 C conformance.  They soon find that it does not do quite what they want:
3300 it finds some non-ISO practices, but not all---only those for which
3301 ISO C @emph{requires} a diagnostic, and some others for which
3302 diagnostics have been added.
3304 A feature to report any failure to conform to ISO C might be useful in
3305 some instances, but would require considerable additional work and would
3306 be quite different from @option{-Wpedantic}.  We don't have plans to
3307 support such a feature in the near future.
3309 Where the standard specified with @option{-std} represents a GNU
3310 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3311 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3312 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3313 where they are required by the base standard.  (It does not make sense
3314 for such warnings to be given only for features not in the specified GNU
3315 C dialect, since by definition the GNU dialects of C include all
3316 features the compiler supports with the given option, and there would be
3317 nothing to warn about.)
3319 @item -pedantic-errors
3320 @opindex pedantic-errors
3321 Like @option{-Wpedantic}, except that errors are produced rather than
3322 warnings.
3324 @item -Wall
3325 @opindex Wall
3326 @opindex Wno-all
3327 This enables all the warnings about constructions that some users
3328 consider questionable, and that are easy to avoid (or modify to
3329 prevent the warning), even in conjunction with macros.  This also
3330 enables some language-specific warnings described in @ref{C++ Dialect
3331 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3333 @option{-Wall} turns on the following warning flags:
3335 @gccoptlist{-Waddress   @gol
3336 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3337 -Wc++11-compat  @gol
3338 -Wchar-subscripts  @gol
3339 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3340 -Wimplicit-int @r{(C and Objective-C only)} @gol
3341 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3342 -Wcomment  @gol
3343 -Wformat   @gol
3344 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3345 -Wmaybe-uninitialized @gol
3346 -Wmissing-braces @r{(only for C/ObjC)} @gol
3347 -Wnonnull  @gol
3348 -Wopenmp-simd @gol
3349 -Wparentheses  @gol
3350 -Wpointer-sign  @gol
3351 -Wreorder   @gol
3352 -Wreturn-type  @gol
3353 -Wsequence-point  @gol
3354 -Wsign-compare @r{(only in C++)}  @gol
3355 -Wstrict-aliasing  @gol
3356 -Wstrict-overflow=1  @gol
3357 -Wswitch  @gol
3358 -Wtrigraphs  @gol
3359 -Wuninitialized  @gol
3360 -Wunknown-pragmas  @gol
3361 -Wunused-function  @gol
3362 -Wunused-label     @gol
3363 -Wunused-value     @gol
3364 -Wunused-variable  @gol
3365 -Wvolatile-register-var @gol
3368 Note that some warning flags are not implied by @option{-Wall}.  Some of
3369 them warn about constructions that users generally do not consider
3370 questionable, but which occasionally you might wish to check for;
3371 others warn about constructions that are necessary or hard to avoid in
3372 some cases, and there is no simple way to modify the code to suppress
3373 the warning. Some of them are enabled by @option{-Wextra} but many of
3374 them must be enabled individually.
3376 @item -Wextra
3377 @opindex W
3378 @opindex Wextra
3379 @opindex Wno-extra
3380 This enables some extra warning flags that are not enabled by
3381 @option{-Wall}. (This option used to be called @option{-W}.  The older
3382 name is still supported, but the newer name is more descriptive.)
3384 @gccoptlist{-Wclobbered  @gol
3385 -Wempty-body  @gol
3386 -Wignored-qualifiers @gol
3387 -Wmissing-field-initializers  @gol
3388 -Wmissing-parameter-type @r{(C only)}  @gol
3389 -Wold-style-declaration @r{(C only)}  @gol
3390 -Woverride-init  @gol
3391 -Wsign-compare  @gol
3392 -Wtype-limits  @gol
3393 -Wuninitialized  @gol
3394 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3395 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3398 The option @option{-Wextra} also prints warning messages for the
3399 following cases:
3401 @itemize @bullet
3403 @item
3404 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3405 @samp{>}, or @samp{>=}.
3407 @item
3408 (C++ only) An enumerator and a non-enumerator both appear in a
3409 conditional expression.
3411 @item
3412 (C++ only) Ambiguous virtual bases.
3414 @item
3415 (C++ only) Subscripting an array that has been declared @samp{register}.
3417 @item
3418 (C++ only) Taking the address of a variable that has been declared
3419 @samp{register}.
3421 @item
3422 (C++ only) A base class is not initialized in a derived class's copy
3423 constructor.
3425 @end itemize
3427 @item -Wchar-subscripts
3428 @opindex Wchar-subscripts
3429 @opindex Wno-char-subscripts
3430 Warn if an array subscript has type @code{char}.  This is a common cause
3431 of error, as programmers often forget that this type is signed on some
3432 machines.
3433 This warning is enabled by @option{-Wall}.
3435 @item -Wcomment
3436 @opindex Wcomment
3437 @opindex Wno-comment
3438 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3439 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3440 This warning is enabled by @option{-Wall}.
3442 @item -Wno-coverage-mismatch
3443 @opindex Wno-coverage-mismatch
3444 Warn if feedback profiles do not match when using the
3445 @option{-fprofile-use} option.
3446 If a source file is changed between compiling with @option{-fprofile-gen} and
3447 with @option{-fprofile-use}, the files with the profile feedback can fail
3448 to match the source file and GCC cannot use the profile feedback
3449 information.  By default, this warning is enabled and is treated as an
3450 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3451 warning or @option{-Wno-error=coverage-mismatch} can be used to
3452 disable the error.  Disabling the error for this warning can result in
3453 poorly optimized code and is useful only in the
3454 case of very minor changes such as bug fixes to an existing code-base.
3455 Completely disabling the warning is not recommended.
3457 @item -Wno-cpp
3458 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3460 Suppress warning messages emitted by @code{#warning} directives.
3462 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3463 @opindex Wdouble-promotion
3464 @opindex Wno-double-promotion
3465 Give a warning when a value of type @code{float} is implicitly
3466 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3467 floating-point unit implement @code{float} in hardware, but emulate
3468 @code{double} in software.  On such a machine, doing computations
3469 using @code{double} values is much more expensive because of the
3470 overhead required for software emulation.
3472 It is easy to accidentally do computations with @code{double} because
3473 floating-point literals are implicitly of type @code{double}.  For
3474 example, in:
3475 @smallexample
3476 @group
3477 float area(float radius)
3479    return 3.14159 * radius * radius;
3481 @end group
3482 @end smallexample
3483 the compiler performs the entire computation with @code{double}
3484 because the floating-point literal is a @code{double}.
3486 @item -Wformat
3487 @itemx -Wformat=@var{n}
3488 @opindex Wformat
3489 @opindex Wno-format
3490 @opindex ffreestanding
3491 @opindex fno-builtin
3492 @opindex Wformat=
3493 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3494 the arguments supplied have types appropriate to the format string
3495 specified, and that the conversions specified in the format string make
3496 sense.  This includes standard functions, and others specified by format
3497 attributes (@pxref{Function Attributes}), in the @code{printf},
3498 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3499 not in the C standard) families (or other target-specific families).
3500 Which functions are checked without format attributes having been
3501 specified depends on the standard version selected, and such checks of
3502 functions without the attribute specified are disabled by
3503 @option{-ffreestanding} or @option{-fno-builtin}.
3505 The formats are checked against the format features supported by GNU
3506 libc version 2.2.  These include all ISO C90 and C99 features, as well
3507 as features from the Single Unix Specification and some BSD and GNU
3508 extensions.  Other library implementations may not support all these
3509 features; GCC does not support warning about features that go beyond a
3510 particular library's limitations.  However, if @option{-Wpedantic} is used
3511 with @option{-Wformat}, warnings are given about format features not
3512 in the selected standard version (but not for @code{strfmon} formats,
3513 since those are not in any version of the C standard).  @xref{C Dialect
3514 Options,,Options Controlling C Dialect}.
3516 @table @gcctabopt
3517 @item -Wformat=1
3518 @itemx -Wformat
3519 @opindex Wformat
3520 @opindex Wformat=1
3521 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3522 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3523 @option{-Wformat} also checks for null format arguments for several
3524 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3525 aspects of this level of format checking can be disabled by the
3526 options: @option{-Wno-format-contains-nul},
3527 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3528 @option{-Wformat} is enabled by @option{-Wall}.
3530 @item -Wno-format-contains-nul
3531 @opindex Wno-format-contains-nul
3532 @opindex Wformat-contains-nul
3533 If @option{-Wformat} is specified, do not warn about format strings that
3534 contain NUL bytes.
3536 @item -Wno-format-extra-args
3537 @opindex Wno-format-extra-args
3538 @opindex Wformat-extra-args
3539 If @option{-Wformat} is specified, do not warn about excess arguments to a
3540 @code{printf} or @code{scanf} format function.  The C standard specifies
3541 that such arguments are ignored.
3543 Where the unused arguments lie between used arguments that are
3544 specified with @samp{$} operand number specifications, normally
3545 warnings are still given, since the implementation could not know what
3546 type to pass to @code{va_arg} to skip the unused arguments.  However,
3547 in the case of @code{scanf} formats, this option suppresses the
3548 warning if the unused arguments are all pointers, since the Single
3549 Unix Specification says that such unused arguments are allowed.
3551 @item -Wno-format-zero-length
3552 @opindex Wno-format-zero-length
3553 @opindex Wformat-zero-length
3554 If @option{-Wformat} is specified, do not warn about zero-length formats.
3555 The C standard specifies that zero-length formats are allowed.
3558 @item -Wformat=2
3559 @opindex Wformat=2
3560 Enable @option{-Wformat} plus additional format checks.  Currently
3561 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3562 -Wformat-signedness -Wformat-y2k}.
3564 @item -Wformat-nonliteral
3565 @opindex Wformat-nonliteral
3566 @opindex Wno-format-nonliteral
3567 If @option{-Wformat} is specified, also warn if the format string is not a
3568 string literal and so cannot be checked, unless the format function
3569 takes its format arguments as a @code{va_list}.
3571 @item -Wformat-security
3572 @opindex Wformat-security
3573 @opindex Wno-format-security
3574 If @option{-Wformat} is specified, also warn about uses of format
3575 functions that represent possible security problems.  At present, this
3576 warns about calls to @code{printf} and @code{scanf} functions where the
3577 format string is not a string literal and there are no format arguments,
3578 as in @code{printf (foo);}.  This may be a security hole if the format
3579 string came from untrusted input and contains @samp{%n}.  (This is
3580 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3581 in future warnings may be added to @option{-Wformat-security} that are not
3582 included in @option{-Wformat-nonliteral}.)
3584 @item -Wformat-signedness
3585 @opindex Wformat-signedness
3586 @opindex Wno-format-signedness
3587 If @option{-Wformat} is specified, also warn if the format string
3588 requires an unsigned argument and the argument is signed and vice versa.
3590 @item -Wformat-y2k
3591 @opindex Wformat-y2k
3592 @opindex Wno-format-y2k
3593 If @option{-Wformat} is specified, also warn about @code{strftime}
3594 formats that may yield only a two-digit year.
3595 @end table
3597 @item -Wnonnull
3598 @opindex Wnonnull
3599 @opindex Wno-nonnull
3600 Warn about passing a null pointer for arguments marked as
3601 requiring a non-null value by the @code{nonnull} function attribute.
3603 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3604 can be disabled with the @option{-Wno-nonnull} option.
3606 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3607 @opindex Winit-self
3608 @opindex Wno-init-self
3609 Warn about uninitialized variables that are initialized with themselves.
3610 Note this option can only be used with the @option{-Wuninitialized} option.
3612 For example, GCC warns about @code{i} being uninitialized in the
3613 following snippet only when @option{-Winit-self} has been specified:
3614 @smallexample
3615 @group
3616 int f()
3618   int i = i;
3619   return i;
3621 @end group
3622 @end smallexample
3624 This warning is enabled by @option{-Wall} in C++.
3626 @item -Wimplicit-int @r{(C and Objective-C only)}
3627 @opindex Wimplicit-int
3628 @opindex Wno-implicit-int
3629 Warn when a declaration does not specify a type.
3630 This warning is enabled by @option{-Wall}.
3632 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3633 @opindex Wimplicit-function-declaration
3634 @opindex Wno-implicit-function-declaration
3635 Give a warning whenever a function is used before being declared. In
3636 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3637 enabled by default and it is made into an error by
3638 @option{-pedantic-errors}. This warning is also enabled by
3639 @option{-Wall}.
3641 @item -Wimplicit @r{(C and Objective-C only)}
3642 @opindex Wimplicit
3643 @opindex Wno-implicit
3644 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3645 This warning is enabled by @option{-Wall}.
3647 @item -Wignored-qualifiers @r{(C and C++ only)}
3648 @opindex Wignored-qualifiers
3649 @opindex Wno-ignored-qualifiers
3650 Warn if the return type of a function has a type qualifier
3651 such as @code{const}.  For ISO C such a type qualifier has no effect,
3652 since the value returned by a function is not an lvalue.
3653 For C++, the warning is only emitted for scalar types or @code{void}.
3654 ISO C prohibits qualified @code{void} return types on function
3655 definitions, so such return types always receive a warning
3656 even without this option.
3658 This warning is also enabled by @option{-Wextra}.
3660 @item -Wmain
3661 @opindex Wmain
3662 @opindex Wno-main
3663 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3664 a function with external linkage, returning int, taking either zero
3665 arguments, two, or three arguments of appropriate types.  This warning
3666 is enabled by default in C++ and is enabled by either @option{-Wall}
3667 or @option{-Wpedantic}.
3669 @item -Wmissing-braces
3670 @opindex Wmissing-braces
3671 @opindex Wno-missing-braces
3672 Warn if an aggregate or union initializer is not fully bracketed.  In
3673 the following example, the initializer for @samp{a} is not fully
3674 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3675 enabled by @option{-Wall} in C.
3677 @smallexample
3678 int a[2][2] = @{ 0, 1, 2, 3 @};
3679 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3680 @end smallexample
3682 This warning is enabled by @option{-Wall}.
3684 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3685 @opindex Wmissing-include-dirs
3686 @opindex Wno-missing-include-dirs
3687 Warn if a user-supplied include directory does not exist.
3689 @item -Wparentheses
3690 @opindex Wparentheses
3691 @opindex Wno-parentheses
3692 Warn if parentheses are omitted in certain contexts, such
3693 as when there is an assignment in a context where a truth value
3694 is expected, or when operators are nested whose precedence people
3695 often get confused about.
3697 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3698 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3699 interpretation from that of ordinary mathematical notation.
3701 Also warn about constructions where there may be confusion to which
3702 @code{if} statement an @code{else} branch belongs.  Here is an example of
3703 such a case:
3705 @smallexample
3706 @group
3708   if (a)
3709     if (b)
3710       foo ();
3711   else
3712     bar ();
3714 @end group
3715 @end smallexample
3717 In C/C++, every @code{else} branch belongs to the innermost possible
3718 @code{if} statement, which in this example is @code{if (b)}.  This is
3719 often not what the programmer expected, as illustrated in the above
3720 example by indentation the programmer chose.  When there is the
3721 potential for this confusion, GCC issues a warning when this flag
3722 is specified.  To eliminate the warning, add explicit braces around
3723 the innermost @code{if} statement so there is no way the @code{else}
3724 can belong to the enclosing @code{if}.  The resulting code
3725 looks like this:
3727 @smallexample
3728 @group
3730   if (a)
3731     @{
3732       if (b)
3733         foo ();
3734       else
3735         bar ();
3736     @}
3738 @end group
3739 @end smallexample
3741 Also warn for dangerous uses of the GNU extension to
3742 @code{?:} with omitted middle operand. When the condition
3743 in the @code{?}: operator is a boolean expression, the omitted value is
3744 always 1.  Often programmers expect it to be a value computed
3745 inside the conditional expression instead.
3747 This warning is enabled by @option{-Wall}.
3749 @item -Wsequence-point
3750 @opindex Wsequence-point
3751 @opindex Wno-sequence-point
3752 Warn about code that may have undefined semantics because of violations
3753 of sequence point rules in the C and C++ standards.
3755 The C and C++ standards define the order in which expressions in a C/C++
3756 program are evaluated in terms of @dfn{sequence points}, which represent
3757 a partial ordering between the execution of parts of the program: those
3758 executed before the sequence point, and those executed after it.  These
3759 occur after the evaluation of a full expression (one which is not part
3760 of a larger expression), after the evaluation of the first operand of a
3761 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3762 function is called (but after the evaluation of its arguments and the
3763 expression denoting the called function), and in certain other places.
3764 Other than as expressed by the sequence point rules, the order of
3765 evaluation of subexpressions of an expression is not specified.  All
3766 these rules describe only a partial order rather than a total order,
3767 since, for example, if two functions are called within one expression
3768 with no sequence point between them, the order in which the functions
3769 are called is not specified.  However, the standards committee have
3770 ruled that function calls do not overlap.
3772 It is not specified when between sequence points modifications to the
3773 values of objects take effect.  Programs whose behavior depends on this
3774 have undefined behavior; the C and C++ standards specify that ``Between
3775 the previous and next sequence point an object shall have its stored
3776 value modified at most once by the evaluation of an expression.
3777 Furthermore, the prior value shall be read only to determine the value
3778 to be stored.''.  If a program breaks these rules, the results on any
3779 particular implementation are entirely unpredictable.
3781 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3782 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3783 diagnosed by this option, and it may give an occasional false positive
3784 result, but in general it has been found fairly effective at detecting
3785 this sort of problem in programs.
3787 The standard is worded confusingly, therefore there is some debate
3788 over the precise meaning of the sequence point rules in subtle cases.
3789 Links to discussions of the problem, including proposed formal
3790 definitions, may be found on the GCC readings page, at
3791 @uref{http://gcc.gnu.org/@/readings.html}.
3793 This warning is enabled by @option{-Wall} for C and C++.
3795 @item -Wno-return-local-addr
3796 @opindex Wno-return-local-addr
3797 @opindex Wreturn-local-addr
3798 Do not warn about returning a pointer (or in C++, a reference) to a
3799 variable that goes out of scope after the function returns.
3801 @item -Wreturn-type
3802 @opindex Wreturn-type
3803 @opindex Wno-return-type
3804 Warn whenever a function is defined with a return type that defaults
3805 to @code{int}.  Also warn about any @code{return} statement with no
3806 return value in a function whose return type is not @code{void}
3807 (falling off the end of the function body is considered returning
3808 without a value), and about a @code{return} statement with an
3809 expression in a function whose return type is @code{void}.
3811 For C++, a function without return type always produces a diagnostic
3812 message, even when @option{-Wno-return-type} is specified.  The only
3813 exceptions are @samp{main} and functions defined in system headers.
3815 This warning is enabled by @option{-Wall}.
3817 @item -Wswitch
3818 @opindex Wswitch
3819 @opindex Wno-switch
3820 Warn whenever a @code{switch} statement has an index of enumerated type
3821 and lacks a @code{case} for one or more of the named codes of that
3822 enumeration.  (The presence of a @code{default} label prevents this
3823 warning.)  @code{case} labels outside the enumeration range also
3824 provoke warnings when this option is used (even if there is a
3825 @code{default} label).
3826 This warning is enabled by @option{-Wall}.
3828 @item -Wswitch-default
3829 @opindex Wswitch-default
3830 @opindex Wno-switch-default
3831 Warn whenever a @code{switch} statement does not have a @code{default}
3832 case.
3834 @item -Wswitch-enum
3835 @opindex Wswitch-enum
3836 @opindex Wno-switch-enum
3837 Warn whenever a @code{switch} statement has an index of enumerated type
3838 and lacks a @code{case} for one or more of the named codes of that
3839 enumeration.  @code{case} labels outside the enumeration range also
3840 provoke warnings when this option is used.  The only difference
3841 between @option{-Wswitch} and this option is that this option gives a
3842 warning about an omitted enumeration code even if there is a
3843 @code{default} label.
3845 @item -Wswitch-bool
3846 @opindex Wswitch-bool
3847 @opindex Wno-switch-bool
3848 Warn whenever a @code{switch} statement has an index of boolean type.
3849 It is possible to suppress this warning by casting the controlling
3850 expression to a type other than @code{bool}.  For example:
3851 @smallexample
3852 @group
3853 switch ((int) (a == 4))
3854   @{
3855   @dots{}
3856   @}
3857 @end group
3858 @end smallexample
3859 This warning is enabled by default for C and C++ programs.
3861 @item -Wsync-nand @r{(C and C++ only)}
3862 @opindex Wsync-nand
3863 @opindex Wno-sync-nand
3864 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3865 built-in functions are used.  These functions changed semantics in GCC 4.4.
3867 @item -Wtrigraphs
3868 @opindex Wtrigraphs
3869 @opindex Wno-trigraphs
3870 Warn if any trigraphs are encountered that might change the meaning of
3871 the program (trigraphs within comments are not warned about).
3872 This warning is enabled by @option{-Wall}.
3874 @item -Wunused-but-set-parameter
3875 @opindex Wunused-but-set-parameter
3876 @opindex Wno-unused-but-set-parameter
3877 Warn whenever a function parameter is assigned to, but otherwise unused
3878 (aside from its declaration).
3880 To suppress this warning use the @samp{unused} attribute
3881 (@pxref{Variable Attributes}).
3883 This warning is also enabled by @option{-Wunused} together with
3884 @option{-Wextra}.
3886 @item -Wunused-but-set-variable
3887 @opindex Wunused-but-set-variable
3888 @opindex Wno-unused-but-set-variable
3889 Warn whenever a local variable is assigned to, but otherwise unused
3890 (aside from its declaration).
3891 This warning is enabled by @option{-Wall}.
3893 To suppress this warning use the @samp{unused} attribute
3894 (@pxref{Variable Attributes}).
3896 This warning is also enabled by @option{-Wunused}, which is enabled
3897 by @option{-Wall}.
3899 @item -Wunused-function
3900 @opindex Wunused-function
3901 @opindex Wno-unused-function
3902 Warn whenever a static function is declared but not defined or a
3903 non-inline static function is unused.
3904 This warning is enabled by @option{-Wall}.
3906 @item -Wunused-label
3907 @opindex Wunused-label
3908 @opindex Wno-unused-label
3909 Warn whenever a label is declared but not used.
3910 This warning is enabled by @option{-Wall}.
3912 To suppress this warning use the @samp{unused} attribute
3913 (@pxref{Variable Attributes}).
3915 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3916 @opindex Wunused-local-typedefs
3917 Warn when a typedef locally defined in a function is not used.
3918 This warning is enabled by @option{-Wall}.
3920 @item -Wunused-parameter
3921 @opindex Wunused-parameter
3922 @opindex Wno-unused-parameter
3923 Warn whenever a function parameter is unused aside from its declaration.
3925 To suppress this warning use the @samp{unused} attribute
3926 (@pxref{Variable Attributes}).
3928 @item -Wno-unused-result
3929 @opindex Wunused-result
3930 @opindex Wno-unused-result
3931 Do not warn if a caller of a function marked with attribute
3932 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3933 its return value. The default is @option{-Wunused-result}.
3935 @item -Wunused-variable
3936 @opindex Wunused-variable
3937 @opindex Wno-unused-variable
3938 Warn whenever a local variable or non-constant static variable is unused
3939 aside from its declaration.
3940 This warning is enabled by @option{-Wall}.
3942 To suppress this warning use the @samp{unused} attribute
3943 (@pxref{Variable Attributes}).
3945 @item -Wunused-value
3946 @opindex Wunused-value
3947 @opindex Wno-unused-value
3948 Warn whenever a statement computes a result that is explicitly not
3949 used. To suppress this warning cast the unused expression to
3950 @samp{void}. This includes an expression-statement or the left-hand
3951 side of a comma expression that contains no side effects. For example,
3952 an expression such as @samp{x[i,j]} causes a warning, while
3953 @samp{x[(void)i,j]} does not.
3955 This warning is enabled by @option{-Wall}.
3957 @item -Wunused
3958 @opindex Wunused
3959 @opindex Wno-unused
3960 All the above @option{-Wunused} options combined.
3962 In order to get a warning about an unused function parameter, you must
3963 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3964 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3966 @item -Wuninitialized
3967 @opindex Wuninitialized
3968 @opindex Wno-uninitialized
3969 Warn if an automatic variable is used without first being initialized
3970 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3971 warn if a non-static reference or non-static @samp{const} member
3972 appears in a class without constructors.
3974 If you want to warn about code that uses the uninitialized value of the
3975 variable in its own initializer, use the @option{-Winit-self} option.
3977 These warnings occur for individual uninitialized or clobbered
3978 elements of structure, union or array variables as well as for
3979 variables that are uninitialized or clobbered as a whole.  They do
3980 not occur for variables or elements declared @code{volatile}.  Because
3981 these warnings depend on optimization, the exact variables or elements
3982 for which there are warnings depends on the precise optimization
3983 options and version of GCC used.
3985 Note that there may be no warning about a variable that is used only
3986 to compute a value that itself is never used, because such
3987 computations may be deleted by data flow analysis before the warnings
3988 are printed.
3990 @item -Wmaybe-uninitialized
3991 @opindex Wmaybe-uninitialized
3992 @opindex Wno-maybe-uninitialized
3993 For an automatic variable, if there exists a path from the function
3994 entry to a use of the variable that is initialized, but there exist
3995 some other paths for which the variable is not initialized, the compiler
3996 emits a warning if it cannot prove the uninitialized paths are not
3997 executed at run time. These warnings are made optional because GCC is
3998 not smart enough to see all the reasons why the code might be correct
3999 in spite of appearing to have an error.  Here is one example of how
4000 this can happen:
4002 @smallexample
4003 @group
4005   int x;
4006   switch (y)
4007     @{
4008     case 1: x = 1;
4009       break;
4010     case 2: x = 4;
4011       break;
4012     case 3: x = 5;
4013     @}
4014   foo (x);
4016 @end group
4017 @end smallexample
4019 @noindent
4020 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4021 always initialized, but GCC doesn't know this. To suppress the
4022 warning, you need to provide a default case with assert(0) or
4023 similar code.
4025 @cindex @code{longjmp} warnings
4026 This option also warns when a non-volatile automatic variable might be
4027 changed by a call to @code{longjmp}.  These warnings as well are possible
4028 only in optimizing compilation.
4030 The compiler sees only the calls to @code{setjmp}.  It cannot know
4031 where @code{longjmp} will be called; in fact, a signal handler could
4032 call it at any point in the code.  As a result, you may get a warning
4033 even when there is in fact no problem because @code{longjmp} cannot
4034 in fact be called at the place that would cause a problem.
4036 Some spurious warnings can be avoided if you declare all the functions
4037 you use that never return as @code{noreturn}.  @xref{Function
4038 Attributes}.
4040 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4042 @item -Wunknown-pragmas
4043 @opindex Wunknown-pragmas
4044 @opindex Wno-unknown-pragmas
4045 @cindex warning for unknown pragmas
4046 @cindex unknown pragmas, warning
4047 @cindex pragmas, warning of unknown
4048 Warn when a @code{#pragma} directive is encountered that is not understood by 
4049 GCC@.  If this command-line option is used, warnings are even issued
4050 for unknown pragmas in system header files.  This is not the case if
4051 the warnings are only enabled by the @option{-Wall} command-line option.
4053 @item -Wno-pragmas
4054 @opindex Wno-pragmas
4055 @opindex Wpragmas
4056 Do not warn about misuses of pragmas, such as incorrect parameters,
4057 invalid syntax, or conflicts between pragmas.  See also
4058 @option{-Wunknown-pragmas}.
4060 @item -Wstrict-aliasing
4061 @opindex Wstrict-aliasing
4062 @opindex Wno-strict-aliasing
4063 This option is only active when @option{-fstrict-aliasing} is active.
4064 It warns about code that might break the strict aliasing rules that the
4065 compiler is using for optimization.  The warning does not catch all
4066 cases, but does attempt to catch the more common pitfalls.  It is
4067 included in @option{-Wall}.
4068 It is equivalent to @option{-Wstrict-aliasing=3}
4070 @item -Wstrict-aliasing=n
4071 @opindex Wstrict-aliasing=n
4072 This option is only active when @option{-fstrict-aliasing} is active.
4073 It warns about code that might break the strict aliasing rules that the
4074 compiler is using for optimization.
4075 Higher levels correspond to higher accuracy (fewer false positives).
4076 Higher levels also correspond to more effort, similar to the way @option{-O} 
4077 works.
4078 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4080 Level 1: Most aggressive, quick, least accurate.
4081 Possibly useful when higher levels
4082 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4083 false negatives.  However, it has many false positives.
4084 Warns for all pointer conversions between possibly incompatible types,
4085 even if never dereferenced.  Runs in the front end only.
4087 Level 2: Aggressive, quick, not too precise.
4088 May still have many false positives (not as many as level 1 though),
4089 and few false negatives (but possibly more than level 1).
4090 Unlike level 1, it only warns when an address is taken.  Warns about
4091 incomplete types.  Runs in the front end only.
4093 Level 3 (default for @option{-Wstrict-aliasing}):
4094 Should have very few false positives and few false
4095 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4096 Takes care of the common pun+dereference pattern in the front end:
4097 @code{*(int*)&some_float}.
4098 If optimization is enabled, it also runs in the back end, where it deals
4099 with multiple statement cases using flow-sensitive points-to information.
4100 Only warns when the converted pointer is dereferenced.
4101 Does not warn about incomplete types.
4103 @item -Wstrict-overflow
4104 @itemx -Wstrict-overflow=@var{n}
4105 @opindex Wstrict-overflow
4106 @opindex Wno-strict-overflow
4107 This option is only active when @option{-fstrict-overflow} is active.
4108 It warns about cases where the compiler optimizes based on the
4109 assumption that signed overflow does not occur.  Note that it does not
4110 warn about all cases where the code might overflow: it only warns
4111 about cases where the compiler implements some optimization.  Thus
4112 this warning depends on the optimization level.
4114 An optimization that assumes that signed overflow does not occur is
4115 perfectly safe if the values of the variables involved are such that
4116 overflow never does, in fact, occur.  Therefore this warning can
4117 easily give a false positive: a warning about code that is not
4118 actually a problem.  To help focus on important issues, several
4119 warning levels are defined.  No warnings are issued for the use of
4120 undefined signed overflow when estimating how many iterations a loop
4121 requires, in particular when determining whether a loop will be
4122 executed at all.
4124 @table @gcctabopt
4125 @item -Wstrict-overflow=1
4126 Warn about cases that are both questionable and easy to avoid.  For
4127 example,  with @option{-fstrict-overflow}, the compiler simplifies
4128 @code{x + 1 > x} to @code{1}.  This level of
4129 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4130 are not, and must be explicitly requested.
4132 @item -Wstrict-overflow=2
4133 Also warn about other cases where a comparison is simplified to a
4134 constant.  For example: @code{abs (x) >= 0}.  This can only be
4135 simplified when @option{-fstrict-overflow} is in effect, because
4136 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4137 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4138 @option{-Wstrict-overflow=2}.
4140 @item -Wstrict-overflow=3
4141 Also warn about other cases where a comparison is simplified.  For
4142 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4144 @item -Wstrict-overflow=4
4145 Also warn about other simplifications not covered by the above cases.
4146 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4148 @item -Wstrict-overflow=5
4149 Also warn about cases where the compiler reduces the magnitude of a
4150 constant involved in a comparison.  For example: @code{x + 2 > y} is
4151 simplified to @code{x + 1 >= y}.  This is reported only at the
4152 highest warning level because this simplification applies to many
4153 comparisons, so this warning level gives a very large number of
4154 false positives.
4155 @end table
4157 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4158 @opindex Wsuggest-attribute=
4159 @opindex Wno-suggest-attribute=
4160 Warn for cases where adding an attribute may be beneficial. The
4161 attributes currently supported are listed below.
4163 @table @gcctabopt
4164 @item -Wsuggest-attribute=pure
4165 @itemx -Wsuggest-attribute=const
4166 @itemx -Wsuggest-attribute=noreturn
4167 @opindex Wsuggest-attribute=pure
4168 @opindex Wno-suggest-attribute=pure
4169 @opindex Wsuggest-attribute=const
4170 @opindex Wno-suggest-attribute=const
4171 @opindex Wsuggest-attribute=noreturn
4172 @opindex Wno-suggest-attribute=noreturn
4174 Warn about functions that might be candidates for attributes
4175 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4176 functions visible in other compilation units or (in the case of @code{pure} and
4177 @code{const}) if it cannot prove that the function returns normally. A function
4178 returns normally if it doesn't contain an infinite loop or return abnormally
4179 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4180 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4181 higher.  Higher optimization levels improve the accuracy of the analysis.
4183 @item -Wsuggest-attribute=format
4184 @itemx -Wmissing-format-attribute
4185 @opindex Wsuggest-attribute=format
4186 @opindex Wmissing-format-attribute
4187 @opindex Wno-suggest-attribute=format
4188 @opindex Wno-missing-format-attribute
4189 @opindex Wformat
4190 @opindex Wno-format
4192 Warn about function pointers that might be candidates for @code{format}
4193 attributes.  Note these are only possible candidates, not absolute ones.
4194 GCC guesses that function pointers with @code{format} attributes that
4195 are used in assignment, initialization, parameter passing or return
4196 statements should have a corresponding @code{format} attribute in the
4197 resulting type.  I.e.@: the left-hand side of the assignment or
4198 initialization, the type of the parameter variable, or the return type
4199 of the containing function respectively should also have a @code{format}
4200 attribute to avoid the warning.
4202 GCC also warns about function definitions that might be
4203 candidates for @code{format} attributes.  Again, these are only
4204 possible candidates.  GCC guesses that @code{format} attributes
4205 might be appropriate for any function that calls a function like
4206 @code{vprintf} or @code{vscanf}, but this might not always be the
4207 case, and some functions for which @code{format} attributes are
4208 appropriate may not be detected.
4209 @end table
4211 @item -Wsuggest-final-types
4212 @opindex Wno-suggest-final-types
4213 @opindex Wsuggest-final-types
4214 Warn about types with virtual methods where code quality would be improved
4215 if the type was declared with C++11 final specifier, or, if possible,
4216 declared in anonymous namespace. This allows GCC to devritualize more aggressively
4217 the polymorphic calls. This warning is more effective with link time optimization,
4218 where the information about the class hiearchy graph is more complete.
4220 @item -Wsuggest-final-methods
4221 @opindex Wno-suggest-final-methods
4222 @opindex Wsuggest-final-methods
4223 Warn about virtual methods where code quality would be improved if the method
4224 was declared with C++11 final specifier, or, if possible, its type was declared
4225 in the anonymous namespace or with final specifier. This warning is more
4226 effective with link time optimization, where the information about the class
4227 hiearchy graph is more complete. It is recommended to first consider suggestins
4228 of @option{-Wsuggest-final-types} and then rebuild with new annotations.
4230 @item -Warray-bounds
4231 @opindex Wno-array-bounds
4232 @opindex Warray-bounds
4233 This option is only active when @option{-ftree-vrp} is active
4234 (default for @option{-O2} and above). It warns about subscripts to arrays
4235 that are always out of bounds. This warning is enabled by @option{-Wall}.
4237 @item -Wbool-compare
4238 @opindex Wno-bool-compare
4239 @opindex Wbool-compare
4240 Warn about boolean expression compared with an integer value different from
4241 @code{true}/@code{false}.  For instance, the following comparison is
4242 always false:
4243 @smallexample
4244 int n = 5;
4245 @dots{}
4246 if ((n > 1) == 2) @{ @dots{} @}
4247 @end smallexample
4248 This warning is enabled by @option{-Wall}.
4250 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4251 @opindex Wno-discarded-qualifiers
4252 @opindex Wdiscarded-qualifiers
4253 Do not warn if type qualifiers on pointers are being discarded.
4254 Typically, the compiler will warn if a @code{const char *} variable is
4255 passed to a function that takes @code{char *} parameter.  This option
4256 can be used to suppress such a warning.
4258 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4259 @opindex Wno-incompatible-pointer-types
4260 @opindex Wincompatible-pointer-types
4261 Do not warn when there is a conversion between pointers that have incompatible
4262 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4263 which warns for pointer argument passing or assignment with different signedness
4265 @item -Wno-int-conversion @r{(C and Objective-C only)}
4266 @opindex Wno-int-conversion
4267 @opindex Wint-conversion
4268 Do not warn about incompatible integer to pointer and pointer to integer
4269 conversions.  This warning is about implicit conversions; for explicit
4270 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4271 @option{-Wno-pointer-to-int-cast} may be used.
4273 @item -Wno-div-by-zero
4274 @opindex Wno-div-by-zero
4275 @opindex Wdiv-by-zero
4276 Do not warn about compile-time integer division by zero.  Floating-point
4277 division by zero is not warned about, as it can be a legitimate way of
4278 obtaining infinities and NaNs.
4280 @item -Wsystem-headers
4281 @opindex Wsystem-headers
4282 @opindex Wno-system-headers
4283 @cindex warnings from system headers
4284 @cindex system headers, warnings from
4285 Print warning messages for constructs found in system header files.
4286 Warnings from system headers are normally suppressed, on the assumption
4287 that they usually do not indicate real problems and would only make the
4288 compiler output harder to read.  Using this command-line option tells
4289 GCC to emit warnings from system headers as if they occurred in user
4290 code.  However, note that using @option{-Wall} in conjunction with this
4291 option does @emph{not} warn about unknown pragmas in system
4292 headers---for that, @option{-Wunknown-pragmas} must also be used.
4294 @item -Wtrampolines
4295 @opindex Wtrampolines
4296 @opindex Wno-trampolines
4297  Warn about trampolines generated for pointers to nested functions.
4299  A trampoline is a small piece of data or code that is created at run
4300  time on the stack when the address of a nested function is taken, and
4301  is used to call the nested function indirectly.  For some targets, it
4302  is made up of data only and thus requires no special treatment.  But,
4303  for most targets, it is made up of code and thus requires the stack
4304  to be made executable in order for the program to work properly.
4306 @item -Wfloat-equal
4307 @opindex Wfloat-equal
4308 @opindex Wno-float-equal
4309 Warn if floating-point values are used in equality comparisons.
4311 The idea behind this is that sometimes it is convenient (for the
4312 programmer) to consider floating-point values as approximations to
4313 infinitely precise real numbers.  If you are doing this, then you need
4314 to compute (by analyzing the code, or in some other way) the maximum or
4315 likely maximum error that the computation introduces, and allow for it
4316 when performing comparisons (and when producing output, but that's a
4317 different problem).  In particular, instead of testing for equality, you
4318 should check to see whether the two values have ranges that overlap; and
4319 this is done with the relational operators, so equality comparisons are
4320 probably mistaken.
4322 @item -Wtraditional @r{(C and Objective-C only)}
4323 @opindex Wtraditional
4324 @opindex Wno-traditional
4325 Warn about certain constructs that behave differently in traditional and
4326 ISO C@.  Also warn about ISO C constructs that have no traditional C
4327 equivalent, and/or problematic constructs that should be avoided.
4329 @itemize @bullet
4330 @item
4331 Macro parameters that appear within string literals in the macro body.
4332 In traditional C macro replacement takes place within string literals,
4333 but in ISO C it does not.
4335 @item
4336 In traditional C, some preprocessor directives did not exist.
4337 Traditional preprocessors only considered a line to be a directive
4338 if the @samp{#} appeared in column 1 on the line.  Therefore
4339 @option{-Wtraditional} warns about directives that traditional C
4340 understands but ignores because the @samp{#} does not appear as the
4341 first character on the line.  It also suggests you hide directives like
4342 @samp{#pragma} not understood by traditional C by indenting them.  Some
4343 traditional implementations do not recognize @samp{#elif}, so this option
4344 suggests avoiding it altogether.
4346 @item
4347 A function-like macro that appears without arguments.
4349 @item
4350 The unary plus operator.
4352 @item
4353 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4354 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4355 constants.)  Note, these suffixes appear in macros defined in the system
4356 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4357 Use of these macros in user code might normally lead to spurious
4358 warnings, however GCC's integrated preprocessor has enough context to
4359 avoid warning in these cases.
4361 @item
4362 A function declared external in one block and then used after the end of
4363 the block.
4365 @item
4366 A @code{switch} statement has an operand of type @code{long}.
4368 @item
4369 A non-@code{static} function declaration follows a @code{static} one.
4370 This construct is not accepted by some traditional C compilers.
4372 @item
4373 The ISO type of an integer constant has a different width or
4374 signedness from its traditional type.  This warning is only issued if
4375 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4376 typically represent bit patterns, are not warned about.
4378 @item
4379 Usage of ISO string concatenation is detected.
4381 @item
4382 Initialization of automatic aggregates.
4384 @item
4385 Identifier conflicts with labels.  Traditional C lacks a separate
4386 namespace for labels.
4388 @item
4389 Initialization of unions.  If the initializer is zero, the warning is
4390 omitted.  This is done under the assumption that the zero initializer in
4391 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4392 initializer warnings and relies on default initialization to zero in the
4393 traditional C case.
4395 @item
4396 Conversions by prototypes between fixed/floating-point values and vice
4397 versa.  The absence of these prototypes when compiling with traditional
4398 C causes serious problems.  This is a subset of the possible
4399 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4401 @item
4402 Use of ISO C style function definitions.  This warning intentionally is
4403 @emph{not} issued for prototype declarations or variadic functions
4404 because these ISO C features appear in your code when using
4405 libiberty's traditional C compatibility macros, @code{PARAMS} and
4406 @code{VPARAMS}.  This warning is also bypassed for nested functions
4407 because that feature is already a GCC extension and thus not relevant to
4408 traditional C compatibility.
4409 @end itemize
4411 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4412 @opindex Wtraditional-conversion
4413 @opindex Wno-traditional-conversion
4414 Warn if a prototype causes a type conversion that is different from what
4415 would happen to the same argument in the absence of a prototype.  This
4416 includes conversions of fixed point to floating and vice versa, and
4417 conversions changing the width or signedness of a fixed-point argument
4418 except when the same as the default promotion.
4420 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4421 @opindex Wdeclaration-after-statement
4422 @opindex Wno-declaration-after-statement
4423 Warn when a declaration is found after a statement in a block.  This
4424 construct, known from C++, was introduced with ISO C99 and is by default
4425 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4426 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4428 @item -Wundef
4429 @opindex Wundef
4430 @opindex Wno-undef
4431 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4433 @item -Wno-endif-labels
4434 @opindex Wno-endif-labels
4435 @opindex Wendif-labels
4436 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4438 @item -Wshadow
4439 @opindex Wshadow
4440 @opindex Wno-shadow
4441 Warn whenever a local variable or type declaration shadows another
4442 variable, parameter, type, class member (in C++), or instance variable
4443 (in Objective-C) or whenever a built-in function is shadowed. Note
4444 that in C++, the compiler warns if a local variable shadows an
4445 explicit typedef, but not if it shadows a struct/class/enum.
4447 @item -Wno-shadow-ivar @r{(Objective-C only)}
4448 @opindex Wno-shadow-ivar
4449 @opindex Wshadow-ivar
4450 Do not warn whenever a local variable shadows an instance variable in an
4451 Objective-C method.
4453 @item -Wlarger-than=@var{len}
4454 @opindex Wlarger-than=@var{len}
4455 @opindex Wlarger-than-@var{len}
4456 Warn whenever an object of larger than @var{len} bytes is defined.
4458 @item -Wframe-larger-than=@var{len}
4459 @opindex Wframe-larger-than
4460 Warn if the size of a function frame is larger than @var{len} bytes.
4461 The computation done to determine the stack frame size is approximate
4462 and not conservative.
4463 The actual requirements may be somewhat greater than @var{len}
4464 even if you do not get a warning.  In addition, any space allocated
4465 via @code{alloca}, variable-length arrays, or related constructs
4466 is not included by the compiler when determining
4467 whether or not to issue a warning.
4469 @item -Wno-free-nonheap-object
4470 @opindex Wno-free-nonheap-object
4471 @opindex Wfree-nonheap-object
4472 Do not warn when attempting to free an object that was not allocated
4473 on the heap.
4475 @item -Wstack-usage=@var{len}
4476 @opindex Wstack-usage
4477 Warn if the stack usage of a function might be larger than @var{len} bytes.
4478 The computation done to determine the stack usage is conservative.
4479 Any space allocated via @code{alloca}, variable-length arrays, or related
4480 constructs is included by the compiler when determining whether or not to
4481 issue a warning.
4483 The message is in keeping with the output of @option{-fstack-usage}.
4485 @itemize
4486 @item
4487 If the stack usage is fully static but exceeds the specified amount, it's:
4489 @smallexample
4490   warning: stack usage is 1120 bytes
4491 @end smallexample
4492 @item
4493 If the stack usage is (partly) dynamic but bounded, it's:
4495 @smallexample
4496   warning: stack usage might be 1648 bytes
4497 @end smallexample
4498 @item
4499 If the stack usage is (partly) dynamic and not bounded, it's:
4501 @smallexample
4502   warning: stack usage might be unbounded
4503 @end smallexample
4504 @end itemize
4506 @item -Wunsafe-loop-optimizations
4507 @opindex Wunsafe-loop-optimizations
4508 @opindex Wno-unsafe-loop-optimizations
4509 Warn if the loop cannot be optimized because the compiler cannot
4510 assume anything on the bounds of the loop indices.  With
4511 @option{-funsafe-loop-optimizations} warn if the compiler makes
4512 such assumptions.
4514 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4515 @opindex Wno-pedantic-ms-format
4516 @opindex Wpedantic-ms-format
4517 When used in combination with @option{-Wformat}
4518 and @option{-pedantic} without GNU extensions, this option
4519 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4520 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4521 which depend on the MS runtime.
4523 @item -Wpointer-arith
4524 @opindex Wpointer-arith
4525 @opindex Wno-pointer-arith
4526 Warn about anything that depends on the ``size of'' a function type or
4527 of @code{void}.  GNU C assigns these types a size of 1, for
4528 convenience in calculations with @code{void *} pointers and pointers
4529 to functions.  In C++, warn also when an arithmetic operation involves
4530 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4532 @item -Wtype-limits
4533 @opindex Wtype-limits
4534 @opindex Wno-type-limits
4535 Warn if a comparison is always true or always false due to the limited
4536 range of the data type, but do not warn for constant expressions.  For
4537 example, warn if an unsigned variable is compared against zero with
4538 @samp{<} or @samp{>=}.  This warning is also enabled by
4539 @option{-Wextra}.
4541 @item -Wbad-function-cast @r{(C and Objective-C only)}
4542 @opindex Wbad-function-cast
4543 @opindex Wno-bad-function-cast
4544 Warn whenever a function call is cast to a non-matching type.
4545 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4547 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4548 @opindex Wc90-c99-compat
4549 @opindex Wno-c90-c99-compat
4550 Warn about features not present in ISO C90, but present in ISO C99.
4551 For instance, warn about use of variable length arrays, @code{long long}
4552 type, @code{bool} type, compound literals, designated initializers, and so
4553 on.  This option is independent of the standards mode.  Warnings are disabled
4554 in the expression that follows @code{__extension__}.
4556 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4557 @opindex Wc99-c11-compat
4558 @opindex Wno-c99-c11-compat
4559 Warn about features not present in ISO C99, but present in ISO C11.
4560 For instance, warn about use of anonymous structures and unions,
4561 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4562 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4563 and so on.  This option is independent of the standards mode.  Warnings are
4564 disabled in the expression that follows @code{__extension__}.
4566 @item -Wc++-compat @r{(C and Objective-C only)}
4567 Warn about ISO C constructs that are outside of the common subset of
4568 ISO C and ISO C++, e.g.@: request for implicit conversion from
4569 @code{void *} to a pointer to non-@code{void} type.
4571 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4572 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4573 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4574 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4575 enabled by @option{-Wall}.
4577 @item -Wcast-qual
4578 @opindex Wcast-qual
4579 @opindex Wno-cast-qual
4580 Warn whenever a pointer is cast so as to remove a type qualifier from
4581 the target type.  For example, warn if a @code{const char *} is cast
4582 to an ordinary @code{char *}.
4584 Also warn when making a cast that introduces a type qualifier in an
4585 unsafe way.  For example, casting @code{char **} to @code{const char **}
4586 is unsafe, as in this example:
4588 @smallexample
4589   /* p is char ** value.  */
4590   const char **q = (const char **) p;
4591   /* Assignment of readonly string to const char * is OK.  */
4592   *q = "string";
4593   /* Now char** pointer points to read-only memory.  */
4594   **p = 'b';
4595 @end smallexample
4597 @item -Wcast-align
4598 @opindex Wcast-align
4599 @opindex Wno-cast-align
4600 Warn whenever a pointer is cast such that the required alignment of the
4601 target is increased.  For example, warn if a @code{char *} is cast to
4602 an @code{int *} on machines where integers can only be accessed at
4603 two- or four-byte boundaries.
4605 @item -Wwrite-strings
4606 @opindex Wwrite-strings
4607 @opindex Wno-write-strings
4608 When compiling C, give string constants the type @code{const
4609 char[@var{length}]} so that copying the address of one into a
4610 non-@code{const} @code{char *} pointer produces a warning.  These
4611 warnings help you find at compile time code that can try to write
4612 into a string constant, but only if you have been very careful about
4613 using @code{const} in declarations and prototypes.  Otherwise, it is
4614 just a nuisance. This is why we did not make @option{-Wall} request
4615 these warnings.
4617 When compiling C++, warn about the deprecated conversion from string
4618 literals to @code{char *}.  This warning is enabled by default for C++
4619 programs.
4621 @item -Wclobbered
4622 @opindex Wclobbered
4623 @opindex Wno-clobbered
4624 Warn for variables that might be changed by @samp{longjmp} or
4625 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4627 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4628 @opindex Wconditionally-supported
4629 @opindex Wno-conditionally-supported
4630 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4632 @item -Wconversion
4633 @opindex Wconversion
4634 @opindex Wno-conversion
4635 Warn for implicit conversions that may alter a value. This includes
4636 conversions between real and integer, like @code{abs (x)} when
4637 @code{x} is @code{double}; conversions between signed and unsigned,
4638 like @code{unsigned ui = -1}; and conversions to smaller types, like
4639 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4640 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4641 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4642 conversions between signed and unsigned integers can be disabled by
4643 using @option{-Wno-sign-conversion}.
4645 For C++, also warn for confusing overload resolution for user-defined
4646 conversions; and conversions that never use a type conversion
4647 operator: conversions to @code{void}, the same type, a base class or a
4648 reference to them. Warnings about conversions between signed and
4649 unsigned integers are disabled by default in C++ unless
4650 @option{-Wsign-conversion} is explicitly enabled.
4652 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4653 @opindex Wconversion-null
4654 @opindex Wno-conversion-null
4655 Do not warn for conversions between @code{NULL} and non-pointer
4656 types. @option{-Wconversion-null} is enabled by default.
4658 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4659 @opindex Wzero-as-null-pointer-constant
4660 @opindex Wno-zero-as-null-pointer-constant
4661 Warn when a literal '0' is used as null pointer constant.  This can
4662 be useful to facilitate the conversion to @code{nullptr} in C++11.
4664 @item -Wdate-time
4665 @opindex Wdate-time
4666 @opindex Wno-date-time
4667 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4668 are encountered as they might prevent bit-wise-identical reproducible
4669 compilations.
4671 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4672 @opindex Wdelete-incomplete
4673 @opindex Wno-delete-incomplete
4674 Warn when deleting a pointer to incomplete type, which may cause
4675 undefined behavior at runtime.  This warning is enabled by default.
4677 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4678 @opindex Wuseless-cast
4679 @opindex Wno-useless-cast
4680 Warn when an expression is casted to its own type.
4682 @item -Wempty-body
4683 @opindex Wempty-body
4684 @opindex Wno-empty-body
4685 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4686 while} statement.  This warning is also enabled by @option{-Wextra}.
4688 @item -Wenum-compare
4689 @opindex Wenum-compare
4690 @opindex Wno-enum-compare
4691 Warn about a comparison between values of different enumerated types.
4692 In C++ enumeral mismatches in conditional expressions are also
4693 diagnosed and the warning is enabled by default.  In C this warning is 
4694 enabled by @option{-Wall}.
4696 @item -Wjump-misses-init @r{(C, Objective-C only)}
4697 @opindex Wjump-misses-init
4698 @opindex Wno-jump-misses-init
4699 Warn if a @code{goto} statement or a @code{switch} statement jumps
4700 forward across the initialization of a variable, or jumps backward to a
4701 label after the variable has been initialized.  This only warns about
4702 variables that are initialized when they are declared.  This warning is
4703 only supported for C and Objective-C; in C++ this sort of branch is an
4704 error in any case.
4706 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4707 can be disabled with the @option{-Wno-jump-misses-init} option.
4709 @item -Wsign-compare
4710 @opindex Wsign-compare
4711 @opindex Wno-sign-compare
4712 @cindex warning for comparison of signed and unsigned values
4713 @cindex comparison of signed and unsigned values, warning
4714 @cindex signed and unsigned values, comparison warning
4715 Warn when a comparison between signed and unsigned values could produce
4716 an incorrect result when the signed value is converted to unsigned.
4717 This warning is also enabled by @option{-Wextra}; to get the other warnings
4718 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4720 @item -Wsign-conversion
4721 @opindex Wsign-conversion
4722 @opindex Wno-sign-conversion
4723 Warn for implicit conversions that may change the sign of an integer
4724 value, like assigning a signed integer expression to an unsigned
4725 integer variable. An explicit cast silences the warning. In C, this
4726 option is enabled also by @option{-Wconversion}.
4728 @item -Wfloat-conversion
4729 @opindex Wfloat-conversion
4730 @opindex Wno-float-conversion
4731 Warn for implicit conversions that reduce the precision of a real value.
4732 This includes conversions from real to integer, and from higher precision
4733 real to lower precision real values.  This option is also enabled by
4734 @option{-Wconversion}.
4736 @item -Wsizeof-pointer-memaccess
4737 @opindex Wsizeof-pointer-memaccess
4738 @opindex Wno-sizeof-pointer-memaccess
4739 Warn for suspicious length parameters to certain string and memory built-in
4740 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4741 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4742 but a pointer, and suggests a possible fix, or about
4743 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4744 @option{-Wall}.
4746 @item -Wsizeof-array-argument
4747 @opindex Wsizeof-array-argument
4748 @opindex Wno-sizeof-array-argument
4749 Warn when the @code{sizeof} operator is applied to a parameter that is
4750 declared as an array in a function definition.  This warning is enabled by
4751 default for C and C++ programs.
4753 @item -Wmemset-transposed-args
4754 @opindex Wmemset-transposed-args
4755 @opindex Wno-memset-transposed-args
4756 Warn for suspicious calls to the @code{memset} built-in function, if the
4757 second argument is not zero and the third argument is zero.  This warns e.g.@
4758 about @code{memset (buf, sizeof buf, 0)} where most probably
4759 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4760 is only emitted if the third argument is literal zero, if it is some expression
4761 that is folded to zero, or e.g. a cast of zero to some type etc., it
4762 is far less likely that user has mistakenly exchanged the arguments and
4763 no warning is emitted.  This warning is enabled by @option{-Wall}.
4765 @item -Waddress
4766 @opindex Waddress
4767 @opindex Wno-address
4768 Warn about suspicious uses of memory addresses. These include using
4769 the address of a function in a conditional expression, such as
4770 @code{void func(void); if (func)}, and comparisons against the memory
4771 address of a string literal, such as @code{if (x == "abc")}.  Such
4772 uses typically indicate a programmer error: the address of a function
4773 always evaluates to true, so their use in a conditional usually
4774 indicate that the programmer forgot the parentheses in a function
4775 call; and comparisons against string literals result in unspecified
4776 behavior and are not portable in C, so they usually indicate that the
4777 programmer intended to use @code{strcmp}.  This warning is enabled by
4778 @option{-Wall}.
4780 @item -Wlogical-op
4781 @opindex Wlogical-op
4782 @opindex Wno-logical-op
4783 Warn about suspicious uses of logical operators in expressions.
4784 This includes using logical operators in contexts where a
4785 bit-wise operator is likely to be expected.
4787 @item -Wlogical-not-parentheses
4788 @opindex Wlogical-not-parentheses
4789 @opindex Wno-logical-not-parentheses
4790 Warn about logical not used on the left hand side operand of a comparison.
4791 This option does not warn if the RHS operand is of a boolean type.  Its
4792 purpose is to detect suspicious code like the following:
4793 @smallexample
4794 int a;
4795 @dots{}
4796 if (!a > 1) @{ @dots{} @}
4797 @end smallexample
4799 It is possible to suppress the warning by wrapping the LHS into
4800 parentheses:
4801 @smallexample
4802 if ((!a) > 1) @{ @dots{} @}
4803 @end smallexample
4805 This warning is enabled by @option{-Wall}.
4807 @item -Waggregate-return
4808 @opindex Waggregate-return
4809 @opindex Wno-aggregate-return
4810 Warn if any functions that return structures or unions are defined or
4811 called.  (In languages where you can return an array, this also elicits
4812 a warning.)
4814 @item -Wno-aggressive-loop-optimizations
4815 @opindex Wno-aggressive-loop-optimizations
4816 @opindex Waggressive-loop-optimizations
4817 Warn if in a loop with constant number of iterations the compiler detects
4818 undefined behavior in some statement during one or more of the iterations.
4820 @item -Wno-attributes
4821 @opindex Wno-attributes
4822 @opindex Wattributes
4823 Do not warn if an unexpected @code{__attribute__} is used, such as
4824 unrecognized attributes, function attributes applied to variables,
4825 etc.  This does not stop errors for incorrect use of supported
4826 attributes.
4828 @item -Wno-builtin-macro-redefined
4829 @opindex Wno-builtin-macro-redefined
4830 @opindex Wbuiltin-macro-redefined
4831 Do not warn if certain built-in macros are redefined.  This suppresses
4832 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4833 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4835 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4836 @opindex Wstrict-prototypes
4837 @opindex Wno-strict-prototypes
4838 Warn if a function is declared or defined without specifying the
4839 argument types.  (An old-style function definition is permitted without
4840 a warning if preceded by a declaration that specifies the argument
4841 types.)
4843 @item -Wold-style-declaration @r{(C and Objective-C only)}
4844 @opindex Wold-style-declaration
4845 @opindex Wno-old-style-declaration
4846 Warn for obsolescent usages, according to the C Standard, in a
4847 declaration. For example, warn if storage-class specifiers like
4848 @code{static} are not the first things in a declaration.  This warning
4849 is also enabled by @option{-Wextra}.
4851 @item -Wold-style-definition @r{(C and Objective-C only)}
4852 @opindex Wold-style-definition
4853 @opindex Wno-old-style-definition
4854 Warn if an old-style function definition is used.  A warning is given
4855 even if there is a previous prototype.
4857 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4858 @opindex Wmissing-parameter-type
4859 @opindex Wno-missing-parameter-type
4860 A function parameter is declared without a type specifier in K&R-style
4861 functions:
4863 @smallexample
4864 void foo(bar) @{ @}
4865 @end smallexample
4867 This warning is also enabled by @option{-Wextra}.
4869 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4870 @opindex Wmissing-prototypes
4871 @opindex Wno-missing-prototypes
4872 Warn if a global function is defined without a previous prototype
4873 declaration.  This warning is issued even if the definition itself
4874 provides a prototype.  Use this option to detect global functions
4875 that do not have a matching prototype declaration in a header file.
4876 This option is not valid for C++ because all function declarations
4877 provide prototypes and a non-matching declaration will declare an
4878 overload rather than conflict with an earlier declaration.
4879 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4881 @item -Wmissing-declarations
4882 @opindex Wmissing-declarations
4883 @opindex Wno-missing-declarations
4884 Warn if a global function is defined without a previous declaration.
4885 Do so even if the definition itself provides a prototype.
4886 Use this option to detect global functions that are not declared in
4887 header files.  In C, no warnings are issued for functions with previous
4888 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4889 missing prototypes.  In C++, no warnings are issued for function templates,
4890 or for inline functions, or for functions in anonymous namespaces.
4892 @item -Wmissing-field-initializers
4893 @opindex Wmissing-field-initializers
4894 @opindex Wno-missing-field-initializers
4895 @opindex W
4896 @opindex Wextra
4897 @opindex Wno-extra
4898 Warn if a structure's initializer has some fields missing.  For
4899 example, the following code causes such a warning, because
4900 @code{x.h} is implicitly zero:
4902 @smallexample
4903 struct s @{ int f, g, h; @};
4904 struct s x = @{ 3, 4 @};
4905 @end smallexample
4907 This option does not warn about designated initializers, so the following
4908 modification does not trigger a warning:
4910 @smallexample
4911 struct s @{ int f, g, h; @};
4912 struct s x = @{ .f = 3, .g = 4 @};
4913 @end smallexample
4915 In C++ this option does not warn either about the empty @{ @}
4916 initializer, for example:
4918 @smallexample
4919 struct s @{ int f, g, h; @};
4920 s x = @{ @};
4921 @end smallexample
4923 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4924 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4926 @item -Wno-multichar
4927 @opindex Wno-multichar
4928 @opindex Wmultichar
4929 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4930 Usually they indicate a typo in the user's code, as they have
4931 implementation-defined values, and should not be used in portable code.
4933 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
4934 @opindex Wnormalized=
4935 @opindex Wnormalized
4936 @opindex Wno-normalized
4937 @cindex NFC
4938 @cindex NFKC
4939 @cindex character set, input normalization
4940 In ISO C and ISO C++, two identifiers are different if they are
4941 different sequences of characters.  However, sometimes when characters
4942 outside the basic ASCII character set are used, you can have two
4943 different character sequences that look the same.  To avoid confusion,
4944 the ISO 10646 standard sets out some @dfn{normalization rules} which
4945 when applied ensure that two sequences that look the same are turned into
4946 the same sequence.  GCC can warn you if you are using identifiers that
4947 have not been normalized; this option controls that warning.
4949 There are four levels of warning supported by GCC@.  The default is
4950 @option{-Wnormalized=nfc}, which warns about any identifier that is
4951 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4952 recommended form for most uses.  It is equivalent to
4953 @option{-Wnormalized}.
4955 Unfortunately, there are some characters allowed in identifiers by
4956 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4957 identifiers.  That is, there's no way to use these symbols in portable
4958 ISO C or C++ and have all your identifiers in NFC@.
4959 @option{-Wnormalized=id} suppresses the warning for these characters.
4960 It is hoped that future versions of the standards involved will correct
4961 this, which is why this option is not the default.
4963 You can switch the warning off for all characters by writing
4964 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
4965 only do this if you are using some other normalization scheme (like
4966 ``D''), because otherwise you can easily create bugs that are
4967 literally impossible to see.
4969 Some characters in ISO 10646 have distinct meanings but look identical
4970 in some fonts or display methodologies, especially once formatting has
4971 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4972 LETTER N'', displays just like a regular @code{n} that has been
4973 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4974 normalization scheme to convert all these into a standard form as
4975 well, and GCC warns if your code is not in NFKC if you use
4976 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4977 about every identifier that contains the letter O because it might be
4978 confused with the digit 0, and so is not the default, but may be
4979 useful as a local coding convention if the programming environment 
4980 cannot be fixed to display these characters distinctly.
4982 @item -Wno-deprecated
4983 @opindex Wno-deprecated
4984 @opindex Wdeprecated
4985 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4987 @item -Wno-deprecated-declarations
4988 @opindex Wno-deprecated-declarations
4989 @opindex Wdeprecated-declarations
4990 Do not warn about uses of functions (@pxref{Function Attributes}),
4991 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4992 Attributes}) marked as deprecated by using the @code{deprecated}
4993 attribute.
4995 @item -Wno-overflow
4996 @opindex Wno-overflow
4997 @opindex Woverflow
4998 Do not warn about compile-time overflow in constant expressions.
5000 @item -Wno-odr
5001 @opindex Wno-odr
5002 @opindex Wodr
5003 Warn about One Definition Rule violations during link-time optimization.
5004 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5006 @item -Wopenmp-simd
5007 @opindex Wopenm-simd
5008 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5009 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
5010 be used to relax the cost model.
5012 @item -Woverride-init @r{(C and Objective-C only)}
5013 @opindex Woverride-init
5014 @opindex Wno-override-init
5015 @opindex W
5016 @opindex Wextra
5017 @opindex Wno-extra
5018 Warn if an initialized field without side effects is overridden when
5019 using designated initializers (@pxref{Designated Inits, , Designated
5020 Initializers}).
5022 This warning is included in @option{-Wextra}.  To get other
5023 @option{-Wextra} warnings without this one, use @option{-Wextra
5024 -Wno-override-init}.
5026 @item -Wpacked
5027 @opindex Wpacked
5028 @opindex Wno-packed
5029 Warn if a structure is given the packed attribute, but the packed
5030 attribute has no effect on the layout or size of the structure.
5031 Such structures may be mis-aligned for little benefit.  For
5032 instance, in this code, the variable @code{f.x} in @code{struct bar}
5033 is misaligned even though @code{struct bar} does not itself
5034 have the packed attribute:
5036 @smallexample
5037 @group
5038 struct foo @{
5039   int x;
5040   char a, b, c, d;
5041 @} __attribute__((packed));
5042 struct bar @{
5043   char z;
5044   struct foo f;
5046 @end group
5047 @end smallexample
5049 @item -Wpacked-bitfield-compat
5050 @opindex Wpacked-bitfield-compat
5051 @opindex Wno-packed-bitfield-compat
5052 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5053 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5054 the change can lead to differences in the structure layout.  GCC
5055 informs you when the offset of such a field has changed in GCC 4.4.
5056 For example there is no longer a 4-bit padding between field @code{a}
5057 and @code{b} in this structure:
5059 @smallexample
5060 struct foo
5062   char a:4;
5063   char b:8;
5064 @} __attribute__ ((packed));
5065 @end smallexample
5067 This warning is enabled by default.  Use
5068 @option{-Wno-packed-bitfield-compat} to disable this warning.
5070 @item -Wpadded
5071 @opindex Wpadded
5072 @opindex Wno-padded
5073 Warn if padding is included in a structure, either to align an element
5074 of the structure or to align the whole structure.  Sometimes when this
5075 happens it is possible to rearrange the fields of the structure to
5076 reduce the padding and so make the structure smaller.
5078 @item -Wredundant-decls
5079 @opindex Wredundant-decls
5080 @opindex Wno-redundant-decls
5081 Warn if anything is declared more than once in the same scope, even in
5082 cases where multiple declaration is valid and changes nothing.
5084 @item -Wnested-externs @r{(C and Objective-C only)}
5085 @opindex Wnested-externs
5086 @opindex Wno-nested-externs
5087 Warn if an @code{extern} declaration is encountered within a function.
5089 @item -Wno-inherited-variadic-ctor
5090 @opindex Winherited-variadic-ctor
5091 @opindex Wno-inherited-variadic-ctor
5092 Suppress warnings about use of C++11 inheriting constructors when the
5093 base class inherited from has a C variadic constructor; the warning is
5094 on by default because the ellipsis is not inherited.
5096 @item -Winline
5097 @opindex Winline
5098 @opindex Wno-inline
5099 Warn if a function that is declared as inline cannot be inlined.
5100 Even with this option, the compiler does not warn about failures to
5101 inline functions declared in system headers.
5103 The compiler uses a variety of heuristics to determine whether or not
5104 to inline a function.  For example, the compiler takes into account
5105 the size of the function being inlined and the amount of inlining
5106 that has already been done in the current function.  Therefore,
5107 seemingly insignificant changes in the source program can cause the
5108 warnings produced by @option{-Winline} to appear or disappear.
5110 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5111 @opindex Wno-invalid-offsetof
5112 @opindex Winvalid-offsetof
5113 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
5114 type.  According to the 2014 ISO C++ standard, applying @samp{offsetof}
5115 to a non-standard-layout type is undefined.  In existing C++ implementations,
5116 however, @samp{offsetof} typically gives meaningful results.
5117 This flag is for users who are aware that they are
5118 writing nonportable code and who have deliberately chosen to ignore the
5119 warning about it.
5121 The restrictions on @samp{offsetof} may be relaxed in a future version
5122 of the C++ standard.
5124 @item -Wno-int-to-pointer-cast
5125 @opindex Wno-int-to-pointer-cast
5126 @opindex Wint-to-pointer-cast
5127 Suppress warnings from casts to pointer type of an integer of a
5128 different size. In C++, casting to a pointer type of smaller size is
5129 an error. @option{Wint-to-pointer-cast} is enabled by default.
5132 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5133 @opindex Wno-pointer-to-int-cast
5134 @opindex Wpointer-to-int-cast
5135 Suppress warnings from casts from a pointer to an integer type of a
5136 different size.
5138 @item -Winvalid-pch
5139 @opindex Winvalid-pch
5140 @opindex Wno-invalid-pch
5141 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5142 the search path but can't be used.
5144 @item -Wlong-long
5145 @opindex Wlong-long
5146 @opindex Wno-long-long
5147 Warn if @samp{long long} type is used.  This is enabled by either
5148 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5149 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5151 @item -Wvariadic-macros
5152 @opindex Wvariadic-macros
5153 @opindex Wno-variadic-macros
5154 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5155 alternate syntax is used in ISO C99 mode.  This is enabled by either
5156 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5157 messages, use @option{-Wno-variadic-macros}.
5159 @item -Wvarargs
5160 @opindex Wvarargs
5161 @opindex Wno-varargs
5162 Warn upon questionable usage of the macros used to handle variable
5163 arguments like @samp{va_start}.  This is default.  To inhibit the
5164 warning messages, use @option{-Wno-varargs}.
5166 @item -Wvector-operation-performance
5167 @opindex Wvector-operation-performance
5168 @opindex Wno-vector-operation-performance
5169 Warn if vector operation is not implemented via SIMD capabilities of the
5170 architecture.  Mainly useful for the performance tuning.
5171 Vector operation can be implemented @code{piecewise}, which means that the
5172 scalar operation is performed on every vector element; 
5173 @code{in parallel}, which means that the vector operation is implemented
5174 using scalars of wider type, which normally is more performance efficient;
5175 and @code{as a single scalar}, which means that vector fits into a
5176 scalar type.
5178 @item -Wno-virtual-move-assign
5179 @opindex Wvirtual-move-assign
5180 @opindex Wno-virtual-move-assign
5181 Suppress warnings about inheriting from a virtual base with a
5182 non-trivial C++11 move assignment operator.  This is dangerous because
5183 if the virtual base is reachable along more than one path, it will be
5184 moved multiple times, which can mean both objects end up in the
5185 moved-from state.  If the move assignment operator is written to avoid
5186 moving from a moved-from object, this warning can be disabled.
5188 @item -Wvla
5189 @opindex Wvla
5190 @opindex Wno-vla
5191 Warn if variable length array is used in the code.
5192 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5193 the variable length array.
5195 @item -Wvolatile-register-var
5196 @opindex Wvolatile-register-var
5197 @opindex Wno-volatile-register-var
5198 Warn if a register variable is declared volatile.  The volatile
5199 modifier does not inhibit all optimizations that may eliminate reads
5200 and/or writes to register variables.  This warning is enabled by
5201 @option{-Wall}.
5203 @item -Wdisabled-optimization
5204 @opindex Wdisabled-optimization
5205 @opindex Wno-disabled-optimization
5206 Warn if a requested optimization pass is disabled.  This warning does
5207 not generally indicate that there is anything wrong with your code; it
5208 merely indicates that GCC's optimizers are unable to handle the code
5209 effectively.  Often, the problem is that your code is too big or too
5210 complex; GCC refuses to optimize programs when the optimization
5211 itself is likely to take inordinate amounts of time.
5213 @item -Wpointer-sign @r{(C and Objective-C only)}
5214 @opindex Wpointer-sign
5215 @opindex Wno-pointer-sign
5216 Warn for pointer argument passing or assignment with different signedness.
5217 This option is only supported for C and Objective-C@.  It is implied by
5218 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5219 @option{-Wno-pointer-sign}.
5221 @item -Wstack-protector
5222 @opindex Wstack-protector
5223 @opindex Wno-stack-protector
5224 This option is only active when @option{-fstack-protector} is active.  It
5225 warns about functions that are not protected against stack smashing.
5227 @item -Woverlength-strings
5228 @opindex Woverlength-strings
5229 @opindex Wno-overlength-strings
5230 Warn about string constants that are longer than the ``minimum
5231 maximum'' length specified in the C standard.  Modern compilers
5232 generally allow string constants that are much longer than the
5233 standard's minimum limit, but very portable programs should avoid
5234 using longer strings.
5236 The limit applies @emph{after} string constant concatenation, and does
5237 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5238 C99, it was raised to 4095.  C++98 does not specify a normative
5239 minimum maximum, so we do not diagnose overlength strings in C++@.
5241 This option is implied by @option{-Wpedantic}, and can be disabled with
5242 @option{-Wno-overlength-strings}.
5244 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5245 @opindex Wunsuffixed-float-constants
5247 Issue a warning for any floating constant that does not have
5248 a suffix.  When used together with @option{-Wsystem-headers} it
5249 warns about such constants in system header files.  This can be useful
5250 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5251 from the decimal floating-point extension to C99.
5253 @item -Wno-designated-init @r{(C and Objective-C only)}
5254 Suppress warnings when a positional initializer is used to initialize
5255 a structure that has been marked with the @code{designated_init}
5256 attribute.
5258 @end table
5260 @node Debugging Options
5261 @section Options for Debugging Your Program or GCC
5262 @cindex options, debugging
5263 @cindex debugging information options
5265 GCC has various special options that are used for debugging
5266 either your program or GCC:
5268 @table @gcctabopt
5269 @item -g
5270 @opindex g
5271 Produce debugging information in the operating system's native format
5272 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5273 information.
5275 On most systems that use stabs format, @option{-g} enables use of extra
5276 debugging information that only GDB can use; this extra information
5277 makes debugging work better in GDB but probably makes other debuggers
5278 crash or
5279 refuse to read the program.  If you want to control for certain whether
5280 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5281 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5283 GCC allows you to use @option{-g} with
5284 @option{-O}.  The shortcuts taken by optimized code may occasionally
5285 produce surprising results: some variables you declared may not exist
5286 at all; flow of control may briefly move where you did not expect it;
5287 some statements may not be executed because they compute constant
5288 results or their values are already at hand; some statements may
5289 execute in different places because they have been moved out of loops.
5291 Nevertheless it proves possible to debug optimized output.  This makes
5292 it reasonable to use the optimizer for programs that might have bugs.
5294 The following options are useful when GCC is generated with the
5295 capability for more than one debugging format.
5297 @item -gsplit-dwarf
5298 @opindex gsplit-dwarf
5299 Separate as much dwarf debugging information as possible into a
5300 separate output file with the extension .dwo.  This option allows
5301 the build system to avoid linking files with debug information.  To
5302 be useful, this option requires a debugger capable of reading .dwo
5303 files.
5305 @item -ggdb
5306 @opindex ggdb
5307 Produce debugging information for use by GDB@.  This means to use the
5308 most expressive format available (DWARF 2, stabs, or the native format
5309 if neither of those are supported), including GDB extensions if at all
5310 possible.
5312 @item -gpubnames
5313 @opindex gpubnames
5314 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5316 @item -ggnu-pubnames
5317 @opindex ggnu-pubnames
5318 Generate .debug_pubnames and .debug_pubtypes sections in a format
5319 suitable for conversion into a GDB@ index.  This option is only useful
5320 with a linker that can produce GDB@ index version 7.
5322 @item -gstabs
5323 @opindex gstabs
5324 Produce debugging information in stabs format (if that is supported),
5325 without GDB extensions.  This is the format used by DBX on most BSD
5326 systems.  On MIPS, Alpha and System V Release 4 systems this option
5327 produces stabs debugging output that is not understood by DBX or SDB@.
5328 On System V Release 4 systems this option requires the GNU assembler.
5330 @item -feliminate-unused-debug-symbols
5331 @opindex feliminate-unused-debug-symbols
5332 Produce debugging information in stabs format (if that is supported),
5333 for only symbols that are actually used.
5335 @item -femit-class-debug-always
5336 Instead of emitting debugging information for a C++ class in only one
5337 object file, emit it in all object files using the class.  This option
5338 should be used only with debuggers that are unable to handle the way GCC
5339 normally emits debugging information for classes because using this
5340 option increases the size of debugging information by as much as a
5341 factor of two.
5343 @item -fdebug-types-section
5344 @opindex fdebug-types-section
5345 @opindex fno-debug-types-section
5346 When using DWARF Version 4 or higher, type DIEs can be put into
5347 their own @code{.debug_types} section instead of making them part of the
5348 @code{.debug_info} section.  It is more efficient to put them in a separate
5349 comdat sections since the linker can then remove duplicates.
5350 But not all DWARF consumers support @code{.debug_types} sections yet
5351 and on some objects @code{.debug_types} produces larger instead of smaller
5352 debugging information.
5354 @item -gstabs+
5355 @opindex gstabs+
5356 Produce debugging information in stabs format (if that is supported),
5357 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5358 use of these extensions is likely to make other debuggers crash or
5359 refuse to read the program.
5361 @item -gcoff
5362 @opindex gcoff
5363 Produce debugging information in COFF format (if that is supported).
5364 This is the format used by SDB on most System V systems prior to
5365 System V Release 4.
5367 @item -gxcoff
5368 @opindex gxcoff
5369 Produce debugging information in XCOFF format (if that is supported).
5370 This is the format used by the DBX debugger on IBM RS/6000 systems.
5372 @item -gxcoff+
5373 @opindex gxcoff+
5374 Produce debugging information in XCOFF format (if that is supported),
5375 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5376 use of these extensions is likely to make other debuggers crash or
5377 refuse to read the program, and may cause assemblers other than the GNU
5378 assembler (GAS) to fail with an error.
5380 @item -gdwarf-@var{version}
5381 @opindex gdwarf-@var{version}
5382 Produce debugging information in DWARF format (if that is supported).
5383 The value of @var{version} may be either 2, 3 or 4; the default version
5384 for most targets is 4.
5386 Note that with DWARF Version 2, some ports require and always
5387 use some non-conflicting DWARF 3 extensions in the unwind tables.
5389 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5390 for maximum benefit.
5392 @item -grecord-gcc-switches
5393 @opindex grecord-gcc-switches
5394 This switch causes the command-line options used to invoke the
5395 compiler that may affect code generation to be appended to the
5396 DW_AT_producer attribute in DWARF debugging information.  The options
5397 are concatenated with spaces separating them from each other and from
5398 the compiler version.  See also @option{-frecord-gcc-switches} for another
5399 way of storing compiler options into the object file.  This is the default.
5401 @item -gno-record-gcc-switches
5402 @opindex gno-record-gcc-switches
5403 Disallow appending command-line options to the DW_AT_producer attribute
5404 in DWARF debugging information.
5406 @item -gstrict-dwarf
5407 @opindex gstrict-dwarf
5408 Disallow using extensions of later DWARF standard version than selected
5409 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5410 DWARF extensions from later standard versions is allowed.
5412 @item -gno-strict-dwarf
5413 @opindex gno-strict-dwarf
5414 Allow using extensions of later DWARF standard version than selected with
5415 @option{-gdwarf-@var{version}}.
5417 @item -gz@r{[}=@var{type}@r{]}
5418 @opindex gz
5419 Produce compressed debug sections in DWARF format, if that is supported.
5420 If @var{type} is not given, the default type depends on the capabilities
5421 of the assembler and linker used.  @var{type} may be one of
5422 @option{none} (don't compress debug sections), @option{zlib} (use zlib
5423 compression in ELF gABI format), or @option{zlib-gnu} (use zlib
5424 compression in traditional GNU format).  If the linker doesn't support
5425 writing compressed debug sections, the option is rejected.  Otherwise,
5426 if the assembler does not support them, @option{-gz} is silently ignored
5427 when producing object files.
5429 @item -gvms
5430 @opindex gvms
5431 Produce debugging information in Alpha/VMS debug format (if that is
5432 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5434 @item -g@var{level}
5435 @itemx -ggdb@var{level}
5436 @itemx -gstabs@var{level}
5437 @itemx -gcoff@var{level}
5438 @itemx -gxcoff@var{level}
5439 @itemx -gvms@var{level}
5440 Request debugging information and also use @var{level} to specify how
5441 much information.  The default level is 2.
5443 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5444 @option{-g}.
5446 Level 1 produces minimal information, enough for making backtraces in
5447 parts of the program that you don't plan to debug.  This includes
5448 descriptions of functions and external variables, and line number
5449 tables, but no information about local variables.
5451 Level 3 includes extra information, such as all the macro definitions
5452 present in the program.  Some debuggers support macro expansion when
5453 you use @option{-g3}.
5455 @option{-gdwarf-2} does not accept a concatenated debug level, because
5456 GCC used to support an option @option{-gdwarf} that meant to generate
5457 debug information in version 1 of the DWARF format (which is very
5458 different from version 2), and it would have been too confusing.  That
5459 debug format is long obsolete, but the option cannot be changed now.
5460 Instead use an additional @option{-g@var{level}} option to change the
5461 debug level for DWARF.
5463 @item -gtoggle
5464 @opindex gtoggle
5465 Turn off generation of debug info, if leaving out this option
5466 generates it, or turn it on at level 2 otherwise.  The position of this
5467 argument in the command line does not matter; it takes effect after all
5468 other options are processed, and it does so only once, no matter how
5469 many times it is given.  This is mainly intended to be used with
5470 @option{-fcompare-debug}.
5472 @item -fsanitize=address
5473 @opindex fsanitize=address
5474 Enable AddressSanitizer, a fast memory error detector.
5475 Memory access instructions will be instrumented to detect
5476 out-of-bounds and use-after-free bugs.
5477 See @uref{http://code.google.com/p/address-sanitizer/} for
5478 more details.  The run-time behavior can be influenced using the
5479 @env{ASAN_OPTIONS} environment variable; see
5480 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5481 a list of supported options.
5483 @item -fsanitize=kernel-address
5484 @opindex fsanitize=kernel-address
5485 Enable AddressSanitizer for Linux kernel.
5486 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5488 @item -fsanitize=thread
5489 @opindex fsanitize=thread
5490 Enable ThreadSanitizer, a fast data race detector.
5491 Memory access instructions will be instrumented to detect
5492 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5493 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5494 environment variable; see
5495 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5496 supported options.
5498 @item -fsanitize=leak
5499 @opindex fsanitize=leak
5500 Enable LeakSanitizer, a memory leak detector.
5501 This option only matters for linking of executables and if neither
5502 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5503 case it will link the executable against a library that overrides @code{malloc}
5504 and other allocator functions.  See
5505 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5506 details.  The run-time behavior can be influenced using the
5507 @env{LSAN_OPTIONS} environment variable.
5509 @item -fsanitize=undefined
5510 @opindex fsanitize=undefined
5511 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5512 Various computations will be instrumented to detect undefined behavior
5513 at runtime.  Current suboptions are:
5515 @table @gcctabopt
5517 @item -fsanitize=shift
5518 @opindex fsanitize=shift
5519 This option enables checking that the result of a shift operation is
5520 not undefined.  Note that what exactly is considered undefined differs
5521 slightly between C and C++, as well as between ISO C90 and C99, etc.
5523 @item -fsanitize=integer-divide-by-zero
5524 @opindex fsanitize=integer-divide-by-zero
5525 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5527 @item -fsanitize=unreachable
5528 @opindex fsanitize=unreachable
5529 With this option, the compiler will turn the @code{__builtin_unreachable}
5530 call into a diagnostics message call instead.  When reaching the
5531 @code{__builtin_unreachable} call, the behavior is undefined.
5533 @item -fsanitize=vla-bound
5534 @opindex fsanitize=vla-bound
5535 This option instructs the compiler to check that the size of a variable
5536 length array is positive.  This option does not have any effect in
5537 @option{-std=c++14} mode, as the standard requires the exception be thrown
5538 instead.
5540 @item -fsanitize=null
5541 @opindex fsanitize=null
5542 This option enables pointer checking.  Particularly, the application
5543 built with this option turned on will issue an error message when it
5544 tries to dereference a NULL pointer, or if a reference (possibly an
5545 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5546 on an object pointed by a NULL pointer.
5548 @item -fsanitize=return
5549 @opindex fsanitize=return
5550 This option enables return statement checking.  Programs
5551 built with this option turned on will issue an error message
5552 when the end of a non-void function is reached without actually
5553 returning a value.  This option works in C++ only.
5555 @item -fsanitize=signed-integer-overflow
5556 @opindex fsanitize=signed-integer-overflow
5557 This option enables signed integer overflow checking.  We check that
5558 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5559 does not overflow in the signed arithmetics.  Note, integer promotion
5560 rules must be taken into account.  That is, the following is not an
5561 overflow:
5562 @smallexample
5563 signed char a = SCHAR_MAX;
5564 a++;
5565 @end smallexample
5567 @item -fsanitize=bounds
5568 @opindex fsanitize=bounds
5569 This option enables instrumentation of array bounds.  Various out of bounds
5570 accesses are detected.  Flexible array members and initializers of variables
5571 with static storage are not instrumented.
5573 @item -fsanitize=alignment
5574 @opindex fsanitize=alignment
5576 This option enables checking of alignment of pointers when they are
5577 dereferenced, or when a reference is bound to insufficiently aligned target,
5578 or when a method or constructor is invoked on insufficiently aligned object.
5580 @item -fsanitize=float-divide-by-zero
5581 @opindex fsanitize=float-divide-by-zero
5582 Detect floating-point division by zero.  Unlike other similar options,
5583 @option{-fsanitize=float-divide-by-zero} is not enabled by
5584 @option{-fsanitize=undefined}, since floating-point division by zero can
5585 be a legitimate way of obtaining infinities and NaNs.
5587 @item -fsanitize=float-cast-overflow
5588 @opindex fsanitize=float-cast-overflow
5589 This option enables floating-point type to integer conversion checking.
5590 We check that the result of the conversion does not overflow.
5591 This option does not work well with @code{FE_INVALID} exceptions enabled.
5593 @item -fsanitize=nonnull-attribute
5594 @opindex fsanitize=nonnull-attribute
5596 This option enables instrumentation of calls, checking whether null values
5597 are not passed to arguments marked as requiring a non-null value by the
5598 @code{nonnull} function attribute.
5600 @item -fsanitize=returns-nonnull-attribute
5601 @opindex fsanitize=returns-nonnull-attribute
5603 This option enables instrumentation of return statements in functions
5604 marked with @code{returns_nonnull} function attribute, to detect returning
5605 of null values from such functions.
5607 @end table
5609 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5610 @option{-fsanitize=undefined} gives a diagnostic message.
5611 This currently works only for the C family of languages.
5613 @item -fsanitize-recover
5614 @opindex fsanitize-recover
5615 By default @option{-fsanitize=undefined} sanitization (and its suboptions
5616 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return})
5617 after reporting undefined behavior attempts to continue running the
5618 program as if no undefined behavior happened.  This means multiple undefined
5619 behavior runtime errors can be reported in a single program run, and the exit
5620 code of the program may indicate success even when undefined behavior
5621 has been reported.  The @option{-fno-sanitize-recover} can be used to alter
5622 this behavior, only the first detected undefined behavior will be reported
5623 and program will exit after that with non-zero exit code.
5625 @item -fsanitize-undefined-trap-on-error
5626 @opindex fsanitize-undefined-trap-on-error
5627 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5628 report undefined behavior using @code{__builtin_trap ()} rather than
5629 a @code{libubsan} library routine.  The advantage of this is that the
5630 @code{libubsan} library is not needed and will not be linked in, so this
5631 is usable even for use in freestanding environments.
5633 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5634 @opindex fdump-final-insns
5635 Dump the final internal representation (RTL) to @var{file}.  If the
5636 optional argument is omitted (or if @var{file} is @code{.}), the name
5637 of the dump file is determined by appending @code{.gkd} to the
5638 compilation output file name.
5640 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5641 @opindex fcompare-debug
5642 @opindex fno-compare-debug
5643 If no error occurs during compilation, run the compiler a second time,
5644 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5645 passed to the second compilation.  Dump the final internal
5646 representation in both compilations, and print an error if they differ.
5648 If the equal sign is omitted, the default @option{-gtoggle} is used.
5650 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5651 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5652 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5653 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5654 is used.
5656 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5657 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5658 of the final representation and the second compilation, preventing even
5659 @env{GCC_COMPARE_DEBUG} from taking effect.
5661 To verify full coverage during @option{-fcompare-debug} testing, set
5662 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5663 which GCC rejects as an invalid option in any actual compilation
5664 (rather than preprocessing, assembly or linking).  To get just a
5665 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5666 not overridden} will do.
5668 @item -fcompare-debug-second
5669 @opindex fcompare-debug-second
5670 This option is implicitly passed to the compiler for the second
5671 compilation requested by @option{-fcompare-debug}, along with options to
5672 silence warnings, and omitting other options that would cause
5673 side-effect compiler outputs to files or to the standard output.  Dump
5674 files and preserved temporary files are renamed so as to contain the
5675 @code{.gk} additional extension during the second compilation, to avoid
5676 overwriting those generated by the first.
5678 When this option is passed to the compiler driver, it causes the
5679 @emph{first} compilation to be skipped, which makes it useful for little
5680 other than debugging the compiler proper.
5682 @item -feliminate-dwarf2-dups
5683 @opindex feliminate-dwarf2-dups
5684 Compress DWARF 2 debugging information by eliminating duplicated
5685 information about each symbol.  This option only makes sense when
5686 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5688 @item -femit-struct-debug-baseonly
5689 @opindex femit-struct-debug-baseonly
5690 Emit debug information for struct-like types
5691 only when the base name of the compilation source file
5692 matches the base name of file in which the struct is defined.
5694 This option substantially reduces the size of debugging information,
5695 but at significant potential loss in type information to the debugger.
5696 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5697 See @option{-femit-struct-debug-detailed} for more detailed control.
5699 This option works only with DWARF 2.
5701 @item -femit-struct-debug-reduced
5702 @opindex femit-struct-debug-reduced
5703 Emit debug information for struct-like types
5704 only when the base name of the compilation source file
5705 matches the base name of file in which the type is defined,
5706 unless the struct is a template or defined in a system header.
5708 This option significantly reduces the size of debugging information,
5709 with some potential loss in type information to the debugger.
5710 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5711 See @option{-femit-struct-debug-detailed} for more detailed control.
5713 This option works only with DWARF 2.
5715 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5716 Specify the struct-like types
5717 for which the compiler generates debug information.
5718 The intent is to reduce duplicate struct debug information
5719 between different object files within the same program.
5721 This option is a detailed version of
5722 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5723 which serves for most needs.
5725 A specification has the syntax@*
5726 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5728 The optional first word limits the specification to
5729 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5730 A struct type is used directly when it is the type of a variable, member.
5731 Indirect uses arise through pointers to structs.
5732 That is, when use of an incomplete struct is valid, the use is indirect.
5733 An example is
5734 @samp{struct one direct; struct two * indirect;}.
5736 The optional second word limits the specification to
5737 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5738 Generic structs are a bit complicated to explain.
5739 For C++, these are non-explicit specializations of template classes,
5740 or non-template classes within the above.
5741 Other programming languages have generics,
5742 but @option{-femit-struct-debug-detailed} does not yet implement them.
5744 The third word specifies the source files for those
5745 structs for which the compiler should emit debug information.
5746 The values @samp{none} and @samp{any} have the normal meaning.
5747 The value @samp{base} means that
5748 the base of name of the file in which the type declaration appears
5749 must match the base of the name of the main compilation file.
5750 In practice, this means that when compiling @file{foo.c}, debug information
5751 is generated for types declared in that file and @file{foo.h},
5752 but not other header files.
5753 The value @samp{sys} means those types satisfying @samp{base}
5754 or declared in system or compiler headers.
5756 You may need to experiment to determine the best settings for your application.
5758 The default is @option{-femit-struct-debug-detailed=all}.
5760 This option works only with DWARF 2.
5762 @item -fno-merge-debug-strings
5763 @opindex fmerge-debug-strings
5764 @opindex fno-merge-debug-strings
5765 Direct the linker to not merge together strings in the debugging
5766 information that are identical in different object files.  Merging is
5767 not supported by all assemblers or linkers.  Merging decreases the size
5768 of the debug information in the output file at the cost of increasing
5769 link processing time.  Merging is enabled by default.
5771 @item -fdebug-prefix-map=@var{old}=@var{new}
5772 @opindex fdebug-prefix-map
5773 When compiling files in directory @file{@var{old}}, record debugging
5774 information describing them as in @file{@var{new}} instead.
5776 @item -fno-dwarf2-cfi-asm
5777 @opindex fdwarf2-cfi-asm
5778 @opindex fno-dwarf2-cfi-asm
5779 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5780 instead of using GAS @code{.cfi_*} directives.
5782 @cindex @command{prof}
5783 @item -p
5784 @opindex p
5785 Generate extra code to write profile information suitable for the
5786 analysis program @command{prof}.  You must use this option when compiling
5787 the source files you want data about, and you must also use it when
5788 linking.
5790 @cindex @command{gprof}
5791 @item -pg
5792 @opindex pg
5793 Generate extra code to write profile information suitable for the
5794 analysis program @command{gprof}.  You must use this option when compiling
5795 the source files you want data about, and you must also use it when
5796 linking.
5798 @item -Q
5799 @opindex Q
5800 Makes the compiler print out each function name as it is compiled, and
5801 print some statistics about each pass when it finishes.
5803 @item -ftime-report
5804 @opindex ftime-report
5805 Makes the compiler print some statistics about the time consumed by each
5806 pass when it finishes.
5808 @item -fmem-report
5809 @opindex fmem-report
5810 Makes the compiler print some statistics about permanent memory
5811 allocation when it finishes.
5813 @item -fmem-report-wpa
5814 @opindex fmem-report-wpa
5815 Makes the compiler print some statistics about permanent memory
5816 allocation for the WPA phase only.
5818 @item -fpre-ipa-mem-report
5819 @opindex fpre-ipa-mem-report
5820 @item -fpost-ipa-mem-report
5821 @opindex fpost-ipa-mem-report
5822 Makes the compiler print some statistics about permanent memory
5823 allocation before or after interprocedural optimization.
5825 @item -fprofile-report
5826 @opindex fprofile-report
5827 Makes the compiler print some statistics about consistency of the
5828 (estimated) profile and effect of individual passes.
5830 @item -fstack-usage
5831 @opindex fstack-usage
5832 Makes the compiler output stack usage information for the program, on a
5833 per-function basis.  The filename for the dump is made by appending
5834 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5835 the output file, if explicitly specified and it is not an executable,
5836 otherwise it is the basename of the source file.  An entry is made up
5837 of three fields:
5839 @itemize
5840 @item
5841 The name of the function.
5842 @item
5843 A number of bytes.
5844 @item
5845 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5846 @end itemize
5848 The qualifier @code{static} means that the function manipulates the stack
5849 statically: a fixed number of bytes are allocated for the frame on function
5850 entry and released on function exit; no stack adjustments are otherwise made
5851 in the function.  The second field is this fixed number of bytes.
5853 The qualifier @code{dynamic} means that the function manipulates the stack
5854 dynamically: in addition to the static allocation described above, stack
5855 adjustments are made in the body of the function, for example to push/pop
5856 arguments around function calls.  If the qualifier @code{bounded} is also
5857 present, the amount of these adjustments is bounded at compile time and
5858 the second field is an upper bound of the total amount of stack used by
5859 the function.  If it is not present, the amount of these adjustments is
5860 not bounded at compile time and the second field only represents the
5861 bounded part.
5863 @item -fprofile-arcs
5864 @opindex fprofile-arcs
5865 Add code so that program flow @dfn{arcs} are instrumented.  During
5866 execution the program records how many times each branch and call is
5867 executed and how many times it is taken or returns.  When the compiled
5868 program exits it saves this data to a file called
5869 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5870 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5871 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5872 @var{auxname} is generated from the name of the output file, if
5873 explicitly specified and it is not the final executable, otherwise it is
5874 the basename of the source file.  In both cases any suffix is removed
5875 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5876 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5877 @xref{Cross-profiling}.
5879 @cindex @command{gcov}
5880 @item --coverage
5881 @opindex coverage
5883 This option is used to compile and link code instrumented for coverage
5884 analysis.  The option is a synonym for @option{-fprofile-arcs}
5885 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5886 linking).  See the documentation for those options for more details.
5888 @itemize
5890 @item
5891 Compile the source files with @option{-fprofile-arcs} plus optimization
5892 and code generation options.  For test coverage analysis, use the
5893 additional @option{-ftest-coverage} option.  You do not need to profile
5894 every source file in a program.
5896 @item
5897 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5898 (the latter implies the former).
5900 @item
5901 Run the program on a representative workload to generate the arc profile
5902 information.  This may be repeated any number of times.  You can run
5903 concurrent instances of your program, and provided that the file system
5904 supports locking, the data files will be correctly updated.  Also
5905 @code{fork} calls are detected and correctly handled (double counting
5906 will not happen).
5908 @item
5909 For profile-directed optimizations, compile the source files again with
5910 the same optimization and code generation options plus
5911 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5912 Control Optimization}).
5914 @item
5915 For test coverage analysis, use @command{gcov} to produce human readable
5916 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5917 @command{gcov} documentation for further information.
5919 @end itemize
5921 With @option{-fprofile-arcs}, for each function of your program GCC
5922 creates a program flow graph, then finds a spanning tree for the graph.
5923 Only arcs that are not on the spanning tree have to be instrumented: the
5924 compiler adds code to count the number of times that these arcs are
5925 executed.  When an arc is the only exit or only entrance to a block, the
5926 instrumentation code can be added to the block; otherwise, a new basic
5927 block must be created to hold the instrumentation code.
5929 @need 2000
5930 @item -ftest-coverage
5931 @opindex ftest-coverage
5932 Produce a notes file that the @command{gcov} code-coverage utility
5933 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5934 show program coverage.  Each source file's note file is called
5935 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5936 above for a description of @var{auxname} and instructions on how to
5937 generate test coverage data.  Coverage data matches the source files
5938 more closely if you do not optimize.
5940 @item -fdbg-cnt-list
5941 @opindex fdbg-cnt-list
5942 Print the name and the counter upper bound for all debug counters.
5945 @item -fdbg-cnt=@var{counter-value-list}
5946 @opindex fdbg-cnt
5947 Set the internal debug counter upper bound.  @var{counter-value-list}
5948 is a comma-separated list of @var{name}:@var{value} pairs
5949 which sets the upper bound of each debug counter @var{name} to @var{value}.
5950 All debug counters have the initial upper bound of @code{UINT_MAX};
5951 thus @code{dbg_cnt()} returns true always unless the upper bound
5952 is set by this option.
5953 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5954 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5956 @item -fenable-@var{kind}-@var{pass}
5957 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5958 @opindex fdisable-
5959 @opindex fenable-
5961 This is a set of options that are used to explicitly disable/enable
5962 optimization passes.  These options are intended for use for debugging GCC.
5963 Compiler users should use regular options for enabling/disabling
5964 passes instead.
5966 @table @gcctabopt
5968 @item -fdisable-ipa-@var{pass}
5969 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5970 statically invoked in the compiler multiple times, the pass name should be
5971 appended with a sequential number starting from 1.
5973 @item -fdisable-rtl-@var{pass}
5974 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5975 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5976 statically invoked in the compiler multiple times, the pass name should be
5977 appended with a sequential number starting from 1.  @var{range-list} is a 
5978 comma-separated list of function ranges or assembler names.  Each range is a number
5979 pair separated by a colon.  The range is inclusive in both ends.  If the range
5980 is trivial, the number pair can be simplified as a single number.  If the
5981 function's call graph node's @var{uid} falls within one of the specified ranges,
5982 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5983 function header of a dump file, and the pass names can be dumped by using
5984 option @option{-fdump-passes}.
5986 @item -fdisable-tree-@var{pass}
5987 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5988 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5989 option arguments.
5991 @item -fenable-ipa-@var{pass}
5992 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5993 statically invoked in the compiler multiple times, the pass name should be
5994 appended with a sequential number starting from 1.
5996 @item -fenable-rtl-@var{pass}
5997 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5998 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5999 description and examples.
6001 @item -fenable-tree-@var{pass}
6002 @itemx -fenable-tree-@var{pass}=@var{range-list}
6003 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6004 of option arguments.
6006 @end table
6008 Here are some examples showing uses of these options.
6010 @smallexample
6012 # disable ccp1 for all functions
6013    -fdisable-tree-ccp1
6014 # disable complete unroll for function whose cgraph node uid is 1
6015    -fenable-tree-cunroll=1
6016 # disable gcse2 for functions at the following ranges [1,1],
6017 # [300,400], and [400,1000]
6018 # disable gcse2 for functions foo and foo2
6019    -fdisable-rtl-gcse2=foo,foo2
6020 # disable early inlining
6021    -fdisable-tree-einline
6022 # disable ipa inlining
6023    -fdisable-ipa-inline
6024 # enable tree full unroll
6025    -fenable-tree-unroll
6027 @end smallexample
6029 @item -d@var{letters}
6030 @itemx -fdump-rtl-@var{pass}
6031 @itemx -fdump-rtl-@var{pass}=@var{filename}
6032 @opindex d
6033 @opindex fdump-rtl-@var{pass}
6034 Says to make debugging dumps during compilation at times specified by
6035 @var{letters}.  This is used for debugging the RTL-based passes of the
6036 compiler.  The file names for most of the dumps are made by appending
6037 a pass number and a word to the @var{dumpname}, and the files are
6038 created in the directory of the output file. In case of
6039 @option{=@var{filename}} option, the dump is output on the given file
6040 instead of the pass numbered dump files. Note that the pass number is
6041 computed statically as passes get registered into the pass manager.
6042 Thus the numbering is not related to the dynamic order of execution of
6043 passes.  In particular, a pass installed by a plugin could have a
6044 number over 200 even if it executed quite early.  @var{dumpname} is
6045 generated from the name of the output file, if explicitly specified
6046 and it is not an executable, otherwise it is the basename of the
6047 source file. These switches may have different effects when
6048 @option{-E} is used for preprocessing.
6050 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6051 @option{-d} option @var{letters}.  Here are the possible
6052 letters for use in @var{pass} and @var{letters}, and their meanings:
6054 @table @gcctabopt
6056 @item -fdump-rtl-alignments
6057 @opindex fdump-rtl-alignments
6058 Dump after branch alignments have been computed.
6060 @item -fdump-rtl-asmcons
6061 @opindex fdump-rtl-asmcons
6062 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6064 @item -fdump-rtl-auto_inc_dec
6065 @opindex fdump-rtl-auto_inc_dec
6066 Dump after auto-inc-dec discovery.  This pass is only run on
6067 architectures that have auto inc or auto dec instructions.
6069 @item -fdump-rtl-barriers
6070 @opindex fdump-rtl-barriers
6071 Dump after cleaning up the barrier instructions.
6073 @item -fdump-rtl-bbpart
6074 @opindex fdump-rtl-bbpart
6075 Dump after partitioning hot and cold basic blocks.
6077 @item -fdump-rtl-bbro
6078 @opindex fdump-rtl-bbro
6079 Dump after block reordering.
6081 @item -fdump-rtl-btl1
6082 @itemx -fdump-rtl-btl2
6083 @opindex fdump-rtl-btl2
6084 @opindex fdump-rtl-btl2
6085 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6086 after the two branch
6087 target load optimization passes.
6089 @item -fdump-rtl-bypass
6090 @opindex fdump-rtl-bypass
6091 Dump after jump bypassing and control flow optimizations.
6093 @item -fdump-rtl-combine
6094 @opindex fdump-rtl-combine
6095 Dump after the RTL instruction combination pass.
6097 @item -fdump-rtl-compgotos
6098 @opindex fdump-rtl-compgotos
6099 Dump after duplicating the computed gotos.
6101 @item -fdump-rtl-ce1
6102 @itemx -fdump-rtl-ce2
6103 @itemx -fdump-rtl-ce3
6104 @opindex fdump-rtl-ce1
6105 @opindex fdump-rtl-ce2
6106 @opindex fdump-rtl-ce3
6107 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6108 @option{-fdump-rtl-ce3} enable dumping after the three
6109 if conversion passes.
6111 @item -fdump-rtl-cprop_hardreg
6112 @opindex fdump-rtl-cprop_hardreg
6113 Dump after hard register copy propagation.
6115 @item -fdump-rtl-csa
6116 @opindex fdump-rtl-csa
6117 Dump after combining stack adjustments.
6119 @item -fdump-rtl-cse1
6120 @itemx -fdump-rtl-cse2
6121 @opindex fdump-rtl-cse1
6122 @opindex fdump-rtl-cse2
6123 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6124 the two common subexpression elimination passes.
6126 @item -fdump-rtl-dce
6127 @opindex fdump-rtl-dce
6128 Dump after the standalone dead code elimination passes.
6130 @item -fdump-rtl-dbr
6131 @opindex fdump-rtl-dbr
6132 Dump after delayed branch scheduling.
6134 @item -fdump-rtl-dce1
6135 @itemx -fdump-rtl-dce2
6136 @opindex fdump-rtl-dce1
6137 @opindex fdump-rtl-dce2
6138 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6139 the two dead store elimination passes.
6141 @item -fdump-rtl-eh
6142 @opindex fdump-rtl-eh
6143 Dump after finalization of EH handling code.
6145 @item -fdump-rtl-eh_ranges
6146 @opindex fdump-rtl-eh_ranges
6147 Dump after conversion of EH handling range regions.
6149 @item -fdump-rtl-expand
6150 @opindex fdump-rtl-expand
6151 Dump after RTL generation.
6153 @item -fdump-rtl-fwprop1
6154 @itemx -fdump-rtl-fwprop2
6155 @opindex fdump-rtl-fwprop1
6156 @opindex fdump-rtl-fwprop2
6157 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6158 dumping after the two forward propagation passes.
6160 @item -fdump-rtl-gcse1
6161 @itemx -fdump-rtl-gcse2
6162 @opindex fdump-rtl-gcse1
6163 @opindex fdump-rtl-gcse2
6164 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6165 after global common subexpression elimination.
6167 @item -fdump-rtl-init-regs
6168 @opindex fdump-rtl-init-regs
6169 Dump after the initialization of the registers.
6171 @item -fdump-rtl-initvals
6172 @opindex fdump-rtl-initvals
6173 Dump after the computation of the initial value sets.
6175 @item -fdump-rtl-into_cfglayout
6176 @opindex fdump-rtl-into_cfglayout
6177 Dump after converting to cfglayout mode.
6179 @item -fdump-rtl-ira
6180 @opindex fdump-rtl-ira
6181 Dump after iterated register allocation.
6183 @item -fdump-rtl-jump
6184 @opindex fdump-rtl-jump
6185 Dump after the second jump optimization.
6187 @item -fdump-rtl-loop2
6188 @opindex fdump-rtl-loop2
6189 @option{-fdump-rtl-loop2} enables dumping after the rtl
6190 loop optimization passes.
6192 @item -fdump-rtl-mach
6193 @opindex fdump-rtl-mach
6194 Dump after performing the machine dependent reorganization pass, if that
6195 pass exists.
6197 @item -fdump-rtl-mode_sw
6198 @opindex fdump-rtl-mode_sw
6199 Dump after removing redundant mode switches.
6201 @item -fdump-rtl-rnreg
6202 @opindex fdump-rtl-rnreg
6203 Dump after register renumbering.
6205 @item -fdump-rtl-outof_cfglayout
6206 @opindex fdump-rtl-outof_cfglayout
6207 Dump after converting from cfglayout mode.
6209 @item -fdump-rtl-peephole2
6210 @opindex fdump-rtl-peephole2
6211 Dump after the peephole pass.
6213 @item -fdump-rtl-postreload
6214 @opindex fdump-rtl-postreload
6215 Dump after post-reload optimizations.
6217 @item -fdump-rtl-pro_and_epilogue
6218 @opindex fdump-rtl-pro_and_epilogue
6219 Dump after generating the function prologues and epilogues.
6221 @item -fdump-rtl-sched1
6222 @itemx -fdump-rtl-sched2
6223 @opindex fdump-rtl-sched1
6224 @opindex fdump-rtl-sched2
6225 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6226 after the basic block scheduling passes.
6228 @item -fdump-rtl-ree
6229 @opindex fdump-rtl-ree
6230 Dump after sign/zero extension elimination.
6232 @item -fdump-rtl-seqabstr
6233 @opindex fdump-rtl-seqabstr
6234 Dump after common sequence discovery.
6236 @item -fdump-rtl-shorten
6237 @opindex fdump-rtl-shorten
6238 Dump after shortening branches.
6240 @item -fdump-rtl-sibling
6241 @opindex fdump-rtl-sibling
6242 Dump after sibling call optimizations.
6244 @item -fdump-rtl-split1
6245 @itemx -fdump-rtl-split2
6246 @itemx -fdump-rtl-split3
6247 @itemx -fdump-rtl-split4
6248 @itemx -fdump-rtl-split5
6249 @opindex fdump-rtl-split1
6250 @opindex fdump-rtl-split2
6251 @opindex fdump-rtl-split3
6252 @opindex fdump-rtl-split4
6253 @opindex fdump-rtl-split5
6254 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6255 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6256 @option{-fdump-rtl-split5} enable dumping after five rounds of
6257 instruction splitting.
6259 @item -fdump-rtl-sms
6260 @opindex fdump-rtl-sms
6261 Dump after modulo scheduling.  This pass is only run on some
6262 architectures.
6264 @item -fdump-rtl-stack
6265 @opindex fdump-rtl-stack
6266 Dump after conversion from GCC's ``flat register file'' registers to the
6267 x87's stack-like registers.  This pass is only run on x86 variants.
6269 @item -fdump-rtl-subreg1
6270 @itemx -fdump-rtl-subreg2
6271 @opindex fdump-rtl-subreg1
6272 @opindex fdump-rtl-subreg2
6273 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6274 the two subreg expansion passes.
6276 @item -fdump-rtl-unshare
6277 @opindex fdump-rtl-unshare
6278 Dump after all rtl has been unshared.
6280 @item -fdump-rtl-vartrack
6281 @opindex fdump-rtl-vartrack
6282 Dump after variable tracking.
6284 @item -fdump-rtl-vregs
6285 @opindex fdump-rtl-vregs
6286 Dump after converting virtual registers to hard registers.
6288 @item -fdump-rtl-web
6289 @opindex fdump-rtl-web
6290 Dump after live range splitting.
6292 @item -fdump-rtl-regclass
6293 @itemx -fdump-rtl-subregs_of_mode_init
6294 @itemx -fdump-rtl-subregs_of_mode_finish
6295 @itemx -fdump-rtl-dfinit
6296 @itemx -fdump-rtl-dfinish
6297 @opindex fdump-rtl-regclass
6298 @opindex fdump-rtl-subregs_of_mode_init
6299 @opindex fdump-rtl-subregs_of_mode_finish
6300 @opindex fdump-rtl-dfinit
6301 @opindex fdump-rtl-dfinish
6302 These dumps are defined but always produce empty files.
6304 @item -da
6305 @itemx -fdump-rtl-all
6306 @opindex da
6307 @opindex fdump-rtl-all
6308 Produce all the dumps listed above.
6310 @item -dA
6311 @opindex dA
6312 Annotate the assembler output with miscellaneous debugging information.
6314 @item -dD
6315 @opindex dD
6316 Dump all macro definitions, at the end of preprocessing, in addition to
6317 normal output.
6319 @item -dH
6320 @opindex dH
6321 Produce a core dump whenever an error occurs.
6323 @item -dp
6324 @opindex dp
6325 Annotate the assembler output with a comment indicating which
6326 pattern and alternative is used.  The length of each instruction is
6327 also printed.
6329 @item -dP
6330 @opindex dP
6331 Dump the RTL in the assembler output as a comment before each instruction.
6332 Also turns on @option{-dp} annotation.
6334 @item -dx
6335 @opindex dx
6336 Just generate RTL for a function instead of compiling it.  Usually used
6337 with @option{-fdump-rtl-expand}.
6338 @end table
6340 @item -fdump-noaddr
6341 @opindex fdump-noaddr
6342 When doing debugging dumps, suppress address output.  This makes it more
6343 feasible to use diff on debugging dumps for compiler invocations with
6344 different compiler binaries and/or different
6345 text / bss / data / heap / stack / dso start locations.
6347 @item -freport-bug
6348 @opindex freport-bug
6349 Collect and dump debug information into temporary file if ICE in C/C++
6350 compiler occured.
6352 @item -fdump-unnumbered
6353 @opindex fdump-unnumbered
6354 When doing debugging dumps, suppress instruction numbers and address output.
6355 This makes it more feasible to use diff on debugging dumps for compiler
6356 invocations with different options, in particular with and without
6357 @option{-g}.
6359 @item -fdump-unnumbered-links
6360 @opindex fdump-unnumbered-links
6361 When doing debugging dumps (see @option{-d} option above), suppress
6362 instruction numbers for the links to the previous and next instructions
6363 in a sequence.
6365 @item -fdump-translation-unit @r{(C++ only)}
6366 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6367 @opindex fdump-translation-unit
6368 Dump a representation of the tree structure for the entire translation
6369 unit to a file.  The file name is made by appending @file{.tu} to the
6370 source file name, and the file is created in the same directory as the
6371 output file.  If the @samp{-@var{options}} form is used, @var{options}
6372 controls the details of the dump as described for the
6373 @option{-fdump-tree} options.
6375 @item -fdump-class-hierarchy @r{(C++ only)}
6376 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6377 @opindex fdump-class-hierarchy
6378 Dump a representation of each class's hierarchy and virtual function
6379 table layout to a file.  The file name is made by appending
6380 @file{.class} to the source file name, and the file is created in the
6381 same directory as the output file.  If the @samp{-@var{options}} form
6382 is used, @var{options} controls the details of the dump as described
6383 for the @option{-fdump-tree} options.
6385 @item -fdump-ipa-@var{switch}
6386 @opindex fdump-ipa
6387 Control the dumping at various stages of inter-procedural analysis
6388 language tree to a file.  The file name is generated by appending a
6389 switch specific suffix to the source file name, and the file is created
6390 in the same directory as the output file.  The following dumps are
6391 possible:
6393 @table @samp
6394 @item all
6395 Enables all inter-procedural analysis dumps.
6397 @item cgraph
6398 Dumps information about call-graph optimization, unused function removal,
6399 and inlining decisions.
6401 @item inline
6402 Dump after function inlining.
6404 @end table
6406 @item -fdump-passes
6407 @opindex fdump-passes
6408 Dump the list of optimization passes that are turned on and off by
6409 the current command-line options.
6411 @item -fdump-statistics-@var{option}
6412 @opindex fdump-statistics
6413 Enable and control dumping of pass statistics in a separate file.  The
6414 file name is generated by appending a suffix ending in
6415 @samp{.statistics} to the source file name, and the file is created in
6416 the same directory as the output file.  If the @samp{-@var{option}}
6417 form is used, @samp{-stats} causes counters to be summed over the
6418 whole compilation unit while @samp{-details} dumps every event as
6419 the passes generate them.  The default with no option is to sum
6420 counters for each function compiled.
6422 @item -fdump-tree-@var{switch}
6423 @itemx -fdump-tree-@var{switch}-@var{options}
6424 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6425 @opindex fdump-tree
6426 Control the dumping at various stages of processing the intermediate
6427 language tree to a file.  The file name is generated by appending a
6428 switch-specific suffix to the source file name, and the file is
6429 created in the same directory as the output file. In case of
6430 @option{=@var{filename}} option, the dump is output on the given file
6431 instead of the auto named dump files.  If the @samp{-@var{options}}
6432 form is used, @var{options} is a list of @samp{-} separated options
6433 which control the details of the dump.  Not all options are applicable
6434 to all dumps; those that are not meaningful are ignored.  The
6435 following options are available
6437 @table @samp
6438 @item address
6439 Print the address of each node.  Usually this is not meaningful as it
6440 changes according to the environment and source file.  Its primary use
6441 is for tying up a dump file with a debug environment.
6442 @item asmname
6443 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6444 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6445 use working backward from mangled names in the assembly file.
6446 @item slim
6447 When dumping front-end intermediate representations, inhibit dumping
6448 of members of a scope or body of a function merely because that scope
6449 has been reached.  Only dump such items when they are directly reachable
6450 by some other path.
6452 When dumping pretty-printed trees, this option inhibits dumping the
6453 bodies of control structures.
6455 When dumping RTL, print the RTL in slim (condensed) form instead of
6456 the default LISP-like representation.
6457 @item raw
6458 Print a raw representation of the tree.  By default, trees are
6459 pretty-printed into a C-like representation.
6460 @item details
6461 Enable more detailed dumps (not honored by every dump option). Also
6462 include information from the optimization passes.
6463 @item stats
6464 Enable dumping various statistics about the pass (not honored by every dump
6465 option).
6466 @item blocks
6467 Enable showing basic block boundaries (disabled in raw dumps).
6468 @item graph
6469 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6470 dump a representation of the control flow graph suitable for viewing with
6471 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6472 the file is pretty-printed as a subgraph, so that GraphViz can render them
6473 all in a single plot.
6475 This option currently only works for RTL dumps, and the RTL is always
6476 dumped in slim form.
6477 @item vops
6478 Enable showing virtual operands for every statement.
6479 @item lineno
6480 Enable showing line numbers for statements.
6481 @item uid
6482 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6483 @item verbose
6484 Enable showing the tree dump for each statement.
6485 @item eh
6486 Enable showing the EH region number holding each statement.
6487 @item scev
6488 Enable showing scalar evolution analysis details.
6489 @item optimized
6490 Enable showing optimization information (only available in certain
6491 passes).
6492 @item missed
6493 Enable showing missed optimization information (only available in certain
6494 passes).
6495 @item note
6496 Enable other detailed optimization information (only available in
6497 certain passes).
6498 @item =@var{filename}
6499 Instead of an auto named dump file, output into the given file
6500 name. The file names @file{stdout} and @file{stderr} are treated
6501 specially and are considered already open standard streams. For
6502 example,
6504 @smallexample
6505 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6506      -fdump-tree-pre=stderr file.c
6507 @end smallexample
6509 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6510 output on to @file{stderr}. If two conflicting dump filenames are
6511 given for the same pass, then the latter option overrides the earlier
6512 one.
6514 @item all
6515 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6516 and @option{lineno}.
6518 @item optall
6519 Turn on all optimization options, i.e., @option{optimized},
6520 @option{missed}, and @option{note}.
6521 @end table
6523 The following tree dumps are possible:
6524 @table @samp
6526 @item original
6527 @opindex fdump-tree-original
6528 Dump before any tree based optimization, to @file{@var{file}.original}.
6530 @item optimized
6531 @opindex fdump-tree-optimized
6532 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6534 @item gimple
6535 @opindex fdump-tree-gimple
6536 Dump each function before and after the gimplification pass to a file.  The
6537 file name is made by appending @file{.gimple} to the source file name.
6539 @item cfg
6540 @opindex fdump-tree-cfg
6541 Dump the control flow graph of each function to a file.  The file name is
6542 made by appending @file{.cfg} to the source file name.
6544 @item ch
6545 @opindex fdump-tree-ch
6546 Dump each function after copying loop headers.  The file name is made by
6547 appending @file{.ch} to the source file name.
6549 @item ssa
6550 @opindex fdump-tree-ssa
6551 Dump SSA related information to a file.  The file name is made by appending
6552 @file{.ssa} to the source file name.
6554 @item alias
6555 @opindex fdump-tree-alias
6556 Dump aliasing information for each function.  The file name is made by
6557 appending @file{.alias} to the source file name.
6559 @item ccp
6560 @opindex fdump-tree-ccp
6561 Dump each function after CCP@.  The file name is made by appending
6562 @file{.ccp} to the source file name.
6564 @item storeccp
6565 @opindex fdump-tree-storeccp
6566 Dump each function after STORE-CCP@.  The file name is made by appending
6567 @file{.storeccp} to the source file name.
6569 @item pre
6570 @opindex fdump-tree-pre
6571 Dump trees after partial redundancy elimination.  The file name is made
6572 by appending @file{.pre} to the source file name.
6574 @item fre
6575 @opindex fdump-tree-fre
6576 Dump trees after full redundancy elimination.  The file name is made
6577 by appending @file{.fre} to the source file name.
6579 @item copyprop
6580 @opindex fdump-tree-copyprop
6581 Dump trees after copy propagation.  The file name is made
6582 by appending @file{.copyprop} to the source file name.
6584 @item store_copyprop
6585 @opindex fdump-tree-store_copyprop
6586 Dump trees after store copy-propagation.  The file name is made
6587 by appending @file{.store_copyprop} to the source file name.
6589 @item dce
6590 @opindex fdump-tree-dce
6591 Dump each function after dead code elimination.  The file name is made by
6592 appending @file{.dce} to the source file name.
6594 @item sra
6595 @opindex fdump-tree-sra
6596 Dump each function after performing scalar replacement of aggregates.  The
6597 file name is made by appending @file{.sra} to the source file name.
6599 @item sink
6600 @opindex fdump-tree-sink
6601 Dump each function after performing code sinking.  The file name is made
6602 by appending @file{.sink} to the source file name.
6604 @item dom
6605 @opindex fdump-tree-dom
6606 Dump each function after applying dominator tree optimizations.  The file
6607 name is made by appending @file{.dom} to the source file name.
6609 @item dse
6610 @opindex fdump-tree-dse
6611 Dump each function after applying dead store elimination.  The file
6612 name is made by appending @file{.dse} to the source file name.
6614 @item phiopt
6615 @opindex fdump-tree-phiopt
6616 Dump each function after optimizing PHI nodes into straightline code.  The file
6617 name is made by appending @file{.phiopt} to the source file name.
6619 @item forwprop
6620 @opindex fdump-tree-forwprop
6621 Dump each function after forward propagating single use variables.  The file
6622 name is made by appending @file{.forwprop} to the source file name.
6624 @item copyrename
6625 @opindex fdump-tree-copyrename
6626 Dump each function after applying the copy rename optimization.  The file
6627 name is made by appending @file{.copyrename} to the source file name.
6629 @item nrv
6630 @opindex fdump-tree-nrv
6631 Dump each function after applying the named return value optimization on
6632 generic trees.  The file name is made by appending @file{.nrv} to the source
6633 file name.
6635 @item vect
6636 @opindex fdump-tree-vect
6637 Dump each function after applying vectorization of loops.  The file name is
6638 made by appending @file{.vect} to the source file name.
6640 @item slp
6641 @opindex fdump-tree-slp
6642 Dump each function after applying vectorization of basic blocks.  The file name
6643 is made by appending @file{.slp} to the source file name.
6645 @item vrp
6646 @opindex fdump-tree-vrp
6647 Dump each function after Value Range Propagation (VRP).  The file name
6648 is made by appending @file{.vrp} to the source file name.
6650 @item all
6651 @opindex fdump-tree-all
6652 Enable all the available tree dumps with the flags provided in this option.
6653 @end table
6655 @item -fopt-info
6656 @itemx -fopt-info-@var{options}
6657 @itemx -fopt-info-@var{options}=@var{filename}
6658 @opindex fopt-info
6659 Controls optimization dumps from various optimization passes. If the
6660 @samp{-@var{options}} form is used, @var{options} is a list of
6661 @samp{-} separated options to select the dump details and
6662 optimizations.  If @var{options} is not specified, it defaults to
6663 @option{optimized} for details and @option{optall} for optimization
6664 groups. If the @var{filename} is not specified, it defaults to
6665 @file{stderr}. Note that the output @var{filename} will be overwritten
6666 in case of multiple translation units. If a combined output from
6667 multiple translation units is desired, @file{stderr} should be used
6668 instead.
6670 The options can be divided into two groups, 1) options describing the
6671 verbosity of the dump, and 2) options describing which optimizations
6672 should be included. The options from both the groups can be freely
6673 mixed as they are non-overlapping. However, in case of any conflicts,
6674 the latter options override the earlier options on the command
6675 line. Though multiple -fopt-info options are accepted, only one of
6676 them can have @option{=filename}. If other filenames are provided then
6677 all but the first one are ignored.
6679 The dump verbosity has the following options
6681 @table @samp
6682 @item optimized
6683 Print information when an optimization is successfully applied. It is
6684 up to a pass to decide which information is relevant. For example, the
6685 vectorizer passes print the source location of loops which got
6686 successfully vectorized.
6687 @item missed
6688 Print information about missed optimizations. Individual passes
6689 control which information to include in the output. For example,
6691 @smallexample
6692 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6693 @end smallexample
6695 will print information about missed optimization opportunities from
6696 vectorization passes on stderr.
6697 @item note
6698 Print verbose information about optimizations, such as certain
6699 transformations, more detailed messages about decisions etc.
6700 @item all
6701 Print detailed optimization information. This includes
6702 @var{optimized}, @var{missed}, and @var{note}.
6703 @end table
6705 The second set of options describes a group of optimizations and may
6706 include one or more of the following.
6708 @table @samp
6709 @item ipa
6710 Enable dumps from all interprocedural optimizations.
6711 @item loop
6712 Enable dumps from all loop optimizations.
6713 @item inline
6714 Enable dumps from all inlining optimizations.
6715 @item vec
6716 Enable dumps from all vectorization optimizations.
6717 @item optall
6718 Enable dumps from all optimizations. This is a superset of
6719 the optimization groups listed above.
6720 @end table
6722 For example,
6723 @smallexample
6724 gcc -O3 -fopt-info-missed=missed.all
6725 @end smallexample
6727 outputs missed optimization report from all the passes into
6728 @file{missed.all}.
6730 As another example,
6731 @smallexample
6732 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6733 @end smallexample
6735 will output information about missed optimizations as well as
6736 optimized locations from all the inlining passes into
6737 @file{inline.txt}.
6739 If the @var{filename} is provided, then the dumps from all the
6740 applicable optimizations are concatenated into the @file{filename}.
6741 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6742 omitted, it defaults to @option{all-optall}, which means dump all
6743 available optimization info from all the passes. In the following
6744 example, all optimization info is output on to @file{stderr}.
6746 @smallexample
6747 gcc -O3 -fopt-info
6748 @end smallexample
6750 Note that @option{-fopt-info-vec-missed} behaves the same as
6751 @option{-fopt-info-missed-vec}.
6753 As another example, consider
6755 @smallexample
6756 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6757 @end smallexample
6759 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6760 in conflict since only one output file is allowed. In this case, only
6761 the first option takes effect and the subsequent options are
6762 ignored. Thus only the @file{vec.miss} is produced which contains
6763 dumps from the vectorizer about missed opportunities.
6765 @item -frandom-seed=@var{string}
6766 @opindex frandom-seed
6767 This option provides a seed that GCC uses in place of
6768 random numbers in generating certain symbol names
6769 that have to be different in every compiled file.  It is also used to
6770 place unique stamps in coverage data files and the object files that
6771 produce them.  You can use the @option{-frandom-seed} option to produce
6772 reproducibly identical object files.
6774 The @var{string} should be different for every file you compile.
6776 @item -fsched-verbose=@var{n}
6777 @opindex fsched-verbose
6778 On targets that use instruction scheduling, this option controls the
6779 amount of debugging output the scheduler prints.  This information is
6780 written to standard error, unless @option{-fdump-rtl-sched1} or
6781 @option{-fdump-rtl-sched2} is specified, in which case it is output
6782 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6783 respectively.  However for @var{n} greater than nine, the output is
6784 always printed to standard error.
6786 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6787 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6788 For @var{n} greater than one, it also output basic block probabilities,
6789 detailed ready list information and unit/insn info.  For @var{n} greater
6790 than two, it includes RTL at abort point, control-flow and regions info.
6791 And for @var{n} over four, @option{-fsched-verbose} also includes
6792 dependence info.
6794 @item -save-temps
6795 @itemx -save-temps=cwd
6796 @opindex save-temps
6797 Store the usual ``temporary'' intermediate files permanently; place them
6798 in the current directory and name them based on the source file.  Thus,
6799 compiling @file{foo.c} with @option{-c -save-temps} produces files
6800 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6801 preprocessed @file{foo.i} output file even though the compiler now
6802 normally uses an integrated preprocessor.
6804 When used in combination with the @option{-x} command-line option,
6805 @option{-save-temps} is sensible enough to avoid over writing an
6806 input source file with the same extension as an intermediate file.
6807 The corresponding intermediate file may be obtained by renaming the
6808 source file before using @option{-save-temps}.
6810 If you invoke GCC in parallel, compiling several different source
6811 files that share a common base name in different subdirectories or the
6812 same source file compiled for multiple output destinations, it is
6813 likely that the different parallel compilers will interfere with each
6814 other, and overwrite the temporary files.  For instance:
6816 @smallexample
6817 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6818 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6819 @end smallexample
6821 may result in @file{foo.i} and @file{foo.o} being written to
6822 simultaneously by both compilers.
6824 @item -save-temps=obj
6825 @opindex save-temps=obj
6826 Store the usual ``temporary'' intermediate files permanently.  If the
6827 @option{-o} option is used, the temporary files are based on the
6828 object file.  If the @option{-o} option is not used, the
6829 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6831 For example:
6833 @smallexample
6834 gcc -save-temps=obj -c foo.c
6835 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6836 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6837 @end smallexample
6839 @noindent
6840 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6841 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6842 @file{dir2/yfoobar.o}.
6844 @item -time@r{[}=@var{file}@r{]}
6845 @opindex time
6846 Report the CPU time taken by each subprocess in the compilation
6847 sequence.  For C source files, this is the compiler proper and assembler
6848 (plus the linker if linking is done).
6850 Without the specification of an output file, the output looks like this:
6852 @smallexample
6853 # cc1 0.12 0.01
6854 # as 0.00 0.01
6855 @end smallexample
6857 The first number on each line is the ``user time'', that is time spent
6858 executing the program itself.  The second number is ``system time'',
6859 time spent executing operating system routines on behalf of the program.
6860 Both numbers are in seconds.
6862 With the specification of an output file, the output is appended to the
6863 named file, and it looks like this:
6865 @smallexample
6866 0.12 0.01 cc1 @var{options}
6867 0.00 0.01 as @var{options}
6868 @end smallexample
6870 The ``user time'' and the ``system time'' are moved before the program
6871 name, and the options passed to the program are displayed, so that one
6872 can later tell what file was being compiled, and with which options.
6874 @item -fvar-tracking
6875 @opindex fvar-tracking
6876 Run variable tracking pass.  It computes where variables are stored at each
6877 position in code.  Better debugging information is then generated
6878 (if the debugging information format supports this information).
6880 It is enabled by default when compiling with optimization (@option{-Os},
6881 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6882 the debug info format supports it.
6884 @item -fvar-tracking-assignments
6885 @opindex fvar-tracking-assignments
6886 @opindex fno-var-tracking-assignments
6887 Annotate assignments to user variables early in the compilation and
6888 attempt to carry the annotations over throughout the compilation all the
6889 way to the end, in an attempt to improve debug information while
6890 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6892 It can be enabled even if var-tracking is disabled, in which case
6893 annotations are created and maintained, but discarded at the end.
6895 @item -fvar-tracking-assignments-toggle
6896 @opindex fvar-tracking-assignments-toggle
6897 @opindex fno-var-tracking-assignments-toggle
6898 Toggle @option{-fvar-tracking-assignments}, in the same way that
6899 @option{-gtoggle} toggles @option{-g}.
6901 @item -print-file-name=@var{library}
6902 @opindex print-file-name
6903 Print the full absolute name of the library file @var{library} that
6904 would be used when linking---and don't do anything else.  With this
6905 option, GCC does not compile or link anything; it just prints the
6906 file name.
6908 @item -print-multi-directory
6909 @opindex print-multi-directory
6910 Print the directory name corresponding to the multilib selected by any
6911 other switches present in the command line.  This directory is supposed
6912 to exist in @env{GCC_EXEC_PREFIX}.
6914 @item -print-multi-lib
6915 @opindex print-multi-lib
6916 Print the mapping from multilib directory names to compiler switches
6917 that enable them.  The directory name is separated from the switches by
6918 @samp{;}, and each switch starts with an @samp{@@} instead of the
6919 @samp{-}, without spaces between multiple switches.  This is supposed to
6920 ease shell processing.
6922 @item -print-multi-os-directory
6923 @opindex print-multi-os-directory
6924 Print the path to OS libraries for the selected
6925 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6926 present in the @file{lib} subdirectory and no multilibs are used, this is
6927 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6928 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6929 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6930 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6932 @item -print-multiarch
6933 @opindex print-multiarch
6934 Print the path to OS libraries for the selected multiarch,
6935 relative to some @file{lib} subdirectory.
6937 @item -print-prog-name=@var{program}
6938 @opindex print-prog-name
6939 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6941 @item -print-libgcc-file-name
6942 @opindex print-libgcc-file-name
6943 Same as @option{-print-file-name=libgcc.a}.
6945 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6946 but you do want to link with @file{libgcc.a}.  You can do:
6948 @smallexample
6949 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6950 @end smallexample
6952 @item -print-search-dirs
6953 @opindex print-search-dirs
6954 Print the name of the configured installation directory and a list of
6955 program and library directories @command{gcc} searches---and don't do anything else.
6957 This is useful when @command{gcc} prints the error message
6958 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6959 To resolve this you either need to put @file{cpp0} and the other compiler
6960 components where @command{gcc} expects to find them, or you can set the environment
6961 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6962 Don't forget the trailing @samp{/}.
6963 @xref{Environment Variables}.
6965 @item -print-sysroot
6966 @opindex print-sysroot
6967 Print the target sysroot directory that is used during
6968 compilation.  This is the target sysroot specified either at configure
6969 time or using the @option{--sysroot} option, possibly with an extra
6970 suffix that depends on compilation options.  If no target sysroot is
6971 specified, the option prints nothing.
6973 @item -print-sysroot-headers-suffix
6974 @opindex print-sysroot-headers-suffix
6975 Print the suffix added to the target sysroot when searching for
6976 headers, or give an error if the compiler is not configured with such
6977 a suffix---and don't do anything else.
6979 @item -dumpmachine
6980 @opindex dumpmachine
6981 Print the compiler's target machine (for example,
6982 @samp{i686-pc-linux-gnu})---and don't do anything else.
6984 @item -dumpversion
6985 @opindex dumpversion
6986 Print the compiler version (for example, @samp{3.0})---and don't do
6987 anything else.
6989 @item -dumpspecs
6990 @opindex dumpspecs
6991 Print the compiler's built-in specs---and don't do anything else.  (This
6992 is used when GCC itself is being built.)  @xref{Spec Files}.
6994 @item -fno-eliminate-unused-debug-types
6995 @opindex feliminate-unused-debug-types
6996 @opindex fno-eliminate-unused-debug-types
6997 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6998 output for types that are nowhere used in the source file being compiled.
6999 Sometimes it is useful to have GCC emit debugging
7000 information for all types declared in a compilation
7001 unit, regardless of whether or not they are actually used
7002 in that compilation unit, for example 
7003 if, in the debugger, you want to cast a value to a type that is
7004 not actually used in your program (but is declared).  More often,
7005 however, this results in a significant amount of wasted space.
7006 @end table
7008 @node Optimize Options
7009 @section Options That Control Optimization
7010 @cindex optimize options
7011 @cindex options, optimization
7013 These options control various sorts of optimizations.
7015 Without any optimization option, the compiler's goal is to reduce the
7016 cost of compilation and to make debugging produce the expected
7017 results.  Statements are independent: if you stop the program with a
7018 breakpoint between statements, you can then assign a new value to any
7019 variable or change the program counter to any other statement in the
7020 function and get exactly the results you expect from the source
7021 code.
7023 Turning on optimization flags makes the compiler attempt to improve
7024 the performance and/or code size at the expense of compilation time
7025 and possibly the ability to debug the program.
7027 The compiler performs optimization based on the knowledge it has of the
7028 program.  Compiling multiple files at once to a single output file mode allows
7029 the compiler to use information gained from all of the files when compiling
7030 each of them.
7032 Not all optimizations are controlled directly by a flag.  Only
7033 optimizations that have a flag are listed in this section.
7035 Most optimizations are only enabled if an @option{-O} level is set on
7036 the command line.  Otherwise they are disabled, even if individual
7037 optimization flags are specified.
7039 Depending on the target and how GCC was configured, a slightly different
7040 set of optimizations may be enabled at each @option{-O} level than
7041 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7042 to find out the exact set of optimizations that are enabled at each level.
7043 @xref{Overall Options}, for examples.
7045 @table @gcctabopt
7046 @item -O
7047 @itemx -O1
7048 @opindex O
7049 @opindex O1
7050 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7051 more memory for a large function.
7053 With @option{-O}, the compiler tries to reduce code size and execution
7054 time, without performing any optimizations that take a great deal of
7055 compilation time.
7057 @option{-O} turns on the following optimization flags:
7058 @gccoptlist{
7059 -fauto-inc-dec @gol
7060 -fbranch-count-reg @gol
7061 -fcombine-stack-adjustments @gol
7062 -fcompare-elim @gol
7063 -fcprop-registers @gol
7064 -fdce @gol
7065 -fdefer-pop @gol
7066 -fdelayed-branch @gol
7067 -fdse @gol
7068 -fforward-propagate @gol
7069 -fguess-branch-probability @gol
7070 -fif-conversion2 @gol
7071 -fif-conversion @gol
7072 -finline-functions-called-once @gol
7073 -fipa-pure-const @gol
7074 -fipa-profile @gol
7075 -fipa-reference @gol
7076 -fmerge-constants @gol
7077 -fmove-loop-invariants @gol
7078 -fshrink-wrap @gol
7079 -fsplit-wide-types @gol
7080 -ftree-bit-ccp @gol
7081 -ftree-ccp @gol
7082 -fssa-phiopt @gol
7083 -ftree-ch @gol
7084 -ftree-copy-prop @gol
7085 -ftree-copyrename @gol
7086 -ftree-dce @gol
7087 -ftree-dominator-opts @gol
7088 -ftree-dse @gol
7089 -ftree-forwprop @gol
7090 -ftree-fre @gol
7091 -ftree-phiprop @gol
7092 -ftree-sink @gol
7093 -ftree-slsr @gol
7094 -ftree-sra @gol
7095 -ftree-pta @gol
7096 -ftree-ter @gol
7097 -funit-at-a-time}
7099 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7100 where doing so does not interfere with debugging.
7102 @item -O2
7103 @opindex O2
7104 Optimize even more.  GCC performs nearly all supported optimizations
7105 that do not involve a space-speed tradeoff.
7106 As compared to @option{-O}, this option increases both compilation time
7107 and the performance of the generated code.
7109 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7110 also turns on the following optimization flags:
7111 @gccoptlist{-fthread-jumps @gol
7112 -falign-functions  -falign-jumps @gol
7113 -falign-loops  -falign-labels @gol
7114 -fcaller-saves @gol
7115 -fcrossjumping @gol
7116 -fcse-follow-jumps  -fcse-skip-blocks @gol
7117 -fdelete-null-pointer-checks @gol
7118 -fdevirtualize -fdevirtualize-speculatively @gol
7119 -fexpensive-optimizations @gol
7120 -fgcse  -fgcse-lm  @gol
7121 -fhoist-adjacent-loads @gol
7122 -finline-small-functions @gol
7123 -findirect-inlining @gol
7124 -fipa-cp @gol
7125 -fipa-sra @gol
7126 -fisolate-erroneous-paths-dereference @gol
7127 -foptimize-sibling-calls @gol
7128 -foptimize-strlen @gol
7129 -fpartial-inlining @gol
7130 -fpeephole2 @gol
7131 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7132 -frerun-cse-after-loop  @gol
7133 -fsched-interblock  -fsched-spec @gol
7134 -fschedule-insns  -fschedule-insns2 @gol
7135 -fstrict-aliasing -fstrict-overflow @gol
7136 -ftree-builtin-call-dce @gol
7137 -ftree-switch-conversion -ftree-tail-merge @gol
7138 -ftree-pre @gol
7139 -ftree-vrp @gol
7140 -fuse-caller-save}
7142 Please note the warning under @option{-fgcse} about
7143 invoking @option{-O2} on programs that use computed gotos.
7145 @item -O3
7146 @opindex O3
7147 Optimize yet more.  @option{-O3} turns on all optimizations specified
7148 by @option{-O2} and also turns on the @option{-finline-functions},
7149 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7150 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7151 @option{-ftree-loop-distribute-patterns},
7152 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7153 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7155 @item -O0
7156 @opindex O0
7157 Reduce compilation time and make debugging produce the expected
7158 results.  This is the default.
7160 @item -Os
7161 @opindex Os
7162 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7163 do not typically increase code size.  It also performs further
7164 optimizations designed to reduce code size.
7166 @option{-Os} disables the following optimization flags:
7167 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7168 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7169 -fprefetch-loop-arrays}
7171 @item -Ofast
7172 @opindex Ofast
7173 Disregard strict standards compliance.  @option{-Ofast} enables all
7174 @option{-O3} optimizations.  It also enables optimizations that are not
7175 valid for all standard-compliant programs.
7176 It turns on @option{-ffast-math} and the Fortran-specific
7177 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7179 @item -Og
7180 @opindex Og
7181 Optimize debugging experience.  @option{-Og} enables optimizations
7182 that do not interfere with debugging. It should be the optimization
7183 level of choice for the standard edit-compile-debug cycle, offering
7184 a reasonable level of optimization while maintaining fast compilation
7185 and a good debugging experience.
7187 If you use multiple @option{-O} options, with or without level numbers,
7188 the last such option is the one that is effective.
7189 @end table
7191 Options of the form @option{-f@var{flag}} specify machine-independent
7192 flags.  Most flags have both positive and negative forms; the negative
7193 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7194 below, only one of the forms is listed---the one you typically 
7195 use.  You can figure out the other form by either removing @samp{no-}
7196 or adding it.
7198 The following options control specific optimizations.  They are either
7199 activated by @option{-O} options or are related to ones that are.  You
7200 can use the following flags in the rare cases when ``fine-tuning'' of
7201 optimizations to be performed is desired.
7203 @table @gcctabopt
7204 @item -fno-defer-pop
7205 @opindex fno-defer-pop
7206 Always pop the arguments to each function call as soon as that function
7207 returns.  For machines that must pop arguments after a function call,
7208 the compiler normally lets arguments accumulate on the stack for several
7209 function calls and pops them all at once.
7211 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7213 @item -fforward-propagate
7214 @opindex fforward-propagate
7215 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7216 instructions and checks if the result can be simplified.  If loop unrolling
7217 is active, two passes are performed and the second is scheduled after
7218 loop unrolling.
7220 This option is enabled by default at optimization levels @option{-O},
7221 @option{-O2}, @option{-O3}, @option{-Os}.
7223 @item -ffp-contract=@var{style}
7224 @opindex ffp-contract
7225 @option{-ffp-contract=off} disables floating-point expression contraction.
7226 @option{-ffp-contract=fast} enables floating-point expression contraction
7227 such as forming of fused multiply-add operations if the target has
7228 native support for them.
7229 @option{-ffp-contract=on} enables floating-point expression contraction
7230 if allowed by the language standard.  This is currently not implemented
7231 and treated equal to @option{-ffp-contract=off}.
7233 The default is @option{-ffp-contract=fast}.
7235 @item -fomit-frame-pointer
7236 @opindex fomit-frame-pointer
7237 Don't keep the frame pointer in a register for functions that
7238 don't need one.  This avoids the instructions to save, set up and
7239 restore frame pointers; it also makes an extra register available
7240 in many functions.  @strong{It also makes debugging impossible on
7241 some machines.}
7243 On some machines, such as the VAX, this flag has no effect, because
7244 the standard calling sequence automatically handles the frame pointer
7245 and nothing is saved by pretending it doesn't exist.  The
7246 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7247 whether a target machine supports this flag.  @xref{Registers,,Register
7248 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7250 Starting with GCC version 4.6, the default setting (when not optimizing for
7251 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7252 @option{-fomit-frame-pointer}.  The default can be reverted to
7253 @option{-fno-omit-frame-pointer} by configuring GCC with the
7254 @option{--enable-frame-pointer} configure option.
7256 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7258 @item -foptimize-sibling-calls
7259 @opindex foptimize-sibling-calls
7260 Optimize sibling and tail recursive calls.
7262 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7264 @item -foptimize-strlen
7265 @opindex foptimize-strlen
7266 Optimize various standard C string functions (e.g. @code{strlen},
7267 @code{strchr} or @code{strcpy}) and
7268 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7270 Enabled at levels @option{-O2}, @option{-O3}.
7272 @item -fno-inline
7273 @opindex fno-inline
7274 Do not expand any functions inline apart from those marked with
7275 the @code{always_inline} attribute.  This is the default when not
7276 optimizing.
7278 Single functions can be exempted from inlining by marking them
7279 with the @code{noinline} attribute.
7281 @item -finline-small-functions
7282 @opindex finline-small-functions
7283 Integrate functions into their callers when their body is smaller than expected
7284 function call code (so overall size of program gets smaller).  The compiler
7285 heuristically decides which functions are simple enough to be worth integrating
7286 in this way.  This inlining applies to all functions, even those not declared
7287 inline.
7289 Enabled at level @option{-O2}.
7291 @item -findirect-inlining
7292 @opindex findirect-inlining
7293 Inline also indirect calls that are discovered to be known at compile
7294 time thanks to previous inlining.  This option has any effect only
7295 when inlining itself is turned on by the @option{-finline-functions}
7296 or @option{-finline-small-functions} options.
7298 Enabled at level @option{-O2}.
7300 @item -finline-functions
7301 @opindex finline-functions
7302 Consider all functions for inlining, even if they are not declared inline.
7303 The compiler heuristically decides which functions are worth integrating
7304 in this way.
7306 If all calls to a given function are integrated, and the function is
7307 declared @code{static}, then the function is normally not output as
7308 assembler code in its own right.
7310 Enabled at level @option{-O3}.
7312 @item -finline-functions-called-once
7313 @opindex finline-functions-called-once
7314 Consider all @code{static} functions called once for inlining into their
7315 caller even if they are not marked @code{inline}.  If a call to a given
7316 function is integrated, then the function is not output as assembler code
7317 in its own right.
7319 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7321 @item -fearly-inlining
7322 @opindex fearly-inlining
7323 Inline functions marked by @code{always_inline} and functions whose body seems
7324 smaller than the function call overhead early before doing
7325 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7326 makes profiling significantly cheaper and usually inlining faster on programs
7327 having large chains of nested wrapper functions.
7329 Enabled by default.
7331 @item -fipa-sra
7332 @opindex fipa-sra
7333 Perform interprocedural scalar replacement of aggregates, removal of
7334 unused parameters and replacement of parameters passed by reference
7335 by parameters passed by value.
7337 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7339 @item -finline-limit=@var{n}
7340 @opindex finline-limit
7341 By default, GCC limits the size of functions that can be inlined.  This flag
7342 allows coarse control of this limit.  @var{n} is the size of functions that
7343 can be inlined in number of pseudo instructions.
7345 Inlining is actually controlled by a number of parameters, which may be
7346 specified individually by using @option{--param @var{name}=@var{value}}.
7347 The @option{-finline-limit=@var{n}} option sets some of these parameters
7348 as follows:
7350 @table @gcctabopt
7351 @item max-inline-insns-single
7352 is set to @var{n}/2.
7353 @item max-inline-insns-auto
7354 is set to @var{n}/2.
7355 @end table
7357 See below for a documentation of the individual
7358 parameters controlling inlining and for the defaults of these parameters.
7360 @emph{Note:} there may be no value to @option{-finline-limit} that results
7361 in default behavior.
7363 @emph{Note:} pseudo instruction represents, in this particular context, an
7364 abstract measurement of function's size.  In no way does it represent a count
7365 of assembly instructions and as such its exact meaning might change from one
7366 release to an another.
7368 @item -fno-keep-inline-dllexport
7369 @opindex -fno-keep-inline-dllexport
7370 This is a more fine-grained version of @option{-fkeep-inline-functions},
7371 which applies only to functions that are declared using the @code{dllexport}
7372 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7373 Functions}.)
7375 @item -fkeep-inline-functions
7376 @opindex fkeep-inline-functions
7377 In C, emit @code{static} functions that are declared @code{inline}
7378 into the object file, even if the function has been inlined into all
7379 of its callers.  This switch does not affect functions using the
7380 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7381 inline functions into the object file.
7383 @item -fkeep-static-consts
7384 @opindex fkeep-static-consts
7385 Emit variables declared @code{static const} when optimization isn't turned
7386 on, even if the variables aren't referenced.
7388 GCC enables this option by default.  If you want to force the compiler to
7389 check if a variable is referenced, regardless of whether or not
7390 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7392 @item -fmerge-constants
7393 @opindex fmerge-constants
7394 Attempt to merge identical constants (string constants and floating-point
7395 constants) across compilation units.
7397 This option is the default for optimized compilation if the assembler and
7398 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7399 behavior.
7401 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7403 @item -fmerge-all-constants
7404 @opindex fmerge-all-constants
7405 Attempt to merge identical constants and identical variables.
7407 This option implies @option{-fmerge-constants}.  In addition to
7408 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7409 arrays or initialized constant variables with integral or floating-point
7410 types.  Languages like C or C++ require each variable, including multiple
7411 instances of the same variable in recursive calls, to have distinct locations,
7412 so using this option results in non-conforming
7413 behavior.
7415 @item -fmodulo-sched
7416 @opindex fmodulo-sched
7417 Perform swing modulo scheduling immediately before the first scheduling
7418 pass.  This pass looks at innermost loops and reorders their
7419 instructions by overlapping different iterations.
7421 @item -fmodulo-sched-allow-regmoves
7422 @opindex fmodulo-sched-allow-regmoves
7423 Perform more aggressive SMS-based modulo scheduling with register moves
7424 allowed.  By setting this flag certain anti-dependences edges are
7425 deleted, which triggers the generation of reg-moves based on the
7426 life-range analysis.  This option is effective only with
7427 @option{-fmodulo-sched} enabled.
7429 @item -fno-branch-count-reg
7430 @opindex fno-branch-count-reg
7431 Do not use ``decrement and branch'' instructions on a count register,
7432 but instead generate a sequence of instructions that decrement a
7433 register, compare it against zero, then branch based upon the result.
7434 This option is only meaningful on architectures that support such
7435 instructions, which include x86, PowerPC, IA-64 and S/390.
7437 Enabled by default at @option{-O1} and higher.
7439 The default is @option{-fbranch-count-reg}.
7441 @item -fno-function-cse
7442 @opindex fno-function-cse
7443 Do not put function addresses in registers; make each instruction that
7444 calls a constant function contain the function's address explicitly.
7446 This option results in less efficient code, but some strange hacks
7447 that alter the assembler output may be confused by the optimizations
7448 performed when this option is not used.
7450 The default is @option{-ffunction-cse}
7452 @item -fno-zero-initialized-in-bss
7453 @opindex fno-zero-initialized-in-bss
7454 If the target supports a BSS section, GCC by default puts variables that
7455 are initialized to zero into BSS@.  This can save space in the resulting
7456 code.
7458 This option turns off this behavior because some programs explicitly
7459 rely on variables going to the data section---e.g., so that the
7460 resulting executable can find the beginning of that section and/or make
7461 assumptions based on that.
7463 The default is @option{-fzero-initialized-in-bss}.
7465 @item -fthread-jumps
7466 @opindex fthread-jumps
7467 Perform optimizations that check to see if a jump branches to a
7468 location where another comparison subsumed by the first is found.  If
7469 so, the first branch is redirected to either the destination of the
7470 second branch or a point immediately following it, depending on whether
7471 the condition is known to be true or false.
7473 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7475 @item -fsplit-wide-types
7476 @opindex fsplit-wide-types
7477 When using a type that occupies multiple registers, such as @code{long
7478 long} on a 32-bit system, split the registers apart and allocate them
7479 independently.  This normally generates better code for those types,
7480 but may make debugging more difficult.
7482 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7483 @option{-Os}.
7485 @item -fcse-follow-jumps
7486 @opindex fcse-follow-jumps
7487 In common subexpression elimination (CSE), scan through jump instructions
7488 when the target of the jump is not reached by any other path.  For
7489 example, when CSE encounters an @code{if} statement with an
7490 @code{else} clause, CSE follows the jump when the condition
7491 tested is false.
7493 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7495 @item -fcse-skip-blocks
7496 @opindex fcse-skip-blocks
7497 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7498 follow jumps that conditionally skip over blocks.  When CSE
7499 encounters a simple @code{if} statement with no else clause,
7500 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7501 body of the @code{if}.
7503 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7505 @item -frerun-cse-after-loop
7506 @opindex frerun-cse-after-loop
7507 Re-run common subexpression elimination after loop optimizations are
7508 performed.
7510 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7512 @item -fgcse
7513 @opindex fgcse
7514 Perform a global common subexpression elimination pass.
7515 This pass also performs global constant and copy propagation.
7517 @emph{Note:} When compiling a program using computed gotos, a GCC
7518 extension, you may get better run-time performance if you disable
7519 the global common subexpression elimination pass by adding
7520 @option{-fno-gcse} to the command line.
7522 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7524 @item -fgcse-lm
7525 @opindex fgcse-lm
7526 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7527 attempts to move loads that are only killed by stores into themselves.  This
7528 allows a loop containing a load/store sequence to be changed to a load outside
7529 the loop, and a copy/store within the loop.
7531 Enabled by default when @option{-fgcse} is enabled.
7533 @item -fgcse-sm
7534 @opindex fgcse-sm
7535 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7536 global common subexpression elimination.  This pass attempts to move
7537 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7538 loops containing a load/store sequence can be changed to a load before
7539 the loop and a store after the loop.
7541 Not enabled at any optimization level.
7543 @item -fgcse-las
7544 @opindex fgcse-las
7545 When @option{-fgcse-las} is enabled, the global common subexpression
7546 elimination pass eliminates redundant loads that come after stores to the
7547 same memory location (both partial and full redundancies).
7549 Not enabled at any optimization level.
7551 @item -fgcse-after-reload
7552 @opindex fgcse-after-reload
7553 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7554 pass is performed after reload.  The purpose of this pass is to clean up
7555 redundant spilling.
7557 @item -faggressive-loop-optimizations
7558 @opindex faggressive-loop-optimizations
7559 This option tells the loop optimizer to use language constraints to
7560 derive bounds for the number of iterations of a loop.  This assumes that
7561 loop code does not invoke undefined behavior by for example causing signed
7562 integer overflows or out-of-bound array accesses.  The bounds for the
7563 number of iterations of a loop are used to guide loop unrolling and peeling
7564 and loop exit test optimizations.
7565 This option is enabled by default.
7567 @item -funsafe-loop-optimizations
7568 @opindex funsafe-loop-optimizations
7569 This option tells the loop optimizer to assume that loop indices do not
7570 overflow, and that loops with nontrivial exit condition are not
7571 infinite.  This enables a wider range of loop optimizations even if
7572 the loop optimizer itself cannot prove that these assumptions are valid.
7573 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7574 if it finds this kind of loop.
7576 @item -fcrossjumping
7577 @opindex fcrossjumping
7578 Perform cross-jumping transformation.
7579 This transformation unifies equivalent code and saves code size.  The
7580 resulting code may or may not perform better than without cross-jumping.
7582 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7584 @item -fauto-inc-dec
7585 @opindex fauto-inc-dec
7586 Combine increments or decrements of addresses with memory accesses.
7587 This pass is always skipped on architectures that do not have
7588 instructions to support this.  Enabled by default at @option{-O} and
7589 higher on architectures that support this.
7591 @item -fdce
7592 @opindex fdce
7593 Perform dead code elimination (DCE) on RTL@.
7594 Enabled by default at @option{-O} and higher.
7596 @item -fdse
7597 @opindex fdse
7598 Perform dead store elimination (DSE) on RTL@.
7599 Enabled by default at @option{-O} and higher.
7601 @item -fif-conversion
7602 @opindex fif-conversion
7603 Attempt to transform conditional jumps into branch-less equivalents.  This
7604 includes use of conditional moves, min, max, set flags and abs instructions, and
7605 some tricks doable by standard arithmetics.  The use of conditional execution
7606 on chips where it is available is controlled by @code{if-conversion2}.
7608 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7610 @item -fif-conversion2
7611 @opindex fif-conversion2
7612 Use conditional execution (where available) to transform conditional jumps into
7613 branch-less equivalents.
7615 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7617 @item -fdeclone-ctor-dtor
7618 @opindex fdeclone-ctor-dtor
7619 The C++ ABI requires multiple entry points for constructors and
7620 destructors: one for a base subobject, one for a complete object, and
7621 one for a virtual destructor that calls operator delete afterwards.
7622 For a hierarchy with virtual bases, the base and complete variants are
7623 clones, which means two copies of the function.  With this option, the
7624 base and complete variants are changed to be thunks that call a common
7625 implementation.
7627 Enabled by @option{-Os}.
7629 @item -fdelete-null-pointer-checks
7630 @opindex fdelete-null-pointer-checks
7631 Assume that programs cannot safely dereference null pointers, and that
7632 no code or data element resides there.  This enables simple constant
7633 folding optimizations at all optimization levels.  In addition, other
7634 optimization passes in GCC use this flag to control global dataflow
7635 analyses that eliminate useless checks for null pointers; these assume
7636 that if a pointer is checked after it has already been dereferenced,
7637 it cannot be null.
7639 Note however that in some environments this assumption is not true.
7640 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7641 for programs that depend on that behavior.
7643 Some targets, especially embedded ones, disable this option at all levels.
7644 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7645 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7646 are enabled independently at different optimization levels.
7648 @item -fdevirtualize
7649 @opindex fdevirtualize
7650 Attempt to convert calls to virtual functions to direct calls.  This
7651 is done both within a procedure and interprocedurally as part of
7652 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7653 propagation (@option{-fipa-cp}).
7654 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7656 @item -fdevirtualize-speculatively
7657 @opindex fdevirtualize-speculatively
7658 Attempt to convert calls to virtual functions to speculative direct calls.
7659 Based on the analysis of the type inheritance graph, determine for a given call
7660 the set of likely targets. If the set is small, preferably of size 1, change
7661 the call into an conditional deciding on direct and indirect call.  The
7662 speculative calls enable more optimizations, such as inlining.  When they seem
7663 useless after further optimization, they are converted back into original form.
7665 @item -fexpensive-optimizations
7666 @opindex fexpensive-optimizations
7667 Perform a number of minor optimizations that are relatively expensive.
7669 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7671 @item -free
7672 @opindex free
7673 Attempt to remove redundant extension instructions.  This is especially
7674 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7675 registers after writing to their lower 32-bit half.
7677 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7678 @option{-O3}, @option{-Os}.
7680 @item -flive-range-shrinkage
7681 @opindex flive-range-shrinkage
7682 Attempt to decrease register pressure through register live range
7683 shrinkage.  This is helpful for fast processors with small or moderate
7684 size register sets.
7686 @item -fira-algorithm=@var{algorithm}
7687 Use the specified coloring algorithm for the integrated register
7688 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7689 specifies Chow's priority coloring, or @samp{CB}, which specifies
7690 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7691 for all architectures, but for those targets that do support it, it is
7692 the default because it generates better code.
7694 @item -fira-region=@var{region}
7695 Use specified regions for the integrated register allocator.  The
7696 @var{region} argument should be one of the following:
7698 @table @samp
7700 @item all
7701 Use all loops as register allocation regions.
7702 This can give the best results for machines with a small and/or
7703 irregular register set.
7705 @item mixed
7706 Use all loops except for loops with small register pressure 
7707 as the regions.  This value usually gives
7708 the best results in most cases and for most architectures,
7709 and is enabled by default when compiling with optimization for speed
7710 (@option{-O}, @option{-O2}, @dots{}).
7712 @item one
7713 Use all functions as a single region.  
7714 This typically results in the smallest code size, and is enabled by default for
7715 @option{-Os} or @option{-O0}.
7717 @end table
7719 @item -fira-hoist-pressure
7720 @opindex fira-hoist-pressure
7721 Use IRA to evaluate register pressure in the code hoisting pass for
7722 decisions to hoist expressions.  This option usually results in smaller
7723 code, but it can slow the compiler down.
7725 This option is enabled at level @option{-Os} for all targets.
7727 @item -fira-loop-pressure
7728 @opindex fira-loop-pressure
7729 Use IRA to evaluate register pressure in loops for decisions to move
7730 loop invariants.  This option usually results in generation
7731 of faster and smaller code on machines with large register files (>= 32
7732 registers), but it can slow the compiler down.
7734 This option is enabled at level @option{-O3} for some targets.
7736 @item -fno-ira-share-save-slots
7737 @opindex fno-ira-share-save-slots
7738 Disable sharing of stack slots used for saving call-used hard
7739 registers living through a call.  Each hard register gets a
7740 separate stack slot, and as a result function stack frames are
7741 larger.
7743 @item -fno-ira-share-spill-slots
7744 @opindex fno-ira-share-spill-slots
7745 Disable sharing of stack slots allocated for pseudo-registers.  Each
7746 pseudo-register that does not get a hard register gets a separate
7747 stack slot, and as a result function stack frames are larger.
7749 @item -fira-verbose=@var{n}
7750 @opindex fira-verbose
7751 Control the verbosity of the dump file for the integrated register allocator.
7752 The default value is 5.  If the value @var{n} is greater or equal to 10,
7753 the dump output is sent to stderr using the same format as @var{n} minus 10.
7755 @item -fdelayed-branch
7756 @opindex fdelayed-branch
7757 If supported for the target machine, attempt to reorder instructions
7758 to exploit instruction slots available after delayed branch
7759 instructions.
7761 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7763 @item -fschedule-insns
7764 @opindex fschedule-insns
7765 If supported for the target machine, attempt to reorder instructions to
7766 eliminate execution stalls due to required data being unavailable.  This
7767 helps machines that have slow floating point or memory load instructions
7768 by allowing other instructions to be issued until the result of the load
7769 or floating-point instruction is required.
7771 Enabled at levels @option{-O2}, @option{-O3}.
7773 @item -fschedule-insns2
7774 @opindex fschedule-insns2
7775 Similar to @option{-fschedule-insns}, but requests an additional pass of
7776 instruction scheduling after register allocation has been done.  This is
7777 especially useful on machines with a relatively small number of
7778 registers and where memory load instructions take more than one cycle.
7780 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7782 @item -fno-sched-interblock
7783 @opindex fno-sched-interblock
7784 Don't schedule instructions across basic blocks.  This is normally
7785 enabled by default when scheduling before register allocation, i.e.@:
7786 with @option{-fschedule-insns} or at @option{-O2} or higher.
7788 @item -fno-sched-spec
7789 @opindex fno-sched-spec
7790 Don't allow speculative motion of non-load instructions.  This is normally
7791 enabled by default when scheduling before register allocation, i.e.@:
7792 with @option{-fschedule-insns} or at @option{-O2} or higher.
7794 @item -fsched-pressure
7795 @opindex fsched-pressure
7796 Enable register pressure sensitive insn scheduling before register
7797 allocation.  This only makes sense when scheduling before register
7798 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7799 @option{-O2} or higher.  Usage of this option can improve the
7800 generated code and decrease its size by preventing register pressure
7801 increase above the number of available hard registers and subsequent
7802 spills in register allocation.
7804 @item -fsched-spec-load
7805 @opindex fsched-spec-load
7806 Allow speculative motion of some load instructions.  This only makes
7807 sense when scheduling before register allocation, i.e.@: with
7808 @option{-fschedule-insns} or at @option{-O2} or higher.
7810 @item -fsched-spec-load-dangerous
7811 @opindex fsched-spec-load-dangerous
7812 Allow speculative motion of more load instructions.  This only makes
7813 sense when scheduling before register allocation, i.e.@: with
7814 @option{-fschedule-insns} or at @option{-O2} or higher.
7816 @item -fsched-stalled-insns
7817 @itemx -fsched-stalled-insns=@var{n}
7818 @opindex fsched-stalled-insns
7819 Define how many insns (if any) can be moved prematurely from the queue
7820 of stalled insns into the ready list during the second scheduling pass.
7821 @option{-fno-sched-stalled-insns} means that no insns are moved
7822 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7823 on how many queued insns can be moved prematurely.
7824 @option{-fsched-stalled-insns} without a value is equivalent to
7825 @option{-fsched-stalled-insns=1}.
7827 @item -fsched-stalled-insns-dep
7828 @itemx -fsched-stalled-insns-dep=@var{n}
7829 @opindex fsched-stalled-insns-dep
7830 Define how many insn groups (cycles) are examined for a dependency
7831 on a stalled insn that is a candidate for premature removal from the queue
7832 of stalled insns.  This has an effect only during the second scheduling pass,
7833 and only if @option{-fsched-stalled-insns} is used.
7834 @option{-fno-sched-stalled-insns-dep} is equivalent to
7835 @option{-fsched-stalled-insns-dep=0}.
7836 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7837 @option{-fsched-stalled-insns-dep=1}.
7839 @item -fsched2-use-superblocks
7840 @opindex fsched2-use-superblocks
7841 When scheduling after register allocation, use superblock scheduling.
7842 This allows motion across basic block boundaries,
7843 resulting in faster schedules.  This option is experimental, as not all machine
7844 descriptions used by GCC model the CPU closely enough to avoid unreliable
7845 results from the algorithm.
7847 This only makes sense when scheduling after register allocation, i.e.@: with
7848 @option{-fschedule-insns2} or at @option{-O2} or higher.
7850 @item -fsched-group-heuristic
7851 @opindex fsched-group-heuristic
7852 Enable the group heuristic in the scheduler.  This heuristic favors
7853 the instruction that belongs to a schedule group.  This is enabled
7854 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7855 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7857 @item -fsched-critical-path-heuristic
7858 @opindex fsched-critical-path-heuristic
7859 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7860 instructions on the critical path.  This is enabled by default when
7861 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7862 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7864 @item -fsched-spec-insn-heuristic
7865 @opindex fsched-spec-insn-heuristic
7866 Enable the speculative instruction heuristic in the scheduler.  This
7867 heuristic favors speculative instructions with greater dependency weakness.
7868 This is enabled by default when scheduling is enabled, i.e.@:
7869 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7870 or at @option{-O2} or higher.
7872 @item -fsched-rank-heuristic
7873 @opindex fsched-rank-heuristic
7874 Enable the rank heuristic in the scheduler.  This heuristic favors
7875 the instruction belonging to a basic block with greater size or frequency.
7876 This is enabled by default when scheduling is enabled, i.e.@:
7877 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7878 at @option{-O2} or higher.
7880 @item -fsched-last-insn-heuristic
7881 @opindex fsched-last-insn-heuristic
7882 Enable the last-instruction heuristic in the scheduler.  This heuristic
7883 favors the instruction that is less dependent on the last instruction
7884 scheduled.  This is enabled by default when scheduling is enabled,
7885 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7886 at @option{-O2} or higher.
7888 @item -fsched-dep-count-heuristic
7889 @opindex fsched-dep-count-heuristic
7890 Enable the dependent-count heuristic in the scheduler.  This heuristic
7891 favors the instruction that has more instructions depending on it.
7892 This is enabled by default when scheduling is enabled, i.e.@:
7893 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7894 at @option{-O2} or higher.
7896 @item -freschedule-modulo-scheduled-loops
7897 @opindex freschedule-modulo-scheduled-loops
7898 Modulo scheduling is performed before traditional scheduling.  If a loop
7899 is modulo scheduled, later scheduling passes may change its schedule.  
7900 Use this option to control that behavior.
7902 @item -fselective-scheduling
7903 @opindex fselective-scheduling
7904 Schedule instructions using selective scheduling algorithm.  Selective
7905 scheduling runs instead of the first scheduler pass.
7907 @item -fselective-scheduling2
7908 @opindex fselective-scheduling2
7909 Schedule instructions using selective scheduling algorithm.  Selective
7910 scheduling runs instead of the second scheduler pass.
7912 @item -fsel-sched-pipelining
7913 @opindex fsel-sched-pipelining
7914 Enable software pipelining of innermost loops during selective scheduling.
7915 This option has no effect unless one of @option{-fselective-scheduling} or
7916 @option{-fselective-scheduling2} is turned on.
7918 @item -fsel-sched-pipelining-outer-loops
7919 @opindex fsel-sched-pipelining-outer-loops
7920 When pipelining loops during selective scheduling, also pipeline outer loops.
7921 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7923 @item -fsemantic-interposition
7924 @opindex fsemantic-interposition
7925 Some object formats, like ELF, allow interposing of symbols by dynamic linker.
7926 This means that for symbols exported from the DSO compiler can not perform
7927 inter-procedural propagation, inlining and other optimizations in anticipation
7928 that the function or variable in question may change. While this feature is
7929 useful, for example, to rewrite memory allocation functions by a debugging
7930 implementation, it is expensive in the terms of code quality.
7931 With @option{-fno-semantic-inteposition} compiler assumest that if interposition
7932 happens for functions the overwritting function will have
7933 precisely same semantics (and side effects). Similarly if interposition happens
7934 for variables, the constructor of the variable will be the same. The flag
7935 has no effect for functions explicitly declared inline, where
7936 interposition changing semantic is never allowed and for symbols explicitly
7937 declared weak.
7939 @item -fshrink-wrap
7940 @opindex fshrink-wrap
7941 Emit function prologues only before parts of the function that need it,
7942 rather than at the top of the function.  This flag is enabled by default at
7943 @option{-O} and higher.
7945 @item -fcaller-saves
7946 @opindex fcaller-saves
7947 Enable allocation of values to registers that are clobbered by
7948 function calls, by emitting extra instructions to save and restore the
7949 registers around such calls.  Such allocation is done only when it
7950 seems to result in better code.
7952 This option is always enabled by default on certain machines, usually
7953 those which have no call-preserved registers to use instead.
7955 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7957 @item -fcombine-stack-adjustments
7958 @opindex fcombine-stack-adjustments
7959 Tracks stack adjustments (pushes and pops) and stack memory references
7960 and then tries to find ways to combine them.
7962 Enabled by default at @option{-O1} and higher.
7964 @item -fuse-caller-save
7965 Use caller save registers for allocation if those registers are not used by
7966 any called function.  In that case it is not necessary to save and restore
7967 them around calls.  This is only possible if called functions are part of
7968 same compilation unit as current function and they are compiled before it.
7970 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7972 @item -fconserve-stack
7973 @opindex fconserve-stack
7974 Attempt to minimize stack usage.  The compiler attempts to use less
7975 stack space, even if that makes the program slower.  This option
7976 implies setting the @option{large-stack-frame} parameter to 100
7977 and the @option{large-stack-frame-growth} parameter to 400.
7979 @item -ftree-reassoc
7980 @opindex ftree-reassoc
7981 Perform reassociation on trees.  This flag is enabled by default
7982 at @option{-O} and higher.
7984 @item -ftree-pre
7985 @opindex ftree-pre
7986 Perform partial redundancy elimination (PRE) on trees.  This flag is
7987 enabled by default at @option{-O2} and @option{-O3}.
7989 @item -ftree-partial-pre
7990 @opindex ftree-partial-pre
7991 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7992 enabled by default at @option{-O3}.
7994 @item -ftree-forwprop
7995 @opindex ftree-forwprop
7996 Perform forward propagation on trees.  This flag is enabled by default
7997 at @option{-O} and higher.
7999 @item -ftree-fre
8000 @opindex ftree-fre
8001 Perform full redundancy elimination (FRE) on trees.  The difference
8002 between FRE and PRE is that FRE only considers expressions
8003 that are computed on all paths leading to the redundant computation.
8004 This analysis is faster than PRE, though it exposes fewer redundancies.
8005 This flag is enabled by default at @option{-O} and higher.
8007 @item -ftree-phiprop
8008 @opindex ftree-phiprop
8009 Perform hoisting of loads from conditional pointers on trees.  This
8010 pass is enabled by default at @option{-O} and higher.
8012 @item -fhoist-adjacent-loads
8013 @opindex hoist-adjacent-loads
8014 Speculatively hoist loads from both branches of an if-then-else if the
8015 loads are from adjacent locations in the same structure and the target
8016 architecture has a conditional move instruction.  This flag is enabled
8017 by default at @option{-O2} and higher.
8019 @item -ftree-copy-prop
8020 @opindex ftree-copy-prop
8021 Perform copy propagation on trees.  This pass eliminates unnecessary
8022 copy operations.  This flag is enabled by default at @option{-O} and
8023 higher.
8025 @item -fipa-pure-const
8026 @opindex fipa-pure-const
8027 Discover which functions are pure or constant.
8028 Enabled by default at @option{-O} and higher.
8030 @item -fipa-reference
8031 @opindex fipa-reference
8032 Discover which static variables do not escape the
8033 compilation unit.
8034 Enabled by default at @option{-O} and higher.
8036 @item -fipa-pta
8037 @opindex fipa-pta
8038 Perform interprocedural pointer analysis and interprocedural modification
8039 and reference analysis.  This option can cause excessive memory and
8040 compile-time usage on large compilation units.  It is not enabled by
8041 default at any optimization level.
8043 @item -fipa-profile
8044 @opindex fipa-profile
8045 Perform interprocedural profile propagation.  The functions called only from
8046 cold functions are marked as cold. Also functions executed once (such as
8047 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8048 functions and loop less parts of functions executed once are then optimized for
8049 size.
8050 Enabled by default at @option{-O} and higher.
8052 @item -fipa-cp
8053 @opindex fipa-cp
8054 Perform interprocedural constant propagation.
8055 This optimization analyzes the program to determine when values passed
8056 to functions are constants and then optimizes accordingly.
8057 This optimization can substantially increase performance
8058 if the application has constants passed to functions.
8059 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8061 @item -fipa-cp-clone
8062 @opindex fipa-cp-clone
8063 Perform function cloning to make interprocedural constant propagation stronger.
8064 When enabled, interprocedural constant propagation performs function cloning
8065 when externally visible function can be called with constant arguments.
8066 Because this optimization can create multiple copies of functions,
8067 it may significantly increase code size
8068 (see @option{--param ipcp-unit-growth=@var{value}}).
8069 This flag is enabled by default at @option{-O3}.
8071 @item -fisolate-erroneous-paths-dereference
8072 Detect paths which trigger erroneous or undefined behaviour due to
8073 dereferencing a NULL pointer.  Isolate those paths from the main control
8074 flow and turn the statement with erroneous or undefined behaviour into a trap.
8076 @item -fisolate-erroneous-paths-attribute
8077 Detect paths which trigger erroneous or undefined behaviour due a NULL value
8078 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
8079 attribute.  Isolate those paths from the main control flow and turn the
8080 statement with erroneous or undefined behaviour into a trap.  This is not
8081 currently enabled, but may be enabled by @code{-O2} in the future.
8083 @item -ftree-sink
8084 @opindex ftree-sink
8085 Perform forward store motion  on trees.  This flag is
8086 enabled by default at @option{-O} and higher.
8088 @item -ftree-bit-ccp
8089 @opindex ftree-bit-ccp
8090 Perform sparse conditional bit constant propagation on trees and propagate
8091 pointer alignment information.
8092 This pass only operates on local scalar variables and is enabled by default
8093 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8095 @item -ftree-ccp
8096 @opindex ftree-ccp
8097 Perform sparse conditional constant propagation (CCP) on trees.  This
8098 pass only operates on local scalar variables and is enabled by default
8099 at @option{-O} and higher.
8101 @item -fssa-phiopt
8102 @opindex fssa-phiopt
8103 Perform pattern matching on SSA PHI nodes to optimize conditional
8104 code.  This pass is enabled by default at @option{-O} and higher.
8106 @item -ftree-switch-conversion
8107 Perform conversion of simple initializations in a switch to
8108 initializations from a scalar array.  This flag is enabled by default
8109 at @option{-O2} and higher.
8111 @item -ftree-tail-merge
8112 Look for identical code sequences.  When found, replace one with a jump to the
8113 other.  This optimization is known as tail merging or cross jumping.  This flag
8114 is enabled by default at @option{-O2} and higher.  The compilation time
8115 in this pass can
8116 be limited using @option{max-tail-merge-comparisons} parameter and
8117 @option{max-tail-merge-iterations} parameter.
8119 @item -ftree-dce
8120 @opindex ftree-dce
8121 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8122 default at @option{-O} and higher.
8124 @item -ftree-builtin-call-dce
8125 @opindex ftree-builtin-call-dce
8126 Perform conditional dead code elimination (DCE) for calls to built-in functions
8127 that may set @code{errno} but are otherwise side-effect free.  This flag is
8128 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8129 specified.
8131 @item -ftree-dominator-opts
8132 @opindex ftree-dominator-opts
8133 Perform a variety of simple scalar cleanups (constant/copy
8134 propagation, redundancy elimination, range propagation and expression
8135 simplification) based on a dominator tree traversal.  This also
8136 performs jump threading (to reduce jumps to jumps). This flag is
8137 enabled by default at @option{-O} and higher.
8139 @item -ftree-dse
8140 @opindex ftree-dse
8141 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8142 a memory location that is later overwritten by another store without
8143 any intervening loads.  In this case the earlier store can be deleted.  This
8144 flag is enabled by default at @option{-O} and higher.
8146 @item -ftree-ch
8147 @opindex ftree-ch
8148 Perform loop header copying on trees.  This is beneficial since it increases
8149 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8150 is enabled by default at @option{-O} and higher.  It is not enabled
8151 for @option{-Os}, since it usually increases code size.
8153 @item -ftree-loop-optimize
8154 @opindex ftree-loop-optimize
8155 Perform loop optimizations on trees.  This flag is enabled by default
8156 at @option{-O} and higher.
8158 @item -ftree-loop-linear
8159 @opindex ftree-loop-linear
8160 Perform loop interchange transformations on tree.  Same as
8161 @option{-floop-interchange}.  To use this code transformation, GCC has
8162 to be configured with @option{--with-ppl} and @option{--with-cloog} to
8163 enable the Graphite loop transformation infrastructure.
8165 @item -floop-interchange
8166 @opindex floop-interchange
8167 Perform loop interchange transformations on loops.  Interchanging two
8168 nested loops switches the inner and outer loops.  For example, given a
8169 loop like:
8170 @smallexample
8171 DO J = 1, M
8172   DO I = 1, N
8173     A(J, I) = A(J, I) * C
8174   ENDDO
8175 ENDDO
8176 @end smallexample
8177 loop interchange transforms the loop as if it were written:
8178 @smallexample
8179 DO I = 1, N
8180   DO J = 1, M
8181     A(J, I) = A(J, I) * C
8182   ENDDO
8183 ENDDO
8184 @end smallexample
8185 which can be beneficial when @code{N} is larger than the caches,
8186 because in Fortran, the elements of an array are stored in memory
8187 contiguously by column, and the original loop iterates over rows,
8188 potentially creating at each access a cache miss.  This optimization
8189 applies to all the languages supported by GCC and is not limited to
8190 Fortran.  To use this code transformation, GCC has to be configured
8191 with @option{--with-ppl} and @option{--with-cloog} to enable the
8192 Graphite loop transformation infrastructure.
8194 @item -floop-strip-mine
8195 @opindex floop-strip-mine
8196 Perform loop strip mining transformations on loops.  Strip mining
8197 splits a loop into two nested loops.  The outer loop has strides
8198 equal to the strip size and the inner loop has strides of the
8199 original loop within a strip.  The strip length can be changed
8200 using the @option{loop-block-tile-size} parameter.  For example,
8201 given a loop like:
8202 @smallexample
8203 DO I = 1, N
8204   A(I) = A(I) + C
8205 ENDDO
8206 @end smallexample
8207 loop strip mining transforms the loop as if it were written:
8208 @smallexample
8209 DO II = 1, N, 51
8210   DO I = II, min (II + 50, N)
8211     A(I) = A(I) + C
8212   ENDDO
8213 ENDDO
8214 @end smallexample
8215 This optimization applies to all the languages supported by GCC and is
8216 not limited to Fortran.  To use this code transformation, GCC has to
8217 be configured with @option{--with-ppl} and @option{--with-cloog} to
8218 enable the Graphite loop transformation infrastructure.
8220 @item -floop-block
8221 @opindex floop-block
8222 Perform loop blocking transformations on loops.  Blocking strip mines
8223 each loop in the loop nest such that the memory accesses of the
8224 element loops fit inside caches.  The strip length can be changed
8225 using the @option{loop-block-tile-size} parameter.  For example, given
8226 a loop like:
8227 @smallexample
8228 DO I = 1, N
8229   DO J = 1, M
8230     A(J, I) = B(I) + C(J)
8231   ENDDO
8232 ENDDO
8233 @end smallexample
8234 loop blocking transforms the loop as if it were written:
8235 @smallexample
8236 DO II = 1, N, 51
8237   DO JJ = 1, M, 51
8238     DO I = II, min (II + 50, N)
8239       DO J = JJ, min (JJ + 50, M)
8240         A(J, I) = B(I) + C(J)
8241       ENDDO
8242     ENDDO
8243   ENDDO
8244 ENDDO
8245 @end smallexample
8246 which can be beneficial when @code{M} is larger than the caches,
8247 because the innermost loop iterates over a smaller amount of data
8248 which can be kept in the caches.  This optimization applies to all the
8249 languages supported by GCC and is not limited to Fortran.  To use this
8250 code transformation, GCC has to be configured with @option{--with-ppl}
8251 and @option{--with-cloog} to enable the Graphite loop transformation
8252 infrastructure.
8254 @item -fgraphite-identity
8255 @opindex fgraphite-identity
8256 Enable the identity transformation for graphite.  For every SCoP we generate
8257 the polyhedral representation and transform it back to gimple.  Using
8258 @option{-fgraphite-identity} we can check the costs or benefits of the
8259 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8260 are also performed by the code generator CLooG, like index splitting and
8261 dead code elimination in loops.
8263 @item -floop-nest-optimize
8264 @opindex floop-nest-optimize
8265 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8266 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8267 structure optimized for data-locality and parallelism.  This option
8268 is experimental.
8270 @item -floop-parallelize-all
8271 @opindex floop-parallelize-all
8272 Use the Graphite data dependence analysis to identify loops that can
8273 be parallelized.  Parallelize all the loops that can be analyzed to
8274 not contain loop carried dependences without checking that it is
8275 profitable to parallelize the loops.
8277 @item -fcheck-data-deps
8278 @opindex fcheck-data-deps
8279 Compare the results of several data dependence analyzers.  This option
8280 is used for debugging the data dependence analyzers.
8282 @item -ftree-loop-if-convert
8283 Attempt to transform conditional jumps in the innermost loops to
8284 branch-less equivalents.  The intent is to remove control-flow from
8285 the innermost loops in order to improve the ability of the
8286 vectorization pass to handle these loops.  This is enabled by default
8287 if vectorization is enabled.
8289 @item -ftree-loop-if-convert-stores
8290 Attempt to also if-convert conditional jumps containing memory writes.
8291 This transformation can be unsafe for multi-threaded programs as it
8292 transforms conditional memory writes into unconditional memory writes.
8293 For example,
8294 @smallexample
8295 for (i = 0; i < N; i++)
8296   if (cond)
8297     A[i] = expr;
8298 @end smallexample
8299 is transformed to
8300 @smallexample
8301 for (i = 0; i < N; i++)
8302   A[i] = cond ? expr : A[i];
8303 @end smallexample
8304 potentially producing data races.
8306 @item -ftree-loop-distribution
8307 Perform loop distribution.  This flag can improve cache performance on
8308 big loop bodies and allow further loop optimizations, like
8309 parallelization or vectorization, to take place.  For example, the loop
8310 @smallexample
8311 DO I = 1, N
8312   A(I) = B(I) + C
8313   D(I) = E(I) * F
8314 ENDDO
8315 @end smallexample
8316 is transformed to
8317 @smallexample
8318 DO I = 1, N
8319    A(I) = B(I) + C
8320 ENDDO
8321 DO I = 1, N
8322    D(I) = E(I) * F
8323 ENDDO
8324 @end smallexample
8326 @item -ftree-loop-distribute-patterns
8327 Perform loop distribution of patterns that can be code generated with
8328 calls to a library.  This flag is enabled by default at @option{-O3}.
8330 This pass distributes the initialization loops and generates a call to
8331 memset zero.  For example, the loop
8332 @smallexample
8333 DO I = 1, N
8334   A(I) = 0
8335   B(I) = A(I) + I
8336 ENDDO
8337 @end smallexample
8338 is transformed to
8339 @smallexample
8340 DO I = 1, N
8341    A(I) = 0
8342 ENDDO
8343 DO I = 1, N
8344    B(I) = A(I) + I
8345 ENDDO
8346 @end smallexample
8347 and the initialization loop is transformed into a call to memset zero.
8349 @item -ftree-loop-im
8350 @opindex ftree-loop-im
8351 Perform loop invariant motion on trees.  This pass moves only invariants that
8352 are hard to handle at RTL level (function calls, operations that expand to
8353 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8354 operands of conditions that are invariant out of the loop, so that we can use
8355 just trivial invariantness analysis in loop unswitching.  The pass also includes
8356 store motion.
8358 @item -ftree-loop-ivcanon
8359 @opindex ftree-loop-ivcanon
8360 Create a canonical counter for number of iterations in loops for which
8361 determining number of iterations requires complicated analysis.  Later
8362 optimizations then may determine the number easily.  Useful especially
8363 in connection with unrolling.
8365 @item -fivopts
8366 @opindex fivopts
8367 Perform induction variable optimizations (strength reduction, induction
8368 variable merging and induction variable elimination) on trees.
8370 @item -ftree-parallelize-loops=n
8371 @opindex ftree-parallelize-loops
8372 Parallelize loops, i.e., split their iteration space to run in n threads.
8373 This is only possible for loops whose iterations are independent
8374 and can be arbitrarily reordered.  The optimization is only
8375 profitable on multiprocessor machines, for loops that are CPU-intensive,
8376 rather than constrained e.g.@: by memory bandwidth.  This option
8377 implies @option{-pthread}, and thus is only supported on targets
8378 that have support for @option{-pthread}.
8380 @item -ftree-pta
8381 @opindex ftree-pta
8382 Perform function-local points-to analysis on trees.  This flag is
8383 enabled by default at @option{-O} and higher.
8385 @item -ftree-sra
8386 @opindex ftree-sra
8387 Perform scalar replacement of aggregates.  This pass replaces structure
8388 references with scalars to prevent committing structures to memory too
8389 early.  This flag is enabled by default at @option{-O} and higher.
8391 @item -ftree-copyrename
8392 @opindex ftree-copyrename
8393 Perform copy renaming on trees.  This pass attempts to rename compiler
8394 temporaries to other variables at copy locations, usually resulting in
8395 variable names which more closely resemble the original variables.  This flag
8396 is enabled by default at @option{-O} and higher.
8398 @item -ftree-coalesce-inlined-vars
8399 @opindex ftree-coalesce-inlined-vars
8400 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8401 combine small user-defined variables too, but only if they were inlined
8402 from other functions.  It is a more limited form of
8403 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8404 inlined variables, but it will keep variables of the inlined-into
8405 function apart from each other, such that they are more likely to
8406 contain the expected values in a debugging session.  This was the
8407 default in GCC versions older than 4.7.
8409 @item -ftree-coalesce-vars
8410 @opindex ftree-coalesce-vars
8411 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8412 combine small user-defined variables too, instead of just compiler
8413 temporaries.  This may severely limit the ability to debug an optimized
8414 program compiled with @option{-fno-var-tracking-assignments}.  In the
8415 negated form, this flag prevents SSA coalescing of user variables,
8416 including inlined ones.  This option is enabled by default.
8418 @item -ftree-ter
8419 @opindex ftree-ter
8420 Perform temporary expression replacement during the SSA->normal phase.  Single
8421 use/single def temporaries are replaced at their use location with their
8422 defining expression.  This results in non-GIMPLE code, but gives the expanders
8423 much more complex trees to work on resulting in better RTL generation.  This is
8424 enabled by default at @option{-O} and higher.
8426 @item -ftree-slsr
8427 @opindex ftree-slsr
8428 Perform straight-line strength reduction on trees.  This recognizes related
8429 expressions involving multiplications and replaces them by less expensive
8430 calculations when possible.  This is enabled by default at @option{-O} and
8431 higher.
8433 @item -ftree-vectorize
8434 @opindex ftree-vectorize
8435 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8436 and @option{-ftree-slp-vectorize} if not explicitly specified.
8438 @item -ftree-loop-vectorize
8439 @opindex ftree-loop-vectorize
8440 Perform loop vectorization on trees. This flag is enabled by default at
8441 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8443 @item -ftree-slp-vectorize
8444 @opindex ftree-slp-vectorize
8445 Perform basic block vectorization on trees. This flag is enabled by default at
8446 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8448 @item -fvect-cost-model=@var{model}
8449 @opindex fvect-cost-model
8450 Alter the cost model used for vectorization.  The @var{model} argument
8451 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8452 With the @code{unlimited} model the vectorized code-path is assumed
8453 to be profitable while with the @code{dynamic} model a runtime check
8454 will guard the vectorized code-path to enable it only for iteration
8455 counts that will likely execute faster than when executing the original
8456 scalar loop.  The @code{cheap} model will disable vectorization of
8457 loops where doing so would be cost prohibitive for example due to
8458 required runtime checks for data dependence or alignment but otherwise
8459 is equal to the @code{dynamic} model.
8460 The default cost model depends on other optimization flags and is
8461 either @code{dynamic} or @code{cheap}.
8463 @item -fsimd-cost-model=@var{model}
8464 @opindex fsimd-cost-model
8465 Alter the cost model used for vectorization of loops marked with the OpenMP
8466 or Cilk Plus simd directive.  The @var{model} argument should be one of
8467 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8468 have the same meaning as described in @option{-fvect-cost-model} and by
8469 default a cost model defined with @option{-fvect-cost-model} is used.
8471 @item -ftree-vrp
8472 @opindex ftree-vrp
8473 Perform Value Range Propagation on trees.  This is similar to the
8474 constant propagation pass, but instead of values, ranges of values are
8475 propagated.  This allows the optimizers to remove unnecessary range
8476 checks like array bound checks and null pointer checks.  This is
8477 enabled by default at @option{-O2} and higher.  Null pointer check
8478 elimination is only done if @option{-fdelete-null-pointer-checks} is
8479 enabled.
8481 @item -ftracer
8482 @opindex ftracer
8483 Perform tail duplication to enlarge superblock size.  This transformation
8484 simplifies the control flow of the function allowing other optimizations to do
8485 a better job.
8487 @item -funroll-loops
8488 @opindex funroll-loops
8489 Unroll loops whose number of iterations can be determined at compile
8490 time or upon entry to the loop.  @option{-funroll-loops} implies
8491 @option{-frerun-cse-after-loop}.  This option makes code larger,
8492 and may or may not make it run faster.
8494 @item -funroll-all-loops
8495 @opindex funroll-all-loops
8496 Unroll all loops, even if their number of iterations is uncertain when
8497 the loop is entered.  This usually makes programs run more slowly.
8498 @option{-funroll-all-loops} implies the same options as
8499 @option{-funroll-loops},
8501 @item -fsplit-ivs-in-unroller
8502 @opindex fsplit-ivs-in-unroller
8503 Enables expression of values of induction variables in later iterations
8504 of the unrolled loop using the value in the first iteration.  This breaks
8505 long dependency chains, thus improving efficiency of the scheduling passes.
8507 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8508 same effect.  However, that is not reliable in cases where the loop body
8509 is more complicated than a single basic block.  It also does not work at all
8510 on some architectures due to restrictions in the CSE pass.
8512 This optimization is enabled by default.
8514 @item -fvariable-expansion-in-unroller
8515 @opindex fvariable-expansion-in-unroller
8516 With this option, the compiler creates multiple copies of some
8517 local variables when unrolling a loop, which can result in superior code.
8519 @item -fpartial-inlining
8520 @opindex fpartial-inlining
8521 Inline parts of functions.  This option has any effect only
8522 when inlining itself is turned on by the @option{-finline-functions}
8523 or @option{-finline-small-functions} options.
8525 Enabled at level @option{-O2}.
8527 @item -fpredictive-commoning
8528 @opindex fpredictive-commoning
8529 Perform predictive commoning optimization, i.e., reusing computations
8530 (especially memory loads and stores) performed in previous
8531 iterations of loops.
8533 This option is enabled at level @option{-O3}.
8535 @item -fprefetch-loop-arrays
8536 @opindex fprefetch-loop-arrays
8537 If supported by the target machine, generate instructions to prefetch
8538 memory to improve the performance of loops that access large arrays.
8540 This option may generate better or worse code; results are highly
8541 dependent on the structure of loops within the source code.
8543 Disabled at level @option{-Os}.
8545 @item -fno-peephole
8546 @itemx -fno-peephole2
8547 @opindex fno-peephole
8548 @opindex fno-peephole2
8549 Disable any machine-specific peephole optimizations.  The difference
8550 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8551 are implemented in the compiler; some targets use one, some use the
8552 other, a few use both.
8554 @option{-fpeephole} is enabled by default.
8555 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8557 @item -fno-guess-branch-probability
8558 @opindex fno-guess-branch-probability
8559 Do not guess branch probabilities using heuristics.
8561 GCC uses heuristics to guess branch probabilities if they are
8562 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8563 heuristics are based on the control flow graph.  If some branch probabilities
8564 are specified by @samp{__builtin_expect}, then the heuristics are
8565 used to guess branch probabilities for the rest of the control flow graph,
8566 taking the @samp{__builtin_expect} info into account.  The interactions
8567 between the heuristics and @samp{__builtin_expect} can be complex, and in
8568 some cases, it may be useful to disable the heuristics so that the effects
8569 of @samp{__builtin_expect} are easier to understand.
8571 The default is @option{-fguess-branch-probability} at levels
8572 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8574 @item -freorder-blocks
8575 @opindex freorder-blocks
8576 Reorder basic blocks in the compiled function in order to reduce number of
8577 taken branches and improve code locality.
8579 Enabled at levels @option{-O2}, @option{-O3}.
8581 @item -freorder-blocks-and-partition
8582 @opindex freorder-blocks-and-partition
8583 In addition to reordering basic blocks in the compiled function, in order
8584 to reduce number of taken branches, partitions hot and cold basic blocks
8585 into separate sections of the assembly and .o files, to improve
8586 paging and cache locality performance.
8588 This optimization is automatically turned off in the presence of
8589 exception handling, for linkonce sections, for functions with a user-defined
8590 section attribute and on any architecture that does not support named
8591 sections.
8593 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8595 @item -freorder-functions
8596 @opindex freorder-functions
8597 Reorder functions in the object file in order to
8598 improve code locality.  This is implemented by using special
8599 subsections @code{.text.hot} for most frequently executed functions and
8600 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8601 the linker so object file format must support named sections and linker must
8602 place them in a reasonable way.
8604 Also profile feedback must be available to make this option effective.  See
8605 @option{-fprofile-arcs} for details.
8607 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8609 @item -fstrict-aliasing
8610 @opindex fstrict-aliasing
8611 Allow the compiler to assume the strictest aliasing rules applicable to
8612 the language being compiled.  For C (and C++), this activates
8613 optimizations based on the type of expressions.  In particular, an
8614 object of one type is assumed never to reside at the same address as an
8615 object of a different type, unless the types are almost the same.  For
8616 example, an @code{unsigned int} can alias an @code{int}, but not a
8617 @code{void*} or a @code{double}.  A character type may alias any other
8618 type.
8620 @anchor{Type-punning}Pay special attention to code like this:
8621 @smallexample
8622 union a_union @{
8623   int i;
8624   double d;
8627 int f() @{
8628   union a_union t;
8629   t.d = 3.0;
8630   return t.i;
8632 @end smallexample
8633 The practice of reading from a different union member than the one most
8634 recently written to (called ``type-punning'') is common.  Even with
8635 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8636 is accessed through the union type.  So, the code above works as
8637 expected.  @xref{Structures unions enumerations and bit-fields
8638 implementation}.  However, this code might not:
8639 @smallexample
8640 int f() @{
8641   union a_union t;
8642   int* ip;
8643   t.d = 3.0;
8644   ip = &t.i;
8645   return *ip;
8647 @end smallexample
8649 Similarly, access by taking the address, casting the resulting pointer
8650 and dereferencing the result has undefined behavior, even if the cast
8651 uses a union type, e.g.:
8652 @smallexample
8653 int f() @{
8654   double d = 3.0;
8655   return ((union a_union *) &d)->i;
8657 @end smallexample
8659 The @option{-fstrict-aliasing} option is enabled at levels
8660 @option{-O2}, @option{-O3}, @option{-Os}.
8662 @item -fstrict-overflow
8663 @opindex fstrict-overflow
8664 Allow the compiler to assume strict signed overflow rules, depending
8665 on the language being compiled.  For C (and C++) this means that
8666 overflow when doing arithmetic with signed numbers is undefined, which
8667 means that the compiler may assume that it does not happen.  This
8668 permits various optimizations.  For example, the compiler assumes
8669 that an expression like @code{i + 10 > i} is always true for
8670 signed @code{i}.  This assumption is only valid if signed overflow is
8671 undefined, as the expression is false if @code{i + 10} overflows when
8672 using twos complement arithmetic.  When this option is in effect any
8673 attempt to determine whether an operation on signed numbers 
8674 overflows must be written carefully to not actually involve overflow.
8676 This option also allows the compiler to assume strict pointer
8677 semantics: given a pointer to an object, if adding an offset to that
8678 pointer does not produce a pointer to the same object, the addition is
8679 undefined.  This permits the compiler to conclude that @code{p + u >
8680 p} is always true for a pointer @code{p} and unsigned integer
8681 @code{u}.  This assumption is only valid because pointer wraparound is
8682 undefined, as the expression is false if @code{p + u} overflows using
8683 twos complement arithmetic.
8685 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8686 that integer signed overflow is fully defined: it wraps.  When
8687 @option{-fwrapv} is used, there is no difference between
8688 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8689 integers.  With @option{-fwrapv} certain types of overflow are
8690 permitted.  For example, if the compiler gets an overflow when doing
8691 arithmetic on constants, the overflowed value can still be used with
8692 @option{-fwrapv}, but not otherwise.
8694 The @option{-fstrict-overflow} option is enabled at levels
8695 @option{-O2}, @option{-O3}, @option{-Os}.
8697 @item -falign-functions
8698 @itemx -falign-functions=@var{n}
8699 @opindex falign-functions
8700 Align the start of functions to the next power-of-two greater than
8701 @var{n}, skipping up to @var{n} bytes.  For instance,
8702 @option{-falign-functions=32} aligns functions to the next 32-byte
8703 boundary, but @option{-falign-functions=24} aligns to the next
8704 32-byte boundary only if this can be done by skipping 23 bytes or less.
8706 @option{-fno-align-functions} and @option{-falign-functions=1} are
8707 equivalent and mean that functions are not aligned.
8709 Some assemblers only support this flag when @var{n} is a power of two;
8710 in that case, it is rounded up.
8712 If @var{n} is not specified or is zero, use a machine-dependent default.
8714 Enabled at levels @option{-O2}, @option{-O3}.
8716 @item -falign-labels
8717 @itemx -falign-labels=@var{n}
8718 @opindex falign-labels
8719 Align all branch targets to a power-of-two boundary, skipping up to
8720 @var{n} bytes like @option{-falign-functions}.  This option can easily
8721 make code slower, because it must insert dummy operations for when the
8722 branch target is reached in the usual flow of the code.
8724 @option{-fno-align-labels} and @option{-falign-labels=1} are
8725 equivalent and mean that labels are not aligned.
8727 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8728 are greater than this value, then their values are used instead.
8730 If @var{n} is not specified or is zero, use a machine-dependent default
8731 which is very likely to be @samp{1}, meaning no alignment.
8733 Enabled at levels @option{-O2}, @option{-O3}.
8735 @item -falign-loops
8736 @itemx -falign-loops=@var{n}
8737 @opindex falign-loops
8738 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8739 like @option{-falign-functions}.  If the loops are
8740 executed many times, this makes up for any execution of the dummy
8741 operations.
8743 @option{-fno-align-loops} and @option{-falign-loops=1} are
8744 equivalent and mean that loops are not aligned.
8746 If @var{n} is not specified or is zero, use a machine-dependent default.
8748 Enabled at levels @option{-O2}, @option{-O3}.
8750 @item -falign-jumps
8751 @itemx -falign-jumps=@var{n}
8752 @opindex falign-jumps
8753 Align branch targets to a power-of-two boundary, for branch targets
8754 where the targets can only be reached by jumping, skipping up to @var{n}
8755 bytes like @option{-falign-functions}.  In this case, no dummy operations
8756 need be executed.
8758 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8759 equivalent and mean that loops are not aligned.
8761 If @var{n} is not specified or is zero, use a machine-dependent default.
8763 Enabled at levels @option{-O2}, @option{-O3}.
8765 @item -funit-at-a-time
8766 @opindex funit-at-a-time
8767 This option is left for compatibility reasons. @option{-funit-at-a-time}
8768 has no effect, while @option{-fno-unit-at-a-time} implies
8769 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8771 Enabled by default.
8773 @item -fno-toplevel-reorder
8774 @opindex fno-toplevel-reorder
8775 Do not reorder top-level functions, variables, and @code{asm}
8776 statements.  Output them in the same order that they appear in the
8777 input file.  When this option is used, unreferenced static variables
8778 are not removed.  This option is intended to support existing code
8779 that relies on a particular ordering.  For new code, it is better to
8780 use attributes when possible.
8782 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8783 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8784 targets.
8786 @item -fweb
8787 @opindex fweb
8788 Constructs webs as commonly used for register allocation purposes and assign
8789 each web individual pseudo register.  This allows the register allocation pass
8790 to operate on pseudos directly, but also strengthens several other optimization
8791 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8792 however, make debugging impossible, since variables no longer stay in a
8793 ``home register''.
8795 Enabled by default with @option{-funroll-loops}.
8797 @item -fwhole-program
8798 @opindex fwhole-program
8799 Assume that the current compilation unit represents the whole program being
8800 compiled.  All public functions and variables with the exception of @code{main}
8801 and those merged by attribute @code{externally_visible} become static functions
8802 and in effect are optimized more aggressively by interprocedural optimizers.
8804 This option should not be used in combination with @code{-flto}.
8805 Instead relying on a linker plugin should provide safer and more precise
8806 information.
8808 @item -flto[=@var{n}]
8809 @opindex flto
8810 This option runs the standard link-time optimizer.  When invoked
8811 with source code, it generates GIMPLE (one of GCC's internal
8812 representations) and writes it to special ELF sections in the object
8813 file.  When the object files are linked together, all the function
8814 bodies are read from these ELF sections and instantiated as if they
8815 had been part of the same translation unit.
8817 To use the link-time optimizer, @option{-flto} and optimization
8818 options should be specified at compile time and during the final link.
8819 For example:
8821 @smallexample
8822 gcc -c -O2 -flto foo.c
8823 gcc -c -O2 -flto bar.c
8824 gcc -o myprog -flto -O2 foo.o bar.o
8825 @end smallexample
8827 The first two invocations to GCC save a bytecode representation
8828 of GIMPLE into special ELF sections inside @file{foo.o} and
8829 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8830 @file{foo.o} and @file{bar.o}, merges the two files into a single
8831 internal image, and compiles the result as usual.  Since both
8832 @file{foo.o} and @file{bar.o} are merged into a single image, this
8833 causes all the interprocedural analyses and optimizations in GCC to
8834 work across the two files as if they were a single one.  This means,
8835 for example, that the inliner is able to inline functions in
8836 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8838 Another (simpler) way to enable link-time optimization is:
8840 @smallexample
8841 gcc -o myprog -flto -O2 foo.c bar.c
8842 @end smallexample
8844 The above generates bytecode for @file{foo.c} and @file{bar.c},
8845 merges them together into a single GIMPLE representation and optimizes
8846 them as usual to produce @file{myprog}.
8848 The only important thing to keep in mind is that to enable link-time
8849 optimizations you need to use the GCC driver to perform the link-step.
8850 GCC then automatically performs link-time optimization if any of the
8851 objects involved were compiled with the @option{-flto}.  You generally
8852 should specify the optimization options to be used for link-time
8853 optimization though GCC will try to be clever at guessing an
8854 optimization level to use from the options used at compile-time
8855 if you fail to specify one at link-time.  You can always override
8856 the automatic decision to do link-time optimization at link-time
8857 by passing @option{-fno-lto} to the link command.
8859 To make whole program optimization effective, it is necessary to make
8860 certain whole program assumptions.  The compiler needs to know
8861 what functions and variables can be accessed by libraries and runtime
8862 outside of the link-time optimized unit.  When supported by the linker,
8863 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8864 to the compiler about used and externally visible symbols.  When
8865 the linker plugin is not available, @option{-fwhole-program} should be
8866 used to allow the compiler to make these assumptions, which leads
8867 to more aggressive optimization decisions.
8869 When @option{-fuse-linker-plugin} is not enabled then, when a file is
8870 compiled with @option{-flto}, the generated object file is larger than
8871 a regular object file because it contains GIMPLE bytecodes and the usual
8872 final code (see @option{-ffat-lto-objects}.  This means that
8873 object files with LTO information can be linked as normal object
8874 files; if @option{-fno-lto} is passed to the linker, no
8875 interprocedural optimizations are applied.  Note that when
8876 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
8877 but you cannot perform a regular, non-LTO link on them.
8879 Additionally, the optimization flags used to compile individual files
8880 are not necessarily related to those used at link time.  For instance,
8882 @smallexample
8883 gcc -c -O0 -ffat-lto-objects -flto foo.c
8884 gcc -c -O0 -ffat-lto-objects -flto bar.c
8885 gcc -o myprog -O3 foo.o bar.o
8886 @end smallexample
8888 This produces individual object files with unoptimized assembler
8889 code, but the resulting binary @file{myprog} is optimized at
8890 @option{-O3}.  If, instead, the final binary is generated with
8891 @option{-fno-lto}, then @file{myprog} is not optimized.
8893 When producing the final binary, GCC only
8894 applies link-time optimizations to those files that contain bytecode.
8895 Therefore, you can mix and match object files and libraries with
8896 GIMPLE bytecodes and final object code.  GCC automatically selects
8897 which files to optimize in LTO mode and which files to link without
8898 further processing.
8900 There are some code generation flags preserved by GCC when
8901 generating bytecodes, as they need to be used during the final link
8902 stage.  Generally options specified at link-time override those
8903 specified at compile-time.
8905 If you do not specify an optimization level option @option{-O} at
8906 link-time then GCC will compute one based on the optimization levels
8907 used when compiling the object files.  The highest optimization
8908 level will win here.
8910 Currently, the following options and their setting are take from
8911 the first object file that explicitely specified it: 
8912 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8913 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8914 and all the @option{-m} target flags.
8916 Certain ABI changing flags are required to match in all compilation-units
8917 and trying to override this at link-time with a conflicting value
8918 is ignored.  This includes options such as @option{-freg-struct-return}
8919 and @option{-fpcc-struct-return}. 
8921 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8922 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8923 are passed through to the link stage and merged conservatively for
8924 conflicting translation units.  Specifically
8925 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8926 precedence and for example @option{-ffp-contract=off} takes precedence
8927 over @option{-ffp-contract=fast}.  You can override them at linke-time.
8929 It is recommended that you compile all the files participating in the
8930 same link with the same options and also specify those options at
8931 link time.
8933 If LTO encounters objects with C linkage declared with incompatible
8934 types in separate translation units to be linked together (undefined
8935 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8936 issued.  The behavior is still undefined at run time.  Similar
8937 diagnostics may be raised for other languages.
8939 Another feature of LTO is that it is possible to apply interprocedural
8940 optimizations on files written in different languages:
8942 @smallexample
8943 gcc -c -flto foo.c
8944 g++ -c -flto bar.cc
8945 gfortran -c -flto baz.f90
8946 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8947 @end smallexample
8949 Notice that the final link is done with @command{g++} to get the C++
8950 runtime libraries and @option{-lgfortran} is added to get the Fortran
8951 runtime libraries.  In general, when mixing languages in LTO mode, you
8952 should use the same link command options as when mixing languages in a
8953 regular (non-LTO) compilation.
8955 If object files containing GIMPLE bytecode are stored in a library archive, say
8956 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8957 are using a linker with plugin support.  To create static libraries suitable
8958 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8959 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
8960 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8961 and @command{nm} have been compiled with plugin support.  At link time, use the the
8962 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8963 the LTO optimization process:
8965 @smallexample
8966 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8967 @end smallexample
8969 With the linker plugin enabled, the linker extracts the needed
8970 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8971 to make them part of the aggregated GIMPLE image to be optimized.
8973 If you are not using a linker with plugin support and/or do not
8974 enable the linker plugin, then the objects inside @file{libfoo.a}
8975 are extracted and linked as usual, but they do not participate
8976 in the LTO optimization process.  In order to make a static library suitable
8977 for both LTO optimization and usual linkage, compile its object files with
8978 @option{-flto} @code{-ffat-lto-objects}.
8980 Link-time optimizations do not require the presence of the whole program to
8981 operate.  If the program does not require any symbols to be exported, it is
8982 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8983 the interprocedural optimizers to use more aggressive assumptions which may
8984 lead to improved optimization opportunities.
8985 Use of @option{-fwhole-program} is not needed when linker plugin is
8986 active (see @option{-fuse-linker-plugin}).
8988 The current implementation of LTO makes no
8989 attempt to generate bytecode that is portable between different
8990 types of hosts.  The bytecode files are versioned and there is a
8991 strict version check, so bytecode files generated in one version of
8992 GCC will not work with an older or newer version of GCC.
8994 Link-time optimization does not work well with generation of debugging
8995 information.  Combining @option{-flto} with
8996 @option{-g} is currently experimental and expected to produce unexpected
8997 results.
8999 If you specify the optional @var{n}, the optimization and code
9000 generation done at link time is executed in parallel using @var{n}
9001 parallel jobs by utilizing an installed @command{make} program.  The
9002 environment variable @env{MAKE} may be used to override the program
9003 used.  The default value for @var{n} is 1.
9005 You can also specify @option{-flto=jobserver} to use GNU make's
9006 job server mode to determine the number of parallel jobs. This
9007 is useful when the Makefile calling GCC is already executing in parallel.
9008 You must prepend a @samp{+} to the command recipe in the parent Makefile
9009 for this to work.  This option likely only works if @env{MAKE} is
9010 GNU make.
9012 @item -flto-partition=@var{alg}
9013 @opindex flto-partition
9014 Specify the partitioning algorithm used by the link-time optimizer.
9015 The value is either @code{1to1} to specify a partitioning mirroring
9016 the original source files or @code{balanced} to specify partitioning
9017 into equally sized chunks (whenever possible) or @code{max} to create
9018 new partition for every symbol where possible.  Specifying @code{none}
9019 as an algorithm disables partitioning and streaming completely. 
9020 The default value is @code{balanced}. While @code{1to1} can be used
9021 as an workaround for various code ordering issues, the @code{max}
9022 partitioning is intended for internal testing only.
9023 The value @code{one} specifies that exactly one partition should be
9024 used while the value @code{none} bypasses partitioning and executes
9025 the link-time optimization step directly from the WPA phase.
9027 @item -flto-odr-type-merging
9028 @opindex flto-odr-type-merging
9029 Enable streaming of mangled types names of C++ types and their unification
9030 at linktime.  This increases size of LTO object files, but enable
9031 diagnostics about One Definition Rule violations.
9033 @item -flto-compression-level=@var{n}
9034 This option specifies the level of compression used for intermediate
9035 language written to LTO object files, and is only meaningful in
9036 conjunction with LTO mode (@option{-flto}).  Valid
9037 values are 0 (no compression) to 9 (maximum compression).  Values
9038 outside this range are clamped to either 0 or 9.  If the option is not
9039 given, a default balanced compression setting is used.
9041 @item -flto-report
9042 Prints a report with internal details on the workings of the link-time
9043 optimizer.  The contents of this report vary from version to version.
9044 It is meant to be useful to GCC developers when processing object
9045 files in LTO mode (via @option{-flto}).
9047 Disabled by default.
9049 @item -flto-report-wpa
9050 Like @option{-flto-report}, but only print for the WPA phase of Link
9051 Time Optimization.
9053 @item -fuse-linker-plugin
9054 Enables the use of a linker plugin during link-time optimization.  This
9055 option relies on plugin support in the linker, which is available in gold
9056 or in GNU ld 2.21 or newer.
9058 This option enables the extraction of object files with GIMPLE bytecode out
9059 of library archives. This improves the quality of optimization by exposing
9060 more code to the link-time optimizer.  This information specifies what
9061 symbols can be accessed externally (by non-LTO object or during dynamic
9062 linking).  Resulting code quality improvements on binaries (and shared
9063 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
9064 See @option{-flto} for a description of the effect of this flag and how to
9065 use it.
9067 This option is enabled by default when LTO support in GCC is enabled
9068 and GCC was configured for use with
9069 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9071 @item -ffat-lto-objects
9072 @opindex ffat-lto-objects
9073 Fat LTO objects are object files that contain both the intermediate language
9074 and the object code. This makes them usable for both LTO linking and normal
9075 linking. This option is effective only when compiling with @option{-flto}
9076 and is ignored at link time.
9078 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9079 requires the complete toolchain to be aware of LTO. It requires a linker with
9080 linker plugin support for basic functionality.  Additionally,
9081 @command{nm}, @command{ar} and @command{ranlib}
9082 need to support linker plugins to allow a full-featured build environment
9083 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9084 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9085 to these tools. With non fat LTO makefiles need to be modified to use them.
9087 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9088 support.
9090 @item -fcompare-elim
9091 @opindex fcompare-elim
9092 After register allocation and post-register allocation instruction splitting,
9093 identify arithmetic instructions that compute processor flags similar to a
9094 comparison operation based on that arithmetic.  If possible, eliminate the
9095 explicit comparison operation.
9097 This pass only applies to certain targets that cannot explicitly represent
9098 the comparison operation before register allocation is complete.
9100 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9102 @item -fuse-ld=bfd
9103 @opindex fuse-ld=bfd
9104 Use the @command{bfd} linker instead of the default linker.
9106 @item -fuse-ld=gold
9107 @opindex fuse-ld=gold
9108 Use the @command{gold} linker instead of the default linker.
9110 @item -fcprop-registers
9111 @opindex fcprop-registers
9112 After register allocation and post-register allocation instruction splitting,
9113 perform a copy-propagation pass to try to reduce scheduling dependencies
9114 and occasionally eliminate the copy.
9116 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9118 @item -fprofile-correction
9119 @opindex fprofile-correction
9120 Profiles collected using an instrumented binary for multi-threaded programs may
9121 be inconsistent due to missed counter updates. When this option is specified,
9122 GCC uses heuristics to correct or smooth out such inconsistencies. By
9123 default, GCC emits an error message when an inconsistent profile is detected.
9125 @item -fprofile-dir=@var{path}
9126 @opindex fprofile-dir
9128 Set the directory to search for the profile data files in to @var{path}.
9129 This option affects only the profile data generated by
9130 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9131 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9132 and its related options.  Both absolute and relative paths can be used.
9133 By default, GCC uses the current directory as @var{path}, thus the
9134 profile data file appears in the same directory as the object file.
9136 @item -fprofile-generate
9137 @itemx -fprofile-generate=@var{path}
9138 @opindex fprofile-generate
9140 Enable options usually used for instrumenting application to produce
9141 profile useful for later recompilation with profile feedback based
9142 optimization.  You must use @option{-fprofile-generate} both when
9143 compiling and when linking your program.
9145 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
9147 If @var{path} is specified, GCC looks at the @var{path} to find
9148 the profile feedback data files. See @option{-fprofile-dir}.
9150 @item -fprofile-use
9151 @itemx -fprofile-use=@var{path}
9152 @opindex fprofile-use
9153 Enable profile feedback directed optimizations, and optimizations
9154 generally profitable only with profile feedback available.
9156 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9157 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9158 @code{ftree-loop-distribute-patterns}
9160 By default, GCC emits an error message if the feedback profiles do not
9161 match the source code.  This error can be turned into a warning by using
9162 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9163 code.
9165 If @var{path} is specified, GCC looks at the @var{path} to find
9166 the profile feedback data files. See @option{-fprofile-dir}.
9167 @end table
9169 The following options control compiler behavior regarding floating-point 
9170 arithmetic.  These options trade off between speed and
9171 correctness.  All must be specifically enabled.
9173 @table @gcctabopt
9174 @item -ffloat-store
9175 @opindex ffloat-store
9176 Do not store floating-point variables in registers, and inhibit other
9177 options that might change whether a floating-point value is taken from a
9178 register or memory.
9180 @cindex floating-point precision
9181 This option prevents undesirable excess precision on machines such as
9182 the 68000 where the floating registers (of the 68881) keep more
9183 precision than a @code{double} is supposed to have.  Similarly for the
9184 x86 architecture.  For most programs, the excess precision does only
9185 good, but a few programs rely on the precise definition of IEEE floating
9186 point.  Use @option{-ffloat-store} for such programs, after modifying
9187 them to store all pertinent intermediate computations into variables.
9189 @item -fexcess-precision=@var{style}
9190 @opindex fexcess-precision
9191 This option allows further control over excess precision on machines
9192 where floating-point registers have more precision than the IEEE
9193 @code{float} and @code{double} types and the processor does not
9194 support operations rounding to those types.  By default,
9195 @option{-fexcess-precision=fast} is in effect; this means that
9196 operations are carried out in the precision of the registers and that
9197 it is unpredictable when rounding to the types specified in the source
9198 code takes place.  When compiling C, if
9199 @option{-fexcess-precision=standard} is specified then excess
9200 precision follows the rules specified in ISO C99; in particular,
9201 both casts and assignments cause values to be rounded to their
9202 semantic types (whereas @option{-ffloat-store} only affects
9203 assignments).  This option is enabled by default for C if a strict
9204 conformance option such as @option{-std=c99} is used.
9206 @opindex mfpmath
9207 @option{-fexcess-precision=standard} is not implemented for languages
9208 other than C, and has no effect if
9209 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9210 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9211 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9212 semantics apply without excess precision, and in the latter, rounding
9213 is unpredictable.
9215 @item -ffast-math
9216 @opindex ffast-math
9217 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9218 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9219 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9221 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9223 This option is not turned on by any @option{-O} option besides
9224 @option{-Ofast} since it can result in incorrect output for programs
9225 that depend on an exact implementation of IEEE or ISO rules/specifications
9226 for math functions. It may, however, yield faster code for programs
9227 that do not require the guarantees of these specifications.
9229 @item -fno-math-errno
9230 @opindex fno-math-errno
9231 Do not set @code{errno} after calling math functions that are executed
9232 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9233 IEEE exceptions for math error handling may want to use this flag
9234 for speed while maintaining IEEE arithmetic compatibility.
9236 This option is not turned on by any @option{-O} option since
9237 it can result in incorrect output for programs that depend on
9238 an exact implementation of IEEE or ISO rules/specifications for
9239 math functions. It may, however, yield faster code for programs
9240 that do not require the guarantees of these specifications.
9242 The default is @option{-fmath-errno}.
9244 On Darwin systems, the math library never sets @code{errno}.  There is
9245 therefore no reason for the compiler to consider the possibility that
9246 it might, and @option{-fno-math-errno} is the default.
9248 @item -funsafe-math-optimizations
9249 @opindex funsafe-math-optimizations
9251 Allow optimizations for floating-point arithmetic that (a) assume
9252 that arguments and results are valid and (b) may violate IEEE or
9253 ANSI standards.  When used at link-time, it may include libraries
9254 or startup files that change the default FPU control word or other
9255 similar optimizations.
9257 This option is not turned on by any @option{-O} option since
9258 it can result in incorrect output for programs that depend on
9259 an exact implementation of IEEE or ISO rules/specifications for
9260 math functions. It may, however, yield faster code for programs
9261 that do not require the guarantees of these specifications.
9262 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9263 @option{-fassociative-math} and @option{-freciprocal-math}.
9265 The default is @option{-fno-unsafe-math-optimizations}.
9267 @item -fassociative-math
9268 @opindex fassociative-math
9270 Allow re-association of operands in series of floating-point operations.
9271 This violates the ISO C and C++ language standard by possibly changing
9272 computation result.  NOTE: re-ordering may change the sign of zero as
9273 well as ignore NaNs and inhibit or create underflow or overflow (and
9274 thus cannot be used on code that relies on rounding behavior like
9275 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9276 and thus may not be used when ordered comparisons are required.
9277 This option requires that both @option{-fno-signed-zeros} and
9278 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9279 much sense with @option{-frounding-math}. For Fortran the option
9280 is automatically enabled when both @option{-fno-signed-zeros} and
9281 @option{-fno-trapping-math} are in effect.
9283 The default is @option{-fno-associative-math}.
9285 @item -freciprocal-math
9286 @opindex freciprocal-math
9288 Allow the reciprocal of a value to be used instead of dividing by
9289 the value if this enables optimizations.  For example @code{x / y}
9290 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9291 is subject to common subexpression elimination.  Note that this loses
9292 precision and increases the number of flops operating on the value.
9294 The default is @option{-fno-reciprocal-math}.
9296 @item -ffinite-math-only
9297 @opindex ffinite-math-only
9298 Allow optimizations for floating-point arithmetic that assume
9299 that arguments and results are not NaNs or +-Infs.
9301 This option is not turned on by any @option{-O} option since
9302 it can result in incorrect output for programs that depend on
9303 an exact implementation of IEEE or ISO rules/specifications for
9304 math functions. It may, however, yield faster code for programs
9305 that do not require the guarantees of these specifications.
9307 The default is @option{-fno-finite-math-only}.
9309 @item -fno-signed-zeros
9310 @opindex fno-signed-zeros
9311 Allow optimizations for floating-point arithmetic that ignore the
9312 signedness of zero.  IEEE arithmetic specifies the behavior of
9313 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9314 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9315 This option implies that the sign of a zero result isn't significant.
9317 The default is @option{-fsigned-zeros}.
9319 @item -fno-trapping-math
9320 @opindex fno-trapping-math
9321 Compile code assuming that floating-point operations cannot generate
9322 user-visible traps.  These traps include division by zero, overflow,
9323 underflow, inexact result and invalid operation.  This option requires
9324 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9325 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9327 This option should never be turned on by any @option{-O} option since
9328 it can result in incorrect output for programs that depend on
9329 an exact implementation of IEEE or ISO rules/specifications for
9330 math functions.
9332 The default is @option{-ftrapping-math}.
9334 @item -frounding-math
9335 @opindex frounding-math
9336 Disable transformations and optimizations that assume default floating-point
9337 rounding behavior.  This is round-to-zero for all floating point
9338 to integer conversions, and round-to-nearest for all other arithmetic
9339 truncations.  This option should be specified for programs that change
9340 the FP rounding mode dynamically, or that may be executed with a
9341 non-default rounding mode.  This option disables constant folding of
9342 floating-point expressions at compile time (which may be affected by
9343 rounding mode) and arithmetic transformations that are unsafe in the
9344 presence of sign-dependent rounding modes.
9346 The default is @option{-fno-rounding-math}.
9348 This option is experimental and does not currently guarantee to
9349 disable all GCC optimizations that are affected by rounding mode.
9350 Future versions of GCC may provide finer control of this setting
9351 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9352 will be used to specify the default state for @code{FENV_ACCESS}.
9354 @item -fsignaling-nans
9355 @opindex fsignaling-nans
9356 Compile code assuming that IEEE signaling NaNs may generate user-visible
9357 traps during floating-point operations.  Setting this option disables
9358 optimizations that may change the number of exceptions visible with
9359 signaling NaNs.  This option implies @option{-ftrapping-math}.
9361 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9362 be defined.
9364 The default is @option{-fno-signaling-nans}.
9366 This option is experimental and does not currently guarantee to
9367 disable all GCC optimizations that affect signaling NaN behavior.
9369 @item -fsingle-precision-constant
9370 @opindex fsingle-precision-constant
9371 Treat floating-point constants as single precision instead of
9372 implicitly converting them to double-precision constants.
9374 @item -fcx-limited-range
9375 @opindex fcx-limited-range
9376 When enabled, this option states that a range reduction step is not
9377 needed when performing complex division.  Also, there is no checking
9378 whether the result of a complex multiplication or division is @code{NaN
9379 + I*NaN}, with an attempt to rescue the situation in that case.  The
9380 default is @option{-fno-cx-limited-range}, but is enabled by
9381 @option{-ffast-math}.
9383 This option controls the default setting of the ISO C99
9384 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9385 all languages.
9387 @item -fcx-fortran-rules
9388 @opindex fcx-fortran-rules
9389 Complex multiplication and division follow Fortran rules.  Range
9390 reduction is done as part of complex division, but there is no checking
9391 whether the result of a complex multiplication or division is @code{NaN
9392 + I*NaN}, with an attempt to rescue the situation in that case.
9394 The default is @option{-fno-cx-fortran-rules}.
9396 @end table
9398 The following options control optimizations that may improve
9399 performance, but are not enabled by any @option{-O} options.  This
9400 section includes experimental options that may produce broken code.
9402 @table @gcctabopt
9403 @item -fbranch-probabilities
9404 @opindex fbranch-probabilities
9405 After running a program compiled with @option{-fprofile-arcs}
9406 (@pxref{Debugging Options,, Options for Debugging Your Program or
9407 @command{gcc}}), you can compile it a second time using
9408 @option{-fbranch-probabilities}, to improve optimizations based on
9409 the number of times each branch was taken.  When a program
9410 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9411 counts to a file called @file{@var{sourcename}.gcda} for each source
9412 file.  The information in this data file is very dependent on the
9413 structure of the generated code, so you must use the same source code
9414 and the same optimization options for both compilations.
9416 With @option{-fbranch-probabilities}, GCC puts a
9417 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9418 These can be used to improve optimization.  Currently, they are only
9419 used in one place: in @file{reorg.c}, instead of guessing which path a
9420 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9421 exactly determine which path is taken more often.
9423 @item -fprofile-values
9424 @opindex fprofile-values
9425 If combined with @option{-fprofile-arcs}, it adds code so that some
9426 data about values of expressions in the program is gathered.
9428 With @option{-fbranch-probabilities}, it reads back the data gathered
9429 from profiling values of expressions for usage in optimizations.
9431 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9433 @item -fprofile-reorder-functions
9434 @opindex fprofile-reorder-functions
9435 Function reordering based on profile instrumentation collects
9436 first time of execution of a function and orders these functions
9437 in ascending order.
9439 Enabled with @option{-fprofile-use}.
9441 @item -fvpt
9442 @opindex fvpt
9443 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9444 to add code to gather information about values of expressions.
9446 With @option{-fbranch-probabilities}, it reads back the data gathered
9447 and actually performs the optimizations based on them.
9448 Currently the optimizations include specialization of division operations
9449 using the knowledge about the value of the denominator.
9451 @item -frename-registers
9452 @opindex frename-registers
9453 Attempt to avoid false dependencies in scheduled code by making use
9454 of registers left over after register allocation.  This optimization
9455 most benefits processors with lots of registers.  Depending on the
9456 debug information format adopted by the target, however, it can
9457 make debugging impossible, since variables no longer stay in
9458 a ``home register''.
9460 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9462 @item -ftracer
9463 @opindex ftracer
9464 Perform tail duplication to enlarge superblock size.  This transformation
9465 simplifies the control flow of the function allowing other optimizations to do
9466 a better job.
9468 Enabled with @option{-fprofile-use}.
9470 @item -funroll-loops
9471 @opindex funroll-loops
9472 Unroll loops whose number of iterations can be determined at compile time or
9473 upon entry to the loop.  @option{-funroll-loops} implies
9474 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9475 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9476 a small constant number of iterations).  This option makes code larger, and may
9477 or may not make it run faster.
9479 Enabled with @option{-fprofile-use}.
9481 @item -funroll-all-loops
9482 @opindex funroll-all-loops
9483 Unroll all loops, even if their number of iterations is uncertain when
9484 the loop is entered.  This usually makes programs run more slowly.
9485 @option{-funroll-all-loops} implies the same options as
9486 @option{-funroll-loops}.
9488 @item -fpeel-loops
9489 @opindex fpeel-loops
9490 Peels loops for which there is enough information that they do not
9491 roll much (from profile feedback).  It also turns on complete loop peeling
9492 (i.e.@: complete removal of loops with small constant number of iterations).
9494 Enabled with @option{-fprofile-use}.
9496 @item -fmove-loop-invariants
9497 @opindex fmove-loop-invariants
9498 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9499 at level @option{-O1}
9501 @item -funswitch-loops
9502 @opindex funswitch-loops
9503 Move branches with loop invariant conditions out of the loop, with duplicates
9504 of the loop on both branches (modified according to result of the condition).
9506 @item -ffunction-sections
9507 @itemx -fdata-sections
9508 @opindex ffunction-sections
9509 @opindex fdata-sections
9510 Place each function or data item into its own section in the output
9511 file if the target supports arbitrary sections.  The name of the
9512 function or the name of the data item determines the section's name
9513 in the output file.
9515 Use these options on systems where the linker can perform optimizations
9516 to improve locality of reference in the instruction space.  Most systems
9517 using the ELF object format and SPARC processors running Solaris 2 have
9518 linkers with such optimizations.  AIX may have these optimizations in
9519 the future.
9521 Only use these options when there are significant benefits from doing
9522 so.  When you specify these options, the assembler and linker
9523 create larger object and executable files and are also slower.
9524 You cannot use @code{gprof} on all systems if you
9525 specify this option, and you may have problems with debugging if
9526 you specify both this option and @option{-g}.
9528 @item -fbranch-target-load-optimize
9529 @opindex fbranch-target-load-optimize
9530 Perform branch target register load optimization before prologue / epilogue
9531 threading.
9532 The use of target registers can typically be exposed only during reload,
9533 thus hoisting loads out of loops and doing inter-block scheduling needs
9534 a separate optimization pass.
9536 @item -fbranch-target-load-optimize2
9537 @opindex fbranch-target-load-optimize2
9538 Perform branch target register load optimization after prologue / epilogue
9539 threading.
9541 @item -fbtr-bb-exclusive
9542 @opindex fbtr-bb-exclusive
9543 When performing branch target register load optimization, don't reuse
9544 branch target registers within any basic block.
9546 @item -fstack-protector
9547 @opindex fstack-protector
9548 Emit extra code to check for buffer overflows, such as stack smashing
9549 attacks.  This is done by adding a guard variable to functions with
9550 vulnerable objects.  This includes functions that call @code{alloca}, and
9551 functions with buffers larger than 8 bytes.  The guards are initialized
9552 when a function is entered and then checked when the function exits.
9553 If a guard check fails, an error message is printed and the program exits.
9555 @item -fstack-protector-all
9556 @opindex fstack-protector-all
9557 Like @option{-fstack-protector} except that all functions are protected.
9559 @item -fstack-protector-strong
9560 @opindex fstack-protector-strong
9561 Like @option{-fstack-protector} but includes additional functions to
9562 be protected --- those that have local array definitions, or have
9563 references to local frame addresses.
9565 @item -fsection-anchors
9566 @opindex fsection-anchors
9567 Try to reduce the number of symbolic address calculations by using
9568 shared ``anchor'' symbols to address nearby objects.  This transformation
9569 can help to reduce the number of GOT entries and GOT accesses on some
9570 targets.
9572 For example, the implementation of the following function @code{foo}:
9574 @smallexample
9575 static int a, b, c;
9576 int foo (void) @{ return a + b + c; @}
9577 @end smallexample
9579 @noindent
9580 usually calculates the addresses of all three variables, but if you
9581 compile it with @option{-fsection-anchors}, it accesses the variables
9582 from a common anchor point instead.  The effect is similar to the
9583 following pseudocode (which isn't valid C):
9585 @smallexample
9586 int foo (void)
9588   register int *xr = &x;
9589   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9591 @end smallexample
9593 Not all targets support this option.
9595 @item --param @var{name}=@var{value}
9596 @opindex param
9597 In some places, GCC uses various constants to control the amount of
9598 optimization that is done.  For example, GCC does not inline functions
9599 that contain more than a certain number of instructions.  You can
9600 control some of these constants on the command line using the
9601 @option{--param} option.
9603 The names of specific parameters, and the meaning of the values, are
9604 tied to the internals of the compiler, and are subject to change
9605 without notice in future releases.
9607 In each case, the @var{value} is an integer.  The allowable choices for
9608 @var{name} are:
9610 @table @gcctabopt
9611 @item predictable-branch-outcome
9612 When branch is predicted to be taken with probability lower than this threshold
9613 (in percent), then it is considered well predictable. The default is 10.
9615 @item max-crossjump-edges
9616 The maximum number of incoming edges to consider for cross-jumping.
9617 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9618 the number of edges incoming to each block.  Increasing values mean
9619 more aggressive optimization, making the compilation time increase with
9620 probably small improvement in executable size.
9622 @item min-crossjump-insns
9623 The minimum number of instructions that must be matched at the end
9624 of two blocks before cross-jumping is performed on them.  This
9625 value is ignored in the case where all instructions in the block being
9626 cross-jumped from are matched.  The default value is 5.
9628 @item max-grow-copy-bb-insns
9629 The maximum code size expansion factor when copying basic blocks
9630 instead of jumping.  The expansion is relative to a jump instruction.
9631 The default value is 8.
9633 @item max-goto-duplication-insns
9634 The maximum number of instructions to duplicate to a block that jumps
9635 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9636 passes, GCC factors computed gotos early in the compilation process,
9637 and unfactors them as late as possible.  Only computed jumps at the
9638 end of a basic blocks with no more than max-goto-duplication-insns are
9639 unfactored.  The default value is 8.
9641 @item max-delay-slot-insn-search
9642 The maximum number of instructions to consider when looking for an
9643 instruction to fill a delay slot.  If more than this arbitrary number of
9644 instructions are searched, the time savings from filling the delay slot
9645 are minimal, so stop searching.  Increasing values mean more
9646 aggressive optimization, making the compilation time increase with probably
9647 small improvement in execution time.
9649 @item max-delay-slot-live-search
9650 When trying to fill delay slots, the maximum number of instructions to
9651 consider when searching for a block with valid live register
9652 information.  Increasing this arbitrarily chosen value means more
9653 aggressive optimization, increasing the compilation time.  This parameter
9654 should be removed when the delay slot code is rewritten to maintain the
9655 control-flow graph.
9657 @item max-gcse-memory
9658 The approximate maximum amount of memory that can be allocated in
9659 order to perform the global common subexpression elimination
9660 optimization.  If more memory than specified is required, the
9661 optimization is not done.
9663 @item max-gcse-insertion-ratio
9664 If the ratio of expression insertions to deletions is larger than this value
9665 for any expression, then RTL PRE inserts or removes the expression and thus
9666 leaves partially redundant computations in the instruction stream.  The default value is 20.
9668 @item max-pending-list-length
9669 The maximum number of pending dependencies scheduling allows
9670 before flushing the current state and starting over.  Large functions
9671 with few branches or calls can create excessively large lists which
9672 needlessly consume memory and resources.
9674 @item max-modulo-backtrack-attempts
9675 The maximum number of backtrack attempts the scheduler should make
9676 when modulo scheduling a loop.  Larger values can exponentially increase
9677 compilation time.
9679 @item max-inline-insns-single
9680 Several parameters control the tree inliner used in GCC@.
9681 This number sets the maximum number of instructions (counted in GCC's
9682 internal representation) in a single function that the tree inliner
9683 considers for inlining.  This only affects functions declared
9684 inline and methods implemented in a class declaration (C++).
9685 The default value is 400.
9687 @item max-inline-insns-auto
9688 When you use @option{-finline-functions} (included in @option{-O3}),
9689 a lot of functions that would otherwise not be considered for inlining
9690 by the compiler are investigated.  To those functions, a different
9691 (more restrictive) limit compared to functions declared inline can
9692 be applied.
9693 The default value is 40.
9695 @item inline-min-speedup
9696 When estimated performance improvement of caller + callee runtime exceeds this
9697 threshold (in precent), the function can be inlined regardless the limit on
9698 @option{--param max-inline-insns-single} and @option{--param
9699 max-inline-insns-auto}.
9701 @item large-function-insns
9702 The limit specifying really large functions.  For functions larger than this
9703 limit after inlining, inlining is constrained by
9704 @option{--param large-function-growth}.  This parameter is useful primarily
9705 to avoid extreme compilation time caused by non-linear algorithms used by the
9706 back end.
9707 The default value is 2700.
9709 @item large-function-growth
9710 Specifies maximal growth of large function caused by inlining in percents.
9711 The default value is 100 which limits large function growth to 2.0 times
9712 the original size.
9714 @item large-unit-insns
9715 The limit specifying large translation unit.  Growth caused by inlining of
9716 units larger than this limit is limited by @option{--param inline-unit-growth}.
9717 For small units this might be too tight.
9718 For example, consider a unit consisting of function A
9719 that is inline and B that just calls A three times.  If B is small relative to
9720 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9721 large units consisting of small inlineable functions, however, the overall unit
9722 growth limit is needed to avoid exponential explosion of code size.  Thus for
9723 smaller units, the size is increased to @option{--param large-unit-insns}
9724 before applying @option{--param inline-unit-growth}.  The default is 10000.
9726 @item inline-unit-growth
9727 Specifies maximal overall growth of the compilation unit caused by inlining.
9728 The default value is 30 which limits unit growth to 1.3 times the original
9729 size. Cold functions (either marked cold via an attribute or by profile
9730 feedback) are not accounted into the unit size.
9732 @item ipcp-unit-growth
9733 Specifies maximal overall growth of the compilation unit caused by
9734 interprocedural constant propagation.  The default value is 10 which limits
9735 unit growth to 1.1 times the original size.
9737 @item large-stack-frame
9738 The limit specifying large stack frames.  While inlining the algorithm is trying
9739 to not grow past this limit too much.  The default value is 256 bytes.
9741 @item large-stack-frame-growth
9742 Specifies maximal growth of large stack frames caused by inlining in percents.
9743 The default value is 1000 which limits large stack frame growth to 11 times
9744 the original size.
9746 @item max-inline-insns-recursive
9747 @itemx max-inline-insns-recursive-auto
9748 Specifies the maximum number of instructions an out-of-line copy of a
9749 self-recursive inline
9750 function can grow into by performing recursive inlining.
9752 For functions declared inline, @option{--param max-inline-insns-recursive} is
9753 taken into account.  For functions not declared inline, recursive inlining
9754 happens only when @option{-finline-functions} (included in @option{-O3}) is
9755 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9756 default value is 450.
9758 @item max-inline-recursive-depth
9759 @itemx max-inline-recursive-depth-auto
9760 Specifies the maximum recursion depth used for recursive inlining.
9762 For functions declared inline, @option{--param max-inline-recursive-depth} is
9763 taken into account.  For functions not declared inline, recursive inlining
9764 happens only when @option{-finline-functions} (included in @option{-O3}) is
9765 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9766 default value is 8.
9768 @item min-inline-recursive-probability
9769 Recursive inlining is profitable only for function having deep recursion
9770 in average and can hurt for function having little recursion depth by
9771 increasing the prologue size or complexity of function body to other
9772 optimizers.
9774 When profile feedback is available (see @option{-fprofile-generate}) the actual
9775 recursion depth can be guessed from probability that function recurses via a
9776 given call expression.  This parameter limits inlining only to call expressions
9777 whose probability exceeds the given threshold (in percents).
9778 The default value is 10.
9780 @item early-inlining-insns
9781 Specify growth that the early inliner can make.  In effect it increases
9782 the amount of inlining for code having a large abstraction penalty.
9783 The default value is 10.
9785 @item max-early-inliner-iterations
9786 @itemx max-early-inliner-iterations
9787 Limit of iterations of the early inliner.  This basically bounds
9788 the number of nested indirect calls the early inliner can resolve.
9789 Deeper chains are still handled by late inlining.
9791 @item comdat-sharing-probability
9792 @itemx comdat-sharing-probability
9793 Probability (in percent) that C++ inline function with comdat visibility
9794 are shared across multiple compilation units.  The default value is 20.
9796 @item profile-func-internal-id
9797 @itemx profile-func-internal-id
9798 A parameter to control whether to use function internal id in profile
9799 database lookup. If the value is 0, the compiler will use id that
9800 is based on function assembler name and filename, which makes old profile
9801 data more tolerant to source changes such as function reordering etc.
9802 The default value is 0.
9804 @item min-vect-loop-bound
9805 The minimum number of iterations under which loops are not vectorized
9806 when @option{-ftree-vectorize} is used.  The number of iterations after
9807 vectorization needs to be greater than the value specified by this option
9808 to allow vectorization.  The default value is 0.
9810 @item gcse-cost-distance-ratio
9811 Scaling factor in calculation of maximum distance an expression
9812 can be moved by GCSE optimizations.  This is currently supported only in the
9813 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9814 is with simple expressions, i.e., the expressions that have cost
9815 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9816 hoisting of simple expressions.  The default value is 10.
9818 @item gcse-unrestricted-cost
9819 Cost, roughly measured as the cost of a single typical machine
9820 instruction, at which GCSE optimizations do not constrain
9821 the distance an expression can travel.  This is currently
9822 supported only in the code hoisting pass.  The lesser the cost,
9823 the more aggressive code hoisting is.  Specifying 0 
9824 allows all expressions to travel unrestricted distances.
9825 The default value is 3.
9827 @item max-hoist-depth
9828 The depth of search in the dominator tree for expressions to hoist.
9829 This is used to avoid quadratic behavior in hoisting algorithm.
9830 The value of 0 does not limit on the search, but may slow down compilation
9831 of huge functions.  The default value is 30.
9833 @item max-tail-merge-comparisons
9834 The maximum amount of similar bbs to compare a bb with.  This is used to
9835 avoid quadratic behavior in tree tail merging.  The default value is 10.
9837 @item max-tail-merge-iterations
9838 The maximum amount of iterations of the pass over the function.  This is used to
9839 limit compilation time in tree tail merging.  The default value is 2.
9841 @item max-unrolled-insns
9842 The maximum number of instructions that a loop may have to be unrolled.
9843 If a loop is unrolled, this parameter also determines how many times
9844 the loop code is unrolled.
9846 @item max-average-unrolled-insns
9847 The maximum number of instructions biased by probabilities of their execution
9848 that a loop may have to be unrolled.  If a loop is unrolled,
9849 this parameter also determines how many times the loop code is unrolled.
9851 @item max-unroll-times
9852 The maximum number of unrollings of a single loop.
9854 @item max-peeled-insns
9855 The maximum number of instructions that a loop may have to be peeled.
9856 If a loop is peeled, this parameter also determines how many times
9857 the loop code is peeled.
9859 @item max-peel-times
9860 The maximum number of peelings of a single loop.
9862 @item max-peel-branches
9863 The maximum number of branches on the hot path through the peeled sequence.
9865 @item max-completely-peeled-insns
9866 The maximum number of insns of a completely peeled loop.
9868 @item max-completely-peel-times
9869 The maximum number of iterations of a loop to be suitable for complete peeling.
9871 @item max-completely-peel-loop-nest-depth
9872 The maximum depth of a loop nest suitable for complete peeling.
9874 @item max-unswitch-insns
9875 The maximum number of insns of an unswitched loop.
9877 @item max-unswitch-level
9878 The maximum number of branches unswitched in a single loop.
9880 @item lim-expensive
9881 The minimum cost of an expensive expression in the loop invariant motion.
9883 @item iv-consider-all-candidates-bound
9884 Bound on number of candidates for induction variables, below which
9885 all candidates are considered for each use in induction variable
9886 optimizations.  If there are more candidates than this,
9887 only the most relevant ones are considered to avoid quadratic time complexity.
9889 @item iv-max-considered-uses
9890 The induction variable optimizations give up on loops that contain more
9891 induction variable uses.
9893 @item iv-always-prune-cand-set-bound
9894 If the number of candidates in the set is smaller than this value,
9895 always try to remove unnecessary ivs from the set
9896 when adding a new one.
9898 @item scev-max-expr-size
9899 Bound on size of expressions used in the scalar evolutions analyzer.
9900 Large expressions slow the analyzer.
9902 @item scev-max-expr-complexity
9903 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9904 Complex expressions slow the analyzer.
9906 @item omega-max-vars
9907 The maximum number of variables in an Omega constraint system.
9908 The default value is 128.
9910 @item omega-max-geqs
9911 The maximum number of inequalities in an Omega constraint system.
9912 The default value is 256.
9914 @item omega-max-eqs
9915 The maximum number of equalities in an Omega constraint system.
9916 The default value is 128.
9918 @item omega-max-wild-cards
9919 The maximum number of wildcard variables that the Omega solver is
9920 able to insert.  The default value is 18.
9922 @item omega-hash-table-size
9923 The size of the hash table in the Omega solver.  The default value is
9924 550.
9926 @item omega-max-keys
9927 The maximal number of keys used by the Omega solver.  The default
9928 value is 500.
9930 @item omega-eliminate-redundant-constraints
9931 When set to 1, use expensive methods to eliminate all redundant
9932 constraints.  The default value is 0.
9934 @item vect-max-version-for-alignment-checks
9935 The maximum number of run-time checks that can be performed when
9936 doing loop versioning for alignment in the vectorizer.
9938 @item vect-max-version-for-alias-checks
9939 The maximum number of run-time checks that can be performed when
9940 doing loop versioning for alias in the vectorizer.
9942 @item vect-max-peeling-for-alignment
9943 The maximum number of loop peels to enhance access alignment
9944 for vectorizer. Value -1 means 'no limit'.
9946 @item max-iterations-to-track
9947 The maximum number of iterations of a loop the brute-force algorithm
9948 for analysis of the number of iterations of the loop tries to evaluate.
9950 @item hot-bb-count-ws-permille
9951 A basic block profile count is considered hot if it contributes to 
9952 the given permillage (i.e. 0...1000) of the entire profiled execution.
9954 @item hot-bb-frequency-fraction
9955 Select fraction of the entry block frequency of executions of basic block in
9956 function given basic block needs to have to be considered hot.
9958 @item max-predicted-iterations
9959 The maximum number of loop iterations we predict statically.  This is useful
9960 in cases where a function contains a single loop with known bound and
9961 another loop with unknown bound.
9962 The known number of iterations is predicted correctly, while
9963 the unknown number of iterations average to roughly 10.  This means that the
9964 loop without bounds appears artificially cold relative to the other one.
9966 @item builtin-expect-probability
9967 Control the probability of the expression having the specified value. This
9968 parameter takes a percentage (i.e. 0 ... 100) as input.
9969 The default probability of 90 is obtained empirically.
9971 @item align-threshold
9973 Select fraction of the maximal frequency of executions of a basic block in
9974 a function to align the basic block.
9976 @item align-loop-iterations
9978 A loop expected to iterate at least the selected number of iterations is
9979 aligned.
9981 @item tracer-dynamic-coverage
9982 @itemx tracer-dynamic-coverage-feedback
9984 This value is used to limit superblock formation once the given percentage of
9985 executed instructions is covered.  This limits unnecessary code size
9986 expansion.
9988 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9989 feedback is available.  The real profiles (as opposed to statically estimated
9990 ones) are much less balanced allowing the threshold to be larger value.
9992 @item tracer-max-code-growth
9993 Stop tail duplication once code growth has reached given percentage.  This is
9994 a rather artificial limit, as most of the duplicates are eliminated later in
9995 cross jumping, so it may be set to much higher values than is the desired code
9996 growth.
9998 @item tracer-min-branch-ratio
10000 Stop reverse growth when the reverse probability of best edge is less than this
10001 threshold (in percent).
10003 @item tracer-min-branch-ratio
10004 @itemx tracer-min-branch-ratio-feedback
10006 Stop forward growth if the best edge has probability lower than this
10007 threshold.
10009 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10010 compilation for profile feedback and one for compilation without.  The value
10011 for compilation with profile feedback needs to be more conservative (higher) in
10012 order to make tracer effective.
10014 @item max-cse-path-length
10016 The maximum number of basic blocks on path that CSE considers.
10017 The default is 10.
10019 @item max-cse-insns
10020 The maximum number of instructions CSE processes before flushing.
10021 The default is 1000.
10023 @item ggc-min-expand
10025 GCC uses a garbage collector to manage its own memory allocation.  This
10026 parameter specifies the minimum percentage by which the garbage
10027 collector's heap should be allowed to expand between collections.
10028 Tuning this may improve compilation speed; it has no effect on code
10029 generation.
10031 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10032 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10033 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10034 GCC is not able to calculate RAM on a particular platform, the lower
10035 bound of 30% is used.  Setting this parameter and
10036 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10037 every opportunity.  This is extremely slow, but can be useful for
10038 debugging.
10040 @item ggc-min-heapsize
10042 Minimum size of the garbage collector's heap before it begins bothering
10043 to collect garbage.  The first collection occurs after the heap expands
10044 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10045 tuning this may improve compilation speed, and has no effect on code
10046 generation.
10048 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10049 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10050 with a lower bound of 4096 (four megabytes) and an upper bound of
10051 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10052 particular platform, the lower bound is used.  Setting this parameter
10053 very large effectively disables garbage collection.  Setting this
10054 parameter and @option{ggc-min-expand} to zero causes a full collection
10055 to occur at every opportunity.
10057 @item max-reload-search-insns
10058 The maximum number of instruction reload should look backward for equivalent
10059 register.  Increasing values mean more aggressive optimization, making the
10060 compilation time increase with probably slightly better performance.
10061 The default value is 100.
10063 @item max-cselib-memory-locations
10064 The maximum number of memory locations cselib should take into account.
10065 Increasing values mean more aggressive optimization, making the compilation time
10066 increase with probably slightly better performance.  The default value is 500.
10068 @item reorder-blocks-duplicate
10069 @itemx reorder-blocks-duplicate-feedback
10071 Used by the basic block reordering pass to decide whether to use unconditional
10072 branch or duplicate the code on its destination.  Code is duplicated when its
10073 estimated size is smaller than this value multiplied by the estimated size of
10074 unconditional jump in the hot spots of the program.
10076 The @option{reorder-block-duplicate-feedback} is used only when profile
10077 feedback is available.  It may be set to higher values than
10078 @option{reorder-block-duplicate} since information about the hot spots is more
10079 accurate.
10081 @item max-sched-ready-insns
10082 The maximum number of instructions ready to be issued the scheduler should
10083 consider at any given time during the first scheduling pass.  Increasing
10084 values mean more thorough searches, making the compilation time increase
10085 with probably little benefit.  The default value is 100.
10087 @item max-sched-region-blocks
10088 The maximum number of blocks in a region to be considered for
10089 interblock scheduling.  The default value is 10.
10091 @item max-pipeline-region-blocks
10092 The maximum number of blocks in a region to be considered for
10093 pipelining in the selective scheduler.  The default value is 15.
10095 @item max-sched-region-insns
10096 The maximum number of insns in a region to be considered for
10097 interblock scheduling.  The default value is 100.
10099 @item max-pipeline-region-insns
10100 The maximum number of insns in a region to be considered for
10101 pipelining in the selective scheduler.  The default value is 200.
10103 @item min-spec-prob
10104 The minimum probability (in percents) of reaching a source block
10105 for interblock speculative scheduling.  The default value is 40.
10107 @item max-sched-extend-regions-iters
10108 The maximum number of iterations through CFG to extend regions.
10109 A value of 0 (the default) disables region extensions.
10111 @item max-sched-insn-conflict-delay
10112 The maximum conflict delay for an insn to be considered for speculative motion.
10113 The default value is 3.
10115 @item sched-spec-prob-cutoff
10116 The minimal probability of speculation success (in percents), so that
10117 speculative insns are scheduled.
10118 The default value is 40.
10120 @item sched-spec-state-edge-prob-cutoff
10121 The minimum probability an edge must have for the scheduler to save its
10122 state across it.
10123 The default value is 10.
10125 @item sched-mem-true-dep-cost
10126 Minimal distance (in CPU cycles) between store and load targeting same
10127 memory locations.  The default value is 1.
10129 @item selsched-max-lookahead
10130 The maximum size of the lookahead window of selective scheduling.  It is a
10131 depth of search for available instructions.
10132 The default value is 50.
10134 @item selsched-max-sched-times
10135 The maximum number of times that an instruction is scheduled during
10136 selective scheduling.  This is the limit on the number of iterations
10137 through which the instruction may be pipelined.  The default value is 2.
10139 @item selsched-max-insns-to-rename
10140 The maximum number of best instructions in the ready list that are considered
10141 for renaming in the selective scheduler.  The default value is 2.
10143 @item sms-min-sc
10144 The minimum value of stage count that swing modulo scheduler
10145 generates.  The default value is 2.
10147 @item max-last-value-rtl
10148 The maximum size measured as number of RTLs that can be recorded in an expression
10149 in combiner for a pseudo register as last known value of that register.  The default
10150 is 10000.
10152 @item max-combine-insns
10153 The maximum number of instructions the RTL combiner tries to combine.
10154 The default value is 2 at @option{-Og} and 4 otherwise.
10156 @item integer-share-limit
10157 Small integer constants can use a shared data structure, reducing the
10158 compiler's memory usage and increasing its speed.  This sets the maximum
10159 value of a shared integer constant.  The default value is 256.
10161 @item ssp-buffer-size
10162 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10163 protection when @option{-fstack-protection} is used.
10165 @item min-size-for-stack-sharing
10166 The minimum size of variables taking part in stack slot sharing when not
10167 optimizing. The default value is 32.
10169 @item max-jump-thread-duplication-stmts
10170 Maximum number of statements allowed in a block that needs to be
10171 duplicated when threading jumps.
10173 @item max-fields-for-field-sensitive
10174 Maximum number of fields in a structure treated in
10175 a field sensitive manner during pointer analysis.  The default is zero
10176 for @option{-O0} and @option{-O1},
10177 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10179 @item prefetch-latency
10180 Estimate on average number of instructions that are executed before
10181 prefetch finishes.  The distance prefetched ahead is proportional
10182 to this constant.  Increasing this number may also lead to less
10183 streams being prefetched (see @option{simultaneous-prefetches}).
10185 @item simultaneous-prefetches
10186 Maximum number of prefetches that can run at the same time.
10188 @item l1-cache-line-size
10189 The size of cache line in L1 cache, in bytes.
10191 @item l1-cache-size
10192 The size of L1 cache, in kilobytes.
10194 @item l2-cache-size
10195 The size of L2 cache, in kilobytes.
10197 @item min-insn-to-prefetch-ratio
10198 The minimum ratio between the number of instructions and the
10199 number of prefetches to enable prefetching in a loop.
10201 @item prefetch-min-insn-to-mem-ratio
10202 The minimum ratio between the number of instructions and the
10203 number of memory references to enable prefetching in a loop.
10205 @item use-canonical-types
10206 Whether the compiler should use the ``canonical'' type system.  By
10207 default, this should always be 1, which uses a more efficient internal
10208 mechanism for comparing types in C++ and Objective-C++.  However, if
10209 bugs in the canonical type system are causing compilation failures,
10210 set this value to 0 to disable canonical types.
10212 @item switch-conversion-max-branch-ratio
10213 Switch initialization conversion refuses to create arrays that are
10214 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10215 branches in the switch.
10217 @item max-partial-antic-length
10218 Maximum length of the partial antic set computed during the tree
10219 partial redundancy elimination optimization (@option{-ftree-pre}) when
10220 optimizing at @option{-O3} and above.  For some sorts of source code
10221 the enhanced partial redundancy elimination optimization can run away,
10222 consuming all of the memory available on the host machine.  This
10223 parameter sets a limit on the length of the sets that are computed,
10224 which prevents the runaway behavior.  Setting a value of 0 for
10225 this parameter allows an unlimited set length.
10227 @item sccvn-max-scc-size
10228 Maximum size of a strongly connected component (SCC) during SCCVN
10229 processing.  If this limit is hit, SCCVN processing for the whole
10230 function is not done and optimizations depending on it are
10231 disabled.  The default maximum SCC size is 10000.
10233 @item sccvn-max-alias-queries-per-access
10234 Maximum number of alias-oracle queries we perform when looking for
10235 redundancies for loads and stores.  If this limit is hit the search
10236 is aborted and the load or store is not considered redundant.  The
10237 number of queries is algorithmically limited to the number of
10238 stores on all paths from the load to the function entry.
10239 The default maxmimum number of queries is 1000.
10241 @item ira-max-loops-num
10242 IRA uses regional register allocation by default.  If a function
10243 contains more loops than the number given by this parameter, only at most
10244 the given number of the most frequently-executed loops form regions
10245 for regional register allocation.  The default value of the
10246 parameter is 100.
10248 @item ira-max-conflict-table-size 
10249 Although IRA uses a sophisticated algorithm to compress the conflict
10250 table, the table can still require excessive amounts of memory for
10251 huge functions.  If the conflict table for a function could be more
10252 than the size in MB given by this parameter, the register allocator
10253 instead uses a faster, simpler, and lower-quality
10254 algorithm that does not require building a pseudo-register conflict table.  
10255 The default value of the parameter is 2000.
10257 @item ira-loop-reserved-regs
10258 IRA can be used to evaluate more accurate register pressure in loops
10259 for decisions to move loop invariants (see @option{-O3}).  The number
10260 of available registers reserved for some other purposes is given
10261 by this parameter.  The default value of the parameter is 2, which is
10262 the minimal number of registers needed by typical instructions.
10263 This value is the best found from numerous experiments.
10265 @item loop-invariant-max-bbs-in-loop
10266 Loop invariant motion can be very expensive, both in compilation time and
10267 in amount of needed compile-time memory, with very large loops.  Loops
10268 with more basic blocks than this parameter won't have loop invariant
10269 motion optimization performed on them.  The default value of the
10270 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10272 @item loop-max-datarefs-for-datadeps
10273 Building data dapendencies is expensive for very large loops.  This
10274 parameter limits the number of data references in loops that are
10275 considered for data dependence analysis.  These large loops are no
10276 handled by the optimizations using loop data dependencies.
10277 The default value is 1000.
10279 @item max-vartrack-size
10280 Sets a maximum number of hash table slots to use during variable
10281 tracking dataflow analysis of any function.  If this limit is exceeded
10282 with variable tracking at assignments enabled, analysis for that
10283 function is retried without it, after removing all debug insns from
10284 the function.  If the limit is exceeded even without debug insns, var
10285 tracking analysis is completely disabled for the function.  Setting
10286 the parameter to zero makes it unlimited.
10288 @item max-vartrack-expr-depth
10289 Sets a maximum number of recursion levels when attempting to map
10290 variable names or debug temporaries to value expressions.  This trades
10291 compilation time for more complete debug information.  If this is set too
10292 low, value expressions that are available and could be represented in
10293 debug information may end up not being used; setting this higher may
10294 enable the compiler to find more complex debug expressions, but compile
10295 time and memory use may grow.  The default is 12.
10297 @item min-nondebug-insn-uid
10298 Use uids starting at this parameter for nondebug insns.  The range below
10299 the parameter is reserved exclusively for debug insns created by
10300 @option{-fvar-tracking-assignments}, but debug insns may get
10301 (non-overlapping) uids above it if the reserved range is exhausted.
10303 @item ipa-sra-ptr-growth-factor
10304 IPA-SRA replaces a pointer to an aggregate with one or more new
10305 parameters only when their cumulative size is less or equal to
10306 @option{ipa-sra-ptr-growth-factor} times the size of the original
10307 pointer parameter.
10309 @item tm-max-aggregate-size
10310 When making copies of thread-local variables in a transaction, this
10311 parameter specifies the size in bytes after which variables are
10312 saved with the logging functions as opposed to save/restore code
10313 sequence pairs.  This option only applies when using
10314 @option{-fgnu-tm}.
10316 @item graphite-max-nb-scop-params
10317 To avoid exponential effects in the Graphite loop transforms, the
10318 number of parameters in a Static Control Part (SCoP) is bounded.  The
10319 default value is 10 parameters.  A variable whose value is unknown at
10320 compilation time and defined outside a SCoP is a parameter of the SCoP.
10322 @item graphite-max-bbs-per-function
10323 To avoid exponential effects in the detection of SCoPs, the size of
10324 the functions analyzed by Graphite is bounded.  The default value is
10325 100 basic blocks.
10327 @item loop-block-tile-size
10328 Loop blocking or strip mining transforms, enabled with
10329 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10330 loop in the loop nest by a given number of iterations.  The strip
10331 length can be changed using the @option{loop-block-tile-size}
10332 parameter.  The default value is 51 iterations.
10334 @item ipa-cp-value-list-size
10335 IPA-CP attempts to track all possible values and types passed to a function's
10336 parameter in order to propagate them and perform devirtualization.
10337 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10338 stores per one formal parameter of a function.
10340 @item ipa-cp-eval-threshold
10341 IPA-CP calculates its own score of cloning profitability heuristics
10342 and performs those cloning opportunities with scores that exceed
10343 @option{ipa-cp-eval-threshold}.
10345 @item ipa-max-agg-items
10346 IPA-CP is also capable to propagate a number of scalar values passed
10347 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10348 number of such values per one parameter.
10350 @item ipa-cp-loop-hint-bonus
10351 When IPA-CP determines that a cloning candidate would make the number
10352 of iterations of a loop known, it adds a bonus of
10353 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10354 the candidate.
10356 @item ipa-cp-array-index-hint-bonus
10357 When IPA-CP determines that a cloning candidate would make the index of
10358 an array access known, it adds a bonus of
10359 @option{ipa-cp-array-index-hint-bonus} to the profitability
10360 score of the candidate.
10362 @item ipa-max-aa-steps
10363 During its analysis of function bodies, IPA-CP employs alias analysis
10364 in order to track values pointed to by function parameters.  In order
10365 not spend too much time analyzing huge functions, it will give up and
10366 consider all memory clobbered after examining
10367 @option{ipa-max-aa-steps} statements modifying memory.
10369 @item lto-partitions
10370 Specify desired number of partitions produced during WHOPR compilation.
10371 The number of partitions should exceed the number of CPUs used for compilation.
10372 The default value is 32.
10374 @item lto-minpartition
10375 Size of minimal partition for WHOPR (in estimated instructions).
10376 This prevents expenses of splitting very small programs into too many
10377 partitions.
10379 @item cxx-max-namespaces-for-diagnostic-help
10380 The maximum number of namespaces to consult for suggestions when C++
10381 name lookup fails for an identifier.  The default is 1000.
10383 @item sink-frequency-threshold
10384 The maximum relative execution frequency (in percents) of the target block
10385 relative to a statement's original block to allow statement sinking of a
10386 statement.  Larger numbers result in more aggressive statement sinking.
10387 The default value is 75.  A small positive adjustment is applied for
10388 statements with memory operands as those are even more profitable so sink.
10390 @item max-stores-to-sink
10391 The maximum number of conditional stores paires that can be sunk.  Set to 0
10392 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10393 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10395 @item allow-store-data-races
10396 Allow optimizers to introduce new data races on stores.
10397 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10398 at optimization level @option{-Ofast}.
10400 @item case-values-threshold
10401 The smallest number of different values for which it is best to use a
10402 jump-table instead of a tree of conditional branches.  If the value is
10403 0, use the default for the machine.  The default is 0.
10405 @item tree-reassoc-width
10406 Set the maximum number of instructions executed in parallel in
10407 reassociated tree. This parameter overrides target dependent
10408 heuristics used by default if has non zero value.
10410 @item sched-pressure-algorithm
10411 Choose between the two available implementations of
10412 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10413 and is the more likely to prevent instructions from being reordered.
10414 Algorithm 2 was designed to be a compromise between the relatively
10415 conservative approach taken by algorithm 1 and the rather aggressive
10416 approach taken by the default scheduler.  It relies more heavily on
10417 having a regular register file and accurate register pressure classes.
10418 See @file{haifa-sched.c} in the GCC sources for more details.
10420 The default choice depends on the target.
10422 @item max-slsr-cand-scan
10423 Set the maximum number of existing candidates that will be considered when
10424 seeking a basis for a new straight-line strength reduction candidate.
10426 @item asan-globals
10427 Enable buffer overflow detection for global objects.  This kind
10428 of protection is enabled by default if you are using
10429 @option{-fsanitize=address} option.
10430 To disable global objects protection use @option{--param asan-globals=0}.
10432 @item asan-stack
10433 Enable buffer overflow detection for stack objects.  This kind of
10434 protection is enabled by default when using@option{-fsanitize=address}.
10435 To disable stack protection use @option{--param asan-stack=0} option.
10437 @item asan-instrument-reads
10438 Enable buffer overflow detection for memory reads.  This kind of
10439 protection is enabled by default when using @option{-fsanitize=address}.
10440 To disable memory reads protection use
10441 @option{--param asan-instrument-reads=0}.
10443 @item asan-instrument-writes
10444 Enable buffer overflow detection for memory writes.  This kind of
10445 protection is enabled by default when using @option{-fsanitize=address}.
10446 To disable memory writes protection use
10447 @option{--param asan-instrument-writes=0} option.
10449 @item asan-memintrin
10450 Enable detection for built-in functions.  This kind of protection
10451 is enabled by default when using @option{-fsanitize=address}.
10452 To disable built-in functions protection use
10453 @option{--param asan-memintrin=0}.
10455 @item asan-use-after-return
10456 Enable detection of use-after-return.  This kind of protection
10457 is enabled by default when using @option{-fsanitize=address} option.
10458 To disable use-after-return detection use 
10459 @option{--param asan-use-after-return=0}.
10461 @item asan-instrumentation-with-call-threshold
10462 If number of memory accesses in function being instrumented
10463 is greater or equal to this number, use callbacks instead of inline checks.
10464 E.g. to disable inline code use
10465 @option{--param asan-instrumentation-with-call-threshold=0}.
10467 @end table
10468 @end table
10470 @node Preprocessor Options
10471 @section Options Controlling the Preprocessor
10472 @cindex preprocessor options
10473 @cindex options, preprocessor
10475 These options control the C preprocessor, which is run on each C source
10476 file before actual compilation.
10478 If you use the @option{-E} option, nothing is done except preprocessing.
10479 Some of these options make sense only together with @option{-E} because
10480 they cause the preprocessor output to be unsuitable for actual
10481 compilation.
10483 @table @gcctabopt
10484 @item -Wp,@var{option}
10485 @opindex Wp
10486 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10487 and pass @var{option} directly through to the preprocessor.  If
10488 @var{option} contains commas, it is split into multiple options at the
10489 commas.  However, many options are modified, translated or interpreted
10490 by the compiler driver before being passed to the preprocessor, and
10491 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10492 interface is undocumented and subject to change, so whenever possible
10493 you should avoid using @option{-Wp} and let the driver handle the
10494 options instead.
10496 @item -Xpreprocessor @var{option}
10497 @opindex Xpreprocessor
10498 Pass @var{option} as an option to the preprocessor.  You can use this to
10499 supply system-specific preprocessor options that GCC does not 
10500 recognize.
10502 If you want to pass an option that takes an argument, you must use
10503 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10505 @item -no-integrated-cpp
10506 @opindex no-integrated-cpp
10507 Perform preprocessing as a separate pass before compilation.
10508 By default, GCC performs preprocessing as an integrated part of
10509 input tokenization and parsing.
10510 If this option is provided, the appropriate language front end
10511 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10512 and Objective-C, respectively) is instead invoked twice,
10513 once for preprocessing only and once for actual compilation
10514 of the preprocessed input.
10515 This option may be useful in conjunction with the @option{-B} or
10516 @option{-wrapper} options to specify an alternate preprocessor or
10517 perform additional processing of the program source between
10518 normal preprocessing and compilation.
10519 @end table
10521 @include cppopts.texi
10523 @node Assembler Options
10524 @section Passing Options to the Assembler
10526 @c prevent bad page break with this line
10527 You can pass options to the assembler.
10529 @table @gcctabopt
10530 @item -Wa,@var{option}
10531 @opindex Wa
10532 Pass @var{option} as an option to the assembler.  If @var{option}
10533 contains commas, it is split into multiple options at the commas.
10535 @item -Xassembler @var{option}
10536 @opindex Xassembler
10537 Pass @var{option} as an option to the assembler.  You can use this to
10538 supply system-specific assembler options that GCC does not
10539 recognize.
10541 If you want to pass an option that takes an argument, you must use
10542 @option{-Xassembler} twice, once for the option and once for the argument.
10544 @end table
10546 @node Link Options
10547 @section Options for Linking
10548 @cindex link options
10549 @cindex options, linking
10551 These options come into play when the compiler links object files into
10552 an executable output file.  They are meaningless if the compiler is
10553 not doing a link step.
10555 @table @gcctabopt
10556 @cindex file names
10557 @item @var{object-file-name}
10558 A file name that does not end in a special recognized suffix is
10559 considered to name an object file or library.  (Object files are
10560 distinguished from libraries by the linker according to the file
10561 contents.)  If linking is done, these object files are used as input
10562 to the linker.
10564 @item -c
10565 @itemx -S
10566 @itemx -E
10567 @opindex c
10568 @opindex S
10569 @opindex E
10570 If any of these options is used, then the linker is not run, and
10571 object file names should not be used as arguments.  @xref{Overall
10572 Options}.
10574 @cindex Libraries
10575 @item -l@var{library}
10576 @itemx -l @var{library}
10577 @opindex l
10578 Search the library named @var{library} when linking.  (The second
10579 alternative with the library as a separate argument is only for
10580 POSIX compliance and is not recommended.)
10582 It makes a difference where in the command you write this option; the
10583 linker searches and processes libraries and object files in the order they
10584 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10585 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10586 to functions in @samp{z}, those functions may not be loaded.
10588 The linker searches a standard list of directories for the library,
10589 which is actually a file named @file{lib@var{library}.a}.  The linker
10590 then uses this file as if it had been specified precisely by name.
10592 The directories searched include several standard system directories
10593 plus any that you specify with @option{-L}.
10595 Normally the files found this way are library files---archive files
10596 whose members are object files.  The linker handles an archive file by
10597 scanning through it for members which define symbols that have so far
10598 been referenced but not defined.  But if the file that is found is an
10599 ordinary object file, it is linked in the usual fashion.  The only
10600 difference between using an @option{-l} option and specifying a file name
10601 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10602 and searches several directories.
10604 @item -lobjc
10605 @opindex lobjc
10606 You need this special case of the @option{-l} option in order to
10607 link an Objective-C or Objective-C++ program.
10609 @item -nostartfiles
10610 @opindex nostartfiles
10611 Do not use the standard system startup files when linking.
10612 The standard system libraries are used normally, unless @option{-nostdlib}
10613 or @option{-nodefaultlibs} is used.
10615 @item -nodefaultlibs
10616 @opindex nodefaultlibs
10617 Do not use the standard system libraries when linking.
10618 Only the libraries you specify are passed to the linker, and options
10619 specifying linkage of the system libraries, such as @code{-static-libgcc}
10620 or @code{-shared-libgcc}, are ignored.  
10621 The standard startup files are used normally, unless @option{-nostartfiles}
10622 is used.  
10624 The compiler may generate calls to @code{memcmp},
10625 @code{memset}, @code{memcpy} and @code{memmove}.
10626 These entries are usually resolved by entries in
10627 libc.  These entry points should be supplied through some other
10628 mechanism when this option is specified.
10630 @item -nostdlib
10631 @opindex nostdlib
10632 Do not use the standard system startup files or libraries when linking.
10633 No startup files and only the libraries you specify are passed to
10634 the linker, and options specifying linkage of the system libraries, such as
10635 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10637 The compiler may generate calls to @code{memcmp}, @code{memset},
10638 @code{memcpy} and @code{memmove}.
10639 These entries are usually resolved by entries in
10640 libc.  These entry points should be supplied through some other
10641 mechanism when this option is specified.
10643 @cindex @option{-lgcc}, use with @option{-nostdlib}
10644 @cindex @option{-nostdlib} and unresolved references
10645 @cindex unresolved references and @option{-nostdlib}
10646 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10647 @cindex @option{-nodefaultlibs} and unresolved references
10648 @cindex unresolved references and @option{-nodefaultlibs}
10649 One of the standard libraries bypassed by @option{-nostdlib} and
10650 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10651 which GCC uses to overcome shortcomings of particular machines, or special
10652 needs for some languages.
10653 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10654 Collection (GCC) Internals},
10655 for more discussion of @file{libgcc.a}.)
10656 In most cases, you need @file{libgcc.a} even when you want to avoid
10657 other standard libraries.  In other words, when you specify @option{-nostdlib}
10658 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10659 This ensures that you have no unresolved references to internal GCC
10660 library subroutines.
10661 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10662 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10663 GNU Compiler Collection (GCC) Internals}.)
10665 @item -pie
10666 @opindex pie
10667 Produce a position independent executable on targets that support it.
10668 For predictable results, you must also specify the same set of options
10669 used for compilation (@option{-fpie}, @option{-fPIE},
10670 or model suboptions) when you specify this linker option.
10672 @item -rdynamic
10673 @opindex rdynamic
10674 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10675 that support it. This instructs the linker to add all symbols, not
10676 only used ones, to the dynamic symbol table. This option is needed
10677 for some uses of @code{dlopen} or to allow obtaining backtraces
10678 from within a program.
10680 @item -s
10681 @opindex s
10682 Remove all symbol table and relocation information from the executable.
10684 @item -static
10685 @opindex static
10686 On systems that support dynamic linking, this prevents linking with the shared
10687 libraries.  On other systems, this option has no effect.
10689 @item -shared
10690 @opindex shared
10691 Produce a shared object which can then be linked with other objects to
10692 form an executable.  Not all systems support this option.  For predictable
10693 results, you must also specify the same set of options used for compilation
10694 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10695 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10696 needs to build supplementary stub code for constructors to work.  On
10697 multi-libbed systems, @samp{gcc -shared} must select the correct support
10698 libraries to link against.  Failing to supply the correct flags may lead
10699 to subtle defects.  Supplying them in cases where they are not necessary
10700 is innocuous.}
10702 @item -shared-libgcc
10703 @itemx -static-libgcc
10704 @opindex shared-libgcc
10705 @opindex static-libgcc
10706 On systems that provide @file{libgcc} as a shared library, these options
10707 force the use of either the shared or static version, respectively.
10708 If no shared version of @file{libgcc} was built when the compiler was
10709 configured, these options have no effect.
10711 There are several situations in which an application should use the
10712 shared @file{libgcc} instead of the static version.  The most common
10713 of these is when the application wishes to throw and catch exceptions
10714 across different shared libraries.  In that case, each of the libraries
10715 as well as the application itself should use the shared @file{libgcc}.
10717 Therefore, the G++ and GCJ drivers automatically add
10718 @option{-shared-libgcc} whenever you build a shared library or a main
10719 executable, because C++ and Java programs typically use exceptions, so
10720 this is the right thing to do.
10722 If, instead, you use the GCC driver to create shared libraries, you may
10723 find that they are not always linked with the shared @file{libgcc}.
10724 If GCC finds, at its configuration time, that you have a non-GNU linker
10725 or a GNU linker that does not support option @option{--eh-frame-hdr},
10726 it links the shared version of @file{libgcc} into shared libraries
10727 by default.  Otherwise, it takes advantage of the linker and optimizes
10728 away the linking with the shared version of @file{libgcc}, linking with
10729 the static version of libgcc by default.  This allows exceptions to
10730 propagate through such shared libraries, without incurring relocation
10731 costs at library load time.
10733 However, if a library or main executable is supposed to throw or catch
10734 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10735 for the languages used in the program, or using the option
10736 @option{-shared-libgcc}, such that it is linked with the shared
10737 @file{libgcc}.
10739 @item -static-libasan
10740 @opindex static-libasan
10741 When the @option{-fsanitize=address} option is used to link a program,
10742 the GCC driver automatically links against @option{libasan}.  If
10743 @file{libasan} is available as a shared library, and the @option{-static}
10744 option is not used, then this links against the shared version of
10745 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10746 driver to link @file{libasan} statically, without necessarily linking
10747 other libraries statically.
10749 @item -static-libtsan
10750 @opindex static-libtsan
10751 When the @option{-fsanitize=thread} option is used to link a program,
10752 the GCC driver automatically links against @option{libtsan}.  If
10753 @file{libtsan} is available as a shared library, and the @option{-static}
10754 option is not used, then this links against the shared version of
10755 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10756 driver to link @file{libtsan} statically, without necessarily linking
10757 other libraries statically.
10759 @item -static-liblsan
10760 @opindex static-liblsan
10761 When the @option{-fsanitize=leak} option is used to link a program,
10762 the GCC driver automatically links against @option{liblsan}.  If
10763 @file{liblsan} is available as a shared library, and the @option{-static}
10764 option is not used, then this links against the shared version of
10765 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10766 driver to link @file{liblsan} statically, without necessarily linking
10767 other libraries statically.
10769 @item -static-libubsan
10770 @opindex static-libubsan
10771 When the @option{-fsanitize=undefined} option is used to link a program,
10772 the GCC driver automatically links against @option{libubsan}.  If
10773 @file{libubsan} is available as a shared library, and the @option{-static}
10774 option is not used, then this links against the shared version of
10775 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10776 driver to link @file{libubsan} statically, without necessarily linking
10777 other libraries statically.
10779 @item -static-libstdc++
10780 @opindex static-libstdc++
10781 When the @command{g++} program is used to link a C++ program, it
10782 normally automatically links against @option{libstdc++}.  If
10783 @file{libstdc++} is available as a shared library, and the
10784 @option{-static} option is not used, then this links against the
10785 shared version of @file{libstdc++}.  That is normally fine.  However, it
10786 is sometimes useful to freeze the version of @file{libstdc++} used by
10787 the program without going all the way to a fully static link.  The
10788 @option{-static-libstdc++} option directs the @command{g++} driver to
10789 link @file{libstdc++} statically, without necessarily linking other
10790 libraries statically.
10792 @item -symbolic
10793 @opindex symbolic
10794 Bind references to global symbols when building a shared object.  Warn
10795 about any unresolved references (unless overridden by the link editor
10796 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10797 this option.
10799 @item -T @var{script}
10800 @opindex T
10801 @cindex linker script
10802 Use @var{script} as the linker script.  This option is supported by most
10803 systems using the GNU linker.  On some targets, such as bare-board
10804 targets without an operating system, the @option{-T} option may be required
10805 when linking to avoid references to undefined symbols.
10807 @item -Xlinker @var{option}
10808 @opindex Xlinker
10809 Pass @var{option} as an option to the linker.  You can use this to
10810 supply system-specific linker options that GCC does not recognize.
10812 If you want to pass an option that takes a separate argument, you must use
10813 @option{-Xlinker} twice, once for the option and once for the argument.
10814 For example, to pass @option{-assert definitions}, you must write
10815 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10816 @option{-Xlinker "-assert definitions"}, because this passes the entire
10817 string as a single argument, which is not what the linker expects.
10819 When using the GNU linker, it is usually more convenient to pass
10820 arguments to linker options using the @option{@var{option}=@var{value}}
10821 syntax than as separate arguments.  For example, you can specify
10822 @option{-Xlinker -Map=output.map} rather than
10823 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10824 this syntax for command-line options.
10826 @item -Wl,@var{option}
10827 @opindex Wl
10828 Pass @var{option} as an option to the linker.  If @var{option} contains
10829 commas, it is split into multiple options at the commas.  You can use this
10830 syntax to pass an argument to the option.
10831 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10832 linker.  When using the GNU linker, you can also get the same effect with
10833 @option{-Wl,-Map=output.map}.
10835 @item -u @var{symbol}
10836 @opindex u
10837 Pretend the symbol @var{symbol} is undefined, to force linking of
10838 library modules to define it.  You can use @option{-u} multiple times with
10839 different symbols to force loading of additional library modules.
10841 @item -z @var{keyword}
10842 @opindex z
10843 @option{-z} is passed directly on to the linker along with the keyword
10844 @var{keyword}. See the section in the documentation of your linker for
10845 permitted values and their meanings.
10846 @end table
10848 @node Directory Options
10849 @section Options for Directory Search
10850 @cindex directory options
10851 @cindex options, directory search
10852 @cindex search path
10854 These options specify directories to search for header files, for
10855 libraries and for parts of the compiler:
10857 @table @gcctabopt
10858 @item -I@var{dir}
10859 @opindex I
10860 Add the directory @var{dir} to the head of the list of directories to be
10861 searched for header files.  This can be used to override a system header
10862 file, substituting your own version, since these directories are
10863 searched before the system header file directories.  However, you should
10864 not use this option to add directories that contain vendor-supplied
10865 system header files (use @option{-isystem} for that).  If you use more than
10866 one @option{-I} option, the directories are scanned in left-to-right
10867 order; the standard system directories come after.
10869 If a standard system include directory, or a directory specified with
10870 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10871 option is ignored.  The directory is still searched but as a
10872 system directory at its normal position in the system include chain.
10873 This is to ensure that GCC's procedure to fix buggy system headers and
10874 the ordering for the @code{include_next} directive are not inadvertently changed.
10875 If you really need to change the search order for system directories,
10876 use the @option{-nostdinc} and/or @option{-isystem} options.
10878 @item -iplugindir=@var{dir}
10879 @opindex iplugindir=
10880 Set the directory to search for plugins that are passed
10881 by @option{-fplugin=@var{name}} instead of
10882 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10883 to be used by the user, but only passed by the driver.
10885 @item -iquote@var{dir}
10886 @opindex iquote
10887 Add the directory @var{dir} to the head of the list of directories to
10888 be searched for header files only for the case of @samp{#include
10889 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10890 otherwise just like @option{-I}.
10892 @item -L@var{dir}
10893 @opindex L
10894 Add directory @var{dir} to the list of directories to be searched
10895 for @option{-l}.
10897 @item -B@var{prefix}
10898 @opindex B
10899 This option specifies where to find the executables, libraries,
10900 include files, and data files of the compiler itself.
10902 The compiler driver program runs one or more of the subprograms
10903 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10904 @var{prefix} as a prefix for each program it tries to run, both with and
10905 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10907 For each subprogram to be run, the compiler driver first tries the
10908 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10909 is not specified, the driver tries two standard prefixes, 
10910 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10911 those results in a file name that is found, the unmodified program
10912 name is searched for using the directories specified in your
10913 @env{PATH} environment variable.
10915 The compiler checks to see if the path provided by the @option{-B}
10916 refers to a directory, and if necessary it adds a directory
10917 separator character at the end of the path.
10919 @option{-B} prefixes that effectively specify directory names also apply
10920 to libraries in the linker, because the compiler translates these
10921 options into @option{-L} options for the linker.  They also apply to
10922 include files in the preprocessor, because the compiler translates these
10923 options into @option{-isystem} options for the preprocessor.  In this case,
10924 the compiler appends @samp{include} to the prefix.
10926 The runtime support file @file{libgcc.a} can also be searched for using
10927 the @option{-B} prefix, if needed.  If it is not found there, the two
10928 standard prefixes above are tried, and that is all.  The file is left
10929 out of the link if it is not found by those means.
10931 Another way to specify a prefix much like the @option{-B} prefix is to use
10932 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10933 Variables}.
10935 As a special kludge, if the path provided by @option{-B} is
10936 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10937 9, then it is replaced by @file{[dir/]include}.  This is to help
10938 with boot-strapping the compiler.
10940 @item -specs=@var{file}
10941 @opindex specs
10942 Process @var{file} after the compiler reads in the standard @file{specs}
10943 file, in order to override the defaults which the @command{gcc} driver
10944 program uses when determining what switches to pass to @command{cc1},
10945 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10946 @option{-specs=@var{file}} can be specified on the command line, and they
10947 are processed in order, from left to right.
10949 @item --sysroot=@var{dir}
10950 @opindex sysroot
10951 Use @var{dir} as the logical root directory for headers and libraries.
10952 For example, if the compiler normally searches for headers in
10953 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10954 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10956 If you use both this option and the @option{-isysroot} option, then
10957 the @option{--sysroot} option applies to libraries, but the
10958 @option{-isysroot} option applies to header files.
10960 The GNU linker (beginning with version 2.16) has the necessary support
10961 for this option.  If your linker does not support this option, the
10962 header file aspect of @option{--sysroot} still works, but the
10963 library aspect does not.
10965 @item --no-sysroot-suffix
10966 @opindex no-sysroot-suffix
10967 For some targets, a suffix is added to the root directory specified
10968 with @option{--sysroot}, depending on the other options used, so that
10969 headers may for example be found in
10970 @file{@var{dir}/@var{suffix}/usr/include} instead of
10971 @file{@var{dir}/usr/include}.  This option disables the addition of
10972 such a suffix.
10974 @item -I-
10975 @opindex I-
10976 This option has been deprecated.  Please use @option{-iquote} instead for
10977 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10978 Any directories you specify with @option{-I} options before the @option{-I-}
10979 option are searched only for the case of @samp{#include "@var{file}"};
10980 they are not searched for @samp{#include <@var{file}>}.
10982 If additional directories are specified with @option{-I} options after
10983 the @option{-I-}, these directories are searched for all @samp{#include}
10984 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10985 this way.)
10987 In addition, the @option{-I-} option inhibits the use of the current
10988 directory (where the current input file came from) as the first search
10989 directory for @samp{#include "@var{file}"}.  There is no way to
10990 override this effect of @option{-I-}.  With @option{-I.} you can specify
10991 searching the directory that is current when the compiler is
10992 invoked.  That is not exactly the same as what the preprocessor does
10993 by default, but it is often satisfactory.
10995 @option{-I-} does not inhibit the use of the standard system directories
10996 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10997 independent.
10998 @end table
11000 @c man end
11002 @node Spec Files
11003 @section Specifying subprocesses and the switches to pass to them
11004 @cindex Spec Files
11006 @command{gcc} is a driver program.  It performs its job by invoking a
11007 sequence of other programs to do the work of compiling, assembling and
11008 linking.  GCC interprets its command-line parameters and uses these to
11009 deduce which programs it should invoke, and which command-line options
11010 it ought to place on their command lines.  This behavior is controlled
11011 by @dfn{spec strings}.  In most cases there is one spec string for each
11012 program that GCC can invoke, but a few programs have multiple spec
11013 strings to control their behavior.  The spec strings built into GCC can
11014 be overridden by using the @option{-specs=} command-line switch to specify
11015 a spec file.
11017 @dfn{Spec files} are plaintext files that are used to construct spec
11018 strings.  They consist of a sequence of directives separated by blank
11019 lines.  The type of directive is determined by the first non-whitespace
11020 character on the line, which can be one of the following:
11022 @table @code
11023 @item %@var{command}
11024 Issues a @var{command} to the spec file processor.  The commands that can
11025 appear here are:
11027 @table @code
11028 @item %include <@var{file}>
11029 @cindex @code{%include}
11030 Search for @var{file} and insert its text at the current point in the
11031 specs file.
11033 @item %include_noerr <@var{file}>
11034 @cindex @code{%include_noerr}
11035 Just like @samp{%include}, but do not generate an error message if the include
11036 file cannot be found.
11038 @item %rename @var{old_name} @var{new_name}
11039 @cindex @code{%rename}
11040 Rename the spec string @var{old_name} to @var{new_name}.
11042 @end table
11044 @item *[@var{spec_name}]:
11045 This tells the compiler to create, override or delete the named spec
11046 string.  All lines after this directive up to the next directive or
11047 blank line are considered to be the text for the spec string.  If this
11048 results in an empty string then the spec is deleted.  (Or, if the
11049 spec did not exist, then nothing happens.)  Otherwise, if the spec
11050 does not currently exist a new spec is created.  If the spec does
11051 exist then its contents are overridden by the text of this
11052 directive, unless the first character of that text is the @samp{+}
11053 character, in which case the text is appended to the spec.
11055 @item [@var{suffix}]:
11056 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11057 and up to the next directive or blank line are considered to make up the
11058 spec string for the indicated suffix.  When the compiler encounters an
11059 input file with the named suffix, it processes the spec string in
11060 order to work out how to compile that file.  For example:
11062 @smallexample
11063 .ZZ:
11064 z-compile -input %i
11065 @end smallexample
11067 This says that any input file whose name ends in @samp{.ZZ} should be
11068 passed to the program @samp{z-compile}, which should be invoked with the
11069 command-line switch @option{-input} and with the result of performing the
11070 @samp{%i} substitution.  (See below.)
11072 As an alternative to providing a spec string, the text following a
11073 suffix directive can be one of the following:
11075 @table @code
11076 @item @@@var{language}
11077 This says that the suffix is an alias for a known @var{language}.  This is
11078 similar to using the @option{-x} command-line switch to GCC to specify a
11079 language explicitly.  For example:
11081 @smallexample
11082 .ZZ:
11083 @@c++
11084 @end smallexample
11086 Says that .ZZ files are, in fact, C++ source files.
11088 @item #@var{name}
11089 This causes an error messages saying:
11091 @smallexample
11092 @var{name} compiler not installed on this system.
11093 @end smallexample
11094 @end table
11096 GCC already has an extensive list of suffixes built into it.
11097 This directive adds an entry to the end of the list of suffixes, but
11098 since the list is searched from the end backwards, it is effectively
11099 possible to override earlier entries using this technique.
11101 @end table
11103 GCC has the following spec strings built into it.  Spec files can
11104 override these strings or create their own.  Note that individual
11105 targets can also add their own spec strings to this list.
11107 @smallexample
11108 asm          Options to pass to the assembler
11109 asm_final    Options to pass to the assembler post-processor
11110 cpp          Options to pass to the C preprocessor
11111 cc1          Options to pass to the C compiler
11112 cc1plus      Options to pass to the C++ compiler
11113 endfile      Object files to include at the end of the link
11114 link         Options to pass to the linker
11115 lib          Libraries to include on the command line to the linker
11116 libgcc       Decides which GCC support library to pass to the linker
11117 linker       Sets the name of the linker
11118 predefines   Defines to be passed to the C preprocessor
11119 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11120              by default
11121 startfile    Object files to include at the start of the link
11122 @end smallexample
11124 Here is a small example of a spec file:
11126 @smallexample
11127 %rename lib                 old_lib
11129 *lib:
11130 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11131 @end smallexample
11133 This example renames the spec called @samp{lib} to @samp{old_lib} and
11134 then overrides the previous definition of @samp{lib} with a new one.
11135 The new definition adds in some extra command-line options before
11136 including the text of the old definition.
11138 @dfn{Spec strings} are a list of command-line options to be passed to their
11139 corresponding program.  In addition, the spec strings can contain
11140 @samp{%}-prefixed sequences to substitute variable text or to
11141 conditionally insert text into the command line.  Using these constructs
11142 it is possible to generate quite complex command lines.
11144 Here is a table of all defined @samp{%}-sequences for spec
11145 strings.  Note that spaces are not generated automatically around the
11146 results of expanding these sequences.  Therefore you can concatenate them
11147 together or combine them with constant text in a single argument.
11149 @table @code
11150 @item %%
11151 Substitute one @samp{%} into the program name or argument.
11153 @item %i
11154 Substitute the name of the input file being processed.
11156 @item %b
11157 Substitute the basename of the input file being processed.
11158 This is the substring up to (and not including) the last period
11159 and not including the directory.
11161 @item %B
11162 This is the same as @samp{%b}, but include the file suffix (text after
11163 the last period).
11165 @item %d
11166 Marks the argument containing or following the @samp{%d} as a
11167 temporary file name, so that that file is deleted if GCC exits
11168 successfully.  Unlike @samp{%g}, this contributes no text to the
11169 argument.
11171 @item %g@var{suffix}
11172 Substitute a file name that has suffix @var{suffix} and is chosen
11173 once per compilation, and mark the argument in the same way as
11174 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11175 name is now chosen in a way that is hard to predict even when previously
11176 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11177 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11178 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11179 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11180 was simply substituted with a file name chosen once per compilation,
11181 without regard to any appended suffix (which was therefore treated
11182 just like ordinary text), making such attacks more likely to succeed.
11184 @item %u@var{suffix}
11185 Like @samp{%g}, but generates a new temporary file name
11186 each time it appears instead of once per compilation.
11188 @item %U@var{suffix}
11189 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11190 new one if there is no such last file name.  In the absence of any
11191 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11192 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11193 involves the generation of two distinct file names, one
11194 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11195 simply substituted with a file name chosen for the previous @samp{%u},
11196 without regard to any appended suffix.
11198 @item %j@var{suffix}
11199 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11200 writable, and if @option{-save-temps} is not used; 
11201 otherwise, substitute the name
11202 of a temporary file, just like @samp{%u}.  This temporary file is not
11203 meant for communication between processes, but rather as a junk
11204 disposal mechanism.
11206 @item %|@var{suffix}
11207 @itemx %m@var{suffix}
11208 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11209 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11210 all.  These are the two most common ways to instruct a program that it
11211 should read from standard input or write to standard output.  If you
11212 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11213 construct: see for example @file{f/lang-specs.h}.
11215 @item %.@var{SUFFIX}
11216 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11217 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11218 terminated by the next space or %.
11220 @item %w
11221 Marks the argument containing or following the @samp{%w} as the
11222 designated output file of this compilation.  This puts the argument
11223 into the sequence of arguments that @samp{%o} substitutes.
11225 @item %o
11226 Substitutes the names of all the output files, with spaces
11227 automatically placed around them.  You should write spaces
11228 around the @samp{%o} as well or the results are undefined.
11229 @samp{%o} is for use in the specs for running the linker.
11230 Input files whose names have no recognized suffix are not compiled
11231 at all, but they are included among the output files, so they are
11232 linked.
11234 @item %O
11235 Substitutes the suffix for object files.  Note that this is
11236 handled specially when it immediately follows @samp{%g, %u, or %U},
11237 because of the need for those to form complete file names.  The
11238 handling is such that @samp{%O} is treated exactly as if it had already
11239 been substituted, except that @samp{%g, %u, and %U} do not currently
11240 support additional @var{suffix} characters following @samp{%O} as they do
11241 following, for example, @samp{.o}.
11243 @item %p
11244 Substitutes the standard macro predefinitions for the
11245 current target machine.  Use this when running @code{cpp}.
11247 @item %P
11248 Like @samp{%p}, but puts @samp{__} before and after the name of each
11249 predefined macro, except for macros that start with @samp{__} or with
11250 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11253 @item %I
11254 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11255 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11256 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11257 and @option{-imultilib} as necessary.
11259 @item %s
11260 Current argument is the name of a library or startup file of some sort.
11261 Search for that file in a standard list of directories and substitute
11262 the full name found.  The current working directory is included in the
11263 list of directories scanned.
11265 @item %T
11266 Current argument is the name of a linker script.  Search for that file
11267 in the current list of directories to scan for libraries. If the file
11268 is located insert a @option{--script} option into the command line
11269 followed by the full path name found.  If the file is not found then
11270 generate an error message.  Note: the current working directory is not
11271 searched.
11273 @item %e@var{str}
11274 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11275 Use this when inconsistent options are detected.
11277 @item %(@var{name})
11278 Substitute the contents of spec string @var{name} at this point.
11280 @item %x@{@var{option}@}
11281 Accumulate an option for @samp{%X}.
11283 @item %X
11284 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11285 spec string.
11287 @item %Y
11288 Output the accumulated assembler options specified by @option{-Wa}.
11290 @item %Z
11291 Output the accumulated preprocessor options specified by @option{-Wp}.
11293 @item %a
11294 Process the @code{asm} spec.  This is used to compute the
11295 switches to be passed to the assembler.
11297 @item %A
11298 Process the @code{asm_final} spec.  This is a spec string for
11299 passing switches to an assembler post-processor, if such a program is
11300 needed.
11302 @item %l
11303 Process the @code{link} spec.  This is the spec for computing the
11304 command line passed to the linker.  Typically it makes use of the
11305 @samp{%L %G %S %D and %E} sequences.
11307 @item %D
11308 Dump out a @option{-L} option for each directory that GCC believes might
11309 contain startup files.  If the target supports multilibs then the
11310 current multilib directory is prepended to each of these paths.
11312 @item %L
11313 Process the @code{lib} spec.  This is a spec string for deciding which
11314 libraries are included on the command line to the linker.
11316 @item %G
11317 Process the @code{libgcc} spec.  This is a spec string for deciding
11318 which GCC support library is included on the command line to the linker.
11320 @item %S
11321 Process the @code{startfile} spec.  This is a spec for deciding which
11322 object files are the first ones passed to the linker.  Typically
11323 this might be a file named @file{crt0.o}.
11325 @item %E
11326 Process the @code{endfile} spec.  This is a spec string that specifies
11327 the last object files that are passed to the linker.
11329 @item %C
11330 Process the @code{cpp} spec.  This is used to construct the arguments
11331 to be passed to the C preprocessor.
11333 @item %1
11334 Process the @code{cc1} spec.  This is used to construct the options to be
11335 passed to the actual C compiler (@samp{cc1}).
11337 @item %2
11338 Process the @code{cc1plus} spec.  This is used to construct the options to be
11339 passed to the actual C++ compiler (@samp{cc1plus}).
11341 @item %*
11342 Substitute the variable part of a matched option.  See below.
11343 Note that each comma in the substituted string is replaced by
11344 a single space.
11346 @item %<@code{S}
11347 Remove all occurrences of @code{-S} from the command line.  Note---this
11348 command is position dependent.  @samp{%} commands in the spec string
11349 before this one see @code{-S}, @samp{%} commands in the spec string
11350 after this one do not.
11352 @item %:@var{function}(@var{args})
11353 Call the named function @var{function}, passing it @var{args}.
11354 @var{args} is first processed as a nested spec string, then split
11355 into an argument vector in the usual fashion.  The function returns
11356 a string which is processed as if it had appeared literally as part
11357 of the current spec.
11359 The following built-in spec functions are provided:
11361 @table @code
11362 @item @code{getenv}
11363 The @code{getenv} spec function takes two arguments: an environment
11364 variable name and a string.  If the environment variable is not
11365 defined, a fatal error is issued.  Otherwise, the return value is the
11366 value of the environment variable concatenated with the string.  For
11367 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11369 @smallexample
11370 %:getenv(TOPDIR /include)
11371 @end smallexample
11373 expands to @file{/path/to/top/include}.
11375 @item @code{if-exists}
11376 The @code{if-exists} spec function takes one argument, an absolute
11377 pathname to a file.  If the file exists, @code{if-exists} returns the
11378 pathname.  Here is a small example of its usage:
11380 @smallexample
11381 *startfile:
11382 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11383 @end smallexample
11385 @item @code{if-exists-else}
11386 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11387 spec function, except that it takes two arguments.  The first argument is
11388 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11389 returns the pathname.  If it does not exist, it returns the second argument.
11390 This way, @code{if-exists-else} can be used to select one file or another,
11391 based on the existence of the first.  Here is a small example of its usage:
11393 @smallexample
11394 *startfile:
11395 crt0%O%s %:if-exists(crti%O%s) \
11396 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11397 @end smallexample
11399 @item @code{replace-outfile}
11400 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11401 first argument in the outfiles array and replaces it with the second argument.  Here
11402 is a small example of its usage:
11404 @smallexample
11405 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11406 @end smallexample
11408 @item @code{remove-outfile}
11409 The @code{remove-outfile} spec function takes one argument.  It looks for the
11410 first argument in the outfiles array and removes it.  Here is a small example
11411 its usage:
11413 @smallexample
11414 %:remove-outfile(-lm)
11415 @end smallexample
11417 @item @code{pass-through-libs}
11418 The @code{pass-through-libs} spec function takes any number of arguments.  It
11419 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11420 assumes are the names of linker input library archive files) and returns a
11421 result containing all the found arguments each prepended by
11422 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11423 intended to be passed to the LTO linker plugin.
11425 @smallexample
11426 %:pass-through-libs(%G %L %G)
11427 @end smallexample
11429 @item @code{print-asm-header}
11430 The @code{print-asm-header} function takes no arguments and simply
11431 prints a banner like:
11433 @smallexample
11434 Assembler options
11435 =================
11437 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11438 @end smallexample
11440 It is used to separate compiler options from assembler options
11441 in the @option{--target-help} output.
11442 @end table
11444 @item %@{@code{S}@}
11445 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11446 If that switch is not specified, this substitutes nothing.  Note that
11447 the leading dash is omitted when specifying this option, and it is
11448 automatically inserted if the substitution is performed.  Thus the spec
11449 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11450 and outputs the command-line option @option{-foo}.
11452 @item %W@{@code{S}@}
11453 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11454 deleted on failure.
11456 @item %@{@code{S}*@}
11457 Substitutes all the switches specified to GCC whose names start
11458 with @code{-S}, but which also take an argument.  This is used for
11459 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11460 GCC considers @option{-o foo} as being
11461 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11462 text, including the space.  Thus two arguments are generated.
11464 @item %@{@code{S}*&@code{T}*@}
11465 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11466 (the order of @code{S} and @code{T} in the spec is not significant).
11467 There can be any number of ampersand-separated variables; for each the
11468 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11470 @item %@{@code{S}:@code{X}@}
11471 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11473 @item %@{!@code{S}:@code{X}@}
11474 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11476 @item %@{@code{S}*:@code{X}@}
11477 Substitutes @code{X} if one or more switches whose names start with
11478 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11479 once, no matter how many such switches appeared.  However, if @code{%*}
11480 appears somewhere in @code{X}, then @code{X} is substituted once
11481 for each matching switch, with the @code{%*} replaced by the part of
11482 that switch matching the @code{*}.
11484 If @code{%*} appears as the last part of a spec sequence then a space
11485 will be added after the end of the last substitution.  If there is more
11486 text in the sequence however then a space will not be generated.  This
11487 allows the @code{%*} substitution to be used as part of a larger
11488 string.  For example, a spec string like this:
11490 @smallexample
11491 %@{mcu=*:--script=%*/memory.ld@}
11492 @end smallexample
11494 when matching an option like @code{-mcu=newchip} will produce:
11496 @smallexample
11497 --script=newchip/memory.ld
11498 @end smallexample
11500 @item %@{.@code{S}:@code{X}@}
11501 Substitutes @code{X}, if processing a file with suffix @code{S}.
11503 @item %@{!.@code{S}:@code{X}@}
11504 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11506 @item %@{,@code{S}:@code{X}@}
11507 Substitutes @code{X}, if processing a file for language @code{S}.
11509 @item %@{!,@code{S}:@code{X}@}
11510 Substitutes @code{X}, if not processing a file for language @code{S}.
11512 @item %@{@code{S}|@code{P}:@code{X}@}
11513 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11514 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11515 @code{*} sequences as well, although they have a stronger binding than
11516 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11517 alternatives must be starred, and only the first matching alternative
11518 is substituted.
11520 For example, a spec string like this:
11522 @smallexample
11523 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11524 @end smallexample
11526 @noindent
11527 outputs the following command-line options from the following input
11528 command-line options:
11530 @smallexample
11531 fred.c        -foo -baz
11532 jim.d         -bar -boggle
11533 -d fred.c     -foo -baz -boggle
11534 -d jim.d      -bar -baz -boggle
11535 @end smallexample
11537 @item %@{S:X; T:Y; :D@}
11539 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11540 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11541 be as many clauses as you need.  This may be combined with @code{.},
11542 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11545 @end table
11547 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11548 construct may contain other nested @samp{%} constructs or spaces, or
11549 even newlines.  They are processed as usual, as described above.
11550 Trailing white space in @code{X} is ignored.  White space may also
11551 appear anywhere on the left side of the colon in these constructs,
11552 except between @code{.} or @code{*} and the corresponding word.
11554 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11555 handled specifically in these constructs.  If another value of
11556 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11557 @option{-W} switch is found later in the command line, the earlier
11558 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11559 just one letter, which passes all matching options.
11561 The character @samp{|} at the beginning of the predicate text is used to
11562 indicate that a command should be piped to the following command, but
11563 only if @option{-pipe} is specified.
11565 It is built into GCC which switches take arguments and which do not.
11566 (You might think it would be useful to generalize this to allow each
11567 compiler's spec to say which switches take arguments.  But this cannot
11568 be done in a consistent fashion.  GCC cannot even decide which input
11569 files have been specified without knowing which switches take arguments,
11570 and it must know which input files to compile in order to tell which
11571 compilers to run).
11573 GCC also knows implicitly that arguments starting in @option{-l} are to be
11574 treated as compiler output files, and passed to the linker in their
11575 proper position among the other output files.
11577 @c man begin OPTIONS
11579 @node Target Options
11580 @section Specifying Target Machine and Compiler Version
11581 @cindex target options
11582 @cindex cross compiling
11583 @cindex specifying machine version
11584 @cindex specifying compiler version and target machine
11585 @cindex compiler version, specifying
11586 @cindex target machine, specifying
11588 The usual way to run GCC is to run the executable called @command{gcc}, or
11589 @command{@var{machine}-gcc} when cross-compiling, or
11590 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11591 one that was installed last.
11593 @node Submodel Options
11594 @section Hardware Models and Configurations
11595 @cindex submodel options
11596 @cindex specifying hardware config
11597 @cindex hardware models and configurations, specifying
11598 @cindex machine dependent options
11600 Each target machine types can have its own
11601 special options, starting with @samp{-m}, to choose among various
11602 hardware models or configurations---for example, 68010 vs 68020,
11603 floating coprocessor or none.  A single installed version of the
11604 compiler can compile for any model or configuration, according to the
11605 options specified.
11607 Some configurations of the compiler also support additional special
11608 options, usually for compatibility with other compilers on the same
11609 platform.
11611 @c This list is ordered alphanumerically by subsection name.
11612 @c It should be the same order and spelling as these options are listed
11613 @c in Machine Dependent Options
11615 @menu
11616 * AArch64 Options::
11617 * Adapteva Epiphany Options::
11618 * ARC Options::
11619 * ARM Options::
11620 * AVR Options::
11621 * Blackfin Options::
11622 * C6X Options::
11623 * CRIS Options::
11624 * CR16 Options::
11625 * Darwin Options::
11626 * DEC Alpha Options::
11627 * FR30 Options::
11628 * FRV Options::
11629 * GNU/Linux Options::
11630 * H8/300 Options::
11631 * HPPA Options::
11632 * i386 and x86-64 Options::
11633 * i386 and x86-64 Windows Options::
11634 * IA-64 Options::
11635 * LM32 Options::
11636 * M32C Options::
11637 * M32R/D Options::
11638 * M680x0 Options::
11639 * MCore Options::
11640 * MeP Options::
11641 * MicroBlaze Options::
11642 * MIPS Options::
11643 * MMIX Options::
11644 * MN10300 Options::
11645 * Moxie Options::
11646 * MSP430 Options::
11647 * NDS32 Options::
11648 * Nios II Options::
11649 * PDP-11 Options::
11650 * picoChip Options::
11651 * PowerPC Options::
11652 * RL78 Options::
11653 * RS/6000 and PowerPC Options::
11654 * RX Options::
11655 * S/390 and zSeries Options::
11656 * Score Options::
11657 * SH Options::
11658 * Solaris 2 Options::
11659 * SPARC Options::
11660 * SPU Options::
11661 * System V Options::
11662 * TILE-Gx Options::
11663 * TILEPro Options::
11664 * V850 Options::
11665 * VAX Options::
11666 * VMS Options::
11667 * VxWorks Options::
11668 * x86-64 Options::
11669 * Xstormy16 Options::
11670 * Xtensa Options::
11671 * zSeries Options::
11672 @end menu
11674 @node AArch64 Options
11675 @subsection AArch64 Options
11676 @cindex AArch64 Options
11678 These options are defined for AArch64 implementations:
11680 @table @gcctabopt
11682 @item -mabi=@var{name}
11683 @opindex mabi
11684 Generate code for the specified data model.  Permissible values
11685 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11686 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11687 but long int and pointer are 64-bit.
11689 The default depends on the specific target configuration.  Note that
11690 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11691 entire program with the same ABI, and link with a compatible set of libraries.
11693 @item -mbig-endian
11694 @opindex mbig-endian
11695 Generate big-endian code.  This is the default when GCC is configured for an
11696 @samp{aarch64_be-*-*} target.
11698 @item -mgeneral-regs-only
11699 @opindex mgeneral-regs-only
11700 Generate code which uses only the general registers.
11702 @item -mlittle-endian
11703 @opindex mlittle-endian
11704 Generate little-endian code.  This is the default when GCC is configured for an
11705 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11707 @item -mcmodel=tiny
11708 @opindex mcmodel=tiny
11709 Generate code for the tiny code model.  The program and its statically defined
11710 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11711 be statically or dynamically linked.  This model is not fully implemented and
11712 mostly treated as @samp{small}.
11714 @item -mcmodel=small
11715 @opindex mcmodel=small
11716 Generate code for the small code model.  The program and its statically defined
11717 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11718 be statically or dynamically linked.  This is the default code model.
11720 @item -mcmodel=large
11721 @opindex mcmodel=large
11722 Generate code for the large code model.  This makes no assumptions about
11723 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11724 statically linked only.
11726 @item -mstrict-align
11727 @opindex mstrict-align
11728 Do not assume that unaligned memory references will be handled by the system.
11730 @item -momit-leaf-frame-pointer
11731 @itemx -mno-omit-leaf-frame-pointer
11732 @opindex momit-leaf-frame-pointer
11733 @opindex mno-omit-leaf-frame-pointer
11734 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11735 default.
11737 @item -mtls-dialect=desc
11738 @opindex mtls-dialect=desc
11739 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11740 of TLS variables.  This is the default.
11742 @item -mtls-dialect=traditional
11743 @opindex mtls-dialect=traditional
11744 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11745 of TLS variables.
11747 @item -march=@var{name}
11748 @opindex march
11749 Specify the name of the target architecture, optionally suffixed by one or
11750 more feature modifiers.  This option has the form
11751 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11752 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11753 values for @var{feature} are documented in the sub-section below.
11755 Where conflicting feature modifiers are specified, the right-most feature is
11756 used.
11758 GCC uses this name to determine what kind of instructions it can emit when
11759 generating assembly code.
11761 Where @option{-march} is specified without either of @option{-mtune}
11762 or @option{-mcpu} also being specified, the code will be tuned to perform
11763 well across a range of target processors implementing the target
11764 architecture.
11766 @item -mtune=@var{name}
11767 @opindex mtune
11768 Specify the name of the target processor for which GCC should tune the
11769 performance of the code.  Permissible values for this option are:
11770 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}.
11772 Additionally, this option can specify that GCC should tune the performance
11773 of the code for a big.LITTLE system.  The only permissible value is
11774 @samp{cortex-a57.cortex-a53}.
11776 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
11777 are specified, the code will be tuned to perform well across a range
11778 of target processors.
11780 This option cannot be suffixed by feature modifiers.
11782 @item -mcpu=@var{name}
11783 @opindex mcpu
11784 Specify the name of the target processor, optionally suffixed by one or more
11785 feature modifiers.  This option has the form
11786 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11787 permissible values for @var{cpu} are the same as those available for
11788 @option{-mtune}.
11790 The permissible values for @var{feature} are documented in the sub-section
11791 below.
11793 Where conflicting feature modifiers are specified, the right-most feature is
11794 used.
11796 GCC uses this name to determine what kind of instructions it can emit when
11797 generating assembly code (as if by @option{-march}) and to determine
11798 the target processor for which to tune for performance (as if
11799 by @option{-mtune}).  Where this option is used in conjunction
11800 with @option{-march} or @option{-mtune}, those options take precedence
11801 over the appropriate part of this option.
11802 @end table
11804 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11805 @cindex @option{-march} feature modifiers
11806 @cindex @option{-mcpu} feature modifiers
11807 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11808 the following:
11810 @table @samp
11811 @item crc
11812 Enable CRC extension.
11813 @item crypto
11814 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11815 @item fp
11816 Enable floating-point instructions.
11817 @item simd
11818 Enable Advanced SIMD instructions.  This implies floating-point instructions
11819 are enabled.  This is the default for all current possible values for options
11820 @option{-march} and @option{-mcpu=}.
11821 @end table
11823 @node Adapteva Epiphany Options
11824 @subsection Adapteva Epiphany Options
11826 These @samp{-m} options are defined for Adapteva Epiphany:
11828 @table @gcctabopt
11829 @item -mhalf-reg-file
11830 @opindex mhalf-reg-file
11831 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11832 That allows code to run on hardware variants that lack these registers.
11834 @item -mprefer-short-insn-regs
11835 @opindex mprefer-short-insn-regs
11836 Preferrentially allocate registers that allow short instruction generation.
11837 This can result in increased instruction count, so this may either reduce or
11838 increase overall code size.
11840 @item -mbranch-cost=@var{num}
11841 @opindex mbranch-cost
11842 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11843 This cost is only a heuristic and is not guaranteed to produce
11844 consistent results across releases.
11846 @item -mcmove
11847 @opindex mcmove
11848 Enable the generation of conditional moves.
11850 @item -mnops=@var{num}
11851 @opindex mnops
11852 Emit @var{num} NOPs before every other generated instruction.
11854 @item -mno-soft-cmpsf
11855 @opindex mno-soft-cmpsf
11856 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11857 and test the flags.  This is faster than a software comparison, but can
11858 get incorrect results in the presence of NaNs, or when two different small
11859 numbers are compared such that their difference is calculated as zero.
11860 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11861 software comparisons.
11863 @item -mstack-offset=@var{num}
11864 @opindex mstack-offset
11865 Set the offset between the top of the stack and the stack pointer.
11866 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11867 can be used by leaf functions without stack allocation.
11868 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11869 Note also that this option changes the ABI; compiling a program with a
11870 different stack offset than the libraries have been compiled with
11871 generally does not work.
11872 This option can be useful if you want to evaluate if a different stack
11873 offset would give you better code, but to actually use a different stack
11874 offset to build working programs, it is recommended to configure the
11875 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11877 @item -mno-round-nearest
11878 @opindex mno-round-nearest
11879 Make the scheduler assume that the rounding mode has been set to
11880 truncating.  The default is @option{-mround-nearest}.
11882 @item -mlong-calls
11883 @opindex mlong-calls
11884 If not otherwise specified by an attribute, assume all calls might be beyond
11885 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11886 function address into a register before performing a (otherwise direct) call.
11887 This is the default.
11889 @item -mshort-calls
11890 @opindex short-calls
11891 If not otherwise specified by an attribute, assume all direct calls are
11892 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11893 for direct calls.  The default is @option{-mlong-calls}.
11895 @item -msmall16
11896 @opindex msmall16
11897 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11898 apply to function addresses for which @option{-mlong-calls} semantics
11899 are in effect.
11901 @item -mfp-mode=@var{mode}
11902 @opindex mfp-mode
11903 Set the prevailing mode of the floating-point unit.
11904 This determines the floating-point mode that is provided and expected
11905 at function call and return time.  Making this mode match the mode you
11906 predominantly need at function start can make your programs smaller and
11907 faster by avoiding unnecessary mode switches.
11909 @var{mode} can be set to one the following values:
11911 @table @samp
11912 @item caller
11913 Any mode at function entry is valid, and retained or restored when
11914 the function returns, and when it calls other functions.
11915 This mode is useful for compiling libraries or other compilation units
11916 you might want to incorporate into different programs with different
11917 prevailing FPU modes, and the convenience of being able to use a single
11918 object file outweighs the size and speed overhead for any extra
11919 mode switching that might be needed, compared with what would be needed
11920 with a more specific choice of prevailing FPU mode.
11922 @item truncate
11923 This is the mode used for floating-point calculations with
11924 truncating (i.e.@: round towards zero) rounding mode.  That includes
11925 conversion from floating point to integer.
11927 @item round-nearest
11928 This is the mode used for floating-point calculations with
11929 round-to-nearest-or-even rounding mode.
11931 @item int
11932 This is the mode used to perform integer calculations in the FPU, e.g.@:
11933 integer multiply, or integer multiply-and-accumulate.
11934 @end table
11936 The default is @option{-mfp-mode=caller}
11938 @item -mnosplit-lohi
11939 @itemx -mno-postinc
11940 @itemx -mno-postmodify
11941 @opindex mnosplit-lohi
11942 @opindex mno-postinc
11943 @opindex mno-postmodify
11944 Code generation tweaks that disable, respectively, splitting of 32-bit
11945 loads, generation of post-increment addresses, and generation of
11946 post-modify addresses.  The defaults are @option{msplit-lohi},
11947 @option{-mpost-inc}, and @option{-mpost-modify}.
11949 @item -mnovect-double
11950 @opindex mno-vect-double
11951 Change the preferred SIMD mode to SImode.  The default is
11952 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11954 @item -max-vect-align=@var{num}
11955 @opindex max-vect-align
11956 The maximum alignment for SIMD vector mode types.
11957 @var{num} may be 4 or 8.  The default is 8.
11958 Note that this is an ABI change, even though many library function
11959 interfaces are unaffected if they don't use SIMD vector modes
11960 in places that affect size and/or alignment of relevant types.
11962 @item -msplit-vecmove-early
11963 @opindex msplit-vecmove-early
11964 Split vector moves into single word moves before reload.  In theory this
11965 can give better register allocation, but so far the reverse seems to be
11966 generally the case.
11968 @item -m1reg-@var{reg}
11969 @opindex m1reg-
11970 Specify a register to hold the constant @minus{}1, which makes loading small negative
11971 constants and certain bitmasks faster.
11972 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11973 which specify use of that register as a fixed register,
11974 and @samp{none}, which means that no register is used for this
11975 purpose.  The default is @option{-m1reg-none}.
11977 @end table
11979 @node ARC Options
11980 @subsection ARC Options
11981 @cindex ARC options
11983 The following options control the architecture variant for which code
11984 is being compiled:
11986 @c architecture variants
11987 @table @gcctabopt
11989 @item -mbarrel-shifter
11990 @opindex mbarrel-shifter
11991 Generate instructions supported by barrel shifter.  This is the default
11992 unless @samp{-mcpu=ARC601} is in effect.
11994 @item -mcpu=@var{cpu}
11995 @opindex mcpu
11996 Set architecture type, register usage, and instruction scheduling
11997 parameters for @var{cpu}.  There are also shortcut alias options
11998 available for backward compatibility and convenience.  Supported
11999 values for @var{cpu} are
12001 @table @samp
12002 @opindex mA6
12003 @opindex mARC600
12004 @item ARC600
12005 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12007 @item ARC601
12008 @opindex mARC601
12009 Compile for ARC601.  Alias: @option{-mARC601}.
12011 @item ARC700
12012 @opindex mA7
12013 @opindex mARC700
12014 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12015 This is the default when configured with @samp{--with-cpu=arc700}@.
12016 @end table
12018 @item -mdpfp
12019 @opindex mdpfp
12020 @itemx -mdpfp-compact
12021 @opindex mdpfp-compact
12022 FPX: Generate Double Precision FPX instructions, tuned for the compact
12023 implementation.
12025 @item -mdpfp-fast
12026 @opindex mdpfp-fast
12027 FPX: Generate Double Precision FPX instructions, tuned for the fast
12028 implementation.
12030 @item -mno-dpfp-lrsr
12031 @opindex mno-dpfp-lrsr
12032 Disable LR and SR instructions from using FPX extension aux registers.
12034 @item -mea
12035 @opindex mea
12036 Generate Extended arithmetic instructions.  Currently only
12037 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12038 supported.  This is always enabled for @samp{-mcpu=ARC700}.
12040 @item -mno-mpy
12041 @opindex mno-mpy
12042 Do not generate mpy instructions for ARC700.
12044 @item -mmul32x16
12045 @opindex mmul32x16
12046 Generate 32x16 bit multiply and mac instructions.
12048 @item -mmul64
12049 @opindex mmul64
12050 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
12052 @item -mnorm
12053 @opindex mnorm
12054 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
12055 is in effect.
12057 @item -mspfp
12058 @opindex mspfp
12059 @itemx -mspfp-compact
12060 @opindex mspfp-compact
12061 FPX: Generate Single Precision FPX instructions, tuned for the compact
12062 implementation.
12064 @item -mspfp-fast
12065 @opindex mspfp-fast
12066 FPX: Generate Single Precision FPX instructions, tuned for the fast
12067 implementation.
12069 @item -msimd
12070 @opindex msimd
12071 Enable generation of ARC SIMD instructions via target-specific
12072 builtins.  Only valid for @samp{-mcpu=ARC700}.
12074 @item -msoft-float
12075 @opindex msoft-float
12076 This option ignored; it is provided for compatibility purposes only.
12077 Software floating point code is emitted by default, and this default
12078 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12079 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12080 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12082 @item -mswap
12083 @opindex mswap
12084 Generate swap instructions.
12086 @end table
12088 The following options are passed through to the assembler, and also
12089 define preprocessor macro symbols.
12091 @c Flags used by the assembler, but for which we define preprocessor
12092 @c macro symbols as well.
12093 @table @gcctabopt
12094 @item -mdsp-packa
12095 @opindex mdsp-packa
12096 Passed down to the assembler to enable the DSP Pack A extensions.
12097 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12099 @item -mdvbf
12100 @opindex mdvbf
12101 Passed down to the assembler to enable the dual viterbi butterfly
12102 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12104 @c ARC700 4.10 extension instruction
12105 @item -mlock
12106 @opindex mlock
12107 Passed down to the assembler to enable the Locked Load/Store
12108 Conditional extension.  Also sets the preprocessor symbol
12109 @code{__Xlock}.
12111 @item -mmac-d16
12112 @opindex mmac-d16
12113 Passed down to the assembler.  Also sets the preprocessor symbol
12114 @code{__Xxmac_d16}.
12116 @item -mmac-24
12117 @opindex mmac-24
12118 Passed down to the assembler.  Also sets the preprocessor symbol
12119 @code{__Xxmac_24}.
12121 @c ARC700 4.10 extension instruction
12122 @item -mrtsc
12123 @opindex mrtsc
12124 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12125 extension instruction.  Also sets the preprocessor symbol
12126 @code{__Xrtsc}.
12128 @c ARC700 4.10 extension instruction
12129 @item -mswape
12130 @opindex mswape
12131 Passed down to the assembler to enable the swap byte ordering
12132 extension instruction.  Also sets the preprocessor symbol
12133 @code{__Xswape}.
12135 @item -mtelephony
12136 @opindex mtelephony
12137 Passed down to the assembler to enable dual and single operand
12138 instructions for telephony.  Also sets the preprocessor symbol
12139 @code{__Xtelephony}.
12141 @item -mxy
12142 @opindex mxy
12143 Passed down to the assembler to enable the XY Memory extension.  Also
12144 sets the preprocessor symbol @code{__Xxy}.
12146 @end table
12148 The following options control how the assembly code is annotated:
12150 @c Assembly annotation options
12151 @table @gcctabopt
12152 @item -misize
12153 @opindex misize
12154 Annotate assembler instructions with estimated addresses.
12156 @item -mannotate-align
12157 @opindex mannotate-align
12158 Explain what alignment considerations lead to the decision to make an
12159 instruction short or long.
12161 @end table
12163 The following options are passed through to the linker:
12165 @c options passed through to the linker
12166 @table @gcctabopt
12167 @item -marclinux
12168 @opindex marclinux
12169 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12170 This option is enabled by default in tool chains built for
12171 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12172 when profiling is not requested.
12174 @item -marclinux_prof
12175 @opindex marclinux_prof
12176 Passed through to the linker, to specify use of the
12177 @code{arclinux_prof} emulation.  This option is enabled by default in
12178 tool chains built for @w{@code{arc-linux-uclibc}} and
12179 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12181 @end table
12183 The following options control the semantics of generated code:
12185 @c semantically relevant code generation options
12186 @table @gcctabopt
12187 @item -mepilogue-cfi
12188 @opindex mepilogue-cfi
12189 Enable generation of call frame information for epilogues.
12191 @item -mno-epilogue-cfi
12192 @opindex mno-epilogue-cfi
12193 Disable generation of call frame information for epilogues.
12195 @item -mlong-calls
12196 @opindex mlong-calls
12197 Generate call insns as register indirect calls, thus providing access
12198 to the full 32-bit address range.
12200 @item -mmedium-calls
12201 @opindex mmedium-calls
12202 Don't use less than 25 bit addressing range for calls, which is the
12203 offset available for an unconditional branch-and-link
12204 instruction.  Conditional execution of function calls is suppressed, to
12205 allow use of the 25-bit range, rather than the 21-bit range with
12206 conditional branch-and-link.  This is the default for tool chains built
12207 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12209 @item -mno-sdata
12210 @opindex mno-sdata
12211 Do not generate sdata references.  This is the default for tool chains
12212 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12213 targets.
12215 @item -mucb-mcount
12216 @opindex mucb-mcount
12217 Instrument with mcount calls as used in UCB code.  I.e. do the
12218 counting in the callee, not the caller.  By default ARC instrumentation
12219 counts in the caller.
12221 @item -mvolatile-cache
12222 @opindex mvolatile-cache
12223 Use ordinarily cached memory accesses for volatile references.  This is the
12224 default.
12226 @item -mno-volatile-cache
12227 @opindex mno-volatile-cache
12228 Enable cache bypass for volatile references.
12230 @end table
12232 The following options fine tune code generation:
12233 @c code generation tuning options
12234 @table @gcctabopt
12235 @item -malign-call
12236 @opindex malign-call
12237 Do alignment optimizations for call instructions.
12239 @item -mauto-modify-reg
12240 @opindex mauto-modify-reg
12241 Enable the use of pre/post modify with register displacement.
12243 @item -mbbit-peephole
12244 @opindex mbbit-peephole
12245 Enable bbit peephole2.
12247 @item -mno-brcc
12248 @opindex mno-brcc
12249 This option disables a target-specific pass in @file{arc_reorg} to
12250 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12251 generation driven by the combiner pass.
12253 @item -mcase-vector-pcrel
12254 @opindex mcase-vector-pcrel
12255 Use pc-relative switch case tables - this enables case table shortening.
12256 This is the default for @option{-Os}.
12258 @item -mcompact-casesi
12259 @opindex mcompact-casesi
12260 Enable compact casesi pattern.
12261 This is the default for @option{-Os}.
12263 @item -mno-cond-exec
12264 @opindex mno-cond-exec
12265 Disable ARCompact specific pass to generate conditional execution instructions.
12266 Due to delay slot scheduling and interactions between operand numbers,
12267 literal sizes, instruction lengths, and the support for conditional execution,
12268 the target-independent pass to generate conditional execution is often lacking,
12269 so the ARC port has kept a special pass around that tries to find more
12270 conditional execution generating opportunities after register allocation,
12271 branch shortening, and delay slot scheduling have been done.  This pass
12272 generally, but not always, improves performance and code size, at the cost of
12273 extra compilation time, which is why there is an option to switch it off.
12274 If you have a problem with call instructions exceeding their allowable
12275 offset range because they are conditionalized, you should consider using
12276 @option{-mmedium-calls} instead.
12278 @item -mearly-cbranchsi
12279 @opindex mearly-cbranchsi
12280 Enable pre-reload use of the cbranchsi pattern.
12282 @item -mexpand-adddi
12283 @opindex mexpand-adddi
12284 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12285 @code{add.f}, @code{adc} etc.
12287 @item -mindexed-loads
12288 @opindex mindexed-loads
12289 Enable the use of indexed loads.  This can be problematic because some
12290 optimizers will then assume the that indexed stores exist, which is not
12291 the case.
12293 @item -mlra
12294 @opindex mlra
12295 Enable Local Register Allocation.  This is still experimental for ARC,
12296 so by default the compiler uses standard reload
12297 (i.e. @samp{-mno-lra}).
12299 @item -mlra-priority-none
12300 @opindex mlra-priority-none
12301 Don't indicate any priority for target registers.
12303 @item -mlra-priority-compact
12304 @opindex mlra-priority-compact
12305 Indicate target register priority for r0..r3 / r12..r15.
12307 @item -mlra-priority-noncompact
12308 @opindex mlra-priority-noncompact
12309 Reduce target regsiter priority for r0..r3 / r12..r15.
12311 @item -mno-millicode
12312 @opindex mno-millicode
12313 When optimizing for size (using @option{-Os}), prologues and epilogues
12314 that have to save or restore a large number of registers are often
12315 shortened by using call to a special function in libgcc; this is
12316 referred to as a @emph{millicode} call.  As these calls can pose
12317 performance issues, and/or cause linking issues when linking in a
12318 nonstandard way, this option is provided to turn off millicode call
12319 generation.
12321 @item -mmixed-code
12322 @opindex mmixed-code
12323 Tweak register allocation to help 16-bit instruction generation.
12324 This generally has the effect of decreasing the average instruction size
12325 while increasing the instruction count.
12327 @item -mq-class
12328 @opindex mq-class
12329 Enable 'q' instruction alternatives.
12330 This is the default for @option{-Os}.
12332 @item -mRcq
12333 @opindex mRcq
12334 Enable Rcq constraint handling - most short code generation depends on this.
12335 This is the default.
12337 @item -mRcw
12338 @opindex mRcw
12339 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12340 This is the default.
12342 @item -msize-level=@var{level}
12343 @opindex msize-level
12344 Fine-tune size optimization with regards to instruction lengths and alignment.
12345 The recognized values for @var{level} are:
12346 @table @samp
12347 @item 0
12348 No size optimization.  This level is deprecated and treated like @samp{1}.
12350 @item 1
12351 Short instructions are used opportunistically.
12353 @item 2
12354 In addition, alignment of loops and of code after barriers are dropped.
12356 @item 3
12357 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12359 @end table
12361 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12362 the behavior when this is not set is equivalent to level @samp{1}.
12364 @item -mtune=@var{cpu}
12365 @opindex mtune
12366 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12367 by @option{-mcpu=}.
12369 Supported values for @var{cpu} are
12371 @table @samp
12372 @item ARC600
12373 Tune for ARC600 cpu.
12375 @item ARC601
12376 Tune for ARC601 cpu.
12378 @item ARC700
12379 Tune for ARC700 cpu with standard multiplier block.
12381 @item ARC700-xmac
12382 Tune for ARC700 cpu with XMAC block.
12384 @item ARC725D
12385 Tune for ARC725D cpu.
12387 @item ARC750D
12388 Tune for ARC750D cpu.
12390 @end table
12392 @item -mmultcost=@var{num}
12393 @opindex mmultcost
12394 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12395 normal instruction.
12397 @item -munalign-prob-threshold=@var{probability}
12398 @opindex munalign-prob-threshold
12399 Set probability threshold for unaligning branches.
12400 When tuning for @samp{ARC700} and optimizing for speed, branches without
12401 filled delay slot are preferably emitted unaligned and long, unless
12402 profiling indicates that the probability for the branch to be taken
12403 is below @var{probability}.  @xref{Cross-profiling}.
12404 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12406 @end table
12408 The following options are maintained for backward compatibility, but
12409 are now deprecated and will be removed in a future release:
12411 @c Deprecated options
12412 @table @gcctabopt
12414 @item -margonaut
12415 @opindex margonaut
12416 Obsolete FPX.
12418 @item -mbig-endian
12419 @opindex mbig-endian
12420 @itemx -EB
12421 @opindex EB
12422 Compile code for big endian targets.  Use of these options is now
12423 deprecated.  Users wanting big-endian code, should use the
12424 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12425 building the tool chain, for which big-endian is the default.
12427 @item -mlittle-endian
12428 @opindex mlittle-endian
12429 @itemx -EL
12430 @opindex EL
12431 Compile code for little endian targets.  Use of these options is now
12432 deprecated.  Users wanting little-endian code should use the
12433 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12434 building the tool chain, for which little-endian is the default.
12436 @item -mbarrel_shifter
12437 @opindex mbarrel_shifter
12438 Replaced by @samp{-mbarrel-shifter}
12440 @item -mdpfp_compact
12441 @opindex mdpfp_compact
12442 Replaced by @samp{-mdpfp-compact}
12444 @item -mdpfp_fast
12445 @opindex mdpfp_fast
12446 Replaced by @samp{-mdpfp-fast}
12448 @item -mdsp_packa
12449 @opindex mdsp_packa
12450 Replaced by @samp{-mdsp-packa}
12452 @item -mEA
12453 @opindex mEA
12454 Replaced by @samp{-mea}
12456 @item -mmac_24
12457 @opindex mmac_24
12458 Replaced by @samp{-mmac-24}
12460 @item -mmac_d16
12461 @opindex mmac_d16
12462 Replaced by @samp{-mmac-d16}
12464 @item -mspfp_compact
12465 @opindex mspfp_compact
12466 Replaced by @samp{-mspfp-compact}
12468 @item -mspfp_fast
12469 @opindex mspfp_fast
12470 Replaced by @samp{-mspfp-fast}
12472 @item -mtune=@var{cpu}
12473 @opindex mtune
12474 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12475 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12476 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12478 @item -multcost=@var{num}
12479 @opindex multcost
12480 Replaced by @samp{-mmultcost}.
12482 @end table
12484 @node ARM Options
12485 @subsection ARM Options
12486 @cindex ARM options
12488 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
12489 architectures:
12491 @table @gcctabopt
12492 @item -mabi=@var{name}
12493 @opindex mabi
12494 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12495 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12497 @item -mapcs-frame
12498 @opindex mapcs-frame
12499 Generate a stack frame that is compliant with the ARM Procedure Call
12500 Standard for all functions, even if this is not strictly necessary for
12501 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12502 with this option causes the stack frames not to be generated for
12503 leaf functions.  The default is @option{-mno-apcs-frame}.
12505 @item -mapcs
12506 @opindex mapcs
12507 This is a synonym for @option{-mapcs-frame}.
12509 @ignore
12510 @c not currently implemented
12511 @item -mapcs-stack-check
12512 @opindex mapcs-stack-check
12513 Generate code to check the amount of stack space available upon entry to
12514 every function (that actually uses some stack space).  If there is
12515 insufficient space available then either the function
12516 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12517 called, depending upon the amount of stack space required.  The runtime
12518 system is required to provide these functions.  The default is
12519 @option{-mno-apcs-stack-check}, since this produces smaller code.
12521 @c not currently implemented
12522 @item -mapcs-float
12523 @opindex mapcs-float
12524 Pass floating-point arguments using the floating-point registers.  This is
12525 one of the variants of the APCS@.  This option is recommended if the
12526 target hardware has a floating-point unit or if a lot of floating-point
12527 arithmetic is going to be performed by the code.  The default is
12528 @option{-mno-apcs-float}, since the size of integer-only code is 
12529 slightly increased if @option{-mapcs-float} is used.
12531 @c not currently implemented
12532 @item -mapcs-reentrant
12533 @opindex mapcs-reentrant
12534 Generate reentrant, position-independent code.  The default is
12535 @option{-mno-apcs-reentrant}.
12536 @end ignore
12538 @item -mthumb-interwork
12539 @opindex mthumb-interwork
12540 Generate code that supports calling between the ARM and Thumb
12541 instruction sets.  Without this option, on pre-v5 architectures, the
12542 two instruction sets cannot be reliably used inside one program.  The
12543 default is @option{-mno-thumb-interwork}, since slightly larger code
12544 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12545 configurations this option is meaningless.
12547 @item -mno-sched-prolog
12548 @opindex mno-sched-prolog
12549 Prevent the reordering of instructions in the function prologue, or the
12550 merging of those instruction with the instructions in the function's
12551 body.  This means that all functions start with a recognizable set
12552 of instructions (or in fact one of a choice from a small set of
12553 different function prologues), and this information can be used to
12554 locate the start of functions inside an executable piece of code.  The
12555 default is @option{-msched-prolog}.
12557 @item -mfloat-abi=@var{name}
12558 @opindex mfloat-abi
12559 Specifies which floating-point ABI to use.  Permissible values
12560 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12562 Specifying @samp{soft} causes GCC to generate output containing
12563 library calls for floating-point operations.
12564 @samp{softfp} allows the generation of code using hardware floating-point
12565 instructions, but still uses the soft-float calling conventions.
12566 @samp{hard} allows generation of floating-point instructions
12567 and uses FPU-specific calling conventions.
12569 The default depends on the specific target configuration.  Note that
12570 the hard-float and soft-float ABIs are not link-compatible; you must
12571 compile your entire program with the same ABI, and link with a
12572 compatible set of libraries.
12574 @item -mlittle-endian
12575 @opindex mlittle-endian
12576 Generate code for a processor running in little-endian mode.  This is
12577 the default for all standard configurations.
12579 @item -mbig-endian
12580 @opindex mbig-endian
12581 Generate code for a processor running in big-endian mode; the default is
12582 to compile code for a little-endian processor.
12584 @item -march=@var{name}
12585 @opindex march
12586 This specifies the name of the target ARM architecture.  GCC uses this
12587 name to determine what kind of instructions it can emit when generating
12588 assembly code.  This option can be used in conjunction with or instead
12589 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12590 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12591 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12592 @samp{armv6}, @samp{armv6j},
12593 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12594 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12595 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12596 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12598 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12599 extensions.
12601 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12602 architecture together with the optional CRC32 extensions.
12604 @option{-march=native} causes the compiler to auto-detect the architecture
12605 of the build computer.  At present, this feature is only supported on
12606 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12607 is unsuccessful the option has no effect.
12609 @item -mtune=@var{name}
12610 @opindex mtune
12611 This option specifies the name of the target ARM processor for
12612 which GCC should tune the performance of the code.
12613 For some ARM implementations better performance can be obtained by using
12614 this option.
12615 Permissible names are: @samp{arm2}, @samp{arm250},
12616 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12617 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12618 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12619 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12620 @samp{arm720},
12621 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12622 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12623 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12624 @samp{strongarm1110},
12625 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12626 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12627 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12628 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12629 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12630 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12631 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12632 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12633 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12634 @samp{cortex-r4},
12635 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12636 @samp{cortex-m4},
12637 @samp{cortex-m3},
12638 @samp{cortex-m1},
12639 @samp{cortex-m0},
12640 @samp{cortex-m0plus},
12641 @samp{marvell-pj4},
12642 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12643 @samp{fa526}, @samp{fa626},
12644 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12646 Additionally, this option can specify that GCC should tune the performance
12647 of the code for a big.LITTLE system.  Permissible names are:
12648 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12650 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12651 performance for a blend of processors within architecture @var{arch}.
12652 The aim is to generate code that run well on the current most popular
12653 processors, balancing between optimizations that benefit some CPUs in the
12654 range, and avoiding performance pitfalls of other CPUs.  The effects of
12655 this option may change in future GCC versions as CPU models come and go.
12657 @option{-mtune=native} causes the compiler to auto-detect the CPU
12658 of the build computer.  At present, this feature is only supported on
12659 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12660 unsuccessful the option has no effect.
12662 @item -mcpu=@var{name}
12663 @opindex mcpu
12664 This specifies the name of the target ARM processor.  GCC uses this name
12665 to derive the name of the target ARM architecture (as if specified
12666 by @option{-march}) and the ARM processor type for which to tune for
12667 performance (as if specified by @option{-mtune}).  Where this option
12668 is used in conjunction with @option{-march} or @option{-mtune},
12669 those options take precedence over the appropriate part of this option.
12671 Permissible names for this option are the same as those for
12672 @option{-mtune}.
12674 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12675 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12676 See @option{-mtune} for more information.
12678 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12679 of the build computer.  At present, this feature is only supported on
12680 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12681 is unsuccessful the option has no effect.
12683 @item -mfpu=@var{name}
12684 @opindex mfpu
12685 This specifies what floating-point hardware (or hardware emulation) is
12686 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12687 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12688 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12689 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12690 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12691 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12693 If @option{-msoft-float} is specified this specifies the format of
12694 floating-point values.
12696 If the selected floating-point hardware includes the NEON extension
12697 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12698 operations are not generated by GCC's auto-vectorization pass unless
12699 @option{-funsafe-math-optimizations} is also specified.  This is
12700 because NEON hardware does not fully implement the IEEE 754 standard for
12701 floating-point arithmetic (in particular denormal values are treated as
12702 zero), so the use of NEON instructions may lead to a loss of precision.
12704 @item -mfp16-format=@var{name}
12705 @opindex mfp16-format
12706 Specify the format of the @code{__fp16} half-precision floating-point type.
12707 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12708 the default is @samp{none}, in which case the @code{__fp16} type is not
12709 defined.  @xref{Half-Precision}, for more information.
12711 @item -mstructure-size-boundary=@var{n}
12712 @opindex mstructure-size-boundary
12713 The sizes of all structures and unions are rounded up to a multiple
12714 of the number of bits set by this option.  Permissible values are 8, 32
12715 and 64.  The default value varies for different toolchains.  For the COFF
12716 targeted toolchain the default value is 8.  A value of 64 is only allowed
12717 if the underlying ABI supports it.
12719 Specifying a larger number can produce faster, more efficient code, but
12720 can also increase the size of the program.  Different values are potentially
12721 incompatible.  Code compiled with one value cannot necessarily expect to
12722 work with code or libraries compiled with another value, if they exchange
12723 information using structures or unions.
12725 @item -mabort-on-noreturn
12726 @opindex mabort-on-noreturn
12727 Generate a call to the function @code{abort} at the end of a
12728 @code{noreturn} function.  It is executed if the function tries to
12729 return.
12731 @item -mlong-calls
12732 @itemx -mno-long-calls
12733 @opindex mlong-calls
12734 @opindex mno-long-calls
12735 Tells the compiler to perform function calls by first loading the
12736 address of the function into a register and then performing a subroutine
12737 call on this register.  This switch is needed if the target function
12738 lies outside of the 64-megabyte addressing range of the offset-based
12739 version of subroutine call instruction.
12741 Even if this switch is enabled, not all function calls are turned
12742 into long calls.  The heuristic is that static functions, functions
12743 that have the @samp{short-call} attribute, functions that are inside
12744 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12745 definitions have already been compiled within the current compilation
12746 unit are not turned into long calls.  The exceptions to this rule are
12747 that weak function definitions, functions with the @samp{long-call}
12748 attribute or the @samp{section} attribute, and functions that are within
12749 the scope of a @samp{#pragma long_calls} directive are always
12750 turned into long calls.
12752 This feature is not enabled by default.  Specifying
12753 @option{-mno-long-calls} restores the default behavior, as does
12754 placing the function calls within the scope of a @samp{#pragma
12755 long_calls_off} directive.  Note these switches have no effect on how
12756 the compiler generates code to handle function calls via function
12757 pointers.
12759 @item -msingle-pic-base
12760 @opindex msingle-pic-base
12761 Treat the register used for PIC addressing as read-only, rather than
12762 loading it in the prologue for each function.  The runtime system is
12763 responsible for initializing this register with an appropriate value
12764 before execution begins.
12766 @item -mpic-register=@var{reg}
12767 @opindex mpic-register
12768 Specify the register to be used for PIC addressing.
12769 For standard PIC base case, the default will be any suitable register
12770 determined by compiler.  For single PIC base case, the default is
12771 @samp{R9} if target is EABI based or stack-checking is enabled,
12772 otherwise the default is @samp{R10}.
12774 @item -mpic-data-is-text-relative
12775 @opindex mpic-data-is-text-relative
12776 Assume that each data segments are relative to text segment at load time.
12777 Therefore, it permits addressing data using PC-relative operations.
12778 This option is on by default for targets other than VxWorks RTP.
12780 @item -mpoke-function-name
12781 @opindex mpoke-function-name
12782 Write the name of each function into the text section, directly
12783 preceding the function prologue.  The generated code is similar to this:
12785 @smallexample
12786      t0
12787          .ascii "arm_poke_function_name", 0
12788          .align
12789      t1
12790          .word 0xff000000 + (t1 - t0)
12791      arm_poke_function_name
12792          mov     ip, sp
12793          stmfd   sp!, @{fp, ip, lr, pc@}
12794          sub     fp, ip, #4
12795 @end smallexample
12797 When performing a stack backtrace, code can inspect the value of
12798 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
12799 location @code{pc - 12} and the top 8 bits are set, then we know that
12800 there is a function name embedded immediately preceding this location
12801 and has length @code{((pc[-3]) & 0xff000000)}.
12803 @item -mthumb
12804 @itemx -marm
12805 @opindex marm
12806 @opindex mthumb
12808 Select between generating code that executes in ARM and Thumb
12809 states.  The default for most configurations is to generate code
12810 that executes in ARM state, but the default can be changed by
12811 configuring GCC with the @option{--with-mode=}@var{state}
12812 configure option.
12814 @item -mtpcs-frame
12815 @opindex mtpcs-frame
12816 Generate a stack frame that is compliant with the Thumb Procedure Call
12817 Standard for all non-leaf functions.  (A leaf function is one that does
12818 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
12820 @item -mtpcs-leaf-frame
12821 @opindex mtpcs-leaf-frame
12822 Generate a stack frame that is compliant with the Thumb Procedure Call
12823 Standard for all leaf functions.  (A leaf function is one that does
12824 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
12826 @item -mcallee-super-interworking
12827 @opindex mcallee-super-interworking
12828 Gives all externally visible functions in the file being compiled an ARM
12829 instruction set header which switches to Thumb mode before executing the
12830 rest of the function.  This allows these functions to be called from
12831 non-interworking code.  This option is not valid in AAPCS configurations
12832 because interworking is enabled by default.
12834 @item -mcaller-super-interworking
12835 @opindex mcaller-super-interworking
12836 Allows calls via function pointers (including virtual functions) to
12837 execute correctly regardless of whether the target code has been
12838 compiled for interworking or not.  There is a small overhead in the cost
12839 of executing a function pointer if this option is enabled.  This option
12840 is not valid in AAPCS configurations because interworking is enabled
12841 by default.
12843 @item -mtp=@var{name}
12844 @opindex mtp
12845 Specify the access model for the thread local storage pointer.  The valid
12846 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
12847 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
12848 (supported in the arm6k architecture), and @option{auto}, which uses the
12849 best available method for the selected processor.  The default setting is
12850 @option{auto}.
12852 @item -mtls-dialect=@var{dialect}
12853 @opindex mtls-dialect
12854 Specify the dialect to use for accessing thread local storage.  Two
12855 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
12856 @samp{gnu} dialect selects the original GNU scheme for supporting
12857 local and global dynamic TLS models.  The @samp{gnu2} dialect
12858 selects the GNU descriptor scheme, which provides better performance
12859 for shared libraries.  The GNU descriptor scheme is compatible with
12860 the original scheme, but does require new assembler, linker and
12861 library support.  Initial and local exec TLS models are unaffected by
12862 this option and always use the original scheme.
12864 @item -mword-relocations
12865 @opindex mword-relocations
12866 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
12867 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
12868 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
12869 is specified.
12871 @item -mfix-cortex-m3-ldrd
12872 @opindex mfix-cortex-m3-ldrd
12873 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
12874 with overlapping destination and base registers are used.  This option avoids
12875 generating these instructions.  This option is enabled by default when
12876 @option{-mcpu=cortex-m3} is specified.
12878 @item -munaligned-access
12879 @itemx -mno-unaligned-access
12880 @opindex munaligned-access
12881 @opindex mno-unaligned-access
12882 Enables (or disables) reading and writing of 16- and 32- bit values
12883 from addresses that are not 16- or 32- bit aligned.  By default
12884 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
12885 architectures, and enabled for all other architectures.  If unaligned
12886 access is not enabled then words in packed data structures will be
12887 accessed a byte at a time.
12889 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
12890 generated object file to either true or false, depending upon the
12891 setting of this option.  If unaligned access is enabled then the
12892 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
12893 defined.
12895 @item -mneon-for-64bits
12896 @opindex mneon-for-64bits
12897 Enables using Neon to handle scalar 64-bits operations. This is
12898 disabled by default since the cost of moving data from core registers
12899 to Neon is high.
12901 @item -mslow-flash-data
12902 @opindex mslow-flash-data
12903 Assume loading data from flash is slower than fetching instruction.
12904 Therefore literal load is minimized for better performance.
12905 This option is only supported when compiling for ARMv7 M-profile and
12906 off by default.
12908 @item -mrestrict-it
12909 @opindex mrestrict-it
12910 Restricts generation of IT blocks to conform to the rules of ARMv8.
12911 IT blocks can only contain a single 16-bit instruction from a select
12912 set of instructions. This option is on by default for ARMv8 Thumb mode.
12913 @end table
12915 @node AVR Options
12916 @subsection AVR Options
12917 @cindex AVR Options
12919 These options are defined for AVR implementations:
12921 @table @gcctabopt
12922 @item -mmcu=@var{mcu}
12923 @opindex mmcu
12924 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
12926 The default for this option is@tie{}@code{avr2}.
12928 GCC supports the following AVR devices and ISAs:
12930 @include avr-mmcu.texi
12932 @item -maccumulate-args
12933 @opindex maccumulate-args
12934 Accumulate outgoing function arguments and acquire/release the needed
12935 stack space for outgoing function arguments once in function
12936 prologue/epilogue.  Without this option, outgoing arguments are pushed
12937 before calling a function and popped afterwards.
12939 Popping the arguments after the function call can be expensive on
12940 AVR so that accumulating the stack space might lead to smaller
12941 executables because arguments need not to be removed from the
12942 stack after such a function call.
12944 This option can lead to reduced code size for functions that perform
12945 several calls to functions that get their arguments on the stack like
12946 calls to printf-like functions.
12948 @item -mbranch-cost=@var{cost}
12949 @opindex mbranch-cost
12950 Set the branch costs for conditional branch instructions to
12951 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
12952 integers. The default branch cost is 0.
12954 @item -mcall-prologues
12955 @opindex mcall-prologues
12956 Functions prologues/epilogues are expanded as calls to appropriate
12957 subroutines.  Code size is smaller.
12959 @item -mint8
12960 @opindex mint8
12961 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
12962 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
12963 and @code{long long} is 4 bytes.  Please note that this option does not
12964 conform to the C standards, but it results in smaller code
12965 size.
12967 @item -mno-interrupts
12968 @opindex mno-interrupts
12969 Generated code is not compatible with hardware interrupts.
12970 Code size is smaller.
12972 @item -mrelax
12973 @opindex mrelax
12974 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
12975 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
12976 Setting @code{-mrelax} just adds the @code{--relax} option to the
12977 linker command line when the linker is called.
12979 Jump relaxing is performed by the linker because jump offsets are not
12980 known before code is located. Therefore, the assembler code generated by the
12981 compiler is the same, but the instructions in the executable may
12982 differ from instructions in the assembler code.
12984 Relaxing must be turned on if linker stubs are needed, see the
12985 section on @code{EIND} and linker stubs below.
12987 @item -msp8
12988 @opindex msp8
12989 Treat the stack pointer register as an 8-bit register,
12990 i.e.@: assume the high byte of the stack pointer is zero.
12991 In general, you don't need to set this option by hand.
12993 This option is used internally by the compiler to select and
12994 build multilibs for architectures @code{avr2} and @code{avr25}.
12995 These architectures mix devices with and without @code{SPH}.
12996 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
12997 the compiler driver will add or remove this option from the compiler
12998 proper's command line, because the compiler then knows if the device
12999 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13000 register or not.
13002 @item -mstrict-X
13003 @opindex mstrict-X
13004 Use address register @code{X} in a way proposed by the hardware.  This means
13005 that @code{X} is only used in indirect, post-increment or
13006 pre-decrement addressing.
13008 Without this option, the @code{X} register may be used in the same way
13009 as @code{Y} or @code{Z} which then is emulated by additional
13010 instructions.  
13011 For example, loading a value with @code{X+const} addressing with a
13012 small non-negative @code{const < 64} to a register @var{Rn} is
13013 performed as
13015 @example
13016 adiw r26, const   ; X += const
13017 ld   @var{Rn}, X        ; @var{Rn} = *X
13018 sbiw r26, const   ; X -= const
13019 @end example
13021 @item -mtiny-stack
13022 @opindex mtiny-stack
13023 Only change the lower 8@tie{}bits of the stack pointer.
13025 @item -Waddr-space-convert
13026 @opindex Waddr-space-convert
13027 Warn about conversions between address spaces in the case where the
13028 resulting address space is not contained in the incoming address space.
13029 @end table
13031 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
13032 @cindex @code{EIND}
13033 Pointers in the implementation are 16@tie{}bits wide.
13034 The address of a function or label is represented as word address so
13035 that indirect jumps and calls can target any code address in the
13036 range of 64@tie{}Ki words.
13038 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13039 bytes of program memory space, there is a special function register called
13040 @code{EIND} that serves as most significant part of the target address
13041 when @code{EICALL} or @code{EIJMP} instructions are used.
13043 Indirect jumps and calls on these devices are handled as follows by
13044 the compiler and are subject to some limitations:
13046 @itemize @bullet
13048 @item
13049 The compiler never sets @code{EIND}.
13051 @item
13052 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13053 instructions or might read @code{EIND} directly in order to emulate an
13054 indirect call/jump by means of a @code{RET} instruction.
13056 @item
13057 The compiler assumes that @code{EIND} never changes during the startup
13058 code or during the application. In particular, @code{EIND} is not
13059 saved/restored in function or interrupt service routine
13060 prologue/epilogue.
13062 @item
13063 For indirect calls to functions and computed goto, the linker
13064 generates @emph{stubs}. Stubs are jump pads sometimes also called
13065 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13066 The stub contains a direct jump to the desired address.
13068 @item
13069 Linker relaxation must be turned on so that the linker will generate
13070 the stubs correctly an all situaltion. See the compiler option
13071 @code{-mrelax} and the linler option @code{--relax}.
13072 There are corner cases where the linker is supposed to generate stubs
13073 but aborts without relaxation and without a helpful error message.
13075 @item
13076 The default linker script is arranged for code with @code{EIND = 0}.
13077 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13078 linker script has to be used in order to place the sections whose
13079 name start with @code{.trampolines} into the segment where @code{EIND}
13080 points to.
13082 @item
13083 The startup code from libgcc never sets @code{EIND}.
13084 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13085 For the impact of AVR-LibC on @code{EIND}, see the
13086 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13088 @item
13089 It is legitimate for user-specific startup code to set up @code{EIND}
13090 early, for example by means of initialization code located in
13091 section @code{.init3}. Such code runs prior to general startup code
13092 that initializes RAM and calls constructors, but after the bit
13093 of startup code from AVR-LibC that sets @code{EIND} to the segment
13094 where the vector table is located.
13095 @example
13096 #include <avr/io.h>
13098 static void
13099 __attribute__((section(".init3"),naked,used,no_instrument_function))
13100 init3_set_eind (void)
13102   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13103                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13105 @end example
13107 @noindent
13108 The @code{__trampolines_start} symbol is defined in the linker script.
13110 @item
13111 Stubs are generated automatically by the linker if
13112 the following two conditions are met:
13113 @itemize @minus
13115 @item The address of a label is taken by means of the @code{gs} modifier
13116 (short for @emph{generate stubs}) like so:
13117 @example
13118 LDI r24, lo8(gs(@var{func}))
13119 LDI r25, hi8(gs(@var{func}))
13120 @end example
13121 @item The final location of that label is in a code segment
13122 @emph{outside} the segment where the stubs are located.
13123 @end itemize
13125 @item
13126 The compiler emits such @code{gs} modifiers for code labels in the
13127 following situations:
13128 @itemize @minus
13129 @item Taking address of a function or code label.
13130 @item Computed goto.
13131 @item If prologue-save function is used, see @option{-mcall-prologues}
13132 command-line option.
13133 @item Switch/case dispatch tables. If you do not want such dispatch
13134 tables you can specify the @option{-fno-jump-tables} command-line option.
13135 @item C and C++ constructors/destructors called during startup/shutdown.
13136 @item If the tools hit a @code{gs()} modifier explained above.
13137 @end itemize
13139 @item
13140 Jumping to non-symbolic addresses like so is @emph{not} supported:
13142 @example
13143 int main (void)
13145     /* Call function at word address 0x2 */
13146     return ((int(*)(void)) 0x2)();
13148 @end example
13150 Instead, a stub has to be set up, i.e.@: the function has to be called
13151 through a symbol (@code{func_4} in the example):
13153 @example
13154 int main (void)
13156     extern int func_4 (void);
13158     /* Call function at byte address 0x4 */
13159     return func_4();
13161 @end example
13163 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
13164 Alternatively, @code{func_4} can be defined in the linker script.
13165 @end itemize
13167 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13168 @cindex @code{RAMPD}
13169 @cindex @code{RAMPX}
13170 @cindex @code{RAMPY}
13171 @cindex @code{RAMPZ}
13172 Some AVR devices support memories larger than the 64@tie{}KiB range
13173 that can be accessed with 16-bit pointers.  To access memory locations
13174 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13175 register is used as high part of the address:
13176 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13177 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13178 register, respectively, to get a wide address. Similarly,
13179 @code{RAMPD} is used together with direct addressing.
13181 @itemize
13182 @item
13183 The startup code initializes the @code{RAMP} special function
13184 registers with zero.
13186 @item
13187 If a @ref{AVR Named Address Spaces,named address space} other than
13188 generic or @code{__flash} is used, then @code{RAMPZ} is set
13189 as needed before the operation.
13191 @item
13192 If the device supports RAM larger than 64@tie{}KiB and the compiler
13193 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13194 is reset to zero after the operation.
13196 @item
13197 If the device comes with a specific @code{RAMP} register, the ISR
13198 prologue/epilogue saves/restores that SFR and initializes it with
13199 zero in case the ISR code might (implicitly) use it.
13201 @item
13202 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13203 If you use inline assembler to read from locations outside the
13204 16-bit address range and change one of the @code{RAMP} registers,
13205 you must reset it to zero after the access.
13207 @end itemize
13209 @subsubsection AVR Built-in Macros
13211 GCC defines several built-in macros so that the user code can test
13212 for the presence or absence of features.  Almost any of the following
13213 built-in macros are deduced from device capabilities and thus
13214 triggered by the @code{-mmcu=} command-line option.
13216 For even more AVR-specific built-in macros see
13217 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13219 @table @code
13221 @item __AVR_ARCH__
13222 Build-in macro that resolves to a decimal number that identifies the
13223 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13224 Possible values are:
13226 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13227 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13228 @code{105}, @code{106}, @code{107}
13230 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13231 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13232 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13233 @code{avrxmega6}, @code{avrxmega7}, respectively.
13234 If @var{mcu} specifies a device, this built-in macro is set
13235 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13236 defined to @code{4}.
13238 @item __AVR_@var{Device}__
13239 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13240 the device's name. For example, @code{-mmcu=atmega8} defines the
13241 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13242 @code{__AVR_ATtiny261A__}, etc.
13244 The built-in macros' names follow
13245 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13246 the device name as from the AVR user manual. The difference between
13247 @var{Device} in the built-in macro and @var{device} in
13248 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13250 If @var{device} is not a device but only a core architecture like
13251 @code{avr51}, this macro will not be defined.
13253 @item   __AVR_DEVICE_NAME__
13254 Setting @code{-mmcu=@var{device}} defines this built-in macro to
13255 the device's name. For example, with @code{-mmcu=atmega8} the macro
13256 will be defined to @code{atmega8}.
13258 If @var{device} is not a device but only a core architecture like
13259 @code{avr51}, this macro will not be defined.
13261 @item __AVR_XMEGA__
13262 The device / architecture belongs to the XMEGA family of devices.
13264 @item __AVR_HAVE_ELPM__
13265 The device has the the @code{ELPM} instruction.
13267 @item __AVR_HAVE_ELPMX__
13268 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13269 R@var{n},Z+} instructions.
13271 @item __AVR_HAVE_MOVW__
13272 The device has the @code{MOVW} instruction to perform 16-bit
13273 register-register moves.
13275 @item __AVR_HAVE_LPMX__
13276 The device has the @code{LPM R@var{n},Z} and
13277 @code{LPM R@var{n},Z+} instructions.
13279 @item __AVR_HAVE_MUL__
13280 The device has a hardware multiplier. 
13282 @item __AVR_HAVE_JMP_CALL__
13283 The device has the @code{JMP} and @code{CALL} instructions.
13284 This is the case for devices with at least 16@tie{}KiB of program
13285 memory.
13287 @item __AVR_HAVE_EIJMP_EICALL__
13288 @itemx __AVR_3_BYTE_PC__
13289 The device has the @code{EIJMP} and @code{EICALL} instructions.
13290 This is the case for devices with more than 128@tie{}KiB of program memory.
13291 This also means that the program counter
13292 (PC) is 3@tie{}bytes wide.
13294 @item __AVR_2_BYTE_PC__
13295 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13296 with up to 128@tie{}KiB of program memory.
13298 @item __AVR_HAVE_8BIT_SP__
13299 @itemx __AVR_HAVE_16BIT_SP__
13300 The stack pointer (SP) register is treated as 8-bit respectively
13301 16-bit register by the compiler.
13302 The definition of these macros is affected by @code{-mtiny-stack}.
13304 @item __AVR_HAVE_SPH__
13305 @itemx __AVR_SP8__
13306 The device has the SPH (high part of stack pointer) special function
13307 register or has an 8-bit stack pointer, respectively.
13308 The definition of these macros is affected by @code{-mmcu=} and
13309 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13310 by @code{-msp8}.
13312 @item __AVR_HAVE_RAMPD__
13313 @itemx __AVR_HAVE_RAMPX__
13314 @itemx __AVR_HAVE_RAMPY__
13315 @itemx __AVR_HAVE_RAMPZ__
13316 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13317 @code{RAMPZ} special function register, respectively.
13319 @item __NO_INTERRUPTS__
13320 This macro reflects the @code{-mno-interrupts} command line option.
13322 @item __AVR_ERRATA_SKIP__
13323 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13324 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13325 instructions because of a hardware erratum.  Skip instructions are
13326 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13327 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13328 set.
13330 @item __AVR_ISA_RMW__
13331 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13333 @item __AVR_SFR_OFFSET__=@var{offset}
13334 Instructions that can address I/O special function registers directly
13335 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13336 address as if addressed by an instruction to access RAM like @code{LD}
13337 or @code{STS}. This offset depends on the device architecture and has
13338 to be subtracted from the RAM address in order to get the
13339 respective I/O@tie{}address.
13341 @item __WITH_AVRLIBC__
13342 The compiler is configured to be used together with AVR-Libc.
13343 See the @code{--with-avrlibc} configure option.
13345 @end table
13347 @node Blackfin Options
13348 @subsection Blackfin Options
13349 @cindex Blackfin Options
13351 @table @gcctabopt
13352 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13353 @opindex mcpu=
13354 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13355 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13356 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13357 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13358 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13359 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13360 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13361 @samp{bf561}, @samp{bf592}.
13363 The optional @var{sirevision} specifies the silicon revision of the target
13364 Blackfin processor.  Any workarounds available for the targeted silicon revision
13365 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13366 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13367 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13368 hexadecimal digits representing the major and minor numbers in the silicon
13369 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13370 is not defined.  If @var{sirevision} is @samp{any}, the
13371 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13372 If this optional @var{sirevision} is not used, GCC assumes the latest known
13373 silicon revision of the targeted Blackfin processor.
13375 GCC defines a preprocessor macro for the specified @var{cpu}.
13376 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13377 provided by libgloss to be linked in if @option{-msim} is not given.
13379 Without this option, @samp{bf532} is used as the processor by default.
13381 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13382 only the preprocessor macro is defined.
13384 @item -msim
13385 @opindex msim
13386 Specifies that the program will be run on the simulator.  This causes
13387 the simulator BSP provided by libgloss to be linked in.  This option
13388 has effect only for @samp{bfin-elf} toolchain.
13389 Certain other options, such as @option{-mid-shared-library} and
13390 @option{-mfdpic}, imply @option{-msim}.
13392 @item -momit-leaf-frame-pointer
13393 @opindex momit-leaf-frame-pointer
13394 Don't keep the frame pointer in a register for leaf functions.  This
13395 avoids the instructions to save, set up and restore frame pointers and
13396 makes an extra register available in leaf functions.  The option
13397 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13398 which might make debugging harder.
13400 @item -mspecld-anomaly
13401 @opindex mspecld-anomaly
13402 When enabled, the compiler ensures that the generated code does not
13403 contain speculative loads after jump instructions. If this option is used,
13404 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13406 @item -mno-specld-anomaly
13407 @opindex mno-specld-anomaly
13408 Don't generate extra code to prevent speculative loads from occurring.
13410 @item -mcsync-anomaly
13411 @opindex mcsync-anomaly
13412 When enabled, the compiler ensures that the generated code does not
13413 contain CSYNC or SSYNC instructions too soon after conditional branches.
13414 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13416 @item -mno-csync-anomaly
13417 @opindex mno-csync-anomaly
13418 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13419 occurring too soon after a conditional branch.
13421 @item -mlow-64k
13422 @opindex mlow-64k
13423 When enabled, the compiler is free to take advantage of the knowledge that
13424 the entire program fits into the low 64k of memory.
13426 @item -mno-low-64k
13427 @opindex mno-low-64k
13428 Assume that the program is arbitrarily large.  This is the default.
13430 @item -mstack-check-l1
13431 @opindex mstack-check-l1
13432 Do stack checking using information placed into L1 scratchpad memory by the
13433 uClinux kernel.
13435 @item -mid-shared-library
13436 @opindex mid-shared-library
13437 Generate code that supports shared libraries via the library ID method.
13438 This allows for execute in place and shared libraries in an environment
13439 without virtual memory management.  This option implies @option{-fPIC}.
13440 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13442 @item -mno-id-shared-library
13443 @opindex mno-id-shared-library
13444 Generate code that doesn't assume ID-based shared libraries are being used.
13445 This is the default.
13447 @item -mleaf-id-shared-library
13448 @opindex mleaf-id-shared-library
13449 Generate code that supports shared libraries via the library ID method,
13450 but assumes that this library or executable won't link against any other
13451 ID shared libraries.  That allows the compiler to use faster code for jumps
13452 and calls.
13454 @item -mno-leaf-id-shared-library
13455 @opindex mno-leaf-id-shared-library
13456 Do not assume that the code being compiled won't link against any ID shared
13457 libraries.  Slower code is generated for jump and call insns.
13459 @item -mshared-library-id=n
13460 @opindex mshared-library-id
13461 Specifies the identification number of the ID-based shared library being
13462 compiled.  Specifying a value of 0 generates more compact code; specifying
13463 other values forces the allocation of that number to the current
13464 library but is no more space- or time-efficient than omitting this option.
13466 @item -msep-data
13467 @opindex msep-data
13468 Generate code that allows the data segment to be located in a different
13469 area of memory from the text segment.  This allows for execute in place in
13470 an environment without virtual memory management by eliminating relocations
13471 against the text section.
13473 @item -mno-sep-data
13474 @opindex mno-sep-data
13475 Generate code that assumes that the data segment follows the text segment.
13476 This is the default.
13478 @item -mlong-calls
13479 @itemx -mno-long-calls
13480 @opindex mlong-calls
13481 @opindex mno-long-calls
13482 Tells the compiler to perform function calls by first loading the
13483 address of the function into a register and then performing a subroutine
13484 call on this register.  This switch is needed if the target function
13485 lies outside of the 24-bit addressing range of the offset-based
13486 version of subroutine call instruction.
13488 This feature is not enabled by default.  Specifying
13489 @option{-mno-long-calls} restores the default behavior.  Note these
13490 switches have no effect on how the compiler generates code to handle
13491 function calls via function pointers.
13493 @item -mfast-fp
13494 @opindex mfast-fp
13495 Link with the fast floating-point library. This library relaxes some of
13496 the IEEE floating-point standard's rules for checking inputs against
13497 Not-a-Number (NAN), in the interest of performance.
13499 @item -minline-plt
13500 @opindex minline-plt
13501 Enable inlining of PLT entries in function calls to functions that are
13502 not known to bind locally.  It has no effect without @option{-mfdpic}.
13504 @item -mmulticore
13505 @opindex mmulticore
13506 Build a standalone application for multicore Blackfin processors. 
13507 This option causes proper start files and link scripts supporting 
13508 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13509 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13511 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13512 selects the one-application-per-core programming model.  Without
13513 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13514 programming model is used. In this model, the main function of Core B
13515 should be named as @code{coreb_main}.
13517 If this option is not used, the single-core application programming
13518 model is used.
13520 @item -mcorea
13521 @opindex mcorea
13522 Build a standalone application for Core A of BF561 when using
13523 the one-application-per-core programming model. Proper start files
13524 and link scripts are used to support Core A, and the macro
13525 @code{__BFIN_COREA} is defined.
13526 This option can only be used in conjunction with @option{-mmulticore}.
13528 @item -mcoreb
13529 @opindex mcoreb
13530 Build a standalone application for Core B of BF561 when using
13531 the one-application-per-core programming model. Proper start files
13532 and link scripts are used to support Core B, and the macro
13533 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13534 should be used instead of @code{main}. 
13535 This option can only be used in conjunction with @option{-mmulticore}.
13537 @item -msdram
13538 @opindex msdram
13539 Build a standalone application for SDRAM. Proper start files and
13540 link scripts are used to put the application into SDRAM, and the macro
13541 @code{__BFIN_SDRAM} is defined.
13542 The loader should initialize SDRAM before loading the application.
13544 @item -micplb
13545 @opindex micplb
13546 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13547 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13548 are enabled; for standalone applications the default is off.
13549 @end table
13551 @node C6X Options
13552 @subsection C6X Options
13553 @cindex C6X Options
13555 @table @gcctabopt
13556 @item -march=@var{name}
13557 @opindex march
13558 This specifies the name of the target architecture.  GCC uses this
13559 name to determine what kind of instructions it can emit when generating
13560 assembly code.  Permissible names are: @samp{c62x},
13561 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13563 @item -mbig-endian
13564 @opindex mbig-endian
13565 Generate code for a big-endian target.
13567 @item -mlittle-endian
13568 @opindex mlittle-endian
13569 Generate code for a little-endian target.  This is the default.
13571 @item -msim
13572 @opindex msim
13573 Choose startup files and linker script suitable for the simulator.
13575 @item -msdata=default
13576 @opindex msdata=default
13577 Put small global and static data in the @samp{.neardata} section,
13578 which is pointed to by register @code{B14}.  Put small uninitialized
13579 global and static data in the @samp{.bss} section, which is adjacent
13580 to the @samp{.neardata} section.  Put small read-only data into the
13581 @samp{.rodata} section.  The corresponding sections used for large
13582 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13584 @item -msdata=all
13585 @opindex msdata=all
13586 Put all data, not just small objects, into the sections reserved for
13587 small data, and use addressing relative to the @code{B14} register to
13588 access them.
13590 @item -msdata=none
13591 @opindex msdata=none
13592 Make no use of the sections reserved for small data, and use absolute
13593 addresses to access all data.  Put all initialized global and static
13594 data in the @samp{.fardata} section, and all uninitialized data in the
13595 @samp{.far} section.  Put all constant data into the @samp{.const}
13596 section.
13597 @end table
13599 @node CRIS Options
13600 @subsection CRIS Options
13601 @cindex CRIS Options
13603 These options are defined specifically for the CRIS ports.
13605 @table @gcctabopt
13606 @item -march=@var{architecture-type}
13607 @itemx -mcpu=@var{architecture-type}
13608 @opindex march
13609 @opindex mcpu
13610 Generate code for the specified architecture.  The choices for
13611 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13612 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13613 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13614 @samp{v10}.
13616 @item -mtune=@var{architecture-type}
13617 @opindex mtune
13618 Tune to @var{architecture-type} everything applicable about the generated
13619 code, except for the ABI and the set of available instructions.  The
13620 choices for @var{architecture-type} are the same as for
13621 @option{-march=@var{architecture-type}}.
13623 @item -mmax-stack-frame=@var{n}
13624 @opindex mmax-stack-frame
13625 Warn when the stack frame of a function exceeds @var{n} bytes.
13627 @item -metrax4
13628 @itemx -metrax100
13629 @opindex metrax4
13630 @opindex metrax100
13631 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13632 @option{-march=v3} and @option{-march=v8} respectively.
13634 @item -mmul-bug-workaround
13635 @itemx -mno-mul-bug-workaround
13636 @opindex mmul-bug-workaround
13637 @opindex mno-mul-bug-workaround
13638 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13639 models where it applies.  This option is active by default.
13641 @item -mpdebug
13642 @opindex mpdebug
13643 Enable CRIS-specific verbose debug-related information in the assembly
13644 code.  This option also has the effect of turning off the @samp{#NO_APP}
13645 formatted-code indicator to the assembler at the beginning of the
13646 assembly file.
13648 @item -mcc-init
13649 @opindex mcc-init
13650 Do not use condition-code results from previous instruction; always emit
13651 compare and test instructions before use of condition codes.
13653 @item -mno-side-effects
13654 @opindex mno-side-effects
13655 Do not emit instructions with side effects in addressing modes other than
13656 post-increment.
13658 @item -mstack-align
13659 @itemx -mno-stack-align
13660 @itemx -mdata-align
13661 @itemx -mno-data-align
13662 @itemx -mconst-align
13663 @itemx -mno-const-align
13664 @opindex mstack-align
13665 @opindex mno-stack-align
13666 @opindex mdata-align
13667 @opindex mno-data-align
13668 @opindex mconst-align
13669 @opindex mno-const-align
13670 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13671 stack frame, individual data and constants to be aligned for the maximum
13672 single data access size for the chosen CPU model.  The default is to
13673 arrange for 32-bit alignment.  ABI details such as structure layout are
13674 not affected by these options.
13676 @item -m32-bit
13677 @itemx -m16-bit
13678 @itemx -m8-bit
13679 @opindex m32-bit
13680 @opindex m16-bit
13681 @opindex m8-bit
13682 Similar to the stack- data- and const-align options above, these options
13683 arrange for stack frame, writable data and constants to all be 32-bit,
13684 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13686 @item -mno-prologue-epilogue
13687 @itemx -mprologue-epilogue
13688 @opindex mno-prologue-epilogue
13689 @opindex mprologue-epilogue
13690 With @option{-mno-prologue-epilogue}, the normal function prologue and
13691 epilogue which set up the stack frame are omitted and no return
13692 instructions or return sequences are generated in the code.  Use this
13693 option only together with visual inspection of the compiled code: no
13694 warnings or errors are generated when call-saved registers must be saved,
13695 or storage for local variables needs to be allocated.
13697 @item -mno-gotplt
13698 @itemx -mgotplt
13699 @opindex mno-gotplt
13700 @opindex mgotplt
13701 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13702 instruction sequences that load addresses for functions from the PLT part
13703 of the GOT rather than (traditional on other architectures) calls to the
13704 PLT@.  The default is @option{-mgotplt}.
13706 @item -melf
13707 @opindex melf
13708 Legacy no-op option only recognized with the cris-axis-elf and
13709 cris-axis-linux-gnu targets.
13711 @item -mlinux
13712 @opindex mlinux
13713 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13715 @item -sim
13716 @opindex sim
13717 This option, recognized for the cris-axis-elf, arranges
13718 to link with input-output functions from a simulator library.  Code,
13719 initialized data and zero-initialized data are allocated consecutively.
13721 @item -sim2
13722 @opindex sim2
13723 Like @option{-sim}, but pass linker options to locate initialized data at
13724 0x40000000 and zero-initialized data at 0x80000000.
13725 @end table
13727 @node CR16 Options
13728 @subsection CR16 Options
13729 @cindex CR16 Options
13731 These options are defined specifically for the CR16 ports.
13733 @table @gcctabopt
13735 @item -mmac
13736 @opindex mmac
13737 Enable the use of multiply-accumulate instructions. Disabled by default.
13739 @item -mcr16cplus
13740 @itemx -mcr16c
13741 @opindex mcr16cplus
13742 @opindex mcr16c
13743 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13744 is default.
13746 @item -msim
13747 @opindex msim
13748 Links the library libsim.a which is in compatible with simulator. Applicable
13749 to ELF compiler only.
13751 @item -mint32
13752 @opindex mint32
13753 Choose integer type as 32-bit wide.
13755 @item -mbit-ops
13756 @opindex mbit-ops
13757 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13759 @item -mdata-model=@var{model}
13760 @opindex mdata-model
13761 Choose a data model. The choices for @var{model} are @samp{near},
13762 @samp{far} or @samp{medium}. @samp{medium} is default.
13763 However, @samp{far} is not valid with @option{-mcr16c}, as the
13764 CR16C architecture does not support the far data model.
13765 @end table
13767 @node Darwin Options
13768 @subsection Darwin Options
13769 @cindex Darwin options
13771 These options are defined for all architectures running the Darwin operating
13772 system.
13774 FSF GCC on Darwin does not create ``fat'' object files; it creates
13775 an object file for the single architecture that GCC was built to
13776 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13777 @option{-arch} options are used; it does so by running the compiler or
13778 linker multiple times and joining the results together with
13779 @file{lipo}.
13781 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13782 @samp{i686}) is determined by the flags that specify the ISA
13783 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13784 @option{-force_cpusubtype_ALL} option can be used to override this.
13786 The Darwin tools vary in their behavior when presented with an ISA
13787 mismatch.  The assembler, @file{as}, only permits instructions to
13788 be used that are valid for the subtype of the file it is generating,
13789 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
13790 The linker for shared libraries, @file{/usr/bin/libtool}, fails
13791 and prints an error if asked to create a shared library with a less
13792 restrictive subtype than its input files (for instance, trying to put
13793 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
13794 for executables, @command{ld}, quietly gives the executable the most
13795 restrictive subtype of any of its input files.
13797 @table @gcctabopt
13798 @item -F@var{dir}
13799 @opindex F
13800 Add the framework directory @var{dir} to the head of the list of
13801 directories to be searched for header files.  These directories are
13802 interleaved with those specified by @option{-I} options and are
13803 scanned in a left-to-right order.
13805 A framework directory is a directory with frameworks in it.  A
13806 framework is a directory with a @file{Headers} and/or
13807 @file{PrivateHeaders} directory contained directly in it that ends
13808 in @file{.framework}.  The name of a framework is the name of this
13809 directory excluding the @file{.framework}.  Headers associated with
13810 the framework are found in one of those two directories, with
13811 @file{Headers} being searched first.  A subframework is a framework
13812 directory that is in a framework's @file{Frameworks} directory.
13813 Includes of subframework headers can only appear in a header of a
13814 framework that contains the subframework, or in a sibling subframework
13815 header.  Two subframeworks are siblings if they occur in the same
13816 framework.  A subframework should not have the same name as a
13817 framework; a warning is issued if this is violated.  Currently a
13818 subframework cannot have subframeworks; in the future, the mechanism
13819 may be extended to support this.  The standard frameworks can be found
13820 in @file{/System/Library/Frameworks} and
13821 @file{/Library/Frameworks}.  An example include looks like
13822 @code{#include <Framework/header.h>}, where @file{Framework} denotes
13823 the name of the framework and @file{header.h} is found in the
13824 @file{PrivateHeaders} or @file{Headers} directory.
13826 @item -iframework@var{dir}
13827 @opindex iframework
13828 Like @option{-F} except the directory is a treated as a system
13829 directory.  The main difference between this @option{-iframework} and
13830 @option{-F} is that with @option{-iframework} the compiler does not
13831 warn about constructs contained within header files found via
13832 @var{dir}.  This option is valid only for the C family of languages.
13834 @item -gused
13835 @opindex gused
13836 Emit debugging information for symbols that are used.  For stabs
13837 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
13838 This is by default ON@.
13840 @item -gfull
13841 @opindex gfull
13842 Emit debugging information for all symbols and types.
13844 @item -mmacosx-version-min=@var{version}
13845 The earliest version of MacOS X that this executable will run on
13846 is @var{version}.  Typical values of @var{version} include @code{10.1},
13847 @code{10.2}, and @code{10.3.9}.
13849 If the compiler was built to use the system's headers by default,
13850 then the default for this option is the system version on which the
13851 compiler is running, otherwise the default is to make choices that
13852 are compatible with as many systems and code bases as possible.
13854 @item -mkernel
13855 @opindex mkernel
13856 Enable kernel development mode.  The @option{-mkernel} option sets
13857 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
13858 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
13859 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
13860 applicable.  This mode also sets @option{-mno-altivec},
13861 @option{-msoft-float}, @option{-fno-builtin} and
13862 @option{-mlong-branch} for PowerPC targets.
13864 @item -mone-byte-bool
13865 @opindex mone-byte-bool
13866 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
13867 By default @samp{sizeof(bool)} is @samp{4} when compiling for
13868 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
13869 option has no effect on x86.
13871 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
13872 to generate code that is not binary compatible with code generated
13873 without that switch.  Using this switch may require recompiling all
13874 other modules in a program, including system libraries.  Use this
13875 switch to conform to a non-default data model.
13877 @item -mfix-and-continue
13878 @itemx -ffix-and-continue
13879 @itemx -findirect-data
13880 @opindex mfix-and-continue
13881 @opindex ffix-and-continue
13882 @opindex findirect-data
13883 Generate code suitable for fast turnaround development, such as to
13884 allow GDB to dynamically load @code{.o} files into already-running
13885 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
13886 are provided for backwards compatibility.
13888 @item -all_load
13889 @opindex all_load
13890 Loads all members of static archive libraries.
13891 See man ld(1) for more information.
13893 @item -arch_errors_fatal
13894 @opindex arch_errors_fatal
13895 Cause the errors having to do with files that have the wrong architecture
13896 to be fatal.
13898 @item -bind_at_load
13899 @opindex bind_at_load
13900 Causes the output file to be marked such that the dynamic linker will
13901 bind all undefined references when the file is loaded or launched.
13903 @item -bundle
13904 @opindex bundle
13905 Produce a Mach-o bundle format file.
13906 See man ld(1) for more information.
13908 @item -bundle_loader @var{executable}
13909 @opindex bundle_loader
13910 This option specifies the @var{executable} that will load the build
13911 output file being linked.  See man ld(1) for more information.
13913 @item -dynamiclib
13914 @opindex dynamiclib
13915 When passed this option, GCC produces a dynamic library instead of
13916 an executable when linking, using the Darwin @file{libtool} command.
13918 @item -force_cpusubtype_ALL
13919 @opindex force_cpusubtype_ALL
13920 This causes GCC's output file to have the @var{ALL} subtype, instead of
13921 one controlled by the @option{-mcpu} or @option{-march} option.
13923 @item -allowable_client  @var{client_name}
13924 @itemx -client_name
13925 @itemx -compatibility_version
13926 @itemx -current_version
13927 @itemx -dead_strip
13928 @itemx -dependency-file
13929 @itemx -dylib_file
13930 @itemx -dylinker_install_name
13931 @itemx -dynamic
13932 @itemx -exported_symbols_list
13933 @itemx -filelist
13934 @need 800
13935 @itemx -flat_namespace
13936 @itemx -force_flat_namespace
13937 @itemx -headerpad_max_install_names
13938 @itemx -image_base
13939 @itemx -init
13940 @itemx -install_name
13941 @itemx -keep_private_externs
13942 @itemx -multi_module
13943 @itemx -multiply_defined
13944 @itemx -multiply_defined_unused
13945 @need 800
13946 @itemx -noall_load
13947 @itemx -no_dead_strip_inits_and_terms
13948 @itemx -nofixprebinding
13949 @itemx -nomultidefs
13950 @itemx -noprebind
13951 @itemx -noseglinkedit
13952 @itemx -pagezero_size
13953 @itemx -prebind
13954 @itemx -prebind_all_twolevel_modules
13955 @itemx -private_bundle
13956 @need 800
13957 @itemx -read_only_relocs
13958 @itemx -sectalign
13959 @itemx -sectobjectsymbols
13960 @itemx -whyload
13961 @itemx -seg1addr
13962 @itemx -sectcreate
13963 @itemx -sectobjectsymbols
13964 @itemx -sectorder
13965 @itemx -segaddr
13966 @itemx -segs_read_only_addr
13967 @need 800
13968 @itemx -segs_read_write_addr
13969 @itemx -seg_addr_table
13970 @itemx -seg_addr_table_filename
13971 @itemx -seglinkedit
13972 @itemx -segprot
13973 @itemx -segs_read_only_addr
13974 @itemx -segs_read_write_addr
13975 @itemx -single_module
13976 @itemx -static
13977 @itemx -sub_library
13978 @need 800
13979 @itemx -sub_umbrella
13980 @itemx -twolevel_namespace
13981 @itemx -umbrella
13982 @itemx -undefined
13983 @itemx -unexported_symbols_list
13984 @itemx -weak_reference_mismatches
13985 @itemx -whatsloaded
13986 @opindex allowable_client
13987 @opindex client_name
13988 @opindex compatibility_version
13989 @opindex current_version
13990 @opindex dead_strip
13991 @opindex dependency-file
13992 @opindex dylib_file
13993 @opindex dylinker_install_name
13994 @opindex dynamic
13995 @opindex exported_symbols_list
13996 @opindex filelist
13997 @opindex flat_namespace
13998 @opindex force_flat_namespace
13999 @opindex headerpad_max_install_names
14000 @opindex image_base
14001 @opindex init
14002 @opindex install_name
14003 @opindex keep_private_externs
14004 @opindex multi_module
14005 @opindex multiply_defined
14006 @opindex multiply_defined_unused
14007 @opindex noall_load
14008 @opindex no_dead_strip_inits_and_terms
14009 @opindex nofixprebinding
14010 @opindex nomultidefs
14011 @opindex noprebind
14012 @opindex noseglinkedit
14013 @opindex pagezero_size
14014 @opindex prebind
14015 @opindex prebind_all_twolevel_modules
14016 @opindex private_bundle
14017 @opindex read_only_relocs
14018 @opindex sectalign
14019 @opindex sectobjectsymbols
14020 @opindex whyload
14021 @opindex seg1addr
14022 @opindex sectcreate
14023 @opindex sectobjectsymbols
14024 @opindex sectorder
14025 @opindex segaddr
14026 @opindex segs_read_only_addr
14027 @opindex segs_read_write_addr
14028 @opindex seg_addr_table
14029 @opindex seg_addr_table_filename
14030 @opindex seglinkedit
14031 @opindex segprot
14032 @opindex segs_read_only_addr
14033 @opindex segs_read_write_addr
14034 @opindex single_module
14035 @opindex static
14036 @opindex sub_library
14037 @opindex sub_umbrella
14038 @opindex twolevel_namespace
14039 @opindex umbrella
14040 @opindex undefined
14041 @opindex unexported_symbols_list
14042 @opindex weak_reference_mismatches
14043 @opindex whatsloaded
14044 These options are passed to the Darwin linker.  The Darwin linker man page
14045 describes them in detail.
14046 @end table
14048 @node DEC Alpha Options
14049 @subsection DEC Alpha Options
14051 These @samp{-m} options are defined for the DEC Alpha implementations:
14053 @table @gcctabopt
14054 @item -mno-soft-float
14055 @itemx -msoft-float
14056 @opindex mno-soft-float
14057 @opindex msoft-float
14058 Use (do not use) the hardware floating-point instructions for
14059 floating-point operations.  When @option{-msoft-float} is specified,
14060 functions in @file{libgcc.a} are used to perform floating-point
14061 operations.  Unless they are replaced by routines that emulate the
14062 floating-point operations, or compiled in such a way as to call such
14063 emulations routines, these routines issue floating-point
14064 operations.   If you are compiling for an Alpha without floating-point
14065 operations, you must ensure that the library is built so as not to call
14066 them.
14068 Note that Alpha implementations without floating-point operations are
14069 required to have floating-point registers.
14071 @item -mfp-reg
14072 @itemx -mno-fp-regs
14073 @opindex mfp-reg
14074 @opindex mno-fp-regs
14075 Generate code that uses (does not use) the floating-point register set.
14076 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14077 register set is not used, floating-point operands are passed in integer
14078 registers as if they were integers and floating-point results are passed
14079 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14080 so any function with a floating-point argument or return value called by code
14081 compiled with @option{-mno-fp-regs} must also be compiled with that
14082 option.
14084 A typical use of this option is building a kernel that does not use,
14085 and hence need not save and restore, any floating-point registers.
14087 @item -mieee
14088 @opindex mieee
14089 The Alpha architecture implements floating-point hardware optimized for
14090 maximum performance.  It is mostly compliant with the IEEE floating-point
14091 standard.  However, for full compliance, software assistance is
14092 required.  This option generates code fully IEEE-compliant code
14093 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14094 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14095 defined during compilation.  The resulting code is less efficient but is
14096 able to correctly support denormalized numbers and exceptional IEEE
14097 values such as not-a-number and plus/minus infinity.  Other Alpha
14098 compilers call this option @option{-ieee_with_no_inexact}.
14100 @item -mieee-with-inexact
14101 @opindex mieee-with-inexact
14102 This is like @option{-mieee} except the generated code also maintains
14103 the IEEE @var{inexact-flag}.  Turning on this option causes the
14104 generated code to implement fully-compliant IEEE math.  In addition to
14105 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14106 macro.  On some Alpha implementations the resulting code may execute
14107 significantly slower than the code generated by default.  Since there is
14108 very little code that depends on the @var{inexact-flag}, you should
14109 normally not specify this option.  Other Alpha compilers call this
14110 option @option{-ieee_with_inexact}.
14112 @item -mfp-trap-mode=@var{trap-mode}
14113 @opindex mfp-trap-mode
14114 This option controls what floating-point related traps are enabled.
14115 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14116 The trap mode can be set to one of four values:
14118 @table @samp
14119 @item n
14120 This is the default (normal) setting.  The only traps that are enabled
14121 are the ones that cannot be disabled in software (e.g., division by zero
14122 trap).
14124 @item u
14125 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14126 as well.
14128 @item su
14129 Like @samp{u}, but the instructions are marked to be safe for software
14130 completion (see Alpha architecture manual for details).
14132 @item sui
14133 Like @samp{su}, but inexact traps are enabled as well.
14134 @end table
14136 @item -mfp-rounding-mode=@var{rounding-mode}
14137 @opindex mfp-rounding-mode
14138 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14139 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14142 @table @samp
14143 @item n
14144 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14145 the nearest machine number or towards the even machine number in case
14146 of a tie.
14148 @item m
14149 Round towards minus infinity.
14151 @item c
14152 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14154 @item d
14155 Dynamic rounding mode.  A field in the floating-point control register
14156 (@var{fpcr}, see Alpha architecture reference manual) controls the
14157 rounding mode in effect.  The C library initializes this register for
14158 rounding towards plus infinity.  Thus, unless your program modifies the
14159 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14160 @end table
14162 @item -mtrap-precision=@var{trap-precision}
14163 @opindex mtrap-precision
14164 In the Alpha architecture, floating-point traps are imprecise.  This
14165 means without software assistance it is impossible to recover from a
14166 floating trap and program execution normally needs to be terminated.
14167 GCC can generate code that can assist operating system trap handlers
14168 in determining the exact location that caused a floating-point trap.
14169 Depending on the requirements of an application, different levels of
14170 precisions can be selected:
14172 @table @samp
14173 @item p
14174 Program precision.  This option is the default and means a trap handler
14175 can only identify which program caused a floating-point exception.
14177 @item f
14178 Function precision.  The trap handler can determine the function that
14179 caused a floating-point exception.
14181 @item i
14182 Instruction precision.  The trap handler can determine the exact
14183 instruction that caused a floating-point exception.
14184 @end table
14186 Other Alpha compilers provide the equivalent options called
14187 @option{-scope_safe} and @option{-resumption_safe}.
14189 @item -mieee-conformant
14190 @opindex mieee-conformant
14191 This option marks the generated code as IEEE conformant.  You must not
14192 use this option unless you also specify @option{-mtrap-precision=i} and either
14193 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14194 is to emit the line @samp{.eflag 48} in the function prologue of the
14195 generated assembly file.
14197 @item -mbuild-constants
14198 @opindex mbuild-constants
14199 Normally GCC examines a 32- or 64-bit integer constant to
14200 see if it can construct it from smaller constants in two or three
14201 instructions.  If it cannot, it outputs the constant as a literal and
14202 generates code to load it from the data segment at run time.
14204 Use this option to require GCC to construct @emph{all} integer constants
14205 using code, even if it takes more instructions (the maximum is six).
14207 You typically use this option to build a shared library dynamic
14208 loader.  Itself a shared library, it must relocate itself in memory
14209 before it can find the variables and constants in its own data segment.
14211 @item -mbwx
14212 @itemx -mno-bwx
14213 @itemx -mcix
14214 @itemx -mno-cix
14215 @itemx -mfix
14216 @itemx -mno-fix
14217 @itemx -mmax
14218 @itemx -mno-max
14219 @opindex mbwx
14220 @opindex mno-bwx
14221 @opindex mcix
14222 @opindex mno-cix
14223 @opindex mfix
14224 @opindex mno-fix
14225 @opindex mmax
14226 @opindex mno-max
14227 Indicate whether GCC should generate code to use the optional BWX,
14228 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14229 sets supported by the CPU type specified via @option{-mcpu=} option or that
14230 of the CPU on which GCC was built if none is specified.
14232 @item -mfloat-vax
14233 @itemx -mfloat-ieee
14234 @opindex mfloat-vax
14235 @opindex mfloat-ieee
14236 Generate code that uses (does not use) VAX F and G floating-point
14237 arithmetic instead of IEEE single and double precision.
14239 @item -mexplicit-relocs
14240 @itemx -mno-explicit-relocs
14241 @opindex mexplicit-relocs
14242 @opindex mno-explicit-relocs
14243 Older Alpha assemblers provided no way to generate symbol relocations
14244 except via assembler macros.  Use of these macros does not allow
14245 optimal instruction scheduling.  GNU binutils as of version 2.12
14246 supports a new syntax that allows the compiler to explicitly mark
14247 which relocations should apply to which instructions.  This option
14248 is mostly useful for debugging, as GCC detects the capabilities of
14249 the assembler when it is built and sets the default accordingly.
14251 @item -msmall-data
14252 @itemx -mlarge-data
14253 @opindex msmall-data
14254 @opindex mlarge-data
14255 When @option{-mexplicit-relocs} is in effect, static data is
14256 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14257 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14258 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14259 16-bit relocations off of the @code{$gp} register.  This limits the
14260 size of the small data area to 64KB, but allows the variables to be
14261 directly accessed via a single instruction.
14263 The default is @option{-mlarge-data}.  With this option the data area
14264 is limited to just below 2GB@.  Programs that require more than 2GB of
14265 data must use @code{malloc} or @code{mmap} to allocate the data in the
14266 heap instead of in the program's data segment.
14268 When generating code for shared libraries, @option{-fpic} implies
14269 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14271 @item -msmall-text
14272 @itemx -mlarge-text
14273 @opindex msmall-text
14274 @opindex mlarge-text
14275 When @option{-msmall-text} is used, the compiler assumes that the
14276 code of the entire program (or shared library) fits in 4MB, and is
14277 thus reachable with a branch instruction.  When @option{-msmall-data}
14278 is used, the compiler can assume that all local symbols share the
14279 same @code{$gp} value, and thus reduce the number of instructions
14280 required for a function call from 4 to 1.
14282 The default is @option{-mlarge-text}.
14284 @item -mcpu=@var{cpu_type}
14285 @opindex mcpu
14286 Set the instruction set and instruction scheduling parameters for
14287 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14288 style name or the corresponding chip number.  GCC supports scheduling
14289 parameters for the EV4, EV5 and EV6 family of processors and
14290 chooses the default values for the instruction set from the processor
14291 you specify.  If you do not specify a processor type, GCC defaults
14292 to the processor on which the compiler was built.
14294 Supported values for @var{cpu_type} are
14296 @table @samp
14297 @item ev4
14298 @itemx ev45
14299 @itemx 21064
14300 Schedules as an EV4 and has no instruction set extensions.
14302 @item ev5
14303 @itemx 21164
14304 Schedules as an EV5 and has no instruction set extensions.
14306 @item ev56
14307 @itemx 21164a
14308 Schedules as an EV5 and supports the BWX extension.
14310 @item pca56
14311 @itemx 21164pc
14312 @itemx 21164PC
14313 Schedules as an EV5 and supports the BWX and MAX extensions.
14315 @item ev6
14316 @itemx 21264
14317 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14319 @item ev67
14320 @itemx 21264a
14321 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14322 @end table
14324 Native toolchains also support the value @samp{native},
14325 which selects the best architecture option for the host processor.
14326 @option{-mcpu=native} has no effect if GCC does not recognize
14327 the processor.
14329 @item -mtune=@var{cpu_type}
14330 @opindex mtune
14331 Set only the instruction scheduling parameters for machine type
14332 @var{cpu_type}.  The instruction set is not changed.
14334 Native toolchains also support the value @samp{native},
14335 which selects the best architecture option for the host processor.
14336 @option{-mtune=native} has no effect if GCC does not recognize
14337 the processor.
14339 @item -mmemory-latency=@var{time}
14340 @opindex mmemory-latency
14341 Sets the latency the scheduler should assume for typical memory
14342 references as seen by the application.  This number is highly
14343 dependent on the memory access patterns used by the application
14344 and the size of the external cache on the machine.
14346 Valid options for @var{time} are
14348 @table @samp
14349 @item @var{number}
14350 A decimal number representing clock cycles.
14352 @item L1
14353 @itemx L2
14354 @itemx L3
14355 @itemx main
14356 The compiler contains estimates of the number of clock cycles for
14357 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14358 (also called Dcache, Scache, and Bcache), as well as to main memory.
14359 Note that L3 is only valid for EV5.
14361 @end table
14362 @end table
14364 @node FR30 Options
14365 @subsection FR30 Options
14366 @cindex FR30 Options
14368 These options are defined specifically for the FR30 port.
14370 @table @gcctabopt
14372 @item -msmall-model
14373 @opindex msmall-model
14374 Use the small address space model.  This can produce smaller code, but
14375 it does assume that all symbolic values and addresses fit into a
14376 20-bit range.
14378 @item -mno-lsim
14379 @opindex mno-lsim
14380 Assume that runtime support has been provided and so there is no need
14381 to include the simulator library (@file{libsim.a}) on the linker
14382 command line.
14384 @end table
14386 @node FRV Options
14387 @subsection FRV Options
14388 @cindex FRV Options
14390 @table @gcctabopt
14391 @item -mgpr-32
14392 @opindex mgpr-32
14394 Only use the first 32 general-purpose registers.
14396 @item -mgpr-64
14397 @opindex mgpr-64
14399 Use all 64 general-purpose registers.
14401 @item -mfpr-32
14402 @opindex mfpr-32
14404 Use only the first 32 floating-point registers.
14406 @item -mfpr-64
14407 @opindex mfpr-64
14409 Use all 64 floating-point registers.
14411 @item -mhard-float
14412 @opindex mhard-float
14414 Use hardware instructions for floating-point operations.
14416 @item -msoft-float
14417 @opindex msoft-float
14419 Use library routines for floating-point operations.
14421 @item -malloc-cc
14422 @opindex malloc-cc
14424 Dynamically allocate condition code registers.
14426 @item -mfixed-cc
14427 @opindex mfixed-cc
14429 Do not try to dynamically allocate condition code registers, only
14430 use @code{icc0} and @code{fcc0}.
14432 @item -mdword
14433 @opindex mdword
14435 Change ABI to use double word insns.
14437 @item -mno-dword
14438 @opindex mno-dword
14440 Do not use double word instructions.
14442 @item -mdouble
14443 @opindex mdouble
14445 Use floating-point double instructions.
14447 @item -mno-double
14448 @opindex mno-double
14450 Do not use floating-point double instructions.
14452 @item -mmedia
14453 @opindex mmedia
14455 Use media instructions.
14457 @item -mno-media
14458 @opindex mno-media
14460 Do not use media instructions.
14462 @item -mmuladd
14463 @opindex mmuladd
14465 Use multiply and add/subtract instructions.
14467 @item -mno-muladd
14468 @opindex mno-muladd
14470 Do not use multiply and add/subtract instructions.
14472 @item -mfdpic
14473 @opindex mfdpic
14475 Select the FDPIC ABI, which uses function descriptors to represent
14476 pointers to functions.  Without any PIC/PIE-related options, it
14477 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14478 assumes GOT entries and small data are within a 12-bit range from the
14479 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14480 are computed with 32 bits.
14481 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14483 @item -minline-plt
14484 @opindex minline-plt
14486 Enable inlining of PLT entries in function calls to functions that are
14487 not known to bind locally.  It has no effect without @option{-mfdpic}.
14488 It's enabled by default if optimizing for speed and compiling for
14489 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14490 optimization option such as @option{-O3} or above is present in the
14491 command line.
14493 @item -mTLS
14494 @opindex mTLS
14496 Assume a large TLS segment when generating thread-local code.
14498 @item -mtls
14499 @opindex mtls
14501 Do not assume a large TLS segment when generating thread-local code.
14503 @item -mgprel-ro
14504 @opindex mgprel-ro
14506 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14507 that is known to be in read-only sections.  It's enabled by default,
14508 except for @option{-fpic} or @option{-fpie}: even though it may help
14509 make the global offset table smaller, it trades 1 instruction for 4.
14510 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14511 one of which may be shared by multiple symbols, and it avoids the need
14512 for a GOT entry for the referenced symbol, so it's more likely to be a
14513 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14515 @item -multilib-library-pic
14516 @opindex multilib-library-pic
14518 Link with the (library, not FD) pic libraries.  It's implied by
14519 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14520 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14521 it explicitly.
14523 @item -mlinked-fp
14524 @opindex mlinked-fp
14526 Follow the EABI requirement of always creating a frame pointer whenever
14527 a stack frame is allocated.  This option is enabled by default and can
14528 be disabled with @option{-mno-linked-fp}.
14530 @item -mlong-calls
14531 @opindex mlong-calls
14533 Use indirect addressing to call functions outside the current
14534 compilation unit.  This allows the functions to be placed anywhere
14535 within the 32-bit address space.
14537 @item -malign-labels
14538 @opindex malign-labels
14540 Try to align labels to an 8-byte boundary by inserting NOPs into the
14541 previous packet.  This option only has an effect when VLIW packing
14542 is enabled.  It doesn't create new packets; it merely adds NOPs to
14543 existing ones.
14545 @item -mlibrary-pic
14546 @opindex mlibrary-pic
14548 Generate position-independent EABI code.
14550 @item -macc-4
14551 @opindex macc-4
14553 Use only the first four media accumulator registers.
14555 @item -macc-8
14556 @opindex macc-8
14558 Use all eight media accumulator registers.
14560 @item -mpack
14561 @opindex mpack
14563 Pack VLIW instructions.
14565 @item -mno-pack
14566 @opindex mno-pack
14568 Do not pack VLIW instructions.
14570 @item -mno-eflags
14571 @opindex mno-eflags
14573 Do not mark ABI switches in e_flags.
14575 @item -mcond-move
14576 @opindex mcond-move
14578 Enable the use of conditional-move instructions (default).
14580 This switch is mainly for debugging the compiler and will likely be removed
14581 in a future version.
14583 @item -mno-cond-move
14584 @opindex mno-cond-move
14586 Disable the use of conditional-move instructions.
14588 This switch is mainly for debugging the compiler and will likely be removed
14589 in a future version.
14591 @item -mscc
14592 @opindex mscc
14594 Enable the use of conditional set instructions (default).
14596 This switch is mainly for debugging the compiler and will likely be removed
14597 in a future version.
14599 @item -mno-scc
14600 @opindex mno-scc
14602 Disable the use of conditional set instructions.
14604 This switch is mainly for debugging the compiler and will likely be removed
14605 in a future version.
14607 @item -mcond-exec
14608 @opindex mcond-exec
14610 Enable the use of conditional execution (default).
14612 This switch is mainly for debugging the compiler and will likely be removed
14613 in a future version.
14615 @item -mno-cond-exec
14616 @opindex mno-cond-exec
14618 Disable the use of conditional execution.
14620 This switch is mainly for debugging the compiler and will likely be removed
14621 in a future version.
14623 @item -mvliw-branch
14624 @opindex mvliw-branch
14626 Run a pass to pack branches into VLIW instructions (default).
14628 This switch is mainly for debugging the compiler and will likely be removed
14629 in a future version.
14631 @item -mno-vliw-branch
14632 @opindex mno-vliw-branch
14634 Do not run a pass to pack branches into VLIW instructions.
14636 This switch is mainly for debugging the compiler and will likely be removed
14637 in a future version.
14639 @item -mmulti-cond-exec
14640 @opindex mmulti-cond-exec
14642 Enable optimization of @code{&&} and @code{||} in conditional execution
14643 (default).
14645 This switch is mainly for debugging the compiler and will likely be removed
14646 in a future version.
14648 @item -mno-multi-cond-exec
14649 @opindex mno-multi-cond-exec
14651 Disable optimization of @code{&&} and @code{||} in conditional execution.
14653 This switch is mainly for debugging the compiler and will likely be removed
14654 in a future version.
14656 @item -mnested-cond-exec
14657 @opindex mnested-cond-exec
14659 Enable nested conditional execution optimizations (default).
14661 This switch is mainly for debugging the compiler and will likely be removed
14662 in a future version.
14664 @item -mno-nested-cond-exec
14665 @opindex mno-nested-cond-exec
14667 Disable nested conditional execution optimizations.
14669 This switch is mainly for debugging the compiler and will likely be removed
14670 in a future version.
14672 @item -moptimize-membar
14673 @opindex moptimize-membar
14675 This switch removes redundant @code{membar} instructions from the
14676 compiler-generated code.  It is enabled by default.
14678 @item -mno-optimize-membar
14679 @opindex mno-optimize-membar
14681 This switch disables the automatic removal of redundant @code{membar}
14682 instructions from the generated code.
14684 @item -mtomcat-stats
14685 @opindex mtomcat-stats
14687 Cause gas to print out tomcat statistics.
14689 @item -mcpu=@var{cpu}
14690 @opindex mcpu
14692 Select the processor type for which to generate code.  Possible values are
14693 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14694 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14696 @end table
14698 @node GNU/Linux Options
14699 @subsection GNU/Linux Options
14701 These @samp{-m} options are defined for GNU/Linux targets:
14703 @table @gcctabopt
14704 @item -mglibc
14705 @opindex mglibc
14706 Use the GNU C library.  This is the default except
14707 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14709 @item -muclibc
14710 @opindex muclibc
14711 Use uClibc C library.  This is the default on
14712 @samp{*-*-linux-*uclibc*} targets.
14714 @item -mbionic
14715 @opindex mbionic
14716 Use Bionic C library.  This is the default on
14717 @samp{*-*-linux-*android*} targets.
14719 @item -mandroid
14720 @opindex mandroid
14721 Compile code compatible with Android platform.  This is the default on
14722 @samp{*-*-linux-*android*} targets.
14724 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14725 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14726 this option makes the GCC driver pass Android-specific options to the linker.
14727 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14728 to be defined.
14730 @item -tno-android-cc
14731 @opindex tno-android-cc
14732 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14733 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14734 @option{-fno-rtti} by default.
14736 @item -tno-android-ld
14737 @opindex tno-android-ld
14738 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14739 linking options to the linker.
14741 @end table
14743 @node H8/300 Options
14744 @subsection H8/300 Options
14746 These @samp{-m} options are defined for the H8/300 implementations:
14748 @table @gcctabopt
14749 @item -mrelax
14750 @opindex mrelax
14751 Shorten some address references at link time, when possible; uses the
14752 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14753 ld, Using ld}, for a fuller description.
14755 @item -mh
14756 @opindex mh
14757 Generate code for the H8/300H@.
14759 @item -ms
14760 @opindex ms
14761 Generate code for the H8S@.
14763 @item -mn
14764 @opindex mn
14765 Generate code for the H8S and H8/300H in the normal mode.  This switch
14766 must be used either with @option{-mh} or @option{-ms}.
14768 @item -ms2600
14769 @opindex ms2600
14770 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14772 @item -mexr
14773 @opindex mexr
14774 Extended registers are stored on stack before execution of function
14775 with monitor attribute. Default option is @option{-mexr}.
14776 This option is valid only for H8S targets.
14778 @item -mno-exr
14779 @opindex mno-exr
14780 Extended registers are not stored on stack before execution of function 
14781 with monitor attribute. Default option is @option{-mno-exr}. 
14782 This option is valid only for H8S targets.
14784 @item -mint32
14785 @opindex mint32
14786 Make @code{int} data 32 bits by default.
14788 @item -malign-300
14789 @opindex malign-300
14790 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
14791 The default for the H8/300H and H8S is to align longs and floats on
14792 4-byte boundaries.
14793 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
14794 This option has no effect on the H8/300.
14795 @end table
14797 @node HPPA Options
14798 @subsection HPPA Options
14799 @cindex HPPA Options
14801 These @samp{-m} options are defined for the HPPA family of computers:
14803 @table @gcctabopt
14804 @item -march=@var{architecture-type}
14805 @opindex march
14806 Generate code for the specified architecture.  The choices for
14807 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
14808 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
14809 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
14810 architecture option for your machine.  Code compiled for lower numbered
14811 architectures runs on higher numbered architectures, but not the
14812 other way around.
14814 @item -mpa-risc-1-0
14815 @itemx -mpa-risc-1-1
14816 @itemx -mpa-risc-2-0
14817 @opindex mpa-risc-1-0
14818 @opindex mpa-risc-1-1
14819 @opindex mpa-risc-2-0
14820 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
14822 @item -mjump-in-delay
14823 @opindex mjump-in-delay
14824 Fill delay slots of function calls with unconditional jump instructions
14825 by modifying the return pointer for the function call to be the target
14826 of the conditional jump.
14828 @item -mdisable-fpregs
14829 @opindex mdisable-fpregs
14830 Prevent floating-point registers from being used in any manner.  This is
14831 necessary for compiling kernels that perform lazy context switching of
14832 floating-point registers.  If you use this option and attempt to perform
14833 floating-point operations, the compiler aborts.
14835 @item -mdisable-indexing
14836 @opindex mdisable-indexing
14837 Prevent the compiler from using indexing address modes.  This avoids some
14838 rather obscure problems when compiling MIG generated code under MACH@.
14840 @item -mno-space-regs
14841 @opindex mno-space-regs
14842 Generate code that assumes the target has no space registers.  This allows
14843 GCC to generate faster indirect calls and use unscaled index address modes.
14845 Such code is suitable for level 0 PA systems and kernels.
14847 @item -mfast-indirect-calls
14848 @opindex mfast-indirect-calls
14849 Generate code that assumes calls never cross space boundaries.  This
14850 allows GCC to emit code that performs faster indirect calls.
14852 This option does not work in the presence of shared libraries or nested
14853 functions.
14855 @item -mfixed-range=@var{register-range}
14856 @opindex mfixed-range
14857 Generate code treating the given register range as fixed registers.
14858 A fixed register is one that the register allocator cannot use.  This is
14859 useful when compiling kernel code.  A register range is specified as
14860 two registers separated by a dash.  Multiple register ranges can be
14861 specified separated by a comma.
14863 @item -mlong-load-store
14864 @opindex mlong-load-store
14865 Generate 3-instruction load and store sequences as sometimes required by
14866 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
14867 the HP compilers.
14869 @item -mportable-runtime
14870 @opindex mportable-runtime
14871 Use the portable calling conventions proposed by HP for ELF systems.
14873 @item -mgas
14874 @opindex mgas
14875 Enable the use of assembler directives only GAS understands.
14877 @item -mschedule=@var{cpu-type}
14878 @opindex mschedule
14879 Schedule code according to the constraints for the machine type
14880 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
14881 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
14882 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
14883 proper scheduling option for your machine.  The default scheduling is
14884 @samp{8000}.
14886 @item -mlinker-opt
14887 @opindex mlinker-opt
14888 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
14889 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
14890 linkers in which they give bogus error messages when linking some programs.
14892 @item -msoft-float
14893 @opindex msoft-float
14894 Generate output containing library calls for floating point.
14895 @strong{Warning:} the requisite libraries are not available for all HPPA
14896 targets.  Normally the facilities of the machine's usual C compiler are
14897 used, but this cannot be done directly in cross-compilation.  You must make
14898 your own arrangements to provide suitable library functions for
14899 cross-compilation.
14901 @option{-msoft-float} changes the calling convention in the output file;
14902 therefore, it is only useful if you compile @emph{all} of a program with
14903 this option.  In particular, you need to compile @file{libgcc.a}, the
14904 library that comes with GCC, with @option{-msoft-float} in order for
14905 this to work.
14907 @item -msio
14908 @opindex msio
14909 Generate the predefine, @code{_SIO}, for server IO@.  The default is
14910 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
14911 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
14912 options are available under HP-UX and HI-UX@.
14914 @item -mgnu-ld
14915 @opindex mgnu-ld
14916 Use options specific to GNU @command{ld}.
14917 This passes @option{-shared} to @command{ld} when
14918 building a shared library.  It is the default when GCC is configured,
14919 explicitly or implicitly, with the GNU linker.  This option does not
14920 affect which @command{ld} is called; it only changes what parameters
14921 are passed to that @command{ld}.
14922 The @command{ld} that is called is determined by the
14923 @option{--with-ld} configure option, GCC's program search path, and
14924 finally by the user's @env{PATH}.  The linker used by GCC can be printed
14925 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
14926 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14928 @item -mhp-ld
14929 @opindex mhp-ld
14930 Use options specific to HP @command{ld}.
14931 This passes @option{-b} to @command{ld} when building
14932 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
14933 links.  It is the default when GCC is configured, explicitly or
14934 implicitly, with the HP linker.  This option does not affect
14935 which @command{ld} is called; it only changes what parameters are passed to that
14936 @command{ld}.
14937 The @command{ld} that is called is determined by the @option{--with-ld}
14938 configure option, GCC's program search path, and finally by the user's
14939 @env{PATH}.  The linker used by GCC can be printed using @samp{which
14940 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
14941 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14943 @item -mlong-calls
14944 @opindex mno-long-calls
14945 Generate code that uses long call sequences.  This ensures that a call
14946 is always able to reach linker generated stubs.  The default is to generate
14947 long calls only when the distance from the call site to the beginning
14948 of the function or translation unit, as the case may be, exceeds a
14949 predefined limit set by the branch type being used.  The limits for
14950 normal calls are 7,600,000 and 240,000 bytes, respectively for the
14951 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
14952 240,000 bytes.
14954 Distances are measured from the beginning of functions when using the
14955 @option{-ffunction-sections} option, or when using the @option{-mgas}
14956 and @option{-mno-portable-runtime} options together under HP-UX with
14957 the SOM linker.
14959 It is normally not desirable to use this option as it degrades
14960 performance.  However, it may be useful in large applications,
14961 particularly when partial linking is used to build the application.
14963 The types of long calls used depends on the capabilities of the
14964 assembler and linker, and the type of code being generated.  The
14965 impact on systems that support long absolute calls, and long pic
14966 symbol-difference or pc-relative calls should be relatively small.
14967 However, an indirect call is used on 32-bit ELF systems in pic code
14968 and it is quite long.
14970 @item -munix=@var{unix-std}
14971 @opindex march
14972 Generate compiler predefines and select a startfile for the specified
14973 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
14974 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
14975 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
14976 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
14977 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
14978 and later.
14980 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
14981 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
14982 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
14983 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
14984 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
14985 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
14987 It is @emph{important} to note that this option changes the interfaces
14988 for various library routines.  It also affects the operational behavior
14989 of the C library.  Thus, @emph{extreme} care is needed in using this
14990 option.
14992 Library code that is intended to operate with more than one UNIX
14993 standard must test, set and restore the variable @var{__xpg4_extended_mask}
14994 as appropriate.  Most GNU software doesn't provide this capability.
14996 @item -nolibdld
14997 @opindex nolibdld
14998 Suppress the generation of link options to search libdld.sl when the
14999 @option{-static} option is specified on HP-UX 10 and later.
15001 @item -static
15002 @opindex static
15003 The HP-UX implementation of setlocale in libc has a dependency on
15004 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15005 when the @option{-static} option is specified, special link options
15006 are needed to resolve this dependency.
15008 On HP-UX 10 and later, the GCC driver adds the necessary options to
15009 link with libdld.sl when the @option{-static} option is specified.
15010 This causes the resulting binary to be dynamic.  On the 64-bit port,
15011 the linkers generate dynamic binaries by default in any case.  The
15012 @option{-nolibdld} option can be used to prevent the GCC driver from
15013 adding these link options.
15015 @item -threads
15016 @opindex threads
15017 Add support for multithreading with the @dfn{dce thread} library
15018 under HP-UX@.  This option sets flags for both the preprocessor and
15019 linker.
15020 @end table
15022 @node i386 and x86-64 Options
15023 @subsection Intel 386 and AMD x86-64 Options
15024 @cindex i386 Options
15025 @cindex x86-64 Options
15026 @cindex Intel 386 Options
15027 @cindex AMD x86-64 Options
15029 These @samp{-m} options are defined for the i386 and x86-64 family of
15030 computers:
15032 @table @gcctabopt
15034 @item -march=@var{cpu-type}
15035 @opindex march
15036 Generate instructions for the machine type @var{cpu-type}.  In contrast to
15037 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
15038 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
15039 to generate code that may not run at all on processors other than the one
15040 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
15041 @option{-mtune=@var{cpu-type}}.
15043 The choices for @var{cpu-type} are:
15045 @table @samp
15046 @item native
15047 This selects the CPU to generate code for at compilation time by determining
15048 the processor type of the compiling machine.  Using @option{-march=native}
15049 enables all instruction subsets supported by the local machine (hence
15050 the result might not run on different machines).  Using @option{-mtune=native}
15051 produces code optimized for the local machine under the constraints
15052 of the selected instruction set.  
15054 @item i386
15055 Original Intel i386 CPU@.
15057 @item i486
15058 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
15060 @item i586
15061 @itemx pentium
15062 Intel Pentium CPU with no MMX support.
15064 @item pentium-mmx
15065 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
15067 @item pentiumpro
15068 Intel Pentium Pro CPU@.
15070 @item i686
15071 When used with @option{-march}, the Pentium Pro
15072 instruction set is used, so the code runs on all i686 family chips.
15073 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
15075 @item pentium2
15076 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
15077 support.
15079 @item pentium3
15080 @itemx pentium3m
15081 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
15082 set support.
15084 @item pentium-m
15085 Intel Pentium M; low-power version of Intel Pentium III CPU
15086 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
15088 @item pentium4
15089 @itemx pentium4m
15090 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
15092 @item prescott
15093 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
15094 set support.
15096 @item nocona
15097 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
15098 SSE2 and SSE3 instruction set support.
15100 @item core2
15101 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
15102 instruction set support.
15104 @item nehalem
15105 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15106 SSE4.1, SSE4.2 and POPCNT instruction set support.
15108 @item westmere
15109 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15110 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
15112 @item sandybridge
15113 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15114 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
15116 @item ivybridge
15117 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15118 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
15119 instruction set support.
15121 @item haswell
15122 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15123 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15124 BMI, BMI2 and F16C instruction set support.
15126 @item broadwell
15127 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15128 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15129 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
15131 @item bonnell
15132 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
15133 instruction set support.
15135 @item silvermont
15136 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15137 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
15139 @item k6
15140 AMD K6 CPU with MMX instruction set support.
15142 @item k6-2
15143 @itemx k6-3
15144 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
15146 @item athlon
15147 @itemx athlon-tbird
15148 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
15149 support.
15151 @item athlon-4
15152 @itemx athlon-xp
15153 @itemx athlon-mp
15154 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
15155 instruction set support.
15157 @item k8
15158 @itemx opteron
15159 @itemx athlon64
15160 @itemx athlon-fx
15161 Processors based on the AMD K8 core with x86-64 instruction set support,
15162 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
15163 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
15164 instruction set extensions.)
15166 @item k8-sse3
15167 @itemx opteron-sse3
15168 @itemx athlon64-sse3
15169 Improved versions of AMD K8 cores with SSE3 instruction set support.
15171 @item amdfam10
15172 @itemx barcelona
15173 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
15174 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
15175 instruction set extensions.)
15177 @item bdver1
15178 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
15179 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
15180 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
15181 @item bdver2
15182 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15183 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
15184 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
15185 extensions.)
15186 @item bdver3
15187 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15188 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
15189 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
15190 64-bit instruction set extensions.
15191 @item bdver4
15192 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15193 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
15194 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
15195 SSE4.2, ABM and 64-bit instruction set extensions.
15197 @item btver1
15198 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
15199 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
15200 instruction set extensions.)
15202 @item btver2
15203 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
15204 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
15205 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
15207 @item winchip-c6
15208 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15209 set support.
15211 @item winchip2
15212 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15213 instruction set support.
15215 @item c3
15216 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15217 implemented for this chip.)
15219 @item c3-2
15220 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15221 (No scheduling is
15222 implemented for this chip.)
15224 @item geode
15225 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15226 @end table
15228 @item -mtune=@var{cpu-type}
15229 @opindex mtune
15230 Tune to @var{cpu-type} everything applicable about the generated code, except
15231 for the ABI and the set of available instructions.  
15232 While picking a specific @var{cpu-type} schedules things appropriately
15233 for that particular chip, the compiler does not generate any code that
15234 cannot run on the default machine type unless you use a
15235 @option{-march=@var{cpu-type}} option.
15236 For example, if GCC is configured for i686-pc-linux-gnu
15237 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15238 but still runs on i686 machines.
15240 The choices for @var{cpu-type} are the same as for @option{-march}.
15241 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15243 @table @samp
15244 @item generic
15245 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15246 If you know the CPU on which your code will run, then you should use
15247 the corresponding @option{-mtune} or @option{-march} option instead of
15248 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15249 of your application will have, then you should use this option.
15251 As new processors are deployed in the marketplace, the behavior of this
15252 option will change.  Therefore, if you upgrade to a newer version of
15253 GCC, code generation controlled by this option will change to reflect
15254 the processors
15255 that are most common at the time that version of GCC is released.
15257 There is no @option{-march=generic} option because @option{-march}
15258 indicates the instruction set the compiler can use, and there is no
15259 generic instruction set applicable to all processors.  In contrast,
15260 @option{-mtune} indicates the processor (or, in this case, collection of
15261 processors) for which the code is optimized.
15263 @item intel
15264 Produce code optimized for the most current Intel processors, which are
15265 Haswell and Silvermont for this version of GCC.  If you know the CPU
15266 on which your code will run, then you should use the corresponding
15267 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15268 But, if you want your application performs better on both Haswell and
15269 Silvermont, then you should use this option.
15271 As new Intel processors are deployed in the marketplace, the behavior of
15272 this option will change.  Therefore, if you upgrade to a newer version of
15273 GCC, code generation controlled by this option will change to reflect
15274 the most current Intel processors at the time that version of GCC is
15275 released.
15277 There is no @option{-march=intel} option because @option{-march} indicates
15278 the instruction set the compiler can use, and there is no common
15279 instruction set applicable to all processors.  In contrast,
15280 @option{-mtune} indicates the processor (or, in this case, collection of
15281 processors) for which the code is optimized.
15282 @end table
15284 @item -mcpu=@var{cpu-type}
15285 @opindex mcpu
15286 A deprecated synonym for @option{-mtune}.
15288 @item -mfpmath=@var{unit}
15289 @opindex mfpmath
15290 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15291 for @var{unit} are:
15293 @table @samp
15294 @item 387
15295 Use the standard 387 floating-point coprocessor present on the majority of chips and
15296 emulated otherwise.  Code compiled with this option runs almost everywhere.
15297 The temporary results are computed in 80-bit precision instead of the precision
15298 specified by the type, resulting in slightly different results compared to most
15299 of other chips.  See @option{-ffloat-store} for more detailed description.
15301 This is the default choice for i386 compiler.
15303 @item sse
15304 Use scalar floating-point instructions present in the SSE instruction set.
15305 This instruction set is supported by Pentium III and newer chips,
15306 and in the AMD line
15307 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15308 instruction set supports only single-precision arithmetic, thus the double and
15309 extended-precision arithmetic are still done using 387.  A later version, present
15310 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15311 arithmetic too.
15313 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15314 or @option{-msse2} switches to enable SSE extensions and make this option
15315 effective.  For the x86-64 compiler, these extensions are enabled by default.
15317 The resulting code should be considerably faster in the majority of cases and avoid
15318 the numerical instability problems of 387 code, but may break some existing
15319 code that expects temporaries to be 80 bits.
15321 This is the default choice for the x86-64 compiler.
15323 @item sse,387
15324 @itemx sse+387
15325 @itemx both
15326 Attempt to utilize both instruction sets at once.  This effectively doubles the
15327 amount of available registers, and on chips with separate execution units for
15328 387 and SSE the execution resources too.  Use this option with care, as it is
15329 still experimental, because the GCC register allocator does not model separate
15330 functional units well, resulting in unstable performance.
15331 @end table
15333 @item -masm=@var{dialect}
15334 @opindex masm=@var{dialect}
15335 Output assembly instructions using selected @var{dialect}.  Supported
15336 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15337 not support @samp{intel}.
15339 @item -mieee-fp
15340 @itemx -mno-ieee-fp
15341 @opindex mieee-fp
15342 @opindex mno-ieee-fp
15343 Control whether or not the compiler uses IEEE floating-point
15344 comparisons.  These correctly handle the case where the result of a
15345 comparison is unordered.
15347 @item -msoft-float
15348 @opindex msoft-float
15349 Generate output containing library calls for floating point.
15351 @strong{Warning:} the requisite libraries are not part of GCC@.
15352 Normally the facilities of the machine's usual C compiler are used, but
15353 this can't be done directly in cross-compilation.  You must make your
15354 own arrangements to provide suitable library functions for
15355 cross-compilation.
15357 On machines where a function returns floating-point results in the 80387
15358 register stack, some floating-point opcodes may be emitted even if
15359 @option{-msoft-float} is used.
15361 @item -mno-fp-ret-in-387
15362 @opindex mno-fp-ret-in-387
15363 Do not use the FPU registers for return values of functions.
15365 The usual calling convention has functions return values of types
15366 @code{float} and @code{double} in an FPU register, even if there
15367 is no FPU@.  The idea is that the operating system should emulate
15368 an FPU@.
15370 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15371 in ordinary CPU registers instead.
15373 @item -mno-fancy-math-387
15374 @opindex mno-fancy-math-387
15375 Some 387 emulators do not support the @code{sin}, @code{cos} and
15376 @code{sqrt} instructions for the 387.  Specify this option to avoid
15377 generating those instructions.  This option is the default on FreeBSD,
15378 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15379 indicates that the target CPU always has an FPU and so the
15380 instruction does not need emulation.  These
15381 instructions are not generated unless you also use the
15382 @option{-funsafe-math-optimizations} switch.
15384 @item -malign-double
15385 @itemx -mno-align-double
15386 @opindex malign-double
15387 @opindex mno-align-double
15388 Control whether GCC aligns @code{double}, @code{long double}, and
15389 @code{long long} variables on a two-word boundary or a one-word
15390 boundary.  Aligning @code{double} variables on a two-word boundary
15391 produces code that runs somewhat faster on a Pentium at the
15392 expense of more memory.
15394 On x86-64, @option{-malign-double} is enabled by default.
15396 @strong{Warning:} if you use the @option{-malign-double} switch,
15397 structures containing the above types are aligned differently than
15398 the published application binary interface specifications for the 386
15399 and are not binary compatible with structures in code compiled
15400 without that switch.
15402 @item -m96bit-long-double
15403 @itemx -m128bit-long-double
15404 @opindex m96bit-long-double
15405 @opindex m128bit-long-double
15406 These switches control the size of @code{long double} type.  The i386
15407 application binary interface specifies the size to be 96 bits,
15408 so @option{-m96bit-long-double} is the default in 32-bit mode.
15410 Modern architectures (Pentium and newer) prefer @code{long double}
15411 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15412 conforming to the ABI, this is not possible.  So specifying
15413 @option{-m128bit-long-double} aligns @code{long double}
15414 to a 16-byte boundary by padding the @code{long double} with an additional
15415 32-bit zero.
15417 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15418 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15420 Notice that neither of these options enable any extra precision over the x87
15421 standard of 80 bits for a @code{long double}.
15423 @strong{Warning:} if you override the default value for your target ABI, this
15424 changes the size of 
15425 structures and arrays containing @code{long double} variables,
15426 as well as modifying the function calling convention for functions taking
15427 @code{long double}.  Hence they are not binary-compatible
15428 with code compiled without that switch.
15430 @item -mlong-double-64
15431 @itemx -mlong-double-80
15432 @itemx -mlong-double-128
15433 @opindex mlong-double-64
15434 @opindex mlong-double-80
15435 @opindex mlong-double-128
15436 These switches control the size of @code{long double} type. A size
15437 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15438 type. This is the default for 32-bit Bionic C library.  A size
15439 of 128 bits makes the @code{long double} type equivalent to the
15440 @code{__float128} type. This is the default for 64-bit Bionic C library.
15442 @strong{Warning:} if you override the default value for your target ABI, this
15443 changes the size of
15444 structures and arrays containing @code{long double} variables,
15445 as well as modifying the function calling convention for functions taking
15446 @code{long double}.  Hence they are not binary-compatible
15447 with code compiled without that switch.
15449 @item -mlarge-data-threshold=@var{threshold}
15450 @opindex mlarge-data-threshold
15451 When @option{-mcmodel=medium} is specified, data objects larger than
15452 @var{threshold} are placed in the large data section.  This value must be the
15453 same across all objects linked into the binary, and defaults to 65535.
15455 @item -mrtd
15456 @opindex mrtd
15457 Use a different function-calling convention, in which functions that
15458 take a fixed number of arguments return with the @code{ret @var{num}}
15459 instruction, which pops their arguments while returning.  This saves one
15460 instruction in the caller since there is no need to pop the arguments
15461 there.
15463 You can specify that an individual function is called with this calling
15464 sequence with the function attribute @samp{stdcall}.  You can also
15465 override the @option{-mrtd} option by using the function attribute
15466 @samp{cdecl}.  @xref{Function Attributes}.
15468 @strong{Warning:} this calling convention is incompatible with the one
15469 normally used on Unix, so you cannot use it if you need to call
15470 libraries compiled with the Unix compiler.
15472 Also, you must provide function prototypes for all functions that
15473 take variable numbers of arguments (including @code{printf});
15474 otherwise incorrect code is generated for calls to those
15475 functions.
15477 In addition, seriously incorrect code results if you call a
15478 function with too many arguments.  (Normally, extra arguments are
15479 harmlessly ignored.)
15481 @item -mregparm=@var{num}
15482 @opindex mregparm
15483 Control how many registers are used to pass integer arguments.  By
15484 default, no registers are used to pass arguments, and at most 3
15485 registers can be used.  You can control this behavior for a specific
15486 function by using the function attribute @samp{regparm}.
15487 @xref{Function Attributes}.
15489 @strong{Warning:} if you use this switch, and
15490 @var{num} is nonzero, then you must build all modules with the same
15491 value, including any libraries.  This includes the system libraries and
15492 startup modules.
15494 @item -msseregparm
15495 @opindex msseregparm
15496 Use SSE register passing conventions for float and double arguments
15497 and return values.  You can control this behavior for a specific
15498 function by using the function attribute @samp{sseregparm}.
15499 @xref{Function Attributes}.
15501 @strong{Warning:} if you use this switch then you must build all
15502 modules with the same value, including any libraries.  This includes
15503 the system libraries and startup modules.
15505 @item -mvect8-ret-in-mem
15506 @opindex mvect8-ret-in-mem
15507 Return 8-byte vectors in memory instead of MMX registers.  This is the
15508 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15509 Studio compilers until version 12.  Later compiler versions (starting
15510 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15511 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15512 you need to remain compatible with existing code produced by those
15513 previous compiler versions or older versions of GCC@.
15515 @item -mpc32
15516 @itemx -mpc64
15517 @itemx -mpc80
15518 @opindex mpc32
15519 @opindex mpc64
15520 @opindex mpc80
15522 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15523 is specified, the significands of results of floating-point operations are
15524 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15525 significands of results of floating-point operations to 53 bits (double
15526 precision) and @option{-mpc80} rounds the significands of results of
15527 floating-point operations to 64 bits (extended double precision), which is
15528 the default.  When this option is used, floating-point operations in higher
15529 precisions are not available to the programmer without setting the FPU
15530 control word explicitly.
15532 Setting the rounding of floating-point operations to less than the default
15533 80 bits can speed some programs by 2% or more.  Note that some mathematical
15534 libraries assume that extended-precision (80-bit) floating-point operations
15535 are enabled by default; routines in such libraries could suffer significant
15536 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15537 when this option is used to set the precision to less than extended precision.
15539 @item -mstackrealign
15540 @opindex mstackrealign
15541 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15542 option generates an alternate prologue and epilogue that realigns the
15543 run-time stack if necessary.  This supports mixing legacy codes that keep
15544 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15545 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15546 applicable to individual functions.
15548 @item -mpreferred-stack-boundary=@var{num}
15549 @opindex mpreferred-stack-boundary
15550 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15551 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15552 the default is 4 (16 bytes or 128 bits).
15554 @strong{Warning:} When generating code for the x86-64 architecture with
15555 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15556 used to keep the stack boundary aligned to 8 byte boundary.  Since
15557 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15558 intended to be used in controlled environment where stack space is
15559 important limitation.  This option will lead to wrong code when functions
15560 compiled with 16 byte stack alignment (such as functions from a standard
15561 library) are called with misaligned stack.  In this case, SSE
15562 instructions may lead to misaligned memory access traps.  In addition,
15563 variable arguments will be handled incorrectly for 16 byte aligned
15564 objects (including x87 long double and __int128), leading to wrong
15565 results.  You must build all modules with
15566 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15567 includes the system libraries and startup modules.
15569 @item -mincoming-stack-boundary=@var{num}
15570 @opindex mincoming-stack-boundary
15571 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15572 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15573 the one specified by @option{-mpreferred-stack-boundary} is used.
15575 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15576 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15577 suffer significant run time performance penalties.  On Pentium III, the
15578 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15579 properly if it is not 16-byte aligned.
15581 To ensure proper alignment of this values on the stack, the stack boundary
15582 must be as aligned as that required by any value stored on the stack.
15583 Further, every function must be generated such that it keeps the stack
15584 aligned.  Thus calling a function compiled with a higher preferred
15585 stack boundary from a function compiled with a lower preferred stack
15586 boundary most likely misaligns the stack.  It is recommended that
15587 libraries that use callbacks always use the default setting.
15589 This extra alignment does consume extra stack space, and generally
15590 increases code size.  Code that is sensitive to stack space usage, such
15591 as embedded systems and operating system kernels, may want to reduce the
15592 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15594 @item -mmmx
15595 @itemx -mno-mmx
15596 @itemx -msse
15597 @itemx -mno-sse
15598 @itemx -msse2
15599 @itemx -mno-sse2
15600 @itemx -msse3
15601 @itemx -mno-sse3
15602 @itemx -mssse3
15603 @itemx -mno-ssse3
15604 @itemx -msse4.1
15605 @need 800
15606 @itemx -mno-sse4.1
15607 @itemx -msse4.2
15608 @itemx -mno-sse4.2
15609 @itemx -msse4
15610 @itemx -mno-sse4
15611 @itemx -mavx
15612 @itemx -mno-avx
15613 @itemx -mavx2
15614 @itemx -mno-avx2
15615 @itemx -mavx512f
15616 @itemx -mno-avx512f
15617 @need 800
15618 @itemx -mavx512pf
15619 @itemx -mno-avx512pf
15620 @itemx -mavx512er
15621 @itemx -mno-avx512er
15622 @itemx -mavx512cd
15623 @itemx -mno-avx512cd
15624 @itemx -msha
15625 @itemx -mno-sha
15626 @itemx -maes
15627 @itemx -mno-aes
15628 @itemx -mpclmul
15629 @itemx -mno-pclmul
15630 @itemx -mclfushopt
15631 @itemx -mno-clflsuhopt
15632 @need 800
15633 @itemx -mfsgsbase
15634 @itemx -mno-fsgsbase
15635 @itemx -mrdrnd
15636 @itemx -mno-rdrnd
15637 @itemx -mf16c
15638 @itemx -mno-f16c
15639 @itemx -mfma
15640 @itemx -mno-fma
15641 @itemx -mprefetchwt1
15642 @itemx -mno-prefetchwt1
15643 @itemx -msse4a
15644 @itemx -mno-sse4a
15645 @itemx -mfma4
15646 @itemx -mno-fma4
15647 @need 800
15648 @itemx -mxop
15649 @itemx -mno-xop
15650 @itemx -mlwp
15651 @itemx -mno-lwp
15652 @itemx -m3dnow
15653 @itemx -mno-3dnow
15654 @itemx -mpopcnt
15655 @itemx -mno-popcnt
15656 @itemx -mabm
15657 @itemx -mno-abm
15658 @itemx -mbmi
15659 @itemx -mbmi2
15660 @itemx -mno-bmi
15661 @itemx -mno-bmi2
15662 @itemx -mlzcnt
15663 @itemx -mno-lzcnt
15664 @itemx -mfxsr
15665 @itemx -mxsave
15666 @itemx -mxsaveopt
15667 @itemx -mrtm
15668 @itemx -mtbm
15669 @itemx -mno-tbm
15670 @itemx -mxsavec
15671 @itemx -mno-xsavec
15672 @itemx -mxsaves
15673 @itemx -mno-xsaves
15674 @opindex mmmx
15675 @opindex mno-mmx
15676 @opindex msse
15677 @opindex mno-sse
15678 @opindex m3dnow
15679 @opindex mno-3dnow
15680 These switches enable or disable the use of instructions in the MMX, SSE,
15681 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15682 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15683 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, or 3DNow!@:
15684 extended instruction sets.
15685 These extensions are also available as built-in functions: see
15686 @ref{X86 Built-in Functions}, for details of the functions enabled and
15687 disabled by these switches.
15689 To generate SSE/SSE2 instructions automatically from floating-point
15690 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15692 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15693 generates new AVX instructions or AVX equivalence for all SSEx instructions
15694 when needed.
15696 These options enable GCC to use these extended instructions in
15697 generated code, even without @option{-mfpmath=sse}.  Applications that
15698 perform run-time CPU detection must compile separate files for each
15699 supported architecture, using the appropriate flags.  In particular,
15700 the file containing the CPU detection code should be compiled without
15701 these options.
15703 @item -mdump-tune-features
15704 @opindex mdump-tune-features
15705 This option instructs GCC to dump the names of the x86 performance 
15706 tuning features and default settings. The names can be used in 
15707 @option{-mtune-ctrl=@var{feature-list}}.
15709 @item -mtune-ctrl=@var{feature-list}
15710 @opindex mtune-ctrl=@var{feature-list}
15711 This option is used to do fine grain control of x86 code generation features.
15712 @var{feature-list} is a comma separated list of @var{feature} names. See also
15713 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15714 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15715 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15716 developers. Using it may lead to code paths not covered by testing and can
15717 potentially result in compiler ICEs or runtime errors.
15719 @item -mno-default
15720 @opindex mno-default
15721 This option instructs GCC to turn off all tunable features. See also 
15722 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15724 @item -mcld
15725 @opindex mcld
15726 This option instructs GCC to emit a @code{cld} instruction in the prologue
15727 of functions that use string instructions.  String instructions depend on
15728 the DF flag to select between autoincrement or autodecrement mode.  While the
15729 ABI specifies the DF flag to be cleared on function entry, some operating
15730 systems violate this specification by not clearing the DF flag in their
15731 exception dispatchers.  The exception handler can be invoked with the DF flag
15732 set, which leads to wrong direction mode when string instructions are used.
15733 This option can be enabled by default on 32-bit x86 targets by configuring
15734 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15735 instructions can be suppressed with the @option{-mno-cld} compiler option
15736 in this case.
15738 @item -mvzeroupper
15739 @opindex mvzeroupper
15740 This option instructs GCC to emit a @code{vzeroupper} instruction
15741 before a transfer of control flow out of the function to minimize
15742 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15743 intrinsics.
15745 @item -mprefer-avx128
15746 @opindex mprefer-avx128
15747 This option instructs GCC to use 128-bit AVX instructions instead of
15748 256-bit AVX instructions in the auto-vectorizer.
15750 @item -mcx16
15751 @opindex mcx16
15752 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15753 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15754 (or oword) data types.  
15755 This is useful for high-resolution counters that can be updated
15756 by multiple processors (or cores).  This instruction is generated as part of
15757 atomic built-in functions: see @ref{__sync Builtins} or
15758 @ref{__atomic Builtins} for details.
15760 @item -msahf
15761 @opindex msahf
15762 This option enables generation of @code{SAHF} instructions in 64-bit code.
15763 Early Intel Pentium 4 CPUs with Intel 64 support,
15764 prior to the introduction of Pentium 4 G1 step in December 2005,
15765 lacked the @code{LAHF} and @code{SAHF} instructions
15766 which were supported by AMD64.
15767 These are load and store instructions, respectively, for certain status flags.
15768 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15769 @code{drem}, and @code{remainder} built-in functions;
15770 see @ref{Other Builtins} for details.
15772 @item -mmovbe
15773 @opindex mmovbe
15774 This option enables use of the @code{movbe} instruction to implement
15775 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15777 @item -mcrc32
15778 @opindex mcrc32
15779 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15780 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15781 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15783 @item -mrecip
15784 @opindex mrecip
15785 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
15786 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
15787 with an additional Newton-Raphson step
15788 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
15789 (and their vectorized
15790 variants) for single-precision floating-point arguments.  These instructions
15791 are generated only when @option{-funsafe-math-optimizations} is enabled
15792 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
15793 Note that while the throughput of the sequence is higher than the throughput
15794 of the non-reciprocal instruction, the precision of the sequence can be
15795 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
15797 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
15798 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
15799 combination), and doesn't need @option{-mrecip}.
15801 Also note that GCC emits the above sequence with additional Newton-Raphson step
15802 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
15803 already with @option{-ffast-math} (or the above option combination), and
15804 doesn't need @option{-mrecip}.
15806 @item -mrecip=@var{opt}
15807 @opindex mrecip=opt
15808 This option controls which reciprocal estimate instructions
15809 may be used.  @var{opt} is a comma-separated list of options, which may
15810 be preceded by a @samp{!} to invert the option:
15812 @table @samp
15813 @item all
15814 Enable all estimate instructions.
15816 @item default
15817 Enable the default instructions, equivalent to @option{-mrecip}.
15819 @item none
15820 Disable all estimate instructions, equivalent to @option{-mno-recip}.
15822 @item div
15823 Enable the approximation for scalar division.
15825 @item vec-div
15826 Enable the approximation for vectorized division.
15828 @item sqrt
15829 Enable the approximation for scalar square root.
15831 @item vec-sqrt
15832 Enable the approximation for vectorized square root.
15833 @end table
15835 So, for example, @option{-mrecip=all,!sqrt} enables
15836 all of the reciprocal approximations, except for square root.
15838 @item -mveclibabi=@var{type}
15839 @opindex mveclibabi
15840 Specifies the ABI type to use for vectorizing intrinsics using an
15841 external library.  Supported values for @var{type} are @samp{svml} 
15842 for the Intel short
15843 vector math library and @samp{acml} for the AMD math core library.
15844 To use this option, both @option{-ftree-vectorize} and
15845 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
15846 ABI-compatible library must be specified at link time.
15848 GCC currently emits calls to @code{vmldExp2},
15849 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
15850 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
15851 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
15852 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
15853 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
15854 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
15855 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
15856 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
15857 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
15858 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
15859 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
15860 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
15861 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
15862 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
15863 when @option{-mveclibabi=acml} is used.  
15865 @item -mabi=@var{name}
15866 @opindex mabi
15867 Generate code for the specified calling convention.  Permissible values
15868 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
15869 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
15870 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
15871 You can control this behavior for a specific function by
15872 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
15873 @xref{Function Attributes}.
15875 @item -mtls-dialect=@var{type}
15876 @opindex mtls-dialect
15877 Generate code to access thread-local storage using the @samp{gnu} or
15878 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
15879 @samp{gnu2} is more efficient, but it may add compile- and run-time
15880 requirements that cannot be satisfied on all systems.
15882 @item -mpush-args
15883 @itemx -mno-push-args
15884 @opindex mpush-args
15885 @opindex mno-push-args
15886 Use PUSH operations to store outgoing parameters.  This method is shorter
15887 and usually equally fast as method using SUB/MOV operations and is enabled
15888 by default.  In some cases disabling it may improve performance because of
15889 improved scheduling and reduced dependencies.
15891 @item -maccumulate-outgoing-args
15892 @opindex maccumulate-outgoing-args
15893 If enabled, the maximum amount of space required for outgoing arguments is
15894 computed in the function prologue.  This is faster on most modern CPUs
15895 because of reduced dependencies, improved scheduling and reduced stack usage
15896 when the preferred stack boundary is not equal to 2.  The drawback is a notable
15897 increase in code size.  This switch implies @option{-mno-push-args}.
15899 @item -mthreads
15900 @opindex mthreads
15901 Support thread-safe exception handling on MinGW.  Programs that rely
15902 on thread-safe exception handling must compile and link all code with the
15903 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
15904 @code{-D_MT}; when linking, it links in a special thread helper library
15905 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
15907 @item -mno-align-stringops
15908 @opindex mno-align-stringops
15909 Do not align the destination of inlined string operations.  This switch reduces
15910 code size and improves performance in case the destination is already aligned,
15911 but GCC doesn't know about it.
15913 @item -minline-all-stringops
15914 @opindex minline-all-stringops
15915 By default GCC inlines string operations only when the destination is 
15916 known to be aligned to least a 4-byte boundary.  
15917 This enables more inlining and increases code
15918 size, but may improve performance of code that depends on fast
15919 @code{memcpy}, @code{strlen},
15920 and @code{memset} for short lengths.
15922 @item -minline-stringops-dynamically
15923 @opindex minline-stringops-dynamically
15924 For string operations of unknown size, use run-time checks with
15925 inline code for small blocks and a library call for large blocks.
15927 @item -mstringop-strategy=@var{alg}
15928 @opindex mstringop-strategy=@var{alg}
15929 Override the internal decision heuristic for the particular algorithm to use
15930 for inlining string operations.  The allowed values for @var{alg} are:
15932 @table @samp
15933 @item rep_byte
15934 @itemx rep_4byte
15935 @itemx rep_8byte
15936 Expand using i386 @code{rep} prefix of the specified size.
15938 @item byte_loop
15939 @itemx loop
15940 @itemx unrolled_loop
15941 Expand into an inline loop.
15943 @item libcall
15944 Always use a library call.
15945 @end table
15947 @item -mmemcpy-strategy=@var{strategy}
15948 @opindex mmemcpy-strategy=@var{strategy}
15949 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
15950 should be inlined and what inline algorithm to use when the expected size
15951 of the copy operation is known. @var{strategy} 
15952 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
15953 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
15954 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
15955 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
15956 in the list must be specified in increasing order.  The minimal byte size for 
15957 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
15958 preceding range.
15960 @item -mmemset-strategy=@var{strategy}
15961 @opindex mmemset-strategy=@var{strategy}
15962 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
15963 @code{__builtin_memset} expansion.
15965 @item -momit-leaf-frame-pointer
15966 @opindex momit-leaf-frame-pointer
15967 Don't keep the frame pointer in a register for leaf functions.  This
15968 avoids the instructions to save, set up, and restore frame pointers and
15969 makes an extra register available in leaf functions.  The option
15970 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
15971 which might make debugging harder.
15973 @item -mtls-direct-seg-refs
15974 @itemx -mno-tls-direct-seg-refs
15975 @opindex mtls-direct-seg-refs
15976 Controls whether TLS variables may be accessed with offsets from the
15977 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
15978 or whether the thread base pointer must be added.  Whether or not this
15979 is valid depends on the operating system, and whether it maps the
15980 segment to cover the entire TLS area.
15982 For systems that use the GNU C Library, the default is on.
15984 @item -msse2avx
15985 @itemx -mno-sse2avx
15986 @opindex msse2avx
15987 Specify that the assembler should encode SSE instructions with VEX
15988 prefix.  The option @option{-mavx} turns this on by default.
15990 @item -mfentry
15991 @itemx -mno-fentry
15992 @opindex mfentry
15993 If profiling is active (@option{-pg}), put the profiling
15994 counter call before the prologue.
15995 Note: On x86 architectures the attribute @code{ms_hook_prologue}
15996 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
15998 @item -mrecord-mcount
15999 @itemx -mno-record-mcount
16000 @opindex mrecord-mcount
16001 If profiling is active (@option{-pg}), generate a __mcount_loc section
16002 that contains pointers to each profiling call. This is useful for
16003 automatically patching and out calls.
16005 @item -mnop-mcount
16006 @itemx -mno-nop-mcount
16007 @opindex mnop-mcount
16008 If profiling is active (@option{-pg}), generate the calls to
16009 the profiling functions as nops. This is useful when they
16010 should be patched in later dynamically. This is likely only
16011 useful together with @option{-mrecord-mcount}.
16013 @item -m8bit-idiv
16014 @itemx -mno-8bit-idiv
16015 @opindex 8bit-idiv
16016 On some processors, like Intel Atom, 8-bit unsigned integer divide is
16017 much faster than 32-bit/64-bit integer divide.  This option generates a
16018 run-time check.  If both dividend and divisor are within range of 0
16019 to 255, 8-bit unsigned integer divide is used instead of
16020 32-bit/64-bit integer divide.
16022 @item -mavx256-split-unaligned-load
16023 @itemx -mavx256-split-unaligned-store
16024 @opindex avx256-split-unaligned-load
16025 @opindex avx256-split-unaligned-store
16026 Split 32-byte AVX unaligned load and store.
16028 @item -mstack-protector-guard=@var{guard}
16029 @opindex mstack-protector-guard=@var{guard}
16030 Generate stack protection code using canary at @var{guard}.  Supported
16031 locations are @samp{global} for global canary or @samp{tls} for per-thread
16032 canary in the TLS block (the default).  This option has effect only when
16033 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
16035 @end table
16037 These @samp{-m} switches are supported in addition to the above
16038 on x86-64 processors in 64-bit environments.
16040 @table @gcctabopt
16041 @item -m32
16042 @itemx -m64
16043 @itemx -mx32
16044 @itemx -m16
16045 @opindex m32
16046 @opindex m64
16047 @opindex mx32
16048 @opindex m16
16049 Generate code for a 16-bit, 32-bit or 64-bit environment.
16050 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
16051 to 32 bits, and
16052 generates code that runs on any i386 system.
16054 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
16055 types to 64 bits, and generates code for the x86-64 architecture.
16056 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
16057 and @option{-mdynamic-no-pic} options.
16059 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
16060 to 32 bits, and
16061 generates code for the x86-64 architecture.
16063 The @option{-m16} option is the same as @option{-m32}, except for that
16064 it outputs the @code{.code16gcc} assembly directive at the beginning of
16065 the assembly output so that the binary can run in 16-bit mode.
16067 @item -mno-red-zone
16068 @opindex mno-red-zone
16069 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
16070 by the x86-64 ABI; it is a 128-byte area beyond the location of the
16071 stack pointer that is not modified by signal or interrupt handlers
16072 and therefore can be used for temporary data without adjusting the stack
16073 pointer.  The flag @option{-mno-red-zone} disables this red zone.
16075 @item -mcmodel=small
16076 @opindex mcmodel=small
16077 Generate code for the small code model: the program and its symbols must
16078 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
16079 Programs can be statically or dynamically linked.  This is the default
16080 code model.
16082 @item -mcmodel=kernel
16083 @opindex mcmodel=kernel
16084 Generate code for the kernel code model.  The kernel runs in the
16085 negative 2 GB of the address space.
16086 This model has to be used for Linux kernel code.
16088 @item -mcmodel=medium
16089 @opindex mcmodel=medium
16090 Generate code for the medium model: the program is linked in the lower 2
16091 GB of the address space.  Small symbols are also placed there.  Symbols
16092 with sizes larger than @option{-mlarge-data-threshold} are put into
16093 large data or BSS sections and can be located above 2GB.  Programs can
16094 be statically or dynamically linked.
16096 @item -mcmodel=large
16097 @opindex mcmodel=large
16098 Generate code for the large model.  This model makes no assumptions
16099 about addresses and sizes of sections.
16101 @item -maddress-mode=long
16102 @opindex maddress-mode=long
16103 Generate code for long address mode.  This is only supported for 64-bit
16104 and x32 environments.  It is the default address mode for 64-bit
16105 environments.
16107 @item -maddress-mode=short
16108 @opindex maddress-mode=short
16109 Generate code for short address mode.  This is only supported for 32-bit
16110 and x32 environments.  It is the default address mode for 32-bit and
16111 x32 environments.
16112 @end table
16114 @node i386 and x86-64 Windows Options
16115 @subsection i386 and x86-64 Windows Options
16116 @cindex i386 and x86-64 Windows Options
16118 These additional options are available for Microsoft Windows targets:
16120 @table @gcctabopt
16121 @item -mconsole
16122 @opindex mconsole
16123 This option
16124 specifies that a console application is to be generated, by
16125 instructing the linker to set the PE header subsystem type
16126 required for console applications.
16127 This option is available for Cygwin and MinGW targets and is
16128 enabled by default on those targets.
16130 @item -mdll
16131 @opindex mdll
16132 This option is available for Cygwin and MinGW targets.  It
16133 specifies that a DLL---a dynamic link library---is to be
16134 generated, enabling the selection of the required runtime
16135 startup object and entry point.
16137 @item -mnop-fun-dllimport
16138 @opindex mnop-fun-dllimport
16139 This option is available for Cygwin and MinGW targets.  It
16140 specifies that the @code{dllimport} attribute should be ignored.
16142 @item -mthread
16143 @opindex mthread
16144 This option is available for MinGW targets. It specifies
16145 that MinGW-specific thread support is to be used.
16147 @item -municode
16148 @opindex municode
16149 This option is available for MinGW-w64 targets.  It causes
16150 the @code{UNICODE} preprocessor macro to be predefined, and
16151 chooses Unicode-capable runtime startup code.
16153 @item -mwin32
16154 @opindex mwin32
16155 This option is available for Cygwin and MinGW targets.  It
16156 specifies that the typical Microsoft Windows predefined macros are to
16157 be set in the pre-processor, but does not influence the choice
16158 of runtime library/startup code.
16160 @item -mwindows
16161 @opindex mwindows
16162 This option is available for Cygwin and MinGW targets.  It
16163 specifies that a GUI application is to be generated by
16164 instructing the linker to set the PE header subsystem type
16165 appropriately.
16167 @item -fno-set-stack-executable
16168 @opindex fno-set-stack-executable
16169 This option is available for MinGW targets. It specifies that
16170 the executable flag for the stack used by nested functions isn't
16171 set. This is necessary for binaries running in kernel mode of
16172 Microsoft Windows, as there the User32 API, which is used to set executable
16173 privileges, isn't available.
16175 @item -fwritable-relocated-rdata
16176 @opindex fno-writable-relocated-rdata
16177 This option is available for MinGW and Cygwin targets.  It specifies
16178 that relocated-data in read-only section is put into .data
16179 section.  This is a necessary for older runtimes not supporting
16180 modification of .rdata sections for pseudo-relocation.
16182 @item -mpe-aligned-commons
16183 @opindex mpe-aligned-commons
16184 This option is available for Cygwin and MinGW targets.  It
16185 specifies that the GNU extension to the PE file format that
16186 permits the correct alignment of COMMON variables should be
16187 used when generating code.  It is enabled by default if
16188 GCC detects that the target assembler found during configuration
16189 supports the feature.
16190 @end table
16192 See also under @ref{i386 and x86-64 Options} for standard options.
16194 @node IA-64 Options
16195 @subsection IA-64 Options
16196 @cindex IA-64 Options
16198 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16200 @table @gcctabopt
16201 @item -mbig-endian
16202 @opindex mbig-endian
16203 Generate code for a big-endian target.  This is the default for HP-UX@.
16205 @item -mlittle-endian
16206 @opindex mlittle-endian
16207 Generate code for a little-endian target.  This is the default for AIX5
16208 and GNU/Linux.
16210 @item -mgnu-as
16211 @itemx -mno-gnu-as
16212 @opindex mgnu-as
16213 @opindex mno-gnu-as
16214 Generate (or don't) code for the GNU assembler.  This is the default.
16215 @c Also, this is the default if the configure option @option{--with-gnu-as}
16216 @c is used.
16218 @item -mgnu-ld
16219 @itemx -mno-gnu-ld
16220 @opindex mgnu-ld
16221 @opindex mno-gnu-ld
16222 Generate (or don't) code for the GNU linker.  This is the default.
16223 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16224 @c is used.
16226 @item -mno-pic
16227 @opindex mno-pic
16228 Generate code that does not use a global pointer register.  The result
16229 is not position independent code, and violates the IA-64 ABI@.
16231 @item -mvolatile-asm-stop
16232 @itemx -mno-volatile-asm-stop
16233 @opindex mvolatile-asm-stop
16234 @opindex mno-volatile-asm-stop
16235 Generate (or don't) a stop bit immediately before and after volatile asm
16236 statements.
16238 @item -mregister-names
16239 @itemx -mno-register-names
16240 @opindex mregister-names
16241 @opindex mno-register-names
16242 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16243 the stacked registers.  This may make assembler output more readable.
16245 @item -mno-sdata
16246 @itemx -msdata
16247 @opindex mno-sdata
16248 @opindex msdata
16249 Disable (or enable) optimizations that use the small data section.  This may
16250 be useful for working around optimizer bugs.
16252 @item -mconstant-gp
16253 @opindex mconstant-gp
16254 Generate code that uses a single constant global pointer value.  This is
16255 useful when compiling kernel code.
16257 @item -mauto-pic
16258 @opindex mauto-pic
16259 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16260 This is useful when compiling firmware code.
16262 @item -minline-float-divide-min-latency
16263 @opindex minline-float-divide-min-latency
16264 Generate code for inline divides of floating-point values
16265 using the minimum latency algorithm.
16267 @item -minline-float-divide-max-throughput
16268 @opindex minline-float-divide-max-throughput
16269 Generate code for inline divides of floating-point values
16270 using the maximum throughput algorithm.
16272 @item -mno-inline-float-divide
16273 @opindex mno-inline-float-divide
16274 Do not generate inline code for divides of floating-point values.
16276 @item -minline-int-divide-min-latency
16277 @opindex minline-int-divide-min-latency
16278 Generate code for inline divides of integer values
16279 using the minimum latency algorithm.
16281 @item -minline-int-divide-max-throughput
16282 @opindex minline-int-divide-max-throughput
16283 Generate code for inline divides of integer values
16284 using the maximum throughput algorithm.
16286 @item -mno-inline-int-divide
16287 @opindex mno-inline-int-divide
16288 Do not generate inline code for divides of integer values.
16290 @item -minline-sqrt-min-latency
16291 @opindex minline-sqrt-min-latency
16292 Generate code for inline square roots
16293 using the minimum latency algorithm.
16295 @item -minline-sqrt-max-throughput
16296 @opindex minline-sqrt-max-throughput
16297 Generate code for inline square roots
16298 using the maximum throughput algorithm.
16300 @item -mno-inline-sqrt
16301 @opindex mno-inline-sqrt
16302 Do not generate inline code for @code{sqrt}.
16304 @item -mfused-madd
16305 @itemx -mno-fused-madd
16306 @opindex mfused-madd
16307 @opindex mno-fused-madd
16308 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16309 instructions.  The default is to use these instructions.
16311 @item -mno-dwarf2-asm
16312 @itemx -mdwarf2-asm
16313 @opindex mno-dwarf2-asm
16314 @opindex mdwarf2-asm
16315 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16316 info.  This may be useful when not using the GNU assembler.
16318 @item -mearly-stop-bits
16319 @itemx -mno-early-stop-bits
16320 @opindex mearly-stop-bits
16321 @opindex mno-early-stop-bits
16322 Allow stop bits to be placed earlier than immediately preceding the
16323 instruction that triggered the stop bit.  This can improve instruction
16324 scheduling, but does not always do so.
16326 @item -mfixed-range=@var{register-range}
16327 @opindex mfixed-range
16328 Generate code treating the given register range as fixed registers.
16329 A fixed register is one that the register allocator cannot use.  This is
16330 useful when compiling kernel code.  A register range is specified as
16331 two registers separated by a dash.  Multiple register ranges can be
16332 specified separated by a comma.
16334 @item -mtls-size=@var{tls-size}
16335 @opindex mtls-size
16336 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16339 @item -mtune=@var{cpu-type}
16340 @opindex mtune
16341 Tune the instruction scheduling for a particular CPU, Valid values are
16342 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16343 and @samp{mckinley}.
16345 @item -milp32
16346 @itemx -mlp64
16347 @opindex milp32
16348 @opindex mlp64
16349 Generate code for a 32-bit or 64-bit environment.
16350 The 32-bit environment sets int, long and pointer to 32 bits.
16351 The 64-bit environment sets int to 32 bits and long and pointer
16352 to 64 bits.  These are HP-UX specific flags.
16354 @item -mno-sched-br-data-spec
16355 @itemx -msched-br-data-spec
16356 @opindex mno-sched-br-data-spec
16357 @opindex msched-br-data-spec
16358 (Dis/En)able data speculative scheduling before reload.
16359 This results in generation of @code{ld.a} instructions and
16360 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16361 The default is 'disable'.
16363 @item -msched-ar-data-spec
16364 @itemx -mno-sched-ar-data-spec
16365 @opindex msched-ar-data-spec
16366 @opindex mno-sched-ar-data-spec
16367 (En/Dis)able data speculative scheduling after reload.
16368 This results in generation of @code{ld.a} instructions and
16369 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16370 The default is 'enable'.
16372 @item -mno-sched-control-spec
16373 @itemx -msched-control-spec
16374 @opindex mno-sched-control-spec
16375 @opindex msched-control-spec
16376 (Dis/En)able control speculative scheduling.  This feature is
16377 available only during region scheduling (i.e.@: before reload).
16378 This results in generation of the @code{ld.s} instructions and
16379 the corresponding check instructions @code{chk.s}.
16380 The default is 'disable'.
16382 @item -msched-br-in-data-spec
16383 @itemx -mno-sched-br-in-data-spec
16384 @opindex msched-br-in-data-spec
16385 @opindex mno-sched-br-in-data-spec
16386 (En/Dis)able speculative scheduling of the instructions that
16387 are dependent on the data speculative loads before reload.
16388 This is effective only with @option{-msched-br-data-spec} enabled.
16389 The default is 'enable'.
16391 @item -msched-ar-in-data-spec
16392 @itemx -mno-sched-ar-in-data-spec
16393 @opindex msched-ar-in-data-spec
16394 @opindex mno-sched-ar-in-data-spec
16395 (En/Dis)able speculative scheduling of the instructions that
16396 are dependent on the data speculative loads after reload.
16397 This is effective only with @option{-msched-ar-data-spec} enabled.
16398 The default is 'enable'.
16400 @item -msched-in-control-spec
16401 @itemx -mno-sched-in-control-spec
16402 @opindex msched-in-control-spec
16403 @opindex mno-sched-in-control-spec
16404 (En/Dis)able speculative scheduling of the instructions that
16405 are dependent on the control speculative loads.
16406 This is effective only with @option{-msched-control-spec} enabled.
16407 The default is 'enable'.
16409 @item -mno-sched-prefer-non-data-spec-insns
16410 @itemx -msched-prefer-non-data-spec-insns
16411 @opindex mno-sched-prefer-non-data-spec-insns
16412 @opindex msched-prefer-non-data-spec-insns
16413 If enabled, data-speculative instructions are chosen for schedule
16414 only if there are no other choices at the moment.  This makes
16415 the use of the data speculation much more conservative.
16416 The default is 'disable'.
16418 @item -mno-sched-prefer-non-control-spec-insns
16419 @itemx -msched-prefer-non-control-spec-insns
16420 @opindex mno-sched-prefer-non-control-spec-insns
16421 @opindex msched-prefer-non-control-spec-insns
16422 If enabled, control-speculative instructions are chosen for schedule
16423 only if there are no other choices at the moment.  This makes
16424 the use of the control speculation much more conservative.
16425 The default is 'disable'.
16427 @item -mno-sched-count-spec-in-critical-path
16428 @itemx -msched-count-spec-in-critical-path
16429 @opindex mno-sched-count-spec-in-critical-path
16430 @opindex msched-count-spec-in-critical-path
16431 If enabled, speculative dependencies are considered during
16432 computation of the instructions priorities.  This makes the use of the
16433 speculation a bit more conservative.
16434 The default is 'disable'.
16436 @item -msched-spec-ldc
16437 @opindex msched-spec-ldc
16438 Use a simple data speculation check.  This option is on by default.
16440 @item -msched-control-spec-ldc
16441 @opindex msched-spec-ldc
16442 Use a simple check for control speculation.  This option is on by default.
16444 @item -msched-stop-bits-after-every-cycle
16445 @opindex msched-stop-bits-after-every-cycle
16446 Place a stop bit after every cycle when scheduling.  This option is on
16447 by default.
16449 @item -msched-fp-mem-deps-zero-cost
16450 @opindex msched-fp-mem-deps-zero-cost
16451 Assume that floating-point stores and loads are not likely to cause a conflict
16452 when placed into the same instruction group.  This option is disabled by
16453 default.
16455 @item -msel-sched-dont-check-control-spec
16456 @opindex msel-sched-dont-check-control-spec
16457 Generate checks for control speculation in selective scheduling.
16458 This flag is disabled by default.
16460 @item -msched-max-memory-insns=@var{max-insns}
16461 @opindex msched-max-memory-insns
16462 Limit on the number of memory insns per instruction group, giving lower
16463 priority to subsequent memory insns attempting to schedule in the same
16464 instruction group. Frequently useful to prevent cache bank conflicts.
16465 The default value is 1.
16467 @item -msched-max-memory-insns-hard-limit
16468 @opindex msched-max-memory-insns-hard-limit
16469 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16470 disallowing more than that number in an instruction group.
16471 Otherwise, the limit is ``soft'', meaning that non-memory operations
16472 are preferred when the limit is reached, but memory operations may still
16473 be scheduled.
16475 @end table
16477 @node LM32 Options
16478 @subsection LM32 Options
16479 @cindex LM32 options
16481 These @option{-m} options are defined for the LatticeMico32 architecture:
16483 @table @gcctabopt
16484 @item -mbarrel-shift-enabled
16485 @opindex mbarrel-shift-enabled
16486 Enable barrel-shift instructions.
16488 @item -mdivide-enabled
16489 @opindex mdivide-enabled
16490 Enable divide and modulus instructions.
16492 @item -mmultiply-enabled
16493 @opindex multiply-enabled
16494 Enable multiply instructions.
16496 @item -msign-extend-enabled
16497 @opindex msign-extend-enabled
16498 Enable sign extend instructions.
16500 @item -muser-enabled
16501 @opindex muser-enabled
16502 Enable user-defined instructions.
16504 @end table
16506 @node M32C Options
16507 @subsection M32C Options
16508 @cindex M32C options
16510 @table @gcctabopt
16511 @item -mcpu=@var{name}
16512 @opindex mcpu=
16513 Select the CPU for which code is generated.  @var{name} may be one of
16514 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16515 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16516 the M32C/80 series.
16518 @item -msim
16519 @opindex msim
16520 Specifies that the program will be run on the simulator.  This causes
16521 an alternate runtime library to be linked in which supports, for
16522 example, file I/O@.  You must not use this option when generating
16523 programs that will run on real hardware; you must provide your own
16524 runtime library for whatever I/O functions are needed.
16526 @item -memregs=@var{number}
16527 @opindex memregs=
16528 Specifies the number of memory-based pseudo-registers GCC uses
16529 during code generation.  These pseudo-registers are used like real
16530 registers, so there is a tradeoff between GCC's ability to fit the
16531 code into available registers, and the performance penalty of using
16532 memory instead of registers.  Note that all modules in a program must
16533 be compiled with the same value for this option.  Because of that, you
16534 must not use this option with GCC's default runtime libraries.
16536 @end table
16538 @node M32R/D Options
16539 @subsection M32R/D Options
16540 @cindex M32R/D options
16542 These @option{-m} options are defined for Renesas M32R/D architectures:
16544 @table @gcctabopt
16545 @item -m32r2
16546 @opindex m32r2
16547 Generate code for the M32R/2@.
16549 @item -m32rx
16550 @opindex m32rx
16551 Generate code for the M32R/X@.
16553 @item -m32r
16554 @opindex m32r
16555 Generate code for the M32R@.  This is the default.
16557 @item -mmodel=small
16558 @opindex mmodel=small
16559 Assume all objects live in the lower 16MB of memory (so that their addresses
16560 can be loaded with the @code{ld24} instruction), and assume all subroutines
16561 are reachable with the @code{bl} instruction.
16562 This is the default.
16564 The addressability of a particular object can be set with the
16565 @code{model} attribute.
16567 @item -mmodel=medium
16568 @opindex mmodel=medium
16569 Assume objects may be anywhere in the 32-bit address space (the compiler
16570 generates @code{seth/add3} instructions to load their addresses), and
16571 assume all subroutines are reachable with the @code{bl} instruction.
16573 @item -mmodel=large
16574 @opindex mmodel=large
16575 Assume objects may be anywhere in the 32-bit address space (the compiler
16576 generates @code{seth/add3} instructions to load their addresses), and
16577 assume subroutines may not be reachable with the @code{bl} instruction
16578 (the compiler generates the much slower @code{seth/add3/jl}
16579 instruction sequence).
16581 @item -msdata=none
16582 @opindex msdata=none
16583 Disable use of the small data area.  Variables are put into
16584 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16585 @code{section} attribute has been specified).
16586 This is the default.
16588 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16589 Objects may be explicitly put in the small data area with the
16590 @code{section} attribute using one of these sections.
16592 @item -msdata=sdata
16593 @opindex msdata=sdata
16594 Put small global and static data in the small data area, but do not
16595 generate special code to reference them.
16597 @item -msdata=use
16598 @opindex msdata=use
16599 Put small global and static data in the small data area, and generate
16600 special instructions to reference them.
16602 @item -G @var{num}
16603 @opindex G
16604 @cindex smaller data references
16605 Put global and static objects less than or equal to @var{num} bytes
16606 into the small data or BSS sections instead of the normal data or BSS
16607 sections.  The default value of @var{num} is 8.
16608 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16609 for this option to have any effect.
16611 All modules should be compiled with the same @option{-G @var{num}} value.
16612 Compiling with different values of @var{num} may or may not work; if it
16613 doesn't the linker gives an error message---incorrect code is not
16614 generated.
16616 @item -mdebug
16617 @opindex mdebug
16618 Makes the M32R-specific code in the compiler display some statistics
16619 that might help in debugging programs.
16621 @item -malign-loops
16622 @opindex malign-loops
16623 Align all loops to a 32-byte boundary.
16625 @item -mno-align-loops
16626 @opindex mno-align-loops
16627 Do not enforce a 32-byte alignment for loops.  This is the default.
16629 @item -missue-rate=@var{number}
16630 @opindex missue-rate=@var{number}
16631 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16632 or 2.
16634 @item -mbranch-cost=@var{number}
16635 @opindex mbranch-cost=@var{number}
16636 @var{number} can only be 1 or 2.  If it is 1 then branches are
16637 preferred over conditional code, if it is 2, then the opposite applies.
16639 @item -mflush-trap=@var{number}
16640 @opindex mflush-trap=@var{number}
16641 Specifies the trap number to use to flush the cache.  The default is
16642 12.  Valid numbers are between 0 and 15 inclusive.
16644 @item -mno-flush-trap
16645 @opindex mno-flush-trap
16646 Specifies that the cache cannot be flushed by using a trap.
16648 @item -mflush-func=@var{name}
16649 @opindex mflush-func=@var{name}
16650 Specifies the name of the operating system function to call to flush
16651 the cache.  The default is @emph{_flush_cache}, but a function call
16652 is only used if a trap is not available.
16654 @item -mno-flush-func
16655 @opindex mno-flush-func
16656 Indicates that there is no OS function for flushing the cache.
16658 @end table
16660 @node M680x0 Options
16661 @subsection M680x0 Options
16662 @cindex M680x0 options
16664 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16665 The default settings depend on which architecture was selected when
16666 the compiler was configured; the defaults for the most common choices
16667 are given below.
16669 @table @gcctabopt
16670 @item -march=@var{arch}
16671 @opindex march
16672 Generate code for a specific M680x0 or ColdFire instruction set
16673 architecture.  Permissible values of @var{arch} for M680x0
16674 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16675 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16676 architectures are selected according to Freescale's ISA classification
16677 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16678 @samp{isab} and @samp{isac}.
16680 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16681 code for a ColdFire target.  The @var{arch} in this macro is one of the
16682 @option{-march} arguments given above.
16684 When used together, @option{-march} and @option{-mtune} select code
16685 that runs on a family of similar processors but that is optimized
16686 for a particular microarchitecture.
16688 @item -mcpu=@var{cpu}
16689 @opindex mcpu
16690 Generate code for a specific M680x0 or ColdFire processor.
16691 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16692 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16693 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16694 below, which also classifies the CPUs into families:
16696 @multitable @columnfractions 0.20 0.80
16697 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16698 @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}
16699 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16700 @item @samp{5206e} @tab @samp{5206e}
16701 @item @samp{5208} @tab @samp{5207} @samp{5208}
16702 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16703 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16704 @item @samp{5216} @tab @samp{5214} @samp{5216}
16705 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16706 @item @samp{5225} @tab @samp{5224} @samp{5225}
16707 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16708 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16709 @item @samp{5249} @tab @samp{5249}
16710 @item @samp{5250} @tab @samp{5250}
16711 @item @samp{5271} @tab @samp{5270} @samp{5271}
16712 @item @samp{5272} @tab @samp{5272}
16713 @item @samp{5275} @tab @samp{5274} @samp{5275}
16714 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16715 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16716 @item @samp{5307} @tab @samp{5307}
16717 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16718 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16719 @item @samp{5407} @tab @samp{5407}
16720 @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}
16721 @end multitable
16723 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16724 @var{arch} is compatible with @var{cpu}.  Other combinations of
16725 @option{-mcpu} and @option{-march} are rejected.
16727 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16728 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16729 where the value of @var{family} is given by the table above.
16731 @item -mtune=@var{tune}
16732 @opindex mtune
16733 Tune the code for a particular microarchitecture within the
16734 constraints set by @option{-march} and @option{-mcpu}.
16735 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16736 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16737 and @samp{cpu32}.  The ColdFire microarchitectures
16738 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16740 You can also use @option{-mtune=68020-40} for code that needs
16741 to run relatively well on 68020, 68030 and 68040 targets.
16742 @option{-mtune=68020-60} is similar but includes 68060 targets
16743 as well.  These two options select the same tuning decisions as
16744 @option{-m68020-40} and @option{-m68020-60} respectively.
16746 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16747 when tuning for 680x0 architecture @var{arch}.  It also defines
16748 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16749 option is used.  If GCC is tuning for a range of architectures,
16750 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16751 it defines the macros for every architecture in the range.
16753 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16754 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16755 of the arguments given above.
16757 @item -m68000
16758 @itemx -mc68000
16759 @opindex m68000
16760 @opindex mc68000
16761 Generate output for a 68000.  This is the default
16762 when the compiler is configured for 68000-based systems.
16763 It is equivalent to @option{-march=68000}.
16765 Use this option for microcontrollers with a 68000 or EC000 core,
16766 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16768 @item -m68010
16769 @opindex m68010
16770 Generate output for a 68010.  This is the default
16771 when the compiler is configured for 68010-based systems.
16772 It is equivalent to @option{-march=68010}.
16774 @item -m68020
16775 @itemx -mc68020
16776 @opindex m68020
16777 @opindex mc68020
16778 Generate output for a 68020.  This is the default
16779 when the compiler is configured for 68020-based systems.
16780 It is equivalent to @option{-march=68020}.
16782 @item -m68030
16783 @opindex m68030
16784 Generate output for a 68030.  This is the default when the compiler is
16785 configured for 68030-based systems.  It is equivalent to
16786 @option{-march=68030}.
16788 @item -m68040
16789 @opindex m68040
16790 Generate output for a 68040.  This is the default when the compiler is
16791 configured for 68040-based systems.  It is equivalent to
16792 @option{-march=68040}.
16794 This option inhibits the use of 68881/68882 instructions that have to be
16795 emulated by software on the 68040.  Use this option if your 68040 does not
16796 have code to emulate those instructions.
16798 @item -m68060
16799 @opindex m68060
16800 Generate output for a 68060.  This is the default when the compiler is
16801 configured for 68060-based systems.  It is equivalent to
16802 @option{-march=68060}.
16804 This option inhibits the use of 68020 and 68881/68882 instructions that
16805 have to be emulated by software on the 68060.  Use this option if your 68060
16806 does not have code to emulate those instructions.
16808 @item -mcpu32
16809 @opindex mcpu32
16810 Generate output for a CPU32.  This is the default
16811 when the compiler is configured for CPU32-based systems.
16812 It is equivalent to @option{-march=cpu32}.
16814 Use this option for microcontrollers with a
16815 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16816 68336, 68340, 68341, 68349 and 68360.
16818 @item -m5200
16819 @opindex m5200
16820 Generate output for a 520X ColdFire CPU@.  This is the default
16821 when the compiler is configured for 520X-based systems.
16822 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16823 in favor of that option.
16825 Use this option for microcontroller with a 5200 core, including
16826 the MCF5202, MCF5203, MCF5204 and MCF5206.
16828 @item -m5206e
16829 @opindex m5206e
16830 Generate output for a 5206e ColdFire CPU@.  The option is now
16831 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16833 @item -m528x
16834 @opindex m528x
16835 Generate output for a member of the ColdFire 528X family.
16836 The option is now deprecated in favor of the equivalent
16837 @option{-mcpu=528x}.
16839 @item -m5307
16840 @opindex m5307
16841 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16842 in favor of the equivalent @option{-mcpu=5307}.
16844 @item -m5407
16845 @opindex m5407
16846 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16847 in favor of the equivalent @option{-mcpu=5407}.
16849 @item -mcfv4e
16850 @opindex mcfv4e
16851 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16852 This includes use of hardware floating-point instructions.
16853 The option is equivalent to @option{-mcpu=547x}, and is now
16854 deprecated in favor of that option.
16856 @item -m68020-40
16857 @opindex m68020-40
16858 Generate output for a 68040, without using any of the new instructions.
16859 This results in code that can run relatively efficiently on either a
16860 68020/68881 or a 68030 or a 68040.  The generated code does use the
16861 68881 instructions that are emulated on the 68040.
16863 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16865 @item -m68020-60
16866 @opindex m68020-60
16867 Generate output for a 68060, without using any of the new instructions.
16868 This results in code that can run relatively efficiently on either a
16869 68020/68881 or a 68030 or a 68040.  The generated code does use the
16870 68881 instructions that are emulated on the 68060.
16872 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16874 @item -mhard-float
16875 @itemx -m68881
16876 @opindex mhard-float
16877 @opindex m68881
16878 Generate floating-point instructions.  This is the default for 68020
16879 and above, and for ColdFire devices that have an FPU@.  It defines the
16880 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
16881 on ColdFire targets.
16883 @item -msoft-float
16884 @opindex msoft-float
16885 Do not generate floating-point instructions; use library calls instead.
16886 This is the default for 68000, 68010, and 68832 targets.  It is also
16887 the default for ColdFire devices that have no FPU.
16889 @item -mdiv
16890 @itemx -mno-div
16891 @opindex mdiv
16892 @opindex mno-div
16893 Generate (do not generate) ColdFire hardware divide and remainder
16894 instructions.  If @option{-march} is used without @option{-mcpu},
16895 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16896 architectures.  Otherwise, the default is taken from the target CPU
16897 (either the default CPU, or the one specified by @option{-mcpu}).  For
16898 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16899 @option{-mcpu=5206e}.
16901 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
16903 @item -mshort
16904 @opindex mshort
16905 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16906 Additionally, parameters passed on the stack are also aligned to a
16907 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16909 @item -mno-short
16910 @opindex mno-short
16911 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16913 @item -mnobitfield
16914 @itemx -mno-bitfield
16915 @opindex mnobitfield
16916 @opindex mno-bitfield
16917 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16918 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16920 @item -mbitfield
16921 @opindex mbitfield
16922 Do use the bit-field instructions.  The @option{-m68020} option implies
16923 @option{-mbitfield}.  This is the default if you use a configuration
16924 designed for a 68020.
16926 @item -mrtd
16927 @opindex mrtd
16928 Use a different function-calling convention, in which functions
16929 that take a fixed number of arguments return with the @code{rtd}
16930 instruction, which pops their arguments while returning.  This
16931 saves one instruction in the caller since there is no need to pop
16932 the arguments there.
16934 This calling convention is incompatible with the one normally
16935 used on Unix, so you cannot use it if you need to call libraries
16936 compiled with the Unix compiler.
16938 Also, you must provide function prototypes for all functions that
16939 take variable numbers of arguments (including @code{printf});
16940 otherwise incorrect code is generated for calls to those
16941 functions.
16943 In addition, seriously incorrect code results if you call a
16944 function with too many arguments.  (Normally, extra arguments are
16945 harmlessly ignored.)
16947 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16948 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16950 @item -mno-rtd
16951 @opindex mno-rtd
16952 Do not use the calling conventions selected by @option{-mrtd}.
16953 This is the default.
16955 @item -malign-int
16956 @itemx -mno-align-int
16957 @opindex malign-int
16958 @opindex mno-align-int
16959 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16960 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16961 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16962 Aligning variables on 32-bit boundaries produces code that runs somewhat
16963 faster on processors with 32-bit busses at the expense of more memory.
16965 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16966 aligns structures containing the above types differently than
16967 most published application binary interface specifications for the m68k.
16969 @item -mpcrel
16970 @opindex mpcrel
16971 Use the pc-relative addressing mode of the 68000 directly, instead of
16972 using a global offset table.  At present, this option implies @option{-fpic},
16973 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16974 not presently supported with @option{-mpcrel}, though this could be supported for
16975 68020 and higher processors.
16977 @item -mno-strict-align
16978 @itemx -mstrict-align
16979 @opindex mno-strict-align
16980 @opindex mstrict-align
16981 Do not (do) assume that unaligned memory references are handled by
16982 the system.
16984 @item -msep-data
16985 Generate code that allows the data segment to be located in a different
16986 area of memory from the text segment.  This allows for execute-in-place in
16987 an environment without virtual memory management.  This option implies
16988 @option{-fPIC}.
16990 @item -mno-sep-data
16991 Generate code that assumes that the data segment follows the text segment.
16992 This is the default.
16994 @item -mid-shared-library
16995 Generate code that supports shared libraries via the library ID method.
16996 This allows for execute-in-place and shared libraries in an environment
16997 without virtual memory management.  This option implies @option{-fPIC}.
16999 @item -mno-id-shared-library
17000 Generate code that doesn't assume ID-based shared libraries are being used.
17001 This is the default.
17003 @item -mshared-library-id=n
17004 Specifies the identification number of the ID-based shared library being
17005 compiled.  Specifying a value of 0 generates more compact code; specifying
17006 other values forces the allocation of that number to the current
17007 library, but is no more space- or time-efficient than omitting this option.
17009 @item -mxgot
17010 @itemx -mno-xgot
17011 @opindex mxgot
17012 @opindex mno-xgot
17013 When generating position-independent code for ColdFire, generate code
17014 that works if the GOT has more than 8192 entries.  This code is
17015 larger and slower than code generated without this option.  On M680x0
17016 processors, this option is not needed; @option{-fPIC} suffices.
17018 GCC normally uses a single instruction to load values from the GOT@.
17019 While this is relatively efficient, it only works if the GOT
17020 is smaller than about 64k.  Anything larger causes the linker
17021 to report an error such as:
17023 @cindex relocation truncated to fit (ColdFire)
17024 @smallexample
17025 relocation truncated to fit: R_68K_GOT16O foobar
17026 @end smallexample
17028 If this happens, you should recompile your code with @option{-mxgot}.
17029 It should then work with very large GOTs.  However, code generated with
17030 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17031 the value of a global symbol.
17033 Note that some linkers, including newer versions of the GNU linker,
17034 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17035 you should only need to use @option{-mxgot} when compiling a single
17036 object file that accesses more than 8192 GOT entries.  Very few do.
17038 These options have no effect unless GCC is generating
17039 position-independent code.
17041 @end table
17043 @node MCore Options
17044 @subsection MCore Options
17045 @cindex MCore options
17047 These are the @samp{-m} options defined for the Motorola M*Core
17048 processors.
17050 @table @gcctabopt
17052 @item -mhardlit
17053 @itemx -mno-hardlit
17054 @opindex mhardlit
17055 @opindex mno-hardlit
17056 Inline constants into the code stream if it can be done in two
17057 instructions or less.
17059 @item -mdiv
17060 @itemx -mno-div
17061 @opindex mdiv
17062 @opindex mno-div
17063 Use the divide instruction.  (Enabled by default).
17065 @item -mrelax-immediate
17066 @itemx -mno-relax-immediate
17067 @opindex mrelax-immediate
17068 @opindex mno-relax-immediate
17069 Allow arbitrary-sized immediates in bit operations.
17071 @item -mwide-bitfields
17072 @itemx -mno-wide-bitfields
17073 @opindex mwide-bitfields
17074 @opindex mno-wide-bitfields
17075 Always treat bit-fields as @code{int}-sized.
17077 @item -m4byte-functions
17078 @itemx -mno-4byte-functions
17079 @opindex m4byte-functions
17080 @opindex mno-4byte-functions
17081 Force all functions to be aligned to a 4-byte boundary.
17083 @item -mcallgraph-data
17084 @itemx -mno-callgraph-data
17085 @opindex mcallgraph-data
17086 @opindex mno-callgraph-data
17087 Emit callgraph information.
17089 @item -mslow-bytes
17090 @itemx -mno-slow-bytes
17091 @opindex mslow-bytes
17092 @opindex mno-slow-bytes
17093 Prefer word access when reading byte quantities.
17095 @item -mlittle-endian
17096 @itemx -mbig-endian
17097 @opindex mlittle-endian
17098 @opindex mbig-endian
17099 Generate code for a little-endian target.
17101 @item -m210
17102 @itemx -m340
17103 @opindex m210
17104 @opindex m340
17105 Generate code for the 210 processor.
17107 @item -mno-lsim
17108 @opindex mno-lsim
17109 Assume that runtime support has been provided and so omit the
17110 simulator library (@file{libsim.a)} from the linker command line.
17112 @item -mstack-increment=@var{size}
17113 @opindex mstack-increment
17114 Set the maximum amount for a single stack increment operation.  Large
17115 values can increase the speed of programs that contain functions
17116 that need a large amount of stack space, but they can also trigger a
17117 segmentation fault if the stack is extended too much.  The default
17118 value is 0x1000.
17120 @end table
17122 @node MeP Options
17123 @subsection MeP Options
17124 @cindex MeP options
17126 @table @gcctabopt
17128 @item -mabsdiff
17129 @opindex mabsdiff
17130 Enables the @code{abs} instruction, which is the absolute difference
17131 between two registers.
17133 @item -mall-opts
17134 @opindex mall-opts
17135 Enables all the optional instructions---average, multiply, divide, bit
17136 operations, leading zero, absolute difference, min/max, clip, and
17137 saturation.
17140 @item -maverage
17141 @opindex maverage
17142 Enables the @code{ave} instruction, which computes the average of two
17143 registers.
17145 @item -mbased=@var{n}
17146 @opindex mbased=
17147 Variables of size @var{n} bytes or smaller are placed in the
17148 @code{.based} section by default.  Based variables use the @code{$tp}
17149 register as a base register, and there is a 128-byte limit to the
17150 @code{.based} section.
17152 @item -mbitops
17153 @opindex mbitops
17154 Enables the bit operation instructions---bit test (@code{btstm}), set
17155 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17156 test-and-set (@code{tas}).
17158 @item -mc=@var{name}
17159 @opindex mc=
17160 Selects which section constant data is placed in.  @var{name} may
17161 be @code{tiny}, @code{near}, or @code{far}.
17163 @item -mclip
17164 @opindex mclip
17165 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
17166 useful unless you also provide @code{-mminmax}.
17168 @item -mconfig=@var{name}
17169 @opindex mconfig=
17170 Selects one of the built-in core configurations.  Each MeP chip has
17171 one or more modules in it; each module has a core CPU and a variety of
17172 coprocessors, optional instructions, and peripherals.  The
17173 @code{MeP-Integrator} tool, not part of GCC, provides these
17174 configurations through this option; using this option is the same as
17175 using all the corresponding command-line options.  The default
17176 configuration is @code{default}.
17178 @item -mcop
17179 @opindex mcop
17180 Enables the coprocessor instructions.  By default, this is a 32-bit
17181 coprocessor.  Note that the coprocessor is normally enabled via the
17182 @code{-mconfig=} option.
17184 @item -mcop32
17185 @opindex mcop32
17186 Enables the 32-bit coprocessor's instructions.
17188 @item -mcop64
17189 @opindex mcop64
17190 Enables the 64-bit coprocessor's instructions.
17192 @item -mivc2
17193 @opindex mivc2
17194 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17196 @item -mdc
17197 @opindex mdc
17198 Causes constant variables to be placed in the @code{.near} section.
17200 @item -mdiv
17201 @opindex mdiv
17202 Enables the @code{div} and @code{divu} instructions.
17204 @item -meb
17205 @opindex meb
17206 Generate big-endian code.
17208 @item -mel
17209 @opindex mel
17210 Generate little-endian code.
17212 @item -mio-volatile
17213 @opindex mio-volatile
17214 Tells the compiler that any variable marked with the @code{io}
17215 attribute is to be considered volatile.
17217 @item -ml
17218 @opindex ml
17219 Causes variables to be assigned to the @code{.far} section by default.
17221 @item -mleadz
17222 @opindex mleadz
17223 Enables the @code{leadz} (leading zero) instruction.
17225 @item -mm
17226 @opindex mm
17227 Causes variables to be assigned to the @code{.near} section by default.
17229 @item -mminmax
17230 @opindex mminmax
17231 Enables the @code{min} and @code{max} instructions.
17233 @item -mmult
17234 @opindex mmult
17235 Enables the multiplication and multiply-accumulate instructions.
17237 @item -mno-opts
17238 @opindex mno-opts
17239 Disables all the optional instructions enabled by @code{-mall-opts}.
17241 @item -mrepeat
17242 @opindex mrepeat
17243 Enables the @code{repeat} and @code{erepeat} instructions, used for
17244 low-overhead looping.
17246 @item -ms
17247 @opindex ms
17248 Causes all variables to default to the @code{.tiny} section.  Note
17249 that there is a 65536-byte limit to this section.  Accesses to these
17250 variables use the @code{%gp} base register.
17252 @item -msatur
17253 @opindex msatur
17254 Enables the saturation instructions.  Note that the compiler does not
17255 currently generate these itself, but this option is included for
17256 compatibility with other tools, like @code{as}.
17258 @item -msdram
17259 @opindex msdram
17260 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17262 @item -msim
17263 @opindex msim
17264 Link the simulator run-time libraries.
17266 @item -msimnovec
17267 @opindex msimnovec
17268 Link the simulator runtime libraries, excluding built-in support
17269 for reset and exception vectors and tables.
17271 @item -mtf
17272 @opindex mtf
17273 Causes all functions to default to the @code{.far} section.  Without
17274 this option, functions default to the @code{.near} section.
17276 @item -mtiny=@var{n}
17277 @opindex mtiny=
17278 Variables that are @var{n} bytes or smaller are allocated to the
17279 @code{.tiny} section.  These variables use the @code{$gp} base
17280 register.  The default for this option is 4, but note that there's a
17281 65536-byte limit to the @code{.tiny} section.
17283 @end table
17285 @node MicroBlaze Options
17286 @subsection MicroBlaze Options
17287 @cindex MicroBlaze Options
17289 @table @gcctabopt
17291 @item -msoft-float
17292 @opindex msoft-float
17293 Use software emulation for floating point (default).
17295 @item -mhard-float
17296 @opindex mhard-float
17297 Use hardware floating-point instructions.
17299 @item -mmemcpy
17300 @opindex mmemcpy
17301 Do not optimize block moves, use @code{memcpy}.
17303 @item -mno-clearbss
17304 @opindex mno-clearbss
17305 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17307 @item -mcpu=@var{cpu-type}
17308 @opindex mcpu=
17309 Use features of, and schedule code for, the given CPU.
17310 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17311 where @var{X} is a major version, @var{YY} is the minor version, and
17312 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17313 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17315 @item -mxl-soft-mul
17316 @opindex mxl-soft-mul
17317 Use software multiply emulation (default).
17319 @item -mxl-soft-div
17320 @opindex mxl-soft-div
17321 Use software emulation for divides (default).
17323 @item -mxl-barrel-shift
17324 @opindex mxl-barrel-shift
17325 Use the hardware barrel shifter.
17327 @item -mxl-pattern-compare
17328 @opindex mxl-pattern-compare
17329 Use pattern compare instructions.
17331 @item -msmall-divides
17332 @opindex msmall-divides
17333 Use table lookup optimization for small signed integer divisions.
17335 @item -mxl-stack-check
17336 @opindex mxl-stack-check
17337 This option is deprecated.  Use @option{-fstack-check} instead.
17339 @item -mxl-gp-opt
17340 @opindex mxl-gp-opt
17341 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17343 @item -mxl-multiply-high
17344 @opindex mxl-multiply-high
17345 Use multiply high instructions for high part of 32x32 multiply.
17347 @item -mxl-float-convert
17348 @opindex mxl-float-convert
17349 Use hardware floating-point conversion instructions.
17351 @item -mxl-float-sqrt
17352 @opindex mxl-float-sqrt
17353 Use hardware floating-point square root instruction.
17355 @item -mbig-endian
17356 @opindex mbig-endian
17357 Generate code for a big-endian target.
17359 @item -mlittle-endian
17360 @opindex mlittle-endian
17361 Generate code for a little-endian target.
17363 @item -mxl-reorder
17364 @opindex mxl-reorder
17365 Use reorder instructions (swap and byte reversed load/store).
17367 @item -mxl-mode-@var{app-model}
17368 Select application model @var{app-model}.  Valid models are
17369 @table @samp
17370 @item executable
17371 normal executable (default), uses startup code @file{crt0.o}.
17373 @item xmdstub
17374 for use with Xilinx Microprocessor Debugger (XMD) based
17375 software intrusive debug agent called xmdstub. This uses startup file
17376 @file{crt1.o} and sets the start address of the program to 0x800.
17378 @item bootstrap
17379 for applications that are loaded using a bootloader.
17380 This model uses startup file @file{crt2.o} which does not contain a processor
17381 reset vector handler. This is suitable for transferring control on a
17382 processor reset to the bootloader rather than the application.
17384 @item novectors
17385 for applications that do not require any of the
17386 MicroBlaze vectors. This option may be useful for applications running
17387 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17388 @end table
17390 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17391 @option{-mxl-mode-@var{app-model}}.
17393 @end table
17395 @node MIPS Options
17396 @subsection MIPS Options
17397 @cindex MIPS options
17399 @table @gcctabopt
17401 @item -EB
17402 @opindex EB
17403 Generate big-endian code.
17405 @item -EL
17406 @opindex EL
17407 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17408 configurations.
17410 @item -march=@var{arch}
17411 @opindex march
17412 Generate code that runs on @var{arch}, which can be the name of a
17413 generic MIPS ISA, or the name of a particular processor.
17414 The ISA names are:
17415 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17416 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5}, 
17417 @samp{mips64}, @samp{mips64r2}, @samp{mips64r3} and @samp{mips64r5}.
17418 The processor names are:
17419 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17420 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17421 @samp{5kc}, @samp{5kf},
17422 @samp{20kc},
17423 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17424 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17425 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17426 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17427 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17428 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17429 @samp{m4k},
17430 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17431 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
17432 @samp{orion},
17433 @samp{p5600},
17434 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17435 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17436 @samp{rm7000}, @samp{rm9000},
17437 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17438 @samp{sb1},
17439 @samp{sr71000},
17440 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17441 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17442 @samp{xlr} and @samp{xlp}.
17443 The special value @samp{from-abi} selects the
17444 most compatible architecture for the selected ABI (that is,
17445 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17447 The native Linux/GNU toolchain also supports the value @samp{native},
17448 which selects the best architecture option for the host processor.
17449 @option{-march=native} has no effect if GCC does not recognize
17450 the processor.
17452 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17453 (for example, @option{-march=r2k}).  Prefixes are optional, and
17454 @samp{vr} may be written @samp{r}.
17456 Names of the form @samp{@var{n}f2_1} refer to processors with
17457 FPUs clocked at half the rate of the core, names of the form
17458 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17459 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17460 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17461 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17462 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17463 accepted as synonyms for @samp{@var{n}f1_1}.
17465 GCC defines two macros based on the value of this option.  The first
17466 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17467 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17468 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17469 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17470 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17472 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17473 above.  In other words, it has the full prefix and does not
17474 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17475 the macro names the resolved architecture (either @samp{"mips1"} or
17476 @samp{"mips3"}).  It names the default architecture when no
17477 @option{-march} option is given.
17479 @item -mtune=@var{arch}
17480 @opindex mtune
17481 Optimize for @var{arch}.  Among other things, this option controls
17482 the way instructions are scheduled, and the perceived cost of arithmetic
17483 operations.  The list of @var{arch} values is the same as for
17484 @option{-march}.
17486 When this option is not used, GCC optimizes for the processor
17487 specified by @option{-march}.  By using @option{-march} and
17488 @option{-mtune} together, it is possible to generate code that
17489 runs on a family of processors, but optimize the code for one
17490 particular member of that family.
17492 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17493 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17494 @option{-march} ones described above.
17496 @item -mips1
17497 @opindex mips1
17498 Equivalent to @option{-march=mips1}.
17500 @item -mips2
17501 @opindex mips2
17502 Equivalent to @option{-march=mips2}.
17504 @item -mips3
17505 @opindex mips3
17506 Equivalent to @option{-march=mips3}.
17508 @item -mips4
17509 @opindex mips4
17510 Equivalent to @option{-march=mips4}.
17512 @item -mips32
17513 @opindex mips32
17514 Equivalent to @option{-march=mips32}.
17516 @item -mips32r3
17517 @opindex mips32r3
17518 Equivalent to @option{-march=mips32r3}.
17520 @item -mips32r5
17521 @opindex mips32r5
17522 Equivalent to @option{-march=mips32r5}.
17524 @item -mips64
17525 @opindex mips64
17526 Equivalent to @option{-march=mips64}.
17528 @item -mips64r2
17529 @opindex mips64r2
17530 Equivalent to @option{-march=mips64r2}.
17532 @item -mips64r3
17533 @opindex mips64r3
17534 Equivalent to @option{-march=mips64r3}.
17536 @item -mips64r5
17537 @opindex mips64r5
17538 Equivalent to @option{-march=mips64r5}.
17540 @item -mips16
17541 @itemx -mno-mips16
17542 @opindex mips16
17543 @opindex mno-mips16
17544 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17545 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17547 MIPS16 code generation can also be controlled on a per-function basis
17548 by means of @code{mips16} and @code{nomips16} attributes.
17549 @xref{Function Attributes}, for more information.
17551 @item -mflip-mips16
17552 @opindex mflip-mips16
17553 Generate MIPS16 code on alternating functions.  This option is provided
17554 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17555 not intended for ordinary use in compiling user code.
17557 @item -minterlink-compressed
17558 @item -mno-interlink-compressed
17559 @opindex minterlink-compressed
17560 @opindex mno-interlink-compressed
17561 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17562 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17564 For example, code using the standard ISA encoding cannot jump directly
17565 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17566 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17567 knows that the target of the jump is not compressed.
17569 @item -minterlink-mips16
17570 @itemx -mno-interlink-mips16
17571 @opindex minterlink-mips16
17572 @opindex mno-interlink-mips16
17573 Aliases of @option{-minterlink-compressed} and
17574 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17575 and are retained for backwards compatibility.
17577 @item -mabi=32
17578 @itemx -mabi=o64
17579 @itemx -mabi=n32
17580 @itemx -mabi=64
17581 @itemx -mabi=eabi
17582 @opindex mabi=32
17583 @opindex mabi=o64
17584 @opindex mabi=n32
17585 @opindex mabi=64
17586 @opindex mabi=eabi
17587 Generate code for the given ABI@.
17589 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17590 generates 64-bit code when you select a 64-bit architecture, but you
17591 can use @option{-mgp32} to get 32-bit code instead.
17593 For information about the O64 ABI, see
17594 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17596 GCC supports a variant of the o32 ABI in which floating-point registers
17597 are 64 rather than 32 bits wide.  You can select this combination with
17598 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17599 and @code{mfhc1} instructions and is therefore only supported for
17600 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17602 The register assignments for arguments and return values remain the
17603 same, but each scalar value is passed in a single 64-bit register
17604 rather than a pair of 32-bit registers.  For example, scalar
17605 floating-point values are returned in @samp{$f0} only, not a
17606 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17607 remains the same, but all 64 bits are saved.
17609 @item -mabicalls
17610 @itemx -mno-abicalls
17611 @opindex mabicalls
17612 @opindex mno-abicalls
17613 Generate (do not generate) code that is suitable for SVR4-style
17614 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17615 systems.
17617 @item -mshared
17618 @itemx -mno-shared
17619 Generate (do not generate) code that is fully position-independent,
17620 and that can therefore be linked into shared libraries.  This option
17621 only affects @option{-mabicalls}.
17623 All @option{-mabicalls} code has traditionally been position-independent,
17624 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17625 as an extension, the GNU toolchain allows executables to use absolute
17626 accesses for locally-binding symbols.  It can also use shorter GP
17627 initialization sequences and generate direct calls to locally-defined
17628 functions.  This mode is selected by @option{-mno-shared}.
17630 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17631 objects that can only be linked by the GNU linker.  However, the option
17632 does not affect the ABI of the final executable; it only affects the ABI
17633 of relocatable objects.  Using @option{-mno-shared} generally makes
17634 executables both smaller and quicker.
17636 @option{-mshared} is the default.
17638 @item -mplt
17639 @itemx -mno-plt
17640 @opindex mplt
17641 @opindex mno-plt
17642 Assume (do not assume) that the static and dynamic linkers
17643 support PLTs and copy relocations.  This option only affects
17644 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17645 has no effect without @option{-msym32}.
17647 You can make @option{-mplt} the default by configuring
17648 GCC with @option{--with-mips-plt}.  The default is
17649 @option{-mno-plt} otherwise.
17651 @item -mxgot
17652 @itemx -mno-xgot
17653 @opindex mxgot
17654 @opindex mno-xgot
17655 Lift (do not lift) the usual restrictions on the size of the global
17656 offset table.
17658 GCC normally uses a single instruction to load values from the GOT@.
17659 While this is relatively efficient, it only works if the GOT
17660 is smaller than about 64k.  Anything larger causes the linker
17661 to report an error such as:
17663 @cindex relocation truncated to fit (MIPS)
17664 @smallexample
17665 relocation truncated to fit: R_MIPS_GOT16 foobar
17666 @end smallexample
17668 If this happens, you should recompile your code with @option{-mxgot}.
17669 This works with very large GOTs, although the code is also
17670 less efficient, since it takes three instructions to fetch the
17671 value of a global symbol.
17673 Note that some linkers can create multiple GOTs.  If you have such a
17674 linker, you should only need to use @option{-mxgot} when a single object
17675 file accesses more than 64k's worth of GOT entries.  Very few do.
17677 These options have no effect unless GCC is generating position
17678 independent code.
17680 @item -mgp32
17681 @opindex mgp32
17682 Assume that general-purpose registers are 32 bits wide.
17684 @item -mgp64
17685 @opindex mgp64
17686 Assume that general-purpose registers are 64 bits wide.
17688 @item -mfp32
17689 @opindex mfp32
17690 Assume that floating-point registers are 32 bits wide.
17692 @item -mfp64
17693 @opindex mfp64
17694 Assume that floating-point registers are 64 bits wide.
17696 @item -mhard-float
17697 @opindex mhard-float
17698 Use floating-point coprocessor instructions.
17700 @item -msoft-float
17701 @opindex msoft-float
17702 Do not use floating-point coprocessor instructions.  Implement
17703 floating-point calculations using library calls instead.
17705 @item -mno-float
17706 @opindex mno-float
17707 Equivalent to @option{-msoft-float}, but additionally asserts that the
17708 program being compiled does not perform any floating-point operations.
17709 This option is presently supported only by some bare-metal MIPS
17710 configurations, where it may select a special set of libraries
17711 that lack all floating-point support (including, for example, the
17712 floating-point @code{printf} formats).  
17713 If code compiled with @code{-mno-float} accidentally contains
17714 floating-point operations, it is likely to suffer a link-time
17715 or run-time failure.
17717 @item -msingle-float
17718 @opindex msingle-float
17719 Assume that the floating-point coprocessor only supports single-precision
17720 operations.
17722 @item -mdouble-float
17723 @opindex mdouble-float
17724 Assume that the floating-point coprocessor supports double-precision
17725 operations.  This is the default.
17727 @item -mabs=2008
17728 @itemx -mabs=legacy
17729 @opindex mabs=2008
17730 @opindex mabs=legacy
17731 These options control the treatment of the special not-a-number (NaN)
17732 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17733 @code{neg.@i{fmt}} machine instructions.
17735 By default or when the @option{-mabs=legacy} is used the legacy
17736 treatment is selected.  In this case these instructions are considered
17737 arithmetic and avoided where correct operation is required and the
17738 input operand might be a NaN.  A longer sequence of instructions that
17739 manipulate the sign bit of floating-point datum manually is used
17740 instead unless the @option{-ffinite-math-only} option has also been
17741 specified.
17743 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17744 this case these instructions are considered non-arithmetic and therefore
17745 operating correctly in all cases, including in particular where the
17746 input operand is a NaN.  These instructions are therefore always used
17747 for the respective operations.
17749 @item -mnan=2008
17750 @itemx -mnan=legacy
17751 @opindex mnan=2008
17752 @opindex mnan=legacy
17753 These options control the encoding of the special not-a-number (NaN)
17754 IEEE 754 floating-point data.
17756 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17757 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17758 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17759 by the first bit of their trailing significand field being 1.
17761 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17762 this case qNaNs are denoted by the first bit of their trailing
17763 significand field being 1, whereas sNaNs are denoted by the first bit of
17764 their trailing significand field being 0.
17766 The default is @option{-mnan=legacy} unless GCC has been configured with
17767 @option{--with-nan=2008}.
17769 @item -mllsc
17770 @itemx -mno-llsc
17771 @opindex mllsc
17772 @opindex mno-llsc
17773 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17774 implement atomic memory built-in functions.  When neither option is
17775 specified, GCC uses the instructions if the target architecture
17776 supports them.
17778 @option{-mllsc} is useful if the runtime environment can emulate the
17779 instructions and @option{-mno-llsc} can be useful when compiling for
17780 nonstandard ISAs.  You can make either option the default by
17781 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17782 respectively.  @option{--with-llsc} is the default for some
17783 configurations; see the installation documentation for details.
17785 @item -mdsp
17786 @itemx -mno-dsp
17787 @opindex mdsp
17788 @opindex mno-dsp
17789 Use (do not use) revision 1 of the MIPS DSP ASE@.
17790 @xref{MIPS DSP Built-in Functions}.  This option defines the
17791 preprocessor macro @samp{__mips_dsp}.  It also defines
17792 @samp{__mips_dsp_rev} to 1.
17794 @item -mdspr2
17795 @itemx -mno-dspr2
17796 @opindex mdspr2
17797 @opindex mno-dspr2
17798 Use (do not use) revision 2 of the MIPS DSP ASE@.
17799 @xref{MIPS DSP Built-in Functions}.  This option defines the
17800 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
17801 It also defines @samp{__mips_dsp_rev} to 2.
17803 @item -msmartmips
17804 @itemx -mno-smartmips
17805 @opindex msmartmips
17806 @opindex mno-smartmips
17807 Use (do not use) the MIPS SmartMIPS ASE.
17809 @item -mpaired-single
17810 @itemx -mno-paired-single
17811 @opindex mpaired-single
17812 @opindex mno-paired-single
17813 Use (do not use) paired-single floating-point instructions.
17814 @xref{MIPS Paired-Single Support}.  This option requires
17815 hardware floating-point support to be enabled.
17817 @item -mdmx
17818 @itemx -mno-mdmx
17819 @opindex mdmx
17820 @opindex mno-mdmx
17821 Use (do not use) MIPS Digital Media Extension instructions.
17822 This option can only be used when generating 64-bit code and requires
17823 hardware floating-point support to be enabled.
17825 @item -mips3d
17826 @itemx -mno-mips3d
17827 @opindex mips3d
17828 @opindex mno-mips3d
17829 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17830 The option @option{-mips3d} implies @option{-mpaired-single}.
17832 @item -mmicromips
17833 @itemx -mno-micromips
17834 @opindex mmicromips
17835 @opindex mno-mmicromips
17836 Generate (do not generate) microMIPS code.
17838 MicroMIPS code generation can also be controlled on a per-function basis
17839 by means of @code{micromips} and @code{nomicromips} attributes.
17840 @xref{Function Attributes}, for more information.
17842 @item -mmt
17843 @itemx -mno-mt
17844 @opindex mmt
17845 @opindex mno-mt
17846 Use (do not use) MT Multithreading instructions.
17848 @item -mmcu
17849 @itemx -mno-mcu
17850 @opindex mmcu
17851 @opindex mno-mcu
17852 Use (do not use) the MIPS MCU ASE instructions.
17854 @item -meva
17855 @itemx -mno-eva
17856 @opindex meva
17857 @opindex mno-eva
17858 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17860 @item -mvirt
17861 @itemx -mno-virt
17862 @opindex mvirt
17863 @opindex mno-virt
17864 Use (do not use) the MIPS Virtualization Application Specific instructions.
17866 @item -mxpa
17867 @itemx -mno-xpa
17868 @opindex mxpa
17869 @opindex mno-xpa
17870 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17872 @item -mlong64
17873 @opindex mlong64
17874 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17875 an explanation of the default and the way that the pointer size is
17876 determined.
17878 @item -mlong32
17879 @opindex mlong32
17880 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17882 The default size of @code{int}s, @code{long}s and pointers depends on
17883 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17884 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17885 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17886 or the same size as integer registers, whichever is smaller.
17888 @item -msym32
17889 @itemx -mno-sym32
17890 @opindex msym32
17891 @opindex mno-sym32
17892 Assume (do not assume) that all symbols have 32-bit values, regardless
17893 of the selected ABI@.  This option is useful in combination with
17894 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17895 to generate shorter and faster references to symbolic addresses.
17897 @item -G @var{num}
17898 @opindex G
17899 Put definitions of externally-visible data in a small data section
17900 if that data is no bigger than @var{num} bytes.  GCC can then generate
17901 more efficient accesses to the data; see @option{-mgpopt} for details.
17903 The default @option{-G} option depends on the configuration.
17905 @item -mlocal-sdata
17906 @itemx -mno-local-sdata
17907 @opindex mlocal-sdata
17908 @opindex mno-local-sdata
17909 Extend (do not extend) the @option{-G} behavior to local data too,
17910 such as to static variables in C@.  @option{-mlocal-sdata} is the
17911 default for all configurations.
17913 If the linker complains that an application is using too much small data,
17914 you might want to try rebuilding the less performance-critical parts with
17915 @option{-mno-local-sdata}.  You might also want to build large
17916 libraries with @option{-mno-local-sdata}, so that the libraries leave
17917 more room for the main program.
17919 @item -mextern-sdata
17920 @itemx -mno-extern-sdata
17921 @opindex mextern-sdata
17922 @opindex mno-extern-sdata
17923 Assume (do not assume) that externally-defined data is in
17924 a small data section if the size of that data is within the @option{-G} limit.
17925 @option{-mextern-sdata} is the default for all configurations.
17927 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17928 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17929 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17930 is placed in a small data section.  If @var{Var} is defined by another
17931 module, you must either compile that module with a high-enough
17932 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17933 definition.  If @var{Var} is common, you must link the application
17934 with a high-enough @option{-G} setting.
17936 The easiest way of satisfying these restrictions is to compile
17937 and link every module with the same @option{-G} option.  However,
17938 you may wish to build a library that supports several different
17939 small data limits.  You can do this by compiling the library with
17940 the highest supported @option{-G} setting and additionally using
17941 @option{-mno-extern-sdata} to stop the library from making assumptions
17942 about externally-defined data.
17944 @item -mgpopt
17945 @itemx -mno-gpopt
17946 @opindex mgpopt
17947 @opindex mno-gpopt
17948 Use (do not use) GP-relative accesses for symbols that are known to be
17949 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17950 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17951 configurations.
17953 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17954 might not hold the value of @code{_gp}.  For example, if the code is
17955 part of a library that might be used in a boot monitor, programs that
17956 call boot monitor routines pass an unknown value in @code{$gp}.
17957 (In such situations, the boot monitor itself is usually compiled
17958 with @option{-G0}.)
17960 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17961 @option{-mno-extern-sdata}.
17963 @item -membedded-data
17964 @itemx -mno-embedded-data
17965 @opindex membedded-data
17966 @opindex mno-embedded-data
17967 Allocate variables to the read-only data section first if possible, then
17968 next in the small data section if possible, otherwise in data.  This gives
17969 slightly slower code than the default, but reduces the amount of RAM required
17970 when executing, and thus may be preferred for some embedded systems.
17972 @item -muninit-const-in-rodata
17973 @itemx -mno-uninit-const-in-rodata
17974 @opindex muninit-const-in-rodata
17975 @opindex mno-uninit-const-in-rodata
17976 Put uninitialized @code{const} variables in the read-only data section.
17977 This option is only meaningful in conjunction with @option{-membedded-data}.
17979 @item -mcode-readable=@var{setting}
17980 @opindex mcode-readable
17981 Specify whether GCC may generate code that reads from executable sections.
17982 There are three possible settings:
17984 @table @gcctabopt
17985 @item -mcode-readable=yes
17986 Instructions may freely access executable sections.  This is the
17987 default setting.
17989 @item -mcode-readable=pcrel
17990 MIPS16 PC-relative load instructions can access executable sections,
17991 but other instructions must not do so.  This option is useful on 4KSc
17992 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17993 It is also useful on processors that can be configured to have a dual
17994 instruction/data SRAM interface and that, like the M4K, automatically
17995 redirect PC-relative loads to the instruction RAM.
17997 @item -mcode-readable=no
17998 Instructions must not access executable sections.  This option can be
17999 useful on targets that are configured to have a dual instruction/data
18000 SRAM interface but that (unlike the M4K) do not automatically redirect
18001 PC-relative loads to the instruction RAM.
18002 @end table
18004 @item -msplit-addresses
18005 @itemx -mno-split-addresses
18006 @opindex msplit-addresses
18007 @opindex mno-split-addresses
18008 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18009 relocation operators.  This option has been superseded by
18010 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18012 @item -mexplicit-relocs
18013 @itemx -mno-explicit-relocs
18014 @opindex mexplicit-relocs
18015 @opindex mno-explicit-relocs
18016 Use (do not use) assembler relocation operators when dealing with symbolic
18017 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18018 is to use assembler macros instead.
18020 @option{-mexplicit-relocs} is the default if GCC was configured
18021 to use an assembler that supports relocation operators.
18023 @item -mcheck-zero-division
18024 @itemx -mno-check-zero-division
18025 @opindex mcheck-zero-division
18026 @opindex mno-check-zero-division
18027 Trap (do not trap) on integer division by zero.
18029 The default is @option{-mcheck-zero-division}.
18031 @item -mdivide-traps
18032 @itemx -mdivide-breaks
18033 @opindex mdivide-traps
18034 @opindex mdivide-breaks
18035 MIPS systems check for division by zero by generating either a
18036 conditional trap or a break instruction.  Using traps results in
18037 smaller code, but is only supported on MIPS II and later.  Also, some
18038 versions of the Linux kernel have a bug that prevents trap from
18039 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18040 allow conditional traps on architectures that support them and
18041 @option{-mdivide-breaks} to force the use of breaks.
18043 The default is usually @option{-mdivide-traps}, but this can be
18044 overridden at configure time using @option{--with-divide=breaks}.
18045 Divide-by-zero checks can be completely disabled using
18046 @option{-mno-check-zero-division}.
18048 @item -mmemcpy
18049 @itemx -mno-memcpy
18050 @opindex mmemcpy
18051 @opindex mno-memcpy
18052 Force (do not force) the use of @code{memcpy()} for non-trivial block
18053 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18054 most constant-sized copies.
18056 @item -mlong-calls
18057 @itemx -mno-long-calls
18058 @opindex mlong-calls
18059 @opindex mno-long-calls
18060 Disable (do not disable) use of the @code{jal} instruction.  Calling
18061 functions using @code{jal} is more efficient but requires the caller
18062 and callee to be in the same 256 megabyte segment.
18064 This option has no effect on abicalls code.  The default is
18065 @option{-mno-long-calls}.
18067 @item -mmad
18068 @itemx -mno-mad
18069 @opindex mmad
18070 @opindex mno-mad
18071 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18072 instructions, as provided by the R4650 ISA@.
18074 @item -mimadd
18075 @itemx -mno-imadd
18076 @opindex mimadd
18077 @opindex mno-imadd
18078 Enable (disable) use of the @code{madd} and @code{msub} integer
18079 instructions.  The default is @option{-mimadd} on architectures
18080 that support @code{madd} and @code{msub} except for the 74k 
18081 architecture where it was found to generate slower code.
18083 @item -mfused-madd
18084 @itemx -mno-fused-madd
18085 @opindex mfused-madd
18086 @opindex mno-fused-madd
18087 Enable (disable) use of the floating-point multiply-accumulate
18088 instructions, when they are available.  The default is
18089 @option{-mfused-madd}.
18091 On the R8000 CPU when multiply-accumulate instructions are used,
18092 the intermediate product is calculated to infinite precision
18093 and is not subject to the FCSR Flush to Zero bit.  This may be
18094 undesirable in some circumstances.  On other processors the result
18095 is numerically identical to the equivalent computation using
18096 separate multiply, add, subtract and negate instructions.
18098 @item -nocpp
18099 @opindex nocpp
18100 Tell the MIPS assembler to not run its preprocessor over user
18101 assembler files (with a @samp{.s} suffix) when assembling them.
18103 @item -mfix-24k
18104 @item -mno-fix-24k
18105 @opindex mfix-24k
18106 @opindex mno-fix-24k
18107 Work around the 24K E48 (lost data on stores during refill) errata.
18108 The workarounds are implemented by the assembler rather than by GCC@.
18110 @item -mfix-r4000
18111 @itemx -mno-fix-r4000
18112 @opindex mfix-r4000
18113 @opindex mno-fix-r4000
18114 Work around certain R4000 CPU errata:
18115 @itemize @minus
18116 @item
18117 A double-word or a variable shift may give an incorrect result if executed
18118 immediately after starting an integer division.
18119 @item
18120 A double-word or a variable shift may give an incorrect result if executed
18121 while an integer multiplication is in progress.
18122 @item
18123 An integer division may give an incorrect result if started in a delay slot
18124 of a taken branch or a jump.
18125 @end itemize
18127 @item -mfix-r4400
18128 @itemx -mno-fix-r4400
18129 @opindex mfix-r4400
18130 @opindex mno-fix-r4400
18131 Work around certain R4400 CPU errata:
18132 @itemize @minus
18133 @item
18134 A double-word or a variable shift may give an incorrect result if executed
18135 immediately after starting an integer division.
18136 @end itemize
18138 @item -mfix-r10000
18139 @itemx -mno-fix-r10000
18140 @opindex mfix-r10000
18141 @opindex mno-fix-r10000
18142 Work around certain R10000 errata:
18143 @itemize @minus
18144 @item
18145 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18146 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18147 @end itemize
18149 This option can only be used if the target architecture supports
18150 branch-likely instructions.  @option{-mfix-r10000} is the default when
18151 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18152 otherwise.
18154 @item -mfix-rm7000
18155 @itemx -mno-fix-rm7000
18156 @opindex mfix-rm7000
18157 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18158 workarounds are implemented by the assembler rather than by GCC@.
18160 @item -mfix-vr4120
18161 @itemx -mno-fix-vr4120
18162 @opindex mfix-vr4120
18163 Work around certain VR4120 errata:
18164 @itemize @minus
18165 @item
18166 @code{dmultu} does not always produce the correct result.
18167 @item
18168 @code{div} and @code{ddiv} do not always produce the correct result if one
18169 of the operands is negative.
18170 @end itemize
18171 The workarounds for the division errata rely on special functions in
18172 @file{libgcc.a}.  At present, these functions are only provided by
18173 the @code{mips64vr*-elf} configurations.
18175 Other VR4120 errata require a NOP to be inserted between certain pairs of
18176 instructions.  These errata are handled by the assembler, not by GCC itself.
18178 @item -mfix-vr4130
18179 @opindex mfix-vr4130
18180 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18181 workarounds are implemented by the assembler rather than by GCC,
18182 although GCC avoids using @code{mflo} and @code{mfhi} if the
18183 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18184 instructions are available instead.
18186 @item -mfix-sb1
18187 @itemx -mno-fix-sb1
18188 @opindex mfix-sb1
18189 Work around certain SB-1 CPU core errata.
18190 (This flag currently works around the SB-1 revision 2
18191 ``F1'' and ``F2'' floating-point errata.)
18193 @item -mr10k-cache-barrier=@var{setting}
18194 @opindex mr10k-cache-barrier
18195 Specify whether GCC should insert cache barriers to avoid the
18196 side-effects of speculation on R10K processors.
18198 In common with many processors, the R10K tries to predict the outcome
18199 of a conditional branch and speculatively executes instructions from
18200 the ``taken'' branch.  It later aborts these instructions if the
18201 predicted outcome is wrong.  However, on the R10K, even aborted
18202 instructions can have side effects.
18204 This problem only affects kernel stores and, depending on the system,
18205 kernel loads.  As an example, a speculatively-executed store may load
18206 the target memory into cache and mark the cache line as dirty, even if
18207 the store itself is later aborted.  If a DMA operation writes to the
18208 same area of memory before the ``dirty'' line is flushed, the cached
18209 data overwrites the DMA-ed data.  See the R10K processor manual
18210 for a full description, including other potential problems.
18212 One workaround is to insert cache barrier instructions before every memory
18213 access that might be speculatively executed and that might have side
18214 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18215 controls GCC's implementation of this workaround.  It assumes that
18216 aborted accesses to any byte in the following regions does not have
18217 side effects:
18219 @enumerate
18220 @item
18221 the memory occupied by the current function's stack frame;
18223 @item
18224 the memory occupied by an incoming stack argument;
18226 @item
18227 the memory occupied by an object with a link-time-constant address.
18228 @end enumerate
18230 It is the kernel's responsibility to ensure that speculative
18231 accesses to these regions are indeed safe.
18233 If the input program contains a function declaration such as:
18235 @smallexample
18236 void foo (void);
18237 @end smallexample
18239 then the implementation of @code{foo} must allow @code{j foo} and
18240 @code{jal foo} to be executed speculatively.  GCC honors this
18241 restriction for functions it compiles itself.  It expects non-GCC
18242 functions (such as hand-written assembly code) to do the same.
18244 The option has three forms:
18246 @table @gcctabopt
18247 @item -mr10k-cache-barrier=load-store
18248 Insert a cache barrier before a load or store that might be
18249 speculatively executed and that might have side effects even
18250 if aborted.
18252 @item -mr10k-cache-barrier=store
18253 Insert a cache barrier before a store that might be speculatively
18254 executed and that might have side effects even if aborted.
18256 @item -mr10k-cache-barrier=none
18257 Disable the insertion of cache barriers.  This is the default setting.
18258 @end table
18260 @item -mflush-func=@var{func}
18261 @itemx -mno-flush-func
18262 @opindex mflush-func
18263 Specifies the function to call to flush the I and D caches, or to not
18264 call any such function.  If called, the function must take the same
18265 arguments as the common @code{_flush_func()}, that is, the address of the
18266 memory range for which the cache is being flushed, the size of the
18267 memory range, and the number 3 (to flush both caches).  The default
18268 depends on the target GCC was configured for, but commonly is either
18269 @samp{_flush_func} or @samp{__cpu_flush}.
18271 @item mbranch-cost=@var{num}
18272 @opindex mbranch-cost
18273 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18274 This cost is only a heuristic and is not guaranteed to produce
18275 consistent results across releases.  A zero cost redundantly selects
18276 the default, which is based on the @option{-mtune} setting.
18278 @item -mbranch-likely
18279 @itemx -mno-branch-likely
18280 @opindex mbranch-likely
18281 @opindex mno-branch-likely
18282 Enable or disable use of Branch Likely instructions, regardless of the
18283 default for the selected architecture.  By default, Branch Likely
18284 instructions may be generated if they are supported by the selected
18285 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18286 and processors that implement those architectures; for those, Branch
18287 Likely instructions are not be generated by default because the MIPS32
18288 and MIPS64 architectures specifically deprecate their use.
18290 @item -mfp-exceptions
18291 @itemx -mno-fp-exceptions
18292 @opindex mfp-exceptions
18293 Specifies whether FP exceptions are enabled.  This affects how
18294 FP instructions are scheduled for some processors.
18295 The default is that FP exceptions are
18296 enabled.
18298 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18299 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18300 FP pipe.
18302 @item -mvr4130-align
18303 @itemx -mno-vr4130-align
18304 @opindex mvr4130-align
18305 The VR4130 pipeline is two-way superscalar, but can only issue two
18306 instructions together if the first one is 8-byte aligned.  When this
18307 option is enabled, GCC aligns pairs of instructions that it
18308 thinks should execute in parallel.
18310 This option only has an effect when optimizing for the VR4130.
18311 It normally makes code faster, but at the expense of making it bigger.
18312 It is enabled by default at optimization level @option{-O3}.
18314 @item -msynci
18315 @itemx -mno-synci
18316 @opindex msynci
18317 Enable (disable) generation of @code{synci} instructions on
18318 architectures that support it.  The @code{synci} instructions (if
18319 enabled) are generated when @code{__builtin___clear_cache()} is
18320 compiled.
18322 This option defaults to @code{-mno-synci}, but the default can be
18323 overridden by configuring with @code{--with-synci}.
18325 When compiling code for single processor systems, it is generally safe
18326 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18327 does not invalidate the instruction caches on all cores and may lead
18328 to undefined behavior.
18330 @item -mrelax-pic-calls
18331 @itemx -mno-relax-pic-calls
18332 @opindex mrelax-pic-calls
18333 Try to turn PIC calls that are normally dispatched via register
18334 @code{$25} into direct calls.  This is only possible if the linker can
18335 resolve the destination at link-time and if the destination is within
18336 range for a direct call.
18338 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18339 an assembler and a linker that support the @code{.reloc} assembly
18340 directive and @code{-mexplicit-relocs} is in effect.  With
18341 @code{-mno-explicit-relocs}, this optimization can be performed by the
18342 assembler and the linker alone without help from the compiler.
18344 @item -mmcount-ra-address
18345 @itemx -mno-mcount-ra-address
18346 @opindex mmcount-ra-address
18347 @opindex mno-mcount-ra-address
18348 Emit (do not emit) code that allows @code{_mcount} to modify the
18349 calling function's return address.  When enabled, this option extends
18350 the usual @code{_mcount} interface with a new @var{ra-address}
18351 parameter, which has type @code{intptr_t *} and is passed in register
18352 @code{$12}.  @code{_mcount} can then modify the return address by
18353 doing both of the following:
18354 @itemize
18355 @item
18356 Returning the new address in register @code{$31}.
18357 @item
18358 Storing the new address in @code{*@var{ra-address}},
18359 if @var{ra-address} is nonnull.
18360 @end itemize
18362 The default is @option{-mno-mcount-ra-address}.
18364 @end table
18366 @node MMIX Options
18367 @subsection MMIX Options
18368 @cindex MMIX Options
18370 These options are defined for the MMIX:
18372 @table @gcctabopt
18373 @item -mlibfuncs
18374 @itemx -mno-libfuncs
18375 @opindex mlibfuncs
18376 @opindex mno-libfuncs
18377 Specify that intrinsic library functions are being compiled, passing all
18378 values in registers, no matter the size.
18380 @item -mepsilon
18381 @itemx -mno-epsilon
18382 @opindex mepsilon
18383 @opindex mno-epsilon
18384 Generate floating-point comparison instructions that compare with respect
18385 to the @code{rE} epsilon register.
18387 @item -mabi=mmixware
18388 @itemx -mabi=gnu
18389 @opindex mabi=mmixware
18390 @opindex mabi=gnu
18391 Generate code that passes function parameters and return values that (in
18392 the called function) are seen as registers @code{$0} and up, as opposed to
18393 the GNU ABI which uses global registers @code{$231} and up.
18395 @item -mzero-extend
18396 @itemx -mno-zero-extend
18397 @opindex mzero-extend
18398 @opindex mno-zero-extend
18399 When reading data from memory in sizes shorter than 64 bits, use (do not
18400 use) zero-extending load instructions by default, rather than
18401 sign-extending ones.
18403 @item -mknuthdiv
18404 @itemx -mno-knuthdiv
18405 @opindex mknuthdiv
18406 @opindex mno-knuthdiv
18407 Make the result of a division yielding a remainder have the same sign as
18408 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18409 remainder follows the sign of the dividend.  Both methods are
18410 arithmetically valid, the latter being almost exclusively used.
18412 @item -mtoplevel-symbols
18413 @itemx -mno-toplevel-symbols
18414 @opindex mtoplevel-symbols
18415 @opindex mno-toplevel-symbols
18416 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18417 code can be used with the @code{PREFIX} assembly directive.
18419 @item -melf
18420 @opindex melf
18421 Generate an executable in the ELF format, rather than the default
18422 @samp{mmo} format used by the @command{mmix} simulator.
18424 @item -mbranch-predict
18425 @itemx -mno-branch-predict
18426 @opindex mbranch-predict
18427 @opindex mno-branch-predict
18428 Use (do not use) the probable-branch instructions, when static branch
18429 prediction indicates a probable branch.
18431 @item -mbase-addresses
18432 @itemx -mno-base-addresses
18433 @opindex mbase-addresses
18434 @opindex mno-base-addresses
18435 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18436 base address automatically generates a request (handled by the assembler
18437 and the linker) for a constant to be set up in a global register.  The
18438 register is used for one or more base address requests within the range 0
18439 to 255 from the value held in the register.  The generally leads to short
18440 and fast code, but the number of different data items that can be
18441 addressed is limited.  This means that a program that uses lots of static
18442 data may require @option{-mno-base-addresses}.
18444 @item -msingle-exit
18445 @itemx -mno-single-exit
18446 @opindex msingle-exit
18447 @opindex mno-single-exit
18448 Force (do not force) generated code to have a single exit point in each
18449 function.
18450 @end table
18452 @node MN10300 Options
18453 @subsection MN10300 Options
18454 @cindex MN10300 options
18456 These @option{-m} options are defined for Matsushita MN10300 architectures:
18458 @table @gcctabopt
18459 @item -mmult-bug
18460 @opindex mmult-bug
18461 Generate code to avoid bugs in the multiply instructions for the MN10300
18462 processors.  This is the default.
18464 @item -mno-mult-bug
18465 @opindex mno-mult-bug
18466 Do not generate code to avoid bugs in the multiply instructions for the
18467 MN10300 processors.
18469 @item -mam33
18470 @opindex mam33
18471 Generate code using features specific to the AM33 processor.
18473 @item -mno-am33
18474 @opindex mno-am33
18475 Do not generate code using features specific to the AM33 processor.  This
18476 is the default.
18478 @item -mam33-2
18479 @opindex mam33-2
18480 Generate code using features specific to the AM33/2.0 processor.
18482 @item -mam34
18483 @opindex mam34
18484 Generate code using features specific to the AM34 processor.
18486 @item -mtune=@var{cpu-type}
18487 @opindex mtune
18488 Use the timing characteristics of the indicated CPU type when
18489 scheduling instructions.  This does not change the targeted processor
18490 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18491 @samp{am33-2} or @samp{am34}.
18493 @item -mreturn-pointer-on-d0
18494 @opindex mreturn-pointer-on-d0
18495 When generating a function that returns a pointer, return the pointer
18496 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18497 only in @code{a0}, and attempts to call such functions without a prototype
18498 result in errors.  Note that this option is on by default; use
18499 @option{-mno-return-pointer-on-d0} to disable it.
18501 @item -mno-crt0
18502 @opindex mno-crt0
18503 Do not link in the C run-time initialization object file.
18505 @item -mrelax
18506 @opindex mrelax
18507 Indicate to the linker that it should perform a relaxation optimization pass
18508 to shorten branches, calls and absolute memory addresses.  This option only
18509 has an effect when used on the command line for the final link step.
18511 This option makes symbolic debugging impossible.
18513 @item -mliw
18514 @opindex mliw
18515 Allow the compiler to generate @emph{Long Instruction Word}
18516 instructions if the target is the @samp{AM33} or later.  This is the
18517 default.  This option defines the preprocessor macro @samp{__LIW__}.
18519 @item -mnoliw
18520 @opindex mnoliw
18521 Do not allow the compiler to generate @emph{Long Instruction Word}
18522 instructions.  This option defines the preprocessor macro
18523 @samp{__NO_LIW__}.
18525 @item -msetlb
18526 @opindex msetlb
18527 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18528 instructions if the target is the @samp{AM33} or later.  This is the
18529 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18531 @item -mnosetlb
18532 @opindex mnosetlb
18533 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18534 instructions.  This option defines the preprocessor macro
18535 @samp{__NO_SETLB__}.
18537 @end table
18539 @node Moxie Options
18540 @subsection Moxie Options
18541 @cindex Moxie Options
18543 @table @gcctabopt
18545 @item -meb
18546 @opindex meb
18547 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18548 configurations.
18550 @item -mel
18551 @opindex mel
18552 Generate little-endian code.
18554 @item -mno-crt0
18555 @opindex mno-crt0
18556 Do not link in the C run-time initialization object file.
18558 @end table
18560 @node MSP430 Options
18561 @subsection MSP430 Options
18562 @cindex MSP430 Options
18564 These options are defined for the MSP430:
18566 @table @gcctabopt
18568 @item -masm-hex
18569 @opindex masm-hex
18570 Force assembly output to always use hex constants.  Normally such
18571 constants are signed decimals, but this option is available for
18572 testsuite and/or aesthetic purposes.
18574 @item -mmcu=
18575 @opindex mmcu=
18576 Select the MCU to target.  This is used to create a C preprocessor
18577 symbol based upon the MCU name, converted to upper case and pre- and
18578 post- fixed with @code{__}.  This in turn will be used by the
18579 @code{msp430.h} header file to select an MCU specific supplimentary
18580 header file.
18582 The option also sets the ISA to use.  If the MCU name is one that is
18583 known to only support the 430 ISA then that is selected, otherwise the
18584 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18585 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18586 name will select the 430X ISA.
18588 In addition an MCU specific linker script will be added to the linker
18589 command line.  The script's name is the name of the MCU with
18590 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18591 command line will define the C preprocessor symbol @code{__XXX__} and
18592 cause the linker to search for a script called @file{xxx.ld}.
18594 This option is also passed on to the assembler.
18596 @item -mcpu=
18597 @opindex -mcpu=
18598 Specifies the ISA to use.  Accepted values are @code{msp430},
18599 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18600 @option{-mmcu=} option should be used to select the ISA.
18602 @item -msim
18603 @opindex msim
18604 Link to the simulator runtime libraries and linker script.  Overrides
18605 any scripts that would be selected by the @option{-mmcu=} option.
18607 @item -mlarge
18608 @opindex mlarge
18609 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18611 @item -msmall
18612 @opindex msmall
18613 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18615 @item -mrelax
18616 @opindex mrelax
18617 This option is passed to the assembler and linker, and allows the
18618 linker to perform certain optimizations that cannot be done until
18619 the final link.
18621 @item mhwmult=
18622 @opindex mhwmult=
18623 Describes the type of hardware multiply supported by the target.
18624 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18625 for the original 16-bit-only multiply supported by early MCUs.
18626 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18627 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18628 A value of @code{auto} can also be given.  This tells GCC to deduce
18629 the hardware multiply support based upon the MCU name provided by the
18630 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18631 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18632 default setting.
18634 Hardware multiplies are normally performed by calling a library
18635 routine.  This saves space in the generated code.  When compiling at
18636 @code{-O3} or higher however the hardware multiplier is invoked
18637 inline.  This makes for bigger, but faster code.
18639 The hardware multiply routines disable interrupts whilst running and
18640 restore the previous interrupt state when they finish.  This makes
18641 them safe to use inside interrupt handlers as well as in normal code.
18643 @item -minrt
18644 @opindex minrt
18645 Enable the use of a minimum runtime environment - no static
18646 initializers or constructors.  This is intended for memory-constrained
18647 devices.  The compiler will include special symbols in some objects
18648 that tell the linker and runtime which code fragments are required.
18650 @end table
18652 @node NDS32 Options
18653 @subsection NDS32 Options
18654 @cindex NDS32 Options
18656 These options are defined for NDS32 implementations:
18658 @table @gcctabopt
18660 @item -mbig-endian
18661 @opindex mbig-endian
18662 Generate code in big-endian mode.
18664 @item -mlittle-endian
18665 @opindex mlittle-endian
18666 Generate code in little-endian mode.
18668 @item -mreduced-regs
18669 @opindex mreduced-regs
18670 Use reduced-set registers for register allocation.
18672 @item -mfull-regs
18673 @opindex mfull-regs
18674 Use full-set registers for register allocation.
18676 @item -mcmov
18677 @opindex mcmov
18678 Generate conditional move instructions.
18680 @item -mno-cmov
18681 @opindex mno-cmov
18682 Do not generate conditional move instructions.
18684 @item -mperf-ext
18685 @opindex mperf-ext
18686 Generate performance extension instructions.
18688 @item -mno-perf-ext
18689 @opindex mno-perf-ext
18690 Do not generate performance extension instructions.
18692 @item -mv3push
18693 @opindex mv3push
18694 Generate v3 push25/pop25 instructions.
18696 @item -mno-v3push
18697 @opindex mno-v3push
18698 Do not generate v3 push25/pop25 instructions.
18700 @item -m16-bit
18701 @opindex m16-bit
18702 Generate 16-bit instructions.
18704 @item -mno-16-bit
18705 @opindex mno-16-bit
18706 Do not generate 16-bit instructions.
18708 @item -mgp-direct
18709 @opindex mgp-direct
18710 Generate GP base instructions directly.
18712 @item -mno-gp-direct
18713 @opindex mno-gp-direct
18714 Do no generate GP base instructions directly.
18716 @item -misr-vector-size=@var{num}
18717 @opindex misr-vector-size
18718 Specify the size of each interrupt vector, which must be 4 or 16.
18720 @item -mcache-block-size=@var{num}
18721 @opindex mcache-block-size
18722 Specify the size of each cache block,
18723 which must be a power of 2 between 4 and 512.
18725 @item -march=@var{arch}
18726 @opindex march
18727 Specify the name of the target architecture.
18729 @item -mforce-fp-as-gp
18730 @opindex mforce-fp-as-gp
18731 Prevent $fp being allocated during register allocation so that compiler
18732 is able to force performing fp-as-gp optimization.
18734 @item -mforbid-fp-as-gp
18735 @opindex mforbid-fp-as-gp
18736 Forbid using $fp to access static and global variables.
18737 This option strictly forbids fp-as-gp optimization
18738 regardless of @option{-mforce-fp-as-gp}.
18740 @item -mex9
18741 @opindex mex9
18742 Use special directives to guide linker doing ex9 optimization.
18744 @item -mctor-dtor
18745 @opindex mctor-dtor
18746 Enable constructor/destructor feature.
18748 @item -mrelax
18749 @opindex mrelax
18750 Guide linker to relax instructions.
18752 @end table
18754 @node Nios II Options
18755 @subsection Nios II Options
18756 @cindex Nios II options
18757 @cindex Altera Nios II options
18759 These are the options defined for the Altera Nios II processor.
18761 @table @gcctabopt
18763 @item -G @var{num}
18764 @opindex G
18765 @cindex smaller data references
18766 Put global and static objects less than or equal to @var{num} bytes
18767 into the small data or BSS sections instead of the normal data or BSS
18768 sections.  The default value of @var{num} is 8.
18770 @item -mgpopt
18771 @itemx -mno-gpopt
18772 @opindex mgpopt
18773 @opindex mno-gpopt
18774 Generate (do not generate) GP-relative accesses for objects in the
18775 small data or BSS sections.  The default is @option{-mgpopt} except
18776 when @option{-fpic} or @option{-fPIC} is specified to generate
18777 position-independent code.  Note that the Nios II ABI does not permit
18778 GP-relative accesses from shared libraries.
18780 You may need to specify @option{-mno-gpopt} explicitly when building
18781 programs that include large amounts of small data, including large
18782 GOT data sections.  In this case, the 16-bit offset for GP-relative
18783 addressing may not be large enough to allow access to the entire 
18784 small data section.
18786 @item -mel
18787 @itemx -meb
18788 @opindex mel
18789 @opindex meb
18790 Generate little-endian (default) or big-endian (experimental) code,
18791 respectively.
18793 @item -mbypass-cache
18794 @itemx -mno-bypass-cache
18795 @opindex mno-bypass-cache
18796 @opindex mbypass-cache
18797 Force all load and store instructions to always bypass cache by 
18798 using I/O variants of the instructions. The default is not to
18799 bypass the cache.
18801 @item -mno-cache-volatile 
18802 @itemx -mcache-volatile       
18803 @opindex mcache-volatile 
18804 @opindex mno-cache-volatile
18805 Volatile memory access bypass the cache using the I/O variants of 
18806 the load and store instructions. The default is not to bypass the cache.
18808 @item -mno-fast-sw-div
18809 @itemx -mfast-sw-div
18810 @opindex mno-fast-sw-div
18811 @opindex mfast-sw-div
18812 Do not use table-based fast divide for small numbers. The default 
18813 is to use the fast divide at @option{-O3} and above.
18815 @item -mno-hw-mul
18816 @itemx -mhw-mul
18817 @itemx -mno-hw-mulx
18818 @itemx -mhw-mulx
18819 @itemx -mno-hw-div
18820 @itemx -mhw-div
18821 @opindex mno-hw-mul
18822 @opindex mhw-mul
18823 @opindex mno-hw-mulx
18824 @opindex mhw-mulx
18825 @opindex mno-hw-div
18826 @opindex mhw-div
18827 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18828 instructions by the compiler. The default is to emit @code{mul}
18829 and not emit @code{div} and @code{mulx}.
18831 @item -mcustom-@var{insn}=@var{N}
18832 @itemx -mno-custom-@var{insn}
18833 @opindex mcustom-@var{insn}
18834 @opindex mno-custom-@var{insn}
18835 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18836 custom instruction with encoding @var{N} when generating code that uses 
18837 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
18838 instruction 253 for single-precision floating-point add operations instead
18839 of the default behavior of using a library call.
18841 The following values of @var{insn} are supported.  Except as otherwise
18842 noted, floating-point operations are expected to be implemented with
18843 normal IEEE 754 semantics and correspond directly to the C operators or the
18844 equivalent GCC built-in functions (@pxref{Other Builtins}).
18846 Single-precision floating point:
18847 @table @asis
18849 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18850 Binary arithmetic operations.
18852 @item @samp{fnegs}
18853 Unary negation.
18855 @item @samp{fabss}
18856 Unary absolute value.
18858 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18859 Comparison operations.
18861 @item @samp{fmins}, @samp{fmaxs}
18862 Floating-point minimum and maximum.  These instructions are only
18863 generated if @option{-ffinite-math-only} is specified.
18865 @item @samp{fsqrts}
18866 Unary square root operation.
18868 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18869 Floating-point trigonometric and exponential functions.  These instructions
18870 are only generated if @option{-funsafe-math-optimizations} is also specified.
18872 @end table
18874 Double-precision floating point:
18875 @table @asis
18877 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18878 Binary arithmetic operations.
18880 @item @samp{fnegd}
18881 Unary negation.
18883 @item @samp{fabsd}
18884 Unary absolute value.
18886 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18887 Comparison operations.
18889 @item @samp{fmind}, @samp{fmaxd}
18890 Double-precision minimum and maximum.  These instructions are only
18891 generated if @option{-ffinite-math-only} is specified.
18893 @item @samp{fsqrtd}
18894 Unary square root operation.
18896 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18897 Double-precision trigonometric and exponential functions.  These instructions
18898 are only generated if @option{-funsafe-math-optimizations} is also specified.
18900 @end table
18902 Conversions:
18903 @table @asis
18904 @item @samp{fextsd}
18905 Conversion from single precision to double precision.
18907 @item @samp{ftruncds}
18908 Conversion from double precision to single precision.
18910 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18911 Conversion from floating point to signed or unsigned integer types, with
18912 truncation towards zero.
18914 @item @samp{round}
18915 Conversion from single-precision floating point to signed integer,
18916 rounding to the nearest integer and ties away from zero.
18917 This corresponds to the @code{__builtin_lroundf} function when
18918 @option{-fno-math-errno} is used.
18920 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18921 Conversion from signed or unsigned integer types to floating-point types.
18923 @end table
18925 In addition, all of the following transfer instructions for internal
18926 registers X and Y must be provided to use any of the double-precision
18927 floating-point instructions.  Custom instructions taking two
18928 double-precision source operands expect the first operand in the
18929 64-bit register X.  The other operand (or only operand of a unary
18930 operation) is given to the custom arithmetic instruction with the
18931 least significant half in source register @var{src1} and the most
18932 significant half in @var{src2}.  A custom instruction that returns a
18933 double-precision result returns the most significant 32 bits in the
18934 destination register and the other half in 32-bit register Y.  
18935 GCC automatically generates the necessary code sequences to write
18936 register X and/or read register Y when double-precision floating-point
18937 instructions are used.
18939 @table @asis
18941 @item @samp{fwrx}
18942 Write @var{src1} into the least significant half of X and @var{src2} into
18943 the most significant half of X.
18945 @item @samp{fwry}
18946 Write @var{src1} into Y.
18948 @item @samp{frdxhi}, @samp{frdxlo}
18949 Read the most or least (respectively) significant half of X and store it in
18950 @var{dest}.
18952 @item @samp{frdy}
18953 Read the value of Y and store it into @var{dest}.
18954 @end table
18956 Note that you can gain more local control over generation of Nios II custom
18957 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18958 and @code{target("no-custom-@var{insn}")} function attributes
18959 (@pxref{Function Attributes})
18960 or pragmas (@pxref{Function Specific Option Pragmas}).
18962 @item -mcustom-fpu-cfg=@var{name}
18963 @opindex mcustom-fpu-cfg
18965 This option enables a predefined, named set of custom instruction encodings
18966 (see @option{-mcustom-@var{insn}} above).  
18967 Currently, the following sets are defined:
18969 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18970 @gccoptlist{-mcustom-fmuls=252 @gol
18971 -mcustom-fadds=253 @gol
18972 -mcustom-fsubs=254 @gol
18973 -fsingle-precision-constant}
18975 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18976 @gccoptlist{-mcustom-fmuls=252 @gol
18977 -mcustom-fadds=253 @gol
18978 -mcustom-fsubs=254 @gol
18979 -mcustom-fdivs=255 @gol
18980 -fsingle-precision-constant}
18982 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18983 @gccoptlist{-mcustom-floatus=243 @gol
18984 -mcustom-fixsi=244 @gol
18985 -mcustom-floatis=245 @gol
18986 -mcustom-fcmpgts=246 @gol
18987 -mcustom-fcmples=249 @gol
18988 -mcustom-fcmpeqs=250 @gol
18989 -mcustom-fcmpnes=251 @gol
18990 -mcustom-fmuls=252 @gol
18991 -mcustom-fadds=253 @gol
18992 -mcustom-fsubs=254 @gol
18993 -mcustom-fdivs=255 @gol
18994 -fsingle-precision-constant}
18996 Custom instruction assignments given by individual
18997 @option{-mcustom-@var{insn}=} options override those given by
18998 @option{-mcustom-fpu-cfg=}, regardless of the
18999 order of the options on the command line.
19001 Note that you can gain more local control over selection of a FPU
19002 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19003 function attribute (@pxref{Function Attributes})
19004 or pragma (@pxref{Function Specific Option Pragmas}).
19006 @end table
19008 These additional @samp{-m} options are available for the Altera Nios II
19009 ELF (bare-metal) target:
19011 @table @gcctabopt
19013 @item -mhal
19014 @opindex mhal
19015 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19016 startup and termination code, and is typically used in conjunction with
19017 @option{-msys-crt0=} to specify the location of the alternate startup code
19018 provided by the HAL BSP.
19020 @item -msmallc
19021 @opindex msmallc
19022 Link with a limited version of the C library, @option{-lsmallc}, rather than
19023 Newlib.
19025 @item -msys-crt0=@var{startfile}
19026 @opindex msys-crt0
19027 @var{startfile} is the file name of the startfile (crt0) to use 
19028 when linking.  This option is only useful in conjunction with @option{-mhal}.
19030 @item -msys-lib=@var{systemlib}
19031 @opindex msys-lib
19032 @var{systemlib} is the library name of the library that provides
19033 low-level system calls required by the C library,
19034 e.g. @code{read} and @code{write}.
19035 This option is typically used to link with a library provided by a HAL BSP.
19037 @end table
19039 @node PDP-11 Options
19040 @subsection PDP-11 Options
19041 @cindex PDP-11 Options
19043 These options are defined for the PDP-11:
19045 @table @gcctabopt
19046 @item -mfpu
19047 @opindex mfpu
19048 Use hardware FPP floating point.  This is the default.  (FIS floating
19049 point on the PDP-11/40 is not supported.)
19051 @item -msoft-float
19052 @opindex msoft-float
19053 Do not use hardware floating point.
19055 @item -mac0
19056 @opindex mac0
19057 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19059 @item -mno-ac0
19060 @opindex mno-ac0
19061 Return floating-point results in memory.  This is the default.
19063 @item -m40
19064 @opindex m40
19065 Generate code for a PDP-11/40.
19067 @item -m45
19068 @opindex m45
19069 Generate code for a PDP-11/45.  This is the default.
19071 @item -m10
19072 @opindex m10
19073 Generate code for a PDP-11/10.
19075 @item -mbcopy-builtin
19076 @opindex mbcopy-builtin
19077 Use inline @code{movmemhi} patterns for copying memory.  This is the
19078 default.
19080 @item -mbcopy
19081 @opindex mbcopy
19082 Do not use inline @code{movmemhi} patterns for copying memory.
19084 @item -mint16
19085 @itemx -mno-int32
19086 @opindex mint16
19087 @opindex mno-int32
19088 Use 16-bit @code{int}.  This is the default.
19090 @item -mint32
19091 @itemx -mno-int16
19092 @opindex mint32
19093 @opindex mno-int16
19094 Use 32-bit @code{int}.
19096 @item -mfloat64
19097 @itemx -mno-float32
19098 @opindex mfloat64
19099 @opindex mno-float32
19100 Use 64-bit @code{float}.  This is the default.
19102 @item -mfloat32
19103 @itemx -mno-float64
19104 @opindex mfloat32
19105 @opindex mno-float64
19106 Use 32-bit @code{float}.
19108 @item -mabshi
19109 @opindex mabshi
19110 Use @code{abshi2} pattern.  This is the default.
19112 @item -mno-abshi
19113 @opindex mno-abshi
19114 Do not use @code{abshi2} pattern.
19116 @item -mbranch-expensive
19117 @opindex mbranch-expensive
19118 Pretend that branches are expensive.  This is for experimenting with
19119 code generation only.
19121 @item -mbranch-cheap
19122 @opindex mbranch-cheap
19123 Do not pretend that branches are expensive.  This is the default.
19125 @item -munix-asm
19126 @opindex munix-asm
19127 Use Unix assembler syntax.  This is the default when configured for
19128 @samp{pdp11-*-bsd}.
19130 @item -mdec-asm
19131 @opindex mdec-asm
19132 Use DEC assembler syntax.  This is the default when configured for any
19133 PDP-11 target other than @samp{pdp11-*-bsd}.
19134 @end table
19136 @node picoChip Options
19137 @subsection picoChip Options
19138 @cindex picoChip options
19140 These @samp{-m} options are defined for picoChip implementations:
19142 @table @gcctabopt
19144 @item -mae=@var{ae_type}
19145 @opindex mcpu
19146 Set the instruction set, register set, and instruction scheduling
19147 parameters for array element type @var{ae_type}.  Supported values
19148 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19150 @option{-mae=ANY} selects a completely generic AE type.  Code
19151 generated with this option runs on any of the other AE types.  The
19152 code is not as efficient as it would be if compiled for a specific
19153 AE type, and some types of operation (e.g., multiplication) do not
19154 work properly on all types of AE.
19156 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19157 for compiled code, and is the default.
19159 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19160 option may suffer from poor performance of byte (char) manipulation,
19161 since the DSP AE does not provide hardware support for byte load/stores.
19163 @item -msymbol-as-address
19164 Enable the compiler to directly use a symbol name as an address in a
19165 load/store instruction, without first loading it into a
19166 register.  Typically, the use of this option generates larger
19167 programs, which run faster than when the option isn't used.  However, the
19168 results vary from program to program, so it is left as a user option,
19169 rather than being permanently enabled.
19171 @item -mno-inefficient-warnings
19172 Disables warnings about the generation of inefficient code.  These
19173 warnings can be generated, for example, when compiling code that
19174 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19175 no hardware support for byte-level memory operations, so all byte
19176 load/stores must be synthesized from word load/store operations.  This is
19177 inefficient and a warning is generated to indicate
19178 that you should rewrite the code to avoid byte operations, or to target
19179 an AE type that has the necessary hardware support.  This option disables
19180 these warnings.
19182 @end table
19184 @node PowerPC Options
19185 @subsection PowerPC Options
19186 @cindex PowerPC options
19188 These are listed under @xref{RS/6000 and PowerPC Options}.
19190 @node RL78 Options
19191 @subsection RL78 Options
19192 @cindex RL78 Options
19194 @table @gcctabopt
19196 @item -msim
19197 @opindex msim
19198 Links in additional target libraries to support operation within a
19199 simulator.
19201 @item -mmul=none
19202 @itemx -mmul=g13
19203 @itemx -mmul=rl78
19204 @opindex mmul
19205 Specifies the type of hardware multiplication support to be used.  The
19206 default is @code{none}, which uses software multiplication functions.
19207 The @code{g13} option is for the hardware multiply/divide peripheral
19208 only on the RL78/G13 targets.  The @code{rl78} option is for the
19209 standard hardware multiplication defined in the RL78 software manual.
19211 @item -m64bit-doubles
19212 @itemx -m32bit-doubles
19213 @opindex m64bit-doubles
19214 @opindex m32bit-doubles
19215 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19216 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19217 @option{-m32bit-doubles}.
19219 @end table
19221 @node RS/6000 and PowerPC Options
19222 @subsection IBM RS/6000 and PowerPC Options
19223 @cindex RS/6000 and PowerPC Options
19224 @cindex IBM RS/6000 and PowerPC Options
19226 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19227 @table @gcctabopt
19228 @item -mpowerpc-gpopt
19229 @itemx -mno-powerpc-gpopt
19230 @itemx -mpowerpc-gfxopt
19231 @itemx -mno-powerpc-gfxopt
19232 @need 800
19233 @itemx -mpowerpc64
19234 @itemx -mno-powerpc64
19235 @itemx -mmfcrf
19236 @itemx -mno-mfcrf
19237 @itemx -mpopcntb
19238 @itemx -mno-popcntb
19239 @itemx -mpopcntd
19240 @itemx -mno-popcntd
19241 @itemx -mfprnd
19242 @itemx -mno-fprnd
19243 @need 800
19244 @itemx -mcmpb
19245 @itemx -mno-cmpb
19246 @itemx -mmfpgpr
19247 @itemx -mno-mfpgpr
19248 @itemx -mhard-dfp
19249 @itemx -mno-hard-dfp
19250 @opindex mpowerpc-gpopt
19251 @opindex mno-powerpc-gpopt
19252 @opindex mpowerpc-gfxopt
19253 @opindex mno-powerpc-gfxopt
19254 @opindex mpowerpc64
19255 @opindex mno-powerpc64
19256 @opindex mmfcrf
19257 @opindex mno-mfcrf
19258 @opindex mpopcntb
19259 @opindex mno-popcntb
19260 @opindex mpopcntd
19261 @opindex mno-popcntd
19262 @opindex mfprnd
19263 @opindex mno-fprnd
19264 @opindex mcmpb
19265 @opindex mno-cmpb
19266 @opindex mmfpgpr
19267 @opindex mno-mfpgpr
19268 @opindex mhard-dfp
19269 @opindex mno-hard-dfp
19270 You use these options to specify which instructions are available on the
19271 processor you are using.  The default value of these options is
19272 determined when configuring GCC@.  Specifying the
19273 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19274 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19275 rather than the options listed above.
19277 Specifying @option{-mpowerpc-gpopt} allows
19278 GCC to use the optional PowerPC architecture instructions in the
19279 General Purpose group, including floating-point square root.  Specifying
19280 @option{-mpowerpc-gfxopt} allows GCC to
19281 use the optional PowerPC architecture instructions in the Graphics
19282 group, including floating-point select.
19284 The @option{-mmfcrf} option allows GCC to generate the move from
19285 condition register field instruction implemented on the POWER4
19286 processor and other processors that support the PowerPC V2.01
19287 architecture.
19288 The @option{-mpopcntb} option allows GCC to generate the popcount and
19289 double-precision FP reciprocal estimate instruction implemented on the
19290 POWER5 processor and other processors that support the PowerPC V2.02
19291 architecture.
19292 The @option{-mpopcntd} option allows GCC to generate the popcount
19293 instruction implemented on the POWER7 processor and other processors
19294 that support the PowerPC V2.06 architecture.
19295 The @option{-mfprnd} option allows GCC to generate the FP round to
19296 integer instructions implemented on the POWER5+ processor and other
19297 processors that support the PowerPC V2.03 architecture.
19298 The @option{-mcmpb} option allows GCC to generate the compare bytes
19299 instruction implemented on the POWER6 processor and other processors
19300 that support the PowerPC V2.05 architecture.
19301 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19302 general-purpose register instructions implemented on the POWER6X
19303 processor and other processors that support the extended PowerPC V2.05
19304 architecture.
19305 The @option{-mhard-dfp} option allows GCC to generate the decimal
19306 floating-point instructions implemented on some POWER processors.
19308 The @option{-mpowerpc64} option allows GCC to generate the additional
19309 64-bit instructions that are found in the full PowerPC64 architecture
19310 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19311 @option{-mno-powerpc64}.
19313 @item -mcpu=@var{cpu_type}
19314 @opindex mcpu
19315 Set architecture type, register usage, and
19316 instruction scheduling parameters for machine type @var{cpu_type}.
19317 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19318 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19319 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19320 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19321 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19322 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19323 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19324 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19325 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19326 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19327 @samp{powerpc64}, and @samp{rs64}.
19329 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19330 PowerPC and 64-bit PowerPC architecture machine
19331 types, with an appropriate, generic processor model assumed for
19332 scheduling purposes.
19334 The other options specify a specific processor.  Code generated under
19335 those options runs best on that processor, and may not run at all on
19336 others.
19338 The @option{-mcpu} options automatically enable or disable the
19339 following options:
19341 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19342 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19343 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19344 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19345 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19346 -mquad-memory -mquad-memory-atomic}
19348 The particular options set for any particular CPU varies between
19349 compiler versions, depending on what setting seems to produce optimal
19350 code for that CPU; it doesn't necessarily reflect the actual hardware's
19351 capabilities.  If you wish to set an individual option to a particular
19352 value, you may specify it after the @option{-mcpu} option, like
19353 @option{-mcpu=970 -mno-altivec}.
19355 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19356 not enabled or disabled by the @option{-mcpu} option at present because
19357 AIX does not have full support for these options.  You may still
19358 enable or disable them individually if you're sure it'll work in your
19359 environment.
19361 @item -mtune=@var{cpu_type}
19362 @opindex mtune
19363 Set the instruction scheduling parameters for machine type
19364 @var{cpu_type}, but do not set the architecture type or register usage,
19365 as @option{-mcpu=@var{cpu_type}} does.  The same
19366 values for @var{cpu_type} are used for @option{-mtune} as for
19367 @option{-mcpu}.  If both are specified, the code generated uses the
19368 architecture and registers set by @option{-mcpu}, but the
19369 scheduling parameters set by @option{-mtune}.
19371 @item -mcmodel=small
19372 @opindex mcmodel=small
19373 Generate PowerPC64 code for the small model: The TOC is limited to
19374 64k.
19376 @item -mcmodel=medium
19377 @opindex mcmodel=medium
19378 Generate PowerPC64 code for the medium model: The TOC and other static
19379 data may be up to a total of 4G in size.
19381 @item -mcmodel=large
19382 @opindex mcmodel=large
19383 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19384 in size.  Other data and code is only limited by the 64-bit address
19385 space.
19387 @item -maltivec
19388 @itemx -mno-altivec
19389 @opindex maltivec
19390 @opindex mno-altivec
19391 Generate code that uses (does not use) AltiVec instructions, and also
19392 enable the use of built-in functions that allow more direct access to
19393 the AltiVec instruction set.  You may also need to set
19394 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19395 enhancements.
19397 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19398 @option{-maltivec=be}, the element order for Altivec intrinsics such
19399 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19400 match array element order corresponding to the endianness of the
19401 target.  That is, element zero identifies the leftmost element in a
19402 vector register when targeting a big-endian platform, and identifies
19403 the rightmost element in a vector register when targeting a
19404 little-endian platform.
19406 @item -maltivec=be
19407 @opindex maltivec=be
19408 Generate Altivec instructions using big-endian element order,
19409 regardless of whether the target is big- or little-endian.  This is
19410 the default when targeting a big-endian platform.
19412 The element order is used to interpret element numbers in Altivec
19413 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19414 @code{vec_insert}.  By default, these will match array element order
19415 corresponding to the endianness for the target.
19417 @item -maltivec=le
19418 @opindex maltivec=le
19419 Generate Altivec instructions using little-endian element order,
19420 regardless of whether the target is big- or little-endian.  This is
19421 the default when targeting a little-endian platform.  This option is
19422 currently ignored when targeting a big-endian platform.
19424 The element order is used to interpret element numbers in Altivec
19425 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19426 @code{vec_insert}.  By default, these will match array element order
19427 corresponding to the endianness for the target.
19429 @item -mvrsave
19430 @itemx -mno-vrsave
19431 @opindex mvrsave
19432 @opindex mno-vrsave
19433 Generate VRSAVE instructions when generating AltiVec code.
19435 @item -mgen-cell-microcode
19436 @opindex mgen-cell-microcode
19437 Generate Cell microcode instructions.
19439 @item -mwarn-cell-microcode
19440 @opindex mwarn-cell-microcode
19441 Warn when a Cell microcode instruction is emitted.  An example
19442 of a Cell microcode instruction is a variable shift.
19444 @item -msecure-plt
19445 @opindex msecure-plt
19446 Generate code that allows @command{ld} and @command{ld.so}
19447 to build executables and shared
19448 libraries with non-executable @code{.plt} and @code{.got} sections.
19449 This is a PowerPC
19450 32-bit SYSV ABI option.
19452 @item -mbss-plt
19453 @opindex mbss-plt
19454 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19455 fills in, and
19456 requires @code{.plt} and @code{.got}
19457 sections that are both writable and executable.
19458 This is a PowerPC 32-bit SYSV ABI option.
19460 @item -misel
19461 @itemx -mno-isel
19462 @opindex misel
19463 @opindex mno-isel
19464 This switch enables or disables the generation of ISEL instructions.
19466 @item -misel=@var{yes/no}
19467 This switch has been deprecated.  Use @option{-misel} and
19468 @option{-mno-isel} instead.
19470 @item -mspe
19471 @itemx -mno-spe
19472 @opindex mspe
19473 @opindex mno-spe
19474 This switch enables or disables the generation of SPE simd
19475 instructions.
19477 @item -mpaired
19478 @itemx -mno-paired
19479 @opindex mpaired
19480 @opindex mno-paired
19481 This switch enables or disables the generation of PAIRED simd
19482 instructions.
19484 @item -mspe=@var{yes/no}
19485 This option has been deprecated.  Use @option{-mspe} and
19486 @option{-mno-spe} instead.
19488 @item -mvsx
19489 @itemx -mno-vsx
19490 @opindex mvsx
19491 @opindex mno-vsx
19492 Generate code that uses (does not use) vector/scalar (VSX)
19493 instructions, and also enable the use of built-in functions that allow
19494 more direct access to the VSX instruction set.
19496 @item -mcrypto
19497 @itemx -mno-crypto
19498 @opindex mcrypto
19499 @opindex mno-crypto
19500 Enable the use (disable) of the built-in functions that allow direct
19501 access to the cryptographic instructions that were added in version
19502 2.07 of the PowerPC ISA.
19504 @item -mdirect-move
19505 @itemx -mno-direct-move
19506 @opindex mdirect-move
19507 @opindex mno-direct-move
19508 Generate code that uses (does not use) the instructions to move data
19509 between the general purpose registers and the vector/scalar (VSX)
19510 registers that were added in version 2.07 of the PowerPC ISA.
19512 @item -mpower8-fusion
19513 @itemx -mno-power8-fusion
19514 @opindex mpower8-fusion
19515 @opindex mno-power8-fusion
19516 Generate code that keeps (does not keeps) some integer operations
19517 adjacent so that the instructions can be fused together on power8 and
19518 later processors.
19520 @item -mpower8-vector
19521 @itemx -mno-power8-vector
19522 @opindex mpower8-vector
19523 @opindex mno-power8-vector
19524 Generate code that uses (does not use) the vector and scalar
19525 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19526 enable the use of built-in functions that allow more direct access to
19527 the vector instructions.
19529 @item -mquad-memory
19530 @itemx -mno-quad-memory
19531 @opindex mquad-memory
19532 @opindex mno-quad-memory
19533 Generate code that uses (does not use) the non-atomic quad word memory
19534 instructions.  The @option{-mquad-memory} option requires use of
19535 64-bit mode.
19537 @item -mquad-memory-atomic
19538 @itemx -mno-quad-memory-atomic
19539 @opindex mquad-memory-atomic
19540 @opindex mno-quad-memory-atomic
19541 Generate code that uses (does not use) the atomic quad word memory
19542 instructions.  The @option{-mquad-memory-atomic} option requires use of
19543 64-bit mode.
19545 @item -mfloat-gprs=@var{yes/single/double/no}
19546 @itemx -mfloat-gprs
19547 @opindex mfloat-gprs
19548 This switch enables or disables the generation of floating-point
19549 operations on the general-purpose registers for architectures that
19550 support it.
19552 The argument @var{yes} or @var{single} enables the use of
19553 single-precision floating-point operations.
19555 The argument @var{double} enables the use of single and
19556 double-precision floating-point operations.
19558 The argument @var{no} disables floating-point operations on the
19559 general-purpose registers.
19561 This option is currently only available on the MPC854x.
19563 @item -m32
19564 @itemx -m64
19565 @opindex m32
19566 @opindex m64
19567 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19568 targets (including GNU/Linux).  The 32-bit environment sets int, long
19569 and pointer to 32 bits and generates code that runs on any PowerPC
19570 variant.  The 64-bit environment sets int to 32 bits and long and
19571 pointer to 64 bits, and generates code for PowerPC64, as for
19572 @option{-mpowerpc64}.
19574 @item -mfull-toc
19575 @itemx -mno-fp-in-toc
19576 @itemx -mno-sum-in-toc
19577 @itemx -mminimal-toc
19578 @opindex mfull-toc
19579 @opindex mno-fp-in-toc
19580 @opindex mno-sum-in-toc
19581 @opindex mminimal-toc
19582 Modify generation of the TOC (Table Of Contents), which is created for
19583 every executable file.  The @option{-mfull-toc} option is selected by
19584 default.  In that case, GCC allocates at least one TOC entry for
19585 each unique non-automatic variable reference in your program.  GCC
19586 also places floating-point constants in the TOC@.  However, only
19587 16,384 entries are available in the TOC@.
19589 If you receive a linker error message that saying you have overflowed
19590 the available TOC space, you can reduce the amount of TOC space used
19591 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19592 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19593 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19594 generate code to calculate the sum of an address and a constant at
19595 run time instead of putting that sum into the TOC@.  You may specify one
19596 or both of these options.  Each causes GCC to produce very slightly
19597 slower and larger code at the expense of conserving TOC space.
19599 If you still run out of space in the TOC even when you specify both of
19600 these options, specify @option{-mminimal-toc} instead.  This option causes
19601 GCC to make only one TOC entry for every file.  When you specify this
19602 option, GCC produces code that is slower and larger but which
19603 uses extremely little TOC space.  You may wish to use this option
19604 only on files that contain less frequently-executed code.
19606 @item -maix64
19607 @itemx -maix32
19608 @opindex maix64
19609 @opindex maix32
19610 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19611 @code{long} type, and the infrastructure needed to support them.
19612 Specifying @option{-maix64} implies @option{-mpowerpc64},
19613 while @option{-maix32} disables the 64-bit ABI and
19614 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19616 @item -mxl-compat
19617 @itemx -mno-xl-compat
19618 @opindex mxl-compat
19619 @opindex mno-xl-compat
19620 Produce code that conforms more closely to IBM XL compiler semantics
19621 when using AIX-compatible ABI@.  Pass floating-point arguments to
19622 prototyped functions beyond the register save area (RSA) on the stack
19623 in addition to argument FPRs.  Do not assume that most significant
19624 double in 128-bit long double value is properly rounded when comparing
19625 values and converting to double.  Use XL symbol names for long double
19626 support routines.
19628 The AIX calling convention was extended but not initially documented to
19629 handle an obscure K&R C case of calling a function that takes the
19630 address of its arguments with fewer arguments than declared.  IBM XL
19631 compilers access floating-point arguments that do not fit in the
19632 RSA from the stack when a subroutine is compiled without
19633 optimization.  Because always storing floating-point arguments on the
19634 stack is inefficient and rarely needed, this option is not enabled by
19635 default and only is necessary when calling subroutines compiled by IBM
19636 XL compilers without optimization.
19638 @item -mpe
19639 @opindex mpe
19640 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19641 application written to use message passing with special startup code to
19642 enable the application to run.  The system must have PE installed in the
19643 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19644 must be overridden with the @option{-specs=} option to specify the
19645 appropriate directory location.  The Parallel Environment does not
19646 support threads, so the @option{-mpe} option and the @option{-pthread}
19647 option are incompatible.
19649 @item -malign-natural
19650 @itemx -malign-power
19651 @opindex malign-natural
19652 @opindex malign-power
19653 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19654 @option{-malign-natural} overrides the ABI-defined alignment of larger
19655 types, such as floating-point doubles, on their natural size-based boundary.
19656 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19657 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19659 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19660 is not supported.
19662 @item -msoft-float
19663 @itemx -mhard-float
19664 @opindex msoft-float
19665 @opindex mhard-float
19666 Generate code that does not use (uses) the floating-point register set.
19667 Software floating-point emulation is provided if you use the
19668 @option{-msoft-float} option, and pass the option to GCC when linking.
19670 @item -msingle-float
19671 @itemx -mdouble-float
19672 @opindex msingle-float
19673 @opindex mdouble-float
19674 Generate code for single- or double-precision floating-point operations.
19675 @option{-mdouble-float} implies @option{-msingle-float}.
19677 @item -msimple-fpu
19678 @opindex msimple-fpu
19679 Do not generate @code{sqrt} and @code{div} instructions for hardware
19680 floating-point unit.
19682 @item -mfpu=@var{name}
19683 @opindex mfpu
19684 Specify type of floating-point unit.  Valid values for @var{name} are
19685 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19686 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19687 @samp{sp_full} (equivalent to @option{-msingle-float}),
19688 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19690 @item -mxilinx-fpu
19691 @opindex mxilinx-fpu
19692 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19694 @item -mmultiple
19695 @itemx -mno-multiple
19696 @opindex mmultiple
19697 @opindex mno-multiple
19698 Generate code that uses (does not use) the load multiple word
19699 instructions and the store multiple word instructions.  These
19700 instructions are generated by default on POWER systems, and not
19701 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19702 PowerPC systems, since those instructions do not work when the
19703 processor is in little-endian mode.  The exceptions are PPC740 and
19704 PPC750 which permit these instructions in little-endian mode.
19706 @item -mstring
19707 @itemx -mno-string
19708 @opindex mstring
19709 @opindex mno-string
19710 Generate code that uses (does not use) the load string instructions
19711 and the store string word instructions to save multiple registers and
19712 do small block moves.  These instructions are generated by default on
19713 POWER systems, and not generated on PowerPC systems.  Do not use
19714 @option{-mstring} on little-endian PowerPC systems, since those
19715 instructions do not work when the processor is in little-endian mode.
19716 The exceptions are PPC740 and PPC750 which permit these instructions
19717 in little-endian mode.
19719 @item -mupdate
19720 @itemx -mno-update
19721 @opindex mupdate
19722 @opindex mno-update
19723 Generate code that uses (does not use) the load or store instructions
19724 that update the base register to the address of the calculated memory
19725 location.  These instructions are generated by default.  If you use
19726 @option{-mno-update}, there is a small window between the time that the
19727 stack pointer is updated and the address of the previous frame is
19728 stored, which means code that walks the stack frame across interrupts or
19729 signals may get corrupted data.
19731 @item -mavoid-indexed-addresses
19732 @itemx -mno-avoid-indexed-addresses
19733 @opindex mavoid-indexed-addresses
19734 @opindex mno-avoid-indexed-addresses
19735 Generate code that tries to avoid (not avoid) the use of indexed load
19736 or store instructions. These instructions can incur a performance
19737 penalty on Power6 processors in certain situations, such as when
19738 stepping through large arrays that cross a 16M boundary.  This option
19739 is enabled by default when targeting Power6 and disabled otherwise.
19741 @item -mfused-madd
19742 @itemx -mno-fused-madd
19743 @opindex mfused-madd
19744 @opindex mno-fused-madd
19745 Generate code that uses (does not use) the floating-point multiply and
19746 accumulate instructions.  These instructions are generated by default
19747 if hardware floating point is used.  The machine-dependent
19748 @option{-mfused-madd} option is now mapped to the machine-independent
19749 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19750 mapped to @option{-ffp-contract=off}.
19752 @item -mmulhw
19753 @itemx -mno-mulhw
19754 @opindex mmulhw
19755 @opindex mno-mulhw
19756 Generate code that uses (does not use) the half-word multiply and
19757 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19758 These instructions are generated by default when targeting those
19759 processors.
19761 @item -mdlmzb
19762 @itemx -mno-dlmzb
19763 @opindex mdlmzb
19764 @opindex mno-dlmzb
19765 Generate code that uses (does not use) the string-search @samp{dlmzb}
19766 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19767 generated by default when targeting those processors.
19769 @item -mno-bit-align
19770 @itemx -mbit-align
19771 @opindex mno-bit-align
19772 @opindex mbit-align
19773 On System V.4 and embedded PowerPC systems do not (do) force structures
19774 and unions that contain bit-fields to be aligned to the base type of the
19775 bit-field.
19777 For example, by default a structure containing nothing but 8
19778 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19779 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19780 the structure is aligned to a 1-byte boundary and is 1 byte in
19781 size.
19783 @item -mno-strict-align
19784 @itemx -mstrict-align
19785 @opindex mno-strict-align
19786 @opindex mstrict-align
19787 On System V.4 and embedded PowerPC systems do not (do) assume that
19788 unaligned memory references are handled by the system.
19790 @item -mrelocatable
19791 @itemx -mno-relocatable
19792 @opindex mrelocatable
19793 @opindex mno-relocatable
19794 Generate code that allows (does not allow) a static executable to be
19795 relocated to a different address at run time.  A simple embedded
19796 PowerPC system loader should relocate the entire contents of
19797 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19798 a table of 32-bit addresses generated by this option.  For this to
19799 work, all objects linked together must be compiled with
19800 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19801 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19803 @item -mrelocatable-lib
19804 @itemx -mno-relocatable-lib
19805 @opindex mrelocatable-lib
19806 @opindex mno-relocatable-lib
19807 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19808 @code{.fixup} section to allow static executables to be relocated at
19809 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19810 alignment of @option{-mrelocatable}.  Objects compiled with
19811 @option{-mrelocatable-lib} may be linked with objects compiled with
19812 any combination of the @option{-mrelocatable} options.
19814 @item -mno-toc
19815 @itemx -mtoc
19816 @opindex mno-toc
19817 @opindex mtoc
19818 On System V.4 and embedded PowerPC systems do not (do) assume that
19819 register 2 contains a pointer to a global area pointing to the addresses
19820 used in the program.
19822 @item -mlittle
19823 @itemx -mlittle-endian
19824 @opindex mlittle
19825 @opindex mlittle-endian
19826 On System V.4 and embedded PowerPC systems compile code for the
19827 processor in little-endian mode.  The @option{-mlittle-endian} option is
19828 the same as @option{-mlittle}.
19830 @item -mbig
19831 @itemx -mbig-endian
19832 @opindex mbig
19833 @opindex mbig-endian
19834 On System V.4 and embedded PowerPC systems compile code for the
19835 processor in big-endian mode.  The @option{-mbig-endian} option is
19836 the same as @option{-mbig}.
19838 @item -mdynamic-no-pic
19839 @opindex mdynamic-no-pic
19840 On Darwin and Mac OS X systems, compile code so that it is not
19841 relocatable, but that its external references are relocatable.  The
19842 resulting code is suitable for applications, but not shared
19843 libraries.
19845 @item -msingle-pic-base
19846 @opindex msingle-pic-base
19847 Treat the register used for PIC addressing as read-only, rather than
19848 loading it in the prologue for each function.  The runtime system is
19849 responsible for initializing this register with an appropriate value
19850 before execution begins.
19852 @item -mprioritize-restricted-insns=@var{priority}
19853 @opindex mprioritize-restricted-insns
19854 This option controls the priority that is assigned to
19855 dispatch-slot restricted instructions during the second scheduling
19856 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19857 or @samp{2} to assign no, highest, or second-highest (respectively) 
19858 priority to dispatch-slot restricted
19859 instructions.
19861 @item -msched-costly-dep=@var{dependence_type}
19862 @opindex msched-costly-dep
19863 This option controls which dependences are considered costly
19864 by the target during instruction scheduling.  The argument
19865 @var{dependence_type} takes one of the following values:
19867 @table @asis
19868 @item @samp{no}
19869 No dependence is costly.
19871 @item @samp{all}
19872 All dependences are costly.
19874 @item @samp{true_store_to_load}
19875 A true dependence from store to load is costly.
19877 @item @samp{store_to_load}
19878 Any dependence from store to load is costly.
19880 @item @var{number}
19881 Any dependence for which the latency is greater than or equal to 
19882 @var{number} is costly.
19883 @end table
19885 @item -minsert-sched-nops=@var{scheme}
19886 @opindex minsert-sched-nops
19887 This option controls which NOP insertion scheme is used during
19888 the second scheduling pass.  The argument @var{scheme} takes one of the
19889 following values:
19891 @table @asis
19892 @item @samp{no}
19893 Don't insert NOPs.
19895 @item @samp{pad}
19896 Pad with NOPs any dispatch group that has vacant issue slots,
19897 according to the scheduler's grouping.
19899 @item @samp{regroup_exact}
19900 Insert NOPs to force costly dependent insns into
19901 separate groups.  Insert exactly as many NOPs as needed to force an insn
19902 to a new group, according to the estimated processor grouping.
19904 @item @var{number}
19905 Insert NOPs to force costly dependent insns into
19906 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19907 @end table
19909 @item -mcall-sysv
19910 @opindex mcall-sysv
19911 On System V.4 and embedded PowerPC systems compile code using calling
19912 conventions that adhere to the March 1995 draft of the System V
19913 Application Binary Interface, PowerPC processor supplement.  This is the
19914 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19916 @item -mcall-sysv-eabi
19917 @itemx -mcall-eabi
19918 @opindex mcall-sysv-eabi
19919 @opindex mcall-eabi
19920 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19922 @item -mcall-sysv-noeabi
19923 @opindex mcall-sysv-noeabi
19924 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19926 @item -mcall-aixdesc
19927 @opindex m
19928 On System V.4 and embedded PowerPC systems compile code for the AIX
19929 operating system.
19931 @item -mcall-linux
19932 @opindex mcall-linux
19933 On System V.4 and embedded PowerPC systems compile code for the
19934 Linux-based GNU system.
19936 @item -mcall-freebsd
19937 @opindex mcall-freebsd
19938 On System V.4 and embedded PowerPC systems compile code for the
19939 FreeBSD operating system.
19941 @item -mcall-netbsd
19942 @opindex mcall-netbsd
19943 On System V.4 and embedded PowerPC systems compile code for the
19944 NetBSD operating system.
19946 @item -mcall-openbsd
19947 @opindex mcall-netbsd
19948 On System V.4 and embedded PowerPC systems compile code for the
19949 OpenBSD operating system.
19951 @item -maix-struct-return
19952 @opindex maix-struct-return
19953 Return all structures in memory (as specified by the AIX ABI)@.
19955 @item -msvr4-struct-return
19956 @opindex msvr4-struct-return
19957 Return structures smaller than 8 bytes in registers (as specified by the
19958 SVR4 ABI)@.
19960 @item -mabi=@var{abi-type}
19961 @opindex mabi
19962 Extend the current ABI with a particular extension, or remove such extension.
19963 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
19964 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
19965 @var{elfv1}, @var{elfv2}@.
19967 @item -mabi=spe
19968 @opindex mabi=spe
19969 Extend the current ABI with SPE ABI extensions.  This does not change
19970 the default ABI, instead it adds the SPE ABI extensions to the current
19971 ABI@.
19973 @item -mabi=no-spe
19974 @opindex mabi=no-spe
19975 Disable Book-E SPE ABI extensions for the current ABI@.
19977 @item -mabi=ibmlongdouble
19978 @opindex mabi=ibmlongdouble
19979 Change the current ABI to use IBM extended-precision long double.
19980 This is a PowerPC 32-bit SYSV ABI option.
19982 @item -mabi=ieeelongdouble
19983 @opindex mabi=ieeelongdouble
19984 Change the current ABI to use IEEE extended-precision long double.
19985 This is a PowerPC 32-bit Linux ABI option.
19987 @item -mabi=elfv1
19988 @opindex mabi=elfv1
19989 Change the current ABI to use the ELFv1 ABI.
19990 This is the default ABI for big-endian PowerPC 64-bit Linux.
19991 Overriding the default ABI requires special system support and is
19992 likely to fail in spectacular ways.
19994 @item -mabi=elfv2
19995 @opindex mabi=elfv2
19996 Change the current ABI to use the ELFv2 ABI.
19997 This is the default ABI for little-endian PowerPC 64-bit Linux.
19998 Overriding the default ABI requires special system support and is
19999 likely to fail in spectacular ways.
20001 @item -mprototype
20002 @itemx -mno-prototype
20003 @opindex mprototype
20004 @opindex mno-prototype
20005 On System V.4 and embedded PowerPC systems assume that all calls to
20006 variable argument functions are properly prototyped.  Otherwise, the
20007 compiler must insert an instruction before every non-prototyped call to
20008 set or clear bit 6 of the condition code register (@var{CR}) to
20009 indicate whether floating-point values are passed in the floating-point
20010 registers in case the function takes variable arguments.  With
20011 @option{-mprototype}, only calls to prototyped variable argument functions
20012 set or clear the bit.
20014 @item -msim
20015 @opindex msim
20016 On embedded PowerPC systems, assume that the startup module is called
20017 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20018 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20019 configurations.
20021 @item -mmvme
20022 @opindex mmvme
20023 On embedded PowerPC systems, assume that the startup module is called
20024 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20025 @file{libc.a}.
20027 @item -mads
20028 @opindex mads
20029 On embedded PowerPC systems, assume that the startup module is called
20030 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20031 @file{libc.a}.
20033 @item -myellowknife
20034 @opindex myellowknife
20035 On embedded PowerPC systems, assume that the startup module is called
20036 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20037 @file{libc.a}.
20039 @item -mvxworks
20040 @opindex mvxworks
20041 On System V.4 and embedded PowerPC systems, specify that you are
20042 compiling for a VxWorks system.
20044 @item -memb
20045 @opindex memb
20046 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
20047 header to indicate that @samp{eabi} extended relocations are used.
20049 @item -meabi
20050 @itemx -mno-eabi
20051 @opindex meabi
20052 @opindex mno-eabi
20053 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20054 Embedded Applications Binary Interface (EABI), which is a set of
20055 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20056 means that the stack is aligned to an 8-byte boundary, a function
20057 @code{__eabi} is called from @code{main} to set up the EABI
20058 environment, and the @option{-msdata} option can use both @code{r2} and
20059 @code{r13} to point to two separate small data areas.  Selecting
20060 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20061 no EABI initialization function is called from @code{main}, and the
20062 @option{-msdata} option only uses @code{r13} to point to a single
20063 small data area.  The @option{-meabi} option is on by default if you
20064 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20066 @item -msdata=eabi
20067 @opindex msdata=eabi
20068 On System V.4 and embedded PowerPC systems, put small initialized
20069 @code{const} global and static data in the @samp{.sdata2} section, which
20070 is pointed to by register @code{r2}.  Put small initialized
20071 non-@code{const} global and static data in the @samp{.sdata} section,
20072 which is pointed to by register @code{r13}.  Put small uninitialized
20073 global and static data in the @samp{.sbss} section, which is adjacent to
20074 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
20075 incompatible with the @option{-mrelocatable} option.  The
20076 @option{-msdata=eabi} option also sets the @option{-memb} option.
20078 @item -msdata=sysv
20079 @opindex msdata=sysv
20080 On System V.4 and embedded PowerPC systems, put small global and static
20081 data in the @samp{.sdata} section, which is pointed to by register
20082 @code{r13}.  Put small uninitialized global and static data in the
20083 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
20084 The @option{-msdata=sysv} option is incompatible with the
20085 @option{-mrelocatable} option.
20087 @item -msdata=default
20088 @itemx -msdata
20089 @opindex msdata=default
20090 @opindex msdata
20091 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20092 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20093 same as @option{-msdata=sysv}.
20095 @item -msdata=data
20096 @opindex msdata=data
20097 On System V.4 and embedded PowerPC systems, put small global
20098 data in the @samp{.sdata} section.  Put small uninitialized global
20099 data in the @samp{.sbss} section.  Do not use register @code{r13}
20100 to address small data however.  This is the default behavior unless
20101 other @option{-msdata} options are used.
20103 @item -msdata=none
20104 @itemx -mno-sdata
20105 @opindex msdata=none
20106 @opindex mno-sdata
20107 On embedded PowerPC systems, put all initialized global and static data
20108 in the @samp{.data} section, and all uninitialized data in the
20109 @samp{.bss} section.
20111 @item -mblock-move-inline-limit=@var{num}
20112 @opindex mblock-move-inline-limit
20113 Inline all block moves (such as calls to @code{memcpy} or structure
20114 copies) less than or equal to @var{num} bytes.  The minimum value for
20115 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20116 targets.  The default value is target-specific.
20118 @item -G @var{num}
20119 @opindex G
20120 @cindex smaller data references (PowerPC)
20121 @cindex .sdata/.sdata2 references (PowerPC)
20122 On embedded PowerPC systems, put global and static items less than or
20123 equal to @var{num} bytes into the small data or BSS sections instead of
20124 the normal data or BSS section.  By default, @var{num} is 8.  The
20125 @option{-G @var{num}} switch is also passed to the linker.
20126 All modules should be compiled with the same @option{-G @var{num}} value.
20128 @item -mregnames
20129 @itemx -mno-regnames
20130 @opindex mregnames
20131 @opindex mno-regnames
20132 On System V.4 and embedded PowerPC systems do (do not) emit register
20133 names in the assembly language output using symbolic forms.
20135 @item -mlongcall
20136 @itemx -mno-longcall
20137 @opindex mlongcall
20138 @opindex mno-longcall
20139 By default assume that all calls are far away so that a longer and more
20140 expensive calling sequence is required.  This is required for calls
20141 farther than 32 megabytes (33,554,432 bytes) from the current location.
20142 A short call is generated if the compiler knows
20143 the call cannot be that far away.  This setting can be overridden by
20144 the @code{shortcall} function attribute, or by @code{#pragma
20145 longcall(0)}.
20147 Some linkers are capable of detecting out-of-range calls and generating
20148 glue code on the fly.  On these systems, long calls are unnecessary and
20149 generate slower code.  As of this writing, the AIX linker can do this,
20150 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20151 to the GNU linker for 32-bit PowerPC systems as well.
20153 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20154 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20155 addresses represent the callee and the branch island.  The
20156 Darwin/PPC linker prefers the first address and generates a @code{bl
20157 callee} if the PPC @code{bl} instruction reaches the callee directly;
20158 otherwise, the linker generates @code{bl L42} to call the branch
20159 island.  The branch island is appended to the body of the
20160 calling function; it computes the full 32-bit address of the callee
20161 and jumps to it.
20163 On Mach-O (Darwin) systems, this option directs the compiler emit to
20164 the glue for every direct call, and the Darwin linker decides whether
20165 to use or discard it.
20167 In the future, GCC may ignore all longcall specifications
20168 when the linker is known to generate glue.
20170 @item -mtls-markers
20171 @itemx -mno-tls-markers
20172 @opindex mtls-markers
20173 @opindex mno-tls-markers
20174 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20175 specifying the function argument.  The relocation allows the linker to
20176 reliably associate function call with argument setup instructions for
20177 TLS optimization, which in turn allows GCC to better schedule the
20178 sequence.
20180 @item -pthread
20181 @opindex pthread
20182 Adds support for multithreading with the @dfn{pthreads} library.
20183 This option sets flags for both the preprocessor and linker.
20185 @item -mrecip
20186 @itemx -mno-recip
20187 @opindex mrecip
20188 This option enables use of the reciprocal estimate and
20189 reciprocal square root estimate instructions with additional
20190 Newton-Raphson steps to increase precision instead of doing a divide or
20191 square root and divide for floating-point arguments.  You should use
20192 the @option{-ffast-math} option when using @option{-mrecip} (or at
20193 least @option{-funsafe-math-optimizations},
20194 @option{-finite-math-only}, @option{-freciprocal-math} and
20195 @option{-fno-trapping-math}).  Note that while the throughput of the
20196 sequence is generally higher than the throughput of the non-reciprocal
20197 instruction, the precision of the sequence can be decreased by up to 2
20198 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20199 roots.
20201 @item -mrecip=@var{opt}
20202 @opindex mrecip=opt
20203 This option controls which reciprocal estimate instructions
20204 may be used.  @var{opt} is a comma-separated list of options, which may
20205 be preceded by a @code{!} to invert the option:
20206 @code{all}: enable all estimate instructions,
20207 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
20208 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
20209 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
20210 @code{divf}: enable the single-precision reciprocal approximation instructions;
20211 @code{divd}: enable the double-precision reciprocal approximation instructions;
20212 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
20213 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
20214 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
20216 So, for example, @option{-mrecip=all,!rsqrtd} enables
20217 all of the reciprocal estimate instructions, except for the
20218 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20219 which handle the double-precision reciprocal square root calculations.
20221 @item -mrecip-precision
20222 @itemx -mno-recip-precision
20223 @opindex mrecip-precision
20224 Assume (do not assume) that the reciprocal estimate instructions
20225 provide higher-precision estimates than is mandated by the PowerPC
20226 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20227 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20228 The double-precision square root estimate instructions are not generated by
20229 default on low-precision machines, since they do not provide an
20230 estimate that converges after three steps.
20232 @item -mveclibabi=@var{type}
20233 @opindex mveclibabi
20234 Specifies the ABI type to use for vectorizing intrinsics using an
20235 external library.  The only type supported at present is @code{mass},
20236 which specifies to use IBM's Mathematical Acceleration Subsystem
20237 (MASS) libraries for vectorizing intrinsics using external libraries.
20238 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20239 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20240 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20241 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20242 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20243 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20244 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20245 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20246 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20247 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20248 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20249 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20250 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20251 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20252 for power7.  Both @option{-ftree-vectorize} and
20253 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20254 libraries must be specified at link time.
20256 @item -mfriz
20257 @itemx -mno-friz
20258 @opindex mfriz
20259 Generate (do not generate) the @code{friz} instruction when the
20260 @option{-funsafe-math-optimizations} option is used to optimize
20261 rounding of floating-point values to 64-bit integer and back to floating
20262 point.  The @code{friz} instruction does not return the same value if
20263 the floating-point number is too large to fit in an integer.
20265 @item -mpointers-to-nested-functions
20266 @itemx -mno-pointers-to-nested-functions
20267 @opindex mpointers-to-nested-functions
20268 Generate (do not generate) code to load up the static chain register
20269 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20270 systems where a function pointer points to a 3-word descriptor giving
20271 the function address, TOC value to be loaded in register @var{r2}, and
20272 static chain value to be loaded in register @var{r11}.  The
20273 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20274 call through pointers to nested functions or pointers
20275 to functions compiled in other languages that use the static chain if
20276 you use the @option{-mno-pointers-to-nested-functions}.
20278 @item -msave-toc-indirect
20279 @itemx -mno-save-toc-indirect
20280 @opindex msave-toc-indirect
20281 Generate (do not generate) code to save the TOC value in the reserved
20282 stack location in the function prologue if the function calls through
20283 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20284 saved in the prologue, it is saved just before the call through the
20285 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20287 @item -mcompat-align-parm
20288 @itemx -mno-compat-align-parm
20289 @opindex mcompat-align-parm
20290 Generate (do not generate) code to pass structure parameters with a
20291 maximum alignment of 64 bits, for compatibility with older versions
20292 of GCC.
20294 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20295 structure parameter on a 128-bit boundary when that structure contained
20296 a member requiring 128-bit alignment.  This is corrected in more
20297 recent versions of GCC.  This option may be used to generate code
20298 that is compatible with functions compiled with older versions of
20299 GCC.
20301 The @option{-mno-compat-align-parm} option is the default.
20302 @end table
20304 @node RX Options
20305 @subsection RX Options
20306 @cindex RX Options
20308 These command-line options are defined for RX targets:
20310 @table @gcctabopt
20311 @item -m64bit-doubles
20312 @itemx -m32bit-doubles
20313 @opindex m64bit-doubles
20314 @opindex m32bit-doubles
20315 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20316 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20317 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20318 works on 32-bit values, which is why the default is
20319 @option{-m32bit-doubles}.
20321 @item -fpu
20322 @itemx -nofpu
20323 @opindex fpu
20324 @opindex nofpu
20325 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20326 floating-point hardware.  The default is enabled for the @var{RX600}
20327 series and disabled for the @var{RX200} series.
20329 Floating-point instructions are only generated for 32-bit floating-point 
20330 values, however, so the FPU hardware is not used for doubles if the
20331 @option{-m64bit-doubles} option is used.
20333 @emph{Note} If the @option{-fpu} option is enabled then
20334 @option{-funsafe-math-optimizations} is also enabled automatically.
20335 This is because the RX FPU instructions are themselves unsafe.
20337 @item -mcpu=@var{name}
20338 @opindex -mcpu
20339 Selects the type of RX CPU to be targeted.  Currently three types are
20340 supported, the generic @var{RX600} and @var{RX200} series hardware and
20341 the specific @var{RX610} CPU.  The default is @var{RX600}.
20343 The only difference between @var{RX600} and @var{RX610} is that the
20344 @var{RX610} does not support the @code{MVTIPL} instruction.
20346 The @var{RX200} series does not have a hardware floating-point unit
20347 and so @option{-nofpu} is enabled by default when this type is
20348 selected.
20350 @item -mbig-endian-data
20351 @itemx -mlittle-endian-data
20352 @opindex mbig-endian-data
20353 @opindex mlittle-endian-data
20354 Store data (but not code) in the big-endian format.  The default is
20355 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20356 format.
20358 @item -msmall-data-limit=@var{N}
20359 @opindex msmall-data-limit
20360 Specifies the maximum size in bytes of global and static variables
20361 which can be placed into the small data area.  Using the small data
20362 area can lead to smaller and faster code, but the size of area is
20363 limited and it is up to the programmer to ensure that the area does
20364 not overflow.  Also when the small data area is used one of the RX's
20365 registers (usually @code{r13}) is reserved for use pointing to this
20366 area, so it is no longer available for use by the compiler.  This
20367 could result in slower and/or larger code if variables are pushed onto
20368 the stack instead of being held in this register.
20370 Note, common variables (variables that have not been initialized) and
20371 constants are not placed into the small data area as they are assigned
20372 to other sections in the output executable.
20374 The default value is zero, which disables this feature.  Note, this
20375 feature is not enabled by default with higher optimization levels
20376 (@option{-O2} etc) because of the potentially detrimental effects of
20377 reserving a register.  It is up to the programmer to experiment and
20378 discover whether this feature is of benefit to their program.  See the
20379 description of the @option{-mpid} option for a description of how the
20380 actual register to hold the small data area pointer is chosen.
20382 @item -msim
20383 @itemx -mno-sim
20384 @opindex msim
20385 @opindex mno-sim
20386 Use the simulator runtime.  The default is to use the libgloss
20387 board-specific runtime.
20389 @item -mas100-syntax
20390 @itemx -mno-as100-syntax
20391 @opindex mas100-syntax
20392 @opindex mno-as100-syntax
20393 When generating assembler output use a syntax that is compatible with
20394 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20395 assembler, but it has some restrictions so it is not generated by default.
20397 @item -mmax-constant-size=@var{N}
20398 @opindex mmax-constant-size
20399 Specifies the maximum size, in bytes, of a constant that can be used as
20400 an operand in a RX instruction.  Although the RX instruction set does
20401 allow constants of up to 4 bytes in length to be used in instructions,
20402 a longer value equates to a longer instruction.  Thus in some
20403 circumstances it can be beneficial to restrict the size of constants
20404 that are used in instructions.  Constants that are too big are instead
20405 placed into a constant pool and referenced via register indirection.
20407 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20408 or 4 means that constants of any size are allowed.
20410 @item -mrelax
20411 @opindex mrelax
20412 Enable linker relaxation.  Linker relaxation is a process whereby the
20413 linker attempts to reduce the size of a program by finding shorter
20414 versions of various instructions.  Disabled by default.
20416 @item -mint-register=@var{N}
20417 @opindex mint-register
20418 Specify the number of registers to reserve for fast interrupt handler
20419 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20420 means that register @code{r13} is reserved for the exclusive use
20421 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20422 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20423 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20424 A value of 0, the default, does not reserve any registers.
20426 @item -msave-acc-in-interrupts
20427 @opindex msave-acc-in-interrupts
20428 Specifies that interrupt handler functions should preserve the
20429 accumulator register.  This is only necessary if normal code might use
20430 the accumulator register, for example because it performs 64-bit
20431 multiplications.  The default is to ignore the accumulator as this
20432 makes the interrupt handlers faster.
20434 @item -mpid
20435 @itemx -mno-pid
20436 @opindex mpid
20437 @opindex mno-pid
20438 Enables the generation of position independent data.  When enabled any
20439 access to constant data is done via an offset from a base address
20440 held in a register.  This allows the location of constant data to be
20441 determined at run time without requiring the executable to be
20442 relocated, which is a benefit to embedded applications with tight
20443 memory constraints.  Data that can be modified is not affected by this
20444 option.
20446 Note, using this feature reserves a register, usually @code{r13}, for
20447 the constant data base address.  This can result in slower and/or
20448 larger code, especially in complicated functions.
20450 The actual register chosen to hold the constant data base address
20451 depends upon whether the @option{-msmall-data-limit} and/or the
20452 @option{-mint-register} command-line options are enabled.  Starting
20453 with register @code{r13} and proceeding downwards, registers are
20454 allocated first to satisfy the requirements of @option{-mint-register},
20455 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20456 is possible for the small data area register to be @code{r8} if both
20457 @option{-mint-register=4} and @option{-mpid} are specified on the
20458 command line.
20460 By default this feature is not enabled.  The default can be restored
20461 via the @option{-mno-pid} command-line option.
20463 @item -mno-warn-multiple-fast-interrupts
20464 @itemx -mwarn-multiple-fast-interrupts
20465 @opindex mno-warn-multiple-fast-interrupts
20466 @opindex mwarn-multiple-fast-interrupts
20467 Prevents GCC from issuing a warning message if it finds more than one
20468 fast interrupt handler when it is compiling a file.  The default is to
20469 issue a warning for each extra fast interrupt handler found, as the RX
20470 only supports one such interrupt.
20472 @end table
20474 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20475 has special significance to the RX port when used with the
20476 @code{interrupt} function attribute.  This attribute indicates a
20477 function intended to process fast interrupts.  GCC ensures
20478 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20479 and/or @code{r13} and only provided that the normal use of the
20480 corresponding registers have been restricted via the
20481 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20482 options.
20484 @node S/390 and zSeries Options
20485 @subsection S/390 and zSeries Options
20486 @cindex S/390 and zSeries Options
20488 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20490 @table @gcctabopt
20491 @item -mhard-float
20492 @itemx -msoft-float
20493 @opindex mhard-float
20494 @opindex msoft-float
20495 Use (do not use) the hardware floating-point instructions and registers
20496 for floating-point operations.  When @option{-msoft-float} is specified,
20497 functions in @file{libgcc.a} are used to perform floating-point
20498 operations.  When @option{-mhard-float} is specified, the compiler
20499 generates IEEE floating-point instructions.  This is the default.
20501 @item -mhard-dfp
20502 @itemx -mno-hard-dfp
20503 @opindex mhard-dfp
20504 @opindex mno-hard-dfp
20505 Use (do not use) the hardware decimal-floating-point instructions for
20506 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20507 specified, functions in @file{libgcc.a} are used to perform
20508 decimal-floating-point operations.  When @option{-mhard-dfp} is
20509 specified, the compiler generates decimal-floating-point hardware
20510 instructions.  This is the default for @option{-march=z9-ec} or higher.
20512 @item -mlong-double-64
20513 @itemx -mlong-double-128
20514 @opindex mlong-double-64
20515 @opindex mlong-double-128
20516 These switches control the size of @code{long double} type. A size
20517 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20518 type. This is the default.
20520 @item -mbackchain
20521 @itemx -mno-backchain
20522 @opindex mbackchain
20523 @opindex mno-backchain
20524 Store (do not store) the address of the caller's frame as backchain pointer
20525 into the callee's stack frame.
20526 A backchain may be needed to allow debugging using tools that do not understand
20527 DWARF 2 call frame information.
20528 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20529 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20530 the backchain is placed into the topmost word of the 96/160 byte register
20531 save area.
20533 In general, code compiled with @option{-mbackchain} is call-compatible with
20534 code compiled with @option{-mmo-backchain}; however, use of the backchain
20535 for debugging purposes usually requires that the whole binary is built with
20536 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20537 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20538 to build a linux kernel use @option{-msoft-float}.
20540 The default is to not maintain the backchain.
20542 @item -mpacked-stack
20543 @itemx -mno-packed-stack
20544 @opindex mpacked-stack
20545 @opindex mno-packed-stack
20546 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20547 specified, the compiler uses the all fields of the 96/160 byte register save
20548 area only for their default purpose; unused fields still take up stack space.
20549 When @option{-mpacked-stack} is specified, register save slots are densely
20550 packed at the top of the register save area; unused space is reused for other
20551 purposes, allowing for more efficient use of the available stack space.
20552 However, when @option{-mbackchain} is also in effect, the topmost word of
20553 the save area is always used to store the backchain, and the return address
20554 register is always saved two words below the backchain.
20556 As long as the stack frame backchain is not used, code generated with
20557 @option{-mpacked-stack} is call-compatible with code generated with
20558 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20559 S/390 or zSeries generated code that uses the stack frame backchain at run
20560 time, not just for debugging purposes.  Such code is not call-compatible
20561 with code compiled with @option{-mpacked-stack}.  Also, note that the
20562 combination of @option{-mbackchain},
20563 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20564 to build a linux kernel use @option{-msoft-float}.
20566 The default is to not use the packed stack layout.
20568 @item -msmall-exec
20569 @itemx -mno-small-exec
20570 @opindex msmall-exec
20571 @opindex mno-small-exec
20572 Generate (or do not generate) code using the @code{bras} instruction
20573 to do subroutine calls.
20574 This only works reliably if the total executable size does not
20575 exceed 64k.  The default is to use the @code{basr} instruction instead,
20576 which does not have this limitation.
20578 @item -m64
20579 @itemx -m31
20580 @opindex m64
20581 @opindex m31
20582 When @option{-m31} is specified, generate code compliant to the
20583 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20584 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20585 particular to generate 64-bit instructions.  For the @samp{s390}
20586 targets, the default is @option{-m31}, while the @samp{s390x}
20587 targets default to @option{-m64}.
20589 @item -mzarch
20590 @itemx -mesa
20591 @opindex mzarch
20592 @opindex mesa
20593 When @option{-mzarch} is specified, generate code using the
20594 instructions available on z/Architecture.
20595 When @option{-mesa} is specified, generate code using the
20596 instructions available on ESA/390.  Note that @option{-mesa} is
20597 not possible with @option{-m64}.
20598 When generating code compliant to the GNU/Linux for S/390 ABI,
20599 the default is @option{-mesa}.  When generating code compliant
20600 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20602 @item -mmvcle
20603 @itemx -mno-mvcle
20604 @opindex mmvcle
20605 @opindex mno-mvcle
20606 Generate (or do not generate) code using the @code{mvcle} instruction
20607 to perform block moves.  When @option{-mno-mvcle} is specified,
20608 use a @code{mvc} loop instead.  This is the default unless optimizing for
20609 size.
20611 @item -mdebug
20612 @itemx -mno-debug
20613 @opindex mdebug
20614 @opindex mno-debug
20615 Print (or do not print) additional debug information when compiling.
20616 The default is to not print debug information.
20618 @item -march=@var{cpu-type}
20619 @opindex march
20620 Generate code that runs on @var{cpu-type}, which is the name of a system
20621 representing a certain processor type.  Possible values for
20622 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20623 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20624 When generating code using the instructions available on z/Architecture,
20625 the default is @option{-march=z900}.  Otherwise, the default is
20626 @option{-march=g5}.
20628 @item -mtune=@var{cpu-type}
20629 @opindex mtune
20630 Tune to @var{cpu-type} everything applicable about the generated code,
20631 except for the ABI and the set of available instructions.
20632 The list of @var{cpu-type} values is the same as for @option{-march}.
20633 The default is the value used for @option{-march}.
20635 @item -mtpf-trace
20636 @itemx -mno-tpf-trace
20637 @opindex mtpf-trace
20638 @opindex mno-tpf-trace
20639 Generate code that adds (does not add) in TPF OS specific branches to trace
20640 routines in the operating system.  This option is off by default, even
20641 when compiling for the TPF OS@.
20643 @item -mfused-madd
20644 @itemx -mno-fused-madd
20645 @opindex mfused-madd
20646 @opindex mno-fused-madd
20647 Generate code that uses (does not use) the floating-point multiply and
20648 accumulate instructions.  These instructions are generated by default if
20649 hardware floating point is used.
20651 @item -mwarn-framesize=@var{framesize}
20652 @opindex mwarn-framesize
20653 Emit a warning if the current function exceeds the given frame size.  Because
20654 this is a compile-time check it doesn't need to be a real problem when the program
20655 runs.  It is intended to identify functions that most probably cause
20656 a stack overflow.  It is useful to be used in an environment with limited stack
20657 size e.g.@: the linux kernel.
20659 @item -mwarn-dynamicstack
20660 @opindex mwarn-dynamicstack
20661 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20662 arrays.  This is generally a bad idea with a limited stack size.
20664 @item -mstack-guard=@var{stack-guard}
20665 @itemx -mstack-size=@var{stack-size}
20666 @opindex mstack-guard
20667 @opindex mstack-size
20668 If these options are provided the S/390 back end emits additional instructions in
20669 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20670 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20671 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20672 the frame size of the compiled function is chosen.
20673 These options are intended to be used to help debugging stack overflow problems.
20674 The additionally emitted code causes only little overhead and hence can also be
20675 used in production-like systems without greater performance degradation.  The given
20676 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20677 @var{stack-guard} without exceeding 64k.
20678 In order to be efficient the extra code makes the assumption that the stack starts
20679 at an address aligned to the value given by @var{stack-size}.
20680 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20682 @item -mhotpatch[=@var{halfwords}]
20683 @itemx -mno-hotpatch
20684 @opindex mhotpatch
20685 If the hotpatch option is enabled, a ``hot-patching'' function
20686 prologue is generated for all functions in the compilation unit.
20687 The funtion label is prepended with the given number of two-byte
20688 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
20689 instructions if no argument is present.  Functions with a
20690 hot-patching prologue are never inlined automatically, and a
20691 hot-patching prologue is never generated for functions
20692 that are explicitly inline.
20694 This option can be overridden for individual functions with the
20695 @code{hotpatch} attribute.
20696 @end table
20698 @node Score Options
20699 @subsection Score Options
20700 @cindex Score Options
20702 These options are defined for Score implementations:
20704 @table @gcctabopt
20705 @item -meb
20706 @opindex meb
20707 Compile code for big-endian mode.  This is the default.
20709 @item -mel
20710 @opindex mel
20711 Compile code for little-endian mode.
20713 @item -mnhwloop
20714 @opindex mnhwloop
20715 Disable generation of @code{bcnz} instructions.
20717 @item -muls
20718 @opindex muls
20719 Enable generation of unaligned load and store instructions.
20721 @item -mmac
20722 @opindex mmac
20723 Enable the use of multiply-accumulate instructions. Disabled by default.
20725 @item -mscore5
20726 @opindex mscore5
20727 Specify the SCORE5 as the target architecture.
20729 @item -mscore5u
20730 @opindex mscore5u
20731 Specify the SCORE5U of the target architecture.
20733 @item -mscore7
20734 @opindex mscore7
20735 Specify the SCORE7 as the target architecture. This is the default.
20737 @item -mscore7d
20738 @opindex mscore7d
20739 Specify the SCORE7D as the target architecture.
20740 @end table
20742 @node SH Options
20743 @subsection SH Options
20745 These @samp{-m} options are defined for the SH implementations:
20747 @table @gcctabopt
20748 @item -m1
20749 @opindex m1
20750 Generate code for the SH1.
20752 @item -m2
20753 @opindex m2
20754 Generate code for the SH2.
20756 @item -m2e
20757 Generate code for the SH2e.
20759 @item -m2a-nofpu
20760 @opindex m2a-nofpu
20761 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20762 that the floating-point unit is not used.
20764 @item -m2a-single-only
20765 @opindex m2a-single-only
20766 Generate code for the SH2a-FPU, in such a way that no double-precision
20767 floating-point operations are used.
20769 @item -m2a-single
20770 @opindex m2a-single
20771 Generate code for the SH2a-FPU assuming the floating-point unit is in
20772 single-precision mode by default.
20774 @item -m2a
20775 @opindex m2a
20776 Generate code for the SH2a-FPU assuming the floating-point unit is in
20777 double-precision mode by default.
20779 @item -m3
20780 @opindex m3
20781 Generate code for the SH3.
20783 @item -m3e
20784 @opindex m3e
20785 Generate code for the SH3e.
20787 @item -m4-nofpu
20788 @opindex m4-nofpu
20789 Generate code for the SH4 without a floating-point unit.
20791 @item -m4-single-only
20792 @opindex m4-single-only
20793 Generate code for the SH4 with a floating-point unit that only
20794 supports single-precision arithmetic.
20796 @item -m4-single
20797 @opindex m4-single
20798 Generate code for the SH4 assuming the floating-point unit is in
20799 single-precision mode by default.
20801 @item -m4
20802 @opindex m4
20803 Generate code for the SH4.
20805 @item -m4-100
20806 @opindex m4-100
20807 Generate code for SH4-100.
20809 @item -m4-100-nofpu
20810 @opindex m4-100-nofpu
20811 Generate code for SH4-100 in such a way that the
20812 floating-point unit is not used.
20814 @item -m4-100-single
20815 @opindex m4-100-single
20816 Generate code for SH4-100 assuming the floating-point unit is in
20817 single-precision mode by default.
20819 @item -m4-100-single-only
20820 @opindex m4-100-single-only
20821 Generate code for SH4-100 in such a way that no double-precision
20822 floating-point operations are used.
20824 @item -m4-200
20825 @opindex m4-200
20826 Generate code for SH4-200.
20828 @item -m4-200-nofpu
20829 @opindex m4-200-nofpu
20830 Generate code for SH4-200 without in such a way that the
20831 floating-point unit is not used.
20833 @item -m4-200-single
20834 @opindex m4-200-single
20835 Generate code for SH4-200 assuming the floating-point unit is in
20836 single-precision mode by default.
20838 @item -m4-200-single-only
20839 @opindex m4-200-single-only
20840 Generate code for SH4-200 in such a way that no double-precision
20841 floating-point operations are used.
20843 @item -m4-300
20844 @opindex m4-300
20845 Generate code for SH4-300.
20847 @item -m4-300-nofpu
20848 @opindex m4-300-nofpu
20849 Generate code for SH4-300 without in such a way that the
20850 floating-point unit is not used.
20852 @item -m4-300-single
20853 @opindex m4-300-single
20854 Generate code for SH4-300 in such a way that no double-precision
20855 floating-point operations are used.
20857 @item -m4-300-single-only
20858 @opindex m4-300-single-only
20859 Generate code for SH4-300 in such a way that no double-precision
20860 floating-point operations are used.
20862 @item -m4-340
20863 @opindex m4-340
20864 Generate code for SH4-340 (no MMU, no FPU).
20866 @item -m4-500
20867 @opindex m4-500
20868 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20869 assembler.
20871 @item -m4a-nofpu
20872 @opindex m4a-nofpu
20873 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20874 floating-point unit is not used.
20876 @item -m4a-single-only
20877 @opindex m4a-single-only
20878 Generate code for the SH4a, in such a way that no double-precision
20879 floating-point operations are used.
20881 @item -m4a-single
20882 @opindex m4a-single
20883 Generate code for the SH4a assuming the floating-point unit is in
20884 single-precision mode by default.
20886 @item -m4a
20887 @opindex m4a
20888 Generate code for the SH4a.
20890 @item -m4al
20891 @opindex m4al
20892 Same as @option{-m4a-nofpu}, except that it implicitly passes
20893 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20894 instructions at the moment.
20896 @item -m5-32media
20897 @opindex m5-32media
20898 Generate 32-bit code for SHmedia.
20900 @item -m5-32media-nofpu
20901 @opindex m5-32media-nofpu
20902 Generate 32-bit code for SHmedia in such a way that the
20903 floating-point unit is not used.
20905 @item -m5-64media
20906 @opindex m5-64media
20907 Generate 64-bit code for SHmedia.
20909 @item -m5-64media-nofpu
20910 @opindex m5-64media-nofpu
20911 Generate 64-bit code for SHmedia in such a way that the
20912 floating-point unit is not used.
20914 @item -m5-compact
20915 @opindex m5-compact
20916 Generate code for SHcompact.
20918 @item -m5-compact-nofpu
20919 @opindex m5-compact-nofpu
20920 Generate code for SHcompact in such a way that the
20921 floating-point unit is not used.
20923 @item -mb
20924 @opindex mb
20925 Compile code for the processor in big-endian mode.
20927 @item -ml
20928 @opindex ml
20929 Compile code for the processor in little-endian mode.
20931 @item -mdalign
20932 @opindex mdalign
20933 Align doubles at 64-bit boundaries.  Note that this changes the calling
20934 conventions, and thus some functions from the standard C library do
20935 not work unless you recompile it first with @option{-mdalign}.
20937 @item -mrelax
20938 @opindex mrelax
20939 Shorten some address references at link time, when possible; uses the
20940 linker option @option{-relax}.
20942 @item -mbigtable
20943 @opindex mbigtable
20944 Use 32-bit offsets in @code{switch} tables.  The default is to use
20945 16-bit offsets.
20947 @item -mbitops
20948 @opindex mbitops
20949 Enable the use of bit manipulation instructions on SH2A.
20951 @item -mfmovd
20952 @opindex mfmovd
20953 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20954 alignment constraints.
20956 @item -mrenesas
20957 @opindex mrenesas
20958 Comply with the calling conventions defined by Renesas.
20960 @item -mno-renesas
20961 @opindex mno-renesas
20962 Comply with the calling conventions defined for GCC before the Renesas
20963 conventions were available.  This option is the default for all
20964 targets of the SH toolchain.
20966 @item -mnomacsave
20967 @opindex mnomacsave
20968 Mark the @code{MAC} register as call-clobbered, even if
20969 @option{-mrenesas} is given.
20971 @item -mieee
20972 @itemx -mno-ieee
20973 @opindex mieee
20974 @opindex mno-ieee
20975 Control the IEEE compliance of floating-point comparisons, which affects the
20976 handling of cases where the result of a comparison is unordered.  By default
20977 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20978 enabled @option{-mno-ieee} is implicitly set, which results in faster
20979 floating-point greater-equal and less-equal comparisons.  The implcit settings
20980 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20982 @item -minline-ic_invalidate
20983 @opindex minline-ic_invalidate
20984 Inline code to invalidate instruction cache entries after setting up
20985 nested function trampolines.
20986 This option has no effect if @option{-musermode} is in effect and the selected
20987 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20988 instruction.
20989 If the selected code generation option does not allow the use of the @code{icbi}
20990 instruction, and @option{-musermode} is not in effect, the inlined code
20991 manipulates the instruction cache address array directly with an associative
20992 write.  This not only requires privileged mode at run time, but it also
20993 fails if the cache line had been mapped via the TLB and has become unmapped.
20995 @item -misize
20996 @opindex misize
20997 Dump instruction size and location in the assembly code.
20999 @item -mpadstruct
21000 @opindex mpadstruct
21001 This option is deprecated.  It pads structures to multiple of 4 bytes,
21002 which is incompatible with the SH ABI@.
21004 @item -matomic-model=@var{model}
21005 @opindex matomic-model=@var{model}
21006 Sets the model of atomic operations and additional parameters as a comma
21007 separated list.  For details on the atomic built-in functions see
21008 @ref{__atomic Builtins}.  The following models and parameters are supported:
21010 @table @samp
21012 @item none
21013 Disable compiler generated atomic sequences and emit library calls for atomic
21014 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21016 @item soft-gusa
21017 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21018 built-in functions.  The generated atomic sequences require additional support
21019 from the interrupt/exception handling code of the system and are only suitable
21020 for SH3* and SH4* single-core systems.  This option is enabled by default when
21021 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21022 this option will also partially utilize the hardware atomic instructions
21023 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21024 @samp{strict} is specified.  
21026 @item soft-tcb
21027 Generate software atomic sequences that use a variable in the thread control
21028 block.  This is a variation of the gUSA sequences which can also be used on
21029 SH1* and SH2* targets.  The generated atomic sequences require additional
21030 support from the interrupt/exception handling code of the system and are only
21031 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21032 parameter has to be specified as well.
21034 @item soft-imask
21035 Generate software atomic sequences that temporarily disable interrupts by
21036 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21037 in privileged mode and is only suitable for single-core systems.  Additional
21038 support from the interrupt/exception handling code of the system is not
21039 required.  This model is enabled by default when the target is
21040 @code{sh*-*-linux*} and SH1* or SH2*.
21042 @item hard-llcs
21043 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21044 instructions only.  This is only available on SH4A and is suitable for
21045 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21046 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21047 Code compiled with this option will also be compatible with other software
21048 atomic model interrupt/exception handling systems if executed on an SH4A
21049 system.  Additional support from the interrupt/exception handling code of the
21050 system is not required for this model.
21052 @item gbr-offset=
21053 This parameter specifies the offset in bytes of the variable in the thread
21054 control block structure that should be used by the generated atomic sequences
21055 when the @samp{soft-tcb} model has been selected.  For other models this
21056 parameter is ignored.  The specified value must be an integer multiple of four
21057 and in the range 0-1020.
21059 @item strict
21060 This parameter prevents mixed usage of multiple atomic models, even though they
21061 would be compatible, and will make the compiler generate atomic sequences of the
21062 specified model only.
21064 @end table
21066 @item -mtas
21067 @opindex mtas
21068 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21069 Notice that depending on the particular hardware and software configuration
21070 this can degrade overall performance due to the operand cache line flushes
21071 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21072 processors the @code{tas.b} instruction must be used with caution since it
21073 can result in data corruption for certain cache configurations.
21075 @item -mprefergot
21076 @opindex mprefergot
21077 When generating position-independent code, emit function calls using
21078 the Global Offset Table instead of the Procedure Linkage Table.
21080 @item -musermode
21081 @itemx -mno-usermode
21082 @opindex musermode
21083 @opindex mno-usermode
21084 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21085 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21086 inlined code would not work in user mode.  @option{-musermode} is the default
21087 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21088 @option{-musermode} has no effect, since there is no user mode.
21090 @item -multcost=@var{number}
21091 @opindex multcost=@var{number}
21092 Set the cost to assume for a multiply insn.
21094 @item -mdiv=@var{strategy}
21095 @opindex mdiv=@var{strategy}
21096 Set the division strategy to be used for integer division operations.
21097 For SHmedia @var{strategy} can be one of: 
21099 @table @samp
21101 @item fp 
21102 Performs the operation in floating point.  This has a very high latency,
21103 but needs only a few instructions, so it might be a good choice if
21104 your code has enough easily-exploitable ILP to allow the compiler to
21105 schedule the floating-point instructions together with other instructions.
21106 Division by zero causes a floating-point exception.
21108 @item inv
21109 Uses integer operations to calculate the inverse of the divisor,
21110 and then multiplies the dividend with the inverse.  This strategy allows
21111 CSE and hoisting of the inverse calculation.  Division by zero calculates
21112 an unspecified result, but does not trap.
21114 @item inv:minlat
21115 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21116 have been found, or if the entire operation has been hoisted to the same
21117 place, the last stages of the inverse calculation are intertwined with the
21118 final multiply to reduce the overall latency, at the expense of using a few
21119 more instructions, and thus offering fewer scheduling opportunities with
21120 other code.
21122 @item call
21123 Calls a library function that usually implements the @samp{inv:minlat}
21124 strategy.
21125 This gives high code density for @code{m5-*media-nofpu} compilations.
21127 @item call2
21128 Uses a different entry point of the same library function, where it
21129 assumes that a pointer to a lookup table has already been set up, which
21130 exposes the pointer load to CSE and code hoisting optimizations.
21132 @item inv:call
21133 @itemx inv:call2
21134 @itemx inv:fp
21135 Use the @samp{inv} algorithm for initial
21136 code generation, but if the code stays unoptimized, revert to the @samp{call},
21137 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21138 potentially-trapping side effect of division by zero is carried by a
21139 separate instruction, so it is possible that all the integer instructions
21140 are hoisted out, but the marker for the side effect stays where it is.
21141 A recombination to floating-point operations or a call is not possible
21142 in that case.
21144 @item inv20u
21145 @itemx inv20l
21146 Variants of the @samp{inv:minlat} strategy.  In the case
21147 that the inverse calculation is not separated from the multiply, they speed
21148 up division where the dividend fits into 20 bits (plus sign where applicable)
21149 by inserting a test to skip a number of operations in this case; this test
21150 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21151 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21153 @end table
21155 For targets other than SHmedia @var{strategy} can be one of:
21157 @table @samp
21159 @item call-div1
21160 Calls a library function that uses the single-step division instruction
21161 @code{div1} to perform the operation.  Division by zero calculates an
21162 unspecified result and does not trap.  This is the default except for SH4,
21163 SH2A and SHcompact.
21165 @item call-fp
21166 Calls a library function that performs the operation in double precision
21167 floating point.  Division by zero causes a floating-point exception.  This is
21168 the default for SHcompact with FPU.  Specifying this for targets that do not
21169 have a double precision FPU will default to @code{call-div1}.
21171 @item call-table
21172 Calls a library function that uses a lookup table for small divisors and
21173 the @code{div1} instruction with case distinction for larger divisors.  Division
21174 by zero calculates an unspecified result and does not trap.  This is the default
21175 for SH4.  Specifying this for targets that do not have dynamic shift
21176 instructions will default to @code{call-div1}.
21178 @end table
21180 When a division strategy has not been specified the default strategy will be
21181 selected based on the current target.  For SH2A the default strategy is to
21182 use the @code{divs} and @code{divu} instructions instead of library function
21183 calls.
21185 @item -maccumulate-outgoing-args
21186 @opindex maccumulate-outgoing-args
21187 Reserve space once for outgoing arguments in the function prologue rather
21188 than around each call.  Generally beneficial for performance and size.  Also
21189 needed for unwinding to avoid changing the stack frame around conditional code.
21191 @item -mdivsi3_libfunc=@var{name}
21192 @opindex mdivsi3_libfunc=@var{name}
21193 Set the name of the library function used for 32-bit signed division to
21194 @var{name}.
21195 This only affects the name used in the @samp{call} and @samp{inv:call}
21196 division strategies, and the compiler still expects the same
21197 sets of input/output/clobbered registers as if this option were not present.
21199 @item -mfixed-range=@var{register-range}
21200 @opindex mfixed-range
21201 Generate code treating the given register range as fixed registers.
21202 A fixed register is one that the register allocator can not use.  This is
21203 useful when compiling kernel code.  A register range is specified as
21204 two registers separated by a dash.  Multiple register ranges can be
21205 specified separated by a comma.
21207 @item -mindexed-addressing
21208 @opindex mindexed-addressing
21209 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21210 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21211 semantics for the indexed addressing mode.  The architecture allows the
21212 implementation of processors with 64-bit MMU, which the OS could use to
21213 get 32-bit addressing, but since no current hardware implementation supports
21214 this or any other way to make the indexed addressing mode safe to use in
21215 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21217 @item -mgettrcost=@var{number}
21218 @opindex mgettrcost=@var{number}
21219 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21220 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21222 @item -mpt-fixed
21223 @opindex mpt-fixed
21224 Assume @code{pt*} instructions won't trap.  This generally generates
21225 better-scheduled code, but is unsafe on current hardware.
21226 The current architecture
21227 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21228 anded with 3 is 3.
21229 This has the unintentional effect of making it unsafe to schedule these
21230 instructions before a branch, or hoist them out of a loop.  For example,
21231 @code{__do_global_ctors}, a part of @file{libgcc}
21232 that runs constructors at program
21233 startup, calls functions in a list which is delimited by @minus{}1.  With the
21234 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21235 That means that all the constructors run a bit more quickly, but when
21236 the loop comes to the end of the list, the program crashes because @code{ptabs}
21237 loads @minus{}1 into a target register.  
21239 Since this option is unsafe for any
21240 hardware implementing the current architecture specification, the default
21241 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21242 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21243 this deters register allocation from using target registers for storing
21244 ordinary integers.
21246 @item -minvalid-symbols
21247 @opindex minvalid-symbols
21248 Assume symbols might be invalid.  Ordinary function symbols generated by
21249 the compiler are always valid to load with
21250 @code{movi}/@code{shori}/@code{ptabs} or
21251 @code{movi}/@code{shori}/@code{ptrel},
21252 but with assembler and/or linker tricks it is possible
21253 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21254 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21255 It prevents cross-basic-block CSE, hoisting and most scheduling
21256 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21258 @item -mbranch-cost=@var{num}
21259 @opindex mbranch-cost=@var{num}
21260 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21261 make the compiler try to generate more branch-free code if possible.  
21262 If not specified the value is selected depending on the processor type that
21263 is being compiled for.
21265 @item -mzdcbranch
21266 @itemx -mno-zdcbranch
21267 @opindex mzdcbranch
21268 @opindex mno-zdcbranch
21269 Assume (do not assume) that zero displacement conditional branch instructions
21270 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21271 compiler will try to prefer zero displacement branch code sequences.  This is
21272 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21273 disabled by specifying @option{-mno-zdcbranch}.
21275 @item -mfused-madd
21276 @itemx -mno-fused-madd
21277 @opindex mfused-madd
21278 @opindex mno-fused-madd
21279 Generate code that uses (does not use) the floating-point multiply and
21280 accumulate instructions.  These instructions are generated by default
21281 if hardware floating point is used.  The machine-dependent
21282 @option{-mfused-madd} option is now mapped to the machine-independent
21283 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21284 mapped to @option{-ffp-contract=off}.
21286 @item -mfsca
21287 @itemx -mno-fsca
21288 @opindex mfsca
21289 @opindex mno-fsca
21290 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21291 and cosine approximations.  The option @code{-mfsca} must be used in
21292 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
21293 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
21294 approximations even if @code{-funsafe-math-optimizations} is in effect.
21296 @item -mfsrra
21297 @itemx -mno-fsrra
21298 @opindex mfsrra
21299 @opindex mno-fsrra
21300 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21301 reciprocal square root approximations.  The option @code{-mfsrra} must be used
21302 in combination with @code{-funsafe-math-optimizations} and
21303 @code{-ffinite-math-only}.  It is enabled by default when generating code for
21304 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
21305 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
21306 in effect.
21308 @item -mpretend-cmove
21309 @opindex mpretend-cmove
21310 Prefer zero-displacement conditional branches for conditional move instruction
21311 patterns.  This can result in faster code on the SH4 processor.
21313 @end table
21315 @node Solaris 2 Options
21316 @subsection Solaris 2 Options
21317 @cindex Solaris 2 options
21319 These @samp{-m} options are supported on Solaris 2:
21321 @table @gcctabopt
21322 @item -mclear-hwcap
21323 @opindex mclear-hwcap
21324 @option{-mclear-hwcap} tells the compiler to remove the hardware
21325 capabilities generated by the Solaris assembler.  This is only necessary
21326 when object files use ISA extensions not supported by the current
21327 machine, but check at runtime whether or not to use them.
21329 @item -mimpure-text
21330 @opindex mimpure-text
21331 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21332 the compiler to not pass @option{-z text} to the linker when linking a
21333 shared object.  Using this option, you can link position-dependent
21334 code into a shared object.
21336 @option{-mimpure-text} suppresses the ``relocations remain against
21337 allocatable but non-writable sections'' linker error message.
21338 However, the necessary relocations trigger copy-on-write, and the
21339 shared object is not actually shared across processes.  Instead of
21340 using @option{-mimpure-text}, you should compile all source code with
21341 @option{-fpic} or @option{-fPIC}.
21343 @end table
21345 These switches are supported in addition to the above on Solaris 2:
21347 @table @gcctabopt
21348 @item -pthreads
21349 @opindex pthreads
21350 Add support for multithreading using the POSIX threads library.  This
21351 option sets flags for both the preprocessor and linker.  This option does
21352 not affect the thread safety of object code produced  by the compiler or
21353 that of libraries supplied with it.
21355 @item -pthread
21356 @opindex pthread
21357 This is a synonym for @option{-pthreads}.
21358 @end table
21360 @node SPARC Options
21361 @subsection SPARC Options
21362 @cindex SPARC options
21364 These @samp{-m} options are supported on the SPARC:
21366 @table @gcctabopt
21367 @item -mno-app-regs
21368 @itemx -mapp-regs
21369 @opindex mno-app-regs
21370 @opindex mapp-regs
21371 Specify @option{-mapp-regs} to generate output using the global registers
21372 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21373 global register 1, each global register 2 through 4 is then treated as an
21374 allocable register that is clobbered by function calls.  This is the default.
21376 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21377 specify @option{-mno-app-regs}.  You should compile libraries and system
21378 software with this option.
21380 @item -mflat
21381 @itemx -mno-flat
21382 @opindex mflat
21383 @opindex mno-flat
21384 With @option{-mflat}, the compiler does not generate save/restore instructions
21385 and uses a ``flat'' or single register window model.  This model is compatible
21386 with the regular register window model.  The local registers and the input
21387 registers (0--5) are still treated as ``call-saved'' registers and are
21388 saved on the stack as needed.
21390 With @option{-mno-flat} (the default), the compiler generates save/restore
21391 instructions (except for leaf functions).  This is the normal operating mode.
21393 @item -mfpu
21394 @itemx -mhard-float
21395 @opindex mfpu
21396 @opindex mhard-float
21397 Generate output containing floating-point instructions.  This is the
21398 default.
21400 @item -mno-fpu
21401 @itemx -msoft-float
21402 @opindex mno-fpu
21403 @opindex msoft-float
21404 Generate output containing library calls for floating point.
21405 @strong{Warning:} the requisite libraries are not available for all SPARC
21406 targets.  Normally the facilities of the machine's usual C compiler are
21407 used, but this cannot be done directly in cross-compilation.  You must make
21408 your own arrangements to provide suitable library functions for
21409 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21410 @samp{sparclite-*-*} do provide software floating-point support.
21412 @option{-msoft-float} changes the calling convention in the output file;
21413 therefore, it is only useful if you compile @emph{all} of a program with
21414 this option.  In particular, you need to compile @file{libgcc.a}, the
21415 library that comes with GCC, with @option{-msoft-float} in order for
21416 this to work.
21418 @item -mhard-quad-float
21419 @opindex mhard-quad-float
21420 Generate output containing quad-word (long double) floating-point
21421 instructions.
21423 @item -msoft-quad-float
21424 @opindex msoft-quad-float
21425 Generate output containing library calls for quad-word (long double)
21426 floating-point instructions.  The functions called are those specified
21427 in the SPARC ABI@.  This is the default.
21429 As of this writing, there are no SPARC implementations that have hardware
21430 support for the quad-word floating-point instructions.  They all invoke
21431 a trap handler for one of these instructions, and then the trap handler
21432 emulates the effect of the instruction.  Because of the trap handler overhead,
21433 this is much slower than calling the ABI library routines.  Thus the
21434 @option{-msoft-quad-float} option is the default.
21436 @item -mno-unaligned-doubles
21437 @itemx -munaligned-doubles
21438 @opindex mno-unaligned-doubles
21439 @opindex munaligned-doubles
21440 Assume that doubles have 8-byte alignment.  This is the default.
21442 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21443 alignment only if they are contained in another type, or if they have an
21444 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21445 Specifying this option avoids some rare compatibility problems with code
21446 generated by other compilers.  It is not the default because it results
21447 in a performance loss, especially for floating-point code.
21449 @item -muser-mode
21450 @itemx -mno-user-mode
21451 @opindex muser-mode
21452 @opindex mno-user-mode
21453 Do not generate code that can only run in supervisor mode.  This is relevant
21454 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21455 default is @option{-mno-user-mode}.
21457 @item -mno-faster-structs
21458 @itemx -mfaster-structs
21459 @opindex mno-faster-structs
21460 @opindex mfaster-structs
21461 With @option{-mfaster-structs}, the compiler assumes that structures
21462 should have 8-byte alignment.  This enables the use of pairs of
21463 @code{ldd} and @code{std} instructions for copies in structure
21464 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21465 However, the use of this changed alignment directly violates the SPARC
21466 ABI@.  Thus, it's intended only for use on targets where the developer
21467 acknowledges that their resulting code is not directly in line with
21468 the rules of the ABI@.
21470 @item -mcpu=@var{cpu_type}
21471 @opindex mcpu
21472 Set the instruction set, register set, and instruction scheduling parameters
21473 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21474 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21475 @samp{leon}, @samp{leon3}, @samp{sparclite}, @samp{f930}, @samp{f934},
21476 @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21477 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21478 @samp{niagara3} and @samp{niagara4}.
21480 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21481 which selects the best architecture option for the host processor.
21482 @option{-mcpu=native} has no effect if GCC does not recognize
21483 the processor.
21485 Default instruction scheduling parameters are used for values that select
21486 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21487 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21489 Here is a list of each supported architecture and their supported
21490 implementations.
21492 @table @asis
21493 @item v7
21494 cypress
21496 @item v8
21497 supersparc, hypersparc, leon, leon3
21499 @item sparclite
21500 f930, f934, sparclite86x
21502 @item sparclet
21503 tsc701
21505 @item v9
21506 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21507 @end table
21509 By default (unless configured otherwise), GCC generates code for the V7
21510 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21511 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21512 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21513 SPARCStation 1, 2, IPX etc.
21515 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21516 architecture.  The only difference from V7 code is that the compiler emits
21517 the integer multiply and integer divide instructions which exist in SPARC-V8
21518 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21519 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21520 2000 series.
21522 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21523 the SPARC architecture.  This adds the integer multiply, integer divide step
21524 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21525 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21526 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21527 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21528 MB86934 chip, which is the more recent SPARClite with FPU@.
21530 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21531 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21532 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21533 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21534 optimizes it for the TEMIC SPARClet chip.
21536 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21537 architecture.  This adds 64-bit integer and floating-point move instructions,
21538 3 additional floating-point condition code registers and conditional move
21539 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21540 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21541 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21542 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21543 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21544 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21545 additionally optimizes it for Sun UltraSPARC T2 chips. With
21546 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21547 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21548 additionally optimizes it for Sun UltraSPARC T4 chips.
21550 @item -mtune=@var{cpu_type}
21551 @opindex mtune
21552 Set the instruction scheduling parameters for machine type
21553 @var{cpu_type}, but do not set the instruction set or register set that the
21554 option @option{-mcpu=@var{cpu_type}} does.
21556 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21557 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21558 that select a particular CPU implementation.  Those are @samp{cypress},
21559 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3}, @samp{f930},
21560 @samp{f934}, @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
21561 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3} and
21562 @samp{niagara4}.  With native Solaris and GNU/Linux toolchains, @samp{native}
21563 can also be used.
21565 @item -mv8plus
21566 @itemx -mno-v8plus
21567 @opindex mv8plus
21568 @opindex mno-v8plus
21569 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21570 difference from the V8 ABI is that the global and out registers are
21571 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21572 mode for all SPARC-V9 processors.
21574 @item -mvis
21575 @itemx -mno-vis
21576 @opindex mvis
21577 @opindex mno-vis
21578 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21579 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21581 @item -mvis2
21582 @itemx -mno-vis2
21583 @opindex mvis2
21584 @opindex mno-vis2
21585 With @option{-mvis2}, GCC generates code that takes advantage of
21586 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21587 default is @option{-mvis2} when targeting a cpu that supports such
21588 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21589 also sets @option{-mvis}.
21591 @item -mvis3
21592 @itemx -mno-vis3
21593 @opindex mvis3
21594 @opindex mno-vis3
21595 With @option{-mvis3}, GCC generates code that takes advantage of
21596 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21597 default is @option{-mvis3} when targeting a cpu that supports such
21598 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21599 also sets @option{-mvis2} and @option{-mvis}.
21601 @item -mcbcond
21602 @itemx -mno-cbcond
21603 @opindex mcbcond
21604 @opindex mno-cbcond
21605 With @option{-mcbcond}, GCC generates code that takes advantage of
21606 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21607 The default is @option{-mcbcond} when targeting a cpu that supports such
21608 instructions, such as niagara-4 and later.
21610 @item -mpopc
21611 @itemx -mno-popc
21612 @opindex mpopc
21613 @opindex mno-popc
21614 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21615 population count instruction.  The default is @option{-mpopc}
21616 when targeting a cpu that supports such instructions, such as Niagara-2 and
21617 later.
21619 @item -mfmaf
21620 @itemx -mno-fmaf
21621 @opindex mfmaf
21622 @opindex mno-fmaf
21623 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21624 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21625 when targeting a cpu that supports such instructions, such as Niagara-3 and
21626 later.
21628 @item -mfix-at697f
21629 @opindex mfix-at697f
21630 Enable the documented workaround for the single erratum of the Atmel AT697F
21631 processor (which corresponds to erratum #13 of the AT697E processor).
21633 @item -mfix-ut699
21634 @opindex mfix-ut699
21635 Enable the documented workarounds for the floating-point errata and the data
21636 cache nullify errata of the UT699 processor.
21637 @end table
21639 These @samp{-m} options are supported in addition to the above
21640 on SPARC-V9 processors in 64-bit environments:
21642 @table @gcctabopt
21643 @item -m32
21644 @itemx -m64
21645 @opindex m32
21646 @opindex m64
21647 Generate code for a 32-bit or 64-bit environment.
21648 The 32-bit environment sets int, long and pointer to 32 bits.
21649 The 64-bit environment sets int to 32 bits and long and pointer
21650 to 64 bits.
21652 @item -mcmodel=@var{which}
21653 @opindex mcmodel
21654 Set the code model to one of
21656 @table @samp
21657 @item medlow
21658 The Medium/Low code model: 64-bit addresses, programs
21659 must be linked in the low 32 bits of memory.  Programs can be statically
21660 or dynamically linked.
21662 @item medmid
21663 The Medium/Middle code model: 64-bit addresses, programs
21664 must be linked in the low 44 bits of memory, the text and data segments must
21665 be less than 2GB in size and the data segment must be located within 2GB of
21666 the text segment.
21668 @item medany
21669 The Medium/Anywhere code model: 64-bit addresses, programs
21670 may be linked anywhere in memory, the text and data segments must be less
21671 than 2GB in size and the data segment must be located within 2GB of the
21672 text segment.
21674 @item embmedany
21675 The Medium/Anywhere code model for embedded systems:
21676 64-bit addresses, the text and data segments must be less than 2GB in
21677 size, both starting anywhere in memory (determined at link time).  The
21678 global register %g4 points to the base of the data segment.  Programs
21679 are statically linked and PIC is not supported.
21680 @end table
21682 @item -mmemory-model=@var{mem-model}
21683 @opindex mmemory-model
21684 Set the memory model in force on the processor to one of
21686 @table @samp
21687 @item default
21688 The default memory model for the processor and operating system.
21690 @item rmo
21691 Relaxed Memory Order
21693 @item pso
21694 Partial Store Order
21696 @item tso
21697 Total Store Order
21699 @item sc
21700 Sequential Consistency
21701 @end table
21703 These memory models are formally defined in Appendix D of the Sparc V9
21704 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21706 @item -mstack-bias
21707 @itemx -mno-stack-bias
21708 @opindex mstack-bias
21709 @opindex mno-stack-bias
21710 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21711 frame pointer if present, are offset by @minus{}2047 which must be added back
21712 when making stack frame references.  This is the default in 64-bit mode.
21713 Otherwise, assume no such offset is present.
21714 @end table
21716 @node SPU Options
21717 @subsection SPU Options
21718 @cindex SPU options
21720 These @samp{-m} options are supported on the SPU:
21722 @table @gcctabopt
21723 @item -mwarn-reloc
21724 @itemx -merror-reloc
21725 @opindex mwarn-reloc
21726 @opindex merror-reloc
21728 The loader for SPU does not handle dynamic relocations.  By default, GCC
21729 gives an error when it generates code that requires a dynamic
21730 relocation.  @option{-mno-error-reloc} disables the error,
21731 @option{-mwarn-reloc} generates a warning instead.
21733 @item -msafe-dma
21734 @itemx -munsafe-dma
21735 @opindex msafe-dma
21736 @opindex munsafe-dma
21738 Instructions that initiate or test completion of DMA must not be
21739 reordered with respect to loads and stores of the memory that is being
21740 accessed.
21741 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21742 memory accesses, but that can lead to inefficient code in places where the
21743 memory is known to not change.  Rather than mark the memory as volatile,
21744 you can use @option{-msafe-dma} to tell the compiler to treat
21745 the DMA instructions as potentially affecting all memory.  
21747 @item -mbranch-hints
21748 @opindex mbranch-hints
21750 By default, GCC generates a branch hint instruction to avoid
21751 pipeline stalls for always-taken or probably-taken branches.  A hint
21752 is not generated closer than 8 instructions away from its branch.
21753 There is little reason to disable them, except for debugging purposes,
21754 or to make an object a little bit smaller.
21756 @item -msmall-mem
21757 @itemx -mlarge-mem
21758 @opindex msmall-mem
21759 @opindex mlarge-mem
21761 By default, GCC generates code assuming that addresses are never larger
21762 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21763 a full 32-bit address.
21765 @item -mstdmain
21766 @opindex mstdmain
21768 By default, GCC links against startup code that assumes the SPU-style
21769 main function interface (which has an unconventional parameter list).
21770 With @option{-mstdmain}, GCC links your program against startup
21771 code that assumes a C99-style interface to @code{main}, including a
21772 local copy of @code{argv} strings.
21774 @item -mfixed-range=@var{register-range}
21775 @opindex mfixed-range
21776 Generate code treating the given register range as fixed registers.
21777 A fixed register is one that the register allocator cannot use.  This is
21778 useful when compiling kernel code.  A register range is specified as
21779 two registers separated by a dash.  Multiple register ranges can be
21780 specified separated by a comma.
21782 @item -mea32
21783 @itemx -mea64
21784 @opindex mea32
21785 @opindex mea64
21786 Compile code assuming that pointers to the PPU address space accessed
21787 via the @code{__ea} named address space qualifier are either 32 or 64
21788 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21789 all object code in an executable must be compiled with the same setting.
21791 @item -maddress-space-conversion
21792 @itemx -mno-address-space-conversion
21793 @opindex maddress-space-conversion
21794 @opindex mno-address-space-conversion
21795 Allow/disallow treating the @code{__ea} address space as superset
21796 of the generic address space.  This enables explicit type casts
21797 between @code{__ea} and generic pointer as well as implicit
21798 conversions of generic pointers to @code{__ea} pointers.  The
21799 default is to allow address space pointer conversions.
21801 @item -mcache-size=@var{cache-size}
21802 @opindex mcache-size
21803 This option controls the version of libgcc that the compiler links to an
21804 executable and selects a software-managed cache for accessing variables
21805 in the @code{__ea} address space with a particular cache size.  Possible
21806 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21807 and @samp{128}.  The default cache size is 64KB.
21809 @item -matomic-updates
21810 @itemx -mno-atomic-updates
21811 @opindex matomic-updates
21812 @opindex mno-atomic-updates
21813 This option controls the version of libgcc that the compiler links to an
21814 executable and selects whether atomic updates to the software-managed
21815 cache of PPU-side variables are used.  If you use atomic updates, changes
21816 to a PPU variable from SPU code using the @code{__ea} named address space
21817 qualifier do not interfere with changes to other PPU variables residing
21818 in the same cache line from PPU code.  If you do not use atomic updates,
21819 such interference may occur; however, writing back cache lines is
21820 more efficient.  The default behavior is to use atomic updates.
21822 @item -mdual-nops
21823 @itemx -mdual-nops=@var{n}
21824 @opindex mdual-nops
21825 By default, GCC inserts nops to increase dual issue when it expects
21826 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21827 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21828 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21830 @item -mhint-max-nops=@var{n}
21831 @opindex mhint-max-nops
21832 Maximum number of nops to insert for a branch hint.  A branch hint must
21833 be at least 8 instructions away from the branch it is affecting.  GCC
21834 inserts up to @var{n} nops to enforce this, otherwise it does not
21835 generate the branch hint.
21837 @item -mhint-max-distance=@var{n}
21838 @opindex mhint-max-distance
21839 The encoding of the branch hint instruction limits the hint to be within
21840 256 instructions of the branch it is affecting.  By default, GCC makes
21841 sure it is within 125.
21843 @item -msafe-hints
21844 @opindex msafe-hints
21845 Work around a hardware bug that causes the SPU to stall indefinitely.
21846 By default, GCC inserts the @code{hbrp} instruction to make sure
21847 this stall won't happen.
21849 @end table
21851 @node System V Options
21852 @subsection Options for System V
21854 These additional options are available on System V Release 4 for
21855 compatibility with other compilers on those systems:
21857 @table @gcctabopt
21858 @item -G
21859 @opindex G
21860 Create a shared object.
21861 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21863 @item -Qy
21864 @opindex Qy
21865 Identify the versions of each tool used by the compiler, in a
21866 @code{.ident} assembler directive in the output.
21868 @item -Qn
21869 @opindex Qn
21870 Refrain from adding @code{.ident} directives to the output file (this is
21871 the default).
21873 @item -YP,@var{dirs}
21874 @opindex YP
21875 Search the directories @var{dirs}, and no others, for libraries
21876 specified with @option{-l}.
21878 @item -Ym,@var{dir}
21879 @opindex Ym
21880 Look in the directory @var{dir} to find the M4 preprocessor.
21881 The assembler uses this option.
21882 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21883 @c the generic assembler that comes with Solaris takes just -Ym.
21884 @end table
21886 @node TILE-Gx Options
21887 @subsection TILE-Gx Options
21888 @cindex TILE-Gx options
21890 These @samp{-m} options are supported on the TILE-Gx:
21892 @table @gcctabopt
21893 @item -mcmodel=small
21894 @opindex mcmodel=small
21895 Generate code for the small model.  The distance for direct calls is
21896 limited to 500M in either direction.  PC-relative addresses are 32
21897 bits.  Absolute addresses support the full address range.
21899 @item -mcmodel=large
21900 @opindex mcmodel=large
21901 Generate code for the large model.  There is no limitation on call
21902 distance, pc-relative addresses, or absolute addresses.
21904 @item -mcpu=@var{name}
21905 @opindex mcpu
21906 Selects the type of CPU to be targeted.  Currently the only supported
21907 type is @samp{tilegx}.
21909 @item -m32
21910 @itemx -m64
21911 @opindex m32
21912 @opindex m64
21913 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21914 environment sets int, long, and pointer to 32 bits.  The 64-bit
21915 environment sets int to 32 bits and long and pointer to 64 bits.
21917 @item -mbig-endian
21918 @itemx -mlittle-endian
21919 @opindex mbig-endian
21920 @opindex mlittle-endian
21921 Generate code in big/little endian mode, respectively.
21922 @end table
21924 @node TILEPro Options
21925 @subsection TILEPro Options
21926 @cindex TILEPro options
21928 These @samp{-m} options are supported on the TILEPro:
21930 @table @gcctabopt
21931 @item -mcpu=@var{name}
21932 @opindex mcpu
21933 Selects the type of CPU to be targeted.  Currently the only supported
21934 type is @samp{tilepro}.
21936 @item -m32
21937 @opindex m32
21938 Generate code for a 32-bit environment, which sets int, long, and
21939 pointer to 32 bits.  This is the only supported behavior so the flag
21940 is essentially ignored.
21941 @end table
21943 @node V850 Options
21944 @subsection V850 Options
21945 @cindex V850 Options
21947 These @samp{-m} options are defined for V850 implementations:
21949 @table @gcctabopt
21950 @item -mlong-calls
21951 @itemx -mno-long-calls
21952 @opindex mlong-calls
21953 @opindex mno-long-calls
21954 Treat all calls as being far away (near).  If calls are assumed to be
21955 far away, the compiler always loads the function's address into a
21956 register, and calls indirect through the pointer.
21958 @item -mno-ep
21959 @itemx -mep
21960 @opindex mno-ep
21961 @opindex mep
21962 Do not optimize (do optimize) basic blocks that use the same index
21963 pointer 4 or more times to copy pointer into the @code{ep} register, and
21964 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21965 option is on by default if you optimize.
21967 @item -mno-prolog-function
21968 @itemx -mprolog-function
21969 @opindex mno-prolog-function
21970 @opindex mprolog-function
21971 Do not use (do use) external functions to save and restore registers
21972 at the prologue and epilogue of a function.  The external functions
21973 are slower, but use less code space if more than one function saves
21974 the same number of registers.  The @option{-mprolog-function} option
21975 is on by default if you optimize.
21977 @item -mspace
21978 @opindex mspace
21979 Try to make the code as small as possible.  At present, this just turns
21980 on the @option{-mep} and @option{-mprolog-function} options.
21982 @item -mtda=@var{n}
21983 @opindex mtda
21984 Put static or global variables whose size is @var{n} bytes or less into
21985 the tiny data area that register @code{ep} points to.  The tiny data
21986 area can hold up to 256 bytes in total (128 bytes for byte references).
21988 @item -msda=@var{n}
21989 @opindex msda
21990 Put static or global variables whose size is @var{n} bytes or less into
21991 the small data area that register @code{gp} points to.  The small data
21992 area can hold up to 64 kilobytes.
21994 @item -mzda=@var{n}
21995 @opindex mzda
21996 Put static or global variables whose size is @var{n} bytes or less into
21997 the first 32 kilobytes of memory.
21999 @item -mv850
22000 @opindex mv850
22001 Specify that the target processor is the V850.
22003 @item -mv850e3v5
22004 @opindex mv850e3v5
22005 Specify that the target processor is the V850E3V5.  The preprocessor
22006 constant @samp{__v850e3v5__} is defined if this option is used.
22008 @item -mv850e2v4
22009 @opindex mv850e2v4
22010 Specify that the target processor is the V850E3V5.  This is an alias for
22011 the @option{-mv850e3v5} option.
22013 @item -mv850e2v3
22014 @opindex mv850e2v3
22015 Specify that the target processor is the V850E2V3.  The preprocessor
22016 constant @samp{__v850e2v3__} is defined if this option is used.
22018 @item -mv850e2
22019 @opindex mv850e2
22020 Specify that the target processor is the V850E2.  The preprocessor
22021 constant @samp{__v850e2__} is defined if this option is used.
22023 @item -mv850e1
22024 @opindex mv850e1
22025 Specify that the target processor is the V850E1.  The preprocessor
22026 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
22027 this option is used.
22029 @item -mv850es
22030 @opindex mv850es
22031 Specify that the target processor is the V850ES.  This is an alias for
22032 the @option{-mv850e1} option.
22034 @item -mv850e
22035 @opindex mv850e
22036 Specify that the target processor is the V850E@.  The preprocessor
22037 constant @samp{__v850e__} is defined if this option is used.
22039 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22040 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22041 are defined then a default target processor is chosen and the
22042 relevant @samp{__v850*__} preprocessor constant is defined.
22044 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
22045 defined, regardless of which processor variant is the target.
22047 @item -mdisable-callt
22048 @itemx -mno-disable-callt
22049 @opindex mdisable-callt
22050 @opindex mno-disable-callt
22051 This option suppresses generation of the @code{CALLT} instruction for the
22052 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22053 architecture.
22055 This option is enabled by default when the RH850 ABI is
22056 in use (see @option{-mrh850-abi}), and disabled by default when the
22057 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22058 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
22060 @item -mrelax
22061 @itemx -mno-relax
22062 @opindex mrelax
22063 @opindex mno-relax
22064 Pass on (or do not pass on) the @option{-mrelax} command line option
22065 to the assembler.
22067 @item -mlong-jumps
22068 @itemx -mno-long-jumps
22069 @opindex mlong-jumps
22070 @opindex mno-long-jumps
22071 Disable (or re-enable) the generation of PC-relative jump instructions.
22073 @item -msoft-float
22074 @itemx -mhard-float
22075 @opindex msoft-float
22076 @opindex mhard-float
22077 Disable (or re-enable) the generation of hardware floating point
22078 instructions.  This option is only significant when the target
22079 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22080 instructions are being generated then the C preprocessor symbol
22081 @code{__FPU_OK__} will be defined, otherwise the symbol
22082 @code{__NO_FPU__} will be defined.
22084 @item -mloop
22085 @opindex mloop
22086 Enables the use of the e3v5 LOOP instruction.  The use of this
22087 instruction is not enabled by default when the e3v5 architecture is
22088 selected because its use is still experimental.
22090 @item -mrh850-abi
22091 @itemx -mghs
22092 @opindex mrh850-abi
22093 @opindex mghs
22094 Enables support for the RH850 version of the V850 ABI.  This is the
22095 default.  With this version of the ABI the following rules apply:
22097 @itemize
22098 @item
22099 Integer sized structures and unions are returned via a memory pointer
22100 rather than a register.
22102 @item
22103 Large structures and unions (more than 8 bytes in size) are passed by
22104 value.
22106 @item
22107 Functions are aligned to 16-bit boundaries.
22109 @item
22110 The @option{-m8byte-align} command line option is supported.
22112 @item
22113 The @option{-mdisable-callt} command line option is enabled by
22114 default.  The @option{-mno-disable-callt} command line option is not
22115 supported.
22116 @end itemize
22118 When this version of the ABI is enabled the C preprocessor symbol
22119 @code{__V850_RH850_ABI__} is defined.
22121 @item -mgcc-abi
22122 @opindex mgcc-abi
22123 Enables support for the old GCC version of the V850 ABI.  With this
22124 version of the ABI the following rules apply:
22126 @itemize
22127 @item
22128 Integer sized structures and unions are returned in register @code{r10}.
22130 @item
22131 Large structures and unions (more than 8 bytes in size) are passed by
22132 reference.
22134 @item
22135 Functions are aligned to 32-bit boundaries, unless optimizing for
22136 size.
22138 @item
22139 The @option{-m8byte-align} command line option is not supported.
22141 @item
22142 The @option{-mdisable-callt} command line option is supported but not
22143 enabled by default.
22144 @end itemize
22146 When this version of the ABI is enabled the C preprocessor symbol
22147 @code{__V850_GCC_ABI__} is defined.
22149 @item -m8byte-align
22150 @itemx -mno-8byte-align
22151 @opindex m8byte-align
22152 @opindex mno-8byte-align
22153 Enables support for @code{doubles} and @code{long long} types to be
22154 aligned on 8-byte boundaries.  The default is to restrict the
22155 alignment of all objects to at most 4-bytes.  When
22156 @option{-m8byte-align} is in effect the C preprocessor symbol
22157 @code{__V850_8BYTE_ALIGN__} will be defined.
22159 @item -mbig-switch
22160 @opindex mbig-switch
22161 Generate code suitable for big switch tables.  Use this option only if
22162 the assembler/linker complain about out of range branches within a switch
22163 table.
22165 @item -mapp-regs
22166 @opindex mapp-regs
22167 This option causes r2 and r5 to be used in the code generated by
22168 the compiler.  This setting is the default.
22170 @item -mno-app-regs
22171 @opindex mno-app-regs
22172 This option causes r2 and r5 to be treated as fixed registers.
22174 @end table
22176 @node VAX Options
22177 @subsection VAX Options
22178 @cindex VAX options
22180 These @samp{-m} options are defined for the VAX:
22182 @table @gcctabopt
22183 @item -munix
22184 @opindex munix
22185 Do not output certain jump instructions (@code{aobleq} and so on)
22186 that the Unix assembler for the VAX cannot handle across long
22187 ranges.
22189 @item -mgnu
22190 @opindex mgnu
22191 Do output those jump instructions, on the assumption that the
22192 GNU assembler is being used.
22194 @item -mg
22195 @opindex mg
22196 Output code for G-format floating-point numbers instead of D-format.
22197 @end table
22199 @node VMS Options
22200 @subsection VMS Options
22202 These @samp{-m} options are defined for the VMS implementations:
22204 @table @gcctabopt
22205 @item -mvms-return-codes
22206 @opindex mvms-return-codes
22207 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22208 condition (e.g.@ error) codes.
22210 @item -mdebug-main=@var{prefix}
22211 @opindex mdebug-main=@var{prefix}
22212 Flag the first routine whose name starts with @var{prefix} as the main
22213 routine for the debugger.
22215 @item -mmalloc64
22216 @opindex mmalloc64
22217 Default to 64-bit memory allocation routines.
22219 @item -mpointer-size=@var{size}
22220 @opindex -mpointer-size=@var{size}
22221 Set the default size of pointers. Possible options for @var{size} are
22222 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22223 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22224 The later option disables @code{pragma pointer_size}.
22225 @end table
22227 @node VxWorks Options
22228 @subsection VxWorks Options
22229 @cindex VxWorks Options
22231 The options in this section are defined for all VxWorks targets.
22232 Options specific to the target hardware are listed with the other
22233 options for that target.
22235 @table @gcctabopt
22236 @item -mrtp
22237 @opindex mrtp
22238 GCC can generate code for both VxWorks kernels and real time processes
22239 (RTPs).  This option switches from the former to the latter.  It also
22240 defines the preprocessor macro @code{__RTP__}.
22242 @item -non-static
22243 @opindex non-static
22244 Link an RTP executable against shared libraries rather than static
22245 libraries.  The options @option{-static} and @option{-shared} can
22246 also be used for RTPs (@pxref{Link Options}); @option{-static}
22247 is the default.
22249 @item -Bstatic
22250 @itemx -Bdynamic
22251 @opindex Bstatic
22252 @opindex Bdynamic
22253 These options are passed down to the linker.  They are defined for
22254 compatibility with Diab.
22256 @item -Xbind-lazy
22257 @opindex Xbind-lazy
22258 Enable lazy binding of function calls.  This option is equivalent to
22259 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22261 @item -Xbind-now
22262 @opindex Xbind-now
22263 Disable lazy binding of function calls.  This option is the default and
22264 is defined for compatibility with Diab.
22265 @end table
22267 @node x86-64 Options
22268 @subsection x86-64 Options
22269 @cindex x86-64 options
22271 These are listed under @xref{i386 and x86-64 Options}.
22273 @node Xstormy16 Options
22274 @subsection Xstormy16 Options
22275 @cindex Xstormy16 Options
22277 These options are defined for Xstormy16:
22279 @table @gcctabopt
22280 @item -msim
22281 @opindex msim
22282 Choose startup files and linker script suitable for the simulator.
22283 @end table
22285 @node Xtensa Options
22286 @subsection Xtensa Options
22287 @cindex Xtensa Options
22289 These options are supported for Xtensa targets:
22291 @table @gcctabopt
22292 @item -mconst16
22293 @itemx -mno-const16
22294 @opindex mconst16
22295 @opindex mno-const16
22296 Enable or disable use of @code{CONST16} instructions for loading
22297 constant values.  The @code{CONST16} instruction is currently not a
22298 standard option from Tensilica.  When enabled, @code{CONST16}
22299 instructions are always used in place of the standard @code{L32R}
22300 instructions.  The use of @code{CONST16} is enabled by default only if
22301 the @code{L32R} instruction is not available.
22303 @item -mfused-madd
22304 @itemx -mno-fused-madd
22305 @opindex mfused-madd
22306 @opindex mno-fused-madd
22307 Enable or disable use of fused multiply/add and multiply/subtract
22308 instructions in the floating-point option.  This has no effect if the
22309 floating-point option is not also enabled.  Disabling fused multiply/add
22310 and multiply/subtract instructions forces the compiler to use separate
22311 instructions for the multiply and add/subtract operations.  This may be
22312 desirable in some cases where strict IEEE 754-compliant results are
22313 required: the fused multiply add/subtract instructions do not round the
22314 intermediate result, thereby producing results with @emph{more} bits of
22315 precision than specified by the IEEE standard.  Disabling fused multiply
22316 add/subtract instructions also ensures that the program output is not
22317 sensitive to the compiler's ability to combine multiply and add/subtract
22318 operations.
22320 @item -mserialize-volatile
22321 @itemx -mno-serialize-volatile
22322 @opindex mserialize-volatile
22323 @opindex mno-serialize-volatile
22324 When this option is enabled, GCC inserts @code{MEMW} instructions before
22325 @code{volatile} memory references to guarantee sequential consistency.
22326 The default is @option{-mserialize-volatile}.  Use
22327 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22329 @item -mforce-no-pic
22330 @opindex mforce-no-pic
22331 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22332 position-independent code (PIC), this option disables PIC for compiling
22333 kernel code.
22335 @item -mtext-section-literals
22336 @itemx -mno-text-section-literals
22337 @opindex mtext-section-literals
22338 @opindex mno-text-section-literals
22339 Control the treatment of literal pools.  The default is
22340 @option{-mno-text-section-literals}, which places literals in a separate
22341 section in the output file.  This allows the literal pool to be placed
22342 in a data RAM/ROM, and it also allows the linker to combine literal
22343 pools from separate object files to remove redundant literals and
22344 improve code size.  With @option{-mtext-section-literals}, the literals
22345 are interspersed in the text section in order to keep them as close as
22346 possible to their references.  This may be necessary for large assembly
22347 files.
22349 @item -mtarget-align
22350 @itemx -mno-target-align
22351 @opindex mtarget-align
22352 @opindex mno-target-align
22353 When this option is enabled, GCC instructs the assembler to
22354 automatically align instructions to reduce branch penalties at the
22355 expense of some code density.  The assembler attempts to widen density
22356 instructions to align branch targets and the instructions following call
22357 instructions.  If there are not enough preceding safe density
22358 instructions to align a target, no widening is performed.  The
22359 default is @option{-mtarget-align}.  These options do not affect the
22360 treatment of auto-aligned instructions like @code{LOOP}, which the
22361 assembler always aligns, either by widening density instructions or
22362 by inserting NOP instructions.
22364 @item -mlongcalls
22365 @itemx -mno-longcalls
22366 @opindex mlongcalls
22367 @opindex mno-longcalls
22368 When this option is enabled, GCC instructs the assembler to translate
22369 direct calls to indirect calls unless it can determine that the target
22370 of a direct call is in the range allowed by the call instruction.  This
22371 translation typically occurs for calls to functions in other source
22372 files.  Specifically, the assembler translates a direct @code{CALL}
22373 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22374 The default is @option{-mno-longcalls}.  This option should be used in
22375 programs where the call target can potentially be out of range.  This
22376 option is implemented in the assembler, not the compiler, so the
22377 assembly code generated by GCC still shows direct call
22378 instructions---look at the disassembled object code to see the actual
22379 instructions.  Note that the assembler uses an indirect call for
22380 every cross-file call, not just those that really are out of range.
22381 @end table
22383 @node zSeries Options
22384 @subsection zSeries Options
22385 @cindex zSeries options
22387 These are listed under @xref{S/390 and zSeries Options}.
22389 @node Code Gen Options
22390 @section Options for Code Generation Conventions
22391 @cindex code generation conventions
22392 @cindex options, code generation
22393 @cindex run-time options
22395 These machine-independent options control the interface conventions
22396 used in code generation.
22398 Most of them have both positive and negative forms; the negative form
22399 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22400 one of the forms is listed---the one that is not the default.  You
22401 can figure out the other form by either removing @samp{no-} or adding
22404 @table @gcctabopt
22405 @item -fbounds-check
22406 @opindex fbounds-check
22407 For front ends that support it, generate additional code to check that
22408 indices used to access arrays are within the declared range.  This is
22409 currently only supported by the Java and Fortran front ends, where
22410 this option defaults to true and false respectively.
22412 @item -fstack-reuse=@var{reuse-level}
22413 @opindex fstack_reuse
22414 This option controls stack space reuse for user declared local/auto variables
22415 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22416 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22417 local variables and temporaries, @samp{named_vars} enables the reuse only for
22418 user defined local variables with names, and @samp{none} disables stack reuse
22419 completely. The default value is @samp{all}. The option is needed when the
22420 program extends the lifetime of a scoped local variable or a compiler generated
22421 temporary beyond the end point defined by the language.  When a lifetime of
22422 a variable ends, and if the variable lives in memory, the optimizing compiler
22423 has the freedom to reuse its stack space with other temporaries or scoped
22424 local variables whose live range does not overlap with it. Legacy code extending
22425 local lifetime will likely to break with the stack reuse optimization.
22427 For example,
22429 @smallexample
22430    int *p;
22431    @{
22432      int local1;
22434      p = &local1;
22435      local1 = 10;
22436      ....
22437    @}
22438    @{
22439       int local2;
22440       local2 = 20;
22441       ...
22442    @}
22444    if (*p == 10)  // out of scope use of local1
22445      @{
22447      @}
22448 @end smallexample
22450 Another example:
22451 @smallexample
22453    struct A
22454    @{
22455        A(int k) : i(k), j(k) @{ @}
22456        int i;
22457        int j;
22458    @};
22460    A *ap;
22462    void foo(const A& ar)
22463    @{
22464       ap = &ar;
22465    @}
22467    void bar()
22468    @{
22469       foo(A(10)); // temp object's lifetime ends when foo returns
22471       @{
22472         A a(20);
22473         ....
22474       @}
22475       ap->i+= 10;  // ap references out of scope temp whose space
22476                    // is reused with a. What is the value of ap->i?
22477    @}
22479 @end smallexample
22481 The lifetime of a compiler generated temporary is well defined by the C++
22482 standard. When a lifetime of a temporary ends, and if the temporary lives
22483 in memory, the optimizing compiler has the freedom to reuse its stack
22484 space with other temporaries or scoped local variables whose live range
22485 does not overlap with it. However some of the legacy code relies on
22486 the behavior of older compilers in which temporaries' stack space is
22487 not reused, the aggressive stack reuse can lead to runtime errors. This
22488 option is used to control the temporary stack reuse optimization.
22490 @item -ftrapv
22491 @opindex ftrapv
22492 This option generates traps for signed overflow on addition, subtraction,
22493 multiplication operations.
22495 @item -fwrapv
22496 @opindex fwrapv
22497 This option instructs the compiler to assume that signed arithmetic
22498 overflow of addition, subtraction and multiplication wraps around
22499 using twos-complement representation.  This flag enables some optimizations
22500 and disables others.  This option is enabled by default for the Java
22501 front end, as required by the Java language specification.
22503 @item -fexceptions
22504 @opindex fexceptions
22505 Enable exception handling.  Generates extra code needed to propagate
22506 exceptions.  For some targets, this implies GCC generates frame
22507 unwind information for all functions, which can produce significant data
22508 size overhead, although it does not affect execution.  If you do not
22509 specify this option, GCC enables it by default for languages like
22510 C++ that normally require exception handling, and disables it for
22511 languages like C that do not normally require it.  However, you may need
22512 to enable this option when compiling C code that needs to interoperate
22513 properly with exception handlers written in C++.  You may also wish to
22514 disable this option if you are compiling older C++ programs that don't
22515 use exception handling.
22517 @item -fnon-call-exceptions
22518 @opindex fnon-call-exceptions
22519 Generate code that allows trapping instructions to throw exceptions.
22520 Note that this requires platform-specific runtime support that does
22521 not exist everywhere.  Moreover, it only allows @emph{trapping}
22522 instructions to throw exceptions, i.e.@: memory references or floating-point
22523 instructions.  It does not allow exceptions to be thrown from
22524 arbitrary signal handlers such as @code{SIGALRM}.
22526 @item -fdelete-dead-exceptions
22527 @opindex fdelete-dead-exceptions
22528 Consider that instructions that may throw exceptions but don't otherwise
22529 contribute to the execution of the program can be optimized away.
22530 This option is enabled by default for the Ada front end, as permitted by
22531 the Ada language specification.
22532 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22534 @item -funwind-tables
22535 @opindex funwind-tables
22536 Similar to @option{-fexceptions}, except that it just generates any needed
22537 static data, but does not affect the generated code in any other way.
22538 You normally do not need to enable this option; instead, a language processor
22539 that needs this handling enables it on your behalf.
22541 @item -fasynchronous-unwind-tables
22542 @opindex fasynchronous-unwind-tables
22543 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22544 table is exact at each instruction boundary, so it can be used for stack
22545 unwinding from asynchronous events (such as debugger or garbage collector).
22547 @item -fno-gnu-unique
22548 @opindex fno-gnu-unique
22549 On systems with recent GNU assembler and C library, the C++ compiler
22550 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22551 of template static data members and static local variables in inline
22552 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22553 is necessary to avoid problems with a library used by two different
22554 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22555 therefore disagreeing with the other one about the binding of the
22556 symbol.  But this causes @code{dlclose} to be ignored for affected
22557 DSOs; if your program relies on reinitialization of a DSO via
22558 @code{dlclose} and @code{dlopen}, you can use
22559 @option{-fno-gnu-unique}.
22561 @item -fpcc-struct-return
22562 @opindex fpcc-struct-return
22563 Return ``short'' @code{struct} and @code{union} values in memory like
22564 longer ones, rather than in registers.  This convention is less
22565 efficient, but it has the advantage of allowing intercallability between
22566 GCC-compiled files and files compiled with other compilers, particularly
22567 the Portable C Compiler (pcc).
22569 The precise convention for returning structures in memory depends
22570 on the target configuration macros.
22572 Short structures and unions are those whose size and alignment match
22573 that of some integer type.
22575 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22576 switch is not binary compatible with code compiled with the
22577 @option{-freg-struct-return} switch.
22578 Use it to conform to a non-default application binary interface.
22580 @item -freg-struct-return
22581 @opindex freg-struct-return
22582 Return @code{struct} and @code{union} values in registers when possible.
22583 This is more efficient for small structures than
22584 @option{-fpcc-struct-return}.
22586 If you specify neither @option{-fpcc-struct-return} nor
22587 @option{-freg-struct-return}, GCC defaults to whichever convention is
22588 standard for the target.  If there is no standard convention, GCC
22589 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22590 the principal compiler.  In those cases, we can choose the standard, and
22591 we chose the more efficient register return alternative.
22593 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22594 switch is not binary compatible with code compiled with the
22595 @option{-fpcc-struct-return} switch.
22596 Use it to conform to a non-default application binary interface.
22598 @item -fshort-enums
22599 @opindex fshort-enums
22600 Allocate to an @code{enum} type only as many bytes as it needs for the
22601 declared range of possible values.  Specifically, the @code{enum} type
22602 is equivalent to the smallest integer type that has enough room.
22604 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22605 code that is not binary compatible with code generated without that switch.
22606 Use it to conform to a non-default application binary interface.
22608 @item -fshort-double
22609 @opindex fshort-double
22610 Use the same size for @code{double} as for @code{float}.
22612 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22613 code that is not binary compatible with code generated without that switch.
22614 Use it to conform to a non-default application binary interface.
22616 @item -fshort-wchar
22617 @opindex fshort-wchar
22618 Override the underlying type for @samp{wchar_t} to be @samp{short
22619 unsigned int} instead of the default for the target.  This option is
22620 useful for building programs to run under WINE@.
22622 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22623 code that is not binary compatible with code generated without that switch.
22624 Use it to conform to a non-default application binary interface.
22626 @item -fno-common
22627 @opindex fno-common
22628 In C code, controls the placement of uninitialized global variables.
22629 Unix C compilers have traditionally permitted multiple definitions of
22630 such variables in different compilation units by placing the variables
22631 in a common block.
22632 This is the behavior specified by @option{-fcommon}, and is the default
22633 for GCC on most targets.
22634 On the other hand, this behavior is not required by ISO C, and on some
22635 targets may carry a speed or code size penalty on variable references.
22636 The @option{-fno-common} option specifies that the compiler should place
22637 uninitialized global variables in the data section of the object file,
22638 rather than generating them as common blocks.
22639 This has the effect that if the same variable is declared
22640 (without @code{extern}) in two different compilations,
22641 you get a multiple-definition error when you link them.
22642 In this case, you must compile with @option{-fcommon} instead.
22643 Compiling with @option{-fno-common} is useful on targets for which
22644 it provides better performance, or if you wish to verify that the
22645 program will work on other systems that always treat uninitialized
22646 variable declarations this way.
22648 @item -fno-ident
22649 @opindex fno-ident
22650 Ignore the @samp{#ident} directive.
22652 @item -finhibit-size-directive
22653 @opindex finhibit-size-directive
22654 Don't output a @code{.size} assembler directive, or anything else that
22655 would cause trouble if the function is split in the middle, and the
22656 two halves are placed at locations far apart in memory.  This option is
22657 used when compiling @file{crtstuff.c}; you should not need to use it
22658 for anything else.
22660 @item -fverbose-asm
22661 @opindex fverbose-asm
22662 Put extra commentary information in the generated assembly code to
22663 make it more readable.  This option is generally only of use to those
22664 who actually need to read the generated assembly code (perhaps while
22665 debugging the compiler itself).
22667 @option{-fno-verbose-asm}, the default, causes the
22668 extra information to be omitted and is useful when comparing two assembler
22669 files.
22671 @item -frecord-gcc-switches
22672 @opindex frecord-gcc-switches
22673 This switch causes the command line used to invoke the
22674 compiler to be recorded into the object file that is being created.
22675 This switch is only implemented on some targets and the exact format
22676 of the recording is target and binary file format dependent, but it
22677 usually takes the form of a section containing ASCII text.  This
22678 switch is related to the @option{-fverbose-asm} switch, but that
22679 switch only records information in the assembler output file as
22680 comments, so it never reaches the object file.
22681 See also @option{-grecord-gcc-switches} for another
22682 way of storing compiler options into the object file.
22684 @item -fpic
22685 @opindex fpic
22686 @cindex global offset table
22687 @cindex PIC
22688 Generate position-independent code (PIC) suitable for use in a shared
22689 library, if supported for the target machine.  Such code accesses all
22690 constant addresses through a global offset table (GOT)@.  The dynamic
22691 loader resolves the GOT entries when the program starts (the dynamic
22692 loader is not part of GCC; it is part of the operating system).  If
22693 the GOT size for the linked executable exceeds a machine-specific
22694 maximum size, you get an error message from the linker indicating that
22695 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
22696 instead.  (These maximums are 8k on the SPARC and 32k
22697 on the m68k and RS/6000.  The 386 has no such limit.)
22699 Position-independent code requires special support, and therefore works
22700 only on certain machines.  For the 386, GCC supports PIC for System V
22701 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
22702 position-independent.
22704 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22705 are defined to 1.
22707 @item -fPIC
22708 @opindex fPIC
22709 If supported for the target machine, emit position-independent code,
22710 suitable for dynamic linking and avoiding any limit on the size of the
22711 global offset table.  This option makes a difference on the m68k,
22712 PowerPC and SPARC@.
22714 Position-independent code requires special support, and therefore works
22715 only on certain machines.
22717 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22718 are defined to 2.
22720 @item -fpie
22721 @itemx -fPIE
22722 @opindex fpie
22723 @opindex fPIE
22724 These options are similar to @option{-fpic} and @option{-fPIC}, but
22725 generated position independent code can be only linked into executables.
22726 Usually these options are used when @option{-pie} GCC option is
22727 used during linking.
22729 @option{-fpie} and @option{-fPIE} both define the macros
22730 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
22731 for @option{-fpie} and 2 for @option{-fPIE}.
22733 @item -fno-jump-tables
22734 @opindex fno-jump-tables
22735 Do not use jump tables for switch statements even where it would be
22736 more efficient than other code generation strategies.  This option is
22737 of use in conjunction with @option{-fpic} or @option{-fPIC} for
22738 building code that forms part of a dynamic linker and cannot
22739 reference the address of a jump table.  On some targets, jump tables
22740 do not require a GOT and this option is not needed.
22742 @item -ffixed-@var{reg}
22743 @opindex ffixed
22744 Treat the register named @var{reg} as a fixed register; generated code
22745 should never refer to it (except perhaps as a stack pointer, frame
22746 pointer or in some other fixed role).
22748 @var{reg} must be the name of a register.  The register names accepted
22749 are machine-specific and are defined in the @code{REGISTER_NAMES}
22750 macro in the machine description macro file.
22752 This flag does not have a negative form, because it specifies a
22753 three-way choice.
22755 @item -fcall-used-@var{reg}
22756 @opindex fcall-used
22757 Treat the register named @var{reg} as an allocable register that is
22758 clobbered by function calls.  It may be allocated for temporaries or
22759 variables that do not live across a call.  Functions compiled this way
22760 do not save and restore the register @var{reg}.
22762 It is an error to use this flag with the frame pointer or stack pointer.
22763 Use of this flag for other registers that have fixed pervasive roles in
22764 the machine's execution model produces disastrous results.
22766 This flag does not have a negative form, because it specifies a
22767 three-way choice.
22769 @item -fcall-saved-@var{reg}
22770 @opindex fcall-saved
22771 Treat the register named @var{reg} as an allocable register saved by
22772 functions.  It may be allocated even for temporaries or variables that
22773 live across a call.  Functions compiled this way save and restore
22774 the register @var{reg} if they use it.
22776 It is an error to use this flag with the frame pointer or stack pointer.
22777 Use of this flag for other registers that have fixed pervasive roles in
22778 the machine's execution model produces disastrous results.
22780 A different sort of disaster results from the use of this flag for
22781 a register in which function values may be returned.
22783 This flag does not have a negative form, because it specifies a
22784 three-way choice.
22786 @item -fpack-struct[=@var{n}]
22787 @opindex fpack-struct
22788 Without a value specified, pack all structure members together without
22789 holes.  When a value is specified (which must be a small power of two), pack
22790 structure members according to this value, representing the maximum
22791 alignment (that is, objects with default alignment requirements larger than
22792 this are output potentially unaligned at the next fitting location.
22794 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
22795 code that is not binary compatible with code generated without that switch.
22796 Additionally, it makes the code suboptimal.
22797 Use it to conform to a non-default application binary interface.
22799 @item -finstrument-functions
22800 @opindex finstrument-functions
22801 Generate instrumentation calls for entry and exit to functions.  Just
22802 after function entry and just before function exit, the following
22803 profiling functions are called with the address of the current
22804 function and its call site.  (On some platforms,
22805 @code{__builtin_return_address} does not work beyond the current
22806 function, so the call site information may not be available to the
22807 profiling functions otherwise.)
22809 @smallexample
22810 void __cyg_profile_func_enter (void *this_fn,
22811                                void *call_site);
22812 void __cyg_profile_func_exit  (void *this_fn,
22813                                void *call_site);
22814 @end smallexample
22816 The first argument is the address of the start of the current function,
22817 which may be looked up exactly in the symbol table.
22819 This instrumentation is also done for functions expanded inline in other
22820 functions.  The profiling calls indicate where, conceptually, the
22821 inline function is entered and exited.  This means that addressable
22822 versions of such functions must be available.  If all your uses of a
22823 function are expanded inline, this may mean an additional expansion of
22824 code size.  If you use @samp{extern inline} in your C code, an
22825 addressable version of such functions must be provided.  (This is
22826 normally the case anyway, but if you get lucky and the optimizer always
22827 expands the functions inline, you might have gotten away without
22828 providing static copies.)
22830 A function may be given the attribute @code{no_instrument_function}, in
22831 which case this instrumentation is not done.  This can be used, for
22832 example, for the profiling functions listed above, high-priority
22833 interrupt routines, and any functions from which the profiling functions
22834 cannot safely be called (perhaps signal handlers, if the profiling
22835 routines generate output or allocate memory).
22837 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
22838 @opindex finstrument-functions-exclude-file-list
22840 Set the list of functions that are excluded from instrumentation (see
22841 the description of @code{-finstrument-functions}).  If the file that
22842 contains a function definition matches with one of @var{file}, then
22843 that function is not instrumented.  The match is done on substrings:
22844 if the @var{file} parameter is a substring of the file name, it is
22845 considered to be a match.
22847 For example:
22849 @smallexample
22850 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
22851 @end smallexample
22853 @noindent
22854 excludes any inline function defined in files whose pathnames
22855 contain @code{/bits/stl} or @code{include/sys}.
22857 If, for some reason, you want to include letter @code{','} in one of
22858 @var{sym}, write @code{'\,'}. For example,
22859 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
22860 (note the single quote surrounding the option).
22862 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
22863 @opindex finstrument-functions-exclude-function-list
22865 This is similar to @code{-finstrument-functions-exclude-file-list},
22866 but this option sets the list of function names to be excluded from
22867 instrumentation.  The function name to be matched is its user-visible
22868 name, such as @code{vector<int> blah(const vector<int> &)}, not the
22869 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
22870 match is done on substrings: if the @var{sym} parameter is a substring
22871 of the function name, it is considered to be a match.  For C99 and C++
22872 extended identifiers, the function name must be given in UTF-8, not
22873 using universal character names.
22875 @item -fstack-check
22876 @opindex fstack-check
22877 Generate code to verify that you do not go beyond the boundary of the
22878 stack.  You should specify this flag if you are running in an
22879 environment with multiple threads, but you only rarely need to specify it in
22880 a single-threaded environment since stack overflow is automatically
22881 detected on nearly all systems if there is only one stack.
22883 Note that this switch does not actually cause checking to be done; the
22884 operating system or the language runtime must do that.  The switch causes
22885 generation of code to ensure that they see the stack being extended.
22887 You can additionally specify a string parameter: @code{no} means no
22888 checking, @code{generic} means force the use of old-style checking,
22889 @code{specific} means use the best checking method and is equivalent
22890 to bare @option{-fstack-check}.
22892 Old-style checking is a generic mechanism that requires no specific
22893 target support in the compiler but comes with the following drawbacks:
22895 @enumerate
22896 @item
22897 Modified allocation strategy for large objects: they are always
22898 allocated dynamically if their size exceeds a fixed threshold.
22900 @item
22901 Fixed limit on the size of the static frame of functions: when it is
22902 topped by a particular function, stack checking is not reliable and
22903 a warning is issued by the compiler.
22905 @item
22906 Inefficiency: because of both the modified allocation strategy and the
22907 generic implementation, code performance is hampered.
22908 @end enumerate
22910 Note that old-style stack checking is also the fallback method for
22911 @code{specific} if no target support has been added in the compiler.
22913 @item -fstack-limit-register=@var{reg}
22914 @itemx -fstack-limit-symbol=@var{sym}
22915 @itemx -fno-stack-limit
22916 @opindex fstack-limit-register
22917 @opindex fstack-limit-symbol
22918 @opindex fno-stack-limit
22919 Generate code to ensure that the stack does not grow beyond a certain value,
22920 either the value of a register or the address of a symbol.  If a larger
22921 stack is required, a signal is raised at run time.  For most targets,
22922 the signal is raised before the stack overruns the boundary, so
22923 it is possible to catch the signal without taking special precautions.
22925 For instance, if the stack starts at absolute address @samp{0x80000000}
22926 and grows downwards, you can use the flags
22927 @option{-fstack-limit-symbol=__stack_limit} and
22928 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
22929 of 128KB@.  Note that this may only work with the GNU linker.
22931 @item -fsplit-stack
22932 @opindex fsplit-stack
22933 Generate code to automatically split the stack before it overflows.
22934 The resulting program has a discontiguous stack which can only
22935 overflow if the program is unable to allocate any more memory.  This
22936 is most useful when running threaded programs, as it is no longer
22937 necessary to calculate a good stack size to use for each thread.  This
22938 is currently only implemented for the i386 and x86_64 back ends running
22939 GNU/Linux.
22941 When code compiled with @option{-fsplit-stack} calls code compiled
22942 without @option{-fsplit-stack}, there may not be much stack space
22943 available for the latter code to run.  If compiling all code,
22944 including library code, with @option{-fsplit-stack} is not an option,
22945 then the linker can fix up these calls so that the code compiled
22946 without @option{-fsplit-stack} always has a large stack.  Support for
22947 this is implemented in the gold linker in GNU binutils release 2.21
22948 and later.
22950 @item -fleading-underscore
22951 @opindex fleading-underscore
22952 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
22953 change the way C symbols are represented in the object file.  One use
22954 is to help link with legacy assembly code.
22956 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
22957 generate code that is not binary compatible with code generated without that
22958 switch.  Use it to conform to a non-default application binary interface.
22959 Not all targets provide complete support for this switch.
22961 @item -ftls-model=@var{model}
22962 @opindex ftls-model
22963 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
22964 The @var{model} argument should be one of @code{global-dynamic},
22965 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
22966 Note that the choice is subject to optimization: the compiler may use
22967 a more efficient model for symbols not visible outside of the translation
22968 unit, or if @option{-fpic} is not given on the command line.
22970 The default without @option{-fpic} is @code{initial-exec}; with
22971 @option{-fpic} the default is @code{global-dynamic}.
22973 @item -fvisibility=@var{default|internal|hidden|protected}
22974 @opindex fvisibility
22975 Set the default ELF image symbol visibility to the specified option---all
22976 symbols are marked with this unless overridden within the code.
22977 Using this feature can very substantially improve linking and
22978 load times of shared object libraries, produce more optimized
22979 code, provide near-perfect API export and prevent symbol clashes.
22980 It is @strong{strongly} recommended that you use this in any shared objects
22981 you distribute.
22983 Despite the nomenclature, @code{default} always means public; i.e.,
22984 available to be linked against from outside the shared object.
22985 @code{protected} and @code{internal} are pretty useless in real-world
22986 usage so the only other commonly used option is @code{hidden}.
22987 The default if @option{-fvisibility} isn't specified is
22988 @code{default}, i.e., make every
22989 symbol public---this causes the same behavior as previous versions of
22990 GCC@.
22992 A good explanation of the benefits offered by ensuring ELF
22993 symbols have the correct visibility is given by ``How To Write
22994 Shared Libraries'' by Ulrich Drepper (which can be found at
22995 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
22996 solution made possible by this option to marking things hidden when
22997 the default is public is to make the default hidden and mark things
22998 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
22999 and @code{__attribute__ ((visibility("default")))} instead of
23000 @code{__declspec(dllexport)} you get almost identical semantics with
23001 identical syntax.  This is a great boon to those working with
23002 cross-platform projects.
23004 For those adding visibility support to existing code, you may find
23005 @samp{#pragma GCC visibility} of use.  This works by you enclosing
23006 the declarations you wish to set visibility for with (for example)
23007 @samp{#pragma GCC visibility push(hidden)} and
23008 @samp{#pragma GCC visibility pop}.
23009 Bear in mind that symbol visibility should be viewed @strong{as
23010 part of the API interface contract} and thus all new code should
23011 always specify visibility when it is not the default; i.e., declarations
23012 only for use within the local DSO should @strong{always} be marked explicitly
23013 as hidden as so to avoid PLT indirection overheads---making this
23014 abundantly clear also aids readability and self-documentation of the code.
23015 Note that due to ISO C++ specification requirements, @code{operator new} and
23016 @code{operator delete} must always be of default visibility.
23018 Be aware that headers from outside your project, in particular system
23019 headers and headers from any other library you use, may not be
23020 expecting to be compiled with visibility other than the default.  You
23021 may need to explicitly say @samp{#pragma GCC visibility push(default)}
23022 before including any such headers.
23024 @samp{extern} declarations are not affected by @option{-fvisibility}, so
23025 a lot of code can be recompiled with @option{-fvisibility=hidden} with
23026 no modifications.  However, this means that calls to @code{extern}
23027 functions with no explicit visibility use the PLT, so it is more
23028 effective to use @code{__attribute ((visibility))} and/or
23029 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
23030 declarations should be treated as hidden.
23032 Note that @option{-fvisibility} does affect C++ vague linkage
23033 entities. This means that, for instance, an exception class that is
23034 be thrown between DSOs must be explicitly marked with default
23035 visibility so that the @samp{type_info} nodes are unified between
23036 the DSOs.
23038 An overview of these techniques, their benefits and how to use them
23039 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
23041 @item -fstrict-volatile-bitfields
23042 @opindex fstrict-volatile-bitfields
23043 This option should be used if accesses to volatile bit-fields (or other
23044 structure fields, although the compiler usually honors those types
23045 anyway) should use a single access of the width of the
23046 field's type, aligned to a natural alignment if possible.  For
23047 example, targets with memory-mapped peripheral registers might require
23048 all such accesses to be 16 bits wide; with this flag you can
23049 declare all peripheral bit-fields as @code{unsigned short} (assuming short
23050 is 16 bits on these targets) to force GCC to use 16-bit accesses
23051 instead of, perhaps, a more efficient 32-bit access.
23053 If this option is disabled, the compiler uses the most efficient
23054 instruction.  In the previous example, that might be a 32-bit load
23055 instruction, even though that accesses bytes that do not contain
23056 any portion of the bit-field, or memory-mapped registers unrelated to
23057 the one being updated.
23059 In some cases, such as when the @code{packed} attribute is applied to a 
23060 structure field, it may not be possible to access the field with a single
23061 read or write that is correctly aligned for the target machine.  In this
23062 case GCC falls back to generating multiple accesses rather than code that 
23063 will fault or truncate the result at run time.
23065 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
23066 not allowed to touch non bit-field members.  It is therefore recommended
23067 to define all bits of the field's type as bit-field members.
23069 The default value of this option is determined by the application binary
23070 interface for the target processor.
23072 @item -fsync-libcalls
23073 @opindex fsync-libcalls
23074 This option controls whether any out-of-line instance of the @code{__sync}
23075 family of functions may be used to implement the C++11 @code{__atomic}
23076 family of functions.
23078 The default value of this option is enabled, thus the only useful form
23079 of the option is @option{-fno-sync-libcalls}.  This option is used in
23080 the implementation of the @file{libatomic} runtime library.
23082 @end table
23084 @c man end
23086 @node Environment Variables
23087 @section Environment Variables Affecting GCC
23088 @cindex environment variables
23090 @c man begin ENVIRONMENT
23091 This section describes several environment variables that affect how GCC
23092 operates.  Some of them work by specifying directories or prefixes to use
23093 when searching for various kinds of files.  Some are used to specify other
23094 aspects of the compilation environment.
23096 Note that you can also specify places to search using options such as
23097 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
23098 take precedence over places specified using environment variables, which
23099 in turn take precedence over those specified by the configuration of GCC@.
23100 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
23101 GNU Compiler Collection (GCC) Internals}.
23103 @table @env
23104 @item LANG
23105 @itemx LC_CTYPE
23106 @c @itemx LC_COLLATE
23107 @itemx LC_MESSAGES
23108 @c @itemx LC_MONETARY
23109 @c @itemx LC_NUMERIC
23110 @c @itemx LC_TIME
23111 @itemx LC_ALL
23112 @findex LANG
23113 @findex LC_CTYPE
23114 @c @findex LC_COLLATE
23115 @findex LC_MESSAGES
23116 @c @findex LC_MONETARY
23117 @c @findex LC_NUMERIC
23118 @c @findex LC_TIME
23119 @findex LC_ALL
23120 @cindex locale
23121 These environment variables control the way that GCC uses
23122 localization information which allows GCC to work with different
23123 national conventions.  GCC inspects the locale categories
23124 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
23125 so.  These locale categories can be set to any value supported by your
23126 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
23127 Kingdom encoded in UTF-8.
23129 The @env{LC_CTYPE} environment variable specifies character
23130 classification.  GCC uses it to determine the character boundaries in
23131 a string; this is needed for some multibyte encodings that contain quote
23132 and escape characters that are otherwise interpreted as a string
23133 end or escape.
23135 The @env{LC_MESSAGES} environment variable specifies the language to
23136 use in diagnostic messages.
23138 If the @env{LC_ALL} environment variable is set, it overrides the value
23139 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
23140 and @env{LC_MESSAGES} default to the value of the @env{LANG}
23141 environment variable.  If none of these variables are set, GCC
23142 defaults to traditional C English behavior.
23144 @item TMPDIR
23145 @findex TMPDIR
23146 If @env{TMPDIR} is set, it specifies the directory to use for temporary
23147 files.  GCC uses temporary files to hold the output of one stage of
23148 compilation which is to be used as input to the next stage: for example,
23149 the output of the preprocessor, which is the input to the compiler
23150 proper.
23152 @item GCC_COMPARE_DEBUG
23153 @findex GCC_COMPARE_DEBUG
23154 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
23155 @option{-fcompare-debug} to the compiler driver.  See the documentation
23156 of this option for more details.
23158 @item GCC_EXEC_PREFIX
23159 @findex GCC_EXEC_PREFIX
23160 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
23161 names of the subprograms executed by the compiler.  No slash is added
23162 when this prefix is combined with the name of a subprogram, but you can
23163 specify a prefix that ends with a slash if you wish.
23165 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
23166 an appropriate prefix to use based on the pathname it is invoked with.
23168 If GCC cannot find the subprogram using the specified prefix, it
23169 tries looking in the usual places for the subprogram.
23171 The default value of @env{GCC_EXEC_PREFIX} is
23172 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
23173 the installed compiler. In many cases @var{prefix} is the value
23174 of @code{prefix} when you ran the @file{configure} script.
23176 Other prefixes specified with @option{-B} take precedence over this prefix.
23178 This prefix is also used for finding files such as @file{crt0.o} that are
23179 used for linking.
23181 In addition, the prefix is used in an unusual way in finding the
23182 directories to search for header files.  For each of the standard
23183 directories whose name normally begins with @samp{/usr/local/lib/gcc}
23184 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
23185 replacing that beginning with the specified prefix to produce an
23186 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
23187 @file{foo/bar} just before it searches the standard directory 
23188 @file{/usr/local/lib/bar}.
23189 If a standard directory begins with the configured
23190 @var{prefix} then the value of @var{prefix} is replaced by
23191 @env{GCC_EXEC_PREFIX} when looking for header files.
23193 @item COMPILER_PATH
23194 @findex COMPILER_PATH
23195 The value of @env{COMPILER_PATH} is a colon-separated list of
23196 directories, much like @env{PATH}.  GCC tries the directories thus
23197 specified when searching for subprograms, if it can't find the
23198 subprograms using @env{GCC_EXEC_PREFIX}.
23200 @item LIBRARY_PATH
23201 @findex LIBRARY_PATH
23202 The value of @env{LIBRARY_PATH} is a colon-separated list of
23203 directories, much like @env{PATH}.  When configured as a native compiler,
23204 GCC tries the directories thus specified when searching for special
23205 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
23206 using GCC also uses these directories when searching for ordinary
23207 libraries for the @option{-l} option (but directories specified with
23208 @option{-L} come first).
23210 @item LANG
23211 @findex LANG
23212 @cindex locale definition
23213 This variable is used to pass locale information to the compiler.  One way in
23214 which this information is used is to determine the character set to be used
23215 when character literals, string literals and comments are parsed in C and C++.
23216 When the compiler is configured to allow multibyte characters,
23217 the following values for @env{LANG} are recognized:
23219 @table @samp
23220 @item C-JIS
23221 Recognize JIS characters.
23222 @item C-SJIS
23223 Recognize SJIS characters.
23224 @item C-EUCJP
23225 Recognize EUCJP characters.
23226 @end table
23228 If @env{LANG} is not defined, or if it has some other value, then the
23229 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
23230 recognize and translate multibyte characters.
23231 @end table
23233 @noindent
23234 Some additional environment variables affect the behavior of the
23235 preprocessor.
23237 @include cppenv.texi
23239 @c man end
23241 @node Precompiled Headers
23242 @section Using Precompiled Headers
23243 @cindex precompiled headers
23244 @cindex speed of compilation
23246 Often large projects have many header files that are included in every
23247 source file.  The time the compiler takes to process these header files
23248 over and over again can account for nearly all of the time required to
23249 build the project.  To make builds faster, GCC allows you to
23250 @dfn{precompile} a header file.
23252 To create a precompiled header file, simply compile it as you would any
23253 other file, if necessary using the @option{-x} option to make the driver
23254 treat it as a C or C++ header file.  You may want to use a
23255 tool like @command{make} to keep the precompiled header up-to-date when
23256 the headers it contains change.
23258 A precompiled header file is searched for when @code{#include} is
23259 seen in the compilation.  As it searches for the included file
23260 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
23261 compiler looks for a precompiled header in each directory just before it
23262 looks for the include file in that directory.  The name searched for is
23263 the name specified in the @code{#include} with @samp{.gch} appended.  If
23264 the precompiled header file can't be used, it is ignored.
23266 For instance, if you have @code{#include "all.h"}, and you have
23267 @file{all.h.gch} in the same directory as @file{all.h}, then the
23268 precompiled header file is used if possible, and the original
23269 header is used otherwise.
23271 Alternatively, you might decide to put the precompiled header file in a
23272 directory and use @option{-I} to ensure that directory is searched
23273 before (or instead of) the directory containing the original header.
23274 Then, if you want to check that the precompiled header file is always
23275 used, you can put a file of the same name as the original header in this
23276 directory containing an @code{#error} command.
23278 This also works with @option{-include}.  So yet another way to use
23279 precompiled headers, good for projects not designed with precompiled
23280 header files in mind, is to simply take most of the header files used by
23281 a project, include them from another header file, precompile that header
23282 file, and @option{-include} the precompiled header.  If the header files
23283 have guards against multiple inclusion, they are skipped because
23284 they've already been included (in the precompiled header).
23286 If you need to precompile the same header file for different
23287 languages, targets, or compiler options, you can instead make a
23288 @emph{directory} named like @file{all.h.gch}, and put each precompiled
23289 header in the directory, perhaps using @option{-o}.  It doesn't matter
23290 what you call the files in the directory; every precompiled header in
23291 the directory is considered.  The first precompiled header
23292 encountered in the directory that is valid for this compilation is
23293 used; they're searched in no particular order.
23295 There are many other possibilities, limited only by your imagination,
23296 good sense, and the constraints of your build system.
23298 A precompiled header file can be used only when these conditions apply:
23300 @itemize
23301 @item
23302 Only one precompiled header can be used in a particular compilation.
23304 @item
23305 A precompiled header can't be used once the first C token is seen.  You
23306 can have preprocessor directives before a precompiled header; you cannot
23307 include a precompiled header from inside another header.
23309 @item
23310 The precompiled header file must be produced for the same language as
23311 the current compilation.  You can't use a C precompiled header for a C++
23312 compilation.
23314 @item
23315 The precompiled header file must have been produced by the same compiler
23316 binary as the current compilation is using.
23318 @item
23319 Any macros defined before the precompiled header is included must
23320 either be defined in the same way as when the precompiled header was
23321 generated, or must not affect the precompiled header, which usually
23322 means that they don't appear in the precompiled header at all.
23324 The @option{-D} option is one way to define a macro before a
23325 precompiled header is included; using a @code{#define} can also do it.
23326 There are also some options that define macros implicitly, like
23327 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23328 defined this way.
23330 @item If debugging information is output when using the precompiled
23331 header, using @option{-g} or similar, the same kind of debugging information
23332 must have been output when building the precompiled header.  However,
23333 a precompiled header built using @option{-g} can be used in a compilation
23334 when no debugging information is being output.
23336 @item The same @option{-m} options must generally be used when building
23337 and using the precompiled header.  @xref{Submodel Options},
23338 for any cases where this rule is relaxed.
23340 @item Each of the following options must be the same when building and using
23341 the precompiled header:
23343 @gccoptlist{-fexceptions}
23345 @item
23346 Some other command-line options starting with @option{-f},
23347 @option{-p}, or @option{-O} must be defined in the same way as when
23348 the precompiled header was generated.  At present, it's not clear
23349 which options are safe to change and which are not; the safest choice
23350 is to use exactly the same options when generating and using the
23351 precompiled header.  The following are known to be safe:
23353 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23354 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23355 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23356 -pedantic-errors}
23358 @end itemize
23360 For all of these except the last, the compiler automatically
23361 ignores the precompiled header if the conditions aren't met.  If you
23362 find an option combination that doesn't work and doesn't cause the
23363 precompiled header to be ignored, please consider filing a bug report,
23364 see @ref{Bugs}.
23366 If you do use differing options when generating and using the
23367 precompiled header, the actual behavior is a mixture of the
23368 behavior for the options.  For instance, if you use @option{-g} to
23369 generate the precompiled header but not when using it, you may or may
23370 not get debugging information for routines in the precompiled header.