* asan.c (pass_sanopt::execute): Handle IFN_UBSAN_OBJECT_SIZE.
[official-gcc.git] / gcc / doc / invoke.texi
blob2b62a73c9522146a6335f05fdbcd0245af279c05
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 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
493 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
495 @emph{Adapteva Epiphany Options}
496 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
497 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
498 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
499 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
500 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
501 -msplit-vecmove-early -m1reg-@var{reg}}
503 @emph{ARC Options}
504 @gccoptlist{-mbarrel-shifter @gol
505 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
506 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
507 -mea -mno-mpy -mmul32x16 -mmul64 @gol
508 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
509 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
510 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
511 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
512 -mucb-mcount -mvolatile-cache @gol
513 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
514 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
515 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
516 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
517 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
518 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
520 @emph{ARM Options}
521 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
522 -mabi=@var{name} @gol
523 -mapcs-stack-check  -mno-apcs-stack-check @gol
524 -mapcs-float  -mno-apcs-float @gol
525 -mapcs-reentrant  -mno-apcs-reentrant @gol
526 -msched-prolog  -mno-sched-prolog @gol
527 -mlittle-endian  -mbig-endian @gol
528 -mfloat-abi=@var{name} @gol
529 -mfp16-format=@var{name}
530 -mthumb-interwork  -mno-thumb-interwork @gol
531 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
532 -mstructure-size-boundary=@var{n} @gol
533 -mabort-on-noreturn @gol
534 -mlong-calls  -mno-long-calls @gol
535 -msingle-pic-base  -mno-single-pic-base @gol
536 -mpic-register=@var{reg} @gol
537 -mnop-fun-dllimport @gol
538 -mpoke-function-name @gol
539 -mthumb  -marm @gol
540 -mtpcs-frame  -mtpcs-leaf-frame @gol
541 -mcaller-super-interworking  -mcallee-super-interworking @gol
542 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
543 -mword-relocations @gol
544 -mfix-cortex-m3-ldrd @gol
545 -munaligned-access @gol
546 -mneon-for-64bits @gol
547 -mslow-flash-data @gol
548 -mrestrict-it}
550 @emph{AVR Options}
551 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
552 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
553 -mstrict-X -mtiny-stack -Waddr-space-convert}
555 @emph{Blackfin Options}
556 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
557 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
558 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
559 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
560 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
561 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
562 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
563 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
564 -micplb}
566 @emph{C6X Options}
567 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
568 -msim -msdata=@var{sdata-type}}
570 @emph{CRIS Options}
571 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
572 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
573 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
574 -mstack-align  -mdata-align  -mconst-align @gol
575 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
576 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
577 -mmul-bug-workaround  -mno-mul-bug-workaround}
579 @emph{CR16 Options}
580 @gccoptlist{-mmac @gol
581 -mcr16cplus -mcr16c @gol
582 -msim -mint32 -mbit-ops
583 -mdata-model=@var{model}}
585 @emph{Darwin Options}
586 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
587 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
588 -client_name  -compatibility_version  -current_version @gol
589 -dead_strip @gol
590 -dependency-file  -dylib_file  -dylinker_install_name @gol
591 -dynamic  -dynamiclib  -exported_symbols_list @gol
592 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
593 -force_flat_namespace  -headerpad_max_install_names @gol
594 -iframework @gol
595 -image_base  -init  -install_name  -keep_private_externs @gol
596 -multi_module  -multiply_defined  -multiply_defined_unused @gol
597 -noall_load   -no_dead_strip_inits_and_terms @gol
598 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
599 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
600 -private_bundle  -read_only_relocs  -sectalign @gol
601 -sectobjectsymbols  -whyload  -seg1addr @gol
602 -sectcreate  -sectobjectsymbols  -sectorder @gol
603 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
604 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
605 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
606 -single_module  -static  -sub_library  -sub_umbrella @gol
607 -twolevel_namespace  -umbrella  -undefined @gol
608 -unexported_symbols_list  -weak_reference_mismatches @gol
609 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
610 -mkernel -mone-byte-bool}
612 @emph{DEC Alpha Options}
613 @gccoptlist{-mno-fp-regs  -msoft-float @gol
614 -mieee  -mieee-with-inexact  -mieee-conformant @gol
615 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
616 -mtrap-precision=@var{mode}  -mbuild-constants @gol
617 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
618 -mbwx  -mmax  -mfix  -mcix @gol
619 -mfloat-vax  -mfloat-ieee @gol
620 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
621 -msmall-text  -mlarge-text @gol
622 -mmemory-latency=@var{time}}
624 @emph{FR30 Options}
625 @gccoptlist{-msmall-model -mno-lsim}
627 @emph{FRV Options}
628 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
629 -mhard-float  -msoft-float @gol
630 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
631 -mdouble  -mno-double @gol
632 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
633 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
634 -mlinked-fp  -mlong-calls  -malign-labels @gol
635 -mlibrary-pic  -macc-4  -macc-8 @gol
636 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
637 -moptimize-membar -mno-optimize-membar @gol
638 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
639 -mvliw-branch  -mno-vliw-branch @gol
640 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
641 -mno-nested-cond-exec  -mtomcat-stats @gol
642 -mTLS -mtls @gol
643 -mcpu=@var{cpu}}
645 @emph{GNU/Linux Options}
646 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
647 -tno-android-cc -tno-android-ld}
649 @emph{H8/300 Options}
650 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
652 @emph{HPPA Options}
653 @gccoptlist{-march=@var{architecture-type} @gol
654 -mdisable-fpregs  -mdisable-indexing @gol
655 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
656 -mfixed-range=@var{register-range} @gol
657 -mjump-in-delay -mlinker-opt -mlong-calls @gol
658 -mlong-load-store  -mno-disable-fpregs @gol
659 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
660 -mno-jump-in-delay  -mno-long-load-store @gol
661 -mno-portable-runtime  -mno-soft-float @gol
662 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
663 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
664 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
665 -munix=@var{unix-std}  -nolibdld  -static  -threads}
667 @emph{i386 and x86-64 Options}
668 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
669 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
670 -mfpmath=@var{unit} @gol
671 -masm=@var{dialect}  -mno-fancy-math-387 @gol
672 -mno-fp-ret-in-387  -msoft-float @gol
673 -mno-wide-multiply  -mrtd  -malign-double @gol
674 -mpreferred-stack-boundary=@var{num} @gol
675 -mincoming-stack-boundary=@var{num} @gol
676 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
677 -mrecip -mrecip=@var{opt} @gol
678 -mvzeroupper -mprefer-avx128 @gol
679 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
680 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
681 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
682 -mclflushopt -mxsavec -mxsaves @gol
683 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
684 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mthreads @gol
685 -mno-align-stringops  -minline-all-stringops @gol
686 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
687 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
688 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
689 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
690 -mregparm=@var{num}  -msseregparm @gol
691 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
692 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
693 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
694 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
695 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
696 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
697 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
698 -mstack-protector-guard=@var{guard}}
700 @emph{i386 and x86-64 Windows Options}
701 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
702 -mnop-fun-dllimport -mthread @gol
703 -municode -mwin32 -mwindows -fno-set-stack-executable}
705 @emph{IA-64 Options}
706 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
707 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
708 -mconstant-gp  -mauto-pic  -mfused-madd @gol
709 -minline-float-divide-min-latency @gol
710 -minline-float-divide-max-throughput @gol
711 -mno-inline-float-divide @gol
712 -minline-int-divide-min-latency @gol
713 -minline-int-divide-max-throughput  @gol
714 -mno-inline-int-divide @gol
715 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
716 -mno-inline-sqrt @gol
717 -mdwarf2-asm -mearly-stop-bits @gol
718 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
719 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
720 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
721 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
722 -msched-spec-ldc -msched-spec-control-ldc @gol
723 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
724 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
725 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
726 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
728 @emph{LM32 Options}
729 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
730 -msign-extend-enabled -muser-enabled}
732 @emph{M32R/D Options}
733 @gccoptlist{-m32r2 -m32rx -m32r @gol
734 -mdebug @gol
735 -malign-loops -mno-align-loops @gol
736 -missue-rate=@var{number} @gol
737 -mbranch-cost=@var{number} @gol
738 -mmodel=@var{code-size-model-type} @gol
739 -msdata=@var{sdata-type} @gol
740 -mno-flush-func -mflush-func=@var{name} @gol
741 -mno-flush-trap -mflush-trap=@var{number} @gol
742 -G @var{num}}
744 @emph{M32C Options}
745 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
747 @emph{M680x0 Options}
748 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
749 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
750 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
751 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
752 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
753 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
754 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
755 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
756 -mxgot -mno-xgot}
758 @emph{MCore Options}
759 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
760 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
761 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
762 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
763 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
765 @emph{MeP Options}
766 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
767 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
768 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
769 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
770 -mtiny=@var{n}}
772 @emph{MicroBlaze Options}
773 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
774 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
775 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
776 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
777 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
779 @emph{MIPS Options}
780 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
781 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
782 -mips64  -mips64r2  -mips64r3  -mips64r5 @gol
783 -mips16  -mno-mips16  -mflip-mips16 @gol
784 -minterlink-compressed -mno-interlink-compressed @gol
785 -minterlink-mips16  -mno-interlink-mips16 @gol
786 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
787 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
788 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
789 -mno-float  -msingle-float  -mdouble-float @gol
790 -mabs=@var{mode}  -mnan=@var{encoding} @gol
791 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
792 -mmcu -mmno-mcu @gol
793 -meva -mno-eva @gol
794 -mvirt -mno-virt @gol
795 -mxpa -mno-xpa @gol
796 -mmicromips -mno-micromips @gol
797 -mfpu=@var{fpu-type} @gol
798 -msmartmips  -mno-smartmips @gol
799 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
800 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
801 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
802 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
803 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
804 -membedded-data  -mno-embedded-data @gol
805 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
806 -mcode-readable=@var{setting} @gol
807 -msplit-addresses  -mno-split-addresses @gol
808 -mexplicit-relocs  -mno-explicit-relocs @gol
809 -mcheck-zero-division  -mno-check-zero-division @gol
810 -mdivide-traps  -mdivide-breaks @gol
811 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
812 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
813 -mfix-24k -mno-fix-24k @gol
814 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
815 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
816 -mfix-vr4120  -mno-fix-vr4120 @gol
817 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
818 -mflush-func=@var{func}  -mno-flush-func @gol
819 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
820 -mfp-exceptions -mno-fp-exceptions @gol
821 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
822 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
824 @emph{MMIX Options}
825 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
826 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
827 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
828 -mno-base-addresses  -msingle-exit  -mno-single-exit}
830 @emph{MN10300 Options}
831 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
832 -mno-am33 -mam33 -mam33-2 -mam34 @gol
833 -mtune=@var{cpu-type} @gol
834 -mreturn-pointer-on-d0 @gol
835 -mno-crt0  -mrelax -mliw -msetlb}
837 @emph{Moxie Options}
838 @gccoptlist{-meb -mel -mno-crt0}
840 @emph{MSP430 Options}
841 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
842 -mhwmult= -minrt}
844 @emph{NDS32 Options}
845 @gccoptlist{-mbig-endian -mlittle-endian @gol
846 -mreduced-regs -mfull-regs @gol
847 -mcmov -mno-cmov @gol
848 -mperf-ext -mno-perf-ext @gol
849 -mv3push -mno-v3push @gol
850 -m16bit -mno-16bit @gol
851 -mgp-direct -mno-gp-direct @gol
852 -misr-vector-size=@var{num} @gol
853 -mcache-block-size=@var{num} @gol
854 -march=@var{arch} @gol
855 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
856 -mex9 -mctor-dtor -mrelax}
858 @emph{Nios II Options}
859 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
860 -mno-bypass-cache -mbypass-cache @gol
861 -mno-cache-volatile -mcache-volatile @gol
862 -mno-fast-sw-div -mfast-sw-div @gol
863 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
864 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
865 -mcustom-fpu-cfg=@var{name} @gol
866 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
868 @emph{PDP-11 Options}
869 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
870 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
871 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
872 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
873 -mbranch-expensive  -mbranch-cheap @gol
874 -munix-asm  -mdec-asm}
876 @emph{picoChip Options}
877 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
878 -msymbol-as-address -mno-inefficient-warnings}
880 @emph{PowerPC Options}
881 See RS/6000 and PowerPC Options.
883 @emph{RL78 Options}
884 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78 @gol
885 -m64bit-doubles -m32bit-doubles}
887 @emph{RS/6000 and PowerPC Options}
888 @gccoptlist{-mcpu=@var{cpu-type} @gol
889 -mtune=@var{cpu-type} @gol
890 -mcmodel=@var{code-model} @gol
891 -mpowerpc64 @gol
892 -maltivec  -mno-altivec @gol
893 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
894 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
895 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
896 -mfprnd  -mno-fprnd @gol
897 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
898 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
899 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
900 -malign-power  -malign-natural @gol
901 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
902 -msingle-float -mdouble-float -msimple-fpu @gol
903 -mstring  -mno-string  -mupdate  -mno-update @gol
904 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
905 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
906 -mstrict-align  -mno-strict-align  -mrelocatable @gol
907 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
908 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
909 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
910 -mprioritize-restricted-insns=@var{priority} @gol
911 -msched-costly-dep=@var{dependence_type} @gol
912 -minsert-sched-nops=@var{scheme} @gol
913 -mcall-sysv  -mcall-netbsd @gol
914 -maix-struct-return  -msvr4-struct-return @gol
915 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
916 -mblock-move-inline-limit=@var{num} @gol
917 -misel -mno-isel @gol
918 -misel=yes  -misel=no @gol
919 -mspe -mno-spe @gol
920 -mspe=yes  -mspe=no @gol
921 -mpaired @gol
922 -mgen-cell-microcode -mwarn-cell-microcode @gol
923 -mvrsave -mno-vrsave @gol
924 -mmulhw -mno-mulhw @gol
925 -mdlmzb -mno-dlmzb @gol
926 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
927 -mprototype  -mno-prototype @gol
928 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
929 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
930 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
931 -mno-recip-precision @gol
932 -mveclibabi=@var{type} -mfriz -mno-friz @gol
933 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
934 -msave-toc-indirect -mno-save-toc-indirect @gol
935 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
936 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
937 -mquad-memory -mno-quad-memory @gol
938 -mquad-memory-atomic -mno-quad-memory-atomic @gol
939 -mcompat-align-parm -mno-compat-align-parm}
941 @emph{RX Options}
942 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
943 -mcpu=@gol
944 -mbig-endian-data -mlittle-endian-data @gol
945 -msmall-data @gol
946 -msim  -mno-sim@gol
947 -mas100-syntax -mno-as100-syntax@gol
948 -mrelax@gol
949 -mmax-constant-size=@gol
950 -mint-register=@gol
951 -mpid@gol
952 -mno-warn-multiple-fast-interrupts@gol
953 -msave-acc-in-interrupts}
955 @emph{S/390 and zSeries Options}
956 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
957 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
958 -mlong-double-64 -mlong-double-128 @gol
959 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
960 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
961 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
962 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
963 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
964 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
966 @emph{Score Options}
967 @gccoptlist{-meb -mel @gol
968 -mnhwloop @gol
969 -muls @gol
970 -mmac @gol
971 -mscore5 -mscore5u -mscore7 -mscore7d}
973 @emph{SH Options}
974 @gccoptlist{-m1  -m2  -m2e @gol
975 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
976 -m3  -m3e @gol
977 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
978 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
979 -m5-64media  -m5-64media-nofpu @gol
980 -m5-32media  -m5-32media-nofpu @gol
981 -m5-compact  -m5-compact-nofpu @gol
982 -mb  -ml  -mdalign  -mrelax @gol
983 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
984 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
985 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
986 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
987 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
988 -maccumulate-outgoing-args -minvalid-symbols @gol
989 -matomic-model=@var{atomic-model} @gol
990 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
991 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
992 -mpretend-cmove -mtas}
994 @emph{Solaris 2 Options}
995 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
996 -pthreads -pthread}
998 @emph{SPARC Options}
999 @gccoptlist{-mcpu=@var{cpu-type} @gol
1000 -mtune=@var{cpu-type} @gol
1001 -mcmodel=@var{code-model} @gol
1002 -mmemory-model=@var{mem-model} @gol
1003 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1004 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1005 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1006 -mhard-quad-float  -msoft-quad-float @gol
1007 -mstack-bias  -mno-stack-bias @gol
1008 -munaligned-doubles  -mno-unaligned-doubles @gol
1009 -muser-mode  -mno-user-mode @gol
1010 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1011 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1012 -mcbcond -mno-cbcond @gol
1013 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1014 -mfix-at697f -mfix-ut699}
1016 @emph{SPU Options}
1017 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1018 -msafe-dma -munsafe-dma @gol
1019 -mbranch-hints @gol
1020 -msmall-mem -mlarge-mem -mstdmain @gol
1021 -mfixed-range=@var{register-range} @gol
1022 -mea32 -mea64 @gol
1023 -maddress-space-conversion -mno-address-space-conversion @gol
1024 -mcache-size=@var{cache-size} @gol
1025 -matomic-updates -mno-atomic-updates}
1027 @emph{System V Options}
1028 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1030 @emph{TILE-Gx Options}
1031 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1032 -mcmodel=@var{code-model}}
1034 @emph{TILEPro Options}
1035 @gccoptlist{-mcpu=@var{cpu} -m32}
1037 @emph{V850 Options}
1038 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1039 -mprolog-function  -mno-prolog-function  -mspace @gol
1040 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1041 -mapp-regs  -mno-app-regs @gol
1042 -mdisable-callt  -mno-disable-callt @gol
1043 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1044 -mv850e -mv850 -mv850e3v5 @gol
1045 -mloop @gol
1046 -mrelax @gol
1047 -mlong-jumps @gol
1048 -msoft-float @gol
1049 -mhard-float @gol
1050 -mgcc-abi @gol
1051 -mrh850-abi @gol
1052 -mbig-switch}
1054 @emph{VAX Options}
1055 @gccoptlist{-mg  -mgnu  -munix}
1057 @emph{VMS Options}
1058 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1059 -mpointer-size=@var{size}}
1061 @emph{VxWorks Options}
1062 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1063 -Xbind-lazy  -Xbind-now}
1065 @emph{x86-64 Options}
1066 See i386 and x86-64 Options.
1068 @emph{Xstormy16 Options}
1069 @gccoptlist{-msim}
1071 @emph{Xtensa Options}
1072 @gccoptlist{-mconst16 -mno-const16 @gol
1073 -mfused-madd  -mno-fused-madd @gol
1074 -mforce-no-pic @gol
1075 -mserialize-volatile  -mno-serialize-volatile @gol
1076 -mtext-section-literals  -mno-text-section-literals @gol
1077 -mtarget-align  -mno-target-align @gol
1078 -mlongcalls  -mno-longcalls}
1080 @emph{zSeries Options}
1081 See S/390 and zSeries Options.
1083 @item Code Generation Options
1084 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1085 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1086 -ffixed-@var{reg}  -fexceptions @gol
1087 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1088 -fasynchronous-unwind-tables @gol
1089 -fno-gnu-unique @gol
1090 -finhibit-size-directive  -finstrument-functions @gol
1091 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1092 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1093 -fno-common  -fno-ident @gol
1094 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1095 -fno-jump-tables @gol
1096 -frecord-gcc-switches @gol
1097 -freg-struct-return  -fshort-enums @gol
1098 -fshort-double  -fshort-wchar @gol
1099 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1100 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1101 -fno-stack-limit -fsplit-stack @gol
1102 -fleading-underscore  -ftls-model=@var{model} @gol
1103 -fstack-reuse=@var{reuse_level} @gol
1104 -ftrapv  -fwrapv  -fbounds-check @gol
1105 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1106 @end table
1109 @node Overall Options
1110 @section Options Controlling the Kind of Output
1112 Compilation can involve up to four stages: preprocessing, compilation
1113 proper, assembly and linking, always in that order.  GCC is capable of
1114 preprocessing and compiling several files either into several
1115 assembler input files, or into one assembler input file; then each
1116 assembler input file produces an object file, and linking combines all
1117 the object files (those newly compiled, and those specified as input)
1118 into an executable file.
1120 @cindex file name suffix
1121 For any given input file, the file name suffix determines what kind of
1122 compilation is done:
1124 @table @gcctabopt
1125 @item @var{file}.c
1126 C source code that must be preprocessed.
1128 @item @var{file}.i
1129 C source code that should not be preprocessed.
1131 @item @var{file}.ii
1132 C++ source code that should not be preprocessed.
1134 @item @var{file}.m
1135 Objective-C source code.  Note that you must link with the @file{libobjc}
1136 library to make an Objective-C program work.
1138 @item @var{file}.mi
1139 Objective-C source code that should not be preprocessed.
1141 @item @var{file}.mm
1142 @itemx @var{file}.M
1143 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1144 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1145 to a literal capital M@.
1147 @item @var{file}.mii
1148 Objective-C++ source code that should not be preprocessed.
1150 @item @var{file}.h
1151 C, C++, Objective-C or Objective-C++ header file to be turned into a
1152 precompiled header (default), or C, C++ header file to be turned into an
1153 Ada spec (via the @option{-fdump-ada-spec} switch).
1155 @item @var{file}.cc
1156 @itemx @var{file}.cp
1157 @itemx @var{file}.cxx
1158 @itemx @var{file}.cpp
1159 @itemx @var{file}.CPP
1160 @itemx @var{file}.c++
1161 @itemx @var{file}.C
1162 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1163 the last two letters must both be literally @samp{x}.  Likewise,
1164 @samp{.C} refers to a literal capital C@.
1166 @item @var{file}.mm
1167 @itemx @var{file}.M
1168 Objective-C++ source code that must be preprocessed.
1170 @item @var{file}.mii
1171 Objective-C++ source code that should not be preprocessed.
1173 @item @var{file}.hh
1174 @itemx @var{file}.H
1175 @itemx @var{file}.hp
1176 @itemx @var{file}.hxx
1177 @itemx @var{file}.hpp
1178 @itemx @var{file}.HPP
1179 @itemx @var{file}.h++
1180 @itemx @var{file}.tcc
1181 C++ header file to be turned into a precompiled header or Ada spec.
1183 @item @var{file}.f
1184 @itemx @var{file}.for
1185 @itemx @var{file}.ftn
1186 Fixed form Fortran source code that should not be preprocessed.
1188 @item @var{file}.F
1189 @itemx @var{file}.FOR
1190 @itemx @var{file}.fpp
1191 @itemx @var{file}.FPP
1192 @itemx @var{file}.FTN
1193 Fixed form Fortran source code that must be preprocessed (with the traditional
1194 preprocessor).
1196 @item @var{file}.f90
1197 @itemx @var{file}.f95
1198 @itemx @var{file}.f03
1199 @itemx @var{file}.f08
1200 Free form Fortran source code that should not be preprocessed.
1202 @item @var{file}.F90
1203 @itemx @var{file}.F95
1204 @itemx @var{file}.F03
1205 @itemx @var{file}.F08
1206 Free form Fortran source code that must be preprocessed (with the
1207 traditional preprocessor).
1209 @item @var{file}.go
1210 Go source code.
1212 @c FIXME: Descriptions of Java file types.
1213 @c @var{file}.java
1214 @c @var{file}.class
1215 @c @var{file}.zip
1216 @c @var{file}.jar
1218 @item @var{file}.ads
1219 Ada source code file that contains a library unit declaration (a
1220 declaration of a package, subprogram, or generic, or a generic
1221 instantiation), or a library unit renaming declaration (a package,
1222 generic, or subprogram renaming declaration).  Such files are also
1223 called @dfn{specs}.
1225 @item @var{file}.adb
1226 Ada source code file containing a library unit body (a subprogram or
1227 package body).  Such files are also called @dfn{bodies}.
1229 @c GCC also knows about some suffixes for languages not yet included:
1230 @c Pascal:
1231 @c @var{file}.p
1232 @c @var{file}.pas
1233 @c Ratfor:
1234 @c @var{file}.r
1236 @item @var{file}.s
1237 Assembler code.
1239 @item @var{file}.S
1240 @itemx @var{file}.sx
1241 Assembler code that must be preprocessed.
1243 @item @var{other}
1244 An object file to be fed straight into linking.
1245 Any file name with no recognized suffix is treated this way.
1246 @end table
1248 @opindex x
1249 You can specify the input language explicitly with the @option{-x} option:
1251 @table @gcctabopt
1252 @item -x @var{language}
1253 Specify explicitly the @var{language} for the following input files
1254 (rather than letting the compiler choose a default based on the file
1255 name suffix).  This option applies to all following input files until
1256 the next @option{-x} option.  Possible values for @var{language} are:
1257 @smallexample
1258 c  c-header  cpp-output
1259 c++  c++-header  c++-cpp-output
1260 objective-c  objective-c-header  objective-c-cpp-output
1261 objective-c++ objective-c++-header objective-c++-cpp-output
1262 assembler  assembler-with-cpp
1264 f77  f77-cpp-input f95  f95-cpp-input
1266 java
1267 @end smallexample
1269 @item -x none
1270 Turn off any specification of a language, so that subsequent files are
1271 handled according to their file name suffixes (as they are if @option{-x}
1272 has not been used at all).
1274 @item -pass-exit-codes
1275 @opindex pass-exit-codes
1276 Normally the @command{gcc} program exits with the code of 1 if any
1277 phase of the compiler returns a non-success return code.  If you specify
1278 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1279 the numerically highest error produced by any phase returning an error
1280 indication.  The C, C++, and Fortran front ends return 4 if an internal
1281 compiler error is encountered.
1282 @end table
1284 If you only want some of the stages of compilation, you can use
1285 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1286 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1287 @command{gcc} is to stop.  Note that some combinations (for example,
1288 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1290 @table @gcctabopt
1291 @item -c
1292 @opindex c
1293 Compile or assemble the source files, but do not link.  The linking
1294 stage simply is not done.  The ultimate output is in the form of an
1295 object file for each source file.
1297 By default, the object file name for a source file is made by replacing
1298 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1300 Unrecognized input files, not requiring compilation or assembly, are
1301 ignored.
1303 @item -S
1304 @opindex S
1305 Stop after the stage of compilation proper; do not assemble.  The output
1306 is in the form of an assembler code file for each non-assembler input
1307 file specified.
1309 By default, the assembler file name for a source file is made by
1310 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1312 Input files that don't require compilation are ignored.
1314 @item -E
1315 @opindex E
1316 Stop after the preprocessing stage; do not run the compiler proper.  The
1317 output is in the form of preprocessed source code, which is sent to the
1318 standard output.
1320 Input files that don't require preprocessing are ignored.
1322 @cindex output file option
1323 @item -o @var{file}
1324 @opindex o
1325 Place output in file @var{file}.  This applies to whatever
1326 sort of output is being produced, whether it be an executable file,
1327 an object file, an assembler file or preprocessed C code.
1329 If @option{-o} is not specified, the default is to put an executable
1330 file in @file{a.out}, the object file for
1331 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1332 assembler file in @file{@var{source}.s}, a precompiled header file in
1333 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1334 standard output.
1336 @item -v
1337 @opindex v
1338 Print (on standard error output) the commands executed to run the stages
1339 of compilation.  Also print the version number of the compiler driver
1340 program and of the preprocessor and the compiler proper.
1342 @item -###
1343 @opindex ###
1344 Like @option{-v} except the commands are not executed and arguments
1345 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1346 This is useful for shell scripts to capture the driver-generated command lines.
1348 @item -pipe
1349 @opindex pipe
1350 Use pipes rather than temporary files for communication between the
1351 various stages of compilation.  This fails to work on some systems where
1352 the assembler is unable to read from a pipe; but the GNU assembler has
1353 no trouble.
1355 @item --help
1356 @opindex help
1357 Print (on the standard output) a description of the command-line options
1358 understood by @command{gcc}.  If the @option{-v} option is also specified
1359 then @option{--help} is also passed on to the various processes
1360 invoked by @command{gcc}, so that they can display the command-line options
1361 they accept.  If the @option{-Wextra} option has also been specified
1362 (prior to the @option{--help} option), then command-line options that
1363 have no documentation associated with them are also displayed.
1365 @item --target-help
1366 @opindex target-help
1367 Print (on the standard output) a description of target-specific command-line
1368 options for each tool.  For some targets extra target-specific
1369 information may also be printed.
1371 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1372 Print (on the standard output) a description of the command-line
1373 options understood by the compiler that fit into all specified classes
1374 and qualifiers.  These are the supported classes:
1376 @table @asis
1377 @item @samp{optimizers}
1378 Display all of the optimization options supported by the
1379 compiler.
1381 @item @samp{warnings}
1382 Display all of the options controlling warning messages
1383 produced by the compiler.
1385 @item @samp{target}
1386 Display target-specific options.  Unlike the
1387 @option{--target-help} option however, target-specific options of the
1388 linker and assembler are not displayed.  This is because those
1389 tools do not currently support the extended @option{--help=} syntax.
1391 @item @samp{params}
1392 Display the values recognized by the @option{--param}
1393 option.
1395 @item @var{language}
1396 Display the options supported for @var{language}, where
1397 @var{language} is the name of one of the languages supported in this
1398 version of GCC@.
1400 @item @samp{common}
1401 Display the options that are common to all languages.
1402 @end table
1404 These are the supported qualifiers:
1406 @table @asis
1407 @item @samp{undocumented}
1408 Display only those options that are undocumented.
1410 @item @samp{joined}
1411 Display options taking an argument that appears after an equal
1412 sign in the same continuous piece of text, such as:
1413 @samp{--help=target}.
1415 @item @samp{separate}
1416 Display options taking an argument that appears as a separate word
1417 following the original option, such as: @samp{-o output-file}.
1418 @end table
1420 Thus for example to display all the undocumented target-specific
1421 switches supported by the compiler, use:
1423 @smallexample
1424 --help=target,undocumented
1425 @end smallexample
1427 The sense of a qualifier can be inverted by prefixing it with the
1428 @samp{^} character, so for example to display all binary warning
1429 options (i.e., ones that are either on or off and that do not take an
1430 argument) that have a description, use:
1432 @smallexample
1433 --help=warnings,^joined,^undocumented
1434 @end smallexample
1436 The argument to @option{--help=} should not consist solely of inverted
1437 qualifiers.
1439 Combining several classes is possible, although this usually
1440 restricts the output so much that there is nothing to display.  One
1441 case where it does work, however, is when one of the classes is
1442 @var{target}.  For example, to display all the target-specific
1443 optimization options, use:
1445 @smallexample
1446 --help=target,optimizers
1447 @end smallexample
1449 The @option{--help=} option can be repeated on the command line.  Each
1450 successive use displays its requested class of options, skipping
1451 those that have already been displayed.
1453 If the @option{-Q} option appears on the command line before the
1454 @option{--help=} option, then the descriptive text displayed by
1455 @option{--help=} is changed.  Instead of describing the displayed
1456 options, an indication is given as to whether the option is enabled,
1457 disabled or set to a specific value (assuming that the compiler
1458 knows this at the point where the @option{--help=} option is used).
1460 Here is a truncated example from the ARM port of @command{gcc}:
1462 @smallexample
1463   % gcc -Q -mabi=2 --help=target -c
1464   The following options are target specific:
1465   -mabi=                                2
1466   -mabort-on-noreturn                   [disabled]
1467   -mapcs                                [disabled]
1468 @end smallexample
1470 The output is sensitive to the effects of previous command-line
1471 options, so for example it is possible to find out which optimizations
1472 are enabled at @option{-O2} by using:
1474 @smallexample
1475 -Q -O2 --help=optimizers
1476 @end smallexample
1478 Alternatively you can discover which binary optimizations are enabled
1479 by @option{-O3} by using:
1481 @smallexample
1482 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1483 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1484 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1485 @end smallexample
1487 @item -no-canonical-prefixes
1488 @opindex no-canonical-prefixes
1489 Do not expand any symbolic links, resolve references to @samp{/../}
1490 or @samp{/./}, or make the path absolute when generating a relative
1491 prefix.
1493 @item --version
1494 @opindex version
1495 Display the version number and copyrights of the invoked GCC@.
1497 @item -wrapper
1498 @opindex wrapper
1499 Invoke all subcommands under a wrapper program.  The name of the
1500 wrapper program and its parameters are passed as a comma separated
1501 list.
1503 @smallexample
1504 gcc -c t.c -wrapper gdb,--args
1505 @end smallexample
1507 @noindent
1508 This invokes all subprograms of @command{gcc} under
1509 @samp{gdb --args}, thus the invocation of @command{cc1} is
1510 @samp{gdb --args cc1 @dots{}}.
1512 @item -fplugin=@var{name}.so
1513 @opindex fplugin
1514 Load the plugin code in file @var{name}.so, assumed to be a
1515 shared object to be dlopen'd by the compiler.  The base name of
1516 the shared object file is used to identify the plugin for the
1517 purposes of argument parsing (See
1518 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1519 Each plugin should define the callback functions specified in the
1520 Plugins API.
1522 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1523 @opindex fplugin-arg
1524 Define an argument called @var{key} with a value of @var{value}
1525 for the plugin called @var{name}.
1527 @item -fdump-ada-spec@r{[}-slim@r{]}
1528 @opindex fdump-ada-spec
1529 For C and C++ source and include files, generate corresponding Ada specs.
1530 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1531 GNAT User's Guide}, which provides detailed documentation on this feature.
1533 @item -fada-spec-parent=@var{unit}
1534 @opindex fada-spec-parent
1535 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1536 Ada specs as child units of parent @var{unit}.
1538 @item -fdump-go-spec=@var{file}
1539 @opindex fdump-go-spec
1540 For input files in any language, generate corresponding Go
1541 declarations in @var{file}.  This generates Go @code{const},
1542 @code{type}, @code{var}, and @code{func} declarations which may be a
1543 useful way to start writing a Go interface to code written in some
1544 other language.
1546 @include @value{srcdir}/../libiberty/at-file.texi
1547 @end table
1549 @node Invoking G++
1550 @section Compiling C++ Programs
1552 @cindex suffixes for C++ source
1553 @cindex C++ source file suffixes
1554 C++ source files conventionally use one of the suffixes @samp{.C},
1555 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1556 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1557 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1558 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1559 files with these names and compiles them as C++ programs even if you
1560 call the compiler the same way as for compiling C programs (usually
1561 with the name @command{gcc}).
1563 @findex g++
1564 @findex c++
1565 However, the use of @command{gcc} does not add the C++ library.
1566 @command{g++} is a program that calls GCC and automatically specifies linking
1567 against the C++ library.  It treats @samp{.c},
1568 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1569 files unless @option{-x} is used.  This program is also useful when
1570 precompiling a C header file with a @samp{.h} extension for use in C++
1571 compilations.  On many systems, @command{g++} is also installed with
1572 the name @command{c++}.
1574 @cindex invoking @command{g++}
1575 When you compile C++ programs, you may specify many of the same
1576 command-line options that you use for compiling programs in any
1577 language; or command-line options meaningful for C and related
1578 languages; or options that are meaningful only for C++ programs.
1579 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1580 explanations of options for languages related to C@.
1581 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1582 explanations of options that are meaningful only for C++ programs.
1584 @node C Dialect Options
1585 @section Options Controlling C Dialect
1586 @cindex dialect options
1587 @cindex language dialect options
1588 @cindex options, dialect
1590 The following options control the dialect of C (or languages derived
1591 from C, such as C++, Objective-C and Objective-C++) that the compiler
1592 accepts:
1594 @table @gcctabopt
1595 @cindex ANSI support
1596 @cindex ISO support
1597 @item -ansi
1598 @opindex ansi
1599 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1600 equivalent to @option{-std=c++98}.
1602 This turns off certain features of GCC that are incompatible with ISO
1603 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1604 such as the @code{asm} and @code{typeof} keywords, and
1605 predefined macros such as @code{unix} and @code{vax} that identify the
1606 type of system you are using.  It also enables the undesirable and
1607 rarely used ISO trigraph feature.  For the C compiler,
1608 it disables recognition of C++ style @samp{//} comments as well as
1609 the @code{inline} keyword.
1611 The alternate keywords @code{__asm__}, @code{__extension__},
1612 @code{__inline__} and @code{__typeof__} continue to work despite
1613 @option{-ansi}.  You would not want to use them in an ISO C program, of
1614 course, but it is useful to put them in header files that might be included
1615 in compilations done with @option{-ansi}.  Alternate predefined macros
1616 such as @code{__unix__} and @code{__vax__} are also available, with or
1617 without @option{-ansi}.
1619 The @option{-ansi} option does not cause non-ISO programs to be
1620 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1621 addition to @option{-ansi}.  @xref{Warning Options}.
1623 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1624 option is used.  Some header files may notice this macro and refrain
1625 from declaring certain functions or defining certain macros that the
1626 ISO standard doesn't call for; this is to avoid interfering with any
1627 programs that might use these names for other things.
1629 Functions that are normally built in but do not have semantics
1630 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1631 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1632 built-in functions provided by GCC}, for details of the functions
1633 affected.
1635 @item -std=
1636 @opindex std
1637 Determine the language standard. @xref{Standards,,Language Standards
1638 Supported by GCC}, for details of these standard versions.  This option
1639 is currently only supported when compiling C or C++.
1641 The compiler can accept several base standards, such as @samp{c90} or
1642 @samp{c++98}, and GNU dialects of those standards, such as
1643 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1644 compiler accepts all programs following that standard plus those
1645 using GNU extensions that do not contradict it.  For example,
1646 @option{-std=c90} turns off certain features of GCC that are
1647 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1648 keywords, but not other GNU extensions that do not have a meaning in
1649 ISO C90, such as omitting the middle term of a @code{?:}
1650 expression. On the other hand, when a GNU dialect of a standard is
1651 specified, all features supported by the compiler are enabled, even when
1652 those features change the meaning of the base standard.  As a result, some
1653 strict-conforming programs may be rejected.  The particular standard
1654 is used by @option{-Wpedantic} to identify which features are GNU
1655 extensions given that version of the standard. For example
1656 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1657 comments, while @option{-std=gnu99 -Wpedantic} does not.
1659 A value for this option must be provided; possible values are
1661 @table @samp
1662 @item c90
1663 @itemx c89
1664 @itemx iso9899:1990
1665 Support all ISO C90 programs (certain GNU extensions that conflict
1666 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1668 @item iso9899:199409
1669 ISO C90 as modified in amendment 1.
1671 @item c99
1672 @itemx c9x
1673 @itemx iso9899:1999
1674 @itemx iso9899:199x
1675 ISO C99.  This standard is substantially completely supported, modulo
1676 bugs, extended identifiers (supported except for corner cases when
1677 @option{-fextended-identifiers} is used) and floating-point issues
1678 (mainly but not entirely relating to optional C99 features from
1679 Annexes F and G).  See
1680 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1681 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1683 @item c11
1684 @itemx c1x
1685 @itemx iso9899:2011
1686 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1687 substantially completely supported, modulo bugs, extended identifiers
1688 (supported except for corner cases when
1689 @option{-fextended-identifiers} is used), floating-point issues
1690 (mainly but not entirely relating to optional C11 features from
1691 Annexes F and G) and the optional Annexes K (Bounds-checking
1692 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1694 @item gnu90
1695 @itemx gnu89
1696 GNU dialect of ISO C90 (including some C99 features). This
1697 is the default for C code.
1699 @item gnu99
1700 @itemx gnu9x
1701 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1703 @item gnu11
1704 @itemx gnu1x
1705 GNU dialect of ISO C11.  This is intended to become the default in a
1706 future release of GCC.  The name @samp{gnu1x} is deprecated.
1708 @item c++98
1709 @itemx c++03
1710 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1711 additional defect reports. Same as @option{-ansi} for C++ code.
1713 @item gnu++98
1714 @itemx gnu++03
1715 GNU dialect of @option{-std=c++98}.  This is the default for
1716 C++ code.
1718 @item c++11
1719 @itemx c++0x
1720 The 2011 ISO C++ standard plus amendments.
1721 The name @samp{c++0x} is deprecated.
1723 @item gnu++11
1724 @itemx gnu++0x
1725 GNU dialect of @option{-std=c++11}.
1726 The name @samp{gnu++0x} is deprecated.
1728 @item c++14
1729 @itemx c++1y
1730 The 2014 ISO C++ standard plus amendments.
1731 The name @samp{c++1y} is deprecated.
1733 @item gnu++14
1734 @itemx gnu++1y
1735 GNU dialect of @option{-std=c++14}.
1736 The name @samp{gnu++1y} is deprecated.
1738 @item c++1z
1739 The next revision of the ISO C++ standard, tentatively planned for
1740 2017.  Support is highly experimental, and will almost certainly
1741 change in incompatible ways in future releases.
1743 @item gnu++1z
1744 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1745 and will almost certainly change in incompatible ways in future
1746 releases.
1747 @end table
1749 @item -fgnu89-inline
1750 @opindex fgnu89-inline
1751 The option @option{-fgnu89-inline} tells GCC to use the traditional
1752 GNU semantics for @code{inline} functions when in C99 mode.
1753 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1754 is accepted and ignored by GCC versions 4.1.3 up to but not including
1755 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1756 C99 mode.  Using this option is roughly equivalent to adding the
1757 @code{gnu_inline} function attribute to all inline functions
1758 (@pxref{Function Attributes}).
1760 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1761 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1762 specifies the default behavior).  This option was first supported in
1763 GCC 4.3.  This option is not supported in @option{-std=c90} or
1764 @option{-std=gnu90} mode.
1766 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1767 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1768 in effect for @code{inline} functions.  @xref{Common Predefined
1769 Macros,,,cpp,The C Preprocessor}.
1771 @item -aux-info @var{filename}
1772 @opindex aux-info
1773 Output to the given filename prototyped declarations for all functions
1774 declared and/or defined in a translation unit, including those in header
1775 files.  This option is silently ignored in any language other than C@.
1777 Besides declarations, the file indicates, in comments, the origin of
1778 each declaration (source file and line), whether the declaration was
1779 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1780 @samp{O} for old, respectively, in the first character after the line
1781 number and the colon), and whether it came from a declaration or a
1782 definition (@samp{C} or @samp{F}, respectively, in the following
1783 character).  In the case of function definitions, a K&R-style list of
1784 arguments followed by their declarations is also provided, inside
1785 comments, after the declaration.
1787 @item -fallow-parameterless-variadic-functions
1788 @opindex fallow-parameterless-variadic-functions
1789 Accept variadic functions without named parameters.
1791 Although it is possible to define such a function, this is not very
1792 useful as it is not possible to read the arguments.  This is only
1793 supported for C as this construct is allowed by C++.
1795 @item -fno-asm
1796 @opindex fno-asm
1797 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1798 keyword, so that code can use these words as identifiers.  You can use
1799 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1800 instead.  @option{-ansi} implies @option{-fno-asm}.
1802 In C++, this switch only affects the @code{typeof} keyword, since
1803 @code{asm} and @code{inline} are standard keywords.  You may want to
1804 use the @option{-fno-gnu-keywords} flag instead, which has the same
1805 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1806 switch only affects the @code{asm} and @code{typeof} keywords, since
1807 @code{inline} is a standard keyword in ISO C99.
1809 @item -fno-builtin
1810 @itemx -fno-builtin-@var{function}
1811 @opindex fno-builtin
1812 @cindex built-in functions
1813 Don't recognize built-in functions that do not begin with
1814 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1815 functions provided by GCC}, for details of the functions affected,
1816 including those which are not built-in functions when @option{-ansi} or
1817 @option{-std} options for strict ISO C conformance are used because they
1818 do not have an ISO standard meaning.
1820 GCC normally generates special code to handle certain built-in functions
1821 more efficiently; for instance, calls to @code{alloca} may become single
1822 instructions which adjust the stack directly, and calls to @code{memcpy}
1823 may become inline copy loops.  The resulting code is often both smaller
1824 and faster, but since the function calls no longer appear as such, you
1825 cannot set a breakpoint on those calls, nor can you change the behavior
1826 of the functions by linking with a different library.  In addition,
1827 when a function is recognized as a built-in function, GCC may use
1828 information about that function to warn about problems with calls to
1829 that function, or to generate more efficient code, even if the
1830 resulting code still contains calls to that function.  For example,
1831 warnings are given with @option{-Wformat} for bad calls to
1832 @code{printf} when @code{printf} is built in and @code{strlen} is
1833 known not to modify global memory.
1835 With the @option{-fno-builtin-@var{function}} option
1836 only the built-in function @var{function} is
1837 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1838 function is named that is not built-in in this version of GCC, this
1839 option is ignored.  There is no corresponding
1840 @option{-fbuiltin-@var{function}} option; if you wish to enable
1841 built-in functions selectively when using @option{-fno-builtin} or
1842 @option{-ffreestanding}, you may define macros such as:
1844 @smallexample
1845 #define abs(n)          __builtin_abs ((n))
1846 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1847 @end smallexample
1849 @item -fhosted
1850 @opindex fhosted
1851 @cindex hosted environment
1853 Assert that compilation targets a hosted environment.  This implies
1854 @option{-fbuiltin}.  A hosted environment is one in which the
1855 entire standard library is available, and in which @code{main} has a return
1856 type of @code{int}.  Examples are nearly everything except a kernel.
1857 This is equivalent to @option{-fno-freestanding}.
1859 @item -ffreestanding
1860 @opindex ffreestanding
1861 @cindex hosted environment
1863 Assert that compilation targets a freestanding environment.  This
1864 implies @option{-fno-builtin}.  A freestanding environment
1865 is one in which the standard library may not exist, and program startup may
1866 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1867 This is equivalent to @option{-fno-hosted}.
1869 @xref{Standards,,Language Standards Supported by GCC}, for details of
1870 freestanding and hosted environments.
1872 @item -fopenmp
1873 @opindex fopenmp
1874 @cindex OpenMP parallel
1875 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1876 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1877 compiler generates parallel code according to the OpenMP Application
1878 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1879 implies @option{-pthread}, and thus is only supported on targets that
1880 have support for @option{-pthread}. @option{-fopenmp} implies
1881 @option{-fopenmp-simd}.
1883 @item -fopenmp-simd
1884 @opindex fopenmp-simd
1885 @cindex OpenMP SIMD
1886 @cindex SIMD
1887 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1888 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1889 are ignored.
1891 @item -fcilkplus
1892 @opindex fcilkplus
1893 @cindex Enable Cilk Plus
1894 Enable the usage of Cilk Plus language extension features for C/C++.
1895 When the option @option{-fcilkplus} is specified, enable the usage of
1896 the Cilk Plus Language extension features for C/C++.  The present
1897 implementation follows ABI version 1.2.  This is an experimental
1898 feature that is only partially complete, and whose interface may
1899 change in future versions of GCC as the official specification
1900 changes.  Currently, all features but @code{_Cilk_for} have been
1901 implemented.
1903 @item -fgnu-tm
1904 @opindex fgnu-tm
1905 When the option @option{-fgnu-tm} is specified, the compiler
1906 generates code for the Linux variant of Intel's current Transactional
1907 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1908 an experimental feature whose interface may change in future versions
1909 of GCC, as the official specification changes.  Please note that not
1910 all architectures are supported for this feature.
1912 For more information on GCC's support for transactional memory,
1913 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1914 Transactional Memory Library}.
1916 Note that the transactional memory feature is not supported with
1917 non-call exceptions (@option{-fnon-call-exceptions}).
1919 @item -fms-extensions
1920 @opindex fms-extensions
1921 Accept some non-standard constructs used in Microsoft header files.
1923 In C++ code, this allows member names in structures to be similar
1924 to previous types declarations.
1926 @smallexample
1927 typedef int UOW;
1928 struct ABC @{
1929   UOW UOW;
1931 @end smallexample
1933 Some cases of unnamed fields in structures and unions are only
1934 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1935 fields within structs/unions}, for details.
1937 Note that this option is off for all targets but i?86 and x86_64
1938 targets using ms-abi.
1939 @item -fplan9-extensions
1940 Accept some non-standard constructs used in Plan 9 code.
1942 This enables @option{-fms-extensions}, permits passing pointers to
1943 structures with anonymous fields to functions that expect pointers to
1944 elements of the type of the field, and permits referring to anonymous
1945 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1946 struct/union fields within structs/unions}, for details.  This is only
1947 supported for C, not C++.
1949 @item -trigraphs
1950 @opindex trigraphs
1951 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1952 options for strict ISO C conformance) implies @option{-trigraphs}.
1954 @cindex traditional C language
1955 @cindex C language, traditional
1956 @item -traditional
1957 @itemx -traditional-cpp
1958 @opindex traditional-cpp
1959 @opindex traditional
1960 Formerly, these options caused GCC to attempt to emulate a pre-standard
1961 C compiler.  They are now only supported with the @option{-E} switch.
1962 The preprocessor continues to support a pre-standard mode.  See the GNU
1963 CPP manual for details.
1965 @item -fcond-mismatch
1966 @opindex fcond-mismatch
1967 Allow conditional expressions with mismatched types in the second and
1968 third arguments.  The value of such an expression is void.  This option
1969 is not supported for C++.
1971 @item -flax-vector-conversions
1972 @opindex flax-vector-conversions
1973 Allow implicit conversions between vectors with differing numbers of
1974 elements and/or incompatible element types.  This option should not be
1975 used for new code.
1977 @item -funsigned-char
1978 @opindex funsigned-char
1979 Let the type @code{char} be unsigned, like @code{unsigned char}.
1981 Each kind of machine has a default for what @code{char} should
1982 be.  It is either like @code{unsigned char} by default or like
1983 @code{signed char} by default.
1985 Ideally, a portable program should always use @code{signed char} or
1986 @code{unsigned char} when it depends on the signedness of an object.
1987 But many programs have been written to use plain @code{char} and
1988 expect it to be signed, or expect it to be unsigned, depending on the
1989 machines they were written for.  This option, and its inverse, let you
1990 make such a program work with the opposite default.
1992 The type @code{char} is always a distinct type from each of
1993 @code{signed char} or @code{unsigned char}, even though its behavior
1994 is always just like one of those two.
1996 @item -fsigned-char
1997 @opindex fsigned-char
1998 Let the type @code{char} be signed, like @code{signed char}.
2000 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2001 the negative form of @option{-funsigned-char}.  Likewise, the option
2002 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2004 @item -fsigned-bitfields
2005 @itemx -funsigned-bitfields
2006 @itemx -fno-signed-bitfields
2007 @itemx -fno-unsigned-bitfields
2008 @opindex fsigned-bitfields
2009 @opindex funsigned-bitfields
2010 @opindex fno-signed-bitfields
2011 @opindex fno-unsigned-bitfields
2012 These options control whether a bit-field is signed or unsigned, when the
2013 declaration does not use either @code{signed} or @code{unsigned}.  By
2014 default, such a bit-field is signed, because this is consistent: the
2015 basic integer types such as @code{int} are signed types.
2016 @end table
2018 @node C++ Dialect Options
2019 @section Options Controlling C++ Dialect
2021 @cindex compiler options, C++
2022 @cindex C++ options, command-line
2023 @cindex options, C++
2024 This section describes the command-line options that are only meaningful
2025 for C++ programs.  You can also use most of the GNU compiler options
2026 regardless of what language your program is in.  For example, you
2027 might compile a file @code{firstClass.C} like this:
2029 @smallexample
2030 g++ -g -frepo -O -c firstClass.C
2031 @end smallexample
2033 @noindent
2034 In this example, only @option{-frepo} is an option meant
2035 only for C++ programs; you can use the other options with any
2036 language supported by GCC@.
2038 Here is a list of options that are @emph{only} for compiling C++ programs:
2040 @table @gcctabopt
2042 @item -fabi-version=@var{n}
2043 @opindex fabi-version
2044 Use version @var{n} of the C++ ABI@.  The default is version 0.
2046 Version 0 refers to the version conforming most closely to
2047 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2048 will change in different versions of G++ as ABI bugs are fixed.
2050 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2052 Version 2 is the version of the C++ ABI that first appeared in G++
2053 3.4, and was the default through G++ 4.9.
2055 Version 3 corrects an error in mangling a constant address as a
2056 template argument.
2058 Version 4, which first appeared in G++ 4.5, implements a standard
2059 mangling for vector types.
2061 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2062 attribute const/volatile on function pointer types, decltype of a
2063 plain decl, and use of a function parameter in the declaration of
2064 another parameter.
2066 Version 6, which first appeared in G++ 4.7, corrects the promotion
2067 behavior of C++11 scoped enums and the mangling of template argument
2068 packs, const/static_cast, prefix ++ and --, and a class scope function
2069 used as a template argument.
2071 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2072 builtin type and corrects the mangling of lambdas in default argument
2073 scope.
2075 Version 8, which first appeared in G++ 4.9, corrects the substitution
2076 behavior of function types with function-cv-qualifiers.
2078 See also @option{-Wabi}.
2080 @item -fabi-compat-version=@var{n}
2081 @opindex fabi-compat-version
2082 Starting with GCC 4.5, on targets that support strong aliases, G++
2083 works around mangling changes by creating an alias with the correct
2084 mangled name when defining a symbol with an incorrect mangled name.
2085 This switch specifies which ABI version to use for the alias.
2087 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2088 another ABI version is explicitly selected, this defaults to 0.
2090 The compatibility version is also set by @option{-Wabi=@var{n}}.
2092 @item -fno-access-control
2093 @opindex fno-access-control
2094 Turn off all access checking.  This switch is mainly useful for working
2095 around bugs in the access control code.
2097 @item -fcheck-new
2098 @opindex fcheck-new
2099 Check that the pointer returned by @code{operator new} is non-null
2100 before attempting to modify the storage allocated.  This check is
2101 normally unnecessary because the C++ standard specifies that
2102 @code{operator new} only returns @code{0} if it is declared
2103 @samp{throw()}, in which case the compiler always checks the
2104 return value even without this option.  In all other cases, when
2105 @code{operator new} has a non-empty exception specification, memory
2106 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2107 @samp{new (nothrow)}.
2109 @item -fconstexpr-depth=@var{n}
2110 @opindex fconstexpr-depth
2111 Set the maximum nested evaluation depth for C++11 constexpr functions
2112 to @var{n}.  A limit is needed to detect endless recursion during
2113 constant expression evaluation.  The minimum specified by the standard
2114 is 512.
2116 @item -fdeduce-init-list
2117 @opindex fdeduce-init-list
2118 Enable deduction of a template type parameter as
2119 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2121 @smallexample
2122 template <class T> auto forward(T t) -> decltype (realfn (t))
2124   return realfn (t);
2127 void f()
2129   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2131 @end smallexample
2133 This deduction was implemented as a possible extension to the
2134 originally proposed semantics for the C++11 standard, but was not part
2135 of the final standard, so it is disabled by default.  This option is
2136 deprecated, and may be removed in a future version of G++.
2138 @item -ffriend-injection
2139 @opindex ffriend-injection
2140 Inject friend functions into the enclosing namespace, so that they are
2141 visible outside the scope of the class in which they are declared.
2142 Friend functions were documented to work this way in the old Annotated
2143 C++ Reference Manual, and versions of G++ before 4.1 always worked
2144 that way.  However, in ISO C++ a friend function that is not declared
2145 in an enclosing scope can only be found using argument dependent
2146 lookup.  This option causes friends to be injected as they were in
2147 earlier releases.
2149 This option is for compatibility, and may be removed in a future
2150 release of G++.
2152 @item -fno-elide-constructors
2153 @opindex fno-elide-constructors
2154 The C++ standard allows an implementation to omit creating a temporary
2155 that is only used to initialize another object of the same type.
2156 Specifying this option disables that optimization, and forces G++ to
2157 call the copy constructor in all cases.
2159 @item -fno-enforce-eh-specs
2160 @opindex fno-enforce-eh-specs
2161 Don't generate code to check for violation of exception specifications
2162 at run time.  This option violates the C++ standard, but may be useful
2163 for reducing code size in production builds, much like defining
2164 @samp{NDEBUG}.  This does not give user code permission to throw
2165 exceptions in violation of the exception specifications; the compiler
2166 still optimizes based on the specifications, so throwing an
2167 unexpected exception results in undefined behavior at run time.
2169 @item -fextern-tls-init
2170 @itemx -fno-extern-tls-init
2171 @opindex fextern-tls-init
2172 @opindex fno-extern-tls-init
2173 The C++11 and OpenMP standards allow @samp{thread_local} and
2174 @samp{threadprivate} variables to have dynamic (runtime)
2175 initialization.  To support this, any use of such a variable goes
2176 through a wrapper function that performs any necessary initialization.
2177 When the use and definition of the variable are in the same
2178 translation unit, this overhead can be optimized away, but when the
2179 use is in a different translation unit there is significant overhead
2180 even if the variable doesn't actually need dynamic initialization.  If
2181 the programmer can be sure that no use of the variable in a
2182 non-defining TU needs to trigger dynamic initialization (either
2183 because the variable is statically initialized, or a use of the
2184 variable in the defining TU will be executed before any uses in
2185 another TU), they can avoid this overhead with the
2186 @option{-fno-extern-tls-init} option.
2188 On targets that support symbol aliases, the default is
2189 @option{-fextern-tls-init}.  On targets that do not support symbol
2190 aliases, the default is @option{-fno-extern-tls-init}.
2192 @item -ffor-scope
2193 @itemx -fno-for-scope
2194 @opindex ffor-scope
2195 @opindex fno-for-scope
2196 If @option{-ffor-scope} is specified, the scope of variables declared in
2197 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2198 as specified by the C++ standard.
2199 If @option{-fno-for-scope} is specified, the scope of variables declared in
2200 a @i{for-init-statement} extends to the end of the enclosing scope,
2201 as was the case in old versions of G++, and other (traditional)
2202 implementations of C++.
2204 If neither flag is given, the default is to follow the standard,
2205 but to allow and give a warning for old-style code that would
2206 otherwise be invalid, or have different behavior.
2208 @item -fno-gnu-keywords
2209 @opindex fno-gnu-keywords
2210 Do not recognize @code{typeof} as a keyword, so that code can use this
2211 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2212 @option{-ansi} implies @option{-fno-gnu-keywords}.
2214 @item -fno-implicit-templates
2215 @opindex fno-implicit-templates
2216 Never emit code for non-inline templates that are instantiated
2217 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2218 @xref{Template Instantiation}, for more information.
2220 @item -fno-implicit-inline-templates
2221 @opindex fno-implicit-inline-templates
2222 Don't emit code for implicit instantiations of inline templates, either.
2223 The default is to handle inlines differently so that compiles with and
2224 without optimization need the same set of explicit instantiations.
2226 @item -fno-implement-inlines
2227 @opindex fno-implement-inlines
2228 To save space, do not emit out-of-line copies of inline functions
2229 controlled by @samp{#pragma implementation}.  This causes linker
2230 errors if these functions are not inlined everywhere they are called.
2232 @item -fms-extensions
2233 @opindex fms-extensions
2234 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2235 int and getting a pointer to member function via non-standard syntax.
2237 @item -fno-nonansi-builtins
2238 @opindex fno-nonansi-builtins
2239 Disable built-in declarations of functions that are not mandated by
2240 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2241 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2243 @item -fnothrow-opt
2244 @opindex fnothrow-opt
2245 Treat a @code{throw()} exception specification as if it were a
2246 @code{noexcept} specification to reduce or eliminate the text size
2247 overhead relative to a function with no exception specification.  If
2248 the function has local variables of types with non-trivial
2249 destructors, the exception specification actually makes the
2250 function smaller because the EH cleanups for those variables can be
2251 optimized away.  The semantic effect is that an exception thrown out of
2252 a function with such an exception specification results in a call
2253 to @code{terminate} rather than @code{unexpected}.
2255 @item -fno-operator-names
2256 @opindex fno-operator-names
2257 Do not treat the operator name keywords @code{and}, @code{bitand},
2258 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2259 synonyms as keywords.
2261 @item -fno-optional-diags
2262 @opindex fno-optional-diags
2263 Disable diagnostics that the standard says a compiler does not need to
2264 issue.  Currently, the only such diagnostic issued by G++ is the one for
2265 a name having multiple meanings within a class.
2267 @item -fpermissive
2268 @opindex fpermissive
2269 Downgrade some diagnostics about nonconformant code from errors to
2270 warnings.  Thus, using @option{-fpermissive} allows some
2271 nonconforming code to compile.
2273 @item -fno-pretty-templates
2274 @opindex fno-pretty-templates
2275 When an error message refers to a specialization of a function
2276 template, the compiler normally prints the signature of the
2277 template followed by the template arguments and any typedefs or
2278 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2279 rather than @code{void f(int)}) so that it's clear which template is
2280 involved.  When an error message refers to a specialization of a class
2281 template, the compiler omits any template arguments that match
2282 the default template arguments for that template.  If either of these
2283 behaviors make it harder to understand the error message rather than
2284 easier, you can use @option{-fno-pretty-templates} to disable them.
2286 @item -frepo
2287 @opindex frepo
2288 Enable automatic template instantiation at link time.  This option also
2289 implies @option{-fno-implicit-templates}.  @xref{Template
2290 Instantiation}, for more information.
2292 @item -fno-rtti
2293 @opindex fno-rtti
2294 Disable generation of information about every class with virtual
2295 functions for use by the C++ run-time type identification features
2296 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2297 of the language, you can save some space by using this flag.  Note that
2298 exception handling uses the same information, but G++ generates it as
2299 needed. The @samp{dynamic_cast} operator can still be used for casts that
2300 do not require run-time type information, i.e.@: casts to @code{void *} or to
2301 unambiguous base classes.
2303 @item -fstats
2304 @opindex fstats
2305 Emit statistics about front-end processing at the end of the compilation.
2306 This information is generally only useful to the G++ development team.
2308 @item -fstrict-enums
2309 @opindex fstrict-enums
2310 Allow the compiler to optimize using the assumption that a value of
2311 enumerated type can only be one of the values of the enumeration (as
2312 defined in the C++ standard; basically, a value that can be
2313 represented in the minimum number of bits needed to represent all the
2314 enumerators).  This assumption may not be valid if the program uses a
2315 cast to convert an arbitrary integer value to the enumerated type.
2317 @item -ftemplate-backtrace-limit=@var{n}
2318 @opindex ftemplate-backtrace-limit
2319 Set the maximum number of template instantiation notes for a single
2320 warning or error to @var{n}.  The default value is 10.
2322 @item -ftemplate-depth=@var{n}
2323 @opindex ftemplate-depth
2324 Set the maximum instantiation depth for template classes to @var{n}.
2325 A limit on the template instantiation depth is needed to detect
2326 endless recursions during template class instantiation.  ANSI/ISO C++
2327 conforming programs must not rely on a maximum depth greater than 17
2328 (changed to 1024 in C++11).  The default value is 900, as the compiler
2329 can run out of stack space before hitting 1024 in some situations.
2331 @item -fno-threadsafe-statics
2332 @opindex fno-threadsafe-statics
2333 Do not emit the extra code to use the routines specified in the C++
2334 ABI for thread-safe initialization of local statics.  You can use this
2335 option to reduce code size slightly in code that doesn't need to be
2336 thread-safe.
2338 @item -fuse-cxa-atexit
2339 @opindex fuse-cxa-atexit
2340 Register destructors for objects with static storage duration with the
2341 @code{__cxa_atexit} function rather than the @code{atexit} function.
2342 This option is required for fully standards-compliant handling of static
2343 destructors, but only works if your C library supports
2344 @code{__cxa_atexit}.
2346 @item -fno-use-cxa-get-exception-ptr
2347 @opindex fno-use-cxa-get-exception-ptr
2348 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2349 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2350 if the runtime routine is not available.
2352 @item -fvisibility-inlines-hidden
2353 @opindex fvisibility-inlines-hidden
2354 This switch declares that the user does not attempt to compare
2355 pointers to inline functions or methods where the addresses of the two functions
2356 are taken in different shared objects.
2358 The effect of this is that GCC may, effectively, mark inline methods with
2359 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2360 appear in the export table of a DSO and do not require a PLT indirection
2361 when used within the DSO@.  Enabling this option can have a dramatic effect
2362 on load and link times of a DSO as it massively reduces the size of the
2363 dynamic export table when the library makes heavy use of templates.
2365 The behavior of this switch is not quite the same as marking the
2366 methods as hidden directly, because it does not affect static variables
2367 local to the function or cause the compiler to deduce that
2368 the function is defined in only one shared object.
2370 You may mark a method as having a visibility explicitly to negate the
2371 effect of the switch for that method.  For example, if you do want to
2372 compare pointers to a particular inline method, you might mark it as
2373 having default visibility.  Marking the enclosing class with explicit
2374 visibility has no effect.
2376 Explicitly instantiated inline methods are unaffected by this option
2377 as their linkage might otherwise cross a shared library boundary.
2378 @xref{Template Instantiation}.
2380 @item -fvisibility-ms-compat
2381 @opindex fvisibility-ms-compat
2382 This flag attempts to use visibility settings to make GCC's C++
2383 linkage model compatible with that of Microsoft Visual Studio.
2385 The flag makes these changes to GCC's linkage model:
2387 @enumerate
2388 @item
2389 It sets the default visibility to @code{hidden}, like
2390 @option{-fvisibility=hidden}.
2392 @item
2393 Types, but not their members, are not hidden by default.
2395 @item
2396 The One Definition Rule is relaxed for types without explicit
2397 visibility specifications that are defined in more than one
2398 shared object: those declarations are permitted if they are
2399 permitted when this option is not used.
2400 @end enumerate
2402 In new code it is better to use @option{-fvisibility=hidden} and
2403 export those classes that are intended to be externally visible.
2404 Unfortunately it is possible for code to rely, perhaps accidentally,
2405 on the Visual Studio behavior.
2407 Among the consequences of these changes are that static data members
2408 of the same type with the same name but defined in different shared
2409 objects are different, so changing one does not change the other;
2410 and that pointers to function members defined in different shared
2411 objects may not compare equal.  When this flag is given, it is a
2412 violation of the ODR to define types with the same name differently.
2414 @item -fvtable-verify=@var{std|preinit|none}
2415 @opindex fvtable-verify
2416 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2417 feature that verifies at runtime, for every virtual call that is made, that
2418 the vtable pointer through which the call is made is valid for the type of
2419 the object, and has not been corrupted or overwritten.  If an invalid vtable
2420 pointer is detected (at runtime), an error is reported and execution of the
2421 program is immediately halted.
2423 This option causes runtime data structures to be built, at program start up,
2424 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2425 control the timing of when these data structures are built.  In both cases the
2426 data structures are built before execution reaches 'main'.  The
2427 @option{-fvtable-verify=std} causes these data structure to be built after the
2428 shared libraries have been loaded and initialized.
2429 @option{-fvtable-verify=preinit} causes them to be built before the shared
2430 libraries have been loaded and initialized.
2432 If this option appears multiple times in the compiler line, with different
2433 values specified, 'none' will take highest priority over both 'std' and
2434 'preinit'; 'preinit' will take priority over 'std'.
2436 @item -fvtv-debug
2437 @opindex (fvtv-debug)
2438 Causes debug versions of the runtime functions for the vtable verification 
2439 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2440 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2441 compiler to keep track of which vtable pointers it found for each class, and
2442 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2443 file directory on the user's machine.
2445 Note:  This feature APPENDS data to the log file. If you want a fresh log
2446 file, be sure to delete any existing one.
2448 @item -fvtv-counts
2449 @opindex fvtv-counts
2450 This is a debugging flag.  When used in conjunction with
2451 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2452 causes the compiler to keep track of the total number of virtual calls
2453 it encountered and the number of verifications it inserted.  It also
2454 counts the number of calls to certain runtime library functions
2455 that it inserts.  This information, for each compilation unit, is written
2456 to a file named ``vtv_count_data.log'', in the dump_file directory on
2457 the user's machine.   It also counts the size of the vtable pointer sets
2458 for each class, and writes this information to ``vtv_class_set_sizes.log''
2459 in the same directory.
2461 Note:  This feature APPENDS data to the log files.  To get a fresh log
2462 files, be sure to delete any existing ones.
2464 @item -fno-weak
2465 @opindex fno-weak
2466 Do not use weak symbol support, even if it is provided by the linker.
2467 By default, G++ uses weak symbols if they are available.  This
2468 option exists only for testing, and should not be used by end-users;
2469 it results in inferior code and has no benefits.  This option may
2470 be removed in a future release of G++.
2472 @item -nostdinc++
2473 @opindex nostdinc++
2474 Do not search for header files in the standard directories specific to
2475 C++, but do still search the other standard directories.  (This option
2476 is used when building the C++ library.)
2477 @end table
2479 In addition, these optimization, warning, and code generation options
2480 have meanings only for C++ programs:
2482 @table @gcctabopt
2483 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2484 @opindex Wabi
2485 @opindex Wno-abi
2486 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2487 G++ to warn when it generates code that is probably not compatible with the
2488 vendor-neutral C++ ABI@.  Since G++ now defaults to
2489 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2490 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2491 or an older compatibility version is selected (with
2492 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2494 Although an effort has been made to warn about
2495 all such cases, there are probably some cases that are not warned about,
2496 even though G++ is generating incompatible code.  There may also be
2497 cases where warnings are emitted even though the code that is generated
2498 is compatible.
2500 You should rewrite your code to avoid these warnings if you are
2501 concerned about the fact that code generated by G++ may not be binary
2502 compatible with code generated by other compilers.
2504 @option{-Wabi} can also be used with an explicit version number to
2505 warn about compatibility with a particular @option{-fabi-version}
2506 level, e.g. @option{-Wabi=2} to warn about changes relative to
2507 @option{-fabi-version=2}.  Specifying a version number also sets
2508 @option{-fabi-compat-version=@var{n}}.
2510 The known incompatibilities in @option{-fabi-version=2} (which was the
2511 default from GCC 3.4 to 4.9) include:
2513 @itemize @bullet
2515 @item
2516 A template with a non-type template parameter of reference type was
2517 mangled incorrectly:
2518 @smallexample
2519 extern int N;
2520 template <int &> struct S @{@};
2521 void n (S<N>) @{2@}
2522 @end smallexample
2524 This was fixed in @option{-fabi-version=3}.
2526 @item
2527 SIMD vector types declared using @code{__attribute ((vector_size))} were
2528 mangled in a non-standard way that does not allow for overloading of
2529 functions taking vectors of different sizes.
2531 The mangling was changed in @option{-fabi-version=4}.
2533 @item
2534 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2535 qualifiers, and @code{decltype} of a plain declaration was folded away.
2537 These mangling issues were fixed in @option{-fabi-version=5}.
2539 @item
2540 Scoped enumerators passed as arguments to a variadic function are
2541 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2542 On most targets this does not actually affect the parameter passing
2543 ABI, as there is no way to pass an argument smaller than @samp{int}.
2545 Also, the ABI changed the mangling of template argument packs,
2546 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2547 a class scope function used as a template argument.
2549 These issues were corrected in @option{-fabi-version=6}.
2551 @item
2552 Lambdas in default argument scope were mangled incorrectly, and the
2553 ABI changed the mangling of nullptr_t.
2555 These issues were corrected in @option{-fabi-version=7}.
2557 @item
2558 When mangling a function type with function-cv-qualifiers, the
2559 un-qualified function type was incorrectly treated as a substitution
2560 candidate.
2562 This was fixed in @option{-fabi-version=8}.
2563 @end itemize
2565 It also warns about psABI-related changes.  The known psABI changes at this
2566 point include:
2568 @itemize @bullet
2570 @item
2571 For SysV/x86-64, unions with @code{long double} members are 
2572 passed in memory as specified in psABI.  For example:
2574 @smallexample
2575 union U @{
2576   long double ld;
2577   int i;
2579 @end smallexample
2581 @noindent
2582 @code{union U} is always passed in memory.
2584 @end itemize
2586 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2587 @opindex Wctor-dtor-privacy
2588 @opindex Wno-ctor-dtor-privacy
2589 Warn when a class seems unusable because all the constructors or
2590 destructors in that class are private, and it has neither friends nor
2591 public static member functions.  Also warn if there are no non-private
2592 methods, and there's at least one private member function that isn't
2593 a constructor or destructor.
2595 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2596 @opindex Wdelete-non-virtual-dtor
2597 @opindex Wno-delete-non-virtual-dtor
2598 Warn when @samp{delete} is used to destroy an instance of a class that
2599 has virtual functions and non-virtual destructor. It is unsafe to delete
2600 an instance of a derived class through a pointer to a base class if the
2601 base class does not have a virtual destructor.  This warning is enabled
2602 by @option{-Wall}.
2604 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2605 @opindex Wliteral-suffix
2606 @opindex Wno-literal-suffix
2607 Warn when a string or character literal is followed by a ud-suffix which does
2608 not begin with an underscore.  As a conforming extension, GCC treats such
2609 suffixes as separate preprocessing tokens in order to maintain backwards
2610 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2611 For example:
2613 @smallexample
2614 #define __STDC_FORMAT_MACROS
2615 #include <inttypes.h>
2616 #include <stdio.h>
2618 int main() @{
2619   int64_t i64 = 123;
2620   printf("My int64: %"PRId64"\n", i64);
2622 @end smallexample
2624 In this case, @code{PRId64} is treated as a separate preprocessing token.
2626 This warning is enabled by default.
2628 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2629 @opindex Wnarrowing
2630 @opindex Wno-narrowing
2631 Warn when a narrowing conversion prohibited by C++11 occurs within
2632 @samp{@{ @}}, e.g.
2634 @smallexample
2635 int i = @{ 2.2 @}; // error: narrowing from double to int
2636 @end smallexample
2638 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2640 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses for
2641 non-constants the diagnostic required by the standard.  Note that this
2642 does not affect the meaning of well-formed code; narrowing conversions
2643 are still considered ill-formed in SFINAE context.
2645 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2646 @opindex Wnoexcept
2647 @opindex Wno-noexcept
2648 Warn when a noexcept-expression evaluates to false because of a call
2649 to a function that does not have a non-throwing exception
2650 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2651 the compiler to never throw an exception.
2653 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2654 @opindex Wnon-virtual-dtor
2655 @opindex Wno-non-virtual-dtor
2656 Warn when a class has virtual functions and an accessible non-virtual
2657 destructor itself or in an accessible polymorphic base class, in which
2658 case it is possible but unsafe to delete an instance of a derived
2659 class through a pointer to the class itself or base class.  This
2660 warning is automatically enabled if @option{-Weffc++} is specified.
2662 @item -Wreorder @r{(C++ and Objective-C++ only)}
2663 @opindex Wreorder
2664 @opindex Wno-reorder
2665 @cindex reordering, warning
2666 @cindex warning for reordering of member initializers
2667 Warn when the order of member initializers given in the code does not
2668 match the order in which they must be executed.  For instance:
2670 @smallexample
2671 struct A @{
2672   int i;
2673   int j;
2674   A(): j (0), i (1) @{ @}
2676 @end smallexample
2678 @noindent
2679 The compiler rearranges the member initializers for @samp{i}
2680 and @samp{j} to match the declaration order of the members, emitting
2681 a warning to that effect.  This warning is enabled by @option{-Wall}.
2683 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2684 @opindex fext-numeric-literals
2685 @opindex fno-ext-numeric-literals
2686 Accept imaginary, fixed-point, or machine-defined
2687 literal number suffixes as GNU extensions.
2688 When this option is turned off these suffixes are treated
2689 as C++11 user-defined literal numeric suffixes.
2690 This is on by default for all pre-C++11 dialects and all GNU dialects:
2691 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2692 @option{-std=gnu++14}.
2693 This option is off by default
2694 for ISO C++11 onwards (@option{-std=c++11}, ...).
2695 @end table
2697 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2699 @table @gcctabopt
2700 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2701 @opindex Weffc++
2702 @opindex Wno-effc++
2703 Warn about violations of the following style guidelines from Scott Meyers'
2704 @cite{Effective C++} series of books:
2706 @itemize @bullet
2707 @item
2708 Define a copy constructor and an assignment operator for classes
2709 with dynamically-allocated memory.
2711 @item
2712 Prefer initialization to assignment in constructors.
2714 @item
2715 Have @code{operator=} return a reference to @code{*this}.
2717 @item
2718 Don't try to return a reference when you must return an object.
2720 @item
2721 Distinguish between prefix and postfix forms of increment and
2722 decrement operators.
2724 @item
2725 Never overload @code{&&}, @code{||}, or @code{,}.
2727 @end itemize
2729 This option also enables @option{-Wnon-virtual-dtor}, which is also
2730 one of the effective C++ recommendations.  However, the check is
2731 extended to warn about the lack of virtual destructor in accessible
2732 non-polymorphic bases classes too.
2734 When selecting this option, be aware that the standard library
2735 headers do not obey all of these guidelines; use @samp{grep -v}
2736 to filter out those warnings.
2738 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2739 @opindex Wstrict-null-sentinel
2740 @opindex Wno-strict-null-sentinel
2741 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2742 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2743 to @code{__null}.  Although it is a null pointer constant rather than a
2744 null pointer, it is guaranteed to be of the same size as a pointer.
2745 But this use is not portable across different compilers.
2747 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2748 @opindex Wno-non-template-friend
2749 @opindex Wnon-template-friend
2750 Disable warnings when non-templatized friend functions are declared
2751 within a template.  Since the advent of explicit template specification
2752 support in G++, if the name of the friend is an unqualified-id (i.e.,
2753 @samp{friend foo(int)}), the C++ language specification demands that the
2754 friend declare or define an ordinary, nontemplate function.  (Section
2755 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2756 could be interpreted as a particular specialization of a templatized
2757 function.  Because this non-conforming behavior is no longer the default
2758 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2759 check existing code for potential trouble spots and is on by default.
2760 This new compiler behavior can be turned off with
2761 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2762 but disables the helpful warning.
2764 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2765 @opindex Wold-style-cast
2766 @opindex Wno-old-style-cast
2767 Warn if an old-style (C-style) cast to a non-void type is used within
2768 a C++ program.  The new-style casts (@samp{dynamic_cast},
2769 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2770 less vulnerable to unintended effects and much easier to search for.
2772 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2773 @opindex Woverloaded-virtual
2774 @opindex Wno-overloaded-virtual
2775 @cindex overloaded virtual function, warning
2776 @cindex warning for overloaded virtual function
2777 Warn when a function declaration hides virtual functions from a
2778 base class.  For example, in:
2780 @smallexample
2781 struct A @{
2782   virtual void f();
2785 struct B: public A @{
2786   void f(int);
2788 @end smallexample
2790 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2791 like:
2793 @smallexample
2794 B* b;
2795 b->f();
2796 @end smallexample
2798 @noindent
2799 fails to compile.
2801 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2802 @opindex Wno-pmf-conversions
2803 @opindex Wpmf-conversions
2804 Disable the diagnostic for converting a bound pointer to member function
2805 to a plain pointer.
2807 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2808 @opindex Wsign-promo
2809 @opindex Wno-sign-promo
2810 Warn when overload resolution chooses a promotion from unsigned or
2811 enumerated type to a signed type, over a conversion to an unsigned type of
2812 the same size.  Previous versions of G++ tried to preserve
2813 unsignedness, but the standard mandates the current behavior.
2814 @end table
2816 @node Objective-C and Objective-C++ Dialect Options
2817 @section Options Controlling Objective-C and Objective-C++ Dialects
2819 @cindex compiler options, Objective-C and Objective-C++
2820 @cindex Objective-C and Objective-C++ options, command-line
2821 @cindex options, Objective-C and Objective-C++
2822 (NOTE: This manual does not describe the Objective-C and Objective-C++
2823 languages themselves.  @xref{Standards,,Language Standards
2824 Supported by GCC}, for references.)
2826 This section describes the command-line options that are only meaningful
2827 for Objective-C and Objective-C++ programs.  You can also use most of
2828 the language-independent GNU compiler options.
2829 For example, you might compile a file @code{some_class.m} like this:
2831 @smallexample
2832 gcc -g -fgnu-runtime -O -c some_class.m
2833 @end smallexample
2835 @noindent
2836 In this example, @option{-fgnu-runtime} is an option meant only for
2837 Objective-C and Objective-C++ programs; you can use the other options with
2838 any language supported by GCC@.
2840 Note that since Objective-C is an extension of the C language, Objective-C
2841 compilations may also use options specific to the C front-end (e.g.,
2842 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2843 C++-specific options (e.g., @option{-Wabi}).
2845 Here is a list of options that are @emph{only} for compiling Objective-C
2846 and Objective-C++ programs:
2848 @table @gcctabopt
2849 @item -fconstant-string-class=@var{class-name}
2850 @opindex fconstant-string-class
2851 Use @var{class-name} as the name of the class to instantiate for each
2852 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2853 class name is @code{NXConstantString} if the GNU runtime is being used, and
2854 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2855 @option{-fconstant-cfstrings} option, if also present, overrides the
2856 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2857 to be laid out as constant CoreFoundation strings.
2859 @item -fgnu-runtime
2860 @opindex fgnu-runtime
2861 Generate object code compatible with the standard GNU Objective-C
2862 runtime.  This is the default for most types of systems.
2864 @item -fnext-runtime
2865 @opindex fnext-runtime
2866 Generate output compatible with the NeXT runtime.  This is the default
2867 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2868 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2869 used.
2871 @item -fno-nil-receivers
2872 @opindex fno-nil-receivers
2873 Assume that all Objective-C message dispatches (@code{[receiver
2874 message:arg]}) in this translation unit ensure that the receiver is
2875 not @code{nil}.  This allows for more efficient entry points in the
2876 runtime to be used.  This option is only available in conjunction with
2877 the NeXT runtime and ABI version 0 or 1.
2879 @item -fobjc-abi-version=@var{n}
2880 @opindex fobjc-abi-version
2881 Use version @var{n} of the Objective-C ABI for the selected runtime.
2882 This option is currently supported only for the NeXT runtime.  In that
2883 case, Version 0 is the traditional (32-bit) ABI without support for
2884 properties and other Objective-C 2.0 additions.  Version 1 is the
2885 traditional (32-bit) ABI with support for properties and other
2886 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2887 nothing is specified, the default is Version 0 on 32-bit target
2888 machines, and Version 2 on 64-bit target machines.
2890 @item -fobjc-call-cxx-cdtors
2891 @opindex fobjc-call-cxx-cdtors
2892 For each Objective-C class, check if any of its instance variables is a
2893 C++ object with a non-trivial default constructor.  If so, synthesize a
2894 special @code{- (id) .cxx_construct} instance method which runs
2895 non-trivial default constructors on any such instance variables, in order,
2896 and then return @code{self}.  Similarly, check if any instance variable
2897 is a C++ object with a non-trivial destructor, and if so, synthesize a
2898 special @code{- (void) .cxx_destruct} method which runs
2899 all such default destructors, in reverse order.
2901 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2902 methods thusly generated only operate on instance variables
2903 declared in the current Objective-C class, and not those inherited
2904 from superclasses.  It is the responsibility of the Objective-C
2905 runtime to invoke all such methods in an object's inheritance
2906 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2907 by the runtime immediately after a new object instance is allocated;
2908 the @code{- (void) .cxx_destruct} methods are invoked immediately
2909 before the runtime deallocates an object instance.
2911 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2912 support for invoking the @code{- (id) .cxx_construct} and
2913 @code{- (void) .cxx_destruct} methods.
2915 @item -fobjc-direct-dispatch
2916 @opindex fobjc-direct-dispatch
2917 Allow fast jumps to the message dispatcher.  On Darwin this is
2918 accomplished via the comm page.
2920 @item -fobjc-exceptions
2921 @opindex fobjc-exceptions
2922 Enable syntactic support for structured exception handling in
2923 Objective-C, similar to what is offered by C++ and Java.  This option
2924 is required to use the Objective-C keywords @code{@@try},
2925 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2926 @code{@@synchronized}.  This option is available with both the GNU
2927 runtime and the NeXT runtime (but not available in conjunction with
2928 the NeXT runtime on Mac OS X 10.2 and earlier).
2930 @item -fobjc-gc
2931 @opindex fobjc-gc
2932 Enable garbage collection (GC) in Objective-C and Objective-C++
2933 programs.  This option is only available with the NeXT runtime; the
2934 GNU runtime has a different garbage collection implementation that
2935 does not require special compiler flags.
2937 @item -fobjc-nilcheck
2938 @opindex fobjc-nilcheck
2939 For the NeXT runtime with version 2 of the ABI, check for a nil
2940 receiver in method invocations before doing the actual method call.
2941 This is the default and can be disabled using
2942 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2943 checked for nil in this way no matter what this flag is set to.
2944 Currently this flag does nothing when the GNU runtime, or an older
2945 version of the NeXT runtime ABI, is used.
2947 @item -fobjc-std=objc1
2948 @opindex fobjc-std
2949 Conform to the language syntax of Objective-C 1.0, the language
2950 recognized by GCC 4.0.  This only affects the Objective-C additions to
2951 the C/C++ language; it does not affect conformance to C/C++ standards,
2952 which is controlled by the separate C/C++ dialect option flags.  When
2953 this option is used with the Objective-C or Objective-C++ compiler,
2954 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2955 This is useful if you need to make sure that your Objective-C code can
2956 be compiled with older versions of GCC@.
2958 @item -freplace-objc-classes
2959 @opindex freplace-objc-classes
2960 Emit a special marker instructing @command{ld(1)} not to statically link in
2961 the resulting object file, and allow @command{dyld(1)} to load it in at
2962 run time instead.  This is used in conjunction with the Fix-and-Continue
2963 debugging mode, where the object file in question may be recompiled and
2964 dynamically reloaded in the course of program execution, without the need
2965 to restart the program itself.  Currently, Fix-and-Continue functionality
2966 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2967 and later.
2969 @item -fzero-link
2970 @opindex fzero-link
2971 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2972 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2973 compile time) with static class references that get initialized at load time,
2974 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2975 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2976 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2977 for individual class implementations to be modified during program execution.
2978 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2979 regardless of command-line options.
2981 @item -fno-local-ivars
2982 @opindex fno-local-ivars
2983 @opindex flocal-ivars
2984 By default instance variables in Objective-C can be accessed as if
2985 they were local variables from within the methods of the class they're
2986 declared in.  This can lead to shadowing between instance variables
2987 and other variables declared either locally inside a class method or
2988 globally with the same name.  Specifying the @option{-fno-local-ivars}
2989 flag disables this behavior thus avoiding variable shadowing issues.
2991 @item -fivar-visibility=@var{public|protected|private|package}
2992 @opindex fivar-visibility
2993 Set the default instance variable visibility to the specified option
2994 so that instance variables declared outside the scope of any access
2995 modifier directives default to the specified visibility.
2997 @item -gen-decls
2998 @opindex gen-decls
2999 Dump interface declarations for all classes seen in the source file to a
3000 file named @file{@var{sourcename}.decl}.
3002 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3003 @opindex Wassign-intercept
3004 @opindex Wno-assign-intercept
3005 Warn whenever an Objective-C assignment is being intercepted by the
3006 garbage collector.
3008 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3009 @opindex Wno-protocol
3010 @opindex Wprotocol
3011 If a class is declared to implement a protocol, a warning is issued for
3012 every method in the protocol that is not implemented by the class.  The
3013 default behavior is to issue a warning for every method not explicitly
3014 implemented in the class, even if a method implementation is inherited
3015 from the superclass.  If you use the @option{-Wno-protocol} option, then
3016 methods inherited from the superclass are considered to be implemented,
3017 and no warning is issued for them.
3019 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3020 @opindex Wselector
3021 @opindex Wno-selector
3022 Warn if multiple methods of different types for the same selector are
3023 found during compilation.  The check is performed on the list of methods
3024 in the final stage of compilation.  Additionally, a check is performed
3025 for each selector appearing in a @code{@@selector(@dots{})}
3026 expression, and a corresponding method for that selector has been found
3027 during compilation.  Because these checks scan the method table only at
3028 the end of compilation, these warnings are not produced if the final
3029 stage of compilation is not reached, for example because an error is
3030 found during compilation, or because the @option{-fsyntax-only} option is
3031 being used.
3033 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3034 @opindex Wstrict-selector-match
3035 @opindex Wno-strict-selector-match
3036 Warn if multiple methods with differing argument and/or return types are
3037 found for a given selector when attempting to send a message using this
3038 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3039 is off (which is the default behavior), the compiler omits such warnings
3040 if any differences found are confined to types that share the same size
3041 and alignment.
3043 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3044 @opindex Wundeclared-selector
3045 @opindex Wno-undeclared-selector
3046 Warn if a @code{@@selector(@dots{})} expression referring to an
3047 undeclared selector is found.  A selector is considered undeclared if no
3048 method with that name has been declared before the
3049 @code{@@selector(@dots{})} expression, either explicitly in an
3050 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3051 an @code{@@implementation} section.  This option always performs its
3052 checks as soon as a @code{@@selector(@dots{})} expression is found,
3053 while @option{-Wselector} only performs its checks in the final stage of
3054 compilation.  This also enforces the coding style convention
3055 that methods and selectors must be declared before being used.
3057 @item -print-objc-runtime-info
3058 @opindex print-objc-runtime-info
3059 Generate C header describing the largest structure that is passed by
3060 value, if any.
3062 @end table
3064 @node Language Independent Options
3065 @section Options to Control Diagnostic Messages Formatting
3066 @cindex options to control diagnostics formatting
3067 @cindex diagnostic messages
3068 @cindex message formatting
3070 Traditionally, diagnostic messages have been formatted irrespective of
3071 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3072 options described below
3073 to control the formatting algorithm for diagnostic messages, 
3074 e.g.@: how many characters per line, how often source location
3075 information should be reported.  Note that some language front ends may not
3076 honor these options.
3078 @table @gcctabopt
3079 @item -fmessage-length=@var{n}
3080 @opindex fmessage-length
3081 Try to format error messages so that they fit on lines of about @var{n}
3082 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
3083 the front ends supported by GCC@.  If @var{n} is zero, then no
3084 line-wrapping is done; each error message appears on a single
3085 line.
3087 @item -fdiagnostics-show-location=once
3088 @opindex fdiagnostics-show-location
3089 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3090 reporter to emit source location information @emph{once}; that is, in
3091 case the message is too long to fit on a single physical line and has to
3092 be wrapped, the source location won't be emitted (as prefix) again,
3093 over and over, in subsequent continuation lines.  This is the default
3094 behavior.
3096 @item -fdiagnostics-show-location=every-line
3097 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3098 messages reporter to emit the same source location information (as
3099 prefix) for physical lines that result from the process of breaking
3100 a message which is too long to fit on a single line.
3102 @item -fdiagnostics-color[=@var{WHEN}]
3103 @itemx -fno-diagnostics-color
3104 @opindex fdiagnostics-color
3105 @cindex highlight, color, colour
3106 @vindex GCC_COLORS @r{environment variable}
3107 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3108 or @samp{auto}.  The default is @samp{never} if @env{GCC_COLORS} environment
3109 variable isn't present in the environment, and @samp{auto} otherwise.
3110 @samp{auto} means to use color only when the standard error is a terminal.
3111 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3112 aliases for @option{-fdiagnostics-color=always} and
3113 @option{-fdiagnostics-color=never}, respectively.
3115 The colors are defined by the environment variable @env{GCC_COLORS}.
3116 Its value is a colon-separated list of capabilities and Select Graphic
3117 Rendition (SGR) substrings. SGR commands are interpreted by the
3118 terminal or terminal emulator.  (See the section in the documentation
3119 of your text terminal for permitted values and their meanings as
3120 character attributes.)  These substring values are integers in decimal
3121 representation and can be concatenated with semicolons.
3122 Common values to concatenate include
3123 @samp{1} for bold,
3124 @samp{4} for underline,
3125 @samp{5} for blink,
3126 @samp{7} for inverse,
3127 @samp{39} for default foreground color,
3128 @samp{30} to @samp{37} for foreground colors,
3129 @samp{90} to @samp{97} for 16-color mode foreground colors,
3130 @samp{38;5;0} to @samp{38;5;255}
3131 for 88-color and 256-color modes foreground colors,
3132 @samp{49} for default background color,
3133 @samp{40} to @samp{47} for background colors,
3134 @samp{100} to @samp{107} for 16-color mode background colors,
3135 and @samp{48;5;0} to @samp{48;5;255}
3136 for 88-color and 256-color modes background colors.
3138 The default @env{GCC_COLORS} is
3139 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3140 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3141 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3142 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3143 string disables colors.
3144 Supported capabilities are as follows.
3146 @table @code
3147 @item error=
3148 @vindex error GCC_COLORS @r{capability}
3149 SGR substring for error: markers.
3151 @item warning=
3152 @vindex warning GCC_COLORS @r{capability}
3153 SGR substring for warning: markers.
3155 @item note=
3156 @vindex note GCC_COLORS @r{capability}
3157 SGR substring for note: markers.
3159 @item caret=
3160 @vindex caret GCC_COLORS @r{capability}
3161 SGR substring for caret line.
3163 @item locus=
3164 @vindex locus GCC_COLORS @r{capability}
3165 SGR substring for location information, @samp{file:line} or
3166 @samp{file:line:column} etc.
3168 @item quote=
3169 @vindex quote GCC_COLORS @r{capability}
3170 SGR substring for information printed within quotes.
3171 @end table
3173 @item -fno-diagnostics-show-option
3174 @opindex fno-diagnostics-show-option
3175 @opindex fdiagnostics-show-option
3176 By default, each diagnostic emitted includes text indicating the
3177 command-line option that directly controls the diagnostic (if such an
3178 option is known to the diagnostic machinery).  Specifying the
3179 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3181 @item -fno-diagnostics-show-caret
3182 @opindex fno-diagnostics-show-caret
3183 @opindex fdiagnostics-show-caret
3184 By default, each diagnostic emitted includes the original source line
3185 and a caret '^' indicating the column.  This option suppresses this
3186 information.
3188 @end table
3190 @node Warning Options
3191 @section Options to Request or Suppress Warnings
3192 @cindex options to control warnings
3193 @cindex warning messages
3194 @cindex messages, warning
3195 @cindex suppressing warnings
3197 Warnings are diagnostic messages that report constructions that
3198 are not inherently erroneous but that are risky or suggest there
3199 may have been an error.
3201 The following language-independent options do not enable specific
3202 warnings but control the kinds of diagnostics produced by GCC@.
3204 @table @gcctabopt
3205 @cindex syntax checking
3206 @item -fsyntax-only
3207 @opindex fsyntax-only
3208 Check the code for syntax errors, but don't do anything beyond that.
3210 @item -fmax-errors=@var{n}
3211 @opindex fmax-errors
3212 Limits the maximum number of error messages to @var{n}, at which point
3213 GCC bails out rather than attempting to continue processing the source
3214 code.  If @var{n} is 0 (the default), there is no limit on the number
3215 of error messages produced.  If @option{-Wfatal-errors} is also
3216 specified, then @option{-Wfatal-errors} takes precedence over this
3217 option.
3219 @item -w
3220 @opindex w
3221 Inhibit all warning messages.
3223 @item -Werror
3224 @opindex Werror
3225 @opindex Wno-error
3226 Make all warnings into errors.
3228 @item -Werror=
3229 @opindex Werror=
3230 @opindex Wno-error=
3231 Make the specified warning into an error.  The specifier for a warning
3232 is appended; for example @option{-Werror=switch} turns the warnings
3233 controlled by @option{-Wswitch} into errors.  This switch takes a
3234 negative form, to be used to negate @option{-Werror} for specific
3235 warnings; for example @option{-Wno-error=switch} makes
3236 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3237 is in effect.
3239 The warning message for each controllable warning includes the
3240 option that controls the warning.  That option can then be used with
3241 @option{-Werror=} and @option{-Wno-error=} as described above.
3242 (Printing of the option in the warning message can be disabled using the
3243 @option{-fno-diagnostics-show-option} flag.)
3245 Note that specifying @option{-Werror=}@var{foo} automatically implies
3246 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3247 imply anything.
3249 @item -Wfatal-errors
3250 @opindex Wfatal-errors
3251 @opindex Wno-fatal-errors
3252 This option causes the compiler to abort compilation on the first error
3253 occurred rather than trying to keep going and printing further error
3254 messages.
3256 @end table
3258 You can request many specific warnings with options beginning with
3259 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3260 implicit declarations.  Each of these specific warning options also
3261 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3262 example, @option{-Wno-implicit}.  This manual lists only one of the
3263 two forms, whichever is not the default.  For further
3264 language-specific options also refer to @ref{C++ Dialect Options} and
3265 @ref{Objective-C and Objective-C++ Dialect Options}.
3267 When an unrecognized warning option is requested (e.g.,
3268 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3269 that the option is not recognized.  However, if the @option{-Wno-} form
3270 is used, the behavior is slightly different: no diagnostic is
3271 produced for @option{-Wno-unknown-warning} unless other diagnostics
3272 are being produced.  This allows the use of new @option{-Wno-} options
3273 with old compilers, but if something goes wrong, the compiler
3274 warns that an unrecognized option is present.
3276 @table @gcctabopt
3277 @item -Wpedantic
3278 @itemx -pedantic
3279 @opindex pedantic
3280 @opindex Wpedantic
3281 Issue all the warnings demanded by strict ISO C and ISO C++;
3282 reject all programs that use forbidden extensions, and some other
3283 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3284 version of the ISO C standard specified by any @option{-std} option used.
3286 Valid ISO C and ISO C++ programs should compile properly with or without
3287 this option (though a rare few require @option{-ansi} or a
3288 @option{-std} option specifying the required version of ISO C)@.  However,
3289 without this option, certain GNU extensions and traditional C and C++
3290 features are supported as well.  With this option, they are rejected.
3292 @option{-Wpedantic} does not cause warning messages for use of the
3293 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3294 warnings are also disabled in the expression that follows
3295 @code{__extension__}.  However, only system header files should use
3296 these escape routes; application programs should avoid them.
3297 @xref{Alternate Keywords}.
3299 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3300 C conformance.  They soon find that it does not do quite what they want:
3301 it finds some non-ISO practices, but not all---only those for which
3302 ISO C @emph{requires} a diagnostic, and some others for which
3303 diagnostics have been added.
3305 A feature to report any failure to conform to ISO C might be useful in
3306 some instances, but would require considerable additional work and would
3307 be quite different from @option{-Wpedantic}.  We don't have plans to
3308 support such a feature in the near future.
3310 Where the standard specified with @option{-std} represents a GNU
3311 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3312 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3313 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3314 where they are required by the base standard.  (It does not make sense
3315 for such warnings to be given only for features not in the specified GNU
3316 C dialect, since by definition the GNU dialects of C include all
3317 features the compiler supports with the given option, and there would be
3318 nothing to warn about.)
3320 @item -pedantic-errors
3321 @opindex pedantic-errors
3322 Like @option{-Wpedantic}, except that errors are produced rather than
3323 warnings.
3325 @item -Wall
3326 @opindex Wall
3327 @opindex Wno-all
3328 This enables all the warnings about constructions that some users
3329 consider questionable, and that are easy to avoid (or modify to
3330 prevent the warning), even in conjunction with macros.  This also
3331 enables some language-specific warnings described in @ref{C++ Dialect
3332 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3334 @option{-Wall} turns on the following warning flags:
3336 @gccoptlist{-Waddress   @gol
3337 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3338 -Wc++11-compat  @gol
3339 -Wchar-subscripts  @gol
3340 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3341 -Wimplicit-int @r{(C and Objective-C only)} @gol
3342 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3343 -Wcomment  @gol
3344 -Wformat   @gol
3345 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3346 -Wmaybe-uninitialized @gol
3347 -Wmissing-braces @r{(only for C/ObjC)} @gol
3348 -Wnonnull  @gol
3349 -Wopenmp-simd @gol
3350 -Wparentheses  @gol
3351 -Wpointer-sign  @gol
3352 -Wreorder   @gol
3353 -Wreturn-type  @gol
3354 -Wsequence-point  @gol
3355 -Wsign-compare @r{(only in C++)}  @gol
3356 -Wstrict-aliasing  @gol
3357 -Wstrict-overflow=1  @gol
3358 -Wswitch  @gol
3359 -Wtrigraphs  @gol
3360 -Wuninitialized  @gol
3361 -Wunknown-pragmas  @gol
3362 -Wunused-function  @gol
3363 -Wunused-label     @gol
3364 -Wunused-value     @gol
3365 -Wunused-variable  @gol
3366 -Wvolatile-register-var @gol
3369 Note that some warning flags are not implied by @option{-Wall}.  Some of
3370 them warn about constructions that users generally do not consider
3371 questionable, but which occasionally you might wish to check for;
3372 others warn about constructions that are necessary or hard to avoid in
3373 some cases, and there is no simple way to modify the code to suppress
3374 the warning. Some of them are enabled by @option{-Wextra} but many of
3375 them must be enabled individually.
3377 @item -Wextra
3378 @opindex W
3379 @opindex Wextra
3380 @opindex Wno-extra
3381 This enables some extra warning flags that are not enabled by
3382 @option{-Wall}. (This option used to be called @option{-W}.  The older
3383 name is still supported, but the newer name is more descriptive.)
3385 @gccoptlist{-Wclobbered  @gol
3386 -Wempty-body  @gol
3387 -Wignored-qualifiers @gol
3388 -Wmissing-field-initializers  @gol
3389 -Wmissing-parameter-type @r{(C only)}  @gol
3390 -Wold-style-declaration @r{(C only)}  @gol
3391 -Woverride-init  @gol
3392 -Wsign-compare  @gol
3393 -Wtype-limits  @gol
3394 -Wuninitialized  @gol
3395 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3396 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3399 The option @option{-Wextra} also prints warning messages for the
3400 following cases:
3402 @itemize @bullet
3404 @item
3405 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3406 @samp{>}, or @samp{>=}.
3408 @item
3409 (C++ only) An enumerator and a non-enumerator both appear in a
3410 conditional expression.
3412 @item
3413 (C++ only) Ambiguous virtual bases.
3415 @item
3416 (C++ only) Subscripting an array that has been declared @samp{register}.
3418 @item
3419 (C++ only) Taking the address of a variable that has been declared
3420 @samp{register}.
3422 @item
3423 (C++ only) A base class is not initialized in a derived class's copy
3424 constructor.
3426 @end itemize
3428 @item -Wchar-subscripts
3429 @opindex Wchar-subscripts
3430 @opindex Wno-char-subscripts
3431 Warn if an array subscript has type @code{char}.  This is a common cause
3432 of error, as programmers often forget that this type is signed on some
3433 machines.
3434 This warning is enabled by @option{-Wall}.
3436 @item -Wcomment
3437 @opindex Wcomment
3438 @opindex Wno-comment
3439 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3440 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3441 This warning is enabled by @option{-Wall}.
3443 @item -Wno-coverage-mismatch
3444 @opindex Wno-coverage-mismatch
3445 Warn if feedback profiles do not match when using the
3446 @option{-fprofile-use} option.
3447 If a source file is changed between compiling with @option{-fprofile-gen} and
3448 with @option{-fprofile-use}, the files with the profile feedback can fail
3449 to match the source file and GCC cannot use the profile feedback
3450 information.  By default, this warning is enabled and is treated as an
3451 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3452 warning or @option{-Wno-error=coverage-mismatch} can be used to
3453 disable the error.  Disabling the error for this warning can result in
3454 poorly optimized code and is useful only in the
3455 case of very minor changes such as bug fixes to an existing code-base.
3456 Completely disabling the warning is not recommended.
3458 @item -Wno-cpp
3459 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3461 Suppress warning messages emitted by @code{#warning} directives.
3463 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3464 @opindex Wdouble-promotion
3465 @opindex Wno-double-promotion
3466 Give a warning when a value of type @code{float} is implicitly
3467 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3468 floating-point unit implement @code{float} in hardware, but emulate
3469 @code{double} in software.  On such a machine, doing computations
3470 using @code{double} values is much more expensive because of the
3471 overhead required for software emulation.
3473 It is easy to accidentally do computations with @code{double} because
3474 floating-point literals are implicitly of type @code{double}.  For
3475 example, in:
3476 @smallexample
3477 @group
3478 float area(float radius)
3480    return 3.14159 * radius * radius;
3482 @end group
3483 @end smallexample
3484 the compiler performs the entire computation with @code{double}
3485 because the floating-point literal is a @code{double}.
3487 @item -Wformat
3488 @itemx -Wformat=@var{n}
3489 @opindex Wformat
3490 @opindex Wno-format
3491 @opindex ffreestanding
3492 @opindex fno-builtin
3493 @opindex Wformat=
3494 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3495 the arguments supplied have types appropriate to the format string
3496 specified, and that the conversions specified in the format string make
3497 sense.  This includes standard functions, and others specified by format
3498 attributes (@pxref{Function Attributes}), in the @code{printf},
3499 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3500 not in the C standard) families (or other target-specific families).
3501 Which functions are checked without format attributes having been
3502 specified depends on the standard version selected, and such checks of
3503 functions without the attribute specified are disabled by
3504 @option{-ffreestanding} or @option{-fno-builtin}.
3506 The formats are checked against the format features supported by GNU
3507 libc version 2.2.  These include all ISO C90 and C99 features, as well
3508 as features from the Single Unix Specification and some BSD and GNU
3509 extensions.  Other library implementations may not support all these
3510 features; GCC does not support warning about features that go beyond a
3511 particular library's limitations.  However, if @option{-Wpedantic} is used
3512 with @option{-Wformat}, warnings are given about format features not
3513 in the selected standard version (but not for @code{strfmon} formats,
3514 since those are not in any version of the C standard).  @xref{C Dialect
3515 Options,,Options Controlling C Dialect}.
3517 @table @gcctabopt
3518 @item -Wformat=1
3519 @itemx -Wformat
3520 @opindex Wformat
3521 @opindex Wformat=1
3522 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3523 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3524 @option{-Wformat} also checks for null format arguments for several
3525 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3526 aspects of this level of format checking can be disabled by the
3527 options: @option{-Wno-format-contains-nul},
3528 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3529 @option{-Wformat} is enabled by @option{-Wall}.
3531 @item -Wno-format-contains-nul
3532 @opindex Wno-format-contains-nul
3533 @opindex Wformat-contains-nul
3534 If @option{-Wformat} is specified, do not warn about format strings that
3535 contain NUL bytes.
3537 @item -Wno-format-extra-args
3538 @opindex Wno-format-extra-args
3539 @opindex Wformat-extra-args
3540 If @option{-Wformat} is specified, do not warn about excess arguments to a
3541 @code{printf} or @code{scanf} format function.  The C standard specifies
3542 that such arguments are ignored.
3544 Where the unused arguments lie between used arguments that are
3545 specified with @samp{$} operand number specifications, normally
3546 warnings are still given, since the implementation could not know what
3547 type to pass to @code{va_arg} to skip the unused arguments.  However,
3548 in the case of @code{scanf} formats, this option suppresses the
3549 warning if the unused arguments are all pointers, since the Single
3550 Unix Specification says that such unused arguments are allowed.
3552 @item -Wno-format-zero-length
3553 @opindex Wno-format-zero-length
3554 @opindex Wformat-zero-length
3555 If @option{-Wformat} is specified, do not warn about zero-length formats.
3556 The C standard specifies that zero-length formats are allowed.
3559 @item -Wformat=2
3560 @opindex Wformat=2
3561 Enable @option{-Wformat} plus additional format checks.  Currently
3562 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3563 -Wformat-signedness -Wformat-y2k}.
3565 @item -Wformat-nonliteral
3566 @opindex Wformat-nonliteral
3567 @opindex Wno-format-nonliteral
3568 If @option{-Wformat} is specified, also warn if the format string is not a
3569 string literal and so cannot be checked, unless the format function
3570 takes its format arguments as a @code{va_list}.
3572 @item -Wformat-security
3573 @opindex Wformat-security
3574 @opindex Wno-format-security
3575 If @option{-Wformat} is specified, also warn about uses of format
3576 functions that represent possible security problems.  At present, this
3577 warns about calls to @code{printf} and @code{scanf} functions where the
3578 format string is not a string literal and there are no format arguments,
3579 as in @code{printf (foo);}.  This may be a security hole if the format
3580 string came from untrusted input and contains @samp{%n}.  (This is
3581 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3582 in future warnings may be added to @option{-Wformat-security} that are not
3583 included in @option{-Wformat-nonliteral}.)
3585 @item -Wformat-signedness
3586 @opindex Wformat-signedness
3587 @opindex Wno-format-signedness
3588 If @option{-Wformat} is specified, also warn if the format string
3589 requires an unsigned argument and the argument is signed and vice versa.
3591 @item -Wformat-y2k
3592 @opindex Wformat-y2k
3593 @opindex Wno-format-y2k
3594 If @option{-Wformat} is specified, also warn about @code{strftime}
3595 formats that may yield only a two-digit year.
3596 @end table
3598 @item -Wnonnull
3599 @opindex Wnonnull
3600 @opindex Wno-nonnull
3601 Warn about passing a null pointer for arguments marked as
3602 requiring a non-null value by the @code{nonnull} function attribute.
3604 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3605 can be disabled with the @option{-Wno-nonnull} option.
3607 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3608 @opindex Winit-self
3609 @opindex Wno-init-self
3610 Warn about uninitialized variables that are initialized with themselves.
3611 Note this option can only be used with the @option{-Wuninitialized} option.
3613 For example, GCC warns about @code{i} being uninitialized in the
3614 following snippet only when @option{-Winit-self} has been specified:
3615 @smallexample
3616 @group
3617 int f()
3619   int i = i;
3620   return i;
3622 @end group
3623 @end smallexample
3625 This warning is enabled by @option{-Wall} in C++.
3627 @item -Wimplicit-int @r{(C and Objective-C only)}
3628 @opindex Wimplicit-int
3629 @opindex Wno-implicit-int
3630 Warn when a declaration does not specify a type.
3631 This warning is enabled by @option{-Wall}.
3633 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3634 @opindex Wimplicit-function-declaration
3635 @opindex Wno-implicit-function-declaration
3636 Give a warning whenever a function is used before being declared. In
3637 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3638 enabled by default and it is made into an error by
3639 @option{-pedantic-errors}. This warning is also enabled by
3640 @option{-Wall}.
3642 @item -Wimplicit @r{(C and Objective-C only)}
3643 @opindex Wimplicit
3644 @opindex Wno-implicit
3645 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3646 This warning is enabled by @option{-Wall}.
3648 @item -Wignored-qualifiers @r{(C and C++ only)}
3649 @opindex Wignored-qualifiers
3650 @opindex Wno-ignored-qualifiers
3651 Warn if the return type of a function has a type qualifier
3652 such as @code{const}.  For ISO C such a type qualifier has no effect,
3653 since the value returned by a function is not an lvalue.
3654 For C++, the warning is only emitted for scalar types or @code{void}.
3655 ISO C prohibits qualified @code{void} return types on function
3656 definitions, so such return types always receive a warning
3657 even without this option.
3659 This warning is also enabled by @option{-Wextra}.
3661 @item -Wmain
3662 @opindex Wmain
3663 @opindex Wno-main
3664 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3665 a function with external linkage, returning int, taking either zero
3666 arguments, two, or three arguments of appropriate types.  This warning
3667 is enabled by default in C++ and is enabled by either @option{-Wall}
3668 or @option{-Wpedantic}.
3670 @item -Wmissing-braces
3671 @opindex Wmissing-braces
3672 @opindex Wno-missing-braces
3673 Warn if an aggregate or union initializer is not fully bracketed.  In
3674 the following example, the initializer for @samp{a} is not fully
3675 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3676 enabled by @option{-Wall} in C.
3678 @smallexample
3679 int a[2][2] = @{ 0, 1, 2, 3 @};
3680 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3681 @end smallexample
3683 This warning is enabled by @option{-Wall}.
3685 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3686 @opindex Wmissing-include-dirs
3687 @opindex Wno-missing-include-dirs
3688 Warn if a user-supplied include directory does not exist.
3690 @item -Wparentheses
3691 @opindex Wparentheses
3692 @opindex Wno-parentheses
3693 Warn if parentheses are omitted in certain contexts, such
3694 as when there is an assignment in a context where a truth value
3695 is expected, or when operators are nested whose precedence people
3696 often get confused about.
3698 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3699 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3700 interpretation from that of ordinary mathematical notation.
3702 Also warn about constructions where there may be confusion to which
3703 @code{if} statement an @code{else} branch belongs.  Here is an example of
3704 such a case:
3706 @smallexample
3707 @group
3709   if (a)
3710     if (b)
3711       foo ();
3712   else
3713     bar ();
3715 @end group
3716 @end smallexample
3718 In C/C++, every @code{else} branch belongs to the innermost possible
3719 @code{if} statement, which in this example is @code{if (b)}.  This is
3720 often not what the programmer expected, as illustrated in the above
3721 example by indentation the programmer chose.  When there is the
3722 potential for this confusion, GCC issues a warning when this flag
3723 is specified.  To eliminate the warning, add explicit braces around
3724 the innermost @code{if} statement so there is no way the @code{else}
3725 can belong to the enclosing @code{if}.  The resulting code
3726 looks like this:
3728 @smallexample
3729 @group
3731   if (a)
3732     @{
3733       if (b)
3734         foo ();
3735       else
3736         bar ();
3737     @}
3739 @end group
3740 @end smallexample
3742 Also warn for dangerous uses of the GNU extension to
3743 @code{?:} with omitted middle operand. When the condition
3744 in the @code{?}: operator is a boolean expression, the omitted value is
3745 always 1.  Often programmers expect it to be a value computed
3746 inside the conditional expression instead.
3748 This warning is enabled by @option{-Wall}.
3750 @item -Wsequence-point
3751 @opindex Wsequence-point
3752 @opindex Wno-sequence-point
3753 Warn about code that may have undefined semantics because of violations
3754 of sequence point rules in the C and C++ standards.
3756 The C and C++ standards define the order in which expressions in a C/C++
3757 program are evaluated in terms of @dfn{sequence points}, which represent
3758 a partial ordering between the execution of parts of the program: those
3759 executed before the sequence point, and those executed after it.  These
3760 occur after the evaluation of a full expression (one which is not part
3761 of a larger expression), after the evaluation of the first operand of a
3762 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3763 function is called (but after the evaluation of its arguments and the
3764 expression denoting the called function), and in certain other places.
3765 Other than as expressed by the sequence point rules, the order of
3766 evaluation of subexpressions of an expression is not specified.  All
3767 these rules describe only a partial order rather than a total order,
3768 since, for example, if two functions are called within one expression
3769 with no sequence point between them, the order in which the functions
3770 are called is not specified.  However, the standards committee have
3771 ruled that function calls do not overlap.
3773 It is not specified when between sequence points modifications to the
3774 values of objects take effect.  Programs whose behavior depends on this
3775 have undefined behavior; the C and C++ standards specify that ``Between
3776 the previous and next sequence point an object shall have its stored
3777 value modified at most once by the evaluation of an expression.
3778 Furthermore, the prior value shall be read only to determine the value
3779 to be stored.''.  If a program breaks these rules, the results on any
3780 particular implementation are entirely unpredictable.
3782 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3783 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3784 diagnosed by this option, and it may give an occasional false positive
3785 result, but in general it has been found fairly effective at detecting
3786 this sort of problem in programs.
3788 The standard is worded confusingly, therefore there is some debate
3789 over the precise meaning of the sequence point rules in subtle cases.
3790 Links to discussions of the problem, including proposed formal
3791 definitions, may be found on the GCC readings page, at
3792 @uref{http://gcc.gnu.org/@/readings.html}.
3794 This warning is enabled by @option{-Wall} for C and C++.
3796 @item -Wno-return-local-addr
3797 @opindex Wno-return-local-addr
3798 @opindex Wreturn-local-addr
3799 Do not warn about returning a pointer (or in C++, a reference) to a
3800 variable that goes out of scope after the function returns.
3802 @item -Wreturn-type
3803 @opindex Wreturn-type
3804 @opindex Wno-return-type
3805 Warn whenever a function is defined with a return type that defaults
3806 to @code{int}.  Also warn about any @code{return} statement with no
3807 return value in a function whose return type is not @code{void}
3808 (falling off the end of the function body is considered returning
3809 without a value), and about a @code{return} statement with an
3810 expression in a function whose return type is @code{void}.
3812 For C++, a function without return type always produces a diagnostic
3813 message, even when @option{-Wno-return-type} is specified.  The only
3814 exceptions are @samp{main} and functions defined in system headers.
3816 This warning is enabled by @option{-Wall}.
3818 @item -Wswitch
3819 @opindex Wswitch
3820 @opindex Wno-switch
3821 Warn whenever a @code{switch} statement has an index of enumerated type
3822 and lacks a @code{case} for one or more of the named codes of that
3823 enumeration.  (The presence of a @code{default} label prevents this
3824 warning.)  @code{case} labels outside the enumeration range also
3825 provoke warnings when this option is used (even if there is a
3826 @code{default} label).
3827 This warning is enabled by @option{-Wall}.
3829 @item -Wswitch-default
3830 @opindex Wswitch-default
3831 @opindex Wno-switch-default
3832 Warn whenever a @code{switch} statement does not have a @code{default}
3833 case.
3835 @item -Wswitch-enum
3836 @opindex Wswitch-enum
3837 @opindex Wno-switch-enum
3838 Warn whenever a @code{switch} statement has an index of enumerated type
3839 and lacks a @code{case} for one or more of the named codes of that
3840 enumeration.  @code{case} labels outside the enumeration range also
3841 provoke warnings when this option is used.  The only difference
3842 between @option{-Wswitch} and this option is that this option gives a
3843 warning about an omitted enumeration code even if there is a
3844 @code{default} label.
3846 @item -Wswitch-bool
3847 @opindex Wswitch-bool
3848 @opindex Wno-switch-bool
3849 Warn whenever a @code{switch} statement has an index of boolean type.
3850 It is possible to suppress this warning by casting the controlling
3851 expression to a type other than @code{bool}.  For example:
3852 @smallexample
3853 @group
3854 switch ((int) (a == 4))
3855   @{
3856   @dots{}
3857   @}
3858 @end group
3859 @end smallexample
3860 This warning is enabled by default for C and C++ programs.
3862 @item -Wsync-nand @r{(C and C++ only)}
3863 @opindex Wsync-nand
3864 @opindex Wno-sync-nand
3865 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3866 built-in functions are used.  These functions changed semantics in GCC 4.4.
3868 @item -Wtrigraphs
3869 @opindex Wtrigraphs
3870 @opindex Wno-trigraphs
3871 Warn if any trigraphs are encountered that might change the meaning of
3872 the program (trigraphs within comments are not warned about).
3873 This warning is enabled by @option{-Wall}.
3875 @item -Wunused-but-set-parameter
3876 @opindex Wunused-but-set-parameter
3877 @opindex Wno-unused-but-set-parameter
3878 Warn whenever a function parameter is assigned to, but otherwise unused
3879 (aside from its declaration).
3881 To suppress this warning use the @samp{unused} attribute
3882 (@pxref{Variable Attributes}).
3884 This warning is also enabled by @option{-Wunused} together with
3885 @option{-Wextra}.
3887 @item -Wunused-but-set-variable
3888 @opindex Wunused-but-set-variable
3889 @opindex Wno-unused-but-set-variable
3890 Warn whenever a local variable is assigned to, but otherwise unused
3891 (aside from its declaration).
3892 This warning is enabled by @option{-Wall}.
3894 To suppress this warning use the @samp{unused} attribute
3895 (@pxref{Variable Attributes}).
3897 This warning is also enabled by @option{-Wunused}, which is enabled
3898 by @option{-Wall}.
3900 @item -Wunused-function
3901 @opindex Wunused-function
3902 @opindex Wno-unused-function
3903 Warn whenever a static function is declared but not defined or a
3904 non-inline static function is unused.
3905 This warning is enabled by @option{-Wall}.
3907 @item -Wunused-label
3908 @opindex Wunused-label
3909 @opindex Wno-unused-label
3910 Warn whenever a label is declared but not used.
3911 This warning is enabled by @option{-Wall}.
3913 To suppress this warning use the @samp{unused} attribute
3914 (@pxref{Variable Attributes}).
3916 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3917 @opindex Wunused-local-typedefs
3918 Warn when a typedef locally defined in a function is not used.
3919 This warning is enabled by @option{-Wall}.
3921 @item -Wunused-parameter
3922 @opindex Wunused-parameter
3923 @opindex Wno-unused-parameter
3924 Warn whenever a function parameter is unused aside from its declaration.
3926 To suppress this warning use the @samp{unused} attribute
3927 (@pxref{Variable Attributes}).
3929 @item -Wno-unused-result
3930 @opindex Wunused-result
3931 @opindex Wno-unused-result
3932 Do not warn if a caller of a function marked with attribute
3933 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3934 its return value. The default is @option{-Wunused-result}.
3936 @item -Wunused-variable
3937 @opindex Wunused-variable
3938 @opindex Wno-unused-variable
3939 Warn whenever a local variable or non-constant static variable is unused
3940 aside from its declaration.
3941 This warning is enabled by @option{-Wall}.
3943 To suppress this warning use the @samp{unused} attribute
3944 (@pxref{Variable Attributes}).
3946 @item -Wunused-value
3947 @opindex Wunused-value
3948 @opindex Wno-unused-value
3949 Warn whenever a statement computes a result that is explicitly not
3950 used. To suppress this warning cast the unused expression to
3951 @samp{void}. This includes an expression-statement or the left-hand
3952 side of a comma expression that contains no side effects. For example,
3953 an expression such as @samp{x[i,j]} causes a warning, while
3954 @samp{x[(void)i,j]} does not.
3956 This warning is enabled by @option{-Wall}.
3958 @item -Wunused
3959 @opindex Wunused
3960 @opindex Wno-unused
3961 All the above @option{-Wunused} options combined.
3963 In order to get a warning about an unused function parameter, you must
3964 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3965 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3967 @item -Wuninitialized
3968 @opindex Wuninitialized
3969 @opindex Wno-uninitialized
3970 Warn if an automatic variable is used without first being initialized
3971 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3972 warn if a non-static reference or non-static @samp{const} member
3973 appears in a class without constructors.
3975 If you want to warn about code that uses the uninitialized value of the
3976 variable in its own initializer, use the @option{-Winit-self} option.
3978 These warnings occur for individual uninitialized or clobbered
3979 elements of structure, union or array variables as well as for
3980 variables that are uninitialized or clobbered as a whole.  They do
3981 not occur for variables or elements declared @code{volatile}.  Because
3982 these warnings depend on optimization, the exact variables or elements
3983 for which there are warnings depends on the precise optimization
3984 options and version of GCC used.
3986 Note that there may be no warning about a variable that is used only
3987 to compute a value that itself is never used, because such
3988 computations may be deleted by data flow analysis before the warnings
3989 are printed.
3991 @item -Wmaybe-uninitialized
3992 @opindex Wmaybe-uninitialized
3993 @opindex Wno-maybe-uninitialized
3994 For an automatic variable, if there exists a path from the function
3995 entry to a use of the variable that is initialized, but there exist
3996 some other paths for which the variable is not initialized, the compiler
3997 emits a warning if it cannot prove the uninitialized paths are not
3998 executed at run time. These warnings are made optional because GCC is
3999 not smart enough to see all the reasons why the code might be correct
4000 in spite of appearing to have an error.  Here is one example of how
4001 this can happen:
4003 @smallexample
4004 @group
4006   int x;
4007   switch (y)
4008     @{
4009     case 1: x = 1;
4010       break;
4011     case 2: x = 4;
4012       break;
4013     case 3: x = 5;
4014     @}
4015   foo (x);
4017 @end group
4018 @end smallexample
4020 @noindent
4021 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4022 always initialized, but GCC doesn't know this. To suppress the
4023 warning, you need to provide a default case with assert(0) or
4024 similar code.
4026 @cindex @code{longjmp} warnings
4027 This option also warns when a non-volatile automatic variable might be
4028 changed by a call to @code{longjmp}.  These warnings as well are possible
4029 only in optimizing compilation.
4031 The compiler sees only the calls to @code{setjmp}.  It cannot know
4032 where @code{longjmp} will be called; in fact, a signal handler could
4033 call it at any point in the code.  As a result, you may get a warning
4034 even when there is in fact no problem because @code{longjmp} cannot
4035 in fact be called at the place that would cause a problem.
4037 Some spurious warnings can be avoided if you declare all the functions
4038 you use that never return as @code{noreturn}.  @xref{Function
4039 Attributes}.
4041 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4043 @item -Wunknown-pragmas
4044 @opindex Wunknown-pragmas
4045 @opindex Wno-unknown-pragmas
4046 @cindex warning for unknown pragmas
4047 @cindex unknown pragmas, warning
4048 @cindex pragmas, warning of unknown
4049 Warn when a @code{#pragma} directive is encountered that is not understood by 
4050 GCC@.  If this command-line option is used, warnings are even issued
4051 for unknown pragmas in system header files.  This is not the case if
4052 the warnings are only enabled by the @option{-Wall} command-line option.
4054 @item -Wno-pragmas
4055 @opindex Wno-pragmas
4056 @opindex Wpragmas
4057 Do not warn about misuses of pragmas, such as incorrect parameters,
4058 invalid syntax, or conflicts between pragmas.  See also
4059 @option{-Wunknown-pragmas}.
4061 @item -Wstrict-aliasing
4062 @opindex Wstrict-aliasing
4063 @opindex Wno-strict-aliasing
4064 This option is only active when @option{-fstrict-aliasing} is active.
4065 It warns about code that might break the strict aliasing rules that the
4066 compiler is using for optimization.  The warning does not catch all
4067 cases, but does attempt to catch the more common pitfalls.  It is
4068 included in @option{-Wall}.
4069 It is equivalent to @option{-Wstrict-aliasing=3}
4071 @item -Wstrict-aliasing=n
4072 @opindex Wstrict-aliasing=n
4073 This option is only active when @option{-fstrict-aliasing} is active.
4074 It warns about code that might break the strict aliasing rules that the
4075 compiler is using for optimization.
4076 Higher levels correspond to higher accuracy (fewer false positives).
4077 Higher levels also correspond to more effort, similar to the way @option{-O} 
4078 works.
4079 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4081 Level 1: Most aggressive, quick, least accurate.
4082 Possibly useful when higher levels
4083 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4084 false negatives.  However, it has many false positives.
4085 Warns for all pointer conversions between possibly incompatible types,
4086 even if never dereferenced.  Runs in the front end only.
4088 Level 2: Aggressive, quick, not too precise.
4089 May still have many false positives (not as many as level 1 though),
4090 and few false negatives (but possibly more than level 1).
4091 Unlike level 1, it only warns when an address is taken.  Warns about
4092 incomplete types.  Runs in the front end only.
4094 Level 3 (default for @option{-Wstrict-aliasing}):
4095 Should have very few false positives and few false
4096 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4097 Takes care of the common pun+dereference pattern in the front end:
4098 @code{*(int*)&some_float}.
4099 If optimization is enabled, it also runs in the back end, where it deals
4100 with multiple statement cases using flow-sensitive points-to information.
4101 Only warns when the converted pointer is dereferenced.
4102 Does not warn about incomplete types.
4104 @item -Wstrict-overflow
4105 @itemx -Wstrict-overflow=@var{n}
4106 @opindex Wstrict-overflow
4107 @opindex Wno-strict-overflow
4108 This option is only active when @option{-fstrict-overflow} is active.
4109 It warns about cases where the compiler optimizes based on the
4110 assumption that signed overflow does not occur.  Note that it does not
4111 warn about all cases where the code might overflow: it only warns
4112 about cases where the compiler implements some optimization.  Thus
4113 this warning depends on the optimization level.
4115 An optimization that assumes that signed overflow does not occur is
4116 perfectly safe if the values of the variables involved are such that
4117 overflow never does, in fact, occur.  Therefore this warning can
4118 easily give a false positive: a warning about code that is not
4119 actually a problem.  To help focus on important issues, several
4120 warning levels are defined.  No warnings are issued for the use of
4121 undefined signed overflow when estimating how many iterations a loop
4122 requires, in particular when determining whether a loop will be
4123 executed at all.
4125 @table @gcctabopt
4126 @item -Wstrict-overflow=1
4127 Warn about cases that are both questionable and easy to avoid.  For
4128 example,  with @option{-fstrict-overflow}, the compiler simplifies
4129 @code{x + 1 > x} to @code{1}.  This level of
4130 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4131 are not, and must be explicitly requested.
4133 @item -Wstrict-overflow=2
4134 Also warn about other cases where a comparison is simplified to a
4135 constant.  For example: @code{abs (x) >= 0}.  This can only be
4136 simplified when @option{-fstrict-overflow} is in effect, because
4137 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4138 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4139 @option{-Wstrict-overflow=2}.
4141 @item -Wstrict-overflow=3
4142 Also warn about other cases where a comparison is simplified.  For
4143 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4145 @item -Wstrict-overflow=4
4146 Also warn about other simplifications not covered by the above cases.
4147 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4149 @item -Wstrict-overflow=5
4150 Also warn about cases where the compiler reduces the magnitude of a
4151 constant involved in a comparison.  For example: @code{x + 2 > y} is
4152 simplified to @code{x + 1 >= y}.  This is reported only at the
4153 highest warning level because this simplification applies to many
4154 comparisons, so this warning level gives a very large number of
4155 false positives.
4156 @end table
4158 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4159 @opindex Wsuggest-attribute=
4160 @opindex Wno-suggest-attribute=
4161 Warn for cases where adding an attribute may be beneficial. The
4162 attributes currently supported are listed below.
4164 @table @gcctabopt
4165 @item -Wsuggest-attribute=pure
4166 @itemx -Wsuggest-attribute=const
4167 @itemx -Wsuggest-attribute=noreturn
4168 @opindex Wsuggest-attribute=pure
4169 @opindex Wno-suggest-attribute=pure
4170 @opindex Wsuggest-attribute=const
4171 @opindex Wno-suggest-attribute=const
4172 @opindex Wsuggest-attribute=noreturn
4173 @opindex Wno-suggest-attribute=noreturn
4175 Warn about functions that might be candidates for attributes
4176 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4177 functions visible in other compilation units or (in the case of @code{pure} and
4178 @code{const}) if it cannot prove that the function returns normally. A function
4179 returns normally if it doesn't contain an infinite loop or return abnormally
4180 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4181 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4182 higher.  Higher optimization levels improve the accuracy of the analysis.
4184 @item -Wsuggest-attribute=format
4185 @itemx -Wmissing-format-attribute
4186 @opindex Wsuggest-attribute=format
4187 @opindex Wmissing-format-attribute
4188 @opindex Wno-suggest-attribute=format
4189 @opindex Wno-missing-format-attribute
4190 @opindex Wformat
4191 @opindex Wno-format
4193 Warn about function pointers that might be candidates for @code{format}
4194 attributes.  Note these are only possible candidates, not absolute ones.
4195 GCC guesses that function pointers with @code{format} attributes that
4196 are used in assignment, initialization, parameter passing or return
4197 statements should have a corresponding @code{format} attribute in the
4198 resulting type.  I.e.@: the left-hand side of the assignment or
4199 initialization, the type of the parameter variable, or the return type
4200 of the containing function respectively should also have a @code{format}
4201 attribute to avoid the warning.
4203 GCC also warns about function definitions that might be
4204 candidates for @code{format} attributes.  Again, these are only
4205 possible candidates.  GCC guesses that @code{format} attributes
4206 might be appropriate for any function that calls a function like
4207 @code{vprintf} or @code{vscanf}, but this might not always be the
4208 case, and some functions for which @code{format} attributes are
4209 appropriate may not be detected.
4210 @end table
4212 @item -Wsuggest-final-types
4213 @opindex Wno-suggest-final-types
4214 @opindex Wsuggest-final-types
4215 Warn about types with virtual methods where code quality would be improved
4216 if the type was declared with C++11 final specifier, or, if possible,
4217 declared in anonymous namespace. This allows GCC to devritualize more aggressively
4218 the polymorphic calls. This warning is more effective with link time optimization,
4219 where the information about the class hiearchy graph is more complete.
4221 @item -Wsuggest-final-methods
4222 @opindex Wno-suggest-final-methods
4223 @opindex Wsuggest-final-methods
4224 Warn about virtual methods where code quality would be improved if the method
4225 was declared with C++11 final specifier, or, if possible, its type was declared
4226 in the anonymous namespace or with final specifier. This warning is more
4227 effective with link time optimization, where the information about the class
4228 hiearchy graph is more complete. It is recommended to first consider suggestins
4229 of @option{-Wsuggest-final-types} and then rebuild with new annotations.
4231 @item -Warray-bounds
4232 @opindex Wno-array-bounds
4233 @opindex Warray-bounds
4234 This option is only active when @option{-ftree-vrp} is active
4235 (default for @option{-O2} and above). It warns about subscripts to arrays
4236 that are always out of bounds. This warning is enabled by @option{-Wall}.
4238 @item -Wbool-compare
4239 @opindex Wno-bool-compare
4240 @opindex Wbool-compare
4241 Warn about boolean expression compared with an integer value different from
4242 @code{true}/@code{false}.  For instance, the following comparison is
4243 always false:
4244 @smallexample
4245 int n = 5;
4246 @dots{}
4247 if ((n > 1) == 2) @{ @dots{} @}
4248 @end smallexample
4249 This warning is enabled by @option{-Wall}.
4251 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4252 @opindex Wno-discarded-qualifiers
4253 @opindex Wdiscarded-qualifiers
4254 Do not warn if type qualifiers on pointers are being discarded.
4255 Typically, the compiler will warn if a @code{const char *} variable is
4256 passed to a function that takes @code{char *} parameter.  This option
4257 can be used to suppress such a warning.
4259 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4260 @opindex Wno-incompatible-pointer-types
4261 @opindex Wincompatible-pointer-types
4262 Do not warn when there is a conversion between pointers that have incompatible
4263 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4264 which warns for pointer argument passing or assignment with different signedness
4266 @item -Wno-int-conversion @r{(C and Objective-C only)}
4267 @opindex Wno-int-conversion
4268 @opindex Wint-conversion
4269 Do not warn about incompatible integer to pointer and pointer to integer
4270 conversions.  This warning is about implicit conversions; for explicit
4271 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4272 @option{-Wno-pointer-to-int-cast} may be used.
4274 @item -Wno-div-by-zero
4275 @opindex Wno-div-by-zero
4276 @opindex Wdiv-by-zero
4277 Do not warn about compile-time integer division by zero.  Floating-point
4278 division by zero is not warned about, as it can be a legitimate way of
4279 obtaining infinities and NaNs.
4281 @item -Wsystem-headers
4282 @opindex Wsystem-headers
4283 @opindex Wno-system-headers
4284 @cindex warnings from system headers
4285 @cindex system headers, warnings from
4286 Print warning messages for constructs found in system header files.
4287 Warnings from system headers are normally suppressed, on the assumption
4288 that they usually do not indicate real problems and would only make the
4289 compiler output harder to read.  Using this command-line option tells
4290 GCC to emit warnings from system headers as if they occurred in user
4291 code.  However, note that using @option{-Wall} in conjunction with this
4292 option does @emph{not} warn about unknown pragmas in system
4293 headers---for that, @option{-Wunknown-pragmas} must also be used.
4295 @item -Wtrampolines
4296 @opindex Wtrampolines
4297 @opindex Wno-trampolines
4298  Warn about trampolines generated for pointers to nested functions.
4300  A trampoline is a small piece of data or code that is created at run
4301  time on the stack when the address of a nested function is taken, and
4302  is used to call the nested function indirectly.  For some targets, it
4303  is made up of data only and thus requires no special treatment.  But,
4304  for most targets, it is made up of code and thus requires the stack
4305  to be made executable in order for the program to work properly.
4307 @item -Wfloat-equal
4308 @opindex Wfloat-equal
4309 @opindex Wno-float-equal
4310 Warn if floating-point values are used in equality comparisons.
4312 The idea behind this is that sometimes it is convenient (for the
4313 programmer) to consider floating-point values as approximations to
4314 infinitely precise real numbers.  If you are doing this, then you need
4315 to compute (by analyzing the code, or in some other way) the maximum or
4316 likely maximum error that the computation introduces, and allow for it
4317 when performing comparisons (and when producing output, but that's a
4318 different problem).  In particular, instead of testing for equality, you
4319 should check to see whether the two values have ranges that overlap; and
4320 this is done with the relational operators, so equality comparisons are
4321 probably mistaken.
4323 @item -Wtraditional @r{(C and Objective-C only)}
4324 @opindex Wtraditional
4325 @opindex Wno-traditional
4326 Warn about certain constructs that behave differently in traditional and
4327 ISO C@.  Also warn about ISO C constructs that have no traditional C
4328 equivalent, and/or problematic constructs that should be avoided.
4330 @itemize @bullet
4331 @item
4332 Macro parameters that appear within string literals in the macro body.
4333 In traditional C macro replacement takes place within string literals,
4334 but in ISO C it does not.
4336 @item
4337 In traditional C, some preprocessor directives did not exist.
4338 Traditional preprocessors only considered a line to be a directive
4339 if the @samp{#} appeared in column 1 on the line.  Therefore
4340 @option{-Wtraditional} warns about directives that traditional C
4341 understands but ignores because the @samp{#} does not appear as the
4342 first character on the line.  It also suggests you hide directives like
4343 @samp{#pragma} not understood by traditional C by indenting them.  Some
4344 traditional implementations do not recognize @samp{#elif}, so this option
4345 suggests avoiding it altogether.
4347 @item
4348 A function-like macro that appears without arguments.
4350 @item
4351 The unary plus operator.
4353 @item
4354 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4355 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4356 constants.)  Note, these suffixes appear in macros defined in the system
4357 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4358 Use of these macros in user code might normally lead to spurious
4359 warnings, however GCC's integrated preprocessor has enough context to
4360 avoid warning in these cases.
4362 @item
4363 A function declared external in one block and then used after the end of
4364 the block.
4366 @item
4367 A @code{switch} statement has an operand of type @code{long}.
4369 @item
4370 A non-@code{static} function declaration follows a @code{static} one.
4371 This construct is not accepted by some traditional C compilers.
4373 @item
4374 The ISO type of an integer constant has a different width or
4375 signedness from its traditional type.  This warning is only issued if
4376 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4377 typically represent bit patterns, are not warned about.
4379 @item
4380 Usage of ISO string concatenation is detected.
4382 @item
4383 Initialization of automatic aggregates.
4385 @item
4386 Identifier conflicts with labels.  Traditional C lacks a separate
4387 namespace for labels.
4389 @item
4390 Initialization of unions.  If the initializer is zero, the warning is
4391 omitted.  This is done under the assumption that the zero initializer in
4392 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4393 initializer warnings and relies on default initialization to zero in the
4394 traditional C case.
4396 @item
4397 Conversions by prototypes between fixed/floating-point values and vice
4398 versa.  The absence of these prototypes when compiling with traditional
4399 C causes serious problems.  This is a subset of the possible
4400 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4402 @item
4403 Use of ISO C style function definitions.  This warning intentionally is
4404 @emph{not} issued for prototype declarations or variadic functions
4405 because these ISO C features appear in your code when using
4406 libiberty's traditional C compatibility macros, @code{PARAMS} and
4407 @code{VPARAMS}.  This warning is also bypassed for nested functions
4408 because that feature is already a GCC extension and thus not relevant to
4409 traditional C compatibility.
4410 @end itemize
4412 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4413 @opindex Wtraditional-conversion
4414 @opindex Wno-traditional-conversion
4415 Warn if a prototype causes a type conversion that is different from what
4416 would happen to the same argument in the absence of a prototype.  This
4417 includes conversions of fixed point to floating and vice versa, and
4418 conversions changing the width or signedness of a fixed-point argument
4419 except when the same as the default promotion.
4421 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4422 @opindex Wdeclaration-after-statement
4423 @opindex Wno-declaration-after-statement
4424 Warn when a declaration is found after a statement in a block.  This
4425 construct, known from C++, was introduced with ISO C99 and is by default
4426 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4427 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4429 @item -Wundef
4430 @opindex Wundef
4431 @opindex Wno-undef
4432 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4434 @item -Wno-endif-labels
4435 @opindex Wno-endif-labels
4436 @opindex Wendif-labels
4437 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4439 @item -Wshadow
4440 @opindex Wshadow
4441 @opindex Wno-shadow
4442 Warn whenever a local variable or type declaration shadows another
4443 variable, parameter, type, class member (in C++), or instance variable
4444 (in Objective-C) or whenever a built-in function is shadowed. Note
4445 that in C++, the compiler warns if a local variable shadows an
4446 explicit typedef, but not if it shadows a struct/class/enum.
4448 @item -Wno-shadow-ivar @r{(Objective-C only)}
4449 @opindex Wno-shadow-ivar
4450 @opindex Wshadow-ivar
4451 Do not warn whenever a local variable shadows an instance variable in an
4452 Objective-C method.
4454 @item -Wlarger-than=@var{len}
4455 @opindex Wlarger-than=@var{len}
4456 @opindex Wlarger-than-@var{len}
4457 Warn whenever an object of larger than @var{len} bytes is defined.
4459 @item -Wframe-larger-than=@var{len}
4460 @opindex Wframe-larger-than
4461 Warn if the size of a function frame is larger than @var{len} bytes.
4462 The computation done to determine the stack frame size is approximate
4463 and not conservative.
4464 The actual requirements may be somewhat greater than @var{len}
4465 even if you do not get a warning.  In addition, any space allocated
4466 via @code{alloca}, variable-length arrays, or related constructs
4467 is not included by the compiler when determining
4468 whether or not to issue a warning.
4470 @item -Wno-free-nonheap-object
4471 @opindex Wno-free-nonheap-object
4472 @opindex Wfree-nonheap-object
4473 Do not warn when attempting to free an object that was not allocated
4474 on the heap.
4476 @item -Wstack-usage=@var{len}
4477 @opindex Wstack-usage
4478 Warn if the stack usage of a function might be larger than @var{len} bytes.
4479 The computation done to determine the stack usage is conservative.
4480 Any space allocated via @code{alloca}, variable-length arrays, or related
4481 constructs is included by the compiler when determining whether or not to
4482 issue a warning.
4484 The message is in keeping with the output of @option{-fstack-usage}.
4486 @itemize
4487 @item
4488 If the stack usage is fully static but exceeds the specified amount, it's:
4490 @smallexample
4491   warning: stack usage is 1120 bytes
4492 @end smallexample
4493 @item
4494 If the stack usage is (partly) dynamic but bounded, it's:
4496 @smallexample
4497   warning: stack usage might be 1648 bytes
4498 @end smallexample
4499 @item
4500 If the stack usage is (partly) dynamic and not bounded, it's:
4502 @smallexample
4503   warning: stack usage might be unbounded
4504 @end smallexample
4505 @end itemize
4507 @item -Wunsafe-loop-optimizations
4508 @opindex Wunsafe-loop-optimizations
4509 @opindex Wno-unsafe-loop-optimizations
4510 Warn if the loop cannot be optimized because the compiler cannot
4511 assume anything on the bounds of the loop indices.  With
4512 @option{-funsafe-loop-optimizations} warn if the compiler makes
4513 such assumptions.
4515 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4516 @opindex Wno-pedantic-ms-format
4517 @opindex Wpedantic-ms-format
4518 When used in combination with @option{-Wformat}
4519 and @option{-pedantic} without GNU extensions, this option
4520 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4521 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4522 which depend on the MS runtime.
4524 @item -Wpointer-arith
4525 @opindex Wpointer-arith
4526 @opindex Wno-pointer-arith
4527 Warn about anything that depends on the ``size of'' a function type or
4528 of @code{void}.  GNU C assigns these types a size of 1, for
4529 convenience in calculations with @code{void *} pointers and pointers
4530 to functions.  In C++, warn also when an arithmetic operation involves
4531 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4533 @item -Wtype-limits
4534 @opindex Wtype-limits
4535 @opindex Wno-type-limits
4536 Warn if a comparison is always true or always false due to the limited
4537 range of the data type, but do not warn for constant expressions.  For
4538 example, warn if an unsigned variable is compared against zero with
4539 @samp{<} or @samp{>=}.  This warning is also enabled by
4540 @option{-Wextra}.
4542 @item -Wbad-function-cast @r{(C and Objective-C only)}
4543 @opindex Wbad-function-cast
4544 @opindex Wno-bad-function-cast
4545 Warn whenever a function call is cast to a non-matching type.
4546 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4548 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4549 @opindex Wc90-c99-compat
4550 @opindex Wno-c90-c99-compat
4551 Warn about features not present in ISO C90, but present in ISO C99.
4552 For instance, warn about use of variable length arrays, @code{long long}
4553 type, @code{bool} type, compound literals, designated initializers, and so
4554 on.  This option is independent of the standards mode.  Warnings are disabled
4555 in the expression that follows @code{__extension__}.
4557 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4558 @opindex Wc99-c11-compat
4559 @opindex Wno-c99-c11-compat
4560 Warn about features not present in ISO C99, but present in ISO C11.
4561 For instance, warn about use of anonymous structures and unions,
4562 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4563 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4564 and so on.  This option is independent of the standards mode.  Warnings are
4565 disabled in the expression that follows @code{__extension__}.
4567 @item -Wc++-compat @r{(C and Objective-C only)}
4568 Warn about ISO C constructs that are outside of the common subset of
4569 ISO C and ISO C++, e.g.@: request for implicit conversion from
4570 @code{void *} to a pointer to non-@code{void} type.
4572 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4573 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4574 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4575 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4576 enabled by @option{-Wall}.
4578 @item -Wcast-qual
4579 @opindex Wcast-qual
4580 @opindex Wno-cast-qual
4581 Warn whenever a pointer is cast so as to remove a type qualifier from
4582 the target type.  For example, warn if a @code{const char *} is cast
4583 to an ordinary @code{char *}.
4585 Also warn when making a cast that introduces a type qualifier in an
4586 unsafe way.  For example, casting @code{char **} to @code{const char **}
4587 is unsafe, as in this example:
4589 @smallexample
4590   /* p is char ** value.  */
4591   const char **q = (const char **) p;
4592   /* Assignment of readonly string to const char * is OK.  */
4593   *q = "string";
4594   /* Now char** pointer points to read-only memory.  */
4595   **p = 'b';
4596 @end smallexample
4598 @item -Wcast-align
4599 @opindex Wcast-align
4600 @opindex Wno-cast-align
4601 Warn whenever a pointer is cast such that the required alignment of the
4602 target is increased.  For example, warn if a @code{char *} is cast to
4603 an @code{int *} on machines where integers can only be accessed at
4604 two- or four-byte boundaries.
4606 @item -Wwrite-strings
4607 @opindex Wwrite-strings
4608 @opindex Wno-write-strings
4609 When compiling C, give string constants the type @code{const
4610 char[@var{length}]} so that copying the address of one into a
4611 non-@code{const} @code{char *} pointer produces a warning.  These
4612 warnings help you find at compile time code that can try to write
4613 into a string constant, but only if you have been very careful about
4614 using @code{const} in declarations and prototypes.  Otherwise, it is
4615 just a nuisance. This is why we did not make @option{-Wall} request
4616 these warnings.
4618 When compiling C++, warn about the deprecated conversion from string
4619 literals to @code{char *}.  This warning is enabled by default for C++
4620 programs.
4622 @item -Wclobbered
4623 @opindex Wclobbered
4624 @opindex Wno-clobbered
4625 Warn for variables that might be changed by @samp{longjmp} or
4626 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4628 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4629 @opindex Wconditionally-supported
4630 @opindex Wno-conditionally-supported
4631 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4633 @item -Wconversion
4634 @opindex Wconversion
4635 @opindex Wno-conversion
4636 Warn for implicit conversions that may alter a value. This includes
4637 conversions between real and integer, like @code{abs (x)} when
4638 @code{x} is @code{double}; conversions between signed and unsigned,
4639 like @code{unsigned ui = -1}; and conversions to smaller types, like
4640 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4641 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4642 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4643 conversions between signed and unsigned integers can be disabled by
4644 using @option{-Wno-sign-conversion}.
4646 For C++, also warn for confusing overload resolution for user-defined
4647 conversions; and conversions that never use a type conversion
4648 operator: conversions to @code{void}, the same type, a base class or a
4649 reference to them. Warnings about conversions between signed and
4650 unsigned integers are disabled by default in C++ unless
4651 @option{-Wsign-conversion} is explicitly enabled.
4653 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4654 @opindex Wconversion-null
4655 @opindex Wno-conversion-null
4656 Do not warn for conversions between @code{NULL} and non-pointer
4657 types. @option{-Wconversion-null} is enabled by default.
4659 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4660 @opindex Wzero-as-null-pointer-constant
4661 @opindex Wno-zero-as-null-pointer-constant
4662 Warn when a literal '0' is used as null pointer constant.  This can
4663 be useful to facilitate the conversion to @code{nullptr} in C++11.
4665 @item -Wdate-time
4666 @opindex Wdate-time
4667 @opindex Wno-date-time
4668 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4669 are encountered as they might prevent bit-wise-identical reproducible
4670 compilations.
4672 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4673 @opindex Wdelete-incomplete
4674 @opindex Wno-delete-incomplete
4675 Warn when deleting a pointer to incomplete type, which may cause
4676 undefined behavior at runtime.  This warning is enabled by default.
4678 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4679 @opindex Wuseless-cast
4680 @opindex Wno-useless-cast
4681 Warn when an expression is casted to its own type.
4683 @item -Wempty-body
4684 @opindex Wempty-body
4685 @opindex Wno-empty-body
4686 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4687 while} statement.  This warning is also enabled by @option{-Wextra}.
4689 @item -Wenum-compare
4690 @opindex Wenum-compare
4691 @opindex Wno-enum-compare
4692 Warn about a comparison between values of different enumerated types.
4693 In C++ enumeral mismatches in conditional expressions are also
4694 diagnosed and the warning is enabled by default.  In C this warning is 
4695 enabled by @option{-Wall}.
4697 @item -Wjump-misses-init @r{(C, Objective-C only)}
4698 @opindex Wjump-misses-init
4699 @opindex Wno-jump-misses-init
4700 Warn if a @code{goto} statement or a @code{switch} statement jumps
4701 forward across the initialization of a variable, or jumps backward to a
4702 label after the variable has been initialized.  This only warns about
4703 variables that are initialized when they are declared.  This warning is
4704 only supported for C and Objective-C; in C++ this sort of branch is an
4705 error in any case.
4707 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4708 can be disabled with the @option{-Wno-jump-misses-init} option.
4710 @item -Wsign-compare
4711 @opindex Wsign-compare
4712 @opindex Wno-sign-compare
4713 @cindex warning for comparison of signed and unsigned values
4714 @cindex comparison of signed and unsigned values, warning
4715 @cindex signed and unsigned values, comparison warning
4716 Warn when a comparison between signed and unsigned values could produce
4717 an incorrect result when the signed value is converted to unsigned.
4718 This warning is also enabled by @option{-Wextra}; to get the other warnings
4719 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4721 @item -Wsign-conversion
4722 @opindex Wsign-conversion
4723 @opindex Wno-sign-conversion
4724 Warn for implicit conversions that may change the sign of an integer
4725 value, like assigning a signed integer expression to an unsigned
4726 integer variable. An explicit cast silences the warning. In C, this
4727 option is enabled also by @option{-Wconversion}.
4729 @item -Wfloat-conversion
4730 @opindex Wfloat-conversion
4731 @opindex Wno-float-conversion
4732 Warn for implicit conversions that reduce the precision of a real value.
4733 This includes conversions from real to integer, and from higher precision
4734 real to lower precision real values.  This option is also enabled by
4735 @option{-Wconversion}.
4737 @item -Wsizeof-pointer-memaccess
4738 @opindex Wsizeof-pointer-memaccess
4739 @opindex Wno-sizeof-pointer-memaccess
4740 Warn for suspicious length parameters to certain string and memory built-in
4741 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4742 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4743 but a pointer, and suggests a possible fix, or about
4744 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4745 @option{-Wall}.
4747 @item -Wsizeof-array-argument
4748 @opindex Wsizeof-array-argument
4749 @opindex Wno-sizeof-array-argument
4750 Warn when the @code{sizeof} operator is applied to a parameter that is
4751 declared as an array in a function definition.  This warning is enabled by
4752 default for C and C++ programs.
4754 @item -Wmemset-transposed-args
4755 @opindex Wmemset-transposed-args
4756 @opindex Wno-memset-transposed-args
4757 Warn for suspicious calls to the @code{memset} built-in function, if the
4758 second argument is not zero and the third argument is zero.  This warns e.g.@
4759 about @code{memset (buf, sizeof buf, 0)} where most probably
4760 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4761 is only emitted if the third argument is literal zero, if it is some expression
4762 that is folded to zero, or e.g. a cast of zero to some type etc., it
4763 is far less likely that user has mistakenly exchanged the arguments and
4764 no warning is emitted.  This warning is enabled by @option{-Wall}.
4766 @item -Waddress
4767 @opindex Waddress
4768 @opindex Wno-address
4769 Warn about suspicious uses of memory addresses. These include using
4770 the address of a function in a conditional expression, such as
4771 @code{void func(void); if (func)}, and comparisons against the memory
4772 address of a string literal, such as @code{if (x == "abc")}.  Such
4773 uses typically indicate a programmer error: the address of a function
4774 always evaluates to true, so their use in a conditional usually
4775 indicate that the programmer forgot the parentheses in a function
4776 call; and comparisons against string literals result in unspecified
4777 behavior and are not portable in C, so they usually indicate that the
4778 programmer intended to use @code{strcmp}.  This warning is enabled by
4779 @option{-Wall}.
4781 @item -Wlogical-op
4782 @opindex Wlogical-op
4783 @opindex Wno-logical-op
4784 Warn about suspicious uses of logical operators in expressions.
4785 This includes using logical operators in contexts where a
4786 bit-wise operator is likely to be expected.
4788 @item -Wlogical-not-parentheses
4789 @opindex Wlogical-not-parentheses
4790 @opindex Wno-logical-not-parentheses
4791 Warn about logical not used on the left hand side operand of a comparison.
4792 This option does not warn if the RHS operand is of a boolean type.  Its
4793 purpose is to detect suspicious code like the following:
4794 @smallexample
4795 int a;
4796 @dots{}
4797 if (!a > 1) @{ @dots{} @}
4798 @end smallexample
4800 It is possible to suppress the warning by wrapping the LHS into
4801 parentheses:
4802 @smallexample
4803 if ((!a) > 1) @{ @dots{} @}
4804 @end smallexample
4806 This warning is enabled by @option{-Wall}.
4808 @item -Waggregate-return
4809 @opindex Waggregate-return
4810 @opindex Wno-aggregate-return
4811 Warn if any functions that return structures or unions are defined or
4812 called.  (In languages where you can return an array, this also elicits
4813 a warning.)
4815 @item -Wno-aggressive-loop-optimizations
4816 @opindex Wno-aggressive-loop-optimizations
4817 @opindex Waggressive-loop-optimizations
4818 Warn if in a loop with constant number of iterations the compiler detects
4819 undefined behavior in some statement during one or more of the iterations.
4821 @item -Wno-attributes
4822 @opindex Wno-attributes
4823 @opindex Wattributes
4824 Do not warn if an unexpected @code{__attribute__} is used, such as
4825 unrecognized attributes, function attributes applied to variables,
4826 etc.  This does not stop errors for incorrect use of supported
4827 attributes.
4829 @item -Wno-builtin-macro-redefined
4830 @opindex Wno-builtin-macro-redefined
4831 @opindex Wbuiltin-macro-redefined
4832 Do not warn if certain built-in macros are redefined.  This suppresses
4833 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4834 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4836 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4837 @opindex Wstrict-prototypes
4838 @opindex Wno-strict-prototypes
4839 Warn if a function is declared or defined without specifying the
4840 argument types.  (An old-style function definition is permitted without
4841 a warning if preceded by a declaration that specifies the argument
4842 types.)
4844 @item -Wold-style-declaration @r{(C and Objective-C only)}
4845 @opindex Wold-style-declaration
4846 @opindex Wno-old-style-declaration
4847 Warn for obsolescent usages, according to the C Standard, in a
4848 declaration. For example, warn if storage-class specifiers like
4849 @code{static} are not the first things in a declaration.  This warning
4850 is also enabled by @option{-Wextra}.
4852 @item -Wold-style-definition @r{(C and Objective-C only)}
4853 @opindex Wold-style-definition
4854 @opindex Wno-old-style-definition
4855 Warn if an old-style function definition is used.  A warning is given
4856 even if there is a previous prototype.
4858 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4859 @opindex Wmissing-parameter-type
4860 @opindex Wno-missing-parameter-type
4861 A function parameter is declared without a type specifier in K&R-style
4862 functions:
4864 @smallexample
4865 void foo(bar) @{ @}
4866 @end smallexample
4868 This warning is also enabled by @option{-Wextra}.
4870 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4871 @opindex Wmissing-prototypes
4872 @opindex Wno-missing-prototypes
4873 Warn if a global function is defined without a previous prototype
4874 declaration.  This warning is issued even if the definition itself
4875 provides a prototype.  Use this option to detect global functions
4876 that do not have a matching prototype declaration in a header file.
4877 This option is not valid for C++ because all function declarations
4878 provide prototypes and a non-matching declaration will declare an
4879 overload rather than conflict with an earlier declaration.
4880 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4882 @item -Wmissing-declarations
4883 @opindex Wmissing-declarations
4884 @opindex Wno-missing-declarations
4885 Warn if a global function is defined without a previous declaration.
4886 Do so even if the definition itself provides a prototype.
4887 Use this option to detect global functions that are not declared in
4888 header files.  In C, no warnings are issued for functions with previous
4889 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4890 missing prototypes.  In C++, no warnings are issued for function templates,
4891 or for inline functions, or for functions in anonymous namespaces.
4893 @item -Wmissing-field-initializers
4894 @opindex Wmissing-field-initializers
4895 @opindex Wno-missing-field-initializers
4896 @opindex W
4897 @opindex Wextra
4898 @opindex Wno-extra
4899 Warn if a structure's initializer has some fields missing.  For
4900 example, the following code causes such a warning, because
4901 @code{x.h} is implicitly zero:
4903 @smallexample
4904 struct s @{ int f, g, h; @};
4905 struct s x = @{ 3, 4 @};
4906 @end smallexample
4908 This option does not warn about designated initializers, so the following
4909 modification does not trigger a warning:
4911 @smallexample
4912 struct s @{ int f, g, h; @};
4913 struct s x = @{ .f = 3, .g = 4 @};
4914 @end smallexample
4916 In C++ this option does not warn either about the empty @{ @}
4917 initializer, for example:
4919 @smallexample
4920 struct s @{ int f, g, h; @};
4921 s x = @{ @};
4922 @end smallexample
4924 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4925 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4927 @item -Wno-multichar
4928 @opindex Wno-multichar
4929 @opindex Wmultichar
4930 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4931 Usually they indicate a typo in the user's code, as they have
4932 implementation-defined values, and should not be used in portable code.
4934 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
4935 @opindex Wnormalized=
4936 @opindex Wnormalized
4937 @opindex Wno-normalized
4938 @cindex NFC
4939 @cindex NFKC
4940 @cindex character set, input normalization
4941 In ISO C and ISO C++, two identifiers are different if they are
4942 different sequences of characters.  However, sometimes when characters
4943 outside the basic ASCII character set are used, you can have two
4944 different character sequences that look the same.  To avoid confusion,
4945 the ISO 10646 standard sets out some @dfn{normalization rules} which
4946 when applied ensure that two sequences that look the same are turned into
4947 the same sequence.  GCC can warn you if you are using identifiers that
4948 have not been normalized; this option controls that warning.
4950 There are four levels of warning supported by GCC@.  The default is
4951 @option{-Wnormalized=nfc}, which warns about any identifier that is
4952 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4953 recommended form for most uses.  It is equivalent to
4954 @option{-Wnormalized}.
4956 Unfortunately, there are some characters allowed in identifiers by
4957 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4958 identifiers.  That is, there's no way to use these symbols in portable
4959 ISO C or C++ and have all your identifiers in NFC@.
4960 @option{-Wnormalized=id} suppresses the warning for these characters.
4961 It is hoped that future versions of the standards involved will correct
4962 this, which is why this option is not the default.
4964 You can switch the warning off for all characters by writing
4965 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
4966 only do this if you are using some other normalization scheme (like
4967 ``D''), because otherwise you can easily create bugs that are
4968 literally impossible to see.
4970 Some characters in ISO 10646 have distinct meanings but look identical
4971 in some fonts or display methodologies, especially once formatting has
4972 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4973 LETTER N'', displays just like a regular @code{n} that has been
4974 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4975 normalization scheme to convert all these into a standard form as
4976 well, and GCC warns if your code is not in NFKC if you use
4977 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4978 about every identifier that contains the letter O because it might be
4979 confused with the digit 0, and so is not the default, but may be
4980 useful as a local coding convention if the programming environment 
4981 cannot be fixed to display these characters distinctly.
4983 @item -Wno-deprecated
4984 @opindex Wno-deprecated
4985 @opindex Wdeprecated
4986 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4988 @item -Wno-deprecated-declarations
4989 @opindex Wno-deprecated-declarations
4990 @opindex Wdeprecated-declarations
4991 Do not warn about uses of functions (@pxref{Function Attributes}),
4992 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4993 Attributes}) marked as deprecated by using the @code{deprecated}
4994 attribute.
4996 @item -Wno-overflow
4997 @opindex Wno-overflow
4998 @opindex Woverflow
4999 Do not warn about compile-time overflow in constant expressions.
5001 @item -Wno-odr
5002 @opindex Wno-odr
5003 @opindex Wodr
5004 Warn about One Definition Rule violations during link-time optimization.
5005 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5007 @item -Wopenmp-simd
5008 @opindex Wopenm-simd
5009 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5010 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
5011 be used to relax the cost model.
5013 @item -Woverride-init @r{(C and Objective-C only)}
5014 @opindex Woverride-init
5015 @opindex Wno-override-init
5016 @opindex W
5017 @opindex Wextra
5018 @opindex Wno-extra
5019 Warn if an initialized field without side effects is overridden when
5020 using designated initializers (@pxref{Designated Inits, , Designated
5021 Initializers}).
5023 This warning is included in @option{-Wextra}.  To get other
5024 @option{-Wextra} warnings without this one, use @option{-Wextra
5025 -Wno-override-init}.
5027 @item -Wpacked
5028 @opindex Wpacked
5029 @opindex Wno-packed
5030 Warn if a structure is given the packed attribute, but the packed
5031 attribute has no effect on the layout or size of the structure.
5032 Such structures may be mis-aligned for little benefit.  For
5033 instance, in this code, the variable @code{f.x} in @code{struct bar}
5034 is misaligned even though @code{struct bar} does not itself
5035 have the packed attribute:
5037 @smallexample
5038 @group
5039 struct foo @{
5040   int x;
5041   char a, b, c, d;
5042 @} __attribute__((packed));
5043 struct bar @{
5044   char z;
5045   struct foo f;
5047 @end group
5048 @end smallexample
5050 @item -Wpacked-bitfield-compat
5051 @opindex Wpacked-bitfield-compat
5052 @opindex Wno-packed-bitfield-compat
5053 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5054 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5055 the change can lead to differences in the structure layout.  GCC
5056 informs you when the offset of such a field has changed in GCC 4.4.
5057 For example there is no longer a 4-bit padding between field @code{a}
5058 and @code{b} in this structure:
5060 @smallexample
5061 struct foo
5063   char a:4;
5064   char b:8;
5065 @} __attribute__ ((packed));
5066 @end smallexample
5068 This warning is enabled by default.  Use
5069 @option{-Wno-packed-bitfield-compat} to disable this warning.
5071 @item -Wpadded
5072 @opindex Wpadded
5073 @opindex Wno-padded
5074 Warn if padding is included in a structure, either to align an element
5075 of the structure or to align the whole structure.  Sometimes when this
5076 happens it is possible to rearrange the fields of the structure to
5077 reduce the padding and so make the structure smaller.
5079 @item -Wredundant-decls
5080 @opindex Wredundant-decls
5081 @opindex Wno-redundant-decls
5082 Warn if anything is declared more than once in the same scope, even in
5083 cases where multiple declaration is valid and changes nothing.
5085 @item -Wnested-externs @r{(C and Objective-C only)}
5086 @opindex Wnested-externs
5087 @opindex Wno-nested-externs
5088 Warn if an @code{extern} declaration is encountered within a function.
5090 @item -Wno-inherited-variadic-ctor
5091 @opindex Winherited-variadic-ctor
5092 @opindex Wno-inherited-variadic-ctor
5093 Suppress warnings about use of C++11 inheriting constructors when the
5094 base class inherited from has a C variadic constructor; the warning is
5095 on by default because the ellipsis is not inherited.
5097 @item -Winline
5098 @opindex Winline
5099 @opindex Wno-inline
5100 Warn if a function that is declared as inline cannot be inlined.
5101 Even with this option, the compiler does not warn about failures to
5102 inline functions declared in system headers.
5104 The compiler uses a variety of heuristics to determine whether or not
5105 to inline a function.  For example, the compiler takes into account
5106 the size of the function being inlined and the amount of inlining
5107 that has already been done in the current function.  Therefore,
5108 seemingly insignificant changes in the source program can cause the
5109 warnings produced by @option{-Winline} to appear or disappear.
5111 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5112 @opindex Wno-invalid-offsetof
5113 @opindex Winvalid-offsetof
5114 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
5115 type.  According to the 2014 ISO C++ standard, applying @samp{offsetof}
5116 to a non-standard-layout type is undefined.  In existing C++ implementations,
5117 however, @samp{offsetof} typically gives meaningful results.
5118 This flag is for users who are aware that they are
5119 writing nonportable code and who have deliberately chosen to ignore the
5120 warning about it.
5122 The restrictions on @samp{offsetof} may be relaxed in a future version
5123 of the C++ standard.
5125 @item -Wno-int-to-pointer-cast
5126 @opindex Wno-int-to-pointer-cast
5127 @opindex Wint-to-pointer-cast
5128 Suppress warnings from casts to pointer type of an integer of a
5129 different size. In C++, casting to a pointer type of smaller size is
5130 an error. @option{Wint-to-pointer-cast} is enabled by default.
5133 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5134 @opindex Wno-pointer-to-int-cast
5135 @opindex Wpointer-to-int-cast
5136 Suppress warnings from casts from a pointer to an integer type of a
5137 different size.
5139 @item -Winvalid-pch
5140 @opindex Winvalid-pch
5141 @opindex Wno-invalid-pch
5142 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5143 the search path but can't be used.
5145 @item -Wlong-long
5146 @opindex Wlong-long
5147 @opindex Wno-long-long
5148 Warn if @samp{long long} type is used.  This is enabled by either
5149 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5150 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5152 @item -Wvariadic-macros
5153 @opindex Wvariadic-macros
5154 @opindex Wno-variadic-macros
5155 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5156 alternate syntax is used in ISO C99 mode.  This is enabled by either
5157 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5158 messages, use @option{-Wno-variadic-macros}.
5160 @item -Wvarargs
5161 @opindex Wvarargs
5162 @opindex Wno-varargs
5163 Warn upon questionable usage of the macros used to handle variable
5164 arguments like @samp{va_start}.  This is default.  To inhibit the
5165 warning messages, use @option{-Wno-varargs}.
5167 @item -Wvector-operation-performance
5168 @opindex Wvector-operation-performance
5169 @opindex Wno-vector-operation-performance
5170 Warn if vector operation is not implemented via SIMD capabilities of the
5171 architecture.  Mainly useful for the performance tuning.
5172 Vector operation can be implemented @code{piecewise}, which means that the
5173 scalar operation is performed on every vector element; 
5174 @code{in parallel}, which means that the vector operation is implemented
5175 using scalars of wider type, which normally is more performance efficient;
5176 and @code{as a single scalar}, which means that vector fits into a
5177 scalar type.
5179 @item -Wno-virtual-move-assign
5180 @opindex Wvirtual-move-assign
5181 @opindex Wno-virtual-move-assign
5182 Suppress warnings about inheriting from a virtual base with a
5183 non-trivial C++11 move assignment operator.  This is dangerous because
5184 if the virtual base is reachable along more than one path, it will be
5185 moved multiple times, which can mean both objects end up in the
5186 moved-from state.  If the move assignment operator is written to avoid
5187 moving from a moved-from object, this warning can be disabled.
5189 @item -Wvla
5190 @opindex Wvla
5191 @opindex Wno-vla
5192 Warn if variable length array is used in the code.
5193 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5194 the variable length array.
5196 @item -Wvolatile-register-var
5197 @opindex Wvolatile-register-var
5198 @opindex Wno-volatile-register-var
5199 Warn if a register variable is declared volatile.  The volatile
5200 modifier does not inhibit all optimizations that may eliminate reads
5201 and/or writes to register variables.  This warning is enabled by
5202 @option{-Wall}.
5204 @item -Wdisabled-optimization
5205 @opindex Wdisabled-optimization
5206 @opindex Wno-disabled-optimization
5207 Warn if a requested optimization pass is disabled.  This warning does
5208 not generally indicate that there is anything wrong with your code; it
5209 merely indicates that GCC's optimizers are unable to handle the code
5210 effectively.  Often, the problem is that your code is too big or too
5211 complex; GCC refuses to optimize programs when the optimization
5212 itself is likely to take inordinate amounts of time.
5214 @item -Wpointer-sign @r{(C and Objective-C only)}
5215 @opindex Wpointer-sign
5216 @opindex Wno-pointer-sign
5217 Warn for pointer argument passing or assignment with different signedness.
5218 This option is only supported for C and Objective-C@.  It is implied by
5219 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5220 @option{-Wno-pointer-sign}.
5222 @item -Wstack-protector
5223 @opindex Wstack-protector
5224 @opindex Wno-stack-protector
5225 This option is only active when @option{-fstack-protector} is active.  It
5226 warns about functions that are not protected against stack smashing.
5228 @item -Woverlength-strings
5229 @opindex Woverlength-strings
5230 @opindex Wno-overlength-strings
5231 Warn about string constants that are longer than the ``minimum
5232 maximum'' length specified in the C standard.  Modern compilers
5233 generally allow string constants that are much longer than the
5234 standard's minimum limit, but very portable programs should avoid
5235 using longer strings.
5237 The limit applies @emph{after} string constant concatenation, and does
5238 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5239 C99, it was raised to 4095.  C++98 does not specify a normative
5240 minimum maximum, so we do not diagnose overlength strings in C++@.
5242 This option is implied by @option{-Wpedantic}, and can be disabled with
5243 @option{-Wno-overlength-strings}.
5245 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5246 @opindex Wunsuffixed-float-constants
5248 Issue a warning for any floating constant that does not have
5249 a suffix.  When used together with @option{-Wsystem-headers} it
5250 warns about such constants in system header files.  This can be useful
5251 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5252 from the decimal floating-point extension to C99.
5254 @item -Wno-designated-init @r{(C and Objective-C only)}
5255 Suppress warnings when a positional initializer is used to initialize
5256 a structure that has been marked with the @code{designated_init}
5257 attribute.
5259 @end table
5261 @node Debugging Options
5262 @section Options for Debugging Your Program or GCC
5263 @cindex options, debugging
5264 @cindex debugging information options
5266 GCC has various special options that are used for debugging
5267 either your program or GCC:
5269 @table @gcctabopt
5270 @item -g
5271 @opindex g
5272 Produce debugging information in the operating system's native format
5273 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5274 information.
5276 On most systems that use stabs format, @option{-g} enables use of extra
5277 debugging information that only GDB can use; this extra information
5278 makes debugging work better in GDB but probably makes other debuggers
5279 crash or
5280 refuse to read the program.  If you want to control for certain whether
5281 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5282 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5284 GCC allows you to use @option{-g} with
5285 @option{-O}.  The shortcuts taken by optimized code may occasionally
5286 produce surprising results: some variables you declared may not exist
5287 at all; flow of control may briefly move where you did not expect it;
5288 some statements may not be executed because they compute constant
5289 results or their values are already at hand; some statements may
5290 execute in different places because they have been moved out of loops.
5292 Nevertheless it proves possible to debug optimized output.  This makes
5293 it reasonable to use the optimizer for programs that might have bugs.
5295 The following options are useful when GCC is generated with the
5296 capability for more than one debugging format.
5298 @item -gsplit-dwarf
5299 @opindex gsplit-dwarf
5300 Separate as much dwarf debugging information as possible into a
5301 separate output file with the extension .dwo.  This option allows
5302 the build system to avoid linking files with debug information.  To
5303 be useful, this option requires a debugger capable of reading .dwo
5304 files.
5306 @item -ggdb
5307 @opindex ggdb
5308 Produce debugging information for use by GDB@.  This means to use the
5309 most expressive format available (DWARF 2, stabs, or the native format
5310 if neither of those are supported), including GDB extensions if at all
5311 possible.
5313 @item -gpubnames
5314 @opindex gpubnames
5315 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5317 @item -ggnu-pubnames
5318 @opindex ggnu-pubnames
5319 Generate .debug_pubnames and .debug_pubtypes sections in a format
5320 suitable for conversion into a GDB@ index.  This option is only useful
5321 with a linker that can produce GDB@ index version 7.
5323 @item -gstabs
5324 @opindex gstabs
5325 Produce debugging information in stabs format (if that is supported),
5326 without GDB extensions.  This is the format used by DBX on most BSD
5327 systems.  On MIPS, Alpha and System V Release 4 systems this option
5328 produces stabs debugging output that is not understood by DBX or SDB@.
5329 On System V Release 4 systems this option requires the GNU assembler.
5331 @item -feliminate-unused-debug-symbols
5332 @opindex feliminate-unused-debug-symbols
5333 Produce debugging information in stabs format (if that is supported),
5334 for only symbols that are actually used.
5336 @item -femit-class-debug-always
5337 Instead of emitting debugging information for a C++ class in only one
5338 object file, emit it in all object files using the class.  This option
5339 should be used only with debuggers that are unable to handle the way GCC
5340 normally emits debugging information for classes because using this
5341 option increases the size of debugging information by as much as a
5342 factor of two.
5344 @item -fdebug-types-section
5345 @opindex fdebug-types-section
5346 @opindex fno-debug-types-section
5347 When using DWARF Version 4 or higher, type DIEs can be put into
5348 their own @code{.debug_types} section instead of making them part of the
5349 @code{.debug_info} section.  It is more efficient to put them in a separate
5350 comdat sections since the linker can then remove duplicates.
5351 But not all DWARF consumers support @code{.debug_types} sections yet
5352 and on some objects @code{.debug_types} produces larger instead of smaller
5353 debugging information.
5355 @item -gstabs+
5356 @opindex gstabs+
5357 Produce debugging information in stabs format (if that is supported),
5358 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5359 use of these extensions is likely to make other debuggers crash or
5360 refuse to read the program.
5362 @item -gcoff
5363 @opindex gcoff
5364 Produce debugging information in COFF format (if that is supported).
5365 This is the format used by SDB on most System V systems prior to
5366 System V Release 4.
5368 @item -gxcoff
5369 @opindex gxcoff
5370 Produce debugging information in XCOFF format (if that is supported).
5371 This is the format used by the DBX debugger on IBM RS/6000 systems.
5373 @item -gxcoff+
5374 @opindex gxcoff+
5375 Produce debugging information in XCOFF format (if that is supported),
5376 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5377 use of these extensions is likely to make other debuggers crash or
5378 refuse to read the program, and may cause assemblers other than the GNU
5379 assembler (GAS) to fail with an error.
5381 @item -gdwarf-@var{version}
5382 @opindex gdwarf-@var{version}
5383 Produce debugging information in DWARF format (if that is supported).
5384 The value of @var{version} may be either 2, 3 or 4; the default version
5385 for most targets is 4.
5387 Note that with DWARF Version 2, some ports require and always
5388 use some non-conflicting DWARF 3 extensions in the unwind tables.
5390 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5391 for maximum benefit.
5393 @item -grecord-gcc-switches
5394 @opindex grecord-gcc-switches
5395 This switch causes the command-line options used to invoke the
5396 compiler that may affect code generation to be appended to the
5397 DW_AT_producer attribute in DWARF debugging information.  The options
5398 are concatenated with spaces separating them from each other and from
5399 the compiler version.  See also @option{-frecord-gcc-switches} for another
5400 way of storing compiler options into the object file.  This is the default.
5402 @item -gno-record-gcc-switches
5403 @opindex gno-record-gcc-switches
5404 Disallow appending command-line options to the DW_AT_producer attribute
5405 in DWARF debugging information.
5407 @item -gstrict-dwarf
5408 @opindex gstrict-dwarf
5409 Disallow using extensions of later DWARF standard version than selected
5410 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5411 DWARF extensions from later standard versions is allowed.
5413 @item -gno-strict-dwarf
5414 @opindex gno-strict-dwarf
5415 Allow using extensions of later DWARF standard version than selected with
5416 @option{-gdwarf-@var{version}}.
5418 @item -gz@r{[}=@var{type}@r{]}
5419 @opindex gz
5420 Produce compressed debug sections in DWARF format, if that is supported.
5421 If @var{type} is not given, the default type depends on the capabilities
5422 of the assembler and linker used.  @var{type} may be one of
5423 @option{none} (don't compress debug sections), @option{zlib} (use zlib
5424 compression in ELF gABI format), or @option{zlib-gnu} (use zlib
5425 compression in traditional GNU format).  If the linker doesn't support
5426 writing compressed debug sections, the option is rejected.  Otherwise,
5427 if the assembler does not support them, @option{-gz} is silently ignored
5428 when producing object files.
5430 @item -gvms
5431 @opindex gvms
5432 Produce debugging information in Alpha/VMS debug format (if that is
5433 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5435 @item -g@var{level}
5436 @itemx -ggdb@var{level}
5437 @itemx -gstabs@var{level}
5438 @itemx -gcoff@var{level}
5439 @itemx -gxcoff@var{level}
5440 @itemx -gvms@var{level}
5441 Request debugging information and also use @var{level} to specify how
5442 much information.  The default level is 2.
5444 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5445 @option{-g}.
5447 Level 1 produces minimal information, enough for making backtraces in
5448 parts of the program that you don't plan to debug.  This includes
5449 descriptions of functions and external variables, and line number
5450 tables, but no information about local variables.
5452 Level 3 includes extra information, such as all the macro definitions
5453 present in the program.  Some debuggers support macro expansion when
5454 you use @option{-g3}.
5456 @option{-gdwarf-2} does not accept a concatenated debug level, because
5457 GCC used to support an option @option{-gdwarf} that meant to generate
5458 debug information in version 1 of the DWARF format (which is very
5459 different from version 2), and it would have been too confusing.  That
5460 debug format is long obsolete, but the option cannot be changed now.
5461 Instead use an additional @option{-g@var{level}} option to change the
5462 debug level for DWARF.
5464 @item -gtoggle
5465 @opindex gtoggle
5466 Turn off generation of debug info, if leaving out this option
5467 generates it, or turn it on at level 2 otherwise.  The position of this
5468 argument in the command line does not matter; it takes effect after all
5469 other options are processed, and it does so only once, no matter how
5470 many times it is given.  This is mainly intended to be used with
5471 @option{-fcompare-debug}.
5473 @item -fsanitize=address
5474 @opindex fsanitize=address
5475 Enable AddressSanitizer, a fast memory error detector.
5476 Memory access instructions will be instrumented to detect
5477 out-of-bounds and use-after-free bugs.
5478 See @uref{http://code.google.com/p/address-sanitizer/} for
5479 more details.  The run-time behavior can be influenced using the
5480 @env{ASAN_OPTIONS} environment variable; see
5481 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5482 a list of supported options.
5484 @item -fsanitize=kernel-address
5485 @opindex fsanitize=kernel-address
5486 Enable AddressSanitizer for Linux kernel.
5487 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5489 @item -fsanitize=thread
5490 @opindex fsanitize=thread
5491 Enable ThreadSanitizer, a fast data race detector.
5492 Memory access instructions will be instrumented to detect
5493 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5494 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5495 environment variable; see
5496 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5497 supported options.
5499 @item -fsanitize=leak
5500 @opindex fsanitize=leak
5501 Enable LeakSanitizer, a memory leak detector.
5502 This option only matters for linking of executables and if neither
5503 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5504 case it will link the executable against a library that overrides @code{malloc}
5505 and other allocator functions.  See
5506 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5507 details.  The run-time behavior can be influenced using the
5508 @env{LSAN_OPTIONS} environment variable.
5510 @item -fsanitize=undefined
5511 @opindex fsanitize=undefined
5512 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5513 Various computations will be instrumented to detect undefined behavior
5514 at runtime.  Current suboptions are:
5516 @table @gcctabopt
5518 @item -fsanitize=shift
5519 @opindex fsanitize=shift
5520 This option enables checking that the result of a shift operation is
5521 not undefined.  Note that what exactly is considered undefined differs
5522 slightly between C and C++, as well as between ISO C90 and C99, etc.
5524 @item -fsanitize=integer-divide-by-zero
5525 @opindex fsanitize=integer-divide-by-zero
5526 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5528 @item -fsanitize=unreachable
5529 @opindex fsanitize=unreachable
5530 With this option, the compiler will turn the @code{__builtin_unreachable}
5531 call into a diagnostics message call instead.  When reaching the
5532 @code{__builtin_unreachable} call, the behavior is undefined.
5534 @item -fsanitize=vla-bound
5535 @opindex fsanitize=vla-bound
5536 This option instructs the compiler to check that the size of a variable
5537 length array is positive.  This option does not have any effect in
5538 @option{-std=c++14} mode, as the standard requires the exception be thrown
5539 instead.
5541 @item -fsanitize=null
5542 @opindex fsanitize=null
5543 This option enables pointer checking.  Particularly, the application
5544 built with this option turned on will issue an error message when it
5545 tries to dereference a NULL pointer, or if a reference (possibly an
5546 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5547 on an object pointed by a NULL pointer.
5549 @item -fsanitize=return
5550 @opindex fsanitize=return
5551 This option enables return statement checking.  Programs
5552 built with this option turned on will issue an error message
5553 when the end of a non-void function is reached without actually
5554 returning a value.  This option works in C++ only.
5556 @item -fsanitize=signed-integer-overflow
5557 @opindex fsanitize=signed-integer-overflow
5558 This option enables signed integer overflow checking.  We check that
5559 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5560 does not overflow in the signed arithmetics.  Note, integer promotion
5561 rules must be taken into account.  That is, the following is not an
5562 overflow:
5563 @smallexample
5564 signed char a = SCHAR_MAX;
5565 a++;
5566 @end smallexample
5568 @item -fsanitize=bounds
5569 @opindex fsanitize=bounds
5570 This option enables instrumentation of array bounds.  Various out of bounds
5571 accesses are detected.  Flexible array members and initializers of variables
5572 with static storage are not instrumented.
5574 @item -fsanitize=alignment
5575 @opindex fsanitize=alignment
5577 This option enables checking of alignment of pointers when they are
5578 dereferenced, or when a reference is bound to insufficiently aligned target,
5579 or when a method or constructor is invoked on insufficiently aligned object.
5581 @item -fsanitize=object-size
5582 @opindex fsanitize=object-size
5583 This option enables instrumentation of memory references using the
5584 @code{__builtin_object_size} function.  Various out of bounds pointer
5585 accesses are detected.
5587 @item -fsanitize=float-divide-by-zero
5588 @opindex fsanitize=float-divide-by-zero
5589 Detect floating-point division by zero.  Unlike other similar options,
5590 @option{-fsanitize=float-divide-by-zero} is not enabled by
5591 @option{-fsanitize=undefined}, since floating-point division by zero can
5592 be a legitimate way of obtaining infinities and NaNs.
5594 @item -fsanitize=float-cast-overflow
5595 @opindex fsanitize=float-cast-overflow
5596 This option enables floating-point type to integer conversion checking.
5597 We check that the result of the conversion does not overflow.
5598 This option does not work well with @code{FE_INVALID} exceptions enabled.
5600 @item -fsanitize=nonnull-attribute
5601 @opindex fsanitize=nonnull-attribute
5603 This option enables instrumentation of calls, checking whether null values
5604 are not passed to arguments marked as requiring a non-null value by the
5605 @code{nonnull} function attribute.
5607 @item -fsanitize=returns-nonnull-attribute
5608 @opindex fsanitize=returns-nonnull-attribute
5610 This option enables instrumentation of return statements in functions
5611 marked with @code{returns_nonnull} function attribute, to detect returning
5612 of null values from such functions.
5614 @item -fsanitize=bool
5615 @opindex fsanitize=bool
5617 This option enables instrumentation of loads from bool.  If a value other
5618 than 0/1 is loaded, a run-time error is issued.
5620 @item -fsanitize=enum
5621 @opindex fsanitize=enum
5623 This option enables instrumentation of loads from an enum type.  If
5624 a value outside the range of values for the enum type is loaded,
5625 a run-time error is issued.
5627 @end table
5629 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5630 @option{-fsanitize=undefined} gives a diagnostic message.
5631 This currently works only for the C family of languages.
5633 @item -fsanitize-recover
5634 @opindex fsanitize-recover
5635 By default @option{-fsanitize=undefined} sanitization (and its suboptions
5636 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return})
5637 after reporting undefined behavior attempts to continue running the
5638 program as if no undefined behavior happened.  This means multiple undefined
5639 behavior runtime errors can be reported in a single program run, and the exit
5640 code of the program may indicate success even when undefined behavior
5641 has been reported.  The @option{-fno-sanitize-recover} can be used to alter
5642 this behavior, only the first detected undefined behavior will be reported
5643 and program will exit after that with non-zero exit code.
5645 @item -fsanitize-undefined-trap-on-error
5646 @opindex fsanitize-undefined-trap-on-error
5647 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5648 report undefined behavior using @code{__builtin_trap ()} rather than
5649 a @code{libubsan} library routine.  The advantage of this is that the
5650 @code{libubsan} library is not needed and will not be linked in, so this
5651 is usable even for use in freestanding environments.
5653 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5654 @opindex fdump-final-insns
5655 Dump the final internal representation (RTL) to @var{file}.  If the
5656 optional argument is omitted (or if @var{file} is @code{.}), the name
5657 of the dump file is determined by appending @code{.gkd} to the
5658 compilation output file name.
5660 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5661 @opindex fcompare-debug
5662 @opindex fno-compare-debug
5663 If no error occurs during compilation, run the compiler a second time,
5664 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5665 passed to the second compilation.  Dump the final internal
5666 representation in both compilations, and print an error if they differ.
5668 If the equal sign is omitted, the default @option{-gtoggle} is used.
5670 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5671 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5672 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5673 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5674 is used.
5676 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5677 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5678 of the final representation and the second compilation, preventing even
5679 @env{GCC_COMPARE_DEBUG} from taking effect.
5681 To verify full coverage during @option{-fcompare-debug} testing, set
5682 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5683 which GCC rejects as an invalid option in any actual compilation
5684 (rather than preprocessing, assembly or linking).  To get just a
5685 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5686 not overridden} will do.
5688 @item -fcompare-debug-second
5689 @opindex fcompare-debug-second
5690 This option is implicitly passed to the compiler for the second
5691 compilation requested by @option{-fcompare-debug}, along with options to
5692 silence warnings, and omitting other options that would cause
5693 side-effect compiler outputs to files or to the standard output.  Dump
5694 files and preserved temporary files are renamed so as to contain the
5695 @code{.gk} additional extension during the second compilation, to avoid
5696 overwriting those generated by the first.
5698 When this option is passed to the compiler driver, it causes the
5699 @emph{first} compilation to be skipped, which makes it useful for little
5700 other than debugging the compiler proper.
5702 @item -feliminate-dwarf2-dups
5703 @opindex feliminate-dwarf2-dups
5704 Compress DWARF 2 debugging information by eliminating duplicated
5705 information about each symbol.  This option only makes sense when
5706 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5708 @item -femit-struct-debug-baseonly
5709 @opindex femit-struct-debug-baseonly
5710 Emit debug information for struct-like types
5711 only when the base name of the compilation source file
5712 matches the base name of file in which the struct is defined.
5714 This option substantially reduces the size of debugging information,
5715 but at significant potential loss in type information to the debugger.
5716 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5717 See @option{-femit-struct-debug-detailed} for more detailed control.
5719 This option works only with DWARF 2.
5721 @item -femit-struct-debug-reduced
5722 @opindex femit-struct-debug-reduced
5723 Emit debug information for struct-like types
5724 only when the base name of the compilation source file
5725 matches the base name of file in which the type is defined,
5726 unless the struct is a template or defined in a system header.
5728 This option significantly reduces the size of debugging information,
5729 with some potential loss in type information to the debugger.
5730 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5731 See @option{-femit-struct-debug-detailed} for more detailed control.
5733 This option works only with DWARF 2.
5735 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5736 Specify the struct-like types
5737 for which the compiler generates debug information.
5738 The intent is to reduce duplicate struct debug information
5739 between different object files within the same program.
5741 This option is a detailed version of
5742 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5743 which serves for most needs.
5745 A specification has the syntax@*
5746 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5748 The optional first word limits the specification to
5749 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5750 A struct type is used directly when it is the type of a variable, member.
5751 Indirect uses arise through pointers to structs.
5752 That is, when use of an incomplete struct is valid, the use is indirect.
5753 An example is
5754 @samp{struct one direct; struct two * indirect;}.
5756 The optional second word limits the specification to
5757 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5758 Generic structs are a bit complicated to explain.
5759 For C++, these are non-explicit specializations of template classes,
5760 or non-template classes within the above.
5761 Other programming languages have generics,
5762 but @option{-femit-struct-debug-detailed} does not yet implement them.
5764 The third word specifies the source files for those
5765 structs for which the compiler should emit debug information.
5766 The values @samp{none} and @samp{any} have the normal meaning.
5767 The value @samp{base} means that
5768 the base of name of the file in which the type declaration appears
5769 must match the base of the name of the main compilation file.
5770 In practice, this means that when compiling @file{foo.c}, debug information
5771 is generated for types declared in that file and @file{foo.h},
5772 but not other header files.
5773 The value @samp{sys} means those types satisfying @samp{base}
5774 or declared in system or compiler headers.
5776 You may need to experiment to determine the best settings for your application.
5778 The default is @option{-femit-struct-debug-detailed=all}.
5780 This option works only with DWARF 2.
5782 @item -fno-merge-debug-strings
5783 @opindex fmerge-debug-strings
5784 @opindex fno-merge-debug-strings
5785 Direct the linker to not merge together strings in the debugging
5786 information that are identical in different object files.  Merging is
5787 not supported by all assemblers or linkers.  Merging decreases the size
5788 of the debug information in the output file at the cost of increasing
5789 link processing time.  Merging is enabled by default.
5791 @item -fdebug-prefix-map=@var{old}=@var{new}
5792 @opindex fdebug-prefix-map
5793 When compiling files in directory @file{@var{old}}, record debugging
5794 information describing them as in @file{@var{new}} instead.
5796 @item -fno-dwarf2-cfi-asm
5797 @opindex fdwarf2-cfi-asm
5798 @opindex fno-dwarf2-cfi-asm
5799 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5800 instead of using GAS @code{.cfi_*} directives.
5802 @cindex @command{prof}
5803 @item -p
5804 @opindex p
5805 Generate extra code to write profile information suitable for the
5806 analysis program @command{prof}.  You must use this option when compiling
5807 the source files you want data about, and you must also use it when
5808 linking.
5810 @cindex @command{gprof}
5811 @item -pg
5812 @opindex pg
5813 Generate extra code to write profile information suitable for the
5814 analysis program @command{gprof}.  You must use this option when compiling
5815 the source files you want data about, and you must also use it when
5816 linking.
5818 @item -Q
5819 @opindex Q
5820 Makes the compiler print out each function name as it is compiled, and
5821 print some statistics about each pass when it finishes.
5823 @item -ftime-report
5824 @opindex ftime-report
5825 Makes the compiler print some statistics about the time consumed by each
5826 pass when it finishes.
5828 @item -fmem-report
5829 @opindex fmem-report
5830 Makes the compiler print some statistics about permanent memory
5831 allocation when it finishes.
5833 @item -fmem-report-wpa
5834 @opindex fmem-report-wpa
5835 Makes the compiler print some statistics about permanent memory
5836 allocation for the WPA phase only.
5838 @item -fpre-ipa-mem-report
5839 @opindex fpre-ipa-mem-report
5840 @item -fpost-ipa-mem-report
5841 @opindex fpost-ipa-mem-report
5842 Makes the compiler print some statistics about permanent memory
5843 allocation before or after interprocedural optimization.
5845 @item -fprofile-report
5846 @opindex fprofile-report
5847 Makes the compiler print some statistics about consistency of the
5848 (estimated) profile and effect of individual passes.
5850 @item -fstack-usage
5851 @opindex fstack-usage
5852 Makes the compiler output stack usage information for the program, on a
5853 per-function basis.  The filename for the dump is made by appending
5854 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5855 the output file, if explicitly specified and it is not an executable,
5856 otherwise it is the basename of the source file.  An entry is made up
5857 of three fields:
5859 @itemize
5860 @item
5861 The name of the function.
5862 @item
5863 A number of bytes.
5864 @item
5865 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5866 @end itemize
5868 The qualifier @code{static} means that the function manipulates the stack
5869 statically: a fixed number of bytes are allocated for the frame on function
5870 entry and released on function exit; no stack adjustments are otherwise made
5871 in the function.  The second field is this fixed number of bytes.
5873 The qualifier @code{dynamic} means that the function manipulates the stack
5874 dynamically: in addition to the static allocation described above, stack
5875 adjustments are made in the body of the function, for example to push/pop
5876 arguments around function calls.  If the qualifier @code{bounded} is also
5877 present, the amount of these adjustments is bounded at compile time and
5878 the second field is an upper bound of the total amount of stack used by
5879 the function.  If it is not present, the amount of these adjustments is
5880 not bounded at compile time and the second field only represents the
5881 bounded part.
5883 @item -fprofile-arcs
5884 @opindex fprofile-arcs
5885 Add code so that program flow @dfn{arcs} are instrumented.  During
5886 execution the program records how many times each branch and call is
5887 executed and how many times it is taken or returns.  When the compiled
5888 program exits it saves this data to a file called
5889 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5890 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5891 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5892 @var{auxname} is generated from the name of the output file, if
5893 explicitly specified and it is not the final executable, otherwise it is
5894 the basename of the source file.  In both cases any suffix is removed
5895 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5896 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5897 @xref{Cross-profiling}.
5899 @cindex @command{gcov}
5900 @item --coverage
5901 @opindex coverage
5903 This option is used to compile and link code instrumented for coverage
5904 analysis.  The option is a synonym for @option{-fprofile-arcs}
5905 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5906 linking).  See the documentation for those options for more details.
5908 @itemize
5910 @item
5911 Compile the source files with @option{-fprofile-arcs} plus optimization
5912 and code generation options.  For test coverage analysis, use the
5913 additional @option{-ftest-coverage} option.  You do not need to profile
5914 every source file in a program.
5916 @item
5917 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5918 (the latter implies the former).
5920 @item
5921 Run the program on a representative workload to generate the arc profile
5922 information.  This may be repeated any number of times.  You can run
5923 concurrent instances of your program, and provided that the file system
5924 supports locking, the data files will be correctly updated.  Also
5925 @code{fork} calls are detected and correctly handled (double counting
5926 will not happen).
5928 @item
5929 For profile-directed optimizations, compile the source files again with
5930 the same optimization and code generation options plus
5931 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5932 Control Optimization}).
5934 @item
5935 For test coverage analysis, use @command{gcov} to produce human readable
5936 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5937 @command{gcov} documentation for further information.
5939 @end itemize
5941 With @option{-fprofile-arcs}, for each function of your program GCC
5942 creates a program flow graph, then finds a spanning tree for the graph.
5943 Only arcs that are not on the spanning tree have to be instrumented: the
5944 compiler adds code to count the number of times that these arcs are
5945 executed.  When an arc is the only exit or only entrance to a block, the
5946 instrumentation code can be added to the block; otherwise, a new basic
5947 block must be created to hold the instrumentation code.
5949 @need 2000
5950 @item -ftest-coverage
5951 @opindex ftest-coverage
5952 Produce a notes file that the @command{gcov} code-coverage utility
5953 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5954 show program coverage.  Each source file's note file is called
5955 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5956 above for a description of @var{auxname} and instructions on how to
5957 generate test coverage data.  Coverage data matches the source files
5958 more closely if you do not optimize.
5960 @item -fdbg-cnt-list
5961 @opindex fdbg-cnt-list
5962 Print the name and the counter upper bound for all debug counters.
5965 @item -fdbg-cnt=@var{counter-value-list}
5966 @opindex fdbg-cnt
5967 Set the internal debug counter upper bound.  @var{counter-value-list}
5968 is a comma-separated list of @var{name}:@var{value} pairs
5969 which sets the upper bound of each debug counter @var{name} to @var{value}.
5970 All debug counters have the initial upper bound of @code{UINT_MAX};
5971 thus @code{dbg_cnt()} returns true always unless the upper bound
5972 is set by this option.
5973 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5974 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5976 @item -fenable-@var{kind}-@var{pass}
5977 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5978 @opindex fdisable-
5979 @opindex fenable-
5981 This is a set of options that are used to explicitly disable/enable
5982 optimization passes.  These options are intended for use for debugging GCC.
5983 Compiler users should use regular options for enabling/disabling
5984 passes instead.
5986 @table @gcctabopt
5988 @item -fdisable-ipa-@var{pass}
5989 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5990 statically invoked in the compiler multiple times, the pass name should be
5991 appended with a sequential number starting from 1.
5993 @item -fdisable-rtl-@var{pass}
5994 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5995 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5996 statically invoked in the compiler multiple times, the pass name should be
5997 appended with a sequential number starting from 1.  @var{range-list} is a 
5998 comma-separated list of function ranges or assembler names.  Each range is a number
5999 pair separated by a colon.  The range is inclusive in both ends.  If the range
6000 is trivial, the number pair can be simplified as a single number.  If the
6001 function's call graph node's @var{uid} falls within one of the specified ranges,
6002 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6003 function header of a dump file, and the pass names can be dumped by using
6004 option @option{-fdump-passes}.
6006 @item -fdisable-tree-@var{pass}
6007 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6008 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6009 option arguments.
6011 @item -fenable-ipa-@var{pass}
6012 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6013 statically invoked in the compiler multiple times, the pass name should be
6014 appended with a sequential number starting from 1.
6016 @item -fenable-rtl-@var{pass}
6017 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6018 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6019 description and examples.
6021 @item -fenable-tree-@var{pass}
6022 @itemx -fenable-tree-@var{pass}=@var{range-list}
6023 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6024 of option arguments.
6026 @end table
6028 Here are some examples showing uses of these options.
6030 @smallexample
6032 # disable ccp1 for all functions
6033    -fdisable-tree-ccp1
6034 # disable complete unroll for function whose cgraph node uid is 1
6035    -fenable-tree-cunroll=1
6036 # disable gcse2 for functions at the following ranges [1,1],
6037 # [300,400], and [400,1000]
6038 # disable gcse2 for functions foo and foo2
6039    -fdisable-rtl-gcse2=foo,foo2
6040 # disable early inlining
6041    -fdisable-tree-einline
6042 # disable ipa inlining
6043    -fdisable-ipa-inline
6044 # enable tree full unroll
6045    -fenable-tree-unroll
6047 @end smallexample
6049 @item -d@var{letters}
6050 @itemx -fdump-rtl-@var{pass}
6051 @itemx -fdump-rtl-@var{pass}=@var{filename}
6052 @opindex d
6053 @opindex fdump-rtl-@var{pass}
6054 Says to make debugging dumps during compilation at times specified by
6055 @var{letters}.  This is used for debugging the RTL-based passes of the
6056 compiler.  The file names for most of the dumps are made by appending
6057 a pass number and a word to the @var{dumpname}, and the files are
6058 created in the directory of the output file. In case of
6059 @option{=@var{filename}} option, the dump is output on the given file
6060 instead of the pass numbered dump files. Note that the pass number is
6061 computed statically as passes get registered into the pass manager.
6062 Thus the numbering is not related to the dynamic order of execution of
6063 passes.  In particular, a pass installed by a plugin could have a
6064 number over 200 even if it executed quite early.  @var{dumpname} is
6065 generated from the name of the output file, if explicitly specified
6066 and it is not an executable, otherwise it is the basename of the
6067 source file. These switches may have different effects when
6068 @option{-E} is used for preprocessing.
6070 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6071 @option{-d} option @var{letters}.  Here are the possible
6072 letters for use in @var{pass} and @var{letters}, and their meanings:
6074 @table @gcctabopt
6076 @item -fdump-rtl-alignments
6077 @opindex fdump-rtl-alignments
6078 Dump after branch alignments have been computed.
6080 @item -fdump-rtl-asmcons
6081 @opindex fdump-rtl-asmcons
6082 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6084 @item -fdump-rtl-auto_inc_dec
6085 @opindex fdump-rtl-auto_inc_dec
6086 Dump after auto-inc-dec discovery.  This pass is only run on
6087 architectures that have auto inc or auto dec instructions.
6089 @item -fdump-rtl-barriers
6090 @opindex fdump-rtl-barriers
6091 Dump after cleaning up the barrier instructions.
6093 @item -fdump-rtl-bbpart
6094 @opindex fdump-rtl-bbpart
6095 Dump after partitioning hot and cold basic blocks.
6097 @item -fdump-rtl-bbro
6098 @opindex fdump-rtl-bbro
6099 Dump after block reordering.
6101 @item -fdump-rtl-btl1
6102 @itemx -fdump-rtl-btl2
6103 @opindex fdump-rtl-btl2
6104 @opindex fdump-rtl-btl2
6105 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6106 after the two branch
6107 target load optimization passes.
6109 @item -fdump-rtl-bypass
6110 @opindex fdump-rtl-bypass
6111 Dump after jump bypassing and control flow optimizations.
6113 @item -fdump-rtl-combine
6114 @opindex fdump-rtl-combine
6115 Dump after the RTL instruction combination pass.
6117 @item -fdump-rtl-compgotos
6118 @opindex fdump-rtl-compgotos
6119 Dump after duplicating the computed gotos.
6121 @item -fdump-rtl-ce1
6122 @itemx -fdump-rtl-ce2
6123 @itemx -fdump-rtl-ce3
6124 @opindex fdump-rtl-ce1
6125 @opindex fdump-rtl-ce2
6126 @opindex fdump-rtl-ce3
6127 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6128 @option{-fdump-rtl-ce3} enable dumping after the three
6129 if conversion passes.
6131 @item -fdump-rtl-cprop_hardreg
6132 @opindex fdump-rtl-cprop_hardreg
6133 Dump after hard register copy propagation.
6135 @item -fdump-rtl-csa
6136 @opindex fdump-rtl-csa
6137 Dump after combining stack adjustments.
6139 @item -fdump-rtl-cse1
6140 @itemx -fdump-rtl-cse2
6141 @opindex fdump-rtl-cse1
6142 @opindex fdump-rtl-cse2
6143 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6144 the two common subexpression elimination passes.
6146 @item -fdump-rtl-dce
6147 @opindex fdump-rtl-dce
6148 Dump after the standalone dead code elimination passes.
6150 @item -fdump-rtl-dbr
6151 @opindex fdump-rtl-dbr
6152 Dump after delayed branch scheduling.
6154 @item -fdump-rtl-dce1
6155 @itemx -fdump-rtl-dce2
6156 @opindex fdump-rtl-dce1
6157 @opindex fdump-rtl-dce2
6158 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6159 the two dead store elimination passes.
6161 @item -fdump-rtl-eh
6162 @opindex fdump-rtl-eh
6163 Dump after finalization of EH handling code.
6165 @item -fdump-rtl-eh_ranges
6166 @opindex fdump-rtl-eh_ranges
6167 Dump after conversion of EH handling range regions.
6169 @item -fdump-rtl-expand
6170 @opindex fdump-rtl-expand
6171 Dump after RTL generation.
6173 @item -fdump-rtl-fwprop1
6174 @itemx -fdump-rtl-fwprop2
6175 @opindex fdump-rtl-fwprop1
6176 @opindex fdump-rtl-fwprop2
6177 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6178 dumping after the two forward propagation passes.
6180 @item -fdump-rtl-gcse1
6181 @itemx -fdump-rtl-gcse2
6182 @opindex fdump-rtl-gcse1
6183 @opindex fdump-rtl-gcse2
6184 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6185 after global common subexpression elimination.
6187 @item -fdump-rtl-init-regs
6188 @opindex fdump-rtl-init-regs
6189 Dump after the initialization of the registers.
6191 @item -fdump-rtl-initvals
6192 @opindex fdump-rtl-initvals
6193 Dump after the computation of the initial value sets.
6195 @item -fdump-rtl-into_cfglayout
6196 @opindex fdump-rtl-into_cfglayout
6197 Dump after converting to cfglayout mode.
6199 @item -fdump-rtl-ira
6200 @opindex fdump-rtl-ira
6201 Dump after iterated register allocation.
6203 @item -fdump-rtl-jump
6204 @opindex fdump-rtl-jump
6205 Dump after the second jump optimization.
6207 @item -fdump-rtl-loop2
6208 @opindex fdump-rtl-loop2
6209 @option{-fdump-rtl-loop2} enables dumping after the rtl
6210 loop optimization passes.
6212 @item -fdump-rtl-mach
6213 @opindex fdump-rtl-mach
6214 Dump after performing the machine dependent reorganization pass, if that
6215 pass exists.
6217 @item -fdump-rtl-mode_sw
6218 @opindex fdump-rtl-mode_sw
6219 Dump after removing redundant mode switches.
6221 @item -fdump-rtl-rnreg
6222 @opindex fdump-rtl-rnreg
6223 Dump after register renumbering.
6225 @item -fdump-rtl-outof_cfglayout
6226 @opindex fdump-rtl-outof_cfglayout
6227 Dump after converting from cfglayout mode.
6229 @item -fdump-rtl-peephole2
6230 @opindex fdump-rtl-peephole2
6231 Dump after the peephole pass.
6233 @item -fdump-rtl-postreload
6234 @opindex fdump-rtl-postreload
6235 Dump after post-reload optimizations.
6237 @item -fdump-rtl-pro_and_epilogue
6238 @opindex fdump-rtl-pro_and_epilogue
6239 Dump after generating the function prologues and epilogues.
6241 @item -fdump-rtl-sched1
6242 @itemx -fdump-rtl-sched2
6243 @opindex fdump-rtl-sched1
6244 @opindex fdump-rtl-sched2
6245 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6246 after the basic block scheduling passes.
6248 @item -fdump-rtl-ree
6249 @opindex fdump-rtl-ree
6250 Dump after sign/zero extension elimination.
6252 @item -fdump-rtl-seqabstr
6253 @opindex fdump-rtl-seqabstr
6254 Dump after common sequence discovery.
6256 @item -fdump-rtl-shorten
6257 @opindex fdump-rtl-shorten
6258 Dump after shortening branches.
6260 @item -fdump-rtl-sibling
6261 @opindex fdump-rtl-sibling
6262 Dump after sibling call optimizations.
6264 @item -fdump-rtl-split1
6265 @itemx -fdump-rtl-split2
6266 @itemx -fdump-rtl-split3
6267 @itemx -fdump-rtl-split4
6268 @itemx -fdump-rtl-split5
6269 @opindex fdump-rtl-split1
6270 @opindex fdump-rtl-split2
6271 @opindex fdump-rtl-split3
6272 @opindex fdump-rtl-split4
6273 @opindex fdump-rtl-split5
6274 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6275 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6276 @option{-fdump-rtl-split5} enable dumping after five rounds of
6277 instruction splitting.
6279 @item -fdump-rtl-sms
6280 @opindex fdump-rtl-sms
6281 Dump after modulo scheduling.  This pass is only run on some
6282 architectures.
6284 @item -fdump-rtl-stack
6285 @opindex fdump-rtl-stack
6286 Dump after conversion from GCC's ``flat register file'' registers to the
6287 x87's stack-like registers.  This pass is only run on x86 variants.
6289 @item -fdump-rtl-subreg1
6290 @itemx -fdump-rtl-subreg2
6291 @opindex fdump-rtl-subreg1
6292 @opindex fdump-rtl-subreg2
6293 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6294 the two subreg expansion passes.
6296 @item -fdump-rtl-unshare
6297 @opindex fdump-rtl-unshare
6298 Dump after all rtl has been unshared.
6300 @item -fdump-rtl-vartrack
6301 @opindex fdump-rtl-vartrack
6302 Dump after variable tracking.
6304 @item -fdump-rtl-vregs
6305 @opindex fdump-rtl-vregs
6306 Dump after converting virtual registers to hard registers.
6308 @item -fdump-rtl-web
6309 @opindex fdump-rtl-web
6310 Dump after live range splitting.
6312 @item -fdump-rtl-regclass
6313 @itemx -fdump-rtl-subregs_of_mode_init
6314 @itemx -fdump-rtl-subregs_of_mode_finish
6315 @itemx -fdump-rtl-dfinit
6316 @itemx -fdump-rtl-dfinish
6317 @opindex fdump-rtl-regclass
6318 @opindex fdump-rtl-subregs_of_mode_init
6319 @opindex fdump-rtl-subregs_of_mode_finish
6320 @opindex fdump-rtl-dfinit
6321 @opindex fdump-rtl-dfinish
6322 These dumps are defined but always produce empty files.
6324 @item -da
6325 @itemx -fdump-rtl-all
6326 @opindex da
6327 @opindex fdump-rtl-all
6328 Produce all the dumps listed above.
6330 @item -dA
6331 @opindex dA
6332 Annotate the assembler output with miscellaneous debugging information.
6334 @item -dD
6335 @opindex dD
6336 Dump all macro definitions, at the end of preprocessing, in addition to
6337 normal output.
6339 @item -dH
6340 @opindex dH
6341 Produce a core dump whenever an error occurs.
6343 @item -dp
6344 @opindex dp
6345 Annotate the assembler output with a comment indicating which
6346 pattern and alternative is used.  The length of each instruction is
6347 also printed.
6349 @item -dP
6350 @opindex dP
6351 Dump the RTL in the assembler output as a comment before each instruction.
6352 Also turns on @option{-dp} annotation.
6354 @item -dx
6355 @opindex dx
6356 Just generate RTL for a function instead of compiling it.  Usually used
6357 with @option{-fdump-rtl-expand}.
6358 @end table
6360 @item -fdump-noaddr
6361 @opindex fdump-noaddr
6362 When doing debugging dumps, suppress address output.  This makes it more
6363 feasible to use diff on debugging dumps for compiler invocations with
6364 different compiler binaries and/or different
6365 text / bss / data / heap / stack / dso start locations.
6367 @item -freport-bug
6368 @opindex freport-bug
6369 Collect and dump debug information into temporary file if ICE in C/C++
6370 compiler occured.
6372 @item -fdump-unnumbered
6373 @opindex fdump-unnumbered
6374 When doing debugging dumps, suppress instruction numbers and address output.
6375 This makes it more feasible to use diff on debugging dumps for compiler
6376 invocations with different options, in particular with and without
6377 @option{-g}.
6379 @item -fdump-unnumbered-links
6380 @opindex fdump-unnumbered-links
6381 When doing debugging dumps (see @option{-d} option above), suppress
6382 instruction numbers for the links to the previous and next instructions
6383 in a sequence.
6385 @item -fdump-translation-unit @r{(C++ only)}
6386 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6387 @opindex fdump-translation-unit
6388 Dump a representation of the tree structure for the entire translation
6389 unit to a file.  The file name is made by appending @file{.tu} to the
6390 source file name, and the file is created in the same directory as the
6391 output file.  If the @samp{-@var{options}} form is used, @var{options}
6392 controls the details of the dump as described for the
6393 @option{-fdump-tree} options.
6395 @item -fdump-class-hierarchy @r{(C++ only)}
6396 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6397 @opindex fdump-class-hierarchy
6398 Dump a representation of each class's hierarchy and virtual function
6399 table layout to a file.  The file name is made by appending
6400 @file{.class} to the source file name, and the file is created in the
6401 same directory as the output file.  If the @samp{-@var{options}} form
6402 is used, @var{options} controls the details of the dump as described
6403 for the @option{-fdump-tree} options.
6405 @item -fdump-ipa-@var{switch}
6406 @opindex fdump-ipa
6407 Control the dumping at various stages of inter-procedural analysis
6408 language tree to a file.  The file name is generated by appending a
6409 switch specific suffix to the source file name, and the file is created
6410 in the same directory as the output file.  The following dumps are
6411 possible:
6413 @table @samp
6414 @item all
6415 Enables all inter-procedural analysis dumps.
6417 @item cgraph
6418 Dumps information about call-graph optimization, unused function removal,
6419 and inlining decisions.
6421 @item inline
6422 Dump after function inlining.
6424 @end table
6426 @item -fdump-passes
6427 @opindex fdump-passes
6428 Dump the list of optimization passes that are turned on and off by
6429 the current command-line options.
6431 @item -fdump-statistics-@var{option}
6432 @opindex fdump-statistics
6433 Enable and control dumping of pass statistics in a separate file.  The
6434 file name is generated by appending a suffix ending in
6435 @samp{.statistics} to the source file name, and the file is created in
6436 the same directory as the output file.  If the @samp{-@var{option}}
6437 form is used, @samp{-stats} causes counters to be summed over the
6438 whole compilation unit while @samp{-details} dumps every event as
6439 the passes generate them.  The default with no option is to sum
6440 counters for each function compiled.
6442 @item -fdump-tree-@var{switch}
6443 @itemx -fdump-tree-@var{switch}-@var{options}
6444 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6445 @opindex fdump-tree
6446 Control the dumping at various stages of processing the intermediate
6447 language tree to a file.  The file name is generated by appending a
6448 switch-specific suffix to the source file name, and the file is
6449 created in the same directory as the output file. In case of
6450 @option{=@var{filename}} option, the dump is output on the given file
6451 instead of the auto named dump files.  If the @samp{-@var{options}}
6452 form is used, @var{options} is a list of @samp{-} separated options
6453 which control the details of the dump.  Not all options are applicable
6454 to all dumps; those that are not meaningful are ignored.  The
6455 following options are available
6457 @table @samp
6458 @item address
6459 Print the address of each node.  Usually this is not meaningful as it
6460 changes according to the environment and source file.  Its primary use
6461 is for tying up a dump file with a debug environment.
6462 @item asmname
6463 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6464 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6465 use working backward from mangled names in the assembly file.
6466 @item slim
6467 When dumping front-end intermediate representations, inhibit dumping
6468 of members of a scope or body of a function merely because that scope
6469 has been reached.  Only dump such items when they are directly reachable
6470 by some other path.
6472 When dumping pretty-printed trees, this option inhibits dumping the
6473 bodies of control structures.
6475 When dumping RTL, print the RTL in slim (condensed) form instead of
6476 the default LISP-like representation.
6477 @item raw
6478 Print a raw representation of the tree.  By default, trees are
6479 pretty-printed into a C-like representation.
6480 @item details
6481 Enable more detailed dumps (not honored by every dump option). Also
6482 include information from the optimization passes.
6483 @item stats
6484 Enable dumping various statistics about the pass (not honored by every dump
6485 option).
6486 @item blocks
6487 Enable showing basic block boundaries (disabled in raw dumps).
6488 @item graph
6489 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6490 dump a representation of the control flow graph suitable for viewing with
6491 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6492 the file is pretty-printed as a subgraph, so that GraphViz can render them
6493 all in a single plot.
6495 This option currently only works for RTL dumps, and the RTL is always
6496 dumped in slim form.
6497 @item vops
6498 Enable showing virtual operands for every statement.
6499 @item lineno
6500 Enable showing line numbers for statements.
6501 @item uid
6502 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6503 @item verbose
6504 Enable showing the tree dump for each statement.
6505 @item eh
6506 Enable showing the EH region number holding each statement.
6507 @item scev
6508 Enable showing scalar evolution analysis details.
6509 @item optimized
6510 Enable showing optimization information (only available in certain
6511 passes).
6512 @item missed
6513 Enable showing missed optimization information (only available in certain
6514 passes).
6515 @item note
6516 Enable other detailed optimization information (only available in
6517 certain passes).
6518 @item =@var{filename}
6519 Instead of an auto named dump file, output into the given file
6520 name. The file names @file{stdout} and @file{stderr} are treated
6521 specially and are considered already open standard streams. For
6522 example,
6524 @smallexample
6525 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6526      -fdump-tree-pre=stderr file.c
6527 @end smallexample
6529 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6530 output on to @file{stderr}. If two conflicting dump filenames are
6531 given for the same pass, then the latter option overrides the earlier
6532 one.
6534 @item all
6535 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6536 and @option{lineno}.
6538 @item optall
6539 Turn on all optimization options, i.e., @option{optimized},
6540 @option{missed}, and @option{note}.
6541 @end table
6543 The following tree dumps are possible:
6544 @table @samp
6546 @item original
6547 @opindex fdump-tree-original
6548 Dump before any tree based optimization, to @file{@var{file}.original}.
6550 @item optimized
6551 @opindex fdump-tree-optimized
6552 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6554 @item gimple
6555 @opindex fdump-tree-gimple
6556 Dump each function before and after the gimplification pass to a file.  The
6557 file name is made by appending @file{.gimple} to the source file name.
6559 @item cfg
6560 @opindex fdump-tree-cfg
6561 Dump the control flow graph of each function to a file.  The file name is
6562 made by appending @file{.cfg} to the source file name.
6564 @item ch
6565 @opindex fdump-tree-ch
6566 Dump each function after copying loop headers.  The file name is made by
6567 appending @file{.ch} to the source file name.
6569 @item ssa
6570 @opindex fdump-tree-ssa
6571 Dump SSA related information to a file.  The file name is made by appending
6572 @file{.ssa} to the source file name.
6574 @item alias
6575 @opindex fdump-tree-alias
6576 Dump aliasing information for each function.  The file name is made by
6577 appending @file{.alias} to the source file name.
6579 @item ccp
6580 @opindex fdump-tree-ccp
6581 Dump each function after CCP@.  The file name is made by appending
6582 @file{.ccp} to the source file name.
6584 @item storeccp
6585 @opindex fdump-tree-storeccp
6586 Dump each function after STORE-CCP@.  The file name is made by appending
6587 @file{.storeccp} to the source file name.
6589 @item pre
6590 @opindex fdump-tree-pre
6591 Dump trees after partial redundancy elimination.  The file name is made
6592 by appending @file{.pre} to the source file name.
6594 @item fre
6595 @opindex fdump-tree-fre
6596 Dump trees after full redundancy elimination.  The file name is made
6597 by appending @file{.fre} to the source file name.
6599 @item copyprop
6600 @opindex fdump-tree-copyprop
6601 Dump trees after copy propagation.  The file name is made
6602 by appending @file{.copyprop} to the source file name.
6604 @item store_copyprop
6605 @opindex fdump-tree-store_copyprop
6606 Dump trees after store copy-propagation.  The file name is made
6607 by appending @file{.store_copyprop} to the source file name.
6609 @item dce
6610 @opindex fdump-tree-dce
6611 Dump each function after dead code elimination.  The file name is made by
6612 appending @file{.dce} to the source file name.
6614 @item sra
6615 @opindex fdump-tree-sra
6616 Dump each function after performing scalar replacement of aggregates.  The
6617 file name is made by appending @file{.sra} to the source file name.
6619 @item sink
6620 @opindex fdump-tree-sink
6621 Dump each function after performing code sinking.  The file name is made
6622 by appending @file{.sink} to the source file name.
6624 @item dom
6625 @opindex fdump-tree-dom
6626 Dump each function after applying dominator tree optimizations.  The file
6627 name is made by appending @file{.dom} to the source file name.
6629 @item dse
6630 @opindex fdump-tree-dse
6631 Dump each function after applying dead store elimination.  The file
6632 name is made by appending @file{.dse} to the source file name.
6634 @item phiopt
6635 @opindex fdump-tree-phiopt
6636 Dump each function after optimizing PHI nodes into straightline code.  The file
6637 name is made by appending @file{.phiopt} to the source file name.
6639 @item forwprop
6640 @opindex fdump-tree-forwprop
6641 Dump each function after forward propagating single use variables.  The file
6642 name is made by appending @file{.forwprop} to the source file name.
6644 @item copyrename
6645 @opindex fdump-tree-copyrename
6646 Dump each function after applying the copy rename optimization.  The file
6647 name is made by appending @file{.copyrename} to the source file name.
6649 @item nrv
6650 @opindex fdump-tree-nrv
6651 Dump each function after applying the named return value optimization on
6652 generic trees.  The file name is made by appending @file{.nrv} to the source
6653 file name.
6655 @item vect
6656 @opindex fdump-tree-vect
6657 Dump each function after applying vectorization of loops.  The file name is
6658 made by appending @file{.vect} to the source file name.
6660 @item slp
6661 @opindex fdump-tree-slp
6662 Dump each function after applying vectorization of basic blocks.  The file name
6663 is made by appending @file{.slp} to the source file name.
6665 @item vrp
6666 @opindex fdump-tree-vrp
6667 Dump each function after Value Range Propagation (VRP).  The file name
6668 is made by appending @file{.vrp} to the source file name.
6670 @item all
6671 @opindex fdump-tree-all
6672 Enable all the available tree dumps with the flags provided in this option.
6673 @end table
6675 @item -fopt-info
6676 @itemx -fopt-info-@var{options}
6677 @itemx -fopt-info-@var{options}=@var{filename}
6678 @opindex fopt-info
6679 Controls optimization dumps from various optimization passes. If the
6680 @samp{-@var{options}} form is used, @var{options} is a list of
6681 @samp{-} separated options to select the dump details and
6682 optimizations.  If @var{options} is not specified, it defaults to
6683 @option{optimized} for details and @option{optall} for optimization
6684 groups. If the @var{filename} is not specified, it defaults to
6685 @file{stderr}. Note that the output @var{filename} will be overwritten
6686 in case of multiple translation units. If a combined output from
6687 multiple translation units is desired, @file{stderr} should be used
6688 instead.
6690 The options can be divided into two groups, 1) options describing the
6691 verbosity of the dump, and 2) options describing which optimizations
6692 should be included. The options from both the groups can be freely
6693 mixed as they are non-overlapping. However, in case of any conflicts,
6694 the latter options override the earlier options on the command
6695 line. Though multiple -fopt-info options are accepted, only one of
6696 them can have @option{=filename}. If other filenames are provided then
6697 all but the first one are ignored.
6699 The dump verbosity has the following options
6701 @table @samp
6702 @item optimized
6703 Print information when an optimization is successfully applied. It is
6704 up to a pass to decide which information is relevant. For example, the
6705 vectorizer passes print the source location of loops which got
6706 successfully vectorized.
6707 @item missed
6708 Print information about missed optimizations. Individual passes
6709 control which information to include in the output. For example,
6711 @smallexample
6712 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6713 @end smallexample
6715 will print information about missed optimization opportunities from
6716 vectorization passes on stderr.
6717 @item note
6718 Print verbose information about optimizations, such as certain
6719 transformations, more detailed messages about decisions etc.
6720 @item all
6721 Print detailed optimization information. This includes
6722 @var{optimized}, @var{missed}, and @var{note}.
6723 @end table
6725 The second set of options describes a group of optimizations and may
6726 include one or more of the following.
6728 @table @samp
6729 @item ipa
6730 Enable dumps from all interprocedural optimizations.
6731 @item loop
6732 Enable dumps from all loop optimizations.
6733 @item inline
6734 Enable dumps from all inlining optimizations.
6735 @item vec
6736 Enable dumps from all vectorization optimizations.
6737 @item optall
6738 Enable dumps from all optimizations. This is a superset of
6739 the optimization groups listed above.
6740 @end table
6742 For example,
6743 @smallexample
6744 gcc -O3 -fopt-info-missed=missed.all
6745 @end smallexample
6747 outputs missed optimization report from all the passes into
6748 @file{missed.all}.
6750 As another example,
6751 @smallexample
6752 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6753 @end smallexample
6755 will output information about missed optimizations as well as
6756 optimized locations from all the inlining passes into
6757 @file{inline.txt}.
6759 If the @var{filename} is provided, then the dumps from all the
6760 applicable optimizations are concatenated into the @file{filename}.
6761 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6762 omitted, it defaults to @option{all-optall}, which means dump all
6763 available optimization info from all the passes. In the following
6764 example, all optimization info is output on to @file{stderr}.
6766 @smallexample
6767 gcc -O3 -fopt-info
6768 @end smallexample
6770 Note that @option{-fopt-info-vec-missed} behaves the same as
6771 @option{-fopt-info-missed-vec}.
6773 As another example, consider
6775 @smallexample
6776 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6777 @end smallexample
6779 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6780 in conflict since only one output file is allowed. In this case, only
6781 the first option takes effect and the subsequent options are
6782 ignored. Thus only the @file{vec.miss} is produced which contains
6783 dumps from the vectorizer about missed opportunities.
6785 @item -frandom-seed=@var{string}
6786 @opindex frandom-seed
6787 This option provides a seed that GCC uses in place of
6788 random numbers in generating certain symbol names
6789 that have to be different in every compiled file.  It is also used to
6790 place unique stamps in coverage data files and the object files that
6791 produce them.  You can use the @option{-frandom-seed} option to produce
6792 reproducibly identical object files.
6794 The @var{string} should be different for every file you compile.
6796 @item -fsched-verbose=@var{n}
6797 @opindex fsched-verbose
6798 On targets that use instruction scheduling, this option controls the
6799 amount of debugging output the scheduler prints.  This information is
6800 written to standard error, unless @option{-fdump-rtl-sched1} or
6801 @option{-fdump-rtl-sched2} is specified, in which case it is output
6802 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6803 respectively.  However for @var{n} greater than nine, the output is
6804 always printed to standard error.
6806 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6807 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6808 For @var{n} greater than one, it also output basic block probabilities,
6809 detailed ready list information and unit/insn info.  For @var{n} greater
6810 than two, it includes RTL at abort point, control-flow and regions info.
6811 And for @var{n} over four, @option{-fsched-verbose} also includes
6812 dependence info.
6814 @item -save-temps
6815 @itemx -save-temps=cwd
6816 @opindex save-temps
6817 Store the usual ``temporary'' intermediate files permanently; place them
6818 in the current directory and name them based on the source file.  Thus,
6819 compiling @file{foo.c} with @option{-c -save-temps} produces files
6820 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6821 preprocessed @file{foo.i} output file even though the compiler now
6822 normally uses an integrated preprocessor.
6824 When used in combination with the @option{-x} command-line option,
6825 @option{-save-temps} is sensible enough to avoid over writing an
6826 input source file with the same extension as an intermediate file.
6827 The corresponding intermediate file may be obtained by renaming the
6828 source file before using @option{-save-temps}.
6830 If you invoke GCC in parallel, compiling several different source
6831 files that share a common base name in different subdirectories or the
6832 same source file compiled for multiple output destinations, it is
6833 likely that the different parallel compilers will interfere with each
6834 other, and overwrite the temporary files.  For instance:
6836 @smallexample
6837 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6838 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6839 @end smallexample
6841 may result in @file{foo.i} and @file{foo.o} being written to
6842 simultaneously by both compilers.
6844 @item -save-temps=obj
6845 @opindex save-temps=obj
6846 Store the usual ``temporary'' intermediate files permanently.  If the
6847 @option{-o} option is used, the temporary files are based on the
6848 object file.  If the @option{-o} option is not used, the
6849 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6851 For example:
6853 @smallexample
6854 gcc -save-temps=obj -c foo.c
6855 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6856 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6857 @end smallexample
6859 @noindent
6860 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6861 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6862 @file{dir2/yfoobar.o}.
6864 @item -time@r{[}=@var{file}@r{]}
6865 @opindex time
6866 Report the CPU time taken by each subprocess in the compilation
6867 sequence.  For C source files, this is the compiler proper and assembler
6868 (plus the linker if linking is done).
6870 Without the specification of an output file, the output looks like this:
6872 @smallexample
6873 # cc1 0.12 0.01
6874 # as 0.00 0.01
6875 @end smallexample
6877 The first number on each line is the ``user time'', that is time spent
6878 executing the program itself.  The second number is ``system time'',
6879 time spent executing operating system routines on behalf of the program.
6880 Both numbers are in seconds.
6882 With the specification of an output file, the output is appended to the
6883 named file, and it looks like this:
6885 @smallexample
6886 0.12 0.01 cc1 @var{options}
6887 0.00 0.01 as @var{options}
6888 @end smallexample
6890 The ``user time'' and the ``system time'' are moved before the program
6891 name, and the options passed to the program are displayed, so that one
6892 can later tell what file was being compiled, and with which options.
6894 @item -fvar-tracking
6895 @opindex fvar-tracking
6896 Run variable tracking pass.  It computes where variables are stored at each
6897 position in code.  Better debugging information is then generated
6898 (if the debugging information format supports this information).
6900 It is enabled by default when compiling with optimization (@option{-Os},
6901 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6902 the debug info format supports it.
6904 @item -fvar-tracking-assignments
6905 @opindex fvar-tracking-assignments
6906 @opindex fno-var-tracking-assignments
6907 Annotate assignments to user variables early in the compilation and
6908 attempt to carry the annotations over throughout the compilation all the
6909 way to the end, in an attempt to improve debug information while
6910 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6912 It can be enabled even if var-tracking is disabled, in which case
6913 annotations are created and maintained, but discarded at the end.
6915 @item -fvar-tracking-assignments-toggle
6916 @opindex fvar-tracking-assignments-toggle
6917 @opindex fno-var-tracking-assignments-toggle
6918 Toggle @option{-fvar-tracking-assignments}, in the same way that
6919 @option{-gtoggle} toggles @option{-g}.
6921 @item -print-file-name=@var{library}
6922 @opindex print-file-name
6923 Print the full absolute name of the library file @var{library} that
6924 would be used when linking---and don't do anything else.  With this
6925 option, GCC does not compile or link anything; it just prints the
6926 file name.
6928 @item -print-multi-directory
6929 @opindex print-multi-directory
6930 Print the directory name corresponding to the multilib selected by any
6931 other switches present in the command line.  This directory is supposed
6932 to exist in @env{GCC_EXEC_PREFIX}.
6934 @item -print-multi-lib
6935 @opindex print-multi-lib
6936 Print the mapping from multilib directory names to compiler switches
6937 that enable them.  The directory name is separated from the switches by
6938 @samp{;}, and each switch starts with an @samp{@@} instead of the
6939 @samp{-}, without spaces between multiple switches.  This is supposed to
6940 ease shell processing.
6942 @item -print-multi-os-directory
6943 @opindex print-multi-os-directory
6944 Print the path to OS libraries for the selected
6945 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6946 present in the @file{lib} subdirectory and no multilibs are used, this is
6947 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6948 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6949 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6950 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6952 @item -print-multiarch
6953 @opindex print-multiarch
6954 Print the path to OS libraries for the selected multiarch,
6955 relative to some @file{lib} subdirectory.
6957 @item -print-prog-name=@var{program}
6958 @opindex print-prog-name
6959 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6961 @item -print-libgcc-file-name
6962 @opindex print-libgcc-file-name
6963 Same as @option{-print-file-name=libgcc.a}.
6965 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6966 but you do want to link with @file{libgcc.a}.  You can do:
6968 @smallexample
6969 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6970 @end smallexample
6972 @item -print-search-dirs
6973 @opindex print-search-dirs
6974 Print the name of the configured installation directory and a list of
6975 program and library directories @command{gcc} searches---and don't do anything else.
6977 This is useful when @command{gcc} prints the error message
6978 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6979 To resolve this you either need to put @file{cpp0} and the other compiler
6980 components where @command{gcc} expects to find them, or you can set the environment
6981 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6982 Don't forget the trailing @samp{/}.
6983 @xref{Environment Variables}.
6985 @item -print-sysroot
6986 @opindex print-sysroot
6987 Print the target sysroot directory that is used during
6988 compilation.  This is the target sysroot specified either at configure
6989 time or using the @option{--sysroot} option, possibly with an extra
6990 suffix that depends on compilation options.  If no target sysroot is
6991 specified, the option prints nothing.
6993 @item -print-sysroot-headers-suffix
6994 @opindex print-sysroot-headers-suffix
6995 Print the suffix added to the target sysroot when searching for
6996 headers, or give an error if the compiler is not configured with such
6997 a suffix---and don't do anything else.
6999 @item -dumpmachine
7000 @opindex dumpmachine
7001 Print the compiler's target machine (for example,
7002 @samp{i686-pc-linux-gnu})---and don't do anything else.
7004 @item -dumpversion
7005 @opindex dumpversion
7006 Print the compiler version (for example, @samp{3.0})---and don't do
7007 anything else.
7009 @item -dumpspecs
7010 @opindex dumpspecs
7011 Print the compiler's built-in specs---and don't do anything else.  (This
7012 is used when GCC itself is being built.)  @xref{Spec Files}.
7014 @item -fno-eliminate-unused-debug-types
7015 @opindex feliminate-unused-debug-types
7016 @opindex fno-eliminate-unused-debug-types
7017 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7018 output for types that are nowhere used in the source file being compiled.
7019 Sometimes it is useful to have GCC emit debugging
7020 information for all types declared in a compilation
7021 unit, regardless of whether or not they are actually used
7022 in that compilation unit, for example 
7023 if, in the debugger, you want to cast a value to a type that is
7024 not actually used in your program (but is declared).  More often,
7025 however, this results in a significant amount of wasted space.
7026 @end table
7028 @node Optimize Options
7029 @section Options That Control Optimization
7030 @cindex optimize options
7031 @cindex options, optimization
7033 These options control various sorts of optimizations.
7035 Without any optimization option, the compiler's goal is to reduce the
7036 cost of compilation and to make debugging produce the expected
7037 results.  Statements are independent: if you stop the program with a
7038 breakpoint between statements, you can then assign a new value to any
7039 variable or change the program counter to any other statement in the
7040 function and get exactly the results you expect from the source
7041 code.
7043 Turning on optimization flags makes the compiler attempt to improve
7044 the performance and/or code size at the expense of compilation time
7045 and possibly the ability to debug the program.
7047 The compiler performs optimization based on the knowledge it has of the
7048 program.  Compiling multiple files at once to a single output file mode allows
7049 the compiler to use information gained from all of the files when compiling
7050 each of them.
7052 Not all optimizations are controlled directly by a flag.  Only
7053 optimizations that have a flag are listed in this section.
7055 Most optimizations are only enabled if an @option{-O} level is set on
7056 the command line.  Otherwise they are disabled, even if individual
7057 optimization flags are specified.
7059 Depending on the target and how GCC was configured, a slightly different
7060 set of optimizations may be enabled at each @option{-O} level than
7061 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7062 to find out the exact set of optimizations that are enabled at each level.
7063 @xref{Overall Options}, for examples.
7065 @table @gcctabopt
7066 @item -O
7067 @itemx -O1
7068 @opindex O
7069 @opindex O1
7070 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7071 more memory for a large function.
7073 With @option{-O}, the compiler tries to reduce code size and execution
7074 time, without performing any optimizations that take a great deal of
7075 compilation time.
7077 @option{-O} turns on the following optimization flags:
7078 @gccoptlist{
7079 -fauto-inc-dec @gol
7080 -fbranch-count-reg @gol
7081 -fcombine-stack-adjustments @gol
7082 -fcompare-elim @gol
7083 -fcprop-registers @gol
7084 -fdce @gol
7085 -fdefer-pop @gol
7086 -fdelayed-branch @gol
7087 -fdse @gol
7088 -fforward-propagate @gol
7089 -fguess-branch-probability @gol
7090 -fif-conversion2 @gol
7091 -fif-conversion @gol
7092 -finline-functions-called-once @gol
7093 -fipa-pure-const @gol
7094 -fipa-profile @gol
7095 -fipa-reference @gol
7096 -fmerge-constants @gol
7097 -fmove-loop-invariants @gol
7098 -fshrink-wrap @gol
7099 -fsplit-wide-types @gol
7100 -ftree-bit-ccp @gol
7101 -ftree-ccp @gol
7102 -fssa-phiopt @gol
7103 -ftree-ch @gol
7104 -ftree-copy-prop @gol
7105 -ftree-copyrename @gol
7106 -ftree-dce @gol
7107 -ftree-dominator-opts @gol
7108 -ftree-dse @gol
7109 -ftree-forwprop @gol
7110 -ftree-fre @gol
7111 -ftree-phiprop @gol
7112 -ftree-sink @gol
7113 -ftree-slsr @gol
7114 -ftree-sra @gol
7115 -ftree-pta @gol
7116 -ftree-ter @gol
7117 -funit-at-a-time}
7119 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7120 where doing so does not interfere with debugging.
7122 @item -O2
7123 @opindex O2
7124 Optimize even more.  GCC performs nearly all supported optimizations
7125 that do not involve a space-speed tradeoff.
7126 As compared to @option{-O}, this option increases both compilation time
7127 and the performance of the generated code.
7129 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7130 also turns on the following optimization flags:
7131 @gccoptlist{-fthread-jumps @gol
7132 -falign-functions  -falign-jumps @gol
7133 -falign-loops  -falign-labels @gol
7134 -fcaller-saves @gol
7135 -fcrossjumping @gol
7136 -fcse-follow-jumps  -fcse-skip-blocks @gol
7137 -fdelete-null-pointer-checks @gol
7138 -fdevirtualize -fdevirtualize-speculatively @gol
7139 -fexpensive-optimizations @gol
7140 -fgcse  -fgcse-lm  @gol
7141 -fhoist-adjacent-loads @gol
7142 -finline-small-functions @gol
7143 -findirect-inlining @gol
7144 -fipa-cp @gol
7145 -fipa-sra @gol
7146 -fisolate-erroneous-paths-dereference @gol
7147 -foptimize-sibling-calls @gol
7148 -foptimize-strlen @gol
7149 -fpartial-inlining @gol
7150 -fpeephole2 @gol
7151 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7152 -frerun-cse-after-loop  @gol
7153 -fsched-interblock  -fsched-spec @gol
7154 -fschedule-insns  -fschedule-insns2 @gol
7155 -fstrict-aliasing -fstrict-overflow @gol
7156 -ftree-builtin-call-dce @gol
7157 -ftree-switch-conversion -ftree-tail-merge @gol
7158 -ftree-pre @gol
7159 -ftree-vrp @gol
7160 -fuse-caller-save}
7162 Please note the warning under @option{-fgcse} about
7163 invoking @option{-O2} on programs that use computed gotos.
7165 @item -O3
7166 @opindex O3
7167 Optimize yet more.  @option{-O3} turns on all optimizations specified
7168 by @option{-O2} and also turns on the @option{-finline-functions},
7169 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7170 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7171 @option{-ftree-loop-distribute-patterns},
7172 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7173 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7175 @item -O0
7176 @opindex O0
7177 Reduce compilation time and make debugging produce the expected
7178 results.  This is the default.
7180 @item -Os
7181 @opindex Os
7182 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7183 do not typically increase code size.  It also performs further
7184 optimizations designed to reduce code size.
7186 @option{-Os} disables the following optimization flags:
7187 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7188 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7189 -fprefetch-loop-arrays}
7191 @item -Ofast
7192 @opindex Ofast
7193 Disregard strict standards compliance.  @option{-Ofast} enables all
7194 @option{-O3} optimizations.  It also enables optimizations that are not
7195 valid for all standard-compliant programs.
7196 It turns on @option{-ffast-math} and the Fortran-specific
7197 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7199 @item -Og
7200 @opindex Og
7201 Optimize debugging experience.  @option{-Og} enables optimizations
7202 that do not interfere with debugging. It should be the optimization
7203 level of choice for the standard edit-compile-debug cycle, offering
7204 a reasonable level of optimization while maintaining fast compilation
7205 and a good debugging experience.
7207 If you use multiple @option{-O} options, with or without level numbers,
7208 the last such option is the one that is effective.
7209 @end table
7211 Options of the form @option{-f@var{flag}} specify machine-independent
7212 flags.  Most flags have both positive and negative forms; the negative
7213 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7214 below, only one of the forms is listed---the one you typically 
7215 use.  You can figure out the other form by either removing @samp{no-}
7216 or adding it.
7218 The following options control specific optimizations.  They are either
7219 activated by @option{-O} options or are related to ones that are.  You
7220 can use the following flags in the rare cases when ``fine-tuning'' of
7221 optimizations to be performed is desired.
7223 @table @gcctabopt
7224 @item -fno-defer-pop
7225 @opindex fno-defer-pop
7226 Always pop the arguments to each function call as soon as that function
7227 returns.  For machines that must pop arguments after a function call,
7228 the compiler normally lets arguments accumulate on the stack for several
7229 function calls and pops them all at once.
7231 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7233 @item -fforward-propagate
7234 @opindex fforward-propagate
7235 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7236 instructions and checks if the result can be simplified.  If loop unrolling
7237 is active, two passes are performed and the second is scheduled after
7238 loop unrolling.
7240 This option is enabled by default at optimization levels @option{-O},
7241 @option{-O2}, @option{-O3}, @option{-Os}.
7243 @item -ffp-contract=@var{style}
7244 @opindex ffp-contract
7245 @option{-ffp-contract=off} disables floating-point expression contraction.
7246 @option{-ffp-contract=fast} enables floating-point expression contraction
7247 such as forming of fused multiply-add operations if the target has
7248 native support for them.
7249 @option{-ffp-contract=on} enables floating-point expression contraction
7250 if allowed by the language standard.  This is currently not implemented
7251 and treated equal to @option{-ffp-contract=off}.
7253 The default is @option{-ffp-contract=fast}.
7255 @item -fomit-frame-pointer
7256 @opindex fomit-frame-pointer
7257 Don't keep the frame pointer in a register for functions that
7258 don't need one.  This avoids the instructions to save, set up and
7259 restore frame pointers; it also makes an extra register available
7260 in many functions.  @strong{It also makes debugging impossible on
7261 some machines.}
7263 On some machines, such as the VAX, this flag has no effect, because
7264 the standard calling sequence automatically handles the frame pointer
7265 and nothing is saved by pretending it doesn't exist.  The
7266 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7267 whether a target machine supports this flag.  @xref{Registers,,Register
7268 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7270 Starting with GCC version 4.6, the default setting (when not optimizing for
7271 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7272 @option{-fomit-frame-pointer}.  The default can be reverted to
7273 @option{-fno-omit-frame-pointer} by configuring GCC with the
7274 @option{--enable-frame-pointer} configure option.
7276 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7278 @item -foptimize-sibling-calls
7279 @opindex foptimize-sibling-calls
7280 Optimize sibling and tail recursive calls.
7282 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7284 @item -foptimize-strlen
7285 @opindex foptimize-strlen
7286 Optimize various standard C string functions (e.g. @code{strlen},
7287 @code{strchr} or @code{strcpy}) and
7288 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7290 Enabled at levels @option{-O2}, @option{-O3}.
7292 @item -fno-inline
7293 @opindex fno-inline
7294 Do not expand any functions inline apart from those marked with
7295 the @code{always_inline} attribute.  This is the default when not
7296 optimizing.
7298 Single functions can be exempted from inlining by marking them
7299 with the @code{noinline} attribute.
7301 @item -finline-small-functions
7302 @opindex finline-small-functions
7303 Integrate functions into their callers when their body is smaller than expected
7304 function call code (so overall size of program gets smaller).  The compiler
7305 heuristically decides which functions are simple enough to be worth integrating
7306 in this way.  This inlining applies to all functions, even those not declared
7307 inline.
7309 Enabled at level @option{-O2}.
7311 @item -findirect-inlining
7312 @opindex findirect-inlining
7313 Inline also indirect calls that are discovered to be known at compile
7314 time thanks to previous inlining.  This option has any effect only
7315 when inlining itself is turned on by the @option{-finline-functions}
7316 or @option{-finline-small-functions} options.
7318 Enabled at level @option{-O2}.
7320 @item -finline-functions
7321 @opindex finline-functions
7322 Consider all functions for inlining, even if they are not declared inline.
7323 The compiler heuristically decides which functions are worth integrating
7324 in this way.
7326 If all calls to a given function are integrated, and the function is
7327 declared @code{static}, then the function is normally not output as
7328 assembler code in its own right.
7330 Enabled at level @option{-O3}.
7332 @item -finline-functions-called-once
7333 @opindex finline-functions-called-once
7334 Consider all @code{static} functions called once for inlining into their
7335 caller even if they are not marked @code{inline}.  If a call to a given
7336 function is integrated, then the function is not output as assembler code
7337 in its own right.
7339 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7341 @item -fearly-inlining
7342 @opindex fearly-inlining
7343 Inline functions marked by @code{always_inline} and functions whose body seems
7344 smaller than the function call overhead early before doing
7345 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7346 makes profiling significantly cheaper and usually inlining faster on programs
7347 having large chains of nested wrapper functions.
7349 Enabled by default.
7351 @item -fipa-sra
7352 @opindex fipa-sra
7353 Perform interprocedural scalar replacement of aggregates, removal of
7354 unused parameters and replacement of parameters passed by reference
7355 by parameters passed by value.
7357 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7359 @item -finline-limit=@var{n}
7360 @opindex finline-limit
7361 By default, GCC limits the size of functions that can be inlined.  This flag
7362 allows coarse control of this limit.  @var{n} is the size of functions that
7363 can be inlined in number of pseudo instructions.
7365 Inlining is actually controlled by a number of parameters, which may be
7366 specified individually by using @option{--param @var{name}=@var{value}}.
7367 The @option{-finline-limit=@var{n}} option sets some of these parameters
7368 as follows:
7370 @table @gcctabopt
7371 @item max-inline-insns-single
7372 is set to @var{n}/2.
7373 @item max-inline-insns-auto
7374 is set to @var{n}/2.
7375 @end table
7377 See below for a documentation of the individual
7378 parameters controlling inlining and for the defaults of these parameters.
7380 @emph{Note:} there may be no value to @option{-finline-limit} that results
7381 in default behavior.
7383 @emph{Note:} pseudo instruction represents, in this particular context, an
7384 abstract measurement of function's size.  In no way does it represent a count
7385 of assembly instructions and as such its exact meaning might change from one
7386 release to an another.
7388 @item -fno-keep-inline-dllexport
7389 @opindex -fno-keep-inline-dllexport
7390 This is a more fine-grained version of @option{-fkeep-inline-functions},
7391 which applies only to functions that are declared using the @code{dllexport}
7392 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7393 Functions}.)
7395 @item -fkeep-inline-functions
7396 @opindex fkeep-inline-functions
7397 In C, emit @code{static} functions that are declared @code{inline}
7398 into the object file, even if the function has been inlined into all
7399 of its callers.  This switch does not affect functions using the
7400 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7401 inline functions into the object file.
7403 @item -fkeep-static-consts
7404 @opindex fkeep-static-consts
7405 Emit variables declared @code{static const} when optimization isn't turned
7406 on, even if the variables aren't referenced.
7408 GCC enables this option by default.  If you want to force the compiler to
7409 check if a variable is referenced, regardless of whether or not
7410 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7412 @item -fmerge-constants
7413 @opindex fmerge-constants
7414 Attempt to merge identical constants (string constants and floating-point
7415 constants) across compilation units.
7417 This option is the default for optimized compilation if the assembler and
7418 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7419 behavior.
7421 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7423 @item -fmerge-all-constants
7424 @opindex fmerge-all-constants
7425 Attempt to merge identical constants and identical variables.
7427 This option implies @option{-fmerge-constants}.  In addition to
7428 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7429 arrays or initialized constant variables with integral or floating-point
7430 types.  Languages like C or C++ require each variable, including multiple
7431 instances of the same variable in recursive calls, to have distinct locations,
7432 so using this option results in non-conforming
7433 behavior.
7435 @item -fmodulo-sched
7436 @opindex fmodulo-sched
7437 Perform swing modulo scheduling immediately before the first scheduling
7438 pass.  This pass looks at innermost loops and reorders their
7439 instructions by overlapping different iterations.
7441 @item -fmodulo-sched-allow-regmoves
7442 @opindex fmodulo-sched-allow-regmoves
7443 Perform more aggressive SMS-based modulo scheduling with register moves
7444 allowed.  By setting this flag certain anti-dependences edges are
7445 deleted, which triggers the generation of reg-moves based on the
7446 life-range analysis.  This option is effective only with
7447 @option{-fmodulo-sched} enabled.
7449 @item -fno-branch-count-reg
7450 @opindex fno-branch-count-reg
7451 Do not use ``decrement and branch'' instructions on a count register,
7452 but instead generate a sequence of instructions that decrement a
7453 register, compare it against zero, then branch based upon the result.
7454 This option is only meaningful on architectures that support such
7455 instructions, which include x86, PowerPC, IA-64 and S/390.
7457 Enabled by default at @option{-O1} and higher.
7459 The default is @option{-fbranch-count-reg}.
7461 @item -fno-function-cse
7462 @opindex fno-function-cse
7463 Do not put function addresses in registers; make each instruction that
7464 calls a constant function contain the function's address explicitly.
7466 This option results in less efficient code, but some strange hacks
7467 that alter the assembler output may be confused by the optimizations
7468 performed when this option is not used.
7470 The default is @option{-ffunction-cse}
7472 @item -fno-zero-initialized-in-bss
7473 @opindex fno-zero-initialized-in-bss
7474 If the target supports a BSS section, GCC by default puts variables that
7475 are initialized to zero into BSS@.  This can save space in the resulting
7476 code.
7478 This option turns off this behavior because some programs explicitly
7479 rely on variables going to the data section---e.g., so that the
7480 resulting executable can find the beginning of that section and/or make
7481 assumptions based on that.
7483 The default is @option{-fzero-initialized-in-bss}.
7485 @item -fthread-jumps
7486 @opindex fthread-jumps
7487 Perform optimizations that check to see if a jump branches to a
7488 location where another comparison subsumed by the first is found.  If
7489 so, the first branch is redirected to either the destination of the
7490 second branch or a point immediately following it, depending on whether
7491 the condition is known to be true or false.
7493 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7495 @item -fsplit-wide-types
7496 @opindex fsplit-wide-types
7497 When using a type that occupies multiple registers, such as @code{long
7498 long} on a 32-bit system, split the registers apart and allocate them
7499 independently.  This normally generates better code for those types,
7500 but may make debugging more difficult.
7502 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7503 @option{-Os}.
7505 @item -fcse-follow-jumps
7506 @opindex fcse-follow-jumps
7507 In common subexpression elimination (CSE), scan through jump instructions
7508 when the target of the jump is not reached by any other path.  For
7509 example, when CSE encounters an @code{if} statement with an
7510 @code{else} clause, CSE follows the jump when the condition
7511 tested is false.
7513 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7515 @item -fcse-skip-blocks
7516 @opindex fcse-skip-blocks
7517 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7518 follow jumps that conditionally skip over blocks.  When CSE
7519 encounters a simple @code{if} statement with no else clause,
7520 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7521 body of the @code{if}.
7523 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7525 @item -frerun-cse-after-loop
7526 @opindex frerun-cse-after-loop
7527 Re-run common subexpression elimination after loop optimizations are
7528 performed.
7530 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7532 @item -fgcse
7533 @opindex fgcse
7534 Perform a global common subexpression elimination pass.
7535 This pass also performs global constant and copy propagation.
7537 @emph{Note:} When compiling a program using computed gotos, a GCC
7538 extension, you may get better run-time performance if you disable
7539 the global common subexpression elimination pass by adding
7540 @option{-fno-gcse} to the command line.
7542 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7544 @item -fgcse-lm
7545 @opindex fgcse-lm
7546 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7547 attempts to move loads that are only killed by stores into themselves.  This
7548 allows a loop containing a load/store sequence to be changed to a load outside
7549 the loop, and a copy/store within the loop.
7551 Enabled by default when @option{-fgcse} is enabled.
7553 @item -fgcse-sm
7554 @opindex fgcse-sm
7555 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7556 global common subexpression elimination.  This pass attempts to move
7557 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7558 loops containing a load/store sequence can be changed to a load before
7559 the loop and a store after the loop.
7561 Not enabled at any optimization level.
7563 @item -fgcse-las
7564 @opindex fgcse-las
7565 When @option{-fgcse-las} is enabled, the global common subexpression
7566 elimination pass eliminates redundant loads that come after stores to the
7567 same memory location (both partial and full redundancies).
7569 Not enabled at any optimization level.
7571 @item -fgcse-after-reload
7572 @opindex fgcse-after-reload
7573 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7574 pass is performed after reload.  The purpose of this pass is to clean up
7575 redundant spilling.
7577 @item -faggressive-loop-optimizations
7578 @opindex faggressive-loop-optimizations
7579 This option tells the loop optimizer to use language constraints to
7580 derive bounds for the number of iterations of a loop.  This assumes that
7581 loop code does not invoke undefined behavior by for example causing signed
7582 integer overflows or out-of-bound array accesses.  The bounds for the
7583 number of iterations of a loop are used to guide loop unrolling and peeling
7584 and loop exit test optimizations.
7585 This option is enabled by default.
7587 @item -funsafe-loop-optimizations
7588 @opindex funsafe-loop-optimizations
7589 This option tells the loop optimizer to assume that loop indices do not
7590 overflow, and that loops with nontrivial exit condition are not
7591 infinite.  This enables a wider range of loop optimizations even if
7592 the loop optimizer itself cannot prove that these assumptions are valid.
7593 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7594 if it finds this kind of loop.
7596 @item -fcrossjumping
7597 @opindex fcrossjumping
7598 Perform cross-jumping transformation.
7599 This transformation unifies equivalent code and saves code size.  The
7600 resulting code may or may not perform better than without cross-jumping.
7602 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7604 @item -fauto-inc-dec
7605 @opindex fauto-inc-dec
7606 Combine increments or decrements of addresses with memory accesses.
7607 This pass is always skipped on architectures that do not have
7608 instructions to support this.  Enabled by default at @option{-O} and
7609 higher on architectures that support this.
7611 @item -fdce
7612 @opindex fdce
7613 Perform dead code elimination (DCE) on RTL@.
7614 Enabled by default at @option{-O} and higher.
7616 @item -fdse
7617 @opindex fdse
7618 Perform dead store elimination (DSE) on RTL@.
7619 Enabled by default at @option{-O} and higher.
7621 @item -fif-conversion
7622 @opindex fif-conversion
7623 Attempt to transform conditional jumps into branch-less equivalents.  This
7624 includes use of conditional moves, min, max, set flags and abs instructions, and
7625 some tricks doable by standard arithmetics.  The use of conditional execution
7626 on chips where it is available is controlled by @code{if-conversion2}.
7628 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7630 @item -fif-conversion2
7631 @opindex fif-conversion2
7632 Use conditional execution (where available) to transform conditional jumps into
7633 branch-less equivalents.
7635 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7637 @item -fdeclone-ctor-dtor
7638 @opindex fdeclone-ctor-dtor
7639 The C++ ABI requires multiple entry points for constructors and
7640 destructors: one for a base subobject, one for a complete object, and
7641 one for a virtual destructor that calls operator delete afterwards.
7642 For a hierarchy with virtual bases, the base and complete variants are
7643 clones, which means two copies of the function.  With this option, the
7644 base and complete variants are changed to be thunks that call a common
7645 implementation.
7647 Enabled by @option{-Os}.
7649 @item -fdelete-null-pointer-checks
7650 @opindex fdelete-null-pointer-checks
7651 Assume that programs cannot safely dereference null pointers, and that
7652 no code or data element resides there.  This enables simple constant
7653 folding optimizations at all optimization levels.  In addition, other
7654 optimization passes in GCC use this flag to control global dataflow
7655 analyses that eliminate useless checks for null pointers; these assume
7656 that if a pointer is checked after it has already been dereferenced,
7657 it cannot be null.
7659 Note however that in some environments this assumption is not true.
7660 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7661 for programs that depend on that behavior.
7663 Some targets, especially embedded ones, disable this option at all levels.
7664 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7665 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7666 are enabled independently at different optimization levels.
7668 @item -fdevirtualize
7669 @opindex fdevirtualize
7670 Attempt to convert calls to virtual functions to direct calls.  This
7671 is done both within a procedure and interprocedurally as part of
7672 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7673 propagation (@option{-fipa-cp}).
7674 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7676 @item -fdevirtualize-speculatively
7677 @opindex fdevirtualize-speculatively
7678 Attempt to convert calls to virtual functions to speculative direct calls.
7679 Based on the analysis of the type inheritance graph, determine for a given call
7680 the set of likely targets. If the set is small, preferably of size 1, change
7681 the call into an conditional deciding on direct and indirect call.  The
7682 speculative calls enable more optimizations, such as inlining.  When they seem
7683 useless after further optimization, they are converted back into original form.
7685 @item -fexpensive-optimizations
7686 @opindex fexpensive-optimizations
7687 Perform a number of minor optimizations that are relatively expensive.
7689 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7691 @item -free
7692 @opindex free
7693 Attempt to remove redundant extension instructions.  This is especially
7694 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7695 registers after writing to their lower 32-bit half.
7697 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7698 @option{-O3}, @option{-Os}.
7700 @item -flive-range-shrinkage
7701 @opindex flive-range-shrinkage
7702 Attempt to decrease register pressure through register live range
7703 shrinkage.  This is helpful for fast processors with small or moderate
7704 size register sets.
7706 @item -fira-algorithm=@var{algorithm}
7707 Use the specified coloring algorithm for the integrated register
7708 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7709 specifies Chow's priority coloring, or @samp{CB}, which specifies
7710 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7711 for all architectures, but for those targets that do support it, it is
7712 the default because it generates better code.
7714 @item -fira-region=@var{region}
7715 Use specified regions for the integrated register allocator.  The
7716 @var{region} argument should be one of the following:
7718 @table @samp
7720 @item all
7721 Use all loops as register allocation regions.
7722 This can give the best results for machines with a small and/or
7723 irregular register set.
7725 @item mixed
7726 Use all loops except for loops with small register pressure 
7727 as the regions.  This value usually gives
7728 the best results in most cases and for most architectures,
7729 and is enabled by default when compiling with optimization for speed
7730 (@option{-O}, @option{-O2}, @dots{}).
7732 @item one
7733 Use all functions as a single region.  
7734 This typically results in the smallest code size, and is enabled by default for
7735 @option{-Os} or @option{-O0}.
7737 @end table
7739 @item -fira-hoist-pressure
7740 @opindex fira-hoist-pressure
7741 Use IRA to evaluate register pressure in the code hoisting pass for
7742 decisions to hoist expressions.  This option usually results in smaller
7743 code, but it can slow the compiler down.
7745 This option is enabled at level @option{-Os} for all targets.
7747 @item -fira-loop-pressure
7748 @opindex fira-loop-pressure
7749 Use IRA to evaluate register pressure in loops for decisions to move
7750 loop invariants.  This option usually results in generation
7751 of faster and smaller code on machines with large register files (>= 32
7752 registers), but it can slow the compiler down.
7754 This option is enabled at level @option{-O3} for some targets.
7756 @item -fno-ira-share-save-slots
7757 @opindex fno-ira-share-save-slots
7758 Disable sharing of stack slots used for saving call-used hard
7759 registers living through a call.  Each hard register gets a
7760 separate stack slot, and as a result function stack frames are
7761 larger.
7763 @item -fno-ira-share-spill-slots
7764 @opindex fno-ira-share-spill-slots
7765 Disable sharing of stack slots allocated for pseudo-registers.  Each
7766 pseudo-register that does not get a hard register gets a separate
7767 stack slot, and as a result function stack frames are larger.
7769 @item -fira-verbose=@var{n}
7770 @opindex fira-verbose
7771 Control the verbosity of the dump file for the integrated register allocator.
7772 The default value is 5.  If the value @var{n} is greater or equal to 10,
7773 the dump output is sent to stderr using the same format as @var{n} minus 10.
7775 @item -fdelayed-branch
7776 @opindex fdelayed-branch
7777 If supported for the target machine, attempt to reorder instructions
7778 to exploit instruction slots available after delayed branch
7779 instructions.
7781 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7783 @item -fschedule-insns
7784 @opindex fschedule-insns
7785 If supported for the target machine, attempt to reorder instructions to
7786 eliminate execution stalls due to required data being unavailable.  This
7787 helps machines that have slow floating point or memory load instructions
7788 by allowing other instructions to be issued until the result of the load
7789 or floating-point instruction is required.
7791 Enabled at levels @option{-O2}, @option{-O3}.
7793 @item -fschedule-insns2
7794 @opindex fschedule-insns2
7795 Similar to @option{-fschedule-insns}, but requests an additional pass of
7796 instruction scheduling after register allocation has been done.  This is
7797 especially useful on machines with a relatively small number of
7798 registers and where memory load instructions take more than one cycle.
7800 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7802 @item -fno-sched-interblock
7803 @opindex fno-sched-interblock
7804 Don't schedule instructions across basic blocks.  This is normally
7805 enabled by default when scheduling before register allocation, i.e.@:
7806 with @option{-fschedule-insns} or at @option{-O2} or higher.
7808 @item -fno-sched-spec
7809 @opindex fno-sched-spec
7810 Don't allow speculative motion of non-load instructions.  This is normally
7811 enabled by default when scheduling before register allocation, i.e.@:
7812 with @option{-fschedule-insns} or at @option{-O2} or higher.
7814 @item -fsched-pressure
7815 @opindex fsched-pressure
7816 Enable register pressure sensitive insn scheduling before register
7817 allocation.  This only makes sense when scheduling before register
7818 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7819 @option{-O2} or higher.  Usage of this option can improve the
7820 generated code and decrease its size by preventing register pressure
7821 increase above the number of available hard registers and subsequent
7822 spills in register allocation.
7824 @item -fsched-spec-load
7825 @opindex fsched-spec-load
7826 Allow speculative motion of some load instructions.  This only makes
7827 sense when scheduling before register allocation, i.e.@: with
7828 @option{-fschedule-insns} or at @option{-O2} or higher.
7830 @item -fsched-spec-load-dangerous
7831 @opindex fsched-spec-load-dangerous
7832 Allow speculative motion of more load instructions.  This only makes
7833 sense when scheduling before register allocation, i.e.@: with
7834 @option{-fschedule-insns} or at @option{-O2} or higher.
7836 @item -fsched-stalled-insns
7837 @itemx -fsched-stalled-insns=@var{n}
7838 @opindex fsched-stalled-insns
7839 Define how many insns (if any) can be moved prematurely from the queue
7840 of stalled insns into the ready list during the second scheduling pass.
7841 @option{-fno-sched-stalled-insns} means that no insns are moved
7842 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7843 on how many queued insns can be moved prematurely.
7844 @option{-fsched-stalled-insns} without a value is equivalent to
7845 @option{-fsched-stalled-insns=1}.
7847 @item -fsched-stalled-insns-dep
7848 @itemx -fsched-stalled-insns-dep=@var{n}
7849 @opindex fsched-stalled-insns-dep
7850 Define how many insn groups (cycles) are examined for a dependency
7851 on a stalled insn that is a candidate for premature removal from the queue
7852 of stalled insns.  This has an effect only during the second scheduling pass,
7853 and only if @option{-fsched-stalled-insns} is used.
7854 @option{-fno-sched-stalled-insns-dep} is equivalent to
7855 @option{-fsched-stalled-insns-dep=0}.
7856 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7857 @option{-fsched-stalled-insns-dep=1}.
7859 @item -fsched2-use-superblocks
7860 @opindex fsched2-use-superblocks
7861 When scheduling after register allocation, use superblock scheduling.
7862 This allows motion across basic block boundaries,
7863 resulting in faster schedules.  This option is experimental, as not all machine
7864 descriptions used by GCC model the CPU closely enough to avoid unreliable
7865 results from the algorithm.
7867 This only makes sense when scheduling after register allocation, i.e.@: with
7868 @option{-fschedule-insns2} or at @option{-O2} or higher.
7870 @item -fsched-group-heuristic
7871 @opindex fsched-group-heuristic
7872 Enable the group heuristic in the scheduler.  This heuristic favors
7873 the instruction that belongs to a schedule group.  This is enabled
7874 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7875 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7877 @item -fsched-critical-path-heuristic
7878 @opindex fsched-critical-path-heuristic
7879 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7880 instructions on the critical path.  This is enabled by default when
7881 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7882 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7884 @item -fsched-spec-insn-heuristic
7885 @opindex fsched-spec-insn-heuristic
7886 Enable the speculative instruction heuristic in the scheduler.  This
7887 heuristic favors speculative instructions with greater dependency weakness.
7888 This is enabled by default when scheduling is enabled, i.e.@:
7889 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7890 or at @option{-O2} or higher.
7892 @item -fsched-rank-heuristic
7893 @opindex fsched-rank-heuristic
7894 Enable the rank heuristic in the scheduler.  This heuristic favors
7895 the instruction belonging to a basic block with greater size or frequency.
7896 This is enabled by default when scheduling is enabled, i.e.@:
7897 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7898 at @option{-O2} or higher.
7900 @item -fsched-last-insn-heuristic
7901 @opindex fsched-last-insn-heuristic
7902 Enable the last-instruction heuristic in the scheduler.  This heuristic
7903 favors the instruction that is less dependent on the last instruction
7904 scheduled.  This is enabled by default when scheduling is enabled,
7905 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7906 at @option{-O2} or higher.
7908 @item -fsched-dep-count-heuristic
7909 @opindex fsched-dep-count-heuristic
7910 Enable the dependent-count heuristic in the scheduler.  This heuristic
7911 favors the instruction that has more instructions depending on it.
7912 This is enabled by default when scheduling is enabled, i.e.@:
7913 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7914 at @option{-O2} or higher.
7916 @item -freschedule-modulo-scheduled-loops
7917 @opindex freschedule-modulo-scheduled-loops
7918 Modulo scheduling is performed before traditional scheduling.  If a loop
7919 is modulo scheduled, later scheduling passes may change its schedule.  
7920 Use this option to control that behavior.
7922 @item -fselective-scheduling
7923 @opindex fselective-scheduling
7924 Schedule instructions using selective scheduling algorithm.  Selective
7925 scheduling runs instead of the first scheduler pass.
7927 @item -fselective-scheduling2
7928 @opindex fselective-scheduling2
7929 Schedule instructions using selective scheduling algorithm.  Selective
7930 scheduling runs instead of the second scheduler pass.
7932 @item -fsel-sched-pipelining
7933 @opindex fsel-sched-pipelining
7934 Enable software pipelining of innermost loops during selective scheduling.
7935 This option has no effect unless one of @option{-fselective-scheduling} or
7936 @option{-fselective-scheduling2} is turned on.
7938 @item -fsel-sched-pipelining-outer-loops
7939 @opindex fsel-sched-pipelining-outer-loops
7940 When pipelining loops during selective scheduling, also pipeline outer loops.
7941 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7943 @item -fsemantic-interposition
7944 @opindex fsemantic-interposition
7945 Some object formats, like ELF, allow interposing of symbols by dynamic linker.
7946 This means that for symbols exported from the DSO compiler can not perform
7947 inter-procedural propagation, inlining and other optimizations in anticipation
7948 that the function or variable in question may change. While this feature is
7949 useful, for example, to rewrite memory allocation functions by a debugging
7950 implementation, it is expensive in the terms of code quality.
7951 With @option{-fno-semantic-inteposition} compiler assumest that if interposition
7952 happens for functions the overwritting function will have
7953 precisely same semantics (and side effects). Similarly if interposition happens
7954 for variables, the constructor of the variable will be the same. The flag
7955 has no effect for functions explicitly declared inline, where
7956 interposition changing semantic is never allowed and for symbols explicitly
7957 declared weak.
7959 @item -fshrink-wrap
7960 @opindex fshrink-wrap
7961 Emit function prologues only before parts of the function that need it,
7962 rather than at the top of the function.  This flag is enabled by default at
7963 @option{-O} and higher.
7965 @item -fcaller-saves
7966 @opindex fcaller-saves
7967 Enable allocation of values to registers that are clobbered by
7968 function calls, by emitting extra instructions to save and restore the
7969 registers around such calls.  Such allocation is done only when it
7970 seems to result in better code.
7972 This option is always enabled by default on certain machines, usually
7973 those which have no call-preserved registers to use instead.
7975 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7977 @item -fcombine-stack-adjustments
7978 @opindex fcombine-stack-adjustments
7979 Tracks stack adjustments (pushes and pops) and stack memory references
7980 and then tries to find ways to combine them.
7982 Enabled by default at @option{-O1} and higher.
7984 @item -fuse-caller-save
7985 Use caller save registers for allocation if those registers are not used by
7986 any called function.  In that case it is not necessary to save and restore
7987 them around calls.  This is only possible if called functions are part of
7988 same compilation unit as current function and they are compiled before it.
7990 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7992 @item -fconserve-stack
7993 @opindex fconserve-stack
7994 Attempt to minimize stack usage.  The compiler attempts to use less
7995 stack space, even if that makes the program slower.  This option
7996 implies setting the @option{large-stack-frame} parameter to 100
7997 and the @option{large-stack-frame-growth} parameter to 400.
7999 @item -ftree-reassoc
8000 @opindex ftree-reassoc
8001 Perform reassociation on trees.  This flag is enabled by default
8002 at @option{-O} and higher.
8004 @item -ftree-pre
8005 @opindex ftree-pre
8006 Perform partial redundancy elimination (PRE) on trees.  This flag is
8007 enabled by default at @option{-O2} and @option{-O3}.
8009 @item -ftree-partial-pre
8010 @opindex ftree-partial-pre
8011 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8012 enabled by default at @option{-O3}.
8014 @item -ftree-forwprop
8015 @opindex ftree-forwprop
8016 Perform forward propagation on trees.  This flag is enabled by default
8017 at @option{-O} and higher.
8019 @item -ftree-fre
8020 @opindex ftree-fre
8021 Perform full redundancy elimination (FRE) on trees.  The difference
8022 between FRE and PRE is that FRE only considers expressions
8023 that are computed on all paths leading to the redundant computation.
8024 This analysis is faster than PRE, though it exposes fewer redundancies.
8025 This flag is enabled by default at @option{-O} and higher.
8027 @item -ftree-phiprop
8028 @opindex ftree-phiprop
8029 Perform hoisting of loads from conditional pointers on trees.  This
8030 pass is enabled by default at @option{-O} and higher.
8032 @item -fhoist-adjacent-loads
8033 @opindex hoist-adjacent-loads
8034 Speculatively hoist loads from both branches of an if-then-else if the
8035 loads are from adjacent locations in the same structure and the target
8036 architecture has a conditional move instruction.  This flag is enabled
8037 by default at @option{-O2} and higher.
8039 @item -ftree-copy-prop
8040 @opindex ftree-copy-prop
8041 Perform copy propagation on trees.  This pass eliminates unnecessary
8042 copy operations.  This flag is enabled by default at @option{-O} and
8043 higher.
8045 @item -fipa-pure-const
8046 @opindex fipa-pure-const
8047 Discover which functions are pure or constant.
8048 Enabled by default at @option{-O} and higher.
8050 @item -fipa-reference
8051 @opindex fipa-reference
8052 Discover which static variables do not escape the
8053 compilation unit.
8054 Enabled by default at @option{-O} and higher.
8056 @item -fipa-pta
8057 @opindex fipa-pta
8058 Perform interprocedural pointer analysis and interprocedural modification
8059 and reference analysis.  This option can cause excessive memory and
8060 compile-time usage on large compilation units.  It is not enabled by
8061 default at any optimization level.
8063 @item -fipa-profile
8064 @opindex fipa-profile
8065 Perform interprocedural profile propagation.  The functions called only from
8066 cold functions are marked as cold. Also functions executed once (such as
8067 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8068 functions and loop less parts of functions executed once are then optimized for
8069 size.
8070 Enabled by default at @option{-O} and higher.
8072 @item -fipa-cp
8073 @opindex fipa-cp
8074 Perform interprocedural constant propagation.
8075 This optimization analyzes the program to determine when values passed
8076 to functions are constants and then optimizes accordingly.
8077 This optimization can substantially increase performance
8078 if the application has constants passed to functions.
8079 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8081 @item -fipa-cp-clone
8082 @opindex fipa-cp-clone
8083 Perform function cloning to make interprocedural constant propagation stronger.
8084 When enabled, interprocedural constant propagation performs function cloning
8085 when externally visible function can be called with constant arguments.
8086 Because this optimization can create multiple copies of functions,
8087 it may significantly increase code size
8088 (see @option{--param ipcp-unit-growth=@var{value}}).
8089 This flag is enabled by default at @option{-O3}.
8091 @item -fisolate-erroneous-paths-dereference
8092 Detect paths which trigger erroneous or undefined behaviour due to
8093 dereferencing a NULL pointer.  Isolate those paths from the main control
8094 flow and turn the statement with erroneous or undefined behaviour into a trap.
8096 @item -fisolate-erroneous-paths-attribute
8097 Detect paths which trigger erroneous or undefined behaviour due a NULL value
8098 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
8099 attribute.  Isolate those paths from the main control flow and turn the
8100 statement with erroneous or undefined behaviour into a trap.  This is not
8101 currently enabled, but may be enabled by @code{-O2} in the future.
8103 @item -ftree-sink
8104 @opindex ftree-sink
8105 Perform forward store motion  on trees.  This flag is
8106 enabled by default at @option{-O} and higher.
8108 @item -ftree-bit-ccp
8109 @opindex ftree-bit-ccp
8110 Perform sparse conditional bit constant propagation on trees and propagate
8111 pointer alignment information.
8112 This pass only operates on local scalar variables and is enabled by default
8113 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8115 @item -ftree-ccp
8116 @opindex ftree-ccp
8117 Perform sparse conditional constant propagation (CCP) on trees.  This
8118 pass only operates on local scalar variables and is enabled by default
8119 at @option{-O} and higher.
8121 @item -fssa-phiopt
8122 @opindex fssa-phiopt
8123 Perform pattern matching on SSA PHI nodes to optimize conditional
8124 code.  This pass is enabled by default at @option{-O} and higher.
8126 @item -ftree-switch-conversion
8127 Perform conversion of simple initializations in a switch to
8128 initializations from a scalar array.  This flag is enabled by default
8129 at @option{-O2} and higher.
8131 @item -ftree-tail-merge
8132 Look for identical code sequences.  When found, replace one with a jump to the
8133 other.  This optimization is known as tail merging or cross jumping.  This flag
8134 is enabled by default at @option{-O2} and higher.  The compilation time
8135 in this pass can
8136 be limited using @option{max-tail-merge-comparisons} parameter and
8137 @option{max-tail-merge-iterations} parameter.
8139 @item -ftree-dce
8140 @opindex ftree-dce
8141 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8142 default at @option{-O} and higher.
8144 @item -ftree-builtin-call-dce
8145 @opindex ftree-builtin-call-dce
8146 Perform conditional dead code elimination (DCE) for calls to built-in functions
8147 that may set @code{errno} but are otherwise side-effect free.  This flag is
8148 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8149 specified.
8151 @item -ftree-dominator-opts
8152 @opindex ftree-dominator-opts
8153 Perform a variety of simple scalar cleanups (constant/copy
8154 propagation, redundancy elimination, range propagation and expression
8155 simplification) based on a dominator tree traversal.  This also
8156 performs jump threading (to reduce jumps to jumps). This flag is
8157 enabled by default at @option{-O} and higher.
8159 @item -ftree-dse
8160 @opindex ftree-dse
8161 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8162 a memory location that is later overwritten by another store without
8163 any intervening loads.  In this case the earlier store can be deleted.  This
8164 flag is enabled by default at @option{-O} and higher.
8166 @item -ftree-ch
8167 @opindex ftree-ch
8168 Perform loop header copying on trees.  This is beneficial since it increases
8169 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8170 is enabled by default at @option{-O} and higher.  It is not enabled
8171 for @option{-Os}, since it usually increases code size.
8173 @item -ftree-loop-optimize
8174 @opindex ftree-loop-optimize
8175 Perform loop optimizations on trees.  This flag is enabled by default
8176 at @option{-O} and higher.
8178 @item -ftree-loop-linear
8179 @opindex ftree-loop-linear
8180 Perform loop interchange transformations on tree.  Same as
8181 @option{-floop-interchange}.  To use this code transformation, GCC has
8182 to be configured with @option{--with-ppl} and @option{--with-cloog} to
8183 enable the Graphite loop transformation infrastructure.
8185 @item -floop-interchange
8186 @opindex floop-interchange
8187 Perform loop interchange transformations on loops.  Interchanging two
8188 nested loops switches the inner and outer loops.  For example, given a
8189 loop like:
8190 @smallexample
8191 DO J = 1, M
8192   DO I = 1, N
8193     A(J, I) = A(J, I) * C
8194   ENDDO
8195 ENDDO
8196 @end smallexample
8197 loop interchange transforms the loop as if it were written:
8198 @smallexample
8199 DO I = 1, N
8200   DO J = 1, M
8201     A(J, I) = A(J, I) * C
8202   ENDDO
8203 ENDDO
8204 @end smallexample
8205 which can be beneficial when @code{N} is larger than the caches,
8206 because in Fortran, the elements of an array are stored in memory
8207 contiguously by column, and the original loop iterates over rows,
8208 potentially creating at each access a cache miss.  This optimization
8209 applies to all the languages supported by GCC and is not limited to
8210 Fortran.  To use this code transformation, GCC has to be configured
8211 with @option{--with-ppl} and @option{--with-cloog} to enable the
8212 Graphite loop transformation infrastructure.
8214 @item -floop-strip-mine
8215 @opindex floop-strip-mine
8216 Perform loop strip mining transformations on loops.  Strip mining
8217 splits a loop into two nested loops.  The outer loop has strides
8218 equal to the strip size and the inner loop has strides of the
8219 original loop within a strip.  The strip length can be changed
8220 using the @option{loop-block-tile-size} parameter.  For example,
8221 given a loop like:
8222 @smallexample
8223 DO I = 1, N
8224   A(I) = A(I) + C
8225 ENDDO
8226 @end smallexample
8227 loop strip mining transforms the loop as if it were written:
8228 @smallexample
8229 DO II = 1, N, 51
8230   DO I = II, min (II + 50, N)
8231     A(I) = A(I) + C
8232   ENDDO
8233 ENDDO
8234 @end smallexample
8235 This optimization applies to all the languages supported by GCC and is
8236 not limited to Fortran.  To use this code transformation, GCC has to
8237 be configured with @option{--with-ppl} and @option{--with-cloog} to
8238 enable the Graphite loop transformation infrastructure.
8240 @item -floop-block
8241 @opindex floop-block
8242 Perform loop blocking transformations on loops.  Blocking strip mines
8243 each loop in the loop nest such that the memory accesses of the
8244 element loops fit inside caches.  The strip length can be changed
8245 using the @option{loop-block-tile-size} parameter.  For example, given
8246 a loop like:
8247 @smallexample
8248 DO I = 1, N
8249   DO J = 1, M
8250     A(J, I) = B(I) + C(J)
8251   ENDDO
8252 ENDDO
8253 @end smallexample
8254 loop blocking transforms the loop as if it were written:
8255 @smallexample
8256 DO II = 1, N, 51
8257   DO JJ = 1, M, 51
8258     DO I = II, min (II + 50, N)
8259       DO J = JJ, min (JJ + 50, M)
8260         A(J, I) = B(I) + C(J)
8261       ENDDO
8262     ENDDO
8263   ENDDO
8264 ENDDO
8265 @end smallexample
8266 which can be beneficial when @code{M} is larger than the caches,
8267 because the innermost loop iterates over a smaller amount of data
8268 which can be kept in the caches.  This optimization applies to all the
8269 languages supported by GCC and is not limited to Fortran.  To use this
8270 code transformation, GCC has to be configured with @option{--with-ppl}
8271 and @option{--with-cloog} to enable the Graphite loop transformation
8272 infrastructure.
8274 @item -fgraphite-identity
8275 @opindex fgraphite-identity
8276 Enable the identity transformation for graphite.  For every SCoP we generate
8277 the polyhedral representation and transform it back to gimple.  Using
8278 @option{-fgraphite-identity} we can check the costs or benefits of the
8279 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8280 are also performed by the code generator CLooG, like index splitting and
8281 dead code elimination in loops.
8283 @item -floop-nest-optimize
8284 @opindex floop-nest-optimize
8285 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8286 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8287 structure optimized for data-locality and parallelism.  This option
8288 is experimental.
8290 @item -floop-parallelize-all
8291 @opindex floop-parallelize-all
8292 Use the Graphite data dependence analysis to identify loops that can
8293 be parallelized.  Parallelize all the loops that can be analyzed to
8294 not contain loop carried dependences without checking that it is
8295 profitable to parallelize the loops.
8297 @item -fcheck-data-deps
8298 @opindex fcheck-data-deps
8299 Compare the results of several data dependence analyzers.  This option
8300 is used for debugging the data dependence analyzers.
8302 @item -ftree-loop-if-convert
8303 Attempt to transform conditional jumps in the innermost loops to
8304 branch-less equivalents.  The intent is to remove control-flow from
8305 the innermost loops in order to improve the ability of the
8306 vectorization pass to handle these loops.  This is enabled by default
8307 if vectorization is enabled.
8309 @item -ftree-loop-if-convert-stores
8310 Attempt to also if-convert conditional jumps containing memory writes.
8311 This transformation can be unsafe for multi-threaded programs as it
8312 transforms conditional memory writes into unconditional memory writes.
8313 For example,
8314 @smallexample
8315 for (i = 0; i < N; i++)
8316   if (cond)
8317     A[i] = expr;
8318 @end smallexample
8319 is transformed to
8320 @smallexample
8321 for (i = 0; i < N; i++)
8322   A[i] = cond ? expr : A[i];
8323 @end smallexample
8324 potentially producing data races.
8326 @item -ftree-loop-distribution
8327 Perform loop distribution.  This flag can improve cache performance on
8328 big loop bodies and allow further loop optimizations, like
8329 parallelization or vectorization, to take place.  For example, the loop
8330 @smallexample
8331 DO I = 1, N
8332   A(I) = B(I) + C
8333   D(I) = E(I) * F
8334 ENDDO
8335 @end smallexample
8336 is transformed to
8337 @smallexample
8338 DO I = 1, N
8339    A(I) = B(I) + C
8340 ENDDO
8341 DO I = 1, N
8342    D(I) = E(I) * F
8343 ENDDO
8344 @end smallexample
8346 @item -ftree-loop-distribute-patterns
8347 Perform loop distribution of patterns that can be code generated with
8348 calls to a library.  This flag is enabled by default at @option{-O3}.
8350 This pass distributes the initialization loops and generates a call to
8351 memset zero.  For example, the loop
8352 @smallexample
8353 DO I = 1, N
8354   A(I) = 0
8355   B(I) = A(I) + I
8356 ENDDO
8357 @end smallexample
8358 is transformed to
8359 @smallexample
8360 DO I = 1, N
8361    A(I) = 0
8362 ENDDO
8363 DO I = 1, N
8364    B(I) = A(I) + I
8365 ENDDO
8366 @end smallexample
8367 and the initialization loop is transformed into a call to memset zero.
8369 @item -ftree-loop-im
8370 @opindex ftree-loop-im
8371 Perform loop invariant motion on trees.  This pass moves only invariants that
8372 are hard to handle at RTL level (function calls, operations that expand to
8373 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8374 operands of conditions that are invariant out of the loop, so that we can use
8375 just trivial invariantness analysis in loop unswitching.  The pass also includes
8376 store motion.
8378 @item -ftree-loop-ivcanon
8379 @opindex ftree-loop-ivcanon
8380 Create a canonical counter for number of iterations in loops for which
8381 determining number of iterations requires complicated analysis.  Later
8382 optimizations then may determine the number easily.  Useful especially
8383 in connection with unrolling.
8385 @item -fivopts
8386 @opindex fivopts
8387 Perform induction variable optimizations (strength reduction, induction
8388 variable merging and induction variable elimination) on trees.
8390 @item -ftree-parallelize-loops=n
8391 @opindex ftree-parallelize-loops
8392 Parallelize loops, i.e., split their iteration space to run in n threads.
8393 This is only possible for loops whose iterations are independent
8394 and can be arbitrarily reordered.  The optimization is only
8395 profitable on multiprocessor machines, for loops that are CPU-intensive,
8396 rather than constrained e.g.@: by memory bandwidth.  This option
8397 implies @option{-pthread}, and thus is only supported on targets
8398 that have support for @option{-pthread}.
8400 @item -ftree-pta
8401 @opindex ftree-pta
8402 Perform function-local points-to analysis on trees.  This flag is
8403 enabled by default at @option{-O} and higher.
8405 @item -ftree-sra
8406 @opindex ftree-sra
8407 Perform scalar replacement of aggregates.  This pass replaces structure
8408 references with scalars to prevent committing structures to memory too
8409 early.  This flag is enabled by default at @option{-O} and higher.
8411 @item -ftree-copyrename
8412 @opindex ftree-copyrename
8413 Perform copy renaming on trees.  This pass attempts to rename compiler
8414 temporaries to other variables at copy locations, usually resulting in
8415 variable names which more closely resemble the original variables.  This flag
8416 is enabled by default at @option{-O} and higher.
8418 @item -ftree-coalesce-inlined-vars
8419 @opindex ftree-coalesce-inlined-vars
8420 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8421 combine small user-defined variables too, but only if they were inlined
8422 from other functions.  It is a more limited form of
8423 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8424 inlined variables, but it will keep variables of the inlined-into
8425 function apart from each other, such that they are more likely to
8426 contain the expected values in a debugging session.  This was the
8427 default in GCC versions older than 4.7.
8429 @item -ftree-coalesce-vars
8430 @opindex ftree-coalesce-vars
8431 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8432 combine small user-defined variables too, instead of just compiler
8433 temporaries.  This may severely limit the ability to debug an optimized
8434 program compiled with @option{-fno-var-tracking-assignments}.  In the
8435 negated form, this flag prevents SSA coalescing of user variables,
8436 including inlined ones.  This option is enabled by default.
8438 @item -ftree-ter
8439 @opindex ftree-ter
8440 Perform temporary expression replacement during the SSA->normal phase.  Single
8441 use/single def temporaries are replaced at their use location with their
8442 defining expression.  This results in non-GIMPLE code, but gives the expanders
8443 much more complex trees to work on resulting in better RTL generation.  This is
8444 enabled by default at @option{-O} and higher.
8446 @item -ftree-slsr
8447 @opindex ftree-slsr
8448 Perform straight-line strength reduction on trees.  This recognizes related
8449 expressions involving multiplications and replaces them by less expensive
8450 calculations when possible.  This is enabled by default at @option{-O} and
8451 higher.
8453 @item -ftree-vectorize
8454 @opindex ftree-vectorize
8455 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8456 and @option{-ftree-slp-vectorize} if not explicitly specified.
8458 @item -ftree-loop-vectorize
8459 @opindex ftree-loop-vectorize
8460 Perform loop vectorization on trees. This flag is enabled by default at
8461 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8463 @item -ftree-slp-vectorize
8464 @opindex ftree-slp-vectorize
8465 Perform basic block vectorization on trees. This flag is enabled by default at
8466 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8468 @item -fvect-cost-model=@var{model}
8469 @opindex fvect-cost-model
8470 Alter the cost model used for vectorization.  The @var{model} argument
8471 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8472 With the @code{unlimited} model the vectorized code-path is assumed
8473 to be profitable while with the @code{dynamic} model a runtime check
8474 will guard the vectorized code-path to enable it only for iteration
8475 counts that will likely execute faster than when executing the original
8476 scalar loop.  The @code{cheap} model will disable vectorization of
8477 loops where doing so would be cost prohibitive for example due to
8478 required runtime checks for data dependence or alignment but otherwise
8479 is equal to the @code{dynamic} model.
8480 The default cost model depends on other optimization flags and is
8481 either @code{dynamic} or @code{cheap}.
8483 @item -fsimd-cost-model=@var{model}
8484 @opindex fsimd-cost-model
8485 Alter the cost model used for vectorization of loops marked with the OpenMP
8486 or Cilk Plus simd directive.  The @var{model} argument should be one of
8487 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8488 have the same meaning as described in @option{-fvect-cost-model} and by
8489 default a cost model defined with @option{-fvect-cost-model} is used.
8491 @item -ftree-vrp
8492 @opindex ftree-vrp
8493 Perform Value Range Propagation on trees.  This is similar to the
8494 constant propagation pass, but instead of values, ranges of values are
8495 propagated.  This allows the optimizers to remove unnecessary range
8496 checks like array bound checks and null pointer checks.  This is
8497 enabled by default at @option{-O2} and higher.  Null pointer check
8498 elimination is only done if @option{-fdelete-null-pointer-checks} is
8499 enabled.
8501 @item -ftracer
8502 @opindex ftracer
8503 Perform tail duplication to enlarge superblock size.  This transformation
8504 simplifies the control flow of the function allowing other optimizations to do
8505 a better job.
8507 @item -funroll-loops
8508 @opindex funroll-loops
8509 Unroll loops whose number of iterations can be determined at compile
8510 time or upon entry to the loop.  @option{-funroll-loops} implies
8511 @option{-frerun-cse-after-loop}.  This option makes code larger,
8512 and may or may not make it run faster.
8514 @item -funroll-all-loops
8515 @opindex funroll-all-loops
8516 Unroll all loops, even if their number of iterations is uncertain when
8517 the loop is entered.  This usually makes programs run more slowly.
8518 @option{-funroll-all-loops} implies the same options as
8519 @option{-funroll-loops},
8521 @item -fsplit-ivs-in-unroller
8522 @opindex fsplit-ivs-in-unroller
8523 Enables expression of values of induction variables in later iterations
8524 of the unrolled loop using the value in the first iteration.  This breaks
8525 long dependency chains, thus improving efficiency of the scheduling passes.
8527 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8528 same effect.  However, that is not reliable in cases where the loop body
8529 is more complicated than a single basic block.  It also does not work at all
8530 on some architectures due to restrictions in the CSE pass.
8532 This optimization is enabled by default.
8534 @item -fvariable-expansion-in-unroller
8535 @opindex fvariable-expansion-in-unroller
8536 With this option, the compiler creates multiple copies of some
8537 local variables when unrolling a loop, which can result in superior code.
8539 @item -fpartial-inlining
8540 @opindex fpartial-inlining
8541 Inline parts of functions.  This option has any effect only
8542 when inlining itself is turned on by the @option{-finline-functions}
8543 or @option{-finline-small-functions} options.
8545 Enabled at level @option{-O2}.
8547 @item -fpredictive-commoning
8548 @opindex fpredictive-commoning
8549 Perform predictive commoning optimization, i.e., reusing computations
8550 (especially memory loads and stores) performed in previous
8551 iterations of loops.
8553 This option is enabled at level @option{-O3}.
8555 @item -fprefetch-loop-arrays
8556 @opindex fprefetch-loop-arrays
8557 If supported by the target machine, generate instructions to prefetch
8558 memory to improve the performance of loops that access large arrays.
8560 This option may generate better or worse code; results are highly
8561 dependent on the structure of loops within the source code.
8563 Disabled at level @option{-Os}.
8565 @item -fno-peephole
8566 @itemx -fno-peephole2
8567 @opindex fno-peephole
8568 @opindex fno-peephole2
8569 Disable any machine-specific peephole optimizations.  The difference
8570 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8571 are implemented in the compiler; some targets use one, some use the
8572 other, a few use both.
8574 @option{-fpeephole} is enabled by default.
8575 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8577 @item -fno-guess-branch-probability
8578 @opindex fno-guess-branch-probability
8579 Do not guess branch probabilities using heuristics.
8581 GCC uses heuristics to guess branch probabilities if they are
8582 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8583 heuristics are based on the control flow graph.  If some branch probabilities
8584 are specified by @samp{__builtin_expect}, then the heuristics are
8585 used to guess branch probabilities for the rest of the control flow graph,
8586 taking the @samp{__builtin_expect} info into account.  The interactions
8587 between the heuristics and @samp{__builtin_expect} can be complex, and in
8588 some cases, it may be useful to disable the heuristics so that the effects
8589 of @samp{__builtin_expect} are easier to understand.
8591 The default is @option{-fguess-branch-probability} at levels
8592 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8594 @item -freorder-blocks
8595 @opindex freorder-blocks
8596 Reorder basic blocks in the compiled function in order to reduce number of
8597 taken branches and improve code locality.
8599 Enabled at levels @option{-O2}, @option{-O3}.
8601 @item -freorder-blocks-and-partition
8602 @opindex freorder-blocks-and-partition
8603 In addition to reordering basic blocks in the compiled function, in order
8604 to reduce number of taken branches, partitions hot and cold basic blocks
8605 into separate sections of the assembly and .o files, to improve
8606 paging and cache locality performance.
8608 This optimization is automatically turned off in the presence of
8609 exception handling, for linkonce sections, for functions with a user-defined
8610 section attribute and on any architecture that does not support named
8611 sections.
8613 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8615 @item -freorder-functions
8616 @opindex freorder-functions
8617 Reorder functions in the object file in order to
8618 improve code locality.  This is implemented by using special
8619 subsections @code{.text.hot} for most frequently executed functions and
8620 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8621 the linker so object file format must support named sections and linker must
8622 place them in a reasonable way.
8624 Also profile feedback must be available to make this option effective.  See
8625 @option{-fprofile-arcs} for details.
8627 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8629 @item -fstrict-aliasing
8630 @opindex fstrict-aliasing
8631 Allow the compiler to assume the strictest aliasing rules applicable to
8632 the language being compiled.  For C (and C++), this activates
8633 optimizations based on the type of expressions.  In particular, an
8634 object of one type is assumed never to reside at the same address as an
8635 object of a different type, unless the types are almost the same.  For
8636 example, an @code{unsigned int} can alias an @code{int}, but not a
8637 @code{void*} or a @code{double}.  A character type may alias any other
8638 type.
8640 @anchor{Type-punning}Pay special attention to code like this:
8641 @smallexample
8642 union a_union @{
8643   int i;
8644   double d;
8647 int f() @{
8648   union a_union t;
8649   t.d = 3.0;
8650   return t.i;
8652 @end smallexample
8653 The practice of reading from a different union member than the one most
8654 recently written to (called ``type-punning'') is common.  Even with
8655 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8656 is accessed through the union type.  So, the code above works as
8657 expected.  @xref{Structures unions enumerations and bit-fields
8658 implementation}.  However, this code might not:
8659 @smallexample
8660 int f() @{
8661   union a_union t;
8662   int* ip;
8663   t.d = 3.0;
8664   ip = &t.i;
8665   return *ip;
8667 @end smallexample
8669 Similarly, access by taking the address, casting the resulting pointer
8670 and dereferencing the result has undefined behavior, even if the cast
8671 uses a union type, e.g.:
8672 @smallexample
8673 int f() @{
8674   double d = 3.0;
8675   return ((union a_union *) &d)->i;
8677 @end smallexample
8679 The @option{-fstrict-aliasing} option is enabled at levels
8680 @option{-O2}, @option{-O3}, @option{-Os}.
8682 @item -fstrict-overflow
8683 @opindex fstrict-overflow
8684 Allow the compiler to assume strict signed overflow rules, depending
8685 on the language being compiled.  For C (and C++) this means that
8686 overflow when doing arithmetic with signed numbers is undefined, which
8687 means that the compiler may assume that it does not happen.  This
8688 permits various optimizations.  For example, the compiler assumes
8689 that an expression like @code{i + 10 > i} is always true for
8690 signed @code{i}.  This assumption is only valid if signed overflow is
8691 undefined, as the expression is false if @code{i + 10} overflows when
8692 using twos complement arithmetic.  When this option is in effect any
8693 attempt to determine whether an operation on signed numbers 
8694 overflows must be written carefully to not actually involve overflow.
8696 This option also allows the compiler to assume strict pointer
8697 semantics: given a pointer to an object, if adding an offset to that
8698 pointer does not produce a pointer to the same object, the addition is
8699 undefined.  This permits the compiler to conclude that @code{p + u >
8700 p} is always true for a pointer @code{p} and unsigned integer
8701 @code{u}.  This assumption is only valid because pointer wraparound is
8702 undefined, as the expression is false if @code{p + u} overflows using
8703 twos complement arithmetic.
8705 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8706 that integer signed overflow is fully defined: it wraps.  When
8707 @option{-fwrapv} is used, there is no difference between
8708 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8709 integers.  With @option{-fwrapv} certain types of overflow are
8710 permitted.  For example, if the compiler gets an overflow when doing
8711 arithmetic on constants, the overflowed value can still be used with
8712 @option{-fwrapv}, but not otherwise.
8714 The @option{-fstrict-overflow} option is enabled at levels
8715 @option{-O2}, @option{-O3}, @option{-Os}.
8717 @item -falign-functions
8718 @itemx -falign-functions=@var{n}
8719 @opindex falign-functions
8720 Align the start of functions to the next power-of-two greater than
8721 @var{n}, skipping up to @var{n} bytes.  For instance,
8722 @option{-falign-functions=32} aligns functions to the next 32-byte
8723 boundary, but @option{-falign-functions=24} aligns to the next
8724 32-byte boundary only if this can be done by skipping 23 bytes or less.
8726 @option{-fno-align-functions} and @option{-falign-functions=1} are
8727 equivalent and mean that functions are not aligned.
8729 Some assemblers only support this flag when @var{n} is a power of two;
8730 in that case, it is rounded up.
8732 If @var{n} is not specified or is zero, use a machine-dependent default.
8734 Enabled at levels @option{-O2}, @option{-O3}.
8736 @item -falign-labels
8737 @itemx -falign-labels=@var{n}
8738 @opindex falign-labels
8739 Align all branch targets to a power-of-two boundary, skipping up to
8740 @var{n} bytes like @option{-falign-functions}.  This option can easily
8741 make code slower, because it must insert dummy operations for when the
8742 branch target is reached in the usual flow of the code.
8744 @option{-fno-align-labels} and @option{-falign-labels=1} are
8745 equivalent and mean that labels are not aligned.
8747 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8748 are greater than this value, then their values are used instead.
8750 If @var{n} is not specified or is zero, use a machine-dependent default
8751 which is very likely to be @samp{1}, meaning no alignment.
8753 Enabled at levels @option{-O2}, @option{-O3}.
8755 @item -falign-loops
8756 @itemx -falign-loops=@var{n}
8757 @opindex falign-loops
8758 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8759 like @option{-falign-functions}.  If the loops are
8760 executed many times, this makes up for any execution of the dummy
8761 operations.
8763 @option{-fno-align-loops} and @option{-falign-loops=1} are
8764 equivalent and mean that loops are not aligned.
8766 If @var{n} is not specified or is zero, use a machine-dependent default.
8768 Enabled at levels @option{-O2}, @option{-O3}.
8770 @item -falign-jumps
8771 @itemx -falign-jumps=@var{n}
8772 @opindex falign-jumps
8773 Align branch targets to a power-of-two boundary, for branch targets
8774 where the targets can only be reached by jumping, skipping up to @var{n}
8775 bytes like @option{-falign-functions}.  In this case, no dummy operations
8776 need be executed.
8778 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8779 equivalent and mean that loops are not aligned.
8781 If @var{n} is not specified or is zero, use a machine-dependent default.
8783 Enabled at levels @option{-O2}, @option{-O3}.
8785 @item -funit-at-a-time
8786 @opindex funit-at-a-time
8787 This option is left for compatibility reasons. @option{-funit-at-a-time}
8788 has no effect, while @option{-fno-unit-at-a-time} implies
8789 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8791 Enabled by default.
8793 @item -fno-toplevel-reorder
8794 @opindex fno-toplevel-reorder
8795 Do not reorder top-level functions, variables, and @code{asm}
8796 statements.  Output them in the same order that they appear in the
8797 input file.  When this option is used, unreferenced static variables
8798 are not removed.  This option is intended to support existing code
8799 that relies on a particular ordering.  For new code, it is better to
8800 use attributes when possible.
8802 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8803 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8804 targets.
8806 @item -fweb
8807 @opindex fweb
8808 Constructs webs as commonly used for register allocation purposes and assign
8809 each web individual pseudo register.  This allows the register allocation pass
8810 to operate on pseudos directly, but also strengthens several other optimization
8811 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8812 however, make debugging impossible, since variables no longer stay in a
8813 ``home register''.
8815 Enabled by default with @option{-funroll-loops}.
8817 @item -fwhole-program
8818 @opindex fwhole-program
8819 Assume that the current compilation unit represents the whole program being
8820 compiled.  All public functions and variables with the exception of @code{main}
8821 and those merged by attribute @code{externally_visible} become static functions
8822 and in effect are optimized more aggressively by interprocedural optimizers.
8824 This option should not be used in combination with @code{-flto}.
8825 Instead relying on a linker plugin should provide safer and more precise
8826 information.
8828 @item -flto[=@var{n}]
8829 @opindex flto
8830 This option runs the standard link-time optimizer.  When invoked
8831 with source code, it generates GIMPLE (one of GCC's internal
8832 representations) and writes it to special ELF sections in the object
8833 file.  When the object files are linked together, all the function
8834 bodies are read from these ELF sections and instantiated as if they
8835 had been part of the same translation unit.
8837 To use the link-time optimizer, @option{-flto} and optimization
8838 options should be specified at compile time and during the final link.
8839 For example:
8841 @smallexample
8842 gcc -c -O2 -flto foo.c
8843 gcc -c -O2 -flto bar.c
8844 gcc -o myprog -flto -O2 foo.o bar.o
8845 @end smallexample
8847 The first two invocations to GCC save a bytecode representation
8848 of GIMPLE into special ELF sections inside @file{foo.o} and
8849 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8850 @file{foo.o} and @file{bar.o}, merges the two files into a single
8851 internal image, and compiles the result as usual.  Since both
8852 @file{foo.o} and @file{bar.o} are merged into a single image, this
8853 causes all the interprocedural analyses and optimizations in GCC to
8854 work across the two files as if they were a single one.  This means,
8855 for example, that the inliner is able to inline functions in
8856 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8858 Another (simpler) way to enable link-time optimization is:
8860 @smallexample
8861 gcc -o myprog -flto -O2 foo.c bar.c
8862 @end smallexample
8864 The above generates bytecode for @file{foo.c} and @file{bar.c},
8865 merges them together into a single GIMPLE representation and optimizes
8866 them as usual to produce @file{myprog}.
8868 The only important thing to keep in mind is that to enable link-time
8869 optimizations you need to use the GCC driver to perform the link-step.
8870 GCC then automatically performs link-time optimization if any of the
8871 objects involved were compiled with the @option{-flto}.  You generally
8872 should specify the optimization options to be used for link-time
8873 optimization though GCC will try to be clever at guessing an
8874 optimization level to use from the options used at compile-time
8875 if you fail to specify one at link-time.  You can always override
8876 the automatic decision to do link-time optimization at link-time
8877 by passing @option{-fno-lto} to the link command.
8879 To make whole program optimization effective, it is necessary to make
8880 certain whole program assumptions.  The compiler needs to know
8881 what functions and variables can be accessed by libraries and runtime
8882 outside of the link-time optimized unit.  When supported by the linker,
8883 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8884 to the compiler about used and externally visible symbols.  When
8885 the linker plugin is not available, @option{-fwhole-program} should be
8886 used to allow the compiler to make these assumptions, which leads
8887 to more aggressive optimization decisions.
8889 When @option{-fuse-linker-plugin} is not enabled then, when a file is
8890 compiled with @option{-flto}, the generated object file is larger than
8891 a regular object file because it contains GIMPLE bytecodes and the usual
8892 final code (see @option{-ffat-lto-objects}.  This means that
8893 object files with LTO information can be linked as normal object
8894 files; if @option{-fno-lto} is passed to the linker, no
8895 interprocedural optimizations are applied.  Note that when
8896 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
8897 but you cannot perform a regular, non-LTO link on them.
8899 Additionally, the optimization flags used to compile individual files
8900 are not necessarily related to those used at link time.  For instance,
8902 @smallexample
8903 gcc -c -O0 -ffat-lto-objects -flto foo.c
8904 gcc -c -O0 -ffat-lto-objects -flto bar.c
8905 gcc -o myprog -O3 foo.o bar.o
8906 @end smallexample
8908 This produces individual object files with unoptimized assembler
8909 code, but the resulting binary @file{myprog} is optimized at
8910 @option{-O3}.  If, instead, the final binary is generated with
8911 @option{-fno-lto}, then @file{myprog} is not optimized.
8913 When producing the final binary, GCC only
8914 applies link-time optimizations to those files that contain bytecode.
8915 Therefore, you can mix and match object files and libraries with
8916 GIMPLE bytecodes and final object code.  GCC automatically selects
8917 which files to optimize in LTO mode and which files to link without
8918 further processing.
8920 There are some code generation flags preserved by GCC when
8921 generating bytecodes, as they need to be used during the final link
8922 stage.  Generally options specified at link-time override those
8923 specified at compile-time.
8925 If you do not specify an optimization level option @option{-O} at
8926 link-time then GCC will compute one based on the optimization levels
8927 used when compiling the object files.  The highest optimization
8928 level will win here.
8930 Currently, the following options and their setting are take from
8931 the first object file that explicitely specified it: 
8932 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8933 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8934 and all the @option{-m} target flags.
8936 Certain ABI changing flags are required to match in all compilation-units
8937 and trying to override this at link-time with a conflicting value
8938 is ignored.  This includes options such as @option{-freg-struct-return}
8939 and @option{-fpcc-struct-return}. 
8941 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8942 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8943 are passed through to the link stage and merged conservatively for
8944 conflicting translation units.  Specifically
8945 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8946 precedence and for example @option{-ffp-contract=off} takes precedence
8947 over @option{-ffp-contract=fast}.  You can override them at linke-time.
8949 It is recommended that you compile all the files participating in the
8950 same link with the same options and also specify those options at
8951 link time.
8953 If LTO encounters objects with C linkage declared with incompatible
8954 types in separate translation units to be linked together (undefined
8955 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8956 issued.  The behavior is still undefined at run time.  Similar
8957 diagnostics may be raised for other languages.
8959 Another feature of LTO is that it is possible to apply interprocedural
8960 optimizations on files written in different languages:
8962 @smallexample
8963 gcc -c -flto foo.c
8964 g++ -c -flto bar.cc
8965 gfortran -c -flto baz.f90
8966 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8967 @end smallexample
8969 Notice that the final link is done with @command{g++} to get the C++
8970 runtime libraries and @option{-lgfortran} is added to get the Fortran
8971 runtime libraries.  In general, when mixing languages in LTO mode, you
8972 should use the same link command options as when mixing languages in a
8973 regular (non-LTO) compilation.
8975 If object files containing GIMPLE bytecode are stored in a library archive, say
8976 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8977 are using a linker with plugin support.  To create static libraries suitable
8978 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8979 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
8980 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8981 and @command{nm} have been compiled with plugin support.  At link time, use the the
8982 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8983 the LTO optimization process:
8985 @smallexample
8986 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8987 @end smallexample
8989 With the linker plugin enabled, the linker extracts the needed
8990 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8991 to make them part of the aggregated GIMPLE image to be optimized.
8993 If you are not using a linker with plugin support and/or do not
8994 enable the linker plugin, then the objects inside @file{libfoo.a}
8995 are extracted and linked as usual, but they do not participate
8996 in the LTO optimization process.  In order to make a static library suitable
8997 for both LTO optimization and usual linkage, compile its object files with
8998 @option{-flto} @code{-ffat-lto-objects}.
9000 Link-time optimizations do not require the presence of the whole program to
9001 operate.  If the program does not require any symbols to be exported, it is
9002 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9003 the interprocedural optimizers to use more aggressive assumptions which may
9004 lead to improved optimization opportunities.
9005 Use of @option{-fwhole-program} is not needed when linker plugin is
9006 active (see @option{-fuse-linker-plugin}).
9008 The current implementation of LTO makes no
9009 attempt to generate bytecode that is portable between different
9010 types of hosts.  The bytecode files are versioned and there is a
9011 strict version check, so bytecode files generated in one version of
9012 GCC will not work with an older or newer version of GCC.
9014 Link-time optimization does not work well with generation of debugging
9015 information.  Combining @option{-flto} with
9016 @option{-g} is currently experimental and expected to produce unexpected
9017 results.
9019 If you specify the optional @var{n}, the optimization and code
9020 generation done at link time is executed in parallel using @var{n}
9021 parallel jobs by utilizing an installed @command{make} program.  The
9022 environment variable @env{MAKE} may be used to override the program
9023 used.  The default value for @var{n} is 1.
9025 You can also specify @option{-flto=jobserver} to use GNU make's
9026 job server mode to determine the number of parallel jobs. This
9027 is useful when the Makefile calling GCC is already executing in parallel.
9028 You must prepend a @samp{+} to the command recipe in the parent Makefile
9029 for this to work.  This option likely only works if @env{MAKE} is
9030 GNU make.
9032 @item -flto-partition=@var{alg}
9033 @opindex flto-partition
9034 Specify the partitioning algorithm used by the link-time optimizer.
9035 The value is either @code{1to1} to specify a partitioning mirroring
9036 the original source files or @code{balanced} to specify partitioning
9037 into equally sized chunks (whenever possible) or @code{max} to create
9038 new partition for every symbol where possible.  Specifying @code{none}
9039 as an algorithm disables partitioning and streaming completely. 
9040 The default value is @code{balanced}. While @code{1to1} can be used
9041 as an workaround for various code ordering issues, the @code{max}
9042 partitioning is intended for internal testing only.
9043 The value @code{one} specifies that exactly one partition should be
9044 used while the value @code{none} bypasses partitioning and executes
9045 the link-time optimization step directly from the WPA phase.
9047 @item -flto-odr-type-merging
9048 @opindex flto-odr-type-merging
9049 Enable streaming of mangled types names of C++ types and their unification
9050 at linktime.  This increases size of LTO object files, but enable
9051 diagnostics about One Definition Rule violations.
9053 @item -flto-compression-level=@var{n}
9054 This option specifies the level of compression used for intermediate
9055 language written to LTO object files, and is only meaningful in
9056 conjunction with LTO mode (@option{-flto}).  Valid
9057 values are 0 (no compression) to 9 (maximum compression).  Values
9058 outside this range are clamped to either 0 or 9.  If the option is not
9059 given, a default balanced compression setting is used.
9061 @item -flto-report
9062 Prints a report with internal details on the workings of the link-time
9063 optimizer.  The contents of this report vary from version to version.
9064 It is meant to be useful to GCC developers when processing object
9065 files in LTO mode (via @option{-flto}).
9067 Disabled by default.
9069 @item -flto-report-wpa
9070 Like @option{-flto-report}, but only print for the WPA phase of Link
9071 Time Optimization.
9073 @item -fuse-linker-plugin
9074 Enables the use of a linker plugin during link-time optimization.  This
9075 option relies on plugin support in the linker, which is available in gold
9076 or in GNU ld 2.21 or newer.
9078 This option enables the extraction of object files with GIMPLE bytecode out
9079 of library archives. This improves the quality of optimization by exposing
9080 more code to the link-time optimizer.  This information specifies what
9081 symbols can be accessed externally (by non-LTO object or during dynamic
9082 linking).  Resulting code quality improvements on binaries (and shared
9083 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
9084 See @option{-flto} for a description of the effect of this flag and how to
9085 use it.
9087 This option is enabled by default when LTO support in GCC is enabled
9088 and GCC was configured for use with
9089 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9091 @item -ffat-lto-objects
9092 @opindex ffat-lto-objects
9093 Fat LTO objects are object files that contain both the intermediate language
9094 and the object code. This makes them usable for both LTO linking and normal
9095 linking. This option is effective only when compiling with @option{-flto}
9096 and is ignored at link time.
9098 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9099 requires the complete toolchain to be aware of LTO. It requires a linker with
9100 linker plugin support for basic functionality.  Additionally,
9101 @command{nm}, @command{ar} and @command{ranlib}
9102 need to support linker plugins to allow a full-featured build environment
9103 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9104 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9105 to these tools. With non fat LTO makefiles need to be modified to use them.
9107 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9108 support.
9110 @item -fcompare-elim
9111 @opindex fcompare-elim
9112 After register allocation and post-register allocation instruction splitting,
9113 identify arithmetic instructions that compute processor flags similar to a
9114 comparison operation based on that arithmetic.  If possible, eliminate the
9115 explicit comparison operation.
9117 This pass only applies to certain targets that cannot explicitly represent
9118 the comparison operation before register allocation is complete.
9120 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9122 @item -fuse-ld=bfd
9123 @opindex fuse-ld=bfd
9124 Use the @command{bfd} linker instead of the default linker.
9126 @item -fuse-ld=gold
9127 @opindex fuse-ld=gold
9128 Use the @command{gold} linker instead of the default linker.
9130 @item -fcprop-registers
9131 @opindex fcprop-registers
9132 After register allocation and post-register allocation instruction splitting,
9133 perform a copy-propagation pass to try to reduce scheduling dependencies
9134 and occasionally eliminate the copy.
9136 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9138 @item -fprofile-correction
9139 @opindex fprofile-correction
9140 Profiles collected using an instrumented binary for multi-threaded programs may
9141 be inconsistent due to missed counter updates. When this option is specified,
9142 GCC uses heuristics to correct or smooth out such inconsistencies. By
9143 default, GCC emits an error message when an inconsistent profile is detected.
9145 @item -fprofile-dir=@var{path}
9146 @opindex fprofile-dir
9148 Set the directory to search for the profile data files in to @var{path}.
9149 This option affects only the profile data generated by
9150 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9151 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9152 and its related options.  Both absolute and relative paths can be used.
9153 By default, GCC uses the current directory as @var{path}, thus the
9154 profile data file appears in the same directory as the object file.
9156 @item -fprofile-generate
9157 @itemx -fprofile-generate=@var{path}
9158 @opindex fprofile-generate
9160 Enable options usually used for instrumenting application to produce
9161 profile useful for later recompilation with profile feedback based
9162 optimization.  You must use @option{-fprofile-generate} both when
9163 compiling and when linking your program.
9165 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
9167 If @var{path} is specified, GCC looks at the @var{path} to find
9168 the profile feedback data files. See @option{-fprofile-dir}.
9170 @item -fprofile-use
9171 @itemx -fprofile-use=@var{path}
9172 @opindex fprofile-use
9173 Enable profile feedback directed optimizations, and optimizations
9174 generally profitable only with profile feedback available.
9176 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9177 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9178 @code{ftree-loop-distribute-patterns}
9180 By default, GCC emits an error message if the feedback profiles do not
9181 match the source code.  This error can be turned into a warning by using
9182 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9183 code.
9185 If @var{path} is specified, GCC looks at the @var{path} to find
9186 the profile feedback data files. See @option{-fprofile-dir}.
9187 @end table
9189 The following options control compiler behavior regarding floating-point 
9190 arithmetic.  These options trade off between speed and
9191 correctness.  All must be specifically enabled.
9193 @table @gcctabopt
9194 @item -ffloat-store
9195 @opindex ffloat-store
9196 Do not store floating-point variables in registers, and inhibit other
9197 options that might change whether a floating-point value is taken from a
9198 register or memory.
9200 @cindex floating-point precision
9201 This option prevents undesirable excess precision on machines such as
9202 the 68000 where the floating registers (of the 68881) keep more
9203 precision than a @code{double} is supposed to have.  Similarly for the
9204 x86 architecture.  For most programs, the excess precision does only
9205 good, but a few programs rely on the precise definition of IEEE floating
9206 point.  Use @option{-ffloat-store} for such programs, after modifying
9207 them to store all pertinent intermediate computations into variables.
9209 @item -fexcess-precision=@var{style}
9210 @opindex fexcess-precision
9211 This option allows further control over excess precision on machines
9212 where floating-point registers have more precision than the IEEE
9213 @code{float} and @code{double} types and the processor does not
9214 support operations rounding to those types.  By default,
9215 @option{-fexcess-precision=fast} is in effect; this means that
9216 operations are carried out in the precision of the registers and that
9217 it is unpredictable when rounding to the types specified in the source
9218 code takes place.  When compiling C, if
9219 @option{-fexcess-precision=standard} is specified then excess
9220 precision follows the rules specified in ISO C99; in particular,
9221 both casts and assignments cause values to be rounded to their
9222 semantic types (whereas @option{-ffloat-store} only affects
9223 assignments).  This option is enabled by default for C if a strict
9224 conformance option such as @option{-std=c99} is used.
9226 @opindex mfpmath
9227 @option{-fexcess-precision=standard} is not implemented for languages
9228 other than C, and has no effect if
9229 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9230 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9231 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9232 semantics apply without excess precision, and in the latter, rounding
9233 is unpredictable.
9235 @item -ffast-math
9236 @opindex ffast-math
9237 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9238 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9239 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9241 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9243 This option is not turned on by any @option{-O} option besides
9244 @option{-Ofast} since it can result in incorrect output for programs
9245 that depend on an exact implementation of IEEE or ISO rules/specifications
9246 for math functions. It may, however, yield faster code for programs
9247 that do not require the guarantees of these specifications.
9249 @item -fno-math-errno
9250 @opindex fno-math-errno
9251 Do not set @code{errno} after calling math functions that are executed
9252 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9253 IEEE exceptions for math error handling may want to use this flag
9254 for speed while maintaining IEEE arithmetic compatibility.
9256 This option is not turned on by any @option{-O} option since
9257 it can result in incorrect output for programs that depend on
9258 an exact implementation of IEEE or ISO rules/specifications for
9259 math functions. It may, however, yield faster code for programs
9260 that do not require the guarantees of these specifications.
9262 The default is @option{-fmath-errno}.
9264 On Darwin systems, the math library never sets @code{errno}.  There is
9265 therefore no reason for the compiler to consider the possibility that
9266 it might, and @option{-fno-math-errno} is the default.
9268 @item -funsafe-math-optimizations
9269 @opindex funsafe-math-optimizations
9271 Allow optimizations for floating-point arithmetic that (a) assume
9272 that arguments and results are valid and (b) may violate IEEE or
9273 ANSI standards.  When used at link-time, it may include libraries
9274 or startup files that change the default FPU control word or other
9275 similar optimizations.
9277 This option is not turned on by any @option{-O} option since
9278 it can result in incorrect output for programs that depend on
9279 an exact implementation of IEEE or ISO rules/specifications for
9280 math functions. It may, however, yield faster code for programs
9281 that do not require the guarantees of these specifications.
9282 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9283 @option{-fassociative-math} and @option{-freciprocal-math}.
9285 The default is @option{-fno-unsafe-math-optimizations}.
9287 @item -fassociative-math
9288 @opindex fassociative-math
9290 Allow re-association of operands in series of floating-point operations.
9291 This violates the ISO C and C++ language standard by possibly changing
9292 computation result.  NOTE: re-ordering may change the sign of zero as
9293 well as ignore NaNs and inhibit or create underflow or overflow (and
9294 thus cannot be used on code that relies on rounding behavior like
9295 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9296 and thus may not be used when ordered comparisons are required.
9297 This option requires that both @option{-fno-signed-zeros} and
9298 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9299 much sense with @option{-frounding-math}. For Fortran the option
9300 is automatically enabled when both @option{-fno-signed-zeros} and
9301 @option{-fno-trapping-math} are in effect.
9303 The default is @option{-fno-associative-math}.
9305 @item -freciprocal-math
9306 @opindex freciprocal-math
9308 Allow the reciprocal of a value to be used instead of dividing by
9309 the value if this enables optimizations.  For example @code{x / y}
9310 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9311 is subject to common subexpression elimination.  Note that this loses
9312 precision and increases the number of flops operating on the value.
9314 The default is @option{-fno-reciprocal-math}.
9316 @item -ffinite-math-only
9317 @opindex ffinite-math-only
9318 Allow optimizations for floating-point arithmetic that assume
9319 that arguments and results are not NaNs or +-Infs.
9321 This option is not turned on by any @option{-O} option since
9322 it can result in incorrect output for programs that depend on
9323 an exact implementation of IEEE or ISO rules/specifications for
9324 math functions. It may, however, yield faster code for programs
9325 that do not require the guarantees of these specifications.
9327 The default is @option{-fno-finite-math-only}.
9329 @item -fno-signed-zeros
9330 @opindex fno-signed-zeros
9331 Allow optimizations for floating-point arithmetic that ignore the
9332 signedness of zero.  IEEE arithmetic specifies the behavior of
9333 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9334 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9335 This option implies that the sign of a zero result isn't significant.
9337 The default is @option{-fsigned-zeros}.
9339 @item -fno-trapping-math
9340 @opindex fno-trapping-math
9341 Compile code assuming that floating-point operations cannot generate
9342 user-visible traps.  These traps include division by zero, overflow,
9343 underflow, inexact result and invalid operation.  This option requires
9344 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9345 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9347 This option should never be turned on by any @option{-O} option since
9348 it can result in incorrect output for programs that depend on
9349 an exact implementation of IEEE or ISO rules/specifications for
9350 math functions.
9352 The default is @option{-ftrapping-math}.
9354 @item -frounding-math
9355 @opindex frounding-math
9356 Disable transformations and optimizations that assume default floating-point
9357 rounding behavior.  This is round-to-zero for all floating point
9358 to integer conversions, and round-to-nearest for all other arithmetic
9359 truncations.  This option should be specified for programs that change
9360 the FP rounding mode dynamically, or that may be executed with a
9361 non-default rounding mode.  This option disables constant folding of
9362 floating-point expressions at compile time (which may be affected by
9363 rounding mode) and arithmetic transformations that are unsafe in the
9364 presence of sign-dependent rounding modes.
9366 The default is @option{-fno-rounding-math}.
9368 This option is experimental and does not currently guarantee to
9369 disable all GCC optimizations that are affected by rounding mode.
9370 Future versions of GCC may provide finer control of this setting
9371 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9372 will be used to specify the default state for @code{FENV_ACCESS}.
9374 @item -fsignaling-nans
9375 @opindex fsignaling-nans
9376 Compile code assuming that IEEE signaling NaNs may generate user-visible
9377 traps during floating-point operations.  Setting this option disables
9378 optimizations that may change the number of exceptions visible with
9379 signaling NaNs.  This option implies @option{-ftrapping-math}.
9381 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9382 be defined.
9384 The default is @option{-fno-signaling-nans}.
9386 This option is experimental and does not currently guarantee to
9387 disable all GCC optimizations that affect signaling NaN behavior.
9389 @item -fsingle-precision-constant
9390 @opindex fsingle-precision-constant
9391 Treat floating-point constants as single precision instead of
9392 implicitly converting them to double-precision constants.
9394 @item -fcx-limited-range
9395 @opindex fcx-limited-range
9396 When enabled, this option states that a range reduction step is not
9397 needed when performing complex division.  Also, there is no checking
9398 whether the result of a complex multiplication or division is @code{NaN
9399 + I*NaN}, with an attempt to rescue the situation in that case.  The
9400 default is @option{-fno-cx-limited-range}, but is enabled by
9401 @option{-ffast-math}.
9403 This option controls the default setting of the ISO C99
9404 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9405 all languages.
9407 @item -fcx-fortran-rules
9408 @opindex fcx-fortran-rules
9409 Complex multiplication and division follow Fortran rules.  Range
9410 reduction is done as part of complex division, but there is no checking
9411 whether the result of a complex multiplication or division is @code{NaN
9412 + I*NaN}, with an attempt to rescue the situation in that case.
9414 The default is @option{-fno-cx-fortran-rules}.
9416 @end table
9418 The following options control optimizations that may improve
9419 performance, but are not enabled by any @option{-O} options.  This
9420 section includes experimental options that may produce broken code.
9422 @table @gcctabopt
9423 @item -fbranch-probabilities
9424 @opindex fbranch-probabilities
9425 After running a program compiled with @option{-fprofile-arcs}
9426 (@pxref{Debugging Options,, Options for Debugging Your Program or
9427 @command{gcc}}), you can compile it a second time using
9428 @option{-fbranch-probabilities}, to improve optimizations based on
9429 the number of times each branch was taken.  When a program
9430 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9431 counts to a file called @file{@var{sourcename}.gcda} for each source
9432 file.  The information in this data file is very dependent on the
9433 structure of the generated code, so you must use the same source code
9434 and the same optimization options for both compilations.
9436 With @option{-fbranch-probabilities}, GCC puts a
9437 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9438 These can be used to improve optimization.  Currently, they are only
9439 used in one place: in @file{reorg.c}, instead of guessing which path a
9440 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9441 exactly determine which path is taken more often.
9443 @item -fprofile-values
9444 @opindex fprofile-values
9445 If combined with @option{-fprofile-arcs}, it adds code so that some
9446 data about values of expressions in the program is gathered.
9448 With @option{-fbranch-probabilities}, it reads back the data gathered
9449 from profiling values of expressions for usage in optimizations.
9451 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9453 @item -fprofile-reorder-functions
9454 @opindex fprofile-reorder-functions
9455 Function reordering based on profile instrumentation collects
9456 first time of execution of a function and orders these functions
9457 in ascending order.
9459 Enabled with @option{-fprofile-use}.
9461 @item -fvpt
9462 @opindex fvpt
9463 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9464 to add code to gather information about values of expressions.
9466 With @option{-fbranch-probabilities}, it reads back the data gathered
9467 and actually performs the optimizations based on them.
9468 Currently the optimizations include specialization of division operations
9469 using the knowledge about the value of the denominator.
9471 @item -frename-registers
9472 @opindex frename-registers
9473 Attempt to avoid false dependencies in scheduled code by making use
9474 of registers left over after register allocation.  This optimization
9475 most benefits processors with lots of registers.  Depending on the
9476 debug information format adopted by the target, however, it can
9477 make debugging impossible, since variables no longer stay in
9478 a ``home register''.
9480 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9482 @item -ftracer
9483 @opindex ftracer
9484 Perform tail duplication to enlarge superblock size.  This transformation
9485 simplifies the control flow of the function allowing other optimizations to do
9486 a better job.
9488 Enabled with @option{-fprofile-use}.
9490 @item -funroll-loops
9491 @opindex funroll-loops
9492 Unroll loops whose number of iterations can be determined at compile time or
9493 upon entry to the loop.  @option{-funroll-loops} implies
9494 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9495 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9496 a small constant number of iterations).  This option makes code larger, and may
9497 or may not make it run faster.
9499 Enabled with @option{-fprofile-use}.
9501 @item -funroll-all-loops
9502 @opindex funroll-all-loops
9503 Unroll all loops, even if their number of iterations is uncertain when
9504 the loop is entered.  This usually makes programs run more slowly.
9505 @option{-funroll-all-loops} implies the same options as
9506 @option{-funroll-loops}.
9508 @item -fpeel-loops
9509 @opindex fpeel-loops
9510 Peels loops for which there is enough information that they do not
9511 roll much (from profile feedback).  It also turns on complete loop peeling
9512 (i.e.@: complete removal of loops with small constant number of iterations).
9514 Enabled with @option{-fprofile-use}.
9516 @item -fmove-loop-invariants
9517 @opindex fmove-loop-invariants
9518 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9519 at level @option{-O1}
9521 @item -funswitch-loops
9522 @opindex funswitch-loops
9523 Move branches with loop invariant conditions out of the loop, with duplicates
9524 of the loop on both branches (modified according to result of the condition).
9526 @item -ffunction-sections
9527 @itemx -fdata-sections
9528 @opindex ffunction-sections
9529 @opindex fdata-sections
9530 Place each function or data item into its own section in the output
9531 file if the target supports arbitrary sections.  The name of the
9532 function or the name of the data item determines the section's name
9533 in the output file.
9535 Use these options on systems where the linker can perform optimizations
9536 to improve locality of reference in the instruction space.  Most systems
9537 using the ELF object format and SPARC processors running Solaris 2 have
9538 linkers with such optimizations.  AIX may have these optimizations in
9539 the future.
9541 Only use these options when there are significant benefits from doing
9542 so.  When you specify these options, the assembler and linker
9543 create larger object and executable files and are also slower.
9544 You cannot use @code{gprof} on all systems if you
9545 specify this option, and you may have problems with debugging if
9546 you specify both this option and @option{-g}.
9548 @item -fbranch-target-load-optimize
9549 @opindex fbranch-target-load-optimize
9550 Perform branch target register load optimization before prologue / epilogue
9551 threading.
9552 The use of target registers can typically be exposed only during reload,
9553 thus hoisting loads out of loops and doing inter-block scheduling needs
9554 a separate optimization pass.
9556 @item -fbranch-target-load-optimize2
9557 @opindex fbranch-target-load-optimize2
9558 Perform branch target register load optimization after prologue / epilogue
9559 threading.
9561 @item -fbtr-bb-exclusive
9562 @opindex fbtr-bb-exclusive
9563 When performing branch target register load optimization, don't reuse
9564 branch target registers within any basic block.
9566 @item -fstack-protector
9567 @opindex fstack-protector
9568 Emit extra code to check for buffer overflows, such as stack smashing
9569 attacks.  This is done by adding a guard variable to functions with
9570 vulnerable objects.  This includes functions that call @code{alloca}, and
9571 functions with buffers larger than 8 bytes.  The guards are initialized
9572 when a function is entered and then checked when the function exits.
9573 If a guard check fails, an error message is printed and the program exits.
9575 @item -fstack-protector-all
9576 @opindex fstack-protector-all
9577 Like @option{-fstack-protector} except that all functions are protected.
9579 @item -fstack-protector-strong
9580 @opindex fstack-protector-strong
9581 Like @option{-fstack-protector} but includes additional functions to
9582 be protected --- those that have local array definitions, or have
9583 references to local frame addresses.
9585 @item -fsection-anchors
9586 @opindex fsection-anchors
9587 Try to reduce the number of symbolic address calculations by using
9588 shared ``anchor'' symbols to address nearby objects.  This transformation
9589 can help to reduce the number of GOT entries and GOT accesses on some
9590 targets.
9592 For example, the implementation of the following function @code{foo}:
9594 @smallexample
9595 static int a, b, c;
9596 int foo (void) @{ return a + b + c; @}
9597 @end smallexample
9599 @noindent
9600 usually calculates the addresses of all three variables, but if you
9601 compile it with @option{-fsection-anchors}, it accesses the variables
9602 from a common anchor point instead.  The effect is similar to the
9603 following pseudocode (which isn't valid C):
9605 @smallexample
9606 int foo (void)
9608   register int *xr = &x;
9609   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9611 @end smallexample
9613 Not all targets support this option.
9615 @item --param @var{name}=@var{value}
9616 @opindex param
9617 In some places, GCC uses various constants to control the amount of
9618 optimization that is done.  For example, GCC does not inline functions
9619 that contain more than a certain number of instructions.  You can
9620 control some of these constants on the command line using the
9621 @option{--param} option.
9623 The names of specific parameters, and the meaning of the values, are
9624 tied to the internals of the compiler, and are subject to change
9625 without notice in future releases.
9627 In each case, the @var{value} is an integer.  The allowable choices for
9628 @var{name} are:
9630 @table @gcctabopt
9631 @item predictable-branch-outcome
9632 When branch is predicted to be taken with probability lower than this threshold
9633 (in percent), then it is considered well predictable. The default is 10.
9635 @item max-crossjump-edges
9636 The maximum number of incoming edges to consider for cross-jumping.
9637 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9638 the number of edges incoming to each block.  Increasing values mean
9639 more aggressive optimization, making the compilation time increase with
9640 probably small improvement in executable size.
9642 @item min-crossjump-insns
9643 The minimum number of instructions that must be matched at the end
9644 of two blocks before cross-jumping is performed on them.  This
9645 value is ignored in the case where all instructions in the block being
9646 cross-jumped from are matched.  The default value is 5.
9648 @item max-grow-copy-bb-insns
9649 The maximum code size expansion factor when copying basic blocks
9650 instead of jumping.  The expansion is relative to a jump instruction.
9651 The default value is 8.
9653 @item max-goto-duplication-insns
9654 The maximum number of instructions to duplicate to a block that jumps
9655 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9656 passes, GCC factors computed gotos early in the compilation process,
9657 and unfactors them as late as possible.  Only computed jumps at the
9658 end of a basic blocks with no more than max-goto-duplication-insns are
9659 unfactored.  The default value is 8.
9661 @item max-delay-slot-insn-search
9662 The maximum number of instructions to consider when looking for an
9663 instruction to fill a delay slot.  If more than this arbitrary number of
9664 instructions are searched, the time savings from filling the delay slot
9665 are minimal, so stop searching.  Increasing values mean more
9666 aggressive optimization, making the compilation time increase with probably
9667 small improvement in execution time.
9669 @item max-delay-slot-live-search
9670 When trying to fill delay slots, the maximum number of instructions to
9671 consider when searching for a block with valid live register
9672 information.  Increasing this arbitrarily chosen value means more
9673 aggressive optimization, increasing the compilation time.  This parameter
9674 should be removed when the delay slot code is rewritten to maintain the
9675 control-flow graph.
9677 @item max-gcse-memory
9678 The approximate maximum amount of memory that can be allocated in
9679 order to perform the global common subexpression elimination
9680 optimization.  If more memory than specified is required, the
9681 optimization is not done.
9683 @item max-gcse-insertion-ratio
9684 If the ratio of expression insertions to deletions is larger than this value
9685 for any expression, then RTL PRE inserts or removes the expression and thus
9686 leaves partially redundant computations in the instruction stream.  The default value is 20.
9688 @item max-pending-list-length
9689 The maximum number of pending dependencies scheduling allows
9690 before flushing the current state and starting over.  Large functions
9691 with few branches or calls can create excessively large lists which
9692 needlessly consume memory and resources.
9694 @item max-modulo-backtrack-attempts
9695 The maximum number of backtrack attempts the scheduler should make
9696 when modulo scheduling a loop.  Larger values can exponentially increase
9697 compilation time.
9699 @item max-inline-insns-single
9700 Several parameters control the tree inliner used in GCC@.
9701 This number sets the maximum number of instructions (counted in GCC's
9702 internal representation) in a single function that the tree inliner
9703 considers for inlining.  This only affects functions declared
9704 inline and methods implemented in a class declaration (C++).
9705 The default value is 400.
9707 @item max-inline-insns-auto
9708 When you use @option{-finline-functions} (included in @option{-O3}),
9709 a lot of functions that would otherwise not be considered for inlining
9710 by the compiler are investigated.  To those functions, a different
9711 (more restrictive) limit compared to functions declared inline can
9712 be applied.
9713 The default value is 40.
9715 @item inline-min-speedup
9716 When estimated performance improvement of caller + callee runtime exceeds this
9717 threshold (in precent), the function can be inlined regardless the limit on
9718 @option{--param max-inline-insns-single} and @option{--param
9719 max-inline-insns-auto}.
9721 @item large-function-insns
9722 The limit specifying really large functions.  For functions larger than this
9723 limit after inlining, inlining is constrained by
9724 @option{--param large-function-growth}.  This parameter is useful primarily
9725 to avoid extreme compilation time caused by non-linear algorithms used by the
9726 back end.
9727 The default value is 2700.
9729 @item large-function-growth
9730 Specifies maximal growth of large function caused by inlining in percents.
9731 The default value is 100 which limits large function growth to 2.0 times
9732 the original size.
9734 @item large-unit-insns
9735 The limit specifying large translation unit.  Growth caused by inlining of
9736 units larger than this limit is limited by @option{--param inline-unit-growth}.
9737 For small units this might be too tight.
9738 For example, consider a unit consisting of function A
9739 that is inline and B that just calls A three times.  If B is small relative to
9740 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9741 large units consisting of small inlineable functions, however, the overall unit
9742 growth limit is needed to avoid exponential explosion of code size.  Thus for
9743 smaller units, the size is increased to @option{--param large-unit-insns}
9744 before applying @option{--param inline-unit-growth}.  The default is 10000.
9746 @item inline-unit-growth
9747 Specifies maximal overall growth of the compilation unit caused by inlining.
9748 The default value is 30 which limits unit growth to 1.3 times the original
9749 size. Cold functions (either marked cold via an attribute or by profile
9750 feedback) are not accounted into the unit size.
9752 @item ipcp-unit-growth
9753 Specifies maximal overall growth of the compilation unit caused by
9754 interprocedural constant propagation.  The default value is 10 which limits
9755 unit growth to 1.1 times the original size.
9757 @item large-stack-frame
9758 The limit specifying large stack frames.  While inlining the algorithm is trying
9759 to not grow past this limit too much.  The default value is 256 bytes.
9761 @item large-stack-frame-growth
9762 Specifies maximal growth of large stack frames caused by inlining in percents.
9763 The default value is 1000 which limits large stack frame growth to 11 times
9764 the original size.
9766 @item max-inline-insns-recursive
9767 @itemx max-inline-insns-recursive-auto
9768 Specifies the maximum number of instructions an out-of-line copy of a
9769 self-recursive inline
9770 function can grow into by performing recursive inlining.
9772 For functions declared inline, @option{--param max-inline-insns-recursive} is
9773 taken into account.  For functions not declared inline, recursive inlining
9774 happens only when @option{-finline-functions} (included in @option{-O3}) is
9775 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9776 default value is 450.
9778 @item max-inline-recursive-depth
9779 @itemx max-inline-recursive-depth-auto
9780 Specifies the maximum recursion depth used for recursive inlining.
9782 For functions declared inline, @option{--param max-inline-recursive-depth} is
9783 taken into account.  For functions not declared inline, recursive inlining
9784 happens only when @option{-finline-functions} (included in @option{-O3}) is
9785 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9786 default value is 8.
9788 @item min-inline-recursive-probability
9789 Recursive inlining is profitable only for function having deep recursion
9790 in average and can hurt for function having little recursion depth by
9791 increasing the prologue size or complexity of function body to other
9792 optimizers.
9794 When profile feedback is available (see @option{-fprofile-generate}) the actual
9795 recursion depth can be guessed from probability that function recurses via a
9796 given call expression.  This parameter limits inlining only to call expressions
9797 whose probability exceeds the given threshold (in percents).
9798 The default value is 10.
9800 @item early-inlining-insns
9801 Specify growth that the early inliner can make.  In effect it increases
9802 the amount of inlining for code having a large abstraction penalty.
9803 The default value is 10.
9805 @item max-early-inliner-iterations
9806 @itemx max-early-inliner-iterations
9807 Limit of iterations of the early inliner.  This basically bounds
9808 the number of nested indirect calls the early inliner can resolve.
9809 Deeper chains are still handled by late inlining.
9811 @item comdat-sharing-probability
9812 @itemx comdat-sharing-probability
9813 Probability (in percent) that C++ inline function with comdat visibility
9814 are shared across multiple compilation units.  The default value is 20.
9816 @item profile-func-internal-id
9817 @itemx profile-func-internal-id
9818 A parameter to control whether to use function internal id in profile
9819 database lookup. If the value is 0, the compiler will use id that
9820 is based on function assembler name and filename, which makes old profile
9821 data more tolerant to source changes such as function reordering etc.
9822 The default value is 0.
9824 @item min-vect-loop-bound
9825 The minimum number of iterations under which loops are not vectorized
9826 when @option{-ftree-vectorize} is used.  The number of iterations after
9827 vectorization needs to be greater than the value specified by this option
9828 to allow vectorization.  The default value is 0.
9830 @item gcse-cost-distance-ratio
9831 Scaling factor in calculation of maximum distance an expression
9832 can be moved by GCSE optimizations.  This is currently supported only in the
9833 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9834 is with simple expressions, i.e., the expressions that have cost
9835 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9836 hoisting of simple expressions.  The default value is 10.
9838 @item gcse-unrestricted-cost
9839 Cost, roughly measured as the cost of a single typical machine
9840 instruction, at which GCSE optimizations do not constrain
9841 the distance an expression can travel.  This is currently
9842 supported only in the code hoisting pass.  The lesser the cost,
9843 the more aggressive code hoisting is.  Specifying 0 
9844 allows all expressions to travel unrestricted distances.
9845 The default value is 3.
9847 @item max-hoist-depth
9848 The depth of search in the dominator tree for expressions to hoist.
9849 This is used to avoid quadratic behavior in hoisting algorithm.
9850 The value of 0 does not limit on the search, but may slow down compilation
9851 of huge functions.  The default value is 30.
9853 @item max-tail-merge-comparisons
9854 The maximum amount of similar bbs to compare a bb with.  This is used to
9855 avoid quadratic behavior in tree tail merging.  The default value is 10.
9857 @item max-tail-merge-iterations
9858 The maximum amount of iterations of the pass over the function.  This is used to
9859 limit compilation time in tree tail merging.  The default value is 2.
9861 @item max-unrolled-insns
9862 The maximum number of instructions that a loop may have to be unrolled.
9863 If a loop is unrolled, this parameter also determines how many times
9864 the loop code is unrolled.
9866 @item max-average-unrolled-insns
9867 The maximum number of instructions biased by probabilities of their execution
9868 that a loop may have to be unrolled.  If a loop is unrolled,
9869 this parameter also determines how many times the loop code is unrolled.
9871 @item max-unroll-times
9872 The maximum number of unrollings of a single loop.
9874 @item max-peeled-insns
9875 The maximum number of instructions that a loop may have to be peeled.
9876 If a loop is peeled, this parameter also determines how many times
9877 the loop code is peeled.
9879 @item max-peel-times
9880 The maximum number of peelings of a single loop.
9882 @item max-peel-branches
9883 The maximum number of branches on the hot path through the peeled sequence.
9885 @item max-completely-peeled-insns
9886 The maximum number of insns of a completely peeled loop.
9888 @item max-completely-peel-times
9889 The maximum number of iterations of a loop to be suitable for complete peeling.
9891 @item max-completely-peel-loop-nest-depth
9892 The maximum depth of a loop nest suitable for complete peeling.
9894 @item max-unswitch-insns
9895 The maximum number of insns of an unswitched loop.
9897 @item max-unswitch-level
9898 The maximum number of branches unswitched in a single loop.
9900 @item lim-expensive
9901 The minimum cost of an expensive expression in the loop invariant motion.
9903 @item iv-consider-all-candidates-bound
9904 Bound on number of candidates for induction variables, below which
9905 all candidates are considered for each use in induction variable
9906 optimizations.  If there are more candidates than this,
9907 only the most relevant ones are considered to avoid quadratic time complexity.
9909 @item iv-max-considered-uses
9910 The induction variable optimizations give up on loops that contain more
9911 induction variable uses.
9913 @item iv-always-prune-cand-set-bound
9914 If the number of candidates in the set is smaller than this value,
9915 always try to remove unnecessary ivs from the set
9916 when adding a new one.
9918 @item scev-max-expr-size
9919 Bound on size of expressions used in the scalar evolutions analyzer.
9920 Large expressions slow the analyzer.
9922 @item scev-max-expr-complexity
9923 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9924 Complex expressions slow the analyzer.
9926 @item omega-max-vars
9927 The maximum number of variables in an Omega constraint system.
9928 The default value is 128.
9930 @item omega-max-geqs
9931 The maximum number of inequalities in an Omega constraint system.
9932 The default value is 256.
9934 @item omega-max-eqs
9935 The maximum number of equalities in an Omega constraint system.
9936 The default value is 128.
9938 @item omega-max-wild-cards
9939 The maximum number of wildcard variables that the Omega solver is
9940 able to insert.  The default value is 18.
9942 @item omega-hash-table-size
9943 The size of the hash table in the Omega solver.  The default value is
9944 550.
9946 @item omega-max-keys
9947 The maximal number of keys used by the Omega solver.  The default
9948 value is 500.
9950 @item omega-eliminate-redundant-constraints
9951 When set to 1, use expensive methods to eliminate all redundant
9952 constraints.  The default value is 0.
9954 @item vect-max-version-for-alignment-checks
9955 The maximum number of run-time checks that can be performed when
9956 doing loop versioning for alignment in the vectorizer.
9958 @item vect-max-version-for-alias-checks
9959 The maximum number of run-time checks that can be performed when
9960 doing loop versioning for alias in the vectorizer.
9962 @item vect-max-peeling-for-alignment
9963 The maximum number of loop peels to enhance access alignment
9964 for vectorizer. Value -1 means 'no limit'.
9966 @item max-iterations-to-track
9967 The maximum number of iterations of a loop the brute-force algorithm
9968 for analysis of the number of iterations of the loop tries to evaluate.
9970 @item hot-bb-count-ws-permille
9971 A basic block profile count is considered hot if it contributes to 
9972 the given permillage (i.e. 0...1000) of the entire profiled execution.
9974 @item hot-bb-frequency-fraction
9975 Select fraction of the entry block frequency of executions of basic block in
9976 function given basic block needs to have to be considered hot.
9978 @item max-predicted-iterations
9979 The maximum number of loop iterations we predict statically.  This is useful
9980 in cases where a function contains a single loop with known bound and
9981 another loop with unknown bound.
9982 The known number of iterations is predicted correctly, while
9983 the unknown number of iterations average to roughly 10.  This means that the
9984 loop without bounds appears artificially cold relative to the other one.
9986 @item builtin-expect-probability
9987 Control the probability of the expression having the specified value. This
9988 parameter takes a percentage (i.e. 0 ... 100) as input.
9989 The default probability of 90 is obtained empirically.
9991 @item align-threshold
9993 Select fraction of the maximal frequency of executions of a basic block in
9994 a function to align the basic block.
9996 @item align-loop-iterations
9998 A loop expected to iterate at least the selected number of iterations is
9999 aligned.
10001 @item tracer-dynamic-coverage
10002 @itemx tracer-dynamic-coverage-feedback
10004 This value is used to limit superblock formation once the given percentage of
10005 executed instructions is covered.  This limits unnecessary code size
10006 expansion.
10008 The @option{tracer-dynamic-coverage-feedback} is used only when profile
10009 feedback is available.  The real profiles (as opposed to statically estimated
10010 ones) are much less balanced allowing the threshold to be larger value.
10012 @item tracer-max-code-growth
10013 Stop tail duplication once code growth has reached given percentage.  This is
10014 a rather artificial limit, as most of the duplicates are eliminated later in
10015 cross jumping, so it may be set to much higher values than is the desired code
10016 growth.
10018 @item tracer-min-branch-ratio
10020 Stop reverse growth when the reverse probability of best edge is less than this
10021 threshold (in percent).
10023 @item tracer-min-branch-ratio
10024 @itemx tracer-min-branch-ratio-feedback
10026 Stop forward growth if the best edge has probability lower than this
10027 threshold.
10029 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10030 compilation for profile feedback and one for compilation without.  The value
10031 for compilation with profile feedback needs to be more conservative (higher) in
10032 order to make tracer effective.
10034 @item max-cse-path-length
10036 The maximum number of basic blocks on path that CSE considers.
10037 The default is 10.
10039 @item max-cse-insns
10040 The maximum number of instructions CSE processes before flushing.
10041 The default is 1000.
10043 @item ggc-min-expand
10045 GCC uses a garbage collector to manage its own memory allocation.  This
10046 parameter specifies the minimum percentage by which the garbage
10047 collector's heap should be allowed to expand between collections.
10048 Tuning this may improve compilation speed; it has no effect on code
10049 generation.
10051 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10052 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10053 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10054 GCC is not able to calculate RAM on a particular platform, the lower
10055 bound of 30% is used.  Setting this parameter and
10056 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10057 every opportunity.  This is extremely slow, but can be useful for
10058 debugging.
10060 @item ggc-min-heapsize
10062 Minimum size of the garbage collector's heap before it begins bothering
10063 to collect garbage.  The first collection occurs after the heap expands
10064 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10065 tuning this may improve compilation speed, and has no effect on code
10066 generation.
10068 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10069 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10070 with a lower bound of 4096 (four megabytes) and an upper bound of
10071 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10072 particular platform, the lower bound is used.  Setting this parameter
10073 very large effectively disables garbage collection.  Setting this
10074 parameter and @option{ggc-min-expand} to zero causes a full collection
10075 to occur at every opportunity.
10077 @item max-reload-search-insns
10078 The maximum number of instruction reload should look backward for equivalent
10079 register.  Increasing values mean more aggressive optimization, making the
10080 compilation time increase with probably slightly better performance.
10081 The default value is 100.
10083 @item max-cselib-memory-locations
10084 The maximum number of memory locations cselib should take into account.
10085 Increasing values mean more aggressive optimization, making the compilation time
10086 increase with probably slightly better performance.  The default value is 500.
10088 @item reorder-blocks-duplicate
10089 @itemx reorder-blocks-duplicate-feedback
10091 Used by the basic block reordering pass to decide whether to use unconditional
10092 branch or duplicate the code on its destination.  Code is duplicated when its
10093 estimated size is smaller than this value multiplied by the estimated size of
10094 unconditional jump in the hot spots of the program.
10096 The @option{reorder-block-duplicate-feedback} is used only when profile
10097 feedback is available.  It may be set to higher values than
10098 @option{reorder-block-duplicate} since information about the hot spots is more
10099 accurate.
10101 @item max-sched-ready-insns
10102 The maximum number of instructions ready to be issued the scheduler should
10103 consider at any given time during the first scheduling pass.  Increasing
10104 values mean more thorough searches, making the compilation time increase
10105 with probably little benefit.  The default value is 100.
10107 @item max-sched-region-blocks
10108 The maximum number of blocks in a region to be considered for
10109 interblock scheduling.  The default value is 10.
10111 @item max-pipeline-region-blocks
10112 The maximum number of blocks in a region to be considered for
10113 pipelining in the selective scheduler.  The default value is 15.
10115 @item max-sched-region-insns
10116 The maximum number of insns in a region to be considered for
10117 interblock scheduling.  The default value is 100.
10119 @item max-pipeline-region-insns
10120 The maximum number of insns in a region to be considered for
10121 pipelining in the selective scheduler.  The default value is 200.
10123 @item min-spec-prob
10124 The minimum probability (in percents) of reaching a source block
10125 for interblock speculative scheduling.  The default value is 40.
10127 @item max-sched-extend-regions-iters
10128 The maximum number of iterations through CFG to extend regions.
10129 A value of 0 (the default) disables region extensions.
10131 @item max-sched-insn-conflict-delay
10132 The maximum conflict delay for an insn to be considered for speculative motion.
10133 The default value is 3.
10135 @item sched-spec-prob-cutoff
10136 The minimal probability of speculation success (in percents), so that
10137 speculative insns are scheduled.
10138 The default value is 40.
10140 @item sched-spec-state-edge-prob-cutoff
10141 The minimum probability an edge must have for the scheduler to save its
10142 state across it.
10143 The default value is 10.
10145 @item sched-mem-true-dep-cost
10146 Minimal distance (in CPU cycles) between store and load targeting same
10147 memory locations.  The default value is 1.
10149 @item selsched-max-lookahead
10150 The maximum size of the lookahead window of selective scheduling.  It is a
10151 depth of search for available instructions.
10152 The default value is 50.
10154 @item selsched-max-sched-times
10155 The maximum number of times that an instruction is scheduled during
10156 selective scheduling.  This is the limit on the number of iterations
10157 through which the instruction may be pipelined.  The default value is 2.
10159 @item selsched-max-insns-to-rename
10160 The maximum number of best instructions in the ready list that are considered
10161 for renaming in the selective scheduler.  The default value is 2.
10163 @item sms-min-sc
10164 The minimum value of stage count that swing modulo scheduler
10165 generates.  The default value is 2.
10167 @item max-last-value-rtl
10168 The maximum size measured as number of RTLs that can be recorded in an expression
10169 in combiner for a pseudo register as last known value of that register.  The default
10170 is 10000.
10172 @item max-combine-insns
10173 The maximum number of instructions the RTL combiner tries to combine.
10174 The default value is 2 at @option{-Og} and 4 otherwise.
10176 @item integer-share-limit
10177 Small integer constants can use a shared data structure, reducing the
10178 compiler's memory usage and increasing its speed.  This sets the maximum
10179 value of a shared integer constant.  The default value is 256.
10181 @item ssp-buffer-size
10182 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10183 protection when @option{-fstack-protection} is used.
10185 @item min-size-for-stack-sharing
10186 The minimum size of variables taking part in stack slot sharing when not
10187 optimizing. The default value is 32.
10189 @item max-jump-thread-duplication-stmts
10190 Maximum number of statements allowed in a block that needs to be
10191 duplicated when threading jumps.
10193 @item max-fields-for-field-sensitive
10194 Maximum number of fields in a structure treated in
10195 a field sensitive manner during pointer analysis.  The default is zero
10196 for @option{-O0} and @option{-O1},
10197 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10199 @item prefetch-latency
10200 Estimate on average number of instructions that are executed before
10201 prefetch finishes.  The distance prefetched ahead is proportional
10202 to this constant.  Increasing this number may also lead to less
10203 streams being prefetched (see @option{simultaneous-prefetches}).
10205 @item simultaneous-prefetches
10206 Maximum number of prefetches that can run at the same time.
10208 @item l1-cache-line-size
10209 The size of cache line in L1 cache, in bytes.
10211 @item l1-cache-size
10212 The size of L1 cache, in kilobytes.
10214 @item l2-cache-size
10215 The size of L2 cache, in kilobytes.
10217 @item min-insn-to-prefetch-ratio
10218 The minimum ratio between the number of instructions and the
10219 number of prefetches to enable prefetching in a loop.
10221 @item prefetch-min-insn-to-mem-ratio
10222 The minimum ratio between the number of instructions and the
10223 number of memory references to enable prefetching in a loop.
10225 @item use-canonical-types
10226 Whether the compiler should use the ``canonical'' type system.  By
10227 default, this should always be 1, which uses a more efficient internal
10228 mechanism for comparing types in C++ and Objective-C++.  However, if
10229 bugs in the canonical type system are causing compilation failures,
10230 set this value to 0 to disable canonical types.
10232 @item switch-conversion-max-branch-ratio
10233 Switch initialization conversion refuses to create arrays that are
10234 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10235 branches in the switch.
10237 @item max-partial-antic-length
10238 Maximum length of the partial antic set computed during the tree
10239 partial redundancy elimination optimization (@option{-ftree-pre}) when
10240 optimizing at @option{-O3} and above.  For some sorts of source code
10241 the enhanced partial redundancy elimination optimization can run away,
10242 consuming all of the memory available on the host machine.  This
10243 parameter sets a limit on the length of the sets that are computed,
10244 which prevents the runaway behavior.  Setting a value of 0 for
10245 this parameter allows an unlimited set length.
10247 @item sccvn-max-scc-size
10248 Maximum size of a strongly connected component (SCC) during SCCVN
10249 processing.  If this limit is hit, SCCVN processing for the whole
10250 function is not done and optimizations depending on it are
10251 disabled.  The default maximum SCC size is 10000.
10253 @item sccvn-max-alias-queries-per-access
10254 Maximum number of alias-oracle queries we perform when looking for
10255 redundancies for loads and stores.  If this limit is hit the search
10256 is aborted and the load or store is not considered redundant.  The
10257 number of queries is algorithmically limited to the number of
10258 stores on all paths from the load to the function entry.
10259 The default maxmimum number of queries is 1000.
10261 @item ira-max-loops-num
10262 IRA uses regional register allocation by default.  If a function
10263 contains more loops than the number given by this parameter, only at most
10264 the given number of the most frequently-executed loops form regions
10265 for regional register allocation.  The default value of the
10266 parameter is 100.
10268 @item ira-max-conflict-table-size 
10269 Although IRA uses a sophisticated algorithm to compress the conflict
10270 table, the table can still require excessive amounts of memory for
10271 huge functions.  If the conflict table for a function could be more
10272 than the size in MB given by this parameter, the register allocator
10273 instead uses a faster, simpler, and lower-quality
10274 algorithm that does not require building a pseudo-register conflict table.  
10275 The default value of the parameter is 2000.
10277 @item ira-loop-reserved-regs
10278 IRA can be used to evaluate more accurate register pressure in loops
10279 for decisions to move loop invariants (see @option{-O3}).  The number
10280 of available registers reserved for some other purposes is given
10281 by this parameter.  The default value of the parameter is 2, which is
10282 the minimal number of registers needed by typical instructions.
10283 This value is the best found from numerous experiments.
10285 @item loop-invariant-max-bbs-in-loop
10286 Loop invariant motion can be very expensive, both in compilation time and
10287 in amount of needed compile-time memory, with very large loops.  Loops
10288 with more basic blocks than this parameter won't have loop invariant
10289 motion optimization performed on them.  The default value of the
10290 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10292 @item loop-max-datarefs-for-datadeps
10293 Building data dapendencies is expensive for very large loops.  This
10294 parameter limits the number of data references in loops that are
10295 considered for data dependence analysis.  These large loops are no
10296 handled by the optimizations using loop data dependencies.
10297 The default value is 1000.
10299 @item max-vartrack-size
10300 Sets a maximum number of hash table slots to use during variable
10301 tracking dataflow analysis of any function.  If this limit is exceeded
10302 with variable tracking at assignments enabled, analysis for that
10303 function is retried without it, after removing all debug insns from
10304 the function.  If the limit is exceeded even without debug insns, var
10305 tracking analysis is completely disabled for the function.  Setting
10306 the parameter to zero makes it unlimited.
10308 @item max-vartrack-expr-depth
10309 Sets a maximum number of recursion levels when attempting to map
10310 variable names or debug temporaries to value expressions.  This trades
10311 compilation time for more complete debug information.  If this is set too
10312 low, value expressions that are available and could be represented in
10313 debug information may end up not being used; setting this higher may
10314 enable the compiler to find more complex debug expressions, but compile
10315 time and memory use may grow.  The default is 12.
10317 @item min-nondebug-insn-uid
10318 Use uids starting at this parameter for nondebug insns.  The range below
10319 the parameter is reserved exclusively for debug insns created by
10320 @option{-fvar-tracking-assignments}, but debug insns may get
10321 (non-overlapping) uids above it if the reserved range is exhausted.
10323 @item ipa-sra-ptr-growth-factor
10324 IPA-SRA replaces a pointer to an aggregate with one or more new
10325 parameters only when their cumulative size is less or equal to
10326 @option{ipa-sra-ptr-growth-factor} times the size of the original
10327 pointer parameter.
10329 @item tm-max-aggregate-size
10330 When making copies of thread-local variables in a transaction, this
10331 parameter specifies the size in bytes after which variables are
10332 saved with the logging functions as opposed to save/restore code
10333 sequence pairs.  This option only applies when using
10334 @option{-fgnu-tm}.
10336 @item graphite-max-nb-scop-params
10337 To avoid exponential effects in the Graphite loop transforms, the
10338 number of parameters in a Static Control Part (SCoP) is bounded.  The
10339 default value is 10 parameters.  A variable whose value is unknown at
10340 compilation time and defined outside a SCoP is a parameter of the SCoP.
10342 @item graphite-max-bbs-per-function
10343 To avoid exponential effects in the detection of SCoPs, the size of
10344 the functions analyzed by Graphite is bounded.  The default value is
10345 100 basic blocks.
10347 @item loop-block-tile-size
10348 Loop blocking or strip mining transforms, enabled with
10349 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10350 loop in the loop nest by a given number of iterations.  The strip
10351 length can be changed using the @option{loop-block-tile-size}
10352 parameter.  The default value is 51 iterations.
10354 @item ipa-cp-value-list-size
10355 IPA-CP attempts to track all possible values and types passed to a function's
10356 parameter in order to propagate them and perform devirtualization.
10357 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10358 stores per one formal parameter of a function.
10360 @item ipa-cp-eval-threshold
10361 IPA-CP calculates its own score of cloning profitability heuristics
10362 and performs those cloning opportunities with scores that exceed
10363 @option{ipa-cp-eval-threshold}.
10365 @item ipa-max-agg-items
10366 IPA-CP is also capable to propagate a number of scalar values passed
10367 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10368 number of such values per one parameter.
10370 @item ipa-cp-loop-hint-bonus
10371 When IPA-CP determines that a cloning candidate would make the number
10372 of iterations of a loop known, it adds a bonus of
10373 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10374 the candidate.
10376 @item ipa-cp-array-index-hint-bonus
10377 When IPA-CP determines that a cloning candidate would make the index of
10378 an array access known, it adds a bonus of
10379 @option{ipa-cp-array-index-hint-bonus} to the profitability
10380 score of the candidate.
10382 @item ipa-max-aa-steps
10383 During its analysis of function bodies, IPA-CP employs alias analysis
10384 in order to track values pointed to by function parameters.  In order
10385 not spend too much time analyzing huge functions, it will give up and
10386 consider all memory clobbered after examining
10387 @option{ipa-max-aa-steps} statements modifying memory.
10389 @item lto-partitions
10390 Specify desired number of partitions produced during WHOPR compilation.
10391 The number of partitions should exceed the number of CPUs used for compilation.
10392 The default value is 32.
10394 @item lto-minpartition
10395 Size of minimal partition for WHOPR (in estimated instructions).
10396 This prevents expenses of splitting very small programs into too many
10397 partitions.
10399 @item cxx-max-namespaces-for-diagnostic-help
10400 The maximum number of namespaces to consult for suggestions when C++
10401 name lookup fails for an identifier.  The default is 1000.
10403 @item sink-frequency-threshold
10404 The maximum relative execution frequency (in percents) of the target block
10405 relative to a statement's original block to allow statement sinking of a
10406 statement.  Larger numbers result in more aggressive statement sinking.
10407 The default value is 75.  A small positive adjustment is applied for
10408 statements with memory operands as those are even more profitable so sink.
10410 @item max-stores-to-sink
10411 The maximum number of conditional stores paires that can be sunk.  Set to 0
10412 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10413 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10415 @item allow-store-data-races
10416 Allow optimizers to introduce new data races on stores.
10417 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10418 at optimization level @option{-Ofast}.
10420 @item case-values-threshold
10421 The smallest number of different values for which it is best to use a
10422 jump-table instead of a tree of conditional branches.  If the value is
10423 0, use the default for the machine.  The default is 0.
10425 @item tree-reassoc-width
10426 Set the maximum number of instructions executed in parallel in
10427 reassociated tree. This parameter overrides target dependent
10428 heuristics used by default if has non zero value.
10430 @item sched-pressure-algorithm
10431 Choose between the two available implementations of
10432 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10433 and is the more likely to prevent instructions from being reordered.
10434 Algorithm 2 was designed to be a compromise between the relatively
10435 conservative approach taken by algorithm 1 and the rather aggressive
10436 approach taken by the default scheduler.  It relies more heavily on
10437 having a regular register file and accurate register pressure classes.
10438 See @file{haifa-sched.c} in the GCC sources for more details.
10440 The default choice depends on the target.
10442 @item max-slsr-cand-scan
10443 Set the maximum number of existing candidates that will be considered when
10444 seeking a basis for a new straight-line strength reduction candidate.
10446 @item asan-globals
10447 Enable buffer overflow detection for global objects.  This kind
10448 of protection is enabled by default if you are using
10449 @option{-fsanitize=address} option.
10450 To disable global objects protection use @option{--param asan-globals=0}.
10452 @item asan-stack
10453 Enable buffer overflow detection for stack objects.  This kind of
10454 protection is enabled by default when using@option{-fsanitize=address}.
10455 To disable stack protection use @option{--param asan-stack=0} option.
10457 @item asan-instrument-reads
10458 Enable buffer overflow detection for memory reads.  This kind of
10459 protection is enabled by default when using @option{-fsanitize=address}.
10460 To disable memory reads protection use
10461 @option{--param asan-instrument-reads=0}.
10463 @item asan-instrument-writes
10464 Enable buffer overflow detection for memory writes.  This kind of
10465 protection is enabled by default when using @option{-fsanitize=address}.
10466 To disable memory writes protection use
10467 @option{--param asan-instrument-writes=0} option.
10469 @item asan-memintrin
10470 Enable detection for built-in functions.  This kind of protection
10471 is enabled by default when using @option{-fsanitize=address}.
10472 To disable built-in functions protection use
10473 @option{--param asan-memintrin=0}.
10475 @item asan-use-after-return
10476 Enable detection of use-after-return.  This kind of protection
10477 is enabled by default when using @option{-fsanitize=address} option.
10478 To disable use-after-return detection use 
10479 @option{--param asan-use-after-return=0}.
10481 @item asan-instrumentation-with-call-threshold
10482 If number of memory accesses in function being instrumented
10483 is greater or equal to this number, use callbacks instead of inline checks.
10484 E.g. to disable inline code use
10485 @option{--param asan-instrumentation-with-call-threshold=0}.
10487 @end table
10488 @end table
10490 @node Preprocessor Options
10491 @section Options Controlling the Preprocessor
10492 @cindex preprocessor options
10493 @cindex options, preprocessor
10495 These options control the C preprocessor, which is run on each C source
10496 file before actual compilation.
10498 If you use the @option{-E} option, nothing is done except preprocessing.
10499 Some of these options make sense only together with @option{-E} because
10500 they cause the preprocessor output to be unsuitable for actual
10501 compilation.
10503 @table @gcctabopt
10504 @item -Wp,@var{option}
10505 @opindex Wp
10506 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10507 and pass @var{option} directly through to the preprocessor.  If
10508 @var{option} contains commas, it is split into multiple options at the
10509 commas.  However, many options are modified, translated or interpreted
10510 by the compiler driver before being passed to the preprocessor, and
10511 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10512 interface is undocumented and subject to change, so whenever possible
10513 you should avoid using @option{-Wp} and let the driver handle the
10514 options instead.
10516 @item -Xpreprocessor @var{option}
10517 @opindex Xpreprocessor
10518 Pass @var{option} as an option to the preprocessor.  You can use this to
10519 supply system-specific preprocessor options that GCC does not 
10520 recognize.
10522 If you want to pass an option that takes an argument, you must use
10523 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10525 @item -no-integrated-cpp
10526 @opindex no-integrated-cpp
10527 Perform preprocessing as a separate pass before compilation.
10528 By default, GCC performs preprocessing as an integrated part of
10529 input tokenization and parsing.
10530 If this option is provided, the appropriate language front end
10531 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10532 and Objective-C, respectively) is instead invoked twice,
10533 once for preprocessing only and once for actual compilation
10534 of the preprocessed input.
10535 This option may be useful in conjunction with the @option{-B} or
10536 @option{-wrapper} options to specify an alternate preprocessor or
10537 perform additional processing of the program source between
10538 normal preprocessing and compilation.
10539 @end table
10541 @include cppopts.texi
10543 @node Assembler Options
10544 @section Passing Options to the Assembler
10546 @c prevent bad page break with this line
10547 You can pass options to the assembler.
10549 @table @gcctabopt
10550 @item -Wa,@var{option}
10551 @opindex Wa
10552 Pass @var{option} as an option to the assembler.  If @var{option}
10553 contains commas, it is split into multiple options at the commas.
10555 @item -Xassembler @var{option}
10556 @opindex Xassembler
10557 Pass @var{option} as an option to the assembler.  You can use this to
10558 supply system-specific assembler options that GCC does not
10559 recognize.
10561 If you want to pass an option that takes an argument, you must use
10562 @option{-Xassembler} twice, once for the option and once for the argument.
10564 @end table
10566 @node Link Options
10567 @section Options for Linking
10568 @cindex link options
10569 @cindex options, linking
10571 These options come into play when the compiler links object files into
10572 an executable output file.  They are meaningless if the compiler is
10573 not doing a link step.
10575 @table @gcctabopt
10576 @cindex file names
10577 @item @var{object-file-name}
10578 A file name that does not end in a special recognized suffix is
10579 considered to name an object file or library.  (Object files are
10580 distinguished from libraries by the linker according to the file
10581 contents.)  If linking is done, these object files are used as input
10582 to the linker.
10584 @item -c
10585 @itemx -S
10586 @itemx -E
10587 @opindex c
10588 @opindex S
10589 @opindex E
10590 If any of these options is used, then the linker is not run, and
10591 object file names should not be used as arguments.  @xref{Overall
10592 Options}.
10594 @cindex Libraries
10595 @item -l@var{library}
10596 @itemx -l @var{library}
10597 @opindex l
10598 Search the library named @var{library} when linking.  (The second
10599 alternative with the library as a separate argument is only for
10600 POSIX compliance and is not recommended.)
10602 It makes a difference where in the command you write this option; the
10603 linker searches and processes libraries and object files in the order they
10604 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10605 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10606 to functions in @samp{z}, those functions may not be loaded.
10608 The linker searches a standard list of directories for the library,
10609 which is actually a file named @file{lib@var{library}.a}.  The linker
10610 then uses this file as if it had been specified precisely by name.
10612 The directories searched include several standard system directories
10613 plus any that you specify with @option{-L}.
10615 Normally the files found this way are library files---archive files
10616 whose members are object files.  The linker handles an archive file by
10617 scanning through it for members which define symbols that have so far
10618 been referenced but not defined.  But if the file that is found is an
10619 ordinary object file, it is linked in the usual fashion.  The only
10620 difference between using an @option{-l} option and specifying a file name
10621 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10622 and searches several directories.
10624 @item -lobjc
10625 @opindex lobjc
10626 You need this special case of the @option{-l} option in order to
10627 link an Objective-C or Objective-C++ program.
10629 @item -nostartfiles
10630 @opindex nostartfiles
10631 Do not use the standard system startup files when linking.
10632 The standard system libraries are used normally, unless @option{-nostdlib}
10633 or @option{-nodefaultlibs} is used.
10635 @item -nodefaultlibs
10636 @opindex nodefaultlibs
10637 Do not use the standard system libraries when linking.
10638 Only the libraries you specify are passed to the linker, and options
10639 specifying linkage of the system libraries, such as @code{-static-libgcc}
10640 or @code{-shared-libgcc}, are ignored.  
10641 The standard startup files are used normally, unless @option{-nostartfiles}
10642 is used.  
10644 The compiler may generate calls to @code{memcmp},
10645 @code{memset}, @code{memcpy} and @code{memmove}.
10646 These entries are usually resolved by entries in
10647 libc.  These entry points should be supplied through some other
10648 mechanism when this option is specified.
10650 @item -nostdlib
10651 @opindex nostdlib
10652 Do not use the standard system startup files or libraries when linking.
10653 No startup files and only the libraries you specify are passed to
10654 the linker, and options specifying linkage of the system libraries, such as
10655 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10657 The compiler may generate calls to @code{memcmp}, @code{memset},
10658 @code{memcpy} and @code{memmove}.
10659 These entries are usually resolved by entries in
10660 libc.  These entry points should be supplied through some other
10661 mechanism when this option is specified.
10663 @cindex @option{-lgcc}, use with @option{-nostdlib}
10664 @cindex @option{-nostdlib} and unresolved references
10665 @cindex unresolved references and @option{-nostdlib}
10666 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10667 @cindex @option{-nodefaultlibs} and unresolved references
10668 @cindex unresolved references and @option{-nodefaultlibs}
10669 One of the standard libraries bypassed by @option{-nostdlib} and
10670 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10671 which GCC uses to overcome shortcomings of particular machines, or special
10672 needs for some languages.
10673 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10674 Collection (GCC) Internals},
10675 for more discussion of @file{libgcc.a}.)
10676 In most cases, you need @file{libgcc.a} even when you want to avoid
10677 other standard libraries.  In other words, when you specify @option{-nostdlib}
10678 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10679 This ensures that you have no unresolved references to internal GCC
10680 library subroutines.
10681 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10682 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10683 GNU Compiler Collection (GCC) Internals}.)
10685 @item -pie
10686 @opindex pie
10687 Produce a position independent executable on targets that support it.
10688 For predictable results, you must also specify the same set of options
10689 used for compilation (@option{-fpie}, @option{-fPIE},
10690 or model suboptions) when you specify this linker option.
10692 @item -rdynamic
10693 @opindex rdynamic
10694 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10695 that support it. This instructs the linker to add all symbols, not
10696 only used ones, to the dynamic symbol table. This option is needed
10697 for some uses of @code{dlopen} or to allow obtaining backtraces
10698 from within a program.
10700 @item -s
10701 @opindex s
10702 Remove all symbol table and relocation information from the executable.
10704 @item -static
10705 @opindex static
10706 On systems that support dynamic linking, this prevents linking with the shared
10707 libraries.  On other systems, this option has no effect.
10709 @item -shared
10710 @opindex shared
10711 Produce a shared object which can then be linked with other objects to
10712 form an executable.  Not all systems support this option.  For predictable
10713 results, you must also specify the same set of options used for compilation
10714 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10715 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10716 needs to build supplementary stub code for constructors to work.  On
10717 multi-libbed systems, @samp{gcc -shared} must select the correct support
10718 libraries to link against.  Failing to supply the correct flags may lead
10719 to subtle defects.  Supplying them in cases where they are not necessary
10720 is innocuous.}
10722 @item -shared-libgcc
10723 @itemx -static-libgcc
10724 @opindex shared-libgcc
10725 @opindex static-libgcc
10726 On systems that provide @file{libgcc} as a shared library, these options
10727 force the use of either the shared or static version, respectively.
10728 If no shared version of @file{libgcc} was built when the compiler was
10729 configured, these options have no effect.
10731 There are several situations in which an application should use the
10732 shared @file{libgcc} instead of the static version.  The most common
10733 of these is when the application wishes to throw and catch exceptions
10734 across different shared libraries.  In that case, each of the libraries
10735 as well as the application itself should use the shared @file{libgcc}.
10737 Therefore, the G++ and GCJ drivers automatically add
10738 @option{-shared-libgcc} whenever you build a shared library or a main
10739 executable, because C++ and Java programs typically use exceptions, so
10740 this is the right thing to do.
10742 If, instead, you use the GCC driver to create shared libraries, you may
10743 find that they are not always linked with the shared @file{libgcc}.
10744 If GCC finds, at its configuration time, that you have a non-GNU linker
10745 or a GNU linker that does not support option @option{--eh-frame-hdr},
10746 it links the shared version of @file{libgcc} into shared libraries
10747 by default.  Otherwise, it takes advantage of the linker and optimizes
10748 away the linking with the shared version of @file{libgcc}, linking with
10749 the static version of libgcc by default.  This allows exceptions to
10750 propagate through such shared libraries, without incurring relocation
10751 costs at library load time.
10753 However, if a library or main executable is supposed to throw or catch
10754 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10755 for the languages used in the program, or using the option
10756 @option{-shared-libgcc}, such that it is linked with the shared
10757 @file{libgcc}.
10759 @item -static-libasan
10760 @opindex static-libasan
10761 When the @option{-fsanitize=address} option is used to link a program,
10762 the GCC driver automatically links against @option{libasan}.  If
10763 @file{libasan} 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{libasan}.  The @option{-static-libasan} option directs the GCC
10766 driver to link @file{libasan} statically, without necessarily linking
10767 other libraries statically.
10769 @item -static-libtsan
10770 @opindex static-libtsan
10771 When the @option{-fsanitize=thread} option is used to link a program,
10772 the GCC driver automatically links against @option{libtsan}.  If
10773 @file{libtsan} 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{libtsan}.  The @option{-static-libtsan} option directs the GCC
10776 driver to link @file{libtsan} statically, without necessarily linking
10777 other libraries statically.
10779 @item -static-liblsan
10780 @opindex static-liblsan
10781 When the @option{-fsanitize=leak} option is used to link a program,
10782 the GCC driver automatically links against @option{liblsan}.  If
10783 @file{liblsan} is available as a shared library, and the @option{-static}
10784 option is not used, then this links against the shared version of
10785 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10786 driver to link @file{liblsan} statically, without necessarily linking
10787 other libraries statically.
10789 @item -static-libubsan
10790 @opindex static-libubsan
10791 When the @option{-fsanitize=undefined} option is used to link a program,
10792 the GCC driver automatically links against @option{libubsan}.  If
10793 @file{libubsan} is available as a shared library, and the @option{-static}
10794 option is not used, then this links against the shared version of
10795 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10796 driver to link @file{libubsan} statically, without necessarily linking
10797 other libraries statically.
10799 @item -static-libstdc++
10800 @opindex static-libstdc++
10801 When the @command{g++} program is used to link a C++ program, it
10802 normally automatically links against @option{libstdc++}.  If
10803 @file{libstdc++} is available as a shared library, and the
10804 @option{-static} option is not used, then this links against the
10805 shared version of @file{libstdc++}.  That is normally fine.  However, it
10806 is sometimes useful to freeze the version of @file{libstdc++} used by
10807 the program without going all the way to a fully static link.  The
10808 @option{-static-libstdc++} option directs the @command{g++} driver to
10809 link @file{libstdc++} statically, without necessarily linking other
10810 libraries statically.
10812 @item -symbolic
10813 @opindex symbolic
10814 Bind references to global symbols when building a shared object.  Warn
10815 about any unresolved references (unless overridden by the link editor
10816 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10817 this option.
10819 @item -T @var{script}
10820 @opindex T
10821 @cindex linker script
10822 Use @var{script} as the linker script.  This option is supported by most
10823 systems using the GNU linker.  On some targets, such as bare-board
10824 targets without an operating system, the @option{-T} option may be required
10825 when linking to avoid references to undefined symbols.
10827 @item -Xlinker @var{option}
10828 @opindex Xlinker
10829 Pass @var{option} as an option to the linker.  You can use this to
10830 supply system-specific linker options that GCC does not recognize.
10832 If you want to pass an option that takes a separate argument, you must use
10833 @option{-Xlinker} twice, once for the option and once for the argument.
10834 For example, to pass @option{-assert definitions}, you must write
10835 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10836 @option{-Xlinker "-assert definitions"}, because this passes the entire
10837 string as a single argument, which is not what the linker expects.
10839 When using the GNU linker, it is usually more convenient to pass
10840 arguments to linker options using the @option{@var{option}=@var{value}}
10841 syntax than as separate arguments.  For example, you can specify
10842 @option{-Xlinker -Map=output.map} rather than
10843 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10844 this syntax for command-line options.
10846 @item -Wl,@var{option}
10847 @opindex Wl
10848 Pass @var{option} as an option to the linker.  If @var{option} contains
10849 commas, it is split into multiple options at the commas.  You can use this
10850 syntax to pass an argument to the option.
10851 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10852 linker.  When using the GNU linker, you can also get the same effect with
10853 @option{-Wl,-Map=output.map}.
10855 @item -u @var{symbol}
10856 @opindex u
10857 Pretend the symbol @var{symbol} is undefined, to force linking of
10858 library modules to define it.  You can use @option{-u} multiple times with
10859 different symbols to force loading of additional library modules.
10861 @item -z @var{keyword}
10862 @opindex z
10863 @option{-z} is passed directly on to the linker along with the keyword
10864 @var{keyword}. See the section in the documentation of your linker for
10865 permitted values and their meanings.
10866 @end table
10868 @node Directory Options
10869 @section Options for Directory Search
10870 @cindex directory options
10871 @cindex options, directory search
10872 @cindex search path
10874 These options specify directories to search for header files, for
10875 libraries and for parts of the compiler:
10877 @table @gcctabopt
10878 @item -I@var{dir}
10879 @opindex I
10880 Add the directory @var{dir} to the head of the list of directories to be
10881 searched for header files.  This can be used to override a system header
10882 file, substituting your own version, since these directories are
10883 searched before the system header file directories.  However, you should
10884 not use this option to add directories that contain vendor-supplied
10885 system header files (use @option{-isystem} for that).  If you use more than
10886 one @option{-I} option, the directories are scanned in left-to-right
10887 order; the standard system directories come after.
10889 If a standard system include directory, or a directory specified with
10890 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10891 option is ignored.  The directory is still searched but as a
10892 system directory at its normal position in the system include chain.
10893 This is to ensure that GCC's procedure to fix buggy system headers and
10894 the ordering for the @code{include_next} directive are not inadvertently changed.
10895 If you really need to change the search order for system directories,
10896 use the @option{-nostdinc} and/or @option{-isystem} options.
10898 @item -iplugindir=@var{dir}
10899 @opindex iplugindir=
10900 Set the directory to search for plugins that are passed
10901 by @option{-fplugin=@var{name}} instead of
10902 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10903 to be used by the user, but only passed by the driver.
10905 @item -iquote@var{dir}
10906 @opindex iquote
10907 Add the directory @var{dir} to the head of the list of directories to
10908 be searched for header files only for the case of @samp{#include
10909 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10910 otherwise just like @option{-I}.
10912 @item -L@var{dir}
10913 @opindex L
10914 Add directory @var{dir} to the list of directories to be searched
10915 for @option{-l}.
10917 @item -B@var{prefix}
10918 @opindex B
10919 This option specifies where to find the executables, libraries,
10920 include files, and data files of the compiler itself.
10922 The compiler driver program runs one or more of the subprograms
10923 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10924 @var{prefix} as a prefix for each program it tries to run, both with and
10925 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10927 For each subprogram to be run, the compiler driver first tries the
10928 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10929 is not specified, the driver tries two standard prefixes, 
10930 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10931 those results in a file name that is found, the unmodified program
10932 name is searched for using the directories specified in your
10933 @env{PATH} environment variable.
10935 The compiler checks to see if the path provided by the @option{-B}
10936 refers to a directory, and if necessary it adds a directory
10937 separator character at the end of the path.
10939 @option{-B} prefixes that effectively specify directory names also apply
10940 to libraries in the linker, because the compiler translates these
10941 options into @option{-L} options for the linker.  They also apply to
10942 include files in the preprocessor, because the compiler translates these
10943 options into @option{-isystem} options for the preprocessor.  In this case,
10944 the compiler appends @samp{include} to the prefix.
10946 The runtime support file @file{libgcc.a} can also be searched for using
10947 the @option{-B} prefix, if needed.  If it is not found there, the two
10948 standard prefixes above are tried, and that is all.  The file is left
10949 out of the link if it is not found by those means.
10951 Another way to specify a prefix much like the @option{-B} prefix is to use
10952 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10953 Variables}.
10955 As a special kludge, if the path provided by @option{-B} is
10956 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10957 9, then it is replaced by @file{[dir/]include}.  This is to help
10958 with boot-strapping the compiler.
10960 @item -specs=@var{file}
10961 @opindex specs
10962 Process @var{file} after the compiler reads in the standard @file{specs}
10963 file, in order to override the defaults which the @command{gcc} driver
10964 program uses when determining what switches to pass to @command{cc1},
10965 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10966 @option{-specs=@var{file}} can be specified on the command line, and they
10967 are processed in order, from left to right.
10969 @item --sysroot=@var{dir}
10970 @opindex sysroot
10971 Use @var{dir} as the logical root directory for headers and libraries.
10972 For example, if the compiler normally searches for headers in
10973 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10974 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10976 If you use both this option and the @option{-isysroot} option, then
10977 the @option{--sysroot} option applies to libraries, but the
10978 @option{-isysroot} option applies to header files.
10980 The GNU linker (beginning with version 2.16) has the necessary support
10981 for this option.  If your linker does not support this option, the
10982 header file aspect of @option{--sysroot} still works, but the
10983 library aspect does not.
10985 @item --no-sysroot-suffix
10986 @opindex no-sysroot-suffix
10987 For some targets, a suffix is added to the root directory specified
10988 with @option{--sysroot}, depending on the other options used, so that
10989 headers may for example be found in
10990 @file{@var{dir}/@var{suffix}/usr/include} instead of
10991 @file{@var{dir}/usr/include}.  This option disables the addition of
10992 such a suffix.
10994 @item -I-
10995 @opindex I-
10996 This option has been deprecated.  Please use @option{-iquote} instead for
10997 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10998 Any directories you specify with @option{-I} options before the @option{-I-}
10999 option are searched only for the case of @samp{#include "@var{file}"};
11000 they are not searched for @samp{#include <@var{file}>}.
11002 If additional directories are specified with @option{-I} options after
11003 the @option{-I-}, these directories are searched for all @samp{#include}
11004 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11005 this way.)
11007 In addition, the @option{-I-} option inhibits the use of the current
11008 directory (where the current input file came from) as the first search
11009 directory for @samp{#include "@var{file}"}.  There is no way to
11010 override this effect of @option{-I-}.  With @option{-I.} you can specify
11011 searching the directory that is current when the compiler is
11012 invoked.  That is not exactly the same as what the preprocessor does
11013 by default, but it is often satisfactory.
11015 @option{-I-} does not inhibit the use of the standard system directories
11016 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11017 independent.
11018 @end table
11020 @c man end
11022 @node Spec Files
11023 @section Specifying subprocesses and the switches to pass to them
11024 @cindex Spec Files
11026 @command{gcc} is a driver program.  It performs its job by invoking a
11027 sequence of other programs to do the work of compiling, assembling and
11028 linking.  GCC interprets its command-line parameters and uses these to
11029 deduce which programs it should invoke, and which command-line options
11030 it ought to place on their command lines.  This behavior is controlled
11031 by @dfn{spec strings}.  In most cases there is one spec string for each
11032 program that GCC can invoke, but a few programs have multiple spec
11033 strings to control their behavior.  The spec strings built into GCC can
11034 be overridden by using the @option{-specs=} command-line switch to specify
11035 a spec file.
11037 @dfn{Spec files} are plaintext files that are used to construct spec
11038 strings.  They consist of a sequence of directives separated by blank
11039 lines.  The type of directive is determined by the first non-whitespace
11040 character on the line, which can be one of the following:
11042 @table @code
11043 @item %@var{command}
11044 Issues a @var{command} to the spec file processor.  The commands that can
11045 appear here are:
11047 @table @code
11048 @item %include <@var{file}>
11049 @cindex @code{%include}
11050 Search for @var{file} and insert its text at the current point in the
11051 specs file.
11053 @item %include_noerr <@var{file}>
11054 @cindex @code{%include_noerr}
11055 Just like @samp{%include}, but do not generate an error message if the include
11056 file cannot be found.
11058 @item %rename @var{old_name} @var{new_name}
11059 @cindex @code{%rename}
11060 Rename the spec string @var{old_name} to @var{new_name}.
11062 @end table
11064 @item *[@var{spec_name}]:
11065 This tells the compiler to create, override or delete the named spec
11066 string.  All lines after this directive up to the next directive or
11067 blank line are considered to be the text for the spec string.  If this
11068 results in an empty string then the spec is deleted.  (Or, if the
11069 spec did not exist, then nothing happens.)  Otherwise, if the spec
11070 does not currently exist a new spec is created.  If the spec does
11071 exist then its contents are overridden by the text of this
11072 directive, unless the first character of that text is the @samp{+}
11073 character, in which case the text is appended to the spec.
11075 @item [@var{suffix}]:
11076 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11077 and up to the next directive or blank line are considered to make up the
11078 spec string for the indicated suffix.  When the compiler encounters an
11079 input file with the named suffix, it processes the spec string in
11080 order to work out how to compile that file.  For example:
11082 @smallexample
11083 .ZZ:
11084 z-compile -input %i
11085 @end smallexample
11087 This says that any input file whose name ends in @samp{.ZZ} should be
11088 passed to the program @samp{z-compile}, which should be invoked with the
11089 command-line switch @option{-input} and with the result of performing the
11090 @samp{%i} substitution.  (See below.)
11092 As an alternative to providing a spec string, the text following a
11093 suffix directive can be one of the following:
11095 @table @code
11096 @item @@@var{language}
11097 This says that the suffix is an alias for a known @var{language}.  This is
11098 similar to using the @option{-x} command-line switch to GCC to specify a
11099 language explicitly.  For example:
11101 @smallexample
11102 .ZZ:
11103 @@c++
11104 @end smallexample
11106 Says that .ZZ files are, in fact, C++ source files.
11108 @item #@var{name}
11109 This causes an error messages saying:
11111 @smallexample
11112 @var{name} compiler not installed on this system.
11113 @end smallexample
11114 @end table
11116 GCC already has an extensive list of suffixes built into it.
11117 This directive adds an entry to the end of the list of suffixes, but
11118 since the list is searched from the end backwards, it is effectively
11119 possible to override earlier entries using this technique.
11121 @end table
11123 GCC has the following spec strings built into it.  Spec files can
11124 override these strings or create their own.  Note that individual
11125 targets can also add their own spec strings to this list.
11127 @smallexample
11128 asm          Options to pass to the assembler
11129 asm_final    Options to pass to the assembler post-processor
11130 cpp          Options to pass to the C preprocessor
11131 cc1          Options to pass to the C compiler
11132 cc1plus      Options to pass to the C++ compiler
11133 endfile      Object files to include at the end of the link
11134 link         Options to pass to the linker
11135 lib          Libraries to include on the command line to the linker
11136 libgcc       Decides which GCC support library to pass to the linker
11137 linker       Sets the name of the linker
11138 predefines   Defines to be passed to the C preprocessor
11139 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11140              by default
11141 startfile    Object files to include at the start of the link
11142 @end smallexample
11144 Here is a small example of a spec file:
11146 @smallexample
11147 %rename lib                 old_lib
11149 *lib:
11150 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11151 @end smallexample
11153 This example renames the spec called @samp{lib} to @samp{old_lib} and
11154 then overrides the previous definition of @samp{lib} with a new one.
11155 The new definition adds in some extra command-line options before
11156 including the text of the old definition.
11158 @dfn{Spec strings} are a list of command-line options to be passed to their
11159 corresponding program.  In addition, the spec strings can contain
11160 @samp{%}-prefixed sequences to substitute variable text or to
11161 conditionally insert text into the command line.  Using these constructs
11162 it is possible to generate quite complex command lines.
11164 Here is a table of all defined @samp{%}-sequences for spec
11165 strings.  Note that spaces are not generated automatically around the
11166 results of expanding these sequences.  Therefore you can concatenate them
11167 together or combine them with constant text in a single argument.
11169 @table @code
11170 @item %%
11171 Substitute one @samp{%} into the program name or argument.
11173 @item %i
11174 Substitute the name of the input file being processed.
11176 @item %b
11177 Substitute the basename of the input file being processed.
11178 This is the substring up to (and not including) the last period
11179 and not including the directory.
11181 @item %B
11182 This is the same as @samp{%b}, but include the file suffix (text after
11183 the last period).
11185 @item %d
11186 Marks the argument containing or following the @samp{%d} as a
11187 temporary file name, so that that file is deleted if GCC exits
11188 successfully.  Unlike @samp{%g}, this contributes no text to the
11189 argument.
11191 @item %g@var{suffix}
11192 Substitute a file name that has suffix @var{suffix} and is chosen
11193 once per compilation, and mark the argument in the same way as
11194 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11195 name is now chosen in a way that is hard to predict even when previously
11196 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11197 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11198 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11199 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11200 was simply substituted with a file name chosen once per compilation,
11201 without regard to any appended suffix (which was therefore treated
11202 just like ordinary text), making such attacks more likely to succeed.
11204 @item %u@var{suffix}
11205 Like @samp{%g}, but generates a new temporary file name
11206 each time it appears instead of once per compilation.
11208 @item %U@var{suffix}
11209 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11210 new one if there is no such last file name.  In the absence of any
11211 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11212 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11213 involves the generation of two distinct file names, one
11214 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11215 simply substituted with a file name chosen for the previous @samp{%u},
11216 without regard to any appended suffix.
11218 @item %j@var{suffix}
11219 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11220 writable, and if @option{-save-temps} is not used; 
11221 otherwise, substitute the name
11222 of a temporary file, just like @samp{%u}.  This temporary file is not
11223 meant for communication between processes, but rather as a junk
11224 disposal mechanism.
11226 @item %|@var{suffix}
11227 @itemx %m@var{suffix}
11228 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11229 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11230 all.  These are the two most common ways to instruct a program that it
11231 should read from standard input or write to standard output.  If you
11232 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11233 construct: see for example @file{f/lang-specs.h}.
11235 @item %.@var{SUFFIX}
11236 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11237 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11238 terminated by the next space or %.
11240 @item %w
11241 Marks the argument containing or following the @samp{%w} as the
11242 designated output file of this compilation.  This puts the argument
11243 into the sequence of arguments that @samp{%o} substitutes.
11245 @item %o
11246 Substitutes the names of all the output files, with spaces
11247 automatically placed around them.  You should write spaces
11248 around the @samp{%o} as well or the results are undefined.
11249 @samp{%o} is for use in the specs for running the linker.
11250 Input files whose names have no recognized suffix are not compiled
11251 at all, but they are included among the output files, so they are
11252 linked.
11254 @item %O
11255 Substitutes the suffix for object files.  Note that this is
11256 handled specially when it immediately follows @samp{%g, %u, or %U},
11257 because of the need for those to form complete file names.  The
11258 handling is such that @samp{%O} is treated exactly as if it had already
11259 been substituted, except that @samp{%g, %u, and %U} do not currently
11260 support additional @var{suffix} characters following @samp{%O} as they do
11261 following, for example, @samp{.o}.
11263 @item %p
11264 Substitutes the standard macro predefinitions for the
11265 current target machine.  Use this when running @code{cpp}.
11267 @item %P
11268 Like @samp{%p}, but puts @samp{__} before and after the name of each
11269 predefined macro, except for macros that start with @samp{__} or with
11270 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11273 @item %I
11274 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11275 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11276 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11277 and @option{-imultilib} as necessary.
11279 @item %s
11280 Current argument is the name of a library or startup file of some sort.
11281 Search for that file in a standard list of directories and substitute
11282 the full name found.  The current working directory is included in the
11283 list of directories scanned.
11285 @item %T
11286 Current argument is the name of a linker script.  Search for that file
11287 in the current list of directories to scan for libraries. If the file
11288 is located insert a @option{--script} option into the command line
11289 followed by the full path name found.  If the file is not found then
11290 generate an error message.  Note: the current working directory is not
11291 searched.
11293 @item %e@var{str}
11294 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11295 Use this when inconsistent options are detected.
11297 @item %(@var{name})
11298 Substitute the contents of spec string @var{name} at this point.
11300 @item %x@{@var{option}@}
11301 Accumulate an option for @samp{%X}.
11303 @item %X
11304 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11305 spec string.
11307 @item %Y
11308 Output the accumulated assembler options specified by @option{-Wa}.
11310 @item %Z
11311 Output the accumulated preprocessor options specified by @option{-Wp}.
11313 @item %a
11314 Process the @code{asm} spec.  This is used to compute the
11315 switches to be passed to the assembler.
11317 @item %A
11318 Process the @code{asm_final} spec.  This is a spec string for
11319 passing switches to an assembler post-processor, if such a program is
11320 needed.
11322 @item %l
11323 Process the @code{link} spec.  This is the spec for computing the
11324 command line passed to the linker.  Typically it makes use of the
11325 @samp{%L %G %S %D and %E} sequences.
11327 @item %D
11328 Dump out a @option{-L} option for each directory that GCC believes might
11329 contain startup files.  If the target supports multilibs then the
11330 current multilib directory is prepended to each of these paths.
11332 @item %L
11333 Process the @code{lib} spec.  This is a spec string for deciding which
11334 libraries are included on the command line to the linker.
11336 @item %G
11337 Process the @code{libgcc} spec.  This is a spec string for deciding
11338 which GCC support library is included on the command line to the linker.
11340 @item %S
11341 Process the @code{startfile} spec.  This is a spec for deciding which
11342 object files are the first ones passed to the linker.  Typically
11343 this might be a file named @file{crt0.o}.
11345 @item %E
11346 Process the @code{endfile} spec.  This is a spec string that specifies
11347 the last object files that are passed to the linker.
11349 @item %C
11350 Process the @code{cpp} spec.  This is used to construct the arguments
11351 to be passed to the C preprocessor.
11353 @item %1
11354 Process the @code{cc1} spec.  This is used to construct the options to be
11355 passed to the actual C compiler (@samp{cc1}).
11357 @item %2
11358 Process the @code{cc1plus} spec.  This is used to construct the options to be
11359 passed to the actual C++ compiler (@samp{cc1plus}).
11361 @item %*
11362 Substitute the variable part of a matched option.  See below.
11363 Note that each comma in the substituted string is replaced by
11364 a single space.
11366 @item %<@code{S}
11367 Remove all occurrences of @code{-S} from the command line.  Note---this
11368 command is position dependent.  @samp{%} commands in the spec string
11369 before this one see @code{-S}, @samp{%} commands in the spec string
11370 after this one do not.
11372 @item %:@var{function}(@var{args})
11373 Call the named function @var{function}, passing it @var{args}.
11374 @var{args} is first processed as a nested spec string, then split
11375 into an argument vector in the usual fashion.  The function returns
11376 a string which is processed as if it had appeared literally as part
11377 of the current spec.
11379 The following built-in spec functions are provided:
11381 @table @code
11382 @item @code{getenv}
11383 The @code{getenv} spec function takes two arguments: an environment
11384 variable name and a string.  If the environment variable is not
11385 defined, a fatal error is issued.  Otherwise, the return value is the
11386 value of the environment variable concatenated with the string.  For
11387 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11389 @smallexample
11390 %:getenv(TOPDIR /include)
11391 @end smallexample
11393 expands to @file{/path/to/top/include}.
11395 @item @code{if-exists}
11396 The @code{if-exists} spec function takes one argument, an absolute
11397 pathname to a file.  If the file exists, @code{if-exists} returns the
11398 pathname.  Here is a small example of its usage:
11400 @smallexample
11401 *startfile:
11402 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11403 @end smallexample
11405 @item @code{if-exists-else}
11406 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11407 spec function, except that it takes two arguments.  The first argument is
11408 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11409 returns the pathname.  If it does not exist, it returns the second argument.
11410 This way, @code{if-exists-else} can be used to select one file or another,
11411 based on the existence of the first.  Here is a small example of its usage:
11413 @smallexample
11414 *startfile:
11415 crt0%O%s %:if-exists(crti%O%s) \
11416 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11417 @end smallexample
11419 @item @code{replace-outfile}
11420 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11421 first argument in the outfiles array and replaces it with the second argument.  Here
11422 is a small example of its usage:
11424 @smallexample
11425 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11426 @end smallexample
11428 @item @code{remove-outfile}
11429 The @code{remove-outfile} spec function takes one argument.  It looks for the
11430 first argument in the outfiles array and removes it.  Here is a small example
11431 its usage:
11433 @smallexample
11434 %:remove-outfile(-lm)
11435 @end smallexample
11437 @item @code{pass-through-libs}
11438 The @code{pass-through-libs} spec function takes any number of arguments.  It
11439 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11440 assumes are the names of linker input library archive files) and returns a
11441 result containing all the found arguments each prepended by
11442 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11443 intended to be passed to the LTO linker plugin.
11445 @smallexample
11446 %:pass-through-libs(%G %L %G)
11447 @end smallexample
11449 @item @code{print-asm-header}
11450 The @code{print-asm-header} function takes no arguments and simply
11451 prints a banner like:
11453 @smallexample
11454 Assembler options
11455 =================
11457 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11458 @end smallexample
11460 It is used to separate compiler options from assembler options
11461 in the @option{--target-help} output.
11462 @end table
11464 @item %@{@code{S}@}
11465 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11466 If that switch is not specified, this substitutes nothing.  Note that
11467 the leading dash is omitted when specifying this option, and it is
11468 automatically inserted if the substitution is performed.  Thus the spec
11469 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11470 and outputs the command-line option @option{-foo}.
11472 @item %W@{@code{S}@}
11473 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11474 deleted on failure.
11476 @item %@{@code{S}*@}
11477 Substitutes all the switches specified to GCC whose names start
11478 with @code{-S}, but which also take an argument.  This is used for
11479 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11480 GCC considers @option{-o foo} as being
11481 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11482 text, including the space.  Thus two arguments are generated.
11484 @item %@{@code{S}*&@code{T}*@}
11485 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11486 (the order of @code{S} and @code{T} in the spec is not significant).
11487 There can be any number of ampersand-separated variables; for each the
11488 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11490 @item %@{@code{S}:@code{X}@}
11491 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11493 @item %@{!@code{S}:@code{X}@}
11494 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11496 @item %@{@code{S}*:@code{X}@}
11497 Substitutes @code{X} if one or more switches whose names start with
11498 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11499 once, no matter how many such switches appeared.  However, if @code{%*}
11500 appears somewhere in @code{X}, then @code{X} is substituted once
11501 for each matching switch, with the @code{%*} replaced by the part of
11502 that switch matching the @code{*}.
11504 If @code{%*} appears as the last part of a spec sequence then a space
11505 will be added after the end of the last substitution.  If there is more
11506 text in the sequence however then a space will not be generated.  This
11507 allows the @code{%*} substitution to be used as part of a larger
11508 string.  For example, a spec string like this:
11510 @smallexample
11511 %@{mcu=*:--script=%*/memory.ld@}
11512 @end smallexample
11514 when matching an option like @code{-mcu=newchip} will produce:
11516 @smallexample
11517 --script=newchip/memory.ld
11518 @end smallexample
11520 @item %@{.@code{S}:@code{X}@}
11521 Substitutes @code{X}, if processing a file with suffix @code{S}.
11523 @item %@{!.@code{S}:@code{X}@}
11524 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11526 @item %@{,@code{S}:@code{X}@}
11527 Substitutes @code{X}, if processing a file for language @code{S}.
11529 @item %@{!,@code{S}:@code{X}@}
11530 Substitutes @code{X}, if not processing a file for language @code{S}.
11532 @item %@{@code{S}|@code{P}:@code{X}@}
11533 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11534 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11535 @code{*} sequences as well, although they have a stronger binding than
11536 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11537 alternatives must be starred, and only the first matching alternative
11538 is substituted.
11540 For example, a spec string like this:
11542 @smallexample
11543 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11544 @end smallexample
11546 @noindent
11547 outputs the following command-line options from the following input
11548 command-line options:
11550 @smallexample
11551 fred.c        -foo -baz
11552 jim.d         -bar -boggle
11553 -d fred.c     -foo -baz -boggle
11554 -d jim.d      -bar -baz -boggle
11555 @end smallexample
11557 @item %@{S:X; T:Y; :D@}
11559 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11560 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11561 be as many clauses as you need.  This may be combined with @code{.},
11562 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11565 @end table
11567 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11568 construct may contain other nested @samp{%} constructs or spaces, or
11569 even newlines.  They are processed as usual, as described above.
11570 Trailing white space in @code{X} is ignored.  White space may also
11571 appear anywhere on the left side of the colon in these constructs,
11572 except between @code{.} or @code{*} and the corresponding word.
11574 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11575 handled specifically in these constructs.  If another value of
11576 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11577 @option{-W} switch is found later in the command line, the earlier
11578 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11579 just one letter, which passes all matching options.
11581 The character @samp{|} at the beginning of the predicate text is used to
11582 indicate that a command should be piped to the following command, but
11583 only if @option{-pipe} is specified.
11585 It is built into GCC which switches take arguments and which do not.
11586 (You might think it would be useful to generalize this to allow each
11587 compiler's spec to say which switches take arguments.  But this cannot
11588 be done in a consistent fashion.  GCC cannot even decide which input
11589 files have been specified without knowing which switches take arguments,
11590 and it must know which input files to compile in order to tell which
11591 compilers to run).
11593 GCC also knows implicitly that arguments starting in @option{-l} are to be
11594 treated as compiler output files, and passed to the linker in their
11595 proper position among the other output files.
11597 @c man begin OPTIONS
11599 @node Target Options
11600 @section Specifying Target Machine and Compiler Version
11601 @cindex target options
11602 @cindex cross compiling
11603 @cindex specifying machine version
11604 @cindex specifying compiler version and target machine
11605 @cindex compiler version, specifying
11606 @cindex target machine, specifying
11608 The usual way to run GCC is to run the executable called @command{gcc}, or
11609 @command{@var{machine}-gcc} when cross-compiling, or
11610 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11611 one that was installed last.
11613 @node Submodel Options
11614 @section Hardware Models and Configurations
11615 @cindex submodel options
11616 @cindex specifying hardware config
11617 @cindex hardware models and configurations, specifying
11618 @cindex machine dependent options
11620 Each target machine types can have its own
11621 special options, starting with @samp{-m}, to choose among various
11622 hardware models or configurations---for example, 68010 vs 68020,
11623 floating coprocessor or none.  A single installed version of the
11624 compiler can compile for any model or configuration, according to the
11625 options specified.
11627 Some configurations of the compiler also support additional special
11628 options, usually for compatibility with other compilers on the same
11629 platform.
11631 @c This list is ordered alphanumerically by subsection name.
11632 @c It should be the same order and spelling as these options are listed
11633 @c in Machine Dependent Options
11635 @menu
11636 * AArch64 Options::
11637 * Adapteva Epiphany Options::
11638 * ARC Options::
11639 * ARM Options::
11640 * AVR Options::
11641 * Blackfin Options::
11642 * C6X Options::
11643 * CRIS Options::
11644 * CR16 Options::
11645 * Darwin Options::
11646 * DEC Alpha Options::
11647 * FR30 Options::
11648 * FRV Options::
11649 * GNU/Linux Options::
11650 * H8/300 Options::
11651 * HPPA Options::
11652 * i386 and x86-64 Options::
11653 * i386 and x86-64 Windows Options::
11654 * IA-64 Options::
11655 * LM32 Options::
11656 * M32C Options::
11657 * M32R/D Options::
11658 * M680x0 Options::
11659 * MCore Options::
11660 * MeP Options::
11661 * MicroBlaze Options::
11662 * MIPS Options::
11663 * MMIX Options::
11664 * MN10300 Options::
11665 * Moxie Options::
11666 * MSP430 Options::
11667 * NDS32 Options::
11668 * Nios II Options::
11669 * PDP-11 Options::
11670 * picoChip Options::
11671 * PowerPC Options::
11672 * RL78 Options::
11673 * RS/6000 and PowerPC Options::
11674 * RX Options::
11675 * S/390 and zSeries Options::
11676 * Score Options::
11677 * SH Options::
11678 * Solaris 2 Options::
11679 * SPARC Options::
11680 * SPU Options::
11681 * System V Options::
11682 * TILE-Gx Options::
11683 * TILEPro Options::
11684 * V850 Options::
11685 * VAX Options::
11686 * VMS Options::
11687 * VxWorks Options::
11688 * x86-64 Options::
11689 * Xstormy16 Options::
11690 * Xtensa Options::
11691 * zSeries Options::
11692 @end menu
11694 @node AArch64 Options
11695 @subsection AArch64 Options
11696 @cindex AArch64 Options
11698 These options are defined for AArch64 implementations:
11700 @table @gcctabopt
11702 @item -mabi=@var{name}
11703 @opindex mabi
11704 Generate code for the specified data model.  Permissible values
11705 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11706 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11707 but long int and pointer are 64-bit.
11709 The default depends on the specific target configuration.  Note that
11710 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11711 entire program with the same ABI, and link with a compatible set of libraries.
11713 @item -mbig-endian
11714 @opindex mbig-endian
11715 Generate big-endian code.  This is the default when GCC is configured for an
11716 @samp{aarch64_be-*-*} target.
11718 @item -mgeneral-regs-only
11719 @opindex mgeneral-regs-only
11720 Generate code which uses only the general registers.
11722 @item -mlittle-endian
11723 @opindex mlittle-endian
11724 Generate little-endian code.  This is the default when GCC is configured for an
11725 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11727 @item -mcmodel=tiny
11728 @opindex mcmodel=tiny
11729 Generate code for the tiny code model.  The program and its statically defined
11730 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11731 be statically or dynamically linked.  This model is not fully implemented and
11732 mostly treated as @samp{small}.
11734 @item -mcmodel=small
11735 @opindex mcmodel=small
11736 Generate code for the small code model.  The program and its statically defined
11737 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11738 be statically or dynamically linked.  This is the default code model.
11740 @item -mcmodel=large
11741 @opindex mcmodel=large
11742 Generate code for the large code model.  This makes no assumptions about
11743 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11744 statically linked only.
11746 @item -mstrict-align
11747 @opindex mstrict-align
11748 Do not assume that unaligned memory references will be handled by the system.
11750 @item -momit-leaf-frame-pointer
11751 @itemx -mno-omit-leaf-frame-pointer
11752 @opindex momit-leaf-frame-pointer
11753 @opindex mno-omit-leaf-frame-pointer
11754 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11755 default.
11757 @item -mtls-dialect=desc
11758 @opindex mtls-dialect=desc
11759 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11760 of TLS variables.  This is the default.
11762 @item -mtls-dialect=traditional
11763 @opindex mtls-dialect=traditional
11764 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11765 of TLS variables.
11767 @item -mfix-cortex-a53-835769
11768 @itemx -mno-fix-cortex-a53-835769
11769 @opindex -mfix-cortex-a53-835769
11770 @opindex -mno-fix-cortex-a53-835769
11771 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
11772 This will involve inserting a NOP instruction between memory instructions and
11773 64-bit integer multiply-accumulate instructions.
11775 @item -march=@var{name}
11776 @opindex march
11777 Specify the name of the target architecture, optionally suffixed by one or
11778 more feature modifiers.  This option has the form
11779 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11780 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11781 values for @var{feature} are documented in the sub-section below.
11783 Where conflicting feature modifiers are specified, the right-most feature is
11784 used.
11786 GCC uses this name to determine what kind of instructions it can emit when
11787 generating assembly code.
11789 Where @option{-march} is specified without either of @option{-mtune}
11790 or @option{-mcpu} also being specified, the code will be tuned to perform
11791 well across a range of target processors implementing the target
11792 architecture.
11794 @item -mtune=@var{name}
11795 @opindex mtune
11796 Specify the name of the target processor for which GCC should tune the
11797 performance of the code.  Permissible values for this option are:
11798 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}.
11800 Additionally, this option can specify that GCC should tune the performance
11801 of the code for a big.LITTLE system.  The only permissible value is
11802 @samp{cortex-a57.cortex-a53}.
11804 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
11805 are specified, the code will be tuned to perform well across a range
11806 of target processors.
11808 This option cannot be suffixed by feature modifiers.
11810 @item -mcpu=@var{name}
11811 @opindex mcpu
11812 Specify the name of the target processor, optionally suffixed by one or more
11813 feature modifiers.  This option has the form
11814 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11815 permissible values for @var{cpu} are the same as those available for
11816 @option{-mtune}.
11818 The permissible values for @var{feature} are documented in the sub-section
11819 below.
11821 Where conflicting feature modifiers are specified, the right-most feature is
11822 used.
11824 GCC uses this name to determine what kind of instructions it can emit when
11825 generating assembly code (as if by @option{-march}) and to determine
11826 the target processor for which to tune for performance (as if
11827 by @option{-mtune}).  Where this option is used in conjunction
11828 with @option{-march} or @option{-mtune}, those options take precedence
11829 over the appropriate part of this option.
11830 @end table
11832 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11833 @cindex @option{-march} feature modifiers
11834 @cindex @option{-mcpu} feature modifiers
11835 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11836 the following:
11838 @table @samp
11839 @item crc
11840 Enable CRC extension.
11841 @item crypto
11842 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11843 @item fp
11844 Enable floating-point instructions.
11845 @item simd
11846 Enable Advanced SIMD instructions.  This implies floating-point instructions
11847 are enabled.  This is the default for all current possible values for options
11848 @option{-march} and @option{-mcpu=}.
11849 @end table
11851 @node Adapteva Epiphany Options
11852 @subsection Adapteva Epiphany Options
11854 These @samp{-m} options are defined for Adapteva Epiphany:
11856 @table @gcctabopt
11857 @item -mhalf-reg-file
11858 @opindex mhalf-reg-file
11859 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11860 That allows code to run on hardware variants that lack these registers.
11862 @item -mprefer-short-insn-regs
11863 @opindex mprefer-short-insn-regs
11864 Preferrentially allocate registers that allow short instruction generation.
11865 This can result in increased instruction count, so this may either reduce or
11866 increase overall code size.
11868 @item -mbranch-cost=@var{num}
11869 @opindex mbranch-cost
11870 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11871 This cost is only a heuristic and is not guaranteed to produce
11872 consistent results across releases.
11874 @item -mcmove
11875 @opindex mcmove
11876 Enable the generation of conditional moves.
11878 @item -mnops=@var{num}
11879 @opindex mnops
11880 Emit @var{num} NOPs before every other generated instruction.
11882 @item -mno-soft-cmpsf
11883 @opindex mno-soft-cmpsf
11884 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11885 and test the flags.  This is faster than a software comparison, but can
11886 get incorrect results in the presence of NaNs, or when two different small
11887 numbers are compared such that their difference is calculated as zero.
11888 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11889 software comparisons.
11891 @item -mstack-offset=@var{num}
11892 @opindex mstack-offset
11893 Set the offset between the top of the stack and the stack pointer.
11894 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11895 can be used by leaf functions without stack allocation.
11896 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11897 Note also that this option changes the ABI; compiling a program with a
11898 different stack offset than the libraries have been compiled with
11899 generally does not work.
11900 This option can be useful if you want to evaluate if a different stack
11901 offset would give you better code, but to actually use a different stack
11902 offset to build working programs, it is recommended to configure the
11903 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11905 @item -mno-round-nearest
11906 @opindex mno-round-nearest
11907 Make the scheduler assume that the rounding mode has been set to
11908 truncating.  The default is @option{-mround-nearest}.
11910 @item -mlong-calls
11911 @opindex mlong-calls
11912 If not otherwise specified by an attribute, assume all calls might be beyond
11913 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11914 function address into a register before performing a (otherwise direct) call.
11915 This is the default.
11917 @item -mshort-calls
11918 @opindex short-calls
11919 If not otherwise specified by an attribute, assume all direct calls are
11920 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11921 for direct calls.  The default is @option{-mlong-calls}.
11923 @item -msmall16
11924 @opindex msmall16
11925 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11926 apply to function addresses for which @option{-mlong-calls} semantics
11927 are in effect.
11929 @item -mfp-mode=@var{mode}
11930 @opindex mfp-mode
11931 Set the prevailing mode of the floating-point unit.
11932 This determines the floating-point mode that is provided and expected
11933 at function call and return time.  Making this mode match the mode you
11934 predominantly need at function start can make your programs smaller and
11935 faster by avoiding unnecessary mode switches.
11937 @var{mode} can be set to one the following values:
11939 @table @samp
11940 @item caller
11941 Any mode at function entry is valid, and retained or restored when
11942 the function returns, and when it calls other functions.
11943 This mode is useful for compiling libraries or other compilation units
11944 you might want to incorporate into different programs with different
11945 prevailing FPU modes, and the convenience of being able to use a single
11946 object file outweighs the size and speed overhead for any extra
11947 mode switching that might be needed, compared with what would be needed
11948 with a more specific choice of prevailing FPU mode.
11950 @item truncate
11951 This is the mode used for floating-point calculations with
11952 truncating (i.e.@: round towards zero) rounding mode.  That includes
11953 conversion from floating point to integer.
11955 @item round-nearest
11956 This is the mode used for floating-point calculations with
11957 round-to-nearest-or-even rounding mode.
11959 @item int
11960 This is the mode used to perform integer calculations in the FPU, e.g.@:
11961 integer multiply, or integer multiply-and-accumulate.
11962 @end table
11964 The default is @option{-mfp-mode=caller}
11966 @item -mnosplit-lohi
11967 @itemx -mno-postinc
11968 @itemx -mno-postmodify
11969 @opindex mnosplit-lohi
11970 @opindex mno-postinc
11971 @opindex mno-postmodify
11972 Code generation tweaks that disable, respectively, splitting of 32-bit
11973 loads, generation of post-increment addresses, and generation of
11974 post-modify addresses.  The defaults are @option{msplit-lohi},
11975 @option{-mpost-inc}, and @option{-mpost-modify}.
11977 @item -mnovect-double
11978 @opindex mno-vect-double
11979 Change the preferred SIMD mode to SImode.  The default is
11980 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11982 @item -max-vect-align=@var{num}
11983 @opindex max-vect-align
11984 The maximum alignment for SIMD vector mode types.
11985 @var{num} may be 4 or 8.  The default is 8.
11986 Note that this is an ABI change, even though many library function
11987 interfaces are unaffected if they don't use SIMD vector modes
11988 in places that affect size and/or alignment of relevant types.
11990 @item -msplit-vecmove-early
11991 @opindex msplit-vecmove-early
11992 Split vector moves into single word moves before reload.  In theory this
11993 can give better register allocation, but so far the reverse seems to be
11994 generally the case.
11996 @item -m1reg-@var{reg}
11997 @opindex m1reg-
11998 Specify a register to hold the constant @minus{}1, which makes loading small negative
11999 constants and certain bitmasks faster.
12000 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12001 which specify use of that register as a fixed register,
12002 and @samp{none}, which means that no register is used for this
12003 purpose.  The default is @option{-m1reg-none}.
12005 @end table
12007 @node ARC Options
12008 @subsection ARC Options
12009 @cindex ARC options
12011 The following options control the architecture variant for which code
12012 is being compiled:
12014 @c architecture variants
12015 @table @gcctabopt
12017 @item -mbarrel-shifter
12018 @opindex mbarrel-shifter
12019 Generate instructions supported by barrel shifter.  This is the default
12020 unless @samp{-mcpu=ARC601} is in effect.
12022 @item -mcpu=@var{cpu}
12023 @opindex mcpu
12024 Set architecture type, register usage, and instruction scheduling
12025 parameters for @var{cpu}.  There are also shortcut alias options
12026 available for backward compatibility and convenience.  Supported
12027 values for @var{cpu} are
12029 @table @samp
12030 @opindex mA6
12031 @opindex mARC600
12032 @item ARC600
12033 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12035 @item ARC601
12036 @opindex mARC601
12037 Compile for ARC601.  Alias: @option{-mARC601}.
12039 @item ARC700
12040 @opindex mA7
12041 @opindex mARC700
12042 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12043 This is the default when configured with @samp{--with-cpu=arc700}@.
12044 @end table
12046 @item -mdpfp
12047 @opindex mdpfp
12048 @itemx -mdpfp-compact
12049 @opindex mdpfp-compact
12050 FPX: Generate Double Precision FPX instructions, tuned for the compact
12051 implementation.
12053 @item -mdpfp-fast
12054 @opindex mdpfp-fast
12055 FPX: Generate Double Precision FPX instructions, tuned for the fast
12056 implementation.
12058 @item -mno-dpfp-lrsr
12059 @opindex mno-dpfp-lrsr
12060 Disable LR and SR instructions from using FPX extension aux registers.
12062 @item -mea
12063 @opindex mea
12064 Generate Extended arithmetic instructions.  Currently only
12065 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12066 supported.  This is always enabled for @samp{-mcpu=ARC700}.
12068 @item -mno-mpy
12069 @opindex mno-mpy
12070 Do not generate mpy instructions for ARC700.
12072 @item -mmul32x16
12073 @opindex mmul32x16
12074 Generate 32x16 bit multiply and mac instructions.
12076 @item -mmul64
12077 @opindex mmul64
12078 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
12080 @item -mnorm
12081 @opindex mnorm
12082 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
12083 is in effect.
12085 @item -mspfp
12086 @opindex mspfp
12087 @itemx -mspfp-compact
12088 @opindex mspfp-compact
12089 FPX: Generate Single Precision FPX instructions, tuned for the compact
12090 implementation.
12092 @item -mspfp-fast
12093 @opindex mspfp-fast
12094 FPX: Generate Single Precision FPX instructions, tuned for the fast
12095 implementation.
12097 @item -msimd
12098 @opindex msimd
12099 Enable generation of ARC SIMD instructions via target-specific
12100 builtins.  Only valid for @samp{-mcpu=ARC700}.
12102 @item -msoft-float
12103 @opindex msoft-float
12104 This option ignored; it is provided for compatibility purposes only.
12105 Software floating point code is emitted by default, and this default
12106 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12107 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12108 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12110 @item -mswap
12111 @opindex mswap
12112 Generate swap instructions.
12114 @end table
12116 The following options are passed through to the assembler, and also
12117 define preprocessor macro symbols.
12119 @c Flags used by the assembler, but for which we define preprocessor
12120 @c macro symbols as well.
12121 @table @gcctabopt
12122 @item -mdsp-packa
12123 @opindex mdsp-packa
12124 Passed down to the assembler to enable the DSP Pack A extensions.
12125 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12127 @item -mdvbf
12128 @opindex mdvbf
12129 Passed down to the assembler to enable the dual viterbi butterfly
12130 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12132 @c ARC700 4.10 extension instruction
12133 @item -mlock
12134 @opindex mlock
12135 Passed down to the assembler to enable the Locked Load/Store
12136 Conditional extension.  Also sets the preprocessor symbol
12137 @code{__Xlock}.
12139 @item -mmac-d16
12140 @opindex mmac-d16
12141 Passed down to the assembler.  Also sets the preprocessor symbol
12142 @code{__Xxmac_d16}.
12144 @item -mmac-24
12145 @opindex mmac-24
12146 Passed down to the assembler.  Also sets the preprocessor symbol
12147 @code{__Xxmac_24}.
12149 @c ARC700 4.10 extension instruction
12150 @item -mrtsc
12151 @opindex mrtsc
12152 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12153 extension instruction.  Also sets the preprocessor symbol
12154 @code{__Xrtsc}.
12156 @c ARC700 4.10 extension instruction
12157 @item -mswape
12158 @opindex mswape
12159 Passed down to the assembler to enable the swap byte ordering
12160 extension instruction.  Also sets the preprocessor symbol
12161 @code{__Xswape}.
12163 @item -mtelephony
12164 @opindex mtelephony
12165 Passed down to the assembler to enable dual and single operand
12166 instructions for telephony.  Also sets the preprocessor symbol
12167 @code{__Xtelephony}.
12169 @item -mxy
12170 @opindex mxy
12171 Passed down to the assembler to enable the XY Memory extension.  Also
12172 sets the preprocessor symbol @code{__Xxy}.
12174 @end table
12176 The following options control how the assembly code is annotated:
12178 @c Assembly annotation options
12179 @table @gcctabopt
12180 @item -misize
12181 @opindex misize
12182 Annotate assembler instructions with estimated addresses.
12184 @item -mannotate-align
12185 @opindex mannotate-align
12186 Explain what alignment considerations lead to the decision to make an
12187 instruction short or long.
12189 @end table
12191 The following options are passed through to the linker:
12193 @c options passed through to the linker
12194 @table @gcctabopt
12195 @item -marclinux
12196 @opindex marclinux
12197 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12198 This option is enabled by default in tool chains built for
12199 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12200 when profiling is not requested.
12202 @item -marclinux_prof
12203 @opindex marclinux_prof
12204 Passed through to the linker, to specify use of the
12205 @code{arclinux_prof} emulation.  This option is enabled by default in
12206 tool chains built for @w{@code{arc-linux-uclibc}} and
12207 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12209 @end table
12211 The following options control the semantics of generated code:
12213 @c semantically relevant code generation options
12214 @table @gcctabopt
12215 @item -mepilogue-cfi
12216 @opindex mepilogue-cfi
12217 Enable generation of call frame information for epilogues.
12219 @item -mno-epilogue-cfi
12220 @opindex mno-epilogue-cfi
12221 Disable generation of call frame information for epilogues.
12223 @item -mlong-calls
12224 @opindex mlong-calls
12225 Generate call insns as register indirect calls, thus providing access
12226 to the full 32-bit address range.
12228 @item -mmedium-calls
12229 @opindex mmedium-calls
12230 Don't use less than 25 bit addressing range for calls, which is the
12231 offset available for an unconditional branch-and-link
12232 instruction.  Conditional execution of function calls is suppressed, to
12233 allow use of the 25-bit range, rather than the 21-bit range with
12234 conditional branch-and-link.  This is the default for tool chains built
12235 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12237 @item -mno-sdata
12238 @opindex mno-sdata
12239 Do not generate sdata references.  This is the default for tool chains
12240 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12241 targets.
12243 @item -mucb-mcount
12244 @opindex mucb-mcount
12245 Instrument with mcount calls as used in UCB code.  I.e. do the
12246 counting in the callee, not the caller.  By default ARC instrumentation
12247 counts in the caller.
12249 @item -mvolatile-cache
12250 @opindex mvolatile-cache
12251 Use ordinarily cached memory accesses for volatile references.  This is the
12252 default.
12254 @item -mno-volatile-cache
12255 @opindex mno-volatile-cache
12256 Enable cache bypass for volatile references.
12258 @end table
12260 The following options fine tune code generation:
12261 @c code generation tuning options
12262 @table @gcctabopt
12263 @item -malign-call
12264 @opindex malign-call
12265 Do alignment optimizations for call instructions.
12267 @item -mauto-modify-reg
12268 @opindex mauto-modify-reg
12269 Enable the use of pre/post modify with register displacement.
12271 @item -mbbit-peephole
12272 @opindex mbbit-peephole
12273 Enable bbit peephole2.
12275 @item -mno-brcc
12276 @opindex mno-brcc
12277 This option disables a target-specific pass in @file{arc_reorg} to
12278 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12279 generation driven by the combiner pass.
12281 @item -mcase-vector-pcrel
12282 @opindex mcase-vector-pcrel
12283 Use pc-relative switch case tables - this enables case table shortening.
12284 This is the default for @option{-Os}.
12286 @item -mcompact-casesi
12287 @opindex mcompact-casesi
12288 Enable compact casesi pattern.
12289 This is the default for @option{-Os}.
12291 @item -mno-cond-exec
12292 @opindex mno-cond-exec
12293 Disable ARCompact specific pass to generate conditional execution instructions.
12294 Due to delay slot scheduling and interactions between operand numbers,
12295 literal sizes, instruction lengths, and the support for conditional execution,
12296 the target-independent pass to generate conditional execution is often lacking,
12297 so the ARC port has kept a special pass around that tries to find more
12298 conditional execution generating opportunities after register allocation,
12299 branch shortening, and delay slot scheduling have been done.  This pass
12300 generally, but not always, improves performance and code size, at the cost of
12301 extra compilation time, which is why there is an option to switch it off.
12302 If you have a problem with call instructions exceeding their allowable
12303 offset range because they are conditionalized, you should consider using
12304 @option{-mmedium-calls} instead.
12306 @item -mearly-cbranchsi
12307 @opindex mearly-cbranchsi
12308 Enable pre-reload use of the cbranchsi pattern.
12310 @item -mexpand-adddi
12311 @opindex mexpand-adddi
12312 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12313 @code{add.f}, @code{adc} etc.
12315 @item -mindexed-loads
12316 @opindex mindexed-loads
12317 Enable the use of indexed loads.  This can be problematic because some
12318 optimizers will then assume the that indexed stores exist, which is not
12319 the case.
12321 @item -mlra
12322 @opindex mlra
12323 Enable Local Register Allocation.  This is still experimental for ARC,
12324 so by default the compiler uses standard reload
12325 (i.e. @samp{-mno-lra}).
12327 @item -mlra-priority-none
12328 @opindex mlra-priority-none
12329 Don't indicate any priority for target registers.
12331 @item -mlra-priority-compact
12332 @opindex mlra-priority-compact
12333 Indicate target register priority for r0..r3 / r12..r15.
12335 @item -mlra-priority-noncompact
12336 @opindex mlra-priority-noncompact
12337 Reduce target regsiter priority for r0..r3 / r12..r15.
12339 @item -mno-millicode
12340 @opindex mno-millicode
12341 When optimizing for size (using @option{-Os}), prologues and epilogues
12342 that have to save or restore a large number of registers are often
12343 shortened by using call to a special function in libgcc; this is
12344 referred to as a @emph{millicode} call.  As these calls can pose
12345 performance issues, and/or cause linking issues when linking in a
12346 nonstandard way, this option is provided to turn off millicode call
12347 generation.
12349 @item -mmixed-code
12350 @opindex mmixed-code
12351 Tweak register allocation to help 16-bit instruction generation.
12352 This generally has the effect of decreasing the average instruction size
12353 while increasing the instruction count.
12355 @item -mq-class
12356 @opindex mq-class
12357 Enable 'q' instruction alternatives.
12358 This is the default for @option{-Os}.
12360 @item -mRcq
12361 @opindex mRcq
12362 Enable Rcq constraint handling - most short code generation depends on this.
12363 This is the default.
12365 @item -mRcw
12366 @opindex mRcw
12367 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12368 This is the default.
12370 @item -msize-level=@var{level}
12371 @opindex msize-level
12372 Fine-tune size optimization with regards to instruction lengths and alignment.
12373 The recognized values for @var{level} are:
12374 @table @samp
12375 @item 0
12376 No size optimization.  This level is deprecated and treated like @samp{1}.
12378 @item 1
12379 Short instructions are used opportunistically.
12381 @item 2
12382 In addition, alignment of loops and of code after barriers are dropped.
12384 @item 3
12385 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12387 @end table
12389 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12390 the behavior when this is not set is equivalent to level @samp{1}.
12392 @item -mtune=@var{cpu}
12393 @opindex mtune
12394 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12395 by @option{-mcpu=}.
12397 Supported values for @var{cpu} are
12399 @table @samp
12400 @item ARC600
12401 Tune for ARC600 cpu.
12403 @item ARC601
12404 Tune for ARC601 cpu.
12406 @item ARC700
12407 Tune for ARC700 cpu with standard multiplier block.
12409 @item ARC700-xmac
12410 Tune for ARC700 cpu with XMAC block.
12412 @item ARC725D
12413 Tune for ARC725D cpu.
12415 @item ARC750D
12416 Tune for ARC750D cpu.
12418 @end table
12420 @item -mmultcost=@var{num}
12421 @opindex mmultcost
12422 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12423 normal instruction.
12425 @item -munalign-prob-threshold=@var{probability}
12426 @opindex munalign-prob-threshold
12427 Set probability threshold for unaligning branches.
12428 When tuning for @samp{ARC700} and optimizing for speed, branches without
12429 filled delay slot are preferably emitted unaligned and long, unless
12430 profiling indicates that the probability for the branch to be taken
12431 is below @var{probability}.  @xref{Cross-profiling}.
12432 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12434 @end table
12436 The following options are maintained for backward compatibility, but
12437 are now deprecated and will be removed in a future release:
12439 @c Deprecated options
12440 @table @gcctabopt
12442 @item -margonaut
12443 @opindex margonaut
12444 Obsolete FPX.
12446 @item -mbig-endian
12447 @opindex mbig-endian
12448 @itemx -EB
12449 @opindex EB
12450 Compile code for big endian targets.  Use of these options is now
12451 deprecated.  Users wanting big-endian code, should use the
12452 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12453 building the tool chain, for which big-endian is the default.
12455 @item -mlittle-endian
12456 @opindex mlittle-endian
12457 @itemx -EL
12458 @opindex EL
12459 Compile code for little endian targets.  Use of these options is now
12460 deprecated.  Users wanting little-endian code should use the
12461 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12462 building the tool chain, for which little-endian is the default.
12464 @item -mbarrel_shifter
12465 @opindex mbarrel_shifter
12466 Replaced by @samp{-mbarrel-shifter}
12468 @item -mdpfp_compact
12469 @opindex mdpfp_compact
12470 Replaced by @samp{-mdpfp-compact}
12472 @item -mdpfp_fast
12473 @opindex mdpfp_fast
12474 Replaced by @samp{-mdpfp-fast}
12476 @item -mdsp_packa
12477 @opindex mdsp_packa
12478 Replaced by @samp{-mdsp-packa}
12480 @item -mEA
12481 @opindex mEA
12482 Replaced by @samp{-mea}
12484 @item -mmac_24
12485 @opindex mmac_24
12486 Replaced by @samp{-mmac-24}
12488 @item -mmac_d16
12489 @opindex mmac_d16
12490 Replaced by @samp{-mmac-d16}
12492 @item -mspfp_compact
12493 @opindex mspfp_compact
12494 Replaced by @samp{-mspfp-compact}
12496 @item -mspfp_fast
12497 @opindex mspfp_fast
12498 Replaced by @samp{-mspfp-fast}
12500 @item -mtune=@var{cpu}
12501 @opindex mtune
12502 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12503 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12504 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12506 @item -multcost=@var{num}
12507 @opindex multcost
12508 Replaced by @samp{-mmultcost}.
12510 @end table
12512 @node ARM Options
12513 @subsection ARM Options
12514 @cindex ARM options
12516 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
12517 architectures:
12519 @table @gcctabopt
12520 @item -mabi=@var{name}
12521 @opindex mabi
12522 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12523 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12525 @item -mapcs-frame
12526 @opindex mapcs-frame
12527 Generate a stack frame that is compliant with the ARM Procedure Call
12528 Standard for all functions, even if this is not strictly necessary for
12529 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12530 with this option causes the stack frames not to be generated for
12531 leaf functions.  The default is @option{-mno-apcs-frame}.
12533 @item -mapcs
12534 @opindex mapcs
12535 This is a synonym for @option{-mapcs-frame}.
12537 @ignore
12538 @c not currently implemented
12539 @item -mapcs-stack-check
12540 @opindex mapcs-stack-check
12541 Generate code to check the amount of stack space available upon entry to
12542 every function (that actually uses some stack space).  If there is
12543 insufficient space available then either the function
12544 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12545 called, depending upon the amount of stack space required.  The runtime
12546 system is required to provide these functions.  The default is
12547 @option{-mno-apcs-stack-check}, since this produces smaller code.
12549 @c not currently implemented
12550 @item -mapcs-float
12551 @opindex mapcs-float
12552 Pass floating-point arguments using the floating-point registers.  This is
12553 one of the variants of the APCS@.  This option is recommended if the
12554 target hardware has a floating-point unit or if a lot of floating-point
12555 arithmetic is going to be performed by the code.  The default is
12556 @option{-mno-apcs-float}, since the size of integer-only code is 
12557 slightly increased if @option{-mapcs-float} is used.
12559 @c not currently implemented
12560 @item -mapcs-reentrant
12561 @opindex mapcs-reentrant
12562 Generate reentrant, position-independent code.  The default is
12563 @option{-mno-apcs-reentrant}.
12564 @end ignore
12566 @item -mthumb-interwork
12567 @opindex mthumb-interwork
12568 Generate code that supports calling between the ARM and Thumb
12569 instruction sets.  Without this option, on pre-v5 architectures, the
12570 two instruction sets cannot be reliably used inside one program.  The
12571 default is @option{-mno-thumb-interwork}, since slightly larger code
12572 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12573 configurations this option is meaningless.
12575 @item -mno-sched-prolog
12576 @opindex mno-sched-prolog
12577 Prevent the reordering of instructions in the function prologue, or the
12578 merging of those instruction with the instructions in the function's
12579 body.  This means that all functions start with a recognizable set
12580 of instructions (or in fact one of a choice from a small set of
12581 different function prologues), and this information can be used to
12582 locate the start of functions inside an executable piece of code.  The
12583 default is @option{-msched-prolog}.
12585 @item -mfloat-abi=@var{name}
12586 @opindex mfloat-abi
12587 Specifies which floating-point ABI to use.  Permissible values
12588 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12590 Specifying @samp{soft} causes GCC to generate output containing
12591 library calls for floating-point operations.
12592 @samp{softfp} allows the generation of code using hardware floating-point
12593 instructions, but still uses the soft-float calling conventions.
12594 @samp{hard} allows generation of floating-point instructions
12595 and uses FPU-specific calling conventions.
12597 The default depends on the specific target configuration.  Note that
12598 the hard-float and soft-float ABIs are not link-compatible; you must
12599 compile your entire program with the same ABI, and link with a
12600 compatible set of libraries.
12602 @item -mlittle-endian
12603 @opindex mlittle-endian
12604 Generate code for a processor running in little-endian mode.  This is
12605 the default for all standard configurations.
12607 @item -mbig-endian
12608 @opindex mbig-endian
12609 Generate code for a processor running in big-endian mode; the default is
12610 to compile code for a little-endian processor.
12612 @item -march=@var{name}
12613 @opindex march
12614 This specifies the name of the target ARM architecture.  GCC uses this
12615 name to determine what kind of instructions it can emit when generating
12616 assembly code.  This option can be used in conjunction with or instead
12617 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12618 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12619 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12620 @samp{armv6}, @samp{armv6j},
12621 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12622 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12623 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12624 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12626 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12627 extensions.
12629 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12630 architecture together with the optional CRC32 extensions.
12632 @option{-march=native} causes the compiler to auto-detect the architecture
12633 of the build computer.  At present, this feature is only supported on
12634 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12635 is unsuccessful the option has no effect.
12637 @item -mtune=@var{name}
12638 @opindex mtune
12639 This option specifies the name of the target ARM processor for
12640 which GCC should tune the performance of the code.
12641 For some ARM implementations better performance can be obtained by using
12642 this option.
12643 Permissible names are: @samp{arm2}, @samp{arm250},
12644 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12645 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12646 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12647 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12648 @samp{arm720},
12649 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12650 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12651 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12652 @samp{strongarm1110},
12653 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12654 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12655 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12656 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12657 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12658 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12659 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12660 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12661 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12662 @samp{cortex-r4},
12663 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12664 @samp{cortex-m4},
12665 @samp{cortex-m3},
12666 @samp{cortex-m1},
12667 @samp{cortex-m0},
12668 @samp{cortex-m0plus},
12669 @samp{marvell-pj4},
12670 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12671 @samp{fa526}, @samp{fa626},
12672 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12674 Additionally, this option can specify that GCC should tune the performance
12675 of the code for a big.LITTLE system.  Permissible names are:
12676 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12678 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12679 performance for a blend of processors within architecture @var{arch}.
12680 The aim is to generate code that run well on the current most popular
12681 processors, balancing between optimizations that benefit some CPUs in the
12682 range, and avoiding performance pitfalls of other CPUs.  The effects of
12683 this option may change in future GCC versions as CPU models come and go.
12685 @option{-mtune=native} causes the compiler to auto-detect the CPU
12686 of the build computer.  At present, this feature is only supported on
12687 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12688 unsuccessful the option has no effect.
12690 @item -mcpu=@var{name}
12691 @opindex mcpu
12692 This specifies the name of the target ARM processor.  GCC uses this name
12693 to derive the name of the target ARM architecture (as if specified
12694 by @option{-march}) and the ARM processor type for which to tune for
12695 performance (as if specified by @option{-mtune}).  Where this option
12696 is used in conjunction with @option{-march} or @option{-mtune},
12697 those options take precedence over the appropriate part of this option.
12699 Permissible names for this option are the same as those for
12700 @option{-mtune}.
12702 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12703 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12704 See @option{-mtune} for more information.
12706 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12707 of the build computer.  At present, this feature is only supported on
12708 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12709 is unsuccessful the option has no effect.
12711 @item -mfpu=@var{name}
12712 @opindex mfpu
12713 This specifies what floating-point hardware (or hardware emulation) is
12714 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12715 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12716 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12717 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12718 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12719 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12721 If @option{-msoft-float} is specified this specifies the format of
12722 floating-point values.
12724 If the selected floating-point hardware includes the NEON extension
12725 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12726 operations are not generated by GCC's auto-vectorization pass unless
12727 @option{-funsafe-math-optimizations} is also specified.  This is
12728 because NEON hardware does not fully implement the IEEE 754 standard for
12729 floating-point arithmetic (in particular denormal values are treated as
12730 zero), so the use of NEON instructions may lead to a loss of precision.
12732 @item -mfp16-format=@var{name}
12733 @opindex mfp16-format
12734 Specify the format of the @code{__fp16} half-precision floating-point type.
12735 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12736 the default is @samp{none}, in which case the @code{__fp16} type is not
12737 defined.  @xref{Half-Precision}, for more information.
12739 @item -mstructure-size-boundary=@var{n}
12740 @opindex mstructure-size-boundary
12741 The sizes of all structures and unions are rounded up to a multiple
12742 of the number of bits set by this option.  Permissible values are 8, 32
12743 and 64.  The default value varies for different toolchains.  For the COFF
12744 targeted toolchain the default value is 8.  A value of 64 is only allowed
12745 if the underlying ABI supports it.
12747 Specifying a larger number can produce faster, more efficient code, but
12748 can also increase the size of the program.  Different values are potentially
12749 incompatible.  Code compiled with one value cannot necessarily expect to
12750 work with code or libraries compiled with another value, if they exchange
12751 information using structures or unions.
12753 @item -mabort-on-noreturn
12754 @opindex mabort-on-noreturn
12755 Generate a call to the function @code{abort} at the end of a
12756 @code{noreturn} function.  It is executed if the function tries to
12757 return.
12759 @item -mlong-calls
12760 @itemx -mno-long-calls
12761 @opindex mlong-calls
12762 @opindex mno-long-calls
12763 Tells the compiler to perform function calls by first loading the
12764 address of the function into a register and then performing a subroutine
12765 call on this register.  This switch is needed if the target function
12766 lies outside of the 64-megabyte addressing range of the offset-based
12767 version of subroutine call instruction.
12769 Even if this switch is enabled, not all function calls are turned
12770 into long calls.  The heuristic is that static functions, functions
12771 that have the @samp{short-call} attribute, functions that are inside
12772 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12773 definitions have already been compiled within the current compilation
12774 unit are not turned into long calls.  The exceptions to this rule are
12775 that weak function definitions, functions with the @samp{long-call}
12776 attribute or the @samp{section} attribute, and functions that are within
12777 the scope of a @samp{#pragma long_calls} directive are always
12778 turned into long calls.
12780 This feature is not enabled by default.  Specifying
12781 @option{-mno-long-calls} restores the default behavior, as does
12782 placing the function calls within the scope of a @samp{#pragma
12783 long_calls_off} directive.  Note these switches have no effect on how
12784 the compiler generates code to handle function calls via function
12785 pointers.
12787 @item -msingle-pic-base
12788 @opindex msingle-pic-base
12789 Treat the register used for PIC addressing as read-only, rather than
12790 loading it in the prologue for each function.  The runtime system is
12791 responsible for initializing this register with an appropriate value
12792 before execution begins.
12794 @item -mpic-register=@var{reg}
12795 @opindex mpic-register
12796 Specify the register to be used for PIC addressing.
12797 For standard PIC base case, the default will be any suitable register
12798 determined by compiler.  For single PIC base case, the default is
12799 @samp{R9} if target is EABI based or stack-checking is enabled,
12800 otherwise the default is @samp{R10}.
12802 @item -mpic-data-is-text-relative
12803 @opindex mpic-data-is-text-relative
12804 Assume that each data segments are relative to text segment at load time.
12805 Therefore, it permits addressing data using PC-relative operations.
12806 This option is on by default for targets other than VxWorks RTP.
12808 @item -mpoke-function-name
12809 @opindex mpoke-function-name
12810 Write the name of each function into the text section, directly
12811 preceding the function prologue.  The generated code is similar to this:
12813 @smallexample
12814      t0
12815          .ascii "arm_poke_function_name", 0
12816          .align
12817      t1
12818          .word 0xff000000 + (t1 - t0)
12819      arm_poke_function_name
12820          mov     ip, sp
12821          stmfd   sp!, @{fp, ip, lr, pc@}
12822          sub     fp, ip, #4
12823 @end smallexample
12825 When performing a stack backtrace, code can inspect the value of
12826 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
12827 location @code{pc - 12} and the top 8 bits are set, then we know that
12828 there is a function name embedded immediately preceding this location
12829 and has length @code{((pc[-3]) & 0xff000000)}.
12831 @item -mthumb
12832 @itemx -marm
12833 @opindex marm
12834 @opindex mthumb
12836 Select between generating code that executes in ARM and Thumb
12837 states.  The default for most configurations is to generate code
12838 that executes in ARM state, but the default can be changed by
12839 configuring GCC with the @option{--with-mode=}@var{state}
12840 configure option.
12842 @item -mtpcs-frame
12843 @opindex mtpcs-frame
12844 Generate a stack frame that is compliant with the Thumb Procedure Call
12845 Standard for all non-leaf functions.  (A leaf function is one that does
12846 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
12848 @item -mtpcs-leaf-frame
12849 @opindex mtpcs-leaf-frame
12850 Generate a stack frame that is compliant with the Thumb Procedure Call
12851 Standard for all leaf functions.  (A leaf function is one that does
12852 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
12854 @item -mcallee-super-interworking
12855 @opindex mcallee-super-interworking
12856 Gives all externally visible functions in the file being compiled an ARM
12857 instruction set header which switches to Thumb mode before executing the
12858 rest of the function.  This allows these functions to be called from
12859 non-interworking code.  This option is not valid in AAPCS configurations
12860 because interworking is enabled by default.
12862 @item -mcaller-super-interworking
12863 @opindex mcaller-super-interworking
12864 Allows calls via function pointers (including virtual functions) to
12865 execute correctly regardless of whether the target code has been
12866 compiled for interworking or not.  There is a small overhead in the cost
12867 of executing a function pointer if this option is enabled.  This option
12868 is not valid in AAPCS configurations because interworking is enabled
12869 by default.
12871 @item -mtp=@var{name}
12872 @opindex mtp
12873 Specify the access model for the thread local storage pointer.  The valid
12874 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
12875 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
12876 (supported in the arm6k architecture), and @option{auto}, which uses the
12877 best available method for the selected processor.  The default setting is
12878 @option{auto}.
12880 @item -mtls-dialect=@var{dialect}
12881 @opindex mtls-dialect
12882 Specify the dialect to use for accessing thread local storage.  Two
12883 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
12884 @samp{gnu} dialect selects the original GNU scheme for supporting
12885 local and global dynamic TLS models.  The @samp{gnu2} dialect
12886 selects the GNU descriptor scheme, which provides better performance
12887 for shared libraries.  The GNU descriptor scheme is compatible with
12888 the original scheme, but does require new assembler, linker and
12889 library support.  Initial and local exec TLS models are unaffected by
12890 this option and always use the original scheme.
12892 @item -mword-relocations
12893 @opindex mword-relocations
12894 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
12895 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
12896 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
12897 is specified.
12899 @item -mfix-cortex-m3-ldrd
12900 @opindex mfix-cortex-m3-ldrd
12901 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
12902 with overlapping destination and base registers are used.  This option avoids
12903 generating these instructions.  This option is enabled by default when
12904 @option{-mcpu=cortex-m3} is specified.
12906 @item -munaligned-access
12907 @itemx -mno-unaligned-access
12908 @opindex munaligned-access
12909 @opindex mno-unaligned-access
12910 Enables (or disables) reading and writing of 16- and 32- bit values
12911 from addresses that are not 16- or 32- bit aligned.  By default
12912 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
12913 architectures, and enabled for all other architectures.  If unaligned
12914 access is not enabled then words in packed data structures will be
12915 accessed a byte at a time.
12917 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
12918 generated object file to either true or false, depending upon the
12919 setting of this option.  If unaligned access is enabled then the
12920 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
12921 defined.
12923 @item -mneon-for-64bits
12924 @opindex mneon-for-64bits
12925 Enables using Neon to handle scalar 64-bits operations. This is
12926 disabled by default since the cost of moving data from core registers
12927 to Neon is high.
12929 @item -mslow-flash-data
12930 @opindex mslow-flash-data
12931 Assume loading data from flash is slower than fetching instruction.
12932 Therefore literal load is minimized for better performance.
12933 This option is only supported when compiling for ARMv7 M-profile and
12934 off by default.
12936 @item -mrestrict-it
12937 @opindex mrestrict-it
12938 Restricts generation of IT blocks to conform to the rules of ARMv8.
12939 IT blocks can only contain a single 16-bit instruction from a select
12940 set of instructions. This option is on by default for ARMv8 Thumb mode.
12941 @end table
12943 @node AVR Options
12944 @subsection AVR Options
12945 @cindex AVR Options
12947 These options are defined for AVR implementations:
12949 @table @gcctabopt
12950 @item -mmcu=@var{mcu}
12951 @opindex mmcu
12952 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
12954 The default for this option is@tie{}@code{avr2}.
12956 GCC supports the following AVR devices and ISAs:
12958 @include avr-mmcu.texi
12960 @item -maccumulate-args
12961 @opindex maccumulate-args
12962 Accumulate outgoing function arguments and acquire/release the needed
12963 stack space for outgoing function arguments once in function
12964 prologue/epilogue.  Without this option, outgoing arguments are pushed
12965 before calling a function and popped afterwards.
12967 Popping the arguments after the function call can be expensive on
12968 AVR so that accumulating the stack space might lead to smaller
12969 executables because arguments need not to be removed from the
12970 stack after such a function call.
12972 This option can lead to reduced code size for functions that perform
12973 several calls to functions that get their arguments on the stack like
12974 calls to printf-like functions.
12976 @item -mbranch-cost=@var{cost}
12977 @opindex mbranch-cost
12978 Set the branch costs for conditional branch instructions to
12979 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
12980 integers. The default branch cost is 0.
12982 @item -mcall-prologues
12983 @opindex mcall-prologues
12984 Functions prologues/epilogues are expanded as calls to appropriate
12985 subroutines.  Code size is smaller.
12987 @item -mint8
12988 @opindex mint8
12989 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
12990 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
12991 and @code{long long} is 4 bytes.  Please note that this option does not
12992 conform to the C standards, but it results in smaller code
12993 size.
12995 @item -mno-interrupts
12996 @opindex mno-interrupts
12997 Generated code is not compatible with hardware interrupts.
12998 Code size is smaller.
13000 @item -mrelax
13001 @opindex mrelax
13002 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13003 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13004 Setting @code{-mrelax} just adds the @code{--relax} option to the
13005 linker command line when the linker is called.
13007 Jump relaxing is performed by the linker because jump offsets are not
13008 known before code is located. Therefore, the assembler code generated by the
13009 compiler is the same, but the instructions in the executable may
13010 differ from instructions in the assembler code.
13012 Relaxing must be turned on if linker stubs are needed, see the
13013 section on @code{EIND} and linker stubs below.
13015 @item -msp8
13016 @opindex msp8
13017 Treat the stack pointer register as an 8-bit register,
13018 i.e.@: assume the high byte of the stack pointer is zero.
13019 In general, you don't need to set this option by hand.
13021 This option is used internally by the compiler to select and
13022 build multilibs for architectures @code{avr2} and @code{avr25}.
13023 These architectures mix devices with and without @code{SPH}.
13024 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
13025 the compiler driver will add or remove this option from the compiler
13026 proper's command line, because the compiler then knows if the device
13027 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13028 register or not.
13030 @item -mstrict-X
13031 @opindex mstrict-X
13032 Use address register @code{X} in a way proposed by the hardware.  This means
13033 that @code{X} is only used in indirect, post-increment or
13034 pre-decrement addressing.
13036 Without this option, the @code{X} register may be used in the same way
13037 as @code{Y} or @code{Z} which then is emulated by additional
13038 instructions.  
13039 For example, loading a value with @code{X+const} addressing with a
13040 small non-negative @code{const < 64} to a register @var{Rn} is
13041 performed as
13043 @example
13044 adiw r26, const   ; X += const
13045 ld   @var{Rn}, X        ; @var{Rn} = *X
13046 sbiw r26, const   ; X -= const
13047 @end example
13049 @item -mtiny-stack
13050 @opindex mtiny-stack
13051 Only change the lower 8@tie{}bits of the stack pointer.
13053 @item -Waddr-space-convert
13054 @opindex Waddr-space-convert
13055 Warn about conversions between address spaces in the case where the
13056 resulting address space is not contained in the incoming address space.
13057 @end table
13059 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
13060 @cindex @code{EIND}
13061 Pointers in the implementation are 16@tie{}bits wide.
13062 The address of a function or label is represented as word address so
13063 that indirect jumps and calls can target any code address in the
13064 range of 64@tie{}Ki words.
13066 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13067 bytes of program memory space, there is a special function register called
13068 @code{EIND} that serves as most significant part of the target address
13069 when @code{EICALL} or @code{EIJMP} instructions are used.
13071 Indirect jumps and calls on these devices are handled as follows by
13072 the compiler and are subject to some limitations:
13074 @itemize @bullet
13076 @item
13077 The compiler never sets @code{EIND}.
13079 @item
13080 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13081 instructions or might read @code{EIND} directly in order to emulate an
13082 indirect call/jump by means of a @code{RET} instruction.
13084 @item
13085 The compiler assumes that @code{EIND} never changes during the startup
13086 code or during the application. In particular, @code{EIND} is not
13087 saved/restored in function or interrupt service routine
13088 prologue/epilogue.
13090 @item
13091 For indirect calls to functions and computed goto, the linker
13092 generates @emph{stubs}. Stubs are jump pads sometimes also called
13093 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13094 The stub contains a direct jump to the desired address.
13096 @item
13097 Linker relaxation must be turned on so that the linker will generate
13098 the stubs correctly an all situaltion. See the compiler option
13099 @code{-mrelax} and the linler option @code{--relax}.
13100 There are corner cases where the linker is supposed to generate stubs
13101 but aborts without relaxation and without a helpful error message.
13103 @item
13104 The default linker script is arranged for code with @code{EIND = 0}.
13105 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13106 linker script has to be used in order to place the sections whose
13107 name start with @code{.trampolines} into the segment where @code{EIND}
13108 points to.
13110 @item
13111 The startup code from libgcc never sets @code{EIND}.
13112 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13113 For the impact of AVR-LibC on @code{EIND}, see the
13114 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13116 @item
13117 It is legitimate for user-specific startup code to set up @code{EIND}
13118 early, for example by means of initialization code located in
13119 section @code{.init3}. Such code runs prior to general startup code
13120 that initializes RAM and calls constructors, but after the bit
13121 of startup code from AVR-LibC that sets @code{EIND} to the segment
13122 where the vector table is located.
13123 @example
13124 #include <avr/io.h>
13126 static void
13127 __attribute__((section(".init3"),naked,used,no_instrument_function))
13128 init3_set_eind (void)
13130   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13131                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13133 @end example
13135 @noindent
13136 The @code{__trampolines_start} symbol is defined in the linker script.
13138 @item
13139 Stubs are generated automatically by the linker if
13140 the following two conditions are met:
13141 @itemize @minus
13143 @item The address of a label is taken by means of the @code{gs} modifier
13144 (short for @emph{generate stubs}) like so:
13145 @example
13146 LDI r24, lo8(gs(@var{func}))
13147 LDI r25, hi8(gs(@var{func}))
13148 @end example
13149 @item The final location of that label is in a code segment
13150 @emph{outside} the segment where the stubs are located.
13151 @end itemize
13153 @item
13154 The compiler emits such @code{gs} modifiers for code labels in the
13155 following situations:
13156 @itemize @minus
13157 @item Taking address of a function or code label.
13158 @item Computed goto.
13159 @item If prologue-save function is used, see @option{-mcall-prologues}
13160 command-line option.
13161 @item Switch/case dispatch tables. If you do not want such dispatch
13162 tables you can specify the @option{-fno-jump-tables} command-line option.
13163 @item C and C++ constructors/destructors called during startup/shutdown.
13164 @item If the tools hit a @code{gs()} modifier explained above.
13165 @end itemize
13167 @item
13168 Jumping to non-symbolic addresses like so is @emph{not} supported:
13170 @example
13171 int main (void)
13173     /* Call function at word address 0x2 */
13174     return ((int(*)(void)) 0x2)();
13176 @end example
13178 Instead, a stub has to be set up, i.e.@: the function has to be called
13179 through a symbol (@code{func_4} in the example):
13181 @example
13182 int main (void)
13184     extern int func_4 (void);
13186     /* Call function at byte address 0x4 */
13187     return func_4();
13189 @end example
13191 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
13192 Alternatively, @code{func_4} can be defined in the linker script.
13193 @end itemize
13195 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13196 @cindex @code{RAMPD}
13197 @cindex @code{RAMPX}
13198 @cindex @code{RAMPY}
13199 @cindex @code{RAMPZ}
13200 Some AVR devices support memories larger than the 64@tie{}KiB range
13201 that can be accessed with 16-bit pointers.  To access memory locations
13202 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13203 register is used as high part of the address:
13204 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13205 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13206 register, respectively, to get a wide address. Similarly,
13207 @code{RAMPD} is used together with direct addressing.
13209 @itemize
13210 @item
13211 The startup code initializes the @code{RAMP} special function
13212 registers with zero.
13214 @item
13215 If a @ref{AVR Named Address Spaces,named address space} other than
13216 generic or @code{__flash} is used, then @code{RAMPZ} is set
13217 as needed before the operation.
13219 @item
13220 If the device supports RAM larger than 64@tie{}KiB and the compiler
13221 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13222 is reset to zero after the operation.
13224 @item
13225 If the device comes with a specific @code{RAMP} register, the ISR
13226 prologue/epilogue saves/restores that SFR and initializes it with
13227 zero in case the ISR code might (implicitly) use it.
13229 @item
13230 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13231 If you use inline assembler to read from locations outside the
13232 16-bit address range and change one of the @code{RAMP} registers,
13233 you must reset it to zero after the access.
13235 @end itemize
13237 @subsubsection AVR Built-in Macros
13239 GCC defines several built-in macros so that the user code can test
13240 for the presence or absence of features.  Almost any of the following
13241 built-in macros are deduced from device capabilities and thus
13242 triggered by the @code{-mmcu=} command-line option.
13244 For even more AVR-specific built-in macros see
13245 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13247 @table @code
13249 @item __AVR_ARCH__
13250 Build-in macro that resolves to a decimal number that identifies the
13251 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13252 Possible values are:
13254 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13255 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13256 @code{105}, @code{106}, @code{107}
13258 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13259 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13260 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13261 @code{avrxmega6}, @code{avrxmega7}, respectively.
13262 If @var{mcu} specifies a device, this built-in macro is set
13263 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13264 defined to @code{4}.
13266 @item __AVR_@var{Device}__
13267 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13268 the device's name. For example, @code{-mmcu=atmega8} defines the
13269 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13270 @code{__AVR_ATtiny261A__}, etc.
13272 The built-in macros' names follow
13273 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13274 the device name as from the AVR user manual. The difference between
13275 @var{Device} in the built-in macro and @var{device} in
13276 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13278 If @var{device} is not a device but only a core architecture like
13279 @code{avr51}, this macro will not be defined.
13281 @item   __AVR_DEVICE_NAME__
13282 Setting @code{-mmcu=@var{device}} defines this built-in macro to
13283 the device's name. For example, with @code{-mmcu=atmega8} the macro
13284 will be defined to @code{atmega8}.
13286 If @var{device} is not a device but only a core architecture like
13287 @code{avr51}, this macro will not be defined.
13289 @item __AVR_XMEGA__
13290 The device / architecture belongs to the XMEGA family of devices.
13292 @item __AVR_HAVE_ELPM__
13293 The device has the the @code{ELPM} instruction.
13295 @item __AVR_HAVE_ELPMX__
13296 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13297 R@var{n},Z+} instructions.
13299 @item __AVR_HAVE_MOVW__
13300 The device has the @code{MOVW} instruction to perform 16-bit
13301 register-register moves.
13303 @item __AVR_HAVE_LPMX__
13304 The device has the @code{LPM R@var{n},Z} and
13305 @code{LPM R@var{n},Z+} instructions.
13307 @item __AVR_HAVE_MUL__
13308 The device has a hardware multiplier. 
13310 @item __AVR_HAVE_JMP_CALL__
13311 The device has the @code{JMP} and @code{CALL} instructions.
13312 This is the case for devices with at least 16@tie{}KiB of program
13313 memory.
13315 @item __AVR_HAVE_EIJMP_EICALL__
13316 @itemx __AVR_3_BYTE_PC__
13317 The device has the @code{EIJMP} and @code{EICALL} instructions.
13318 This is the case for devices with more than 128@tie{}KiB of program memory.
13319 This also means that the program counter
13320 (PC) is 3@tie{}bytes wide.
13322 @item __AVR_2_BYTE_PC__
13323 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13324 with up to 128@tie{}KiB of program memory.
13326 @item __AVR_HAVE_8BIT_SP__
13327 @itemx __AVR_HAVE_16BIT_SP__
13328 The stack pointer (SP) register is treated as 8-bit respectively
13329 16-bit register by the compiler.
13330 The definition of these macros is affected by @code{-mtiny-stack}.
13332 @item __AVR_HAVE_SPH__
13333 @itemx __AVR_SP8__
13334 The device has the SPH (high part of stack pointer) special function
13335 register or has an 8-bit stack pointer, respectively.
13336 The definition of these macros is affected by @code{-mmcu=} and
13337 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13338 by @code{-msp8}.
13340 @item __AVR_HAVE_RAMPD__
13341 @itemx __AVR_HAVE_RAMPX__
13342 @itemx __AVR_HAVE_RAMPY__
13343 @itemx __AVR_HAVE_RAMPZ__
13344 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13345 @code{RAMPZ} special function register, respectively.
13347 @item __NO_INTERRUPTS__
13348 This macro reflects the @code{-mno-interrupts} command line option.
13350 @item __AVR_ERRATA_SKIP__
13351 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13352 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13353 instructions because of a hardware erratum.  Skip instructions are
13354 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13355 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13356 set.
13358 @item __AVR_ISA_RMW__
13359 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13361 @item __AVR_SFR_OFFSET__=@var{offset}
13362 Instructions that can address I/O special function registers directly
13363 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13364 address as if addressed by an instruction to access RAM like @code{LD}
13365 or @code{STS}. This offset depends on the device architecture and has
13366 to be subtracted from the RAM address in order to get the
13367 respective I/O@tie{}address.
13369 @item __WITH_AVRLIBC__
13370 The compiler is configured to be used together with AVR-Libc.
13371 See the @code{--with-avrlibc} configure option.
13373 @end table
13375 @node Blackfin Options
13376 @subsection Blackfin Options
13377 @cindex Blackfin Options
13379 @table @gcctabopt
13380 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13381 @opindex mcpu=
13382 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13383 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13384 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13385 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13386 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13387 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13388 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13389 @samp{bf561}, @samp{bf592}.
13391 The optional @var{sirevision} specifies the silicon revision of the target
13392 Blackfin processor.  Any workarounds available for the targeted silicon revision
13393 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13394 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13395 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13396 hexadecimal digits representing the major and minor numbers in the silicon
13397 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13398 is not defined.  If @var{sirevision} is @samp{any}, the
13399 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13400 If this optional @var{sirevision} is not used, GCC assumes the latest known
13401 silicon revision of the targeted Blackfin processor.
13403 GCC defines a preprocessor macro for the specified @var{cpu}.
13404 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13405 provided by libgloss to be linked in if @option{-msim} is not given.
13407 Without this option, @samp{bf532} is used as the processor by default.
13409 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13410 only the preprocessor macro is defined.
13412 @item -msim
13413 @opindex msim
13414 Specifies that the program will be run on the simulator.  This causes
13415 the simulator BSP provided by libgloss to be linked in.  This option
13416 has effect only for @samp{bfin-elf} toolchain.
13417 Certain other options, such as @option{-mid-shared-library} and
13418 @option{-mfdpic}, imply @option{-msim}.
13420 @item -momit-leaf-frame-pointer
13421 @opindex momit-leaf-frame-pointer
13422 Don't keep the frame pointer in a register for leaf functions.  This
13423 avoids the instructions to save, set up and restore frame pointers and
13424 makes an extra register available in leaf functions.  The option
13425 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13426 which might make debugging harder.
13428 @item -mspecld-anomaly
13429 @opindex mspecld-anomaly
13430 When enabled, the compiler ensures that the generated code does not
13431 contain speculative loads after jump instructions. If this option is used,
13432 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13434 @item -mno-specld-anomaly
13435 @opindex mno-specld-anomaly
13436 Don't generate extra code to prevent speculative loads from occurring.
13438 @item -mcsync-anomaly
13439 @opindex mcsync-anomaly
13440 When enabled, the compiler ensures that the generated code does not
13441 contain CSYNC or SSYNC instructions too soon after conditional branches.
13442 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13444 @item -mno-csync-anomaly
13445 @opindex mno-csync-anomaly
13446 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13447 occurring too soon after a conditional branch.
13449 @item -mlow-64k
13450 @opindex mlow-64k
13451 When enabled, the compiler is free to take advantage of the knowledge that
13452 the entire program fits into the low 64k of memory.
13454 @item -mno-low-64k
13455 @opindex mno-low-64k
13456 Assume that the program is arbitrarily large.  This is the default.
13458 @item -mstack-check-l1
13459 @opindex mstack-check-l1
13460 Do stack checking using information placed into L1 scratchpad memory by the
13461 uClinux kernel.
13463 @item -mid-shared-library
13464 @opindex mid-shared-library
13465 Generate code that supports shared libraries via the library ID method.
13466 This allows for execute in place and shared libraries in an environment
13467 without virtual memory management.  This option implies @option{-fPIC}.
13468 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13470 @item -mno-id-shared-library
13471 @opindex mno-id-shared-library
13472 Generate code that doesn't assume ID-based shared libraries are being used.
13473 This is the default.
13475 @item -mleaf-id-shared-library
13476 @opindex mleaf-id-shared-library
13477 Generate code that supports shared libraries via the library ID method,
13478 but assumes that this library or executable won't link against any other
13479 ID shared libraries.  That allows the compiler to use faster code for jumps
13480 and calls.
13482 @item -mno-leaf-id-shared-library
13483 @opindex mno-leaf-id-shared-library
13484 Do not assume that the code being compiled won't link against any ID shared
13485 libraries.  Slower code is generated for jump and call insns.
13487 @item -mshared-library-id=n
13488 @opindex mshared-library-id
13489 Specifies the identification number of the ID-based shared library being
13490 compiled.  Specifying a value of 0 generates more compact code; specifying
13491 other values forces the allocation of that number to the current
13492 library but is no more space- or time-efficient than omitting this option.
13494 @item -msep-data
13495 @opindex msep-data
13496 Generate code that allows the data segment to be located in a different
13497 area of memory from the text segment.  This allows for execute in place in
13498 an environment without virtual memory management by eliminating relocations
13499 against the text section.
13501 @item -mno-sep-data
13502 @opindex mno-sep-data
13503 Generate code that assumes that the data segment follows the text segment.
13504 This is the default.
13506 @item -mlong-calls
13507 @itemx -mno-long-calls
13508 @opindex mlong-calls
13509 @opindex mno-long-calls
13510 Tells the compiler to perform function calls by first loading the
13511 address of the function into a register and then performing a subroutine
13512 call on this register.  This switch is needed if the target function
13513 lies outside of the 24-bit addressing range of the offset-based
13514 version of subroutine call instruction.
13516 This feature is not enabled by default.  Specifying
13517 @option{-mno-long-calls} restores the default behavior.  Note these
13518 switches have no effect on how the compiler generates code to handle
13519 function calls via function pointers.
13521 @item -mfast-fp
13522 @opindex mfast-fp
13523 Link with the fast floating-point library. This library relaxes some of
13524 the IEEE floating-point standard's rules for checking inputs against
13525 Not-a-Number (NAN), in the interest of performance.
13527 @item -minline-plt
13528 @opindex minline-plt
13529 Enable inlining of PLT entries in function calls to functions that are
13530 not known to bind locally.  It has no effect without @option{-mfdpic}.
13532 @item -mmulticore
13533 @opindex mmulticore
13534 Build a standalone application for multicore Blackfin processors. 
13535 This option causes proper start files and link scripts supporting 
13536 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13537 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13539 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13540 selects the one-application-per-core programming model.  Without
13541 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13542 programming model is used. In this model, the main function of Core B
13543 should be named as @code{coreb_main}.
13545 If this option is not used, the single-core application programming
13546 model is used.
13548 @item -mcorea
13549 @opindex mcorea
13550 Build a standalone application for Core A of BF561 when using
13551 the one-application-per-core programming model. Proper start files
13552 and link scripts are used to support Core A, and the macro
13553 @code{__BFIN_COREA} is defined.
13554 This option can only be used in conjunction with @option{-mmulticore}.
13556 @item -mcoreb
13557 @opindex mcoreb
13558 Build a standalone application for Core B of BF561 when using
13559 the one-application-per-core programming model. Proper start files
13560 and link scripts are used to support Core B, and the macro
13561 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13562 should be used instead of @code{main}. 
13563 This option can only be used in conjunction with @option{-mmulticore}.
13565 @item -msdram
13566 @opindex msdram
13567 Build a standalone application for SDRAM. Proper start files and
13568 link scripts are used to put the application into SDRAM, and the macro
13569 @code{__BFIN_SDRAM} is defined.
13570 The loader should initialize SDRAM before loading the application.
13572 @item -micplb
13573 @opindex micplb
13574 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13575 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13576 are enabled; for standalone applications the default is off.
13577 @end table
13579 @node C6X Options
13580 @subsection C6X Options
13581 @cindex C6X Options
13583 @table @gcctabopt
13584 @item -march=@var{name}
13585 @opindex march
13586 This specifies the name of the target architecture.  GCC uses this
13587 name to determine what kind of instructions it can emit when generating
13588 assembly code.  Permissible names are: @samp{c62x},
13589 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13591 @item -mbig-endian
13592 @opindex mbig-endian
13593 Generate code for a big-endian target.
13595 @item -mlittle-endian
13596 @opindex mlittle-endian
13597 Generate code for a little-endian target.  This is the default.
13599 @item -msim
13600 @opindex msim
13601 Choose startup files and linker script suitable for the simulator.
13603 @item -msdata=default
13604 @opindex msdata=default
13605 Put small global and static data in the @samp{.neardata} section,
13606 which is pointed to by register @code{B14}.  Put small uninitialized
13607 global and static data in the @samp{.bss} section, which is adjacent
13608 to the @samp{.neardata} section.  Put small read-only data into the
13609 @samp{.rodata} section.  The corresponding sections used for large
13610 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13612 @item -msdata=all
13613 @opindex msdata=all
13614 Put all data, not just small objects, into the sections reserved for
13615 small data, and use addressing relative to the @code{B14} register to
13616 access them.
13618 @item -msdata=none
13619 @opindex msdata=none
13620 Make no use of the sections reserved for small data, and use absolute
13621 addresses to access all data.  Put all initialized global and static
13622 data in the @samp{.fardata} section, and all uninitialized data in the
13623 @samp{.far} section.  Put all constant data into the @samp{.const}
13624 section.
13625 @end table
13627 @node CRIS Options
13628 @subsection CRIS Options
13629 @cindex CRIS Options
13631 These options are defined specifically for the CRIS ports.
13633 @table @gcctabopt
13634 @item -march=@var{architecture-type}
13635 @itemx -mcpu=@var{architecture-type}
13636 @opindex march
13637 @opindex mcpu
13638 Generate code for the specified architecture.  The choices for
13639 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13640 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13641 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13642 @samp{v10}.
13644 @item -mtune=@var{architecture-type}
13645 @opindex mtune
13646 Tune to @var{architecture-type} everything applicable about the generated
13647 code, except for the ABI and the set of available instructions.  The
13648 choices for @var{architecture-type} are the same as for
13649 @option{-march=@var{architecture-type}}.
13651 @item -mmax-stack-frame=@var{n}
13652 @opindex mmax-stack-frame
13653 Warn when the stack frame of a function exceeds @var{n} bytes.
13655 @item -metrax4
13656 @itemx -metrax100
13657 @opindex metrax4
13658 @opindex metrax100
13659 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13660 @option{-march=v3} and @option{-march=v8} respectively.
13662 @item -mmul-bug-workaround
13663 @itemx -mno-mul-bug-workaround
13664 @opindex mmul-bug-workaround
13665 @opindex mno-mul-bug-workaround
13666 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13667 models where it applies.  This option is active by default.
13669 @item -mpdebug
13670 @opindex mpdebug
13671 Enable CRIS-specific verbose debug-related information in the assembly
13672 code.  This option also has the effect of turning off the @samp{#NO_APP}
13673 formatted-code indicator to the assembler at the beginning of the
13674 assembly file.
13676 @item -mcc-init
13677 @opindex mcc-init
13678 Do not use condition-code results from previous instruction; always emit
13679 compare and test instructions before use of condition codes.
13681 @item -mno-side-effects
13682 @opindex mno-side-effects
13683 Do not emit instructions with side effects in addressing modes other than
13684 post-increment.
13686 @item -mstack-align
13687 @itemx -mno-stack-align
13688 @itemx -mdata-align
13689 @itemx -mno-data-align
13690 @itemx -mconst-align
13691 @itemx -mno-const-align
13692 @opindex mstack-align
13693 @opindex mno-stack-align
13694 @opindex mdata-align
13695 @opindex mno-data-align
13696 @opindex mconst-align
13697 @opindex mno-const-align
13698 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13699 stack frame, individual data and constants to be aligned for the maximum
13700 single data access size for the chosen CPU model.  The default is to
13701 arrange for 32-bit alignment.  ABI details such as structure layout are
13702 not affected by these options.
13704 @item -m32-bit
13705 @itemx -m16-bit
13706 @itemx -m8-bit
13707 @opindex m32-bit
13708 @opindex m16-bit
13709 @opindex m8-bit
13710 Similar to the stack- data- and const-align options above, these options
13711 arrange for stack frame, writable data and constants to all be 32-bit,
13712 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13714 @item -mno-prologue-epilogue
13715 @itemx -mprologue-epilogue
13716 @opindex mno-prologue-epilogue
13717 @opindex mprologue-epilogue
13718 With @option{-mno-prologue-epilogue}, the normal function prologue and
13719 epilogue which set up the stack frame are omitted and no return
13720 instructions or return sequences are generated in the code.  Use this
13721 option only together with visual inspection of the compiled code: no
13722 warnings or errors are generated when call-saved registers must be saved,
13723 or storage for local variables needs to be allocated.
13725 @item -mno-gotplt
13726 @itemx -mgotplt
13727 @opindex mno-gotplt
13728 @opindex mgotplt
13729 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13730 instruction sequences that load addresses for functions from the PLT part
13731 of the GOT rather than (traditional on other architectures) calls to the
13732 PLT@.  The default is @option{-mgotplt}.
13734 @item -melf
13735 @opindex melf
13736 Legacy no-op option only recognized with the cris-axis-elf and
13737 cris-axis-linux-gnu targets.
13739 @item -mlinux
13740 @opindex mlinux
13741 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13743 @item -sim
13744 @opindex sim
13745 This option, recognized for the cris-axis-elf, arranges
13746 to link with input-output functions from a simulator library.  Code,
13747 initialized data and zero-initialized data are allocated consecutively.
13749 @item -sim2
13750 @opindex sim2
13751 Like @option{-sim}, but pass linker options to locate initialized data at
13752 0x40000000 and zero-initialized data at 0x80000000.
13753 @end table
13755 @node CR16 Options
13756 @subsection CR16 Options
13757 @cindex CR16 Options
13759 These options are defined specifically for the CR16 ports.
13761 @table @gcctabopt
13763 @item -mmac
13764 @opindex mmac
13765 Enable the use of multiply-accumulate instructions. Disabled by default.
13767 @item -mcr16cplus
13768 @itemx -mcr16c
13769 @opindex mcr16cplus
13770 @opindex mcr16c
13771 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13772 is default.
13774 @item -msim
13775 @opindex msim
13776 Links the library libsim.a which is in compatible with simulator. Applicable
13777 to ELF compiler only.
13779 @item -mint32
13780 @opindex mint32
13781 Choose integer type as 32-bit wide.
13783 @item -mbit-ops
13784 @opindex mbit-ops
13785 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13787 @item -mdata-model=@var{model}
13788 @opindex mdata-model
13789 Choose a data model. The choices for @var{model} are @samp{near},
13790 @samp{far} or @samp{medium}. @samp{medium} is default.
13791 However, @samp{far} is not valid with @option{-mcr16c}, as the
13792 CR16C architecture does not support the far data model.
13793 @end table
13795 @node Darwin Options
13796 @subsection Darwin Options
13797 @cindex Darwin options
13799 These options are defined for all architectures running the Darwin operating
13800 system.
13802 FSF GCC on Darwin does not create ``fat'' object files; it creates
13803 an object file for the single architecture that GCC was built to
13804 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13805 @option{-arch} options are used; it does so by running the compiler or
13806 linker multiple times and joining the results together with
13807 @file{lipo}.
13809 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13810 @samp{i686}) is determined by the flags that specify the ISA
13811 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13812 @option{-force_cpusubtype_ALL} option can be used to override this.
13814 The Darwin tools vary in their behavior when presented with an ISA
13815 mismatch.  The assembler, @file{as}, only permits instructions to
13816 be used that are valid for the subtype of the file it is generating,
13817 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
13818 The linker for shared libraries, @file{/usr/bin/libtool}, fails
13819 and prints an error if asked to create a shared library with a less
13820 restrictive subtype than its input files (for instance, trying to put
13821 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
13822 for executables, @command{ld}, quietly gives the executable the most
13823 restrictive subtype of any of its input files.
13825 @table @gcctabopt
13826 @item -F@var{dir}
13827 @opindex F
13828 Add the framework directory @var{dir} to the head of the list of
13829 directories to be searched for header files.  These directories are
13830 interleaved with those specified by @option{-I} options and are
13831 scanned in a left-to-right order.
13833 A framework directory is a directory with frameworks in it.  A
13834 framework is a directory with a @file{Headers} and/or
13835 @file{PrivateHeaders} directory contained directly in it that ends
13836 in @file{.framework}.  The name of a framework is the name of this
13837 directory excluding the @file{.framework}.  Headers associated with
13838 the framework are found in one of those two directories, with
13839 @file{Headers} being searched first.  A subframework is a framework
13840 directory that is in a framework's @file{Frameworks} directory.
13841 Includes of subframework headers can only appear in a header of a
13842 framework that contains the subframework, or in a sibling subframework
13843 header.  Two subframeworks are siblings if they occur in the same
13844 framework.  A subframework should not have the same name as a
13845 framework; a warning is issued if this is violated.  Currently a
13846 subframework cannot have subframeworks; in the future, the mechanism
13847 may be extended to support this.  The standard frameworks can be found
13848 in @file{/System/Library/Frameworks} and
13849 @file{/Library/Frameworks}.  An example include looks like
13850 @code{#include <Framework/header.h>}, where @file{Framework} denotes
13851 the name of the framework and @file{header.h} is found in the
13852 @file{PrivateHeaders} or @file{Headers} directory.
13854 @item -iframework@var{dir}
13855 @opindex iframework
13856 Like @option{-F} except the directory is a treated as a system
13857 directory.  The main difference between this @option{-iframework} and
13858 @option{-F} is that with @option{-iframework} the compiler does not
13859 warn about constructs contained within header files found via
13860 @var{dir}.  This option is valid only for the C family of languages.
13862 @item -gused
13863 @opindex gused
13864 Emit debugging information for symbols that are used.  For stabs
13865 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
13866 This is by default ON@.
13868 @item -gfull
13869 @opindex gfull
13870 Emit debugging information for all symbols and types.
13872 @item -mmacosx-version-min=@var{version}
13873 The earliest version of MacOS X that this executable will run on
13874 is @var{version}.  Typical values of @var{version} include @code{10.1},
13875 @code{10.2}, and @code{10.3.9}.
13877 If the compiler was built to use the system's headers by default,
13878 then the default for this option is the system version on which the
13879 compiler is running, otherwise the default is to make choices that
13880 are compatible with as many systems and code bases as possible.
13882 @item -mkernel
13883 @opindex mkernel
13884 Enable kernel development mode.  The @option{-mkernel} option sets
13885 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
13886 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
13887 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
13888 applicable.  This mode also sets @option{-mno-altivec},
13889 @option{-msoft-float}, @option{-fno-builtin} and
13890 @option{-mlong-branch} for PowerPC targets.
13892 @item -mone-byte-bool
13893 @opindex mone-byte-bool
13894 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
13895 By default @samp{sizeof(bool)} is @samp{4} when compiling for
13896 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
13897 option has no effect on x86.
13899 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
13900 to generate code that is not binary compatible with code generated
13901 without that switch.  Using this switch may require recompiling all
13902 other modules in a program, including system libraries.  Use this
13903 switch to conform to a non-default data model.
13905 @item -mfix-and-continue
13906 @itemx -ffix-and-continue
13907 @itemx -findirect-data
13908 @opindex mfix-and-continue
13909 @opindex ffix-and-continue
13910 @opindex findirect-data
13911 Generate code suitable for fast turnaround development, such as to
13912 allow GDB to dynamically load @code{.o} files into already-running
13913 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
13914 are provided for backwards compatibility.
13916 @item -all_load
13917 @opindex all_load
13918 Loads all members of static archive libraries.
13919 See man ld(1) for more information.
13921 @item -arch_errors_fatal
13922 @opindex arch_errors_fatal
13923 Cause the errors having to do with files that have the wrong architecture
13924 to be fatal.
13926 @item -bind_at_load
13927 @opindex bind_at_load
13928 Causes the output file to be marked such that the dynamic linker will
13929 bind all undefined references when the file is loaded or launched.
13931 @item -bundle
13932 @opindex bundle
13933 Produce a Mach-o bundle format file.
13934 See man ld(1) for more information.
13936 @item -bundle_loader @var{executable}
13937 @opindex bundle_loader
13938 This option specifies the @var{executable} that will load the build
13939 output file being linked.  See man ld(1) for more information.
13941 @item -dynamiclib
13942 @opindex dynamiclib
13943 When passed this option, GCC produces a dynamic library instead of
13944 an executable when linking, using the Darwin @file{libtool} command.
13946 @item -force_cpusubtype_ALL
13947 @opindex force_cpusubtype_ALL
13948 This causes GCC's output file to have the @var{ALL} subtype, instead of
13949 one controlled by the @option{-mcpu} or @option{-march} option.
13951 @item -allowable_client  @var{client_name}
13952 @itemx -client_name
13953 @itemx -compatibility_version
13954 @itemx -current_version
13955 @itemx -dead_strip
13956 @itemx -dependency-file
13957 @itemx -dylib_file
13958 @itemx -dylinker_install_name
13959 @itemx -dynamic
13960 @itemx -exported_symbols_list
13961 @itemx -filelist
13962 @need 800
13963 @itemx -flat_namespace
13964 @itemx -force_flat_namespace
13965 @itemx -headerpad_max_install_names
13966 @itemx -image_base
13967 @itemx -init
13968 @itemx -install_name
13969 @itemx -keep_private_externs
13970 @itemx -multi_module
13971 @itemx -multiply_defined
13972 @itemx -multiply_defined_unused
13973 @need 800
13974 @itemx -noall_load
13975 @itemx -no_dead_strip_inits_and_terms
13976 @itemx -nofixprebinding
13977 @itemx -nomultidefs
13978 @itemx -noprebind
13979 @itemx -noseglinkedit
13980 @itemx -pagezero_size
13981 @itemx -prebind
13982 @itemx -prebind_all_twolevel_modules
13983 @itemx -private_bundle
13984 @need 800
13985 @itemx -read_only_relocs
13986 @itemx -sectalign
13987 @itemx -sectobjectsymbols
13988 @itemx -whyload
13989 @itemx -seg1addr
13990 @itemx -sectcreate
13991 @itemx -sectobjectsymbols
13992 @itemx -sectorder
13993 @itemx -segaddr
13994 @itemx -segs_read_only_addr
13995 @need 800
13996 @itemx -segs_read_write_addr
13997 @itemx -seg_addr_table
13998 @itemx -seg_addr_table_filename
13999 @itemx -seglinkedit
14000 @itemx -segprot
14001 @itemx -segs_read_only_addr
14002 @itemx -segs_read_write_addr
14003 @itemx -single_module
14004 @itemx -static
14005 @itemx -sub_library
14006 @need 800
14007 @itemx -sub_umbrella
14008 @itemx -twolevel_namespace
14009 @itemx -umbrella
14010 @itemx -undefined
14011 @itemx -unexported_symbols_list
14012 @itemx -weak_reference_mismatches
14013 @itemx -whatsloaded
14014 @opindex allowable_client
14015 @opindex client_name
14016 @opindex compatibility_version
14017 @opindex current_version
14018 @opindex dead_strip
14019 @opindex dependency-file
14020 @opindex dylib_file
14021 @opindex dylinker_install_name
14022 @opindex dynamic
14023 @opindex exported_symbols_list
14024 @opindex filelist
14025 @opindex flat_namespace
14026 @opindex force_flat_namespace
14027 @opindex headerpad_max_install_names
14028 @opindex image_base
14029 @opindex init
14030 @opindex install_name
14031 @opindex keep_private_externs
14032 @opindex multi_module
14033 @opindex multiply_defined
14034 @opindex multiply_defined_unused
14035 @opindex noall_load
14036 @opindex no_dead_strip_inits_and_terms
14037 @opindex nofixprebinding
14038 @opindex nomultidefs
14039 @opindex noprebind
14040 @opindex noseglinkedit
14041 @opindex pagezero_size
14042 @opindex prebind
14043 @opindex prebind_all_twolevel_modules
14044 @opindex private_bundle
14045 @opindex read_only_relocs
14046 @opindex sectalign
14047 @opindex sectobjectsymbols
14048 @opindex whyload
14049 @opindex seg1addr
14050 @opindex sectcreate
14051 @opindex sectobjectsymbols
14052 @opindex sectorder
14053 @opindex segaddr
14054 @opindex segs_read_only_addr
14055 @opindex segs_read_write_addr
14056 @opindex seg_addr_table
14057 @opindex seg_addr_table_filename
14058 @opindex seglinkedit
14059 @opindex segprot
14060 @opindex segs_read_only_addr
14061 @opindex segs_read_write_addr
14062 @opindex single_module
14063 @opindex static
14064 @opindex sub_library
14065 @opindex sub_umbrella
14066 @opindex twolevel_namespace
14067 @opindex umbrella
14068 @opindex undefined
14069 @opindex unexported_symbols_list
14070 @opindex weak_reference_mismatches
14071 @opindex whatsloaded
14072 These options are passed to the Darwin linker.  The Darwin linker man page
14073 describes them in detail.
14074 @end table
14076 @node DEC Alpha Options
14077 @subsection DEC Alpha Options
14079 These @samp{-m} options are defined for the DEC Alpha implementations:
14081 @table @gcctabopt
14082 @item -mno-soft-float
14083 @itemx -msoft-float
14084 @opindex mno-soft-float
14085 @opindex msoft-float
14086 Use (do not use) the hardware floating-point instructions for
14087 floating-point operations.  When @option{-msoft-float} is specified,
14088 functions in @file{libgcc.a} are used to perform floating-point
14089 operations.  Unless they are replaced by routines that emulate the
14090 floating-point operations, or compiled in such a way as to call such
14091 emulations routines, these routines issue floating-point
14092 operations.   If you are compiling for an Alpha without floating-point
14093 operations, you must ensure that the library is built so as not to call
14094 them.
14096 Note that Alpha implementations without floating-point operations are
14097 required to have floating-point registers.
14099 @item -mfp-reg
14100 @itemx -mno-fp-regs
14101 @opindex mfp-reg
14102 @opindex mno-fp-regs
14103 Generate code that uses (does not use) the floating-point register set.
14104 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14105 register set is not used, floating-point operands are passed in integer
14106 registers as if they were integers and floating-point results are passed
14107 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14108 so any function with a floating-point argument or return value called by code
14109 compiled with @option{-mno-fp-regs} must also be compiled with that
14110 option.
14112 A typical use of this option is building a kernel that does not use,
14113 and hence need not save and restore, any floating-point registers.
14115 @item -mieee
14116 @opindex mieee
14117 The Alpha architecture implements floating-point hardware optimized for
14118 maximum performance.  It is mostly compliant with the IEEE floating-point
14119 standard.  However, for full compliance, software assistance is
14120 required.  This option generates code fully IEEE-compliant code
14121 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14122 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14123 defined during compilation.  The resulting code is less efficient but is
14124 able to correctly support denormalized numbers and exceptional IEEE
14125 values such as not-a-number and plus/minus infinity.  Other Alpha
14126 compilers call this option @option{-ieee_with_no_inexact}.
14128 @item -mieee-with-inexact
14129 @opindex mieee-with-inexact
14130 This is like @option{-mieee} except the generated code also maintains
14131 the IEEE @var{inexact-flag}.  Turning on this option causes the
14132 generated code to implement fully-compliant IEEE math.  In addition to
14133 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14134 macro.  On some Alpha implementations the resulting code may execute
14135 significantly slower than the code generated by default.  Since there is
14136 very little code that depends on the @var{inexact-flag}, you should
14137 normally not specify this option.  Other Alpha compilers call this
14138 option @option{-ieee_with_inexact}.
14140 @item -mfp-trap-mode=@var{trap-mode}
14141 @opindex mfp-trap-mode
14142 This option controls what floating-point related traps are enabled.
14143 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14144 The trap mode can be set to one of four values:
14146 @table @samp
14147 @item n
14148 This is the default (normal) setting.  The only traps that are enabled
14149 are the ones that cannot be disabled in software (e.g., division by zero
14150 trap).
14152 @item u
14153 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14154 as well.
14156 @item su
14157 Like @samp{u}, but the instructions are marked to be safe for software
14158 completion (see Alpha architecture manual for details).
14160 @item sui
14161 Like @samp{su}, but inexact traps are enabled as well.
14162 @end table
14164 @item -mfp-rounding-mode=@var{rounding-mode}
14165 @opindex mfp-rounding-mode
14166 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14167 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14170 @table @samp
14171 @item n
14172 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14173 the nearest machine number or towards the even machine number in case
14174 of a tie.
14176 @item m
14177 Round towards minus infinity.
14179 @item c
14180 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14182 @item d
14183 Dynamic rounding mode.  A field in the floating-point control register
14184 (@var{fpcr}, see Alpha architecture reference manual) controls the
14185 rounding mode in effect.  The C library initializes this register for
14186 rounding towards plus infinity.  Thus, unless your program modifies the
14187 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14188 @end table
14190 @item -mtrap-precision=@var{trap-precision}
14191 @opindex mtrap-precision
14192 In the Alpha architecture, floating-point traps are imprecise.  This
14193 means without software assistance it is impossible to recover from a
14194 floating trap and program execution normally needs to be terminated.
14195 GCC can generate code that can assist operating system trap handlers
14196 in determining the exact location that caused a floating-point trap.
14197 Depending on the requirements of an application, different levels of
14198 precisions can be selected:
14200 @table @samp
14201 @item p
14202 Program precision.  This option is the default and means a trap handler
14203 can only identify which program caused a floating-point exception.
14205 @item f
14206 Function precision.  The trap handler can determine the function that
14207 caused a floating-point exception.
14209 @item i
14210 Instruction precision.  The trap handler can determine the exact
14211 instruction that caused a floating-point exception.
14212 @end table
14214 Other Alpha compilers provide the equivalent options called
14215 @option{-scope_safe} and @option{-resumption_safe}.
14217 @item -mieee-conformant
14218 @opindex mieee-conformant
14219 This option marks the generated code as IEEE conformant.  You must not
14220 use this option unless you also specify @option{-mtrap-precision=i} and either
14221 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14222 is to emit the line @samp{.eflag 48} in the function prologue of the
14223 generated assembly file.
14225 @item -mbuild-constants
14226 @opindex mbuild-constants
14227 Normally GCC examines a 32- or 64-bit integer constant to
14228 see if it can construct it from smaller constants in two or three
14229 instructions.  If it cannot, it outputs the constant as a literal and
14230 generates code to load it from the data segment at run time.
14232 Use this option to require GCC to construct @emph{all} integer constants
14233 using code, even if it takes more instructions (the maximum is six).
14235 You typically use this option to build a shared library dynamic
14236 loader.  Itself a shared library, it must relocate itself in memory
14237 before it can find the variables and constants in its own data segment.
14239 @item -mbwx
14240 @itemx -mno-bwx
14241 @itemx -mcix
14242 @itemx -mno-cix
14243 @itemx -mfix
14244 @itemx -mno-fix
14245 @itemx -mmax
14246 @itemx -mno-max
14247 @opindex mbwx
14248 @opindex mno-bwx
14249 @opindex mcix
14250 @opindex mno-cix
14251 @opindex mfix
14252 @opindex mno-fix
14253 @opindex mmax
14254 @opindex mno-max
14255 Indicate whether GCC should generate code to use the optional BWX,
14256 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14257 sets supported by the CPU type specified via @option{-mcpu=} option or that
14258 of the CPU on which GCC was built if none is specified.
14260 @item -mfloat-vax
14261 @itemx -mfloat-ieee
14262 @opindex mfloat-vax
14263 @opindex mfloat-ieee
14264 Generate code that uses (does not use) VAX F and G floating-point
14265 arithmetic instead of IEEE single and double precision.
14267 @item -mexplicit-relocs
14268 @itemx -mno-explicit-relocs
14269 @opindex mexplicit-relocs
14270 @opindex mno-explicit-relocs
14271 Older Alpha assemblers provided no way to generate symbol relocations
14272 except via assembler macros.  Use of these macros does not allow
14273 optimal instruction scheduling.  GNU binutils as of version 2.12
14274 supports a new syntax that allows the compiler to explicitly mark
14275 which relocations should apply to which instructions.  This option
14276 is mostly useful for debugging, as GCC detects the capabilities of
14277 the assembler when it is built and sets the default accordingly.
14279 @item -msmall-data
14280 @itemx -mlarge-data
14281 @opindex msmall-data
14282 @opindex mlarge-data
14283 When @option{-mexplicit-relocs} is in effect, static data is
14284 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14285 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14286 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14287 16-bit relocations off of the @code{$gp} register.  This limits the
14288 size of the small data area to 64KB, but allows the variables to be
14289 directly accessed via a single instruction.
14291 The default is @option{-mlarge-data}.  With this option the data area
14292 is limited to just below 2GB@.  Programs that require more than 2GB of
14293 data must use @code{malloc} or @code{mmap} to allocate the data in the
14294 heap instead of in the program's data segment.
14296 When generating code for shared libraries, @option{-fpic} implies
14297 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14299 @item -msmall-text
14300 @itemx -mlarge-text
14301 @opindex msmall-text
14302 @opindex mlarge-text
14303 When @option{-msmall-text} is used, the compiler assumes that the
14304 code of the entire program (or shared library) fits in 4MB, and is
14305 thus reachable with a branch instruction.  When @option{-msmall-data}
14306 is used, the compiler can assume that all local symbols share the
14307 same @code{$gp} value, and thus reduce the number of instructions
14308 required for a function call from 4 to 1.
14310 The default is @option{-mlarge-text}.
14312 @item -mcpu=@var{cpu_type}
14313 @opindex mcpu
14314 Set the instruction set and instruction scheduling parameters for
14315 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14316 style name or the corresponding chip number.  GCC supports scheduling
14317 parameters for the EV4, EV5 and EV6 family of processors and
14318 chooses the default values for the instruction set from the processor
14319 you specify.  If you do not specify a processor type, GCC defaults
14320 to the processor on which the compiler was built.
14322 Supported values for @var{cpu_type} are
14324 @table @samp
14325 @item ev4
14326 @itemx ev45
14327 @itemx 21064
14328 Schedules as an EV4 and has no instruction set extensions.
14330 @item ev5
14331 @itemx 21164
14332 Schedules as an EV5 and has no instruction set extensions.
14334 @item ev56
14335 @itemx 21164a
14336 Schedules as an EV5 and supports the BWX extension.
14338 @item pca56
14339 @itemx 21164pc
14340 @itemx 21164PC
14341 Schedules as an EV5 and supports the BWX and MAX extensions.
14343 @item ev6
14344 @itemx 21264
14345 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14347 @item ev67
14348 @itemx 21264a
14349 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14350 @end table
14352 Native toolchains also support the value @samp{native},
14353 which selects the best architecture option for the host processor.
14354 @option{-mcpu=native} has no effect if GCC does not recognize
14355 the processor.
14357 @item -mtune=@var{cpu_type}
14358 @opindex mtune
14359 Set only the instruction scheduling parameters for machine type
14360 @var{cpu_type}.  The instruction set is not changed.
14362 Native toolchains also support the value @samp{native},
14363 which selects the best architecture option for the host processor.
14364 @option{-mtune=native} has no effect if GCC does not recognize
14365 the processor.
14367 @item -mmemory-latency=@var{time}
14368 @opindex mmemory-latency
14369 Sets the latency the scheduler should assume for typical memory
14370 references as seen by the application.  This number is highly
14371 dependent on the memory access patterns used by the application
14372 and the size of the external cache on the machine.
14374 Valid options for @var{time} are
14376 @table @samp
14377 @item @var{number}
14378 A decimal number representing clock cycles.
14380 @item L1
14381 @itemx L2
14382 @itemx L3
14383 @itemx main
14384 The compiler contains estimates of the number of clock cycles for
14385 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14386 (also called Dcache, Scache, and Bcache), as well as to main memory.
14387 Note that L3 is only valid for EV5.
14389 @end table
14390 @end table
14392 @node FR30 Options
14393 @subsection FR30 Options
14394 @cindex FR30 Options
14396 These options are defined specifically for the FR30 port.
14398 @table @gcctabopt
14400 @item -msmall-model
14401 @opindex msmall-model
14402 Use the small address space model.  This can produce smaller code, but
14403 it does assume that all symbolic values and addresses fit into a
14404 20-bit range.
14406 @item -mno-lsim
14407 @opindex mno-lsim
14408 Assume that runtime support has been provided and so there is no need
14409 to include the simulator library (@file{libsim.a}) on the linker
14410 command line.
14412 @end table
14414 @node FRV Options
14415 @subsection FRV Options
14416 @cindex FRV Options
14418 @table @gcctabopt
14419 @item -mgpr-32
14420 @opindex mgpr-32
14422 Only use the first 32 general-purpose registers.
14424 @item -mgpr-64
14425 @opindex mgpr-64
14427 Use all 64 general-purpose registers.
14429 @item -mfpr-32
14430 @opindex mfpr-32
14432 Use only the first 32 floating-point registers.
14434 @item -mfpr-64
14435 @opindex mfpr-64
14437 Use all 64 floating-point registers.
14439 @item -mhard-float
14440 @opindex mhard-float
14442 Use hardware instructions for floating-point operations.
14444 @item -msoft-float
14445 @opindex msoft-float
14447 Use library routines for floating-point operations.
14449 @item -malloc-cc
14450 @opindex malloc-cc
14452 Dynamically allocate condition code registers.
14454 @item -mfixed-cc
14455 @opindex mfixed-cc
14457 Do not try to dynamically allocate condition code registers, only
14458 use @code{icc0} and @code{fcc0}.
14460 @item -mdword
14461 @opindex mdword
14463 Change ABI to use double word insns.
14465 @item -mno-dword
14466 @opindex mno-dword
14468 Do not use double word instructions.
14470 @item -mdouble
14471 @opindex mdouble
14473 Use floating-point double instructions.
14475 @item -mno-double
14476 @opindex mno-double
14478 Do not use floating-point double instructions.
14480 @item -mmedia
14481 @opindex mmedia
14483 Use media instructions.
14485 @item -mno-media
14486 @opindex mno-media
14488 Do not use media instructions.
14490 @item -mmuladd
14491 @opindex mmuladd
14493 Use multiply and add/subtract instructions.
14495 @item -mno-muladd
14496 @opindex mno-muladd
14498 Do not use multiply and add/subtract instructions.
14500 @item -mfdpic
14501 @opindex mfdpic
14503 Select the FDPIC ABI, which uses function descriptors to represent
14504 pointers to functions.  Without any PIC/PIE-related options, it
14505 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14506 assumes GOT entries and small data are within a 12-bit range from the
14507 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14508 are computed with 32 bits.
14509 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14511 @item -minline-plt
14512 @opindex minline-plt
14514 Enable inlining of PLT entries in function calls to functions that are
14515 not known to bind locally.  It has no effect without @option{-mfdpic}.
14516 It's enabled by default if optimizing for speed and compiling for
14517 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14518 optimization option such as @option{-O3} or above is present in the
14519 command line.
14521 @item -mTLS
14522 @opindex mTLS
14524 Assume a large TLS segment when generating thread-local code.
14526 @item -mtls
14527 @opindex mtls
14529 Do not assume a large TLS segment when generating thread-local code.
14531 @item -mgprel-ro
14532 @opindex mgprel-ro
14534 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14535 that is known to be in read-only sections.  It's enabled by default,
14536 except for @option{-fpic} or @option{-fpie}: even though it may help
14537 make the global offset table smaller, it trades 1 instruction for 4.
14538 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14539 one of which may be shared by multiple symbols, and it avoids the need
14540 for a GOT entry for the referenced symbol, so it's more likely to be a
14541 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14543 @item -multilib-library-pic
14544 @opindex multilib-library-pic
14546 Link with the (library, not FD) pic libraries.  It's implied by
14547 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14548 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14549 it explicitly.
14551 @item -mlinked-fp
14552 @opindex mlinked-fp
14554 Follow the EABI requirement of always creating a frame pointer whenever
14555 a stack frame is allocated.  This option is enabled by default and can
14556 be disabled with @option{-mno-linked-fp}.
14558 @item -mlong-calls
14559 @opindex mlong-calls
14561 Use indirect addressing to call functions outside the current
14562 compilation unit.  This allows the functions to be placed anywhere
14563 within the 32-bit address space.
14565 @item -malign-labels
14566 @opindex malign-labels
14568 Try to align labels to an 8-byte boundary by inserting NOPs into the
14569 previous packet.  This option only has an effect when VLIW packing
14570 is enabled.  It doesn't create new packets; it merely adds NOPs to
14571 existing ones.
14573 @item -mlibrary-pic
14574 @opindex mlibrary-pic
14576 Generate position-independent EABI code.
14578 @item -macc-4
14579 @opindex macc-4
14581 Use only the first four media accumulator registers.
14583 @item -macc-8
14584 @opindex macc-8
14586 Use all eight media accumulator registers.
14588 @item -mpack
14589 @opindex mpack
14591 Pack VLIW instructions.
14593 @item -mno-pack
14594 @opindex mno-pack
14596 Do not pack VLIW instructions.
14598 @item -mno-eflags
14599 @opindex mno-eflags
14601 Do not mark ABI switches in e_flags.
14603 @item -mcond-move
14604 @opindex mcond-move
14606 Enable the use of conditional-move instructions (default).
14608 This switch is mainly for debugging the compiler and will likely be removed
14609 in a future version.
14611 @item -mno-cond-move
14612 @opindex mno-cond-move
14614 Disable the use of conditional-move instructions.
14616 This switch is mainly for debugging the compiler and will likely be removed
14617 in a future version.
14619 @item -mscc
14620 @opindex mscc
14622 Enable the use of conditional set instructions (default).
14624 This switch is mainly for debugging the compiler and will likely be removed
14625 in a future version.
14627 @item -mno-scc
14628 @opindex mno-scc
14630 Disable the use of conditional set instructions.
14632 This switch is mainly for debugging the compiler and will likely be removed
14633 in a future version.
14635 @item -mcond-exec
14636 @opindex mcond-exec
14638 Enable the use of conditional execution (default).
14640 This switch is mainly for debugging the compiler and will likely be removed
14641 in a future version.
14643 @item -mno-cond-exec
14644 @opindex mno-cond-exec
14646 Disable the use of conditional execution.
14648 This switch is mainly for debugging the compiler and will likely be removed
14649 in a future version.
14651 @item -mvliw-branch
14652 @opindex mvliw-branch
14654 Run a pass to pack branches into VLIW instructions (default).
14656 This switch is mainly for debugging the compiler and will likely be removed
14657 in a future version.
14659 @item -mno-vliw-branch
14660 @opindex mno-vliw-branch
14662 Do not run a pass to pack branches into VLIW instructions.
14664 This switch is mainly for debugging the compiler and will likely be removed
14665 in a future version.
14667 @item -mmulti-cond-exec
14668 @opindex mmulti-cond-exec
14670 Enable optimization of @code{&&} and @code{||} in conditional execution
14671 (default).
14673 This switch is mainly for debugging the compiler and will likely be removed
14674 in a future version.
14676 @item -mno-multi-cond-exec
14677 @opindex mno-multi-cond-exec
14679 Disable optimization of @code{&&} and @code{||} in conditional execution.
14681 This switch is mainly for debugging the compiler and will likely be removed
14682 in a future version.
14684 @item -mnested-cond-exec
14685 @opindex mnested-cond-exec
14687 Enable nested conditional execution optimizations (default).
14689 This switch is mainly for debugging the compiler and will likely be removed
14690 in a future version.
14692 @item -mno-nested-cond-exec
14693 @opindex mno-nested-cond-exec
14695 Disable nested conditional execution optimizations.
14697 This switch is mainly for debugging the compiler and will likely be removed
14698 in a future version.
14700 @item -moptimize-membar
14701 @opindex moptimize-membar
14703 This switch removes redundant @code{membar} instructions from the
14704 compiler-generated code.  It is enabled by default.
14706 @item -mno-optimize-membar
14707 @opindex mno-optimize-membar
14709 This switch disables the automatic removal of redundant @code{membar}
14710 instructions from the generated code.
14712 @item -mtomcat-stats
14713 @opindex mtomcat-stats
14715 Cause gas to print out tomcat statistics.
14717 @item -mcpu=@var{cpu}
14718 @opindex mcpu
14720 Select the processor type for which to generate code.  Possible values are
14721 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14722 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14724 @end table
14726 @node GNU/Linux Options
14727 @subsection GNU/Linux Options
14729 These @samp{-m} options are defined for GNU/Linux targets:
14731 @table @gcctabopt
14732 @item -mglibc
14733 @opindex mglibc
14734 Use the GNU C library.  This is the default except
14735 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14737 @item -muclibc
14738 @opindex muclibc
14739 Use uClibc C library.  This is the default on
14740 @samp{*-*-linux-*uclibc*} targets.
14742 @item -mbionic
14743 @opindex mbionic
14744 Use Bionic C library.  This is the default on
14745 @samp{*-*-linux-*android*} targets.
14747 @item -mandroid
14748 @opindex mandroid
14749 Compile code compatible with Android platform.  This is the default on
14750 @samp{*-*-linux-*android*} targets.
14752 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14753 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14754 this option makes the GCC driver pass Android-specific options to the linker.
14755 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14756 to be defined.
14758 @item -tno-android-cc
14759 @opindex tno-android-cc
14760 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14761 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14762 @option{-fno-rtti} by default.
14764 @item -tno-android-ld
14765 @opindex tno-android-ld
14766 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14767 linking options to the linker.
14769 @end table
14771 @node H8/300 Options
14772 @subsection H8/300 Options
14774 These @samp{-m} options are defined for the H8/300 implementations:
14776 @table @gcctabopt
14777 @item -mrelax
14778 @opindex mrelax
14779 Shorten some address references at link time, when possible; uses the
14780 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14781 ld, Using ld}, for a fuller description.
14783 @item -mh
14784 @opindex mh
14785 Generate code for the H8/300H@.
14787 @item -ms
14788 @opindex ms
14789 Generate code for the H8S@.
14791 @item -mn
14792 @opindex mn
14793 Generate code for the H8S and H8/300H in the normal mode.  This switch
14794 must be used either with @option{-mh} or @option{-ms}.
14796 @item -ms2600
14797 @opindex ms2600
14798 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14800 @item -mexr
14801 @opindex mexr
14802 Extended registers are stored on stack before execution of function
14803 with monitor attribute. Default option is @option{-mexr}.
14804 This option is valid only for H8S targets.
14806 @item -mno-exr
14807 @opindex mno-exr
14808 Extended registers are not stored on stack before execution of function 
14809 with monitor attribute. Default option is @option{-mno-exr}. 
14810 This option is valid only for H8S targets.
14812 @item -mint32
14813 @opindex mint32
14814 Make @code{int} data 32 bits by default.
14816 @item -malign-300
14817 @opindex malign-300
14818 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
14819 The default for the H8/300H and H8S is to align longs and floats on
14820 4-byte boundaries.
14821 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
14822 This option has no effect on the H8/300.
14823 @end table
14825 @node HPPA Options
14826 @subsection HPPA Options
14827 @cindex HPPA Options
14829 These @samp{-m} options are defined for the HPPA family of computers:
14831 @table @gcctabopt
14832 @item -march=@var{architecture-type}
14833 @opindex march
14834 Generate code for the specified architecture.  The choices for
14835 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
14836 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
14837 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
14838 architecture option for your machine.  Code compiled for lower numbered
14839 architectures runs on higher numbered architectures, but not the
14840 other way around.
14842 @item -mpa-risc-1-0
14843 @itemx -mpa-risc-1-1
14844 @itemx -mpa-risc-2-0
14845 @opindex mpa-risc-1-0
14846 @opindex mpa-risc-1-1
14847 @opindex mpa-risc-2-0
14848 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
14850 @item -mjump-in-delay
14851 @opindex mjump-in-delay
14852 Fill delay slots of function calls with unconditional jump instructions
14853 by modifying the return pointer for the function call to be the target
14854 of the conditional jump.
14856 @item -mdisable-fpregs
14857 @opindex mdisable-fpregs
14858 Prevent floating-point registers from being used in any manner.  This is
14859 necessary for compiling kernels that perform lazy context switching of
14860 floating-point registers.  If you use this option and attempt to perform
14861 floating-point operations, the compiler aborts.
14863 @item -mdisable-indexing
14864 @opindex mdisable-indexing
14865 Prevent the compiler from using indexing address modes.  This avoids some
14866 rather obscure problems when compiling MIG generated code under MACH@.
14868 @item -mno-space-regs
14869 @opindex mno-space-regs
14870 Generate code that assumes the target has no space registers.  This allows
14871 GCC to generate faster indirect calls and use unscaled index address modes.
14873 Such code is suitable for level 0 PA systems and kernels.
14875 @item -mfast-indirect-calls
14876 @opindex mfast-indirect-calls
14877 Generate code that assumes calls never cross space boundaries.  This
14878 allows GCC to emit code that performs faster indirect calls.
14880 This option does not work in the presence of shared libraries or nested
14881 functions.
14883 @item -mfixed-range=@var{register-range}
14884 @opindex mfixed-range
14885 Generate code treating the given register range as fixed registers.
14886 A fixed register is one that the register allocator cannot use.  This is
14887 useful when compiling kernel code.  A register range is specified as
14888 two registers separated by a dash.  Multiple register ranges can be
14889 specified separated by a comma.
14891 @item -mlong-load-store
14892 @opindex mlong-load-store
14893 Generate 3-instruction load and store sequences as sometimes required by
14894 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
14895 the HP compilers.
14897 @item -mportable-runtime
14898 @opindex mportable-runtime
14899 Use the portable calling conventions proposed by HP for ELF systems.
14901 @item -mgas
14902 @opindex mgas
14903 Enable the use of assembler directives only GAS understands.
14905 @item -mschedule=@var{cpu-type}
14906 @opindex mschedule
14907 Schedule code according to the constraints for the machine type
14908 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
14909 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
14910 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
14911 proper scheduling option for your machine.  The default scheduling is
14912 @samp{8000}.
14914 @item -mlinker-opt
14915 @opindex mlinker-opt
14916 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
14917 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
14918 linkers in which they give bogus error messages when linking some programs.
14920 @item -msoft-float
14921 @opindex msoft-float
14922 Generate output containing library calls for floating point.
14923 @strong{Warning:} the requisite libraries are not available for all HPPA
14924 targets.  Normally the facilities of the machine's usual C compiler are
14925 used, but this cannot be done directly in cross-compilation.  You must make
14926 your own arrangements to provide suitable library functions for
14927 cross-compilation.
14929 @option{-msoft-float} changes the calling convention in the output file;
14930 therefore, it is only useful if you compile @emph{all} of a program with
14931 this option.  In particular, you need to compile @file{libgcc.a}, the
14932 library that comes with GCC, with @option{-msoft-float} in order for
14933 this to work.
14935 @item -msio
14936 @opindex msio
14937 Generate the predefine, @code{_SIO}, for server IO@.  The default is
14938 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
14939 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
14940 options are available under HP-UX and HI-UX@.
14942 @item -mgnu-ld
14943 @opindex mgnu-ld
14944 Use options specific to GNU @command{ld}.
14945 This passes @option{-shared} to @command{ld} when
14946 building a shared library.  It is the default when GCC is configured,
14947 explicitly or implicitly, with the GNU linker.  This option does not
14948 affect which @command{ld} is called; it only changes what parameters
14949 are passed to that @command{ld}.
14950 The @command{ld} that is called is determined by the
14951 @option{--with-ld} configure option, GCC's program search path, and
14952 finally by the user's @env{PATH}.  The linker used by GCC can be printed
14953 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
14954 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14956 @item -mhp-ld
14957 @opindex mhp-ld
14958 Use options specific to HP @command{ld}.
14959 This passes @option{-b} to @command{ld} when building
14960 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
14961 links.  It is the default when GCC is configured, explicitly or
14962 implicitly, with the HP linker.  This option does not affect
14963 which @command{ld} is called; it only changes what parameters are passed to that
14964 @command{ld}.
14965 The @command{ld} that is called is determined by the @option{--with-ld}
14966 configure option, GCC's program search path, and finally by the user's
14967 @env{PATH}.  The linker used by GCC can be printed using @samp{which
14968 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
14969 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14971 @item -mlong-calls
14972 @opindex mno-long-calls
14973 Generate code that uses long call sequences.  This ensures that a call
14974 is always able to reach linker generated stubs.  The default is to generate
14975 long calls only when the distance from the call site to the beginning
14976 of the function or translation unit, as the case may be, exceeds a
14977 predefined limit set by the branch type being used.  The limits for
14978 normal calls are 7,600,000 and 240,000 bytes, respectively for the
14979 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
14980 240,000 bytes.
14982 Distances are measured from the beginning of functions when using the
14983 @option{-ffunction-sections} option, or when using the @option{-mgas}
14984 and @option{-mno-portable-runtime} options together under HP-UX with
14985 the SOM linker.
14987 It is normally not desirable to use this option as it degrades
14988 performance.  However, it may be useful in large applications,
14989 particularly when partial linking is used to build the application.
14991 The types of long calls used depends on the capabilities of the
14992 assembler and linker, and the type of code being generated.  The
14993 impact on systems that support long absolute calls, and long pic
14994 symbol-difference or pc-relative calls should be relatively small.
14995 However, an indirect call is used on 32-bit ELF systems in pic code
14996 and it is quite long.
14998 @item -munix=@var{unix-std}
14999 @opindex march
15000 Generate compiler predefines and select a startfile for the specified
15001 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15002 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15003 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15004 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15005 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15006 and later.
15008 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15009 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15010 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15011 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15012 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15013 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15015 It is @emph{important} to note that this option changes the interfaces
15016 for various library routines.  It also affects the operational behavior
15017 of the C library.  Thus, @emph{extreme} care is needed in using this
15018 option.
15020 Library code that is intended to operate with more than one UNIX
15021 standard must test, set and restore the variable @var{__xpg4_extended_mask}
15022 as appropriate.  Most GNU software doesn't provide this capability.
15024 @item -nolibdld
15025 @opindex nolibdld
15026 Suppress the generation of link options to search libdld.sl when the
15027 @option{-static} option is specified on HP-UX 10 and later.
15029 @item -static
15030 @opindex static
15031 The HP-UX implementation of setlocale in libc has a dependency on
15032 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15033 when the @option{-static} option is specified, special link options
15034 are needed to resolve this dependency.
15036 On HP-UX 10 and later, the GCC driver adds the necessary options to
15037 link with libdld.sl when the @option{-static} option is specified.
15038 This causes the resulting binary to be dynamic.  On the 64-bit port,
15039 the linkers generate dynamic binaries by default in any case.  The
15040 @option{-nolibdld} option can be used to prevent the GCC driver from
15041 adding these link options.
15043 @item -threads
15044 @opindex threads
15045 Add support for multithreading with the @dfn{dce thread} library
15046 under HP-UX@.  This option sets flags for both the preprocessor and
15047 linker.
15048 @end table
15050 @node i386 and x86-64 Options
15051 @subsection Intel 386 and AMD x86-64 Options
15052 @cindex i386 Options
15053 @cindex x86-64 Options
15054 @cindex Intel 386 Options
15055 @cindex AMD x86-64 Options
15057 These @samp{-m} options are defined for the i386 and x86-64 family of
15058 computers:
15060 @table @gcctabopt
15062 @item -march=@var{cpu-type}
15063 @opindex march
15064 Generate instructions for the machine type @var{cpu-type}.  In contrast to
15065 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
15066 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
15067 to generate code that may not run at all on processors other than the one
15068 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
15069 @option{-mtune=@var{cpu-type}}.
15071 The choices for @var{cpu-type} are:
15073 @table @samp
15074 @item native
15075 This selects the CPU to generate code for at compilation time by determining
15076 the processor type of the compiling machine.  Using @option{-march=native}
15077 enables all instruction subsets supported by the local machine (hence
15078 the result might not run on different machines).  Using @option{-mtune=native}
15079 produces code optimized for the local machine under the constraints
15080 of the selected instruction set.  
15082 @item i386
15083 Original Intel i386 CPU@.
15085 @item i486
15086 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
15088 @item i586
15089 @itemx pentium
15090 Intel Pentium CPU with no MMX support.
15092 @item pentium-mmx
15093 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
15095 @item pentiumpro
15096 Intel Pentium Pro CPU@.
15098 @item i686
15099 When used with @option{-march}, the Pentium Pro
15100 instruction set is used, so the code runs on all i686 family chips.
15101 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
15103 @item pentium2
15104 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
15105 support.
15107 @item pentium3
15108 @itemx pentium3m
15109 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
15110 set support.
15112 @item pentium-m
15113 Intel Pentium M; low-power version of Intel Pentium III CPU
15114 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
15116 @item pentium4
15117 @itemx pentium4m
15118 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
15120 @item prescott
15121 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
15122 set support.
15124 @item nocona
15125 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
15126 SSE2 and SSE3 instruction set support.
15128 @item core2
15129 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
15130 instruction set support.
15132 @item nehalem
15133 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15134 SSE4.1, SSE4.2 and POPCNT instruction set support.
15136 @item westmere
15137 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15138 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
15140 @item sandybridge
15141 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15142 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
15144 @item ivybridge
15145 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15146 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
15147 instruction set support.
15149 @item haswell
15150 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15151 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15152 BMI, BMI2 and F16C instruction set support.
15154 @item broadwell
15155 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15156 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15157 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
15159 @item bonnell
15160 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
15161 instruction set support.
15163 @item silvermont
15164 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15165 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
15167 @item k6
15168 AMD K6 CPU with MMX instruction set support.
15170 @item k6-2
15171 @itemx k6-3
15172 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
15174 @item athlon
15175 @itemx athlon-tbird
15176 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
15177 support.
15179 @item athlon-4
15180 @itemx athlon-xp
15181 @itemx athlon-mp
15182 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
15183 instruction set support.
15185 @item k8
15186 @itemx opteron
15187 @itemx athlon64
15188 @itemx athlon-fx
15189 Processors based on the AMD K8 core with x86-64 instruction set support,
15190 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
15191 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
15192 instruction set extensions.)
15194 @item k8-sse3
15195 @itemx opteron-sse3
15196 @itemx athlon64-sse3
15197 Improved versions of AMD K8 cores with SSE3 instruction set support.
15199 @item amdfam10
15200 @itemx barcelona
15201 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
15202 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
15203 instruction set extensions.)
15205 @item bdver1
15206 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
15207 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
15208 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
15209 @item bdver2
15210 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15211 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
15212 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
15213 extensions.)
15214 @item bdver3
15215 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15216 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
15217 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
15218 64-bit instruction set extensions.
15219 @item bdver4
15220 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15221 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
15222 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
15223 SSE4.2, ABM and 64-bit instruction set extensions.
15225 @item btver1
15226 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
15227 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
15228 instruction set extensions.)
15230 @item btver2
15231 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
15232 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
15233 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
15235 @item winchip-c6
15236 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15237 set support.
15239 @item winchip2
15240 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15241 instruction set support.
15243 @item c3
15244 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15245 implemented for this chip.)
15247 @item c3-2
15248 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15249 (No scheduling is
15250 implemented for this chip.)
15252 @item geode
15253 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15254 @end table
15256 @item -mtune=@var{cpu-type}
15257 @opindex mtune
15258 Tune to @var{cpu-type} everything applicable about the generated code, except
15259 for the ABI and the set of available instructions.  
15260 While picking a specific @var{cpu-type} schedules things appropriately
15261 for that particular chip, the compiler does not generate any code that
15262 cannot run on the default machine type unless you use a
15263 @option{-march=@var{cpu-type}} option.
15264 For example, if GCC is configured for i686-pc-linux-gnu
15265 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15266 but still runs on i686 machines.
15268 The choices for @var{cpu-type} are the same as for @option{-march}.
15269 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15271 @table @samp
15272 @item generic
15273 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15274 If you know the CPU on which your code will run, then you should use
15275 the corresponding @option{-mtune} or @option{-march} option instead of
15276 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15277 of your application will have, then you should use this option.
15279 As new processors are deployed in the marketplace, the behavior of this
15280 option will change.  Therefore, if you upgrade to a newer version of
15281 GCC, code generation controlled by this option will change to reflect
15282 the processors
15283 that are most common at the time that version of GCC is released.
15285 There is no @option{-march=generic} option because @option{-march}
15286 indicates the instruction set the compiler can use, and there is no
15287 generic instruction set applicable to all processors.  In contrast,
15288 @option{-mtune} indicates the processor (or, in this case, collection of
15289 processors) for which the code is optimized.
15291 @item intel
15292 Produce code optimized for the most current Intel processors, which are
15293 Haswell and Silvermont for this version of GCC.  If you know the CPU
15294 on which your code will run, then you should use the corresponding
15295 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15296 But, if you want your application performs better on both Haswell and
15297 Silvermont, then you should use this option.
15299 As new Intel processors are deployed in the marketplace, the behavior of
15300 this option will change.  Therefore, if you upgrade to a newer version of
15301 GCC, code generation controlled by this option will change to reflect
15302 the most current Intel processors at the time that version of GCC is
15303 released.
15305 There is no @option{-march=intel} option because @option{-march} indicates
15306 the instruction set the compiler can use, and there is no common
15307 instruction set applicable to all processors.  In contrast,
15308 @option{-mtune} indicates the processor (or, in this case, collection of
15309 processors) for which the code is optimized.
15310 @end table
15312 @item -mcpu=@var{cpu-type}
15313 @opindex mcpu
15314 A deprecated synonym for @option{-mtune}.
15316 @item -mfpmath=@var{unit}
15317 @opindex mfpmath
15318 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15319 for @var{unit} are:
15321 @table @samp
15322 @item 387
15323 Use the standard 387 floating-point coprocessor present on the majority of chips and
15324 emulated otherwise.  Code compiled with this option runs almost everywhere.
15325 The temporary results are computed in 80-bit precision instead of the precision
15326 specified by the type, resulting in slightly different results compared to most
15327 of other chips.  See @option{-ffloat-store} for more detailed description.
15329 This is the default choice for i386 compiler.
15331 @item sse
15332 Use scalar floating-point instructions present in the SSE instruction set.
15333 This instruction set is supported by Pentium III and newer chips,
15334 and in the AMD line
15335 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15336 instruction set supports only single-precision arithmetic, thus the double and
15337 extended-precision arithmetic are still done using 387.  A later version, present
15338 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15339 arithmetic too.
15341 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15342 or @option{-msse2} switches to enable SSE extensions and make this option
15343 effective.  For the x86-64 compiler, these extensions are enabled by default.
15345 The resulting code should be considerably faster in the majority of cases and avoid
15346 the numerical instability problems of 387 code, but may break some existing
15347 code that expects temporaries to be 80 bits.
15349 This is the default choice for the x86-64 compiler.
15351 @item sse,387
15352 @itemx sse+387
15353 @itemx both
15354 Attempt to utilize both instruction sets at once.  This effectively doubles the
15355 amount of available registers, and on chips with separate execution units for
15356 387 and SSE the execution resources too.  Use this option with care, as it is
15357 still experimental, because the GCC register allocator does not model separate
15358 functional units well, resulting in unstable performance.
15359 @end table
15361 @item -masm=@var{dialect}
15362 @opindex masm=@var{dialect}
15363 Output assembly instructions using selected @var{dialect}.  Supported
15364 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15365 not support @samp{intel}.
15367 @item -mieee-fp
15368 @itemx -mno-ieee-fp
15369 @opindex mieee-fp
15370 @opindex mno-ieee-fp
15371 Control whether or not the compiler uses IEEE floating-point
15372 comparisons.  These correctly handle the case where the result of a
15373 comparison is unordered.
15375 @item -msoft-float
15376 @opindex msoft-float
15377 Generate output containing library calls for floating point.
15379 @strong{Warning:} the requisite libraries are not part of GCC@.
15380 Normally the facilities of the machine's usual C compiler are used, but
15381 this can't be done directly in cross-compilation.  You must make your
15382 own arrangements to provide suitable library functions for
15383 cross-compilation.
15385 On machines where a function returns floating-point results in the 80387
15386 register stack, some floating-point opcodes may be emitted even if
15387 @option{-msoft-float} is used.
15389 @item -mno-fp-ret-in-387
15390 @opindex mno-fp-ret-in-387
15391 Do not use the FPU registers for return values of functions.
15393 The usual calling convention has functions return values of types
15394 @code{float} and @code{double} in an FPU register, even if there
15395 is no FPU@.  The idea is that the operating system should emulate
15396 an FPU@.
15398 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15399 in ordinary CPU registers instead.
15401 @item -mno-fancy-math-387
15402 @opindex mno-fancy-math-387
15403 Some 387 emulators do not support the @code{sin}, @code{cos} and
15404 @code{sqrt} instructions for the 387.  Specify this option to avoid
15405 generating those instructions.  This option is the default on FreeBSD,
15406 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15407 indicates that the target CPU always has an FPU and so the
15408 instruction does not need emulation.  These
15409 instructions are not generated unless you also use the
15410 @option{-funsafe-math-optimizations} switch.
15412 @item -malign-double
15413 @itemx -mno-align-double
15414 @opindex malign-double
15415 @opindex mno-align-double
15416 Control whether GCC aligns @code{double}, @code{long double}, and
15417 @code{long long} variables on a two-word boundary or a one-word
15418 boundary.  Aligning @code{double} variables on a two-word boundary
15419 produces code that runs somewhat faster on a Pentium at the
15420 expense of more memory.
15422 On x86-64, @option{-malign-double} is enabled by default.
15424 @strong{Warning:} if you use the @option{-malign-double} switch,
15425 structures containing the above types are aligned differently than
15426 the published application binary interface specifications for the 386
15427 and are not binary compatible with structures in code compiled
15428 without that switch.
15430 @item -m96bit-long-double
15431 @itemx -m128bit-long-double
15432 @opindex m96bit-long-double
15433 @opindex m128bit-long-double
15434 These switches control the size of @code{long double} type.  The i386
15435 application binary interface specifies the size to be 96 bits,
15436 so @option{-m96bit-long-double} is the default in 32-bit mode.
15438 Modern architectures (Pentium and newer) prefer @code{long double}
15439 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15440 conforming to the ABI, this is not possible.  So specifying
15441 @option{-m128bit-long-double} aligns @code{long double}
15442 to a 16-byte boundary by padding the @code{long double} with an additional
15443 32-bit zero.
15445 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15446 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15448 Notice that neither of these options enable any extra precision over the x87
15449 standard of 80 bits for a @code{long double}.
15451 @strong{Warning:} if you override the default value for your target ABI, this
15452 changes the size of 
15453 structures and arrays containing @code{long double} variables,
15454 as well as modifying the function calling convention for functions taking
15455 @code{long double}.  Hence they are not binary-compatible
15456 with code compiled without that switch.
15458 @item -mlong-double-64
15459 @itemx -mlong-double-80
15460 @itemx -mlong-double-128
15461 @opindex mlong-double-64
15462 @opindex mlong-double-80
15463 @opindex mlong-double-128
15464 These switches control the size of @code{long double} type. A size
15465 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15466 type. This is the default for 32-bit Bionic C library.  A size
15467 of 128 bits makes the @code{long double} type equivalent to the
15468 @code{__float128} type. This is the default for 64-bit Bionic C library.
15470 @strong{Warning:} if you override the default value for your target ABI, this
15471 changes the size of
15472 structures and arrays containing @code{long double} variables,
15473 as well as modifying the function calling convention for functions taking
15474 @code{long double}.  Hence they are not binary-compatible
15475 with code compiled without that switch.
15477 @item -mlarge-data-threshold=@var{threshold}
15478 @opindex mlarge-data-threshold
15479 When @option{-mcmodel=medium} is specified, data objects larger than
15480 @var{threshold} are placed in the large data section.  This value must be the
15481 same across all objects linked into the binary, and defaults to 65535.
15483 @item -mrtd
15484 @opindex mrtd
15485 Use a different function-calling convention, in which functions that
15486 take a fixed number of arguments return with the @code{ret @var{num}}
15487 instruction, which pops their arguments while returning.  This saves one
15488 instruction in the caller since there is no need to pop the arguments
15489 there.
15491 You can specify that an individual function is called with this calling
15492 sequence with the function attribute @samp{stdcall}.  You can also
15493 override the @option{-mrtd} option by using the function attribute
15494 @samp{cdecl}.  @xref{Function Attributes}.
15496 @strong{Warning:} this calling convention is incompatible with the one
15497 normally used on Unix, so you cannot use it if you need to call
15498 libraries compiled with the Unix compiler.
15500 Also, you must provide function prototypes for all functions that
15501 take variable numbers of arguments (including @code{printf});
15502 otherwise incorrect code is generated for calls to those
15503 functions.
15505 In addition, seriously incorrect code results if you call a
15506 function with too many arguments.  (Normally, extra arguments are
15507 harmlessly ignored.)
15509 @item -mregparm=@var{num}
15510 @opindex mregparm
15511 Control how many registers are used to pass integer arguments.  By
15512 default, no registers are used to pass arguments, and at most 3
15513 registers can be used.  You can control this behavior for a specific
15514 function by using the function attribute @samp{regparm}.
15515 @xref{Function Attributes}.
15517 @strong{Warning:} if you use this switch, and
15518 @var{num} is nonzero, then you must build all modules with the same
15519 value, including any libraries.  This includes the system libraries and
15520 startup modules.
15522 @item -msseregparm
15523 @opindex msseregparm
15524 Use SSE register passing conventions for float and double arguments
15525 and return values.  You can control this behavior for a specific
15526 function by using the function attribute @samp{sseregparm}.
15527 @xref{Function Attributes}.
15529 @strong{Warning:} if you use this switch then you must build all
15530 modules with the same value, including any libraries.  This includes
15531 the system libraries and startup modules.
15533 @item -mvect8-ret-in-mem
15534 @opindex mvect8-ret-in-mem
15535 Return 8-byte vectors in memory instead of MMX registers.  This is the
15536 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15537 Studio compilers until version 12.  Later compiler versions (starting
15538 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15539 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15540 you need to remain compatible with existing code produced by those
15541 previous compiler versions or older versions of GCC@.
15543 @item -mpc32
15544 @itemx -mpc64
15545 @itemx -mpc80
15546 @opindex mpc32
15547 @opindex mpc64
15548 @opindex mpc80
15550 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15551 is specified, the significands of results of floating-point operations are
15552 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15553 significands of results of floating-point operations to 53 bits (double
15554 precision) and @option{-mpc80} rounds the significands of results of
15555 floating-point operations to 64 bits (extended double precision), which is
15556 the default.  When this option is used, floating-point operations in higher
15557 precisions are not available to the programmer without setting the FPU
15558 control word explicitly.
15560 Setting the rounding of floating-point operations to less than the default
15561 80 bits can speed some programs by 2% or more.  Note that some mathematical
15562 libraries assume that extended-precision (80-bit) floating-point operations
15563 are enabled by default; routines in such libraries could suffer significant
15564 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15565 when this option is used to set the precision to less than extended precision.
15567 @item -mstackrealign
15568 @opindex mstackrealign
15569 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15570 option generates an alternate prologue and epilogue that realigns the
15571 run-time stack if necessary.  This supports mixing legacy codes that keep
15572 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15573 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15574 applicable to individual functions.
15576 @item -mpreferred-stack-boundary=@var{num}
15577 @opindex mpreferred-stack-boundary
15578 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15579 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15580 the default is 4 (16 bytes or 128 bits).
15582 @strong{Warning:} When generating code for the x86-64 architecture with
15583 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15584 used to keep the stack boundary aligned to 8 byte boundary.  Since
15585 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15586 intended to be used in controlled environment where stack space is
15587 important limitation.  This option will lead to wrong code when functions
15588 compiled with 16 byte stack alignment (such as functions from a standard
15589 library) are called with misaligned stack.  In this case, SSE
15590 instructions may lead to misaligned memory access traps.  In addition,
15591 variable arguments will be handled incorrectly for 16 byte aligned
15592 objects (including x87 long double and __int128), leading to wrong
15593 results.  You must build all modules with
15594 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15595 includes the system libraries and startup modules.
15597 @item -mincoming-stack-boundary=@var{num}
15598 @opindex mincoming-stack-boundary
15599 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15600 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15601 the one specified by @option{-mpreferred-stack-boundary} is used.
15603 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15604 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15605 suffer significant run time performance penalties.  On Pentium III, the
15606 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15607 properly if it is not 16-byte aligned.
15609 To ensure proper alignment of this values on the stack, the stack boundary
15610 must be as aligned as that required by any value stored on the stack.
15611 Further, every function must be generated such that it keeps the stack
15612 aligned.  Thus calling a function compiled with a higher preferred
15613 stack boundary from a function compiled with a lower preferred stack
15614 boundary most likely misaligns the stack.  It is recommended that
15615 libraries that use callbacks always use the default setting.
15617 This extra alignment does consume extra stack space, and generally
15618 increases code size.  Code that is sensitive to stack space usage, such
15619 as embedded systems and operating system kernels, may want to reduce the
15620 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15622 @item -mmmx
15623 @itemx -mno-mmx
15624 @itemx -msse
15625 @itemx -mno-sse
15626 @itemx -msse2
15627 @itemx -mno-sse2
15628 @itemx -msse3
15629 @itemx -mno-sse3
15630 @itemx -mssse3
15631 @itemx -mno-ssse3
15632 @itemx -msse4.1
15633 @need 800
15634 @itemx -mno-sse4.1
15635 @itemx -msse4.2
15636 @itemx -mno-sse4.2
15637 @itemx -msse4
15638 @itemx -mno-sse4
15639 @itemx -mavx
15640 @itemx -mno-avx
15641 @itemx -mavx2
15642 @itemx -mno-avx2
15643 @itemx -mavx512f
15644 @itemx -mno-avx512f
15645 @need 800
15646 @itemx -mavx512pf
15647 @itemx -mno-avx512pf
15648 @itemx -mavx512er
15649 @itemx -mno-avx512er
15650 @itemx -mavx512cd
15651 @itemx -mno-avx512cd
15652 @itemx -msha
15653 @itemx -mno-sha
15654 @itemx -maes
15655 @itemx -mno-aes
15656 @itemx -mpclmul
15657 @itemx -mno-pclmul
15658 @itemx -mclfushopt
15659 @itemx -mno-clflsuhopt
15660 @need 800
15661 @itemx -mfsgsbase
15662 @itemx -mno-fsgsbase
15663 @itemx -mrdrnd
15664 @itemx -mno-rdrnd
15665 @itemx -mf16c
15666 @itemx -mno-f16c
15667 @itemx -mfma
15668 @itemx -mno-fma
15669 @itemx -mprefetchwt1
15670 @itemx -mno-prefetchwt1
15671 @itemx -msse4a
15672 @itemx -mno-sse4a
15673 @itemx -mfma4
15674 @itemx -mno-fma4
15675 @need 800
15676 @itemx -mxop
15677 @itemx -mno-xop
15678 @itemx -mlwp
15679 @itemx -mno-lwp
15680 @itemx -m3dnow
15681 @itemx -mno-3dnow
15682 @itemx -mpopcnt
15683 @itemx -mno-popcnt
15684 @itemx -mabm
15685 @itemx -mno-abm
15686 @itemx -mbmi
15687 @itemx -mbmi2
15688 @itemx -mno-bmi
15689 @itemx -mno-bmi2
15690 @itemx -mlzcnt
15691 @itemx -mno-lzcnt
15692 @itemx -mfxsr
15693 @itemx -mxsave
15694 @itemx -mxsaveopt
15695 @itemx -mrtm
15696 @itemx -mtbm
15697 @itemx -mno-tbm
15698 @itemx -mxsavec
15699 @itemx -mno-xsavec
15700 @itemx -mxsaves
15701 @itemx -mno-xsaves
15702 @opindex mmmx
15703 @opindex mno-mmx
15704 @opindex msse
15705 @opindex mno-sse
15706 @opindex m3dnow
15707 @opindex mno-3dnow
15708 These switches enable or disable the use of instructions in the MMX, SSE,
15709 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15710 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15711 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, or 3DNow!@:
15712 extended instruction sets.
15713 These extensions are also available as built-in functions: see
15714 @ref{X86 Built-in Functions}, for details of the functions enabled and
15715 disabled by these switches.
15717 To generate SSE/SSE2 instructions automatically from floating-point
15718 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15720 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15721 generates new AVX instructions or AVX equivalence for all SSEx instructions
15722 when needed.
15724 These options enable GCC to use these extended instructions in
15725 generated code, even without @option{-mfpmath=sse}.  Applications that
15726 perform run-time CPU detection must compile separate files for each
15727 supported architecture, using the appropriate flags.  In particular,
15728 the file containing the CPU detection code should be compiled without
15729 these options.
15731 @item -mdump-tune-features
15732 @opindex mdump-tune-features
15733 This option instructs GCC to dump the names of the x86 performance 
15734 tuning features and default settings. The names can be used in 
15735 @option{-mtune-ctrl=@var{feature-list}}.
15737 @item -mtune-ctrl=@var{feature-list}
15738 @opindex mtune-ctrl=@var{feature-list}
15739 This option is used to do fine grain control of x86 code generation features.
15740 @var{feature-list} is a comma separated list of @var{feature} names. See also
15741 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15742 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15743 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15744 developers. Using it may lead to code paths not covered by testing and can
15745 potentially result in compiler ICEs or runtime errors.
15747 @item -mno-default
15748 @opindex mno-default
15749 This option instructs GCC to turn off all tunable features. See also 
15750 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15752 @item -mcld
15753 @opindex mcld
15754 This option instructs GCC to emit a @code{cld} instruction in the prologue
15755 of functions that use string instructions.  String instructions depend on
15756 the DF flag to select between autoincrement or autodecrement mode.  While the
15757 ABI specifies the DF flag to be cleared on function entry, some operating
15758 systems violate this specification by not clearing the DF flag in their
15759 exception dispatchers.  The exception handler can be invoked with the DF flag
15760 set, which leads to wrong direction mode when string instructions are used.
15761 This option can be enabled by default on 32-bit x86 targets by configuring
15762 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15763 instructions can be suppressed with the @option{-mno-cld} compiler option
15764 in this case.
15766 @item -mvzeroupper
15767 @opindex mvzeroupper
15768 This option instructs GCC to emit a @code{vzeroupper} instruction
15769 before a transfer of control flow out of the function to minimize
15770 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15771 intrinsics.
15773 @item -mprefer-avx128
15774 @opindex mprefer-avx128
15775 This option instructs GCC to use 128-bit AVX instructions instead of
15776 256-bit AVX instructions in the auto-vectorizer.
15778 @item -mcx16
15779 @opindex mcx16
15780 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15781 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15782 (or oword) data types.  
15783 This is useful for high-resolution counters that can be updated
15784 by multiple processors (or cores).  This instruction is generated as part of
15785 atomic built-in functions: see @ref{__sync Builtins} or
15786 @ref{__atomic Builtins} for details.
15788 @item -msahf
15789 @opindex msahf
15790 This option enables generation of @code{SAHF} instructions in 64-bit code.
15791 Early Intel Pentium 4 CPUs with Intel 64 support,
15792 prior to the introduction of Pentium 4 G1 step in December 2005,
15793 lacked the @code{LAHF} and @code{SAHF} instructions
15794 which were supported by AMD64.
15795 These are load and store instructions, respectively, for certain status flags.
15796 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15797 @code{drem}, and @code{remainder} built-in functions;
15798 see @ref{Other Builtins} for details.
15800 @item -mmovbe
15801 @opindex mmovbe
15802 This option enables use of the @code{movbe} instruction to implement
15803 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15805 @item -mcrc32
15806 @opindex mcrc32
15807 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15808 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15809 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15811 @item -mrecip
15812 @opindex mrecip
15813 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
15814 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
15815 with an additional Newton-Raphson step
15816 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
15817 (and their vectorized
15818 variants) for single-precision floating-point arguments.  These instructions
15819 are generated only when @option{-funsafe-math-optimizations} is enabled
15820 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
15821 Note that while the throughput of the sequence is higher than the throughput
15822 of the non-reciprocal instruction, the precision of the sequence can be
15823 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
15825 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
15826 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
15827 combination), and doesn't need @option{-mrecip}.
15829 Also note that GCC emits the above sequence with additional Newton-Raphson step
15830 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
15831 already with @option{-ffast-math} (or the above option combination), and
15832 doesn't need @option{-mrecip}.
15834 @item -mrecip=@var{opt}
15835 @opindex mrecip=opt
15836 This option controls which reciprocal estimate instructions
15837 may be used.  @var{opt} is a comma-separated list of options, which may
15838 be preceded by a @samp{!} to invert the option:
15840 @table @samp
15841 @item all
15842 Enable all estimate instructions.
15844 @item default
15845 Enable the default instructions, equivalent to @option{-mrecip}.
15847 @item none
15848 Disable all estimate instructions, equivalent to @option{-mno-recip}.
15850 @item div
15851 Enable the approximation for scalar division.
15853 @item vec-div
15854 Enable the approximation for vectorized division.
15856 @item sqrt
15857 Enable the approximation for scalar square root.
15859 @item vec-sqrt
15860 Enable the approximation for vectorized square root.
15861 @end table
15863 So, for example, @option{-mrecip=all,!sqrt} enables
15864 all of the reciprocal approximations, except for square root.
15866 @item -mveclibabi=@var{type}
15867 @opindex mveclibabi
15868 Specifies the ABI type to use for vectorizing intrinsics using an
15869 external library.  Supported values for @var{type} are @samp{svml} 
15870 for the Intel short
15871 vector math library and @samp{acml} for the AMD math core library.
15872 To use this option, both @option{-ftree-vectorize} and
15873 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
15874 ABI-compatible library must be specified at link time.
15876 GCC currently emits calls to @code{vmldExp2},
15877 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
15878 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
15879 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
15880 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
15881 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
15882 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
15883 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
15884 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
15885 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
15886 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
15887 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
15888 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
15889 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
15890 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
15891 when @option{-mveclibabi=acml} is used.  
15893 @item -mabi=@var{name}
15894 @opindex mabi
15895 Generate code for the specified calling convention.  Permissible values
15896 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
15897 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
15898 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
15899 You can control this behavior for a specific function by
15900 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
15901 @xref{Function Attributes}.
15903 @item -mtls-dialect=@var{type}
15904 @opindex mtls-dialect
15905 Generate code to access thread-local storage using the @samp{gnu} or
15906 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
15907 @samp{gnu2} is more efficient, but it may add compile- and run-time
15908 requirements that cannot be satisfied on all systems.
15910 @item -mpush-args
15911 @itemx -mno-push-args
15912 @opindex mpush-args
15913 @opindex mno-push-args
15914 Use PUSH operations to store outgoing parameters.  This method is shorter
15915 and usually equally fast as method using SUB/MOV operations and is enabled
15916 by default.  In some cases disabling it may improve performance because of
15917 improved scheduling and reduced dependencies.
15919 @item -maccumulate-outgoing-args
15920 @opindex maccumulate-outgoing-args
15921 If enabled, the maximum amount of space required for outgoing arguments is
15922 computed in the function prologue.  This is faster on most modern CPUs
15923 because of reduced dependencies, improved scheduling and reduced stack usage
15924 when the preferred stack boundary is not equal to 2.  The drawback is a notable
15925 increase in code size.  This switch implies @option{-mno-push-args}.
15927 @item -mthreads
15928 @opindex mthreads
15929 Support thread-safe exception handling on MinGW.  Programs that rely
15930 on thread-safe exception handling must compile and link all code with the
15931 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
15932 @code{-D_MT}; when linking, it links in a special thread helper library
15933 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
15935 @item -mno-align-stringops
15936 @opindex mno-align-stringops
15937 Do not align the destination of inlined string operations.  This switch reduces
15938 code size and improves performance in case the destination is already aligned,
15939 but GCC doesn't know about it.
15941 @item -minline-all-stringops
15942 @opindex minline-all-stringops
15943 By default GCC inlines string operations only when the destination is 
15944 known to be aligned to least a 4-byte boundary.  
15945 This enables more inlining and increases code
15946 size, but may improve performance of code that depends on fast
15947 @code{memcpy}, @code{strlen},
15948 and @code{memset} for short lengths.
15950 @item -minline-stringops-dynamically
15951 @opindex minline-stringops-dynamically
15952 For string operations of unknown size, use run-time checks with
15953 inline code for small blocks and a library call for large blocks.
15955 @item -mstringop-strategy=@var{alg}
15956 @opindex mstringop-strategy=@var{alg}
15957 Override the internal decision heuristic for the particular algorithm to use
15958 for inlining string operations.  The allowed values for @var{alg} are:
15960 @table @samp
15961 @item rep_byte
15962 @itemx rep_4byte
15963 @itemx rep_8byte
15964 Expand using i386 @code{rep} prefix of the specified size.
15966 @item byte_loop
15967 @itemx loop
15968 @itemx unrolled_loop
15969 Expand into an inline loop.
15971 @item libcall
15972 Always use a library call.
15973 @end table
15975 @item -mmemcpy-strategy=@var{strategy}
15976 @opindex mmemcpy-strategy=@var{strategy}
15977 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
15978 should be inlined and what inline algorithm to use when the expected size
15979 of the copy operation is known. @var{strategy} 
15980 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
15981 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
15982 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
15983 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
15984 in the list must be specified in increasing order.  The minimal byte size for 
15985 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
15986 preceding range.
15988 @item -mmemset-strategy=@var{strategy}
15989 @opindex mmemset-strategy=@var{strategy}
15990 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
15991 @code{__builtin_memset} expansion.
15993 @item -momit-leaf-frame-pointer
15994 @opindex momit-leaf-frame-pointer
15995 Don't keep the frame pointer in a register for leaf functions.  This
15996 avoids the instructions to save, set up, and restore frame pointers and
15997 makes an extra register available in leaf functions.  The option
15998 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
15999 which might make debugging harder.
16001 @item -mtls-direct-seg-refs
16002 @itemx -mno-tls-direct-seg-refs
16003 @opindex mtls-direct-seg-refs
16004 Controls whether TLS variables may be accessed with offsets from the
16005 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
16006 or whether the thread base pointer must be added.  Whether or not this
16007 is valid depends on the operating system, and whether it maps the
16008 segment to cover the entire TLS area.
16010 For systems that use the GNU C Library, the default is on.
16012 @item -msse2avx
16013 @itemx -mno-sse2avx
16014 @opindex msse2avx
16015 Specify that the assembler should encode SSE instructions with VEX
16016 prefix.  The option @option{-mavx} turns this on by default.
16018 @item -mfentry
16019 @itemx -mno-fentry
16020 @opindex mfentry
16021 If profiling is active (@option{-pg}), put the profiling
16022 counter call before the prologue.
16023 Note: On x86 architectures the attribute @code{ms_hook_prologue}
16024 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
16026 @item -mrecord-mcount
16027 @itemx -mno-record-mcount
16028 @opindex mrecord-mcount
16029 If profiling is active (@option{-pg}), generate a __mcount_loc section
16030 that contains pointers to each profiling call. This is useful for
16031 automatically patching and out calls.
16033 @item -mnop-mcount
16034 @itemx -mno-nop-mcount
16035 @opindex mnop-mcount
16036 If profiling is active (@option{-pg}), generate the calls to
16037 the profiling functions as nops. This is useful when they
16038 should be patched in later dynamically. This is likely only
16039 useful together with @option{-mrecord-mcount}.
16041 @item -m8bit-idiv
16042 @itemx -mno-8bit-idiv
16043 @opindex 8bit-idiv
16044 On some processors, like Intel Atom, 8-bit unsigned integer divide is
16045 much faster than 32-bit/64-bit integer divide.  This option generates a
16046 run-time check.  If both dividend and divisor are within range of 0
16047 to 255, 8-bit unsigned integer divide is used instead of
16048 32-bit/64-bit integer divide.
16050 @item -mavx256-split-unaligned-load
16051 @itemx -mavx256-split-unaligned-store
16052 @opindex avx256-split-unaligned-load
16053 @opindex avx256-split-unaligned-store
16054 Split 32-byte AVX unaligned load and store.
16056 @item -mstack-protector-guard=@var{guard}
16057 @opindex mstack-protector-guard=@var{guard}
16058 Generate stack protection code using canary at @var{guard}.  Supported
16059 locations are @samp{global} for global canary or @samp{tls} for per-thread
16060 canary in the TLS block (the default).  This option has effect only when
16061 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
16063 @end table
16065 These @samp{-m} switches are supported in addition to the above
16066 on x86-64 processors in 64-bit environments.
16068 @table @gcctabopt
16069 @item -m32
16070 @itemx -m64
16071 @itemx -mx32
16072 @itemx -m16
16073 @opindex m32
16074 @opindex m64
16075 @opindex mx32
16076 @opindex m16
16077 Generate code for a 16-bit, 32-bit or 64-bit environment.
16078 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
16079 to 32 bits, and
16080 generates code that runs on any i386 system.
16082 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
16083 types to 64 bits, and generates code for the x86-64 architecture.
16084 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
16085 and @option{-mdynamic-no-pic} options.
16087 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
16088 to 32 bits, and
16089 generates code for the x86-64 architecture.
16091 The @option{-m16} option is the same as @option{-m32}, except for that
16092 it outputs the @code{.code16gcc} assembly directive at the beginning of
16093 the assembly output so that the binary can run in 16-bit mode.
16095 @item -mno-red-zone
16096 @opindex mno-red-zone
16097 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
16098 by the x86-64 ABI; it is a 128-byte area beyond the location of the
16099 stack pointer that is not modified by signal or interrupt handlers
16100 and therefore can be used for temporary data without adjusting the stack
16101 pointer.  The flag @option{-mno-red-zone} disables this red zone.
16103 @item -mcmodel=small
16104 @opindex mcmodel=small
16105 Generate code for the small code model: the program and its symbols must
16106 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
16107 Programs can be statically or dynamically linked.  This is the default
16108 code model.
16110 @item -mcmodel=kernel
16111 @opindex mcmodel=kernel
16112 Generate code for the kernel code model.  The kernel runs in the
16113 negative 2 GB of the address space.
16114 This model has to be used for Linux kernel code.
16116 @item -mcmodel=medium
16117 @opindex mcmodel=medium
16118 Generate code for the medium model: the program is linked in the lower 2
16119 GB of the address space.  Small symbols are also placed there.  Symbols
16120 with sizes larger than @option{-mlarge-data-threshold} are put into
16121 large data or BSS sections and can be located above 2GB.  Programs can
16122 be statically or dynamically linked.
16124 @item -mcmodel=large
16125 @opindex mcmodel=large
16126 Generate code for the large model.  This model makes no assumptions
16127 about addresses and sizes of sections.
16129 @item -maddress-mode=long
16130 @opindex maddress-mode=long
16131 Generate code for long address mode.  This is only supported for 64-bit
16132 and x32 environments.  It is the default address mode for 64-bit
16133 environments.
16135 @item -maddress-mode=short
16136 @opindex maddress-mode=short
16137 Generate code for short address mode.  This is only supported for 32-bit
16138 and x32 environments.  It is the default address mode for 32-bit and
16139 x32 environments.
16140 @end table
16142 @node i386 and x86-64 Windows Options
16143 @subsection i386 and x86-64 Windows Options
16144 @cindex i386 and x86-64 Windows Options
16146 These additional options are available for Microsoft Windows targets:
16148 @table @gcctabopt
16149 @item -mconsole
16150 @opindex mconsole
16151 This option
16152 specifies that a console application is to be generated, by
16153 instructing the linker to set the PE header subsystem type
16154 required for console applications.
16155 This option is available for Cygwin and MinGW targets and is
16156 enabled by default on those targets.
16158 @item -mdll
16159 @opindex mdll
16160 This option is available for Cygwin and MinGW targets.  It
16161 specifies that a DLL---a dynamic link library---is to be
16162 generated, enabling the selection of the required runtime
16163 startup object and entry point.
16165 @item -mnop-fun-dllimport
16166 @opindex mnop-fun-dllimport
16167 This option is available for Cygwin and MinGW targets.  It
16168 specifies that the @code{dllimport} attribute should be ignored.
16170 @item -mthread
16171 @opindex mthread
16172 This option is available for MinGW targets. It specifies
16173 that MinGW-specific thread support is to be used.
16175 @item -municode
16176 @opindex municode
16177 This option is available for MinGW-w64 targets.  It causes
16178 the @code{UNICODE} preprocessor macro to be predefined, and
16179 chooses Unicode-capable runtime startup code.
16181 @item -mwin32
16182 @opindex mwin32
16183 This option is available for Cygwin and MinGW targets.  It
16184 specifies that the typical Microsoft Windows predefined macros are to
16185 be set in the pre-processor, but does not influence the choice
16186 of runtime library/startup code.
16188 @item -mwindows
16189 @opindex mwindows
16190 This option is available for Cygwin and MinGW targets.  It
16191 specifies that a GUI application is to be generated by
16192 instructing the linker to set the PE header subsystem type
16193 appropriately.
16195 @item -fno-set-stack-executable
16196 @opindex fno-set-stack-executable
16197 This option is available for MinGW targets. It specifies that
16198 the executable flag for the stack used by nested functions isn't
16199 set. This is necessary for binaries running in kernel mode of
16200 Microsoft Windows, as there the User32 API, which is used to set executable
16201 privileges, isn't available.
16203 @item -fwritable-relocated-rdata
16204 @opindex fno-writable-relocated-rdata
16205 This option is available for MinGW and Cygwin targets.  It specifies
16206 that relocated-data in read-only section is put into .data
16207 section.  This is a necessary for older runtimes not supporting
16208 modification of .rdata sections for pseudo-relocation.
16210 @item -mpe-aligned-commons
16211 @opindex mpe-aligned-commons
16212 This option is available for Cygwin and MinGW targets.  It
16213 specifies that the GNU extension to the PE file format that
16214 permits the correct alignment of COMMON variables should be
16215 used when generating code.  It is enabled by default if
16216 GCC detects that the target assembler found during configuration
16217 supports the feature.
16218 @end table
16220 See also under @ref{i386 and x86-64 Options} for standard options.
16222 @node IA-64 Options
16223 @subsection IA-64 Options
16224 @cindex IA-64 Options
16226 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16228 @table @gcctabopt
16229 @item -mbig-endian
16230 @opindex mbig-endian
16231 Generate code for a big-endian target.  This is the default for HP-UX@.
16233 @item -mlittle-endian
16234 @opindex mlittle-endian
16235 Generate code for a little-endian target.  This is the default for AIX5
16236 and GNU/Linux.
16238 @item -mgnu-as
16239 @itemx -mno-gnu-as
16240 @opindex mgnu-as
16241 @opindex mno-gnu-as
16242 Generate (or don't) code for the GNU assembler.  This is the default.
16243 @c Also, this is the default if the configure option @option{--with-gnu-as}
16244 @c is used.
16246 @item -mgnu-ld
16247 @itemx -mno-gnu-ld
16248 @opindex mgnu-ld
16249 @opindex mno-gnu-ld
16250 Generate (or don't) code for the GNU linker.  This is the default.
16251 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16252 @c is used.
16254 @item -mno-pic
16255 @opindex mno-pic
16256 Generate code that does not use a global pointer register.  The result
16257 is not position independent code, and violates the IA-64 ABI@.
16259 @item -mvolatile-asm-stop
16260 @itemx -mno-volatile-asm-stop
16261 @opindex mvolatile-asm-stop
16262 @opindex mno-volatile-asm-stop
16263 Generate (or don't) a stop bit immediately before and after volatile asm
16264 statements.
16266 @item -mregister-names
16267 @itemx -mno-register-names
16268 @opindex mregister-names
16269 @opindex mno-register-names
16270 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16271 the stacked registers.  This may make assembler output more readable.
16273 @item -mno-sdata
16274 @itemx -msdata
16275 @opindex mno-sdata
16276 @opindex msdata
16277 Disable (or enable) optimizations that use the small data section.  This may
16278 be useful for working around optimizer bugs.
16280 @item -mconstant-gp
16281 @opindex mconstant-gp
16282 Generate code that uses a single constant global pointer value.  This is
16283 useful when compiling kernel code.
16285 @item -mauto-pic
16286 @opindex mauto-pic
16287 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16288 This is useful when compiling firmware code.
16290 @item -minline-float-divide-min-latency
16291 @opindex minline-float-divide-min-latency
16292 Generate code for inline divides of floating-point values
16293 using the minimum latency algorithm.
16295 @item -minline-float-divide-max-throughput
16296 @opindex minline-float-divide-max-throughput
16297 Generate code for inline divides of floating-point values
16298 using the maximum throughput algorithm.
16300 @item -mno-inline-float-divide
16301 @opindex mno-inline-float-divide
16302 Do not generate inline code for divides of floating-point values.
16304 @item -minline-int-divide-min-latency
16305 @opindex minline-int-divide-min-latency
16306 Generate code for inline divides of integer values
16307 using the minimum latency algorithm.
16309 @item -minline-int-divide-max-throughput
16310 @opindex minline-int-divide-max-throughput
16311 Generate code for inline divides of integer values
16312 using the maximum throughput algorithm.
16314 @item -mno-inline-int-divide
16315 @opindex mno-inline-int-divide
16316 Do not generate inline code for divides of integer values.
16318 @item -minline-sqrt-min-latency
16319 @opindex minline-sqrt-min-latency
16320 Generate code for inline square roots
16321 using the minimum latency algorithm.
16323 @item -minline-sqrt-max-throughput
16324 @opindex minline-sqrt-max-throughput
16325 Generate code for inline square roots
16326 using the maximum throughput algorithm.
16328 @item -mno-inline-sqrt
16329 @opindex mno-inline-sqrt
16330 Do not generate inline code for @code{sqrt}.
16332 @item -mfused-madd
16333 @itemx -mno-fused-madd
16334 @opindex mfused-madd
16335 @opindex mno-fused-madd
16336 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16337 instructions.  The default is to use these instructions.
16339 @item -mno-dwarf2-asm
16340 @itemx -mdwarf2-asm
16341 @opindex mno-dwarf2-asm
16342 @opindex mdwarf2-asm
16343 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16344 info.  This may be useful when not using the GNU assembler.
16346 @item -mearly-stop-bits
16347 @itemx -mno-early-stop-bits
16348 @opindex mearly-stop-bits
16349 @opindex mno-early-stop-bits
16350 Allow stop bits to be placed earlier than immediately preceding the
16351 instruction that triggered the stop bit.  This can improve instruction
16352 scheduling, but does not always do so.
16354 @item -mfixed-range=@var{register-range}
16355 @opindex mfixed-range
16356 Generate code treating the given register range as fixed registers.
16357 A fixed register is one that the register allocator cannot use.  This is
16358 useful when compiling kernel code.  A register range is specified as
16359 two registers separated by a dash.  Multiple register ranges can be
16360 specified separated by a comma.
16362 @item -mtls-size=@var{tls-size}
16363 @opindex mtls-size
16364 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16367 @item -mtune=@var{cpu-type}
16368 @opindex mtune
16369 Tune the instruction scheduling for a particular CPU, Valid values are
16370 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16371 and @samp{mckinley}.
16373 @item -milp32
16374 @itemx -mlp64
16375 @opindex milp32
16376 @opindex mlp64
16377 Generate code for a 32-bit or 64-bit environment.
16378 The 32-bit environment sets int, long and pointer to 32 bits.
16379 The 64-bit environment sets int to 32 bits and long and pointer
16380 to 64 bits.  These are HP-UX specific flags.
16382 @item -mno-sched-br-data-spec
16383 @itemx -msched-br-data-spec
16384 @opindex mno-sched-br-data-spec
16385 @opindex msched-br-data-spec
16386 (Dis/En)able data speculative scheduling before reload.
16387 This results in generation of @code{ld.a} instructions and
16388 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16389 The default is 'disable'.
16391 @item -msched-ar-data-spec
16392 @itemx -mno-sched-ar-data-spec
16393 @opindex msched-ar-data-spec
16394 @opindex mno-sched-ar-data-spec
16395 (En/Dis)able data speculative scheduling after reload.
16396 This results in generation of @code{ld.a} instructions and
16397 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16398 The default is 'enable'.
16400 @item -mno-sched-control-spec
16401 @itemx -msched-control-spec
16402 @opindex mno-sched-control-spec
16403 @opindex msched-control-spec
16404 (Dis/En)able control speculative scheduling.  This feature is
16405 available only during region scheduling (i.e.@: before reload).
16406 This results in generation of the @code{ld.s} instructions and
16407 the corresponding check instructions @code{chk.s}.
16408 The default is 'disable'.
16410 @item -msched-br-in-data-spec
16411 @itemx -mno-sched-br-in-data-spec
16412 @opindex msched-br-in-data-spec
16413 @opindex mno-sched-br-in-data-spec
16414 (En/Dis)able speculative scheduling of the instructions that
16415 are dependent on the data speculative loads before reload.
16416 This is effective only with @option{-msched-br-data-spec} enabled.
16417 The default is 'enable'.
16419 @item -msched-ar-in-data-spec
16420 @itemx -mno-sched-ar-in-data-spec
16421 @opindex msched-ar-in-data-spec
16422 @opindex mno-sched-ar-in-data-spec
16423 (En/Dis)able speculative scheduling of the instructions that
16424 are dependent on the data speculative loads after reload.
16425 This is effective only with @option{-msched-ar-data-spec} enabled.
16426 The default is 'enable'.
16428 @item -msched-in-control-spec
16429 @itemx -mno-sched-in-control-spec
16430 @opindex msched-in-control-spec
16431 @opindex mno-sched-in-control-spec
16432 (En/Dis)able speculative scheduling of the instructions that
16433 are dependent on the control speculative loads.
16434 This is effective only with @option{-msched-control-spec} enabled.
16435 The default is 'enable'.
16437 @item -mno-sched-prefer-non-data-spec-insns
16438 @itemx -msched-prefer-non-data-spec-insns
16439 @opindex mno-sched-prefer-non-data-spec-insns
16440 @opindex msched-prefer-non-data-spec-insns
16441 If enabled, data-speculative instructions are chosen for schedule
16442 only if there are no other choices at the moment.  This makes
16443 the use of the data speculation much more conservative.
16444 The default is 'disable'.
16446 @item -mno-sched-prefer-non-control-spec-insns
16447 @itemx -msched-prefer-non-control-spec-insns
16448 @opindex mno-sched-prefer-non-control-spec-insns
16449 @opindex msched-prefer-non-control-spec-insns
16450 If enabled, control-speculative instructions are chosen for schedule
16451 only if there are no other choices at the moment.  This makes
16452 the use of the control speculation much more conservative.
16453 The default is 'disable'.
16455 @item -mno-sched-count-spec-in-critical-path
16456 @itemx -msched-count-spec-in-critical-path
16457 @opindex mno-sched-count-spec-in-critical-path
16458 @opindex msched-count-spec-in-critical-path
16459 If enabled, speculative dependencies are considered during
16460 computation of the instructions priorities.  This makes the use of the
16461 speculation a bit more conservative.
16462 The default is 'disable'.
16464 @item -msched-spec-ldc
16465 @opindex msched-spec-ldc
16466 Use a simple data speculation check.  This option is on by default.
16468 @item -msched-control-spec-ldc
16469 @opindex msched-spec-ldc
16470 Use a simple check for control speculation.  This option is on by default.
16472 @item -msched-stop-bits-after-every-cycle
16473 @opindex msched-stop-bits-after-every-cycle
16474 Place a stop bit after every cycle when scheduling.  This option is on
16475 by default.
16477 @item -msched-fp-mem-deps-zero-cost
16478 @opindex msched-fp-mem-deps-zero-cost
16479 Assume that floating-point stores and loads are not likely to cause a conflict
16480 when placed into the same instruction group.  This option is disabled by
16481 default.
16483 @item -msel-sched-dont-check-control-spec
16484 @opindex msel-sched-dont-check-control-spec
16485 Generate checks for control speculation in selective scheduling.
16486 This flag is disabled by default.
16488 @item -msched-max-memory-insns=@var{max-insns}
16489 @opindex msched-max-memory-insns
16490 Limit on the number of memory insns per instruction group, giving lower
16491 priority to subsequent memory insns attempting to schedule in the same
16492 instruction group. Frequently useful to prevent cache bank conflicts.
16493 The default value is 1.
16495 @item -msched-max-memory-insns-hard-limit
16496 @opindex msched-max-memory-insns-hard-limit
16497 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16498 disallowing more than that number in an instruction group.
16499 Otherwise, the limit is ``soft'', meaning that non-memory operations
16500 are preferred when the limit is reached, but memory operations may still
16501 be scheduled.
16503 @end table
16505 @node LM32 Options
16506 @subsection LM32 Options
16507 @cindex LM32 options
16509 These @option{-m} options are defined for the LatticeMico32 architecture:
16511 @table @gcctabopt
16512 @item -mbarrel-shift-enabled
16513 @opindex mbarrel-shift-enabled
16514 Enable barrel-shift instructions.
16516 @item -mdivide-enabled
16517 @opindex mdivide-enabled
16518 Enable divide and modulus instructions.
16520 @item -mmultiply-enabled
16521 @opindex multiply-enabled
16522 Enable multiply instructions.
16524 @item -msign-extend-enabled
16525 @opindex msign-extend-enabled
16526 Enable sign extend instructions.
16528 @item -muser-enabled
16529 @opindex muser-enabled
16530 Enable user-defined instructions.
16532 @end table
16534 @node M32C Options
16535 @subsection M32C Options
16536 @cindex M32C options
16538 @table @gcctabopt
16539 @item -mcpu=@var{name}
16540 @opindex mcpu=
16541 Select the CPU for which code is generated.  @var{name} may be one of
16542 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16543 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16544 the M32C/80 series.
16546 @item -msim
16547 @opindex msim
16548 Specifies that the program will be run on the simulator.  This causes
16549 an alternate runtime library to be linked in which supports, for
16550 example, file I/O@.  You must not use this option when generating
16551 programs that will run on real hardware; you must provide your own
16552 runtime library for whatever I/O functions are needed.
16554 @item -memregs=@var{number}
16555 @opindex memregs=
16556 Specifies the number of memory-based pseudo-registers GCC uses
16557 during code generation.  These pseudo-registers are used like real
16558 registers, so there is a tradeoff between GCC's ability to fit the
16559 code into available registers, and the performance penalty of using
16560 memory instead of registers.  Note that all modules in a program must
16561 be compiled with the same value for this option.  Because of that, you
16562 must not use this option with GCC's default runtime libraries.
16564 @end table
16566 @node M32R/D Options
16567 @subsection M32R/D Options
16568 @cindex M32R/D options
16570 These @option{-m} options are defined for Renesas M32R/D architectures:
16572 @table @gcctabopt
16573 @item -m32r2
16574 @opindex m32r2
16575 Generate code for the M32R/2@.
16577 @item -m32rx
16578 @opindex m32rx
16579 Generate code for the M32R/X@.
16581 @item -m32r
16582 @opindex m32r
16583 Generate code for the M32R@.  This is the default.
16585 @item -mmodel=small
16586 @opindex mmodel=small
16587 Assume all objects live in the lower 16MB of memory (so that their addresses
16588 can be loaded with the @code{ld24} instruction), and assume all subroutines
16589 are reachable with the @code{bl} instruction.
16590 This is the default.
16592 The addressability of a particular object can be set with the
16593 @code{model} attribute.
16595 @item -mmodel=medium
16596 @opindex mmodel=medium
16597 Assume objects may be anywhere in the 32-bit address space (the compiler
16598 generates @code{seth/add3} instructions to load their addresses), and
16599 assume all subroutines are reachable with the @code{bl} instruction.
16601 @item -mmodel=large
16602 @opindex mmodel=large
16603 Assume objects may be anywhere in the 32-bit address space (the compiler
16604 generates @code{seth/add3} instructions to load their addresses), and
16605 assume subroutines may not be reachable with the @code{bl} instruction
16606 (the compiler generates the much slower @code{seth/add3/jl}
16607 instruction sequence).
16609 @item -msdata=none
16610 @opindex msdata=none
16611 Disable use of the small data area.  Variables are put into
16612 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16613 @code{section} attribute has been specified).
16614 This is the default.
16616 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16617 Objects may be explicitly put in the small data area with the
16618 @code{section} attribute using one of these sections.
16620 @item -msdata=sdata
16621 @opindex msdata=sdata
16622 Put small global and static data in the small data area, but do not
16623 generate special code to reference them.
16625 @item -msdata=use
16626 @opindex msdata=use
16627 Put small global and static data in the small data area, and generate
16628 special instructions to reference them.
16630 @item -G @var{num}
16631 @opindex G
16632 @cindex smaller data references
16633 Put global and static objects less than or equal to @var{num} bytes
16634 into the small data or BSS sections instead of the normal data or BSS
16635 sections.  The default value of @var{num} is 8.
16636 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16637 for this option to have any effect.
16639 All modules should be compiled with the same @option{-G @var{num}} value.
16640 Compiling with different values of @var{num} may or may not work; if it
16641 doesn't the linker gives an error message---incorrect code is not
16642 generated.
16644 @item -mdebug
16645 @opindex mdebug
16646 Makes the M32R-specific code in the compiler display some statistics
16647 that might help in debugging programs.
16649 @item -malign-loops
16650 @opindex malign-loops
16651 Align all loops to a 32-byte boundary.
16653 @item -mno-align-loops
16654 @opindex mno-align-loops
16655 Do not enforce a 32-byte alignment for loops.  This is the default.
16657 @item -missue-rate=@var{number}
16658 @opindex missue-rate=@var{number}
16659 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16660 or 2.
16662 @item -mbranch-cost=@var{number}
16663 @opindex mbranch-cost=@var{number}
16664 @var{number} can only be 1 or 2.  If it is 1 then branches are
16665 preferred over conditional code, if it is 2, then the opposite applies.
16667 @item -mflush-trap=@var{number}
16668 @opindex mflush-trap=@var{number}
16669 Specifies the trap number to use to flush the cache.  The default is
16670 12.  Valid numbers are between 0 and 15 inclusive.
16672 @item -mno-flush-trap
16673 @opindex mno-flush-trap
16674 Specifies that the cache cannot be flushed by using a trap.
16676 @item -mflush-func=@var{name}
16677 @opindex mflush-func=@var{name}
16678 Specifies the name of the operating system function to call to flush
16679 the cache.  The default is @emph{_flush_cache}, but a function call
16680 is only used if a trap is not available.
16682 @item -mno-flush-func
16683 @opindex mno-flush-func
16684 Indicates that there is no OS function for flushing the cache.
16686 @end table
16688 @node M680x0 Options
16689 @subsection M680x0 Options
16690 @cindex M680x0 options
16692 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16693 The default settings depend on which architecture was selected when
16694 the compiler was configured; the defaults for the most common choices
16695 are given below.
16697 @table @gcctabopt
16698 @item -march=@var{arch}
16699 @opindex march
16700 Generate code for a specific M680x0 or ColdFire instruction set
16701 architecture.  Permissible values of @var{arch} for M680x0
16702 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16703 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16704 architectures are selected according to Freescale's ISA classification
16705 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16706 @samp{isab} and @samp{isac}.
16708 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16709 code for a ColdFire target.  The @var{arch} in this macro is one of the
16710 @option{-march} arguments given above.
16712 When used together, @option{-march} and @option{-mtune} select code
16713 that runs on a family of similar processors but that is optimized
16714 for a particular microarchitecture.
16716 @item -mcpu=@var{cpu}
16717 @opindex mcpu
16718 Generate code for a specific M680x0 or ColdFire processor.
16719 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16720 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16721 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16722 below, which also classifies the CPUs into families:
16724 @multitable @columnfractions 0.20 0.80
16725 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16726 @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}
16727 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16728 @item @samp{5206e} @tab @samp{5206e}
16729 @item @samp{5208} @tab @samp{5207} @samp{5208}
16730 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16731 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16732 @item @samp{5216} @tab @samp{5214} @samp{5216}
16733 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16734 @item @samp{5225} @tab @samp{5224} @samp{5225}
16735 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16736 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16737 @item @samp{5249} @tab @samp{5249}
16738 @item @samp{5250} @tab @samp{5250}
16739 @item @samp{5271} @tab @samp{5270} @samp{5271}
16740 @item @samp{5272} @tab @samp{5272}
16741 @item @samp{5275} @tab @samp{5274} @samp{5275}
16742 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16743 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16744 @item @samp{5307} @tab @samp{5307}
16745 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16746 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16747 @item @samp{5407} @tab @samp{5407}
16748 @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}
16749 @end multitable
16751 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16752 @var{arch} is compatible with @var{cpu}.  Other combinations of
16753 @option{-mcpu} and @option{-march} are rejected.
16755 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16756 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16757 where the value of @var{family} is given by the table above.
16759 @item -mtune=@var{tune}
16760 @opindex mtune
16761 Tune the code for a particular microarchitecture within the
16762 constraints set by @option{-march} and @option{-mcpu}.
16763 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16764 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16765 and @samp{cpu32}.  The ColdFire microarchitectures
16766 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16768 You can also use @option{-mtune=68020-40} for code that needs
16769 to run relatively well on 68020, 68030 and 68040 targets.
16770 @option{-mtune=68020-60} is similar but includes 68060 targets
16771 as well.  These two options select the same tuning decisions as
16772 @option{-m68020-40} and @option{-m68020-60} respectively.
16774 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16775 when tuning for 680x0 architecture @var{arch}.  It also defines
16776 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16777 option is used.  If GCC is tuning for a range of architectures,
16778 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16779 it defines the macros for every architecture in the range.
16781 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16782 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16783 of the arguments given above.
16785 @item -m68000
16786 @itemx -mc68000
16787 @opindex m68000
16788 @opindex mc68000
16789 Generate output for a 68000.  This is the default
16790 when the compiler is configured for 68000-based systems.
16791 It is equivalent to @option{-march=68000}.
16793 Use this option for microcontrollers with a 68000 or EC000 core,
16794 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16796 @item -m68010
16797 @opindex m68010
16798 Generate output for a 68010.  This is the default
16799 when the compiler is configured for 68010-based systems.
16800 It is equivalent to @option{-march=68010}.
16802 @item -m68020
16803 @itemx -mc68020
16804 @opindex m68020
16805 @opindex mc68020
16806 Generate output for a 68020.  This is the default
16807 when the compiler is configured for 68020-based systems.
16808 It is equivalent to @option{-march=68020}.
16810 @item -m68030
16811 @opindex m68030
16812 Generate output for a 68030.  This is the default when the compiler is
16813 configured for 68030-based systems.  It is equivalent to
16814 @option{-march=68030}.
16816 @item -m68040
16817 @opindex m68040
16818 Generate output for a 68040.  This is the default when the compiler is
16819 configured for 68040-based systems.  It is equivalent to
16820 @option{-march=68040}.
16822 This option inhibits the use of 68881/68882 instructions that have to be
16823 emulated by software on the 68040.  Use this option if your 68040 does not
16824 have code to emulate those instructions.
16826 @item -m68060
16827 @opindex m68060
16828 Generate output for a 68060.  This is the default when the compiler is
16829 configured for 68060-based systems.  It is equivalent to
16830 @option{-march=68060}.
16832 This option inhibits the use of 68020 and 68881/68882 instructions that
16833 have to be emulated by software on the 68060.  Use this option if your 68060
16834 does not have code to emulate those instructions.
16836 @item -mcpu32
16837 @opindex mcpu32
16838 Generate output for a CPU32.  This is the default
16839 when the compiler is configured for CPU32-based systems.
16840 It is equivalent to @option{-march=cpu32}.
16842 Use this option for microcontrollers with a
16843 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16844 68336, 68340, 68341, 68349 and 68360.
16846 @item -m5200
16847 @opindex m5200
16848 Generate output for a 520X ColdFire CPU@.  This is the default
16849 when the compiler is configured for 520X-based systems.
16850 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16851 in favor of that option.
16853 Use this option for microcontroller with a 5200 core, including
16854 the MCF5202, MCF5203, MCF5204 and MCF5206.
16856 @item -m5206e
16857 @opindex m5206e
16858 Generate output for a 5206e ColdFire CPU@.  The option is now
16859 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16861 @item -m528x
16862 @opindex m528x
16863 Generate output for a member of the ColdFire 528X family.
16864 The option is now deprecated in favor of the equivalent
16865 @option{-mcpu=528x}.
16867 @item -m5307
16868 @opindex m5307
16869 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16870 in favor of the equivalent @option{-mcpu=5307}.
16872 @item -m5407
16873 @opindex m5407
16874 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16875 in favor of the equivalent @option{-mcpu=5407}.
16877 @item -mcfv4e
16878 @opindex mcfv4e
16879 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16880 This includes use of hardware floating-point instructions.
16881 The option is equivalent to @option{-mcpu=547x}, and is now
16882 deprecated in favor of that option.
16884 @item -m68020-40
16885 @opindex m68020-40
16886 Generate output for a 68040, without using any of the new instructions.
16887 This results in code that can run relatively efficiently on either a
16888 68020/68881 or a 68030 or a 68040.  The generated code does use the
16889 68881 instructions that are emulated on the 68040.
16891 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16893 @item -m68020-60
16894 @opindex m68020-60
16895 Generate output for a 68060, without using any of the new instructions.
16896 This results in code that can run relatively efficiently on either a
16897 68020/68881 or a 68030 or a 68040.  The generated code does use the
16898 68881 instructions that are emulated on the 68060.
16900 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16902 @item -mhard-float
16903 @itemx -m68881
16904 @opindex mhard-float
16905 @opindex m68881
16906 Generate floating-point instructions.  This is the default for 68020
16907 and above, and for ColdFire devices that have an FPU@.  It defines the
16908 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
16909 on ColdFire targets.
16911 @item -msoft-float
16912 @opindex msoft-float
16913 Do not generate floating-point instructions; use library calls instead.
16914 This is the default for 68000, 68010, and 68832 targets.  It is also
16915 the default for ColdFire devices that have no FPU.
16917 @item -mdiv
16918 @itemx -mno-div
16919 @opindex mdiv
16920 @opindex mno-div
16921 Generate (do not generate) ColdFire hardware divide and remainder
16922 instructions.  If @option{-march} is used without @option{-mcpu},
16923 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16924 architectures.  Otherwise, the default is taken from the target CPU
16925 (either the default CPU, or the one specified by @option{-mcpu}).  For
16926 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16927 @option{-mcpu=5206e}.
16929 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
16931 @item -mshort
16932 @opindex mshort
16933 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16934 Additionally, parameters passed on the stack are also aligned to a
16935 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16937 @item -mno-short
16938 @opindex mno-short
16939 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16941 @item -mnobitfield
16942 @itemx -mno-bitfield
16943 @opindex mnobitfield
16944 @opindex mno-bitfield
16945 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16946 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16948 @item -mbitfield
16949 @opindex mbitfield
16950 Do use the bit-field instructions.  The @option{-m68020} option implies
16951 @option{-mbitfield}.  This is the default if you use a configuration
16952 designed for a 68020.
16954 @item -mrtd
16955 @opindex mrtd
16956 Use a different function-calling convention, in which functions
16957 that take a fixed number of arguments return with the @code{rtd}
16958 instruction, which pops their arguments while returning.  This
16959 saves one instruction in the caller since there is no need to pop
16960 the arguments there.
16962 This calling convention is incompatible with the one normally
16963 used on Unix, so you cannot use it if you need to call libraries
16964 compiled with the Unix compiler.
16966 Also, you must provide function prototypes for all functions that
16967 take variable numbers of arguments (including @code{printf});
16968 otherwise incorrect code is generated for calls to those
16969 functions.
16971 In addition, seriously incorrect code results if you call a
16972 function with too many arguments.  (Normally, extra arguments are
16973 harmlessly ignored.)
16975 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16976 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16978 @item -mno-rtd
16979 @opindex mno-rtd
16980 Do not use the calling conventions selected by @option{-mrtd}.
16981 This is the default.
16983 @item -malign-int
16984 @itemx -mno-align-int
16985 @opindex malign-int
16986 @opindex mno-align-int
16987 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16988 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16989 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16990 Aligning variables on 32-bit boundaries produces code that runs somewhat
16991 faster on processors with 32-bit busses at the expense of more memory.
16993 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16994 aligns structures containing the above types differently than
16995 most published application binary interface specifications for the m68k.
16997 @item -mpcrel
16998 @opindex mpcrel
16999 Use the pc-relative addressing mode of the 68000 directly, instead of
17000 using a global offset table.  At present, this option implies @option{-fpic},
17001 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
17002 not presently supported with @option{-mpcrel}, though this could be supported for
17003 68020 and higher processors.
17005 @item -mno-strict-align
17006 @itemx -mstrict-align
17007 @opindex mno-strict-align
17008 @opindex mstrict-align
17009 Do not (do) assume that unaligned memory references are handled by
17010 the system.
17012 @item -msep-data
17013 Generate code that allows the data segment to be located in a different
17014 area of memory from the text segment.  This allows for execute-in-place in
17015 an environment without virtual memory management.  This option implies
17016 @option{-fPIC}.
17018 @item -mno-sep-data
17019 Generate code that assumes that the data segment follows the text segment.
17020 This is the default.
17022 @item -mid-shared-library
17023 Generate code that supports shared libraries via the library ID method.
17024 This allows for execute-in-place and shared libraries in an environment
17025 without virtual memory management.  This option implies @option{-fPIC}.
17027 @item -mno-id-shared-library
17028 Generate code that doesn't assume ID-based shared libraries are being used.
17029 This is the default.
17031 @item -mshared-library-id=n
17032 Specifies the identification number of the ID-based shared library being
17033 compiled.  Specifying a value of 0 generates more compact code; specifying
17034 other values forces the allocation of that number to the current
17035 library, but is no more space- or time-efficient than omitting this option.
17037 @item -mxgot
17038 @itemx -mno-xgot
17039 @opindex mxgot
17040 @opindex mno-xgot
17041 When generating position-independent code for ColdFire, generate code
17042 that works if the GOT has more than 8192 entries.  This code is
17043 larger and slower than code generated without this option.  On M680x0
17044 processors, this option is not needed; @option{-fPIC} suffices.
17046 GCC normally uses a single instruction to load values from the GOT@.
17047 While this is relatively efficient, it only works if the GOT
17048 is smaller than about 64k.  Anything larger causes the linker
17049 to report an error such as:
17051 @cindex relocation truncated to fit (ColdFire)
17052 @smallexample
17053 relocation truncated to fit: R_68K_GOT16O foobar
17054 @end smallexample
17056 If this happens, you should recompile your code with @option{-mxgot}.
17057 It should then work with very large GOTs.  However, code generated with
17058 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17059 the value of a global symbol.
17061 Note that some linkers, including newer versions of the GNU linker,
17062 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17063 you should only need to use @option{-mxgot} when compiling a single
17064 object file that accesses more than 8192 GOT entries.  Very few do.
17066 These options have no effect unless GCC is generating
17067 position-independent code.
17069 @end table
17071 @node MCore Options
17072 @subsection MCore Options
17073 @cindex MCore options
17075 These are the @samp{-m} options defined for the Motorola M*Core
17076 processors.
17078 @table @gcctabopt
17080 @item -mhardlit
17081 @itemx -mno-hardlit
17082 @opindex mhardlit
17083 @opindex mno-hardlit
17084 Inline constants into the code stream if it can be done in two
17085 instructions or less.
17087 @item -mdiv
17088 @itemx -mno-div
17089 @opindex mdiv
17090 @opindex mno-div
17091 Use the divide instruction.  (Enabled by default).
17093 @item -mrelax-immediate
17094 @itemx -mno-relax-immediate
17095 @opindex mrelax-immediate
17096 @opindex mno-relax-immediate
17097 Allow arbitrary-sized immediates in bit operations.
17099 @item -mwide-bitfields
17100 @itemx -mno-wide-bitfields
17101 @opindex mwide-bitfields
17102 @opindex mno-wide-bitfields
17103 Always treat bit-fields as @code{int}-sized.
17105 @item -m4byte-functions
17106 @itemx -mno-4byte-functions
17107 @opindex m4byte-functions
17108 @opindex mno-4byte-functions
17109 Force all functions to be aligned to a 4-byte boundary.
17111 @item -mcallgraph-data
17112 @itemx -mno-callgraph-data
17113 @opindex mcallgraph-data
17114 @opindex mno-callgraph-data
17115 Emit callgraph information.
17117 @item -mslow-bytes
17118 @itemx -mno-slow-bytes
17119 @opindex mslow-bytes
17120 @opindex mno-slow-bytes
17121 Prefer word access when reading byte quantities.
17123 @item -mlittle-endian
17124 @itemx -mbig-endian
17125 @opindex mlittle-endian
17126 @opindex mbig-endian
17127 Generate code for a little-endian target.
17129 @item -m210
17130 @itemx -m340
17131 @opindex m210
17132 @opindex m340
17133 Generate code for the 210 processor.
17135 @item -mno-lsim
17136 @opindex mno-lsim
17137 Assume that runtime support has been provided and so omit the
17138 simulator library (@file{libsim.a)} from the linker command line.
17140 @item -mstack-increment=@var{size}
17141 @opindex mstack-increment
17142 Set the maximum amount for a single stack increment operation.  Large
17143 values can increase the speed of programs that contain functions
17144 that need a large amount of stack space, but they can also trigger a
17145 segmentation fault if the stack is extended too much.  The default
17146 value is 0x1000.
17148 @end table
17150 @node MeP Options
17151 @subsection MeP Options
17152 @cindex MeP options
17154 @table @gcctabopt
17156 @item -mabsdiff
17157 @opindex mabsdiff
17158 Enables the @code{abs} instruction, which is the absolute difference
17159 between two registers.
17161 @item -mall-opts
17162 @opindex mall-opts
17163 Enables all the optional instructions---average, multiply, divide, bit
17164 operations, leading zero, absolute difference, min/max, clip, and
17165 saturation.
17168 @item -maverage
17169 @opindex maverage
17170 Enables the @code{ave} instruction, which computes the average of two
17171 registers.
17173 @item -mbased=@var{n}
17174 @opindex mbased=
17175 Variables of size @var{n} bytes or smaller are placed in the
17176 @code{.based} section by default.  Based variables use the @code{$tp}
17177 register as a base register, and there is a 128-byte limit to the
17178 @code{.based} section.
17180 @item -mbitops
17181 @opindex mbitops
17182 Enables the bit operation instructions---bit test (@code{btstm}), set
17183 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17184 test-and-set (@code{tas}).
17186 @item -mc=@var{name}
17187 @opindex mc=
17188 Selects which section constant data is placed in.  @var{name} may
17189 be @code{tiny}, @code{near}, or @code{far}.
17191 @item -mclip
17192 @opindex mclip
17193 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
17194 useful unless you also provide @code{-mminmax}.
17196 @item -mconfig=@var{name}
17197 @opindex mconfig=
17198 Selects one of the built-in core configurations.  Each MeP chip has
17199 one or more modules in it; each module has a core CPU and a variety of
17200 coprocessors, optional instructions, and peripherals.  The
17201 @code{MeP-Integrator} tool, not part of GCC, provides these
17202 configurations through this option; using this option is the same as
17203 using all the corresponding command-line options.  The default
17204 configuration is @code{default}.
17206 @item -mcop
17207 @opindex mcop
17208 Enables the coprocessor instructions.  By default, this is a 32-bit
17209 coprocessor.  Note that the coprocessor is normally enabled via the
17210 @code{-mconfig=} option.
17212 @item -mcop32
17213 @opindex mcop32
17214 Enables the 32-bit coprocessor's instructions.
17216 @item -mcop64
17217 @opindex mcop64
17218 Enables the 64-bit coprocessor's instructions.
17220 @item -mivc2
17221 @opindex mivc2
17222 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17224 @item -mdc
17225 @opindex mdc
17226 Causes constant variables to be placed in the @code{.near} section.
17228 @item -mdiv
17229 @opindex mdiv
17230 Enables the @code{div} and @code{divu} instructions.
17232 @item -meb
17233 @opindex meb
17234 Generate big-endian code.
17236 @item -mel
17237 @opindex mel
17238 Generate little-endian code.
17240 @item -mio-volatile
17241 @opindex mio-volatile
17242 Tells the compiler that any variable marked with the @code{io}
17243 attribute is to be considered volatile.
17245 @item -ml
17246 @opindex ml
17247 Causes variables to be assigned to the @code{.far} section by default.
17249 @item -mleadz
17250 @opindex mleadz
17251 Enables the @code{leadz} (leading zero) instruction.
17253 @item -mm
17254 @opindex mm
17255 Causes variables to be assigned to the @code{.near} section by default.
17257 @item -mminmax
17258 @opindex mminmax
17259 Enables the @code{min} and @code{max} instructions.
17261 @item -mmult
17262 @opindex mmult
17263 Enables the multiplication and multiply-accumulate instructions.
17265 @item -mno-opts
17266 @opindex mno-opts
17267 Disables all the optional instructions enabled by @code{-mall-opts}.
17269 @item -mrepeat
17270 @opindex mrepeat
17271 Enables the @code{repeat} and @code{erepeat} instructions, used for
17272 low-overhead looping.
17274 @item -ms
17275 @opindex ms
17276 Causes all variables to default to the @code{.tiny} section.  Note
17277 that there is a 65536-byte limit to this section.  Accesses to these
17278 variables use the @code{%gp} base register.
17280 @item -msatur
17281 @opindex msatur
17282 Enables the saturation instructions.  Note that the compiler does not
17283 currently generate these itself, but this option is included for
17284 compatibility with other tools, like @code{as}.
17286 @item -msdram
17287 @opindex msdram
17288 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17290 @item -msim
17291 @opindex msim
17292 Link the simulator run-time libraries.
17294 @item -msimnovec
17295 @opindex msimnovec
17296 Link the simulator runtime libraries, excluding built-in support
17297 for reset and exception vectors and tables.
17299 @item -mtf
17300 @opindex mtf
17301 Causes all functions to default to the @code{.far} section.  Without
17302 this option, functions default to the @code{.near} section.
17304 @item -mtiny=@var{n}
17305 @opindex mtiny=
17306 Variables that are @var{n} bytes or smaller are allocated to the
17307 @code{.tiny} section.  These variables use the @code{$gp} base
17308 register.  The default for this option is 4, but note that there's a
17309 65536-byte limit to the @code{.tiny} section.
17311 @end table
17313 @node MicroBlaze Options
17314 @subsection MicroBlaze Options
17315 @cindex MicroBlaze Options
17317 @table @gcctabopt
17319 @item -msoft-float
17320 @opindex msoft-float
17321 Use software emulation for floating point (default).
17323 @item -mhard-float
17324 @opindex mhard-float
17325 Use hardware floating-point instructions.
17327 @item -mmemcpy
17328 @opindex mmemcpy
17329 Do not optimize block moves, use @code{memcpy}.
17331 @item -mno-clearbss
17332 @opindex mno-clearbss
17333 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17335 @item -mcpu=@var{cpu-type}
17336 @opindex mcpu=
17337 Use features of, and schedule code for, the given CPU.
17338 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17339 where @var{X} is a major version, @var{YY} is the minor version, and
17340 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17341 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17343 @item -mxl-soft-mul
17344 @opindex mxl-soft-mul
17345 Use software multiply emulation (default).
17347 @item -mxl-soft-div
17348 @opindex mxl-soft-div
17349 Use software emulation for divides (default).
17351 @item -mxl-barrel-shift
17352 @opindex mxl-barrel-shift
17353 Use the hardware barrel shifter.
17355 @item -mxl-pattern-compare
17356 @opindex mxl-pattern-compare
17357 Use pattern compare instructions.
17359 @item -msmall-divides
17360 @opindex msmall-divides
17361 Use table lookup optimization for small signed integer divisions.
17363 @item -mxl-stack-check
17364 @opindex mxl-stack-check
17365 This option is deprecated.  Use @option{-fstack-check} instead.
17367 @item -mxl-gp-opt
17368 @opindex mxl-gp-opt
17369 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17371 @item -mxl-multiply-high
17372 @opindex mxl-multiply-high
17373 Use multiply high instructions for high part of 32x32 multiply.
17375 @item -mxl-float-convert
17376 @opindex mxl-float-convert
17377 Use hardware floating-point conversion instructions.
17379 @item -mxl-float-sqrt
17380 @opindex mxl-float-sqrt
17381 Use hardware floating-point square root instruction.
17383 @item -mbig-endian
17384 @opindex mbig-endian
17385 Generate code for a big-endian target.
17387 @item -mlittle-endian
17388 @opindex mlittle-endian
17389 Generate code for a little-endian target.
17391 @item -mxl-reorder
17392 @opindex mxl-reorder
17393 Use reorder instructions (swap and byte reversed load/store).
17395 @item -mxl-mode-@var{app-model}
17396 Select application model @var{app-model}.  Valid models are
17397 @table @samp
17398 @item executable
17399 normal executable (default), uses startup code @file{crt0.o}.
17401 @item xmdstub
17402 for use with Xilinx Microprocessor Debugger (XMD) based
17403 software intrusive debug agent called xmdstub. This uses startup file
17404 @file{crt1.o} and sets the start address of the program to 0x800.
17406 @item bootstrap
17407 for applications that are loaded using a bootloader.
17408 This model uses startup file @file{crt2.o} which does not contain a processor
17409 reset vector handler. This is suitable for transferring control on a
17410 processor reset to the bootloader rather than the application.
17412 @item novectors
17413 for applications that do not require any of the
17414 MicroBlaze vectors. This option may be useful for applications running
17415 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17416 @end table
17418 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17419 @option{-mxl-mode-@var{app-model}}.
17421 @end table
17423 @node MIPS Options
17424 @subsection MIPS Options
17425 @cindex MIPS options
17427 @table @gcctabopt
17429 @item -EB
17430 @opindex EB
17431 Generate big-endian code.
17433 @item -EL
17434 @opindex EL
17435 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17436 configurations.
17438 @item -march=@var{arch}
17439 @opindex march
17440 Generate code that runs on @var{arch}, which can be the name of a
17441 generic MIPS ISA, or the name of a particular processor.
17442 The ISA names are:
17443 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17444 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5}, 
17445 @samp{mips64}, @samp{mips64r2}, @samp{mips64r3} and @samp{mips64r5}.
17446 The processor names are:
17447 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17448 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17449 @samp{5kc}, @samp{5kf},
17450 @samp{20kc},
17451 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17452 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17453 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17454 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17455 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17456 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17457 @samp{m4k},
17458 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17459 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
17460 @samp{orion},
17461 @samp{p5600},
17462 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17463 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17464 @samp{rm7000}, @samp{rm9000},
17465 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17466 @samp{sb1},
17467 @samp{sr71000},
17468 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17469 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17470 @samp{xlr} and @samp{xlp}.
17471 The special value @samp{from-abi} selects the
17472 most compatible architecture for the selected ABI (that is,
17473 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17475 The native Linux/GNU toolchain also supports the value @samp{native},
17476 which selects the best architecture option for the host processor.
17477 @option{-march=native} has no effect if GCC does not recognize
17478 the processor.
17480 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17481 (for example, @option{-march=r2k}).  Prefixes are optional, and
17482 @samp{vr} may be written @samp{r}.
17484 Names of the form @samp{@var{n}f2_1} refer to processors with
17485 FPUs clocked at half the rate of the core, names of the form
17486 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17487 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17488 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17489 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17490 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17491 accepted as synonyms for @samp{@var{n}f1_1}.
17493 GCC defines two macros based on the value of this option.  The first
17494 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17495 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17496 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17497 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17498 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17500 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17501 above.  In other words, it has the full prefix and does not
17502 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17503 the macro names the resolved architecture (either @samp{"mips1"} or
17504 @samp{"mips3"}).  It names the default architecture when no
17505 @option{-march} option is given.
17507 @item -mtune=@var{arch}
17508 @opindex mtune
17509 Optimize for @var{arch}.  Among other things, this option controls
17510 the way instructions are scheduled, and the perceived cost of arithmetic
17511 operations.  The list of @var{arch} values is the same as for
17512 @option{-march}.
17514 When this option is not used, GCC optimizes for the processor
17515 specified by @option{-march}.  By using @option{-march} and
17516 @option{-mtune} together, it is possible to generate code that
17517 runs on a family of processors, but optimize the code for one
17518 particular member of that family.
17520 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17521 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17522 @option{-march} ones described above.
17524 @item -mips1
17525 @opindex mips1
17526 Equivalent to @option{-march=mips1}.
17528 @item -mips2
17529 @opindex mips2
17530 Equivalent to @option{-march=mips2}.
17532 @item -mips3
17533 @opindex mips3
17534 Equivalent to @option{-march=mips3}.
17536 @item -mips4
17537 @opindex mips4
17538 Equivalent to @option{-march=mips4}.
17540 @item -mips32
17541 @opindex mips32
17542 Equivalent to @option{-march=mips32}.
17544 @item -mips32r3
17545 @opindex mips32r3
17546 Equivalent to @option{-march=mips32r3}.
17548 @item -mips32r5
17549 @opindex mips32r5
17550 Equivalent to @option{-march=mips32r5}.
17552 @item -mips64
17553 @opindex mips64
17554 Equivalent to @option{-march=mips64}.
17556 @item -mips64r2
17557 @opindex mips64r2
17558 Equivalent to @option{-march=mips64r2}.
17560 @item -mips64r3
17561 @opindex mips64r3
17562 Equivalent to @option{-march=mips64r3}.
17564 @item -mips64r5
17565 @opindex mips64r5
17566 Equivalent to @option{-march=mips64r5}.
17568 @item -mips16
17569 @itemx -mno-mips16
17570 @opindex mips16
17571 @opindex mno-mips16
17572 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17573 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17575 MIPS16 code generation can also be controlled on a per-function basis
17576 by means of @code{mips16} and @code{nomips16} attributes.
17577 @xref{Function Attributes}, for more information.
17579 @item -mflip-mips16
17580 @opindex mflip-mips16
17581 Generate MIPS16 code on alternating functions.  This option is provided
17582 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17583 not intended for ordinary use in compiling user code.
17585 @item -minterlink-compressed
17586 @item -mno-interlink-compressed
17587 @opindex minterlink-compressed
17588 @opindex mno-interlink-compressed
17589 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17590 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17592 For example, code using the standard ISA encoding cannot jump directly
17593 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17594 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17595 knows that the target of the jump is not compressed.
17597 @item -minterlink-mips16
17598 @itemx -mno-interlink-mips16
17599 @opindex minterlink-mips16
17600 @opindex mno-interlink-mips16
17601 Aliases of @option{-minterlink-compressed} and
17602 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17603 and are retained for backwards compatibility.
17605 @item -mabi=32
17606 @itemx -mabi=o64
17607 @itemx -mabi=n32
17608 @itemx -mabi=64
17609 @itemx -mabi=eabi
17610 @opindex mabi=32
17611 @opindex mabi=o64
17612 @opindex mabi=n32
17613 @opindex mabi=64
17614 @opindex mabi=eabi
17615 Generate code for the given ABI@.
17617 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17618 generates 64-bit code when you select a 64-bit architecture, but you
17619 can use @option{-mgp32} to get 32-bit code instead.
17621 For information about the O64 ABI, see
17622 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17624 GCC supports a variant of the o32 ABI in which floating-point registers
17625 are 64 rather than 32 bits wide.  You can select this combination with
17626 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17627 and @code{mfhc1} instructions and is therefore only supported for
17628 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17630 The register assignments for arguments and return values remain the
17631 same, but each scalar value is passed in a single 64-bit register
17632 rather than a pair of 32-bit registers.  For example, scalar
17633 floating-point values are returned in @samp{$f0} only, not a
17634 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17635 remains the same, but all 64 bits are saved.
17637 @item -mabicalls
17638 @itemx -mno-abicalls
17639 @opindex mabicalls
17640 @opindex mno-abicalls
17641 Generate (do not generate) code that is suitable for SVR4-style
17642 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17643 systems.
17645 @item -mshared
17646 @itemx -mno-shared
17647 Generate (do not generate) code that is fully position-independent,
17648 and that can therefore be linked into shared libraries.  This option
17649 only affects @option{-mabicalls}.
17651 All @option{-mabicalls} code has traditionally been position-independent,
17652 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17653 as an extension, the GNU toolchain allows executables to use absolute
17654 accesses for locally-binding symbols.  It can also use shorter GP
17655 initialization sequences and generate direct calls to locally-defined
17656 functions.  This mode is selected by @option{-mno-shared}.
17658 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17659 objects that can only be linked by the GNU linker.  However, the option
17660 does not affect the ABI of the final executable; it only affects the ABI
17661 of relocatable objects.  Using @option{-mno-shared} generally makes
17662 executables both smaller and quicker.
17664 @option{-mshared} is the default.
17666 @item -mplt
17667 @itemx -mno-plt
17668 @opindex mplt
17669 @opindex mno-plt
17670 Assume (do not assume) that the static and dynamic linkers
17671 support PLTs and copy relocations.  This option only affects
17672 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17673 has no effect without @option{-msym32}.
17675 You can make @option{-mplt} the default by configuring
17676 GCC with @option{--with-mips-plt}.  The default is
17677 @option{-mno-plt} otherwise.
17679 @item -mxgot
17680 @itemx -mno-xgot
17681 @opindex mxgot
17682 @opindex mno-xgot
17683 Lift (do not lift) the usual restrictions on the size of the global
17684 offset table.
17686 GCC normally uses a single instruction to load values from the GOT@.
17687 While this is relatively efficient, it only works if the GOT
17688 is smaller than about 64k.  Anything larger causes the linker
17689 to report an error such as:
17691 @cindex relocation truncated to fit (MIPS)
17692 @smallexample
17693 relocation truncated to fit: R_MIPS_GOT16 foobar
17694 @end smallexample
17696 If this happens, you should recompile your code with @option{-mxgot}.
17697 This works with very large GOTs, although the code is also
17698 less efficient, since it takes three instructions to fetch the
17699 value of a global symbol.
17701 Note that some linkers can create multiple GOTs.  If you have such a
17702 linker, you should only need to use @option{-mxgot} when a single object
17703 file accesses more than 64k's worth of GOT entries.  Very few do.
17705 These options have no effect unless GCC is generating position
17706 independent code.
17708 @item -mgp32
17709 @opindex mgp32
17710 Assume that general-purpose registers are 32 bits wide.
17712 @item -mgp64
17713 @opindex mgp64
17714 Assume that general-purpose registers are 64 bits wide.
17716 @item -mfp32
17717 @opindex mfp32
17718 Assume that floating-point registers are 32 bits wide.
17720 @item -mfp64
17721 @opindex mfp64
17722 Assume that floating-point registers are 64 bits wide.
17724 @item -mhard-float
17725 @opindex mhard-float
17726 Use floating-point coprocessor instructions.
17728 @item -msoft-float
17729 @opindex msoft-float
17730 Do not use floating-point coprocessor instructions.  Implement
17731 floating-point calculations using library calls instead.
17733 @item -mno-float
17734 @opindex mno-float
17735 Equivalent to @option{-msoft-float}, but additionally asserts that the
17736 program being compiled does not perform any floating-point operations.
17737 This option is presently supported only by some bare-metal MIPS
17738 configurations, where it may select a special set of libraries
17739 that lack all floating-point support (including, for example, the
17740 floating-point @code{printf} formats).  
17741 If code compiled with @code{-mno-float} accidentally contains
17742 floating-point operations, it is likely to suffer a link-time
17743 or run-time failure.
17745 @item -msingle-float
17746 @opindex msingle-float
17747 Assume that the floating-point coprocessor only supports single-precision
17748 operations.
17750 @item -mdouble-float
17751 @opindex mdouble-float
17752 Assume that the floating-point coprocessor supports double-precision
17753 operations.  This is the default.
17755 @item -mabs=2008
17756 @itemx -mabs=legacy
17757 @opindex mabs=2008
17758 @opindex mabs=legacy
17759 These options control the treatment of the special not-a-number (NaN)
17760 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17761 @code{neg.@i{fmt}} machine instructions.
17763 By default or when the @option{-mabs=legacy} is used the legacy
17764 treatment is selected.  In this case these instructions are considered
17765 arithmetic and avoided where correct operation is required and the
17766 input operand might be a NaN.  A longer sequence of instructions that
17767 manipulate the sign bit of floating-point datum manually is used
17768 instead unless the @option{-ffinite-math-only} option has also been
17769 specified.
17771 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17772 this case these instructions are considered non-arithmetic and therefore
17773 operating correctly in all cases, including in particular where the
17774 input operand is a NaN.  These instructions are therefore always used
17775 for the respective operations.
17777 @item -mnan=2008
17778 @itemx -mnan=legacy
17779 @opindex mnan=2008
17780 @opindex mnan=legacy
17781 These options control the encoding of the special not-a-number (NaN)
17782 IEEE 754 floating-point data.
17784 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17785 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17786 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17787 by the first bit of their trailing significand field being 1.
17789 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17790 this case qNaNs are denoted by the first bit of their trailing
17791 significand field being 1, whereas sNaNs are denoted by the first bit of
17792 their trailing significand field being 0.
17794 The default is @option{-mnan=legacy} unless GCC has been configured with
17795 @option{--with-nan=2008}.
17797 @item -mllsc
17798 @itemx -mno-llsc
17799 @opindex mllsc
17800 @opindex mno-llsc
17801 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17802 implement atomic memory built-in functions.  When neither option is
17803 specified, GCC uses the instructions if the target architecture
17804 supports them.
17806 @option{-mllsc} is useful if the runtime environment can emulate the
17807 instructions and @option{-mno-llsc} can be useful when compiling for
17808 nonstandard ISAs.  You can make either option the default by
17809 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17810 respectively.  @option{--with-llsc} is the default for some
17811 configurations; see the installation documentation for details.
17813 @item -mdsp
17814 @itemx -mno-dsp
17815 @opindex mdsp
17816 @opindex mno-dsp
17817 Use (do not use) revision 1 of the MIPS DSP ASE@.
17818 @xref{MIPS DSP Built-in Functions}.  This option defines the
17819 preprocessor macro @samp{__mips_dsp}.  It also defines
17820 @samp{__mips_dsp_rev} to 1.
17822 @item -mdspr2
17823 @itemx -mno-dspr2
17824 @opindex mdspr2
17825 @opindex mno-dspr2
17826 Use (do not use) revision 2 of the MIPS DSP ASE@.
17827 @xref{MIPS DSP Built-in Functions}.  This option defines the
17828 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
17829 It also defines @samp{__mips_dsp_rev} to 2.
17831 @item -msmartmips
17832 @itemx -mno-smartmips
17833 @opindex msmartmips
17834 @opindex mno-smartmips
17835 Use (do not use) the MIPS SmartMIPS ASE.
17837 @item -mpaired-single
17838 @itemx -mno-paired-single
17839 @opindex mpaired-single
17840 @opindex mno-paired-single
17841 Use (do not use) paired-single floating-point instructions.
17842 @xref{MIPS Paired-Single Support}.  This option requires
17843 hardware floating-point support to be enabled.
17845 @item -mdmx
17846 @itemx -mno-mdmx
17847 @opindex mdmx
17848 @opindex mno-mdmx
17849 Use (do not use) MIPS Digital Media Extension instructions.
17850 This option can only be used when generating 64-bit code and requires
17851 hardware floating-point support to be enabled.
17853 @item -mips3d
17854 @itemx -mno-mips3d
17855 @opindex mips3d
17856 @opindex mno-mips3d
17857 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17858 The option @option{-mips3d} implies @option{-mpaired-single}.
17860 @item -mmicromips
17861 @itemx -mno-micromips
17862 @opindex mmicromips
17863 @opindex mno-mmicromips
17864 Generate (do not generate) microMIPS code.
17866 MicroMIPS code generation can also be controlled on a per-function basis
17867 by means of @code{micromips} and @code{nomicromips} attributes.
17868 @xref{Function Attributes}, for more information.
17870 @item -mmt
17871 @itemx -mno-mt
17872 @opindex mmt
17873 @opindex mno-mt
17874 Use (do not use) MT Multithreading instructions.
17876 @item -mmcu
17877 @itemx -mno-mcu
17878 @opindex mmcu
17879 @opindex mno-mcu
17880 Use (do not use) the MIPS MCU ASE instructions.
17882 @item -meva
17883 @itemx -mno-eva
17884 @opindex meva
17885 @opindex mno-eva
17886 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17888 @item -mvirt
17889 @itemx -mno-virt
17890 @opindex mvirt
17891 @opindex mno-virt
17892 Use (do not use) the MIPS Virtualization Application Specific instructions.
17894 @item -mxpa
17895 @itemx -mno-xpa
17896 @opindex mxpa
17897 @opindex mno-xpa
17898 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17900 @item -mlong64
17901 @opindex mlong64
17902 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17903 an explanation of the default and the way that the pointer size is
17904 determined.
17906 @item -mlong32
17907 @opindex mlong32
17908 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17910 The default size of @code{int}s, @code{long}s and pointers depends on
17911 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17912 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17913 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17914 or the same size as integer registers, whichever is smaller.
17916 @item -msym32
17917 @itemx -mno-sym32
17918 @opindex msym32
17919 @opindex mno-sym32
17920 Assume (do not assume) that all symbols have 32-bit values, regardless
17921 of the selected ABI@.  This option is useful in combination with
17922 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17923 to generate shorter and faster references to symbolic addresses.
17925 @item -G @var{num}
17926 @opindex G
17927 Put definitions of externally-visible data in a small data section
17928 if that data is no bigger than @var{num} bytes.  GCC can then generate
17929 more efficient accesses to the data; see @option{-mgpopt} for details.
17931 The default @option{-G} option depends on the configuration.
17933 @item -mlocal-sdata
17934 @itemx -mno-local-sdata
17935 @opindex mlocal-sdata
17936 @opindex mno-local-sdata
17937 Extend (do not extend) the @option{-G} behavior to local data too,
17938 such as to static variables in C@.  @option{-mlocal-sdata} is the
17939 default for all configurations.
17941 If the linker complains that an application is using too much small data,
17942 you might want to try rebuilding the less performance-critical parts with
17943 @option{-mno-local-sdata}.  You might also want to build large
17944 libraries with @option{-mno-local-sdata}, so that the libraries leave
17945 more room for the main program.
17947 @item -mextern-sdata
17948 @itemx -mno-extern-sdata
17949 @opindex mextern-sdata
17950 @opindex mno-extern-sdata
17951 Assume (do not assume) that externally-defined data is in
17952 a small data section if the size of that data is within the @option{-G} limit.
17953 @option{-mextern-sdata} is the default for all configurations.
17955 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17956 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17957 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17958 is placed in a small data section.  If @var{Var} is defined by another
17959 module, you must either compile that module with a high-enough
17960 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17961 definition.  If @var{Var} is common, you must link the application
17962 with a high-enough @option{-G} setting.
17964 The easiest way of satisfying these restrictions is to compile
17965 and link every module with the same @option{-G} option.  However,
17966 you may wish to build a library that supports several different
17967 small data limits.  You can do this by compiling the library with
17968 the highest supported @option{-G} setting and additionally using
17969 @option{-mno-extern-sdata} to stop the library from making assumptions
17970 about externally-defined data.
17972 @item -mgpopt
17973 @itemx -mno-gpopt
17974 @opindex mgpopt
17975 @opindex mno-gpopt
17976 Use (do not use) GP-relative accesses for symbols that are known to be
17977 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17978 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17979 configurations.
17981 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17982 might not hold the value of @code{_gp}.  For example, if the code is
17983 part of a library that might be used in a boot monitor, programs that
17984 call boot monitor routines pass an unknown value in @code{$gp}.
17985 (In such situations, the boot monitor itself is usually compiled
17986 with @option{-G0}.)
17988 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17989 @option{-mno-extern-sdata}.
17991 @item -membedded-data
17992 @itemx -mno-embedded-data
17993 @opindex membedded-data
17994 @opindex mno-embedded-data
17995 Allocate variables to the read-only data section first if possible, then
17996 next in the small data section if possible, otherwise in data.  This gives
17997 slightly slower code than the default, but reduces the amount of RAM required
17998 when executing, and thus may be preferred for some embedded systems.
18000 @item -muninit-const-in-rodata
18001 @itemx -mno-uninit-const-in-rodata
18002 @opindex muninit-const-in-rodata
18003 @opindex mno-uninit-const-in-rodata
18004 Put uninitialized @code{const} variables in the read-only data section.
18005 This option is only meaningful in conjunction with @option{-membedded-data}.
18007 @item -mcode-readable=@var{setting}
18008 @opindex mcode-readable
18009 Specify whether GCC may generate code that reads from executable sections.
18010 There are three possible settings:
18012 @table @gcctabopt
18013 @item -mcode-readable=yes
18014 Instructions may freely access executable sections.  This is the
18015 default setting.
18017 @item -mcode-readable=pcrel
18018 MIPS16 PC-relative load instructions can access executable sections,
18019 but other instructions must not do so.  This option is useful on 4KSc
18020 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
18021 It is also useful on processors that can be configured to have a dual
18022 instruction/data SRAM interface and that, like the M4K, automatically
18023 redirect PC-relative loads to the instruction RAM.
18025 @item -mcode-readable=no
18026 Instructions must not access executable sections.  This option can be
18027 useful on targets that are configured to have a dual instruction/data
18028 SRAM interface but that (unlike the M4K) do not automatically redirect
18029 PC-relative loads to the instruction RAM.
18030 @end table
18032 @item -msplit-addresses
18033 @itemx -mno-split-addresses
18034 @opindex msplit-addresses
18035 @opindex mno-split-addresses
18036 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18037 relocation operators.  This option has been superseded by
18038 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18040 @item -mexplicit-relocs
18041 @itemx -mno-explicit-relocs
18042 @opindex mexplicit-relocs
18043 @opindex mno-explicit-relocs
18044 Use (do not use) assembler relocation operators when dealing with symbolic
18045 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18046 is to use assembler macros instead.
18048 @option{-mexplicit-relocs} is the default if GCC was configured
18049 to use an assembler that supports relocation operators.
18051 @item -mcheck-zero-division
18052 @itemx -mno-check-zero-division
18053 @opindex mcheck-zero-division
18054 @opindex mno-check-zero-division
18055 Trap (do not trap) on integer division by zero.
18057 The default is @option{-mcheck-zero-division}.
18059 @item -mdivide-traps
18060 @itemx -mdivide-breaks
18061 @opindex mdivide-traps
18062 @opindex mdivide-breaks
18063 MIPS systems check for division by zero by generating either a
18064 conditional trap or a break instruction.  Using traps results in
18065 smaller code, but is only supported on MIPS II and later.  Also, some
18066 versions of the Linux kernel have a bug that prevents trap from
18067 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18068 allow conditional traps on architectures that support them and
18069 @option{-mdivide-breaks} to force the use of breaks.
18071 The default is usually @option{-mdivide-traps}, but this can be
18072 overridden at configure time using @option{--with-divide=breaks}.
18073 Divide-by-zero checks can be completely disabled using
18074 @option{-mno-check-zero-division}.
18076 @item -mmemcpy
18077 @itemx -mno-memcpy
18078 @opindex mmemcpy
18079 @opindex mno-memcpy
18080 Force (do not force) the use of @code{memcpy()} for non-trivial block
18081 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18082 most constant-sized copies.
18084 @item -mlong-calls
18085 @itemx -mno-long-calls
18086 @opindex mlong-calls
18087 @opindex mno-long-calls
18088 Disable (do not disable) use of the @code{jal} instruction.  Calling
18089 functions using @code{jal} is more efficient but requires the caller
18090 and callee to be in the same 256 megabyte segment.
18092 This option has no effect on abicalls code.  The default is
18093 @option{-mno-long-calls}.
18095 @item -mmad
18096 @itemx -mno-mad
18097 @opindex mmad
18098 @opindex mno-mad
18099 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18100 instructions, as provided by the R4650 ISA@.
18102 @item -mimadd
18103 @itemx -mno-imadd
18104 @opindex mimadd
18105 @opindex mno-imadd
18106 Enable (disable) use of the @code{madd} and @code{msub} integer
18107 instructions.  The default is @option{-mimadd} on architectures
18108 that support @code{madd} and @code{msub} except for the 74k 
18109 architecture where it was found to generate slower code.
18111 @item -mfused-madd
18112 @itemx -mno-fused-madd
18113 @opindex mfused-madd
18114 @opindex mno-fused-madd
18115 Enable (disable) use of the floating-point multiply-accumulate
18116 instructions, when they are available.  The default is
18117 @option{-mfused-madd}.
18119 On the R8000 CPU when multiply-accumulate instructions are used,
18120 the intermediate product is calculated to infinite precision
18121 and is not subject to the FCSR Flush to Zero bit.  This may be
18122 undesirable in some circumstances.  On other processors the result
18123 is numerically identical to the equivalent computation using
18124 separate multiply, add, subtract and negate instructions.
18126 @item -nocpp
18127 @opindex nocpp
18128 Tell the MIPS assembler to not run its preprocessor over user
18129 assembler files (with a @samp{.s} suffix) when assembling them.
18131 @item -mfix-24k
18132 @item -mno-fix-24k
18133 @opindex mfix-24k
18134 @opindex mno-fix-24k
18135 Work around the 24K E48 (lost data on stores during refill) errata.
18136 The workarounds are implemented by the assembler rather than by GCC@.
18138 @item -mfix-r4000
18139 @itemx -mno-fix-r4000
18140 @opindex mfix-r4000
18141 @opindex mno-fix-r4000
18142 Work around certain R4000 CPU errata:
18143 @itemize @minus
18144 @item
18145 A double-word or a variable shift may give an incorrect result if executed
18146 immediately after starting an integer division.
18147 @item
18148 A double-word or a variable shift may give an incorrect result if executed
18149 while an integer multiplication is in progress.
18150 @item
18151 An integer division may give an incorrect result if started in a delay slot
18152 of a taken branch or a jump.
18153 @end itemize
18155 @item -mfix-r4400
18156 @itemx -mno-fix-r4400
18157 @opindex mfix-r4400
18158 @opindex mno-fix-r4400
18159 Work around certain R4400 CPU errata:
18160 @itemize @minus
18161 @item
18162 A double-word or a variable shift may give an incorrect result if executed
18163 immediately after starting an integer division.
18164 @end itemize
18166 @item -mfix-r10000
18167 @itemx -mno-fix-r10000
18168 @opindex mfix-r10000
18169 @opindex mno-fix-r10000
18170 Work around certain R10000 errata:
18171 @itemize @minus
18172 @item
18173 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18174 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18175 @end itemize
18177 This option can only be used if the target architecture supports
18178 branch-likely instructions.  @option{-mfix-r10000} is the default when
18179 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18180 otherwise.
18182 @item -mfix-rm7000
18183 @itemx -mno-fix-rm7000
18184 @opindex mfix-rm7000
18185 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18186 workarounds are implemented by the assembler rather than by GCC@.
18188 @item -mfix-vr4120
18189 @itemx -mno-fix-vr4120
18190 @opindex mfix-vr4120
18191 Work around certain VR4120 errata:
18192 @itemize @minus
18193 @item
18194 @code{dmultu} does not always produce the correct result.
18195 @item
18196 @code{div} and @code{ddiv} do not always produce the correct result if one
18197 of the operands is negative.
18198 @end itemize
18199 The workarounds for the division errata rely on special functions in
18200 @file{libgcc.a}.  At present, these functions are only provided by
18201 the @code{mips64vr*-elf} configurations.
18203 Other VR4120 errata require a NOP to be inserted between certain pairs of
18204 instructions.  These errata are handled by the assembler, not by GCC itself.
18206 @item -mfix-vr4130
18207 @opindex mfix-vr4130
18208 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18209 workarounds are implemented by the assembler rather than by GCC,
18210 although GCC avoids using @code{mflo} and @code{mfhi} if the
18211 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18212 instructions are available instead.
18214 @item -mfix-sb1
18215 @itemx -mno-fix-sb1
18216 @opindex mfix-sb1
18217 Work around certain SB-1 CPU core errata.
18218 (This flag currently works around the SB-1 revision 2
18219 ``F1'' and ``F2'' floating-point errata.)
18221 @item -mr10k-cache-barrier=@var{setting}
18222 @opindex mr10k-cache-barrier
18223 Specify whether GCC should insert cache barriers to avoid the
18224 side-effects of speculation on R10K processors.
18226 In common with many processors, the R10K tries to predict the outcome
18227 of a conditional branch and speculatively executes instructions from
18228 the ``taken'' branch.  It later aborts these instructions if the
18229 predicted outcome is wrong.  However, on the R10K, even aborted
18230 instructions can have side effects.
18232 This problem only affects kernel stores and, depending on the system,
18233 kernel loads.  As an example, a speculatively-executed store may load
18234 the target memory into cache and mark the cache line as dirty, even if
18235 the store itself is later aborted.  If a DMA operation writes to the
18236 same area of memory before the ``dirty'' line is flushed, the cached
18237 data overwrites the DMA-ed data.  See the R10K processor manual
18238 for a full description, including other potential problems.
18240 One workaround is to insert cache barrier instructions before every memory
18241 access that might be speculatively executed and that might have side
18242 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18243 controls GCC's implementation of this workaround.  It assumes that
18244 aborted accesses to any byte in the following regions does not have
18245 side effects:
18247 @enumerate
18248 @item
18249 the memory occupied by the current function's stack frame;
18251 @item
18252 the memory occupied by an incoming stack argument;
18254 @item
18255 the memory occupied by an object with a link-time-constant address.
18256 @end enumerate
18258 It is the kernel's responsibility to ensure that speculative
18259 accesses to these regions are indeed safe.
18261 If the input program contains a function declaration such as:
18263 @smallexample
18264 void foo (void);
18265 @end smallexample
18267 then the implementation of @code{foo} must allow @code{j foo} and
18268 @code{jal foo} to be executed speculatively.  GCC honors this
18269 restriction for functions it compiles itself.  It expects non-GCC
18270 functions (such as hand-written assembly code) to do the same.
18272 The option has three forms:
18274 @table @gcctabopt
18275 @item -mr10k-cache-barrier=load-store
18276 Insert a cache barrier before a load or store that might be
18277 speculatively executed and that might have side effects even
18278 if aborted.
18280 @item -mr10k-cache-barrier=store
18281 Insert a cache barrier before a store that might be speculatively
18282 executed and that might have side effects even if aborted.
18284 @item -mr10k-cache-barrier=none
18285 Disable the insertion of cache barriers.  This is the default setting.
18286 @end table
18288 @item -mflush-func=@var{func}
18289 @itemx -mno-flush-func
18290 @opindex mflush-func
18291 Specifies the function to call to flush the I and D caches, or to not
18292 call any such function.  If called, the function must take the same
18293 arguments as the common @code{_flush_func()}, that is, the address of the
18294 memory range for which the cache is being flushed, the size of the
18295 memory range, and the number 3 (to flush both caches).  The default
18296 depends on the target GCC was configured for, but commonly is either
18297 @samp{_flush_func} or @samp{__cpu_flush}.
18299 @item mbranch-cost=@var{num}
18300 @opindex mbranch-cost
18301 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18302 This cost is only a heuristic and is not guaranteed to produce
18303 consistent results across releases.  A zero cost redundantly selects
18304 the default, which is based on the @option{-mtune} setting.
18306 @item -mbranch-likely
18307 @itemx -mno-branch-likely
18308 @opindex mbranch-likely
18309 @opindex mno-branch-likely
18310 Enable or disable use of Branch Likely instructions, regardless of the
18311 default for the selected architecture.  By default, Branch Likely
18312 instructions may be generated if they are supported by the selected
18313 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18314 and processors that implement those architectures; for those, Branch
18315 Likely instructions are not be generated by default because the MIPS32
18316 and MIPS64 architectures specifically deprecate their use.
18318 @item -mfp-exceptions
18319 @itemx -mno-fp-exceptions
18320 @opindex mfp-exceptions
18321 Specifies whether FP exceptions are enabled.  This affects how
18322 FP instructions are scheduled for some processors.
18323 The default is that FP exceptions are
18324 enabled.
18326 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18327 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18328 FP pipe.
18330 @item -mvr4130-align
18331 @itemx -mno-vr4130-align
18332 @opindex mvr4130-align
18333 The VR4130 pipeline is two-way superscalar, but can only issue two
18334 instructions together if the first one is 8-byte aligned.  When this
18335 option is enabled, GCC aligns pairs of instructions that it
18336 thinks should execute in parallel.
18338 This option only has an effect when optimizing for the VR4130.
18339 It normally makes code faster, but at the expense of making it bigger.
18340 It is enabled by default at optimization level @option{-O3}.
18342 @item -msynci
18343 @itemx -mno-synci
18344 @opindex msynci
18345 Enable (disable) generation of @code{synci} instructions on
18346 architectures that support it.  The @code{synci} instructions (if
18347 enabled) are generated when @code{__builtin___clear_cache()} is
18348 compiled.
18350 This option defaults to @code{-mno-synci}, but the default can be
18351 overridden by configuring with @code{--with-synci}.
18353 When compiling code for single processor systems, it is generally safe
18354 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18355 does not invalidate the instruction caches on all cores and may lead
18356 to undefined behavior.
18358 @item -mrelax-pic-calls
18359 @itemx -mno-relax-pic-calls
18360 @opindex mrelax-pic-calls
18361 Try to turn PIC calls that are normally dispatched via register
18362 @code{$25} into direct calls.  This is only possible if the linker can
18363 resolve the destination at link-time and if the destination is within
18364 range for a direct call.
18366 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18367 an assembler and a linker that support the @code{.reloc} assembly
18368 directive and @code{-mexplicit-relocs} is in effect.  With
18369 @code{-mno-explicit-relocs}, this optimization can be performed by the
18370 assembler and the linker alone without help from the compiler.
18372 @item -mmcount-ra-address
18373 @itemx -mno-mcount-ra-address
18374 @opindex mmcount-ra-address
18375 @opindex mno-mcount-ra-address
18376 Emit (do not emit) code that allows @code{_mcount} to modify the
18377 calling function's return address.  When enabled, this option extends
18378 the usual @code{_mcount} interface with a new @var{ra-address}
18379 parameter, which has type @code{intptr_t *} and is passed in register
18380 @code{$12}.  @code{_mcount} can then modify the return address by
18381 doing both of the following:
18382 @itemize
18383 @item
18384 Returning the new address in register @code{$31}.
18385 @item
18386 Storing the new address in @code{*@var{ra-address}},
18387 if @var{ra-address} is nonnull.
18388 @end itemize
18390 The default is @option{-mno-mcount-ra-address}.
18392 @end table
18394 @node MMIX Options
18395 @subsection MMIX Options
18396 @cindex MMIX Options
18398 These options are defined for the MMIX:
18400 @table @gcctabopt
18401 @item -mlibfuncs
18402 @itemx -mno-libfuncs
18403 @opindex mlibfuncs
18404 @opindex mno-libfuncs
18405 Specify that intrinsic library functions are being compiled, passing all
18406 values in registers, no matter the size.
18408 @item -mepsilon
18409 @itemx -mno-epsilon
18410 @opindex mepsilon
18411 @opindex mno-epsilon
18412 Generate floating-point comparison instructions that compare with respect
18413 to the @code{rE} epsilon register.
18415 @item -mabi=mmixware
18416 @itemx -mabi=gnu
18417 @opindex mabi=mmixware
18418 @opindex mabi=gnu
18419 Generate code that passes function parameters and return values that (in
18420 the called function) are seen as registers @code{$0} and up, as opposed to
18421 the GNU ABI which uses global registers @code{$231} and up.
18423 @item -mzero-extend
18424 @itemx -mno-zero-extend
18425 @opindex mzero-extend
18426 @opindex mno-zero-extend
18427 When reading data from memory in sizes shorter than 64 bits, use (do not
18428 use) zero-extending load instructions by default, rather than
18429 sign-extending ones.
18431 @item -mknuthdiv
18432 @itemx -mno-knuthdiv
18433 @opindex mknuthdiv
18434 @opindex mno-knuthdiv
18435 Make the result of a division yielding a remainder have the same sign as
18436 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18437 remainder follows the sign of the dividend.  Both methods are
18438 arithmetically valid, the latter being almost exclusively used.
18440 @item -mtoplevel-symbols
18441 @itemx -mno-toplevel-symbols
18442 @opindex mtoplevel-symbols
18443 @opindex mno-toplevel-symbols
18444 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18445 code can be used with the @code{PREFIX} assembly directive.
18447 @item -melf
18448 @opindex melf
18449 Generate an executable in the ELF format, rather than the default
18450 @samp{mmo} format used by the @command{mmix} simulator.
18452 @item -mbranch-predict
18453 @itemx -mno-branch-predict
18454 @opindex mbranch-predict
18455 @opindex mno-branch-predict
18456 Use (do not use) the probable-branch instructions, when static branch
18457 prediction indicates a probable branch.
18459 @item -mbase-addresses
18460 @itemx -mno-base-addresses
18461 @opindex mbase-addresses
18462 @opindex mno-base-addresses
18463 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18464 base address automatically generates a request (handled by the assembler
18465 and the linker) for a constant to be set up in a global register.  The
18466 register is used for one or more base address requests within the range 0
18467 to 255 from the value held in the register.  The generally leads to short
18468 and fast code, but the number of different data items that can be
18469 addressed is limited.  This means that a program that uses lots of static
18470 data may require @option{-mno-base-addresses}.
18472 @item -msingle-exit
18473 @itemx -mno-single-exit
18474 @opindex msingle-exit
18475 @opindex mno-single-exit
18476 Force (do not force) generated code to have a single exit point in each
18477 function.
18478 @end table
18480 @node MN10300 Options
18481 @subsection MN10300 Options
18482 @cindex MN10300 options
18484 These @option{-m} options are defined for Matsushita MN10300 architectures:
18486 @table @gcctabopt
18487 @item -mmult-bug
18488 @opindex mmult-bug
18489 Generate code to avoid bugs in the multiply instructions for the MN10300
18490 processors.  This is the default.
18492 @item -mno-mult-bug
18493 @opindex mno-mult-bug
18494 Do not generate code to avoid bugs in the multiply instructions for the
18495 MN10300 processors.
18497 @item -mam33
18498 @opindex mam33
18499 Generate code using features specific to the AM33 processor.
18501 @item -mno-am33
18502 @opindex mno-am33
18503 Do not generate code using features specific to the AM33 processor.  This
18504 is the default.
18506 @item -mam33-2
18507 @opindex mam33-2
18508 Generate code using features specific to the AM33/2.0 processor.
18510 @item -mam34
18511 @opindex mam34
18512 Generate code using features specific to the AM34 processor.
18514 @item -mtune=@var{cpu-type}
18515 @opindex mtune
18516 Use the timing characteristics of the indicated CPU type when
18517 scheduling instructions.  This does not change the targeted processor
18518 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18519 @samp{am33-2} or @samp{am34}.
18521 @item -mreturn-pointer-on-d0
18522 @opindex mreturn-pointer-on-d0
18523 When generating a function that returns a pointer, return the pointer
18524 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18525 only in @code{a0}, and attempts to call such functions without a prototype
18526 result in errors.  Note that this option is on by default; use
18527 @option{-mno-return-pointer-on-d0} to disable it.
18529 @item -mno-crt0
18530 @opindex mno-crt0
18531 Do not link in the C run-time initialization object file.
18533 @item -mrelax
18534 @opindex mrelax
18535 Indicate to the linker that it should perform a relaxation optimization pass
18536 to shorten branches, calls and absolute memory addresses.  This option only
18537 has an effect when used on the command line for the final link step.
18539 This option makes symbolic debugging impossible.
18541 @item -mliw
18542 @opindex mliw
18543 Allow the compiler to generate @emph{Long Instruction Word}
18544 instructions if the target is the @samp{AM33} or later.  This is the
18545 default.  This option defines the preprocessor macro @samp{__LIW__}.
18547 @item -mnoliw
18548 @opindex mnoliw
18549 Do not allow the compiler to generate @emph{Long Instruction Word}
18550 instructions.  This option defines the preprocessor macro
18551 @samp{__NO_LIW__}.
18553 @item -msetlb
18554 @opindex msetlb
18555 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18556 instructions if the target is the @samp{AM33} or later.  This is the
18557 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18559 @item -mnosetlb
18560 @opindex mnosetlb
18561 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18562 instructions.  This option defines the preprocessor macro
18563 @samp{__NO_SETLB__}.
18565 @end table
18567 @node Moxie Options
18568 @subsection Moxie Options
18569 @cindex Moxie Options
18571 @table @gcctabopt
18573 @item -meb
18574 @opindex meb
18575 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18576 configurations.
18578 @item -mel
18579 @opindex mel
18580 Generate little-endian code.
18582 @item -mno-crt0
18583 @opindex mno-crt0
18584 Do not link in the C run-time initialization object file.
18586 @end table
18588 @node MSP430 Options
18589 @subsection MSP430 Options
18590 @cindex MSP430 Options
18592 These options are defined for the MSP430:
18594 @table @gcctabopt
18596 @item -masm-hex
18597 @opindex masm-hex
18598 Force assembly output to always use hex constants.  Normally such
18599 constants are signed decimals, but this option is available for
18600 testsuite and/or aesthetic purposes.
18602 @item -mmcu=
18603 @opindex mmcu=
18604 Select the MCU to target.  This is used to create a C preprocessor
18605 symbol based upon the MCU name, converted to upper case and pre- and
18606 post- fixed with @code{__}.  This in turn will be used by the
18607 @code{msp430.h} header file to select an MCU specific supplimentary
18608 header file.
18610 The option also sets the ISA to use.  If the MCU name is one that is
18611 known to only support the 430 ISA then that is selected, otherwise the
18612 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18613 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18614 name will select the 430X ISA.
18616 In addition an MCU specific linker script will be added to the linker
18617 command line.  The script's name is the name of the MCU with
18618 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18619 command line will define the C preprocessor symbol @code{__XXX__} and
18620 cause the linker to search for a script called @file{xxx.ld}.
18622 This option is also passed on to the assembler.
18624 @item -mcpu=
18625 @opindex -mcpu=
18626 Specifies the ISA to use.  Accepted values are @code{msp430},
18627 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18628 @option{-mmcu=} option should be used to select the ISA.
18630 @item -msim
18631 @opindex msim
18632 Link to the simulator runtime libraries and linker script.  Overrides
18633 any scripts that would be selected by the @option{-mmcu=} option.
18635 @item -mlarge
18636 @opindex mlarge
18637 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18639 @item -msmall
18640 @opindex msmall
18641 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18643 @item -mrelax
18644 @opindex mrelax
18645 This option is passed to the assembler and linker, and allows the
18646 linker to perform certain optimizations that cannot be done until
18647 the final link.
18649 @item mhwmult=
18650 @opindex mhwmult=
18651 Describes the type of hardware multiply supported by the target.
18652 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18653 for the original 16-bit-only multiply supported by early MCUs.
18654 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18655 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18656 A value of @code{auto} can also be given.  This tells GCC to deduce
18657 the hardware multiply support based upon the MCU name provided by the
18658 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18659 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18660 default setting.
18662 Hardware multiplies are normally performed by calling a library
18663 routine.  This saves space in the generated code.  When compiling at
18664 @code{-O3} or higher however the hardware multiplier is invoked
18665 inline.  This makes for bigger, but faster code.
18667 The hardware multiply routines disable interrupts whilst running and
18668 restore the previous interrupt state when they finish.  This makes
18669 them safe to use inside interrupt handlers as well as in normal code.
18671 @item -minrt
18672 @opindex minrt
18673 Enable the use of a minimum runtime environment - no static
18674 initializers or constructors.  This is intended for memory-constrained
18675 devices.  The compiler will include special symbols in some objects
18676 that tell the linker and runtime which code fragments are required.
18678 @end table
18680 @node NDS32 Options
18681 @subsection NDS32 Options
18682 @cindex NDS32 Options
18684 These options are defined for NDS32 implementations:
18686 @table @gcctabopt
18688 @item -mbig-endian
18689 @opindex mbig-endian
18690 Generate code in big-endian mode.
18692 @item -mlittle-endian
18693 @opindex mlittle-endian
18694 Generate code in little-endian mode.
18696 @item -mreduced-regs
18697 @opindex mreduced-regs
18698 Use reduced-set registers for register allocation.
18700 @item -mfull-regs
18701 @opindex mfull-regs
18702 Use full-set registers for register allocation.
18704 @item -mcmov
18705 @opindex mcmov
18706 Generate conditional move instructions.
18708 @item -mno-cmov
18709 @opindex mno-cmov
18710 Do not generate conditional move instructions.
18712 @item -mperf-ext
18713 @opindex mperf-ext
18714 Generate performance extension instructions.
18716 @item -mno-perf-ext
18717 @opindex mno-perf-ext
18718 Do not generate performance extension instructions.
18720 @item -mv3push
18721 @opindex mv3push
18722 Generate v3 push25/pop25 instructions.
18724 @item -mno-v3push
18725 @opindex mno-v3push
18726 Do not generate v3 push25/pop25 instructions.
18728 @item -m16-bit
18729 @opindex m16-bit
18730 Generate 16-bit instructions.
18732 @item -mno-16-bit
18733 @opindex mno-16-bit
18734 Do not generate 16-bit instructions.
18736 @item -mgp-direct
18737 @opindex mgp-direct
18738 Generate GP base instructions directly.
18740 @item -mno-gp-direct
18741 @opindex mno-gp-direct
18742 Do no generate GP base instructions directly.
18744 @item -misr-vector-size=@var{num}
18745 @opindex misr-vector-size
18746 Specify the size of each interrupt vector, which must be 4 or 16.
18748 @item -mcache-block-size=@var{num}
18749 @opindex mcache-block-size
18750 Specify the size of each cache block,
18751 which must be a power of 2 between 4 and 512.
18753 @item -march=@var{arch}
18754 @opindex march
18755 Specify the name of the target architecture.
18757 @item -mforce-fp-as-gp
18758 @opindex mforce-fp-as-gp
18759 Prevent $fp being allocated during register allocation so that compiler
18760 is able to force performing fp-as-gp optimization.
18762 @item -mforbid-fp-as-gp
18763 @opindex mforbid-fp-as-gp
18764 Forbid using $fp to access static and global variables.
18765 This option strictly forbids fp-as-gp optimization
18766 regardless of @option{-mforce-fp-as-gp}.
18768 @item -mex9
18769 @opindex mex9
18770 Use special directives to guide linker doing ex9 optimization.
18772 @item -mctor-dtor
18773 @opindex mctor-dtor
18774 Enable constructor/destructor feature.
18776 @item -mrelax
18777 @opindex mrelax
18778 Guide linker to relax instructions.
18780 @end table
18782 @node Nios II Options
18783 @subsection Nios II Options
18784 @cindex Nios II options
18785 @cindex Altera Nios II options
18787 These are the options defined for the Altera Nios II processor.
18789 @table @gcctabopt
18791 @item -G @var{num}
18792 @opindex G
18793 @cindex smaller data references
18794 Put global and static objects less than or equal to @var{num} bytes
18795 into the small data or BSS sections instead of the normal data or BSS
18796 sections.  The default value of @var{num} is 8.
18798 @item -mgpopt
18799 @itemx -mno-gpopt
18800 @opindex mgpopt
18801 @opindex mno-gpopt
18802 Generate (do not generate) GP-relative accesses for objects in the
18803 small data or BSS sections.  The default is @option{-mgpopt} except
18804 when @option{-fpic} or @option{-fPIC} is specified to generate
18805 position-independent code.  Note that the Nios II ABI does not permit
18806 GP-relative accesses from shared libraries.
18808 You may need to specify @option{-mno-gpopt} explicitly when building
18809 programs that include large amounts of small data, including large
18810 GOT data sections.  In this case, the 16-bit offset for GP-relative
18811 addressing may not be large enough to allow access to the entire 
18812 small data section.
18814 @item -mel
18815 @itemx -meb
18816 @opindex mel
18817 @opindex meb
18818 Generate little-endian (default) or big-endian (experimental) code,
18819 respectively.
18821 @item -mbypass-cache
18822 @itemx -mno-bypass-cache
18823 @opindex mno-bypass-cache
18824 @opindex mbypass-cache
18825 Force all load and store instructions to always bypass cache by 
18826 using I/O variants of the instructions. The default is not to
18827 bypass the cache.
18829 @item -mno-cache-volatile 
18830 @itemx -mcache-volatile       
18831 @opindex mcache-volatile 
18832 @opindex mno-cache-volatile
18833 Volatile memory access bypass the cache using the I/O variants of 
18834 the load and store instructions. The default is not to bypass the cache.
18836 @item -mno-fast-sw-div
18837 @itemx -mfast-sw-div
18838 @opindex mno-fast-sw-div
18839 @opindex mfast-sw-div
18840 Do not use table-based fast divide for small numbers. The default 
18841 is to use the fast divide at @option{-O3} and above.
18843 @item -mno-hw-mul
18844 @itemx -mhw-mul
18845 @itemx -mno-hw-mulx
18846 @itemx -mhw-mulx
18847 @itemx -mno-hw-div
18848 @itemx -mhw-div
18849 @opindex mno-hw-mul
18850 @opindex mhw-mul
18851 @opindex mno-hw-mulx
18852 @opindex mhw-mulx
18853 @opindex mno-hw-div
18854 @opindex mhw-div
18855 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18856 instructions by the compiler. The default is to emit @code{mul}
18857 and not emit @code{div} and @code{mulx}.
18859 @item -mcustom-@var{insn}=@var{N}
18860 @itemx -mno-custom-@var{insn}
18861 @opindex mcustom-@var{insn}
18862 @opindex mno-custom-@var{insn}
18863 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18864 custom instruction with encoding @var{N} when generating code that uses 
18865 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
18866 instruction 253 for single-precision floating-point add operations instead
18867 of the default behavior of using a library call.
18869 The following values of @var{insn} are supported.  Except as otherwise
18870 noted, floating-point operations are expected to be implemented with
18871 normal IEEE 754 semantics and correspond directly to the C operators or the
18872 equivalent GCC built-in functions (@pxref{Other Builtins}).
18874 Single-precision floating point:
18875 @table @asis
18877 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18878 Binary arithmetic operations.
18880 @item @samp{fnegs}
18881 Unary negation.
18883 @item @samp{fabss}
18884 Unary absolute value.
18886 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18887 Comparison operations.
18889 @item @samp{fmins}, @samp{fmaxs}
18890 Floating-point minimum and maximum.  These instructions are only
18891 generated if @option{-ffinite-math-only} is specified.
18893 @item @samp{fsqrts}
18894 Unary square root operation.
18896 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18897 Floating-point trigonometric and exponential functions.  These instructions
18898 are only generated if @option{-funsafe-math-optimizations} is also specified.
18900 @end table
18902 Double-precision floating point:
18903 @table @asis
18905 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18906 Binary arithmetic operations.
18908 @item @samp{fnegd}
18909 Unary negation.
18911 @item @samp{fabsd}
18912 Unary absolute value.
18914 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18915 Comparison operations.
18917 @item @samp{fmind}, @samp{fmaxd}
18918 Double-precision minimum and maximum.  These instructions are only
18919 generated if @option{-ffinite-math-only} is specified.
18921 @item @samp{fsqrtd}
18922 Unary square root operation.
18924 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18925 Double-precision trigonometric and exponential functions.  These instructions
18926 are only generated if @option{-funsafe-math-optimizations} is also specified.
18928 @end table
18930 Conversions:
18931 @table @asis
18932 @item @samp{fextsd}
18933 Conversion from single precision to double precision.
18935 @item @samp{ftruncds}
18936 Conversion from double precision to single precision.
18938 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18939 Conversion from floating point to signed or unsigned integer types, with
18940 truncation towards zero.
18942 @item @samp{round}
18943 Conversion from single-precision floating point to signed integer,
18944 rounding to the nearest integer and ties away from zero.
18945 This corresponds to the @code{__builtin_lroundf} function when
18946 @option{-fno-math-errno} is used.
18948 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18949 Conversion from signed or unsigned integer types to floating-point types.
18951 @end table
18953 In addition, all of the following transfer instructions for internal
18954 registers X and Y must be provided to use any of the double-precision
18955 floating-point instructions.  Custom instructions taking two
18956 double-precision source operands expect the first operand in the
18957 64-bit register X.  The other operand (or only operand of a unary
18958 operation) is given to the custom arithmetic instruction with the
18959 least significant half in source register @var{src1} and the most
18960 significant half in @var{src2}.  A custom instruction that returns a
18961 double-precision result returns the most significant 32 bits in the
18962 destination register and the other half in 32-bit register Y.  
18963 GCC automatically generates the necessary code sequences to write
18964 register X and/or read register Y when double-precision floating-point
18965 instructions are used.
18967 @table @asis
18969 @item @samp{fwrx}
18970 Write @var{src1} into the least significant half of X and @var{src2} into
18971 the most significant half of X.
18973 @item @samp{fwry}
18974 Write @var{src1} into Y.
18976 @item @samp{frdxhi}, @samp{frdxlo}
18977 Read the most or least (respectively) significant half of X and store it in
18978 @var{dest}.
18980 @item @samp{frdy}
18981 Read the value of Y and store it into @var{dest}.
18982 @end table
18984 Note that you can gain more local control over generation of Nios II custom
18985 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18986 and @code{target("no-custom-@var{insn}")} function attributes
18987 (@pxref{Function Attributes})
18988 or pragmas (@pxref{Function Specific Option Pragmas}).
18990 @item -mcustom-fpu-cfg=@var{name}
18991 @opindex mcustom-fpu-cfg
18993 This option enables a predefined, named set of custom instruction encodings
18994 (see @option{-mcustom-@var{insn}} above).  
18995 Currently, the following sets are defined:
18997 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18998 @gccoptlist{-mcustom-fmuls=252 @gol
18999 -mcustom-fadds=253 @gol
19000 -mcustom-fsubs=254 @gol
19001 -fsingle-precision-constant}
19003 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
19004 @gccoptlist{-mcustom-fmuls=252 @gol
19005 -mcustom-fadds=253 @gol
19006 -mcustom-fsubs=254 @gol
19007 -mcustom-fdivs=255 @gol
19008 -fsingle-precision-constant}
19010 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
19011 @gccoptlist{-mcustom-floatus=243 @gol
19012 -mcustom-fixsi=244 @gol
19013 -mcustom-floatis=245 @gol
19014 -mcustom-fcmpgts=246 @gol
19015 -mcustom-fcmples=249 @gol
19016 -mcustom-fcmpeqs=250 @gol
19017 -mcustom-fcmpnes=251 @gol
19018 -mcustom-fmuls=252 @gol
19019 -mcustom-fadds=253 @gol
19020 -mcustom-fsubs=254 @gol
19021 -mcustom-fdivs=255 @gol
19022 -fsingle-precision-constant}
19024 Custom instruction assignments given by individual
19025 @option{-mcustom-@var{insn}=} options override those given by
19026 @option{-mcustom-fpu-cfg=}, regardless of the
19027 order of the options on the command line.
19029 Note that you can gain more local control over selection of a FPU
19030 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19031 function attribute (@pxref{Function Attributes})
19032 or pragma (@pxref{Function Specific Option Pragmas}).
19034 @end table
19036 These additional @samp{-m} options are available for the Altera Nios II
19037 ELF (bare-metal) target:
19039 @table @gcctabopt
19041 @item -mhal
19042 @opindex mhal
19043 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19044 startup and termination code, and is typically used in conjunction with
19045 @option{-msys-crt0=} to specify the location of the alternate startup code
19046 provided by the HAL BSP.
19048 @item -msmallc
19049 @opindex msmallc
19050 Link with a limited version of the C library, @option{-lsmallc}, rather than
19051 Newlib.
19053 @item -msys-crt0=@var{startfile}
19054 @opindex msys-crt0
19055 @var{startfile} is the file name of the startfile (crt0) to use 
19056 when linking.  This option is only useful in conjunction with @option{-mhal}.
19058 @item -msys-lib=@var{systemlib}
19059 @opindex msys-lib
19060 @var{systemlib} is the library name of the library that provides
19061 low-level system calls required by the C library,
19062 e.g. @code{read} and @code{write}.
19063 This option is typically used to link with a library provided by a HAL BSP.
19065 @end table
19067 @node PDP-11 Options
19068 @subsection PDP-11 Options
19069 @cindex PDP-11 Options
19071 These options are defined for the PDP-11:
19073 @table @gcctabopt
19074 @item -mfpu
19075 @opindex mfpu
19076 Use hardware FPP floating point.  This is the default.  (FIS floating
19077 point on the PDP-11/40 is not supported.)
19079 @item -msoft-float
19080 @opindex msoft-float
19081 Do not use hardware floating point.
19083 @item -mac0
19084 @opindex mac0
19085 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19087 @item -mno-ac0
19088 @opindex mno-ac0
19089 Return floating-point results in memory.  This is the default.
19091 @item -m40
19092 @opindex m40
19093 Generate code for a PDP-11/40.
19095 @item -m45
19096 @opindex m45
19097 Generate code for a PDP-11/45.  This is the default.
19099 @item -m10
19100 @opindex m10
19101 Generate code for a PDP-11/10.
19103 @item -mbcopy-builtin
19104 @opindex mbcopy-builtin
19105 Use inline @code{movmemhi} patterns for copying memory.  This is the
19106 default.
19108 @item -mbcopy
19109 @opindex mbcopy
19110 Do not use inline @code{movmemhi} patterns for copying memory.
19112 @item -mint16
19113 @itemx -mno-int32
19114 @opindex mint16
19115 @opindex mno-int32
19116 Use 16-bit @code{int}.  This is the default.
19118 @item -mint32
19119 @itemx -mno-int16
19120 @opindex mint32
19121 @opindex mno-int16
19122 Use 32-bit @code{int}.
19124 @item -mfloat64
19125 @itemx -mno-float32
19126 @opindex mfloat64
19127 @opindex mno-float32
19128 Use 64-bit @code{float}.  This is the default.
19130 @item -mfloat32
19131 @itemx -mno-float64
19132 @opindex mfloat32
19133 @opindex mno-float64
19134 Use 32-bit @code{float}.
19136 @item -mabshi
19137 @opindex mabshi
19138 Use @code{abshi2} pattern.  This is the default.
19140 @item -mno-abshi
19141 @opindex mno-abshi
19142 Do not use @code{abshi2} pattern.
19144 @item -mbranch-expensive
19145 @opindex mbranch-expensive
19146 Pretend that branches are expensive.  This is for experimenting with
19147 code generation only.
19149 @item -mbranch-cheap
19150 @opindex mbranch-cheap
19151 Do not pretend that branches are expensive.  This is the default.
19153 @item -munix-asm
19154 @opindex munix-asm
19155 Use Unix assembler syntax.  This is the default when configured for
19156 @samp{pdp11-*-bsd}.
19158 @item -mdec-asm
19159 @opindex mdec-asm
19160 Use DEC assembler syntax.  This is the default when configured for any
19161 PDP-11 target other than @samp{pdp11-*-bsd}.
19162 @end table
19164 @node picoChip Options
19165 @subsection picoChip Options
19166 @cindex picoChip options
19168 These @samp{-m} options are defined for picoChip implementations:
19170 @table @gcctabopt
19172 @item -mae=@var{ae_type}
19173 @opindex mcpu
19174 Set the instruction set, register set, and instruction scheduling
19175 parameters for array element type @var{ae_type}.  Supported values
19176 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19178 @option{-mae=ANY} selects a completely generic AE type.  Code
19179 generated with this option runs on any of the other AE types.  The
19180 code is not as efficient as it would be if compiled for a specific
19181 AE type, and some types of operation (e.g., multiplication) do not
19182 work properly on all types of AE.
19184 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19185 for compiled code, and is the default.
19187 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19188 option may suffer from poor performance of byte (char) manipulation,
19189 since the DSP AE does not provide hardware support for byte load/stores.
19191 @item -msymbol-as-address
19192 Enable the compiler to directly use a symbol name as an address in a
19193 load/store instruction, without first loading it into a
19194 register.  Typically, the use of this option generates larger
19195 programs, which run faster than when the option isn't used.  However, the
19196 results vary from program to program, so it is left as a user option,
19197 rather than being permanently enabled.
19199 @item -mno-inefficient-warnings
19200 Disables warnings about the generation of inefficient code.  These
19201 warnings can be generated, for example, when compiling code that
19202 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19203 no hardware support for byte-level memory operations, so all byte
19204 load/stores must be synthesized from word load/store operations.  This is
19205 inefficient and a warning is generated to indicate
19206 that you should rewrite the code to avoid byte operations, or to target
19207 an AE type that has the necessary hardware support.  This option disables
19208 these warnings.
19210 @end table
19212 @node PowerPC Options
19213 @subsection PowerPC Options
19214 @cindex PowerPC options
19216 These are listed under @xref{RS/6000 and PowerPC Options}.
19218 @node RL78 Options
19219 @subsection RL78 Options
19220 @cindex RL78 Options
19222 @table @gcctabopt
19224 @item -msim
19225 @opindex msim
19226 Links in additional target libraries to support operation within a
19227 simulator.
19229 @item -mmul=none
19230 @itemx -mmul=g13
19231 @itemx -mmul=rl78
19232 @opindex mmul
19233 Specifies the type of hardware multiplication support to be used.  The
19234 default is @code{none}, which uses software multiplication functions.
19235 The @code{g13} option is for the hardware multiply/divide peripheral
19236 only on the RL78/G13 targets.  The @code{rl78} option is for the
19237 standard hardware multiplication defined in the RL78 software manual.
19239 @item -m64bit-doubles
19240 @itemx -m32bit-doubles
19241 @opindex m64bit-doubles
19242 @opindex m32bit-doubles
19243 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19244 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19245 @option{-m32bit-doubles}.
19247 @end table
19249 @node RS/6000 and PowerPC Options
19250 @subsection IBM RS/6000 and PowerPC Options
19251 @cindex RS/6000 and PowerPC Options
19252 @cindex IBM RS/6000 and PowerPC Options
19254 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19255 @table @gcctabopt
19256 @item -mpowerpc-gpopt
19257 @itemx -mno-powerpc-gpopt
19258 @itemx -mpowerpc-gfxopt
19259 @itemx -mno-powerpc-gfxopt
19260 @need 800
19261 @itemx -mpowerpc64
19262 @itemx -mno-powerpc64
19263 @itemx -mmfcrf
19264 @itemx -mno-mfcrf
19265 @itemx -mpopcntb
19266 @itemx -mno-popcntb
19267 @itemx -mpopcntd
19268 @itemx -mno-popcntd
19269 @itemx -mfprnd
19270 @itemx -mno-fprnd
19271 @need 800
19272 @itemx -mcmpb
19273 @itemx -mno-cmpb
19274 @itemx -mmfpgpr
19275 @itemx -mno-mfpgpr
19276 @itemx -mhard-dfp
19277 @itemx -mno-hard-dfp
19278 @opindex mpowerpc-gpopt
19279 @opindex mno-powerpc-gpopt
19280 @opindex mpowerpc-gfxopt
19281 @opindex mno-powerpc-gfxopt
19282 @opindex mpowerpc64
19283 @opindex mno-powerpc64
19284 @opindex mmfcrf
19285 @opindex mno-mfcrf
19286 @opindex mpopcntb
19287 @opindex mno-popcntb
19288 @opindex mpopcntd
19289 @opindex mno-popcntd
19290 @opindex mfprnd
19291 @opindex mno-fprnd
19292 @opindex mcmpb
19293 @opindex mno-cmpb
19294 @opindex mmfpgpr
19295 @opindex mno-mfpgpr
19296 @opindex mhard-dfp
19297 @opindex mno-hard-dfp
19298 You use these options to specify which instructions are available on the
19299 processor you are using.  The default value of these options is
19300 determined when configuring GCC@.  Specifying the
19301 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19302 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19303 rather than the options listed above.
19305 Specifying @option{-mpowerpc-gpopt} allows
19306 GCC to use the optional PowerPC architecture instructions in the
19307 General Purpose group, including floating-point square root.  Specifying
19308 @option{-mpowerpc-gfxopt} allows GCC to
19309 use the optional PowerPC architecture instructions in the Graphics
19310 group, including floating-point select.
19312 The @option{-mmfcrf} option allows GCC to generate the move from
19313 condition register field instruction implemented on the POWER4
19314 processor and other processors that support the PowerPC V2.01
19315 architecture.
19316 The @option{-mpopcntb} option allows GCC to generate the popcount and
19317 double-precision FP reciprocal estimate instruction implemented on the
19318 POWER5 processor and other processors that support the PowerPC V2.02
19319 architecture.
19320 The @option{-mpopcntd} option allows GCC to generate the popcount
19321 instruction implemented on the POWER7 processor and other processors
19322 that support the PowerPC V2.06 architecture.
19323 The @option{-mfprnd} option allows GCC to generate the FP round to
19324 integer instructions implemented on the POWER5+ processor and other
19325 processors that support the PowerPC V2.03 architecture.
19326 The @option{-mcmpb} option allows GCC to generate the compare bytes
19327 instruction implemented on the POWER6 processor and other processors
19328 that support the PowerPC V2.05 architecture.
19329 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19330 general-purpose register instructions implemented on the POWER6X
19331 processor and other processors that support the extended PowerPC V2.05
19332 architecture.
19333 The @option{-mhard-dfp} option allows GCC to generate the decimal
19334 floating-point instructions implemented on some POWER processors.
19336 The @option{-mpowerpc64} option allows GCC to generate the additional
19337 64-bit instructions that are found in the full PowerPC64 architecture
19338 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19339 @option{-mno-powerpc64}.
19341 @item -mcpu=@var{cpu_type}
19342 @opindex mcpu
19343 Set architecture type, register usage, and
19344 instruction scheduling parameters for machine type @var{cpu_type}.
19345 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19346 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19347 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19348 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19349 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19350 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19351 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19352 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19353 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19354 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19355 @samp{powerpc64}, and @samp{rs64}.
19357 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19358 PowerPC and 64-bit PowerPC architecture machine
19359 types, with an appropriate, generic processor model assumed for
19360 scheduling purposes.
19362 The other options specify a specific processor.  Code generated under
19363 those options runs best on that processor, and may not run at all on
19364 others.
19366 The @option{-mcpu} options automatically enable or disable the
19367 following options:
19369 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19370 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19371 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19372 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19373 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19374 -mquad-memory -mquad-memory-atomic}
19376 The particular options set for any particular CPU varies between
19377 compiler versions, depending on what setting seems to produce optimal
19378 code for that CPU; it doesn't necessarily reflect the actual hardware's
19379 capabilities.  If you wish to set an individual option to a particular
19380 value, you may specify it after the @option{-mcpu} option, like
19381 @option{-mcpu=970 -mno-altivec}.
19383 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19384 not enabled or disabled by the @option{-mcpu} option at present because
19385 AIX does not have full support for these options.  You may still
19386 enable or disable them individually if you're sure it'll work in your
19387 environment.
19389 @item -mtune=@var{cpu_type}
19390 @opindex mtune
19391 Set the instruction scheduling parameters for machine type
19392 @var{cpu_type}, but do not set the architecture type or register usage,
19393 as @option{-mcpu=@var{cpu_type}} does.  The same
19394 values for @var{cpu_type} are used for @option{-mtune} as for
19395 @option{-mcpu}.  If both are specified, the code generated uses the
19396 architecture and registers set by @option{-mcpu}, but the
19397 scheduling parameters set by @option{-mtune}.
19399 @item -mcmodel=small
19400 @opindex mcmodel=small
19401 Generate PowerPC64 code for the small model: The TOC is limited to
19402 64k.
19404 @item -mcmodel=medium
19405 @opindex mcmodel=medium
19406 Generate PowerPC64 code for the medium model: The TOC and other static
19407 data may be up to a total of 4G in size.
19409 @item -mcmodel=large
19410 @opindex mcmodel=large
19411 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19412 in size.  Other data and code is only limited by the 64-bit address
19413 space.
19415 @item -maltivec
19416 @itemx -mno-altivec
19417 @opindex maltivec
19418 @opindex mno-altivec
19419 Generate code that uses (does not use) AltiVec instructions, and also
19420 enable the use of built-in functions that allow more direct access to
19421 the AltiVec instruction set.  You may also need to set
19422 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19423 enhancements.
19425 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19426 @option{-maltivec=be}, the element order for Altivec intrinsics such
19427 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19428 match array element order corresponding to the endianness of the
19429 target.  That is, element zero identifies the leftmost element in a
19430 vector register when targeting a big-endian platform, and identifies
19431 the rightmost element in a vector register when targeting a
19432 little-endian platform.
19434 @item -maltivec=be
19435 @opindex maltivec=be
19436 Generate Altivec instructions using big-endian element order,
19437 regardless of whether the target is big- or little-endian.  This is
19438 the default when targeting a big-endian platform.
19440 The element order is used to interpret element numbers in Altivec
19441 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19442 @code{vec_insert}.  By default, these will match array element order
19443 corresponding to the endianness for the target.
19445 @item -maltivec=le
19446 @opindex maltivec=le
19447 Generate Altivec instructions using little-endian element order,
19448 regardless of whether the target is big- or little-endian.  This is
19449 the default when targeting a little-endian platform.  This option is
19450 currently ignored when targeting a big-endian platform.
19452 The element order is used to interpret element numbers in Altivec
19453 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19454 @code{vec_insert}.  By default, these will match array element order
19455 corresponding to the endianness for the target.
19457 @item -mvrsave
19458 @itemx -mno-vrsave
19459 @opindex mvrsave
19460 @opindex mno-vrsave
19461 Generate VRSAVE instructions when generating AltiVec code.
19463 @item -mgen-cell-microcode
19464 @opindex mgen-cell-microcode
19465 Generate Cell microcode instructions.
19467 @item -mwarn-cell-microcode
19468 @opindex mwarn-cell-microcode
19469 Warn when a Cell microcode instruction is emitted.  An example
19470 of a Cell microcode instruction is a variable shift.
19472 @item -msecure-plt
19473 @opindex msecure-plt
19474 Generate code that allows @command{ld} and @command{ld.so}
19475 to build executables and shared
19476 libraries with non-executable @code{.plt} and @code{.got} sections.
19477 This is a PowerPC
19478 32-bit SYSV ABI option.
19480 @item -mbss-plt
19481 @opindex mbss-plt
19482 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19483 fills in, and
19484 requires @code{.plt} and @code{.got}
19485 sections that are both writable and executable.
19486 This is a PowerPC 32-bit SYSV ABI option.
19488 @item -misel
19489 @itemx -mno-isel
19490 @opindex misel
19491 @opindex mno-isel
19492 This switch enables or disables the generation of ISEL instructions.
19494 @item -misel=@var{yes/no}
19495 This switch has been deprecated.  Use @option{-misel} and
19496 @option{-mno-isel} instead.
19498 @item -mspe
19499 @itemx -mno-spe
19500 @opindex mspe
19501 @opindex mno-spe
19502 This switch enables or disables the generation of SPE simd
19503 instructions.
19505 @item -mpaired
19506 @itemx -mno-paired
19507 @opindex mpaired
19508 @opindex mno-paired
19509 This switch enables or disables the generation of PAIRED simd
19510 instructions.
19512 @item -mspe=@var{yes/no}
19513 This option has been deprecated.  Use @option{-mspe} and
19514 @option{-mno-spe} instead.
19516 @item -mvsx
19517 @itemx -mno-vsx
19518 @opindex mvsx
19519 @opindex mno-vsx
19520 Generate code that uses (does not use) vector/scalar (VSX)
19521 instructions, and also enable the use of built-in functions that allow
19522 more direct access to the VSX instruction set.
19524 @item -mcrypto
19525 @itemx -mno-crypto
19526 @opindex mcrypto
19527 @opindex mno-crypto
19528 Enable the use (disable) of the built-in functions that allow direct
19529 access to the cryptographic instructions that were added in version
19530 2.07 of the PowerPC ISA.
19532 @item -mdirect-move
19533 @itemx -mno-direct-move
19534 @opindex mdirect-move
19535 @opindex mno-direct-move
19536 Generate code that uses (does not use) the instructions to move data
19537 between the general purpose registers and the vector/scalar (VSX)
19538 registers that were added in version 2.07 of the PowerPC ISA.
19540 @item -mpower8-fusion
19541 @itemx -mno-power8-fusion
19542 @opindex mpower8-fusion
19543 @opindex mno-power8-fusion
19544 Generate code that keeps (does not keeps) some integer operations
19545 adjacent so that the instructions can be fused together on power8 and
19546 later processors.
19548 @item -mpower8-vector
19549 @itemx -mno-power8-vector
19550 @opindex mpower8-vector
19551 @opindex mno-power8-vector
19552 Generate code that uses (does not use) the vector and scalar
19553 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19554 enable the use of built-in functions that allow more direct access to
19555 the vector instructions.
19557 @item -mquad-memory
19558 @itemx -mno-quad-memory
19559 @opindex mquad-memory
19560 @opindex mno-quad-memory
19561 Generate code that uses (does not use) the non-atomic quad word memory
19562 instructions.  The @option{-mquad-memory} option requires use of
19563 64-bit mode.
19565 @item -mquad-memory-atomic
19566 @itemx -mno-quad-memory-atomic
19567 @opindex mquad-memory-atomic
19568 @opindex mno-quad-memory-atomic
19569 Generate code that uses (does not use) the atomic quad word memory
19570 instructions.  The @option{-mquad-memory-atomic} option requires use of
19571 64-bit mode.
19573 @item -mfloat-gprs=@var{yes/single/double/no}
19574 @itemx -mfloat-gprs
19575 @opindex mfloat-gprs
19576 This switch enables or disables the generation of floating-point
19577 operations on the general-purpose registers for architectures that
19578 support it.
19580 The argument @var{yes} or @var{single} enables the use of
19581 single-precision floating-point operations.
19583 The argument @var{double} enables the use of single and
19584 double-precision floating-point operations.
19586 The argument @var{no} disables floating-point operations on the
19587 general-purpose registers.
19589 This option is currently only available on the MPC854x.
19591 @item -m32
19592 @itemx -m64
19593 @opindex m32
19594 @opindex m64
19595 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19596 targets (including GNU/Linux).  The 32-bit environment sets int, long
19597 and pointer to 32 bits and generates code that runs on any PowerPC
19598 variant.  The 64-bit environment sets int to 32 bits and long and
19599 pointer to 64 bits, and generates code for PowerPC64, as for
19600 @option{-mpowerpc64}.
19602 @item -mfull-toc
19603 @itemx -mno-fp-in-toc
19604 @itemx -mno-sum-in-toc
19605 @itemx -mminimal-toc
19606 @opindex mfull-toc
19607 @opindex mno-fp-in-toc
19608 @opindex mno-sum-in-toc
19609 @opindex mminimal-toc
19610 Modify generation of the TOC (Table Of Contents), which is created for
19611 every executable file.  The @option{-mfull-toc} option is selected by
19612 default.  In that case, GCC allocates at least one TOC entry for
19613 each unique non-automatic variable reference in your program.  GCC
19614 also places floating-point constants in the TOC@.  However, only
19615 16,384 entries are available in the TOC@.
19617 If you receive a linker error message that saying you have overflowed
19618 the available TOC space, you can reduce the amount of TOC space used
19619 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19620 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19621 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19622 generate code to calculate the sum of an address and a constant at
19623 run time instead of putting that sum into the TOC@.  You may specify one
19624 or both of these options.  Each causes GCC to produce very slightly
19625 slower and larger code at the expense of conserving TOC space.
19627 If you still run out of space in the TOC even when you specify both of
19628 these options, specify @option{-mminimal-toc} instead.  This option causes
19629 GCC to make only one TOC entry for every file.  When you specify this
19630 option, GCC produces code that is slower and larger but which
19631 uses extremely little TOC space.  You may wish to use this option
19632 only on files that contain less frequently-executed code.
19634 @item -maix64
19635 @itemx -maix32
19636 @opindex maix64
19637 @opindex maix32
19638 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19639 @code{long} type, and the infrastructure needed to support them.
19640 Specifying @option{-maix64} implies @option{-mpowerpc64},
19641 while @option{-maix32} disables the 64-bit ABI and
19642 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19644 @item -mxl-compat
19645 @itemx -mno-xl-compat
19646 @opindex mxl-compat
19647 @opindex mno-xl-compat
19648 Produce code that conforms more closely to IBM XL compiler semantics
19649 when using AIX-compatible ABI@.  Pass floating-point arguments to
19650 prototyped functions beyond the register save area (RSA) on the stack
19651 in addition to argument FPRs.  Do not assume that most significant
19652 double in 128-bit long double value is properly rounded when comparing
19653 values and converting to double.  Use XL symbol names for long double
19654 support routines.
19656 The AIX calling convention was extended but not initially documented to
19657 handle an obscure K&R C case of calling a function that takes the
19658 address of its arguments with fewer arguments than declared.  IBM XL
19659 compilers access floating-point arguments that do not fit in the
19660 RSA from the stack when a subroutine is compiled without
19661 optimization.  Because always storing floating-point arguments on the
19662 stack is inefficient and rarely needed, this option is not enabled by
19663 default and only is necessary when calling subroutines compiled by IBM
19664 XL compilers without optimization.
19666 @item -mpe
19667 @opindex mpe
19668 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19669 application written to use message passing with special startup code to
19670 enable the application to run.  The system must have PE installed in the
19671 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19672 must be overridden with the @option{-specs=} option to specify the
19673 appropriate directory location.  The Parallel Environment does not
19674 support threads, so the @option{-mpe} option and the @option{-pthread}
19675 option are incompatible.
19677 @item -malign-natural
19678 @itemx -malign-power
19679 @opindex malign-natural
19680 @opindex malign-power
19681 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19682 @option{-malign-natural} overrides the ABI-defined alignment of larger
19683 types, such as floating-point doubles, on their natural size-based boundary.
19684 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19685 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19687 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19688 is not supported.
19690 @item -msoft-float
19691 @itemx -mhard-float
19692 @opindex msoft-float
19693 @opindex mhard-float
19694 Generate code that does not use (uses) the floating-point register set.
19695 Software floating-point emulation is provided if you use the
19696 @option{-msoft-float} option, and pass the option to GCC when linking.
19698 @item -msingle-float
19699 @itemx -mdouble-float
19700 @opindex msingle-float
19701 @opindex mdouble-float
19702 Generate code for single- or double-precision floating-point operations.
19703 @option{-mdouble-float} implies @option{-msingle-float}.
19705 @item -msimple-fpu
19706 @opindex msimple-fpu
19707 Do not generate @code{sqrt} and @code{div} instructions for hardware
19708 floating-point unit.
19710 @item -mfpu=@var{name}
19711 @opindex mfpu
19712 Specify type of floating-point unit.  Valid values for @var{name} are
19713 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19714 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19715 @samp{sp_full} (equivalent to @option{-msingle-float}),
19716 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19718 @item -mxilinx-fpu
19719 @opindex mxilinx-fpu
19720 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19722 @item -mmultiple
19723 @itemx -mno-multiple
19724 @opindex mmultiple
19725 @opindex mno-multiple
19726 Generate code that uses (does not use) the load multiple word
19727 instructions and the store multiple word instructions.  These
19728 instructions are generated by default on POWER systems, and not
19729 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19730 PowerPC systems, since those instructions do not work when the
19731 processor is in little-endian mode.  The exceptions are PPC740 and
19732 PPC750 which permit these instructions in little-endian mode.
19734 @item -mstring
19735 @itemx -mno-string
19736 @opindex mstring
19737 @opindex mno-string
19738 Generate code that uses (does not use) the load string instructions
19739 and the store string word instructions to save multiple registers and
19740 do small block moves.  These instructions are generated by default on
19741 POWER systems, and not generated on PowerPC systems.  Do not use
19742 @option{-mstring} on little-endian PowerPC systems, since those
19743 instructions do not work when the processor is in little-endian mode.
19744 The exceptions are PPC740 and PPC750 which permit these instructions
19745 in little-endian mode.
19747 @item -mupdate
19748 @itemx -mno-update
19749 @opindex mupdate
19750 @opindex mno-update
19751 Generate code that uses (does not use) the load or store instructions
19752 that update the base register to the address of the calculated memory
19753 location.  These instructions are generated by default.  If you use
19754 @option{-mno-update}, there is a small window between the time that the
19755 stack pointer is updated and the address of the previous frame is
19756 stored, which means code that walks the stack frame across interrupts or
19757 signals may get corrupted data.
19759 @item -mavoid-indexed-addresses
19760 @itemx -mno-avoid-indexed-addresses
19761 @opindex mavoid-indexed-addresses
19762 @opindex mno-avoid-indexed-addresses
19763 Generate code that tries to avoid (not avoid) the use of indexed load
19764 or store instructions. These instructions can incur a performance
19765 penalty on Power6 processors in certain situations, such as when
19766 stepping through large arrays that cross a 16M boundary.  This option
19767 is enabled by default when targeting Power6 and disabled otherwise.
19769 @item -mfused-madd
19770 @itemx -mno-fused-madd
19771 @opindex mfused-madd
19772 @opindex mno-fused-madd
19773 Generate code that uses (does not use) the floating-point multiply and
19774 accumulate instructions.  These instructions are generated by default
19775 if hardware floating point is used.  The machine-dependent
19776 @option{-mfused-madd} option is now mapped to the machine-independent
19777 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19778 mapped to @option{-ffp-contract=off}.
19780 @item -mmulhw
19781 @itemx -mno-mulhw
19782 @opindex mmulhw
19783 @opindex mno-mulhw
19784 Generate code that uses (does not use) the half-word multiply and
19785 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19786 These instructions are generated by default when targeting those
19787 processors.
19789 @item -mdlmzb
19790 @itemx -mno-dlmzb
19791 @opindex mdlmzb
19792 @opindex mno-dlmzb
19793 Generate code that uses (does not use) the string-search @samp{dlmzb}
19794 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19795 generated by default when targeting those processors.
19797 @item -mno-bit-align
19798 @itemx -mbit-align
19799 @opindex mno-bit-align
19800 @opindex mbit-align
19801 On System V.4 and embedded PowerPC systems do not (do) force structures
19802 and unions that contain bit-fields to be aligned to the base type of the
19803 bit-field.
19805 For example, by default a structure containing nothing but 8
19806 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19807 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19808 the structure is aligned to a 1-byte boundary and is 1 byte in
19809 size.
19811 @item -mno-strict-align
19812 @itemx -mstrict-align
19813 @opindex mno-strict-align
19814 @opindex mstrict-align
19815 On System V.4 and embedded PowerPC systems do not (do) assume that
19816 unaligned memory references are handled by the system.
19818 @item -mrelocatable
19819 @itemx -mno-relocatable
19820 @opindex mrelocatable
19821 @opindex mno-relocatable
19822 Generate code that allows (does not allow) a static executable to be
19823 relocated to a different address at run time.  A simple embedded
19824 PowerPC system loader should relocate the entire contents of
19825 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19826 a table of 32-bit addresses generated by this option.  For this to
19827 work, all objects linked together must be compiled with
19828 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19829 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19831 @item -mrelocatable-lib
19832 @itemx -mno-relocatable-lib
19833 @opindex mrelocatable-lib
19834 @opindex mno-relocatable-lib
19835 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19836 @code{.fixup} section to allow static executables to be relocated at
19837 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19838 alignment of @option{-mrelocatable}.  Objects compiled with
19839 @option{-mrelocatable-lib} may be linked with objects compiled with
19840 any combination of the @option{-mrelocatable} options.
19842 @item -mno-toc
19843 @itemx -mtoc
19844 @opindex mno-toc
19845 @opindex mtoc
19846 On System V.4 and embedded PowerPC systems do not (do) assume that
19847 register 2 contains a pointer to a global area pointing to the addresses
19848 used in the program.
19850 @item -mlittle
19851 @itemx -mlittle-endian
19852 @opindex mlittle
19853 @opindex mlittle-endian
19854 On System V.4 and embedded PowerPC systems compile code for the
19855 processor in little-endian mode.  The @option{-mlittle-endian} option is
19856 the same as @option{-mlittle}.
19858 @item -mbig
19859 @itemx -mbig-endian
19860 @opindex mbig
19861 @opindex mbig-endian
19862 On System V.4 and embedded PowerPC systems compile code for the
19863 processor in big-endian mode.  The @option{-mbig-endian} option is
19864 the same as @option{-mbig}.
19866 @item -mdynamic-no-pic
19867 @opindex mdynamic-no-pic
19868 On Darwin and Mac OS X systems, compile code so that it is not
19869 relocatable, but that its external references are relocatable.  The
19870 resulting code is suitable for applications, but not shared
19871 libraries.
19873 @item -msingle-pic-base
19874 @opindex msingle-pic-base
19875 Treat the register used for PIC addressing as read-only, rather than
19876 loading it in the prologue for each function.  The runtime system is
19877 responsible for initializing this register with an appropriate value
19878 before execution begins.
19880 @item -mprioritize-restricted-insns=@var{priority}
19881 @opindex mprioritize-restricted-insns
19882 This option controls the priority that is assigned to
19883 dispatch-slot restricted instructions during the second scheduling
19884 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19885 or @samp{2} to assign no, highest, or second-highest (respectively) 
19886 priority to dispatch-slot restricted
19887 instructions.
19889 @item -msched-costly-dep=@var{dependence_type}
19890 @opindex msched-costly-dep
19891 This option controls which dependences are considered costly
19892 by the target during instruction scheduling.  The argument
19893 @var{dependence_type} takes one of the following values:
19895 @table @asis
19896 @item @samp{no}
19897 No dependence is costly.
19899 @item @samp{all}
19900 All dependences are costly.
19902 @item @samp{true_store_to_load}
19903 A true dependence from store to load is costly.
19905 @item @samp{store_to_load}
19906 Any dependence from store to load is costly.
19908 @item @var{number}
19909 Any dependence for which the latency is greater than or equal to 
19910 @var{number} is costly.
19911 @end table
19913 @item -minsert-sched-nops=@var{scheme}
19914 @opindex minsert-sched-nops
19915 This option controls which NOP insertion scheme is used during
19916 the second scheduling pass.  The argument @var{scheme} takes one of the
19917 following values:
19919 @table @asis
19920 @item @samp{no}
19921 Don't insert NOPs.
19923 @item @samp{pad}
19924 Pad with NOPs any dispatch group that has vacant issue slots,
19925 according to the scheduler's grouping.
19927 @item @samp{regroup_exact}
19928 Insert NOPs to force costly dependent insns into
19929 separate groups.  Insert exactly as many NOPs as needed to force an insn
19930 to a new group, according to the estimated processor grouping.
19932 @item @var{number}
19933 Insert NOPs to force costly dependent insns into
19934 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19935 @end table
19937 @item -mcall-sysv
19938 @opindex mcall-sysv
19939 On System V.4 and embedded PowerPC systems compile code using calling
19940 conventions that adhere to the March 1995 draft of the System V
19941 Application Binary Interface, PowerPC processor supplement.  This is the
19942 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19944 @item -mcall-sysv-eabi
19945 @itemx -mcall-eabi
19946 @opindex mcall-sysv-eabi
19947 @opindex mcall-eabi
19948 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19950 @item -mcall-sysv-noeabi
19951 @opindex mcall-sysv-noeabi
19952 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19954 @item -mcall-aixdesc
19955 @opindex m
19956 On System V.4 and embedded PowerPC systems compile code for the AIX
19957 operating system.
19959 @item -mcall-linux
19960 @opindex mcall-linux
19961 On System V.4 and embedded PowerPC systems compile code for the
19962 Linux-based GNU system.
19964 @item -mcall-freebsd
19965 @opindex mcall-freebsd
19966 On System V.4 and embedded PowerPC systems compile code for the
19967 FreeBSD operating system.
19969 @item -mcall-netbsd
19970 @opindex mcall-netbsd
19971 On System V.4 and embedded PowerPC systems compile code for the
19972 NetBSD operating system.
19974 @item -mcall-openbsd
19975 @opindex mcall-netbsd
19976 On System V.4 and embedded PowerPC systems compile code for the
19977 OpenBSD operating system.
19979 @item -maix-struct-return
19980 @opindex maix-struct-return
19981 Return all structures in memory (as specified by the AIX ABI)@.
19983 @item -msvr4-struct-return
19984 @opindex msvr4-struct-return
19985 Return structures smaller than 8 bytes in registers (as specified by the
19986 SVR4 ABI)@.
19988 @item -mabi=@var{abi-type}
19989 @opindex mabi
19990 Extend the current ABI with a particular extension, or remove such extension.
19991 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
19992 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
19993 @var{elfv1}, @var{elfv2}@.
19995 @item -mabi=spe
19996 @opindex mabi=spe
19997 Extend the current ABI with SPE ABI extensions.  This does not change
19998 the default ABI, instead it adds the SPE ABI extensions to the current
19999 ABI@.
20001 @item -mabi=no-spe
20002 @opindex mabi=no-spe
20003 Disable Book-E SPE ABI extensions for the current ABI@.
20005 @item -mabi=ibmlongdouble
20006 @opindex mabi=ibmlongdouble
20007 Change the current ABI to use IBM extended-precision long double.
20008 This is a PowerPC 32-bit SYSV ABI option.
20010 @item -mabi=ieeelongdouble
20011 @opindex mabi=ieeelongdouble
20012 Change the current ABI to use IEEE extended-precision long double.
20013 This is a PowerPC 32-bit Linux ABI option.
20015 @item -mabi=elfv1
20016 @opindex mabi=elfv1
20017 Change the current ABI to use the ELFv1 ABI.
20018 This is the default ABI for big-endian PowerPC 64-bit Linux.
20019 Overriding the default ABI requires special system support and is
20020 likely to fail in spectacular ways.
20022 @item -mabi=elfv2
20023 @opindex mabi=elfv2
20024 Change the current ABI to use the ELFv2 ABI.
20025 This is the default ABI for little-endian PowerPC 64-bit Linux.
20026 Overriding the default ABI requires special system support and is
20027 likely to fail in spectacular ways.
20029 @item -mprototype
20030 @itemx -mno-prototype
20031 @opindex mprototype
20032 @opindex mno-prototype
20033 On System V.4 and embedded PowerPC systems assume that all calls to
20034 variable argument functions are properly prototyped.  Otherwise, the
20035 compiler must insert an instruction before every non-prototyped call to
20036 set or clear bit 6 of the condition code register (@var{CR}) to
20037 indicate whether floating-point values are passed in the floating-point
20038 registers in case the function takes variable arguments.  With
20039 @option{-mprototype}, only calls to prototyped variable argument functions
20040 set or clear the bit.
20042 @item -msim
20043 @opindex msim
20044 On embedded PowerPC systems, assume that the startup module is called
20045 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20046 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20047 configurations.
20049 @item -mmvme
20050 @opindex mmvme
20051 On embedded PowerPC systems, assume that the startup module is called
20052 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20053 @file{libc.a}.
20055 @item -mads
20056 @opindex mads
20057 On embedded PowerPC systems, assume that the startup module is called
20058 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20059 @file{libc.a}.
20061 @item -myellowknife
20062 @opindex myellowknife
20063 On embedded PowerPC systems, assume that the startup module is called
20064 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20065 @file{libc.a}.
20067 @item -mvxworks
20068 @opindex mvxworks
20069 On System V.4 and embedded PowerPC systems, specify that you are
20070 compiling for a VxWorks system.
20072 @item -memb
20073 @opindex memb
20074 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
20075 header to indicate that @samp{eabi} extended relocations are used.
20077 @item -meabi
20078 @itemx -mno-eabi
20079 @opindex meabi
20080 @opindex mno-eabi
20081 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20082 Embedded Applications Binary Interface (EABI), which is a set of
20083 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20084 means that the stack is aligned to an 8-byte boundary, a function
20085 @code{__eabi} is called from @code{main} to set up the EABI
20086 environment, and the @option{-msdata} option can use both @code{r2} and
20087 @code{r13} to point to two separate small data areas.  Selecting
20088 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20089 no EABI initialization function is called from @code{main}, and the
20090 @option{-msdata} option only uses @code{r13} to point to a single
20091 small data area.  The @option{-meabi} option is on by default if you
20092 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20094 @item -msdata=eabi
20095 @opindex msdata=eabi
20096 On System V.4 and embedded PowerPC systems, put small initialized
20097 @code{const} global and static data in the @samp{.sdata2} section, which
20098 is pointed to by register @code{r2}.  Put small initialized
20099 non-@code{const} global and static data in the @samp{.sdata} section,
20100 which is pointed to by register @code{r13}.  Put small uninitialized
20101 global and static data in the @samp{.sbss} section, which is adjacent to
20102 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
20103 incompatible with the @option{-mrelocatable} option.  The
20104 @option{-msdata=eabi} option also sets the @option{-memb} option.
20106 @item -msdata=sysv
20107 @opindex msdata=sysv
20108 On System V.4 and embedded PowerPC systems, put small global and static
20109 data in the @samp{.sdata} section, which is pointed to by register
20110 @code{r13}.  Put small uninitialized global and static data in the
20111 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
20112 The @option{-msdata=sysv} option is incompatible with the
20113 @option{-mrelocatable} option.
20115 @item -msdata=default
20116 @itemx -msdata
20117 @opindex msdata=default
20118 @opindex msdata
20119 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20120 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20121 same as @option{-msdata=sysv}.
20123 @item -msdata=data
20124 @opindex msdata=data
20125 On System V.4 and embedded PowerPC systems, put small global
20126 data in the @samp{.sdata} section.  Put small uninitialized global
20127 data in the @samp{.sbss} section.  Do not use register @code{r13}
20128 to address small data however.  This is the default behavior unless
20129 other @option{-msdata} options are used.
20131 @item -msdata=none
20132 @itemx -mno-sdata
20133 @opindex msdata=none
20134 @opindex mno-sdata
20135 On embedded PowerPC systems, put all initialized global and static data
20136 in the @samp{.data} section, and all uninitialized data in the
20137 @samp{.bss} section.
20139 @item -mblock-move-inline-limit=@var{num}
20140 @opindex mblock-move-inline-limit
20141 Inline all block moves (such as calls to @code{memcpy} or structure
20142 copies) less than or equal to @var{num} bytes.  The minimum value for
20143 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20144 targets.  The default value is target-specific.
20146 @item -G @var{num}
20147 @opindex G
20148 @cindex smaller data references (PowerPC)
20149 @cindex .sdata/.sdata2 references (PowerPC)
20150 On embedded PowerPC systems, put global and static items less than or
20151 equal to @var{num} bytes into the small data or BSS sections instead of
20152 the normal data or BSS section.  By default, @var{num} is 8.  The
20153 @option{-G @var{num}} switch is also passed to the linker.
20154 All modules should be compiled with the same @option{-G @var{num}} value.
20156 @item -mregnames
20157 @itemx -mno-regnames
20158 @opindex mregnames
20159 @opindex mno-regnames
20160 On System V.4 and embedded PowerPC systems do (do not) emit register
20161 names in the assembly language output using symbolic forms.
20163 @item -mlongcall
20164 @itemx -mno-longcall
20165 @opindex mlongcall
20166 @opindex mno-longcall
20167 By default assume that all calls are far away so that a longer and more
20168 expensive calling sequence is required.  This is required for calls
20169 farther than 32 megabytes (33,554,432 bytes) from the current location.
20170 A short call is generated if the compiler knows
20171 the call cannot be that far away.  This setting can be overridden by
20172 the @code{shortcall} function attribute, or by @code{#pragma
20173 longcall(0)}.
20175 Some linkers are capable of detecting out-of-range calls and generating
20176 glue code on the fly.  On these systems, long calls are unnecessary and
20177 generate slower code.  As of this writing, the AIX linker can do this,
20178 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20179 to the GNU linker for 32-bit PowerPC systems as well.
20181 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20182 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20183 addresses represent the callee and the branch island.  The
20184 Darwin/PPC linker prefers the first address and generates a @code{bl
20185 callee} if the PPC @code{bl} instruction reaches the callee directly;
20186 otherwise, the linker generates @code{bl L42} to call the branch
20187 island.  The branch island is appended to the body of the
20188 calling function; it computes the full 32-bit address of the callee
20189 and jumps to it.
20191 On Mach-O (Darwin) systems, this option directs the compiler emit to
20192 the glue for every direct call, and the Darwin linker decides whether
20193 to use or discard it.
20195 In the future, GCC may ignore all longcall specifications
20196 when the linker is known to generate glue.
20198 @item -mtls-markers
20199 @itemx -mno-tls-markers
20200 @opindex mtls-markers
20201 @opindex mno-tls-markers
20202 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20203 specifying the function argument.  The relocation allows the linker to
20204 reliably associate function call with argument setup instructions for
20205 TLS optimization, which in turn allows GCC to better schedule the
20206 sequence.
20208 @item -pthread
20209 @opindex pthread
20210 Adds support for multithreading with the @dfn{pthreads} library.
20211 This option sets flags for both the preprocessor and linker.
20213 @item -mrecip
20214 @itemx -mno-recip
20215 @opindex mrecip
20216 This option enables use of the reciprocal estimate and
20217 reciprocal square root estimate instructions with additional
20218 Newton-Raphson steps to increase precision instead of doing a divide or
20219 square root and divide for floating-point arguments.  You should use
20220 the @option{-ffast-math} option when using @option{-mrecip} (or at
20221 least @option{-funsafe-math-optimizations},
20222 @option{-finite-math-only}, @option{-freciprocal-math} and
20223 @option{-fno-trapping-math}).  Note that while the throughput of the
20224 sequence is generally higher than the throughput of the non-reciprocal
20225 instruction, the precision of the sequence can be decreased by up to 2
20226 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20227 roots.
20229 @item -mrecip=@var{opt}
20230 @opindex mrecip=opt
20231 This option controls which reciprocal estimate instructions
20232 may be used.  @var{opt} is a comma-separated list of options, which may
20233 be preceded by a @code{!} to invert the option:
20234 @code{all}: enable all estimate instructions,
20235 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
20236 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
20237 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
20238 @code{divf}: enable the single-precision reciprocal approximation instructions;
20239 @code{divd}: enable the double-precision reciprocal approximation instructions;
20240 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
20241 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
20242 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
20244 So, for example, @option{-mrecip=all,!rsqrtd} enables
20245 all of the reciprocal estimate instructions, except for the
20246 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20247 which handle the double-precision reciprocal square root calculations.
20249 @item -mrecip-precision
20250 @itemx -mno-recip-precision
20251 @opindex mrecip-precision
20252 Assume (do not assume) that the reciprocal estimate instructions
20253 provide higher-precision estimates than is mandated by the PowerPC
20254 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20255 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20256 The double-precision square root estimate instructions are not generated by
20257 default on low-precision machines, since they do not provide an
20258 estimate that converges after three steps.
20260 @item -mveclibabi=@var{type}
20261 @opindex mveclibabi
20262 Specifies the ABI type to use for vectorizing intrinsics using an
20263 external library.  The only type supported at present is @code{mass},
20264 which specifies to use IBM's Mathematical Acceleration Subsystem
20265 (MASS) libraries for vectorizing intrinsics using external libraries.
20266 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20267 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20268 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20269 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20270 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20271 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20272 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20273 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20274 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20275 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20276 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20277 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20278 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20279 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20280 for power7.  Both @option{-ftree-vectorize} and
20281 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20282 libraries must be specified at link time.
20284 @item -mfriz
20285 @itemx -mno-friz
20286 @opindex mfriz
20287 Generate (do not generate) the @code{friz} instruction when the
20288 @option{-funsafe-math-optimizations} option is used to optimize
20289 rounding of floating-point values to 64-bit integer and back to floating
20290 point.  The @code{friz} instruction does not return the same value if
20291 the floating-point number is too large to fit in an integer.
20293 @item -mpointers-to-nested-functions
20294 @itemx -mno-pointers-to-nested-functions
20295 @opindex mpointers-to-nested-functions
20296 Generate (do not generate) code to load up the static chain register
20297 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20298 systems where a function pointer points to a 3-word descriptor giving
20299 the function address, TOC value to be loaded in register @var{r2}, and
20300 static chain value to be loaded in register @var{r11}.  The
20301 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20302 call through pointers to nested functions or pointers
20303 to functions compiled in other languages that use the static chain if
20304 you use the @option{-mno-pointers-to-nested-functions}.
20306 @item -msave-toc-indirect
20307 @itemx -mno-save-toc-indirect
20308 @opindex msave-toc-indirect
20309 Generate (do not generate) code to save the TOC value in the reserved
20310 stack location in the function prologue if the function calls through
20311 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20312 saved in the prologue, it is saved just before the call through the
20313 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20315 @item -mcompat-align-parm
20316 @itemx -mno-compat-align-parm
20317 @opindex mcompat-align-parm
20318 Generate (do not generate) code to pass structure parameters with a
20319 maximum alignment of 64 bits, for compatibility with older versions
20320 of GCC.
20322 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20323 structure parameter on a 128-bit boundary when that structure contained
20324 a member requiring 128-bit alignment.  This is corrected in more
20325 recent versions of GCC.  This option may be used to generate code
20326 that is compatible with functions compiled with older versions of
20327 GCC.
20329 The @option{-mno-compat-align-parm} option is the default.
20330 @end table
20332 @node RX Options
20333 @subsection RX Options
20334 @cindex RX Options
20336 These command-line options are defined for RX targets:
20338 @table @gcctabopt
20339 @item -m64bit-doubles
20340 @itemx -m32bit-doubles
20341 @opindex m64bit-doubles
20342 @opindex m32bit-doubles
20343 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20344 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20345 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20346 works on 32-bit values, which is why the default is
20347 @option{-m32bit-doubles}.
20349 @item -fpu
20350 @itemx -nofpu
20351 @opindex fpu
20352 @opindex nofpu
20353 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20354 floating-point hardware.  The default is enabled for the @var{RX600}
20355 series and disabled for the @var{RX200} series.
20357 Floating-point instructions are only generated for 32-bit floating-point 
20358 values, however, so the FPU hardware is not used for doubles if the
20359 @option{-m64bit-doubles} option is used.
20361 @emph{Note} If the @option{-fpu} option is enabled then
20362 @option{-funsafe-math-optimizations} is also enabled automatically.
20363 This is because the RX FPU instructions are themselves unsafe.
20365 @item -mcpu=@var{name}
20366 @opindex -mcpu
20367 Selects the type of RX CPU to be targeted.  Currently three types are
20368 supported, the generic @var{RX600} and @var{RX200} series hardware and
20369 the specific @var{RX610} CPU.  The default is @var{RX600}.
20371 The only difference between @var{RX600} and @var{RX610} is that the
20372 @var{RX610} does not support the @code{MVTIPL} instruction.
20374 The @var{RX200} series does not have a hardware floating-point unit
20375 and so @option{-nofpu} is enabled by default when this type is
20376 selected.
20378 @item -mbig-endian-data
20379 @itemx -mlittle-endian-data
20380 @opindex mbig-endian-data
20381 @opindex mlittle-endian-data
20382 Store data (but not code) in the big-endian format.  The default is
20383 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20384 format.
20386 @item -msmall-data-limit=@var{N}
20387 @opindex msmall-data-limit
20388 Specifies the maximum size in bytes of global and static variables
20389 which can be placed into the small data area.  Using the small data
20390 area can lead to smaller and faster code, but the size of area is
20391 limited and it is up to the programmer to ensure that the area does
20392 not overflow.  Also when the small data area is used one of the RX's
20393 registers (usually @code{r13}) is reserved for use pointing to this
20394 area, so it is no longer available for use by the compiler.  This
20395 could result in slower and/or larger code if variables are pushed onto
20396 the stack instead of being held in this register.
20398 Note, common variables (variables that have not been initialized) and
20399 constants are not placed into the small data area as they are assigned
20400 to other sections in the output executable.
20402 The default value is zero, which disables this feature.  Note, this
20403 feature is not enabled by default with higher optimization levels
20404 (@option{-O2} etc) because of the potentially detrimental effects of
20405 reserving a register.  It is up to the programmer to experiment and
20406 discover whether this feature is of benefit to their program.  See the
20407 description of the @option{-mpid} option for a description of how the
20408 actual register to hold the small data area pointer is chosen.
20410 @item -msim
20411 @itemx -mno-sim
20412 @opindex msim
20413 @opindex mno-sim
20414 Use the simulator runtime.  The default is to use the libgloss
20415 board-specific runtime.
20417 @item -mas100-syntax
20418 @itemx -mno-as100-syntax
20419 @opindex mas100-syntax
20420 @opindex mno-as100-syntax
20421 When generating assembler output use a syntax that is compatible with
20422 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20423 assembler, but it has some restrictions so it is not generated by default.
20425 @item -mmax-constant-size=@var{N}
20426 @opindex mmax-constant-size
20427 Specifies the maximum size, in bytes, of a constant that can be used as
20428 an operand in a RX instruction.  Although the RX instruction set does
20429 allow constants of up to 4 bytes in length to be used in instructions,
20430 a longer value equates to a longer instruction.  Thus in some
20431 circumstances it can be beneficial to restrict the size of constants
20432 that are used in instructions.  Constants that are too big are instead
20433 placed into a constant pool and referenced via register indirection.
20435 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20436 or 4 means that constants of any size are allowed.
20438 @item -mrelax
20439 @opindex mrelax
20440 Enable linker relaxation.  Linker relaxation is a process whereby the
20441 linker attempts to reduce the size of a program by finding shorter
20442 versions of various instructions.  Disabled by default.
20444 @item -mint-register=@var{N}
20445 @opindex mint-register
20446 Specify the number of registers to reserve for fast interrupt handler
20447 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20448 means that register @code{r13} is reserved for the exclusive use
20449 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20450 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20451 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20452 A value of 0, the default, does not reserve any registers.
20454 @item -msave-acc-in-interrupts
20455 @opindex msave-acc-in-interrupts
20456 Specifies that interrupt handler functions should preserve the
20457 accumulator register.  This is only necessary if normal code might use
20458 the accumulator register, for example because it performs 64-bit
20459 multiplications.  The default is to ignore the accumulator as this
20460 makes the interrupt handlers faster.
20462 @item -mpid
20463 @itemx -mno-pid
20464 @opindex mpid
20465 @opindex mno-pid
20466 Enables the generation of position independent data.  When enabled any
20467 access to constant data is done via an offset from a base address
20468 held in a register.  This allows the location of constant data to be
20469 determined at run time without requiring the executable to be
20470 relocated, which is a benefit to embedded applications with tight
20471 memory constraints.  Data that can be modified is not affected by this
20472 option.
20474 Note, using this feature reserves a register, usually @code{r13}, for
20475 the constant data base address.  This can result in slower and/or
20476 larger code, especially in complicated functions.
20478 The actual register chosen to hold the constant data base address
20479 depends upon whether the @option{-msmall-data-limit} and/or the
20480 @option{-mint-register} command-line options are enabled.  Starting
20481 with register @code{r13} and proceeding downwards, registers are
20482 allocated first to satisfy the requirements of @option{-mint-register},
20483 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20484 is possible for the small data area register to be @code{r8} if both
20485 @option{-mint-register=4} and @option{-mpid} are specified on the
20486 command line.
20488 By default this feature is not enabled.  The default can be restored
20489 via the @option{-mno-pid} command-line option.
20491 @item -mno-warn-multiple-fast-interrupts
20492 @itemx -mwarn-multiple-fast-interrupts
20493 @opindex mno-warn-multiple-fast-interrupts
20494 @opindex mwarn-multiple-fast-interrupts
20495 Prevents GCC from issuing a warning message if it finds more than one
20496 fast interrupt handler when it is compiling a file.  The default is to
20497 issue a warning for each extra fast interrupt handler found, as the RX
20498 only supports one such interrupt.
20500 @end table
20502 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20503 has special significance to the RX port when used with the
20504 @code{interrupt} function attribute.  This attribute indicates a
20505 function intended to process fast interrupts.  GCC ensures
20506 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20507 and/or @code{r13} and only provided that the normal use of the
20508 corresponding registers have been restricted via the
20509 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20510 options.
20512 @node S/390 and zSeries Options
20513 @subsection S/390 and zSeries Options
20514 @cindex S/390 and zSeries Options
20516 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20518 @table @gcctabopt
20519 @item -mhard-float
20520 @itemx -msoft-float
20521 @opindex mhard-float
20522 @opindex msoft-float
20523 Use (do not use) the hardware floating-point instructions and registers
20524 for floating-point operations.  When @option{-msoft-float} is specified,
20525 functions in @file{libgcc.a} are used to perform floating-point
20526 operations.  When @option{-mhard-float} is specified, the compiler
20527 generates IEEE floating-point instructions.  This is the default.
20529 @item -mhard-dfp
20530 @itemx -mno-hard-dfp
20531 @opindex mhard-dfp
20532 @opindex mno-hard-dfp
20533 Use (do not use) the hardware decimal-floating-point instructions for
20534 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20535 specified, functions in @file{libgcc.a} are used to perform
20536 decimal-floating-point operations.  When @option{-mhard-dfp} is
20537 specified, the compiler generates decimal-floating-point hardware
20538 instructions.  This is the default for @option{-march=z9-ec} or higher.
20540 @item -mlong-double-64
20541 @itemx -mlong-double-128
20542 @opindex mlong-double-64
20543 @opindex mlong-double-128
20544 These switches control the size of @code{long double} type. A size
20545 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20546 type. This is the default.
20548 @item -mbackchain
20549 @itemx -mno-backchain
20550 @opindex mbackchain
20551 @opindex mno-backchain
20552 Store (do not store) the address of the caller's frame as backchain pointer
20553 into the callee's stack frame.
20554 A backchain may be needed to allow debugging using tools that do not understand
20555 DWARF 2 call frame information.
20556 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20557 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20558 the backchain is placed into the topmost word of the 96/160 byte register
20559 save area.
20561 In general, code compiled with @option{-mbackchain} is call-compatible with
20562 code compiled with @option{-mmo-backchain}; however, use of the backchain
20563 for debugging purposes usually requires that the whole binary is built with
20564 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20565 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20566 to build a linux kernel use @option{-msoft-float}.
20568 The default is to not maintain the backchain.
20570 @item -mpacked-stack
20571 @itemx -mno-packed-stack
20572 @opindex mpacked-stack
20573 @opindex mno-packed-stack
20574 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20575 specified, the compiler uses the all fields of the 96/160 byte register save
20576 area only for their default purpose; unused fields still take up stack space.
20577 When @option{-mpacked-stack} is specified, register save slots are densely
20578 packed at the top of the register save area; unused space is reused for other
20579 purposes, allowing for more efficient use of the available stack space.
20580 However, when @option{-mbackchain} is also in effect, the topmost word of
20581 the save area is always used to store the backchain, and the return address
20582 register is always saved two words below the backchain.
20584 As long as the stack frame backchain is not used, code generated with
20585 @option{-mpacked-stack} is call-compatible with code generated with
20586 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20587 S/390 or zSeries generated code that uses the stack frame backchain at run
20588 time, not just for debugging purposes.  Such code is not call-compatible
20589 with code compiled with @option{-mpacked-stack}.  Also, note that the
20590 combination of @option{-mbackchain},
20591 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20592 to build a linux kernel use @option{-msoft-float}.
20594 The default is to not use the packed stack layout.
20596 @item -msmall-exec
20597 @itemx -mno-small-exec
20598 @opindex msmall-exec
20599 @opindex mno-small-exec
20600 Generate (or do not generate) code using the @code{bras} instruction
20601 to do subroutine calls.
20602 This only works reliably if the total executable size does not
20603 exceed 64k.  The default is to use the @code{basr} instruction instead,
20604 which does not have this limitation.
20606 @item -m64
20607 @itemx -m31
20608 @opindex m64
20609 @opindex m31
20610 When @option{-m31} is specified, generate code compliant to the
20611 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20612 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20613 particular to generate 64-bit instructions.  For the @samp{s390}
20614 targets, the default is @option{-m31}, while the @samp{s390x}
20615 targets default to @option{-m64}.
20617 @item -mzarch
20618 @itemx -mesa
20619 @opindex mzarch
20620 @opindex mesa
20621 When @option{-mzarch} is specified, generate code using the
20622 instructions available on z/Architecture.
20623 When @option{-mesa} is specified, generate code using the
20624 instructions available on ESA/390.  Note that @option{-mesa} is
20625 not possible with @option{-m64}.
20626 When generating code compliant to the GNU/Linux for S/390 ABI,
20627 the default is @option{-mesa}.  When generating code compliant
20628 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20630 @item -mmvcle
20631 @itemx -mno-mvcle
20632 @opindex mmvcle
20633 @opindex mno-mvcle
20634 Generate (or do not generate) code using the @code{mvcle} instruction
20635 to perform block moves.  When @option{-mno-mvcle} is specified,
20636 use a @code{mvc} loop instead.  This is the default unless optimizing for
20637 size.
20639 @item -mdebug
20640 @itemx -mno-debug
20641 @opindex mdebug
20642 @opindex mno-debug
20643 Print (or do not print) additional debug information when compiling.
20644 The default is to not print debug information.
20646 @item -march=@var{cpu-type}
20647 @opindex march
20648 Generate code that runs on @var{cpu-type}, which is the name of a system
20649 representing a certain processor type.  Possible values for
20650 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20651 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20652 When generating code using the instructions available on z/Architecture,
20653 the default is @option{-march=z900}.  Otherwise, the default is
20654 @option{-march=g5}.
20656 @item -mtune=@var{cpu-type}
20657 @opindex mtune
20658 Tune to @var{cpu-type} everything applicable about the generated code,
20659 except for the ABI and the set of available instructions.
20660 The list of @var{cpu-type} values is the same as for @option{-march}.
20661 The default is the value used for @option{-march}.
20663 @item -mtpf-trace
20664 @itemx -mno-tpf-trace
20665 @opindex mtpf-trace
20666 @opindex mno-tpf-trace
20667 Generate code that adds (does not add) in TPF OS specific branches to trace
20668 routines in the operating system.  This option is off by default, even
20669 when compiling for the TPF OS@.
20671 @item -mfused-madd
20672 @itemx -mno-fused-madd
20673 @opindex mfused-madd
20674 @opindex mno-fused-madd
20675 Generate code that uses (does not use) the floating-point multiply and
20676 accumulate instructions.  These instructions are generated by default if
20677 hardware floating point is used.
20679 @item -mwarn-framesize=@var{framesize}
20680 @opindex mwarn-framesize
20681 Emit a warning if the current function exceeds the given frame size.  Because
20682 this is a compile-time check it doesn't need to be a real problem when the program
20683 runs.  It is intended to identify functions that most probably cause
20684 a stack overflow.  It is useful to be used in an environment with limited stack
20685 size e.g.@: the linux kernel.
20687 @item -mwarn-dynamicstack
20688 @opindex mwarn-dynamicstack
20689 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20690 arrays.  This is generally a bad idea with a limited stack size.
20692 @item -mstack-guard=@var{stack-guard}
20693 @itemx -mstack-size=@var{stack-size}
20694 @opindex mstack-guard
20695 @opindex mstack-size
20696 If these options are provided the S/390 back end emits additional instructions in
20697 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20698 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20699 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20700 the frame size of the compiled function is chosen.
20701 These options are intended to be used to help debugging stack overflow problems.
20702 The additionally emitted code causes only little overhead and hence can also be
20703 used in production-like systems without greater performance degradation.  The given
20704 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20705 @var{stack-guard} without exceeding 64k.
20706 In order to be efficient the extra code makes the assumption that the stack starts
20707 at an address aligned to the value given by @var{stack-size}.
20708 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20710 @item -mhotpatch[=@var{halfwords}]
20711 @itemx -mno-hotpatch
20712 @opindex mhotpatch
20713 If the hotpatch option is enabled, a ``hot-patching'' function
20714 prologue is generated for all functions in the compilation unit.
20715 The funtion label is prepended with the given number of two-byte
20716 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
20717 instructions if no argument is present.  Functions with a
20718 hot-patching prologue are never inlined automatically, and a
20719 hot-patching prologue is never generated for functions
20720 that are explicitly inline.
20722 This option can be overridden for individual functions with the
20723 @code{hotpatch} attribute.
20724 @end table
20726 @node Score Options
20727 @subsection Score Options
20728 @cindex Score Options
20730 These options are defined for Score implementations:
20732 @table @gcctabopt
20733 @item -meb
20734 @opindex meb
20735 Compile code for big-endian mode.  This is the default.
20737 @item -mel
20738 @opindex mel
20739 Compile code for little-endian mode.
20741 @item -mnhwloop
20742 @opindex mnhwloop
20743 Disable generation of @code{bcnz} instructions.
20745 @item -muls
20746 @opindex muls
20747 Enable generation of unaligned load and store instructions.
20749 @item -mmac
20750 @opindex mmac
20751 Enable the use of multiply-accumulate instructions. Disabled by default.
20753 @item -mscore5
20754 @opindex mscore5
20755 Specify the SCORE5 as the target architecture.
20757 @item -mscore5u
20758 @opindex mscore5u
20759 Specify the SCORE5U of the target architecture.
20761 @item -mscore7
20762 @opindex mscore7
20763 Specify the SCORE7 as the target architecture. This is the default.
20765 @item -mscore7d
20766 @opindex mscore7d
20767 Specify the SCORE7D as the target architecture.
20768 @end table
20770 @node SH Options
20771 @subsection SH Options
20773 These @samp{-m} options are defined for the SH implementations:
20775 @table @gcctabopt
20776 @item -m1
20777 @opindex m1
20778 Generate code for the SH1.
20780 @item -m2
20781 @opindex m2
20782 Generate code for the SH2.
20784 @item -m2e
20785 Generate code for the SH2e.
20787 @item -m2a-nofpu
20788 @opindex m2a-nofpu
20789 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20790 that the floating-point unit is not used.
20792 @item -m2a-single-only
20793 @opindex m2a-single-only
20794 Generate code for the SH2a-FPU, in such a way that no double-precision
20795 floating-point operations are used.
20797 @item -m2a-single
20798 @opindex m2a-single
20799 Generate code for the SH2a-FPU assuming the floating-point unit is in
20800 single-precision mode by default.
20802 @item -m2a
20803 @opindex m2a
20804 Generate code for the SH2a-FPU assuming the floating-point unit is in
20805 double-precision mode by default.
20807 @item -m3
20808 @opindex m3
20809 Generate code for the SH3.
20811 @item -m3e
20812 @opindex m3e
20813 Generate code for the SH3e.
20815 @item -m4-nofpu
20816 @opindex m4-nofpu
20817 Generate code for the SH4 without a floating-point unit.
20819 @item -m4-single-only
20820 @opindex m4-single-only
20821 Generate code for the SH4 with a floating-point unit that only
20822 supports single-precision arithmetic.
20824 @item -m4-single
20825 @opindex m4-single
20826 Generate code for the SH4 assuming the floating-point unit is in
20827 single-precision mode by default.
20829 @item -m4
20830 @opindex m4
20831 Generate code for the SH4.
20833 @item -m4-100
20834 @opindex m4-100
20835 Generate code for SH4-100.
20837 @item -m4-100-nofpu
20838 @opindex m4-100-nofpu
20839 Generate code for SH4-100 in such a way that the
20840 floating-point unit is not used.
20842 @item -m4-100-single
20843 @opindex m4-100-single
20844 Generate code for SH4-100 assuming the floating-point unit is in
20845 single-precision mode by default.
20847 @item -m4-100-single-only
20848 @opindex m4-100-single-only
20849 Generate code for SH4-100 in such a way that no double-precision
20850 floating-point operations are used.
20852 @item -m4-200
20853 @opindex m4-200
20854 Generate code for SH4-200.
20856 @item -m4-200-nofpu
20857 @opindex m4-200-nofpu
20858 Generate code for SH4-200 without in such a way that the
20859 floating-point unit is not used.
20861 @item -m4-200-single
20862 @opindex m4-200-single
20863 Generate code for SH4-200 assuming the floating-point unit is in
20864 single-precision mode by default.
20866 @item -m4-200-single-only
20867 @opindex m4-200-single-only
20868 Generate code for SH4-200 in such a way that no double-precision
20869 floating-point operations are used.
20871 @item -m4-300
20872 @opindex m4-300
20873 Generate code for SH4-300.
20875 @item -m4-300-nofpu
20876 @opindex m4-300-nofpu
20877 Generate code for SH4-300 without in such a way that the
20878 floating-point unit is not used.
20880 @item -m4-300-single
20881 @opindex m4-300-single
20882 Generate code for SH4-300 in such a way that no double-precision
20883 floating-point operations are used.
20885 @item -m4-300-single-only
20886 @opindex m4-300-single-only
20887 Generate code for SH4-300 in such a way that no double-precision
20888 floating-point operations are used.
20890 @item -m4-340
20891 @opindex m4-340
20892 Generate code for SH4-340 (no MMU, no FPU).
20894 @item -m4-500
20895 @opindex m4-500
20896 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20897 assembler.
20899 @item -m4a-nofpu
20900 @opindex m4a-nofpu
20901 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20902 floating-point unit is not used.
20904 @item -m4a-single-only
20905 @opindex m4a-single-only
20906 Generate code for the SH4a, in such a way that no double-precision
20907 floating-point operations are used.
20909 @item -m4a-single
20910 @opindex m4a-single
20911 Generate code for the SH4a assuming the floating-point unit is in
20912 single-precision mode by default.
20914 @item -m4a
20915 @opindex m4a
20916 Generate code for the SH4a.
20918 @item -m4al
20919 @opindex m4al
20920 Same as @option{-m4a-nofpu}, except that it implicitly passes
20921 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20922 instructions at the moment.
20924 @item -m5-32media
20925 @opindex m5-32media
20926 Generate 32-bit code for SHmedia.
20928 @item -m5-32media-nofpu
20929 @opindex m5-32media-nofpu
20930 Generate 32-bit code for SHmedia in such a way that the
20931 floating-point unit is not used.
20933 @item -m5-64media
20934 @opindex m5-64media
20935 Generate 64-bit code for SHmedia.
20937 @item -m5-64media-nofpu
20938 @opindex m5-64media-nofpu
20939 Generate 64-bit code for SHmedia in such a way that the
20940 floating-point unit is not used.
20942 @item -m5-compact
20943 @opindex m5-compact
20944 Generate code for SHcompact.
20946 @item -m5-compact-nofpu
20947 @opindex m5-compact-nofpu
20948 Generate code for SHcompact in such a way that the
20949 floating-point unit is not used.
20951 @item -mb
20952 @opindex mb
20953 Compile code for the processor in big-endian mode.
20955 @item -ml
20956 @opindex ml
20957 Compile code for the processor in little-endian mode.
20959 @item -mdalign
20960 @opindex mdalign
20961 Align doubles at 64-bit boundaries.  Note that this changes the calling
20962 conventions, and thus some functions from the standard C library do
20963 not work unless you recompile it first with @option{-mdalign}.
20965 @item -mrelax
20966 @opindex mrelax
20967 Shorten some address references at link time, when possible; uses the
20968 linker option @option{-relax}.
20970 @item -mbigtable
20971 @opindex mbigtable
20972 Use 32-bit offsets in @code{switch} tables.  The default is to use
20973 16-bit offsets.
20975 @item -mbitops
20976 @opindex mbitops
20977 Enable the use of bit manipulation instructions on SH2A.
20979 @item -mfmovd
20980 @opindex mfmovd
20981 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20982 alignment constraints.
20984 @item -mrenesas
20985 @opindex mrenesas
20986 Comply with the calling conventions defined by Renesas.
20988 @item -mno-renesas
20989 @opindex mno-renesas
20990 Comply with the calling conventions defined for GCC before the Renesas
20991 conventions were available.  This option is the default for all
20992 targets of the SH toolchain.
20994 @item -mnomacsave
20995 @opindex mnomacsave
20996 Mark the @code{MAC} register as call-clobbered, even if
20997 @option{-mrenesas} is given.
20999 @item -mieee
21000 @itemx -mno-ieee
21001 @opindex mieee
21002 @opindex mno-ieee
21003 Control the IEEE compliance of floating-point comparisons, which affects the
21004 handling of cases where the result of a comparison is unordered.  By default
21005 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21006 enabled @option{-mno-ieee} is implicitly set, which results in faster
21007 floating-point greater-equal and less-equal comparisons.  The implcit settings
21008 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21010 @item -minline-ic_invalidate
21011 @opindex minline-ic_invalidate
21012 Inline code to invalidate instruction cache entries after setting up
21013 nested function trampolines.
21014 This option has no effect if @option{-musermode} is in effect and the selected
21015 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21016 instruction.
21017 If the selected code generation option does not allow the use of the @code{icbi}
21018 instruction, and @option{-musermode} is not in effect, the inlined code
21019 manipulates the instruction cache address array directly with an associative
21020 write.  This not only requires privileged mode at run time, but it also
21021 fails if the cache line had been mapped via the TLB and has become unmapped.
21023 @item -misize
21024 @opindex misize
21025 Dump instruction size and location in the assembly code.
21027 @item -mpadstruct
21028 @opindex mpadstruct
21029 This option is deprecated.  It pads structures to multiple of 4 bytes,
21030 which is incompatible with the SH ABI@.
21032 @item -matomic-model=@var{model}
21033 @opindex matomic-model=@var{model}
21034 Sets the model of atomic operations and additional parameters as a comma
21035 separated list.  For details on the atomic built-in functions see
21036 @ref{__atomic Builtins}.  The following models and parameters are supported:
21038 @table @samp
21040 @item none
21041 Disable compiler generated atomic sequences and emit library calls for atomic
21042 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21044 @item soft-gusa
21045 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21046 built-in functions.  The generated atomic sequences require additional support
21047 from the interrupt/exception handling code of the system and are only suitable
21048 for SH3* and SH4* single-core systems.  This option is enabled by default when
21049 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21050 this option will also partially utilize the hardware atomic instructions
21051 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21052 @samp{strict} is specified.  
21054 @item soft-tcb
21055 Generate software atomic sequences that use a variable in the thread control
21056 block.  This is a variation of the gUSA sequences which can also be used on
21057 SH1* and SH2* targets.  The generated atomic sequences require additional
21058 support from the interrupt/exception handling code of the system and are only
21059 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21060 parameter has to be specified as well.
21062 @item soft-imask
21063 Generate software atomic sequences that temporarily disable interrupts by
21064 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21065 in privileged mode and is only suitable for single-core systems.  Additional
21066 support from the interrupt/exception handling code of the system is not
21067 required.  This model is enabled by default when the target is
21068 @code{sh*-*-linux*} and SH1* or SH2*.
21070 @item hard-llcs
21071 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21072 instructions only.  This is only available on SH4A and is suitable for
21073 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21074 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21075 Code compiled with this option will also be compatible with other software
21076 atomic model interrupt/exception handling systems if executed on an SH4A
21077 system.  Additional support from the interrupt/exception handling code of the
21078 system is not required for this model.
21080 @item gbr-offset=
21081 This parameter specifies the offset in bytes of the variable in the thread
21082 control block structure that should be used by the generated atomic sequences
21083 when the @samp{soft-tcb} model has been selected.  For other models this
21084 parameter is ignored.  The specified value must be an integer multiple of four
21085 and in the range 0-1020.
21087 @item strict
21088 This parameter prevents mixed usage of multiple atomic models, even though they
21089 would be compatible, and will make the compiler generate atomic sequences of the
21090 specified model only.
21092 @end table
21094 @item -mtas
21095 @opindex mtas
21096 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21097 Notice that depending on the particular hardware and software configuration
21098 this can degrade overall performance due to the operand cache line flushes
21099 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21100 processors the @code{tas.b} instruction must be used with caution since it
21101 can result in data corruption for certain cache configurations.
21103 @item -mprefergot
21104 @opindex mprefergot
21105 When generating position-independent code, emit function calls using
21106 the Global Offset Table instead of the Procedure Linkage Table.
21108 @item -musermode
21109 @itemx -mno-usermode
21110 @opindex musermode
21111 @opindex mno-usermode
21112 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21113 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21114 inlined code would not work in user mode.  @option{-musermode} is the default
21115 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21116 @option{-musermode} has no effect, since there is no user mode.
21118 @item -multcost=@var{number}
21119 @opindex multcost=@var{number}
21120 Set the cost to assume for a multiply insn.
21122 @item -mdiv=@var{strategy}
21123 @opindex mdiv=@var{strategy}
21124 Set the division strategy to be used for integer division operations.
21125 For SHmedia @var{strategy} can be one of: 
21127 @table @samp
21129 @item fp 
21130 Performs the operation in floating point.  This has a very high latency,
21131 but needs only a few instructions, so it might be a good choice if
21132 your code has enough easily-exploitable ILP to allow the compiler to
21133 schedule the floating-point instructions together with other instructions.
21134 Division by zero causes a floating-point exception.
21136 @item inv
21137 Uses integer operations to calculate the inverse of the divisor,
21138 and then multiplies the dividend with the inverse.  This strategy allows
21139 CSE and hoisting of the inverse calculation.  Division by zero calculates
21140 an unspecified result, but does not trap.
21142 @item inv:minlat
21143 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21144 have been found, or if the entire operation has been hoisted to the same
21145 place, the last stages of the inverse calculation are intertwined with the
21146 final multiply to reduce the overall latency, at the expense of using a few
21147 more instructions, and thus offering fewer scheduling opportunities with
21148 other code.
21150 @item call
21151 Calls a library function that usually implements the @samp{inv:minlat}
21152 strategy.
21153 This gives high code density for @code{m5-*media-nofpu} compilations.
21155 @item call2
21156 Uses a different entry point of the same library function, where it
21157 assumes that a pointer to a lookup table has already been set up, which
21158 exposes the pointer load to CSE and code hoisting optimizations.
21160 @item inv:call
21161 @itemx inv:call2
21162 @itemx inv:fp
21163 Use the @samp{inv} algorithm for initial
21164 code generation, but if the code stays unoptimized, revert to the @samp{call},
21165 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21166 potentially-trapping side effect of division by zero is carried by a
21167 separate instruction, so it is possible that all the integer instructions
21168 are hoisted out, but the marker for the side effect stays where it is.
21169 A recombination to floating-point operations or a call is not possible
21170 in that case.
21172 @item inv20u
21173 @itemx inv20l
21174 Variants of the @samp{inv:minlat} strategy.  In the case
21175 that the inverse calculation is not separated from the multiply, they speed
21176 up division where the dividend fits into 20 bits (plus sign where applicable)
21177 by inserting a test to skip a number of operations in this case; this test
21178 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21179 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21181 @end table
21183 For targets other than SHmedia @var{strategy} can be one of:
21185 @table @samp
21187 @item call-div1
21188 Calls a library function that uses the single-step division instruction
21189 @code{div1} to perform the operation.  Division by zero calculates an
21190 unspecified result and does not trap.  This is the default except for SH4,
21191 SH2A and SHcompact.
21193 @item call-fp
21194 Calls a library function that performs the operation in double precision
21195 floating point.  Division by zero causes a floating-point exception.  This is
21196 the default for SHcompact with FPU.  Specifying this for targets that do not
21197 have a double precision FPU will default to @code{call-div1}.
21199 @item call-table
21200 Calls a library function that uses a lookup table for small divisors and
21201 the @code{div1} instruction with case distinction for larger divisors.  Division
21202 by zero calculates an unspecified result and does not trap.  This is the default
21203 for SH4.  Specifying this for targets that do not have dynamic shift
21204 instructions will default to @code{call-div1}.
21206 @end table
21208 When a division strategy has not been specified the default strategy will be
21209 selected based on the current target.  For SH2A the default strategy is to
21210 use the @code{divs} and @code{divu} instructions instead of library function
21211 calls.
21213 @item -maccumulate-outgoing-args
21214 @opindex maccumulate-outgoing-args
21215 Reserve space once for outgoing arguments in the function prologue rather
21216 than around each call.  Generally beneficial for performance and size.  Also
21217 needed for unwinding to avoid changing the stack frame around conditional code.
21219 @item -mdivsi3_libfunc=@var{name}
21220 @opindex mdivsi3_libfunc=@var{name}
21221 Set the name of the library function used for 32-bit signed division to
21222 @var{name}.
21223 This only affects the name used in the @samp{call} and @samp{inv:call}
21224 division strategies, and the compiler still expects the same
21225 sets of input/output/clobbered registers as if this option were not present.
21227 @item -mfixed-range=@var{register-range}
21228 @opindex mfixed-range
21229 Generate code treating the given register range as fixed registers.
21230 A fixed register is one that the register allocator can not use.  This is
21231 useful when compiling kernel code.  A register range is specified as
21232 two registers separated by a dash.  Multiple register ranges can be
21233 specified separated by a comma.
21235 @item -mindexed-addressing
21236 @opindex mindexed-addressing
21237 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21238 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21239 semantics for the indexed addressing mode.  The architecture allows the
21240 implementation of processors with 64-bit MMU, which the OS could use to
21241 get 32-bit addressing, but since no current hardware implementation supports
21242 this or any other way to make the indexed addressing mode safe to use in
21243 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21245 @item -mgettrcost=@var{number}
21246 @opindex mgettrcost=@var{number}
21247 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21248 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21250 @item -mpt-fixed
21251 @opindex mpt-fixed
21252 Assume @code{pt*} instructions won't trap.  This generally generates
21253 better-scheduled code, but is unsafe on current hardware.
21254 The current architecture
21255 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21256 anded with 3 is 3.
21257 This has the unintentional effect of making it unsafe to schedule these
21258 instructions before a branch, or hoist them out of a loop.  For example,
21259 @code{__do_global_ctors}, a part of @file{libgcc}
21260 that runs constructors at program
21261 startup, calls functions in a list which is delimited by @minus{}1.  With the
21262 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21263 That means that all the constructors run a bit more quickly, but when
21264 the loop comes to the end of the list, the program crashes because @code{ptabs}
21265 loads @minus{}1 into a target register.  
21267 Since this option is unsafe for any
21268 hardware implementing the current architecture specification, the default
21269 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21270 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21271 this deters register allocation from using target registers for storing
21272 ordinary integers.
21274 @item -minvalid-symbols
21275 @opindex minvalid-symbols
21276 Assume symbols might be invalid.  Ordinary function symbols generated by
21277 the compiler are always valid to load with
21278 @code{movi}/@code{shori}/@code{ptabs} or
21279 @code{movi}/@code{shori}/@code{ptrel},
21280 but with assembler and/or linker tricks it is possible
21281 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21282 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21283 It prevents cross-basic-block CSE, hoisting and most scheduling
21284 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21286 @item -mbranch-cost=@var{num}
21287 @opindex mbranch-cost=@var{num}
21288 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21289 make the compiler try to generate more branch-free code if possible.  
21290 If not specified the value is selected depending on the processor type that
21291 is being compiled for.
21293 @item -mzdcbranch
21294 @itemx -mno-zdcbranch
21295 @opindex mzdcbranch
21296 @opindex mno-zdcbranch
21297 Assume (do not assume) that zero displacement conditional branch instructions
21298 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21299 compiler will try to prefer zero displacement branch code sequences.  This is
21300 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21301 disabled by specifying @option{-mno-zdcbranch}.
21303 @item -mfused-madd
21304 @itemx -mno-fused-madd
21305 @opindex mfused-madd
21306 @opindex mno-fused-madd
21307 Generate code that uses (does not use) the floating-point multiply and
21308 accumulate instructions.  These instructions are generated by default
21309 if hardware floating point is used.  The machine-dependent
21310 @option{-mfused-madd} option is now mapped to the machine-independent
21311 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21312 mapped to @option{-ffp-contract=off}.
21314 @item -mfsca
21315 @itemx -mno-fsca
21316 @opindex mfsca
21317 @opindex mno-fsca
21318 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21319 and cosine approximations.  The option @code{-mfsca} must be used in
21320 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
21321 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
21322 approximations even if @code{-funsafe-math-optimizations} is in effect.
21324 @item -mfsrra
21325 @itemx -mno-fsrra
21326 @opindex mfsrra
21327 @opindex mno-fsrra
21328 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21329 reciprocal square root approximations.  The option @code{-mfsrra} must be used
21330 in combination with @code{-funsafe-math-optimizations} and
21331 @code{-ffinite-math-only}.  It is enabled by default when generating code for
21332 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
21333 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
21334 in effect.
21336 @item -mpretend-cmove
21337 @opindex mpretend-cmove
21338 Prefer zero-displacement conditional branches for conditional move instruction
21339 patterns.  This can result in faster code on the SH4 processor.
21341 @end table
21343 @node Solaris 2 Options
21344 @subsection Solaris 2 Options
21345 @cindex Solaris 2 options
21347 These @samp{-m} options are supported on Solaris 2:
21349 @table @gcctabopt
21350 @item -mclear-hwcap
21351 @opindex mclear-hwcap
21352 @option{-mclear-hwcap} tells the compiler to remove the hardware
21353 capabilities generated by the Solaris assembler.  This is only necessary
21354 when object files use ISA extensions not supported by the current
21355 machine, but check at runtime whether or not to use them.
21357 @item -mimpure-text
21358 @opindex mimpure-text
21359 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21360 the compiler to not pass @option{-z text} to the linker when linking a
21361 shared object.  Using this option, you can link position-dependent
21362 code into a shared object.
21364 @option{-mimpure-text} suppresses the ``relocations remain against
21365 allocatable but non-writable sections'' linker error message.
21366 However, the necessary relocations trigger copy-on-write, and the
21367 shared object is not actually shared across processes.  Instead of
21368 using @option{-mimpure-text}, you should compile all source code with
21369 @option{-fpic} or @option{-fPIC}.
21371 @end table
21373 These switches are supported in addition to the above on Solaris 2:
21375 @table @gcctabopt
21376 @item -pthreads
21377 @opindex pthreads
21378 Add support for multithreading using the POSIX threads library.  This
21379 option sets flags for both the preprocessor and linker.  This option does
21380 not affect the thread safety of object code produced  by the compiler or
21381 that of libraries supplied with it.
21383 @item -pthread
21384 @opindex pthread
21385 This is a synonym for @option{-pthreads}.
21386 @end table
21388 @node SPARC Options
21389 @subsection SPARC Options
21390 @cindex SPARC options
21392 These @samp{-m} options are supported on the SPARC:
21394 @table @gcctabopt
21395 @item -mno-app-regs
21396 @itemx -mapp-regs
21397 @opindex mno-app-regs
21398 @opindex mapp-regs
21399 Specify @option{-mapp-regs} to generate output using the global registers
21400 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21401 global register 1, each global register 2 through 4 is then treated as an
21402 allocable register that is clobbered by function calls.  This is the default.
21404 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21405 specify @option{-mno-app-regs}.  You should compile libraries and system
21406 software with this option.
21408 @item -mflat
21409 @itemx -mno-flat
21410 @opindex mflat
21411 @opindex mno-flat
21412 With @option{-mflat}, the compiler does not generate save/restore instructions
21413 and uses a ``flat'' or single register window model.  This model is compatible
21414 with the regular register window model.  The local registers and the input
21415 registers (0--5) are still treated as ``call-saved'' registers and are
21416 saved on the stack as needed.
21418 With @option{-mno-flat} (the default), the compiler generates save/restore
21419 instructions (except for leaf functions).  This is the normal operating mode.
21421 @item -mfpu
21422 @itemx -mhard-float
21423 @opindex mfpu
21424 @opindex mhard-float
21425 Generate output containing floating-point instructions.  This is the
21426 default.
21428 @item -mno-fpu
21429 @itemx -msoft-float
21430 @opindex mno-fpu
21431 @opindex msoft-float
21432 Generate output containing library calls for floating point.
21433 @strong{Warning:} the requisite libraries are not available for all SPARC
21434 targets.  Normally the facilities of the machine's usual C compiler are
21435 used, but this cannot be done directly in cross-compilation.  You must make
21436 your own arrangements to provide suitable library functions for
21437 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21438 @samp{sparclite-*-*} do provide software floating-point support.
21440 @option{-msoft-float} changes the calling convention in the output file;
21441 therefore, it is only useful if you compile @emph{all} of a program with
21442 this option.  In particular, you need to compile @file{libgcc.a}, the
21443 library that comes with GCC, with @option{-msoft-float} in order for
21444 this to work.
21446 @item -mhard-quad-float
21447 @opindex mhard-quad-float
21448 Generate output containing quad-word (long double) floating-point
21449 instructions.
21451 @item -msoft-quad-float
21452 @opindex msoft-quad-float
21453 Generate output containing library calls for quad-word (long double)
21454 floating-point instructions.  The functions called are those specified
21455 in the SPARC ABI@.  This is the default.
21457 As of this writing, there are no SPARC implementations that have hardware
21458 support for the quad-word floating-point instructions.  They all invoke
21459 a trap handler for one of these instructions, and then the trap handler
21460 emulates the effect of the instruction.  Because of the trap handler overhead,
21461 this is much slower than calling the ABI library routines.  Thus the
21462 @option{-msoft-quad-float} option is the default.
21464 @item -mno-unaligned-doubles
21465 @itemx -munaligned-doubles
21466 @opindex mno-unaligned-doubles
21467 @opindex munaligned-doubles
21468 Assume that doubles have 8-byte alignment.  This is the default.
21470 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21471 alignment only if they are contained in another type, or if they have an
21472 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21473 Specifying this option avoids some rare compatibility problems with code
21474 generated by other compilers.  It is not the default because it results
21475 in a performance loss, especially for floating-point code.
21477 @item -muser-mode
21478 @itemx -mno-user-mode
21479 @opindex muser-mode
21480 @opindex mno-user-mode
21481 Do not generate code that can only run in supervisor mode.  This is relevant
21482 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21483 default is @option{-mno-user-mode}.
21485 @item -mno-faster-structs
21486 @itemx -mfaster-structs
21487 @opindex mno-faster-structs
21488 @opindex mfaster-structs
21489 With @option{-mfaster-structs}, the compiler assumes that structures
21490 should have 8-byte alignment.  This enables the use of pairs of
21491 @code{ldd} and @code{std} instructions for copies in structure
21492 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21493 However, the use of this changed alignment directly violates the SPARC
21494 ABI@.  Thus, it's intended only for use on targets where the developer
21495 acknowledges that their resulting code is not directly in line with
21496 the rules of the ABI@.
21498 @item -mcpu=@var{cpu_type}
21499 @opindex mcpu
21500 Set the instruction set, register set, and instruction scheduling parameters
21501 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21502 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21503 @samp{leon}, @samp{leon3}, @samp{sparclite}, @samp{f930}, @samp{f934},
21504 @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21505 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21506 @samp{niagara3} and @samp{niagara4}.
21508 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21509 which selects the best architecture option for the host processor.
21510 @option{-mcpu=native} has no effect if GCC does not recognize
21511 the processor.
21513 Default instruction scheduling parameters are used for values that select
21514 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21515 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21517 Here is a list of each supported architecture and their supported
21518 implementations.
21520 @table @asis
21521 @item v7
21522 cypress
21524 @item v8
21525 supersparc, hypersparc, leon, leon3
21527 @item sparclite
21528 f930, f934, sparclite86x
21530 @item sparclet
21531 tsc701
21533 @item v9
21534 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21535 @end table
21537 By default (unless configured otherwise), GCC generates code for the V7
21538 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21539 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21540 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21541 SPARCStation 1, 2, IPX etc.
21543 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21544 architecture.  The only difference from V7 code is that the compiler emits
21545 the integer multiply and integer divide instructions which exist in SPARC-V8
21546 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21547 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21548 2000 series.
21550 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21551 the SPARC architecture.  This adds the integer multiply, integer divide step
21552 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21553 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21554 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21555 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21556 MB86934 chip, which is the more recent SPARClite with FPU@.
21558 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21559 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21560 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21561 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21562 optimizes it for the TEMIC SPARClet chip.
21564 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21565 architecture.  This adds 64-bit integer and floating-point move instructions,
21566 3 additional floating-point condition code registers and conditional move
21567 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21568 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21569 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21570 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21571 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21572 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21573 additionally optimizes it for Sun UltraSPARC T2 chips. With
21574 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21575 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21576 additionally optimizes it for Sun UltraSPARC T4 chips.
21578 @item -mtune=@var{cpu_type}
21579 @opindex mtune
21580 Set the instruction scheduling parameters for machine type
21581 @var{cpu_type}, but do not set the instruction set or register set that the
21582 option @option{-mcpu=@var{cpu_type}} does.
21584 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21585 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21586 that select a particular CPU implementation.  Those are @samp{cypress},
21587 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3}, @samp{f930},
21588 @samp{f934}, @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
21589 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3} and
21590 @samp{niagara4}.  With native Solaris and GNU/Linux toolchains, @samp{native}
21591 can also be used.
21593 @item -mv8plus
21594 @itemx -mno-v8plus
21595 @opindex mv8plus
21596 @opindex mno-v8plus
21597 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21598 difference from the V8 ABI is that the global and out registers are
21599 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21600 mode for all SPARC-V9 processors.
21602 @item -mvis
21603 @itemx -mno-vis
21604 @opindex mvis
21605 @opindex mno-vis
21606 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21607 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21609 @item -mvis2
21610 @itemx -mno-vis2
21611 @opindex mvis2
21612 @opindex mno-vis2
21613 With @option{-mvis2}, GCC generates code that takes advantage of
21614 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21615 default is @option{-mvis2} when targeting a cpu that supports such
21616 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21617 also sets @option{-mvis}.
21619 @item -mvis3
21620 @itemx -mno-vis3
21621 @opindex mvis3
21622 @opindex mno-vis3
21623 With @option{-mvis3}, GCC generates code that takes advantage of
21624 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21625 default is @option{-mvis3} when targeting a cpu that supports such
21626 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21627 also sets @option{-mvis2} and @option{-mvis}.
21629 @item -mcbcond
21630 @itemx -mno-cbcond
21631 @opindex mcbcond
21632 @opindex mno-cbcond
21633 With @option{-mcbcond}, GCC generates code that takes advantage of
21634 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21635 The default is @option{-mcbcond} when targeting a cpu that supports such
21636 instructions, such as niagara-4 and later.
21638 @item -mpopc
21639 @itemx -mno-popc
21640 @opindex mpopc
21641 @opindex mno-popc
21642 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21643 population count instruction.  The default is @option{-mpopc}
21644 when targeting a cpu that supports such instructions, such as Niagara-2 and
21645 later.
21647 @item -mfmaf
21648 @itemx -mno-fmaf
21649 @opindex mfmaf
21650 @opindex mno-fmaf
21651 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21652 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21653 when targeting a cpu that supports such instructions, such as Niagara-3 and
21654 later.
21656 @item -mfix-at697f
21657 @opindex mfix-at697f
21658 Enable the documented workaround for the single erratum of the Atmel AT697F
21659 processor (which corresponds to erratum #13 of the AT697E processor).
21661 @item -mfix-ut699
21662 @opindex mfix-ut699
21663 Enable the documented workarounds for the floating-point errata and the data
21664 cache nullify errata of the UT699 processor.
21665 @end table
21667 These @samp{-m} options are supported in addition to the above
21668 on SPARC-V9 processors in 64-bit environments:
21670 @table @gcctabopt
21671 @item -m32
21672 @itemx -m64
21673 @opindex m32
21674 @opindex m64
21675 Generate code for a 32-bit or 64-bit environment.
21676 The 32-bit environment sets int, long and pointer to 32 bits.
21677 The 64-bit environment sets int to 32 bits and long and pointer
21678 to 64 bits.
21680 @item -mcmodel=@var{which}
21681 @opindex mcmodel
21682 Set the code model to one of
21684 @table @samp
21685 @item medlow
21686 The Medium/Low code model: 64-bit addresses, programs
21687 must be linked in the low 32 bits of memory.  Programs can be statically
21688 or dynamically linked.
21690 @item medmid
21691 The Medium/Middle code model: 64-bit addresses, programs
21692 must be linked in the low 44 bits of memory, the text and data segments must
21693 be less than 2GB in size and the data segment must be located within 2GB of
21694 the text segment.
21696 @item medany
21697 The Medium/Anywhere code model: 64-bit addresses, programs
21698 may be linked anywhere in memory, the text and data segments must be less
21699 than 2GB in size and the data segment must be located within 2GB of the
21700 text segment.
21702 @item embmedany
21703 The Medium/Anywhere code model for embedded systems:
21704 64-bit addresses, the text and data segments must be less than 2GB in
21705 size, both starting anywhere in memory (determined at link time).  The
21706 global register %g4 points to the base of the data segment.  Programs
21707 are statically linked and PIC is not supported.
21708 @end table
21710 @item -mmemory-model=@var{mem-model}
21711 @opindex mmemory-model
21712 Set the memory model in force on the processor to one of
21714 @table @samp
21715 @item default
21716 The default memory model for the processor and operating system.
21718 @item rmo
21719 Relaxed Memory Order
21721 @item pso
21722 Partial Store Order
21724 @item tso
21725 Total Store Order
21727 @item sc
21728 Sequential Consistency
21729 @end table
21731 These memory models are formally defined in Appendix D of the Sparc V9
21732 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21734 @item -mstack-bias
21735 @itemx -mno-stack-bias
21736 @opindex mstack-bias
21737 @opindex mno-stack-bias
21738 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21739 frame pointer if present, are offset by @minus{}2047 which must be added back
21740 when making stack frame references.  This is the default in 64-bit mode.
21741 Otherwise, assume no such offset is present.
21742 @end table
21744 @node SPU Options
21745 @subsection SPU Options
21746 @cindex SPU options
21748 These @samp{-m} options are supported on the SPU:
21750 @table @gcctabopt
21751 @item -mwarn-reloc
21752 @itemx -merror-reloc
21753 @opindex mwarn-reloc
21754 @opindex merror-reloc
21756 The loader for SPU does not handle dynamic relocations.  By default, GCC
21757 gives an error when it generates code that requires a dynamic
21758 relocation.  @option{-mno-error-reloc} disables the error,
21759 @option{-mwarn-reloc} generates a warning instead.
21761 @item -msafe-dma
21762 @itemx -munsafe-dma
21763 @opindex msafe-dma
21764 @opindex munsafe-dma
21766 Instructions that initiate or test completion of DMA must not be
21767 reordered with respect to loads and stores of the memory that is being
21768 accessed.
21769 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21770 memory accesses, but that can lead to inefficient code in places where the
21771 memory is known to not change.  Rather than mark the memory as volatile,
21772 you can use @option{-msafe-dma} to tell the compiler to treat
21773 the DMA instructions as potentially affecting all memory.  
21775 @item -mbranch-hints
21776 @opindex mbranch-hints
21778 By default, GCC generates a branch hint instruction to avoid
21779 pipeline stalls for always-taken or probably-taken branches.  A hint
21780 is not generated closer than 8 instructions away from its branch.
21781 There is little reason to disable them, except for debugging purposes,
21782 or to make an object a little bit smaller.
21784 @item -msmall-mem
21785 @itemx -mlarge-mem
21786 @opindex msmall-mem
21787 @opindex mlarge-mem
21789 By default, GCC generates code assuming that addresses are never larger
21790 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21791 a full 32-bit address.
21793 @item -mstdmain
21794 @opindex mstdmain
21796 By default, GCC links against startup code that assumes the SPU-style
21797 main function interface (which has an unconventional parameter list).
21798 With @option{-mstdmain}, GCC links your program against startup
21799 code that assumes a C99-style interface to @code{main}, including a
21800 local copy of @code{argv} strings.
21802 @item -mfixed-range=@var{register-range}
21803 @opindex mfixed-range
21804 Generate code treating the given register range as fixed registers.
21805 A fixed register is one that the register allocator cannot use.  This is
21806 useful when compiling kernel code.  A register range is specified as
21807 two registers separated by a dash.  Multiple register ranges can be
21808 specified separated by a comma.
21810 @item -mea32
21811 @itemx -mea64
21812 @opindex mea32
21813 @opindex mea64
21814 Compile code assuming that pointers to the PPU address space accessed
21815 via the @code{__ea} named address space qualifier are either 32 or 64
21816 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21817 all object code in an executable must be compiled with the same setting.
21819 @item -maddress-space-conversion
21820 @itemx -mno-address-space-conversion
21821 @opindex maddress-space-conversion
21822 @opindex mno-address-space-conversion
21823 Allow/disallow treating the @code{__ea} address space as superset
21824 of the generic address space.  This enables explicit type casts
21825 between @code{__ea} and generic pointer as well as implicit
21826 conversions of generic pointers to @code{__ea} pointers.  The
21827 default is to allow address space pointer conversions.
21829 @item -mcache-size=@var{cache-size}
21830 @opindex mcache-size
21831 This option controls the version of libgcc that the compiler links to an
21832 executable and selects a software-managed cache for accessing variables
21833 in the @code{__ea} address space with a particular cache size.  Possible
21834 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21835 and @samp{128}.  The default cache size is 64KB.
21837 @item -matomic-updates
21838 @itemx -mno-atomic-updates
21839 @opindex matomic-updates
21840 @opindex mno-atomic-updates
21841 This option controls the version of libgcc that the compiler links to an
21842 executable and selects whether atomic updates to the software-managed
21843 cache of PPU-side variables are used.  If you use atomic updates, changes
21844 to a PPU variable from SPU code using the @code{__ea} named address space
21845 qualifier do not interfere with changes to other PPU variables residing
21846 in the same cache line from PPU code.  If you do not use atomic updates,
21847 such interference may occur; however, writing back cache lines is
21848 more efficient.  The default behavior is to use atomic updates.
21850 @item -mdual-nops
21851 @itemx -mdual-nops=@var{n}
21852 @opindex mdual-nops
21853 By default, GCC inserts nops to increase dual issue when it expects
21854 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21855 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21856 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21858 @item -mhint-max-nops=@var{n}
21859 @opindex mhint-max-nops
21860 Maximum number of nops to insert for a branch hint.  A branch hint must
21861 be at least 8 instructions away from the branch it is affecting.  GCC
21862 inserts up to @var{n} nops to enforce this, otherwise it does not
21863 generate the branch hint.
21865 @item -mhint-max-distance=@var{n}
21866 @opindex mhint-max-distance
21867 The encoding of the branch hint instruction limits the hint to be within
21868 256 instructions of the branch it is affecting.  By default, GCC makes
21869 sure it is within 125.
21871 @item -msafe-hints
21872 @opindex msafe-hints
21873 Work around a hardware bug that causes the SPU to stall indefinitely.
21874 By default, GCC inserts the @code{hbrp} instruction to make sure
21875 this stall won't happen.
21877 @end table
21879 @node System V Options
21880 @subsection Options for System V
21882 These additional options are available on System V Release 4 for
21883 compatibility with other compilers on those systems:
21885 @table @gcctabopt
21886 @item -G
21887 @opindex G
21888 Create a shared object.
21889 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21891 @item -Qy
21892 @opindex Qy
21893 Identify the versions of each tool used by the compiler, in a
21894 @code{.ident} assembler directive in the output.
21896 @item -Qn
21897 @opindex Qn
21898 Refrain from adding @code{.ident} directives to the output file (this is
21899 the default).
21901 @item -YP,@var{dirs}
21902 @opindex YP
21903 Search the directories @var{dirs}, and no others, for libraries
21904 specified with @option{-l}.
21906 @item -Ym,@var{dir}
21907 @opindex Ym
21908 Look in the directory @var{dir} to find the M4 preprocessor.
21909 The assembler uses this option.
21910 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21911 @c the generic assembler that comes with Solaris takes just -Ym.
21912 @end table
21914 @node TILE-Gx Options
21915 @subsection TILE-Gx Options
21916 @cindex TILE-Gx options
21918 These @samp{-m} options are supported on the TILE-Gx:
21920 @table @gcctabopt
21921 @item -mcmodel=small
21922 @opindex mcmodel=small
21923 Generate code for the small model.  The distance for direct calls is
21924 limited to 500M in either direction.  PC-relative addresses are 32
21925 bits.  Absolute addresses support the full address range.
21927 @item -mcmodel=large
21928 @opindex mcmodel=large
21929 Generate code for the large model.  There is no limitation on call
21930 distance, pc-relative addresses, or absolute addresses.
21932 @item -mcpu=@var{name}
21933 @opindex mcpu
21934 Selects the type of CPU to be targeted.  Currently the only supported
21935 type is @samp{tilegx}.
21937 @item -m32
21938 @itemx -m64
21939 @opindex m32
21940 @opindex m64
21941 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21942 environment sets int, long, and pointer to 32 bits.  The 64-bit
21943 environment sets int to 32 bits and long and pointer to 64 bits.
21945 @item -mbig-endian
21946 @itemx -mlittle-endian
21947 @opindex mbig-endian
21948 @opindex mlittle-endian
21949 Generate code in big/little endian mode, respectively.
21950 @end table
21952 @node TILEPro Options
21953 @subsection TILEPro Options
21954 @cindex TILEPro options
21956 These @samp{-m} options are supported on the TILEPro:
21958 @table @gcctabopt
21959 @item -mcpu=@var{name}
21960 @opindex mcpu
21961 Selects the type of CPU to be targeted.  Currently the only supported
21962 type is @samp{tilepro}.
21964 @item -m32
21965 @opindex m32
21966 Generate code for a 32-bit environment, which sets int, long, and
21967 pointer to 32 bits.  This is the only supported behavior so the flag
21968 is essentially ignored.
21969 @end table
21971 @node V850 Options
21972 @subsection V850 Options
21973 @cindex V850 Options
21975 These @samp{-m} options are defined for V850 implementations:
21977 @table @gcctabopt
21978 @item -mlong-calls
21979 @itemx -mno-long-calls
21980 @opindex mlong-calls
21981 @opindex mno-long-calls
21982 Treat all calls as being far away (near).  If calls are assumed to be
21983 far away, the compiler always loads the function's address into a
21984 register, and calls indirect through the pointer.
21986 @item -mno-ep
21987 @itemx -mep
21988 @opindex mno-ep
21989 @opindex mep
21990 Do not optimize (do optimize) basic blocks that use the same index
21991 pointer 4 or more times to copy pointer into the @code{ep} register, and
21992 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21993 option is on by default if you optimize.
21995 @item -mno-prolog-function
21996 @itemx -mprolog-function
21997 @opindex mno-prolog-function
21998 @opindex mprolog-function
21999 Do not use (do use) external functions to save and restore registers
22000 at the prologue and epilogue of a function.  The external functions
22001 are slower, but use less code space if more than one function saves
22002 the same number of registers.  The @option{-mprolog-function} option
22003 is on by default if you optimize.
22005 @item -mspace
22006 @opindex mspace
22007 Try to make the code as small as possible.  At present, this just turns
22008 on the @option{-mep} and @option{-mprolog-function} options.
22010 @item -mtda=@var{n}
22011 @opindex mtda
22012 Put static or global variables whose size is @var{n} bytes or less into
22013 the tiny data area that register @code{ep} points to.  The tiny data
22014 area can hold up to 256 bytes in total (128 bytes for byte references).
22016 @item -msda=@var{n}
22017 @opindex msda
22018 Put static or global variables whose size is @var{n} bytes or less into
22019 the small data area that register @code{gp} points to.  The small data
22020 area can hold up to 64 kilobytes.
22022 @item -mzda=@var{n}
22023 @opindex mzda
22024 Put static or global variables whose size is @var{n} bytes or less into
22025 the first 32 kilobytes of memory.
22027 @item -mv850
22028 @opindex mv850
22029 Specify that the target processor is the V850.
22031 @item -mv850e3v5
22032 @opindex mv850e3v5
22033 Specify that the target processor is the V850E3V5.  The preprocessor
22034 constant @samp{__v850e3v5__} is defined if this option is used.
22036 @item -mv850e2v4
22037 @opindex mv850e2v4
22038 Specify that the target processor is the V850E3V5.  This is an alias for
22039 the @option{-mv850e3v5} option.
22041 @item -mv850e2v3
22042 @opindex mv850e2v3
22043 Specify that the target processor is the V850E2V3.  The preprocessor
22044 constant @samp{__v850e2v3__} is defined if this option is used.
22046 @item -mv850e2
22047 @opindex mv850e2
22048 Specify that the target processor is the V850E2.  The preprocessor
22049 constant @samp{__v850e2__} is defined if this option is used.
22051 @item -mv850e1
22052 @opindex mv850e1
22053 Specify that the target processor is the V850E1.  The preprocessor
22054 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
22055 this option is used.
22057 @item -mv850es
22058 @opindex mv850es
22059 Specify that the target processor is the V850ES.  This is an alias for
22060 the @option{-mv850e1} option.
22062 @item -mv850e
22063 @opindex mv850e
22064 Specify that the target processor is the V850E@.  The preprocessor
22065 constant @samp{__v850e__} is defined if this option is used.
22067 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22068 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22069 are defined then a default target processor is chosen and the
22070 relevant @samp{__v850*__} preprocessor constant is defined.
22072 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
22073 defined, regardless of which processor variant is the target.
22075 @item -mdisable-callt
22076 @itemx -mno-disable-callt
22077 @opindex mdisable-callt
22078 @opindex mno-disable-callt
22079 This option suppresses generation of the @code{CALLT} instruction for the
22080 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22081 architecture.
22083 This option is enabled by default when the RH850 ABI is
22084 in use (see @option{-mrh850-abi}), and disabled by default when the
22085 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22086 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
22088 @item -mrelax
22089 @itemx -mno-relax
22090 @opindex mrelax
22091 @opindex mno-relax
22092 Pass on (or do not pass on) the @option{-mrelax} command line option
22093 to the assembler.
22095 @item -mlong-jumps
22096 @itemx -mno-long-jumps
22097 @opindex mlong-jumps
22098 @opindex mno-long-jumps
22099 Disable (or re-enable) the generation of PC-relative jump instructions.
22101 @item -msoft-float
22102 @itemx -mhard-float
22103 @opindex msoft-float
22104 @opindex mhard-float
22105 Disable (or re-enable) the generation of hardware floating point
22106 instructions.  This option is only significant when the target
22107 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22108 instructions are being generated then the C preprocessor symbol
22109 @code{__FPU_OK__} will be defined, otherwise the symbol
22110 @code{__NO_FPU__} will be defined.
22112 @item -mloop
22113 @opindex mloop
22114 Enables the use of the e3v5 LOOP instruction.  The use of this
22115 instruction is not enabled by default when the e3v5 architecture is
22116 selected because its use is still experimental.
22118 @item -mrh850-abi
22119 @itemx -mghs
22120 @opindex mrh850-abi
22121 @opindex mghs
22122 Enables support for the RH850 version of the V850 ABI.  This is the
22123 default.  With this version of the ABI the following rules apply:
22125 @itemize
22126 @item
22127 Integer sized structures and unions are returned via a memory pointer
22128 rather than a register.
22130 @item
22131 Large structures and unions (more than 8 bytes in size) are passed by
22132 value.
22134 @item
22135 Functions are aligned to 16-bit boundaries.
22137 @item
22138 The @option{-m8byte-align} command line option is supported.
22140 @item
22141 The @option{-mdisable-callt} command line option is enabled by
22142 default.  The @option{-mno-disable-callt} command line option is not
22143 supported.
22144 @end itemize
22146 When this version of the ABI is enabled the C preprocessor symbol
22147 @code{__V850_RH850_ABI__} is defined.
22149 @item -mgcc-abi
22150 @opindex mgcc-abi
22151 Enables support for the old GCC version of the V850 ABI.  With this
22152 version of the ABI the following rules apply:
22154 @itemize
22155 @item
22156 Integer sized structures and unions are returned in register @code{r10}.
22158 @item
22159 Large structures and unions (more than 8 bytes in size) are passed by
22160 reference.
22162 @item
22163 Functions are aligned to 32-bit boundaries, unless optimizing for
22164 size.
22166 @item
22167 The @option{-m8byte-align} command line option is not supported.
22169 @item
22170 The @option{-mdisable-callt} command line option is supported but not
22171 enabled by default.
22172 @end itemize
22174 When this version of the ABI is enabled the C preprocessor symbol
22175 @code{__V850_GCC_ABI__} is defined.
22177 @item -m8byte-align
22178 @itemx -mno-8byte-align
22179 @opindex m8byte-align
22180 @opindex mno-8byte-align
22181 Enables support for @code{doubles} and @code{long long} types to be
22182 aligned on 8-byte boundaries.  The default is to restrict the
22183 alignment of all objects to at most 4-bytes.  When
22184 @option{-m8byte-align} is in effect the C preprocessor symbol
22185 @code{__V850_8BYTE_ALIGN__} will be defined.
22187 @item -mbig-switch
22188 @opindex mbig-switch
22189 Generate code suitable for big switch tables.  Use this option only if
22190 the assembler/linker complain about out of range branches within a switch
22191 table.
22193 @item -mapp-regs
22194 @opindex mapp-regs
22195 This option causes r2 and r5 to be used in the code generated by
22196 the compiler.  This setting is the default.
22198 @item -mno-app-regs
22199 @opindex mno-app-regs
22200 This option causes r2 and r5 to be treated as fixed registers.
22202 @end table
22204 @node VAX Options
22205 @subsection VAX Options
22206 @cindex VAX options
22208 These @samp{-m} options are defined for the VAX:
22210 @table @gcctabopt
22211 @item -munix
22212 @opindex munix
22213 Do not output certain jump instructions (@code{aobleq} and so on)
22214 that the Unix assembler for the VAX cannot handle across long
22215 ranges.
22217 @item -mgnu
22218 @opindex mgnu
22219 Do output those jump instructions, on the assumption that the
22220 GNU assembler is being used.
22222 @item -mg
22223 @opindex mg
22224 Output code for G-format floating-point numbers instead of D-format.
22225 @end table
22227 @node VMS Options
22228 @subsection VMS Options
22230 These @samp{-m} options are defined for the VMS implementations:
22232 @table @gcctabopt
22233 @item -mvms-return-codes
22234 @opindex mvms-return-codes
22235 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22236 condition (e.g.@ error) codes.
22238 @item -mdebug-main=@var{prefix}
22239 @opindex mdebug-main=@var{prefix}
22240 Flag the first routine whose name starts with @var{prefix} as the main
22241 routine for the debugger.
22243 @item -mmalloc64
22244 @opindex mmalloc64
22245 Default to 64-bit memory allocation routines.
22247 @item -mpointer-size=@var{size}
22248 @opindex -mpointer-size=@var{size}
22249 Set the default size of pointers. Possible options for @var{size} are
22250 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22251 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22252 The later option disables @code{pragma pointer_size}.
22253 @end table
22255 @node VxWorks Options
22256 @subsection VxWorks Options
22257 @cindex VxWorks Options
22259 The options in this section are defined for all VxWorks targets.
22260 Options specific to the target hardware are listed with the other
22261 options for that target.
22263 @table @gcctabopt
22264 @item -mrtp
22265 @opindex mrtp
22266 GCC can generate code for both VxWorks kernels and real time processes
22267 (RTPs).  This option switches from the former to the latter.  It also
22268 defines the preprocessor macro @code{__RTP__}.
22270 @item -non-static
22271 @opindex non-static
22272 Link an RTP executable against shared libraries rather than static
22273 libraries.  The options @option{-static} and @option{-shared} can
22274 also be used for RTPs (@pxref{Link Options}); @option{-static}
22275 is the default.
22277 @item -Bstatic
22278 @itemx -Bdynamic
22279 @opindex Bstatic
22280 @opindex Bdynamic
22281 These options are passed down to the linker.  They are defined for
22282 compatibility with Diab.
22284 @item -Xbind-lazy
22285 @opindex Xbind-lazy
22286 Enable lazy binding of function calls.  This option is equivalent to
22287 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22289 @item -Xbind-now
22290 @opindex Xbind-now
22291 Disable lazy binding of function calls.  This option is the default and
22292 is defined for compatibility with Diab.
22293 @end table
22295 @node x86-64 Options
22296 @subsection x86-64 Options
22297 @cindex x86-64 options
22299 These are listed under @xref{i386 and x86-64 Options}.
22301 @node Xstormy16 Options
22302 @subsection Xstormy16 Options
22303 @cindex Xstormy16 Options
22305 These options are defined for Xstormy16:
22307 @table @gcctabopt
22308 @item -msim
22309 @opindex msim
22310 Choose startup files and linker script suitable for the simulator.
22311 @end table
22313 @node Xtensa Options
22314 @subsection Xtensa Options
22315 @cindex Xtensa Options
22317 These options are supported for Xtensa targets:
22319 @table @gcctabopt
22320 @item -mconst16
22321 @itemx -mno-const16
22322 @opindex mconst16
22323 @opindex mno-const16
22324 Enable or disable use of @code{CONST16} instructions for loading
22325 constant values.  The @code{CONST16} instruction is currently not a
22326 standard option from Tensilica.  When enabled, @code{CONST16}
22327 instructions are always used in place of the standard @code{L32R}
22328 instructions.  The use of @code{CONST16} is enabled by default only if
22329 the @code{L32R} instruction is not available.
22331 @item -mfused-madd
22332 @itemx -mno-fused-madd
22333 @opindex mfused-madd
22334 @opindex mno-fused-madd
22335 Enable or disable use of fused multiply/add and multiply/subtract
22336 instructions in the floating-point option.  This has no effect if the
22337 floating-point option is not also enabled.  Disabling fused multiply/add
22338 and multiply/subtract instructions forces the compiler to use separate
22339 instructions for the multiply and add/subtract operations.  This may be
22340 desirable in some cases where strict IEEE 754-compliant results are
22341 required: the fused multiply add/subtract instructions do not round the
22342 intermediate result, thereby producing results with @emph{more} bits of
22343 precision than specified by the IEEE standard.  Disabling fused multiply
22344 add/subtract instructions also ensures that the program output is not
22345 sensitive to the compiler's ability to combine multiply and add/subtract
22346 operations.
22348 @item -mserialize-volatile
22349 @itemx -mno-serialize-volatile
22350 @opindex mserialize-volatile
22351 @opindex mno-serialize-volatile
22352 When this option is enabled, GCC inserts @code{MEMW} instructions before
22353 @code{volatile} memory references to guarantee sequential consistency.
22354 The default is @option{-mserialize-volatile}.  Use
22355 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22357 @item -mforce-no-pic
22358 @opindex mforce-no-pic
22359 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22360 position-independent code (PIC), this option disables PIC for compiling
22361 kernel code.
22363 @item -mtext-section-literals
22364 @itemx -mno-text-section-literals
22365 @opindex mtext-section-literals
22366 @opindex mno-text-section-literals
22367 Control the treatment of literal pools.  The default is
22368 @option{-mno-text-section-literals}, which places literals in a separate
22369 section in the output file.  This allows the literal pool to be placed
22370 in a data RAM/ROM, and it also allows the linker to combine literal
22371 pools from separate object files to remove redundant literals and
22372 improve code size.  With @option{-mtext-section-literals}, the literals
22373 are interspersed in the text section in order to keep them as close as
22374 possible to their references.  This may be necessary for large assembly
22375 files.
22377 @item -mtarget-align
22378 @itemx -mno-target-align
22379 @opindex mtarget-align
22380 @opindex mno-target-align
22381 When this option is enabled, GCC instructs the assembler to
22382 automatically align instructions to reduce branch penalties at the
22383 expense of some code density.  The assembler attempts to widen density
22384 instructions to align branch targets and the instructions following call
22385 instructions.  If there are not enough preceding safe density
22386 instructions to align a target, no widening is performed.  The
22387 default is @option{-mtarget-align}.  These options do not affect the
22388 treatment of auto-aligned instructions like @code{LOOP}, which the
22389 assembler always aligns, either by widening density instructions or
22390 by inserting NOP instructions.
22392 @item -mlongcalls
22393 @itemx -mno-longcalls
22394 @opindex mlongcalls
22395 @opindex mno-longcalls
22396 When this option is enabled, GCC instructs the assembler to translate
22397 direct calls to indirect calls unless it can determine that the target
22398 of a direct call is in the range allowed by the call instruction.  This
22399 translation typically occurs for calls to functions in other source
22400 files.  Specifically, the assembler translates a direct @code{CALL}
22401 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22402 The default is @option{-mno-longcalls}.  This option should be used in
22403 programs where the call target can potentially be out of range.  This
22404 option is implemented in the assembler, not the compiler, so the
22405 assembly code generated by GCC still shows direct call
22406 instructions---look at the disassembled object code to see the actual
22407 instructions.  Note that the assembler uses an indirect call for
22408 every cross-file call, not just those that really are out of range.
22409 @end table
22411 @node zSeries Options
22412 @subsection zSeries Options
22413 @cindex zSeries options
22415 These are listed under @xref{S/390 and zSeries Options}.
22417 @node Code Gen Options
22418 @section Options for Code Generation Conventions
22419 @cindex code generation conventions
22420 @cindex options, code generation
22421 @cindex run-time options
22423 These machine-independent options control the interface conventions
22424 used in code generation.
22426 Most of them have both positive and negative forms; the negative form
22427 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22428 one of the forms is listed---the one that is not the default.  You
22429 can figure out the other form by either removing @samp{no-} or adding
22432 @table @gcctabopt
22433 @item -fbounds-check
22434 @opindex fbounds-check
22435 For front ends that support it, generate additional code to check that
22436 indices used to access arrays are within the declared range.  This is
22437 currently only supported by the Java and Fortran front ends, where
22438 this option defaults to true and false respectively.
22440 @item -fstack-reuse=@var{reuse-level}
22441 @opindex fstack_reuse
22442 This option controls stack space reuse for user declared local/auto variables
22443 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22444 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22445 local variables and temporaries, @samp{named_vars} enables the reuse only for
22446 user defined local variables with names, and @samp{none} disables stack reuse
22447 completely. The default value is @samp{all}. The option is needed when the
22448 program extends the lifetime of a scoped local variable or a compiler generated
22449 temporary beyond the end point defined by the language.  When a lifetime of
22450 a variable ends, and if the variable lives in memory, the optimizing compiler
22451 has the freedom to reuse its stack space with other temporaries or scoped
22452 local variables whose live range does not overlap with it. Legacy code extending
22453 local lifetime will likely to break with the stack reuse optimization.
22455 For example,
22457 @smallexample
22458    int *p;
22459    @{
22460      int local1;
22462      p = &local1;
22463      local1 = 10;
22464      ....
22465    @}
22466    @{
22467       int local2;
22468       local2 = 20;
22469       ...
22470    @}
22472    if (*p == 10)  // out of scope use of local1
22473      @{
22475      @}
22476 @end smallexample
22478 Another example:
22479 @smallexample
22481    struct A
22482    @{
22483        A(int k) : i(k), j(k) @{ @}
22484        int i;
22485        int j;
22486    @};
22488    A *ap;
22490    void foo(const A& ar)
22491    @{
22492       ap = &ar;
22493    @}
22495    void bar()
22496    @{
22497       foo(A(10)); // temp object's lifetime ends when foo returns
22499       @{
22500         A a(20);
22501         ....
22502       @}
22503       ap->i+= 10;  // ap references out of scope temp whose space
22504                    // is reused with a. What is the value of ap->i?
22505    @}
22507 @end smallexample
22509 The lifetime of a compiler generated temporary is well defined by the C++
22510 standard. When a lifetime of a temporary ends, and if the temporary lives
22511 in memory, the optimizing compiler has the freedom to reuse its stack
22512 space with other temporaries or scoped local variables whose live range
22513 does not overlap with it. However some of the legacy code relies on
22514 the behavior of older compilers in which temporaries' stack space is
22515 not reused, the aggressive stack reuse can lead to runtime errors. This
22516 option is used to control the temporary stack reuse optimization.
22518 @item -ftrapv
22519 @opindex ftrapv
22520 This option generates traps for signed overflow on addition, subtraction,
22521 multiplication operations.
22523 @item -fwrapv
22524 @opindex fwrapv
22525 This option instructs the compiler to assume that signed arithmetic
22526 overflow of addition, subtraction and multiplication wraps around
22527 using twos-complement representation.  This flag enables some optimizations
22528 and disables others.  This option is enabled by default for the Java
22529 front end, as required by the Java language specification.
22531 @item -fexceptions
22532 @opindex fexceptions
22533 Enable exception handling.  Generates extra code needed to propagate
22534 exceptions.  For some targets, this implies GCC generates frame
22535 unwind information for all functions, which can produce significant data
22536 size overhead, although it does not affect execution.  If you do not
22537 specify this option, GCC enables it by default for languages like
22538 C++ that normally require exception handling, and disables it for
22539 languages like C that do not normally require it.  However, you may need
22540 to enable this option when compiling C code that needs to interoperate
22541 properly with exception handlers written in C++.  You may also wish to
22542 disable this option if you are compiling older C++ programs that don't
22543 use exception handling.
22545 @item -fnon-call-exceptions
22546 @opindex fnon-call-exceptions
22547 Generate code that allows trapping instructions to throw exceptions.
22548 Note that this requires platform-specific runtime support that does
22549 not exist everywhere.  Moreover, it only allows @emph{trapping}
22550 instructions to throw exceptions, i.e.@: memory references or floating-point
22551 instructions.  It does not allow exceptions to be thrown from
22552 arbitrary signal handlers such as @code{SIGALRM}.
22554 @item -fdelete-dead-exceptions
22555 @opindex fdelete-dead-exceptions
22556 Consider that instructions that may throw exceptions but don't otherwise
22557 contribute to the execution of the program can be optimized away.
22558 This option is enabled by default for the Ada front end, as permitted by
22559 the Ada language specification.
22560 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22562 @item -funwind-tables
22563 @opindex funwind-tables
22564 Similar to @option{-fexceptions}, except that it just generates any needed
22565 static data, but does not affect the generated code in any other way.
22566 You normally do not need to enable this option; instead, a language processor
22567 that needs this handling enables it on your behalf.
22569 @item -fasynchronous-unwind-tables
22570 @opindex fasynchronous-unwind-tables
22571 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22572 table is exact at each instruction boundary, so it can be used for stack
22573 unwinding from asynchronous events (such as debugger or garbage collector).
22575 @item -fno-gnu-unique
22576 @opindex fno-gnu-unique
22577 On systems with recent GNU assembler and C library, the C++ compiler
22578 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22579 of template static data members and static local variables in inline
22580 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22581 is necessary to avoid problems with a library used by two different
22582 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22583 therefore disagreeing with the other one about the binding of the
22584 symbol.  But this causes @code{dlclose} to be ignored for affected
22585 DSOs; if your program relies on reinitialization of a DSO via
22586 @code{dlclose} and @code{dlopen}, you can use
22587 @option{-fno-gnu-unique}.
22589 @item -fpcc-struct-return
22590 @opindex fpcc-struct-return
22591 Return ``short'' @code{struct} and @code{union} values in memory like
22592 longer ones, rather than in registers.  This convention is less
22593 efficient, but it has the advantage of allowing intercallability between
22594 GCC-compiled files and files compiled with other compilers, particularly
22595 the Portable C Compiler (pcc).
22597 The precise convention for returning structures in memory depends
22598 on the target configuration macros.
22600 Short structures and unions are those whose size and alignment match
22601 that of some integer type.
22603 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22604 switch is not binary compatible with code compiled with the
22605 @option{-freg-struct-return} switch.
22606 Use it to conform to a non-default application binary interface.
22608 @item -freg-struct-return
22609 @opindex freg-struct-return
22610 Return @code{struct} and @code{union} values in registers when possible.
22611 This is more efficient for small structures than
22612 @option{-fpcc-struct-return}.
22614 If you specify neither @option{-fpcc-struct-return} nor
22615 @option{-freg-struct-return}, GCC defaults to whichever convention is
22616 standard for the target.  If there is no standard convention, GCC
22617 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22618 the principal compiler.  In those cases, we can choose the standard, and
22619 we chose the more efficient register return alternative.
22621 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22622 switch is not binary compatible with code compiled with the
22623 @option{-fpcc-struct-return} switch.
22624 Use it to conform to a non-default application binary interface.
22626 @item -fshort-enums
22627 @opindex fshort-enums
22628 Allocate to an @code{enum} type only as many bytes as it needs for the
22629 declared range of possible values.  Specifically, the @code{enum} type
22630 is equivalent to the smallest integer type that has enough room.
22632 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22633 code that is not binary compatible with code generated without that switch.
22634 Use it to conform to a non-default application binary interface.
22636 @item -fshort-double
22637 @opindex fshort-double
22638 Use the same size for @code{double} as for @code{float}.
22640 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22641 code that is not binary compatible with code generated without that switch.
22642 Use it to conform to a non-default application binary interface.
22644 @item -fshort-wchar
22645 @opindex fshort-wchar
22646 Override the underlying type for @samp{wchar_t} to be @samp{short
22647 unsigned int} instead of the default for the target.  This option is
22648 useful for building programs to run under WINE@.
22650 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22651 code that is not binary compatible with code generated without that switch.
22652 Use it to conform to a non-default application binary interface.
22654 @item -fno-common
22655 @opindex fno-common
22656 In C code, controls the placement of uninitialized global variables.
22657 Unix C compilers have traditionally permitted multiple definitions of
22658 such variables in different compilation units by placing the variables
22659 in a common block.
22660 This is the behavior specified by @option{-fcommon}, and is the default
22661 for GCC on most targets.
22662 On the other hand, this behavior is not required by ISO C, and on some
22663 targets may carry a speed or code size penalty on variable references.
22664 The @option{-fno-common} option specifies that the compiler should place
22665 uninitialized global variables in the data section of the object file,
22666 rather than generating them as common blocks.
22667 This has the effect that if the same variable is declared
22668 (without @code{extern}) in two different compilations,
22669 you get a multiple-definition error when you link them.
22670 In this case, you must compile with @option{-fcommon} instead.
22671 Compiling with @option{-fno-common} is useful on targets for which
22672 it provides better performance, or if you wish to verify that the
22673 program will work on other systems that always treat uninitialized
22674 variable declarations this way.
22676 @item -fno-ident
22677 @opindex fno-ident
22678 Ignore the @samp{#ident} directive.
22680 @item -finhibit-size-directive
22681 @opindex finhibit-size-directive
22682 Don't output a @code{.size} assembler directive, or anything else that
22683 would cause trouble if the function is split in the middle, and the
22684 two halves are placed at locations far apart in memory.  This option is
22685 used when compiling @file{crtstuff.c}; you should not need to use it
22686 for anything else.
22688 @item -fverbose-asm
22689 @opindex fverbose-asm
22690 Put extra commentary information in the generated assembly code to
22691 make it more readable.  This option is generally only of use to those
22692 who actually need to read the generated assembly code (perhaps while
22693 debugging the compiler itself).
22695 @option{-fno-verbose-asm}, the default, causes the
22696 extra information to be omitted and is useful when comparing two assembler
22697 files.
22699 @item -frecord-gcc-switches
22700 @opindex frecord-gcc-switches
22701 This switch causes the command line used to invoke the
22702 compiler to be recorded into the object file that is being created.
22703 This switch is only implemented on some targets and the exact format
22704 of the recording is target and binary file format dependent, but it
22705 usually takes the form of a section containing ASCII text.  This
22706 switch is related to the @option{-fverbose-asm} switch, but that
22707 switch only records information in the assembler output file as
22708 comments, so it never reaches the object file.
22709 See also @option{-grecord-gcc-switches} for another
22710 way of storing compiler options into the object file.
22712 @item -fpic
22713 @opindex fpic
22714 @cindex global offset table
22715 @cindex PIC
22716 Generate position-independent code (PIC) suitable for use in a shared
22717 library, if supported for the target machine.  Such code accesses all
22718 constant addresses through a global offset table (GOT)@.  The dynamic
22719 loader resolves the GOT entries when the program starts (the dynamic
22720 loader is not part of GCC; it is part of the operating system).  If
22721 the GOT size for the linked executable exceeds a machine-specific
22722 maximum size, you get an error message from the linker indicating that
22723 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
22724 instead.  (These maximums are 8k on the SPARC and 32k
22725 on the m68k and RS/6000.  The 386 has no such limit.)
22727 Position-independent code requires special support, and therefore works
22728 only on certain machines.  For the 386, GCC supports PIC for System V
22729 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
22730 position-independent.
22732 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22733 are defined to 1.
22735 @item -fPIC
22736 @opindex fPIC
22737 If supported for the target machine, emit position-independent code,
22738 suitable for dynamic linking and avoiding any limit on the size of the
22739 global offset table.  This option makes a difference on the m68k,
22740 PowerPC and SPARC@.
22742 Position-independent code requires special support, and therefore works
22743 only on certain machines.
22745 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22746 are defined to 2.
22748 @item -fpie
22749 @itemx -fPIE
22750 @opindex fpie
22751 @opindex fPIE
22752 These options are similar to @option{-fpic} and @option{-fPIC}, but
22753 generated position independent code can be only linked into executables.
22754 Usually these options are used when @option{-pie} GCC option is
22755 used during linking.
22757 @option{-fpie} and @option{-fPIE} both define the macros
22758 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
22759 for @option{-fpie} and 2 for @option{-fPIE}.
22761 @item -fno-jump-tables
22762 @opindex fno-jump-tables
22763 Do not use jump tables for switch statements even where it would be
22764 more efficient than other code generation strategies.  This option is
22765 of use in conjunction with @option{-fpic} or @option{-fPIC} for
22766 building code that forms part of a dynamic linker and cannot
22767 reference the address of a jump table.  On some targets, jump tables
22768 do not require a GOT and this option is not needed.
22770 @item -ffixed-@var{reg}
22771 @opindex ffixed
22772 Treat the register named @var{reg} as a fixed register; generated code
22773 should never refer to it (except perhaps as a stack pointer, frame
22774 pointer or in some other fixed role).
22776 @var{reg} must be the name of a register.  The register names accepted
22777 are machine-specific and are defined in the @code{REGISTER_NAMES}
22778 macro in the machine description macro file.
22780 This flag does not have a negative form, because it specifies a
22781 three-way choice.
22783 @item -fcall-used-@var{reg}
22784 @opindex fcall-used
22785 Treat the register named @var{reg} as an allocable register that is
22786 clobbered by function calls.  It may be allocated for temporaries or
22787 variables that do not live across a call.  Functions compiled this way
22788 do not save and restore the register @var{reg}.
22790 It is an error to use this flag with the frame pointer or stack pointer.
22791 Use of this flag for other registers that have fixed pervasive roles in
22792 the machine's execution model produces disastrous results.
22794 This flag does not have a negative form, because it specifies a
22795 three-way choice.
22797 @item -fcall-saved-@var{reg}
22798 @opindex fcall-saved
22799 Treat the register named @var{reg} as an allocable register saved by
22800 functions.  It may be allocated even for temporaries or variables that
22801 live across a call.  Functions compiled this way save and restore
22802 the register @var{reg} if they use it.
22804 It is an error to use this flag with the frame pointer or stack pointer.
22805 Use of this flag for other registers that have fixed pervasive roles in
22806 the machine's execution model produces disastrous results.
22808 A different sort of disaster results from the use of this flag for
22809 a register in which function values may be returned.
22811 This flag does not have a negative form, because it specifies a
22812 three-way choice.
22814 @item -fpack-struct[=@var{n}]
22815 @opindex fpack-struct
22816 Without a value specified, pack all structure members together without
22817 holes.  When a value is specified (which must be a small power of two), pack
22818 structure members according to this value, representing the maximum
22819 alignment (that is, objects with default alignment requirements larger than
22820 this are output potentially unaligned at the next fitting location.
22822 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
22823 code that is not binary compatible with code generated without that switch.
22824 Additionally, it makes the code suboptimal.
22825 Use it to conform to a non-default application binary interface.
22827 @item -finstrument-functions
22828 @opindex finstrument-functions
22829 Generate instrumentation calls for entry and exit to functions.  Just
22830 after function entry and just before function exit, the following
22831 profiling functions are called with the address of the current
22832 function and its call site.  (On some platforms,
22833 @code{__builtin_return_address} does not work beyond the current
22834 function, so the call site information may not be available to the
22835 profiling functions otherwise.)
22837 @smallexample
22838 void __cyg_profile_func_enter (void *this_fn,
22839                                void *call_site);
22840 void __cyg_profile_func_exit  (void *this_fn,
22841                                void *call_site);
22842 @end smallexample
22844 The first argument is the address of the start of the current function,
22845 which may be looked up exactly in the symbol table.
22847 This instrumentation is also done for functions expanded inline in other
22848 functions.  The profiling calls indicate where, conceptually, the
22849 inline function is entered and exited.  This means that addressable
22850 versions of such functions must be available.  If all your uses of a
22851 function are expanded inline, this may mean an additional expansion of
22852 code size.  If you use @samp{extern inline} in your C code, an
22853 addressable version of such functions must be provided.  (This is
22854 normally the case anyway, but if you get lucky and the optimizer always
22855 expands the functions inline, you might have gotten away without
22856 providing static copies.)
22858 A function may be given the attribute @code{no_instrument_function}, in
22859 which case this instrumentation is not done.  This can be used, for
22860 example, for the profiling functions listed above, high-priority
22861 interrupt routines, and any functions from which the profiling functions
22862 cannot safely be called (perhaps signal handlers, if the profiling
22863 routines generate output or allocate memory).
22865 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
22866 @opindex finstrument-functions-exclude-file-list
22868 Set the list of functions that are excluded from instrumentation (see
22869 the description of @code{-finstrument-functions}).  If the file that
22870 contains a function definition matches with one of @var{file}, then
22871 that function is not instrumented.  The match is done on substrings:
22872 if the @var{file} parameter is a substring of the file name, it is
22873 considered to be a match.
22875 For example:
22877 @smallexample
22878 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
22879 @end smallexample
22881 @noindent
22882 excludes any inline function defined in files whose pathnames
22883 contain @code{/bits/stl} or @code{include/sys}.
22885 If, for some reason, you want to include letter @code{','} in one of
22886 @var{sym}, write @code{'\,'}. For example,
22887 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
22888 (note the single quote surrounding the option).
22890 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
22891 @opindex finstrument-functions-exclude-function-list
22893 This is similar to @code{-finstrument-functions-exclude-file-list},
22894 but this option sets the list of function names to be excluded from
22895 instrumentation.  The function name to be matched is its user-visible
22896 name, such as @code{vector<int> blah(const vector<int> &)}, not the
22897 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
22898 match is done on substrings: if the @var{sym} parameter is a substring
22899 of the function name, it is considered to be a match.  For C99 and C++
22900 extended identifiers, the function name must be given in UTF-8, not
22901 using universal character names.
22903 @item -fstack-check
22904 @opindex fstack-check
22905 Generate code to verify that you do not go beyond the boundary of the
22906 stack.  You should specify this flag if you are running in an
22907 environment with multiple threads, but you only rarely need to specify it in
22908 a single-threaded environment since stack overflow is automatically
22909 detected on nearly all systems if there is only one stack.
22911 Note that this switch does not actually cause checking to be done; the
22912 operating system or the language runtime must do that.  The switch causes
22913 generation of code to ensure that they see the stack being extended.
22915 You can additionally specify a string parameter: @code{no} means no
22916 checking, @code{generic} means force the use of old-style checking,
22917 @code{specific} means use the best checking method and is equivalent
22918 to bare @option{-fstack-check}.
22920 Old-style checking is a generic mechanism that requires no specific
22921 target support in the compiler but comes with the following drawbacks:
22923 @enumerate
22924 @item
22925 Modified allocation strategy for large objects: they are always
22926 allocated dynamically if their size exceeds a fixed threshold.
22928 @item
22929 Fixed limit on the size of the static frame of functions: when it is
22930 topped by a particular function, stack checking is not reliable and
22931 a warning is issued by the compiler.
22933 @item
22934 Inefficiency: because of both the modified allocation strategy and the
22935 generic implementation, code performance is hampered.
22936 @end enumerate
22938 Note that old-style stack checking is also the fallback method for
22939 @code{specific} if no target support has been added in the compiler.
22941 @item -fstack-limit-register=@var{reg}
22942 @itemx -fstack-limit-symbol=@var{sym}
22943 @itemx -fno-stack-limit
22944 @opindex fstack-limit-register
22945 @opindex fstack-limit-symbol
22946 @opindex fno-stack-limit
22947 Generate code to ensure that the stack does not grow beyond a certain value,
22948 either the value of a register or the address of a symbol.  If a larger
22949 stack is required, a signal is raised at run time.  For most targets,
22950 the signal is raised before the stack overruns the boundary, so
22951 it is possible to catch the signal without taking special precautions.
22953 For instance, if the stack starts at absolute address @samp{0x80000000}
22954 and grows downwards, you can use the flags
22955 @option{-fstack-limit-symbol=__stack_limit} and
22956 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
22957 of 128KB@.  Note that this may only work with the GNU linker.
22959 @item -fsplit-stack
22960 @opindex fsplit-stack
22961 Generate code to automatically split the stack before it overflows.
22962 The resulting program has a discontiguous stack which can only
22963 overflow if the program is unable to allocate any more memory.  This
22964 is most useful when running threaded programs, as it is no longer
22965 necessary to calculate a good stack size to use for each thread.  This
22966 is currently only implemented for the i386 and x86_64 back ends running
22967 GNU/Linux.
22969 When code compiled with @option{-fsplit-stack} calls code compiled
22970 without @option{-fsplit-stack}, there may not be much stack space
22971 available for the latter code to run.  If compiling all code,
22972 including library code, with @option{-fsplit-stack} is not an option,
22973 then the linker can fix up these calls so that the code compiled
22974 without @option{-fsplit-stack} always has a large stack.  Support for
22975 this is implemented in the gold linker in GNU binutils release 2.21
22976 and later.
22978 @item -fleading-underscore
22979 @opindex fleading-underscore
22980 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
22981 change the way C symbols are represented in the object file.  One use
22982 is to help link with legacy assembly code.
22984 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
22985 generate code that is not binary compatible with code generated without that
22986 switch.  Use it to conform to a non-default application binary interface.
22987 Not all targets provide complete support for this switch.
22989 @item -ftls-model=@var{model}
22990 @opindex ftls-model
22991 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
22992 The @var{model} argument should be one of @code{global-dynamic},
22993 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
22994 Note that the choice is subject to optimization: the compiler may use
22995 a more efficient model for symbols not visible outside of the translation
22996 unit, or if @option{-fpic} is not given on the command line.
22998 The default without @option{-fpic} is @code{initial-exec}; with
22999 @option{-fpic} the default is @code{global-dynamic}.
23001 @item -fvisibility=@var{default|internal|hidden|protected}
23002 @opindex fvisibility
23003 Set the default ELF image symbol visibility to the specified option---all
23004 symbols are marked with this unless overridden within the code.
23005 Using this feature can very substantially improve linking and
23006 load times of shared object libraries, produce more optimized
23007 code, provide near-perfect API export and prevent symbol clashes.
23008 It is @strong{strongly} recommended that you use this in any shared objects
23009 you distribute.
23011 Despite the nomenclature, @code{default} always means public; i.e.,
23012 available to be linked against from outside the shared object.
23013 @code{protected} and @code{internal} are pretty useless in real-world
23014 usage so the only other commonly used option is @code{hidden}.
23015 The default if @option{-fvisibility} isn't specified is
23016 @code{default}, i.e., make every
23017 symbol public---this causes the same behavior as previous versions of
23018 GCC@.
23020 A good explanation of the benefits offered by ensuring ELF
23021 symbols have the correct visibility is given by ``How To Write
23022 Shared Libraries'' by Ulrich Drepper (which can be found at
23023 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
23024 solution made possible by this option to marking things hidden when
23025 the default is public is to make the default hidden and mark things
23026 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
23027 and @code{__attribute__ ((visibility("default")))} instead of
23028 @code{__declspec(dllexport)} you get almost identical semantics with
23029 identical syntax.  This is a great boon to those working with
23030 cross-platform projects.
23032 For those adding visibility support to existing code, you may find
23033 @samp{#pragma GCC visibility} of use.  This works by you enclosing
23034 the declarations you wish to set visibility for with (for example)
23035 @samp{#pragma GCC visibility push(hidden)} and
23036 @samp{#pragma GCC visibility pop}.
23037 Bear in mind that symbol visibility should be viewed @strong{as
23038 part of the API interface contract} and thus all new code should
23039 always specify visibility when it is not the default; i.e., declarations
23040 only for use within the local DSO should @strong{always} be marked explicitly
23041 as hidden as so to avoid PLT indirection overheads---making this
23042 abundantly clear also aids readability and self-documentation of the code.
23043 Note that due to ISO C++ specification requirements, @code{operator new} and
23044 @code{operator delete} must always be of default visibility.
23046 Be aware that headers from outside your project, in particular system
23047 headers and headers from any other library you use, may not be
23048 expecting to be compiled with visibility other than the default.  You
23049 may need to explicitly say @samp{#pragma GCC visibility push(default)}
23050 before including any such headers.
23052 @samp{extern} declarations are not affected by @option{-fvisibility}, so
23053 a lot of code can be recompiled with @option{-fvisibility=hidden} with
23054 no modifications.  However, this means that calls to @code{extern}
23055 functions with no explicit visibility use the PLT, so it is more
23056 effective to use @code{__attribute ((visibility))} and/or
23057 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
23058 declarations should be treated as hidden.
23060 Note that @option{-fvisibility} does affect C++ vague linkage
23061 entities. This means that, for instance, an exception class that is
23062 be thrown between DSOs must be explicitly marked with default
23063 visibility so that the @samp{type_info} nodes are unified between
23064 the DSOs.
23066 An overview of these techniques, their benefits and how to use them
23067 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
23069 @item -fstrict-volatile-bitfields
23070 @opindex fstrict-volatile-bitfields
23071 This option should be used if accesses to volatile bit-fields (or other
23072 structure fields, although the compiler usually honors those types
23073 anyway) should use a single access of the width of the
23074 field's type, aligned to a natural alignment if possible.  For
23075 example, targets with memory-mapped peripheral registers might require
23076 all such accesses to be 16 bits wide; with this flag you can
23077 declare all peripheral bit-fields as @code{unsigned short} (assuming short
23078 is 16 bits on these targets) to force GCC to use 16-bit accesses
23079 instead of, perhaps, a more efficient 32-bit access.
23081 If this option is disabled, the compiler uses the most efficient
23082 instruction.  In the previous example, that might be a 32-bit load
23083 instruction, even though that accesses bytes that do not contain
23084 any portion of the bit-field, or memory-mapped registers unrelated to
23085 the one being updated.
23087 In some cases, such as when the @code{packed} attribute is applied to a 
23088 structure field, it may not be possible to access the field with a single
23089 read or write that is correctly aligned for the target machine.  In this
23090 case GCC falls back to generating multiple accesses rather than code that 
23091 will fault or truncate the result at run time.
23093 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
23094 not allowed to touch non bit-field members.  It is therefore recommended
23095 to define all bits of the field's type as bit-field members.
23097 The default value of this option is determined by the application binary
23098 interface for the target processor.
23100 @item -fsync-libcalls
23101 @opindex fsync-libcalls
23102 This option controls whether any out-of-line instance of the @code{__sync}
23103 family of functions may be used to implement the C++11 @code{__atomic}
23104 family of functions.
23106 The default value of this option is enabled, thus the only useful form
23107 of the option is @option{-fno-sync-libcalls}.  This option is used in
23108 the implementation of the @file{libatomic} runtime library.
23110 @end table
23112 @c man end
23114 @node Environment Variables
23115 @section Environment Variables Affecting GCC
23116 @cindex environment variables
23118 @c man begin ENVIRONMENT
23119 This section describes several environment variables that affect how GCC
23120 operates.  Some of them work by specifying directories or prefixes to use
23121 when searching for various kinds of files.  Some are used to specify other
23122 aspects of the compilation environment.
23124 Note that you can also specify places to search using options such as
23125 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
23126 take precedence over places specified using environment variables, which
23127 in turn take precedence over those specified by the configuration of GCC@.
23128 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
23129 GNU Compiler Collection (GCC) Internals}.
23131 @table @env
23132 @item LANG
23133 @itemx LC_CTYPE
23134 @c @itemx LC_COLLATE
23135 @itemx LC_MESSAGES
23136 @c @itemx LC_MONETARY
23137 @c @itemx LC_NUMERIC
23138 @c @itemx LC_TIME
23139 @itemx LC_ALL
23140 @findex LANG
23141 @findex LC_CTYPE
23142 @c @findex LC_COLLATE
23143 @findex LC_MESSAGES
23144 @c @findex LC_MONETARY
23145 @c @findex LC_NUMERIC
23146 @c @findex LC_TIME
23147 @findex LC_ALL
23148 @cindex locale
23149 These environment variables control the way that GCC uses
23150 localization information which allows GCC to work with different
23151 national conventions.  GCC inspects the locale categories
23152 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
23153 so.  These locale categories can be set to any value supported by your
23154 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
23155 Kingdom encoded in UTF-8.
23157 The @env{LC_CTYPE} environment variable specifies character
23158 classification.  GCC uses it to determine the character boundaries in
23159 a string; this is needed for some multibyte encodings that contain quote
23160 and escape characters that are otherwise interpreted as a string
23161 end or escape.
23163 The @env{LC_MESSAGES} environment variable specifies the language to
23164 use in diagnostic messages.
23166 If the @env{LC_ALL} environment variable is set, it overrides the value
23167 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
23168 and @env{LC_MESSAGES} default to the value of the @env{LANG}
23169 environment variable.  If none of these variables are set, GCC
23170 defaults to traditional C English behavior.
23172 @item TMPDIR
23173 @findex TMPDIR
23174 If @env{TMPDIR} is set, it specifies the directory to use for temporary
23175 files.  GCC uses temporary files to hold the output of one stage of
23176 compilation which is to be used as input to the next stage: for example,
23177 the output of the preprocessor, which is the input to the compiler
23178 proper.
23180 @item GCC_COMPARE_DEBUG
23181 @findex GCC_COMPARE_DEBUG
23182 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
23183 @option{-fcompare-debug} to the compiler driver.  See the documentation
23184 of this option for more details.
23186 @item GCC_EXEC_PREFIX
23187 @findex GCC_EXEC_PREFIX
23188 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
23189 names of the subprograms executed by the compiler.  No slash is added
23190 when this prefix is combined with the name of a subprogram, but you can
23191 specify a prefix that ends with a slash if you wish.
23193 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
23194 an appropriate prefix to use based on the pathname it is invoked with.
23196 If GCC cannot find the subprogram using the specified prefix, it
23197 tries looking in the usual places for the subprogram.
23199 The default value of @env{GCC_EXEC_PREFIX} is
23200 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
23201 the installed compiler. In many cases @var{prefix} is the value
23202 of @code{prefix} when you ran the @file{configure} script.
23204 Other prefixes specified with @option{-B} take precedence over this prefix.
23206 This prefix is also used for finding files such as @file{crt0.o} that are
23207 used for linking.
23209 In addition, the prefix is used in an unusual way in finding the
23210 directories to search for header files.  For each of the standard
23211 directories whose name normally begins with @samp{/usr/local/lib/gcc}
23212 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
23213 replacing that beginning with the specified prefix to produce an
23214 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
23215 @file{foo/bar} just before it searches the standard directory 
23216 @file{/usr/local/lib/bar}.
23217 If a standard directory begins with the configured
23218 @var{prefix} then the value of @var{prefix} is replaced by
23219 @env{GCC_EXEC_PREFIX} when looking for header files.
23221 @item COMPILER_PATH
23222 @findex COMPILER_PATH
23223 The value of @env{COMPILER_PATH} is a colon-separated list of
23224 directories, much like @env{PATH}.  GCC tries the directories thus
23225 specified when searching for subprograms, if it can't find the
23226 subprograms using @env{GCC_EXEC_PREFIX}.
23228 @item LIBRARY_PATH
23229 @findex LIBRARY_PATH
23230 The value of @env{LIBRARY_PATH} is a colon-separated list of
23231 directories, much like @env{PATH}.  When configured as a native compiler,
23232 GCC tries the directories thus specified when searching for special
23233 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
23234 using GCC also uses these directories when searching for ordinary
23235 libraries for the @option{-l} option (but directories specified with
23236 @option{-L} come first).
23238 @item LANG
23239 @findex LANG
23240 @cindex locale definition
23241 This variable is used to pass locale information to the compiler.  One way in
23242 which this information is used is to determine the character set to be used
23243 when character literals, string literals and comments are parsed in C and C++.
23244 When the compiler is configured to allow multibyte characters,
23245 the following values for @env{LANG} are recognized:
23247 @table @samp
23248 @item C-JIS
23249 Recognize JIS characters.
23250 @item C-SJIS
23251 Recognize SJIS characters.
23252 @item C-EUCJP
23253 Recognize EUCJP characters.
23254 @end table
23256 If @env{LANG} is not defined, or if it has some other value, then the
23257 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
23258 recognize and translate multibyte characters.
23259 @end table
23261 @noindent
23262 Some additional environment variables affect the behavior of the
23263 preprocessor.
23265 @include cppenv.texi
23267 @c man end
23269 @node Precompiled Headers
23270 @section Using Precompiled Headers
23271 @cindex precompiled headers
23272 @cindex speed of compilation
23274 Often large projects have many header files that are included in every
23275 source file.  The time the compiler takes to process these header files
23276 over and over again can account for nearly all of the time required to
23277 build the project.  To make builds faster, GCC allows you to
23278 @dfn{precompile} a header file.
23280 To create a precompiled header file, simply compile it as you would any
23281 other file, if necessary using the @option{-x} option to make the driver
23282 treat it as a C or C++ header file.  You may want to use a
23283 tool like @command{make} to keep the precompiled header up-to-date when
23284 the headers it contains change.
23286 A precompiled header file is searched for when @code{#include} is
23287 seen in the compilation.  As it searches for the included file
23288 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
23289 compiler looks for a precompiled header in each directory just before it
23290 looks for the include file in that directory.  The name searched for is
23291 the name specified in the @code{#include} with @samp{.gch} appended.  If
23292 the precompiled header file can't be used, it is ignored.
23294 For instance, if you have @code{#include "all.h"}, and you have
23295 @file{all.h.gch} in the same directory as @file{all.h}, then the
23296 precompiled header file is used if possible, and the original
23297 header is used otherwise.
23299 Alternatively, you might decide to put the precompiled header file in a
23300 directory and use @option{-I} to ensure that directory is searched
23301 before (or instead of) the directory containing the original header.
23302 Then, if you want to check that the precompiled header file is always
23303 used, you can put a file of the same name as the original header in this
23304 directory containing an @code{#error} command.
23306 This also works with @option{-include}.  So yet another way to use
23307 precompiled headers, good for projects not designed with precompiled
23308 header files in mind, is to simply take most of the header files used by
23309 a project, include them from another header file, precompile that header
23310 file, and @option{-include} the precompiled header.  If the header files
23311 have guards against multiple inclusion, they are skipped because
23312 they've already been included (in the precompiled header).
23314 If you need to precompile the same header file for different
23315 languages, targets, or compiler options, you can instead make a
23316 @emph{directory} named like @file{all.h.gch}, and put each precompiled
23317 header in the directory, perhaps using @option{-o}.  It doesn't matter
23318 what you call the files in the directory; every precompiled header in
23319 the directory is considered.  The first precompiled header
23320 encountered in the directory that is valid for this compilation is
23321 used; they're searched in no particular order.
23323 There are many other possibilities, limited only by your imagination,
23324 good sense, and the constraints of your build system.
23326 A precompiled header file can be used only when these conditions apply:
23328 @itemize
23329 @item
23330 Only one precompiled header can be used in a particular compilation.
23332 @item
23333 A precompiled header can't be used once the first C token is seen.  You
23334 can have preprocessor directives before a precompiled header; you cannot
23335 include a precompiled header from inside another header.
23337 @item
23338 The precompiled header file must be produced for the same language as
23339 the current compilation.  You can't use a C precompiled header for a C++
23340 compilation.
23342 @item
23343 The precompiled header file must have been produced by the same compiler
23344 binary as the current compilation is using.
23346 @item
23347 Any macros defined before the precompiled header is included must
23348 either be defined in the same way as when the precompiled header was
23349 generated, or must not affect the precompiled header, which usually
23350 means that they don't appear in the precompiled header at all.
23352 The @option{-D} option is one way to define a macro before a
23353 precompiled header is included; using a @code{#define} can also do it.
23354 There are also some options that define macros implicitly, like
23355 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23356 defined this way.
23358 @item If debugging information is output when using the precompiled
23359 header, using @option{-g} or similar, the same kind of debugging information
23360 must have been output when building the precompiled header.  However,
23361 a precompiled header built using @option{-g} can be used in a compilation
23362 when no debugging information is being output.
23364 @item The same @option{-m} options must generally be used when building
23365 and using the precompiled header.  @xref{Submodel Options},
23366 for any cases where this rule is relaxed.
23368 @item Each of the following options must be the same when building and using
23369 the precompiled header:
23371 @gccoptlist{-fexceptions}
23373 @item
23374 Some other command-line options starting with @option{-f},
23375 @option{-p}, or @option{-O} must be defined in the same way as when
23376 the precompiled header was generated.  At present, it's not clear
23377 which options are safe to change and which are not; the safest choice
23378 is to use exactly the same options when generating and using the
23379 precompiled header.  The following are known to be safe:
23381 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23382 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23383 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23384 -pedantic-errors}
23386 @end itemize
23388 For all of these except the last, the compiler automatically
23389 ignores the precompiled header if the conditions aren't met.  If you
23390 find an option combination that doesn't work and doesn't cause the
23391 precompiled header to be ignored, please consider filing a bug report,
23392 see @ref{Bugs}.
23394 If you do use differing options when generating and using the
23395 precompiled header, the actual behavior is a mixture of the
23396 behavior for the options.  For instance, if you use @option{-g} to
23397 generate the precompiled header but not when using it, you may or may
23398 not get debugging information for routines in the precompiled header.