2014-06-24 Marc Glisse <marc.glisse@inria.fr>
[official-gcc.git] / gcc / doc / invoke.texi
blob3a02125de850bb3173b9b0745cfedc261b27c365
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  -fno-weak  -nostdinc++ @gol
193 -fvisibility-inlines-hidden @gol
194 -fvtable-verify=@var{std|preinit|none} @gol
195 -fvtv-counts -fvtv-debug @gol
196 -fvisibility-ms-compat @gol
197 -fext-numeric-literals @gol
198 -Wabi=@var{n}  -Wconversion-null  -Wctor-dtor-privacy @gol
199 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
200 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
201 -Weffc++  -Wstrict-null-sentinel @gol
202 -Wno-non-template-friend  -Wold-style-cast @gol
203 -Woverloaded-virtual  -Wno-pmf-conversions @gol
204 -Wsign-promo}
206 @item Objective-C and Objective-C++ Language Options
207 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
208 Objective-C and Objective-C++ Dialects}.
209 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
210 -fgnu-runtime  -fnext-runtime @gol
211 -fno-nil-receivers @gol
212 -fobjc-abi-version=@var{n} @gol
213 -fobjc-call-cxx-cdtors @gol
214 -fobjc-direct-dispatch @gol
215 -fobjc-exceptions @gol
216 -fobjc-gc @gol
217 -fobjc-nilcheck @gol
218 -fobjc-std=objc1 @gol
219 -fno-local-ivars @gol
220 -fivar-visibility=@var{public|protected|private|package} @gol
221 -freplace-objc-classes @gol
222 -fzero-link @gol
223 -gen-decls @gol
224 -Wassign-intercept @gol
225 -Wno-protocol  -Wselector @gol
226 -Wstrict-selector-match @gol
227 -Wundeclared-selector}
229 @item Language Independent Options
230 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
231 @gccoptlist{-fmessage-length=@var{n}  @gol
232 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
233 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
234 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
236 @item Warning Options
237 @xref{Warning Options,,Options to Request or Suppress Warnings}.
238 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
239 -pedantic-errors @gol
240 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
241 -Waggressive-loop-optimizations -Warray-bounds @gol
242 -Wno-attributes -Wno-builtin-macro-redefined @gol
243 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
244 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
245 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
246 -Wno-deprecated -Wno-deprecated-declarations -Wdisabled-optimization  @gol
247 -Wno-discarded-qualifiers @gol
248 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
249 -Wno-endif-labels -Werror  -Werror=* @gol
250 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
251 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
252 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
253 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
254 -Wignored-qualifiers @gol
255 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
256 -Winit-self  -Winline @gol
257 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
258 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
259 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
260 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
261 -Wmissing-include-dirs @gol
262 -Wno-multichar  -Wnonnull  -Wno-overflow -Wopenmp-simd @gol
263 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
264 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
265 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
266 -Wredundant-decls  -Wno-return-local-addr @gol
267 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
268 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
269 -Wsizeof-pointer-memaccess @gol
270 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
271 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
272 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
273 -Wmissing-format-attribute @gol
274 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
275 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
276 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
277 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
278 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
279 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
280 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
281 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
282 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
284 @item C and Objective-C-only Warning Options
285 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
286 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
287 -Wold-style-declaration  -Wold-style-definition @gol
288 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
289 -Wdeclaration-after-statement -Wpointer-sign}
291 @item Debugging Options
292 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
293 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
294 -fsanitize=@var{style} -fsanitize-recover @gol
295 -fsanitize-undefined-trap-on-error @gol
296 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
297 -fdisable-ipa-@var{pass_name} @gol
298 -fdisable-rtl-@var{pass_name} @gol
299 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
300 -fdisable-tree-@var{pass_name} @gol
301 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
302 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
303 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
304 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
305 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
306 -fdump-passes @gol
307 -fdump-statistics @gol
308 -fdump-tree-all @gol
309 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
310 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-cfg -fdump-tree-alias @gol
312 -fdump-tree-ch @gol
313 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-gimple@r{[}-raw@r{]} @gol
316 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
319 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-nrv -fdump-tree-vect @gol
323 -fdump-tree-sink @gol
324 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
325 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
326 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
327 -fdump-tree-vtable-verify @gol
328 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
329 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
330 -fdump-final-insns=@var{file} @gol
331 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
332 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
333 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
334 -fenable-@var{kind}-@var{pass} @gol
335 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
336 -fdebug-types-section -fmem-report-wpa @gol
337 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
338 -fopt-info @gol
339 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
340 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
341 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
342 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
343 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
344 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
345 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
346 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
347 -gvms  -gxcoff  -gxcoff+ @gol
348 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
349 -fdebug-prefix-map=@var{old}=@var{new} @gol
350 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
351 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
352 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
353 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
354 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
355 -print-sysroot -print-sysroot-headers-suffix @gol
356 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
358 @item Optimization Options
359 @xref{Optimize Options,,Options that Control Optimization}.
360 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
361 -falign-jumps[=@var{n}] @gol
362 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
363 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
364 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
365 -fbtr-bb-exclusive -fcaller-saves @gol
366 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
367 -fcompare-elim -fcprop-registers -fcrossjumping @gol
368 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
369 -fcx-limited-range @gol
370 -fdata-sections -fdce -fdelayed-branch @gol
371 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively -fdse @gol
372 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
373 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
374 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
375 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
376 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
377 -fif-conversion2 -findirect-inlining @gol
378 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
379 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
380 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
381 -fira-algorithm=@var{algorithm} @gol
382 -fira-region=@var{region} -fira-hoist-pressure @gol
383 -fira-loop-pressure -fno-ira-share-save-slots @gol
384 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
385 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute
386 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
387 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
388 -floop-parallelize-all -flto -flto-compression-level @gol
389 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
390 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
391 -fmove-loop-invariants -fno-branch-count-reg @gol
392 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
393 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
394 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
395 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
396 -fomit-frame-pointer -foptimize-sibling-calls @gol
397 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
398 -fprefetch-loop-arrays -fprofile-report @gol
399 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
400 -fprofile-generate=@var{path} @gol
401 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
402 -freciprocal-math -free -frename-registers -freorder-blocks @gol
403 -freorder-blocks-and-partition -freorder-functions @gol
404 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
405 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
406 -fsched-spec-load -fsched-spec-load-dangerous @gol
407 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
408 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
409 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
410 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
411 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
412 -fselective-scheduling -fselective-scheduling2 @gol
413 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
414 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
415 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt -fstack-protector @gol
416 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
417 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
418 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
419 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
420 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
421 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
422 -ftree-loop-if-convert-stores -ftree-loop-im @gol
423 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
424 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
425 -ftree-loop-vectorize @gol
426 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
427 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
428 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
429 -ftree-vectorize -ftree-vrp @gol
430 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
431 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
432 -fuse-caller-save -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
433 -fweb -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
434 --param @var{name}=@var{value}
435 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
437 @item Preprocessor Options
438 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
439 @gccoptlist{-A@var{question}=@var{answer} @gol
440 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
441 -C  -dD  -dI  -dM  -dN @gol
442 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
443 -idirafter @var{dir} @gol
444 -include @var{file}  -imacros @var{file} @gol
445 -iprefix @var{file}  -iwithprefix @var{dir} @gol
446 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
447 -imultilib @var{dir} -isysroot @var{dir} @gol
448 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
449 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
450 -remap -trigraphs  -undef  -U@var{macro}  @gol
451 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
453 @item Assembler Option
454 @xref{Assembler Options,,Passing Options to the Assembler}.
455 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
457 @item Linker Options
458 @xref{Link Options,,Options for Linking}.
459 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
460 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
461 -s  -static -static-libgcc -static-libstdc++ @gol
462 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
463 -shared -shared-libgcc  -symbolic @gol
464 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
465 -u @var{symbol}}
467 @item Directory Options
468 @xref{Directory Options,,Options for Directory Search}.
469 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
470 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
471 --sysroot=@var{dir} --no-sysroot-suffix}
473 @item Machine Dependent Options
474 @xref{Submodel Options,,Hardware Models and Configurations}.
475 @c This list is ordered alphanumerically by subsection name.
476 @c Try and put the significant identifier (CPU or system) first,
477 @c so users have a clue at guessing where the ones they want will be.
479 @emph{AArch64 Options}
480 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
481 -mgeneral-regs-only @gol
482 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
483 -mstrict-align @gol
484 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
485 -mtls-dialect=desc  -mtls-dialect=traditional @gol
486 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
488 @emph{Adapteva Epiphany Options}
489 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
490 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
491 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
492 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
493 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
494 -msplit-vecmove-early -m1reg-@var{reg}}
496 @emph{ARC Options}
497 @gccoptlist{-mbarrel-shifter @gol
498 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
499 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
500 -mea -mno-mpy -mmul32x16 -mmul64 @gol
501 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
502 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
503 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
504 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
505 -mucb-mcount -mvolatile-cache @gol
506 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
507 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
508 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
509 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
510 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
511 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
513 @emph{ARM Options}
514 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
515 -mabi=@var{name} @gol
516 -mapcs-stack-check  -mno-apcs-stack-check @gol
517 -mapcs-float  -mno-apcs-float @gol
518 -mapcs-reentrant  -mno-apcs-reentrant @gol
519 -msched-prolog  -mno-sched-prolog @gol
520 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
521 -mfloat-abi=@var{name} @gol
522 -mfp16-format=@var{name}
523 -mthumb-interwork  -mno-thumb-interwork @gol
524 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
525 -mstructure-size-boundary=@var{n} @gol
526 -mabort-on-noreturn @gol
527 -mlong-calls  -mno-long-calls @gol
528 -msingle-pic-base  -mno-single-pic-base @gol
529 -mpic-register=@var{reg} @gol
530 -mnop-fun-dllimport @gol
531 -mpoke-function-name @gol
532 -mthumb  -marm @gol
533 -mtpcs-frame  -mtpcs-leaf-frame @gol
534 -mcaller-super-interworking  -mcallee-super-interworking @gol
535 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
536 -mword-relocations @gol
537 -mfix-cortex-m3-ldrd @gol
538 -munaligned-access @gol
539 -mneon-for-64bits @gol
540 -mslow-flash-data @gol
541 -mrestrict-it}
543 @emph{AVR Options}
544 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
545 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
546 -mstrict-X -mtiny-stack -Waddr-space-convert}
548 @emph{Blackfin Options}
549 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
550 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
551 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
552 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
553 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
554 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
555 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
556 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
557 -micplb}
559 @emph{C6X Options}
560 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
561 -msim -msdata=@var{sdata-type}}
563 @emph{CRIS Options}
564 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
565 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
566 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
567 -mstack-align  -mdata-align  -mconst-align @gol
568 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
569 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
570 -mmul-bug-workaround  -mno-mul-bug-workaround}
572 @emph{CR16 Options}
573 @gccoptlist{-mmac @gol
574 -mcr16cplus -mcr16c @gol
575 -msim -mint32 -mbit-ops
576 -mdata-model=@var{model}}
578 @emph{Darwin Options}
579 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
580 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
581 -client_name  -compatibility_version  -current_version @gol
582 -dead_strip @gol
583 -dependency-file  -dylib_file  -dylinker_install_name @gol
584 -dynamic  -dynamiclib  -exported_symbols_list @gol
585 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
586 -force_flat_namespace  -headerpad_max_install_names @gol
587 -iframework @gol
588 -image_base  -init  -install_name  -keep_private_externs @gol
589 -multi_module  -multiply_defined  -multiply_defined_unused @gol
590 -noall_load   -no_dead_strip_inits_and_terms @gol
591 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
592 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
593 -private_bundle  -read_only_relocs  -sectalign @gol
594 -sectobjectsymbols  -whyload  -seg1addr @gol
595 -sectcreate  -sectobjectsymbols  -sectorder @gol
596 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
597 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
598 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
599 -single_module  -static  -sub_library  -sub_umbrella @gol
600 -twolevel_namespace  -umbrella  -undefined @gol
601 -unexported_symbols_list  -weak_reference_mismatches @gol
602 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
603 -mkernel -mone-byte-bool}
605 @emph{DEC Alpha Options}
606 @gccoptlist{-mno-fp-regs  -msoft-float @gol
607 -mieee  -mieee-with-inexact  -mieee-conformant @gol
608 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
609 -mtrap-precision=@var{mode}  -mbuild-constants @gol
610 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
611 -mbwx  -mmax  -mfix  -mcix @gol
612 -mfloat-vax  -mfloat-ieee @gol
613 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
614 -msmall-text  -mlarge-text @gol
615 -mmemory-latency=@var{time}}
617 @emph{FR30 Options}
618 @gccoptlist{-msmall-model -mno-lsim}
620 @emph{FRV Options}
621 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
622 -mhard-float  -msoft-float @gol
623 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
624 -mdouble  -mno-double @gol
625 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
626 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
627 -mlinked-fp  -mlong-calls  -malign-labels @gol
628 -mlibrary-pic  -macc-4  -macc-8 @gol
629 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
630 -moptimize-membar -mno-optimize-membar @gol
631 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
632 -mvliw-branch  -mno-vliw-branch @gol
633 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
634 -mno-nested-cond-exec  -mtomcat-stats @gol
635 -mTLS -mtls @gol
636 -mcpu=@var{cpu}}
638 @emph{GNU/Linux Options}
639 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
640 -tno-android-cc -tno-android-ld}
642 @emph{H8/300 Options}
643 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
645 @emph{HPPA Options}
646 @gccoptlist{-march=@var{architecture-type} @gol
647 -mdisable-fpregs  -mdisable-indexing @gol
648 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
649 -mfixed-range=@var{register-range} @gol
650 -mjump-in-delay -mlinker-opt -mlong-calls @gol
651 -mlong-load-store  -mno-disable-fpregs @gol
652 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
653 -mno-jump-in-delay  -mno-long-load-store @gol
654 -mno-portable-runtime  -mno-soft-float @gol
655 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
656 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
657 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
658 -munix=@var{unix-std}  -nolibdld  -static  -threads}
660 @emph{i386 and x86-64 Options}
661 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
662 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
663 -mfpmath=@var{unit} @gol
664 -masm=@var{dialect}  -mno-fancy-math-387 @gol
665 -mno-fp-ret-in-387  -msoft-float @gol
666 -mno-wide-multiply  -mrtd  -malign-double @gol
667 -mpreferred-stack-boundary=@var{num} @gol
668 -mincoming-stack-boundary=@var{num} @gol
669 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
670 -mrecip -mrecip=@var{opt} @gol
671 -mvzeroupper -mprefer-avx128 @gol
672 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
673 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
674 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
675 -mclflushopt -mxsavec -mxsaves @gol
676 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
677 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mthreads @gol
678 -mno-align-stringops  -minline-all-stringops @gol
679 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
680 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
681 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
682 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
683 -mregparm=@var{num}  -msseregparm @gol
684 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
685 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
686 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
687 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
688 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
689 -msse2avx -mfentry -m8bit-idiv @gol
690 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
691 -mstack-protector-guard=@var{guard}}
693 @emph{i386 and x86-64 Windows Options}
694 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
695 -mnop-fun-dllimport -mthread @gol
696 -municode -mwin32 -mwindows -fno-set-stack-executable}
698 @emph{IA-64 Options}
699 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
700 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
701 -mconstant-gp  -mauto-pic  -mfused-madd @gol
702 -minline-float-divide-min-latency @gol
703 -minline-float-divide-max-throughput @gol
704 -mno-inline-float-divide @gol
705 -minline-int-divide-min-latency @gol
706 -minline-int-divide-max-throughput  @gol
707 -mno-inline-int-divide @gol
708 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
709 -mno-inline-sqrt @gol
710 -mdwarf2-asm -mearly-stop-bits @gol
711 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
712 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
713 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
714 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
715 -msched-spec-ldc -msched-spec-control-ldc @gol
716 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
717 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
718 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
719 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
721 @emph{LM32 Options}
722 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
723 -msign-extend-enabled -muser-enabled}
725 @emph{M32R/D Options}
726 @gccoptlist{-m32r2 -m32rx -m32r @gol
727 -mdebug @gol
728 -malign-loops -mno-align-loops @gol
729 -missue-rate=@var{number} @gol
730 -mbranch-cost=@var{number} @gol
731 -mmodel=@var{code-size-model-type} @gol
732 -msdata=@var{sdata-type} @gol
733 -mno-flush-func -mflush-func=@var{name} @gol
734 -mno-flush-trap -mflush-trap=@var{number} @gol
735 -G @var{num}}
737 @emph{M32C Options}
738 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
740 @emph{M680x0 Options}
741 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
742 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
743 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
744 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
745 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
746 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
747 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
748 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
749 -mxgot -mno-xgot}
751 @emph{MCore Options}
752 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
753 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
754 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
755 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
756 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
758 @emph{MeP Options}
759 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
760 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
761 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
762 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
763 -mtiny=@var{n}}
765 @emph{MicroBlaze Options}
766 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
767 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
768 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
769 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
770 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
772 @emph{MIPS Options}
773 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
774 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
775 -mips64  -mips64r2  -mips64r3  -mips64r5 @gol
776 -mips16  -mno-mips16  -mflip-mips16 @gol
777 -minterlink-compressed -mno-interlink-compressed @gol
778 -minterlink-mips16  -mno-interlink-mips16 @gol
779 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
780 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
781 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
782 -mno-float  -msingle-float  -mdouble-float @gol
783 -mabs=@var{mode}  -mnan=@var{encoding} @gol
784 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
785 -mmcu -mmno-mcu @gol
786 -meva -mno-eva @gol
787 -mvirt -mno-virt @gol
788 -mxpa -mno-xpa @gol
789 -mmicromips -mno-micromips @gol
790 -mfpu=@var{fpu-type} @gol
791 -msmartmips  -mno-smartmips @gol
792 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
793 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
794 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
795 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
796 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
797 -membedded-data  -mno-embedded-data @gol
798 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
799 -mcode-readable=@var{setting} @gol
800 -msplit-addresses  -mno-split-addresses @gol
801 -mexplicit-relocs  -mno-explicit-relocs @gol
802 -mcheck-zero-division  -mno-check-zero-division @gol
803 -mdivide-traps  -mdivide-breaks @gol
804 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
805 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
806 -mfix-24k -mno-fix-24k @gol
807 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
808 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
809 -mfix-vr4120  -mno-fix-vr4120 @gol
810 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
811 -mflush-func=@var{func}  -mno-flush-func @gol
812 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
813 -mfp-exceptions -mno-fp-exceptions @gol
814 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
815 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
817 @emph{MMIX Options}
818 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
819 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
820 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
821 -mno-base-addresses  -msingle-exit  -mno-single-exit}
823 @emph{MN10300 Options}
824 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
825 -mno-am33 -mam33 -mam33-2 -mam34 @gol
826 -mtune=@var{cpu-type} @gol
827 -mreturn-pointer-on-d0 @gol
828 -mno-crt0  -mrelax -mliw -msetlb}
830 @emph{Moxie Options}
831 @gccoptlist{-meb -mel -mno-crt0}
833 @emph{MSP430 Options}
834 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
835 -mhwmult=}
837 @emph{NDS32 Options}
838 @gccoptlist{-mbig-endian -mlittle-endian @gol
839 -mreduced-regs -mfull-regs @gol
840 -mcmov -mno-cmov @gol
841 -mperf-ext -mno-perf-ext @gol
842 -mv3push -mno-v3push @gol
843 -m16bit -mno-16bit @gol
844 -mgp-direct -mno-gp-direct @gol
845 -misr-vector-size=@var{num} @gol
846 -mcache-block-size=@var{num} @gol
847 -march=@var{arch} @gol
848 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
849 -mex9 -mctor-dtor -mrelax}
851 @emph{Nios II Options}
852 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
853 -mno-bypass-cache -mbypass-cache @gol
854 -mno-cache-volatile -mcache-volatile @gol
855 -mno-fast-sw-div -mfast-sw-div @gol
856 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
857 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
858 -mcustom-fpu-cfg=@var{name} @gol
859 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
861 @emph{PDP-11 Options}
862 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
863 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
864 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
865 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
866 -mbranch-expensive  -mbranch-cheap @gol
867 -munix-asm  -mdec-asm}
869 @emph{picoChip Options}
870 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
871 -msymbol-as-address -mno-inefficient-warnings}
873 @emph{PowerPC Options}
874 See RS/6000 and PowerPC Options.
876 @emph{RL78 Options}
877 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78 -m64bit-doubles -m32bit-doubles}
879 @emph{RS/6000 and PowerPC Options}
880 @gccoptlist{-mcpu=@var{cpu-type} @gol
881 -mtune=@var{cpu-type} @gol
882 -mcmodel=@var{code-model} @gol
883 -mpowerpc64 @gol
884 -maltivec  -mno-altivec @gol
885 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
886 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
887 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
888 -mfprnd  -mno-fprnd @gol
889 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
890 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
891 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
892 -malign-power  -malign-natural @gol
893 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
894 -msingle-float -mdouble-float -msimple-fpu @gol
895 -mstring  -mno-string  -mupdate  -mno-update @gol
896 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
897 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
898 -mstrict-align  -mno-strict-align  -mrelocatable @gol
899 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
900 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
901 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
902 -mprioritize-restricted-insns=@var{priority} @gol
903 -msched-costly-dep=@var{dependence_type} @gol
904 -minsert-sched-nops=@var{scheme} @gol
905 -mcall-sysv  -mcall-netbsd @gol
906 -maix-struct-return  -msvr4-struct-return @gol
907 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
908 -mblock-move-inline-limit=@var{num} @gol
909 -misel -mno-isel @gol
910 -misel=yes  -misel=no @gol
911 -mspe -mno-spe @gol
912 -mspe=yes  -mspe=no @gol
913 -mpaired @gol
914 -mgen-cell-microcode -mwarn-cell-microcode @gol
915 -mvrsave -mno-vrsave @gol
916 -mmulhw -mno-mulhw @gol
917 -mdlmzb -mno-dlmzb @gol
918 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
919 -mprototype  -mno-prototype @gol
920 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
921 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
922 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
923 -mno-recip-precision @gol
924 -mveclibabi=@var{type} -mfriz -mno-friz @gol
925 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
926 -msave-toc-indirect -mno-save-toc-indirect @gol
927 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
928 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
929 -mquad-memory -mno-quad-memory @gol
930 -mquad-memory-atomic -mno-quad-memory-atomic @gol
931 -mcompat-align-parm -mno-compat-align-parm}
933 @emph{RX Options}
934 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
935 -mcpu=@gol
936 -mbig-endian-data -mlittle-endian-data @gol
937 -msmall-data @gol
938 -msim  -mno-sim@gol
939 -mas100-syntax -mno-as100-syntax@gol
940 -mrelax@gol
941 -mmax-constant-size=@gol
942 -mint-register=@gol
943 -mpid@gol
944 -mno-warn-multiple-fast-interrupts@gol
945 -msave-acc-in-interrupts}
947 @emph{S/390 and zSeries Options}
948 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
949 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
950 -mlong-double-64 -mlong-double-128 @gol
951 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
952 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
953 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
954 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
955 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
956 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
958 @emph{Score Options}
959 @gccoptlist{-meb -mel @gol
960 -mnhwloop @gol
961 -muls @gol
962 -mmac @gol
963 -mscore5 -mscore5u -mscore7 -mscore7d}
965 @emph{SH Options}
966 @gccoptlist{-m1  -m2  -m2e @gol
967 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
968 -m3  -m3e @gol
969 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
970 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
971 -m5-64media  -m5-64media-nofpu @gol
972 -m5-32media  -m5-32media-nofpu @gol
973 -m5-compact  -m5-compact-nofpu @gol
974 -mb  -ml  -mdalign  -mrelax @gol
975 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
976 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
977 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
978 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
979 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
980 -maccumulate-outgoing-args -minvalid-symbols @gol
981 -matomic-model=@var{atomic-model} @gol
982 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
983 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
984 -mpretend-cmove -mtas}
986 @emph{Solaris 2 Options}
987 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
988 -pthreads -pthread}
990 @emph{SPARC Options}
991 @gccoptlist{-mcpu=@var{cpu-type} @gol
992 -mtune=@var{cpu-type} @gol
993 -mcmodel=@var{code-model} @gol
994 -mmemory-model=@var{mem-model} @gol
995 -m32  -m64  -mapp-regs  -mno-app-regs @gol
996 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
997 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
998 -mhard-quad-float  -msoft-quad-float @gol
999 -mstack-bias  -mno-stack-bias @gol
1000 -munaligned-doubles  -mno-unaligned-doubles @gol
1001 -muser-mode  -mno-user-mode @gol
1002 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1003 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1004 -mcbcond -mno-cbcond @gol
1005 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1006 -mfix-at697f -mfix-ut699}
1008 @emph{SPU Options}
1009 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1010 -msafe-dma -munsafe-dma @gol
1011 -mbranch-hints @gol
1012 -msmall-mem -mlarge-mem -mstdmain @gol
1013 -mfixed-range=@var{register-range} @gol
1014 -mea32 -mea64 @gol
1015 -maddress-space-conversion -mno-address-space-conversion @gol
1016 -mcache-size=@var{cache-size} @gol
1017 -matomic-updates -mno-atomic-updates}
1019 @emph{System V Options}
1020 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1022 @emph{TILE-Gx Options}
1023 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1024 -mcmodel=@var{code-model}}
1026 @emph{TILEPro Options}
1027 @gccoptlist{-mcpu=@var{cpu} -m32}
1029 @emph{V850 Options}
1030 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1031 -mprolog-function  -mno-prolog-function  -mspace @gol
1032 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1033 -mapp-regs  -mno-app-regs @gol
1034 -mdisable-callt  -mno-disable-callt @gol
1035 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1036 -mv850e -mv850 -mv850e3v5 @gol
1037 -mloop @gol
1038 -mrelax @gol
1039 -mlong-jumps @gol
1040 -msoft-float @gol
1041 -mhard-float @gol
1042 -mgcc-abi @gol
1043 -mrh850-abi @gol
1044 -mbig-switch}
1046 @emph{VAX Options}
1047 @gccoptlist{-mg  -mgnu  -munix}
1049 @emph{VMS Options}
1050 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1051 -mpointer-size=@var{size}}
1053 @emph{VxWorks Options}
1054 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1055 -Xbind-lazy  -Xbind-now}
1057 @emph{x86-64 Options}
1058 See i386 and x86-64 Options.
1060 @emph{Xstormy16 Options}
1061 @gccoptlist{-msim}
1063 @emph{Xtensa Options}
1064 @gccoptlist{-mconst16 -mno-const16 @gol
1065 -mfused-madd  -mno-fused-madd @gol
1066 -mforce-no-pic @gol
1067 -mserialize-volatile  -mno-serialize-volatile @gol
1068 -mtext-section-literals  -mno-text-section-literals @gol
1069 -mtarget-align  -mno-target-align @gol
1070 -mlongcalls  -mno-longcalls}
1072 @emph{zSeries Options}
1073 See S/390 and zSeries Options.
1075 @item Code Generation Options
1076 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1077 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1078 -ffixed-@var{reg}  -fexceptions @gol
1079 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1080 -fasynchronous-unwind-tables @gol
1081 -fno-gnu-unique @gol
1082 -finhibit-size-directive  -finstrument-functions @gol
1083 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1084 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1085 -fno-common  -fno-ident @gol
1086 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1087 -fno-jump-tables @gol
1088 -frecord-gcc-switches @gol
1089 -freg-struct-return  -fshort-enums @gol
1090 -fshort-double  -fshort-wchar @gol
1091 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1092 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1093 -fno-stack-limit -fsplit-stack @gol
1094 -fleading-underscore  -ftls-model=@var{model} @gol
1095 -fstack-reuse=@var{reuse_level} @gol
1096 -ftrapv  -fwrapv  -fbounds-check @gol
1097 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1098 @end table
1101 @node Overall Options
1102 @section Options Controlling the Kind of Output
1104 Compilation can involve up to four stages: preprocessing, compilation
1105 proper, assembly and linking, always in that order.  GCC is capable of
1106 preprocessing and compiling several files either into several
1107 assembler input files, or into one assembler input file; then each
1108 assembler input file produces an object file, and linking combines all
1109 the object files (those newly compiled, and those specified as input)
1110 into an executable file.
1112 @cindex file name suffix
1113 For any given input file, the file name suffix determines what kind of
1114 compilation is done:
1116 @table @gcctabopt
1117 @item @var{file}.c
1118 C source code that must be preprocessed.
1120 @item @var{file}.i
1121 C source code that should not be preprocessed.
1123 @item @var{file}.ii
1124 C++ source code that should not be preprocessed.
1126 @item @var{file}.m
1127 Objective-C source code.  Note that you must link with the @file{libobjc}
1128 library to make an Objective-C program work.
1130 @item @var{file}.mi
1131 Objective-C source code that should not be preprocessed.
1133 @item @var{file}.mm
1134 @itemx @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.  Note that @samp{.M} refers
1137 to a literal capital M@.
1139 @item @var{file}.mii
1140 Objective-C++ source code that should not be preprocessed.
1142 @item @var{file}.h
1143 C, C++, Objective-C or Objective-C++ header file to be turned into a
1144 precompiled header (default), or C, C++ header file to be turned into an
1145 Ada spec (via the @option{-fdump-ada-spec} switch).
1147 @item @var{file}.cc
1148 @itemx @var{file}.cp
1149 @itemx @var{file}.cxx
1150 @itemx @var{file}.cpp
1151 @itemx @var{file}.CPP
1152 @itemx @var{file}.c++
1153 @itemx @var{file}.C
1154 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1155 the last two letters must both be literally @samp{x}.  Likewise,
1156 @samp{.C} refers to a literal capital C@.
1158 @item @var{file}.mm
1159 @itemx @var{file}.M
1160 Objective-C++ source code that must be preprocessed.
1162 @item @var{file}.mii
1163 Objective-C++ source code that should not be preprocessed.
1165 @item @var{file}.hh
1166 @itemx @var{file}.H
1167 @itemx @var{file}.hp
1168 @itemx @var{file}.hxx
1169 @itemx @var{file}.hpp
1170 @itemx @var{file}.HPP
1171 @itemx @var{file}.h++
1172 @itemx @var{file}.tcc
1173 C++ header file to be turned into a precompiled header or Ada spec.
1175 @item @var{file}.f
1176 @itemx @var{file}.for
1177 @itemx @var{file}.ftn
1178 Fixed form Fortran source code that should not be preprocessed.
1180 @item @var{file}.F
1181 @itemx @var{file}.FOR
1182 @itemx @var{file}.fpp
1183 @itemx @var{file}.FPP
1184 @itemx @var{file}.FTN
1185 Fixed form Fortran source code that must be preprocessed (with the traditional
1186 preprocessor).
1188 @item @var{file}.f90
1189 @itemx @var{file}.f95
1190 @itemx @var{file}.f03
1191 @itemx @var{file}.f08
1192 Free form Fortran source code that should not be preprocessed.
1194 @item @var{file}.F90
1195 @itemx @var{file}.F95
1196 @itemx @var{file}.F03
1197 @itemx @var{file}.F08
1198 Free form Fortran source code that must be preprocessed (with the
1199 traditional preprocessor).
1201 @item @var{file}.go
1202 Go source code.
1204 @c FIXME: Descriptions of Java file types.
1205 @c @var{file}.java
1206 @c @var{file}.class
1207 @c @var{file}.zip
1208 @c @var{file}.jar
1210 @item @var{file}.ads
1211 Ada source code file that contains a library unit declaration (a
1212 declaration of a package, subprogram, or generic, or a generic
1213 instantiation), or a library unit renaming declaration (a package,
1214 generic, or subprogram renaming declaration).  Such files are also
1215 called @dfn{specs}.
1217 @item @var{file}.adb
1218 Ada source code file containing a library unit body (a subprogram or
1219 package body).  Such files are also called @dfn{bodies}.
1221 @c GCC also knows about some suffixes for languages not yet included:
1222 @c Pascal:
1223 @c @var{file}.p
1224 @c @var{file}.pas
1225 @c Ratfor:
1226 @c @var{file}.r
1228 @item @var{file}.s
1229 Assembler code.
1231 @item @var{file}.S
1232 @itemx @var{file}.sx
1233 Assembler code that must be preprocessed.
1235 @item @var{other}
1236 An object file to be fed straight into linking.
1237 Any file name with no recognized suffix is treated this way.
1238 @end table
1240 @opindex x
1241 You can specify the input language explicitly with the @option{-x} option:
1243 @table @gcctabopt
1244 @item -x @var{language}
1245 Specify explicitly the @var{language} for the following input files
1246 (rather than letting the compiler choose a default based on the file
1247 name suffix).  This option applies to all following input files until
1248 the next @option{-x} option.  Possible values for @var{language} are:
1249 @smallexample
1250 c  c-header  cpp-output
1251 c++  c++-header  c++-cpp-output
1252 objective-c  objective-c-header  objective-c-cpp-output
1253 objective-c++ objective-c++-header objective-c++-cpp-output
1254 assembler  assembler-with-cpp
1256 f77  f77-cpp-input f95  f95-cpp-input
1258 java
1259 @end smallexample
1261 @item -x none
1262 Turn off any specification of a language, so that subsequent files are
1263 handled according to their file name suffixes (as they are if @option{-x}
1264 has not been used at all).
1266 @item -pass-exit-codes
1267 @opindex pass-exit-codes
1268 Normally the @command{gcc} program exits with the code of 1 if any
1269 phase of the compiler returns a non-success return code.  If you specify
1270 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1271 the numerically highest error produced by any phase returning an error
1272 indication.  The C, C++, and Fortran front ends return 4 if an internal
1273 compiler error is encountered.
1274 @end table
1276 If you only want some of the stages of compilation, you can use
1277 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1278 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1279 @command{gcc} is to stop.  Note that some combinations (for example,
1280 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1282 @table @gcctabopt
1283 @item -c
1284 @opindex c
1285 Compile or assemble the source files, but do not link.  The linking
1286 stage simply is not done.  The ultimate output is in the form of an
1287 object file for each source file.
1289 By default, the object file name for a source file is made by replacing
1290 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1292 Unrecognized input files, not requiring compilation or assembly, are
1293 ignored.
1295 @item -S
1296 @opindex S
1297 Stop after the stage of compilation proper; do not assemble.  The output
1298 is in the form of an assembler code file for each non-assembler input
1299 file specified.
1301 By default, the assembler file name for a source file is made by
1302 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1304 Input files that don't require compilation are ignored.
1306 @item -E
1307 @opindex E
1308 Stop after the preprocessing stage; do not run the compiler proper.  The
1309 output is in the form of preprocessed source code, which is sent to the
1310 standard output.
1312 Input files that don't require preprocessing are ignored.
1314 @cindex output file option
1315 @item -o @var{file}
1316 @opindex o
1317 Place output in file @var{file}.  This applies to whatever
1318 sort of output is being produced, whether it be an executable file,
1319 an object file, an assembler file or preprocessed C code.
1321 If @option{-o} is not specified, the default is to put an executable
1322 file in @file{a.out}, the object file for
1323 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1324 assembler file in @file{@var{source}.s}, a precompiled header file in
1325 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1326 standard output.
1328 @item -v
1329 @opindex v
1330 Print (on standard error output) the commands executed to run the stages
1331 of compilation.  Also print the version number of the compiler driver
1332 program and of the preprocessor and the compiler proper.
1334 @item -###
1335 @opindex ###
1336 Like @option{-v} except the commands are not executed and arguments
1337 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1338 This is useful for shell scripts to capture the driver-generated command lines.
1340 @item -pipe
1341 @opindex pipe
1342 Use pipes rather than temporary files for communication between the
1343 various stages of compilation.  This fails to work on some systems where
1344 the assembler is unable to read from a pipe; but the GNU assembler has
1345 no trouble.
1347 @item --help
1348 @opindex help
1349 Print (on the standard output) a description of the command-line options
1350 understood by @command{gcc}.  If the @option{-v} option is also specified
1351 then @option{--help} is also passed on to the various processes
1352 invoked by @command{gcc}, so that they can display the command-line options
1353 they accept.  If the @option{-Wextra} option has also been specified
1354 (prior to the @option{--help} option), then command-line options that
1355 have no documentation associated with them are also displayed.
1357 @item --target-help
1358 @opindex target-help
1359 Print (on the standard output) a description of target-specific command-line
1360 options for each tool.  For some targets extra target-specific
1361 information may also be printed.
1363 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1364 Print (on the standard output) a description of the command-line
1365 options understood by the compiler that fit into all specified classes
1366 and qualifiers.  These are the supported classes:
1368 @table @asis
1369 @item @samp{optimizers}
1370 Display all of the optimization options supported by the
1371 compiler.
1373 @item @samp{warnings}
1374 Display all of the options controlling warning messages
1375 produced by the compiler.
1377 @item @samp{target}
1378 Display target-specific options.  Unlike the
1379 @option{--target-help} option however, target-specific options of the
1380 linker and assembler are not displayed.  This is because those
1381 tools do not currently support the extended @option{--help=} syntax.
1383 @item @samp{params}
1384 Display the values recognized by the @option{--param}
1385 option.
1387 @item @var{language}
1388 Display the options supported for @var{language}, where
1389 @var{language} is the name of one of the languages supported in this
1390 version of GCC@.
1392 @item @samp{common}
1393 Display the options that are common to all languages.
1394 @end table
1396 These are the supported qualifiers:
1398 @table @asis
1399 @item @samp{undocumented}
1400 Display only those options that are undocumented.
1402 @item @samp{joined}
1403 Display options taking an argument that appears after an equal
1404 sign in the same continuous piece of text, such as:
1405 @samp{--help=target}.
1407 @item @samp{separate}
1408 Display options taking an argument that appears as a separate word
1409 following the original option, such as: @samp{-o output-file}.
1410 @end table
1412 Thus for example to display all the undocumented target-specific
1413 switches supported by the compiler, use:
1415 @smallexample
1416 --help=target,undocumented
1417 @end smallexample
1419 The sense of a qualifier can be inverted by prefixing it with the
1420 @samp{^} character, so for example to display all binary warning
1421 options (i.e., ones that are either on or off and that do not take an
1422 argument) that have a description, use:
1424 @smallexample
1425 --help=warnings,^joined,^undocumented
1426 @end smallexample
1428 The argument to @option{--help=} should not consist solely of inverted
1429 qualifiers.
1431 Combining several classes is possible, although this usually
1432 restricts the output so much that there is nothing to display.  One
1433 case where it does work, however, is when one of the classes is
1434 @var{target}.  For example, to display all the target-specific
1435 optimization options, use:
1437 @smallexample
1438 --help=target,optimizers
1439 @end smallexample
1441 The @option{--help=} option can be repeated on the command line.  Each
1442 successive use displays its requested class of options, skipping
1443 those that have already been displayed.
1445 If the @option{-Q} option appears on the command line before the
1446 @option{--help=} option, then the descriptive text displayed by
1447 @option{--help=} is changed.  Instead of describing the displayed
1448 options, an indication is given as to whether the option is enabled,
1449 disabled or set to a specific value (assuming that the compiler
1450 knows this at the point where the @option{--help=} option is used).
1452 Here is a truncated example from the ARM port of @command{gcc}:
1454 @smallexample
1455   % gcc -Q -mabi=2 --help=target -c
1456   The following options are target specific:
1457   -mabi=                                2
1458   -mabort-on-noreturn                   [disabled]
1459   -mapcs                                [disabled]
1460 @end smallexample
1462 The output is sensitive to the effects of previous command-line
1463 options, so for example it is possible to find out which optimizations
1464 are enabled at @option{-O2} by using:
1466 @smallexample
1467 -Q -O2 --help=optimizers
1468 @end smallexample
1470 Alternatively you can discover which binary optimizations are enabled
1471 by @option{-O3} by using:
1473 @smallexample
1474 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1475 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1476 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1477 @end smallexample
1479 @item -no-canonical-prefixes
1480 @opindex no-canonical-prefixes
1481 Do not expand any symbolic links, resolve references to @samp{/../}
1482 or @samp{/./}, or make the path absolute when generating a relative
1483 prefix.
1485 @item --version
1486 @opindex version
1487 Display the version number and copyrights of the invoked GCC@.
1489 @item -wrapper
1490 @opindex wrapper
1491 Invoke all subcommands under a wrapper program.  The name of the
1492 wrapper program and its parameters are passed as a comma separated
1493 list.
1495 @smallexample
1496 gcc -c t.c -wrapper gdb,--args
1497 @end smallexample
1499 @noindent
1500 This invokes all subprograms of @command{gcc} under
1501 @samp{gdb --args}, thus the invocation of @command{cc1} is
1502 @samp{gdb --args cc1 @dots{}}.
1504 @item -fplugin=@var{name}.so
1505 @opindex fplugin
1506 Load the plugin code in file @var{name}.so, assumed to be a
1507 shared object to be dlopen'd by the compiler.  The base name of
1508 the shared object file is used to identify the plugin for the
1509 purposes of argument parsing (See
1510 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1511 Each plugin should define the callback functions specified in the
1512 Plugins API.
1514 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1515 @opindex fplugin-arg
1516 Define an argument called @var{key} with a value of @var{value}
1517 for the plugin called @var{name}.
1519 @item -fdump-ada-spec@r{[}-slim@r{]}
1520 @opindex fdump-ada-spec
1521 For C and C++ source and include files, generate corresponding Ada specs.
1522 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1523 GNAT User's Guide}, which provides detailed documentation on this feature.
1525 @item -fada-spec-parent=@var{unit}
1526 @opindex fada-spec-parent
1527 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1528 Ada specs as child units of parent @var{unit}.
1530 @item -fdump-go-spec=@var{file}
1531 @opindex fdump-go-spec
1532 For input files in any language, generate corresponding Go
1533 declarations in @var{file}.  This generates Go @code{const},
1534 @code{type}, @code{var}, and @code{func} declarations which may be a
1535 useful way to start writing a Go interface to code written in some
1536 other language.
1538 @include @value{srcdir}/../libiberty/at-file.texi
1539 @end table
1541 @node Invoking G++
1542 @section Compiling C++ Programs
1544 @cindex suffixes for C++ source
1545 @cindex C++ source file suffixes
1546 C++ source files conventionally use one of the suffixes @samp{.C},
1547 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1548 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1549 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1550 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1551 files with these names and compiles them as C++ programs even if you
1552 call the compiler the same way as for compiling C programs (usually
1553 with the name @command{gcc}).
1555 @findex g++
1556 @findex c++
1557 However, the use of @command{gcc} does not add the C++ library.
1558 @command{g++} is a program that calls GCC and automatically specifies linking
1559 against the C++ library.  It treats @samp{.c},
1560 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1561 files unless @option{-x} is used.  This program is also useful when
1562 precompiling a C header file with a @samp{.h} extension for use in C++
1563 compilations.  On many systems, @command{g++} is also installed with
1564 the name @command{c++}.
1566 @cindex invoking @command{g++}
1567 When you compile C++ programs, you may specify many of the same
1568 command-line options that you use for compiling programs in any
1569 language; or command-line options meaningful for C and related
1570 languages; or options that are meaningful only for C++ programs.
1571 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1572 explanations of options for languages related to C@.
1573 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1574 explanations of options that are meaningful only for C++ programs.
1576 @node C Dialect Options
1577 @section Options Controlling C Dialect
1578 @cindex dialect options
1579 @cindex language dialect options
1580 @cindex options, dialect
1582 The following options control the dialect of C (or languages derived
1583 from C, such as C++, Objective-C and Objective-C++) that the compiler
1584 accepts:
1586 @table @gcctabopt
1587 @cindex ANSI support
1588 @cindex ISO support
1589 @item -ansi
1590 @opindex ansi
1591 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1592 equivalent to @option{-std=c++98}.
1594 This turns off certain features of GCC that are incompatible with ISO
1595 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1596 such as the @code{asm} and @code{typeof} keywords, and
1597 predefined macros such as @code{unix} and @code{vax} that identify the
1598 type of system you are using.  It also enables the undesirable and
1599 rarely used ISO trigraph feature.  For the C compiler,
1600 it disables recognition of C++ style @samp{//} comments as well as
1601 the @code{inline} keyword.
1603 The alternate keywords @code{__asm__}, @code{__extension__},
1604 @code{__inline__} and @code{__typeof__} continue to work despite
1605 @option{-ansi}.  You would not want to use them in an ISO C program, of
1606 course, but it is useful to put them in header files that might be included
1607 in compilations done with @option{-ansi}.  Alternate predefined macros
1608 such as @code{__unix__} and @code{__vax__} are also available, with or
1609 without @option{-ansi}.
1611 The @option{-ansi} option does not cause non-ISO programs to be
1612 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1613 addition to @option{-ansi}.  @xref{Warning Options}.
1615 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1616 option is used.  Some header files may notice this macro and refrain
1617 from declaring certain functions or defining certain macros that the
1618 ISO standard doesn't call for; this is to avoid interfering with any
1619 programs that might use these names for other things.
1621 Functions that are normally built in but do not have semantics
1622 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1623 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1624 built-in functions provided by GCC}, for details of the functions
1625 affected.
1627 @item -std=
1628 @opindex std
1629 Determine the language standard. @xref{Standards,,Language Standards
1630 Supported by GCC}, for details of these standard versions.  This option
1631 is currently only supported when compiling C or C++.
1633 The compiler can accept several base standards, such as @samp{c90} or
1634 @samp{c++98}, and GNU dialects of those standards, such as
1635 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1636 compiler accepts all programs following that standard plus those
1637 using GNU extensions that do not contradict it.  For example,
1638 @option{-std=c90} turns off certain features of GCC that are
1639 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1640 keywords, but not other GNU extensions that do not have a meaning in
1641 ISO C90, such as omitting the middle term of a @code{?:}
1642 expression. On the other hand, when a GNU dialect of a standard is
1643 specified, all features supported by the compiler are enabled, even when
1644 those features change the meaning of the base standard.  As a result, some
1645 strict-conforming programs may be rejected.  The particular standard
1646 is used by @option{-Wpedantic} to identify which features are GNU
1647 extensions given that version of the standard. For example
1648 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1649 comments, while @option{-std=gnu99 -Wpedantic} does not.
1651 A value for this option must be provided; possible values are
1653 @table @samp
1654 @item c90
1655 @itemx c89
1656 @itemx iso9899:1990
1657 Support all ISO C90 programs (certain GNU extensions that conflict
1658 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1660 @item iso9899:199409
1661 ISO C90 as modified in amendment 1.
1663 @item c99
1664 @itemx c9x
1665 @itemx iso9899:1999
1666 @itemx iso9899:199x
1667 ISO C99.  This standard is substantially completely supported, modulo
1668 bugs, extended identifiers (supported except for corner cases when
1669 @option{-fextended-identifiers} is used) and floating-point issues
1670 (mainly but not entirely relating to optional C99 features from
1671 Annexes F and G).  See
1672 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1673 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1675 @item c11
1676 @itemx c1x
1677 @itemx iso9899:2011
1678 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1679 substantially completely supported, modulo bugs, extended identifiers
1680 (supported except for corner cases when
1681 @option{-fextended-identifiers} is used), floating-point issues
1682 (mainly but not entirely relating to optional C11 features from
1683 Annexes F and G) and the optional Annexes K (Bounds-checking
1684 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1686 @item gnu90
1687 @itemx gnu89
1688 GNU dialect of ISO C90 (including some C99 features). This
1689 is the default for C code.
1691 @item gnu99
1692 @itemx gnu9x
1693 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1695 @item gnu11
1696 @itemx gnu1x
1697 GNU dialect of ISO C11.  This is intended to become the default in a
1698 future release of GCC.  The name @samp{gnu1x} is deprecated.
1700 @item c++98
1701 @itemx c++03
1702 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1703 additional defect reports. Same as @option{-ansi} for C++ code.
1705 @item gnu++98
1706 @itemx gnu++03
1707 GNU dialect of @option{-std=c++98}.  This is the default for
1708 C++ code.
1710 @item c++11
1711 @itemx c++0x
1712 The 2011 ISO C++ standard plus amendments.
1713 The name @samp{c++0x} is deprecated.
1715 @item gnu++11
1716 @itemx gnu++0x
1717 GNU dialect of @option{-std=c++11}.
1718 The name @samp{gnu++0x} is deprecated.
1720 @item c++1y
1721 The next revision of the ISO C++ standard, tentatively planned for
1722 2014.  Support is highly experimental, and will almost certainly
1723 change in incompatible ways in future releases.
1725 @item gnu++1y
1726 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1727 and will almost certainly change in incompatible ways in future
1728 releases.
1729 @end table
1731 @item -fgnu89-inline
1732 @opindex fgnu89-inline
1733 The option @option{-fgnu89-inline} tells GCC to use the traditional
1734 GNU semantics for @code{inline} functions when in C99 mode.
1735 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1736 is accepted and ignored by GCC versions 4.1.3 up to but not including
1737 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1738 C99 mode.  Using this option is roughly equivalent to adding the
1739 @code{gnu_inline} function attribute to all inline functions
1740 (@pxref{Function Attributes}).
1742 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1743 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1744 specifies the default behavior).  This option was first supported in
1745 GCC 4.3.  This option is not supported in @option{-std=c90} or
1746 @option{-std=gnu90} mode.
1748 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1749 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1750 in effect for @code{inline} functions.  @xref{Common Predefined
1751 Macros,,,cpp,The C Preprocessor}.
1753 @item -aux-info @var{filename}
1754 @opindex aux-info
1755 Output to the given filename prototyped declarations for all functions
1756 declared and/or defined in a translation unit, including those in header
1757 files.  This option is silently ignored in any language other than C@.
1759 Besides declarations, the file indicates, in comments, the origin of
1760 each declaration (source file and line), whether the declaration was
1761 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1762 @samp{O} for old, respectively, in the first character after the line
1763 number and the colon), and whether it came from a declaration or a
1764 definition (@samp{C} or @samp{F}, respectively, in the following
1765 character).  In the case of function definitions, a K&R-style list of
1766 arguments followed by their declarations is also provided, inside
1767 comments, after the declaration.
1769 @item -fallow-parameterless-variadic-functions
1770 @opindex fallow-parameterless-variadic-functions
1771 Accept variadic functions without named parameters.
1773 Although it is possible to define such a function, this is not very
1774 useful as it is not possible to read the arguments.  This is only
1775 supported for C as this construct is allowed by C++.
1777 @item -fno-asm
1778 @opindex fno-asm
1779 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1780 keyword, so that code can use these words as identifiers.  You can use
1781 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1782 instead.  @option{-ansi} implies @option{-fno-asm}.
1784 In C++, this switch only affects the @code{typeof} keyword, since
1785 @code{asm} and @code{inline} are standard keywords.  You may want to
1786 use the @option{-fno-gnu-keywords} flag instead, which has the same
1787 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1788 switch only affects the @code{asm} and @code{typeof} keywords, since
1789 @code{inline} is a standard keyword in ISO C99.
1791 @item -fno-builtin
1792 @itemx -fno-builtin-@var{function}
1793 @opindex fno-builtin
1794 @cindex built-in functions
1795 Don't recognize built-in functions that do not begin with
1796 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1797 functions provided by GCC}, for details of the functions affected,
1798 including those which are not built-in functions when @option{-ansi} or
1799 @option{-std} options for strict ISO C conformance are used because they
1800 do not have an ISO standard meaning.
1802 GCC normally generates special code to handle certain built-in functions
1803 more efficiently; for instance, calls to @code{alloca} may become single
1804 instructions which adjust the stack directly, and calls to @code{memcpy}
1805 may become inline copy loops.  The resulting code is often both smaller
1806 and faster, but since the function calls no longer appear as such, you
1807 cannot set a breakpoint on those calls, nor can you change the behavior
1808 of the functions by linking with a different library.  In addition,
1809 when a function is recognized as a built-in function, GCC may use
1810 information about that function to warn about problems with calls to
1811 that function, or to generate more efficient code, even if the
1812 resulting code still contains calls to that function.  For example,
1813 warnings are given with @option{-Wformat} for bad calls to
1814 @code{printf} when @code{printf} is built in and @code{strlen} is
1815 known not to modify global memory.
1817 With the @option{-fno-builtin-@var{function}} option
1818 only the built-in function @var{function} is
1819 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1820 function is named that is not built-in in this version of GCC, this
1821 option is ignored.  There is no corresponding
1822 @option{-fbuiltin-@var{function}} option; if you wish to enable
1823 built-in functions selectively when using @option{-fno-builtin} or
1824 @option{-ffreestanding}, you may define macros such as:
1826 @smallexample
1827 #define abs(n)          __builtin_abs ((n))
1828 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1829 @end smallexample
1831 @item -fhosted
1832 @opindex fhosted
1833 @cindex hosted environment
1835 Assert that compilation targets a hosted environment.  This implies
1836 @option{-fbuiltin}.  A hosted environment is one in which the
1837 entire standard library is available, and in which @code{main} has a return
1838 type of @code{int}.  Examples are nearly everything except a kernel.
1839 This is equivalent to @option{-fno-freestanding}.
1841 @item -ffreestanding
1842 @opindex ffreestanding
1843 @cindex hosted environment
1845 Assert that compilation targets a freestanding environment.  This
1846 implies @option{-fno-builtin}.  A freestanding environment
1847 is one in which the standard library may not exist, and program startup may
1848 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1849 This is equivalent to @option{-fno-hosted}.
1851 @xref{Standards,,Language Standards Supported by GCC}, for details of
1852 freestanding and hosted environments.
1854 @item -fopenmp
1855 @opindex fopenmp
1856 @cindex OpenMP parallel
1857 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1858 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1859 compiler generates parallel code according to the OpenMP Application
1860 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1861 implies @option{-pthread}, and thus is only supported on targets that
1862 have support for @option{-pthread}. @option{-fopenmp} implies
1863 @option{-fopenmp-simd}.
1865 @item -fopenmp-simd
1866 @opindex fopenmp-simd
1867 @cindex OpenMP SIMD
1868 @cindex SIMD
1869 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1870 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1871 are ignored.
1873 @item -fcilkplus
1874 @opindex fcilkplus
1875 @cindex Enable Cilk Plus
1876 Enable the usage of Cilk Plus language extension features for C/C++.
1877 When the option @option{-fcilkplus} is specified, enable the usage of
1878 the Cilk Plus Language extension features for C/C++.  The present
1879 implementation follows ABI version 1.2.  This is an experimental
1880 feature that is only partially complete, and whose interface may
1881 change in future versions of GCC as the official specification
1882 changes.  Currently, all features but @code{_Cilk_for} have been
1883 implemented.
1885 @item -fgnu-tm
1886 @opindex fgnu-tm
1887 When the option @option{-fgnu-tm} is specified, the compiler
1888 generates code for the Linux variant of Intel's current Transactional
1889 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1890 an experimental feature whose interface may change in future versions
1891 of GCC, as the official specification changes.  Please note that not
1892 all architectures are supported for this feature.
1894 For more information on GCC's support for transactional memory,
1895 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1896 Transactional Memory Library}.
1898 Note that the transactional memory feature is not supported with
1899 non-call exceptions (@option{-fnon-call-exceptions}).
1901 @item -fms-extensions
1902 @opindex fms-extensions
1903 Accept some non-standard constructs used in Microsoft header files.
1905 In C++ code, this allows member names in structures to be similar
1906 to previous types declarations.
1908 @smallexample
1909 typedef int UOW;
1910 struct ABC @{
1911   UOW UOW;
1913 @end smallexample
1915 Some cases of unnamed fields in structures and unions are only
1916 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1917 fields within structs/unions}, for details.
1919 Note that this option is off for all targets but i?86 and x86_64
1920 targets using ms-abi.
1921 @item -fplan9-extensions
1922 Accept some non-standard constructs used in Plan 9 code.
1924 This enables @option{-fms-extensions}, permits passing pointers to
1925 structures with anonymous fields to functions that expect pointers to
1926 elements of the type of the field, and permits referring to anonymous
1927 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1928 struct/union fields within structs/unions}, for details.  This is only
1929 supported for C, not C++.
1931 @item -trigraphs
1932 @opindex trigraphs
1933 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1934 options for strict ISO C conformance) implies @option{-trigraphs}.
1936 @cindex traditional C language
1937 @cindex C language, traditional
1938 @item -traditional
1939 @itemx -traditional-cpp
1940 @opindex traditional-cpp
1941 @opindex traditional
1942 Formerly, these options caused GCC to attempt to emulate a pre-standard
1943 C compiler.  They are now only supported with the @option{-E} switch.
1944 The preprocessor continues to support a pre-standard mode.  See the GNU
1945 CPP manual for details.
1947 @item -fcond-mismatch
1948 @opindex fcond-mismatch
1949 Allow conditional expressions with mismatched types in the second and
1950 third arguments.  The value of such an expression is void.  This option
1951 is not supported for C++.
1953 @item -flax-vector-conversions
1954 @opindex flax-vector-conversions
1955 Allow implicit conversions between vectors with differing numbers of
1956 elements and/or incompatible element types.  This option should not be
1957 used for new code.
1959 @item -funsigned-char
1960 @opindex funsigned-char
1961 Let the type @code{char} be unsigned, like @code{unsigned char}.
1963 Each kind of machine has a default for what @code{char} should
1964 be.  It is either like @code{unsigned char} by default or like
1965 @code{signed char} by default.
1967 Ideally, a portable program should always use @code{signed char} or
1968 @code{unsigned char} when it depends on the signedness of an object.
1969 But many programs have been written to use plain @code{char} and
1970 expect it to be signed, or expect it to be unsigned, depending on the
1971 machines they were written for.  This option, and its inverse, let you
1972 make such a program work with the opposite default.
1974 The type @code{char} is always a distinct type from each of
1975 @code{signed char} or @code{unsigned char}, even though its behavior
1976 is always just like one of those two.
1978 @item -fsigned-char
1979 @opindex fsigned-char
1980 Let the type @code{char} be signed, like @code{signed char}.
1982 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1983 the negative form of @option{-funsigned-char}.  Likewise, the option
1984 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1986 @item -fsigned-bitfields
1987 @itemx -funsigned-bitfields
1988 @itemx -fno-signed-bitfields
1989 @itemx -fno-unsigned-bitfields
1990 @opindex fsigned-bitfields
1991 @opindex funsigned-bitfields
1992 @opindex fno-signed-bitfields
1993 @opindex fno-unsigned-bitfields
1994 These options control whether a bit-field is signed or unsigned, when the
1995 declaration does not use either @code{signed} or @code{unsigned}.  By
1996 default, such a bit-field is signed, because this is consistent: the
1997 basic integer types such as @code{int} are signed types.
1998 @end table
2000 @node C++ Dialect Options
2001 @section Options Controlling C++ Dialect
2003 @cindex compiler options, C++
2004 @cindex C++ options, command-line
2005 @cindex options, C++
2006 This section describes the command-line options that are only meaningful
2007 for C++ programs.  You can also use most of the GNU compiler options
2008 regardless of what language your program is in.  For example, you
2009 might compile a file @code{firstClass.C} like this:
2011 @smallexample
2012 g++ -g -frepo -O -c firstClass.C
2013 @end smallexample
2015 @noindent
2016 In this example, only @option{-frepo} is an option meant
2017 only for C++ programs; you can use the other options with any
2018 language supported by GCC@.
2020 Here is a list of options that are @emph{only} for compiling C++ programs:
2022 @table @gcctabopt
2024 @item -fabi-version=@var{n}
2025 @opindex fabi-version
2026 Use version @var{n} of the C++ ABI@.  The default is version 0.
2028 Version 0 refers to the version conforming most closely to
2029 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2030 will change in different versions of G++ as ABI bugs are fixed.
2032 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2034 Version 2 is the version of the C++ ABI that first appeared in G++
2035 3.4, and was the default through G++ 4.9.
2037 Version 3 corrects an error in mangling a constant address as a
2038 template argument.
2040 Version 4, which first appeared in G++ 4.5, implements a standard
2041 mangling for vector types.
2043 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2044 attribute const/volatile on function pointer types, decltype of a
2045 plain decl, and use of a function parameter in the declaration of
2046 another parameter.
2048 Version 6, which first appeared in G++ 4.7, corrects the promotion
2049 behavior of C++11 scoped enums and the mangling of template argument
2050 packs, const/static_cast, prefix ++ and --, and a class scope function
2051 used as a template argument.
2053 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2054 builtin type and corrects the mangling of lambdas in default argument
2055 scope.
2057 Version 8, which first appeared in G++ 4.9, corrects the substitution
2058 behavior of function types with function-cv-qualifiers.
2060 See also @option{-Wabi}.
2062 @item -fabi-compat-version=@var{n}
2063 @opindex fabi-compat-version
2064 Starting with GCC 4.5, on targets that support strong aliases, G++
2065 works around mangling changes by creating an alias with the correct
2066 mangled name when defining a symbol with an incorrect mangled name.
2067 This switch specifies which ABI version to use for the alias.
2069 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2070 another ABI version is explicitly selected, this defaults to 0.
2072 The compatibility version is also set by @option{-Wabi=@var{n}}.
2074 @item -fno-access-control
2075 @opindex fno-access-control
2076 Turn off all access checking.  This switch is mainly useful for working
2077 around bugs in the access control code.
2079 @item -fcheck-new
2080 @opindex fcheck-new
2081 Check that the pointer returned by @code{operator new} is non-null
2082 before attempting to modify the storage allocated.  This check is
2083 normally unnecessary because the C++ standard specifies that
2084 @code{operator new} only returns @code{0} if it is declared
2085 @samp{throw()}, in which case the compiler always checks the
2086 return value even without this option.  In all other cases, when
2087 @code{operator new} has a non-empty exception specification, memory
2088 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2089 @samp{new (nothrow)}.
2091 @item -fconstexpr-depth=@var{n}
2092 @opindex fconstexpr-depth
2093 Set the maximum nested evaluation depth for C++11 constexpr functions
2094 to @var{n}.  A limit is needed to detect endless recursion during
2095 constant expression evaluation.  The minimum specified by the standard
2096 is 512.
2098 @item -fdeduce-init-list
2099 @opindex fdeduce-init-list
2100 Enable deduction of a template type parameter as
2101 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2103 @smallexample
2104 template <class T> auto forward(T t) -> decltype (realfn (t))
2106   return realfn (t);
2109 void f()
2111   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2113 @end smallexample
2115 This deduction was implemented as a possible extension to the
2116 originally proposed semantics for the C++11 standard, but was not part
2117 of the final standard, so it is disabled by default.  This option is
2118 deprecated, and may be removed in a future version of G++.
2120 @item -ffriend-injection
2121 @opindex ffriend-injection
2122 Inject friend functions into the enclosing namespace, so that they are
2123 visible outside the scope of the class in which they are declared.
2124 Friend functions were documented to work this way in the old Annotated
2125 C++ Reference Manual, and versions of G++ before 4.1 always worked
2126 that way.  However, in ISO C++ a friend function that is not declared
2127 in an enclosing scope can only be found using argument dependent
2128 lookup.  This option causes friends to be injected as they were in
2129 earlier releases.
2131 This option is for compatibility, and may be removed in a future
2132 release of G++.
2134 @item -fno-elide-constructors
2135 @opindex fno-elide-constructors
2136 The C++ standard allows an implementation to omit creating a temporary
2137 that is only used to initialize another object of the same type.
2138 Specifying this option disables that optimization, and forces G++ to
2139 call the copy constructor in all cases.
2141 @item -fno-enforce-eh-specs
2142 @opindex fno-enforce-eh-specs
2143 Don't generate code to check for violation of exception specifications
2144 at run time.  This option violates the C++ standard, but may be useful
2145 for reducing code size in production builds, much like defining
2146 @samp{NDEBUG}.  This does not give user code permission to throw
2147 exceptions in violation of the exception specifications; the compiler
2148 still optimizes based on the specifications, so throwing an
2149 unexpected exception results in undefined behavior at run time.
2151 @item -fextern-tls-init
2152 @itemx -fno-extern-tls-init
2153 @opindex fextern-tls-init
2154 @opindex fno-extern-tls-init
2155 The C++11 and OpenMP standards allow @samp{thread_local} and
2156 @samp{threadprivate} variables to have dynamic (runtime)
2157 initialization.  To support this, any use of such a variable goes
2158 through a wrapper function that performs any necessary initialization.
2159 When the use and definition of the variable are in the same
2160 translation unit, this overhead can be optimized away, but when the
2161 use is in a different translation unit there is significant overhead
2162 even if the variable doesn't actually need dynamic initialization.  If
2163 the programmer can be sure that no use of the variable in a
2164 non-defining TU needs to trigger dynamic initialization (either
2165 because the variable is statically initialized, or a use of the
2166 variable in the defining TU will be executed before any uses in
2167 another TU), they can avoid this overhead with the
2168 @option{-fno-extern-tls-init} option.
2170 On targets that support symbol aliases, the default is
2171 @option{-fextern-tls-init}.  On targets that do not support symbol
2172 aliases, the default is @option{-fno-extern-tls-init}.
2174 @item -ffor-scope
2175 @itemx -fno-for-scope
2176 @opindex ffor-scope
2177 @opindex fno-for-scope
2178 If @option{-ffor-scope} is specified, the scope of variables declared in
2179 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2180 as specified by the C++ standard.
2181 If @option{-fno-for-scope} is specified, the scope of variables declared in
2182 a @i{for-init-statement} extends to the end of the enclosing scope,
2183 as was the case in old versions of G++, and other (traditional)
2184 implementations of C++.
2186 If neither flag is given, the default is to follow the standard,
2187 but to allow and give a warning for old-style code that would
2188 otherwise be invalid, or have different behavior.
2190 @item -fno-gnu-keywords
2191 @opindex fno-gnu-keywords
2192 Do not recognize @code{typeof} as a keyword, so that code can use this
2193 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2194 @option{-ansi} implies @option{-fno-gnu-keywords}.
2196 @item -fno-implicit-templates
2197 @opindex fno-implicit-templates
2198 Never emit code for non-inline templates that are instantiated
2199 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2200 @xref{Template Instantiation}, for more information.
2202 @item -fno-implicit-inline-templates
2203 @opindex fno-implicit-inline-templates
2204 Don't emit code for implicit instantiations of inline templates, either.
2205 The default is to handle inlines differently so that compiles with and
2206 without optimization need the same set of explicit instantiations.
2208 @item -fno-implement-inlines
2209 @opindex fno-implement-inlines
2210 To save space, do not emit out-of-line copies of inline functions
2211 controlled by @samp{#pragma implementation}.  This causes linker
2212 errors if these functions are not inlined everywhere they are called.
2214 @item -fms-extensions
2215 @opindex fms-extensions
2216 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2217 int and getting a pointer to member function via non-standard syntax.
2219 @item -fno-nonansi-builtins
2220 @opindex fno-nonansi-builtins
2221 Disable built-in declarations of functions that are not mandated by
2222 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2223 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2225 @item -fnothrow-opt
2226 @opindex fnothrow-opt
2227 Treat a @code{throw()} exception specification as if it were a
2228 @code{noexcept} specification to reduce or eliminate the text size
2229 overhead relative to a function with no exception specification.  If
2230 the function has local variables of types with non-trivial
2231 destructors, the exception specification actually makes the
2232 function smaller because the EH cleanups for those variables can be
2233 optimized away.  The semantic effect is that an exception thrown out of
2234 a function with such an exception specification results in a call
2235 to @code{terminate} rather than @code{unexpected}.
2237 @item -fno-operator-names
2238 @opindex fno-operator-names
2239 Do not treat the operator name keywords @code{and}, @code{bitand},
2240 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2241 synonyms as keywords.
2243 @item -fno-optional-diags
2244 @opindex fno-optional-diags
2245 Disable diagnostics that the standard says a compiler does not need to
2246 issue.  Currently, the only such diagnostic issued by G++ is the one for
2247 a name having multiple meanings within a class.
2249 @item -fpermissive
2250 @opindex fpermissive
2251 Downgrade some diagnostics about nonconformant code from errors to
2252 warnings.  Thus, using @option{-fpermissive} allows some
2253 nonconforming code to compile.
2255 @item -fno-pretty-templates
2256 @opindex fno-pretty-templates
2257 When an error message refers to a specialization of a function
2258 template, the compiler normally prints the signature of the
2259 template followed by the template arguments and any typedefs or
2260 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2261 rather than @code{void f(int)}) so that it's clear which template is
2262 involved.  When an error message refers to a specialization of a class
2263 template, the compiler omits any template arguments that match
2264 the default template arguments for that template.  If either of these
2265 behaviors make it harder to understand the error message rather than
2266 easier, you can use @option{-fno-pretty-templates} to disable them.
2268 @item -frepo
2269 @opindex frepo
2270 Enable automatic template instantiation at link time.  This option also
2271 implies @option{-fno-implicit-templates}.  @xref{Template
2272 Instantiation}, for more information.
2274 @item -fno-rtti
2275 @opindex fno-rtti
2276 Disable generation of information about every class with virtual
2277 functions for use by the C++ run-time type identification features
2278 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2279 of the language, you can save some space by using this flag.  Note that
2280 exception handling uses the same information, but G++ generates it as
2281 needed. The @samp{dynamic_cast} operator can still be used for casts that
2282 do not require run-time type information, i.e.@: casts to @code{void *} or to
2283 unambiguous base classes.
2285 @item -fstats
2286 @opindex fstats
2287 Emit statistics about front-end processing at the end of the compilation.
2288 This information is generally only useful to the G++ development team.
2290 @item -fstrict-enums
2291 @opindex fstrict-enums
2292 Allow the compiler to optimize using the assumption that a value of
2293 enumerated type can only be one of the values of the enumeration (as
2294 defined in the C++ standard; basically, a value that can be
2295 represented in the minimum number of bits needed to represent all the
2296 enumerators).  This assumption may not be valid if the program uses a
2297 cast to convert an arbitrary integer value to the enumerated type.
2299 @item -ftemplate-backtrace-limit=@var{n}
2300 @opindex ftemplate-backtrace-limit
2301 Set the maximum number of template instantiation notes for a single
2302 warning or error to @var{n}.  The default value is 10.
2304 @item -ftemplate-depth=@var{n}
2305 @opindex ftemplate-depth
2306 Set the maximum instantiation depth for template classes to @var{n}.
2307 A limit on the template instantiation depth is needed to detect
2308 endless recursions during template class instantiation.  ANSI/ISO C++
2309 conforming programs must not rely on a maximum depth greater than 17
2310 (changed to 1024 in C++11).  The default value is 900, as the compiler
2311 can run out of stack space before hitting 1024 in some situations.
2313 @item -fno-threadsafe-statics
2314 @opindex fno-threadsafe-statics
2315 Do not emit the extra code to use the routines specified in the C++
2316 ABI for thread-safe initialization of local statics.  You can use this
2317 option to reduce code size slightly in code that doesn't need to be
2318 thread-safe.
2320 @item -fuse-cxa-atexit
2321 @opindex fuse-cxa-atexit
2322 Register destructors for objects with static storage duration with the
2323 @code{__cxa_atexit} function rather than the @code{atexit} function.
2324 This option is required for fully standards-compliant handling of static
2325 destructors, but only works if your C library supports
2326 @code{__cxa_atexit}.
2328 @item -fno-use-cxa-get-exception-ptr
2329 @opindex fno-use-cxa-get-exception-ptr
2330 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2331 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2332 if the runtime routine is not available.
2334 @item -fvisibility-inlines-hidden
2335 @opindex fvisibility-inlines-hidden
2336 This switch declares that the user does not attempt to compare
2337 pointers to inline functions or methods where the addresses of the two functions
2338 are taken in different shared objects.
2340 The effect of this is that GCC may, effectively, mark inline methods with
2341 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2342 appear in the export table of a DSO and do not require a PLT indirection
2343 when used within the DSO@.  Enabling this option can have a dramatic effect
2344 on load and link times of a DSO as it massively reduces the size of the
2345 dynamic export table when the library makes heavy use of templates.
2347 The behavior of this switch is not quite the same as marking the
2348 methods as hidden directly, because it does not affect static variables
2349 local to the function or cause the compiler to deduce that
2350 the function is defined in only one shared object.
2352 You may mark a method as having a visibility explicitly to negate the
2353 effect of the switch for that method.  For example, if you do want to
2354 compare pointers to a particular inline method, you might mark it as
2355 having default visibility.  Marking the enclosing class with explicit
2356 visibility has no effect.
2358 Explicitly instantiated inline methods are unaffected by this option
2359 as their linkage might otherwise cross a shared library boundary.
2360 @xref{Template Instantiation}.
2362 @item -fvisibility-ms-compat
2363 @opindex fvisibility-ms-compat
2364 This flag attempts to use visibility settings to make GCC's C++
2365 linkage model compatible with that of Microsoft Visual Studio.
2367 The flag makes these changes to GCC's linkage model:
2369 @enumerate
2370 @item
2371 It sets the default visibility to @code{hidden}, like
2372 @option{-fvisibility=hidden}.
2374 @item
2375 Types, but not their members, are not hidden by default.
2377 @item
2378 The One Definition Rule is relaxed for types without explicit
2379 visibility specifications that are defined in more than one
2380 shared object: those declarations are permitted if they are
2381 permitted when this option is not used.
2382 @end enumerate
2384 In new code it is better to use @option{-fvisibility=hidden} and
2385 export those classes that are intended to be externally visible.
2386 Unfortunately it is possible for code to rely, perhaps accidentally,
2387 on the Visual Studio behavior.
2389 Among the consequences of these changes are that static data members
2390 of the same type with the same name but defined in different shared
2391 objects are different, so changing one does not change the other;
2392 and that pointers to function members defined in different shared
2393 objects may not compare equal.  When this flag is given, it is a
2394 violation of the ODR to define types with the same name differently.
2396 @item -fvtable-verify=@var{std|preinit|none}
2397 @opindex fvtable-verify
2398 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2399 feature that verifies at runtime, for every virtual call that is made, that
2400 the vtable pointer through which the call is made is valid for the type of
2401 the object, and has not been corrupted or overwritten.  If an invalid vtable
2402 pointer is detected (at runtime), an error is reported and execution of the
2403 program is immediately halted.
2405 This option causes runtime data structures to be built, at program start up,
2406 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2407 control the timing of when these data structures are built.  In both cases the
2408 data structures are built before execution reaches 'main'.  The
2409 @option{-fvtable-verify=std} causes these data structure to be built after the
2410 shared libraries have been loaded and initialized.
2411 @option{-fvtable-verify=preinit} causes them to be built before the shared
2412 libraries have been loaded and initialized.
2414 If this option appears multiple times in the compiler line, with different
2415 values specified, 'none' will take highest priority over both 'std' and
2416 'preinit'; 'preinit' will take priority over 'std'.
2418 @item -fvtv-debug
2419 @opindex (fvtv-debug)
2420 Causes debug versions of the runtime functions for the vtable verification 
2421 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2422 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2423 compiler to keep track of which vtable pointers it found for each class, and
2424 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2425 file directory on the user's machine.
2427 Note:  This feature APPENDS data to the log file. If you want a fresh log
2428 file, be sure to delete any existing one.
2430 @item -fvtv-counts
2431 @opindex fvtv-counts
2432 This is a debugging flag.  When used in conjunction with
2433 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2434 causes the compiler to keep track of the total number of virtual calls
2435 it encountered and the number of verifications it inserted.  It also
2436 counts the number of calls to certain runtime library functions
2437 that it inserts.  This information, for each compilation unit, is written
2438 to a file named ``vtv_count_data.log'', in the dump_file directory on
2439 the user's machine.   It also counts the size of the vtable pointer sets
2440 for each class, and writes this information to ``vtv_class_set_sizes.log''
2441 in the same directory.
2443 Note:  This feature APPENDS data to the log files.  To get a fresh log
2444 files, be sure to delete any existing ones.
2446 @item -fno-weak
2447 @opindex fno-weak
2448 Do not use weak symbol support, even if it is provided by the linker.
2449 By default, G++ uses weak symbols if they are available.  This
2450 option exists only for testing, and should not be used by end-users;
2451 it results in inferior code and has no benefits.  This option may
2452 be removed in a future release of G++.
2454 @item -nostdinc++
2455 @opindex nostdinc++
2456 Do not search for header files in the standard directories specific to
2457 C++, but do still search the other standard directories.  (This option
2458 is used when building the C++ library.)
2459 @end table
2461 In addition, these optimization, warning, and code generation options
2462 have meanings only for C++ programs:
2464 @table @gcctabopt
2465 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2466 @opindex Wabi
2467 @opindex Wno-abi
2468 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2469 G++ to warn when it generates code that is probably not compatible with the
2470 vendor-neutral C++ ABI@.  Since G++ now defaults to
2471 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2472 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2473 or an older compatibility version is selected (with
2474 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2476 Although an effort has been made to warn about
2477 all such cases, there are probably some cases that are not warned about,
2478 even though G++ is generating incompatible code.  There may also be
2479 cases where warnings are emitted even though the code that is generated
2480 is compatible.
2482 You should rewrite your code to avoid these warnings if you are
2483 concerned about the fact that code generated by G++ may not be binary
2484 compatible with code generated by other compilers.
2486 @option{-Wabi} can also be used with an explicit version number to
2487 warn about compatibility with a particular @option{-fabi-version}
2488 level, e.g. @option{-Wabi=2} to warn about changes relative to
2489 @option{-fabi-version=2}.  Specifying a version number also sets
2490 @option{-fabi-compat-version=@var{n}}.
2492 The known incompatibilities in @option{-fabi-version=2} (which was the
2493 default from GCC 3.4 to 4.9) include:
2495 @itemize @bullet
2497 @item
2498 A template with a non-type template parameter of reference type was
2499 mangled incorrectly:
2500 @smallexample
2501 extern int N;
2502 template <int &> struct S @{@};
2503 void n (S<N>) @{2@}
2504 @end smallexample
2506 This was fixed in @option{-fabi-version=3}.
2508 @item
2509 SIMD vector types declared using @code{__attribute ((vector_size))} were
2510 mangled in a non-standard way that does not allow for overloading of
2511 functions taking vectors of different sizes.
2513 The mangling was changed in @option{-fabi-version=4}.
2515 @item
2516 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2517 qualifiers, and @code{decltype} of a plain declaration was folded away.
2519 These mangling issues were fixed in @option{-fabi-version=5}.
2521 @item
2522 Scoped enumerators passed as arguments to a variadic function are
2523 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2524 On most targets this does not actually affect the parameter passing
2525 ABI, as there is no way to pass an argument smaller than @samp{int}.
2527 Also, the ABI changed the mangling of template argument packs,
2528 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2529 a class scope function used as a template argument.
2531 These issues were corrected in @option{-fabi-version=6}.
2533 @item
2534 Lambdas in default argument scope were mangled incorrectly, and the
2535 ABI changed the mangling of nullptr_t.
2537 These issues were corrected in @option{-fabi-version=7}.
2539 @item
2540 When mangling a function type with function-cv-qualifiers, the
2541 un-qualified function type was incorrectly treated as a substitution
2542 candidate.
2544 This was fixed in @option{-fabi-version=8}.
2545 @end itemize
2547 It also warns about psABI-related changes.  The known psABI changes at this
2548 point include:
2550 @itemize @bullet
2552 @item
2553 For SysV/x86-64, unions with @code{long double} members are 
2554 passed in memory as specified in psABI.  For example:
2556 @smallexample
2557 union U @{
2558   long double ld;
2559   int i;
2561 @end smallexample
2563 @noindent
2564 @code{union U} is always passed in memory.
2566 @end itemize
2568 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2569 @opindex Wctor-dtor-privacy
2570 @opindex Wno-ctor-dtor-privacy
2571 Warn when a class seems unusable because all the constructors or
2572 destructors in that class are private, and it has neither friends nor
2573 public static member functions.  Also warn if there are no non-private
2574 methods, and there's at least one private member function that isn't
2575 a constructor or destructor.
2577 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2578 @opindex Wdelete-non-virtual-dtor
2579 @opindex Wno-delete-non-virtual-dtor
2580 Warn when @samp{delete} is used to destroy an instance of a class that
2581 has virtual functions and non-virtual destructor. It is unsafe to delete
2582 an instance of a derived class through a pointer to a base class if the
2583 base class does not have a virtual destructor.  This warning is enabled
2584 by @option{-Wall}.
2586 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2587 @opindex Wliteral-suffix
2588 @opindex Wno-literal-suffix
2589 Warn when a string or character literal is followed by a ud-suffix which does
2590 not begin with an underscore.  As a conforming extension, GCC treats such
2591 suffixes as separate preprocessing tokens in order to maintain backwards
2592 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2593 For example:
2595 @smallexample
2596 #define __STDC_FORMAT_MACROS
2597 #include <inttypes.h>
2598 #include <stdio.h>
2600 int main() @{
2601   int64_t i64 = 123;
2602   printf("My int64: %"PRId64"\n", i64);
2604 @end smallexample
2606 In this case, @code{PRId64} is treated as a separate preprocessing token.
2608 This warning is enabled by default.
2610 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2611 @opindex Wnarrowing
2612 @opindex Wno-narrowing
2613 Warn when a narrowing conversion prohibited by C++11 occurs within
2614 @samp{@{ @}}, e.g.
2616 @smallexample
2617 int i = @{ 2.2 @}; // error: narrowing from double to int
2618 @end smallexample
2620 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2622 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2623 required by the standard.  Note that this does not affect the meaning
2624 of well-formed code; narrowing conversions are still considered
2625 ill-formed in SFINAE context.
2627 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2628 @opindex Wnoexcept
2629 @opindex Wno-noexcept
2630 Warn when a noexcept-expression evaluates to false because of a call
2631 to a function that does not have a non-throwing exception
2632 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2633 the compiler to never throw an exception.
2635 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2636 @opindex Wnon-virtual-dtor
2637 @opindex Wno-non-virtual-dtor
2638 Warn when a class has virtual functions and an accessible non-virtual
2639 destructor itself or in an accessible polymorphic base class, in which
2640 case it is possible but unsafe to delete an instance of a derived
2641 class through a pointer to the class itself or base class.  This
2642 warning is automatically enabled if @option{-Weffc++} is specified.
2644 @item -Wreorder @r{(C++ and Objective-C++ only)}
2645 @opindex Wreorder
2646 @opindex Wno-reorder
2647 @cindex reordering, warning
2648 @cindex warning for reordering of member initializers
2649 Warn when the order of member initializers given in the code does not
2650 match the order in which they must be executed.  For instance:
2652 @smallexample
2653 struct A @{
2654   int i;
2655   int j;
2656   A(): j (0), i (1) @{ @}
2658 @end smallexample
2660 @noindent
2661 The compiler rearranges the member initializers for @samp{i}
2662 and @samp{j} to match the declaration order of the members, emitting
2663 a warning to that effect.  This warning is enabled by @option{-Wall}.
2665 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2666 @opindex fext-numeric-literals
2667 @opindex fno-ext-numeric-literals
2668 Accept imaginary, fixed-point, or machine-defined
2669 literal number suffixes as GNU extensions.
2670 When this option is turned off these suffixes are treated
2671 as C++11 user-defined literal numeric suffixes.
2672 This is on by default for all pre-C++11 dialects and all GNU dialects:
2673 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2674 @option{-std=gnu++1y}.
2675 This option is off by default
2676 for ISO C++11 onwards (@option{-std=c++11}, ...).
2677 @end table
2679 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2681 @table @gcctabopt
2682 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2683 @opindex Weffc++
2684 @opindex Wno-effc++
2685 Warn about violations of the following style guidelines from Scott Meyers'
2686 @cite{Effective C++} series of books:
2688 @itemize @bullet
2689 @item
2690 Define a copy constructor and an assignment operator for classes
2691 with dynamically-allocated memory.
2693 @item
2694 Prefer initialization to assignment in constructors.
2696 @item
2697 Have @code{operator=} return a reference to @code{*this}.
2699 @item
2700 Don't try to return a reference when you must return an object.
2702 @item
2703 Distinguish between prefix and postfix forms of increment and
2704 decrement operators.
2706 @item
2707 Never overload @code{&&}, @code{||}, or @code{,}.
2709 @end itemize
2711 This option also enables @option{-Wnon-virtual-dtor}, which is also
2712 one of the effective C++ recommendations.  However, the check is
2713 extended to warn about the lack of virtual destructor in accessible
2714 non-polymorphic bases classes too.
2716 When selecting this option, be aware that the standard library
2717 headers do not obey all of these guidelines; use @samp{grep -v}
2718 to filter out those warnings.
2720 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2721 @opindex Wstrict-null-sentinel
2722 @opindex Wno-strict-null-sentinel
2723 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2724 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2725 to @code{__null}.  Although it is a null pointer constant rather than a
2726 null pointer, it is guaranteed to be of the same size as a pointer.
2727 But this use is not portable across different compilers.
2729 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2730 @opindex Wno-non-template-friend
2731 @opindex Wnon-template-friend
2732 Disable warnings when non-templatized friend functions are declared
2733 within a template.  Since the advent of explicit template specification
2734 support in G++, if the name of the friend is an unqualified-id (i.e.,
2735 @samp{friend foo(int)}), the C++ language specification demands that the
2736 friend declare or define an ordinary, nontemplate function.  (Section
2737 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2738 could be interpreted as a particular specialization of a templatized
2739 function.  Because this non-conforming behavior is no longer the default
2740 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2741 check existing code for potential trouble spots and is on by default.
2742 This new compiler behavior can be turned off with
2743 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2744 but disables the helpful warning.
2746 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2747 @opindex Wold-style-cast
2748 @opindex Wno-old-style-cast
2749 Warn if an old-style (C-style) cast to a non-void type is used within
2750 a C++ program.  The new-style casts (@samp{dynamic_cast},
2751 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2752 less vulnerable to unintended effects and much easier to search for.
2754 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2755 @opindex Woverloaded-virtual
2756 @opindex Wno-overloaded-virtual
2757 @cindex overloaded virtual function, warning
2758 @cindex warning for overloaded virtual function
2759 Warn when a function declaration hides virtual functions from a
2760 base class.  For example, in:
2762 @smallexample
2763 struct A @{
2764   virtual void f();
2767 struct B: public A @{
2768   void f(int);
2770 @end smallexample
2772 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2773 like:
2775 @smallexample
2776 B* b;
2777 b->f();
2778 @end smallexample
2780 @noindent
2781 fails to compile.
2783 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2784 @opindex Wno-pmf-conversions
2785 @opindex Wpmf-conversions
2786 Disable the diagnostic for converting a bound pointer to member function
2787 to a plain pointer.
2789 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2790 @opindex Wsign-promo
2791 @opindex Wno-sign-promo
2792 Warn when overload resolution chooses a promotion from unsigned or
2793 enumerated type to a signed type, over a conversion to an unsigned type of
2794 the same size.  Previous versions of G++ tried to preserve
2795 unsignedness, but the standard mandates the current behavior.
2796 @end table
2798 @node Objective-C and Objective-C++ Dialect Options
2799 @section Options Controlling Objective-C and Objective-C++ Dialects
2801 @cindex compiler options, Objective-C and Objective-C++
2802 @cindex Objective-C and Objective-C++ options, command-line
2803 @cindex options, Objective-C and Objective-C++
2804 (NOTE: This manual does not describe the Objective-C and Objective-C++
2805 languages themselves.  @xref{Standards,,Language Standards
2806 Supported by GCC}, for references.)
2808 This section describes the command-line options that are only meaningful
2809 for Objective-C and Objective-C++ programs.  You can also use most of
2810 the language-independent GNU compiler options.
2811 For example, you might compile a file @code{some_class.m} like this:
2813 @smallexample
2814 gcc -g -fgnu-runtime -O -c some_class.m
2815 @end smallexample
2817 @noindent
2818 In this example, @option{-fgnu-runtime} is an option meant only for
2819 Objective-C and Objective-C++ programs; you can use the other options with
2820 any language supported by GCC@.
2822 Note that since Objective-C is an extension of the C language, Objective-C
2823 compilations may also use options specific to the C front-end (e.g.,
2824 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2825 C++-specific options (e.g., @option{-Wabi}).
2827 Here is a list of options that are @emph{only} for compiling Objective-C
2828 and Objective-C++ programs:
2830 @table @gcctabopt
2831 @item -fconstant-string-class=@var{class-name}
2832 @opindex fconstant-string-class
2833 Use @var{class-name} as the name of the class to instantiate for each
2834 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2835 class name is @code{NXConstantString} if the GNU runtime is being used, and
2836 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2837 @option{-fconstant-cfstrings} option, if also present, overrides the
2838 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2839 to be laid out as constant CoreFoundation strings.
2841 @item -fgnu-runtime
2842 @opindex fgnu-runtime
2843 Generate object code compatible with the standard GNU Objective-C
2844 runtime.  This is the default for most types of systems.
2846 @item -fnext-runtime
2847 @opindex fnext-runtime
2848 Generate output compatible with the NeXT runtime.  This is the default
2849 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2850 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2851 used.
2853 @item -fno-nil-receivers
2854 @opindex fno-nil-receivers
2855 Assume that all Objective-C message dispatches (@code{[receiver
2856 message:arg]}) in this translation unit ensure that the receiver is
2857 not @code{nil}.  This allows for more efficient entry points in the
2858 runtime to be used.  This option is only available in conjunction with
2859 the NeXT runtime and ABI version 0 or 1.
2861 @item -fobjc-abi-version=@var{n}
2862 @opindex fobjc-abi-version
2863 Use version @var{n} of the Objective-C ABI for the selected runtime.
2864 This option is currently supported only for the NeXT runtime.  In that
2865 case, Version 0 is the traditional (32-bit) ABI without support for
2866 properties and other Objective-C 2.0 additions.  Version 1 is the
2867 traditional (32-bit) ABI with support for properties and other
2868 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2869 nothing is specified, the default is Version 0 on 32-bit target
2870 machines, and Version 2 on 64-bit target machines.
2872 @item -fobjc-call-cxx-cdtors
2873 @opindex fobjc-call-cxx-cdtors
2874 For each Objective-C class, check if any of its instance variables is a
2875 C++ object with a non-trivial default constructor.  If so, synthesize a
2876 special @code{- (id) .cxx_construct} instance method which runs
2877 non-trivial default constructors on any such instance variables, in order,
2878 and then return @code{self}.  Similarly, check if any instance variable
2879 is a C++ object with a non-trivial destructor, and if so, synthesize a
2880 special @code{- (void) .cxx_destruct} method which runs
2881 all such default destructors, in reverse order.
2883 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2884 methods thusly generated only operate on instance variables
2885 declared in the current Objective-C class, and not those inherited
2886 from superclasses.  It is the responsibility of the Objective-C
2887 runtime to invoke all such methods in an object's inheritance
2888 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2889 by the runtime immediately after a new object instance is allocated;
2890 the @code{- (void) .cxx_destruct} methods are invoked immediately
2891 before the runtime deallocates an object instance.
2893 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2894 support for invoking the @code{- (id) .cxx_construct} and
2895 @code{- (void) .cxx_destruct} methods.
2897 @item -fobjc-direct-dispatch
2898 @opindex fobjc-direct-dispatch
2899 Allow fast jumps to the message dispatcher.  On Darwin this is
2900 accomplished via the comm page.
2902 @item -fobjc-exceptions
2903 @opindex fobjc-exceptions
2904 Enable syntactic support for structured exception handling in
2905 Objective-C, similar to what is offered by C++ and Java.  This option
2906 is required to use the Objective-C keywords @code{@@try},
2907 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2908 @code{@@synchronized}.  This option is available with both the GNU
2909 runtime and the NeXT runtime (but not available in conjunction with
2910 the NeXT runtime on Mac OS X 10.2 and earlier).
2912 @item -fobjc-gc
2913 @opindex fobjc-gc
2914 Enable garbage collection (GC) in Objective-C and Objective-C++
2915 programs.  This option is only available with the NeXT runtime; the
2916 GNU runtime has a different garbage collection implementation that
2917 does not require special compiler flags.
2919 @item -fobjc-nilcheck
2920 @opindex fobjc-nilcheck
2921 For the NeXT runtime with version 2 of the ABI, check for a nil
2922 receiver in method invocations before doing the actual method call.
2923 This is the default and can be disabled using
2924 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2925 checked for nil in this way no matter what this flag is set to.
2926 Currently this flag does nothing when the GNU runtime, or an older
2927 version of the NeXT runtime ABI, is used.
2929 @item -fobjc-std=objc1
2930 @opindex fobjc-std
2931 Conform to the language syntax of Objective-C 1.0, the language
2932 recognized by GCC 4.0.  This only affects the Objective-C additions to
2933 the C/C++ language; it does not affect conformance to C/C++ standards,
2934 which is controlled by the separate C/C++ dialect option flags.  When
2935 this option is used with the Objective-C or Objective-C++ compiler,
2936 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2937 This is useful if you need to make sure that your Objective-C code can
2938 be compiled with older versions of GCC@.
2940 @item -freplace-objc-classes
2941 @opindex freplace-objc-classes
2942 Emit a special marker instructing @command{ld(1)} not to statically link in
2943 the resulting object file, and allow @command{dyld(1)} to load it in at
2944 run time instead.  This is used in conjunction with the Fix-and-Continue
2945 debugging mode, where the object file in question may be recompiled and
2946 dynamically reloaded in the course of program execution, without the need
2947 to restart the program itself.  Currently, Fix-and-Continue functionality
2948 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2949 and later.
2951 @item -fzero-link
2952 @opindex fzero-link
2953 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2954 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2955 compile time) with static class references that get initialized at load time,
2956 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2957 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2958 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2959 for individual class implementations to be modified during program execution.
2960 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2961 regardless of command-line options.
2963 @item -fno-local-ivars
2964 @opindex fno-local-ivars
2965 @opindex flocal-ivars
2966 By default instance variables in Objective-C can be accessed as if
2967 they were local variables from within the methods of the class they're
2968 declared in.  This can lead to shadowing between instance variables
2969 and other variables declared either locally inside a class method or
2970 globally with the same name.  Specifying the @option{-fno-local-ivars}
2971 flag disables this behavior thus avoiding variable shadowing issues.
2973 @item -fivar-visibility=@var{public|protected|private|package}
2974 @opindex fivar-visibility
2975 Set the default instance variable visibility to the specified option
2976 so that instance variables declared outside the scope of any access
2977 modifier directives default to the specified visibility.
2979 @item -gen-decls
2980 @opindex gen-decls
2981 Dump interface declarations for all classes seen in the source file to a
2982 file named @file{@var{sourcename}.decl}.
2984 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2985 @opindex Wassign-intercept
2986 @opindex Wno-assign-intercept
2987 Warn whenever an Objective-C assignment is being intercepted by the
2988 garbage collector.
2990 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2991 @opindex Wno-protocol
2992 @opindex Wprotocol
2993 If a class is declared to implement a protocol, a warning is issued for
2994 every method in the protocol that is not implemented by the class.  The
2995 default behavior is to issue a warning for every method not explicitly
2996 implemented in the class, even if a method implementation is inherited
2997 from the superclass.  If you use the @option{-Wno-protocol} option, then
2998 methods inherited from the superclass are considered to be implemented,
2999 and no warning is issued for them.
3001 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3002 @opindex Wselector
3003 @opindex Wno-selector
3004 Warn if multiple methods of different types for the same selector are
3005 found during compilation.  The check is performed on the list of methods
3006 in the final stage of compilation.  Additionally, a check is performed
3007 for each selector appearing in a @code{@@selector(@dots{})}
3008 expression, and a corresponding method for that selector has been found
3009 during compilation.  Because these checks scan the method table only at
3010 the end of compilation, these warnings are not produced if the final
3011 stage of compilation is not reached, for example because an error is
3012 found during compilation, or because the @option{-fsyntax-only} option is
3013 being used.
3015 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3016 @opindex Wstrict-selector-match
3017 @opindex Wno-strict-selector-match
3018 Warn if multiple methods with differing argument and/or return types are
3019 found for a given selector when attempting to send a message using this
3020 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3021 is off (which is the default behavior), the compiler omits such warnings
3022 if any differences found are confined to types that share the same size
3023 and alignment.
3025 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3026 @opindex Wundeclared-selector
3027 @opindex Wno-undeclared-selector
3028 Warn if a @code{@@selector(@dots{})} expression referring to an
3029 undeclared selector is found.  A selector is considered undeclared if no
3030 method with that name has been declared before the
3031 @code{@@selector(@dots{})} expression, either explicitly in an
3032 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3033 an @code{@@implementation} section.  This option always performs its
3034 checks as soon as a @code{@@selector(@dots{})} expression is found,
3035 while @option{-Wselector} only performs its checks in the final stage of
3036 compilation.  This also enforces the coding style convention
3037 that methods and selectors must be declared before being used.
3039 @item -print-objc-runtime-info
3040 @opindex print-objc-runtime-info
3041 Generate C header describing the largest structure that is passed by
3042 value, if any.
3044 @end table
3046 @node Language Independent Options
3047 @section Options to Control Diagnostic Messages Formatting
3048 @cindex options to control diagnostics formatting
3049 @cindex diagnostic messages
3050 @cindex message formatting
3052 Traditionally, diagnostic messages have been formatted irrespective of
3053 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3054 options described below
3055 to control the formatting algorithm for diagnostic messages, 
3056 e.g.@: how many characters per line, how often source location
3057 information should be reported.  Note that some language front ends may not
3058 honor these options.
3060 @table @gcctabopt
3061 @item -fmessage-length=@var{n}
3062 @opindex fmessage-length
3063 Try to format error messages so that they fit on lines of about @var{n}
3064 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
3065 the front ends supported by GCC@.  If @var{n} is zero, then no
3066 line-wrapping is done; each error message appears on a single
3067 line.
3069 @item -fdiagnostics-show-location=once
3070 @opindex fdiagnostics-show-location
3071 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3072 reporter to emit source location information @emph{once}; that is, in
3073 case the message is too long to fit on a single physical line and has to
3074 be wrapped, the source location won't be emitted (as prefix) again,
3075 over and over, in subsequent continuation lines.  This is the default
3076 behavior.
3078 @item -fdiagnostics-show-location=every-line
3079 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3080 messages reporter to emit the same source location information (as
3081 prefix) for physical lines that result from the process of breaking
3082 a message which is too long to fit on a single line.
3084 @item -fdiagnostics-color[=@var{WHEN}]
3085 @itemx -fno-diagnostics-color
3086 @opindex fdiagnostics-color
3087 @cindex highlight, color, colour
3088 @vindex GCC_COLORS @r{environment variable}
3089 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3090 or @samp{auto}.  The default is @samp{never} if @env{GCC_COLORS} environment
3091 variable isn't present in the environment, and @samp{auto} otherwise.
3092 @samp{auto} means to use color only when the standard error is a terminal.
3093 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3094 aliases for @option{-fdiagnostics-color=always} and
3095 @option{-fdiagnostics-color=never}, respectively.
3097 The colors are defined by the environment variable @env{GCC_COLORS}.
3098 Its value is a colon-separated list of capabilities and Select Graphic
3099 Rendition (SGR) substrings. SGR commands are interpreted by the
3100 terminal or terminal emulator.  (See the section in the documentation
3101 of your text terminal for permitted values and their meanings as
3102 character attributes.)  These substring values are integers in decimal
3103 representation and can be concatenated with semicolons.
3104 Common values to concatenate include
3105 @samp{1} for bold,
3106 @samp{4} for underline,
3107 @samp{5} for blink,
3108 @samp{7} for inverse,
3109 @samp{39} for default foreground color,
3110 @samp{30} to @samp{37} for foreground colors,
3111 @samp{90} to @samp{97} for 16-color mode foreground colors,
3112 @samp{38;5;0} to @samp{38;5;255}
3113 for 88-color and 256-color modes foreground colors,
3114 @samp{49} for default background color,
3115 @samp{40} to @samp{47} for background colors,
3116 @samp{100} to @samp{107} for 16-color mode background colors,
3117 and @samp{48;5;0} to @samp{48;5;255}
3118 for 88-color and 256-color modes background colors.
3120 The default @env{GCC_COLORS} is
3121 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3122 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3123 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3124 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3125 string disables colors.
3126 Supported capabilities are as follows.
3128 @table @code
3129 @item error=
3130 @vindex error GCC_COLORS @r{capability}
3131 SGR substring for error: markers.
3133 @item warning=
3134 @vindex warning GCC_COLORS @r{capability}
3135 SGR substring for warning: markers.
3137 @item note=
3138 @vindex note GCC_COLORS @r{capability}
3139 SGR substring for note: markers.
3141 @item caret=
3142 @vindex caret GCC_COLORS @r{capability}
3143 SGR substring for caret line.
3145 @item locus=
3146 @vindex locus GCC_COLORS @r{capability}
3147 SGR substring for location information, @samp{file:line} or
3148 @samp{file:line:column} etc.
3150 @item quote=
3151 @vindex quote GCC_COLORS @r{capability}
3152 SGR substring for information printed within quotes.
3153 @end table
3155 @item -fno-diagnostics-show-option
3156 @opindex fno-diagnostics-show-option
3157 @opindex fdiagnostics-show-option
3158 By default, each diagnostic emitted includes text indicating the
3159 command-line option that directly controls the diagnostic (if such an
3160 option is known to the diagnostic machinery).  Specifying the
3161 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3163 @item -fno-diagnostics-show-caret
3164 @opindex fno-diagnostics-show-caret
3165 @opindex fdiagnostics-show-caret
3166 By default, each diagnostic emitted includes the original source line
3167 and a caret '^' indicating the column.  This option suppresses this
3168 information.
3170 @end table
3172 @node Warning Options
3173 @section Options to Request or Suppress Warnings
3174 @cindex options to control warnings
3175 @cindex warning messages
3176 @cindex messages, warning
3177 @cindex suppressing warnings
3179 Warnings are diagnostic messages that report constructions that
3180 are not inherently erroneous but that are risky or suggest there
3181 may have been an error.
3183 The following language-independent options do not enable specific
3184 warnings but control the kinds of diagnostics produced by GCC@.
3186 @table @gcctabopt
3187 @cindex syntax checking
3188 @item -fsyntax-only
3189 @opindex fsyntax-only
3190 Check the code for syntax errors, but don't do anything beyond that.
3192 @item -fmax-errors=@var{n}
3193 @opindex fmax-errors
3194 Limits the maximum number of error messages to @var{n}, at which point
3195 GCC bails out rather than attempting to continue processing the source
3196 code.  If @var{n} is 0 (the default), there is no limit on the number
3197 of error messages produced.  If @option{-Wfatal-errors} is also
3198 specified, then @option{-Wfatal-errors} takes precedence over this
3199 option.
3201 @item -w
3202 @opindex w
3203 Inhibit all warning messages.
3205 @item -Werror
3206 @opindex Werror
3207 @opindex Wno-error
3208 Make all warnings into errors.
3210 @item -Werror=
3211 @opindex Werror=
3212 @opindex Wno-error=
3213 Make the specified warning into an error.  The specifier for a warning
3214 is appended; for example @option{-Werror=switch} turns the warnings
3215 controlled by @option{-Wswitch} into errors.  This switch takes a
3216 negative form, to be used to negate @option{-Werror} for specific
3217 warnings; for example @option{-Wno-error=switch} makes
3218 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3219 is in effect.
3221 The warning message for each controllable warning includes the
3222 option that controls the warning.  That option can then be used with
3223 @option{-Werror=} and @option{-Wno-error=} as described above.
3224 (Printing of the option in the warning message can be disabled using the
3225 @option{-fno-diagnostics-show-option} flag.)
3227 Note that specifying @option{-Werror=}@var{foo} automatically implies
3228 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3229 imply anything.
3231 @item -Wfatal-errors
3232 @opindex Wfatal-errors
3233 @opindex Wno-fatal-errors
3234 This option causes the compiler to abort compilation on the first error
3235 occurred rather than trying to keep going and printing further error
3236 messages.
3238 @end table
3240 You can request many specific warnings with options beginning with
3241 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3242 implicit declarations.  Each of these specific warning options also
3243 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3244 example, @option{-Wno-implicit}.  This manual lists only one of the
3245 two forms, whichever is not the default.  For further
3246 language-specific options also refer to @ref{C++ Dialect Options} and
3247 @ref{Objective-C and Objective-C++ Dialect Options}.
3249 When an unrecognized warning option is requested (e.g.,
3250 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3251 that the option is not recognized.  However, if the @option{-Wno-} form
3252 is used, the behavior is slightly different: no diagnostic is
3253 produced for @option{-Wno-unknown-warning} unless other diagnostics
3254 are being produced.  This allows the use of new @option{-Wno-} options
3255 with old compilers, but if something goes wrong, the compiler
3256 warns that an unrecognized option is present.
3258 @table @gcctabopt
3259 @item -Wpedantic
3260 @itemx -pedantic
3261 @opindex pedantic
3262 @opindex Wpedantic
3263 Issue all the warnings demanded by strict ISO C and ISO C++;
3264 reject all programs that use forbidden extensions, and some other
3265 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3266 version of the ISO C standard specified by any @option{-std} option used.
3268 Valid ISO C and ISO C++ programs should compile properly with or without
3269 this option (though a rare few require @option{-ansi} or a
3270 @option{-std} option specifying the required version of ISO C)@.  However,
3271 without this option, certain GNU extensions and traditional C and C++
3272 features are supported as well.  With this option, they are rejected.
3274 @option{-Wpedantic} does not cause warning messages for use of the
3275 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3276 warnings are also disabled in the expression that follows
3277 @code{__extension__}.  However, only system header files should use
3278 these escape routes; application programs should avoid them.
3279 @xref{Alternate Keywords}.
3281 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3282 C conformance.  They soon find that it does not do quite what they want:
3283 it finds some non-ISO practices, but not all---only those for which
3284 ISO C @emph{requires} a diagnostic, and some others for which
3285 diagnostics have been added.
3287 A feature to report any failure to conform to ISO C might be useful in
3288 some instances, but would require considerable additional work and would
3289 be quite different from @option{-Wpedantic}.  We don't have plans to
3290 support such a feature in the near future.
3292 Where the standard specified with @option{-std} represents a GNU
3293 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3294 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3295 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3296 where they are required by the base standard.  (It does not make sense
3297 for such warnings to be given only for features not in the specified GNU
3298 C dialect, since by definition the GNU dialects of C include all
3299 features the compiler supports with the given option, and there would be
3300 nothing to warn about.)
3302 @item -pedantic-errors
3303 @opindex pedantic-errors
3304 Like @option{-Wpedantic}, except that errors are produced rather than
3305 warnings.
3307 @item -Wall
3308 @opindex Wall
3309 @opindex Wno-all
3310 This enables all the warnings about constructions that some users
3311 consider questionable, and that are easy to avoid (or modify to
3312 prevent the warning), even in conjunction with macros.  This also
3313 enables some language-specific warnings described in @ref{C++ Dialect
3314 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3316 @option{-Wall} turns on the following warning flags:
3318 @gccoptlist{-Waddress   @gol
3319 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3320 -Wc++11-compat  @gol
3321 -Wchar-subscripts  @gol
3322 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3323 -Wimplicit-int @r{(C and Objective-C only)} @gol
3324 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3325 -Wcomment  @gol
3326 -Wformat   @gol
3327 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3328 -Wmaybe-uninitialized @gol
3329 -Wmissing-braces @r{(only for C/ObjC)} @gol
3330 -Wnonnull  @gol
3331 -Wopenmp-simd @gol
3332 -Wparentheses  @gol
3333 -Wpointer-sign  @gol
3334 -Wreorder   @gol
3335 -Wreturn-type  @gol
3336 -Wsequence-point  @gol
3337 -Wsign-compare @r{(only in C++)}  @gol
3338 -Wstrict-aliasing  @gol
3339 -Wstrict-overflow=1  @gol
3340 -Wswitch  @gol
3341 -Wtrigraphs  @gol
3342 -Wuninitialized  @gol
3343 -Wunknown-pragmas  @gol
3344 -Wunused-function  @gol
3345 -Wunused-label     @gol
3346 -Wunused-value     @gol
3347 -Wunused-variable  @gol
3348 -Wvolatile-register-var @gol
3351 Note that some warning flags are not implied by @option{-Wall}.  Some of
3352 them warn about constructions that users generally do not consider
3353 questionable, but which occasionally you might wish to check for;
3354 others warn about constructions that are necessary or hard to avoid in
3355 some cases, and there is no simple way to modify the code to suppress
3356 the warning. Some of them are enabled by @option{-Wextra} but many of
3357 them must be enabled individually.
3359 @item -Wextra
3360 @opindex W
3361 @opindex Wextra
3362 @opindex Wno-extra
3363 This enables some extra warning flags that are not enabled by
3364 @option{-Wall}. (This option used to be called @option{-W}.  The older
3365 name is still supported, but the newer name is more descriptive.)
3367 @gccoptlist{-Wclobbered  @gol
3368 -Wempty-body  @gol
3369 -Wignored-qualifiers @gol
3370 -Wmissing-field-initializers  @gol
3371 -Wmissing-parameter-type @r{(C only)}  @gol
3372 -Wold-style-declaration @r{(C only)}  @gol
3373 -Woverride-init  @gol
3374 -Wsign-compare  @gol
3375 -Wtype-limits  @gol
3376 -Wuninitialized  @gol
3377 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3378 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3381 The option @option{-Wextra} also prints warning messages for the
3382 following cases:
3384 @itemize @bullet
3386 @item
3387 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3388 @samp{>}, or @samp{>=}.
3390 @item
3391 (C++ only) An enumerator and a non-enumerator both appear in a
3392 conditional expression.
3394 @item
3395 (C++ only) Ambiguous virtual bases.
3397 @item
3398 (C++ only) Subscripting an array that has been declared @samp{register}.
3400 @item
3401 (C++ only) Taking the address of a variable that has been declared
3402 @samp{register}.
3404 @item
3405 (C++ only) A base class is not initialized in a derived class's copy
3406 constructor.
3408 @end itemize
3410 @item -Wchar-subscripts
3411 @opindex Wchar-subscripts
3412 @opindex Wno-char-subscripts
3413 Warn if an array subscript has type @code{char}.  This is a common cause
3414 of error, as programmers often forget that this type is signed on some
3415 machines.
3416 This warning is enabled by @option{-Wall}.
3418 @item -Wcomment
3419 @opindex Wcomment
3420 @opindex Wno-comment
3421 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3422 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3423 This warning is enabled by @option{-Wall}.
3425 @item -Wno-coverage-mismatch
3426 @opindex Wno-coverage-mismatch
3427 Warn if feedback profiles do not match when using the
3428 @option{-fprofile-use} option.
3429 If a source file is changed between compiling with @option{-fprofile-gen} and
3430 with @option{-fprofile-use}, the files with the profile feedback can fail
3431 to match the source file and GCC cannot use the profile feedback
3432 information.  By default, this warning is enabled and is treated as an
3433 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3434 warning or @option{-Wno-error=coverage-mismatch} can be used to
3435 disable the error.  Disabling the error for this warning can result in
3436 poorly optimized code and is useful only in the
3437 case of very minor changes such as bug fixes to an existing code-base.
3438 Completely disabling the warning is not recommended.
3440 @item -Wno-cpp
3441 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3443 Suppress warning messages emitted by @code{#warning} directives.
3445 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3446 @opindex Wdouble-promotion
3447 @opindex Wno-double-promotion
3448 Give a warning when a value of type @code{float} is implicitly
3449 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3450 floating-point unit implement @code{float} in hardware, but emulate
3451 @code{double} in software.  On such a machine, doing computations
3452 using @code{double} values is much more expensive because of the
3453 overhead required for software emulation.
3455 It is easy to accidentally do computations with @code{double} because
3456 floating-point literals are implicitly of type @code{double}.  For
3457 example, in:
3458 @smallexample
3459 @group
3460 float area(float radius)
3462    return 3.14159 * radius * radius;
3464 @end group
3465 @end smallexample
3466 the compiler performs the entire computation with @code{double}
3467 because the floating-point literal is a @code{double}.
3469 @item -Wformat
3470 @itemx -Wformat=@var{n}
3471 @opindex Wformat
3472 @opindex Wno-format
3473 @opindex ffreestanding
3474 @opindex fno-builtin
3475 @opindex Wformat=
3476 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3477 the arguments supplied have types appropriate to the format string
3478 specified, and that the conversions specified in the format string make
3479 sense.  This includes standard functions, and others specified by format
3480 attributes (@pxref{Function Attributes}), in the @code{printf},
3481 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3482 not in the C standard) families (or other target-specific families).
3483 Which functions are checked without format attributes having been
3484 specified depends on the standard version selected, and such checks of
3485 functions without the attribute specified are disabled by
3486 @option{-ffreestanding} or @option{-fno-builtin}.
3488 The formats are checked against the format features supported by GNU
3489 libc version 2.2.  These include all ISO C90 and C99 features, as well
3490 as features from the Single Unix Specification and some BSD and GNU
3491 extensions.  Other library implementations may not support all these
3492 features; GCC does not support warning about features that go beyond a
3493 particular library's limitations.  However, if @option{-Wpedantic} is used
3494 with @option{-Wformat}, warnings are given about format features not
3495 in the selected standard version (but not for @code{strfmon} formats,
3496 since those are not in any version of the C standard).  @xref{C Dialect
3497 Options,,Options Controlling C Dialect}.
3499 @table @gcctabopt
3500 @item -Wformat=1
3501 @itemx -Wformat
3502 @opindex Wformat
3503 @opindex Wformat=1
3504 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3505 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3506 @option{-Wformat} also checks for null format arguments for several
3507 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3508 aspects of this level of format checking can be disabled by the
3509 options: @option{-Wno-format-contains-nul},
3510 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3511 @option{-Wformat} is enabled by @option{-Wall}.
3513 @item -Wno-format-contains-nul
3514 @opindex Wno-format-contains-nul
3515 @opindex Wformat-contains-nul
3516 If @option{-Wformat} is specified, do not warn about format strings that
3517 contain NUL bytes.
3519 @item -Wno-format-extra-args
3520 @opindex Wno-format-extra-args
3521 @opindex Wformat-extra-args
3522 If @option{-Wformat} is specified, do not warn about excess arguments to a
3523 @code{printf} or @code{scanf} format function.  The C standard specifies
3524 that such arguments are ignored.
3526 Where the unused arguments lie between used arguments that are
3527 specified with @samp{$} operand number specifications, normally
3528 warnings are still given, since the implementation could not know what
3529 type to pass to @code{va_arg} to skip the unused arguments.  However,
3530 in the case of @code{scanf} formats, this option suppresses the
3531 warning if the unused arguments are all pointers, since the Single
3532 Unix Specification says that such unused arguments are allowed.
3534 @item -Wno-format-zero-length
3535 @opindex Wno-format-zero-length
3536 @opindex Wformat-zero-length
3537 If @option{-Wformat} is specified, do not warn about zero-length formats.
3538 The C standard specifies that zero-length formats are allowed.
3541 @item -Wformat=2
3542 @opindex Wformat=2
3543 Enable @option{-Wformat} plus additional format checks.  Currently
3544 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3545 -Wformat-signedness -Wformat-y2k}.
3547 @item -Wformat-nonliteral
3548 @opindex Wformat-nonliteral
3549 @opindex Wno-format-nonliteral
3550 If @option{-Wformat} is specified, also warn if the format string is not a
3551 string literal and so cannot be checked, unless the format function
3552 takes its format arguments as a @code{va_list}.
3554 @item -Wformat-security
3555 @opindex Wformat-security
3556 @opindex Wno-format-security
3557 If @option{-Wformat} is specified, also warn about uses of format
3558 functions that represent possible security problems.  At present, this
3559 warns about calls to @code{printf} and @code{scanf} functions where the
3560 format string is not a string literal and there are no format arguments,
3561 as in @code{printf (foo);}.  This may be a security hole if the format
3562 string came from untrusted input and contains @samp{%n}.  (This is
3563 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3564 in future warnings may be added to @option{-Wformat-security} that are not
3565 included in @option{-Wformat-nonliteral}.)
3567 @item -Wformat-signedness
3568 @opindex Wformat-signedness
3569 @opindex Wno-format-signedness
3570 If @option{-Wformat} is specified, also warn if the format string
3571 requires an unsigned argument and the argument is signed and vice versa.
3573 @item -Wformat-y2k
3574 @opindex Wformat-y2k
3575 @opindex Wno-format-y2k
3576 If @option{-Wformat} is specified, also warn about @code{strftime}
3577 formats that may yield only a two-digit year.
3578 @end table
3580 @item -Wnonnull
3581 @opindex Wnonnull
3582 @opindex Wno-nonnull
3583 Warn about passing a null pointer for arguments marked as
3584 requiring a non-null value by the @code{nonnull} function attribute.
3586 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3587 can be disabled with the @option{-Wno-nonnull} option.
3589 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3590 @opindex Winit-self
3591 @opindex Wno-init-self
3592 Warn about uninitialized variables that are initialized with themselves.
3593 Note this option can only be used with the @option{-Wuninitialized} option.
3595 For example, GCC warns about @code{i} being uninitialized in the
3596 following snippet only when @option{-Winit-self} has been specified:
3597 @smallexample
3598 @group
3599 int f()
3601   int i = i;
3602   return i;
3604 @end group
3605 @end smallexample
3607 This warning is enabled by @option{-Wall} in C++.
3609 @item -Wimplicit-int @r{(C and Objective-C only)}
3610 @opindex Wimplicit-int
3611 @opindex Wno-implicit-int
3612 Warn when a declaration does not specify a type.
3613 This warning is enabled by @option{-Wall}.
3615 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3616 @opindex Wimplicit-function-declaration
3617 @opindex Wno-implicit-function-declaration
3618 Give a warning whenever a function is used before being declared. In
3619 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3620 enabled by default and it is made into an error by
3621 @option{-pedantic-errors}. This warning is also enabled by
3622 @option{-Wall}.
3624 @item -Wimplicit @r{(C and Objective-C only)}
3625 @opindex Wimplicit
3626 @opindex Wno-implicit
3627 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3628 This warning is enabled by @option{-Wall}.
3630 @item -Wignored-qualifiers @r{(C and C++ only)}
3631 @opindex Wignored-qualifiers
3632 @opindex Wno-ignored-qualifiers
3633 Warn if the return type of a function has a type qualifier
3634 such as @code{const}.  For ISO C such a type qualifier has no effect,
3635 since the value returned by a function is not an lvalue.
3636 For C++, the warning is only emitted for scalar types or @code{void}.
3637 ISO C prohibits qualified @code{void} return types on function
3638 definitions, so such return types always receive a warning
3639 even without this option.
3641 This warning is also enabled by @option{-Wextra}.
3643 @item -Wmain
3644 @opindex Wmain
3645 @opindex Wno-main
3646 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3647 a function with external linkage, returning int, taking either zero
3648 arguments, two, or three arguments of appropriate types.  This warning
3649 is enabled by default in C++ and is enabled by either @option{-Wall}
3650 or @option{-Wpedantic}.
3652 @item -Wmissing-braces
3653 @opindex Wmissing-braces
3654 @opindex Wno-missing-braces
3655 Warn if an aggregate or union initializer is not fully bracketed.  In
3656 the following example, the initializer for @samp{a} is not fully
3657 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3658 enabled by @option{-Wall} in C.
3660 @smallexample
3661 int a[2][2] = @{ 0, 1, 2, 3 @};
3662 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3663 @end smallexample
3665 This warning is enabled by @option{-Wall}.
3667 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3668 @opindex Wmissing-include-dirs
3669 @opindex Wno-missing-include-dirs
3670 Warn if a user-supplied include directory does not exist.
3672 @item -Wparentheses
3673 @opindex Wparentheses
3674 @opindex Wno-parentheses
3675 Warn if parentheses are omitted in certain contexts, such
3676 as when there is an assignment in a context where a truth value
3677 is expected, or when operators are nested whose precedence people
3678 often get confused about.
3680 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3681 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3682 interpretation from that of ordinary mathematical notation.
3684 Also warn about constructions where there may be confusion to which
3685 @code{if} statement an @code{else} branch belongs.  Here is an example of
3686 such a case:
3688 @smallexample
3689 @group
3691   if (a)
3692     if (b)
3693       foo ();
3694   else
3695     bar ();
3697 @end group
3698 @end smallexample
3700 In C/C++, every @code{else} branch belongs to the innermost possible
3701 @code{if} statement, which in this example is @code{if (b)}.  This is
3702 often not what the programmer expected, as illustrated in the above
3703 example by indentation the programmer chose.  When there is the
3704 potential for this confusion, GCC issues a warning when this flag
3705 is specified.  To eliminate the warning, add explicit braces around
3706 the innermost @code{if} statement so there is no way the @code{else}
3707 can belong to the enclosing @code{if}.  The resulting code
3708 looks like this:
3710 @smallexample
3711 @group
3713   if (a)
3714     @{
3715       if (b)
3716         foo ();
3717       else
3718         bar ();
3719     @}
3721 @end group
3722 @end smallexample
3724 Also warn for dangerous uses of the GNU extension to
3725 @code{?:} with omitted middle operand. When the condition
3726 in the @code{?}: operator is a boolean expression, the omitted value is
3727 always 1.  Often programmers expect it to be a value computed
3728 inside the conditional expression instead.
3730 This warning is enabled by @option{-Wall}.
3732 @item -Wsequence-point
3733 @opindex Wsequence-point
3734 @opindex Wno-sequence-point
3735 Warn about code that may have undefined semantics because of violations
3736 of sequence point rules in the C and C++ standards.
3738 The C and C++ standards define the order in which expressions in a C/C++
3739 program are evaluated in terms of @dfn{sequence points}, which represent
3740 a partial ordering between the execution of parts of the program: those
3741 executed before the sequence point, and those executed after it.  These
3742 occur after the evaluation of a full expression (one which is not part
3743 of a larger expression), after the evaluation of the first operand of a
3744 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3745 function is called (but after the evaluation of its arguments and the
3746 expression denoting the called function), and in certain other places.
3747 Other than as expressed by the sequence point rules, the order of
3748 evaluation of subexpressions of an expression is not specified.  All
3749 these rules describe only a partial order rather than a total order,
3750 since, for example, if two functions are called within one expression
3751 with no sequence point between them, the order in which the functions
3752 are called is not specified.  However, the standards committee have
3753 ruled that function calls do not overlap.
3755 It is not specified when between sequence points modifications to the
3756 values of objects take effect.  Programs whose behavior depends on this
3757 have undefined behavior; the C and C++ standards specify that ``Between
3758 the previous and next sequence point an object shall have its stored
3759 value modified at most once by the evaluation of an expression.
3760 Furthermore, the prior value shall be read only to determine the value
3761 to be stored.''.  If a program breaks these rules, the results on any
3762 particular implementation are entirely unpredictable.
3764 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3765 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3766 diagnosed by this option, and it may give an occasional false positive
3767 result, but in general it has been found fairly effective at detecting
3768 this sort of problem in programs.
3770 The standard is worded confusingly, therefore there is some debate
3771 over the precise meaning of the sequence point rules in subtle cases.
3772 Links to discussions of the problem, including proposed formal
3773 definitions, may be found on the GCC readings page, at
3774 @uref{http://gcc.gnu.org/@/readings.html}.
3776 This warning is enabled by @option{-Wall} for C and C++.
3778 @item -Wno-return-local-addr
3779 @opindex Wno-return-local-addr
3780 @opindex Wreturn-local-addr
3781 Do not warn about returning a pointer (or in C++, a reference) to a
3782 variable that goes out of scope after the function returns.
3784 @item -Wreturn-type
3785 @opindex Wreturn-type
3786 @opindex Wno-return-type
3787 Warn whenever a function is defined with a return type that defaults
3788 to @code{int}.  Also warn about any @code{return} statement with no
3789 return value in a function whose return type is not @code{void}
3790 (falling off the end of the function body is considered returning
3791 without a value), and about a @code{return} statement with an
3792 expression in a function whose return type is @code{void}.
3794 For C++, a function without return type always produces a diagnostic
3795 message, even when @option{-Wno-return-type} is specified.  The only
3796 exceptions are @samp{main} and functions defined in system headers.
3798 This warning is enabled by @option{-Wall}.
3800 @item -Wswitch
3801 @opindex Wswitch
3802 @opindex Wno-switch
3803 Warn whenever a @code{switch} statement has an index of enumerated type
3804 and lacks a @code{case} for one or more of the named codes of that
3805 enumeration.  (The presence of a @code{default} label prevents this
3806 warning.)  @code{case} labels outside the enumeration range also
3807 provoke warnings when this option is used (even if there is a
3808 @code{default} label).
3809 This warning is enabled by @option{-Wall}.
3811 @item -Wswitch-default
3812 @opindex Wswitch-default
3813 @opindex Wno-switch-default
3814 Warn whenever a @code{switch} statement does not have a @code{default}
3815 case.
3817 @item -Wswitch-enum
3818 @opindex Wswitch-enum
3819 @opindex Wno-switch-enum
3820 Warn whenever a @code{switch} statement has an index of enumerated type
3821 and lacks a @code{case} for one or more of the named codes of that
3822 enumeration.  @code{case} labels outside the enumeration range also
3823 provoke warnings when this option is used.  The only difference
3824 between @option{-Wswitch} and this option is that this option gives a
3825 warning about an omitted enumeration code even if there is a
3826 @code{default} label.
3828 @item -Wswitch-bool
3829 @opindex Wswitch-bool
3830 @opindex Wno-switch-bool
3831 Warn whenever a @code{switch} statement has an index of boolean type.
3832 It is possible to suppress this warning by casting the controlling
3833 expression to a type other than @code{bool}.  For example:
3834 @smallexample
3835 @group
3836 switch ((int) (a == 4))
3837   @{
3838   @dots{}
3839   @}
3840 @end group
3841 @end smallexample
3842 This warning is enabled by default for C and C++ programs.
3844 @item -Wsync-nand @r{(C and C++ only)}
3845 @opindex Wsync-nand
3846 @opindex Wno-sync-nand
3847 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3848 built-in functions are used.  These functions changed semantics in GCC 4.4.
3850 @item -Wtrigraphs
3851 @opindex Wtrigraphs
3852 @opindex Wno-trigraphs
3853 Warn if any trigraphs are encountered that might change the meaning of
3854 the program (trigraphs within comments are not warned about).
3855 This warning is enabled by @option{-Wall}.
3857 @item -Wunused-but-set-parameter
3858 @opindex Wunused-but-set-parameter
3859 @opindex Wno-unused-but-set-parameter
3860 Warn whenever a function parameter is assigned to, but otherwise unused
3861 (aside from its declaration).
3863 To suppress this warning use the @samp{unused} attribute
3864 (@pxref{Variable Attributes}).
3866 This warning is also enabled by @option{-Wunused} together with
3867 @option{-Wextra}.
3869 @item -Wunused-but-set-variable
3870 @opindex Wunused-but-set-variable
3871 @opindex Wno-unused-but-set-variable
3872 Warn whenever a local variable is assigned to, but otherwise unused
3873 (aside from its declaration).
3874 This warning is enabled by @option{-Wall}.
3876 To suppress this warning use the @samp{unused} attribute
3877 (@pxref{Variable Attributes}).
3879 This warning is also enabled by @option{-Wunused}, which is enabled
3880 by @option{-Wall}.
3882 @item -Wunused-function
3883 @opindex Wunused-function
3884 @opindex Wno-unused-function
3885 Warn whenever a static function is declared but not defined or a
3886 non-inline static function is unused.
3887 This warning is enabled by @option{-Wall}.
3889 @item -Wunused-label
3890 @opindex Wunused-label
3891 @opindex Wno-unused-label
3892 Warn whenever a label is declared but not used.
3893 This warning is enabled by @option{-Wall}.
3895 To suppress this warning use the @samp{unused} attribute
3896 (@pxref{Variable Attributes}).
3898 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3899 @opindex Wunused-local-typedefs
3900 Warn when a typedef locally defined in a function is not used.
3901 This warning is enabled by @option{-Wall}.
3903 @item -Wunused-parameter
3904 @opindex Wunused-parameter
3905 @opindex Wno-unused-parameter
3906 Warn whenever a function parameter is unused aside from its declaration.
3908 To suppress this warning use the @samp{unused} attribute
3909 (@pxref{Variable Attributes}).
3911 @item -Wno-unused-result
3912 @opindex Wunused-result
3913 @opindex Wno-unused-result
3914 Do not warn if a caller of a function marked with attribute
3915 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3916 its return value. The default is @option{-Wunused-result}.
3918 @item -Wunused-variable
3919 @opindex Wunused-variable
3920 @opindex Wno-unused-variable
3921 Warn whenever a local variable or non-constant static variable is unused
3922 aside from its declaration.
3923 This warning is enabled by @option{-Wall}.
3925 To suppress this warning use the @samp{unused} attribute
3926 (@pxref{Variable Attributes}).
3928 @item -Wunused-value
3929 @opindex Wunused-value
3930 @opindex Wno-unused-value
3931 Warn whenever a statement computes a result that is explicitly not
3932 used. To suppress this warning cast the unused expression to
3933 @samp{void}. This includes an expression-statement or the left-hand
3934 side of a comma expression that contains no side effects. For example,
3935 an expression such as @samp{x[i,j]} causes a warning, while
3936 @samp{x[(void)i,j]} does not.
3938 This warning is enabled by @option{-Wall}.
3940 @item -Wunused
3941 @opindex Wunused
3942 @opindex Wno-unused
3943 All the above @option{-Wunused} options combined.
3945 In order to get a warning about an unused function parameter, you must
3946 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3947 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3949 @item -Wuninitialized
3950 @opindex Wuninitialized
3951 @opindex Wno-uninitialized
3952 Warn if an automatic variable is used without first being initialized
3953 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3954 warn if a non-static reference or non-static @samp{const} member
3955 appears in a class without constructors.
3957 If you want to warn about code that uses the uninitialized value of the
3958 variable in its own initializer, use the @option{-Winit-self} option.
3960 These warnings occur for individual uninitialized or clobbered
3961 elements of structure, union or array variables as well as for
3962 variables that are uninitialized or clobbered as a whole.  They do
3963 not occur for variables or elements declared @code{volatile}.  Because
3964 these warnings depend on optimization, the exact variables or elements
3965 for which there are warnings depends on the precise optimization
3966 options and version of GCC used.
3968 Note that there may be no warning about a variable that is used only
3969 to compute a value that itself is never used, because such
3970 computations may be deleted by data flow analysis before the warnings
3971 are printed.
3973 @item -Wmaybe-uninitialized
3974 @opindex Wmaybe-uninitialized
3975 @opindex Wno-maybe-uninitialized
3976 For an automatic variable, if there exists a path from the function
3977 entry to a use of the variable that is initialized, but there exist
3978 some other paths for which the variable is not initialized, the compiler
3979 emits a warning if it cannot prove the uninitialized paths are not
3980 executed at run time. These warnings are made optional because GCC is
3981 not smart enough to see all the reasons why the code might be correct
3982 in spite of appearing to have an error.  Here is one example of how
3983 this can happen:
3985 @smallexample
3986 @group
3988   int x;
3989   switch (y)
3990     @{
3991     case 1: x = 1;
3992       break;
3993     case 2: x = 4;
3994       break;
3995     case 3: x = 5;
3996     @}
3997   foo (x);
3999 @end group
4000 @end smallexample
4002 @noindent
4003 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4004 always initialized, but GCC doesn't know this. To suppress the
4005 warning, you need to provide a default case with assert(0) or
4006 similar code.
4008 @cindex @code{longjmp} warnings
4009 This option also warns when a non-volatile automatic variable might be
4010 changed by a call to @code{longjmp}.  These warnings as well are possible
4011 only in optimizing compilation.
4013 The compiler sees only the calls to @code{setjmp}.  It cannot know
4014 where @code{longjmp} will be called; in fact, a signal handler could
4015 call it at any point in the code.  As a result, you may get a warning
4016 even when there is in fact no problem because @code{longjmp} cannot
4017 in fact be called at the place that would cause a problem.
4019 Some spurious warnings can be avoided if you declare all the functions
4020 you use that never return as @code{noreturn}.  @xref{Function
4021 Attributes}.
4023 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4025 @item -Wunknown-pragmas
4026 @opindex Wunknown-pragmas
4027 @opindex Wno-unknown-pragmas
4028 @cindex warning for unknown pragmas
4029 @cindex unknown pragmas, warning
4030 @cindex pragmas, warning of unknown
4031 Warn when a @code{#pragma} directive is encountered that is not understood by 
4032 GCC@.  If this command-line option is used, warnings are even issued
4033 for unknown pragmas in system header files.  This is not the case if
4034 the warnings are only enabled by the @option{-Wall} command-line option.
4036 @item -Wno-pragmas
4037 @opindex Wno-pragmas
4038 @opindex Wpragmas
4039 Do not warn about misuses of pragmas, such as incorrect parameters,
4040 invalid syntax, or conflicts between pragmas.  See also
4041 @option{-Wunknown-pragmas}.
4043 @item -Wstrict-aliasing
4044 @opindex Wstrict-aliasing
4045 @opindex Wno-strict-aliasing
4046 This option is only active when @option{-fstrict-aliasing} is active.
4047 It warns about code that might break the strict aliasing rules that the
4048 compiler is using for optimization.  The warning does not catch all
4049 cases, but does attempt to catch the more common pitfalls.  It is
4050 included in @option{-Wall}.
4051 It is equivalent to @option{-Wstrict-aliasing=3}
4053 @item -Wstrict-aliasing=n
4054 @opindex Wstrict-aliasing=n
4055 This option is only active when @option{-fstrict-aliasing} is active.
4056 It warns about code that might break the strict aliasing rules that the
4057 compiler is using for optimization.
4058 Higher levels correspond to higher accuracy (fewer false positives).
4059 Higher levels also correspond to more effort, similar to the way @option{-O} 
4060 works.
4061 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4063 Level 1: Most aggressive, quick, least accurate.
4064 Possibly useful when higher levels
4065 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4066 false negatives.  However, it has many false positives.
4067 Warns for all pointer conversions between possibly incompatible types,
4068 even if never dereferenced.  Runs in the front end only.
4070 Level 2: Aggressive, quick, not too precise.
4071 May still have many false positives (not as many as level 1 though),
4072 and few false negatives (but possibly more than level 1).
4073 Unlike level 1, it only warns when an address is taken.  Warns about
4074 incomplete types.  Runs in the front end only.
4076 Level 3 (default for @option{-Wstrict-aliasing}):
4077 Should have very few false positives and few false
4078 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4079 Takes care of the common pun+dereference pattern in the front end:
4080 @code{*(int*)&some_float}.
4081 If optimization is enabled, it also runs in the back end, where it deals
4082 with multiple statement cases using flow-sensitive points-to information.
4083 Only warns when the converted pointer is dereferenced.
4084 Does not warn about incomplete types.
4086 @item -Wstrict-overflow
4087 @itemx -Wstrict-overflow=@var{n}
4088 @opindex Wstrict-overflow
4089 @opindex Wno-strict-overflow
4090 This option is only active when @option{-fstrict-overflow} is active.
4091 It warns about cases where the compiler optimizes based on the
4092 assumption that signed overflow does not occur.  Note that it does not
4093 warn about all cases where the code might overflow: it only warns
4094 about cases where the compiler implements some optimization.  Thus
4095 this warning depends on the optimization level.
4097 An optimization that assumes that signed overflow does not occur is
4098 perfectly safe if the values of the variables involved are such that
4099 overflow never does, in fact, occur.  Therefore this warning can
4100 easily give a false positive: a warning about code that is not
4101 actually a problem.  To help focus on important issues, several
4102 warning levels are defined.  No warnings are issued for the use of
4103 undefined signed overflow when estimating how many iterations a loop
4104 requires, in particular when determining whether a loop will be
4105 executed at all.
4107 @table @gcctabopt
4108 @item -Wstrict-overflow=1
4109 Warn about cases that are both questionable and easy to avoid.  For
4110 example,  with @option{-fstrict-overflow}, the compiler simplifies
4111 @code{x + 1 > x} to @code{1}.  This level of
4112 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4113 are not, and must be explicitly requested.
4115 @item -Wstrict-overflow=2
4116 Also warn about other cases where a comparison is simplified to a
4117 constant.  For example: @code{abs (x) >= 0}.  This can only be
4118 simplified when @option{-fstrict-overflow} is in effect, because
4119 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4120 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4121 @option{-Wstrict-overflow=2}.
4123 @item -Wstrict-overflow=3
4124 Also warn about other cases where a comparison is simplified.  For
4125 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4127 @item -Wstrict-overflow=4
4128 Also warn about other simplifications not covered by the above cases.
4129 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4131 @item -Wstrict-overflow=5
4132 Also warn about cases where the compiler reduces the magnitude of a
4133 constant involved in a comparison.  For example: @code{x + 2 > y} is
4134 simplified to @code{x + 1 >= y}.  This is reported only at the
4135 highest warning level because this simplification applies to many
4136 comparisons, so this warning level gives a very large number of
4137 false positives.
4138 @end table
4140 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4141 @opindex Wsuggest-attribute=
4142 @opindex Wno-suggest-attribute=
4143 Warn for cases where adding an attribute may be beneficial. The
4144 attributes currently supported are listed below.
4146 @table @gcctabopt
4147 @item -Wsuggest-attribute=pure
4148 @itemx -Wsuggest-attribute=const
4149 @itemx -Wsuggest-attribute=noreturn
4150 @opindex Wsuggest-attribute=pure
4151 @opindex Wno-suggest-attribute=pure
4152 @opindex Wsuggest-attribute=const
4153 @opindex Wno-suggest-attribute=const
4154 @opindex Wsuggest-attribute=noreturn
4155 @opindex Wno-suggest-attribute=noreturn
4157 Warn about functions that might be candidates for attributes
4158 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4159 functions visible in other compilation units or (in the case of @code{pure} and
4160 @code{const}) if it cannot prove that the function returns normally. A function
4161 returns normally if it doesn't contain an infinite loop or return abnormally
4162 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4163 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4164 higher.  Higher optimization levels improve the accuracy of the analysis.
4166 @item -Wsuggest-attribute=format
4167 @itemx -Wmissing-format-attribute
4168 @opindex Wsuggest-attribute=format
4169 @opindex Wmissing-format-attribute
4170 @opindex Wno-suggest-attribute=format
4171 @opindex Wno-missing-format-attribute
4172 @opindex Wformat
4173 @opindex Wno-format
4175 Warn about function pointers that might be candidates for @code{format}
4176 attributes.  Note these are only possible candidates, not absolute ones.
4177 GCC guesses that function pointers with @code{format} attributes that
4178 are used in assignment, initialization, parameter passing or return
4179 statements should have a corresponding @code{format} attribute in the
4180 resulting type.  I.e.@: the left-hand side of the assignment or
4181 initialization, the type of the parameter variable, or the return type
4182 of the containing function respectively should also have a @code{format}
4183 attribute to avoid the warning.
4185 GCC also warns about function definitions that might be
4186 candidates for @code{format} attributes.  Again, these are only
4187 possible candidates.  GCC guesses that @code{format} attributes
4188 might be appropriate for any function that calls a function like
4189 @code{vprintf} or @code{vscanf}, but this might not always be the
4190 case, and some functions for which @code{format} attributes are
4191 appropriate may not be detected.
4192 @end table
4194 @item -Warray-bounds
4195 @opindex Wno-array-bounds
4196 @opindex Warray-bounds
4197 This option is only active when @option{-ftree-vrp} is active
4198 (default for @option{-O2} and above). It warns about subscripts to arrays
4199 that are always out of bounds. This warning is enabled by @option{-Wall}.
4201 @item -Wno-discarded-qualifiers
4202 @opindex Wno-discarded-qualifiers
4203 @opindex Wdiscarded-qualifiers
4204 Do not warn if type qualifiers on pointers are being discarded.
4205 Typically, the compiler will warn if a @code{const char *} variable is
4206 passed to a function that takes @code{char *} parameter.  This option
4207 can be used to suppress such a warning.  This warning is only supported
4208 for C.
4210 @item -Wno-div-by-zero
4211 @opindex Wno-div-by-zero
4212 @opindex Wdiv-by-zero
4213 Do not warn about compile-time integer division by zero.  Floating-point
4214 division by zero is not warned about, as it can be a legitimate way of
4215 obtaining infinities and NaNs.
4217 @item -Wsystem-headers
4218 @opindex Wsystem-headers
4219 @opindex Wno-system-headers
4220 @cindex warnings from system headers
4221 @cindex system headers, warnings from
4222 Print warning messages for constructs found in system header files.
4223 Warnings from system headers are normally suppressed, on the assumption
4224 that they usually do not indicate real problems and would only make the
4225 compiler output harder to read.  Using this command-line option tells
4226 GCC to emit warnings from system headers as if they occurred in user
4227 code.  However, note that using @option{-Wall} in conjunction with this
4228 option does @emph{not} warn about unknown pragmas in system
4229 headers---for that, @option{-Wunknown-pragmas} must also be used.
4231 @item -Wtrampolines
4232 @opindex Wtrampolines
4233 @opindex Wno-trampolines
4234  Warn about trampolines generated for pointers to nested functions.
4236  A trampoline is a small piece of data or code that is created at run
4237  time on the stack when the address of a nested function is taken, and
4238  is used to call the nested function indirectly.  For some targets, it
4239  is made up of data only and thus requires no special treatment.  But,
4240  for most targets, it is made up of code and thus requires the stack
4241  to be made executable in order for the program to work properly.
4243 @item -Wfloat-equal
4244 @opindex Wfloat-equal
4245 @opindex Wno-float-equal
4246 Warn if floating-point values are used in equality comparisons.
4248 The idea behind this is that sometimes it is convenient (for the
4249 programmer) to consider floating-point values as approximations to
4250 infinitely precise real numbers.  If you are doing this, then you need
4251 to compute (by analyzing the code, or in some other way) the maximum or
4252 likely maximum error that the computation introduces, and allow for it
4253 when performing comparisons (and when producing output, but that's a
4254 different problem).  In particular, instead of testing for equality, you
4255 should check to see whether the two values have ranges that overlap; and
4256 this is done with the relational operators, so equality comparisons are
4257 probably mistaken.
4259 @item -Wtraditional @r{(C and Objective-C only)}
4260 @opindex Wtraditional
4261 @opindex Wno-traditional
4262 Warn about certain constructs that behave differently in traditional and
4263 ISO C@.  Also warn about ISO C constructs that have no traditional C
4264 equivalent, and/or problematic constructs that should be avoided.
4266 @itemize @bullet
4267 @item
4268 Macro parameters that appear within string literals in the macro body.
4269 In traditional C macro replacement takes place within string literals,
4270 but in ISO C it does not.
4272 @item
4273 In traditional C, some preprocessor directives did not exist.
4274 Traditional preprocessors only considered a line to be a directive
4275 if the @samp{#} appeared in column 1 on the line.  Therefore
4276 @option{-Wtraditional} warns about directives that traditional C
4277 understands but ignores because the @samp{#} does not appear as the
4278 first character on the line.  It also suggests you hide directives like
4279 @samp{#pragma} not understood by traditional C by indenting them.  Some
4280 traditional implementations do not recognize @samp{#elif}, so this option
4281 suggests avoiding it altogether.
4283 @item
4284 A function-like macro that appears without arguments.
4286 @item
4287 The unary plus operator.
4289 @item
4290 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4291 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4292 constants.)  Note, these suffixes appear in macros defined in the system
4293 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4294 Use of these macros in user code might normally lead to spurious
4295 warnings, however GCC's integrated preprocessor has enough context to
4296 avoid warning in these cases.
4298 @item
4299 A function declared external in one block and then used after the end of
4300 the block.
4302 @item
4303 A @code{switch} statement has an operand of type @code{long}.
4305 @item
4306 A non-@code{static} function declaration follows a @code{static} one.
4307 This construct is not accepted by some traditional C compilers.
4309 @item
4310 The ISO type of an integer constant has a different width or
4311 signedness from its traditional type.  This warning is only issued if
4312 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4313 typically represent bit patterns, are not warned about.
4315 @item
4316 Usage of ISO string concatenation is detected.
4318 @item
4319 Initialization of automatic aggregates.
4321 @item
4322 Identifier conflicts with labels.  Traditional C lacks a separate
4323 namespace for labels.
4325 @item
4326 Initialization of unions.  If the initializer is zero, the warning is
4327 omitted.  This is done under the assumption that the zero initializer in
4328 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4329 initializer warnings and relies on default initialization to zero in the
4330 traditional C case.
4332 @item
4333 Conversions by prototypes between fixed/floating-point values and vice
4334 versa.  The absence of these prototypes when compiling with traditional
4335 C causes serious problems.  This is a subset of the possible
4336 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4338 @item
4339 Use of ISO C style function definitions.  This warning intentionally is
4340 @emph{not} issued for prototype declarations or variadic functions
4341 because these ISO C features appear in your code when using
4342 libiberty's traditional C compatibility macros, @code{PARAMS} and
4343 @code{VPARAMS}.  This warning is also bypassed for nested functions
4344 because that feature is already a GCC extension and thus not relevant to
4345 traditional C compatibility.
4346 @end itemize
4348 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4349 @opindex Wtraditional-conversion
4350 @opindex Wno-traditional-conversion
4351 Warn if a prototype causes a type conversion that is different from what
4352 would happen to the same argument in the absence of a prototype.  This
4353 includes conversions of fixed point to floating and vice versa, and
4354 conversions changing the width or signedness of a fixed-point argument
4355 except when the same as the default promotion.
4357 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4358 @opindex Wdeclaration-after-statement
4359 @opindex Wno-declaration-after-statement
4360 Warn when a declaration is found after a statement in a block.  This
4361 construct, known from C++, was introduced with ISO C99 and is by default
4362 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4363 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4365 @item -Wundef
4366 @opindex Wundef
4367 @opindex Wno-undef
4368 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4370 @item -Wno-endif-labels
4371 @opindex Wno-endif-labels
4372 @opindex Wendif-labels
4373 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4375 @item -Wshadow
4376 @opindex Wshadow
4377 @opindex Wno-shadow
4378 Warn whenever a local variable or type declaration shadows another
4379 variable, parameter, type, class member (in C++), or instance variable
4380 (in Objective-C) or whenever a built-in function is shadowed. Note
4381 that in C++, the compiler warns if a local variable shadows an
4382 explicit typedef, but not if it shadows a struct/class/enum.
4384 @item -Wno-shadow-ivar @r{(Objective-C only)}
4385 @opindex Wno-shadow-ivar
4386 @opindex Wshadow-ivar
4387 Do not warn whenever a local variable shadows an instance variable in an
4388 Objective-C method.
4390 @item -Wlarger-than=@var{len}
4391 @opindex Wlarger-than=@var{len}
4392 @opindex Wlarger-than-@var{len}
4393 Warn whenever an object of larger than @var{len} bytes is defined.
4395 @item -Wframe-larger-than=@var{len}
4396 @opindex Wframe-larger-than
4397 Warn if the size of a function frame is larger than @var{len} bytes.
4398 The computation done to determine the stack frame size is approximate
4399 and not conservative.
4400 The actual requirements may be somewhat greater than @var{len}
4401 even if you do not get a warning.  In addition, any space allocated
4402 via @code{alloca}, variable-length arrays, or related constructs
4403 is not included by the compiler when determining
4404 whether or not to issue a warning.
4406 @item -Wno-free-nonheap-object
4407 @opindex Wno-free-nonheap-object
4408 @opindex Wfree-nonheap-object
4409 Do not warn when attempting to free an object that was not allocated
4410 on the heap.
4412 @item -Wstack-usage=@var{len}
4413 @opindex Wstack-usage
4414 Warn if the stack usage of a function might be larger than @var{len} bytes.
4415 The computation done to determine the stack usage is conservative.
4416 Any space allocated via @code{alloca}, variable-length arrays, or related
4417 constructs is included by the compiler when determining whether or not to
4418 issue a warning.
4420 The message is in keeping with the output of @option{-fstack-usage}.
4422 @itemize
4423 @item
4424 If the stack usage is fully static but exceeds the specified amount, it's:
4426 @smallexample
4427   warning: stack usage is 1120 bytes
4428 @end smallexample
4429 @item
4430 If the stack usage is (partly) dynamic but bounded, it's:
4432 @smallexample
4433   warning: stack usage might be 1648 bytes
4434 @end smallexample
4435 @item
4436 If the stack usage is (partly) dynamic and not bounded, it's:
4438 @smallexample
4439   warning: stack usage might be unbounded
4440 @end smallexample
4441 @end itemize
4443 @item -Wunsafe-loop-optimizations
4444 @opindex Wunsafe-loop-optimizations
4445 @opindex Wno-unsafe-loop-optimizations
4446 Warn if the loop cannot be optimized because the compiler cannot
4447 assume anything on the bounds of the loop indices.  With
4448 @option{-funsafe-loop-optimizations} warn if the compiler makes
4449 such assumptions.
4451 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4452 @opindex Wno-pedantic-ms-format
4453 @opindex Wpedantic-ms-format
4454 When used in combination with @option{-Wformat}
4455 and @option{-pedantic} without GNU extensions, this option
4456 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4457 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4458 which depend on the MS runtime.
4460 @item -Wpointer-arith
4461 @opindex Wpointer-arith
4462 @opindex Wno-pointer-arith
4463 Warn about anything that depends on the ``size of'' a function type or
4464 of @code{void}.  GNU C assigns these types a size of 1, for
4465 convenience in calculations with @code{void *} pointers and pointers
4466 to functions.  In C++, warn also when an arithmetic operation involves
4467 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4469 @item -Wtype-limits
4470 @opindex Wtype-limits
4471 @opindex Wno-type-limits
4472 Warn if a comparison is always true or always false due to the limited
4473 range of the data type, but do not warn for constant expressions.  For
4474 example, warn if an unsigned variable is compared against zero with
4475 @samp{<} or @samp{>=}.  This warning is also enabled by
4476 @option{-Wextra}.
4478 @item -Wbad-function-cast @r{(C and Objective-C only)}
4479 @opindex Wbad-function-cast
4480 @opindex Wno-bad-function-cast
4481 Warn whenever a function call is cast to a non-matching type.
4482 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4484 @item -Wc++-compat @r{(C and Objective-C only)}
4485 Warn about ISO C constructs that are outside of the common subset of
4486 ISO C and ISO C++, e.g.@: request for implicit conversion from
4487 @code{void *} to a pointer to non-@code{void} type.
4489 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4490 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4491 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4492 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4493 enabled by @option{-Wall}.
4495 @item -Wcast-qual
4496 @opindex Wcast-qual
4497 @opindex Wno-cast-qual
4498 Warn whenever a pointer is cast so as to remove a type qualifier from
4499 the target type.  For example, warn if a @code{const char *} is cast
4500 to an ordinary @code{char *}.
4502 Also warn when making a cast that introduces a type qualifier in an
4503 unsafe way.  For example, casting @code{char **} to @code{const char **}
4504 is unsafe, as in this example:
4506 @smallexample
4507   /* p is char ** value.  */
4508   const char **q = (const char **) p;
4509   /* Assignment of readonly string to const char * is OK.  */
4510   *q = "string";
4511   /* Now char** pointer points to read-only memory.  */
4512   **p = 'b';
4513 @end smallexample
4515 @item -Wcast-align
4516 @opindex Wcast-align
4517 @opindex Wno-cast-align
4518 Warn whenever a pointer is cast such that the required alignment of the
4519 target is increased.  For example, warn if a @code{char *} is cast to
4520 an @code{int *} on machines where integers can only be accessed at
4521 two- or four-byte boundaries.
4523 @item -Wwrite-strings
4524 @opindex Wwrite-strings
4525 @opindex Wno-write-strings
4526 When compiling C, give string constants the type @code{const
4527 char[@var{length}]} so that copying the address of one into a
4528 non-@code{const} @code{char *} pointer produces a warning.  These
4529 warnings help you find at compile time code that can try to write
4530 into a string constant, but only if you have been very careful about
4531 using @code{const} in declarations and prototypes.  Otherwise, it is
4532 just a nuisance. This is why we did not make @option{-Wall} request
4533 these warnings.
4535 When compiling C++, warn about the deprecated conversion from string
4536 literals to @code{char *}.  This warning is enabled by default for C++
4537 programs.
4539 @item -Wclobbered
4540 @opindex Wclobbered
4541 @opindex Wno-clobbered
4542 Warn for variables that might be changed by @samp{longjmp} or
4543 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4545 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4546 @opindex Wconditionally-supported
4547 @opindex Wno-conditionally-supported
4548 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4550 @item -Wconversion
4551 @opindex Wconversion
4552 @opindex Wno-conversion
4553 Warn for implicit conversions that may alter a value. This includes
4554 conversions between real and integer, like @code{abs (x)} when
4555 @code{x} is @code{double}; conversions between signed and unsigned,
4556 like @code{unsigned ui = -1}; and conversions to smaller types, like
4557 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4558 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4559 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4560 conversions between signed and unsigned integers can be disabled by
4561 using @option{-Wno-sign-conversion}.
4563 For C++, also warn for confusing overload resolution for user-defined
4564 conversions; and conversions that never use a type conversion
4565 operator: conversions to @code{void}, the same type, a base class or a
4566 reference to them. Warnings about conversions between signed and
4567 unsigned integers are disabled by default in C++ unless
4568 @option{-Wsign-conversion} is explicitly enabled.
4570 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4571 @opindex Wconversion-null
4572 @opindex Wno-conversion-null
4573 Do not warn for conversions between @code{NULL} and non-pointer
4574 types. @option{-Wconversion-null} is enabled by default.
4576 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4577 @opindex Wzero-as-null-pointer-constant
4578 @opindex Wno-zero-as-null-pointer-constant
4579 Warn when a literal '0' is used as null pointer constant.  This can
4580 be useful to facilitate the conversion to @code{nullptr} in C++11.
4582 @item -Wdate-time
4583 @opindex Wdate-time
4584 @opindex Wno-date-time
4585 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4586 are encountered as they might prevent bit-wise-identical reproducible
4587 compilations.
4589 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4590 @opindex Wdelete-incomplete
4591 @opindex Wno-delete-incomplete
4592 Warn when deleting a pointer to incomplete type, which may cause
4593 undefined behavior at runtime.  This warning is enabled by default.
4595 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4596 @opindex Wuseless-cast
4597 @opindex Wno-useless-cast
4598 Warn when an expression is casted to its own type.
4600 @item -Wempty-body
4601 @opindex Wempty-body
4602 @opindex Wno-empty-body
4603 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4604 while} statement.  This warning is also enabled by @option{-Wextra}.
4606 @item -Wenum-compare
4607 @opindex Wenum-compare
4608 @opindex Wno-enum-compare
4609 Warn about a comparison between values of different enumerated types.
4610 In C++ enumeral mismatches in conditional expressions are also
4611 diagnosed and the warning is enabled by default.  In C this warning is 
4612 enabled by @option{-Wall}.
4614 @item -Wjump-misses-init @r{(C, Objective-C only)}
4615 @opindex Wjump-misses-init
4616 @opindex Wno-jump-misses-init
4617 Warn if a @code{goto} statement or a @code{switch} statement jumps
4618 forward across the initialization of a variable, or jumps backward to a
4619 label after the variable has been initialized.  This only warns about
4620 variables that are initialized when they are declared.  This warning is
4621 only supported for C and Objective-C; in C++ this sort of branch is an
4622 error in any case.
4624 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4625 can be disabled with the @option{-Wno-jump-misses-init} option.
4627 @item -Wsign-compare
4628 @opindex Wsign-compare
4629 @opindex Wno-sign-compare
4630 @cindex warning for comparison of signed and unsigned values
4631 @cindex comparison of signed and unsigned values, warning
4632 @cindex signed and unsigned values, comparison warning
4633 Warn when a comparison between signed and unsigned values could produce
4634 an incorrect result when the signed value is converted to unsigned.
4635 This warning is also enabled by @option{-Wextra}; to get the other warnings
4636 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4638 @item -Wsign-conversion
4639 @opindex Wsign-conversion
4640 @opindex Wno-sign-conversion
4641 Warn for implicit conversions that may change the sign of an integer
4642 value, like assigning a signed integer expression to an unsigned
4643 integer variable. An explicit cast silences the warning. In C, this
4644 option is enabled also by @option{-Wconversion}.
4646 @item -Wfloat-conversion
4647 @opindex Wfloat-conversion
4648 @opindex Wno-float-conversion
4649 Warn for implicit conversions that reduce the precision of a real value.
4650 This includes conversions from real to integer, and from higher precision
4651 real to lower precision real values.  This option is also enabled by
4652 @option{-Wconversion}.
4654 @item -Wsizeof-pointer-memaccess
4655 @opindex Wsizeof-pointer-memaccess
4656 @opindex Wno-sizeof-pointer-memaccess
4657 Warn for suspicious length parameters to certain string and memory built-in
4658 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4659 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4660 but a pointer, and suggests a possible fix, or about
4661 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4662 @option{-Wall}.
4664 @item -Waddress
4665 @opindex Waddress
4666 @opindex Wno-address
4667 Warn about suspicious uses of memory addresses. These include using
4668 the address of a function in a conditional expression, such as
4669 @code{void func(void); if (func)}, and comparisons against the memory
4670 address of a string literal, such as @code{if (x == "abc")}.  Such
4671 uses typically indicate a programmer error: the address of a function
4672 always evaluates to true, so their use in a conditional usually
4673 indicate that the programmer forgot the parentheses in a function
4674 call; and comparisons against string literals result in unspecified
4675 behavior and are not portable in C, so they usually indicate that the
4676 programmer intended to use @code{strcmp}.  This warning is enabled by
4677 @option{-Wall}.
4679 @item -Wlogical-op
4680 @opindex Wlogical-op
4681 @opindex Wno-logical-op
4682 Warn about suspicious uses of logical operators in expressions.
4683 This includes using logical operators in contexts where a
4684 bit-wise operator is likely to be expected.
4686 @item -Wlogical-not-parentheses
4687 @opindex Wlogical-not-parentheses
4688 @opindex Wno-logical-not-parentheses
4689 Warn about logical not used on the left hand side operand of a comparison.
4690 This option does not warn if the LHS or RHS operand is of a boolean or
4691 a vector type.  Its purpose is to detect suspicious code like the following:
4692 @smallexample
4693 int a;
4694 @dots{}
4695 if (!a > 1) @{ @dots{} @}
4696 @end smallexample
4698 It is possible to suppress the warning by wrapping the LHS into
4699 parentheses:
4700 @smallexample
4701 if ((!a) > 1) @{ @dots{} @}
4702 @end smallexample
4704 @item -Waggregate-return
4705 @opindex Waggregate-return
4706 @opindex Wno-aggregate-return
4707 Warn if any functions that return structures or unions are defined or
4708 called.  (In languages where you can return an array, this also elicits
4709 a warning.)
4711 @item -Wno-aggressive-loop-optimizations
4712 @opindex Wno-aggressive-loop-optimizations
4713 @opindex Waggressive-loop-optimizations
4714 Warn if in a loop with constant number of iterations the compiler detects
4715 undefined behavior in some statement during one or more of the iterations.
4717 @item -Wno-attributes
4718 @opindex Wno-attributes
4719 @opindex Wattributes
4720 Do not warn if an unexpected @code{__attribute__} is used, such as
4721 unrecognized attributes, function attributes applied to variables,
4722 etc.  This does not stop errors for incorrect use of supported
4723 attributes.
4725 @item -Wno-builtin-macro-redefined
4726 @opindex Wno-builtin-macro-redefined
4727 @opindex Wbuiltin-macro-redefined
4728 Do not warn if certain built-in macros are redefined.  This suppresses
4729 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4730 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4732 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4733 @opindex Wstrict-prototypes
4734 @opindex Wno-strict-prototypes
4735 Warn if a function is declared or defined without specifying the
4736 argument types.  (An old-style function definition is permitted without
4737 a warning if preceded by a declaration that specifies the argument
4738 types.)
4740 @item -Wold-style-declaration @r{(C and Objective-C only)}
4741 @opindex Wold-style-declaration
4742 @opindex Wno-old-style-declaration
4743 Warn for obsolescent usages, according to the C Standard, in a
4744 declaration. For example, warn if storage-class specifiers like
4745 @code{static} are not the first things in a declaration.  This warning
4746 is also enabled by @option{-Wextra}.
4748 @item -Wold-style-definition @r{(C and Objective-C only)}
4749 @opindex Wold-style-definition
4750 @opindex Wno-old-style-definition
4751 Warn if an old-style function definition is used.  A warning is given
4752 even if there is a previous prototype.
4754 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4755 @opindex Wmissing-parameter-type
4756 @opindex Wno-missing-parameter-type
4757 A function parameter is declared without a type specifier in K&R-style
4758 functions:
4760 @smallexample
4761 void foo(bar) @{ @}
4762 @end smallexample
4764 This warning is also enabled by @option{-Wextra}.
4766 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4767 @opindex Wmissing-prototypes
4768 @opindex Wno-missing-prototypes
4769 Warn if a global function is defined without a previous prototype
4770 declaration.  This warning is issued even if the definition itself
4771 provides a prototype.  Use this option to detect global functions
4772 that do not have a matching prototype declaration in a header file.
4773 This option is not valid for C++ because all function declarations
4774 provide prototypes and a non-matching declaration will declare an
4775 overload rather than conflict with an earlier declaration.
4776 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4778 @item -Wmissing-declarations
4779 @opindex Wmissing-declarations
4780 @opindex Wno-missing-declarations
4781 Warn if a global function is defined without a previous declaration.
4782 Do so even if the definition itself provides a prototype.
4783 Use this option to detect global functions that are not declared in
4784 header files.  In C, no warnings are issued for functions with previous
4785 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4786 missing prototypes.  In C++, no warnings are issued for function templates,
4787 or for inline functions, or for functions in anonymous namespaces.
4789 @item -Wmissing-field-initializers
4790 @opindex Wmissing-field-initializers
4791 @opindex Wno-missing-field-initializers
4792 @opindex W
4793 @opindex Wextra
4794 @opindex Wno-extra
4795 Warn if a structure's initializer has some fields missing.  For
4796 example, the following code causes such a warning, because
4797 @code{x.h} is implicitly zero:
4799 @smallexample
4800 struct s @{ int f, g, h; @};
4801 struct s x = @{ 3, 4 @};
4802 @end smallexample
4804 This option does not warn about designated initializers, so the following
4805 modification does not trigger a warning:
4807 @smallexample
4808 struct s @{ int f, g, h; @};
4809 struct s x = @{ .f = 3, .g = 4 @};
4810 @end smallexample
4812 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4813 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4815 @item -Wno-multichar
4816 @opindex Wno-multichar
4817 @opindex Wmultichar
4818 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4819 Usually they indicate a typo in the user's code, as they have
4820 implementation-defined values, and should not be used in portable code.
4822 @item -Wnormalized=<none|id|nfc|nfkc>
4823 @opindex Wnormalized=
4824 @cindex NFC
4825 @cindex NFKC
4826 @cindex character set, input normalization
4827 In ISO C and ISO C++, two identifiers are different if they are
4828 different sequences of characters.  However, sometimes when characters
4829 outside the basic ASCII character set are used, you can have two
4830 different character sequences that look the same.  To avoid confusion,
4831 the ISO 10646 standard sets out some @dfn{normalization rules} which
4832 when applied ensure that two sequences that look the same are turned into
4833 the same sequence.  GCC can warn you if you are using identifiers that
4834 have not been normalized; this option controls that warning.
4836 There are four levels of warning supported by GCC@.  The default is
4837 @option{-Wnormalized=nfc}, which warns about any identifier that is
4838 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4839 recommended form for most uses.
4841 Unfortunately, there are some characters allowed in identifiers by
4842 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4843 identifiers.  That is, there's no way to use these symbols in portable
4844 ISO C or C++ and have all your identifiers in NFC@.
4845 @option{-Wnormalized=id} suppresses the warning for these characters.
4846 It is hoped that future versions of the standards involved will correct
4847 this, which is why this option is not the default.
4849 You can switch the warning off for all characters by writing
4850 @option{-Wnormalized=none}.  You should only do this if you
4851 are using some other normalization scheme (like ``D''), because
4852 otherwise you can easily create bugs that are literally impossible to see.
4854 Some characters in ISO 10646 have distinct meanings but look identical
4855 in some fonts or display methodologies, especially once formatting has
4856 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4857 LETTER N'', displays just like a regular @code{n} that has been
4858 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4859 normalization scheme to convert all these into a standard form as
4860 well, and GCC warns if your code is not in NFKC if you use
4861 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4862 about every identifier that contains the letter O because it might be
4863 confused with the digit 0, and so is not the default, but may be
4864 useful as a local coding convention if the programming environment 
4865 cannot be fixed to display these characters distinctly.
4867 @item -Wno-deprecated
4868 @opindex Wno-deprecated
4869 @opindex Wdeprecated
4870 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4872 @item -Wno-deprecated-declarations
4873 @opindex Wno-deprecated-declarations
4874 @opindex Wdeprecated-declarations
4875 Do not warn about uses of functions (@pxref{Function Attributes}),
4876 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4877 Attributes}) marked as deprecated by using the @code{deprecated}
4878 attribute.
4880 @item -Wno-overflow
4881 @opindex Wno-overflow
4882 @opindex Woverflow
4883 Do not warn about compile-time overflow in constant expressions.
4885 @item -Wopenmp-simd
4886 @opindex Wopenm-simd
4887 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
4888 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
4889 be used to relax the cost model.
4891 @item -Woverride-init @r{(C and Objective-C only)}
4892 @opindex Woverride-init
4893 @opindex Wno-override-init
4894 @opindex W
4895 @opindex Wextra
4896 @opindex Wno-extra
4897 Warn if an initialized field without side effects is overridden when
4898 using designated initializers (@pxref{Designated Inits, , Designated
4899 Initializers}).
4901 This warning is included in @option{-Wextra}.  To get other
4902 @option{-Wextra} warnings without this one, use @option{-Wextra
4903 -Wno-override-init}.
4905 @item -Wpacked
4906 @opindex Wpacked
4907 @opindex Wno-packed
4908 Warn if a structure is given the packed attribute, but the packed
4909 attribute has no effect on the layout or size of the structure.
4910 Such structures may be mis-aligned for little benefit.  For
4911 instance, in this code, the variable @code{f.x} in @code{struct bar}
4912 is misaligned even though @code{struct bar} does not itself
4913 have the packed attribute:
4915 @smallexample
4916 @group
4917 struct foo @{
4918   int x;
4919   char a, b, c, d;
4920 @} __attribute__((packed));
4921 struct bar @{
4922   char z;
4923   struct foo f;
4925 @end group
4926 @end smallexample
4928 @item -Wpacked-bitfield-compat
4929 @opindex Wpacked-bitfield-compat
4930 @opindex Wno-packed-bitfield-compat
4931 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4932 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4933 the change can lead to differences in the structure layout.  GCC
4934 informs you when the offset of such a field has changed in GCC 4.4.
4935 For example there is no longer a 4-bit padding between field @code{a}
4936 and @code{b} in this structure:
4938 @smallexample
4939 struct foo
4941   char a:4;
4942   char b:8;
4943 @} __attribute__ ((packed));
4944 @end smallexample
4946 This warning is enabled by default.  Use
4947 @option{-Wno-packed-bitfield-compat} to disable this warning.
4949 @item -Wpadded
4950 @opindex Wpadded
4951 @opindex Wno-padded
4952 Warn if padding is included in a structure, either to align an element
4953 of the structure or to align the whole structure.  Sometimes when this
4954 happens it is possible to rearrange the fields of the structure to
4955 reduce the padding and so make the structure smaller.
4957 @item -Wredundant-decls
4958 @opindex Wredundant-decls
4959 @opindex Wno-redundant-decls
4960 Warn if anything is declared more than once in the same scope, even in
4961 cases where multiple declaration is valid and changes nothing.
4963 @item -Wnested-externs @r{(C and Objective-C only)}
4964 @opindex Wnested-externs
4965 @opindex Wno-nested-externs
4966 Warn if an @code{extern} declaration is encountered within a function.
4968 @item -Wno-inherited-variadic-ctor
4969 @opindex Winherited-variadic-ctor
4970 @opindex Wno-inherited-variadic-ctor
4971 Suppress warnings about use of C++11 inheriting constructors when the
4972 base class inherited from has a C variadic constructor; the warning is
4973 on by default because the ellipsis is not inherited.
4975 @item -Winline
4976 @opindex Winline
4977 @opindex Wno-inline
4978 Warn if a function that is declared as inline cannot be inlined.
4979 Even with this option, the compiler does not warn about failures to
4980 inline functions declared in system headers.
4982 The compiler uses a variety of heuristics to determine whether or not
4983 to inline a function.  For example, the compiler takes into account
4984 the size of the function being inlined and the amount of inlining
4985 that has already been done in the current function.  Therefore,
4986 seemingly insignificant changes in the source program can cause the
4987 warnings produced by @option{-Winline} to appear or disappear.
4989 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4990 @opindex Wno-invalid-offsetof
4991 @opindex Winvalid-offsetof
4992 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4993 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4994 to a non-POD type is undefined.  In existing C++ implementations,
4995 however, @samp{offsetof} typically gives meaningful results even when
4996 applied to certain kinds of non-POD types (such as a simple
4997 @samp{struct} that fails to be a POD type only by virtue of having a
4998 constructor).  This flag is for users who are aware that they are
4999 writing nonportable code and who have deliberately chosen to ignore the
5000 warning about it.
5002 The restrictions on @samp{offsetof} may be relaxed in a future version
5003 of the C++ standard.
5005 @item -Wno-int-to-pointer-cast
5006 @opindex Wno-int-to-pointer-cast
5007 @opindex Wint-to-pointer-cast
5008 Suppress warnings from casts to pointer type of an integer of a
5009 different size. In C++, casting to a pointer type of smaller size is
5010 an error. @option{Wint-to-pointer-cast} is enabled by default.
5013 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5014 @opindex Wno-pointer-to-int-cast
5015 @opindex Wpointer-to-int-cast
5016 Suppress warnings from casts from a pointer to an integer type of a
5017 different size.
5019 @item -Winvalid-pch
5020 @opindex Winvalid-pch
5021 @opindex Wno-invalid-pch
5022 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5023 the search path but can't be used.
5025 @item -Wlong-long
5026 @opindex Wlong-long
5027 @opindex Wno-long-long
5028 Warn if @samp{long long} type is used.  This is enabled by either
5029 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5030 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5032 @item -Wvariadic-macros
5033 @opindex Wvariadic-macros
5034 @opindex Wno-variadic-macros
5035 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
5036 alternate syntax when in pedantic ISO C99 mode.  This is default.
5037 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
5039 @item -Wvarargs
5040 @opindex Wvarargs
5041 @opindex Wno-varargs
5042 Warn upon questionable usage of the macros used to handle variable
5043 arguments like @samp{va_start}.  This is default.  To inhibit the
5044 warning messages, use @option{-Wno-varargs}.
5046 @item -Wvector-operation-performance
5047 @opindex Wvector-operation-performance
5048 @opindex Wno-vector-operation-performance
5049 Warn if vector operation is not implemented via SIMD capabilities of the
5050 architecture.  Mainly useful for the performance tuning.
5051 Vector operation can be implemented @code{piecewise}, which means that the
5052 scalar operation is performed on every vector element; 
5053 @code{in parallel}, which means that the vector operation is implemented
5054 using scalars of wider type, which normally is more performance efficient;
5055 and @code{as a single scalar}, which means that vector fits into a
5056 scalar type.
5058 @item -Wno-virtual-move-assign
5059 @opindex Wvirtual-move-assign
5060 @opindex Wno-virtual-move-assign
5061 Suppress warnings about inheriting from a virtual base with a
5062 non-trivial C++11 move assignment operator.  This is dangerous because
5063 if the virtual base is reachable along more than one path, it will be
5064 moved multiple times, which can mean both objects end up in the
5065 moved-from state.  If the move assignment operator is written to avoid
5066 moving from a moved-from object, this warning can be disabled.
5068 @item -Wvla
5069 @opindex Wvla
5070 @opindex Wno-vla
5071 Warn if variable length array is used in the code.
5072 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5073 the variable length array.
5075 @item -Wvolatile-register-var
5076 @opindex Wvolatile-register-var
5077 @opindex Wno-volatile-register-var
5078 Warn if a register variable is declared volatile.  The volatile
5079 modifier does not inhibit all optimizations that may eliminate reads
5080 and/or writes to register variables.  This warning is enabled by
5081 @option{-Wall}.
5083 @item -Wdisabled-optimization
5084 @opindex Wdisabled-optimization
5085 @opindex Wno-disabled-optimization
5086 Warn if a requested optimization pass is disabled.  This warning does
5087 not generally indicate that there is anything wrong with your code; it
5088 merely indicates that GCC's optimizers are unable to handle the code
5089 effectively.  Often, the problem is that your code is too big or too
5090 complex; GCC refuses to optimize programs when the optimization
5091 itself is likely to take inordinate amounts of time.
5093 @item -Wpointer-sign @r{(C and Objective-C only)}
5094 @opindex Wpointer-sign
5095 @opindex Wno-pointer-sign
5096 Warn for pointer argument passing or assignment with different signedness.
5097 This option is only supported for C and Objective-C@.  It is implied by
5098 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5099 @option{-Wno-pointer-sign}.
5101 @item -Wstack-protector
5102 @opindex Wstack-protector
5103 @opindex Wno-stack-protector
5104 This option is only active when @option{-fstack-protector} is active.  It
5105 warns about functions that are not protected against stack smashing.
5107 @item -Woverlength-strings
5108 @opindex Woverlength-strings
5109 @opindex Wno-overlength-strings
5110 Warn about string constants that are longer than the ``minimum
5111 maximum'' length specified in the C standard.  Modern compilers
5112 generally allow string constants that are much longer than the
5113 standard's minimum limit, but very portable programs should avoid
5114 using longer strings.
5116 The limit applies @emph{after} string constant concatenation, and does
5117 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5118 C99, it was raised to 4095.  C++98 does not specify a normative
5119 minimum maximum, so we do not diagnose overlength strings in C++@.
5121 This option is implied by @option{-Wpedantic}, and can be disabled with
5122 @option{-Wno-overlength-strings}.
5124 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5125 @opindex Wunsuffixed-float-constants
5127 Issue a warning for any floating constant that does not have
5128 a suffix.  When used together with @option{-Wsystem-headers} it
5129 warns about such constants in system header files.  This can be useful
5130 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5131 from the decimal floating-point extension to C99.
5132 @end table
5134 @node Debugging Options
5135 @section Options for Debugging Your Program or GCC
5136 @cindex options, debugging
5137 @cindex debugging information options
5139 GCC has various special options that are used for debugging
5140 either your program or GCC:
5142 @table @gcctabopt
5143 @item -g
5144 @opindex g
5145 Produce debugging information in the operating system's native format
5146 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5147 information.
5149 On most systems that use stabs format, @option{-g} enables use of extra
5150 debugging information that only GDB can use; this extra information
5151 makes debugging work better in GDB but probably makes other debuggers
5152 crash or
5153 refuse to read the program.  If you want to control for certain whether
5154 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5155 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5157 GCC allows you to use @option{-g} with
5158 @option{-O}.  The shortcuts taken by optimized code may occasionally
5159 produce surprising results: some variables you declared may not exist
5160 at all; flow of control may briefly move where you did not expect it;
5161 some statements may not be executed because they compute constant
5162 results or their values are already at hand; some statements may
5163 execute in different places because they have been moved out of loops.
5165 Nevertheless it proves possible to debug optimized output.  This makes
5166 it reasonable to use the optimizer for programs that might have bugs.
5168 The following options are useful when GCC is generated with the
5169 capability for more than one debugging format.
5171 @item -gsplit-dwarf
5172 @opindex gsplit-dwarf
5173 Separate as much dwarf debugging information as possible into a
5174 separate output file with the extension .dwo.  This option allows
5175 the build system to avoid linking files with debug information.  To
5176 be useful, this option requires a debugger capable of reading .dwo
5177 files.
5179 @item -ggdb
5180 @opindex ggdb
5181 Produce debugging information for use by GDB@.  This means to use the
5182 most expressive format available (DWARF 2, stabs, or the native format
5183 if neither of those are supported), including GDB extensions if at all
5184 possible.
5186 @item -gpubnames
5187 @opindex gpubnames
5188 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5190 @item -ggnu-pubnames
5191 @opindex ggnu-pubnames
5192 Generate .debug_pubnames and .debug_pubtypes sections in a format
5193 suitable for conversion into a GDB@ index.  This option is only useful
5194 with a linker that can produce GDB@ index version 7.
5196 @item -gstabs
5197 @opindex gstabs
5198 Produce debugging information in stabs format (if that is supported),
5199 without GDB extensions.  This is the format used by DBX on most BSD
5200 systems.  On MIPS, Alpha and System V Release 4 systems this option
5201 produces stabs debugging output that is not understood by DBX or SDB@.
5202 On System V Release 4 systems this option requires the GNU assembler.
5204 @item -feliminate-unused-debug-symbols
5205 @opindex feliminate-unused-debug-symbols
5206 Produce debugging information in stabs format (if that is supported),
5207 for only symbols that are actually used.
5209 @item -femit-class-debug-always
5210 Instead of emitting debugging information for a C++ class in only one
5211 object file, emit it in all object files using the class.  This option
5212 should be used only with debuggers that are unable to handle the way GCC
5213 normally emits debugging information for classes because using this
5214 option increases the size of debugging information by as much as a
5215 factor of two.
5217 @item -fdebug-types-section
5218 @opindex fdebug-types-section
5219 @opindex fno-debug-types-section
5220 When using DWARF Version 4 or higher, type DIEs can be put into
5221 their own @code{.debug_types} section instead of making them part of the
5222 @code{.debug_info} section.  It is more efficient to put them in a separate
5223 comdat sections since the linker can then remove duplicates.
5224 But not all DWARF consumers support @code{.debug_types} sections yet
5225 and on some objects @code{.debug_types} produces larger instead of smaller
5226 debugging information.
5228 @item -gstabs+
5229 @opindex gstabs+
5230 Produce debugging information in stabs format (if that is supported),
5231 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5232 use of these extensions is likely to make other debuggers crash or
5233 refuse to read the program.
5235 @item -gcoff
5236 @opindex gcoff
5237 Produce debugging information in COFF format (if that is supported).
5238 This is the format used by SDB on most System V systems prior to
5239 System V Release 4.
5241 @item -gxcoff
5242 @opindex gxcoff
5243 Produce debugging information in XCOFF format (if that is supported).
5244 This is the format used by the DBX debugger on IBM RS/6000 systems.
5246 @item -gxcoff+
5247 @opindex gxcoff+
5248 Produce debugging information in XCOFF format (if that is supported),
5249 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5250 use of these extensions is likely to make other debuggers crash or
5251 refuse to read the program, and may cause assemblers other than the GNU
5252 assembler (GAS) to fail with an error.
5254 @item -gdwarf-@var{version}
5255 @opindex gdwarf-@var{version}
5256 Produce debugging information in DWARF format (if that is supported).
5257 The value of @var{version} may be either 2, 3 or 4; the default version
5258 for most targets is 4.
5260 Note that with DWARF Version 2, some ports require and always
5261 use some non-conflicting DWARF 3 extensions in the unwind tables.
5263 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5264 for maximum benefit.
5266 @item -grecord-gcc-switches
5267 @opindex grecord-gcc-switches
5268 This switch causes the command-line options used to invoke the
5269 compiler that may affect code generation to be appended to the
5270 DW_AT_producer attribute in DWARF debugging information.  The options
5271 are concatenated with spaces separating them from each other and from
5272 the compiler version.  See also @option{-frecord-gcc-switches} for another
5273 way of storing compiler options into the object file.  This is the default.
5275 @item -gno-record-gcc-switches
5276 @opindex gno-record-gcc-switches
5277 Disallow appending command-line options to the DW_AT_producer attribute
5278 in DWARF debugging information.
5280 @item -gstrict-dwarf
5281 @opindex gstrict-dwarf
5282 Disallow using extensions of later DWARF standard version than selected
5283 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5284 DWARF extensions from later standard versions is allowed.
5286 @item -gno-strict-dwarf
5287 @opindex gno-strict-dwarf
5288 Allow using extensions of later DWARF standard version than selected with
5289 @option{-gdwarf-@var{version}}.
5291 @item -gvms
5292 @opindex gvms
5293 Produce debugging information in Alpha/VMS debug format (if that is
5294 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5296 @item -g@var{level}
5297 @itemx -ggdb@var{level}
5298 @itemx -gstabs@var{level}
5299 @itemx -gcoff@var{level}
5300 @itemx -gxcoff@var{level}
5301 @itemx -gvms@var{level}
5302 Request debugging information and also use @var{level} to specify how
5303 much information.  The default level is 2.
5305 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5306 @option{-g}.
5308 Level 1 produces minimal information, enough for making backtraces in
5309 parts of the program that you don't plan to debug.  This includes
5310 descriptions of functions and external variables, and line number
5311 tables, but no information about local variables.
5313 Level 3 includes extra information, such as all the macro definitions
5314 present in the program.  Some debuggers support macro expansion when
5315 you use @option{-g3}.
5317 @option{-gdwarf-2} does not accept a concatenated debug level, because
5318 GCC used to support an option @option{-gdwarf} that meant to generate
5319 debug information in version 1 of the DWARF format (which is very
5320 different from version 2), and it would have been too confusing.  That
5321 debug format is long obsolete, but the option cannot be changed now.
5322 Instead use an additional @option{-g@var{level}} option to change the
5323 debug level for DWARF.
5325 @item -gtoggle
5326 @opindex gtoggle
5327 Turn off generation of debug info, if leaving out this option
5328 generates it, or turn it on at level 2 otherwise.  The position of this
5329 argument in the command line does not matter; it takes effect after all
5330 other options are processed, and it does so only once, no matter how
5331 many times it is given.  This is mainly intended to be used with
5332 @option{-fcompare-debug}.
5334 @item -fsanitize=address
5335 @opindex fsanitize=address
5336 Enable AddressSanitizer, a fast memory error detector.
5337 Memory access instructions will be instrumented to detect
5338 out-of-bounds and use-after-free bugs.
5339 See @uref{http://code.google.com/p/address-sanitizer/} for
5340 more details.  The run-time behavior can be influenced using the
5341 @env{ASAN_OPTIONS} environment variable; see
5342 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5343 a list of supported options.
5345 @item -fsanitize=thread
5346 @opindex fsanitize=thread
5347 Enable ThreadSanitizer, a fast data race detector.
5348 Memory access instructions will be instrumented to detect
5349 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5350 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5351 environment variable; see
5352 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5353 supported options.
5355 @item -fsanitize=leak
5356 @opindex fsanitize=leak
5357 Enable LeakSanitizer, a memory leak detector.
5358 This option only matters for linking of executables and if neither
5359 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5360 case it will link the executable against a library that overrides @code{malloc}
5361 and other allocator functions.  See
5362 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5363 details.  The run-time behavior can be influenced using the
5364 @env{LSAN_OPTIONS} environment variable.
5366 @item -fsanitize=undefined
5367 @opindex fsanitize=undefined
5368 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5369 Various computations will be instrumented to detect undefined behavior
5370 at runtime.  Current suboptions are:
5372 @table @gcctabopt
5374 @item -fsanitize=shift
5375 @opindex fsanitize=shift
5377 This option enables checking that the result of a shift operation is
5378 not undefined.  Note that what exactly is considered undefined differs
5379 slightly between C and C++, as well as between ISO C90 and C99, etc.
5381 @item -fsanitize=integer-divide-by-zero
5382 @opindex fsanitize=integer-divide-by-zero
5384 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5386 @item -fsanitize=unreachable
5387 @opindex fsanitize=unreachable
5389 With this option, the compiler will turn the @code{__builtin_unreachable}
5390 call into a diagnostics message call instead.  When reaching the
5391 @code{__builtin_unreachable} call, the behavior is undefined.
5393 @item -fsanitize=vla-bound
5394 @opindex fsanitize=vla-bound
5396 This option instructs the compiler to check that the size of a variable
5397 length array is positive.  This option does not have any effect in
5398 @option{-std=c++1y} mode, as the standard requires the exception be thrown
5399 instead.
5401 @item -fsanitize=null
5402 @opindex fsanitize=null
5404 This option enables pointer checking.  Particularly, the application
5405 built with this option turned on will issue an error message when it
5406 tries to dereference a NULL pointer, or if a reference (possibly an
5407 rvalue reference) is bound to a NULL pointer.
5409 @item -fsanitize=return
5410 @opindex fsanitize=return
5412 This option enables return statement checking.  Programs
5413 built with this option turned on will issue an error message
5414 when the end of a non-void function is reached without actually
5415 returning a value.  This option works in C++ only.
5417 @item -fsanitize=signed-integer-overflow
5418 @opindex fsanitize=signed-integer-overflow
5420 This option enables signed integer overflow checking.  We check that
5421 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5422 does not overflow in the signed arithmetics.  Note, integer promotion
5423 rules must be taken into account.  That is, the following is not an
5424 overflow:
5425 @smallexample
5426 signed char a = SCHAR_MAX;
5427 a++;
5428 @end smallexample
5430 @end table
5432 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5433 @option{-fsanitize=undefined} gives a diagnostic message.
5434 This currently works only for the C family of languages.
5436 @item -fsanitize=float-divide-by-zero
5437 @opindex fsanitize=float-divide-by-zero
5439 Detect floating-point division by zero.  Unlike other similar options,
5440 @option{-fsanitize=float-divide-by-zero} is not enabled by
5441 @option{-fsanitize=undefined}, since floating-point division by zero can
5442 be a legitimate way of obtaining infinities and NaNs.
5444 @item -fsanitize=float-cast-overflow
5445 @opindex fsanitize=float-cast-overflow
5447 This option enables floating-point type to integer conversion checking.
5448 We check that the result of the conversion does not overflow.
5449 This option does not work well with @code{FE_INVALID} exceptions enabled.
5451 @item -fsanitize=bounds
5452 @opindex fsanitize=bounds
5454 This option enables instrumentation of array bounds.  Various out of bounds
5455 accesses are detected.  Flexible array members are not instrumented, as well
5456 as initializers of variables with static storage.
5458 @item -fsanitize-recover
5459 @opindex fsanitize-recover
5460 By default @option{-fsanitize=undefined} sanitization (and its suboptions
5461 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return})
5462 after reporting undefined behavior attempts to continue running the
5463 program as if no undefined behavior happened.  This means multiple undefined
5464 behavior runtime errors can be reported in a single program run, and the exit
5465 code of the program may indicate success even when undefined behavior
5466 has been reported.  The @option{-fno-sanitize-recover} can be used to alter
5467 this behavior, only the first detected undefined behavior will be reported
5468 and program will exit after that with non-zero exit code.
5470 @item -fsanitize-undefined-trap-on-error
5471 @opindex fsanitize-undefined-trap-on-error
5472 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5473 report undefined behavior using @code{__builtin_trap ()} rather than
5474 a @code{libubsan} library routine.  The advantage of this is that the
5475 @code{libubsan} library is not needed and will not be linked in, so this
5476 is usable even for use in freestanding environments.
5478 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5479 @opindex fdump-final-insns
5480 Dump the final internal representation (RTL) to @var{file}.  If the
5481 optional argument is omitted (or if @var{file} is @code{.}), the name
5482 of the dump file is determined by appending @code{.gkd} to the
5483 compilation output file name.
5485 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5486 @opindex fcompare-debug
5487 @opindex fno-compare-debug
5488 If no error occurs during compilation, run the compiler a second time,
5489 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5490 passed to the second compilation.  Dump the final internal
5491 representation in both compilations, and print an error if they differ.
5493 If the equal sign is omitted, the default @option{-gtoggle} is used.
5495 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5496 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5497 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5498 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5499 is used.
5501 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5502 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5503 of the final representation and the second compilation, preventing even
5504 @env{GCC_COMPARE_DEBUG} from taking effect.
5506 To verify full coverage during @option{-fcompare-debug} testing, set
5507 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5508 which GCC rejects as an invalid option in any actual compilation
5509 (rather than preprocessing, assembly or linking).  To get just a
5510 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5511 not overridden} will do.
5513 @item -fcompare-debug-second
5514 @opindex fcompare-debug-second
5515 This option is implicitly passed to the compiler for the second
5516 compilation requested by @option{-fcompare-debug}, along with options to
5517 silence warnings, and omitting other options that would cause
5518 side-effect compiler outputs to files or to the standard output.  Dump
5519 files and preserved temporary files are renamed so as to contain the
5520 @code{.gk} additional extension during the second compilation, to avoid
5521 overwriting those generated by the first.
5523 When this option is passed to the compiler driver, it causes the
5524 @emph{first} compilation to be skipped, which makes it useful for little
5525 other than debugging the compiler proper.
5527 @item -feliminate-dwarf2-dups
5528 @opindex feliminate-dwarf2-dups
5529 Compress DWARF 2 debugging information by eliminating duplicated
5530 information about each symbol.  This option only makes sense when
5531 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5533 @item -femit-struct-debug-baseonly
5534 @opindex femit-struct-debug-baseonly
5535 Emit debug information for struct-like types
5536 only when the base name of the compilation source file
5537 matches the base name of file in which the struct is defined.
5539 This option substantially reduces the size of debugging information,
5540 but at significant potential loss in type information to the debugger.
5541 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5542 See @option{-femit-struct-debug-detailed} for more detailed control.
5544 This option works only with DWARF 2.
5546 @item -femit-struct-debug-reduced
5547 @opindex femit-struct-debug-reduced
5548 Emit debug information for struct-like types
5549 only when the base name of the compilation source file
5550 matches the base name of file in which the type is defined,
5551 unless the struct is a template or defined in a system header.
5553 This option significantly reduces the size of debugging information,
5554 with some potential loss in type information to the debugger.
5555 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5556 See @option{-femit-struct-debug-detailed} for more detailed control.
5558 This option works only with DWARF 2.
5560 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5561 Specify the struct-like types
5562 for which the compiler generates debug information.
5563 The intent is to reduce duplicate struct debug information
5564 between different object files within the same program.
5566 This option is a detailed version of
5567 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5568 which serves for most needs.
5570 A specification has the syntax@*
5571 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5573 The optional first word limits the specification to
5574 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5575 A struct type is used directly when it is the type of a variable, member.
5576 Indirect uses arise through pointers to structs.
5577 That is, when use of an incomplete struct is valid, the use is indirect.
5578 An example is
5579 @samp{struct one direct; struct two * indirect;}.
5581 The optional second word limits the specification to
5582 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5583 Generic structs are a bit complicated to explain.
5584 For C++, these are non-explicit specializations of template classes,
5585 or non-template classes within the above.
5586 Other programming languages have generics,
5587 but @option{-femit-struct-debug-detailed} does not yet implement them.
5589 The third word specifies the source files for those
5590 structs for which the compiler should emit debug information.
5591 The values @samp{none} and @samp{any} have the normal meaning.
5592 The value @samp{base} means that
5593 the base of name of the file in which the type declaration appears
5594 must match the base of the name of the main compilation file.
5595 In practice, this means that when compiling @file{foo.c}, debug information
5596 is generated for types declared in that file and @file{foo.h},
5597 but not other header files.
5598 The value @samp{sys} means those types satisfying @samp{base}
5599 or declared in system or compiler headers.
5601 You may need to experiment to determine the best settings for your application.
5603 The default is @option{-femit-struct-debug-detailed=all}.
5605 This option works only with DWARF 2.
5607 @item -fno-merge-debug-strings
5608 @opindex fmerge-debug-strings
5609 @opindex fno-merge-debug-strings
5610 Direct the linker to not merge together strings in the debugging
5611 information that are identical in different object files.  Merging is
5612 not supported by all assemblers or linkers.  Merging decreases the size
5613 of the debug information in the output file at the cost of increasing
5614 link processing time.  Merging is enabled by default.
5616 @item -fdebug-prefix-map=@var{old}=@var{new}
5617 @opindex fdebug-prefix-map
5618 When compiling files in directory @file{@var{old}}, record debugging
5619 information describing them as in @file{@var{new}} instead.
5621 @item -fno-dwarf2-cfi-asm
5622 @opindex fdwarf2-cfi-asm
5623 @opindex fno-dwarf2-cfi-asm
5624 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5625 instead of using GAS @code{.cfi_*} directives.
5627 @cindex @command{prof}
5628 @item -p
5629 @opindex p
5630 Generate extra code to write profile information suitable for the
5631 analysis program @command{prof}.  You must use this option when compiling
5632 the source files you want data about, and you must also use it when
5633 linking.
5635 @cindex @command{gprof}
5636 @item -pg
5637 @opindex pg
5638 Generate extra code to write profile information suitable for the
5639 analysis program @command{gprof}.  You must use this option when compiling
5640 the source files you want data about, and you must also use it when
5641 linking.
5643 @item -Q
5644 @opindex Q
5645 Makes the compiler print out each function name as it is compiled, and
5646 print some statistics about each pass when it finishes.
5648 @item -ftime-report
5649 @opindex ftime-report
5650 Makes the compiler print some statistics about the time consumed by each
5651 pass when it finishes.
5653 @item -fmem-report
5654 @opindex fmem-report
5655 Makes the compiler print some statistics about permanent memory
5656 allocation when it finishes.
5658 @item -fmem-report-wpa
5659 @opindex fmem-report-wpa
5660 Makes the compiler print some statistics about permanent memory
5661 allocation for the WPA phase only.
5663 @item -fpre-ipa-mem-report
5664 @opindex fpre-ipa-mem-report
5665 @item -fpost-ipa-mem-report
5666 @opindex fpost-ipa-mem-report
5667 Makes the compiler print some statistics about permanent memory
5668 allocation before or after interprocedural optimization.
5670 @item -fprofile-report
5671 @opindex fprofile-report
5672 Makes the compiler print some statistics about consistency of the
5673 (estimated) profile and effect of individual passes.
5675 @item -fstack-usage
5676 @opindex fstack-usage
5677 Makes the compiler output stack usage information for the program, on a
5678 per-function basis.  The filename for the dump is made by appending
5679 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5680 the output file, if explicitly specified and it is not an executable,
5681 otherwise it is the basename of the source file.  An entry is made up
5682 of three fields:
5684 @itemize
5685 @item
5686 The name of the function.
5687 @item
5688 A number of bytes.
5689 @item
5690 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5691 @end itemize
5693 The qualifier @code{static} means that the function manipulates the stack
5694 statically: a fixed number of bytes are allocated for the frame on function
5695 entry and released on function exit; no stack adjustments are otherwise made
5696 in the function.  The second field is this fixed number of bytes.
5698 The qualifier @code{dynamic} means that the function manipulates the stack
5699 dynamically: in addition to the static allocation described above, stack
5700 adjustments are made in the body of the function, for example to push/pop
5701 arguments around function calls.  If the qualifier @code{bounded} is also
5702 present, the amount of these adjustments is bounded at compile time and
5703 the second field is an upper bound of the total amount of stack used by
5704 the function.  If it is not present, the amount of these adjustments is
5705 not bounded at compile time and the second field only represents the
5706 bounded part.
5708 @item -fprofile-arcs
5709 @opindex fprofile-arcs
5710 Add code so that program flow @dfn{arcs} are instrumented.  During
5711 execution the program records how many times each branch and call is
5712 executed and how many times it is taken or returns.  When the compiled
5713 program exits it saves this data to a file called
5714 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5715 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5716 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5717 @var{auxname} is generated from the name of the output file, if
5718 explicitly specified and it is not the final executable, otherwise it is
5719 the basename of the source file.  In both cases any suffix is removed
5720 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5721 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5722 @xref{Cross-profiling}.
5724 @cindex @command{gcov}
5725 @item --coverage
5726 @opindex coverage
5728 This option is used to compile and link code instrumented for coverage
5729 analysis.  The option is a synonym for @option{-fprofile-arcs}
5730 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5731 linking).  See the documentation for those options for more details.
5733 @itemize
5735 @item
5736 Compile the source files with @option{-fprofile-arcs} plus optimization
5737 and code generation options.  For test coverage analysis, use the
5738 additional @option{-ftest-coverage} option.  You do not need to profile
5739 every source file in a program.
5741 @item
5742 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5743 (the latter implies the former).
5745 @item
5746 Run the program on a representative workload to generate the arc profile
5747 information.  This may be repeated any number of times.  You can run
5748 concurrent instances of your program, and provided that the file system
5749 supports locking, the data files will be correctly updated.  Also
5750 @code{fork} calls are detected and correctly handled (double counting
5751 will not happen).
5753 @item
5754 For profile-directed optimizations, compile the source files again with
5755 the same optimization and code generation options plus
5756 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5757 Control Optimization}).
5759 @item
5760 For test coverage analysis, use @command{gcov} to produce human readable
5761 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5762 @command{gcov} documentation for further information.
5764 @end itemize
5766 With @option{-fprofile-arcs}, for each function of your program GCC
5767 creates a program flow graph, then finds a spanning tree for the graph.
5768 Only arcs that are not on the spanning tree have to be instrumented: the
5769 compiler adds code to count the number of times that these arcs are
5770 executed.  When an arc is the only exit or only entrance to a block, the
5771 instrumentation code can be added to the block; otherwise, a new basic
5772 block must be created to hold the instrumentation code.
5774 @need 2000
5775 @item -ftest-coverage
5776 @opindex ftest-coverage
5777 Produce a notes file that the @command{gcov} code-coverage utility
5778 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5779 show program coverage.  Each source file's note file is called
5780 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5781 above for a description of @var{auxname} and instructions on how to
5782 generate test coverage data.  Coverage data matches the source files
5783 more closely if you do not optimize.
5785 @item -fdbg-cnt-list
5786 @opindex fdbg-cnt-list
5787 Print the name and the counter upper bound for all debug counters.
5790 @item -fdbg-cnt=@var{counter-value-list}
5791 @opindex fdbg-cnt
5792 Set the internal debug counter upper bound.  @var{counter-value-list}
5793 is a comma-separated list of @var{name}:@var{value} pairs
5794 which sets the upper bound of each debug counter @var{name} to @var{value}.
5795 All debug counters have the initial upper bound of @code{UINT_MAX};
5796 thus @code{dbg_cnt()} returns true always unless the upper bound
5797 is set by this option.
5798 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5799 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5801 @item -fenable-@var{kind}-@var{pass}
5802 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5803 @opindex fdisable-
5804 @opindex fenable-
5806 This is a set of options that are used to explicitly disable/enable
5807 optimization passes.  These options are intended for use for debugging GCC.
5808 Compiler users should use regular options for enabling/disabling
5809 passes instead.
5811 @table @gcctabopt
5813 @item -fdisable-ipa-@var{pass}
5814 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5815 statically invoked in the compiler multiple times, the pass name should be
5816 appended with a sequential number starting from 1.
5818 @item -fdisable-rtl-@var{pass}
5819 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5820 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5821 statically invoked in the compiler multiple times, the pass name should be
5822 appended with a sequential number starting from 1.  @var{range-list} is a 
5823 comma-separated list of function ranges or assembler names.  Each range is a number
5824 pair separated by a colon.  The range is inclusive in both ends.  If the range
5825 is trivial, the number pair can be simplified as a single number.  If the
5826 function's call graph node's @var{uid} falls within one of the specified ranges,
5827 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5828 function header of a dump file, and the pass names can be dumped by using
5829 option @option{-fdump-passes}.
5831 @item -fdisable-tree-@var{pass}
5832 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5833 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5834 option arguments.
5836 @item -fenable-ipa-@var{pass}
5837 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5838 statically invoked in the compiler multiple times, the pass name should be
5839 appended with a sequential number starting from 1.
5841 @item -fenable-rtl-@var{pass}
5842 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5843 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5844 description and examples.
5846 @item -fenable-tree-@var{pass}
5847 @itemx -fenable-tree-@var{pass}=@var{range-list}
5848 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5849 of option arguments.
5851 @end table
5853 Here are some examples showing uses of these options.
5855 @smallexample
5857 # disable ccp1 for all functions
5858    -fdisable-tree-ccp1
5859 # disable complete unroll for function whose cgraph node uid is 1
5860    -fenable-tree-cunroll=1
5861 # disable gcse2 for functions at the following ranges [1,1],
5862 # [300,400], and [400,1000]
5863 # disable gcse2 for functions foo and foo2
5864    -fdisable-rtl-gcse2=foo,foo2
5865 # disable early inlining
5866    -fdisable-tree-einline
5867 # disable ipa inlining
5868    -fdisable-ipa-inline
5869 # enable tree full unroll
5870    -fenable-tree-unroll
5872 @end smallexample
5874 @item -d@var{letters}
5875 @itemx -fdump-rtl-@var{pass}
5876 @itemx -fdump-rtl-@var{pass}=@var{filename}
5877 @opindex d
5878 @opindex fdump-rtl-@var{pass}
5879 Says to make debugging dumps during compilation at times specified by
5880 @var{letters}.  This is used for debugging the RTL-based passes of the
5881 compiler.  The file names for most of the dumps are made by appending
5882 a pass number and a word to the @var{dumpname}, and the files are
5883 created in the directory of the output file. In case of
5884 @option{=@var{filename}} option, the dump is output on the given file
5885 instead of the pass numbered dump files. Note that the pass number is
5886 computed statically as passes get registered into the pass manager.
5887 Thus the numbering is not related to the dynamic order of execution of
5888 passes.  In particular, a pass installed by a plugin could have a
5889 number over 200 even if it executed quite early.  @var{dumpname} is
5890 generated from the name of the output file, if explicitly specified
5891 and it is not an executable, otherwise it is the basename of the
5892 source file. These switches may have different effects when
5893 @option{-E} is used for preprocessing.
5895 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5896 @option{-d} option @var{letters}.  Here are the possible
5897 letters for use in @var{pass} and @var{letters}, and their meanings:
5899 @table @gcctabopt
5901 @item -fdump-rtl-alignments
5902 @opindex fdump-rtl-alignments
5903 Dump after branch alignments have been computed.
5905 @item -fdump-rtl-asmcons
5906 @opindex fdump-rtl-asmcons
5907 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5909 @item -fdump-rtl-auto_inc_dec
5910 @opindex fdump-rtl-auto_inc_dec
5911 Dump after auto-inc-dec discovery.  This pass is only run on
5912 architectures that have auto inc or auto dec instructions.
5914 @item -fdump-rtl-barriers
5915 @opindex fdump-rtl-barriers
5916 Dump after cleaning up the barrier instructions.
5918 @item -fdump-rtl-bbpart
5919 @opindex fdump-rtl-bbpart
5920 Dump after partitioning hot and cold basic blocks.
5922 @item -fdump-rtl-bbro
5923 @opindex fdump-rtl-bbro
5924 Dump after block reordering.
5926 @item -fdump-rtl-btl1
5927 @itemx -fdump-rtl-btl2
5928 @opindex fdump-rtl-btl2
5929 @opindex fdump-rtl-btl2
5930 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5931 after the two branch
5932 target load optimization passes.
5934 @item -fdump-rtl-bypass
5935 @opindex fdump-rtl-bypass
5936 Dump after jump bypassing and control flow optimizations.
5938 @item -fdump-rtl-combine
5939 @opindex fdump-rtl-combine
5940 Dump after the RTL instruction combination pass.
5942 @item -fdump-rtl-compgotos
5943 @opindex fdump-rtl-compgotos
5944 Dump after duplicating the computed gotos.
5946 @item -fdump-rtl-ce1
5947 @itemx -fdump-rtl-ce2
5948 @itemx -fdump-rtl-ce3
5949 @opindex fdump-rtl-ce1
5950 @opindex fdump-rtl-ce2
5951 @opindex fdump-rtl-ce3
5952 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5953 @option{-fdump-rtl-ce3} enable dumping after the three
5954 if conversion passes.
5956 @item -fdump-rtl-cprop_hardreg
5957 @opindex fdump-rtl-cprop_hardreg
5958 Dump after hard register copy propagation.
5960 @item -fdump-rtl-csa
5961 @opindex fdump-rtl-csa
5962 Dump after combining stack adjustments.
5964 @item -fdump-rtl-cse1
5965 @itemx -fdump-rtl-cse2
5966 @opindex fdump-rtl-cse1
5967 @opindex fdump-rtl-cse2
5968 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5969 the two common subexpression elimination passes.
5971 @item -fdump-rtl-dce
5972 @opindex fdump-rtl-dce
5973 Dump after the standalone dead code elimination passes.
5975 @item -fdump-rtl-dbr
5976 @opindex fdump-rtl-dbr
5977 Dump after delayed branch scheduling.
5979 @item -fdump-rtl-dce1
5980 @itemx -fdump-rtl-dce2
5981 @opindex fdump-rtl-dce1
5982 @opindex fdump-rtl-dce2
5983 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5984 the two dead store elimination passes.
5986 @item -fdump-rtl-eh
5987 @opindex fdump-rtl-eh
5988 Dump after finalization of EH handling code.
5990 @item -fdump-rtl-eh_ranges
5991 @opindex fdump-rtl-eh_ranges
5992 Dump after conversion of EH handling range regions.
5994 @item -fdump-rtl-expand
5995 @opindex fdump-rtl-expand
5996 Dump after RTL generation.
5998 @item -fdump-rtl-fwprop1
5999 @itemx -fdump-rtl-fwprop2
6000 @opindex fdump-rtl-fwprop1
6001 @opindex fdump-rtl-fwprop2
6002 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6003 dumping after the two forward propagation passes.
6005 @item -fdump-rtl-gcse1
6006 @itemx -fdump-rtl-gcse2
6007 @opindex fdump-rtl-gcse1
6008 @opindex fdump-rtl-gcse2
6009 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6010 after global common subexpression elimination.
6012 @item -fdump-rtl-init-regs
6013 @opindex fdump-rtl-init-regs
6014 Dump after the initialization of the registers.
6016 @item -fdump-rtl-initvals
6017 @opindex fdump-rtl-initvals
6018 Dump after the computation of the initial value sets.
6020 @item -fdump-rtl-into_cfglayout
6021 @opindex fdump-rtl-into_cfglayout
6022 Dump after converting to cfglayout mode.
6024 @item -fdump-rtl-ira
6025 @opindex fdump-rtl-ira
6026 Dump after iterated register allocation.
6028 @item -fdump-rtl-jump
6029 @opindex fdump-rtl-jump
6030 Dump after the second jump optimization.
6032 @item -fdump-rtl-loop2
6033 @opindex fdump-rtl-loop2
6034 @option{-fdump-rtl-loop2} enables dumping after the rtl
6035 loop optimization passes.
6037 @item -fdump-rtl-mach
6038 @opindex fdump-rtl-mach
6039 Dump after performing the machine dependent reorganization pass, if that
6040 pass exists.
6042 @item -fdump-rtl-mode_sw
6043 @opindex fdump-rtl-mode_sw
6044 Dump after removing redundant mode switches.
6046 @item -fdump-rtl-rnreg
6047 @opindex fdump-rtl-rnreg
6048 Dump after register renumbering.
6050 @item -fdump-rtl-outof_cfglayout
6051 @opindex fdump-rtl-outof_cfglayout
6052 Dump after converting from cfglayout mode.
6054 @item -fdump-rtl-peephole2
6055 @opindex fdump-rtl-peephole2
6056 Dump after the peephole pass.
6058 @item -fdump-rtl-postreload
6059 @opindex fdump-rtl-postreload
6060 Dump after post-reload optimizations.
6062 @item -fdump-rtl-pro_and_epilogue
6063 @opindex fdump-rtl-pro_and_epilogue
6064 Dump after generating the function prologues and epilogues.
6066 @item -fdump-rtl-sched1
6067 @itemx -fdump-rtl-sched2
6068 @opindex fdump-rtl-sched1
6069 @opindex fdump-rtl-sched2
6070 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6071 after the basic block scheduling passes.
6073 @item -fdump-rtl-ree
6074 @opindex fdump-rtl-ree
6075 Dump after sign/zero extension elimination.
6077 @item -fdump-rtl-seqabstr
6078 @opindex fdump-rtl-seqabstr
6079 Dump after common sequence discovery.
6081 @item -fdump-rtl-shorten
6082 @opindex fdump-rtl-shorten
6083 Dump after shortening branches.
6085 @item -fdump-rtl-sibling
6086 @opindex fdump-rtl-sibling
6087 Dump after sibling call optimizations.
6089 @item -fdump-rtl-split1
6090 @itemx -fdump-rtl-split2
6091 @itemx -fdump-rtl-split3
6092 @itemx -fdump-rtl-split4
6093 @itemx -fdump-rtl-split5
6094 @opindex fdump-rtl-split1
6095 @opindex fdump-rtl-split2
6096 @opindex fdump-rtl-split3
6097 @opindex fdump-rtl-split4
6098 @opindex fdump-rtl-split5
6099 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6100 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6101 @option{-fdump-rtl-split5} enable dumping after five rounds of
6102 instruction splitting.
6104 @item -fdump-rtl-sms
6105 @opindex fdump-rtl-sms
6106 Dump after modulo scheduling.  This pass is only run on some
6107 architectures.
6109 @item -fdump-rtl-stack
6110 @opindex fdump-rtl-stack
6111 Dump after conversion from GCC's ``flat register file'' registers to the
6112 x87's stack-like registers.  This pass is only run on x86 variants.
6114 @item -fdump-rtl-subreg1
6115 @itemx -fdump-rtl-subreg2
6116 @opindex fdump-rtl-subreg1
6117 @opindex fdump-rtl-subreg2
6118 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6119 the two subreg expansion passes.
6121 @item -fdump-rtl-unshare
6122 @opindex fdump-rtl-unshare
6123 Dump after all rtl has been unshared.
6125 @item -fdump-rtl-vartrack
6126 @opindex fdump-rtl-vartrack
6127 Dump after variable tracking.
6129 @item -fdump-rtl-vregs
6130 @opindex fdump-rtl-vregs
6131 Dump after converting virtual registers to hard registers.
6133 @item -fdump-rtl-web
6134 @opindex fdump-rtl-web
6135 Dump after live range splitting.
6137 @item -fdump-rtl-regclass
6138 @itemx -fdump-rtl-subregs_of_mode_init
6139 @itemx -fdump-rtl-subregs_of_mode_finish
6140 @itemx -fdump-rtl-dfinit
6141 @itemx -fdump-rtl-dfinish
6142 @opindex fdump-rtl-regclass
6143 @opindex fdump-rtl-subregs_of_mode_init
6144 @opindex fdump-rtl-subregs_of_mode_finish
6145 @opindex fdump-rtl-dfinit
6146 @opindex fdump-rtl-dfinish
6147 These dumps are defined but always produce empty files.
6149 @item -da
6150 @itemx -fdump-rtl-all
6151 @opindex da
6152 @opindex fdump-rtl-all
6153 Produce all the dumps listed above.
6155 @item -dA
6156 @opindex dA
6157 Annotate the assembler output with miscellaneous debugging information.
6159 @item -dD
6160 @opindex dD
6161 Dump all macro definitions, at the end of preprocessing, in addition to
6162 normal output.
6164 @item -dH
6165 @opindex dH
6166 Produce a core dump whenever an error occurs.
6168 @item -dp
6169 @opindex dp
6170 Annotate the assembler output with a comment indicating which
6171 pattern and alternative is used.  The length of each instruction is
6172 also printed.
6174 @item -dP
6175 @opindex dP
6176 Dump the RTL in the assembler output as a comment before each instruction.
6177 Also turns on @option{-dp} annotation.
6179 @item -dx
6180 @opindex dx
6181 Just generate RTL for a function instead of compiling it.  Usually used
6182 with @option{-fdump-rtl-expand}.
6183 @end table
6185 @item -fdump-noaddr
6186 @opindex fdump-noaddr
6187 When doing debugging dumps, suppress address output.  This makes it more
6188 feasible to use diff on debugging dumps for compiler invocations with
6189 different compiler binaries and/or different
6190 text / bss / data / heap / stack / dso start locations.
6192 @item -fdump-unnumbered
6193 @opindex fdump-unnumbered
6194 When doing debugging dumps, suppress instruction numbers and address output.
6195 This makes it more feasible to use diff on debugging dumps for compiler
6196 invocations with different options, in particular with and without
6197 @option{-g}.
6199 @item -fdump-unnumbered-links
6200 @opindex fdump-unnumbered-links
6201 When doing debugging dumps (see @option{-d} option above), suppress
6202 instruction numbers for the links to the previous and next instructions
6203 in a sequence.
6205 @item -fdump-translation-unit @r{(C++ only)}
6206 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6207 @opindex fdump-translation-unit
6208 Dump a representation of the tree structure for the entire translation
6209 unit to a file.  The file name is made by appending @file{.tu} to the
6210 source file name, and the file is created in the same directory as the
6211 output file.  If the @samp{-@var{options}} form is used, @var{options}
6212 controls the details of the dump as described for the
6213 @option{-fdump-tree} options.
6215 @item -fdump-class-hierarchy @r{(C++ only)}
6216 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6217 @opindex fdump-class-hierarchy
6218 Dump a representation of each class's hierarchy and virtual function
6219 table layout to a file.  The file name is made by appending
6220 @file{.class} to the source file name, and the file is created in the
6221 same directory as the output file.  If the @samp{-@var{options}} form
6222 is used, @var{options} controls the details of the dump as described
6223 for the @option{-fdump-tree} options.
6225 @item -fdump-ipa-@var{switch}
6226 @opindex fdump-ipa
6227 Control the dumping at various stages of inter-procedural analysis
6228 language tree to a file.  The file name is generated by appending a
6229 switch specific suffix to the source file name, and the file is created
6230 in the same directory as the output file.  The following dumps are
6231 possible:
6233 @table @samp
6234 @item all
6235 Enables all inter-procedural analysis dumps.
6237 @item cgraph
6238 Dumps information about call-graph optimization, unused function removal,
6239 and inlining decisions.
6241 @item inline
6242 Dump after function inlining.
6244 @end table
6246 @item -fdump-passes
6247 @opindex fdump-passes
6248 Dump the list of optimization passes that are turned on and off by
6249 the current command-line options.
6251 @item -fdump-statistics-@var{option}
6252 @opindex fdump-statistics
6253 Enable and control dumping of pass statistics in a separate file.  The
6254 file name is generated by appending a suffix ending in
6255 @samp{.statistics} to the source file name, and the file is created in
6256 the same directory as the output file.  If the @samp{-@var{option}}
6257 form is used, @samp{-stats} causes counters to be summed over the
6258 whole compilation unit while @samp{-details} dumps every event as
6259 the passes generate them.  The default with no option is to sum
6260 counters for each function compiled.
6262 @item -fdump-tree-@var{switch}
6263 @itemx -fdump-tree-@var{switch}-@var{options}
6264 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6265 @opindex fdump-tree
6266 Control the dumping at various stages of processing the intermediate
6267 language tree to a file.  The file name is generated by appending a
6268 switch-specific suffix to the source file name, and the file is
6269 created in the same directory as the output file. In case of
6270 @option{=@var{filename}} option, the dump is output on the given file
6271 instead of the auto named dump files.  If the @samp{-@var{options}}
6272 form is used, @var{options} is a list of @samp{-} separated options
6273 which control the details of the dump.  Not all options are applicable
6274 to all dumps; those that are not meaningful are ignored.  The
6275 following options are available
6277 @table @samp
6278 @item address
6279 Print the address of each node.  Usually this is not meaningful as it
6280 changes according to the environment and source file.  Its primary use
6281 is for tying up a dump file with a debug environment.
6282 @item asmname
6283 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6284 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6285 use working backward from mangled names in the assembly file.
6286 @item slim
6287 When dumping front-end intermediate representations, inhibit dumping
6288 of members of a scope or body of a function merely because that scope
6289 has been reached.  Only dump such items when they are directly reachable
6290 by some other path.
6292 When dumping pretty-printed trees, this option inhibits dumping the
6293 bodies of control structures.
6295 When dumping RTL, print the RTL in slim (condensed) form instead of
6296 the default LISP-like representation.
6297 @item raw
6298 Print a raw representation of the tree.  By default, trees are
6299 pretty-printed into a C-like representation.
6300 @item details
6301 Enable more detailed dumps (not honored by every dump option). Also
6302 include information from the optimization passes.
6303 @item stats
6304 Enable dumping various statistics about the pass (not honored by every dump
6305 option).
6306 @item blocks
6307 Enable showing basic block boundaries (disabled in raw dumps).
6308 @item graph
6309 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6310 dump a representation of the control flow graph suitable for viewing with
6311 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6312 the file is pretty-printed as a subgraph, so that GraphViz can render them
6313 all in a single plot.
6315 This option currently only works for RTL dumps, and the RTL is always
6316 dumped in slim form.
6317 @item vops
6318 Enable showing virtual operands for every statement.
6319 @item lineno
6320 Enable showing line numbers for statements.
6321 @item uid
6322 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6323 @item verbose
6324 Enable showing the tree dump for each statement.
6325 @item eh
6326 Enable showing the EH region number holding each statement.
6327 @item scev
6328 Enable showing scalar evolution analysis details.
6329 @item optimized
6330 Enable showing optimization information (only available in certain
6331 passes).
6332 @item missed
6333 Enable showing missed optimization information (only available in certain
6334 passes).
6335 @item notes
6336 Enable other detailed optimization information (only available in
6337 certain passes).
6338 @item =@var{filename}
6339 Instead of an auto named dump file, output into the given file
6340 name. The file names @file{stdout} and @file{stderr} are treated
6341 specially and are considered already open standard streams. For
6342 example,
6344 @smallexample
6345 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6346      -fdump-tree-pre=stderr file.c
6347 @end smallexample
6349 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6350 output on to @file{stderr}. If two conflicting dump filenames are
6351 given for the same pass, then the latter option overrides the earlier
6352 one.
6354 @item all
6355 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6356 and @option{lineno}.
6358 @item optall
6359 Turn on all optimization options, i.e., @option{optimized},
6360 @option{missed}, and @option{note}.
6361 @end table
6363 The following tree dumps are possible:
6364 @table @samp
6366 @item original
6367 @opindex fdump-tree-original
6368 Dump before any tree based optimization, to @file{@var{file}.original}.
6370 @item optimized
6371 @opindex fdump-tree-optimized
6372 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6374 @item gimple
6375 @opindex fdump-tree-gimple
6376 Dump each function before and after the gimplification pass to a file.  The
6377 file name is made by appending @file{.gimple} to the source file name.
6379 @item cfg
6380 @opindex fdump-tree-cfg
6381 Dump the control flow graph of each function to a file.  The file name is
6382 made by appending @file{.cfg} to the source file name.
6384 @item ch
6385 @opindex fdump-tree-ch
6386 Dump each function after copying loop headers.  The file name is made by
6387 appending @file{.ch} to the source file name.
6389 @item ssa
6390 @opindex fdump-tree-ssa
6391 Dump SSA related information to a file.  The file name is made by appending
6392 @file{.ssa} to the source file name.
6394 @item alias
6395 @opindex fdump-tree-alias
6396 Dump aliasing information for each function.  The file name is made by
6397 appending @file{.alias} to the source file name.
6399 @item ccp
6400 @opindex fdump-tree-ccp
6401 Dump each function after CCP@.  The file name is made by appending
6402 @file{.ccp} to the source file name.
6404 @item storeccp
6405 @opindex fdump-tree-storeccp
6406 Dump each function after STORE-CCP@.  The file name is made by appending
6407 @file{.storeccp} to the source file name.
6409 @item pre
6410 @opindex fdump-tree-pre
6411 Dump trees after partial redundancy elimination.  The file name is made
6412 by appending @file{.pre} to the source file name.
6414 @item fre
6415 @opindex fdump-tree-fre
6416 Dump trees after full redundancy elimination.  The file name is made
6417 by appending @file{.fre} to the source file name.
6419 @item copyprop
6420 @opindex fdump-tree-copyprop
6421 Dump trees after copy propagation.  The file name is made
6422 by appending @file{.copyprop} to the source file name.
6424 @item store_copyprop
6425 @opindex fdump-tree-store_copyprop
6426 Dump trees after store copy-propagation.  The file name is made
6427 by appending @file{.store_copyprop} to the source file name.
6429 @item dce
6430 @opindex fdump-tree-dce
6431 Dump each function after dead code elimination.  The file name is made by
6432 appending @file{.dce} to the source file name.
6434 @item sra
6435 @opindex fdump-tree-sra
6436 Dump each function after performing scalar replacement of aggregates.  The
6437 file name is made by appending @file{.sra} to the source file name.
6439 @item sink
6440 @opindex fdump-tree-sink
6441 Dump each function after performing code sinking.  The file name is made
6442 by appending @file{.sink} to the source file name.
6444 @item dom
6445 @opindex fdump-tree-dom
6446 Dump each function after applying dominator tree optimizations.  The file
6447 name is made by appending @file{.dom} to the source file name.
6449 @item dse
6450 @opindex fdump-tree-dse
6451 Dump each function after applying dead store elimination.  The file
6452 name is made by appending @file{.dse} to the source file name.
6454 @item phiopt
6455 @opindex fdump-tree-phiopt
6456 Dump each function after optimizing PHI nodes into straightline code.  The file
6457 name is made by appending @file{.phiopt} to the source file name.
6459 @item forwprop
6460 @opindex fdump-tree-forwprop
6461 Dump each function after forward propagating single use variables.  The file
6462 name is made by appending @file{.forwprop} to the source file name.
6464 @item copyrename
6465 @opindex fdump-tree-copyrename
6466 Dump each function after applying the copy rename optimization.  The file
6467 name is made by appending @file{.copyrename} to the source file name.
6469 @item nrv
6470 @opindex fdump-tree-nrv
6471 Dump each function after applying the named return value optimization on
6472 generic trees.  The file name is made by appending @file{.nrv} to the source
6473 file name.
6475 @item vect
6476 @opindex fdump-tree-vect
6477 Dump each function after applying vectorization of loops.  The file name is
6478 made by appending @file{.vect} to the source file name.
6480 @item slp
6481 @opindex fdump-tree-slp
6482 Dump each function after applying vectorization of basic blocks.  The file name
6483 is made by appending @file{.slp} to the source file name.
6485 @item vrp
6486 @opindex fdump-tree-vrp
6487 Dump each function after Value Range Propagation (VRP).  The file name
6488 is made by appending @file{.vrp} to the source file name.
6490 @item all
6491 @opindex fdump-tree-all
6492 Enable all the available tree dumps with the flags provided in this option.
6493 @end table
6495 @item -fopt-info
6496 @itemx -fopt-info-@var{options}
6497 @itemx -fopt-info-@var{options}=@var{filename}
6498 @opindex fopt-info
6499 Controls optimization dumps from various optimization passes. If the
6500 @samp{-@var{options}} form is used, @var{options} is a list of
6501 @samp{-} separated options to select the dump details and
6502 optimizations.  If @var{options} is not specified, it defaults to
6503 @option{optimized} for details and @option{optall} for optimization
6504 groups. If the @var{filename} is not specified, it defaults to
6505 @file{stderr}. Note that the output @var{filename} will be overwritten
6506 in case of multiple translation units. If a combined output from
6507 multiple translation units is desired, @file{stderr} should be used
6508 instead.
6510 The options can be divided into two groups, 1) options describing the
6511 verbosity of the dump, and 2) options describing which optimizations
6512 should be included. The options from both the groups can be freely
6513 mixed as they are non-overlapping. However, in case of any conflicts,
6514 the latter options override the earlier options on the command
6515 line. Though multiple -fopt-info options are accepted, only one of
6516 them can have @option{=filename}. If other filenames are provided then
6517 all but the first one are ignored.
6519 The dump verbosity has the following options
6521 @table @samp
6522 @item optimized
6523 Print information when an optimization is successfully applied. It is
6524 up to a pass to decide which information is relevant. For example, the
6525 vectorizer passes print the source location of loops which got
6526 successfully vectorized.
6527 @item missed
6528 Print information about missed optimizations. Individual passes
6529 control which information to include in the output. For example,
6531 @smallexample
6532 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6533 @end smallexample
6535 will print information about missed optimization opportunities from
6536 vectorization passes on stderr.
6537 @item note
6538 Print verbose information about optimizations, such as certain
6539 transformations, more detailed messages about decisions etc.
6540 @item all
6541 Print detailed optimization information. This includes
6542 @var{optimized}, @var{missed}, and @var{note}.
6543 @end table
6545 The second set of options describes a group of optimizations and may
6546 include one or more of the following.
6548 @table @samp
6549 @item ipa
6550 Enable dumps from all interprocedural optimizations.
6551 @item loop
6552 Enable dumps from all loop optimizations.
6553 @item inline
6554 Enable dumps from all inlining optimizations.
6555 @item vec
6556 Enable dumps from all vectorization optimizations.
6557 @item optall
6558 Enable dumps from all optimizations. This is a superset of
6559 the optimization groups listed above.
6560 @end table
6562 For example,
6563 @smallexample
6564 gcc -O3 -fopt-info-missed=missed.all
6565 @end smallexample
6567 outputs missed optimization report from all the passes into
6568 @file{missed.all}.
6570 As another example,
6571 @smallexample
6572 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6573 @end smallexample
6575 will output information about missed optimizations as well as
6576 optimized locations from all the inlining passes into
6577 @file{inline.txt}.
6579 If the @var{filename} is provided, then the dumps from all the
6580 applicable optimizations are concatenated into the @file{filename}.
6581 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6582 omitted, it defaults to @option{all-optall}, which means dump all
6583 available optimization info from all the passes. In the following
6584 example, all optimization info is output on to @file{stderr}.
6586 @smallexample
6587 gcc -O3 -fopt-info
6588 @end smallexample
6590 Note that @option{-fopt-info-vec-missed} behaves the same as
6591 @option{-fopt-info-missed-vec}.
6593 As another example, consider
6595 @smallexample
6596 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6597 @end smallexample
6599 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6600 in conflict since only one output file is allowed. In this case, only
6601 the first option takes effect and the subsequent options are
6602 ignored. Thus only the @file{vec.miss} is produced which contains
6603 dumps from the vectorizer about missed opportunities.
6605 @item -frandom-seed=@var{string}
6606 @opindex frandom-seed
6607 This option provides a seed that GCC uses in place of
6608 random numbers in generating certain symbol names
6609 that have to be different in every compiled file.  It is also used to
6610 place unique stamps in coverage data files and the object files that
6611 produce them.  You can use the @option{-frandom-seed} option to produce
6612 reproducibly identical object files.
6614 The @var{string} should be different for every file you compile.
6616 @item -fsched-verbose=@var{n}
6617 @opindex fsched-verbose
6618 On targets that use instruction scheduling, this option controls the
6619 amount of debugging output the scheduler prints.  This information is
6620 written to standard error, unless @option{-fdump-rtl-sched1} or
6621 @option{-fdump-rtl-sched2} is specified, in which case it is output
6622 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6623 respectively.  However for @var{n} greater than nine, the output is
6624 always printed to standard error.
6626 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6627 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6628 For @var{n} greater than one, it also output basic block probabilities,
6629 detailed ready list information and unit/insn info.  For @var{n} greater
6630 than two, it includes RTL at abort point, control-flow and regions info.
6631 And for @var{n} over four, @option{-fsched-verbose} also includes
6632 dependence info.
6634 @item -save-temps
6635 @itemx -save-temps=cwd
6636 @opindex save-temps
6637 Store the usual ``temporary'' intermediate files permanently; place them
6638 in the current directory and name them based on the source file.  Thus,
6639 compiling @file{foo.c} with @option{-c -save-temps} produces files
6640 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6641 preprocessed @file{foo.i} output file even though the compiler now
6642 normally uses an integrated preprocessor.
6644 When used in combination with the @option{-x} command-line option,
6645 @option{-save-temps} is sensible enough to avoid over writing an
6646 input source file with the same extension as an intermediate file.
6647 The corresponding intermediate file may be obtained by renaming the
6648 source file before using @option{-save-temps}.
6650 If you invoke GCC in parallel, compiling several different source
6651 files that share a common base name in different subdirectories or the
6652 same source file compiled for multiple output destinations, it is
6653 likely that the different parallel compilers will interfere with each
6654 other, and overwrite the temporary files.  For instance:
6656 @smallexample
6657 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6658 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6659 @end smallexample
6661 may result in @file{foo.i} and @file{foo.o} being written to
6662 simultaneously by both compilers.
6664 @item -save-temps=obj
6665 @opindex save-temps=obj
6666 Store the usual ``temporary'' intermediate files permanently.  If the
6667 @option{-o} option is used, the temporary files are based on the
6668 object file.  If the @option{-o} option is not used, the
6669 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6671 For example:
6673 @smallexample
6674 gcc -save-temps=obj -c foo.c
6675 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6676 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6677 @end smallexample
6679 @noindent
6680 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6681 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6682 @file{dir2/yfoobar.o}.
6684 @item -time@r{[}=@var{file}@r{]}
6685 @opindex time
6686 Report the CPU time taken by each subprocess in the compilation
6687 sequence.  For C source files, this is the compiler proper and assembler
6688 (plus the linker if linking is done).
6690 Without the specification of an output file, the output looks like this:
6692 @smallexample
6693 # cc1 0.12 0.01
6694 # as 0.00 0.01
6695 @end smallexample
6697 The first number on each line is the ``user time'', that is time spent
6698 executing the program itself.  The second number is ``system time'',
6699 time spent executing operating system routines on behalf of the program.
6700 Both numbers are in seconds.
6702 With the specification of an output file, the output is appended to the
6703 named file, and it looks like this:
6705 @smallexample
6706 0.12 0.01 cc1 @var{options}
6707 0.00 0.01 as @var{options}
6708 @end smallexample
6710 The ``user time'' and the ``system time'' are moved before the program
6711 name, and the options passed to the program are displayed, so that one
6712 can later tell what file was being compiled, and with which options.
6714 @item -fvar-tracking
6715 @opindex fvar-tracking
6716 Run variable tracking pass.  It computes where variables are stored at each
6717 position in code.  Better debugging information is then generated
6718 (if the debugging information format supports this information).
6720 It is enabled by default when compiling with optimization (@option{-Os},
6721 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6722 the debug info format supports it.
6724 @item -fvar-tracking-assignments
6725 @opindex fvar-tracking-assignments
6726 @opindex fno-var-tracking-assignments
6727 Annotate assignments to user variables early in the compilation and
6728 attempt to carry the annotations over throughout the compilation all the
6729 way to the end, in an attempt to improve debug information while
6730 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6732 It can be enabled even if var-tracking is disabled, in which case
6733 annotations are created and maintained, but discarded at the end.
6735 @item -fvar-tracking-assignments-toggle
6736 @opindex fvar-tracking-assignments-toggle
6737 @opindex fno-var-tracking-assignments-toggle
6738 Toggle @option{-fvar-tracking-assignments}, in the same way that
6739 @option{-gtoggle} toggles @option{-g}.
6741 @item -print-file-name=@var{library}
6742 @opindex print-file-name
6743 Print the full absolute name of the library file @var{library} that
6744 would be used when linking---and don't do anything else.  With this
6745 option, GCC does not compile or link anything; it just prints the
6746 file name.
6748 @item -print-multi-directory
6749 @opindex print-multi-directory
6750 Print the directory name corresponding to the multilib selected by any
6751 other switches present in the command line.  This directory is supposed
6752 to exist in @env{GCC_EXEC_PREFIX}.
6754 @item -print-multi-lib
6755 @opindex print-multi-lib
6756 Print the mapping from multilib directory names to compiler switches
6757 that enable them.  The directory name is separated from the switches by
6758 @samp{;}, and each switch starts with an @samp{@@} instead of the
6759 @samp{-}, without spaces between multiple switches.  This is supposed to
6760 ease shell processing.
6762 @item -print-multi-os-directory
6763 @opindex print-multi-os-directory
6764 Print the path to OS libraries for the selected
6765 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6766 present in the @file{lib} subdirectory and no multilibs are used, this is
6767 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6768 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6769 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6770 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6772 @item -print-multiarch
6773 @opindex print-multiarch
6774 Print the path to OS libraries for the selected multiarch,
6775 relative to some @file{lib} subdirectory.
6777 @item -print-prog-name=@var{program}
6778 @opindex print-prog-name
6779 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6781 @item -print-libgcc-file-name
6782 @opindex print-libgcc-file-name
6783 Same as @option{-print-file-name=libgcc.a}.
6785 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6786 but you do want to link with @file{libgcc.a}.  You can do:
6788 @smallexample
6789 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6790 @end smallexample
6792 @item -print-search-dirs
6793 @opindex print-search-dirs
6794 Print the name of the configured installation directory and a list of
6795 program and library directories @command{gcc} searches---and don't do anything else.
6797 This is useful when @command{gcc} prints the error message
6798 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6799 To resolve this you either need to put @file{cpp0} and the other compiler
6800 components where @command{gcc} expects to find them, or you can set the environment
6801 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6802 Don't forget the trailing @samp{/}.
6803 @xref{Environment Variables}.
6805 @item -print-sysroot
6806 @opindex print-sysroot
6807 Print the target sysroot directory that is used during
6808 compilation.  This is the target sysroot specified either at configure
6809 time or using the @option{--sysroot} option, possibly with an extra
6810 suffix that depends on compilation options.  If no target sysroot is
6811 specified, the option prints nothing.
6813 @item -print-sysroot-headers-suffix
6814 @opindex print-sysroot-headers-suffix
6815 Print the suffix added to the target sysroot when searching for
6816 headers, or give an error if the compiler is not configured with such
6817 a suffix---and don't do anything else.
6819 @item -dumpmachine
6820 @opindex dumpmachine
6821 Print the compiler's target machine (for example,
6822 @samp{i686-pc-linux-gnu})---and don't do anything else.
6824 @item -dumpversion
6825 @opindex dumpversion
6826 Print the compiler version (for example, @samp{3.0})---and don't do
6827 anything else.
6829 @item -dumpspecs
6830 @opindex dumpspecs
6831 Print the compiler's built-in specs---and don't do anything else.  (This
6832 is used when GCC itself is being built.)  @xref{Spec Files}.
6834 @item -fno-eliminate-unused-debug-types
6835 @opindex feliminate-unused-debug-types
6836 @opindex fno-eliminate-unused-debug-types
6837 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6838 output for types that are nowhere used in the source file being compiled.
6839 Sometimes it is useful to have GCC emit debugging
6840 information for all types declared in a compilation
6841 unit, regardless of whether or not they are actually used
6842 in that compilation unit, for example 
6843 if, in the debugger, you want to cast a value to a type that is
6844 not actually used in your program (but is declared).  More often,
6845 however, this results in a significant amount of wasted space.
6846 @end table
6848 @node Optimize Options
6849 @section Options That Control Optimization
6850 @cindex optimize options
6851 @cindex options, optimization
6853 These options control various sorts of optimizations.
6855 Without any optimization option, the compiler's goal is to reduce the
6856 cost of compilation and to make debugging produce the expected
6857 results.  Statements are independent: if you stop the program with a
6858 breakpoint between statements, you can then assign a new value to any
6859 variable or change the program counter to any other statement in the
6860 function and get exactly the results you expect from the source
6861 code.
6863 Turning on optimization flags makes the compiler attempt to improve
6864 the performance and/or code size at the expense of compilation time
6865 and possibly the ability to debug the program.
6867 The compiler performs optimization based on the knowledge it has of the
6868 program.  Compiling multiple files at once to a single output file mode allows
6869 the compiler to use information gained from all of the files when compiling
6870 each of them.
6872 Not all optimizations are controlled directly by a flag.  Only
6873 optimizations that have a flag are listed in this section.
6875 Most optimizations are only enabled if an @option{-O} level is set on
6876 the command line.  Otherwise they are disabled, even if individual
6877 optimization flags are specified.
6879 Depending on the target and how GCC was configured, a slightly different
6880 set of optimizations may be enabled at each @option{-O} level than
6881 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6882 to find out the exact set of optimizations that are enabled at each level.
6883 @xref{Overall Options}, for examples.
6885 @table @gcctabopt
6886 @item -O
6887 @itemx -O1
6888 @opindex O
6889 @opindex O1
6890 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6891 more memory for a large function.
6893 With @option{-O}, the compiler tries to reduce code size and execution
6894 time, without performing any optimizations that take a great deal of
6895 compilation time.
6897 @option{-O} turns on the following optimization flags:
6898 @gccoptlist{
6899 -fauto-inc-dec @gol
6900 -fcompare-elim @gol
6901 -fcprop-registers @gol
6902 -fdce @gol
6903 -fdefer-pop @gol
6904 -fdelayed-branch @gol
6905 -fdse @gol
6906 -fguess-branch-probability @gol
6907 -fif-conversion2 @gol
6908 -fif-conversion @gol
6909 -fipa-pure-const @gol
6910 -fipa-profile @gol
6911 -fipa-reference @gol
6912 -fmerge-constants
6913 -fsplit-wide-types @gol
6914 -ftree-bit-ccp @gol
6915 -ftree-builtin-call-dce @gol
6916 -ftree-ccp @gol
6917 -fssa-phiopt @gol
6918 -ftree-ch @gol
6919 -ftree-copyrename @gol
6920 -ftree-dce @gol
6921 -ftree-dominator-opts @gol
6922 -ftree-dse @gol
6923 -ftree-forwprop @gol
6924 -ftree-fre @gol
6925 -ftree-phiprop @gol
6926 -ftree-slsr @gol
6927 -ftree-sra @gol
6928 -ftree-pta @gol
6929 -ftree-ter @gol
6930 -funit-at-a-time}
6932 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6933 where doing so does not interfere with debugging.
6935 @item -O2
6936 @opindex O2
6937 Optimize even more.  GCC performs nearly all supported optimizations
6938 that do not involve a space-speed tradeoff.
6939 As compared to @option{-O}, this option increases both compilation time
6940 and the performance of the generated code.
6942 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6943 also turns on the following optimization flags:
6944 @gccoptlist{-fthread-jumps @gol
6945 -falign-functions  -falign-jumps @gol
6946 -falign-loops  -falign-labels @gol
6947 -fcaller-saves @gol
6948 -fcrossjumping @gol
6949 -fcse-follow-jumps  -fcse-skip-blocks @gol
6950 -fdelete-null-pointer-checks @gol
6951 -fdevirtualize -fdevirtualize-speculatively @gol
6952 -fexpensive-optimizations @gol
6953 -fgcse  -fgcse-lm  @gol
6954 -fhoist-adjacent-loads @gol
6955 -finline-small-functions @gol
6956 -findirect-inlining @gol
6957 -fipa-sra @gol
6958 -fisolate-erroneous-paths-dereference @gol
6959 -foptimize-sibling-calls @gol
6960 -fpartial-inlining @gol
6961 -fpeephole2 @gol
6962 -freorder-blocks  -freorder-functions @gol
6963 -frerun-cse-after-loop  @gol
6964 -fsched-interblock  -fsched-spec @gol
6965 -fschedule-insns  -fschedule-insns2 @gol
6966 -fstrict-aliasing -fstrict-overflow @gol
6967 -ftree-switch-conversion -ftree-tail-merge @gol
6968 -ftree-pre @gol
6969 -ftree-vrp}
6971 Please note the warning under @option{-fgcse} about
6972 invoking @option{-O2} on programs that use computed gotos.
6974 @item -O3
6975 @opindex O3
6976 Optimize yet more.  @option{-O3} turns on all optimizations specified
6977 by @option{-O2} and also turns on the @option{-finline-functions},
6978 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6979 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
6980 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
6981 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6983 @item -O0
6984 @opindex O0
6985 Reduce compilation time and make debugging produce the expected
6986 results.  This is the default.
6988 @item -Os
6989 @opindex Os
6990 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6991 do not typically increase code size.  It also performs further
6992 optimizations designed to reduce code size.
6994 @option{-Os} disables the following optimization flags:
6995 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6996 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6997 -fprefetch-loop-arrays}
6999 @item -Ofast
7000 @opindex Ofast
7001 Disregard strict standards compliance.  @option{-Ofast} enables all
7002 @option{-O3} optimizations.  It also enables optimizations that are not
7003 valid for all standard-compliant programs.
7004 It turns on @option{-ffast-math} and the Fortran-specific
7005 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7007 @item -Og
7008 @opindex Og
7009 Optimize debugging experience.  @option{-Og} enables optimizations
7010 that do not interfere with debugging. It should be the optimization
7011 level of choice for the standard edit-compile-debug cycle, offering
7012 a reasonable level of optimization while maintaining fast compilation
7013 and a good debugging experience.
7015 If you use multiple @option{-O} options, with or without level numbers,
7016 the last such option is the one that is effective.
7017 @end table
7019 Options of the form @option{-f@var{flag}} specify machine-independent
7020 flags.  Most flags have both positive and negative forms; the negative
7021 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7022 below, only one of the forms is listed---the one you typically 
7023 use.  You can figure out the other form by either removing @samp{no-}
7024 or adding it.
7026 The following options control specific optimizations.  They are either
7027 activated by @option{-O} options or are related to ones that are.  You
7028 can use the following flags in the rare cases when ``fine-tuning'' of
7029 optimizations to be performed is desired.
7031 @table @gcctabopt
7032 @item -fno-defer-pop
7033 @opindex fno-defer-pop
7034 Always pop the arguments to each function call as soon as that function
7035 returns.  For machines that must pop arguments after a function call,
7036 the compiler normally lets arguments accumulate on the stack for several
7037 function calls and pops them all at once.
7039 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7041 @item -fforward-propagate
7042 @opindex fforward-propagate
7043 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7044 instructions and checks if the result can be simplified.  If loop unrolling
7045 is active, two passes are performed and the second is scheduled after
7046 loop unrolling.
7048 This option is enabled by default at optimization levels @option{-O},
7049 @option{-O2}, @option{-O3}, @option{-Os}.
7051 @item -ffp-contract=@var{style}
7052 @opindex ffp-contract
7053 @option{-ffp-contract=off} disables floating-point expression contraction.
7054 @option{-ffp-contract=fast} enables floating-point expression contraction
7055 such as forming of fused multiply-add operations if the target has
7056 native support for them.
7057 @option{-ffp-contract=on} enables floating-point expression contraction
7058 if allowed by the language standard.  This is currently not implemented
7059 and treated equal to @option{-ffp-contract=off}.
7061 The default is @option{-ffp-contract=fast}.
7063 @item -fomit-frame-pointer
7064 @opindex fomit-frame-pointer
7065 Don't keep the frame pointer in a register for functions that
7066 don't need one.  This avoids the instructions to save, set up and
7067 restore frame pointers; it also makes an extra register available
7068 in many functions.  @strong{It also makes debugging impossible on
7069 some machines.}
7071 On some machines, such as the VAX, this flag has no effect, because
7072 the standard calling sequence automatically handles the frame pointer
7073 and nothing is saved by pretending it doesn't exist.  The
7074 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7075 whether a target machine supports this flag.  @xref{Registers,,Register
7076 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7078 Starting with GCC version 4.6, the default setting (when not optimizing for
7079 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7080 @option{-fomit-frame-pointer}.  The default can be reverted to
7081 @option{-fno-omit-frame-pointer} by configuring GCC with the
7082 @option{--enable-frame-pointer} configure option.
7084 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7086 @item -foptimize-sibling-calls
7087 @opindex foptimize-sibling-calls
7088 Optimize sibling and tail recursive calls.
7090 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7092 @item -fno-inline
7093 @opindex fno-inline
7094 Do not expand any functions inline apart from those marked with
7095 the @code{always_inline} attribute.  This is the default when not
7096 optimizing.
7098 Single functions can be exempted from inlining by marking them
7099 with the @code{noinline} attribute.
7101 @item -finline-small-functions
7102 @opindex finline-small-functions
7103 Integrate functions into their callers when their body is smaller than expected
7104 function call code (so overall size of program gets smaller).  The compiler
7105 heuristically decides which functions are simple enough to be worth integrating
7106 in this way.  This inlining applies to all functions, even those not declared
7107 inline.
7109 Enabled at level @option{-O2}.
7111 @item -findirect-inlining
7112 @opindex findirect-inlining
7113 Inline also indirect calls that are discovered to be known at compile
7114 time thanks to previous inlining.  This option has any effect only
7115 when inlining itself is turned on by the @option{-finline-functions}
7116 or @option{-finline-small-functions} options.
7118 Enabled at level @option{-O2}.
7120 @item -finline-functions
7121 @opindex finline-functions
7122 Consider all functions for inlining, even if they are not declared inline.
7123 The compiler heuristically decides which functions are worth integrating
7124 in this way.
7126 If all calls to a given function are integrated, and the function is
7127 declared @code{static}, then the function is normally not output as
7128 assembler code in its own right.
7130 Enabled at level @option{-O3}.
7132 @item -finline-functions-called-once
7133 @opindex finline-functions-called-once
7134 Consider all @code{static} functions called once for inlining into their
7135 caller even if they are not marked @code{inline}.  If a call to a given
7136 function is integrated, then the function is not output as assembler code
7137 in its own right.
7139 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7141 @item -fearly-inlining
7142 @opindex fearly-inlining
7143 Inline functions marked by @code{always_inline} and functions whose body seems
7144 smaller than the function call overhead early before doing
7145 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7146 makes profiling significantly cheaper and usually inlining faster on programs
7147 having large chains of nested wrapper functions.
7149 Enabled by default.
7151 @item -fipa-sra
7152 @opindex fipa-sra
7153 Perform interprocedural scalar replacement of aggregates, removal of
7154 unused parameters and replacement of parameters passed by reference
7155 by parameters passed by value.
7157 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7159 @item -finline-limit=@var{n}
7160 @opindex finline-limit
7161 By default, GCC limits the size of functions that can be inlined.  This flag
7162 allows coarse control of this limit.  @var{n} is the size of functions that
7163 can be inlined in number of pseudo instructions.
7165 Inlining is actually controlled by a number of parameters, which may be
7166 specified individually by using @option{--param @var{name}=@var{value}}.
7167 The @option{-finline-limit=@var{n}} option sets some of these parameters
7168 as follows:
7170 @table @gcctabopt
7171 @item max-inline-insns-single
7172 is set to @var{n}/2.
7173 @item max-inline-insns-auto
7174 is set to @var{n}/2.
7175 @end table
7177 See below for a documentation of the individual
7178 parameters controlling inlining and for the defaults of these parameters.
7180 @emph{Note:} there may be no value to @option{-finline-limit} that results
7181 in default behavior.
7183 @emph{Note:} pseudo instruction represents, in this particular context, an
7184 abstract measurement of function's size.  In no way does it represent a count
7185 of assembly instructions and as such its exact meaning might change from one
7186 release to an another.
7188 @item -fno-keep-inline-dllexport
7189 @opindex -fno-keep-inline-dllexport
7190 This is a more fine-grained version of @option{-fkeep-inline-functions},
7191 which applies only to functions that are declared using the @code{dllexport}
7192 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7193 Functions}.)
7195 @item -fkeep-inline-functions
7196 @opindex fkeep-inline-functions
7197 In C, emit @code{static} functions that are declared @code{inline}
7198 into the object file, even if the function has been inlined into all
7199 of its callers.  This switch does not affect functions using the
7200 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7201 inline functions into the object file.
7203 @item -fkeep-static-consts
7204 @opindex fkeep-static-consts
7205 Emit variables declared @code{static const} when optimization isn't turned
7206 on, even if the variables aren't referenced.
7208 GCC enables this option by default.  If you want to force the compiler to
7209 check if a variable is referenced, regardless of whether or not
7210 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7212 @item -fmerge-constants
7213 @opindex fmerge-constants
7214 Attempt to merge identical constants (string constants and floating-point
7215 constants) across compilation units.
7217 This option is the default for optimized compilation if the assembler and
7218 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7219 behavior.
7221 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7223 @item -fmerge-all-constants
7224 @opindex fmerge-all-constants
7225 Attempt to merge identical constants and identical variables.
7227 This option implies @option{-fmerge-constants}.  In addition to
7228 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7229 arrays or initialized constant variables with integral or floating-point
7230 types.  Languages like C or C++ require each variable, including multiple
7231 instances of the same variable in recursive calls, to have distinct locations,
7232 so using this option results in non-conforming
7233 behavior.
7235 @item -fmodulo-sched
7236 @opindex fmodulo-sched
7237 Perform swing modulo scheduling immediately before the first scheduling
7238 pass.  This pass looks at innermost loops and reorders their
7239 instructions by overlapping different iterations.
7241 @item -fmodulo-sched-allow-regmoves
7242 @opindex fmodulo-sched-allow-regmoves
7243 Perform more aggressive SMS-based modulo scheduling with register moves
7244 allowed.  By setting this flag certain anti-dependences edges are
7245 deleted, which triggers the generation of reg-moves based on the
7246 life-range analysis.  This option is effective only with
7247 @option{-fmodulo-sched} enabled.
7249 @item -fno-branch-count-reg
7250 @opindex fno-branch-count-reg
7251 Do not use ``decrement and branch'' instructions on a count register,
7252 but instead generate a sequence of instructions that decrement a
7253 register, compare it against zero, then branch based upon the result.
7254 This option is only meaningful on architectures that support such
7255 instructions, which include x86, PowerPC, IA-64 and S/390.
7257 The default is @option{-fbranch-count-reg}.
7259 @item -fno-function-cse
7260 @opindex fno-function-cse
7261 Do not put function addresses in registers; make each instruction that
7262 calls a constant function contain the function's address explicitly.
7264 This option results in less efficient code, but some strange hacks
7265 that alter the assembler output may be confused by the optimizations
7266 performed when this option is not used.
7268 The default is @option{-ffunction-cse}
7270 @item -fno-zero-initialized-in-bss
7271 @opindex fno-zero-initialized-in-bss
7272 If the target supports a BSS section, GCC by default puts variables that
7273 are initialized to zero into BSS@.  This can save space in the resulting
7274 code.
7276 This option turns off this behavior because some programs explicitly
7277 rely on variables going to the data section---e.g., so that the
7278 resulting executable can find the beginning of that section and/or make
7279 assumptions based on that.
7281 The default is @option{-fzero-initialized-in-bss}.
7283 @item -fthread-jumps
7284 @opindex fthread-jumps
7285 Perform optimizations that check to see if a jump branches to a
7286 location where another comparison subsumed by the first is found.  If
7287 so, the first branch is redirected to either the destination of the
7288 second branch or a point immediately following it, depending on whether
7289 the condition is known to be true or false.
7291 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7293 @item -fsplit-wide-types
7294 @opindex fsplit-wide-types
7295 When using a type that occupies multiple registers, such as @code{long
7296 long} on a 32-bit system, split the registers apart and allocate them
7297 independently.  This normally generates better code for those types,
7298 but may make debugging more difficult.
7300 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7301 @option{-Os}.
7303 @item -fcse-follow-jumps
7304 @opindex fcse-follow-jumps
7305 In common subexpression elimination (CSE), scan through jump instructions
7306 when the target of the jump is not reached by any other path.  For
7307 example, when CSE encounters an @code{if} statement with an
7308 @code{else} clause, CSE follows the jump when the condition
7309 tested is false.
7311 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7313 @item -fcse-skip-blocks
7314 @opindex fcse-skip-blocks
7315 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7316 follow jumps that conditionally skip over blocks.  When CSE
7317 encounters a simple @code{if} statement with no else clause,
7318 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7319 body of the @code{if}.
7321 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7323 @item -frerun-cse-after-loop
7324 @opindex frerun-cse-after-loop
7325 Re-run common subexpression elimination after loop optimizations are
7326 performed.
7328 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7330 @item -fgcse
7331 @opindex fgcse
7332 Perform a global common subexpression elimination pass.
7333 This pass also performs global constant and copy propagation.
7335 @emph{Note:} When compiling a program using computed gotos, a GCC
7336 extension, you may get better run-time performance if you disable
7337 the global common subexpression elimination pass by adding
7338 @option{-fno-gcse} to the command line.
7340 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7342 @item -fgcse-lm
7343 @opindex fgcse-lm
7344 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7345 attempts to move loads that are only killed by stores into themselves.  This
7346 allows a loop containing a load/store sequence to be changed to a load outside
7347 the loop, and a copy/store within the loop.
7349 Enabled by default when @option{-fgcse} is enabled.
7351 @item -fgcse-sm
7352 @opindex fgcse-sm
7353 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7354 global common subexpression elimination.  This pass attempts to move
7355 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7356 loops containing a load/store sequence can be changed to a load before
7357 the loop and a store after the loop.
7359 Not enabled at any optimization level.
7361 @item -fgcse-las
7362 @opindex fgcse-las
7363 When @option{-fgcse-las} is enabled, the global common subexpression
7364 elimination pass eliminates redundant loads that come after stores to the
7365 same memory location (both partial and full redundancies).
7367 Not enabled at any optimization level.
7369 @item -fgcse-after-reload
7370 @opindex fgcse-after-reload
7371 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7372 pass is performed after reload.  The purpose of this pass is to clean up
7373 redundant spilling.
7375 @item -faggressive-loop-optimizations
7376 @opindex faggressive-loop-optimizations
7377 This option tells the loop optimizer to use language constraints to
7378 derive bounds for the number of iterations of a loop.  This assumes that
7379 loop code does not invoke undefined behavior by for example causing signed
7380 integer overflows or out-of-bound array accesses.  The bounds for the
7381 number of iterations of a loop are used to guide loop unrolling and peeling
7382 and loop exit test optimizations.
7383 This option is enabled by default.
7385 @item -funsafe-loop-optimizations
7386 @opindex funsafe-loop-optimizations
7387 This option tells the loop optimizer to assume that loop indices do not
7388 overflow, and that loops with nontrivial exit condition are not
7389 infinite.  This enables a wider range of loop optimizations even if
7390 the loop optimizer itself cannot prove that these assumptions are valid.
7391 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7392 if it finds this kind of loop.
7394 @item -fcrossjumping
7395 @opindex fcrossjumping
7396 Perform cross-jumping transformation.
7397 This transformation unifies equivalent code and saves code size.  The
7398 resulting code may or may not perform better than without cross-jumping.
7400 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7402 @item -fauto-inc-dec
7403 @opindex fauto-inc-dec
7404 Combine increments or decrements of addresses with memory accesses.
7405 This pass is always skipped on architectures that do not have
7406 instructions to support this.  Enabled by default at @option{-O} and
7407 higher on architectures that support this.
7409 @item -fdce
7410 @opindex fdce
7411 Perform dead code elimination (DCE) on RTL@.
7412 Enabled by default at @option{-O} and higher.
7414 @item -fdse
7415 @opindex fdse
7416 Perform dead store elimination (DSE) on RTL@.
7417 Enabled by default at @option{-O} and higher.
7419 @item -fif-conversion
7420 @opindex fif-conversion
7421 Attempt to transform conditional jumps into branch-less equivalents.  This
7422 includes use of conditional moves, min, max, set flags and abs instructions, and
7423 some tricks doable by standard arithmetics.  The use of conditional execution
7424 on chips where it is available is controlled by @code{if-conversion2}.
7426 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7428 @item -fif-conversion2
7429 @opindex fif-conversion2
7430 Use conditional execution (where available) to transform conditional jumps into
7431 branch-less equivalents.
7433 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7435 @item -fdeclone-ctor-dtor
7436 @opindex fdeclone-ctor-dtor
7437 The C++ ABI requires multiple entry points for constructors and
7438 destructors: one for a base subobject, one for a complete object, and
7439 one for a virtual destructor that calls operator delete afterwards.
7440 For a hierarchy with virtual bases, the base and complete variants are
7441 clones, which means two copies of the function.  With this option, the
7442 base and complete variants are changed to be thunks that call a common
7443 implementation.
7445 Enabled by @option{-Os}.
7447 @item -fdelete-null-pointer-checks
7448 @opindex fdelete-null-pointer-checks
7449 Assume that programs cannot safely dereference null pointers, and that
7450 no code or data element resides there.  This enables simple constant
7451 folding optimizations at all optimization levels.  In addition, other
7452 optimization passes in GCC use this flag to control global dataflow
7453 analyses that eliminate useless checks for null pointers; these assume
7454 that if a pointer is checked after it has already been dereferenced,
7455 it cannot be null.
7457 Note however that in some environments this assumption is not true.
7458 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7459 for programs that depend on that behavior.
7461 Some targets, especially embedded ones, disable this option at all levels.
7462 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7463 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7464 are enabled independently at different optimization levels.
7466 @item -fdevirtualize
7467 @opindex fdevirtualize
7468 Attempt to convert calls to virtual functions to direct calls.  This
7469 is done both within a procedure and interprocedurally as part of
7470 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7471 propagation (@option{-fipa-cp}).
7472 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7474 @item -fdevirtualize-speculatively
7475 @opindex fdevirtualize-speculatively
7476 Attempt to convert calls to virtual functions to speculative direct calls.
7477 Based on the analysis of the type inheritance graph, determine for a given call
7478 the set of likely targets. If the set is small, preferably of size 1, change
7479 the call into an conditional deciding on direct and indirect call.  The
7480 speculative calls enable more optimizations, such as inlining.  When they seem
7481 useless after further optimization, they are converted back into original form.
7483 @item -fexpensive-optimizations
7484 @opindex fexpensive-optimizations
7485 Perform a number of minor optimizations that are relatively expensive.
7487 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7489 @item -free
7490 @opindex free
7491 Attempt to remove redundant extension instructions.  This is especially
7492 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7493 registers after writing to their lower 32-bit half.
7495 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7496 @option{-O3}, @option{-Os}.
7498 @item -flive-range-shrinkage
7499 @opindex flive-range-shrinkage
7500 Attempt to decrease register pressure through register live range
7501 shrinkage.  This is helpful for fast processors with small or moderate
7502 size register sets.
7504 @item -fira-algorithm=@var{algorithm}
7505 Use the specified coloring algorithm for the integrated register
7506 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7507 specifies Chow's priority coloring, or @samp{CB}, which specifies
7508 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7509 for all architectures, but for those targets that do support it, it is
7510 the default because it generates better code.
7512 @item -fira-region=@var{region}
7513 Use specified regions for the integrated register allocator.  The
7514 @var{region} argument should be one of the following:
7516 @table @samp
7518 @item all
7519 Use all loops as register allocation regions.
7520 This can give the best results for machines with a small and/or
7521 irregular register set.
7523 @item mixed
7524 Use all loops except for loops with small register pressure 
7525 as the regions.  This value usually gives
7526 the best results in most cases and for most architectures,
7527 and is enabled by default when compiling with optimization for speed
7528 (@option{-O}, @option{-O2}, @dots{}).
7530 @item one
7531 Use all functions as a single region.  
7532 This typically results in the smallest code size, and is enabled by default for
7533 @option{-Os} or @option{-O0}.
7535 @end table
7537 @item -fira-hoist-pressure
7538 @opindex fira-hoist-pressure
7539 Use IRA to evaluate register pressure in the code hoisting pass for
7540 decisions to hoist expressions.  This option usually results in smaller
7541 code, but it can slow the compiler down.
7543 This option is enabled at level @option{-Os} for all targets.
7545 @item -fira-loop-pressure
7546 @opindex fira-loop-pressure
7547 Use IRA to evaluate register pressure in loops for decisions to move
7548 loop invariants.  This option usually results in generation
7549 of faster and smaller code on machines with large register files (>= 32
7550 registers), but it can slow the compiler down.
7552 This option is enabled at level @option{-O3} for some targets.
7554 @item -fno-ira-share-save-slots
7555 @opindex fno-ira-share-save-slots
7556 Disable sharing of stack slots used for saving call-used hard
7557 registers living through a call.  Each hard register gets a
7558 separate stack slot, and as a result function stack frames are
7559 larger.
7561 @item -fno-ira-share-spill-slots
7562 @opindex fno-ira-share-spill-slots
7563 Disable sharing of stack slots allocated for pseudo-registers.  Each
7564 pseudo-register that does not get a hard register gets a separate
7565 stack slot, and as a result function stack frames are larger.
7567 @item -fira-verbose=@var{n}
7568 @opindex fira-verbose
7569 Control the verbosity of the dump file for the integrated register allocator.
7570 The default value is 5.  If the value @var{n} is greater or equal to 10,
7571 the dump output is sent to stderr using the same format as @var{n} minus 10.
7573 @item -fdelayed-branch
7574 @opindex fdelayed-branch
7575 If supported for the target machine, attempt to reorder instructions
7576 to exploit instruction slots available after delayed branch
7577 instructions.
7579 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7581 @item -fschedule-insns
7582 @opindex fschedule-insns
7583 If supported for the target machine, attempt to reorder instructions to
7584 eliminate execution stalls due to required data being unavailable.  This
7585 helps machines that have slow floating point or memory load instructions
7586 by allowing other instructions to be issued until the result of the load
7587 or floating-point instruction is required.
7589 Enabled at levels @option{-O2}, @option{-O3}.
7591 @item -fschedule-insns2
7592 @opindex fschedule-insns2
7593 Similar to @option{-fschedule-insns}, but requests an additional pass of
7594 instruction scheduling after register allocation has been done.  This is
7595 especially useful on machines with a relatively small number of
7596 registers and where memory load instructions take more than one cycle.
7598 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7600 @item -fno-sched-interblock
7601 @opindex fno-sched-interblock
7602 Don't schedule instructions across basic blocks.  This is normally
7603 enabled by default when scheduling before register allocation, i.e.@:
7604 with @option{-fschedule-insns} or at @option{-O2} or higher.
7606 @item -fno-sched-spec
7607 @opindex fno-sched-spec
7608 Don't allow speculative motion of non-load instructions.  This is normally
7609 enabled by default when scheduling before register allocation, i.e.@:
7610 with @option{-fschedule-insns} or at @option{-O2} or higher.
7612 @item -fsched-pressure
7613 @opindex fsched-pressure
7614 Enable register pressure sensitive insn scheduling before register
7615 allocation.  This only makes sense when scheduling before register
7616 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7617 @option{-O2} or higher.  Usage of this option can improve the
7618 generated code and decrease its size by preventing register pressure
7619 increase above the number of available hard registers and subsequent
7620 spills in register allocation.
7622 @item -fsched-spec-load
7623 @opindex fsched-spec-load
7624 Allow speculative motion of some load instructions.  This only makes
7625 sense when scheduling before register allocation, i.e.@: with
7626 @option{-fschedule-insns} or at @option{-O2} or higher.
7628 @item -fsched-spec-load-dangerous
7629 @opindex fsched-spec-load-dangerous
7630 Allow speculative motion of more load instructions.  This only makes
7631 sense when scheduling before register allocation, i.e.@: with
7632 @option{-fschedule-insns} or at @option{-O2} or higher.
7634 @item -fsched-stalled-insns
7635 @itemx -fsched-stalled-insns=@var{n}
7636 @opindex fsched-stalled-insns
7637 Define how many insns (if any) can be moved prematurely from the queue
7638 of stalled insns into the ready list during the second scheduling pass.
7639 @option{-fno-sched-stalled-insns} means that no insns are moved
7640 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7641 on how many queued insns can be moved prematurely.
7642 @option{-fsched-stalled-insns} without a value is equivalent to
7643 @option{-fsched-stalled-insns=1}.
7645 @item -fsched-stalled-insns-dep
7646 @itemx -fsched-stalled-insns-dep=@var{n}
7647 @opindex fsched-stalled-insns-dep
7648 Define how many insn groups (cycles) are examined for a dependency
7649 on a stalled insn that is a candidate for premature removal from the queue
7650 of stalled insns.  This has an effect only during the second scheduling pass,
7651 and only if @option{-fsched-stalled-insns} is used.
7652 @option{-fno-sched-stalled-insns-dep} is equivalent to
7653 @option{-fsched-stalled-insns-dep=0}.
7654 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7655 @option{-fsched-stalled-insns-dep=1}.
7657 @item -fsched2-use-superblocks
7658 @opindex fsched2-use-superblocks
7659 When scheduling after register allocation, use superblock scheduling.
7660 This allows motion across basic block boundaries,
7661 resulting in faster schedules.  This option is experimental, as not all machine
7662 descriptions used by GCC model the CPU closely enough to avoid unreliable
7663 results from the algorithm.
7665 This only makes sense when scheduling after register allocation, i.e.@: with
7666 @option{-fschedule-insns2} or at @option{-O2} or higher.
7668 @item -fsched-group-heuristic
7669 @opindex fsched-group-heuristic
7670 Enable the group heuristic in the scheduler.  This heuristic favors
7671 the instruction that belongs to a schedule group.  This is enabled
7672 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7673 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7675 @item -fsched-critical-path-heuristic
7676 @opindex fsched-critical-path-heuristic
7677 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7678 instructions on the critical path.  This is enabled by default when
7679 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7680 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7682 @item -fsched-spec-insn-heuristic
7683 @opindex fsched-spec-insn-heuristic
7684 Enable the speculative instruction heuristic in the scheduler.  This
7685 heuristic favors speculative instructions with greater dependency weakness.
7686 This is enabled by default when scheduling is enabled, i.e.@:
7687 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7688 or at @option{-O2} or higher.
7690 @item -fsched-rank-heuristic
7691 @opindex fsched-rank-heuristic
7692 Enable the rank heuristic in the scheduler.  This heuristic favors
7693 the instruction belonging to a basic block with greater size or frequency.
7694 This is enabled by default when scheduling is enabled, i.e.@:
7695 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7696 at @option{-O2} or higher.
7698 @item -fsched-last-insn-heuristic
7699 @opindex fsched-last-insn-heuristic
7700 Enable the last-instruction heuristic in the scheduler.  This heuristic
7701 favors the instruction that is less dependent on the last instruction
7702 scheduled.  This is enabled by default when scheduling is enabled,
7703 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7704 at @option{-O2} or higher.
7706 @item -fsched-dep-count-heuristic
7707 @opindex fsched-dep-count-heuristic
7708 Enable the dependent-count heuristic in the scheduler.  This heuristic
7709 favors the instruction that has more instructions depending on it.
7710 This is enabled by default when scheduling is enabled, i.e.@:
7711 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7712 at @option{-O2} or higher.
7714 @item -freschedule-modulo-scheduled-loops
7715 @opindex freschedule-modulo-scheduled-loops
7716 Modulo scheduling is performed before traditional scheduling.  If a loop
7717 is modulo scheduled, later scheduling passes may change its schedule.  
7718 Use this option to control that behavior.
7720 @item -fselective-scheduling
7721 @opindex fselective-scheduling
7722 Schedule instructions using selective scheduling algorithm.  Selective
7723 scheduling runs instead of the first scheduler pass.
7725 @item -fselective-scheduling2
7726 @opindex fselective-scheduling2
7727 Schedule instructions using selective scheduling algorithm.  Selective
7728 scheduling runs instead of the second scheduler pass.
7730 @item -fsel-sched-pipelining
7731 @opindex fsel-sched-pipelining
7732 Enable software pipelining of innermost loops during selective scheduling.
7733 This option has no effect unless one of @option{-fselective-scheduling} or
7734 @option{-fselective-scheduling2} is turned on.
7736 @item -fsel-sched-pipelining-outer-loops
7737 @opindex fsel-sched-pipelining-outer-loops
7738 When pipelining loops during selective scheduling, also pipeline outer loops.
7739 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7741 @item -fshrink-wrap
7742 @opindex fshrink-wrap
7743 Emit function prologues only before parts of the function that need it,
7744 rather than at the top of the function.  This flag is enabled by default at
7745 @option{-O} and higher.
7747 @item -fcaller-saves
7748 @opindex fcaller-saves
7749 Enable allocation of values to registers that are clobbered by
7750 function calls, by emitting extra instructions to save and restore the
7751 registers around such calls.  Such allocation is done only when it
7752 seems to result in better code.
7754 This option is always enabled by default on certain machines, usually
7755 those which have no call-preserved registers to use instead.
7757 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7759 @item -fcombine-stack-adjustments
7760 @opindex fcombine-stack-adjustments
7761 Tracks stack adjustments (pushes and pops) and stack memory references
7762 and then tries to find ways to combine them.
7764 Enabled by default at @option{-O1} and higher.
7766 @item -fuse-caller-save
7767 Use caller save registers for allocation if those registers are not used by
7768 any called function.  In that case it is not necessary to save and restore
7769 them around calls.  This is only possible if called functions are part of
7770 same compilation unit as current function and they are compiled before it.
7772 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7774 @item -fconserve-stack
7775 @opindex fconserve-stack
7776 Attempt to minimize stack usage.  The compiler attempts to use less
7777 stack space, even if that makes the program slower.  This option
7778 implies setting the @option{large-stack-frame} parameter to 100
7779 and the @option{large-stack-frame-growth} parameter to 400.
7781 @item -ftree-reassoc
7782 @opindex ftree-reassoc
7783 Perform reassociation on trees.  This flag is enabled by default
7784 at @option{-O} and higher.
7786 @item -ftree-pre
7787 @opindex ftree-pre
7788 Perform partial redundancy elimination (PRE) on trees.  This flag is
7789 enabled by default at @option{-O2} and @option{-O3}.
7791 @item -ftree-partial-pre
7792 @opindex ftree-partial-pre
7793 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7794 enabled by default at @option{-O3}.
7796 @item -ftree-forwprop
7797 @opindex ftree-forwprop
7798 Perform forward propagation on trees.  This flag is enabled by default
7799 at @option{-O} and higher.
7801 @item -ftree-fre
7802 @opindex ftree-fre
7803 Perform full redundancy elimination (FRE) on trees.  The difference
7804 between FRE and PRE is that FRE only considers expressions
7805 that are computed on all paths leading to the redundant computation.
7806 This analysis is faster than PRE, though it exposes fewer redundancies.
7807 This flag is enabled by default at @option{-O} and higher.
7809 @item -ftree-phiprop
7810 @opindex ftree-phiprop
7811 Perform hoisting of loads from conditional pointers on trees.  This
7812 pass is enabled by default at @option{-O} and higher.
7814 @item -fhoist-adjacent-loads
7815 @opindex hoist-adjacent-loads
7816 Speculatively hoist loads from both branches of an if-then-else if the
7817 loads are from adjacent locations in the same structure and the target
7818 architecture has a conditional move instruction.  This flag is enabled
7819 by default at @option{-O2} and higher.
7821 @item -ftree-copy-prop
7822 @opindex ftree-copy-prop
7823 Perform copy propagation on trees.  This pass eliminates unnecessary
7824 copy operations.  This flag is enabled by default at @option{-O} and
7825 higher.
7827 @item -fipa-pure-const
7828 @opindex fipa-pure-const
7829 Discover which functions are pure or constant.
7830 Enabled by default at @option{-O} and higher.
7832 @item -fipa-reference
7833 @opindex fipa-reference
7834 Discover which static variables do not escape the
7835 compilation unit.
7836 Enabled by default at @option{-O} and higher.
7838 @item -fipa-pta
7839 @opindex fipa-pta
7840 Perform interprocedural pointer analysis and interprocedural modification
7841 and reference analysis.  This option can cause excessive memory and
7842 compile-time usage on large compilation units.  It is not enabled by
7843 default at any optimization level.
7845 @item -fipa-profile
7846 @opindex fipa-profile
7847 Perform interprocedural profile propagation.  The functions called only from
7848 cold functions are marked as cold. Also functions executed once (such as
7849 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7850 functions and loop less parts of functions executed once are then optimized for
7851 size.
7852 Enabled by default at @option{-O} and higher.
7854 @item -fipa-cp
7855 @opindex fipa-cp
7856 Perform interprocedural constant propagation.
7857 This optimization analyzes the program to determine when values passed
7858 to functions are constants and then optimizes accordingly.
7859 This optimization can substantially increase performance
7860 if the application has constants passed to functions.
7861 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7863 @item -fipa-cp-clone
7864 @opindex fipa-cp-clone
7865 Perform function cloning to make interprocedural constant propagation stronger.
7866 When enabled, interprocedural constant propagation performs function cloning
7867 when externally visible function can be called with constant arguments.
7868 Because this optimization can create multiple copies of functions,
7869 it may significantly increase code size
7870 (see @option{--param ipcp-unit-growth=@var{value}}).
7871 This flag is enabled by default at @option{-O3}.
7873 @item -fisolate-erroneous-paths-dereference
7874 Detect paths which trigger erroneous or undefined behaviour due to
7875 dereferencing a NULL pointer.  Isolate those paths from the main control
7876 flow and turn the statement with erroneous or undefined behaviour into a trap.
7878 @item -fisolate-erroneous-paths-attribute
7879 Detect paths which trigger erroneous or undefined behaviour due a NULL value
7880 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
7881 attribute.  Isolate those paths from the main control flow and turn the
7882 statement with erroneous or undefined behaviour into a trap.  This is not
7883 currently enabled, but may be enabled by @code{-O2} in the future.
7885 @item -ftree-sink
7886 @opindex ftree-sink
7887 Perform forward store motion  on trees.  This flag is
7888 enabled by default at @option{-O} and higher.
7890 @item -ftree-bit-ccp
7891 @opindex ftree-bit-ccp
7892 Perform sparse conditional bit constant propagation on trees and propagate
7893 pointer alignment information.
7894 This pass only operates on local scalar variables and is enabled by default
7895 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7897 @item -ftree-ccp
7898 @opindex ftree-ccp
7899 Perform sparse conditional constant propagation (CCP) on trees.  This
7900 pass only operates on local scalar variables and is enabled by default
7901 at @option{-O} and higher.
7903 @item -fssa-phiopt
7904 @opindex fssa-phiopt
7905 Perform pattern matching on SSA PHI nodes to optimize conditional
7906 code.  This pass is enabled by default at @option{-O} and higher.
7908 @item -ftree-switch-conversion
7909 Perform conversion of simple initializations in a switch to
7910 initializations from a scalar array.  This flag is enabled by default
7911 at @option{-O2} and higher.
7913 @item -ftree-tail-merge
7914 Look for identical code sequences.  When found, replace one with a jump to the
7915 other.  This optimization is known as tail merging or cross jumping.  This flag
7916 is enabled by default at @option{-O2} and higher.  The compilation time
7917 in this pass can
7918 be limited using @option{max-tail-merge-comparisons} parameter and
7919 @option{max-tail-merge-iterations} parameter.
7921 @item -ftree-dce
7922 @opindex ftree-dce
7923 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7924 default at @option{-O} and higher.
7926 @item -ftree-builtin-call-dce
7927 @opindex ftree-builtin-call-dce
7928 Perform conditional dead code elimination (DCE) for calls to built-in functions
7929 that may set @code{errno} but are otherwise side-effect free.  This flag is
7930 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7931 specified.
7933 @item -ftree-dominator-opts
7934 @opindex ftree-dominator-opts
7935 Perform a variety of simple scalar cleanups (constant/copy
7936 propagation, redundancy elimination, range propagation and expression
7937 simplification) based on a dominator tree traversal.  This also
7938 performs jump threading (to reduce jumps to jumps). This flag is
7939 enabled by default at @option{-O} and higher.
7941 @item -ftree-dse
7942 @opindex ftree-dse
7943 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7944 a memory location that is later overwritten by another store without
7945 any intervening loads.  In this case the earlier store can be deleted.  This
7946 flag is enabled by default at @option{-O} and higher.
7948 @item -ftree-ch
7949 @opindex ftree-ch
7950 Perform loop header copying on trees.  This is beneficial since it increases
7951 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7952 is enabled by default at @option{-O} and higher.  It is not enabled
7953 for @option{-Os}, since it usually increases code size.
7955 @item -ftree-loop-optimize
7956 @opindex ftree-loop-optimize
7957 Perform loop optimizations on trees.  This flag is enabled by default
7958 at @option{-O} and higher.
7960 @item -ftree-loop-linear
7961 @opindex ftree-loop-linear
7962 Perform loop interchange transformations on tree.  Same as
7963 @option{-floop-interchange}.  To use this code transformation, GCC has
7964 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7965 enable the Graphite loop transformation infrastructure.
7967 @item -floop-interchange
7968 @opindex floop-interchange
7969 Perform loop interchange transformations on loops.  Interchanging two
7970 nested loops switches the inner and outer loops.  For example, given a
7971 loop like:
7972 @smallexample
7973 DO J = 1, M
7974   DO I = 1, N
7975     A(J, I) = A(J, I) * C
7976   ENDDO
7977 ENDDO
7978 @end smallexample
7979 loop interchange transforms the loop as if it were written:
7980 @smallexample
7981 DO I = 1, N
7982   DO J = 1, M
7983     A(J, I) = A(J, I) * C
7984   ENDDO
7985 ENDDO
7986 @end smallexample
7987 which can be beneficial when @code{N} is larger than the caches,
7988 because in Fortran, the elements of an array are stored in memory
7989 contiguously by column, and the original loop iterates over rows,
7990 potentially creating at each access a cache miss.  This optimization
7991 applies to all the languages supported by GCC and is not limited to
7992 Fortran.  To use this code transformation, GCC has to be configured
7993 with @option{--with-ppl} and @option{--with-cloog} to enable the
7994 Graphite loop transformation infrastructure.
7996 @item -floop-strip-mine
7997 @opindex floop-strip-mine
7998 Perform loop strip mining transformations on loops.  Strip mining
7999 splits a loop into two nested loops.  The outer loop has strides
8000 equal to the strip size and the inner loop has strides of the
8001 original loop within a strip.  The strip length can be changed
8002 using the @option{loop-block-tile-size} parameter.  For example,
8003 given a loop like:
8004 @smallexample
8005 DO I = 1, N
8006   A(I) = A(I) + C
8007 ENDDO
8008 @end smallexample
8009 loop strip mining transforms the loop as if it were written:
8010 @smallexample
8011 DO II = 1, N, 51
8012   DO I = II, min (II + 50, N)
8013     A(I) = A(I) + C
8014   ENDDO
8015 ENDDO
8016 @end smallexample
8017 This optimization applies to all the languages supported by GCC and is
8018 not limited to Fortran.  To use this code transformation, GCC has to
8019 be configured with @option{--with-ppl} and @option{--with-cloog} to
8020 enable the Graphite loop transformation infrastructure.
8022 @item -floop-block
8023 @opindex floop-block
8024 Perform loop blocking transformations on loops.  Blocking strip mines
8025 each loop in the loop nest such that the memory accesses of the
8026 element loops fit inside caches.  The strip length can be changed
8027 using the @option{loop-block-tile-size} parameter.  For example, given
8028 a loop like:
8029 @smallexample
8030 DO I = 1, N
8031   DO J = 1, M
8032     A(J, I) = B(I) + C(J)
8033   ENDDO
8034 ENDDO
8035 @end smallexample
8036 loop blocking transforms the loop as if it were written:
8037 @smallexample
8038 DO II = 1, N, 51
8039   DO JJ = 1, M, 51
8040     DO I = II, min (II + 50, N)
8041       DO J = JJ, min (JJ + 50, M)
8042         A(J, I) = B(I) + C(J)
8043       ENDDO
8044     ENDDO
8045   ENDDO
8046 ENDDO
8047 @end smallexample
8048 which can be beneficial when @code{M} is larger than the caches,
8049 because the innermost loop iterates over a smaller amount of data
8050 which can be kept in the caches.  This optimization applies to all the
8051 languages supported by GCC and is not limited to Fortran.  To use this
8052 code transformation, GCC has to be configured with @option{--with-ppl}
8053 and @option{--with-cloog} to enable the Graphite loop transformation
8054 infrastructure.
8056 @item -fgraphite-identity
8057 @opindex fgraphite-identity
8058 Enable the identity transformation for graphite.  For every SCoP we generate
8059 the polyhedral representation and transform it back to gimple.  Using
8060 @option{-fgraphite-identity} we can check the costs or benefits of the
8061 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8062 are also performed by the code generator CLooG, like index splitting and
8063 dead code elimination in loops.
8065 @item -floop-nest-optimize
8066 @opindex floop-nest-optimize
8067 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8068 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8069 structure optimized for data-locality and parallelism.  This option
8070 is experimental.
8072 @item -floop-parallelize-all
8073 @opindex floop-parallelize-all
8074 Use the Graphite data dependence analysis to identify loops that can
8075 be parallelized.  Parallelize all the loops that can be analyzed to
8076 not contain loop carried dependences without checking that it is
8077 profitable to parallelize the loops.
8079 @item -fcheck-data-deps
8080 @opindex fcheck-data-deps
8081 Compare the results of several data dependence analyzers.  This option
8082 is used for debugging the data dependence analyzers.
8084 @item -ftree-loop-if-convert
8085 Attempt to transform conditional jumps in the innermost loops to
8086 branch-less equivalents.  The intent is to remove control-flow from
8087 the innermost loops in order to improve the ability of the
8088 vectorization pass to handle these loops.  This is enabled by default
8089 if vectorization is enabled.
8091 @item -ftree-loop-if-convert-stores
8092 Attempt to also if-convert conditional jumps containing memory writes.
8093 This transformation can be unsafe for multi-threaded programs as it
8094 transforms conditional memory writes into unconditional memory writes.
8095 For example,
8096 @smallexample
8097 for (i = 0; i < N; i++)
8098   if (cond)
8099     A[i] = expr;
8100 @end smallexample
8101 is transformed to
8102 @smallexample
8103 for (i = 0; i < N; i++)
8104   A[i] = cond ? expr : A[i];
8105 @end smallexample
8106 potentially producing data races.
8108 @item -ftree-loop-distribution
8109 Perform loop distribution.  This flag can improve cache performance on
8110 big loop bodies and allow further loop optimizations, like
8111 parallelization or vectorization, to take place.  For example, the loop
8112 @smallexample
8113 DO I = 1, N
8114   A(I) = B(I) + C
8115   D(I) = E(I) * F
8116 ENDDO
8117 @end smallexample
8118 is transformed to
8119 @smallexample
8120 DO I = 1, N
8121    A(I) = B(I) + C
8122 ENDDO
8123 DO I = 1, N
8124    D(I) = E(I) * F
8125 ENDDO
8126 @end smallexample
8128 @item -ftree-loop-distribute-patterns
8129 Perform loop distribution of patterns that can be code generated with
8130 calls to a library.  This flag is enabled by default at @option{-O3}.
8132 This pass distributes the initialization loops and generates a call to
8133 memset zero.  For example, the loop
8134 @smallexample
8135 DO I = 1, N
8136   A(I) = 0
8137   B(I) = A(I) + I
8138 ENDDO
8139 @end smallexample
8140 is transformed to
8141 @smallexample
8142 DO I = 1, N
8143    A(I) = 0
8144 ENDDO
8145 DO I = 1, N
8146    B(I) = A(I) + I
8147 ENDDO
8148 @end smallexample
8149 and the initialization loop is transformed into a call to memset zero.
8151 @item -ftree-loop-im
8152 @opindex ftree-loop-im
8153 Perform loop invariant motion on trees.  This pass moves only invariants that
8154 are hard to handle at RTL level (function calls, operations that expand to
8155 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8156 operands of conditions that are invariant out of the loop, so that we can use
8157 just trivial invariantness analysis in loop unswitching.  The pass also includes
8158 store motion.
8160 @item -ftree-loop-ivcanon
8161 @opindex ftree-loop-ivcanon
8162 Create a canonical counter for number of iterations in loops for which
8163 determining number of iterations requires complicated analysis.  Later
8164 optimizations then may determine the number easily.  Useful especially
8165 in connection with unrolling.
8167 @item -fivopts
8168 @opindex fivopts
8169 Perform induction variable optimizations (strength reduction, induction
8170 variable merging and induction variable elimination) on trees.
8172 @item -ftree-parallelize-loops=n
8173 @opindex ftree-parallelize-loops
8174 Parallelize loops, i.e., split their iteration space to run in n threads.
8175 This is only possible for loops whose iterations are independent
8176 and can be arbitrarily reordered.  The optimization is only
8177 profitable on multiprocessor machines, for loops that are CPU-intensive,
8178 rather than constrained e.g.@: by memory bandwidth.  This option
8179 implies @option{-pthread}, and thus is only supported on targets
8180 that have support for @option{-pthread}.
8182 @item -ftree-pta
8183 @opindex ftree-pta
8184 Perform function-local points-to analysis on trees.  This flag is
8185 enabled by default at @option{-O} and higher.
8187 @item -ftree-sra
8188 @opindex ftree-sra
8189 Perform scalar replacement of aggregates.  This pass replaces structure
8190 references with scalars to prevent committing structures to memory too
8191 early.  This flag is enabled by default at @option{-O} and higher.
8193 @item -ftree-copyrename
8194 @opindex ftree-copyrename
8195 Perform copy renaming on trees.  This pass attempts to rename compiler
8196 temporaries to other variables at copy locations, usually resulting in
8197 variable names which more closely resemble the original variables.  This flag
8198 is enabled by default at @option{-O} and higher.
8200 @item -ftree-coalesce-inlined-vars
8201 @opindex ftree-coalesce-inlined-vars
8202 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8203 combine small user-defined variables too, but only if they were inlined
8204 from other functions.  It is a more limited form of
8205 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8206 inlined variables, but it will keep variables of the inlined-into
8207 function apart from each other, such that they are more likely to
8208 contain the expected values in a debugging session.  This was the
8209 default in GCC versions older than 4.7.
8211 @item -ftree-coalesce-vars
8212 @opindex ftree-coalesce-vars
8213 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8214 combine small user-defined variables too, instead of just compiler
8215 temporaries.  This may severely limit the ability to debug an optimized
8216 program compiled with @option{-fno-var-tracking-assignments}.  In the
8217 negated form, this flag prevents SSA coalescing of user variables,
8218 including inlined ones.  This option is enabled by default.
8220 @item -ftree-ter
8221 @opindex ftree-ter
8222 Perform temporary expression replacement during the SSA->normal phase.  Single
8223 use/single def temporaries are replaced at their use location with their
8224 defining expression.  This results in non-GIMPLE code, but gives the expanders
8225 much more complex trees to work on resulting in better RTL generation.  This is
8226 enabled by default at @option{-O} and higher.
8228 @item -ftree-slsr
8229 @opindex ftree-slsr
8230 Perform straight-line strength reduction on trees.  This recognizes related
8231 expressions involving multiplications and replaces them by less expensive
8232 calculations when possible.  This is enabled by default at @option{-O} and
8233 higher.
8235 @item -ftree-vectorize
8236 @opindex ftree-vectorize
8237 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8238 and @option{-ftree-slp-vectorize} if not explicitly specified.
8240 @item -ftree-loop-vectorize
8241 @opindex ftree-loop-vectorize
8242 Perform loop vectorization on trees. This flag is enabled by default at
8243 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8245 @item -ftree-slp-vectorize
8246 @opindex ftree-slp-vectorize
8247 Perform basic block vectorization on trees. This flag is enabled by default at
8248 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8250 @item -fvect-cost-model=@var{model}
8251 @opindex fvect-cost-model
8252 Alter the cost model used for vectorization.  The @var{model} argument
8253 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8254 With the @code{unlimited} model the vectorized code-path is assumed
8255 to be profitable while with the @code{dynamic} model a runtime check
8256 will guard the vectorized code-path to enable it only for iteration
8257 counts that will likely execute faster than when executing the original
8258 scalar loop.  The @code{cheap} model will disable vectorization of
8259 loops where doing so would be cost prohibitive for example due to
8260 required runtime checks for data dependence or alignment but otherwise
8261 is equal to the @code{dynamic} model.
8262 The default cost model depends on other optimization flags and is
8263 either @code{dynamic} or @code{cheap}.
8265 @item -fsimd-cost-model=@var{model}
8266 @opindex fsimd-cost-model
8267 Alter the cost model used for vectorization of loops marked with the OpenMP
8268 or Cilk Plus simd directive.  The @var{model} argument should be one of
8269 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8270 have the same meaning as described in @option{-fvect-cost-model} and by
8271 default a cost model defined with @option{-fvect-cost-model} is used.
8273 @item -ftree-vrp
8274 @opindex ftree-vrp
8275 Perform Value Range Propagation on trees.  This is similar to the
8276 constant propagation pass, but instead of values, ranges of values are
8277 propagated.  This allows the optimizers to remove unnecessary range
8278 checks like array bound checks and null pointer checks.  This is
8279 enabled by default at @option{-O2} and higher.  Null pointer check
8280 elimination is only done if @option{-fdelete-null-pointer-checks} is
8281 enabled.
8283 @item -ftracer
8284 @opindex ftracer
8285 Perform tail duplication to enlarge superblock size.  This transformation
8286 simplifies the control flow of the function allowing other optimizations to do
8287 a better job.
8289 @item -funroll-loops
8290 @opindex funroll-loops
8291 Unroll loops whose number of iterations can be determined at compile
8292 time or upon entry to the loop.  @option{-funroll-loops} implies
8293 @option{-frerun-cse-after-loop}.  This option makes code larger,
8294 and may or may not make it run faster.
8296 @item -funroll-all-loops
8297 @opindex funroll-all-loops
8298 Unroll all loops, even if their number of iterations is uncertain when
8299 the loop is entered.  This usually makes programs run more slowly.
8300 @option{-funroll-all-loops} implies the same options as
8301 @option{-funroll-loops},
8303 @item -fsplit-ivs-in-unroller
8304 @opindex fsplit-ivs-in-unroller
8305 Enables expression of values of induction variables in later iterations
8306 of the unrolled loop using the value in the first iteration.  This breaks
8307 long dependency chains, thus improving efficiency of the scheduling passes.
8309 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8310 same effect.  However, that is not reliable in cases where the loop body
8311 is more complicated than a single basic block.  It also does not work at all
8312 on some architectures due to restrictions in the CSE pass.
8314 This optimization is enabled by default.
8316 @item -fvariable-expansion-in-unroller
8317 @opindex fvariable-expansion-in-unroller
8318 With this option, the compiler creates multiple copies of some
8319 local variables when unrolling a loop, which can result in superior code.
8321 @item -fpartial-inlining
8322 @opindex fpartial-inlining
8323 Inline parts of functions.  This option has any effect only
8324 when inlining itself is turned on by the @option{-finline-functions}
8325 or @option{-finline-small-functions} options.
8327 Enabled at level @option{-O2}.
8329 @item -fpredictive-commoning
8330 @opindex fpredictive-commoning
8331 Perform predictive commoning optimization, i.e., reusing computations
8332 (especially memory loads and stores) performed in previous
8333 iterations of loops.
8335 This option is enabled at level @option{-O3}.
8337 @item -fprefetch-loop-arrays
8338 @opindex fprefetch-loop-arrays
8339 If supported by the target machine, generate instructions to prefetch
8340 memory to improve the performance of loops that access large arrays.
8342 This option may generate better or worse code; results are highly
8343 dependent on the structure of loops within the source code.
8345 Disabled at level @option{-Os}.
8347 @item -fno-peephole
8348 @itemx -fno-peephole2
8349 @opindex fno-peephole
8350 @opindex fno-peephole2
8351 Disable any machine-specific peephole optimizations.  The difference
8352 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8353 are implemented in the compiler; some targets use one, some use the
8354 other, a few use both.
8356 @option{-fpeephole} is enabled by default.
8357 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8359 @item -fno-guess-branch-probability
8360 @opindex fno-guess-branch-probability
8361 Do not guess branch probabilities using heuristics.
8363 GCC uses heuristics to guess branch probabilities if they are
8364 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8365 heuristics are based on the control flow graph.  If some branch probabilities
8366 are specified by @samp{__builtin_expect}, then the heuristics are
8367 used to guess branch probabilities for the rest of the control flow graph,
8368 taking the @samp{__builtin_expect} info into account.  The interactions
8369 between the heuristics and @samp{__builtin_expect} can be complex, and in
8370 some cases, it may be useful to disable the heuristics so that the effects
8371 of @samp{__builtin_expect} are easier to understand.
8373 The default is @option{-fguess-branch-probability} at levels
8374 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8376 @item -freorder-blocks
8377 @opindex freorder-blocks
8378 Reorder basic blocks in the compiled function in order to reduce number of
8379 taken branches and improve code locality.
8381 Enabled at levels @option{-O2}, @option{-O3}.
8383 @item -freorder-blocks-and-partition
8384 @opindex freorder-blocks-and-partition
8385 In addition to reordering basic blocks in the compiled function, in order
8386 to reduce number of taken branches, partitions hot and cold basic blocks
8387 into separate sections of the assembly and .o files, to improve
8388 paging and cache locality performance.
8390 This optimization is automatically turned off in the presence of
8391 exception handling, for linkonce sections, for functions with a user-defined
8392 section attribute and on any architecture that does not support named
8393 sections.
8395 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8397 @item -freorder-functions
8398 @opindex freorder-functions
8399 Reorder functions in the object file in order to
8400 improve code locality.  This is implemented by using special
8401 subsections @code{.text.hot} for most frequently executed functions and
8402 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8403 the linker so object file format must support named sections and linker must
8404 place them in a reasonable way.
8406 Also profile feedback must be available to make this option effective.  See
8407 @option{-fprofile-arcs} for details.
8409 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8411 @item -fstrict-aliasing
8412 @opindex fstrict-aliasing
8413 Allow the compiler to assume the strictest aliasing rules applicable to
8414 the language being compiled.  For C (and C++), this activates
8415 optimizations based on the type of expressions.  In particular, an
8416 object of one type is assumed never to reside at the same address as an
8417 object of a different type, unless the types are almost the same.  For
8418 example, an @code{unsigned int} can alias an @code{int}, but not a
8419 @code{void*} or a @code{double}.  A character type may alias any other
8420 type.
8422 @anchor{Type-punning}Pay special attention to code like this:
8423 @smallexample
8424 union a_union @{
8425   int i;
8426   double d;
8429 int f() @{
8430   union a_union t;
8431   t.d = 3.0;
8432   return t.i;
8434 @end smallexample
8435 The practice of reading from a different union member than the one most
8436 recently written to (called ``type-punning'') is common.  Even with
8437 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8438 is accessed through the union type.  So, the code above works as
8439 expected.  @xref{Structures unions enumerations and bit-fields
8440 implementation}.  However, this code might not:
8441 @smallexample
8442 int f() @{
8443   union a_union t;
8444   int* ip;
8445   t.d = 3.0;
8446   ip = &t.i;
8447   return *ip;
8449 @end smallexample
8451 Similarly, access by taking the address, casting the resulting pointer
8452 and dereferencing the result has undefined behavior, even if the cast
8453 uses a union type, e.g.:
8454 @smallexample
8455 int f() @{
8456   double d = 3.0;
8457   return ((union a_union *) &d)->i;
8459 @end smallexample
8461 The @option{-fstrict-aliasing} option is enabled at levels
8462 @option{-O2}, @option{-O3}, @option{-Os}.
8464 @item -fstrict-overflow
8465 @opindex fstrict-overflow
8466 Allow the compiler to assume strict signed overflow rules, depending
8467 on the language being compiled.  For C (and C++) this means that
8468 overflow when doing arithmetic with signed numbers is undefined, which
8469 means that the compiler may assume that it does not happen.  This
8470 permits various optimizations.  For example, the compiler assumes
8471 that an expression like @code{i + 10 > i} is always true for
8472 signed @code{i}.  This assumption is only valid if signed overflow is
8473 undefined, as the expression is false if @code{i + 10} overflows when
8474 using twos complement arithmetic.  When this option is in effect any
8475 attempt to determine whether an operation on signed numbers 
8476 overflows must be written carefully to not actually involve overflow.
8478 This option also allows the compiler to assume strict pointer
8479 semantics: given a pointer to an object, if adding an offset to that
8480 pointer does not produce a pointer to the same object, the addition is
8481 undefined.  This permits the compiler to conclude that @code{p + u >
8482 p} is always true for a pointer @code{p} and unsigned integer
8483 @code{u}.  This assumption is only valid because pointer wraparound is
8484 undefined, as the expression is false if @code{p + u} overflows using
8485 twos complement arithmetic.
8487 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8488 that integer signed overflow is fully defined: it wraps.  When
8489 @option{-fwrapv} is used, there is no difference between
8490 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8491 integers.  With @option{-fwrapv} certain types of overflow are
8492 permitted.  For example, if the compiler gets an overflow when doing
8493 arithmetic on constants, the overflowed value can still be used with
8494 @option{-fwrapv}, but not otherwise.
8496 The @option{-fstrict-overflow} option is enabled at levels
8497 @option{-O2}, @option{-O3}, @option{-Os}.
8499 @item -falign-functions
8500 @itemx -falign-functions=@var{n}
8501 @opindex falign-functions
8502 Align the start of functions to the next power-of-two greater than
8503 @var{n}, skipping up to @var{n} bytes.  For instance,
8504 @option{-falign-functions=32} aligns functions to the next 32-byte
8505 boundary, but @option{-falign-functions=24} aligns to the next
8506 32-byte boundary only if this can be done by skipping 23 bytes or less.
8508 @option{-fno-align-functions} and @option{-falign-functions=1} are
8509 equivalent and mean that functions are not aligned.
8511 Some assemblers only support this flag when @var{n} is a power of two;
8512 in that case, it is rounded up.
8514 If @var{n} is not specified or is zero, use a machine-dependent default.
8516 Enabled at levels @option{-O2}, @option{-O3}.
8518 @item -falign-labels
8519 @itemx -falign-labels=@var{n}
8520 @opindex falign-labels
8521 Align all branch targets to a power-of-two boundary, skipping up to
8522 @var{n} bytes like @option{-falign-functions}.  This option can easily
8523 make code slower, because it must insert dummy operations for when the
8524 branch target is reached in the usual flow of the code.
8526 @option{-fno-align-labels} and @option{-falign-labels=1} are
8527 equivalent and mean that labels are not aligned.
8529 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8530 are greater than this value, then their values are used instead.
8532 If @var{n} is not specified or is zero, use a machine-dependent default
8533 which is very likely to be @samp{1}, meaning no alignment.
8535 Enabled at levels @option{-O2}, @option{-O3}.
8537 @item -falign-loops
8538 @itemx -falign-loops=@var{n}
8539 @opindex falign-loops
8540 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8541 like @option{-falign-functions}.  If the loops are
8542 executed many times, this makes up for any execution of the dummy
8543 operations.
8545 @option{-fno-align-loops} and @option{-falign-loops=1} are
8546 equivalent and mean that loops are not aligned.
8548 If @var{n} is not specified or is zero, use a machine-dependent default.
8550 Enabled at levels @option{-O2}, @option{-O3}.
8552 @item -falign-jumps
8553 @itemx -falign-jumps=@var{n}
8554 @opindex falign-jumps
8555 Align branch targets to a power-of-two boundary, for branch targets
8556 where the targets can only be reached by jumping, skipping up to @var{n}
8557 bytes like @option{-falign-functions}.  In this case, no dummy operations
8558 need be executed.
8560 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8561 equivalent and mean that loops are not aligned.
8563 If @var{n} is not specified or is zero, use a machine-dependent default.
8565 Enabled at levels @option{-O2}, @option{-O3}.
8567 @item -funit-at-a-time
8568 @opindex funit-at-a-time
8569 This option is left for compatibility reasons. @option{-funit-at-a-time}
8570 has no effect, while @option{-fno-unit-at-a-time} implies
8571 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8573 Enabled by default.
8575 @item -fno-toplevel-reorder
8576 @opindex fno-toplevel-reorder
8577 Do not reorder top-level functions, variables, and @code{asm}
8578 statements.  Output them in the same order that they appear in the
8579 input file.  When this option is used, unreferenced static variables
8580 are not removed.  This option is intended to support existing code
8581 that relies on a particular ordering.  For new code, it is better to
8582 use attributes when possible.
8584 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8585 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8586 targets.
8588 @item -fweb
8589 @opindex fweb
8590 Constructs webs as commonly used for register allocation purposes and assign
8591 each web individual pseudo register.  This allows the register allocation pass
8592 to operate on pseudos directly, but also strengthens several other optimization
8593 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8594 however, make debugging impossible, since variables no longer stay in a
8595 ``home register''.
8597 Enabled by default with @option{-funroll-loops}.
8599 @item -fwhole-program
8600 @opindex fwhole-program
8601 Assume that the current compilation unit represents the whole program being
8602 compiled.  All public functions and variables with the exception of @code{main}
8603 and those merged by attribute @code{externally_visible} become static functions
8604 and in effect are optimized more aggressively by interprocedural optimizers.
8606 This option should not be used in combination with @code{-flto}.
8607 Instead relying on a linker plugin should provide safer and more precise
8608 information.
8610 @item -flto[=@var{n}]
8611 @opindex flto
8612 This option runs the standard link-time optimizer.  When invoked
8613 with source code, it generates GIMPLE (one of GCC's internal
8614 representations) and writes it to special ELF sections in the object
8615 file.  When the object files are linked together, all the function
8616 bodies are read from these ELF sections and instantiated as if they
8617 had been part of the same translation unit.
8619 To use the link-time optimizer, @option{-flto} and optimization
8620 options should be specified at compile time and during the final link.
8621 For example:
8623 @smallexample
8624 gcc -c -O2 -flto foo.c
8625 gcc -c -O2 -flto bar.c
8626 gcc -o myprog -flto -O2 foo.o bar.o
8627 @end smallexample
8629 The first two invocations to GCC save a bytecode representation
8630 of GIMPLE into special ELF sections inside @file{foo.o} and
8631 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8632 @file{foo.o} and @file{bar.o}, merges the two files into a single
8633 internal image, and compiles the result as usual.  Since both
8634 @file{foo.o} and @file{bar.o} are merged into a single image, this
8635 causes all the interprocedural analyses and optimizations in GCC to
8636 work across the two files as if they were a single one.  This means,
8637 for example, that the inliner is able to inline functions in
8638 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8640 Another (simpler) way to enable link-time optimization is:
8642 @smallexample
8643 gcc -o myprog -flto -O2 foo.c bar.c
8644 @end smallexample
8646 The above generates bytecode for @file{foo.c} and @file{bar.c},
8647 merges them together into a single GIMPLE representation and optimizes
8648 them as usual to produce @file{myprog}.
8650 The only important thing to keep in mind is that to enable link-time
8651 optimizations you need to use the GCC driver to perform the link-step.
8652 GCC then automatically performs link-time optimization if any of the
8653 objects involved were compiled with the @option{-flto}.  You generally
8654 should specify the optimization options to be used for link-time
8655 optimization though GCC will try to be clever at guessing an
8656 optimization level to use from the options used at compile-time
8657 if you fail to specify one at link-time.  You can always override
8658 the automatic decision to do link-time optimization at link-time
8659 by passing @option{-fno-lto} to the link command.
8661 To make whole program optimization effective, it is necessary to make
8662 certain whole program assumptions.  The compiler needs to know
8663 what functions and variables can be accessed by libraries and runtime
8664 outside of the link-time optimized unit.  When supported by the linker,
8665 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8666 to the compiler about used and externally visible symbols.  When
8667 the linker plugin is not available, @option{-fwhole-program} should be
8668 used to allow the compiler to make these assumptions, which leads
8669 to more aggressive optimization decisions.
8671 When @option{-fuse-linker-plugin} is not enabled then, when a file is
8672 compiled with @option{-flto}, the generated object file is larger than
8673 a regular object file because it contains GIMPLE bytecodes and the usual
8674 final code (see @option{-ffat-lto-objects}.  This means that
8675 object files with LTO information can be linked as normal object
8676 files; if @option{-fno-lto} is passed to the linker, no
8677 interprocedural optimizations are applied.  Note that when
8678 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
8679 but you cannot perform a regular, non-LTO link on them.
8681 Additionally, the optimization flags used to compile individual files
8682 are not necessarily related to those used at link time.  For instance,
8684 @smallexample
8685 gcc -c -O0 -ffat-lto-objects -flto foo.c
8686 gcc -c -O0 -ffat-lto-objects -flto bar.c
8687 gcc -o myprog -O3 foo.o bar.o
8688 @end smallexample
8690 This produces individual object files with unoptimized assembler
8691 code, but the resulting binary @file{myprog} is optimized at
8692 @option{-O3}.  If, instead, the final binary is generated with
8693 @option{-fno-lto}, then @file{myprog} is not optimized.
8695 When producing the final binary, GCC only
8696 applies link-time optimizations to those files that contain bytecode.
8697 Therefore, you can mix and match object files and libraries with
8698 GIMPLE bytecodes and final object code.  GCC automatically selects
8699 which files to optimize in LTO mode and which files to link without
8700 further processing.
8702 There are some code generation flags preserved by GCC when
8703 generating bytecodes, as they need to be used during the final link
8704 stage.  Generally options specified at link-time override those
8705 specified at compile-time.
8707 If you do not specify an optimization level option @option{-O} at
8708 link-time then GCC will compute one based on the optimization levels
8709 used when compiling the object files.  The highest optimization
8710 level will win here.
8712 Currently, the following options and their setting are take from
8713 the first object file that explicitely specified it: 
8714 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8715 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8716 and all the @option{-m} target flags.
8718 Certain ABI changing flags are required to match in all compilation-units
8719 and trying to override this at link-time with a conflicting value
8720 is ignored.  This includes options such as @option{-freg-struct-return}
8721 and @option{-fpcc-struct-return}. 
8723 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8724 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8725 are passed through to the link stage and merged conservatively for
8726 conflicting translation units.  Specifically
8727 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8728 precedence and for example @option{-ffp-contract=off} takes precedence
8729 over @option{-ffp-contract=fast}.  You can override them at linke-time.
8731 It is recommended that you compile all the files participating in the
8732 same link with the same options and also specify those options at
8733 link time.
8735 If LTO encounters objects with C linkage declared with incompatible
8736 types in separate translation units to be linked together (undefined
8737 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8738 issued.  The behavior is still undefined at run time.  Similar
8739 diagnostics may be raised for other languages.
8741 Another feature of LTO is that it is possible to apply interprocedural
8742 optimizations on files written in different languages:
8744 @smallexample
8745 gcc -c -flto foo.c
8746 g++ -c -flto bar.cc
8747 gfortran -c -flto baz.f90
8748 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8749 @end smallexample
8751 Notice that the final link is done with @command{g++} to get the C++
8752 runtime libraries and @option{-lgfortran} is added to get the Fortran
8753 runtime libraries.  In general, when mixing languages in LTO mode, you
8754 should use the same link command options as when mixing languages in a
8755 regular (non-LTO) compilation.
8757 If object files containing GIMPLE bytecode are stored in a library archive, say
8758 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8759 are using a linker with plugin support.  To create static libraries suitable
8760 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8761 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
8762 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8763 and @command{nm} have been compiled with plugin support.  At link time, use the the
8764 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8765 the LTO optimization process:
8767 @smallexample
8768 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8769 @end smallexample
8771 With the linker plugin enabled, the linker extracts the needed
8772 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8773 to make them part of the aggregated GIMPLE image to be optimized.
8775 If you are not using a linker with plugin support and/or do not
8776 enable the linker plugin, then the objects inside @file{libfoo.a}
8777 are extracted and linked as usual, but they do not participate
8778 in the LTO optimization process.  In order to make a static library suitable
8779 for both LTO optimization and usual linkage, compile its object files with
8780 @option{-flto} @code{-ffat-lto-objects}.
8782 Link-time optimizations do not require the presence of the whole program to
8783 operate.  If the program does not require any symbols to be exported, it is
8784 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8785 the interprocedural optimizers to use more aggressive assumptions which may
8786 lead to improved optimization opportunities.
8787 Use of @option{-fwhole-program} is not needed when linker plugin is
8788 active (see @option{-fuse-linker-plugin}).
8790 The current implementation of LTO makes no
8791 attempt to generate bytecode that is portable between different
8792 types of hosts.  The bytecode files are versioned and there is a
8793 strict version check, so bytecode files generated in one version of
8794 GCC will not work with an older or newer version of GCC.
8796 Link-time optimization does not work well with generation of debugging
8797 information.  Combining @option{-flto} with
8798 @option{-g} is currently experimental and expected to produce unexpected
8799 results.
8801 If you specify the optional @var{n}, the optimization and code
8802 generation done at link time is executed in parallel using @var{n}
8803 parallel jobs by utilizing an installed @command{make} program.  The
8804 environment variable @env{MAKE} may be used to override the program
8805 used.  The default value for @var{n} is 1.
8807 You can also specify @option{-flto=jobserver} to use GNU make's
8808 job server mode to determine the number of parallel jobs. This
8809 is useful when the Makefile calling GCC is already executing in parallel.
8810 You must prepend a @samp{+} to the command recipe in the parent Makefile
8811 for this to work.  This option likely only works if @env{MAKE} is
8812 GNU make.
8814 @item -flto-partition=@var{alg}
8815 @opindex flto-partition
8816 Specify the partitioning algorithm used by the link-time optimizer.
8817 The value is either @code{1to1} to specify a partitioning mirroring
8818 the original source files or @code{balanced} to specify partitioning
8819 into equally sized chunks (whenever possible) or @code{max} to create
8820 new partition for every symbol where possible.  Specifying @code{none}
8821 as an algorithm disables partitioning and streaming completely. 
8822 The default value is @code{balanced}. While @code{1to1} can be used
8823 as an workaround for various code ordering issues, the @code{max}
8824 partitioning is intended for internal testing only.
8825 The value @code{one} specifies that exactly one partition should be
8826 used while the value @code{none} bypasses partitioning and executes
8827 the link-time optimization step directly from the WPA phase.
8829 @item -flto-compression-level=@var{n}
8830 This option specifies the level of compression used for intermediate
8831 language written to LTO object files, and is only meaningful in
8832 conjunction with LTO mode (@option{-flto}).  Valid
8833 values are 0 (no compression) to 9 (maximum compression).  Values
8834 outside this range are clamped to either 0 or 9.  If the option is not
8835 given, a default balanced compression setting is used.
8837 @item -flto-report
8838 Prints a report with internal details on the workings of the link-time
8839 optimizer.  The contents of this report vary from version to version.
8840 It is meant to be useful to GCC developers when processing object
8841 files in LTO mode (via @option{-flto}).
8843 Disabled by default.
8845 @item -flto-report-wpa
8846 Like @option{-flto-report}, but only print for the WPA phase of Link
8847 Time Optimization.
8849 @item -fuse-linker-plugin
8850 Enables the use of a linker plugin during link-time optimization.  This
8851 option relies on plugin support in the linker, which is available in gold
8852 or in GNU ld 2.21 or newer.
8854 This option enables the extraction of object files with GIMPLE bytecode out
8855 of library archives. This improves the quality of optimization by exposing
8856 more code to the link-time optimizer.  This information specifies what
8857 symbols can be accessed externally (by non-LTO object or during dynamic
8858 linking).  Resulting code quality improvements on binaries (and shared
8859 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8860 See @option{-flto} for a description of the effect of this flag and how to
8861 use it.
8863 This option is enabled by default when LTO support in GCC is enabled
8864 and GCC was configured for use with
8865 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8867 @item -ffat-lto-objects
8868 @opindex ffat-lto-objects
8869 Fat LTO objects are object files that contain both the intermediate language
8870 and the object code. This makes them usable for both LTO linking and normal
8871 linking. This option is effective only when compiling with @option{-flto}
8872 and is ignored at link time.
8874 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8875 requires the complete toolchain to be aware of LTO. It requires a linker with
8876 linker plugin support for basic functionality.  Additionally,
8877 @command{nm}, @command{ar} and @command{ranlib}
8878 need to support linker plugins to allow a full-featured build environment
8879 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8880 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8881 to these tools. With non fat LTO makefiles need to be modified to use them.
8883 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
8884 support.
8886 @item -fcompare-elim
8887 @opindex fcompare-elim
8888 After register allocation and post-register allocation instruction splitting,
8889 identify arithmetic instructions that compute processor flags similar to a
8890 comparison operation based on that arithmetic.  If possible, eliminate the
8891 explicit comparison operation.
8893 This pass only applies to certain targets that cannot explicitly represent
8894 the comparison operation before register allocation is complete.
8896 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8898 @item -fuse-ld=bfd
8899 @opindex fuse-ld=bfd
8900 Use the @command{bfd} linker instead of the default linker.
8902 @item -fuse-ld=gold
8903 @opindex fuse-ld=gold
8904 Use the @command{gold} linker instead of the default linker.
8906 @item -fcprop-registers
8907 @opindex fcprop-registers
8908 After register allocation and post-register allocation instruction splitting,
8909 perform a copy-propagation pass to try to reduce scheduling dependencies
8910 and occasionally eliminate the copy.
8912 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8914 @item -fprofile-correction
8915 @opindex fprofile-correction
8916 Profiles collected using an instrumented binary for multi-threaded programs may
8917 be inconsistent due to missed counter updates. When this option is specified,
8918 GCC uses heuristics to correct or smooth out such inconsistencies. By
8919 default, GCC emits an error message when an inconsistent profile is detected.
8921 @item -fprofile-dir=@var{path}
8922 @opindex fprofile-dir
8924 Set the directory to search for the profile data files in to @var{path}.
8925 This option affects only the profile data generated by
8926 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8927 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8928 and its related options.  Both absolute and relative paths can be used.
8929 By default, GCC uses the current directory as @var{path}, thus the
8930 profile data file appears in the same directory as the object file.
8932 @item -fprofile-generate
8933 @itemx -fprofile-generate=@var{path}
8934 @opindex fprofile-generate
8936 Enable options usually used for instrumenting application to produce
8937 profile useful for later recompilation with profile feedback based
8938 optimization.  You must use @option{-fprofile-generate} both when
8939 compiling and when linking your program.
8941 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8943 If @var{path} is specified, GCC looks at the @var{path} to find
8944 the profile feedback data files. See @option{-fprofile-dir}.
8946 @item -fprofile-use
8947 @itemx -fprofile-use=@var{path}
8948 @opindex fprofile-use
8949 Enable profile feedback directed optimizations, and optimizations
8950 generally profitable only with profile feedback available.
8952 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8953 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8954 @code{ftree-loop-distribute-patterns}
8956 By default, GCC emits an error message if the feedback profiles do not
8957 match the source code.  This error can be turned into a warning by using
8958 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8959 code.
8961 If @var{path} is specified, GCC looks at the @var{path} to find
8962 the profile feedback data files. See @option{-fprofile-dir}.
8963 @end table
8965 The following options control compiler behavior regarding floating-point 
8966 arithmetic.  These options trade off between speed and
8967 correctness.  All must be specifically enabled.
8969 @table @gcctabopt
8970 @item -ffloat-store
8971 @opindex ffloat-store
8972 Do not store floating-point variables in registers, and inhibit other
8973 options that might change whether a floating-point value is taken from a
8974 register or memory.
8976 @cindex floating-point precision
8977 This option prevents undesirable excess precision on machines such as
8978 the 68000 where the floating registers (of the 68881) keep more
8979 precision than a @code{double} is supposed to have.  Similarly for the
8980 x86 architecture.  For most programs, the excess precision does only
8981 good, but a few programs rely on the precise definition of IEEE floating
8982 point.  Use @option{-ffloat-store} for such programs, after modifying
8983 them to store all pertinent intermediate computations into variables.
8985 @item -fexcess-precision=@var{style}
8986 @opindex fexcess-precision
8987 This option allows further control over excess precision on machines
8988 where floating-point registers have more precision than the IEEE
8989 @code{float} and @code{double} types and the processor does not
8990 support operations rounding to those types.  By default,
8991 @option{-fexcess-precision=fast} is in effect; this means that
8992 operations are carried out in the precision of the registers and that
8993 it is unpredictable when rounding to the types specified in the source
8994 code takes place.  When compiling C, if
8995 @option{-fexcess-precision=standard} is specified then excess
8996 precision follows the rules specified in ISO C99; in particular,
8997 both casts and assignments cause values to be rounded to their
8998 semantic types (whereas @option{-ffloat-store} only affects
8999 assignments).  This option is enabled by default for C if a strict
9000 conformance option such as @option{-std=c99} is used.
9002 @opindex mfpmath
9003 @option{-fexcess-precision=standard} is not implemented for languages
9004 other than C, and has no effect if
9005 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9006 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9007 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9008 semantics apply without excess precision, and in the latter, rounding
9009 is unpredictable.
9011 @item -ffast-math
9012 @opindex ffast-math
9013 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9014 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9015 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9017 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9019 This option is not turned on by any @option{-O} option besides
9020 @option{-Ofast} since it can result in incorrect output for programs
9021 that depend on an exact implementation of IEEE or ISO rules/specifications
9022 for math functions. It may, however, yield faster code for programs
9023 that do not require the guarantees of these specifications.
9025 @item -fno-math-errno
9026 @opindex fno-math-errno
9027 Do not set @code{errno} after calling math functions that are executed
9028 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9029 IEEE exceptions for math error handling may want to use this flag
9030 for speed while maintaining IEEE arithmetic compatibility.
9032 This option is not turned on by any @option{-O} option since
9033 it can result in incorrect output for programs that depend on
9034 an exact implementation of IEEE or ISO rules/specifications for
9035 math functions. It may, however, yield faster code for programs
9036 that do not require the guarantees of these specifications.
9038 The default is @option{-fmath-errno}.
9040 On Darwin systems, the math library never sets @code{errno}.  There is
9041 therefore no reason for the compiler to consider the possibility that
9042 it might, and @option{-fno-math-errno} is the default.
9044 @item -funsafe-math-optimizations
9045 @opindex funsafe-math-optimizations
9047 Allow optimizations for floating-point arithmetic that (a) assume
9048 that arguments and results are valid and (b) may violate IEEE or
9049 ANSI standards.  When used at link-time, it may include libraries
9050 or startup files that change the default FPU control word or other
9051 similar optimizations.
9053 This option is not turned on by any @option{-O} option since
9054 it can result in incorrect output for programs that depend on
9055 an exact implementation of IEEE or ISO rules/specifications for
9056 math functions. It may, however, yield faster code for programs
9057 that do not require the guarantees of these specifications.
9058 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9059 @option{-fassociative-math} and @option{-freciprocal-math}.
9061 The default is @option{-fno-unsafe-math-optimizations}.
9063 @item -fassociative-math
9064 @opindex fassociative-math
9066 Allow re-association of operands in series of floating-point operations.
9067 This violates the ISO C and C++ language standard by possibly changing
9068 computation result.  NOTE: re-ordering may change the sign of zero as
9069 well as ignore NaNs and inhibit or create underflow or overflow (and
9070 thus cannot be used on code that relies on rounding behavior like
9071 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9072 and thus may not be used when ordered comparisons are required.
9073 This option requires that both @option{-fno-signed-zeros} and
9074 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9075 much sense with @option{-frounding-math}. For Fortran the option
9076 is automatically enabled when both @option{-fno-signed-zeros} and
9077 @option{-fno-trapping-math} are in effect.
9079 The default is @option{-fno-associative-math}.
9081 @item -freciprocal-math
9082 @opindex freciprocal-math
9084 Allow the reciprocal of a value to be used instead of dividing by
9085 the value if this enables optimizations.  For example @code{x / y}
9086 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9087 is subject to common subexpression elimination.  Note that this loses
9088 precision and increases the number of flops operating on the value.
9090 The default is @option{-fno-reciprocal-math}.
9092 @item -ffinite-math-only
9093 @opindex ffinite-math-only
9094 Allow optimizations for floating-point arithmetic that assume
9095 that arguments and results are not NaNs or +-Infs.
9097 This option is not turned on by any @option{-O} option since
9098 it can result in incorrect output for programs that depend on
9099 an exact implementation of IEEE or ISO rules/specifications for
9100 math functions. It may, however, yield faster code for programs
9101 that do not require the guarantees of these specifications.
9103 The default is @option{-fno-finite-math-only}.
9105 @item -fno-signed-zeros
9106 @opindex fno-signed-zeros
9107 Allow optimizations for floating-point arithmetic that ignore the
9108 signedness of zero.  IEEE arithmetic specifies the behavior of
9109 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9110 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9111 This option implies that the sign of a zero result isn't significant.
9113 The default is @option{-fsigned-zeros}.
9115 @item -fno-trapping-math
9116 @opindex fno-trapping-math
9117 Compile code assuming that floating-point operations cannot generate
9118 user-visible traps.  These traps include division by zero, overflow,
9119 underflow, inexact result and invalid operation.  This option requires
9120 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9121 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9123 This option should never be turned on by any @option{-O} option since
9124 it can result in incorrect output for programs that depend on
9125 an exact implementation of IEEE or ISO rules/specifications for
9126 math functions.
9128 The default is @option{-ftrapping-math}.
9130 @item -frounding-math
9131 @opindex frounding-math
9132 Disable transformations and optimizations that assume default floating-point
9133 rounding behavior.  This is round-to-zero for all floating point
9134 to integer conversions, and round-to-nearest for all other arithmetic
9135 truncations.  This option should be specified for programs that change
9136 the FP rounding mode dynamically, or that may be executed with a
9137 non-default rounding mode.  This option disables constant folding of
9138 floating-point expressions at compile time (which may be affected by
9139 rounding mode) and arithmetic transformations that are unsafe in the
9140 presence of sign-dependent rounding modes.
9142 The default is @option{-fno-rounding-math}.
9144 This option is experimental and does not currently guarantee to
9145 disable all GCC optimizations that are affected by rounding mode.
9146 Future versions of GCC may provide finer control of this setting
9147 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9148 will be used to specify the default state for @code{FENV_ACCESS}.
9150 @item -fsignaling-nans
9151 @opindex fsignaling-nans
9152 Compile code assuming that IEEE signaling NaNs may generate user-visible
9153 traps during floating-point operations.  Setting this option disables
9154 optimizations that may change the number of exceptions visible with
9155 signaling NaNs.  This option implies @option{-ftrapping-math}.
9157 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9158 be defined.
9160 The default is @option{-fno-signaling-nans}.
9162 This option is experimental and does not currently guarantee to
9163 disable all GCC optimizations that affect signaling NaN behavior.
9165 @item -fsingle-precision-constant
9166 @opindex fsingle-precision-constant
9167 Treat floating-point constants as single precision instead of
9168 implicitly converting them to double-precision constants.
9170 @item -fcx-limited-range
9171 @opindex fcx-limited-range
9172 When enabled, this option states that a range reduction step is not
9173 needed when performing complex division.  Also, there is no checking
9174 whether the result of a complex multiplication or division is @code{NaN
9175 + I*NaN}, with an attempt to rescue the situation in that case.  The
9176 default is @option{-fno-cx-limited-range}, but is enabled by
9177 @option{-ffast-math}.
9179 This option controls the default setting of the ISO C99
9180 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9181 all languages.
9183 @item -fcx-fortran-rules
9184 @opindex fcx-fortran-rules
9185 Complex multiplication and division follow Fortran rules.  Range
9186 reduction is done as part of complex division, but there is no checking
9187 whether the result of a complex multiplication or division is @code{NaN
9188 + I*NaN}, with an attempt to rescue the situation in that case.
9190 The default is @option{-fno-cx-fortran-rules}.
9192 @end table
9194 The following options control optimizations that may improve
9195 performance, but are not enabled by any @option{-O} options.  This
9196 section includes experimental options that may produce broken code.
9198 @table @gcctabopt
9199 @item -fbranch-probabilities
9200 @opindex fbranch-probabilities
9201 After running a program compiled with @option{-fprofile-arcs}
9202 (@pxref{Debugging Options,, Options for Debugging Your Program or
9203 @command{gcc}}), you can compile it a second time using
9204 @option{-fbranch-probabilities}, to improve optimizations based on
9205 the number of times each branch was taken.  When a program
9206 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9207 counts to a file called @file{@var{sourcename}.gcda} for each source
9208 file.  The information in this data file is very dependent on the
9209 structure of the generated code, so you must use the same source code
9210 and the same optimization options for both compilations.
9212 With @option{-fbranch-probabilities}, GCC puts a
9213 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9214 These can be used to improve optimization.  Currently, they are only
9215 used in one place: in @file{reorg.c}, instead of guessing which path a
9216 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9217 exactly determine which path is taken more often.
9219 @item -fprofile-values
9220 @opindex fprofile-values
9221 If combined with @option{-fprofile-arcs}, it adds code so that some
9222 data about values of expressions in the program is gathered.
9224 With @option{-fbranch-probabilities}, it reads back the data gathered
9225 from profiling values of expressions for usage in optimizations.
9227 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9229 @item -fprofile-reorder-functions
9230 @opindex fprofile-reorder-functions
9231 Function reordering based on profile instrumentation collects
9232 first time of execution of a function and orders these functions
9233 in ascending order.
9235 Enabled with @option{-fprofile-use}.
9237 @item -fvpt
9238 @opindex fvpt
9239 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9240 to add code to gather information about values of expressions.
9242 With @option{-fbranch-probabilities}, it reads back the data gathered
9243 and actually performs the optimizations based on them.
9244 Currently the optimizations include specialization of division operations
9245 using the knowledge about the value of the denominator.
9247 @item -frename-registers
9248 @opindex frename-registers
9249 Attempt to avoid false dependencies in scheduled code by making use
9250 of registers left over after register allocation.  This optimization
9251 most benefits processors with lots of registers.  Depending on the
9252 debug information format adopted by the target, however, it can
9253 make debugging impossible, since variables no longer stay in
9254 a ``home register''.
9256 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9258 @item -ftracer
9259 @opindex ftracer
9260 Perform tail duplication to enlarge superblock size.  This transformation
9261 simplifies the control flow of the function allowing other optimizations to do
9262 a better job.
9264 Enabled with @option{-fprofile-use}.
9266 @item -funroll-loops
9267 @opindex funroll-loops
9268 Unroll loops whose number of iterations can be determined at compile time or
9269 upon entry to the loop.  @option{-funroll-loops} implies
9270 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9271 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9272 a small constant number of iterations).  This option makes code larger, and may
9273 or may not make it run faster.
9275 Enabled with @option{-fprofile-use}.
9277 @item -funroll-all-loops
9278 @opindex funroll-all-loops
9279 Unroll all loops, even if their number of iterations is uncertain when
9280 the loop is entered.  This usually makes programs run more slowly.
9281 @option{-funroll-all-loops} implies the same options as
9282 @option{-funroll-loops}.
9284 @item -fpeel-loops
9285 @opindex fpeel-loops
9286 Peels loops for which there is enough information that they do not
9287 roll much (from profile feedback).  It also turns on complete loop peeling
9288 (i.e.@: complete removal of loops with small constant number of iterations).
9290 Enabled with @option{-fprofile-use}.
9292 @item -fmove-loop-invariants
9293 @opindex fmove-loop-invariants
9294 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9295 at level @option{-O1}
9297 @item -funswitch-loops
9298 @opindex funswitch-loops
9299 Move branches with loop invariant conditions out of the loop, with duplicates
9300 of the loop on both branches (modified according to result of the condition).
9302 @item -ffunction-sections
9303 @itemx -fdata-sections
9304 @opindex ffunction-sections
9305 @opindex fdata-sections
9306 Place each function or data item into its own section in the output
9307 file if the target supports arbitrary sections.  The name of the
9308 function or the name of the data item determines the section's name
9309 in the output file.
9311 Use these options on systems where the linker can perform optimizations
9312 to improve locality of reference in the instruction space.  Most systems
9313 using the ELF object format and SPARC processors running Solaris 2 have
9314 linkers with such optimizations.  AIX may have these optimizations in
9315 the future.
9317 Only use these options when there are significant benefits from doing
9318 so.  When you specify these options, the assembler and linker
9319 create larger object and executable files and are also slower.
9320 You cannot use @code{gprof} on all systems if you
9321 specify this option, and you may have problems with debugging if
9322 you specify both this option and @option{-g}.
9324 @item -fbranch-target-load-optimize
9325 @opindex fbranch-target-load-optimize
9326 Perform branch target register load optimization before prologue / epilogue
9327 threading.
9328 The use of target registers can typically be exposed only during reload,
9329 thus hoisting loads out of loops and doing inter-block scheduling needs
9330 a separate optimization pass.
9332 @item -fbranch-target-load-optimize2
9333 @opindex fbranch-target-load-optimize2
9334 Perform branch target register load optimization after prologue / epilogue
9335 threading.
9337 @item -fbtr-bb-exclusive
9338 @opindex fbtr-bb-exclusive
9339 When performing branch target register load optimization, don't reuse
9340 branch target registers within any basic block.
9342 @item -fstack-protector
9343 @opindex fstack-protector
9344 Emit extra code to check for buffer overflows, such as stack smashing
9345 attacks.  This is done by adding a guard variable to functions with
9346 vulnerable objects.  This includes functions that call @code{alloca}, and
9347 functions with buffers larger than 8 bytes.  The guards are initialized
9348 when a function is entered and then checked when the function exits.
9349 If a guard check fails, an error message is printed and the program exits.
9351 @item -fstack-protector-all
9352 @opindex fstack-protector-all
9353 Like @option{-fstack-protector} except that all functions are protected.
9355 @item -fstack-protector-strong
9356 @opindex fstack-protector-strong
9357 Like @option{-fstack-protector} but includes additional functions to
9358 be protected --- those that have local array definitions, or have
9359 references to local frame addresses.
9361 @item -fsection-anchors
9362 @opindex fsection-anchors
9363 Try to reduce the number of symbolic address calculations by using
9364 shared ``anchor'' symbols to address nearby objects.  This transformation
9365 can help to reduce the number of GOT entries and GOT accesses on some
9366 targets.
9368 For example, the implementation of the following function @code{foo}:
9370 @smallexample
9371 static int a, b, c;
9372 int foo (void) @{ return a + b + c; @}
9373 @end smallexample
9375 @noindent
9376 usually calculates the addresses of all three variables, but if you
9377 compile it with @option{-fsection-anchors}, it accesses the variables
9378 from a common anchor point instead.  The effect is similar to the
9379 following pseudocode (which isn't valid C):
9381 @smallexample
9382 int foo (void)
9384   register int *xr = &x;
9385   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9387 @end smallexample
9389 Not all targets support this option.
9391 @item --param @var{name}=@var{value}
9392 @opindex param
9393 In some places, GCC uses various constants to control the amount of
9394 optimization that is done.  For example, GCC does not inline functions
9395 that contain more than a certain number of instructions.  You can
9396 control some of these constants on the command line using the
9397 @option{--param} option.
9399 The names of specific parameters, and the meaning of the values, are
9400 tied to the internals of the compiler, and are subject to change
9401 without notice in future releases.
9403 In each case, the @var{value} is an integer.  The allowable choices for
9404 @var{name} are:
9406 @table @gcctabopt
9407 @item predictable-branch-outcome
9408 When branch is predicted to be taken with probability lower than this threshold
9409 (in percent), then it is considered well predictable. The default is 10.
9411 @item max-crossjump-edges
9412 The maximum number of incoming edges to consider for cross-jumping.
9413 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9414 the number of edges incoming to each block.  Increasing values mean
9415 more aggressive optimization, making the compilation time increase with
9416 probably small improvement in executable size.
9418 @item min-crossjump-insns
9419 The minimum number of instructions that must be matched at the end
9420 of two blocks before cross-jumping is performed on them.  This
9421 value is ignored in the case where all instructions in the block being
9422 cross-jumped from are matched.  The default value is 5.
9424 @item max-grow-copy-bb-insns
9425 The maximum code size expansion factor when copying basic blocks
9426 instead of jumping.  The expansion is relative to a jump instruction.
9427 The default value is 8.
9429 @item max-goto-duplication-insns
9430 The maximum number of instructions to duplicate to a block that jumps
9431 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9432 passes, GCC factors computed gotos early in the compilation process,
9433 and unfactors them as late as possible.  Only computed jumps at the
9434 end of a basic blocks with no more than max-goto-duplication-insns are
9435 unfactored.  The default value is 8.
9437 @item max-delay-slot-insn-search
9438 The maximum number of instructions to consider when looking for an
9439 instruction to fill a delay slot.  If more than this arbitrary number of
9440 instructions are searched, the time savings from filling the delay slot
9441 are minimal, so stop searching.  Increasing values mean more
9442 aggressive optimization, making the compilation time increase with probably
9443 small improvement in execution time.
9445 @item max-delay-slot-live-search
9446 When trying to fill delay slots, the maximum number of instructions to
9447 consider when searching for a block with valid live register
9448 information.  Increasing this arbitrarily chosen value means more
9449 aggressive optimization, increasing the compilation time.  This parameter
9450 should be removed when the delay slot code is rewritten to maintain the
9451 control-flow graph.
9453 @item max-gcse-memory
9454 The approximate maximum amount of memory that can be allocated in
9455 order to perform the global common subexpression elimination
9456 optimization.  If more memory than specified is required, the
9457 optimization is not done.
9459 @item max-gcse-insertion-ratio
9460 If the ratio of expression insertions to deletions is larger than this value
9461 for any expression, then RTL PRE inserts or removes the expression and thus
9462 leaves partially redundant computations in the instruction stream.  The default value is 20.
9464 @item max-pending-list-length
9465 The maximum number of pending dependencies scheduling allows
9466 before flushing the current state and starting over.  Large functions
9467 with few branches or calls can create excessively large lists which
9468 needlessly consume memory and resources.
9470 @item max-modulo-backtrack-attempts
9471 The maximum number of backtrack attempts the scheduler should make
9472 when modulo scheduling a loop.  Larger values can exponentially increase
9473 compilation time.
9475 @item max-inline-insns-single
9476 Several parameters control the tree inliner used in GCC@.
9477 This number sets the maximum number of instructions (counted in GCC's
9478 internal representation) in a single function that the tree inliner
9479 considers for inlining.  This only affects functions declared
9480 inline and methods implemented in a class declaration (C++).
9481 The default value is 400.
9483 @item max-inline-insns-auto
9484 When you use @option{-finline-functions} (included in @option{-O3}),
9485 a lot of functions that would otherwise not be considered for inlining
9486 by the compiler are investigated.  To those functions, a different
9487 (more restrictive) limit compared to functions declared inline can
9488 be applied.
9489 The default value is 40.
9491 @item inline-min-speedup
9492 When estimated performance improvement of caller + callee runtime exceeds this
9493 threshold (in precent), the function can be inlined regardless the limit on
9494 @option{--param max-inline-insns-single} and @option{--param
9495 max-inline-insns-auto}.
9497 @item large-function-insns
9498 The limit specifying really large functions.  For functions larger than this
9499 limit after inlining, inlining is constrained by
9500 @option{--param large-function-growth}.  This parameter is useful primarily
9501 to avoid extreme compilation time caused by non-linear algorithms used by the
9502 back end.
9503 The default value is 2700.
9505 @item large-function-growth
9506 Specifies maximal growth of large function caused by inlining in percents.
9507 The default value is 100 which limits large function growth to 2.0 times
9508 the original size.
9510 @item large-unit-insns
9511 The limit specifying large translation unit.  Growth caused by inlining of
9512 units larger than this limit is limited by @option{--param inline-unit-growth}.
9513 For small units this might be too tight.
9514 For example, consider a unit consisting of function A
9515 that is inline and B that just calls A three times.  If B is small relative to
9516 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9517 large units consisting of small inlineable functions, however, the overall unit
9518 growth limit is needed to avoid exponential explosion of code size.  Thus for
9519 smaller units, the size is increased to @option{--param large-unit-insns}
9520 before applying @option{--param inline-unit-growth}.  The default is 10000.
9522 @item inline-unit-growth
9523 Specifies maximal overall growth of the compilation unit caused by inlining.
9524 The default value is 30 which limits unit growth to 1.3 times the original
9525 size. Cold functions (either marked cold via an attribibute or by profile
9526 feedback) are not accounted into the unit size.
9528 @item ipcp-unit-growth
9529 Specifies maximal overall growth of the compilation unit caused by
9530 interprocedural constant propagation.  The default value is 10 which limits
9531 unit growth to 1.1 times the original size.
9533 @item large-stack-frame
9534 The limit specifying large stack frames.  While inlining the algorithm is trying
9535 to not grow past this limit too much.  The default value is 256 bytes.
9537 @item large-stack-frame-growth
9538 Specifies maximal growth of large stack frames caused by inlining in percents.
9539 The default value is 1000 which limits large stack frame growth to 11 times
9540 the original size.
9542 @item max-inline-insns-recursive
9543 @itemx max-inline-insns-recursive-auto
9544 Specifies the maximum number of instructions an out-of-line copy of a
9545 self-recursive inline
9546 function can grow into by performing recursive inlining.
9548 For functions declared inline, @option{--param max-inline-insns-recursive} is
9549 taken into account.  For functions not declared inline, recursive inlining
9550 happens only when @option{-finline-functions} (included in @option{-O3}) is
9551 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9552 default value is 450.
9554 @item max-inline-recursive-depth
9555 @itemx max-inline-recursive-depth-auto
9556 Specifies the maximum recursion depth used for recursive inlining.
9558 For functions declared inline, @option{--param max-inline-recursive-depth} is
9559 taken into account.  For functions not declared inline, recursive inlining
9560 happens only when @option{-finline-functions} (included in @option{-O3}) is
9561 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9562 default value is 8.
9564 @item min-inline-recursive-probability
9565 Recursive inlining is profitable only for function having deep recursion
9566 in average and can hurt for function having little recursion depth by
9567 increasing the prologue size or complexity of function body to other
9568 optimizers.
9570 When profile feedback is available (see @option{-fprofile-generate}) the actual
9571 recursion depth can be guessed from probability that function recurses via a
9572 given call expression.  This parameter limits inlining only to call expressions
9573 whose probability exceeds the given threshold (in percents).
9574 The default value is 10.
9576 @item early-inlining-insns
9577 Specify growth that the early inliner can make.  In effect it increases
9578 the amount of inlining for code having a large abstraction penalty.
9579 The default value is 10.
9581 @item max-early-inliner-iterations
9582 @itemx max-early-inliner-iterations
9583 Limit of iterations of the early inliner.  This basically bounds
9584 the number of nested indirect calls the early inliner can resolve.
9585 Deeper chains are still handled by late inlining.
9587 @item comdat-sharing-probability
9588 @itemx comdat-sharing-probability
9589 Probability (in percent) that C++ inline function with comdat visibility
9590 are shared across multiple compilation units.  The default value is 20.
9592 @item min-vect-loop-bound
9593 The minimum number of iterations under which loops are not vectorized
9594 when @option{-ftree-vectorize} is used.  The number of iterations after
9595 vectorization needs to be greater than the value specified by this option
9596 to allow vectorization.  The default value is 0.
9598 @item gcse-cost-distance-ratio
9599 Scaling factor in calculation of maximum distance an expression
9600 can be moved by GCSE optimizations.  This is currently supported only in the
9601 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9602 is with simple expressions, i.e., the expressions that have cost
9603 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9604 hoisting of simple expressions.  The default value is 10.
9606 @item gcse-unrestricted-cost
9607 Cost, roughly measured as the cost of a single typical machine
9608 instruction, at which GCSE optimizations do not constrain
9609 the distance an expression can travel.  This is currently
9610 supported only in the code hoisting pass.  The lesser the cost,
9611 the more aggressive code hoisting is.  Specifying 0 
9612 allows all expressions to travel unrestricted distances.
9613 The default value is 3.
9615 @item max-hoist-depth
9616 The depth of search in the dominator tree for expressions to hoist.
9617 This is used to avoid quadratic behavior in hoisting algorithm.
9618 The value of 0 does not limit on the search, but may slow down compilation
9619 of huge functions.  The default value is 30.
9621 @item max-tail-merge-comparisons
9622 The maximum amount of similar bbs to compare a bb with.  This is used to
9623 avoid quadratic behavior in tree tail merging.  The default value is 10.
9625 @item max-tail-merge-iterations
9626 The maximum amount of iterations of the pass over the function.  This is used to
9627 limit compilation time in tree tail merging.  The default value is 2.
9629 @item max-unrolled-insns
9630 The maximum number of instructions that a loop may have to be unrolled.
9631 If a loop is unrolled, this parameter also determines how many times
9632 the loop code is unrolled.
9634 @item max-average-unrolled-insns
9635 The maximum number of instructions biased by probabilities of their execution
9636 that a loop may have to be unrolled.  If a loop is unrolled,
9637 this parameter also determines how many times the loop code is unrolled.
9639 @item max-unroll-times
9640 The maximum number of unrollings of a single loop.
9642 @item max-peeled-insns
9643 The maximum number of instructions that a loop may have to be peeled.
9644 If a loop is peeled, this parameter also determines how many times
9645 the loop code is peeled.
9647 @item max-peel-times
9648 The maximum number of peelings of a single loop.
9650 @item max-peel-branches
9651 The maximum number of branches on the hot path through the peeled sequence.
9653 @item max-completely-peeled-insns
9654 The maximum number of insns of a completely peeled loop.
9656 @item max-completely-peel-times
9657 The maximum number of iterations of a loop to be suitable for complete peeling.
9659 @item max-completely-peel-loop-nest-depth
9660 The maximum depth of a loop nest suitable for complete peeling.
9662 @item max-unswitch-insns
9663 The maximum number of insns of an unswitched loop.
9665 @item max-unswitch-level
9666 The maximum number of branches unswitched in a single loop.
9668 @item lim-expensive
9669 The minimum cost of an expensive expression in the loop invariant motion.
9671 @item iv-consider-all-candidates-bound
9672 Bound on number of candidates for induction variables, below which
9673 all candidates are considered for each use in induction variable
9674 optimizations.  If there are more candidates than this,
9675 only the most relevant ones are considered to avoid quadratic time complexity.
9677 @item iv-max-considered-uses
9678 The induction variable optimizations give up on loops that contain more
9679 induction variable uses.
9681 @item iv-always-prune-cand-set-bound
9682 If the number of candidates in the set is smaller than this value,
9683 always try to remove unnecessary ivs from the set
9684 when adding a new one.
9686 @item scev-max-expr-size
9687 Bound on size of expressions used in the scalar evolutions analyzer.
9688 Large expressions slow the analyzer.
9690 @item scev-max-expr-complexity
9691 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9692 Complex expressions slow the analyzer.
9694 @item omega-max-vars
9695 The maximum number of variables in an Omega constraint system.
9696 The default value is 128.
9698 @item omega-max-geqs
9699 The maximum number of inequalities in an Omega constraint system.
9700 The default value is 256.
9702 @item omega-max-eqs
9703 The maximum number of equalities in an Omega constraint system.
9704 The default value is 128.
9706 @item omega-max-wild-cards
9707 The maximum number of wildcard variables that the Omega solver is
9708 able to insert.  The default value is 18.
9710 @item omega-hash-table-size
9711 The size of the hash table in the Omega solver.  The default value is
9712 550.
9714 @item omega-max-keys
9715 The maximal number of keys used by the Omega solver.  The default
9716 value is 500.
9718 @item omega-eliminate-redundant-constraints
9719 When set to 1, use expensive methods to eliminate all redundant
9720 constraints.  The default value is 0.
9722 @item vect-max-version-for-alignment-checks
9723 The maximum number of run-time checks that can be performed when
9724 doing loop versioning for alignment in the vectorizer. 
9726 @item vect-max-version-for-alias-checks
9727 The maximum number of run-time checks that can be performed when
9728 doing loop versioning for alias in the vectorizer. 
9730 @item vect-max-peeling-for-alignment
9731 The maximum number of loop peels to enhance access alignment
9732 for vectorizer. Value -1 means 'no limit'.
9734 @item max-iterations-to-track
9735 The maximum number of iterations of a loop the brute-force algorithm
9736 for analysis of the number of iterations of the loop tries to evaluate.
9738 @item hot-bb-count-ws-permille
9739 A basic block profile count is considered hot if it contributes to 
9740 the given permillage (i.e. 0...1000) of the entire profiled execution.
9742 @item hot-bb-frequency-fraction
9743 Select fraction of the entry block frequency of executions of basic block in
9744 function given basic block needs to have to be considered hot.
9746 @item max-predicted-iterations
9747 The maximum number of loop iterations we predict statically.  This is useful
9748 in cases where a function contains a single loop with known bound and
9749 another loop with unknown bound.
9750 The known number of iterations is predicted correctly, while
9751 the unknown number of iterations average to roughly 10.  This means that the
9752 loop without bounds appears artificially cold relative to the other one.
9754 @item builtin-expect-probability
9755 Control the probability of the expression having the specified value. This
9756 parameter takes a percentage (i.e. 0 ... 100) as input.
9757 The default probability of 90 is obtained empirically.
9759 @item align-threshold
9761 Select fraction of the maximal frequency of executions of a basic block in
9762 a function to align the basic block.
9764 @item align-loop-iterations
9766 A loop expected to iterate at least the selected number of iterations is
9767 aligned.
9769 @item tracer-dynamic-coverage
9770 @itemx tracer-dynamic-coverage-feedback
9772 This value is used to limit superblock formation once the given percentage of
9773 executed instructions is covered.  This limits unnecessary code size
9774 expansion.
9776 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9777 feedback is available.  The real profiles (as opposed to statically estimated
9778 ones) are much less balanced allowing the threshold to be larger value.
9780 @item tracer-max-code-growth
9781 Stop tail duplication once code growth has reached given percentage.  This is
9782 a rather artificial limit, as most of the duplicates are eliminated later in
9783 cross jumping, so it may be set to much higher values than is the desired code
9784 growth.
9786 @item tracer-min-branch-ratio
9788 Stop reverse growth when the reverse probability of best edge is less than this
9789 threshold (in percent).
9791 @item tracer-min-branch-ratio
9792 @itemx tracer-min-branch-ratio-feedback
9794 Stop forward growth if the best edge has probability lower than this
9795 threshold.
9797 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9798 compilation for profile feedback and one for compilation without.  The value
9799 for compilation with profile feedback needs to be more conservative (higher) in
9800 order to make tracer effective.
9802 @item max-cse-path-length
9804 The maximum number of basic blocks on path that CSE considers.
9805 The default is 10.
9807 @item max-cse-insns
9808 The maximum number of instructions CSE processes before flushing.
9809 The default is 1000.
9811 @item ggc-min-expand
9813 GCC uses a garbage collector to manage its own memory allocation.  This
9814 parameter specifies the minimum percentage by which the garbage
9815 collector's heap should be allowed to expand between collections.
9816 Tuning this may improve compilation speed; it has no effect on code
9817 generation.
9819 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9820 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9821 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9822 GCC is not able to calculate RAM on a particular platform, the lower
9823 bound of 30% is used.  Setting this parameter and
9824 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9825 every opportunity.  This is extremely slow, but can be useful for
9826 debugging.
9828 @item ggc-min-heapsize
9830 Minimum size of the garbage collector's heap before it begins bothering
9831 to collect garbage.  The first collection occurs after the heap expands
9832 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9833 tuning this may improve compilation speed, and has no effect on code
9834 generation.
9836 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9837 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9838 with a lower bound of 4096 (four megabytes) and an upper bound of
9839 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9840 particular platform, the lower bound is used.  Setting this parameter
9841 very large effectively disables garbage collection.  Setting this
9842 parameter and @option{ggc-min-expand} to zero causes a full collection
9843 to occur at every opportunity.
9845 @item max-reload-search-insns
9846 The maximum number of instruction reload should look backward for equivalent
9847 register.  Increasing values mean more aggressive optimization, making the
9848 compilation time increase with probably slightly better performance.
9849 The default value is 100.
9851 @item max-cselib-memory-locations
9852 The maximum number of memory locations cselib should take into account.
9853 Increasing values mean more aggressive optimization, making the compilation time
9854 increase with probably slightly better performance.  The default value is 500.
9856 @item reorder-blocks-duplicate
9857 @itemx reorder-blocks-duplicate-feedback
9859 Used by the basic block reordering pass to decide whether to use unconditional
9860 branch or duplicate the code on its destination.  Code is duplicated when its
9861 estimated size is smaller than this value multiplied by the estimated size of
9862 unconditional jump in the hot spots of the program.
9864 The @option{reorder-block-duplicate-feedback} is used only when profile
9865 feedback is available.  It may be set to higher values than
9866 @option{reorder-block-duplicate} since information about the hot spots is more
9867 accurate.
9869 @item max-sched-ready-insns
9870 The maximum number of instructions ready to be issued the scheduler should
9871 consider at any given time during the first scheduling pass.  Increasing
9872 values mean more thorough searches, making the compilation time increase
9873 with probably little benefit.  The default value is 100.
9875 @item max-sched-region-blocks
9876 The maximum number of blocks in a region to be considered for
9877 interblock scheduling.  The default value is 10.
9879 @item max-pipeline-region-blocks
9880 The maximum number of blocks in a region to be considered for
9881 pipelining in the selective scheduler.  The default value is 15.
9883 @item max-sched-region-insns
9884 The maximum number of insns in a region to be considered for
9885 interblock scheduling.  The default value is 100.
9887 @item max-pipeline-region-insns
9888 The maximum number of insns in a region to be considered for
9889 pipelining in the selective scheduler.  The default value is 200.
9891 @item min-spec-prob
9892 The minimum probability (in percents) of reaching a source block
9893 for interblock speculative scheduling.  The default value is 40.
9895 @item max-sched-extend-regions-iters
9896 The maximum number of iterations through CFG to extend regions.
9897 A value of 0 (the default) disables region extensions.
9899 @item max-sched-insn-conflict-delay
9900 The maximum conflict delay for an insn to be considered for speculative motion.
9901 The default value is 3.
9903 @item sched-spec-prob-cutoff
9904 The minimal probability of speculation success (in percents), so that
9905 speculative insns are scheduled.
9906 The default value is 40.
9908 @item sched-spec-state-edge-prob-cutoff
9909 The minimum probability an edge must have for the scheduler to save its
9910 state across it.
9911 The default value is 10.
9913 @item sched-mem-true-dep-cost
9914 Minimal distance (in CPU cycles) between store and load targeting same
9915 memory locations.  The default value is 1.
9917 @item selsched-max-lookahead
9918 The maximum size of the lookahead window of selective scheduling.  It is a
9919 depth of search for available instructions.
9920 The default value is 50.
9922 @item selsched-max-sched-times
9923 The maximum number of times that an instruction is scheduled during
9924 selective scheduling.  This is the limit on the number of iterations
9925 through which the instruction may be pipelined.  The default value is 2.
9927 @item selsched-max-insns-to-rename
9928 The maximum number of best instructions in the ready list that are considered
9929 for renaming in the selective scheduler.  The default value is 2.
9931 @item sms-min-sc
9932 The minimum value of stage count that swing modulo scheduler
9933 generates.  The default value is 2.
9935 @item max-last-value-rtl
9936 The maximum size measured as number of RTLs that can be recorded in an expression
9937 in combiner for a pseudo register as last known value of that register.  The default
9938 is 10000.
9940 @item integer-share-limit
9941 Small integer constants can use a shared data structure, reducing the
9942 compiler's memory usage and increasing its speed.  This sets the maximum
9943 value of a shared integer constant.  The default value is 256.
9945 @item ssp-buffer-size
9946 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9947 protection when @option{-fstack-protection} is used.
9949 @item min-size-for-stack-sharing
9950 The minimum size of variables taking part in stack slot sharing when not
9951 optimizing. The default value is 32.
9953 @item max-jump-thread-duplication-stmts
9954 Maximum number of statements allowed in a block that needs to be
9955 duplicated when threading jumps.
9957 @item max-fields-for-field-sensitive
9958 Maximum number of fields in a structure treated in
9959 a field sensitive manner during pointer analysis.  The default is zero
9960 for @option{-O0} and @option{-O1},
9961 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9963 @item prefetch-latency
9964 Estimate on average number of instructions that are executed before
9965 prefetch finishes.  The distance prefetched ahead is proportional
9966 to this constant.  Increasing this number may also lead to less
9967 streams being prefetched (see @option{simultaneous-prefetches}).
9969 @item simultaneous-prefetches
9970 Maximum number of prefetches that can run at the same time.
9972 @item l1-cache-line-size
9973 The size of cache line in L1 cache, in bytes.
9975 @item l1-cache-size
9976 The size of L1 cache, in kilobytes.
9978 @item l2-cache-size
9979 The size of L2 cache, in kilobytes.
9981 @item min-insn-to-prefetch-ratio
9982 The minimum ratio between the number of instructions and the
9983 number of prefetches to enable prefetching in a loop.
9985 @item prefetch-min-insn-to-mem-ratio
9986 The minimum ratio between the number of instructions and the
9987 number of memory references to enable prefetching in a loop.
9989 @item use-canonical-types
9990 Whether the compiler should use the ``canonical'' type system.  By
9991 default, this should always be 1, which uses a more efficient internal
9992 mechanism for comparing types in C++ and Objective-C++.  However, if
9993 bugs in the canonical type system are causing compilation failures,
9994 set this value to 0 to disable canonical types.
9996 @item switch-conversion-max-branch-ratio
9997 Switch initialization conversion refuses to create arrays that are
9998 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9999 branches in the switch.
10001 @item max-partial-antic-length
10002 Maximum length of the partial antic set computed during the tree
10003 partial redundancy elimination optimization (@option{-ftree-pre}) when
10004 optimizing at @option{-O3} and above.  For some sorts of source code
10005 the enhanced partial redundancy elimination optimization can run away,
10006 consuming all of the memory available on the host machine.  This
10007 parameter sets a limit on the length of the sets that are computed,
10008 which prevents the runaway behavior.  Setting a value of 0 for
10009 this parameter allows an unlimited set length.
10011 @item sccvn-max-scc-size
10012 Maximum size of a strongly connected component (SCC) during SCCVN
10013 processing.  If this limit is hit, SCCVN processing for the whole
10014 function is not done and optimizations depending on it are
10015 disabled.  The default maximum SCC size is 10000.
10017 @item sccvn-max-alias-queries-per-access
10018 Maximum number of alias-oracle queries we perform when looking for
10019 redundancies for loads and stores.  If this limit is hit the search
10020 is aborted and the load or store is not considered redundant.  The
10021 number of queries is algorithmically limited to the number of
10022 stores on all paths from the load to the function entry.
10023 The default maxmimum number of queries is 1000.
10025 @item ira-max-loops-num
10026 IRA uses regional register allocation by default.  If a function
10027 contains more loops than the number given by this parameter, only at most
10028 the given number of the most frequently-executed loops form regions
10029 for regional register allocation.  The default value of the
10030 parameter is 100.
10032 @item ira-max-conflict-table-size 
10033 Although IRA uses a sophisticated algorithm to compress the conflict
10034 table, the table can still require excessive amounts of memory for
10035 huge functions.  If the conflict table for a function could be more
10036 than the size in MB given by this parameter, the register allocator
10037 instead uses a faster, simpler, and lower-quality
10038 algorithm that does not require building a pseudo-register conflict table.  
10039 The default value of the parameter is 2000.
10041 @item ira-loop-reserved-regs
10042 IRA can be used to evaluate more accurate register pressure in loops
10043 for decisions to move loop invariants (see @option{-O3}).  The number
10044 of available registers reserved for some other purposes is given
10045 by this parameter.  The default value of the parameter is 2, which is
10046 the minimal number of registers needed by typical instructions.
10047 This value is the best found from numerous experiments.
10049 @item loop-invariant-max-bbs-in-loop
10050 Loop invariant motion can be very expensive, both in compilation time and
10051 in amount of needed compile-time memory, with very large loops.  Loops
10052 with more basic blocks than this parameter won't have loop invariant
10053 motion optimization performed on them.  The default value of the
10054 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10056 @item loop-max-datarefs-for-datadeps
10057 Building data dapendencies is expensive for very large loops.  This
10058 parameter limits the number of data references in loops that are
10059 considered for data dependence analysis.  These large loops are no
10060 handled by the optimizations using loop data dependencies.
10061 The default value is 1000.
10063 @item max-vartrack-size
10064 Sets a maximum number of hash table slots to use during variable
10065 tracking dataflow analysis of any function.  If this limit is exceeded
10066 with variable tracking at assignments enabled, analysis for that
10067 function is retried without it, after removing all debug insns from
10068 the function.  If the limit is exceeded even without debug insns, var
10069 tracking analysis is completely disabled for the function.  Setting
10070 the parameter to zero makes it unlimited.
10072 @item max-vartrack-expr-depth
10073 Sets a maximum number of recursion levels when attempting to map
10074 variable names or debug temporaries to value expressions.  This trades
10075 compilation time for more complete debug information.  If this is set too
10076 low, value expressions that are available and could be represented in
10077 debug information may end up not being used; setting this higher may
10078 enable the compiler to find more complex debug expressions, but compile
10079 time and memory use may grow.  The default is 12.
10081 @item min-nondebug-insn-uid
10082 Use uids starting at this parameter for nondebug insns.  The range below
10083 the parameter is reserved exclusively for debug insns created by
10084 @option{-fvar-tracking-assignments}, but debug insns may get
10085 (non-overlapping) uids above it if the reserved range is exhausted.
10087 @item ipa-sra-ptr-growth-factor
10088 IPA-SRA replaces a pointer to an aggregate with one or more new
10089 parameters only when their cumulative size is less or equal to
10090 @option{ipa-sra-ptr-growth-factor} times the size of the original
10091 pointer parameter.
10093 @item tm-max-aggregate-size
10094 When making copies of thread-local variables in a transaction, this
10095 parameter specifies the size in bytes after which variables are
10096 saved with the logging functions as opposed to save/restore code
10097 sequence pairs.  This option only applies when using
10098 @option{-fgnu-tm}.
10100 @item graphite-max-nb-scop-params
10101 To avoid exponential effects in the Graphite loop transforms, the
10102 number of parameters in a Static Control Part (SCoP) is bounded.  The
10103 default value is 10 parameters.  A variable whose value is unknown at
10104 compilation time and defined outside a SCoP is a parameter of the SCoP.
10106 @item graphite-max-bbs-per-function
10107 To avoid exponential effects in the detection of SCoPs, the size of
10108 the functions analyzed by Graphite is bounded.  The default value is
10109 100 basic blocks.
10111 @item loop-block-tile-size
10112 Loop blocking or strip mining transforms, enabled with
10113 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10114 loop in the loop nest by a given number of iterations.  The strip
10115 length can be changed using the @option{loop-block-tile-size}
10116 parameter.  The default value is 51 iterations.
10118 @item ipa-cp-value-list-size
10119 IPA-CP attempts to track all possible values and types passed to a function's
10120 parameter in order to propagate them and perform devirtualization.
10121 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10122 stores per one formal parameter of a function.
10124 @item ipa-cp-eval-threshold
10125 IPA-CP calculates its own score of cloning profitability heuristics
10126 and performs those cloning opportunities with scores that exceed
10127 @option{ipa-cp-eval-threshold}.
10129 @item ipa-max-agg-items
10130 IPA-CP is also capable to propagate a number of scalar values passed
10131 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10132 number of such values per one parameter.
10134 @item ipa-cp-loop-hint-bonus
10135 When IPA-CP determines that a cloning candidate would make the number
10136 of iterations of a loop known, it adds a bonus of
10137 @option{ipa-cp-loop-hint-bonus} bonus to the profitability score of
10138 the candidate.
10140 @item ipa-cp-array-index-hint-bonus
10141 When IPA-CP determines that a cloning candidate would make the index of
10142 an array access known, it adds a bonus of
10143 @option{ipa-cp-array-index-hint-bonus} bonus to the profitability
10144 score of the candidate.
10146 @item ipa-max-aa-steps
10147 During its analysis of function bodies, IPA-CP employs alias analysis
10148 in order to track values pointed to by function parameters.  In order
10149 not spend too much time analyzing huge functions, it will give up and
10150 consider all memory clobbered after examining
10151 @option{ipa-max-aa-steps} statements modifying memory.
10153 @item lto-partitions
10154 Specify desired number of partitions produced during WHOPR compilation.
10155 The number of partitions should exceed the number of CPUs used for compilation.
10156 The default value is 32.
10158 @item lto-minpartition
10159 Size of minimal partition for WHOPR (in estimated instructions).
10160 This prevents expenses of splitting very small programs into too many
10161 partitions.
10163 @item cxx-max-namespaces-for-diagnostic-help
10164 The maximum number of namespaces to consult for suggestions when C++
10165 name lookup fails for an identifier.  The default is 1000.
10167 @item sink-frequency-threshold
10168 The maximum relative execution frequency (in percents) of the target block
10169 relative to a statement's original block to allow statement sinking of a
10170 statement.  Larger numbers result in more aggressive statement sinking.
10171 The default value is 75.  A small positive adjustment is applied for
10172 statements with memory operands as those are even more profitable so sink.
10174 @item max-stores-to-sink
10175 The maximum number of conditional stores paires that can be sunk.  Set to 0
10176 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10177 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10179 @item allow-load-data-races
10180 Allow optimizers to introduce new data races on loads.
10181 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10182 unless implicitly set by the @option{-fmemory-model=} option.
10184 @item allow-store-data-races
10185 Allow optimizers to introduce new data races on stores.
10186 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10187 unless implicitly set by the @option{-fmemory-model=} option.
10189 @item allow-packed-load-data-races
10190 Allow optimizers to introduce new data races on packed data loads.
10191 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10192 unless implicitly set by the @option{-fmemory-model=} option.
10194 @item allow-packed-store-data-races
10195 Allow optimizers to introduce new data races on packed data stores.
10196 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10197 unless implicitly set by the @option{-fmemory-model=} option.
10199 @item case-values-threshold
10200 The smallest number of different values for which it is best to use a
10201 jump-table instead of a tree of conditional branches.  If the value is
10202 0, use the default for the machine.  The default is 0.
10204 @item tree-reassoc-width
10205 Set the maximum number of instructions executed in parallel in
10206 reassociated tree. This parameter overrides target dependent
10207 heuristics used by default if has non zero value.
10209 @item sched-pressure-algorithm
10210 Choose between the two available implementations of
10211 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10212 and is the more likely to prevent instructions from being reordered.
10213 Algorithm 2 was designed to be a compromise between the relatively
10214 conservative approach taken by algorithm 1 and the rather aggressive
10215 approach taken by the default scheduler.  It relies more heavily on
10216 having a regular register file and accurate register pressure classes.
10217 See @file{haifa-sched.c} in the GCC sources for more details.
10219 The default choice depends on the target.
10221 @item max-slsr-cand-scan
10222 Set the maximum number of existing candidates that will be considered when
10223 seeking a basis for a new straight-line strength reduction candidate.
10225 @item asan-globals
10226 Enable buffer overflow detection for global objects.  This kind
10227 of protection is enabled by default if you are using
10228 @option{-fsanitize=address} option.
10229 To disable global objects protection use @option{--param asan-globals=0}.
10231 @item asan-stack
10232 Enable buffer overflow detection for stack objects.  This kind of
10233 protection is enabled by default when using@option{-fsanitize=address}.
10234 To disable stack protection use @option{--param asan-stack=0} option.
10236 @item asan-instrument-reads
10237 Enable buffer overflow detection for memory reads.  This kind of
10238 protection is enabled by default when using @option{-fsanitize=address}.
10239 To disable memory reads protection use
10240 @option{--param asan-instrument-reads=0}.
10242 @item asan-instrument-writes
10243 Enable buffer overflow detection for memory writes.  This kind of
10244 protection is enabled by default when using @option{-fsanitize=address}.
10245 To disable memory writes protection use
10246 @option{--param asan-instrument-writes=0} option.
10248 @item asan-memintrin
10249 Enable detection for built-in functions.  This kind of protection
10250 is enabled by default when using @option{-fsanitize=address}.
10251 To disable built-in functions protection use
10252 @option{--param asan-memintrin=0}.
10254 @item asan-use-after-return
10255 Enable detection of use-after-return.  This kind of protection
10256 is enabled by default when using @option{-fsanitize=address} option.
10257 To disable use-after-return detection use 
10258 @option{--param asan-use-after-return=0}.
10260 @item asan-instrumentation-with-call-threshold
10261 Once number of memory accesses  in function becomes greater
10262 or equal than this number, use callbacks instead of
10263 generating inline code.  E.g. to disable inline code use
10264 @option{--param asan-instrumentation-with-call-threshold=0}.
10266 @end table
10267 @end table
10269 @node Preprocessor Options
10270 @section Options Controlling the Preprocessor
10271 @cindex preprocessor options
10272 @cindex options, preprocessor
10274 These options control the C preprocessor, which is run on each C source
10275 file before actual compilation.
10277 If you use the @option{-E} option, nothing is done except preprocessing.
10278 Some of these options make sense only together with @option{-E} because
10279 they cause the preprocessor output to be unsuitable for actual
10280 compilation.
10282 @table @gcctabopt
10283 @item -Wp,@var{option}
10284 @opindex Wp
10285 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10286 and pass @var{option} directly through to the preprocessor.  If
10287 @var{option} contains commas, it is split into multiple options at the
10288 commas.  However, many options are modified, translated or interpreted
10289 by the compiler driver before being passed to the preprocessor, and
10290 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10291 interface is undocumented and subject to change, so whenever possible
10292 you should avoid using @option{-Wp} and let the driver handle the
10293 options instead.
10295 @item -Xpreprocessor @var{option}
10296 @opindex Xpreprocessor
10297 Pass @var{option} as an option to the preprocessor.  You can use this to
10298 supply system-specific preprocessor options that GCC does not 
10299 recognize.
10301 If you want to pass an option that takes an argument, you must use
10302 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10304 @item -no-integrated-cpp
10305 @opindex no-integrated-cpp
10306 Perform preprocessing as a separate pass before compilation.
10307 By default, GCC performs preprocessing as an integrated part of
10308 input tokenization and parsing.
10309 If this option is provided, the appropriate language front end
10310 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10311 and Objective-C, respectively) is instead invoked twice,
10312 once for preprocessing only and once for actual compilation
10313 of the preprocessed input.
10314 This option may be useful in conjunction with the @option{-B} or
10315 @option{-wrapper} options to specify an alternate preprocessor or
10316 perform additional processing of the program source between
10317 normal preprocessing and compilation.
10318 @end table
10320 @include cppopts.texi
10322 @node Assembler Options
10323 @section Passing Options to the Assembler
10325 @c prevent bad page break with this line
10326 You can pass options to the assembler.
10328 @table @gcctabopt
10329 @item -Wa,@var{option}
10330 @opindex Wa
10331 Pass @var{option} as an option to the assembler.  If @var{option}
10332 contains commas, it is split into multiple options at the commas.
10334 @item -Xassembler @var{option}
10335 @opindex Xassembler
10336 Pass @var{option} as an option to the assembler.  You can use this to
10337 supply system-specific assembler options that GCC does not
10338 recognize.
10340 If you want to pass an option that takes an argument, you must use
10341 @option{-Xassembler} twice, once for the option and once for the argument.
10343 @end table
10345 @node Link Options
10346 @section Options for Linking
10347 @cindex link options
10348 @cindex options, linking
10350 These options come into play when the compiler links object files into
10351 an executable output file.  They are meaningless if the compiler is
10352 not doing a link step.
10354 @table @gcctabopt
10355 @cindex file names
10356 @item @var{object-file-name}
10357 A file name that does not end in a special recognized suffix is
10358 considered to name an object file or library.  (Object files are
10359 distinguished from libraries by the linker according to the file
10360 contents.)  If linking is done, these object files are used as input
10361 to the linker.
10363 @item -c
10364 @itemx -S
10365 @itemx -E
10366 @opindex c
10367 @opindex S
10368 @opindex E
10369 If any of these options is used, then the linker is not run, and
10370 object file names should not be used as arguments.  @xref{Overall
10371 Options}.
10373 @cindex Libraries
10374 @item -l@var{library}
10375 @itemx -l @var{library}
10376 @opindex l
10377 Search the library named @var{library} when linking.  (The second
10378 alternative with the library as a separate argument is only for
10379 POSIX compliance and is not recommended.)
10381 It makes a difference where in the command you write this option; the
10382 linker searches and processes libraries and object files in the order they
10383 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10384 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10385 to functions in @samp{z}, those functions may not be loaded.
10387 The linker searches a standard list of directories for the library,
10388 which is actually a file named @file{lib@var{library}.a}.  The linker
10389 then uses this file as if it had been specified precisely by name.
10391 The directories searched include several standard system directories
10392 plus any that you specify with @option{-L}.
10394 Normally the files found this way are library files---archive files
10395 whose members are object files.  The linker handles an archive file by
10396 scanning through it for members which define symbols that have so far
10397 been referenced but not defined.  But if the file that is found is an
10398 ordinary object file, it is linked in the usual fashion.  The only
10399 difference between using an @option{-l} option and specifying a file name
10400 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10401 and searches several directories.
10403 @item -lobjc
10404 @opindex lobjc
10405 You need this special case of the @option{-l} option in order to
10406 link an Objective-C or Objective-C++ program.
10408 @item -nostartfiles
10409 @opindex nostartfiles
10410 Do not use the standard system startup files when linking.
10411 The standard system libraries are used normally, unless @option{-nostdlib}
10412 or @option{-nodefaultlibs} is used.
10414 @item -nodefaultlibs
10415 @opindex nodefaultlibs
10416 Do not use the standard system libraries when linking.
10417 Only the libraries you specify are passed to the linker, and options
10418 specifying linkage of the system libraries, such as @code{-static-libgcc}
10419 or @code{-shared-libgcc}, are ignored.  
10420 The standard startup files are used normally, unless @option{-nostartfiles}
10421 is used.  
10423 The compiler may generate calls to @code{memcmp},
10424 @code{memset}, @code{memcpy} and @code{memmove}.
10425 These entries are usually resolved by entries in
10426 libc.  These entry points should be supplied through some other
10427 mechanism when this option is specified.
10429 @item -nostdlib
10430 @opindex nostdlib
10431 Do not use the standard system startup files or libraries when linking.
10432 No startup files and only the libraries you specify are passed to
10433 the linker, and options specifying linkage of the system libraries, such as
10434 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10436 The compiler may generate calls to @code{memcmp}, @code{memset},
10437 @code{memcpy} and @code{memmove}.
10438 These entries are usually resolved by entries in
10439 libc.  These entry points should be supplied through some other
10440 mechanism when this option is specified.
10442 @cindex @option{-lgcc}, use with @option{-nostdlib}
10443 @cindex @option{-nostdlib} and unresolved references
10444 @cindex unresolved references and @option{-nostdlib}
10445 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10446 @cindex @option{-nodefaultlibs} and unresolved references
10447 @cindex unresolved references and @option{-nodefaultlibs}
10448 One of the standard libraries bypassed by @option{-nostdlib} and
10449 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10450 which GCC uses to overcome shortcomings of particular machines, or special
10451 needs for some languages.
10452 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10453 Collection (GCC) Internals},
10454 for more discussion of @file{libgcc.a}.)
10455 In most cases, you need @file{libgcc.a} even when you want to avoid
10456 other standard libraries.  In other words, when you specify @option{-nostdlib}
10457 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10458 This ensures that you have no unresolved references to internal GCC
10459 library subroutines.
10460 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10461 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10462 GNU Compiler Collection (GCC) Internals}.)
10464 @item -pie
10465 @opindex pie
10466 Produce a position independent executable on targets that support it.
10467 For predictable results, you must also specify the same set of options
10468 used for compilation (@option{-fpie}, @option{-fPIE},
10469 or model suboptions) when you specify this linker option.
10471 @item -rdynamic
10472 @opindex rdynamic
10473 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10474 that support it. This instructs the linker to add all symbols, not
10475 only used ones, to the dynamic symbol table. This option is needed
10476 for some uses of @code{dlopen} or to allow obtaining backtraces
10477 from within a program.
10479 @item -s
10480 @opindex s
10481 Remove all symbol table and relocation information from the executable.
10483 @item -static
10484 @opindex static
10485 On systems that support dynamic linking, this prevents linking with the shared
10486 libraries.  On other systems, this option has no effect.
10488 @item -shared
10489 @opindex shared
10490 Produce a shared object which can then be linked with other objects to
10491 form an executable.  Not all systems support this option.  For predictable
10492 results, you must also specify the same set of options used for compilation
10493 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10494 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10495 needs to build supplementary stub code for constructors to work.  On
10496 multi-libbed systems, @samp{gcc -shared} must select the correct support
10497 libraries to link against.  Failing to supply the correct flags may lead
10498 to subtle defects.  Supplying them in cases where they are not necessary
10499 is innocuous.}
10501 @item -shared-libgcc
10502 @itemx -static-libgcc
10503 @opindex shared-libgcc
10504 @opindex static-libgcc
10505 On systems that provide @file{libgcc} as a shared library, these options
10506 force the use of either the shared or static version, respectively.
10507 If no shared version of @file{libgcc} was built when the compiler was
10508 configured, these options have no effect.
10510 There are several situations in which an application should use the
10511 shared @file{libgcc} instead of the static version.  The most common
10512 of these is when the application wishes to throw and catch exceptions
10513 across different shared libraries.  In that case, each of the libraries
10514 as well as the application itself should use the shared @file{libgcc}.
10516 Therefore, the G++ and GCJ drivers automatically add
10517 @option{-shared-libgcc} whenever you build a shared library or a main
10518 executable, because C++ and Java programs typically use exceptions, so
10519 this is the right thing to do.
10521 If, instead, you use the GCC driver to create shared libraries, you may
10522 find that they are not always linked with the shared @file{libgcc}.
10523 If GCC finds, at its configuration time, that you have a non-GNU linker
10524 or a GNU linker that does not support option @option{--eh-frame-hdr},
10525 it links the shared version of @file{libgcc} into shared libraries
10526 by default.  Otherwise, it takes advantage of the linker and optimizes
10527 away the linking with the shared version of @file{libgcc}, linking with
10528 the static version of libgcc by default.  This allows exceptions to
10529 propagate through such shared libraries, without incurring relocation
10530 costs at library load time.
10532 However, if a library or main executable is supposed to throw or catch
10533 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10534 for the languages used in the program, or using the option
10535 @option{-shared-libgcc}, such that it is linked with the shared
10536 @file{libgcc}.
10538 @item -static-libasan
10539 @opindex static-libasan
10540 When the @option{-fsanitize=address} option is used to link a program,
10541 the GCC driver automatically links against @option{libasan}.  If
10542 @file{libasan} is available as a shared library, and the @option{-static}
10543 option is not used, then this links against the shared version of
10544 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10545 driver to link @file{libasan} statically, without necessarily linking
10546 other libraries statically.
10548 @item -static-libtsan
10549 @opindex static-libtsan
10550 When the @option{-fsanitize=thread} option is used to link a program,
10551 the GCC driver automatically links against @option{libtsan}.  If
10552 @file{libtsan} is available as a shared library, and the @option{-static}
10553 option is not used, then this links against the shared version of
10554 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10555 driver to link @file{libtsan} statically, without necessarily linking
10556 other libraries statically.
10558 @item -static-liblsan
10559 @opindex static-liblsan
10560 When the @option{-fsanitize=leak} option is used to link a program,
10561 the GCC driver automatically links against @option{liblsan}.  If
10562 @file{liblsan} is available as a shared library, and the @option{-static}
10563 option is not used, then this links against the shared version of
10564 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10565 driver to link @file{liblsan} statically, without necessarily linking
10566 other libraries statically.
10568 @item -static-libubsan
10569 @opindex static-libubsan
10570 When the @option{-fsanitize=undefined} option is used to link a program,
10571 the GCC driver automatically links against @option{libubsan}.  If
10572 @file{libubsan} is available as a shared library, and the @option{-static}
10573 option is not used, then this links against the shared version of
10574 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10575 driver to link @file{libubsan} statically, without necessarily linking
10576 other libraries statically.
10578 @item -static-libstdc++
10579 @opindex static-libstdc++
10580 When the @command{g++} program is used to link a C++ program, it
10581 normally automatically links against @option{libstdc++}.  If
10582 @file{libstdc++} is available as a shared library, and the
10583 @option{-static} option is not used, then this links against the
10584 shared version of @file{libstdc++}.  That is normally fine.  However, it
10585 is sometimes useful to freeze the version of @file{libstdc++} used by
10586 the program without going all the way to a fully static link.  The
10587 @option{-static-libstdc++} option directs the @command{g++} driver to
10588 link @file{libstdc++} statically, without necessarily linking other
10589 libraries statically.
10591 @item -symbolic
10592 @opindex symbolic
10593 Bind references to global symbols when building a shared object.  Warn
10594 about any unresolved references (unless overridden by the link editor
10595 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10596 this option.
10598 @item -T @var{script}
10599 @opindex T
10600 @cindex linker script
10601 Use @var{script} as the linker script.  This option is supported by most
10602 systems using the GNU linker.  On some targets, such as bare-board
10603 targets without an operating system, the @option{-T} option may be required
10604 when linking to avoid references to undefined symbols.
10606 @item -Xlinker @var{option}
10607 @opindex Xlinker
10608 Pass @var{option} as an option to the linker.  You can use this to
10609 supply system-specific linker options that GCC does not recognize.
10611 If you want to pass an option that takes a separate argument, you must use
10612 @option{-Xlinker} twice, once for the option and once for the argument.
10613 For example, to pass @option{-assert definitions}, you must write
10614 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10615 @option{-Xlinker "-assert definitions"}, because this passes the entire
10616 string as a single argument, which is not what the linker expects.
10618 When using the GNU linker, it is usually more convenient to pass
10619 arguments to linker options using the @option{@var{option}=@var{value}}
10620 syntax than as separate arguments.  For example, you can specify
10621 @option{-Xlinker -Map=output.map} rather than
10622 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10623 this syntax for command-line options.
10625 @item -Wl,@var{option}
10626 @opindex Wl
10627 Pass @var{option} as an option to the linker.  If @var{option} contains
10628 commas, it is split into multiple options at the commas.  You can use this
10629 syntax to pass an argument to the option.
10630 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10631 linker.  When using the GNU linker, you can also get the same effect with
10632 @option{-Wl,-Map=output.map}.
10634 @item -u @var{symbol}
10635 @opindex u
10636 Pretend the symbol @var{symbol} is undefined, to force linking of
10637 library modules to define it.  You can use @option{-u} multiple times with
10638 different symbols to force loading of additional library modules.
10639 @end table
10641 @node Directory Options
10642 @section Options for Directory Search
10643 @cindex directory options
10644 @cindex options, directory search
10645 @cindex search path
10647 These options specify directories to search for header files, for
10648 libraries and for parts of the compiler:
10650 @table @gcctabopt
10651 @item -I@var{dir}
10652 @opindex I
10653 Add the directory @var{dir} to the head of the list of directories to be
10654 searched for header files.  This can be used to override a system header
10655 file, substituting your own version, since these directories are
10656 searched before the system header file directories.  However, you should
10657 not use this option to add directories that contain vendor-supplied
10658 system header files (use @option{-isystem} for that).  If you use more than
10659 one @option{-I} option, the directories are scanned in left-to-right
10660 order; the standard system directories come after.
10662 If a standard system include directory, or a directory specified with
10663 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10664 option is ignored.  The directory is still searched but as a
10665 system directory at its normal position in the system include chain.
10666 This is to ensure that GCC's procedure to fix buggy system headers and
10667 the ordering for the @code{include_next} directive are not inadvertently changed.
10668 If you really need to change the search order for system directories,
10669 use the @option{-nostdinc} and/or @option{-isystem} options.
10671 @item -iplugindir=@var{dir}
10672 @opindex iplugindir=
10673 Set the directory to search for plugins that are passed
10674 by @option{-fplugin=@var{name}} instead of
10675 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10676 to be used by the user, but only passed by the driver.
10678 @item -iquote@var{dir}
10679 @opindex iquote
10680 Add the directory @var{dir} to the head of the list of directories to
10681 be searched for header files only for the case of @samp{#include
10682 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10683 otherwise just like @option{-I}.
10685 @item -L@var{dir}
10686 @opindex L
10687 Add directory @var{dir} to the list of directories to be searched
10688 for @option{-l}.
10690 @item -B@var{prefix}
10691 @opindex B
10692 This option specifies where to find the executables, libraries,
10693 include files, and data files of the compiler itself.
10695 The compiler driver program runs one or more of the subprograms
10696 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10697 @var{prefix} as a prefix for each program it tries to run, both with and
10698 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10700 For each subprogram to be run, the compiler driver first tries the
10701 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10702 is not specified, the driver tries two standard prefixes, 
10703 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10704 those results in a file name that is found, the unmodified program
10705 name is searched for using the directories specified in your
10706 @env{PATH} environment variable.
10708 The compiler checks to see if the path provided by the @option{-B}
10709 refers to a directory, and if necessary it adds a directory
10710 separator character at the end of the path.
10712 @option{-B} prefixes that effectively specify directory names also apply
10713 to libraries in the linker, because the compiler translates these
10714 options into @option{-L} options for the linker.  They also apply to
10715 include files in the preprocessor, because the compiler translates these
10716 options into @option{-isystem} options for the preprocessor.  In this case,
10717 the compiler appends @samp{include} to the prefix.
10719 The runtime support file @file{libgcc.a} can also be searched for using
10720 the @option{-B} prefix, if needed.  If it is not found there, the two
10721 standard prefixes above are tried, and that is all.  The file is left
10722 out of the link if it is not found by those means.
10724 Another way to specify a prefix much like the @option{-B} prefix is to use
10725 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10726 Variables}.
10728 As a special kludge, if the path provided by @option{-B} is
10729 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10730 9, then it is replaced by @file{[dir/]include}.  This is to help
10731 with boot-strapping the compiler.
10733 @item -specs=@var{file}
10734 @opindex specs
10735 Process @var{file} after the compiler reads in the standard @file{specs}
10736 file, in order to override the defaults which the @command{gcc} driver
10737 program uses when determining what switches to pass to @command{cc1},
10738 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10739 @option{-specs=@var{file}} can be specified on the command line, and they
10740 are processed in order, from left to right.
10742 @item --sysroot=@var{dir}
10743 @opindex sysroot
10744 Use @var{dir} as the logical root directory for headers and libraries.
10745 For example, if the compiler normally searches for headers in
10746 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10747 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10749 If you use both this option and the @option{-isysroot} option, then
10750 the @option{--sysroot} option applies to libraries, but the
10751 @option{-isysroot} option applies to header files.
10753 The GNU linker (beginning with version 2.16) has the necessary support
10754 for this option.  If your linker does not support this option, the
10755 header file aspect of @option{--sysroot} still works, but the
10756 library aspect does not.
10758 @item --no-sysroot-suffix
10759 @opindex no-sysroot-suffix
10760 For some targets, a suffix is added to the root directory specified
10761 with @option{--sysroot}, depending on the other options used, so that
10762 headers may for example be found in
10763 @file{@var{dir}/@var{suffix}/usr/include} instead of
10764 @file{@var{dir}/usr/include}.  This option disables the addition of
10765 such a suffix.
10767 @item -I-
10768 @opindex I-
10769 This option has been deprecated.  Please use @option{-iquote} instead for
10770 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10771 Any directories you specify with @option{-I} options before the @option{-I-}
10772 option are searched only for the case of @samp{#include "@var{file}"};
10773 they are not searched for @samp{#include <@var{file}>}.
10775 If additional directories are specified with @option{-I} options after
10776 the @option{-I-}, these directories are searched for all @samp{#include}
10777 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10778 this way.)
10780 In addition, the @option{-I-} option inhibits the use of the current
10781 directory (where the current input file came from) as the first search
10782 directory for @samp{#include "@var{file}"}.  There is no way to
10783 override this effect of @option{-I-}.  With @option{-I.} you can specify
10784 searching the directory that is current when the compiler is
10785 invoked.  That is not exactly the same as what the preprocessor does
10786 by default, but it is often satisfactory.
10788 @option{-I-} does not inhibit the use of the standard system directories
10789 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10790 independent.
10791 @end table
10793 @c man end
10795 @node Spec Files
10796 @section Specifying subprocesses and the switches to pass to them
10797 @cindex Spec Files
10799 @command{gcc} is a driver program.  It performs its job by invoking a
10800 sequence of other programs to do the work of compiling, assembling and
10801 linking.  GCC interprets its command-line parameters and uses these to
10802 deduce which programs it should invoke, and which command-line options
10803 it ought to place on their command lines.  This behavior is controlled
10804 by @dfn{spec strings}.  In most cases there is one spec string for each
10805 program that GCC can invoke, but a few programs have multiple spec
10806 strings to control their behavior.  The spec strings built into GCC can
10807 be overridden by using the @option{-specs=} command-line switch to specify
10808 a spec file.
10810 @dfn{Spec files} are plaintext files that are used to construct spec
10811 strings.  They consist of a sequence of directives separated by blank
10812 lines.  The type of directive is determined by the first non-whitespace
10813 character on the line, which can be one of the following:
10815 @table @code
10816 @item %@var{command}
10817 Issues a @var{command} to the spec file processor.  The commands that can
10818 appear here are:
10820 @table @code
10821 @item %include <@var{file}>
10822 @cindex @code{%include}
10823 Search for @var{file} and insert its text at the current point in the
10824 specs file.
10826 @item %include_noerr <@var{file}>
10827 @cindex @code{%include_noerr}
10828 Just like @samp{%include}, but do not generate an error message if the include
10829 file cannot be found.
10831 @item %rename @var{old_name} @var{new_name}
10832 @cindex @code{%rename}
10833 Rename the spec string @var{old_name} to @var{new_name}.
10835 @end table
10837 @item *[@var{spec_name}]:
10838 This tells the compiler to create, override or delete the named spec
10839 string.  All lines after this directive up to the next directive or
10840 blank line are considered to be the text for the spec string.  If this
10841 results in an empty string then the spec is deleted.  (Or, if the
10842 spec did not exist, then nothing happens.)  Otherwise, if the spec
10843 does not currently exist a new spec is created.  If the spec does
10844 exist then its contents are overridden by the text of this
10845 directive, unless the first character of that text is the @samp{+}
10846 character, in which case the text is appended to the spec.
10848 @item [@var{suffix}]:
10849 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10850 and up to the next directive or blank line are considered to make up the
10851 spec string for the indicated suffix.  When the compiler encounters an
10852 input file with the named suffix, it processes the spec string in
10853 order to work out how to compile that file.  For example:
10855 @smallexample
10856 .ZZ:
10857 z-compile -input %i
10858 @end smallexample
10860 This says that any input file whose name ends in @samp{.ZZ} should be
10861 passed to the program @samp{z-compile}, which should be invoked with the
10862 command-line switch @option{-input} and with the result of performing the
10863 @samp{%i} substitution.  (See below.)
10865 As an alternative to providing a spec string, the text following a
10866 suffix directive can be one of the following:
10868 @table @code
10869 @item @@@var{language}
10870 This says that the suffix is an alias for a known @var{language}.  This is
10871 similar to using the @option{-x} command-line switch to GCC to specify a
10872 language explicitly.  For example:
10874 @smallexample
10875 .ZZ:
10876 @@c++
10877 @end smallexample
10879 Says that .ZZ files are, in fact, C++ source files.
10881 @item #@var{name}
10882 This causes an error messages saying:
10884 @smallexample
10885 @var{name} compiler not installed on this system.
10886 @end smallexample
10887 @end table
10889 GCC already has an extensive list of suffixes built into it.
10890 This directive adds an entry to the end of the list of suffixes, but
10891 since the list is searched from the end backwards, it is effectively
10892 possible to override earlier entries using this technique.
10894 @end table
10896 GCC has the following spec strings built into it.  Spec files can
10897 override these strings or create their own.  Note that individual
10898 targets can also add their own spec strings to this list.
10900 @smallexample
10901 asm          Options to pass to the assembler
10902 asm_final    Options to pass to the assembler post-processor
10903 cpp          Options to pass to the C preprocessor
10904 cc1          Options to pass to the C compiler
10905 cc1plus      Options to pass to the C++ compiler
10906 endfile      Object files to include at the end of the link
10907 link         Options to pass to the linker
10908 lib          Libraries to include on the command line to the linker
10909 libgcc       Decides which GCC support library to pass to the linker
10910 linker       Sets the name of the linker
10911 predefines   Defines to be passed to the C preprocessor
10912 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10913              by default
10914 startfile    Object files to include at the start of the link
10915 @end smallexample
10917 Here is a small example of a spec file:
10919 @smallexample
10920 %rename lib                 old_lib
10922 *lib:
10923 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10924 @end smallexample
10926 This example renames the spec called @samp{lib} to @samp{old_lib} and
10927 then overrides the previous definition of @samp{lib} with a new one.
10928 The new definition adds in some extra command-line options before
10929 including the text of the old definition.
10931 @dfn{Spec strings} are a list of command-line options to be passed to their
10932 corresponding program.  In addition, the spec strings can contain
10933 @samp{%}-prefixed sequences to substitute variable text or to
10934 conditionally insert text into the command line.  Using these constructs
10935 it is possible to generate quite complex command lines.
10937 Here is a table of all defined @samp{%}-sequences for spec
10938 strings.  Note that spaces are not generated automatically around the
10939 results of expanding these sequences.  Therefore you can concatenate them
10940 together or combine them with constant text in a single argument.
10942 @table @code
10943 @item %%
10944 Substitute one @samp{%} into the program name or argument.
10946 @item %i
10947 Substitute the name of the input file being processed.
10949 @item %b
10950 Substitute the basename of the input file being processed.
10951 This is the substring up to (and not including) the last period
10952 and not including the directory.
10954 @item %B
10955 This is the same as @samp{%b}, but include the file suffix (text after
10956 the last period).
10958 @item %d
10959 Marks the argument containing or following the @samp{%d} as a
10960 temporary file name, so that that file is deleted if GCC exits
10961 successfully.  Unlike @samp{%g}, this contributes no text to the
10962 argument.
10964 @item %g@var{suffix}
10965 Substitute a file name that has suffix @var{suffix} and is chosen
10966 once per compilation, and mark the argument in the same way as
10967 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10968 name is now chosen in a way that is hard to predict even when previously
10969 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10970 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10971 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10972 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10973 was simply substituted with a file name chosen once per compilation,
10974 without regard to any appended suffix (which was therefore treated
10975 just like ordinary text), making such attacks more likely to succeed.
10977 @item %u@var{suffix}
10978 Like @samp{%g}, but generates a new temporary file name
10979 each time it appears instead of once per compilation.
10981 @item %U@var{suffix}
10982 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10983 new one if there is no such last file name.  In the absence of any
10984 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10985 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10986 involves the generation of two distinct file names, one
10987 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10988 simply substituted with a file name chosen for the previous @samp{%u},
10989 without regard to any appended suffix.
10991 @item %j@var{suffix}
10992 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10993 writable, and if @option{-save-temps} is not used; 
10994 otherwise, substitute the name
10995 of a temporary file, just like @samp{%u}.  This temporary file is not
10996 meant for communication between processes, but rather as a junk
10997 disposal mechanism.
10999 @item %|@var{suffix}
11000 @itemx %m@var{suffix}
11001 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11002 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11003 all.  These are the two most common ways to instruct a program that it
11004 should read from standard input or write to standard output.  If you
11005 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11006 construct: see for example @file{f/lang-specs.h}.
11008 @item %.@var{SUFFIX}
11009 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11010 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11011 terminated by the next space or %.
11013 @item %w
11014 Marks the argument containing or following the @samp{%w} as the
11015 designated output file of this compilation.  This puts the argument
11016 into the sequence of arguments that @samp{%o} substitutes.
11018 @item %o
11019 Substitutes the names of all the output files, with spaces
11020 automatically placed around them.  You should write spaces
11021 around the @samp{%o} as well or the results are undefined.
11022 @samp{%o} is for use in the specs for running the linker.
11023 Input files whose names have no recognized suffix are not compiled
11024 at all, but they are included among the output files, so they are
11025 linked.
11027 @item %O
11028 Substitutes the suffix for object files.  Note that this is
11029 handled specially when it immediately follows @samp{%g, %u, or %U},
11030 because of the need for those to form complete file names.  The
11031 handling is such that @samp{%O} is treated exactly as if it had already
11032 been substituted, except that @samp{%g, %u, and %U} do not currently
11033 support additional @var{suffix} characters following @samp{%O} as they do
11034 following, for example, @samp{.o}.
11036 @item %p
11037 Substitutes the standard macro predefinitions for the
11038 current target machine.  Use this when running @code{cpp}.
11040 @item %P
11041 Like @samp{%p}, but puts @samp{__} before and after the name of each
11042 predefined macro, except for macros that start with @samp{__} or with
11043 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11046 @item %I
11047 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11048 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11049 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11050 and @option{-imultilib} as necessary.
11052 @item %s
11053 Current argument is the name of a library or startup file of some sort.
11054 Search for that file in a standard list of directories and substitute
11055 the full name found.  The current working directory is included in the
11056 list of directories scanned.
11058 @item %T
11059 Current argument is the name of a linker script.  Search for that file
11060 in the current list of directories to scan for libraries. If the file
11061 is located insert a @option{--script} option into the command line
11062 followed by the full path name found.  If the file is not found then
11063 generate an error message.  Note: the current working directory is not
11064 searched.
11066 @item %e@var{str}
11067 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11068 Use this when inconsistent options are detected.
11070 @item %(@var{name})
11071 Substitute the contents of spec string @var{name} at this point.
11073 @item %x@{@var{option}@}
11074 Accumulate an option for @samp{%X}.
11076 @item %X
11077 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11078 spec string.
11080 @item %Y
11081 Output the accumulated assembler options specified by @option{-Wa}.
11083 @item %Z
11084 Output the accumulated preprocessor options specified by @option{-Wp}.
11086 @item %a
11087 Process the @code{asm} spec.  This is used to compute the
11088 switches to be passed to the assembler.
11090 @item %A
11091 Process the @code{asm_final} spec.  This is a spec string for
11092 passing switches to an assembler post-processor, if such a program is
11093 needed.
11095 @item %l
11096 Process the @code{link} spec.  This is the spec for computing the
11097 command line passed to the linker.  Typically it makes use of the
11098 @samp{%L %G %S %D and %E} sequences.
11100 @item %D
11101 Dump out a @option{-L} option for each directory that GCC believes might
11102 contain startup files.  If the target supports multilibs then the
11103 current multilib directory is prepended to each of these paths.
11105 @item %L
11106 Process the @code{lib} spec.  This is a spec string for deciding which
11107 libraries are included on the command line to the linker.
11109 @item %G
11110 Process the @code{libgcc} spec.  This is a spec string for deciding
11111 which GCC support library is included on the command line to the linker.
11113 @item %S
11114 Process the @code{startfile} spec.  This is a spec for deciding which
11115 object files are the first ones passed to the linker.  Typically
11116 this might be a file named @file{crt0.o}.
11118 @item %E
11119 Process the @code{endfile} spec.  This is a spec string that specifies
11120 the last object files that are passed to the linker.
11122 @item %C
11123 Process the @code{cpp} spec.  This is used to construct the arguments
11124 to be passed to the C preprocessor.
11126 @item %1
11127 Process the @code{cc1} spec.  This is used to construct the options to be
11128 passed to the actual C compiler (@samp{cc1}).
11130 @item %2
11131 Process the @code{cc1plus} spec.  This is used to construct the options to be
11132 passed to the actual C++ compiler (@samp{cc1plus}).
11134 @item %*
11135 Substitute the variable part of a matched option.  See below.
11136 Note that each comma in the substituted string is replaced by
11137 a single space.
11139 @item %<@code{S}
11140 Remove all occurrences of @code{-S} from the command line.  Note---this
11141 command is position dependent.  @samp{%} commands in the spec string
11142 before this one see @code{-S}, @samp{%} commands in the spec string
11143 after this one do not.
11145 @item %:@var{function}(@var{args})
11146 Call the named function @var{function}, passing it @var{args}.
11147 @var{args} is first processed as a nested spec string, then split
11148 into an argument vector in the usual fashion.  The function returns
11149 a string which is processed as if it had appeared literally as part
11150 of the current spec.
11152 The following built-in spec functions are provided:
11154 @table @code
11155 @item @code{getenv}
11156 The @code{getenv} spec function takes two arguments: an environment
11157 variable name and a string.  If the environment variable is not
11158 defined, a fatal error is issued.  Otherwise, the return value is the
11159 value of the environment variable concatenated with the string.  For
11160 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11162 @smallexample
11163 %:getenv(TOPDIR /include)
11164 @end smallexample
11166 expands to @file{/path/to/top/include}.
11168 @item @code{if-exists}
11169 The @code{if-exists} spec function takes one argument, an absolute
11170 pathname to a file.  If the file exists, @code{if-exists} returns the
11171 pathname.  Here is a small example of its usage:
11173 @smallexample
11174 *startfile:
11175 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11176 @end smallexample
11178 @item @code{if-exists-else}
11179 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11180 spec function, except that it takes two arguments.  The first argument is
11181 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11182 returns the pathname.  If it does not exist, it returns the second argument.
11183 This way, @code{if-exists-else} can be used to select one file or another,
11184 based on the existence of the first.  Here is a small example of its usage:
11186 @smallexample
11187 *startfile:
11188 crt0%O%s %:if-exists(crti%O%s) \
11189 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11190 @end smallexample
11192 @item @code{replace-outfile}
11193 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11194 first argument in the outfiles array and replaces it with the second argument.  Here
11195 is a small example of its usage:
11197 @smallexample
11198 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11199 @end smallexample
11201 @item @code{remove-outfile}
11202 The @code{remove-outfile} spec function takes one argument.  It looks for the
11203 first argument in the outfiles array and removes it.  Here is a small example
11204 its usage:
11206 @smallexample
11207 %:remove-outfile(-lm)
11208 @end smallexample
11210 @item @code{pass-through-libs}
11211 The @code{pass-through-libs} spec function takes any number of arguments.  It
11212 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11213 assumes are the names of linker input library archive files) and returns a
11214 result containing all the found arguments each prepended by
11215 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11216 intended to be passed to the LTO linker plugin.
11218 @smallexample
11219 %:pass-through-libs(%G %L %G)
11220 @end smallexample
11222 @item @code{print-asm-header}
11223 The @code{print-asm-header} function takes no arguments and simply
11224 prints a banner like:
11226 @smallexample
11227 Assembler options
11228 =================
11230 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11231 @end smallexample
11233 It is used to separate compiler options from assembler options
11234 in the @option{--target-help} output.
11235 @end table
11237 @item %@{@code{S}@}
11238 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11239 If that switch is not specified, this substitutes nothing.  Note that
11240 the leading dash is omitted when specifying this option, and it is
11241 automatically inserted if the substitution is performed.  Thus the spec
11242 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11243 and outputs the command-line option @option{-foo}.
11245 @item %W@{@code{S}@}
11246 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11247 deleted on failure.
11249 @item %@{@code{S}*@}
11250 Substitutes all the switches specified to GCC whose names start
11251 with @code{-S}, but which also take an argument.  This is used for
11252 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11253 GCC considers @option{-o foo} as being
11254 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11255 text, including the space.  Thus two arguments are generated.
11257 @item %@{@code{S}*&@code{T}*@}
11258 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11259 (the order of @code{S} and @code{T} in the spec is not significant).
11260 There can be any number of ampersand-separated variables; for each the
11261 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11263 @item %@{@code{S}:@code{X}@}
11264 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11266 @item %@{!@code{S}:@code{X}@}
11267 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11269 @item %@{@code{S}*:@code{X}@}
11270 Substitutes @code{X} if one or more switches whose names start with
11271 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11272 once, no matter how many such switches appeared.  However, if @code{%*}
11273 appears somewhere in @code{X}, then @code{X} is substituted once
11274 for each matching switch, with the @code{%*} replaced by the part of
11275 that switch matching the @code{*}.
11277 If @code{%*} appears as the last part of a spec sequence then a space
11278 will be added after the end of the last substitution.  If there is more
11279 text in the sequence however then a space will not be generated.  This
11280 allows the @code{%*} substitution to be used as part of a larger
11281 string.  For example, a spec string like this:
11283 @smallexample
11284 %@{mcu=*:--script=%*/memory.ld@}
11285 @end smallexample
11287 when matching an option like @code{-mcu=newchip} will produce:
11289 @smallexample
11290 --script=newchip/memory.ld
11291 @end smallexample
11293 @item %@{.@code{S}:@code{X}@}
11294 Substitutes @code{X}, if processing a file with suffix @code{S}.
11296 @item %@{!.@code{S}:@code{X}@}
11297 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11299 @item %@{,@code{S}:@code{X}@}
11300 Substitutes @code{X}, if processing a file for language @code{S}.
11302 @item %@{!,@code{S}:@code{X}@}
11303 Substitutes @code{X}, if not processing a file for language @code{S}.
11305 @item %@{@code{S}|@code{P}:@code{X}@}
11306 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11307 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11308 @code{*} sequences as well, although they have a stronger binding than
11309 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11310 alternatives must be starred, and only the first matching alternative
11311 is substituted.
11313 For example, a spec string like this:
11315 @smallexample
11316 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11317 @end smallexample
11319 @noindent
11320 outputs the following command-line options from the following input
11321 command-line options:
11323 @smallexample
11324 fred.c        -foo -baz
11325 jim.d         -bar -boggle
11326 -d fred.c     -foo -baz -boggle
11327 -d jim.d      -bar -baz -boggle
11328 @end smallexample
11330 @item %@{S:X; T:Y; :D@}
11332 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11333 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11334 be as many clauses as you need.  This may be combined with @code{.},
11335 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11338 @end table
11340 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11341 construct may contain other nested @samp{%} constructs or spaces, or
11342 even newlines.  They are processed as usual, as described above.
11343 Trailing white space in @code{X} is ignored.  White space may also
11344 appear anywhere on the left side of the colon in these constructs,
11345 except between @code{.} or @code{*} and the corresponding word.
11347 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11348 handled specifically in these constructs.  If another value of
11349 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11350 @option{-W} switch is found later in the command line, the earlier
11351 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11352 just one letter, which passes all matching options.
11354 The character @samp{|} at the beginning of the predicate text is used to
11355 indicate that a command should be piped to the following command, but
11356 only if @option{-pipe} is specified.
11358 It is built into GCC which switches take arguments and which do not.
11359 (You might think it would be useful to generalize this to allow each
11360 compiler's spec to say which switches take arguments.  But this cannot
11361 be done in a consistent fashion.  GCC cannot even decide which input
11362 files have been specified without knowing which switches take arguments,
11363 and it must know which input files to compile in order to tell which
11364 compilers to run).
11366 GCC also knows implicitly that arguments starting in @option{-l} are to be
11367 treated as compiler output files, and passed to the linker in their
11368 proper position among the other output files.
11370 @c man begin OPTIONS
11372 @node Target Options
11373 @section Specifying Target Machine and Compiler Version
11374 @cindex target options
11375 @cindex cross compiling
11376 @cindex specifying machine version
11377 @cindex specifying compiler version and target machine
11378 @cindex compiler version, specifying
11379 @cindex target machine, specifying
11381 The usual way to run GCC is to run the executable called @command{gcc}, or
11382 @command{@var{machine}-gcc} when cross-compiling, or
11383 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11384 one that was installed last.
11386 @node Submodel Options
11387 @section Hardware Models and Configurations
11388 @cindex submodel options
11389 @cindex specifying hardware config
11390 @cindex hardware models and configurations, specifying
11391 @cindex machine dependent options
11393 Each target machine types can have its own
11394 special options, starting with @samp{-m}, to choose among various
11395 hardware models or configurations---for example, 68010 vs 68020,
11396 floating coprocessor or none.  A single installed version of the
11397 compiler can compile for any model or configuration, according to the
11398 options specified.
11400 Some configurations of the compiler also support additional special
11401 options, usually for compatibility with other compilers on the same
11402 platform.
11404 @c This list is ordered alphanumerically by subsection name.
11405 @c It should be the same order and spelling as these options are listed
11406 @c in Machine Dependent Options
11408 @menu
11409 * AArch64 Options::
11410 * Adapteva Epiphany Options::
11411 * ARC Options::
11412 * ARM Options::
11413 * AVR Options::
11414 * Blackfin Options::
11415 * C6X Options::
11416 * CRIS Options::
11417 * CR16 Options::
11418 * Darwin Options::
11419 * DEC Alpha Options::
11420 * FR30 Options::
11421 * FRV Options::
11422 * GNU/Linux Options::
11423 * H8/300 Options::
11424 * HPPA Options::
11425 * i386 and x86-64 Options::
11426 * i386 and x86-64 Windows Options::
11427 * IA-64 Options::
11428 * LM32 Options::
11429 * M32C Options::
11430 * M32R/D Options::
11431 * M680x0 Options::
11432 * MCore Options::
11433 * MeP Options::
11434 * MicroBlaze Options::
11435 * MIPS Options::
11436 * MMIX Options::
11437 * MN10300 Options::
11438 * Moxie Options::
11439 * MSP430 Options::
11440 * NDS32 Options::
11441 * Nios II Options::
11442 * PDP-11 Options::
11443 * picoChip Options::
11444 * PowerPC Options::
11445 * RL78 Options::
11446 * RS/6000 and PowerPC Options::
11447 * RX Options::
11448 * S/390 and zSeries Options::
11449 * Score Options::
11450 * SH Options::
11451 * Solaris 2 Options::
11452 * SPARC Options::
11453 * SPU Options::
11454 * System V Options::
11455 * TILE-Gx Options::
11456 * TILEPro Options::
11457 * V850 Options::
11458 * VAX Options::
11459 * VMS Options::
11460 * VxWorks Options::
11461 * x86-64 Options::
11462 * Xstormy16 Options::
11463 * Xtensa Options::
11464 * zSeries Options::
11465 @end menu
11467 @node AArch64 Options
11468 @subsection AArch64 Options
11469 @cindex AArch64 Options
11471 These options are defined for AArch64 implementations:
11473 @table @gcctabopt
11475 @item -mabi=@var{name}
11476 @opindex mabi
11477 Generate code for the specified data model.  Permissible values
11478 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11479 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11480 but long int and pointer are 64-bit.
11482 The default depends on the specific target configuration.  Note that
11483 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11484 entire program with the same ABI, and link with a compatible set of libraries.
11486 @item -mbig-endian
11487 @opindex mbig-endian
11488 Generate big-endian code.  This is the default when GCC is configured for an
11489 @samp{aarch64_be-*-*} target.
11491 @item -mgeneral-regs-only
11492 @opindex mgeneral-regs-only
11493 Generate code which uses only the general registers.
11495 @item -mlittle-endian
11496 @opindex mlittle-endian
11497 Generate little-endian code.  This is the default when GCC is configured for an
11498 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11500 @item -mcmodel=tiny
11501 @opindex mcmodel=tiny
11502 Generate code for the tiny code model.  The program and its statically defined
11503 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11504 be statically or dynamically linked.  This model is not fully implemented and
11505 mostly treated as @samp{small}.
11507 @item -mcmodel=small
11508 @opindex mcmodel=small
11509 Generate code for the small code model.  The program and its statically defined
11510 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11511 be statically or dynamically linked.  This is the default code model.
11513 @item -mcmodel=large
11514 @opindex mcmodel=large
11515 Generate code for the large code model.  This makes no assumptions about
11516 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11517 statically linked only.
11519 @item -mstrict-align
11520 @opindex mstrict-align
11521 Do not assume that unaligned memory references will be handled by the system.
11523 @item -momit-leaf-frame-pointer
11524 @itemx -mno-omit-leaf-frame-pointer
11525 @opindex momit-leaf-frame-pointer
11526 @opindex mno-omit-leaf-frame-pointer
11527 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11528 default.
11530 @item -mtls-dialect=desc
11531 @opindex mtls-dialect=desc
11532 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11533 of TLS variables.  This is the default.
11535 @item -mtls-dialect=traditional
11536 @opindex mtls-dialect=traditional
11537 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11538 of TLS variables.
11540 @item -march=@var{name}
11541 @opindex march
11542 Specify the name of the target architecture, optionally suffixed by one or
11543 more feature modifiers.  This option has the form
11544 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11545 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11546 values for @var{feature} are documented in the sub-section below.
11548 Where conflicting feature modifiers are specified, the right-most feature is
11549 used.
11551 GCC uses this name to determine what kind of instructions it can emit when
11552 generating assembly code.
11554 Where @option{-march} is specified without either of @option{-mtune}
11555 or @option{-mcpu} also being specified, the code will be tuned to perform
11556 well across a range of target processors implementing the target
11557 architecture.
11559 @item -mtune=@var{name}
11560 @opindex mtune
11561 Specify the name of the target processor for which GCC should tune the
11562 performance of the code.  Permissible values for this option are:
11563 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}.
11565 Additionally, this option can specify that GCC should tune the performance
11566 of the code for a big.LITTLE system.  The only permissible value is
11567 @samp{cortex-a57.cortex-a53}.
11569 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
11570 are specified, the code will be tuned to perform well across a range
11571 of target processors.
11573 This option cannot be suffixed by feature modifiers.
11575 @item -mcpu=@var{name}
11576 @opindex mcpu
11577 Specify the name of the target processor, optionally suffixed by one or more
11578 feature modifiers.  This option has the form
11579 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11580 permissible values for @var{cpu} are the same as those available for
11581 @option{-mtune}.
11583 The permissible values for @var{feature} are documented in the sub-section
11584 below.
11586 Where conflicting feature modifiers are specified, the right-most feature is
11587 used.
11589 GCC uses this name to determine what kind of instructions it can emit when
11590 generating assembly code (as if by @option{-march}) and to determine
11591 the target processor for which to tune for performance (as if
11592 by @option{-mtune}).  Where this option is used in conjunction
11593 with @option{-march} or @option{-mtune}, those options take precedence
11594 over the appropriate part of this option.
11595 @end table
11597 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11598 @cindex @option{-march} feature modifiers
11599 @cindex @option{-mcpu} feature modifiers
11600 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11601 the following:
11603 @table @samp
11604 @item crc
11605 Enable CRC extension.
11606 @item crypto
11607 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11608 @item fp
11609 Enable floating-point instructions.
11610 @item simd
11611 Enable Advanced SIMD instructions.  This implies floating-point instructions
11612 are enabled.  This is the default for all current possible values for options
11613 @option{-march} and @option{-mcpu=}.
11614 @end table
11616 @node Adapteva Epiphany Options
11617 @subsection Adapteva Epiphany Options
11619 These @samp{-m} options are defined for Adapteva Epiphany:
11621 @table @gcctabopt
11622 @item -mhalf-reg-file
11623 @opindex mhalf-reg-file
11624 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11625 That allows code to run on hardware variants that lack these registers.
11627 @item -mprefer-short-insn-regs
11628 @opindex mprefer-short-insn-regs
11629 Preferrentially allocate registers that allow short instruction generation.
11630 This can result in increased instruction count, so this may either reduce or
11631 increase overall code size.
11633 @item -mbranch-cost=@var{num}
11634 @opindex mbranch-cost
11635 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11636 This cost is only a heuristic and is not guaranteed to produce
11637 consistent results across releases.
11639 @item -mcmove
11640 @opindex mcmove
11641 Enable the generation of conditional moves.
11643 @item -mnops=@var{num}
11644 @opindex mnops
11645 Emit @var{num} NOPs before every other generated instruction.
11647 @item -mno-soft-cmpsf
11648 @opindex mno-soft-cmpsf
11649 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11650 and test the flags.  This is faster than a software comparison, but can
11651 get incorrect results in the presence of NaNs, or when two different small
11652 numbers are compared such that their difference is calculated as zero.
11653 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11654 software comparisons.
11656 @item -mstack-offset=@var{num}
11657 @opindex mstack-offset
11658 Set the offset between the top of the stack and the stack pointer.
11659 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11660 can be used by leaf functions without stack allocation.
11661 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11662 Note also that this option changes the ABI; compiling a program with a
11663 different stack offset than the libraries have been compiled with
11664 generally does not work.
11665 This option can be useful if you want to evaluate if a different stack
11666 offset would give you better code, but to actually use a different stack
11667 offset to build working programs, it is recommended to configure the
11668 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11670 @item -mno-round-nearest
11671 @opindex mno-round-nearest
11672 Make the scheduler assume that the rounding mode has been set to
11673 truncating.  The default is @option{-mround-nearest}.
11675 @item -mlong-calls
11676 @opindex mlong-calls
11677 If not otherwise specified by an attribute, assume all calls might be beyond
11678 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11679 function address into a register before performing a (otherwise direct) call.
11680 This is the default.
11682 @item -mshort-calls
11683 @opindex short-calls
11684 If not otherwise specified by an attribute, assume all direct calls are
11685 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11686 for direct calls.  The default is @option{-mlong-calls}.
11688 @item -msmall16
11689 @opindex msmall16
11690 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11691 apply to function addresses for which @option{-mlong-calls} semantics
11692 are in effect.
11694 @item -mfp-mode=@var{mode}
11695 @opindex mfp-mode
11696 Set the prevailing mode of the floating-point unit.
11697 This determines the floating-point mode that is provided and expected
11698 at function call and return time.  Making this mode match the mode you
11699 predominantly need at function start can make your programs smaller and
11700 faster by avoiding unnecessary mode switches.
11702 @var{mode} can be set to one the following values:
11704 @table @samp
11705 @item caller
11706 Any mode at function entry is valid, and retained or restored when
11707 the function returns, and when it calls other functions.
11708 This mode is useful for compiling libraries or other compilation units
11709 you might want to incorporate into different programs with different
11710 prevailing FPU modes, and the convenience of being able to use a single
11711 object file outweighs the size and speed overhead for any extra
11712 mode switching that might be needed, compared with what would be needed
11713 with a more specific choice of prevailing FPU mode.
11715 @item truncate
11716 This is the mode used for floating-point calculations with
11717 truncating (i.e.@: round towards zero) rounding mode.  That includes
11718 conversion from floating point to integer.
11720 @item round-nearest
11721 This is the mode used for floating-point calculations with
11722 round-to-nearest-or-even rounding mode.
11724 @item int
11725 This is the mode used to perform integer calculations in the FPU, e.g.@:
11726 integer multiply, or integer multiply-and-accumulate.
11727 @end table
11729 The default is @option{-mfp-mode=caller}
11731 @item -mnosplit-lohi
11732 @itemx -mno-postinc
11733 @itemx -mno-postmodify
11734 @opindex mnosplit-lohi
11735 @opindex mno-postinc
11736 @opindex mno-postmodify
11737 Code generation tweaks that disable, respectively, splitting of 32-bit
11738 loads, generation of post-increment addresses, and generation of
11739 post-modify addresses.  The defaults are @option{msplit-lohi},
11740 @option{-mpost-inc}, and @option{-mpost-modify}.
11742 @item -mnovect-double
11743 @opindex mno-vect-double
11744 Change the preferred SIMD mode to SImode.  The default is
11745 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11747 @item -max-vect-align=@var{num}
11748 @opindex max-vect-align
11749 The maximum alignment for SIMD vector mode types.
11750 @var{num} may be 4 or 8.  The default is 8.
11751 Note that this is an ABI change, even though many library function
11752 interfaces are unaffected if they don't use SIMD vector modes
11753 in places that affect size and/or alignment of relevant types.
11755 @item -msplit-vecmove-early
11756 @opindex msplit-vecmove-early
11757 Split vector moves into single word moves before reload.  In theory this
11758 can give better register allocation, but so far the reverse seems to be
11759 generally the case.
11761 @item -m1reg-@var{reg}
11762 @opindex m1reg-
11763 Specify a register to hold the constant @minus{}1, which makes loading small negative
11764 constants and certain bitmasks faster.
11765 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11766 which specify use of that register as a fixed register,
11767 and @samp{none}, which means that no register is used for this
11768 purpose.  The default is @option{-m1reg-none}.
11770 @end table
11772 @node ARC Options
11773 @subsection ARC Options
11774 @cindex ARC options
11776 The following options control the architecture variant for which code
11777 is being compiled:
11779 @c architecture variants
11780 @table @gcctabopt
11782 @item -mbarrel-shifter
11783 @opindex mbarrel-shifter
11784 Generate instructions supported by barrel shifter.  This is the default
11785 unless @samp{-mcpu=ARC601} is in effect.
11787 @item -mcpu=@var{cpu}
11788 @opindex mcpu
11789 Set architecture type, register usage, and instruction scheduling
11790 parameters for @var{cpu}.  There are also shortcut alias options
11791 available for backward compatibility and convenience.  Supported
11792 values for @var{cpu} are
11794 @table @samp
11795 @opindex mA6
11796 @opindex mARC600
11797 @item ARC600
11798 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
11800 @item ARC601
11801 @opindex mARC601
11802 Compile for ARC601.  Alias: @option{-mARC601}.
11804 @item ARC700
11805 @opindex mA7
11806 @opindex mARC700
11807 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
11808 This is the default when configured with @samp{--with-cpu=arc700}@.
11809 @end table
11811 @item -mdpfp
11812 @opindex mdpfp
11813 @itemx -mdpfp-compact
11814 @opindex mdpfp-compact
11815 FPX: Generate Double Precision FPX instructions, tuned for the compact
11816 implementation.
11818 @item -mdpfp-fast
11819 @opindex mdpfp-fast
11820 FPX: Generate Double Precision FPX instructions, tuned for the fast
11821 implementation.
11823 @item -mno-dpfp-lrsr
11824 @opindex mno-dpfp-lrsr
11825 Disable LR and SR instructions from using FPX extension aux registers.
11827 @item -mea
11828 @opindex mea
11829 Generate Extended arithmetic instructions.  Currently only
11830 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
11831 supported.  This is always enabled for @samp{-mcpu=ARC700}.
11833 @item -mno-mpy
11834 @opindex mno-mpy
11835 Do not generate mpy instructions for ARC700.
11837 @item -mmul32x16
11838 @opindex mmul32x16
11839 Generate 32x16 bit multiply and mac instructions.
11841 @item -mmul64
11842 @opindex mmul64
11843 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
11845 @item -mnorm
11846 @opindex mnorm
11847 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
11848 is in effect.
11850 @item -mspfp
11851 @opindex mspfp
11852 @itemx -mspfp-compact
11853 @opindex mspfp-compact
11854 FPX: Generate Single Precision FPX instructions, tuned for the compact
11855 implementation.
11857 @item -mspfp-fast
11858 @opindex mspfp-fast
11859 FPX: Generate Single Precision FPX instructions, tuned for the fast
11860 implementation.
11862 @item -msimd
11863 @opindex msimd
11864 Enable generation of ARC SIMD instructions via target-specific
11865 builtins.  Only valid for @samp{-mcpu=ARC700}.
11867 @item -msoft-float
11868 @opindex msoft-float
11869 This option ignored; it is provided for compatibility purposes only.
11870 Software floating point code is emitted by default, and this default
11871 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
11872 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
11873 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
11875 @item -mswap
11876 @opindex mswap
11877 Generate swap instructions.
11879 @end table
11881 The following options are passed through to the assembler, and also
11882 define preprocessor macro symbols.
11884 @c Flags used by the assembler, but for which we define preprocessor
11885 @c macro symbols as well.
11886 @table @gcctabopt
11887 @item -mdsp-packa
11888 @opindex mdsp-packa
11889 Passed down to the assembler to enable the DSP Pack A extensions.
11890 Also sets the preprocessor symbol @code{__Xdsp_packa}.
11892 @item -mdvbf
11893 @opindex mdvbf
11894 Passed down to the assembler to enable the dual viterbi butterfly
11895 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
11897 @c ARC700 4.10 extension instruction
11898 @item -mlock
11899 @opindex mlock
11900 Passed down to the assembler to enable the Locked Load/Store
11901 Conditional extension.  Also sets the preprocessor symbol
11902 @code{__Xlock}.
11904 @item -mmac-d16
11905 @opindex mmac-d16
11906 Passed down to the assembler.  Also sets the preprocessor symbol
11907 @code{__Xxmac_d16}.
11909 @item -mmac-24
11910 @opindex mmac-24
11911 Passed down to the assembler.  Also sets the preprocessor symbol
11912 @code{__Xxmac_24}.
11914 @c ARC700 4.10 extension instruction
11915 @item -mrtsc
11916 @opindex mrtsc
11917 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
11918 extension instruction.  Also sets the preprocessor symbol
11919 @code{__Xrtsc}.
11921 @c ARC700 4.10 extension instruction
11922 @item -mswape
11923 @opindex mswape
11924 Passed down to the assembler to enable the swap byte ordering
11925 extension instruction.  Also sets the preprocessor symbol
11926 @code{__Xswape}.
11928 @item -mtelephony
11929 @opindex mtelephony
11930 Passed down to the assembler to enable dual and single operand
11931 instructions for telephony.  Also sets the preprocessor symbol
11932 @code{__Xtelephony}.
11934 @item -mxy
11935 @opindex mxy
11936 Passed down to the assembler to enable the XY Memory extension.  Also
11937 sets the preprocessor symbol @code{__Xxy}.
11939 @end table
11941 The following options control how the assembly code is annotated:
11943 @c Assembly annotation options
11944 @table @gcctabopt
11945 @item -misize
11946 @opindex misize
11947 Annotate assembler instructions with estimated addresses.
11949 @item -mannotate-align
11950 @opindex mannotate-align
11951 Explain what alignment considerations lead to the decision to make an
11952 instruction short or long.
11954 @end table
11956 The following options are passed through to the linker:
11958 @c options passed through to the linker
11959 @table @gcctabopt
11960 @item -marclinux
11961 @opindex marclinux
11962 Passed through to the linker, to specify use of the @code{arclinux} emulation.
11963 This option is enabled by default in tool chains built for
11964 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
11965 when profiling is not requested.
11967 @item -marclinux_prof
11968 @opindex marclinux_prof
11969 Passed through to the linker, to specify use of the
11970 @code{arclinux_prof} emulation.  This option is enabled by default in
11971 tool chains built for @w{@code{arc-linux-uclibc}} and
11972 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
11974 @end table
11976 The following options control the semantics of generated code:
11978 @c semantically relevant code generation options
11979 @table @gcctabopt
11980 @item -mepilogue-cfi
11981 @opindex mepilogue-cfi
11982 Enable generation of call frame information for epilogues.
11984 @item -mno-epilogue-cfi
11985 @opindex mno-epilogue-cfi
11986 Disable generation of call frame information for epilogues.
11988 @item -mlong-calls
11989 @opindex mlong-calls
11990 Generate call insns as register indirect calls, thus providing access
11991 to the full 32-bit address range.
11993 @item -mmedium-calls
11994 @opindex mmedium-calls
11995 Don't use less than 25 bit addressing range for calls, which is the
11996 offset available for an unconditional branch-and-link
11997 instruction.  Conditional execution of function calls is suppressed, to
11998 allow use of the 25-bit range, rather than the 21-bit range with
11999 conditional branch-and-link.  This is the default for tool chains built
12000 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12002 @item -mno-sdata
12003 @opindex mno-sdata
12004 Do not generate sdata references.  This is the default for tool chains
12005 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12006 targets.
12008 @item -mucb-mcount
12009 @opindex mucb-mcount
12010 Instrument with mcount calls as used in UCB code.  I.e. do the
12011 counting in the callee, not the caller.  By default ARC instrumentation
12012 counts in the caller.
12014 @item -mvolatile-cache
12015 @opindex mvolatile-cache
12016 Use ordinarily cached memory accesses for volatile references.  This is the
12017 default.
12019 @item -mno-volatile-cache
12020 @opindex mno-volatile-cache
12021 Enable cache bypass for volatile references.
12023 @end table
12025 The following options fine tune code generation:
12026 @c code generation tuning options
12027 @table @gcctabopt
12028 @item -malign-call
12029 @opindex malign-call
12030 Do alignment optimizations for call instructions.
12032 @item -mauto-modify-reg
12033 @opindex mauto-modify-reg
12034 Enable the use of pre/post modify with register displacement.
12036 @item -mbbit-peephole
12037 @opindex mbbit-peephole
12038 Enable bbit peephole2.
12040 @item -mno-brcc
12041 @opindex mno-brcc
12042 This option disables a target-specific pass in @file{arc_reorg} to
12043 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12044 generation driven by the combiner pass.
12046 @item -mcase-vector-pcrel
12047 @opindex mcase-vector-pcrel
12048 Use pc-relative switch case tables - this enables case table shortening.
12049 This is the default for @option{-Os}.
12051 @item -mcompact-casesi
12052 @opindex mcompact-casesi
12053 Enable compact casesi pattern.
12054 This is the default for @option{-Os}.
12056 @item -mno-cond-exec
12057 @opindex mno-cond-exec
12058 Disable ARCompact specific pass to generate conditional execution instructions.
12059 Due to delay slot scheduling and interactions between operand numbers,
12060 literal sizes, instruction lengths, and the support for conditional execution,
12061 the target-independent pass to generate conditional execution is often lacking,
12062 so the ARC port has kept a special pass around that tries to find more
12063 conditional execution generating opportunities after register allocation,
12064 branch shortening, and delay slot scheduling have been done.  This pass
12065 generally, but not always, improves performance and code size, at the cost of
12066 extra compilation time, which is why there is an option to switch it off.
12067 If you have a problem with call instructions exceeding their allowable
12068 offset range because they are conditionalized, you should consider using
12069 @option{-mmedium-calls} instead.
12071 @item -mearly-cbranchsi
12072 @opindex mearly-cbranchsi
12073 Enable pre-reload use of the cbranchsi pattern.
12075 @item -mexpand-adddi
12076 @opindex mexpand-adddi
12077 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12078 @code{add.f}, @code{adc} etc.
12080 @item -mindexed-loads
12081 @opindex mindexed-loads
12082 Enable the use of indexed loads.  This can be problematic because some
12083 optimizers will then assume the that indexed stores exist, which is not
12084 the case.
12086 @item -mlra
12087 @opindex mlra
12088 Enable Local Register Allocation.  This is still experimental for ARC,
12089 so by default the compiler uses standard reload
12090 (i.e. @samp{-mno-lra}).
12092 @item -mlra-priority-none
12093 @opindex mlra-priority-none
12094 Don't indicate any priority for target registers.
12096 @item -mlra-priority-compact
12097 @opindex mlra-priority-compact
12098 Indicate target register priority for r0..r3 / r12..r15.
12100 @item -mlra-priority-noncompact
12101 @opindex mlra-priority-noncompact
12102 Reduce target regsiter priority for r0..r3 / r12..r15.
12104 @item -mno-millicode
12105 @opindex mno-millicode
12106 When optimizing for size (using @option{-Os}), prologues and epilogues
12107 that have to save or restore a large number of registers are often
12108 shortened by using call to a special function in libgcc; this is
12109 referred to as a @emph{millicode} call.  As these calls can pose
12110 performance issues, and/or cause linking issues when linking in a
12111 nonstandard way, this option is provided to turn off millicode call
12112 generation.
12114 @item -mmixed-code
12115 @opindex mmixed-code
12116 Tweak register allocation to help 16-bit instruction generation.
12117 This generally has the effect of decreasing the average instruction size
12118 while increasing the instruction count.
12120 @item -mq-class
12121 @opindex mq-class
12122 Enable 'q' instruction alternatives.
12123 This is the default for @option{-Os}.
12125 @item -mRcq
12126 @opindex mRcq
12127 Enable Rcq constraint handling - most short code generation depends on this.
12128 This is the default.
12130 @item -mRcw
12131 @opindex mRcw
12132 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12133 This is the default.
12135 @item -msize-level=@var{level}
12136 @opindex msize-level
12137 Fine-tune size optimization with regards to instruction lengths and alignment.
12138 The recognized values for @var{level} are:
12139 @table @samp
12140 @item 0
12141 No size optimization.  This level is deprecated and treated like @samp{1}.
12143 @item 1
12144 Short instructions are used opportunistically.
12146 @item 2
12147 In addition, alignment of loops and of code after barriers are dropped.
12149 @item 3
12150 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12152 @end table
12154 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12155 the behavior when this is not set is equivalent to level @samp{1}.
12157 @item -mtune=@var{cpu}
12158 @opindex mtune
12159 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12160 by @option{-mcpu=}.
12162 Supported values for @var{cpu} are
12164 @table @samp
12165 @item ARC600
12166 Tune for ARC600 cpu.
12168 @item ARC601
12169 Tune for ARC601 cpu.
12171 @item ARC700
12172 Tune for ARC700 cpu with standard multiplier block.
12174 @item ARC700-xmac
12175 Tune for ARC700 cpu with XMAC block.
12177 @item ARC725D
12178 Tune for ARC725D cpu.
12180 @item ARC750D
12181 Tune for ARC750D cpu.
12183 @end table
12185 @item -mmultcost=@var{num}
12186 @opindex mmultcost
12187 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12188 normal instruction.
12190 @item -munalign-prob-threshold=@var{probability}
12191 @opindex munalign-prob-threshold
12192 Set probability threshold for unaligning branches.
12193 When tuning for @samp{ARC700} and optimizing for speed, branches without
12194 filled delay slot are preferably emitted unaligned and long, unless
12195 profiling indicates that the probability for the branch to be taken
12196 is below @var{probability}.  @xref{Cross-profiling}.
12197 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12199 @end table
12201 The following options are maintained for backward compatibility, but
12202 are now deprecated and will be removed in a future release:
12204 @c Deprecated options
12205 @table @gcctabopt
12207 @item -margonaut
12208 @opindex margonaut
12209 Obsolete FPX.
12211 @item -mbig-endian
12212 @opindex mbig-endian
12213 @itemx -EB
12214 @opindex EB
12215 Compile code for big endian targets.  Use of these options is now
12216 deprecated.  Users wanting big-endian code, should use the
12217 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12218 building the tool chain, for which big-endian is the default.
12220 @item -mlittle-endian
12221 @opindex mlittle-endian
12222 @itemx -EL
12223 @opindex EL
12224 Compile code for little endian targets.  Use of these options is now
12225 deprecated.  Users wanting little-endian code should use the
12226 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12227 building the tool chain, for which little-endian is the default.
12229 @item -mbarrel_shifter
12230 @opindex mbarrel_shifter
12231 Replaced by @samp{-mbarrel-shifter}
12233 @item -mdpfp_compact
12234 @opindex mdpfp_compact
12235 Replaced by @samp{-mdpfp-compact}
12237 @item -mdpfp_fast
12238 @opindex mdpfp_fast
12239 Replaced by @samp{-mdpfp-fast}
12241 @item -mdsp_packa
12242 @opindex mdsp_packa
12243 Replaced by @samp{-mdsp-packa}
12245 @item -mEA
12246 @opindex mEA
12247 Replaced by @samp{-mea}
12249 @item -mmac_24
12250 @opindex mmac_24
12251 Replaced by @samp{-mmac-24}
12253 @item -mmac_d16
12254 @opindex mmac_d16
12255 Replaced by @samp{-mmac-d16}
12257 @item -mspfp_compact
12258 @opindex mspfp_compact
12259 Replaced by @samp{-mspfp-compact}
12261 @item -mspfp_fast
12262 @opindex mspfp_fast
12263 Replaced by @samp{-mspfp-fast}
12265 @item -mtune=@var{cpu}
12266 @opindex mtune
12267 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12268 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12269 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12271 @item -multcost=@var{num}
12272 @opindex multcost
12273 Replaced by @samp{-mmultcost}.
12275 @end table
12277 @node ARM Options
12278 @subsection ARM Options
12279 @cindex ARM options
12281 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
12282 architectures:
12284 @table @gcctabopt
12285 @item -mabi=@var{name}
12286 @opindex mabi
12287 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12288 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12290 @item -mapcs-frame
12291 @opindex mapcs-frame
12292 Generate a stack frame that is compliant with the ARM Procedure Call
12293 Standard for all functions, even if this is not strictly necessary for
12294 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12295 with this option causes the stack frames not to be generated for
12296 leaf functions.  The default is @option{-mno-apcs-frame}.
12298 @item -mapcs
12299 @opindex mapcs
12300 This is a synonym for @option{-mapcs-frame}.
12302 @ignore
12303 @c not currently implemented
12304 @item -mapcs-stack-check
12305 @opindex mapcs-stack-check
12306 Generate code to check the amount of stack space available upon entry to
12307 every function (that actually uses some stack space).  If there is
12308 insufficient space available then either the function
12309 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12310 called, depending upon the amount of stack space required.  The runtime
12311 system is required to provide these functions.  The default is
12312 @option{-mno-apcs-stack-check}, since this produces smaller code.
12314 @c not currently implemented
12315 @item -mapcs-float
12316 @opindex mapcs-float
12317 Pass floating-point arguments using the floating-point registers.  This is
12318 one of the variants of the APCS@.  This option is recommended if the
12319 target hardware has a floating-point unit or if a lot of floating-point
12320 arithmetic is going to be performed by the code.  The default is
12321 @option{-mno-apcs-float}, since the size of integer-only code is 
12322 slightly increased if @option{-mapcs-float} is used.
12324 @c not currently implemented
12325 @item -mapcs-reentrant
12326 @opindex mapcs-reentrant
12327 Generate reentrant, position-independent code.  The default is
12328 @option{-mno-apcs-reentrant}.
12329 @end ignore
12331 @item -mthumb-interwork
12332 @opindex mthumb-interwork
12333 Generate code that supports calling between the ARM and Thumb
12334 instruction sets.  Without this option, on pre-v5 architectures, the
12335 two instruction sets cannot be reliably used inside one program.  The
12336 default is @option{-mno-thumb-interwork}, since slightly larger code
12337 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12338 configurations this option is meaningless.
12340 @item -mno-sched-prolog
12341 @opindex mno-sched-prolog
12342 Prevent the reordering of instructions in the function prologue, or the
12343 merging of those instruction with the instructions in the function's
12344 body.  This means that all functions start with a recognizable set
12345 of instructions (or in fact one of a choice from a small set of
12346 different function prologues), and this information can be used to
12347 locate the start of functions inside an executable piece of code.  The
12348 default is @option{-msched-prolog}.
12350 @item -mfloat-abi=@var{name}
12351 @opindex mfloat-abi
12352 Specifies which floating-point ABI to use.  Permissible values
12353 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12355 Specifying @samp{soft} causes GCC to generate output containing
12356 library calls for floating-point operations.
12357 @samp{softfp} allows the generation of code using hardware floating-point
12358 instructions, but still uses the soft-float calling conventions.
12359 @samp{hard} allows generation of floating-point instructions
12360 and uses FPU-specific calling conventions.
12362 The default depends on the specific target configuration.  Note that
12363 the hard-float and soft-float ABIs are not link-compatible; you must
12364 compile your entire program with the same ABI, and link with a
12365 compatible set of libraries.
12367 @item -mlittle-endian
12368 @opindex mlittle-endian
12369 Generate code for a processor running in little-endian mode.  This is
12370 the default for all standard configurations.
12372 @item -mbig-endian
12373 @opindex mbig-endian
12374 Generate code for a processor running in big-endian mode; the default is
12375 to compile code for a little-endian processor.
12377 @item -mwords-little-endian
12378 @opindex mwords-little-endian
12379 This option only applies when generating code for big-endian processors.
12380 Generate code for a little-endian word order but a big-endian byte
12381 order.  That is, a byte order of the form @samp{32107654}.  Note: this
12382 option should only be used if you require compatibility with code for
12383 big-endian ARM processors generated by versions of the compiler prior to
12384 2.8.  This option is now deprecated.
12386 @item -march=@var{name}
12387 @opindex march
12388 This specifies the name of the target ARM architecture.  GCC uses this
12389 name to determine what kind of instructions it can emit when generating
12390 assembly code.  This option can be used in conjunction with or instead
12391 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12392 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12393 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12394 @samp{armv6}, @samp{armv6j},
12395 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12396 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12397 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12398 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12400 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12401 extensions.
12403 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12404 architecture together with the optional CRC32 extensions.
12406 @option{-march=native} causes the compiler to auto-detect the architecture
12407 of the build computer.  At present, this feature is only supported on
12408 Linux, and not all architectures are recognized.  If the auto-detect is
12409 unsuccessful the option has no effect.
12411 @item -mtune=@var{name}
12412 @opindex mtune
12413 This option specifies the name of the target ARM processor for
12414 which GCC should tune the performance of the code.
12415 For some ARM implementations better performance can be obtained by using
12416 this option.
12417 Permissible names are: @samp{arm2}, @samp{arm250},
12418 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12419 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12420 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12421 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12422 @samp{arm720},
12423 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12424 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12425 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12426 @samp{strongarm1110},
12427 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12428 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12429 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12430 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12431 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12432 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12433 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12434 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12435 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12436 @samp{cortex-r4},
12437 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m4},
12438 @samp{cortex-m3},
12439 @samp{cortex-m1},
12440 @samp{cortex-m0},
12441 @samp{cortex-m0plus},
12442 @samp{marvell-pj4},
12443 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12444 @samp{fa526}, @samp{fa626},
12445 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12447 Additionally, this option can specify that GCC should tune the performance
12448 of the code for a big.LITTLE system.  Permissible names are:
12449 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12451 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12452 performance for a blend of processors within architecture @var{arch}.
12453 The aim is to generate code that run well on the current most popular
12454 processors, balancing between optimizations that benefit some CPUs in the
12455 range, and avoiding performance pitfalls of other CPUs.  The effects of
12456 this option may change in future GCC versions as CPU models come and go.
12458 @option{-mtune=native} causes the compiler to auto-detect the CPU
12459 of the build computer.  At present, this feature is only supported on
12460 Linux, and not all architectures are recognized.  If the auto-detect is
12461 unsuccessful the option has no effect.
12463 @item -mcpu=@var{name}
12464 @opindex mcpu
12465 This specifies the name of the target ARM processor.  GCC uses this name
12466 to derive the name of the target ARM architecture (as if specified
12467 by @option{-march}) and the ARM processor type for which to tune for
12468 performance (as if specified by @option{-mtune}).  Where this option
12469 is used in conjunction with @option{-march} or @option{-mtune},
12470 those options take precedence over the appropriate part of this option.
12472 Permissible names for this option are the same as those for
12473 @option{-mtune}.
12475 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12476 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12477 See @option{-mtune} for more information.
12479 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12480 of the build computer.  At present, this feature is only supported on
12481 Linux, and not all architectures are recognized.  If the auto-detect is
12482 unsuccessful the option has no effect.
12484 @item -mfpu=@var{name}
12485 @opindex mfpu
12486 This specifies what floating-point hardware (or hardware emulation) is
12487 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12488 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12489 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12490 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12491 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12493 If @option{-msoft-float} is specified this specifies the format of
12494 floating-point values.
12496 If the selected floating-point hardware includes the NEON extension
12497 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12498 operations are not generated by GCC's auto-vectorization pass unless
12499 @option{-funsafe-math-optimizations} is also specified.  This is
12500 because NEON hardware does not fully implement the IEEE 754 standard for
12501 floating-point arithmetic (in particular denormal values are treated as
12502 zero), so the use of NEON instructions may lead to a loss of precision.
12504 @item -mfp16-format=@var{name}
12505 @opindex mfp16-format
12506 Specify the format of the @code{__fp16} half-precision floating-point type.
12507 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12508 the default is @samp{none}, in which case the @code{__fp16} type is not
12509 defined.  @xref{Half-Precision}, for more information.
12511 @item -mstructure-size-boundary=@var{n}
12512 @opindex mstructure-size-boundary
12513 The sizes of all structures and unions are rounded up to a multiple
12514 of the number of bits set by this option.  Permissible values are 8, 32
12515 and 64.  The default value varies for different toolchains.  For the COFF
12516 targeted toolchain the default value is 8.  A value of 64 is only allowed
12517 if the underlying ABI supports it.
12519 Specifying a larger number can produce faster, more efficient code, but
12520 can also increase the size of the program.  Different values are potentially
12521 incompatible.  Code compiled with one value cannot necessarily expect to
12522 work with code or libraries compiled with another value, if they exchange
12523 information using structures or unions.
12525 @item -mabort-on-noreturn
12526 @opindex mabort-on-noreturn
12527 Generate a call to the function @code{abort} at the end of a
12528 @code{noreturn} function.  It is executed if the function tries to
12529 return.
12531 @item -mlong-calls
12532 @itemx -mno-long-calls
12533 @opindex mlong-calls
12534 @opindex mno-long-calls
12535 Tells the compiler to perform function calls by first loading the
12536 address of the function into a register and then performing a subroutine
12537 call on this register.  This switch is needed if the target function
12538 lies outside of the 64-megabyte addressing range of the offset-based
12539 version of subroutine call instruction.
12541 Even if this switch is enabled, not all function calls are turned
12542 into long calls.  The heuristic is that static functions, functions
12543 that have the @samp{short-call} attribute, functions that are inside
12544 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12545 definitions have already been compiled within the current compilation
12546 unit are not turned into long calls.  The exceptions to this rule are
12547 that weak function definitions, functions with the @samp{long-call}
12548 attribute or the @samp{section} attribute, and functions that are within
12549 the scope of a @samp{#pragma long_calls} directive are always
12550 turned into long calls.
12552 This feature is not enabled by default.  Specifying
12553 @option{-mno-long-calls} restores the default behavior, as does
12554 placing the function calls within the scope of a @samp{#pragma
12555 long_calls_off} directive.  Note these switches have no effect on how
12556 the compiler generates code to handle function calls via function
12557 pointers.
12559 @item -msingle-pic-base
12560 @opindex msingle-pic-base
12561 Treat the register used for PIC addressing as read-only, rather than
12562 loading it in the prologue for each function.  The runtime system is
12563 responsible for initializing this register with an appropriate value
12564 before execution begins.
12566 @item -mpic-register=@var{reg}
12567 @opindex mpic-register
12568 Specify the register to be used for PIC addressing.
12569 For standard PIC base case, the default will be any suitable register
12570 determined by compiler.  For single PIC base case, the default is
12571 @samp{R9} if target is EABI based or stack-checking is enabled,
12572 otherwise the default is @samp{R10}.
12574 @item -mpic-data-is-text-relative
12575 @opindex mpic-data-is-text-relative
12576 Assume that each data segments are relative to text segment at load time.
12577 Therefore, it permits addressing data using PC-relative operations.
12578 This option is on by default for targets other than VxWorks RTP.
12580 @item -mpoke-function-name
12581 @opindex mpoke-function-name
12582 Write the name of each function into the text section, directly
12583 preceding the function prologue.  The generated code is similar to this:
12585 @smallexample
12586      t0
12587          .ascii "arm_poke_function_name", 0
12588          .align
12589      t1
12590          .word 0xff000000 + (t1 - t0)
12591      arm_poke_function_name
12592          mov     ip, sp
12593          stmfd   sp!, @{fp, ip, lr, pc@}
12594          sub     fp, ip, #4
12595 @end smallexample
12597 When performing a stack backtrace, code can inspect the value of
12598 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
12599 location @code{pc - 12} and the top 8 bits are set, then we know that
12600 there is a function name embedded immediately preceding this location
12601 and has length @code{((pc[-3]) & 0xff000000)}.
12603 @item -mthumb
12604 @itemx -marm
12605 @opindex marm
12606 @opindex mthumb
12608 Select between generating code that executes in ARM and Thumb
12609 states.  The default for most configurations is to generate code
12610 that executes in ARM state, but the default can be changed by
12611 configuring GCC with the @option{--with-mode=}@var{state}
12612 configure option.
12614 @item -mtpcs-frame
12615 @opindex mtpcs-frame
12616 Generate a stack frame that is compliant with the Thumb Procedure Call
12617 Standard for all non-leaf functions.  (A leaf function is one that does
12618 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
12620 @item -mtpcs-leaf-frame
12621 @opindex mtpcs-leaf-frame
12622 Generate a stack frame that is compliant with the Thumb Procedure Call
12623 Standard for all leaf functions.  (A leaf function is one that does
12624 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
12626 @item -mcallee-super-interworking
12627 @opindex mcallee-super-interworking
12628 Gives all externally visible functions in the file being compiled an ARM
12629 instruction set header which switches to Thumb mode before executing the
12630 rest of the function.  This allows these functions to be called from
12631 non-interworking code.  This option is not valid in AAPCS configurations
12632 because interworking is enabled by default.
12634 @item -mcaller-super-interworking
12635 @opindex mcaller-super-interworking
12636 Allows calls via function pointers (including virtual functions) to
12637 execute correctly regardless of whether the target code has been
12638 compiled for interworking or not.  There is a small overhead in the cost
12639 of executing a function pointer if this option is enabled.  This option
12640 is not valid in AAPCS configurations because interworking is enabled
12641 by default.
12643 @item -mtp=@var{name}
12644 @opindex mtp
12645 Specify the access model for the thread local storage pointer.  The valid
12646 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
12647 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
12648 (supported in the arm6k architecture), and @option{auto}, which uses the
12649 best available method for the selected processor.  The default setting is
12650 @option{auto}.
12652 @item -mtls-dialect=@var{dialect}
12653 @opindex mtls-dialect
12654 Specify the dialect to use for accessing thread local storage.  Two
12655 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
12656 @samp{gnu} dialect selects the original GNU scheme for supporting
12657 local and global dynamic TLS models.  The @samp{gnu2} dialect
12658 selects the GNU descriptor scheme, which provides better performance
12659 for shared libraries.  The GNU descriptor scheme is compatible with
12660 the original scheme, but does require new assembler, linker and
12661 library support.  Initial and local exec TLS models are unaffected by
12662 this option and always use the original scheme.
12664 @item -mword-relocations
12665 @opindex mword-relocations
12666 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
12667 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
12668 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
12669 is specified.
12671 @item -mfix-cortex-m3-ldrd
12672 @opindex mfix-cortex-m3-ldrd
12673 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
12674 with overlapping destination and base registers are used.  This option avoids
12675 generating these instructions.  This option is enabled by default when
12676 @option{-mcpu=cortex-m3} is specified.
12678 @item -munaligned-access
12679 @itemx -mno-unaligned-access
12680 @opindex munaligned-access
12681 @opindex mno-unaligned-access
12682 Enables (or disables) reading and writing of 16- and 32- bit values
12683 from addresses that are not 16- or 32- bit aligned.  By default
12684 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
12685 architectures, and enabled for all other architectures.  If unaligned
12686 access is not enabled then words in packed data structures will be
12687 accessed a byte at a time.
12689 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
12690 generated object file to either true or false, depending upon the
12691 setting of this option.  If unaligned access is enabled then the
12692 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
12693 defined.
12695 @item -mneon-for-64bits
12696 @opindex mneon-for-64bits
12697 Enables using Neon to handle scalar 64-bits operations. This is
12698 disabled by default since the cost of moving data from core registers
12699 to Neon is high.
12701 @item -mslow-flash-data
12702 @opindex mslow-flash-data
12703 Assume loading data from flash is slower than fetching instruction.
12704 Therefore literal load is minimized for better performance.
12705 This option is only supported when compiling for ARMv7 M-profile and
12706 off by default.
12708 @item -mrestrict-it
12709 @opindex mrestrict-it
12710 Restricts generation of IT blocks to conform to the rules of ARMv8.
12711 IT blocks can only contain a single 16-bit instruction from a select
12712 set of instructions. This option is on by default for ARMv8 Thumb mode.
12713 @end table
12715 @node AVR Options
12716 @subsection AVR Options
12717 @cindex AVR Options
12719 These options are defined for AVR implementations:
12721 @table @gcctabopt
12722 @item -mmcu=@var{mcu}
12723 @opindex mmcu
12724 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
12726 The default for this option is@tie{}@code{avr2}.
12728 GCC supports the following AVR devices and ISAs:
12730 @include avr-mmcu.texi
12732 @item -maccumulate-args
12733 @opindex maccumulate-args
12734 Accumulate outgoing function arguments and acquire/release the needed
12735 stack space for outgoing function arguments once in function
12736 prologue/epilogue.  Without this option, outgoing arguments are pushed
12737 before calling a function and popped afterwards.
12739 Popping the arguments after the function call can be expensive on
12740 AVR so that accumulating the stack space might lead to smaller
12741 executables because arguments need not to be removed from the
12742 stack after such a function call.
12744 This option can lead to reduced code size for functions that perform
12745 several calls to functions that get their arguments on the stack like
12746 calls to printf-like functions.
12748 @item -mbranch-cost=@var{cost}
12749 @opindex mbranch-cost
12750 Set the branch costs for conditional branch instructions to
12751 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
12752 integers. The default branch cost is 0.
12754 @item -mcall-prologues
12755 @opindex mcall-prologues
12756 Functions prologues/epilogues are expanded as calls to appropriate
12757 subroutines.  Code size is smaller.
12759 @item -mint8
12760 @opindex mint8
12761 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
12762 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
12763 and @code{long long} is 4 bytes.  Please note that this option does not
12764 conform to the C standards, but it results in smaller code
12765 size.
12767 @item -mno-interrupts
12768 @opindex mno-interrupts
12769 Generated code is not compatible with hardware interrupts.
12770 Code size is smaller.
12772 @item -mrelax
12773 @opindex mrelax
12774 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
12775 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
12776 Setting @code{-mrelax} just adds the @code{--relax} option to the
12777 linker command line when the linker is called.
12779 Jump relaxing is performed by the linker because jump offsets are not
12780 known before code is located. Therefore, the assembler code generated by the
12781 compiler is the same, but the instructions in the executable may
12782 differ from instructions in the assembler code.
12784 Relaxing must be turned on if linker stubs are needed, see the
12785 section on @code{EIND} and linker stubs below.
12787 @item -msp8
12788 @opindex msp8
12789 Treat the stack pointer register as an 8-bit register,
12790 i.e.@: assume the high byte of the stack pointer is zero.
12791 In general, you don't need to set this option by hand.
12793 This option is used internally by the compiler to select and
12794 build multilibs for architectures @code{avr2} and @code{avr25}.
12795 These architectures mix devices with and without @code{SPH}.
12796 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
12797 the compiler driver will add or remove this option from the compiler
12798 proper's command line, because the compiler then knows if the device
12799 or architecture has an 8-bit stack pointer and thus no @code{SPH}
12800 register or not.
12802 @item -mstrict-X
12803 @opindex mstrict-X
12804 Use address register @code{X} in a way proposed by the hardware.  This means
12805 that @code{X} is only used in indirect, post-increment or
12806 pre-decrement addressing.
12808 Without this option, the @code{X} register may be used in the same way
12809 as @code{Y} or @code{Z} which then is emulated by additional
12810 instructions.  
12811 For example, loading a value with @code{X+const} addressing with a
12812 small non-negative @code{const < 64} to a register @var{Rn} is
12813 performed as
12815 @example
12816 adiw r26, const   ; X += const
12817 ld   @var{Rn}, X        ; @var{Rn} = *X
12818 sbiw r26, const   ; X -= const
12819 @end example
12821 @item -mtiny-stack
12822 @opindex mtiny-stack
12823 Only change the lower 8@tie{}bits of the stack pointer.
12825 @item -Waddr-space-convert
12826 @opindex Waddr-space-convert
12827 Warn about conversions between address spaces in the case where the
12828 resulting address space is not contained in the incoming address space.
12829 @end table
12831 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
12832 @cindex @code{EIND}
12833 Pointers in the implementation are 16@tie{}bits wide.
12834 The address of a function or label is represented as word address so
12835 that indirect jumps and calls can target any code address in the
12836 range of 64@tie{}Ki words.
12838 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
12839 bytes of program memory space, there is a special function register called
12840 @code{EIND} that serves as most significant part of the target address
12841 when @code{EICALL} or @code{EIJMP} instructions are used.
12843 Indirect jumps and calls on these devices are handled as follows by
12844 the compiler and are subject to some limitations:
12846 @itemize @bullet
12848 @item
12849 The compiler never sets @code{EIND}.
12851 @item
12852 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
12853 instructions or might read @code{EIND} directly in order to emulate an
12854 indirect call/jump by means of a @code{RET} instruction.
12856 @item
12857 The compiler assumes that @code{EIND} never changes during the startup
12858 code or during the application. In particular, @code{EIND} is not
12859 saved/restored in function or interrupt service routine
12860 prologue/epilogue.
12862 @item
12863 For indirect calls to functions and computed goto, the linker
12864 generates @emph{stubs}. Stubs are jump pads sometimes also called
12865 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
12866 The stub contains a direct jump to the desired address.
12868 @item
12869 Linker relaxation must be turned on so that the linker will generate
12870 the stubs correctly an all situaltion. See the compiler option
12871 @code{-mrelax} and the linler option @code{--relax}.
12872 There are corner cases where the linker is supposed to generate stubs
12873 but aborts without relaxation and without a helpful error message.
12875 @item
12876 The default linker script is arranged for code with @code{EIND = 0}.
12877 If code is supposed to work for a setup with @code{EIND != 0}, a custom
12878 linker script has to be used in order to place the sections whose
12879 name start with @code{.trampolines} into the segment where @code{EIND}
12880 points to.
12882 @item
12883 The startup code from libgcc never sets @code{EIND}.
12884 Notice that startup code is a blend of code from libgcc and AVR-LibC.
12885 For the impact of AVR-LibC on @code{EIND}, see the
12886 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
12888 @item
12889 It is legitimate for user-specific startup code to set up @code{EIND}
12890 early, for example by means of initialization code located in
12891 section @code{.init3}. Such code runs prior to general startup code
12892 that initializes RAM and calls constructors, but after the bit
12893 of startup code from AVR-LibC that sets @code{EIND} to the segment
12894 where the vector table is located.
12895 @example
12896 #include <avr/io.h>
12898 static void
12899 __attribute__((section(".init3"),naked,used,no_instrument_function))
12900 init3_set_eind (void)
12902   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
12903                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
12905 @end example
12907 @noindent
12908 The @code{__trampolines_start} symbol is defined in the linker script.
12910 @item
12911 Stubs are generated automatically by the linker if
12912 the following two conditions are met:
12913 @itemize @minus
12915 @item The address of a label is taken by means of the @code{gs} modifier
12916 (short for @emph{generate stubs}) like so:
12917 @example
12918 LDI r24, lo8(gs(@var{func}))
12919 LDI r25, hi8(gs(@var{func}))
12920 @end example
12921 @item The final location of that label is in a code segment
12922 @emph{outside} the segment where the stubs are located.
12923 @end itemize
12925 @item
12926 The compiler emits such @code{gs} modifiers for code labels in the
12927 following situations:
12928 @itemize @minus
12929 @item Taking address of a function or code label.
12930 @item Computed goto.
12931 @item If prologue-save function is used, see @option{-mcall-prologues}
12932 command-line option.
12933 @item Switch/case dispatch tables. If you do not want such dispatch
12934 tables you can specify the @option{-fno-jump-tables} command-line option.
12935 @item C and C++ constructors/destructors called during startup/shutdown.
12936 @item If the tools hit a @code{gs()} modifier explained above.
12937 @end itemize
12939 @item
12940 Jumping to non-symbolic addresses like so is @emph{not} supported:
12942 @example
12943 int main (void)
12945     /* Call function at word address 0x2 */
12946     return ((int(*)(void)) 0x2)();
12948 @end example
12950 Instead, a stub has to be set up, i.e.@: the function has to be called
12951 through a symbol (@code{func_4} in the example):
12953 @example
12954 int main (void)
12956     extern int func_4 (void);
12958     /* Call function at byte address 0x4 */
12959     return func_4();
12961 @end example
12963 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
12964 Alternatively, @code{func_4} can be defined in the linker script.
12965 @end itemize
12967 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
12968 @cindex @code{RAMPD}
12969 @cindex @code{RAMPX}
12970 @cindex @code{RAMPY}
12971 @cindex @code{RAMPZ}
12972 Some AVR devices support memories larger than the 64@tie{}KiB range
12973 that can be accessed with 16-bit pointers.  To access memory locations
12974 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
12975 register is used as high part of the address:
12976 The @code{X}, @code{Y}, @code{Z} address register is concatenated
12977 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
12978 register, respectively, to get a wide address. Similarly,
12979 @code{RAMPD} is used together with direct addressing.
12981 @itemize
12982 @item
12983 The startup code initializes the @code{RAMP} special function
12984 registers with zero.
12986 @item
12987 If a @ref{AVR Named Address Spaces,named address space} other than
12988 generic or @code{__flash} is used, then @code{RAMPZ} is set
12989 as needed before the operation.
12991 @item
12992 If the device supports RAM larger than 64@tie{}KiB and the compiler
12993 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
12994 is reset to zero after the operation.
12996 @item
12997 If the device comes with a specific @code{RAMP} register, the ISR
12998 prologue/epilogue saves/restores that SFR and initializes it with
12999 zero in case the ISR code might (implicitly) use it.
13001 @item
13002 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13003 If you use inline assembler to read from locations outside the
13004 16-bit address range and change one of the @code{RAMP} registers,
13005 you must reset it to zero after the access.
13007 @end itemize
13009 @subsubsection AVR Built-in Macros
13011 GCC defines several built-in macros so that the user code can test
13012 for the presence or absence of features.  Almost any of the following
13013 built-in macros are deduced from device capabilities and thus
13014 triggered by the @code{-mmcu=} command-line option.
13016 For even more AVR-specific built-in macros see
13017 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13019 @table @code
13021 @item __AVR_ARCH__
13022 Build-in macro that resolves to a decimal number that identifies the
13023 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13024 Possible values are:
13026 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13027 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13028 @code{105}, @code{106}, @code{107}
13030 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13031 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13032 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13033 @code{avrxmega6}, @code{avrxmega7}, respectively.
13034 If @var{mcu} specifies a device, this built-in macro is set
13035 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13036 defined to @code{4}.
13038 @item __AVR_@var{Device}__
13039 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13040 the device's name. For example, @code{-mmcu=atmega8} defines the
13041 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13042 @code{__AVR_ATtiny261A__}, etc.
13044 The built-in macros' names follow
13045 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13046 the device name as from the AVR user manual. The difference between
13047 @var{Device} in the built-in macro and @var{device} in
13048 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13050 If @var{device} is not a device but only a core architecture like
13051 @code{avr51}, this macro will not be defined.
13053 @item __AVR_XMEGA__
13054 The device / architecture belongs to the XMEGA family of devices.
13056 @item __AVR_HAVE_ELPM__
13057 The device has the the @code{ELPM} instruction.
13059 @item __AVR_HAVE_ELPMX__
13060 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13061 R@var{n},Z+} instructions.
13063 @item __AVR_HAVE_MOVW__
13064 The device has the @code{MOVW} instruction to perform 16-bit
13065 register-register moves.
13067 @item __AVR_HAVE_LPMX__
13068 The device has the @code{LPM R@var{n},Z} and
13069 @code{LPM R@var{n},Z+} instructions.
13071 @item __AVR_HAVE_MUL__
13072 The device has a hardware multiplier. 
13074 @item __AVR_HAVE_JMP_CALL__
13075 The device has the @code{JMP} and @code{CALL} instructions.
13076 This is the case for devices with at least 16@tie{}KiB of program
13077 memory.
13079 @item __AVR_HAVE_EIJMP_EICALL__
13080 @itemx __AVR_3_BYTE_PC__
13081 The device has the @code{EIJMP} and @code{EICALL} instructions.
13082 This is the case for devices with more than 128@tie{}KiB of program memory.
13083 This also means that the program counter
13084 (PC) is 3@tie{}bytes wide.
13086 @item __AVR_2_BYTE_PC__
13087 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13088 with up to 128@tie{}KiB of program memory.
13090 @item __AVR_HAVE_8BIT_SP__
13091 @itemx __AVR_HAVE_16BIT_SP__
13092 The stack pointer (SP) register is treated as 8-bit respectively
13093 16-bit register by the compiler.
13094 The definition of these macros is affected by @code{-mtiny-stack}.
13096 @item __AVR_HAVE_SPH__
13097 @itemx __AVR_SP8__
13098 The device has the SPH (high part of stack pointer) special function
13099 register or has an 8-bit stack pointer, respectively.
13100 The definition of these macros is affected by @code{-mmcu=} and
13101 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13102 by @code{-msp8}.
13104 @item __AVR_HAVE_RAMPD__
13105 @itemx __AVR_HAVE_RAMPX__
13106 @itemx __AVR_HAVE_RAMPY__
13107 @itemx __AVR_HAVE_RAMPZ__
13108 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13109 @code{RAMPZ} special function register, respectively.
13111 @item __NO_INTERRUPTS__
13112 This macro reflects the @code{-mno-interrupts} command line option.
13114 @item __AVR_ERRATA_SKIP__
13115 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13116 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13117 instructions because of a hardware erratum.  Skip instructions are
13118 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13119 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13120 set.
13122 @item __AVR_ISA_RMW__
13123 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13125 @item __AVR_SFR_OFFSET__=@var{offset}
13126 Instructions that can address I/O special function registers directly
13127 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13128 address as if addressed by an instruction to access RAM like @code{LD}
13129 or @code{STS}. This offset depends on the device architecture and has
13130 to be subtracted from the RAM address in order to get the
13131 respective I/O@tie{}address.
13133 @item __WITH_AVRLIBC__
13134 The compiler is configured to be used together with AVR-Libc.
13135 See the @code{--with-avrlibc} configure option.
13137 @end table
13139 @node Blackfin Options
13140 @subsection Blackfin Options
13141 @cindex Blackfin Options
13143 @table @gcctabopt
13144 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13145 @opindex mcpu=
13146 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13147 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13148 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13149 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13150 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13151 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13152 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13153 @samp{bf561}, @samp{bf592}.
13155 The optional @var{sirevision} specifies the silicon revision of the target
13156 Blackfin processor.  Any workarounds available for the targeted silicon revision
13157 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13158 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13159 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13160 hexadecimal digits representing the major and minor numbers in the silicon
13161 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13162 is not defined.  If @var{sirevision} is @samp{any}, the
13163 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13164 If this optional @var{sirevision} is not used, GCC assumes the latest known
13165 silicon revision of the targeted Blackfin processor.
13167 GCC defines a preprocessor macro for the specified @var{cpu}.
13168 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13169 provided by libgloss to be linked in if @option{-msim} is not given.
13171 Without this option, @samp{bf532} is used as the processor by default.
13173 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13174 only the preprocessor macro is defined.
13176 @item -msim
13177 @opindex msim
13178 Specifies that the program will be run on the simulator.  This causes
13179 the simulator BSP provided by libgloss to be linked in.  This option
13180 has effect only for @samp{bfin-elf} toolchain.
13181 Certain other options, such as @option{-mid-shared-library} and
13182 @option{-mfdpic}, imply @option{-msim}.
13184 @item -momit-leaf-frame-pointer
13185 @opindex momit-leaf-frame-pointer
13186 Don't keep the frame pointer in a register for leaf functions.  This
13187 avoids the instructions to save, set up and restore frame pointers and
13188 makes an extra register available in leaf functions.  The option
13189 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13190 which might make debugging harder.
13192 @item -mspecld-anomaly
13193 @opindex mspecld-anomaly
13194 When enabled, the compiler ensures that the generated code does not
13195 contain speculative loads after jump instructions. If this option is used,
13196 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13198 @item -mno-specld-anomaly
13199 @opindex mno-specld-anomaly
13200 Don't generate extra code to prevent speculative loads from occurring.
13202 @item -mcsync-anomaly
13203 @opindex mcsync-anomaly
13204 When enabled, the compiler ensures that the generated code does not
13205 contain CSYNC or SSYNC instructions too soon after conditional branches.
13206 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13208 @item -mno-csync-anomaly
13209 @opindex mno-csync-anomaly
13210 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13211 occurring too soon after a conditional branch.
13213 @item -mlow-64k
13214 @opindex mlow-64k
13215 When enabled, the compiler is free to take advantage of the knowledge that
13216 the entire program fits into the low 64k of memory.
13218 @item -mno-low-64k
13219 @opindex mno-low-64k
13220 Assume that the program is arbitrarily large.  This is the default.
13222 @item -mstack-check-l1
13223 @opindex mstack-check-l1
13224 Do stack checking using information placed into L1 scratchpad memory by the
13225 uClinux kernel.
13227 @item -mid-shared-library
13228 @opindex mid-shared-library
13229 Generate code that supports shared libraries via the library ID method.
13230 This allows for execute in place and shared libraries in an environment
13231 without virtual memory management.  This option implies @option{-fPIC}.
13232 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13234 @item -mno-id-shared-library
13235 @opindex mno-id-shared-library
13236 Generate code that doesn't assume ID-based shared libraries are being used.
13237 This is the default.
13239 @item -mleaf-id-shared-library
13240 @opindex mleaf-id-shared-library
13241 Generate code that supports shared libraries via the library ID method,
13242 but assumes that this library or executable won't link against any other
13243 ID shared libraries.  That allows the compiler to use faster code for jumps
13244 and calls.
13246 @item -mno-leaf-id-shared-library
13247 @opindex mno-leaf-id-shared-library
13248 Do not assume that the code being compiled won't link against any ID shared
13249 libraries.  Slower code is generated for jump and call insns.
13251 @item -mshared-library-id=n
13252 @opindex mshared-library-id
13253 Specifies the identification number of the ID-based shared library being
13254 compiled.  Specifying a value of 0 generates more compact code; specifying
13255 other values forces the allocation of that number to the current
13256 library but is no more space- or time-efficient than omitting this option.
13258 @item -msep-data
13259 @opindex msep-data
13260 Generate code that allows the data segment to be located in a different
13261 area of memory from the text segment.  This allows for execute in place in
13262 an environment without virtual memory management by eliminating relocations
13263 against the text section.
13265 @item -mno-sep-data
13266 @opindex mno-sep-data
13267 Generate code that assumes that the data segment follows the text segment.
13268 This is the default.
13270 @item -mlong-calls
13271 @itemx -mno-long-calls
13272 @opindex mlong-calls
13273 @opindex mno-long-calls
13274 Tells the compiler to perform function calls by first loading the
13275 address of the function into a register and then performing a subroutine
13276 call on this register.  This switch is needed if the target function
13277 lies outside of the 24-bit addressing range of the offset-based
13278 version of subroutine call instruction.
13280 This feature is not enabled by default.  Specifying
13281 @option{-mno-long-calls} restores the default behavior.  Note these
13282 switches have no effect on how the compiler generates code to handle
13283 function calls via function pointers.
13285 @item -mfast-fp
13286 @opindex mfast-fp
13287 Link with the fast floating-point library. This library relaxes some of
13288 the IEEE floating-point standard's rules for checking inputs against
13289 Not-a-Number (NAN), in the interest of performance.
13291 @item -minline-plt
13292 @opindex minline-plt
13293 Enable inlining of PLT entries in function calls to functions that are
13294 not known to bind locally.  It has no effect without @option{-mfdpic}.
13296 @item -mmulticore
13297 @opindex mmulticore
13298 Build a standalone application for multicore Blackfin processors. 
13299 This option causes proper start files and link scripts supporting 
13300 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13301 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13303 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13304 selects the one-application-per-core programming model.  Without
13305 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13306 programming model is used. In this model, the main function of Core B
13307 should be named as @code{coreb_main}.
13309 If this option is not used, the single-core application programming
13310 model is used.
13312 @item -mcorea
13313 @opindex mcorea
13314 Build a standalone application for Core A of BF561 when using
13315 the one-application-per-core programming model. Proper start files
13316 and link scripts are used to support Core A, and the macro
13317 @code{__BFIN_COREA} is defined.
13318 This option can only be used in conjunction with @option{-mmulticore}.
13320 @item -mcoreb
13321 @opindex mcoreb
13322 Build a standalone application for Core B of BF561 when using
13323 the one-application-per-core programming model. Proper start files
13324 and link scripts are used to support Core B, and the macro
13325 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13326 should be used instead of @code{main}. 
13327 This option can only be used in conjunction with @option{-mmulticore}.
13329 @item -msdram
13330 @opindex msdram
13331 Build a standalone application for SDRAM. Proper start files and
13332 link scripts are used to put the application into SDRAM, and the macro
13333 @code{__BFIN_SDRAM} is defined.
13334 The loader should initialize SDRAM before loading the application.
13336 @item -micplb
13337 @opindex micplb
13338 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13339 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13340 are enabled; for standalone applications the default is off.
13341 @end table
13343 @node C6X Options
13344 @subsection C6X Options
13345 @cindex C6X Options
13347 @table @gcctabopt
13348 @item -march=@var{name}
13349 @opindex march
13350 This specifies the name of the target architecture.  GCC uses this
13351 name to determine what kind of instructions it can emit when generating
13352 assembly code.  Permissible names are: @samp{c62x},
13353 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13355 @item -mbig-endian
13356 @opindex mbig-endian
13357 Generate code for a big-endian target.
13359 @item -mlittle-endian
13360 @opindex mlittle-endian
13361 Generate code for a little-endian target.  This is the default.
13363 @item -msim
13364 @opindex msim
13365 Choose startup files and linker script suitable for the simulator.
13367 @item -msdata=default
13368 @opindex msdata=default
13369 Put small global and static data in the @samp{.neardata} section,
13370 which is pointed to by register @code{B14}.  Put small uninitialized
13371 global and static data in the @samp{.bss} section, which is adjacent
13372 to the @samp{.neardata} section.  Put small read-only data into the
13373 @samp{.rodata} section.  The corresponding sections used for large
13374 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13376 @item -msdata=all
13377 @opindex msdata=all
13378 Put all data, not just small objects, into the sections reserved for
13379 small data, and use addressing relative to the @code{B14} register to
13380 access them.
13382 @item -msdata=none
13383 @opindex msdata=none
13384 Make no use of the sections reserved for small data, and use absolute
13385 addresses to access all data.  Put all initialized global and static
13386 data in the @samp{.fardata} section, and all uninitialized data in the
13387 @samp{.far} section.  Put all constant data into the @samp{.const}
13388 section.
13389 @end table
13391 @node CRIS Options
13392 @subsection CRIS Options
13393 @cindex CRIS Options
13395 These options are defined specifically for the CRIS ports.
13397 @table @gcctabopt
13398 @item -march=@var{architecture-type}
13399 @itemx -mcpu=@var{architecture-type}
13400 @opindex march
13401 @opindex mcpu
13402 Generate code for the specified architecture.  The choices for
13403 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13404 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13405 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13406 @samp{v10}.
13408 @item -mtune=@var{architecture-type}
13409 @opindex mtune
13410 Tune to @var{architecture-type} everything applicable about the generated
13411 code, except for the ABI and the set of available instructions.  The
13412 choices for @var{architecture-type} are the same as for
13413 @option{-march=@var{architecture-type}}.
13415 @item -mmax-stack-frame=@var{n}
13416 @opindex mmax-stack-frame
13417 Warn when the stack frame of a function exceeds @var{n} bytes.
13419 @item -metrax4
13420 @itemx -metrax100
13421 @opindex metrax4
13422 @opindex metrax100
13423 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13424 @option{-march=v3} and @option{-march=v8} respectively.
13426 @item -mmul-bug-workaround
13427 @itemx -mno-mul-bug-workaround
13428 @opindex mmul-bug-workaround
13429 @opindex mno-mul-bug-workaround
13430 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13431 models where it applies.  This option is active by default.
13433 @item -mpdebug
13434 @opindex mpdebug
13435 Enable CRIS-specific verbose debug-related information in the assembly
13436 code.  This option also has the effect of turning off the @samp{#NO_APP}
13437 formatted-code indicator to the assembler at the beginning of the
13438 assembly file.
13440 @item -mcc-init
13441 @opindex mcc-init
13442 Do not use condition-code results from previous instruction; always emit
13443 compare and test instructions before use of condition codes.
13445 @item -mno-side-effects
13446 @opindex mno-side-effects
13447 Do not emit instructions with side effects in addressing modes other than
13448 post-increment.
13450 @item -mstack-align
13451 @itemx -mno-stack-align
13452 @itemx -mdata-align
13453 @itemx -mno-data-align
13454 @itemx -mconst-align
13455 @itemx -mno-const-align
13456 @opindex mstack-align
13457 @opindex mno-stack-align
13458 @opindex mdata-align
13459 @opindex mno-data-align
13460 @opindex mconst-align
13461 @opindex mno-const-align
13462 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13463 stack frame, individual data and constants to be aligned for the maximum
13464 single data access size for the chosen CPU model.  The default is to
13465 arrange for 32-bit alignment.  ABI details such as structure layout are
13466 not affected by these options.
13468 @item -m32-bit
13469 @itemx -m16-bit
13470 @itemx -m8-bit
13471 @opindex m32-bit
13472 @opindex m16-bit
13473 @opindex m8-bit
13474 Similar to the stack- data- and const-align options above, these options
13475 arrange for stack frame, writable data and constants to all be 32-bit,
13476 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13478 @item -mno-prologue-epilogue
13479 @itemx -mprologue-epilogue
13480 @opindex mno-prologue-epilogue
13481 @opindex mprologue-epilogue
13482 With @option{-mno-prologue-epilogue}, the normal function prologue and
13483 epilogue which set up the stack frame are omitted and no return
13484 instructions or return sequences are generated in the code.  Use this
13485 option only together with visual inspection of the compiled code: no
13486 warnings or errors are generated when call-saved registers must be saved,
13487 or storage for local variables needs to be allocated.
13489 @item -mno-gotplt
13490 @itemx -mgotplt
13491 @opindex mno-gotplt
13492 @opindex mgotplt
13493 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13494 instruction sequences that load addresses for functions from the PLT part
13495 of the GOT rather than (traditional on other architectures) calls to the
13496 PLT@.  The default is @option{-mgotplt}.
13498 @item -melf
13499 @opindex melf
13500 Legacy no-op option only recognized with the cris-axis-elf and
13501 cris-axis-linux-gnu targets.
13503 @item -mlinux
13504 @opindex mlinux
13505 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13507 @item -sim
13508 @opindex sim
13509 This option, recognized for the cris-axis-elf, arranges
13510 to link with input-output functions from a simulator library.  Code,
13511 initialized data and zero-initialized data are allocated consecutively.
13513 @item -sim2
13514 @opindex sim2
13515 Like @option{-sim}, but pass linker options to locate initialized data at
13516 0x40000000 and zero-initialized data at 0x80000000.
13517 @end table
13519 @node CR16 Options
13520 @subsection CR16 Options
13521 @cindex CR16 Options
13523 These options are defined specifically for the CR16 ports.
13525 @table @gcctabopt
13527 @item -mmac
13528 @opindex mmac
13529 Enable the use of multiply-accumulate instructions. Disabled by default.
13531 @item -mcr16cplus
13532 @itemx -mcr16c
13533 @opindex mcr16cplus
13534 @opindex mcr16c
13535 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13536 is default.
13538 @item -msim
13539 @opindex msim
13540 Links the library libsim.a which is in compatible with simulator. Applicable
13541 to ELF compiler only.
13543 @item -mint32
13544 @opindex mint32
13545 Choose integer type as 32-bit wide.
13547 @item -mbit-ops
13548 @opindex mbit-ops
13549 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13551 @item -mdata-model=@var{model}
13552 @opindex mdata-model
13553 Choose a data model. The choices for @var{model} are @samp{near},
13554 @samp{far} or @samp{medium}. @samp{medium} is default.
13555 However, @samp{far} is not valid with @option{-mcr16c}, as the
13556 CR16C architecture does not support the far data model.
13557 @end table
13559 @node Darwin Options
13560 @subsection Darwin Options
13561 @cindex Darwin options
13563 These options are defined for all architectures running the Darwin operating
13564 system.
13566 FSF GCC on Darwin does not create ``fat'' object files; it creates
13567 an object file for the single architecture that GCC was built to
13568 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13569 @option{-arch} options are used; it does so by running the compiler or
13570 linker multiple times and joining the results together with
13571 @file{lipo}.
13573 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13574 @samp{i686}) is determined by the flags that specify the ISA
13575 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13576 @option{-force_cpusubtype_ALL} option can be used to override this.
13578 The Darwin tools vary in their behavior when presented with an ISA
13579 mismatch.  The assembler, @file{as}, only permits instructions to
13580 be used that are valid for the subtype of the file it is generating,
13581 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
13582 The linker for shared libraries, @file{/usr/bin/libtool}, fails
13583 and prints an error if asked to create a shared library with a less
13584 restrictive subtype than its input files (for instance, trying to put
13585 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
13586 for executables, @command{ld}, quietly gives the executable the most
13587 restrictive subtype of any of its input files.
13589 @table @gcctabopt
13590 @item -F@var{dir}
13591 @opindex F
13592 Add the framework directory @var{dir} to the head of the list of
13593 directories to be searched for header files.  These directories are
13594 interleaved with those specified by @option{-I} options and are
13595 scanned in a left-to-right order.
13597 A framework directory is a directory with frameworks in it.  A
13598 framework is a directory with a @file{Headers} and/or
13599 @file{PrivateHeaders} directory contained directly in it that ends
13600 in @file{.framework}.  The name of a framework is the name of this
13601 directory excluding the @file{.framework}.  Headers associated with
13602 the framework are found in one of those two directories, with
13603 @file{Headers} being searched first.  A subframework is a framework
13604 directory that is in a framework's @file{Frameworks} directory.
13605 Includes of subframework headers can only appear in a header of a
13606 framework that contains the subframework, or in a sibling subframework
13607 header.  Two subframeworks are siblings if they occur in the same
13608 framework.  A subframework should not have the same name as a
13609 framework; a warning is issued if this is violated.  Currently a
13610 subframework cannot have subframeworks; in the future, the mechanism
13611 may be extended to support this.  The standard frameworks can be found
13612 in @file{/System/Library/Frameworks} and
13613 @file{/Library/Frameworks}.  An example include looks like
13614 @code{#include <Framework/header.h>}, where @file{Framework} denotes
13615 the name of the framework and @file{header.h} is found in the
13616 @file{PrivateHeaders} or @file{Headers} directory.
13618 @item -iframework@var{dir}
13619 @opindex iframework
13620 Like @option{-F} except the directory is a treated as a system
13621 directory.  The main difference between this @option{-iframework} and
13622 @option{-F} is that with @option{-iframework} the compiler does not
13623 warn about constructs contained within header files found via
13624 @var{dir}.  This option is valid only for the C family of languages.
13626 @item -gused
13627 @opindex gused
13628 Emit debugging information for symbols that are used.  For stabs
13629 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
13630 This is by default ON@.
13632 @item -gfull
13633 @opindex gfull
13634 Emit debugging information for all symbols and types.
13636 @item -mmacosx-version-min=@var{version}
13637 The earliest version of MacOS X that this executable will run on
13638 is @var{version}.  Typical values of @var{version} include @code{10.1},
13639 @code{10.2}, and @code{10.3.9}.
13641 If the compiler was built to use the system's headers by default,
13642 then the default for this option is the system version on which the
13643 compiler is running, otherwise the default is to make choices that
13644 are compatible with as many systems and code bases as possible.
13646 @item -mkernel
13647 @opindex mkernel
13648 Enable kernel development mode.  The @option{-mkernel} option sets
13649 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
13650 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
13651 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
13652 applicable.  This mode also sets @option{-mno-altivec},
13653 @option{-msoft-float}, @option{-fno-builtin} and
13654 @option{-mlong-branch} for PowerPC targets.
13656 @item -mone-byte-bool
13657 @opindex mone-byte-bool
13658 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
13659 By default @samp{sizeof(bool)} is @samp{4} when compiling for
13660 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
13661 option has no effect on x86.
13663 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
13664 to generate code that is not binary compatible with code generated
13665 without that switch.  Using this switch may require recompiling all
13666 other modules in a program, including system libraries.  Use this
13667 switch to conform to a non-default data model.
13669 @item -mfix-and-continue
13670 @itemx -ffix-and-continue
13671 @itemx -findirect-data
13672 @opindex mfix-and-continue
13673 @opindex ffix-and-continue
13674 @opindex findirect-data
13675 Generate code suitable for fast turnaround development, such as to
13676 allow GDB to dynamically load @code{.o} files into already-running
13677 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
13678 are provided for backwards compatibility.
13680 @item -all_load
13681 @opindex all_load
13682 Loads all members of static archive libraries.
13683 See man ld(1) for more information.
13685 @item -arch_errors_fatal
13686 @opindex arch_errors_fatal
13687 Cause the errors having to do with files that have the wrong architecture
13688 to be fatal.
13690 @item -bind_at_load
13691 @opindex bind_at_load
13692 Causes the output file to be marked such that the dynamic linker will
13693 bind all undefined references when the file is loaded or launched.
13695 @item -bundle
13696 @opindex bundle
13697 Produce a Mach-o bundle format file.
13698 See man ld(1) for more information.
13700 @item -bundle_loader @var{executable}
13701 @opindex bundle_loader
13702 This option specifies the @var{executable} that will load the build
13703 output file being linked.  See man ld(1) for more information.
13705 @item -dynamiclib
13706 @opindex dynamiclib
13707 When passed this option, GCC produces a dynamic library instead of
13708 an executable when linking, using the Darwin @file{libtool} command.
13710 @item -force_cpusubtype_ALL
13711 @opindex force_cpusubtype_ALL
13712 This causes GCC's output file to have the @var{ALL} subtype, instead of
13713 one controlled by the @option{-mcpu} or @option{-march} option.
13715 @item -allowable_client  @var{client_name}
13716 @itemx -client_name
13717 @itemx -compatibility_version
13718 @itemx -current_version
13719 @itemx -dead_strip
13720 @itemx -dependency-file
13721 @itemx -dylib_file
13722 @itemx -dylinker_install_name
13723 @itemx -dynamic
13724 @itemx -exported_symbols_list
13725 @itemx -filelist
13726 @need 800
13727 @itemx -flat_namespace
13728 @itemx -force_flat_namespace
13729 @itemx -headerpad_max_install_names
13730 @itemx -image_base
13731 @itemx -init
13732 @itemx -install_name
13733 @itemx -keep_private_externs
13734 @itemx -multi_module
13735 @itemx -multiply_defined
13736 @itemx -multiply_defined_unused
13737 @need 800
13738 @itemx -noall_load
13739 @itemx -no_dead_strip_inits_and_terms
13740 @itemx -nofixprebinding
13741 @itemx -nomultidefs
13742 @itemx -noprebind
13743 @itemx -noseglinkedit
13744 @itemx -pagezero_size
13745 @itemx -prebind
13746 @itemx -prebind_all_twolevel_modules
13747 @itemx -private_bundle
13748 @need 800
13749 @itemx -read_only_relocs
13750 @itemx -sectalign
13751 @itemx -sectobjectsymbols
13752 @itemx -whyload
13753 @itemx -seg1addr
13754 @itemx -sectcreate
13755 @itemx -sectobjectsymbols
13756 @itemx -sectorder
13757 @itemx -segaddr
13758 @itemx -segs_read_only_addr
13759 @need 800
13760 @itemx -segs_read_write_addr
13761 @itemx -seg_addr_table
13762 @itemx -seg_addr_table_filename
13763 @itemx -seglinkedit
13764 @itemx -segprot
13765 @itemx -segs_read_only_addr
13766 @itemx -segs_read_write_addr
13767 @itemx -single_module
13768 @itemx -static
13769 @itemx -sub_library
13770 @need 800
13771 @itemx -sub_umbrella
13772 @itemx -twolevel_namespace
13773 @itemx -umbrella
13774 @itemx -undefined
13775 @itemx -unexported_symbols_list
13776 @itemx -weak_reference_mismatches
13777 @itemx -whatsloaded
13778 @opindex allowable_client
13779 @opindex client_name
13780 @opindex compatibility_version
13781 @opindex current_version
13782 @opindex dead_strip
13783 @opindex dependency-file
13784 @opindex dylib_file
13785 @opindex dylinker_install_name
13786 @opindex dynamic
13787 @opindex exported_symbols_list
13788 @opindex filelist
13789 @opindex flat_namespace
13790 @opindex force_flat_namespace
13791 @opindex headerpad_max_install_names
13792 @opindex image_base
13793 @opindex init
13794 @opindex install_name
13795 @opindex keep_private_externs
13796 @opindex multi_module
13797 @opindex multiply_defined
13798 @opindex multiply_defined_unused
13799 @opindex noall_load
13800 @opindex no_dead_strip_inits_and_terms
13801 @opindex nofixprebinding
13802 @opindex nomultidefs
13803 @opindex noprebind
13804 @opindex noseglinkedit
13805 @opindex pagezero_size
13806 @opindex prebind
13807 @opindex prebind_all_twolevel_modules
13808 @opindex private_bundle
13809 @opindex read_only_relocs
13810 @opindex sectalign
13811 @opindex sectobjectsymbols
13812 @opindex whyload
13813 @opindex seg1addr
13814 @opindex sectcreate
13815 @opindex sectobjectsymbols
13816 @opindex sectorder
13817 @opindex segaddr
13818 @opindex segs_read_only_addr
13819 @opindex segs_read_write_addr
13820 @opindex seg_addr_table
13821 @opindex seg_addr_table_filename
13822 @opindex seglinkedit
13823 @opindex segprot
13824 @opindex segs_read_only_addr
13825 @opindex segs_read_write_addr
13826 @opindex single_module
13827 @opindex static
13828 @opindex sub_library
13829 @opindex sub_umbrella
13830 @opindex twolevel_namespace
13831 @opindex umbrella
13832 @opindex undefined
13833 @opindex unexported_symbols_list
13834 @opindex weak_reference_mismatches
13835 @opindex whatsloaded
13836 These options are passed to the Darwin linker.  The Darwin linker man page
13837 describes them in detail.
13838 @end table
13840 @node DEC Alpha Options
13841 @subsection DEC Alpha Options
13843 These @samp{-m} options are defined for the DEC Alpha implementations:
13845 @table @gcctabopt
13846 @item -mno-soft-float
13847 @itemx -msoft-float
13848 @opindex mno-soft-float
13849 @opindex msoft-float
13850 Use (do not use) the hardware floating-point instructions for
13851 floating-point operations.  When @option{-msoft-float} is specified,
13852 functions in @file{libgcc.a} are used to perform floating-point
13853 operations.  Unless they are replaced by routines that emulate the
13854 floating-point operations, or compiled in such a way as to call such
13855 emulations routines, these routines issue floating-point
13856 operations.   If you are compiling for an Alpha without floating-point
13857 operations, you must ensure that the library is built so as not to call
13858 them.
13860 Note that Alpha implementations without floating-point operations are
13861 required to have floating-point registers.
13863 @item -mfp-reg
13864 @itemx -mno-fp-regs
13865 @opindex mfp-reg
13866 @opindex mno-fp-regs
13867 Generate code that uses (does not use) the floating-point register set.
13868 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
13869 register set is not used, floating-point operands are passed in integer
13870 registers as if they were integers and floating-point results are passed
13871 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
13872 so any function with a floating-point argument or return value called by code
13873 compiled with @option{-mno-fp-regs} must also be compiled with that
13874 option.
13876 A typical use of this option is building a kernel that does not use,
13877 and hence need not save and restore, any floating-point registers.
13879 @item -mieee
13880 @opindex mieee
13881 The Alpha architecture implements floating-point hardware optimized for
13882 maximum performance.  It is mostly compliant with the IEEE floating-point
13883 standard.  However, for full compliance, software assistance is
13884 required.  This option generates code fully IEEE-compliant code
13885 @emph{except} that the @var{inexact-flag} is not maintained (see below).
13886 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
13887 defined during compilation.  The resulting code is less efficient but is
13888 able to correctly support denormalized numbers and exceptional IEEE
13889 values such as not-a-number and plus/minus infinity.  Other Alpha
13890 compilers call this option @option{-ieee_with_no_inexact}.
13892 @item -mieee-with-inexact
13893 @opindex mieee-with-inexact
13894 This is like @option{-mieee} except the generated code also maintains
13895 the IEEE @var{inexact-flag}.  Turning on this option causes the
13896 generated code to implement fully-compliant IEEE math.  In addition to
13897 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
13898 macro.  On some Alpha implementations the resulting code may execute
13899 significantly slower than the code generated by default.  Since there is
13900 very little code that depends on the @var{inexact-flag}, you should
13901 normally not specify this option.  Other Alpha compilers call this
13902 option @option{-ieee_with_inexact}.
13904 @item -mfp-trap-mode=@var{trap-mode}
13905 @opindex mfp-trap-mode
13906 This option controls what floating-point related traps are enabled.
13907 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
13908 The trap mode can be set to one of four values:
13910 @table @samp
13911 @item n
13912 This is the default (normal) setting.  The only traps that are enabled
13913 are the ones that cannot be disabled in software (e.g., division by zero
13914 trap).
13916 @item u
13917 In addition to the traps enabled by @samp{n}, underflow traps are enabled
13918 as well.
13920 @item su
13921 Like @samp{u}, but the instructions are marked to be safe for software
13922 completion (see Alpha architecture manual for details).
13924 @item sui
13925 Like @samp{su}, but inexact traps are enabled as well.
13926 @end table
13928 @item -mfp-rounding-mode=@var{rounding-mode}
13929 @opindex mfp-rounding-mode
13930 Selects the IEEE rounding mode.  Other Alpha compilers call this option
13931 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
13934 @table @samp
13935 @item n
13936 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
13937 the nearest machine number or towards the even machine number in case
13938 of a tie.
13940 @item m
13941 Round towards minus infinity.
13943 @item c
13944 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
13946 @item d
13947 Dynamic rounding mode.  A field in the floating-point control register
13948 (@var{fpcr}, see Alpha architecture reference manual) controls the
13949 rounding mode in effect.  The C library initializes this register for
13950 rounding towards plus infinity.  Thus, unless your program modifies the
13951 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
13952 @end table
13954 @item -mtrap-precision=@var{trap-precision}
13955 @opindex mtrap-precision
13956 In the Alpha architecture, floating-point traps are imprecise.  This
13957 means without software assistance it is impossible to recover from a
13958 floating trap and program execution normally needs to be terminated.
13959 GCC can generate code that can assist operating system trap handlers
13960 in determining the exact location that caused a floating-point trap.
13961 Depending on the requirements of an application, different levels of
13962 precisions can be selected:
13964 @table @samp
13965 @item p
13966 Program precision.  This option is the default and means a trap handler
13967 can only identify which program caused a floating-point exception.
13969 @item f
13970 Function precision.  The trap handler can determine the function that
13971 caused a floating-point exception.
13973 @item i
13974 Instruction precision.  The trap handler can determine the exact
13975 instruction that caused a floating-point exception.
13976 @end table
13978 Other Alpha compilers provide the equivalent options called
13979 @option{-scope_safe} and @option{-resumption_safe}.
13981 @item -mieee-conformant
13982 @opindex mieee-conformant
13983 This option marks the generated code as IEEE conformant.  You must not
13984 use this option unless you also specify @option{-mtrap-precision=i} and either
13985 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
13986 is to emit the line @samp{.eflag 48} in the function prologue of the
13987 generated assembly file.
13989 @item -mbuild-constants
13990 @opindex mbuild-constants
13991 Normally GCC examines a 32- or 64-bit integer constant to
13992 see if it can construct it from smaller constants in two or three
13993 instructions.  If it cannot, it outputs the constant as a literal and
13994 generates code to load it from the data segment at run time.
13996 Use this option to require GCC to construct @emph{all} integer constants
13997 using code, even if it takes more instructions (the maximum is six).
13999 You typically use this option to build a shared library dynamic
14000 loader.  Itself a shared library, it must relocate itself in memory
14001 before it can find the variables and constants in its own data segment.
14003 @item -mbwx
14004 @itemx -mno-bwx
14005 @itemx -mcix
14006 @itemx -mno-cix
14007 @itemx -mfix
14008 @itemx -mno-fix
14009 @itemx -mmax
14010 @itemx -mno-max
14011 @opindex mbwx
14012 @opindex mno-bwx
14013 @opindex mcix
14014 @opindex mno-cix
14015 @opindex mfix
14016 @opindex mno-fix
14017 @opindex mmax
14018 @opindex mno-max
14019 Indicate whether GCC should generate code to use the optional BWX,
14020 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14021 sets supported by the CPU type specified via @option{-mcpu=} option or that
14022 of the CPU on which GCC was built if none is specified.
14024 @item -mfloat-vax
14025 @itemx -mfloat-ieee
14026 @opindex mfloat-vax
14027 @opindex mfloat-ieee
14028 Generate code that uses (does not use) VAX F and G floating-point
14029 arithmetic instead of IEEE single and double precision.
14031 @item -mexplicit-relocs
14032 @itemx -mno-explicit-relocs
14033 @opindex mexplicit-relocs
14034 @opindex mno-explicit-relocs
14035 Older Alpha assemblers provided no way to generate symbol relocations
14036 except via assembler macros.  Use of these macros does not allow
14037 optimal instruction scheduling.  GNU binutils as of version 2.12
14038 supports a new syntax that allows the compiler to explicitly mark
14039 which relocations should apply to which instructions.  This option
14040 is mostly useful for debugging, as GCC detects the capabilities of
14041 the assembler when it is built and sets the default accordingly.
14043 @item -msmall-data
14044 @itemx -mlarge-data
14045 @opindex msmall-data
14046 @opindex mlarge-data
14047 When @option{-mexplicit-relocs} is in effect, static data is
14048 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14049 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14050 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14051 16-bit relocations off of the @code{$gp} register.  This limits the
14052 size of the small data area to 64KB, but allows the variables to be
14053 directly accessed via a single instruction.
14055 The default is @option{-mlarge-data}.  With this option the data area
14056 is limited to just below 2GB@.  Programs that require more than 2GB of
14057 data must use @code{malloc} or @code{mmap} to allocate the data in the
14058 heap instead of in the program's data segment.
14060 When generating code for shared libraries, @option{-fpic} implies
14061 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14063 @item -msmall-text
14064 @itemx -mlarge-text
14065 @opindex msmall-text
14066 @opindex mlarge-text
14067 When @option{-msmall-text} is used, the compiler assumes that the
14068 code of the entire program (or shared library) fits in 4MB, and is
14069 thus reachable with a branch instruction.  When @option{-msmall-data}
14070 is used, the compiler can assume that all local symbols share the
14071 same @code{$gp} value, and thus reduce the number of instructions
14072 required for a function call from 4 to 1.
14074 The default is @option{-mlarge-text}.
14076 @item -mcpu=@var{cpu_type}
14077 @opindex mcpu
14078 Set the instruction set and instruction scheduling parameters for
14079 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14080 style name or the corresponding chip number.  GCC supports scheduling
14081 parameters for the EV4, EV5 and EV6 family of processors and
14082 chooses the default values for the instruction set from the processor
14083 you specify.  If you do not specify a processor type, GCC defaults
14084 to the processor on which the compiler was built.
14086 Supported values for @var{cpu_type} are
14088 @table @samp
14089 @item ev4
14090 @itemx ev45
14091 @itemx 21064
14092 Schedules as an EV4 and has no instruction set extensions.
14094 @item ev5
14095 @itemx 21164
14096 Schedules as an EV5 and has no instruction set extensions.
14098 @item ev56
14099 @itemx 21164a
14100 Schedules as an EV5 and supports the BWX extension.
14102 @item pca56
14103 @itemx 21164pc
14104 @itemx 21164PC
14105 Schedules as an EV5 and supports the BWX and MAX extensions.
14107 @item ev6
14108 @itemx 21264
14109 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14111 @item ev67
14112 @itemx 21264a
14113 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14114 @end table
14116 Native toolchains also support the value @samp{native},
14117 which selects the best architecture option for the host processor.
14118 @option{-mcpu=native} has no effect if GCC does not recognize
14119 the processor.
14121 @item -mtune=@var{cpu_type}
14122 @opindex mtune
14123 Set only the instruction scheduling parameters for machine type
14124 @var{cpu_type}.  The instruction set is not changed.
14126 Native toolchains also support the value @samp{native},
14127 which selects the best architecture option for the host processor.
14128 @option{-mtune=native} has no effect if GCC does not recognize
14129 the processor.
14131 @item -mmemory-latency=@var{time}
14132 @opindex mmemory-latency
14133 Sets the latency the scheduler should assume for typical memory
14134 references as seen by the application.  This number is highly
14135 dependent on the memory access patterns used by the application
14136 and the size of the external cache on the machine.
14138 Valid options for @var{time} are
14140 @table @samp
14141 @item @var{number}
14142 A decimal number representing clock cycles.
14144 @item L1
14145 @itemx L2
14146 @itemx L3
14147 @itemx main
14148 The compiler contains estimates of the number of clock cycles for
14149 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14150 (also called Dcache, Scache, and Bcache), as well as to main memory.
14151 Note that L3 is only valid for EV5.
14153 @end table
14154 @end table
14156 @node FR30 Options
14157 @subsection FR30 Options
14158 @cindex FR30 Options
14160 These options are defined specifically for the FR30 port.
14162 @table @gcctabopt
14164 @item -msmall-model
14165 @opindex msmall-model
14166 Use the small address space model.  This can produce smaller code, but
14167 it does assume that all symbolic values and addresses fit into a
14168 20-bit range.
14170 @item -mno-lsim
14171 @opindex mno-lsim
14172 Assume that runtime support has been provided and so there is no need
14173 to include the simulator library (@file{libsim.a}) on the linker
14174 command line.
14176 @end table
14178 @node FRV Options
14179 @subsection FRV Options
14180 @cindex FRV Options
14182 @table @gcctabopt
14183 @item -mgpr-32
14184 @opindex mgpr-32
14186 Only use the first 32 general-purpose registers.
14188 @item -mgpr-64
14189 @opindex mgpr-64
14191 Use all 64 general-purpose registers.
14193 @item -mfpr-32
14194 @opindex mfpr-32
14196 Use only the first 32 floating-point registers.
14198 @item -mfpr-64
14199 @opindex mfpr-64
14201 Use all 64 floating-point registers.
14203 @item -mhard-float
14204 @opindex mhard-float
14206 Use hardware instructions for floating-point operations.
14208 @item -msoft-float
14209 @opindex msoft-float
14211 Use library routines for floating-point operations.
14213 @item -malloc-cc
14214 @opindex malloc-cc
14216 Dynamically allocate condition code registers.
14218 @item -mfixed-cc
14219 @opindex mfixed-cc
14221 Do not try to dynamically allocate condition code registers, only
14222 use @code{icc0} and @code{fcc0}.
14224 @item -mdword
14225 @opindex mdword
14227 Change ABI to use double word insns.
14229 @item -mno-dword
14230 @opindex mno-dword
14232 Do not use double word instructions.
14234 @item -mdouble
14235 @opindex mdouble
14237 Use floating-point double instructions.
14239 @item -mno-double
14240 @opindex mno-double
14242 Do not use floating-point double instructions.
14244 @item -mmedia
14245 @opindex mmedia
14247 Use media instructions.
14249 @item -mno-media
14250 @opindex mno-media
14252 Do not use media instructions.
14254 @item -mmuladd
14255 @opindex mmuladd
14257 Use multiply and add/subtract instructions.
14259 @item -mno-muladd
14260 @opindex mno-muladd
14262 Do not use multiply and add/subtract instructions.
14264 @item -mfdpic
14265 @opindex mfdpic
14267 Select the FDPIC ABI, which uses function descriptors to represent
14268 pointers to functions.  Without any PIC/PIE-related options, it
14269 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14270 assumes GOT entries and small data are within a 12-bit range from the
14271 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14272 are computed with 32 bits.
14273 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14275 @item -minline-plt
14276 @opindex minline-plt
14278 Enable inlining of PLT entries in function calls to functions that are
14279 not known to bind locally.  It has no effect without @option{-mfdpic}.
14280 It's enabled by default if optimizing for speed and compiling for
14281 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14282 optimization option such as @option{-O3} or above is present in the
14283 command line.
14285 @item -mTLS
14286 @opindex mTLS
14288 Assume a large TLS segment when generating thread-local code.
14290 @item -mtls
14291 @opindex mtls
14293 Do not assume a large TLS segment when generating thread-local code.
14295 @item -mgprel-ro
14296 @opindex mgprel-ro
14298 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14299 that is known to be in read-only sections.  It's enabled by default,
14300 except for @option{-fpic} or @option{-fpie}: even though it may help
14301 make the global offset table smaller, it trades 1 instruction for 4.
14302 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14303 one of which may be shared by multiple symbols, and it avoids the need
14304 for a GOT entry for the referenced symbol, so it's more likely to be a
14305 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14307 @item -multilib-library-pic
14308 @opindex multilib-library-pic
14310 Link with the (library, not FD) pic libraries.  It's implied by
14311 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14312 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14313 it explicitly.
14315 @item -mlinked-fp
14316 @opindex mlinked-fp
14318 Follow the EABI requirement of always creating a frame pointer whenever
14319 a stack frame is allocated.  This option is enabled by default and can
14320 be disabled with @option{-mno-linked-fp}.
14322 @item -mlong-calls
14323 @opindex mlong-calls
14325 Use indirect addressing to call functions outside the current
14326 compilation unit.  This allows the functions to be placed anywhere
14327 within the 32-bit address space.
14329 @item -malign-labels
14330 @opindex malign-labels
14332 Try to align labels to an 8-byte boundary by inserting NOPs into the
14333 previous packet.  This option only has an effect when VLIW packing
14334 is enabled.  It doesn't create new packets; it merely adds NOPs to
14335 existing ones.
14337 @item -mlibrary-pic
14338 @opindex mlibrary-pic
14340 Generate position-independent EABI code.
14342 @item -macc-4
14343 @opindex macc-4
14345 Use only the first four media accumulator registers.
14347 @item -macc-8
14348 @opindex macc-8
14350 Use all eight media accumulator registers.
14352 @item -mpack
14353 @opindex mpack
14355 Pack VLIW instructions.
14357 @item -mno-pack
14358 @opindex mno-pack
14360 Do not pack VLIW instructions.
14362 @item -mno-eflags
14363 @opindex mno-eflags
14365 Do not mark ABI switches in e_flags.
14367 @item -mcond-move
14368 @opindex mcond-move
14370 Enable the use of conditional-move instructions (default).
14372 This switch is mainly for debugging the compiler and will likely be removed
14373 in a future version.
14375 @item -mno-cond-move
14376 @opindex mno-cond-move
14378 Disable the use of conditional-move instructions.
14380 This switch is mainly for debugging the compiler and will likely be removed
14381 in a future version.
14383 @item -mscc
14384 @opindex mscc
14386 Enable the use of conditional set instructions (default).
14388 This switch is mainly for debugging the compiler and will likely be removed
14389 in a future version.
14391 @item -mno-scc
14392 @opindex mno-scc
14394 Disable the use of conditional set instructions.
14396 This switch is mainly for debugging the compiler and will likely be removed
14397 in a future version.
14399 @item -mcond-exec
14400 @opindex mcond-exec
14402 Enable the use of conditional execution (default).
14404 This switch is mainly for debugging the compiler and will likely be removed
14405 in a future version.
14407 @item -mno-cond-exec
14408 @opindex mno-cond-exec
14410 Disable the use of conditional execution.
14412 This switch is mainly for debugging the compiler and will likely be removed
14413 in a future version.
14415 @item -mvliw-branch
14416 @opindex mvliw-branch
14418 Run a pass to pack branches into VLIW instructions (default).
14420 This switch is mainly for debugging the compiler and will likely be removed
14421 in a future version.
14423 @item -mno-vliw-branch
14424 @opindex mno-vliw-branch
14426 Do not run a pass to pack branches into VLIW instructions.
14428 This switch is mainly for debugging the compiler and will likely be removed
14429 in a future version.
14431 @item -mmulti-cond-exec
14432 @opindex mmulti-cond-exec
14434 Enable optimization of @code{&&} and @code{||} in conditional execution
14435 (default).
14437 This switch is mainly for debugging the compiler and will likely be removed
14438 in a future version.
14440 @item -mno-multi-cond-exec
14441 @opindex mno-multi-cond-exec
14443 Disable optimization of @code{&&} and @code{||} in conditional execution.
14445 This switch is mainly for debugging the compiler and will likely be removed
14446 in a future version.
14448 @item -mnested-cond-exec
14449 @opindex mnested-cond-exec
14451 Enable nested conditional execution optimizations (default).
14453 This switch is mainly for debugging the compiler and will likely be removed
14454 in a future version.
14456 @item -mno-nested-cond-exec
14457 @opindex mno-nested-cond-exec
14459 Disable nested conditional execution optimizations.
14461 This switch is mainly for debugging the compiler and will likely be removed
14462 in a future version.
14464 @item -moptimize-membar
14465 @opindex moptimize-membar
14467 This switch removes redundant @code{membar} instructions from the
14468 compiler-generated code.  It is enabled by default.
14470 @item -mno-optimize-membar
14471 @opindex mno-optimize-membar
14473 This switch disables the automatic removal of redundant @code{membar}
14474 instructions from the generated code.
14476 @item -mtomcat-stats
14477 @opindex mtomcat-stats
14479 Cause gas to print out tomcat statistics.
14481 @item -mcpu=@var{cpu}
14482 @opindex mcpu
14484 Select the processor type for which to generate code.  Possible values are
14485 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14486 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14488 @end table
14490 @node GNU/Linux Options
14491 @subsection GNU/Linux Options
14493 These @samp{-m} options are defined for GNU/Linux targets:
14495 @table @gcctabopt
14496 @item -mglibc
14497 @opindex mglibc
14498 Use the GNU C library.  This is the default except
14499 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14501 @item -muclibc
14502 @opindex muclibc
14503 Use uClibc C library.  This is the default on
14504 @samp{*-*-linux-*uclibc*} targets.
14506 @item -mbionic
14507 @opindex mbionic
14508 Use Bionic C library.  This is the default on
14509 @samp{*-*-linux-*android*} targets.
14511 @item -mandroid
14512 @opindex mandroid
14513 Compile code compatible with Android platform.  This is the default on
14514 @samp{*-*-linux-*android*} targets.
14516 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14517 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14518 this option makes the GCC driver pass Android-specific options to the linker.
14519 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14520 to be defined.
14522 @item -tno-android-cc
14523 @opindex tno-android-cc
14524 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14525 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14526 @option{-fno-rtti} by default.
14528 @item -tno-android-ld
14529 @opindex tno-android-ld
14530 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14531 linking options to the linker.
14533 @end table
14535 @node H8/300 Options
14536 @subsection H8/300 Options
14538 These @samp{-m} options are defined for the H8/300 implementations:
14540 @table @gcctabopt
14541 @item -mrelax
14542 @opindex mrelax
14543 Shorten some address references at link time, when possible; uses the
14544 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14545 ld, Using ld}, for a fuller description.
14547 @item -mh
14548 @opindex mh
14549 Generate code for the H8/300H@.
14551 @item -ms
14552 @opindex ms
14553 Generate code for the H8S@.
14555 @item -mn
14556 @opindex mn
14557 Generate code for the H8S and H8/300H in the normal mode.  This switch
14558 must be used either with @option{-mh} or @option{-ms}.
14560 @item -ms2600
14561 @opindex ms2600
14562 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14564 @item -mexr
14565 @opindex mexr
14566 Extended registers are stored on stack before execution of function
14567 with monitor attribute. Default option is @option{-mexr}.
14568 This option is valid only for H8S targets.
14570 @item -mno-exr
14571 @opindex mno-exr
14572 Extended registers are not stored on stack before execution of function 
14573 with monitor attribute. Default option is @option{-mno-exr}. 
14574 This option is valid only for H8S targets.
14576 @item -mint32
14577 @opindex mint32
14578 Make @code{int} data 32 bits by default.
14580 @item -malign-300
14581 @opindex malign-300
14582 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
14583 The default for the H8/300H and H8S is to align longs and floats on
14584 4-byte boundaries.
14585 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
14586 This option has no effect on the H8/300.
14587 @end table
14589 @node HPPA Options
14590 @subsection HPPA Options
14591 @cindex HPPA Options
14593 These @samp{-m} options are defined for the HPPA family of computers:
14595 @table @gcctabopt
14596 @item -march=@var{architecture-type}
14597 @opindex march
14598 Generate code for the specified architecture.  The choices for
14599 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
14600 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
14601 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
14602 architecture option for your machine.  Code compiled for lower numbered
14603 architectures runs on higher numbered architectures, but not the
14604 other way around.
14606 @item -mpa-risc-1-0
14607 @itemx -mpa-risc-1-1
14608 @itemx -mpa-risc-2-0
14609 @opindex mpa-risc-1-0
14610 @opindex mpa-risc-1-1
14611 @opindex mpa-risc-2-0
14612 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
14614 @item -mjump-in-delay
14615 @opindex mjump-in-delay
14616 Fill delay slots of function calls with unconditional jump instructions
14617 by modifying the return pointer for the function call to be the target
14618 of the conditional jump.
14620 @item -mdisable-fpregs
14621 @opindex mdisable-fpregs
14622 Prevent floating-point registers from being used in any manner.  This is
14623 necessary for compiling kernels that perform lazy context switching of
14624 floating-point registers.  If you use this option and attempt to perform
14625 floating-point operations, the compiler aborts.
14627 @item -mdisable-indexing
14628 @opindex mdisable-indexing
14629 Prevent the compiler from using indexing address modes.  This avoids some
14630 rather obscure problems when compiling MIG generated code under MACH@.
14632 @item -mno-space-regs
14633 @opindex mno-space-regs
14634 Generate code that assumes the target has no space registers.  This allows
14635 GCC to generate faster indirect calls and use unscaled index address modes.
14637 Such code is suitable for level 0 PA systems and kernels.
14639 @item -mfast-indirect-calls
14640 @opindex mfast-indirect-calls
14641 Generate code that assumes calls never cross space boundaries.  This
14642 allows GCC to emit code that performs faster indirect calls.
14644 This option does not work in the presence of shared libraries or nested
14645 functions.
14647 @item -mfixed-range=@var{register-range}
14648 @opindex mfixed-range
14649 Generate code treating the given register range as fixed registers.
14650 A fixed register is one that the register allocator cannot use.  This is
14651 useful when compiling kernel code.  A register range is specified as
14652 two registers separated by a dash.  Multiple register ranges can be
14653 specified separated by a comma.
14655 @item -mlong-load-store
14656 @opindex mlong-load-store
14657 Generate 3-instruction load and store sequences as sometimes required by
14658 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
14659 the HP compilers.
14661 @item -mportable-runtime
14662 @opindex mportable-runtime
14663 Use the portable calling conventions proposed by HP for ELF systems.
14665 @item -mgas
14666 @opindex mgas
14667 Enable the use of assembler directives only GAS understands.
14669 @item -mschedule=@var{cpu-type}
14670 @opindex mschedule
14671 Schedule code according to the constraints for the machine type
14672 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
14673 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
14674 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
14675 proper scheduling option for your machine.  The default scheduling is
14676 @samp{8000}.
14678 @item -mlinker-opt
14679 @opindex mlinker-opt
14680 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
14681 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
14682 linkers in which they give bogus error messages when linking some programs.
14684 @item -msoft-float
14685 @opindex msoft-float
14686 Generate output containing library calls for floating point.
14687 @strong{Warning:} the requisite libraries are not available for all HPPA
14688 targets.  Normally the facilities of the machine's usual C compiler are
14689 used, but this cannot be done directly in cross-compilation.  You must make
14690 your own arrangements to provide suitable library functions for
14691 cross-compilation.
14693 @option{-msoft-float} changes the calling convention in the output file;
14694 therefore, it is only useful if you compile @emph{all} of a program with
14695 this option.  In particular, you need to compile @file{libgcc.a}, the
14696 library that comes with GCC, with @option{-msoft-float} in order for
14697 this to work.
14699 @item -msio
14700 @opindex msio
14701 Generate the predefine, @code{_SIO}, for server IO@.  The default is
14702 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
14703 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
14704 options are available under HP-UX and HI-UX@.
14706 @item -mgnu-ld
14707 @opindex mgnu-ld
14708 Use options specific to GNU @command{ld}.
14709 This passes @option{-shared} to @command{ld} when
14710 building a shared library.  It is the default when GCC is configured,
14711 explicitly or implicitly, with the GNU linker.  This option does not
14712 affect which @command{ld} is called; it only changes what parameters
14713 are passed to that @command{ld}.
14714 The @command{ld} that is called is determined by the
14715 @option{--with-ld} configure option, GCC's program search path, and
14716 finally by the user's @env{PATH}.  The linker used by GCC can be printed
14717 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
14718 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14720 @item -mhp-ld
14721 @opindex mhp-ld
14722 Use options specific to HP @command{ld}.
14723 This passes @option{-b} to @command{ld} when building
14724 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
14725 links.  It is the default when GCC is configured, explicitly or
14726 implicitly, with the HP linker.  This option does not affect
14727 which @command{ld} is called; it only changes what parameters are passed to that
14728 @command{ld}.
14729 The @command{ld} that is called is determined by the @option{--with-ld}
14730 configure option, GCC's program search path, and finally by the user's
14731 @env{PATH}.  The linker used by GCC can be printed using @samp{which
14732 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
14733 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14735 @item -mlong-calls
14736 @opindex mno-long-calls
14737 Generate code that uses long call sequences.  This ensures that a call
14738 is always able to reach linker generated stubs.  The default is to generate
14739 long calls only when the distance from the call site to the beginning
14740 of the function or translation unit, as the case may be, exceeds a
14741 predefined limit set by the branch type being used.  The limits for
14742 normal calls are 7,600,000 and 240,000 bytes, respectively for the
14743 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
14744 240,000 bytes.
14746 Distances are measured from the beginning of functions when using the
14747 @option{-ffunction-sections} option, or when using the @option{-mgas}
14748 and @option{-mno-portable-runtime} options together under HP-UX with
14749 the SOM linker.
14751 It is normally not desirable to use this option as it degrades
14752 performance.  However, it may be useful in large applications,
14753 particularly when partial linking is used to build the application.
14755 The types of long calls used depends on the capabilities of the
14756 assembler and linker, and the type of code being generated.  The
14757 impact on systems that support long absolute calls, and long pic
14758 symbol-difference or pc-relative calls should be relatively small.
14759 However, an indirect call is used on 32-bit ELF systems in pic code
14760 and it is quite long.
14762 @item -munix=@var{unix-std}
14763 @opindex march
14764 Generate compiler predefines and select a startfile for the specified
14765 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
14766 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
14767 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
14768 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
14769 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
14770 and later.
14772 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
14773 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
14774 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
14775 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
14776 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
14777 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
14779 It is @emph{important} to note that this option changes the interfaces
14780 for various library routines.  It also affects the operational behavior
14781 of the C library.  Thus, @emph{extreme} care is needed in using this
14782 option.
14784 Library code that is intended to operate with more than one UNIX
14785 standard must test, set and restore the variable @var{__xpg4_extended_mask}
14786 as appropriate.  Most GNU software doesn't provide this capability.
14788 @item -nolibdld
14789 @opindex nolibdld
14790 Suppress the generation of link options to search libdld.sl when the
14791 @option{-static} option is specified on HP-UX 10 and later.
14793 @item -static
14794 @opindex static
14795 The HP-UX implementation of setlocale in libc has a dependency on
14796 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
14797 when the @option{-static} option is specified, special link options
14798 are needed to resolve this dependency.
14800 On HP-UX 10 and later, the GCC driver adds the necessary options to
14801 link with libdld.sl when the @option{-static} option is specified.
14802 This causes the resulting binary to be dynamic.  On the 64-bit port,
14803 the linkers generate dynamic binaries by default in any case.  The
14804 @option{-nolibdld} option can be used to prevent the GCC driver from
14805 adding these link options.
14807 @item -threads
14808 @opindex threads
14809 Add support for multithreading with the @dfn{dce thread} library
14810 under HP-UX@.  This option sets flags for both the preprocessor and
14811 linker.
14812 @end table
14814 @node i386 and x86-64 Options
14815 @subsection Intel 386 and AMD x86-64 Options
14816 @cindex i386 Options
14817 @cindex x86-64 Options
14818 @cindex Intel 386 Options
14819 @cindex AMD x86-64 Options
14821 These @samp{-m} options are defined for the i386 and x86-64 family of
14822 computers:
14824 @table @gcctabopt
14826 @item -march=@var{cpu-type}
14827 @opindex march
14828 Generate instructions for the machine type @var{cpu-type}.  In contrast to
14829 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
14830 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
14831 to generate code that may not run at all on processors other than the one
14832 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
14833 @option{-mtune=@var{cpu-type}}.
14835 The choices for @var{cpu-type} are:
14837 @table @samp
14838 @item native
14839 This selects the CPU to generate code for at compilation time by determining
14840 the processor type of the compiling machine.  Using @option{-march=native}
14841 enables all instruction subsets supported by the local machine (hence
14842 the result might not run on different machines).  Using @option{-mtune=native}
14843 produces code optimized for the local machine under the constraints
14844 of the selected instruction set.  
14846 @item i386
14847 Original Intel i386 CPU@.
14849 @item i486
14850 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
14852 @item i586
14853 @itemx pentium
14854 Intel Pentium CPU with no MMX support.
14856 @item pentium-mmx
14857 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
14859 @item pentiumpro
14860 Intel Pentium Pro CPU@.
14862 @item i686
14863 When used with @option{-march}, the Pentium Pro
14864 instruction set is used, so the code runs on all i686 family chips.
14865 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
14867 @item pentium2
14868 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
14869 support.
14871 @item pentium3
14872 @itemx pentium3m
14873 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
14874 set support.
14876 @item pentium-m
14877 Intel Pentium M; low-power version of Intel Pentium III CPU
14878 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
14880 @item pentium4
14881 @itemx pentium4m
14882 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
14884 @item prescott
14885 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
14886 set support.
14888 @item nocona
14889 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
14890 SSE2 and SSE3 instruction set support.
14892 @item core2
14893 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
14894 instruction set support.
14896 @item nehalem
14897 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14898 SSE4.1, SSE4.2 and POPCNT instruction set support.
14900 @item westmere
14901 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14902 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
14904 @item sandybridge
14905 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14906 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
14908 @item ivybridge
14909 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14910 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
14911 instruction set support.
14913 @item haswell
14914 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14915 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
14916 BMI, BMI2 and F16C instruction set support.
14918 @item broadwell
14919 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14920 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
14921 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
14923 @item bonnell
14924 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
14925 instruction set support.
14927 @item silvermont
14928 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14929 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
14931 @item k6
14932 AMD K6 CPU with MMX instruction set support.
14934 @item k6-2
14935 @itemx k6-3
14936 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
14938 @item athlon
14939 @itemx athlon-tbird
14940 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
14941 support.
14943 @item athlon-4
14944 @itemx athlon-xp
14945 @itemx athlon-mp
14946 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
14947 instruction set support.
14949 @item k8
14950 @itemx opteron
14951 @itemx athlon64
14952 @itemx athlon-fx
14953 Processors based on the AMD K8 core with x86-64 instruction set support,
14954 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
14955 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
14956 instruction set extensions.)
14958 @item k8-sse3
14959 @itemx opteron-sse3
14960 @itemx athlon64-sse3
14961 Improved versions of AMD K8 cores with SSE3 instruction set support.
14963 @item amdfam10
14964 @itemx barcelona
14965 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
14966 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
14967 instruction set extensions.)
14969 @item bdver1
14970 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
14971 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
14972 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
14973 @item bdver2
14974 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14975 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
14976 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
14977 extensions.)
14978 @item bdver3
14979 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14980 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
14981 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
14982 64-bit instruction set extensions.
14983 @item bdver4
14984 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14985 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
14986 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
14987 SSE4.2, ABM and 64-bit instruction set extensions.
14989 @item btver1
14990 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
14991 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
14992 instruction set extensions.)
14994 @item btver2
14995 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
14996 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
14997 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
14999 @item winchip-c6
15000 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15001 set support.
15003 @item winchip2
15004 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15005 instruction set support.
15007 @item c3
15008 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15009 implemented for this chip.)
15011 @item c3-2
15012 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15013 (No scheduling is
15014 implemented for this chip.)
15016 @item geode
15017 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15018 @end table
15020 @item -mtune=@var{cpu-type}
15021 @opindex mtune
15022 Tune to @var{cpu-type} everything applicable about the generated code, except
15023 for the ABI and the set of available instructions.  
15024 While picking a specific @var{cpu-type} schedules things appropriately
15025 for that particular chip, the compiler does not generate any code that
15026 cannot run on the default machine type unless you use a
15027 @option{-march=@var{cpu-type}} option.
15028 For example, if GCC is configured for i686-pc-linux-gnu
15029 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15030 but still runs on i686 machines.
15032 The choices for @var{cpu-type} are the same as for @option{-march}.
15033 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15035 @table @samp
15036 @item generic
15037 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15038 If you know the CPU on which your code will run, then you should use
15039 the corresponding @option{-mtune} or @option{-march} option instead of
15040 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15041 of your application will have, then you should use this option.
15043 As new processors are deployed in the marketplace, the behavior of this
15044 option will change.  Therefore, if you upgrade to a newer version of
15045 GCC, code generation controlled by this option will change to reflect
15046 the processors
15047 that are most common at the time that version of GCC is released.
15049 There is no @option{-march=generic} option because @option{-march}
15050 indicates the instruction set the compiler can use, and there is no
15051 generic instruction set applicable to all processors.  In contrast,
15052 @option{-mtune} indicates the processor (or, in this case, collection of
15053 processors) for which the code is optimized.
15055 @item intel
15056 Produce code optimized for the most current Intel processors, which are
15057 Haswell and Silvermont for this version of GCC.  If you know the CPU
15058 on which your code will run, then you should use the corresponding
15059 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15060 But, if you want your application performs better on both Haswell and
15061 Silvermont, then you should use this option.
15063 As new Intel processors are deployed in the marketplace, the behavior of
15064 this option will change.  Therefore, if you upgrade to a newer version of
15065 GCC, code generation controlled by this option will change to reflect
15066 the most current Intel processors at the time that version of GCC is
15067 released.
15069 There is no @option{-march=intel} option because @option{-march} indicates
15070 the instruction set the compiler can use, and there is no common
15071 instruction set applicable to all processors.  In contrast,
15072 @option{-mtune} indicates the processor (or, in this case, collection of
15073 processors) for which the code is optimized.
15074 @end table
15076 @item -mcpu=@var{cpu-type}
15077 @opindex mcpu
15078 A deprecated synonym for @option{-mtune}.
15080 @item -mfpmath=@var{unit}
15081 @opindex mfpmath
15082 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15083 for @var{unit} are:
15085 @table @samp
15086 @item 387
15087 Use the standard 387 floating-point coprocessor present on the majority of chips and
15088 emulated otherwise.  Code compiled with this option runs almost everywhere.
15089 The temporary results are computed in 80-bit precision instead of the precision
15090 specified by the type, resulting in slightly different results compared to most
15091 of other chips.  See @option{-ffloat-store} for more detailed description.
15093 This is the default choice for i386 compiler.
15095 @item sse
15096 Use scalar floating-point instructions present in the SSE instruction set.
15097 This instruction set is supported by Pentium III and newer chips,
15098 and in the AMD line
15099 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15100 instruction set supports only single-precision arithmetic, thus the double and
15101 extended-precision arithmetic are still done using 387.  A later version, present
15102 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15103 arithmetic too.
15105 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15106 or @option{-msse2} switches to enable SSE extensions and make this option
15107 effective.  For the x86-64 compiler, these extensions are enabled by default.
15109 The resulting code should be considerably faster in the majority of cases and avoid
15110 the numerical instability problems of 387 code, but may break some existing
15111 code that expects temporaries to be 80 bits.
15113 This is the default choice for the x86-64 compiler.
15115 @item sse,387
15116 @itemx sse+387
15117 @itemx both
15118 Attempt to utilize both instruction sets at once.  This effectively doubles the
15119 amount of available registers, and on chips with separate execution units for
15120 387 and SSE the execution resources too.  Use this option with care, as it is
15121 still experimental, because the GCC register allocator does not model separate
15122 functional units well, resulting in unstable performance.
15123 @end table
15125 @item -masm=@var{dialect}
15126 @opindex masm=@var{dialect}
15127 Output assembly instructions using selected @var{dialect}.  Supported
15128 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15129 not support @samp{intel}.
15131 @item -mieee-fp
15132 @itemx -mno-ieee-fp
15133 @opindex mieee-fp
15134 @opindex mno-ieee-fp
15135 Control whether or not the compiler uses IEEE floating-point
15136 comparisons.  These correctly handle the case where the result of a
15137 comparison is unordered.
15139 @item -msoft-float
15140 @opindex msoft-float
15141 Generate output containing library calls for floating point.
15143 @strong{Warning:} the requisite libraries are not part of GCC@.
15144 Normally the facilities of the machine's usual C compiler are used, but
15145 this can't be done directly in cross-compilation.  You must make your
15146 own arrangements to provide suitable library functions for
15147 cross-compilation.
15149 On machines where a function returns floating-point results in the 80387
15150 register stack, some floating-point opcodes may be emitted even if
15151 @option{-msoft-float} is used.
15153 @item -mno-fp-ret-in-387
15154 @opindex mno-fp-ret-in-387
15155 Do not use the FPU registers for return values of functions.
15157 The usual calling convention has functions return values of types
15158 @code{float} and @code{double} in an FPU register, even if there
15159 is no FPU@.  The idea is that the operating system should emulate
15160 an FPU@.
15162 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15163 in ordinary CPU registers instead.
15165 @item -mno-fancy-math-387
15166 @opindex mno-fancy-math-387
15167 Some 387 emulators do not support the @code{sin}, @code{cos} and
15168 @code{sqrt} instructions for the 387.  Specify this option to avoid
15169 generating those instructions.  This option is the default on FreeBSD,
15170 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15171 indicates that the target CPU always has an FPU and so the
15172 instruction does not need emulation.  These
15173 instructions are not generated unless you also use the
15174 @option{-funsafe-math-optimizations} switch.
15176 @item -malign-double
15177 @itemx -mno-align-double
15178 @opindex malign-double
15179 @opindex mno-align-double
15180 Control whether GCC aligns @code{double}, @code{long double}, and
15181 @code{long long} variables on a two-word boundary or a one-word
15182 boundary.  Aligning @code{double} variables on a two-word boundary
15183 produces code that runs somewhat faster on a Pentium at the
15184 expense of more memory.
15186 On x86-64, @option{-malign-double} is enabled by default.
15188 @strong{Warning:} if you use the @option{-malign-double} switch,
15189 structures containing the above types are aligned differently than
15190 the published application binary interface specifications for the 386
15191 and are not binary compatible with structures in code compiled
15192 without that switch.
15194 @item -m96bit-long-double
15195 @itemx -m128bit-long-double
15196 @opindex m96bit-long-double
15197 @opindex m128bit-long-double
15198 These switches control the size of @code{long double} type.  The i386
15199 application binary interface specifies the size to be 96 bits,
15200 so @option{-m96bit-long-double} is the default in 32-bit mode.
15202 Modern architectures (Pentium and newer) prefer @code{long double}
15203 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15204 conforming to the ABI, this is not possible.  So specifying
15205 @option{-m128bit-long-double} aligns @code{long double}
15206 to a 16-byte boundary by padding the @code{long double} with an additional
15207 32-bit zero.
15209 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15210 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15212 Notice that neither of these options enable any extra precision over the x87
15213 standard of 80 bits for a @code{long double}.
15215 @strong{Warning:} if you override the default value for your target ABI, this
15216 changes the size of 
15217 structures and arrays containing @code{long double} variables,
15218 as well as modifying the function calling convention for functions taking
15219 @code{long double}.  Hence they are not binary-compatible
15220 with code compiled without that switch.
15222 @item -mlong-double-64
15223 @itemx -mlong-double-80
15224 @itemx -mlong-double-128
15225 @opindex mlong-double-64
15226 @opindex mlong-double-80
15227 @opindex mlong-double-128
15228 These switches control the size of @code{long double} type. A size
15229 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15230 type. This is the default for 32-bit Bionic C library.  A size
15231 of 128 bits makes the @code{long double} type equivalent to the
15232 @code{__float128} type. This is the default for 64-bit Bionic C library.
15234 @strong{Warning:} if you override the default value for your target ABI, this
15235 changes the size of
15236 structures and arrays containing @code{long double} variables,
15237 as well as modifying the function calling convention for functions taking
15238 @code{long double}.  Hence they are not binary-compatible
15239 with code compiled without that switch.
15241 @item -mlarge-data-threshold=@var{threshold}
15242 @opindex mlarge-data-threshold
15243 When @option{-mcmodel=medium} is specified, data objects larger than
15244 @var{threshold} are placed in the large data section.  This value must be the
15245 same across all objects linked into the binary, and defaults to 65535.
15247 @item -mrtd
15248 @opindex mrtd
15249 Use a different function-calling convention, in which functions that
15250 take a fixed number of arguments return with the @code{ret @var{num}}
15251 instruction, which pops their arguments while returning.  This saves one
15252 instruction in the caller since there is no need to pop the arguments
15253 there.
15255 You can specify that an individual function is called with this calling
15256 sequence with the function attribute @samp{stdcall}.  You can also
15257 override the @option{-mrtd} option by using the function attribute
15258 @samp{cdecl}.  @xref{Function Attributes}.
15260 @strong{Warning:} this calling convention is incompatible with the one
15261 normally used on Unix, so you cannot use it if you need to call
15262 libraries compiled with the Unix compiler.
15264 Also, you must provide function prototypes for all functions that
15265 take variable numbers of arguments (including @code{printf});
15266 otherwise incorrect code is generated for calls to those
15267 functions.
15269 In addition, seriously incorrect code results if you call a
15270 function with too many arguments.  (Normally, extra arguments are
15271 harmlessly ignored.)
15273 @item -mregparm=@var{num}
15274 @opindex mregparm
15275 Control how many registers are used to pass integer arguments.  By
15276 default, no registers are used to pass arguments, and at most 3
15277 registers can be used.  You can control this behavior for a specific
15278 function by using the function attribute @samp{regparm}.
15279 @xref{Function Attributes}.
15281 @strong{Warning:} if you use this switch, and
15282 @var{num} is nonzero, then you must build all modules with the same
15283 value, including any libraries.  This includes the system libraries and
15284 startup modules.
15286 @item -msseregparm
15287 @opindex msseregparm
15288 Use SSE register passing conventions for float and double arguments
15289 and return values.  You can control this behavior for a specific
15290 function by using the function attribute @samp{sseregparm}.
15291 @xref{Function Attributes}.
15293 @strong{Warning:} if you use this switch then you must build all
15294 modules with the same value, including any libraries.  This includes
15295 the system libraries and startup modules.
15297 @item -mvect8-ret-in-mem
15298 @opindex mvect8-ret-in-mem
15299 Return 8-byte vectors in memory instead of MMX registers.  This is the
15300 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15301 Studio compilers until version 12.  Later compiler versions (starting
15302 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15303 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15304 you need to remain compatible with existing code produced by those
15305 previous compiler versions or older versions of GCC@.
15307 @item -mpc32
15308 @itemx -mpc64
15309 @itemx -mpc80
15310 @opindex mpc32
15311 @opindex mpc64
15312 @opindex mpc80
15314 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15315 is specified, the significands of results of floating-point operations are
15316 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15317 significands of results of floating-point operations to 53 bits (double
15318 precision) and @option{-mpc80} rounds the significands of results of
15319 floating-point operations to 64 bits (extended double precision), which is
15320 the default.  When this option is used, floating-point operations in higher
15321 precisions are not available to the programmer without setting the FPU
15322 control word explicitly.
15324 Setting the rounding of floating-point operations to less than the default
15325 80 bits can speed some programs by 2% or more.  Note that some mathematical
15326 libraries assume that extended-precision (80-bit) floating-point operations
15327 are enabled by default; routines in such libraries could suffer significant
15328 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15329 when this option is used to set the precision to less than extended precision.
15331 @item -mstackrealign
15332 @opindex mstackrealign
15333 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15334 option generates an alternate prologue and epilogue that realigns the
15335 run-time stack if necessary.  This supports mixing legacy codes that keep
15336 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15337 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15338 applicable to individual functions.
15340 @item -mpreferred-stack-boundary=@var{num}
15341 @opindex mpreferred-stack-boundary
15342 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15343 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15344 the default is 4 (16 bytes or 128 bits).
15346 @strong{Warning:} When generating code for the x86-64 architecture with
15347 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15348 used to keep the stack boundary aligned to 8 byte boundary.  Since
15349 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15350 intended to be used in controlled environment where stack space is
15351 important limitation.  This option will lead to wrong code when functions
15352 compiled with 16 byte stack alignment (such as functions from a standard
15353 library) are called with misaligned stack.  In this case, SSE
15354 instructions may lead to misaligned memory access traps.  In addition,
15355 variable arguments will be handled incorrectly for 16 byte aligned
15356 objects (including x87 long double and __int128), leading to wrong
15357 results.  You must build all modules with
15358 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15359 includes the system libraries and startup modules.
15361 @item -mincoming-stack-boundary=@var{num}
15362 @opindex mincoming-stack-boundary
15363 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15364 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15365 the one specified by @option{-mpreferred-stack-boundary} is used.
15367 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15368 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15369 suffer significant run time performance penalties.  On Pentium III, the
15370 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15371 properly if it is not 16-byte aligned.
15373 To ensure proper alignment of this values on the stack, the stack boundary
15374 must be as aligned as that required by any value stored on the stack.
15375 Further, every function must be generated such that it keeps the stack
15376 aligned.  Thus calling a function compiled with a higher preferred
15377 stack boundary from a function compiled with a lower preferred stack
15378 boundary most likely misaligns the stack.  It is recommended that
15379 libraries that use callbacks always use the default setting.
15381 This extra alignment does consume extra stack space, and generally
15382 increases code size.  Code that is sensitive to stack space usage, such
15383 as embedded systems and operating system kernels, may want to reduce the
15384 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15386 @item -mmmx
15387 @itemx -mno-mmx
15388 @itemx -msse
15389 @itemx -mno-sse
15390 @itemx -msse2
15391 @itemx -mno-sse2
15392 @itemx -msse3
15393 @itemx -mno-sse3
15394 @itemx -mssse3
15395 @itemx -mno-ssse3
15396 @itemx -msse4.1
15397 @need 800
15398 @itemx -mno-sse4.1
15399 @itemx -msse4.2
15400 @itemx -mno-sse4.2
15401 @itemx -msse4
15402 @itemx -mno-sse4
15403 @itemx -mavx
15404 @itemx -mno-avx
15405 @itemx -mavx2
15406 @itemx -mno-avx2
15407 @itemx -mavx512f
15408 @itemx -mno-avx512f
15409 @need 800
15410 @itemx -mavx512pf
15411 @itemx -mno-avx512pf
15412 @itemx -mavx512er
15413 @itemx -mno-avx512er
15414 @itemx -mavx512cd
15415 @itemx -mno-avx512cd
15416 @itemx -msha
15417 @itemx -mno-sha
15418 @itemx -maes
15419 @itemx -mno-aes
15420 @itemx -mpclmul
15421 @itemx -mno-pclmul
15422 @itemx -mclfushopt
15423 @itemx -mno-clflsuhopt
15424 @need 800
15425 @itemx -mfsgsbase
15426 @itemx -mno-fsgsbase
15427 @itemx -mrdrnd
15428 @itemx -mno-rdrnd
15429 @itemx -mf16c
15430 @itemx -mno-f16c
15431 @itemx -mfma
15432 @itemx -mno-fma
15433 @itemx -mprefetchwt1
15434 @itemx -mno-prefetchwt1
15435 @itemx -msse4a
15436 @itemx -mno-sse4a
15437 @itemx -mfma4
15438 @itemx -mno-fma4
15439 @need 800
15440 @itemx -mxop
15441 @itemx -mno-xop
15442 @itemx -mlwp
15443 @itemx -mno-lwp
15444 @itemx -m3dnow
15445 @itemx -mno-3dnow
15446 @itemx -mpopcnt
15447 @itemx -mno-popcnt
15448 @itemx -mabm
15449 @itemx -mno-abm
15450 @itemx -mbmi
15451 @itemx -mbmi2
15452 @itemx -mno-bmi
15453 @itemx -mno-bmi2
15454 @itemx -mlzcnt
15455 @itemx -mno-lzcnt
15456 @itemx -mfxsr
15457 @itemx -mxsave
15458 @itemx -mxsaveopt
15459 @itemx -mrtm
15460 @itemx -mtbm
15461 @itemx -mno-tbm
15462 @itemx -mxsavec
15463 @itemx -mno-xsavec
15464 @itemx -mxsaves
15465 @itemx -mno-xsaves
15466 @opindex mmmx
15467 @opindex mno-mmx
15468 @opindex msse
15469 @opindex mno-sse
15470 @opindex m3dnow
15471 @opindex mno-3dnow
15472 These switches enable or disable the use of instructions in the MMX, SSE,
15473 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15474 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15475 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, or 3DNow!@:
15476 extended instruction sets.
15477 These extensions are also available as built-in functions: see
15478 @ref{X86 Built-in Functions}, for details of the functions enabled and
15479 disabled by these switches.
15481 To generate SSE/SSE2 instructions automatically from floating-point
15482 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15484 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15485 generates new AVX instructions or AVX equivalence for all SSEx instructions
15486 when needed.
15488 These options enable GCC to use these extended instructions in
15489 generated code, even without @option{-mfpmath=sse}.  Applications that
15490 perform run-time CPU detection must compile separate files for each
15491 supported architecture, using the appropriate flags.  In particular,
15492 the file containing the CPU detection code should be compiled without
15493 these options.
15495 @item -mdump-tune-features
15496 @opindex mdump-tune-features
15497 This option instructs GCC to dump the names of the x86 performance 
15498 tuning features and default settings. The names can be used in 
15499 @option{-mtune-ctrl=@var{feature-list}}.
15501 @item -mtune-ctrl=@var{feature-list}
15502 @opindex mtune-ctrl=@var{feature-list}
15503 This option is used to do fine grain control of x86 code generation features.
15504 @var{feature-list} is a comma separated list of @var{feature} names. See also
15505 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15506 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15507 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15508 developers. Using it may lead to code paths not covered by testing and can
15509 potentially result in compiler ICEs or runtime errors.
15511 @item -mno-default
15512 @opindex mno-default
15513 This option instructs GCC to turn off all tunable features. See also 
15514 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15516 @item -mcld
15517 @opindex mcld
15518 This option instructs GCC to emit a @code{cld} instruction in the prologue
15519 of functions that use string instructions.  String instructions depend on
15520 the DF flag to select between autoincrement or autodecrement mode.  While the
15521 ABI specifies the DF flag to be cleared on function entry, some operating
15522 systems violate this specification by not clearing the DF flag in their
15523 exception dispatchers.  The exception handler can be invoked with the DF flag
15524 set, which leads to wrong direction mode when string instructions are used.
15525 This option can be enabled by default on 32-bit x86 targets by configuring
15526 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15527 instructions can be suppressed with the @option{-mno-cld} compiler option
15528 in this case.
15530 @item -mvzeroupper
15531 @opindex mvzeroupper
15532 This option instructs GCC to emit a @code{vzeroupper} instruction
15533 before a transfer of control flow out of the function to minimize
15534 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15535 intrinsics.
15537 @item -mprefer-avx128
15538 @opindex mprefer-avx128
15539 This option instructs GCC to use 128-bit AVX instructions instead of
15540 256-bit AVX instructions in the auto-vectorizer.
15542 @item -mcx16
15543 @opindex mcx16
15544 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15545 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15546 (or oword) data types.  
15547 This is useful for high-resolution counters that can be updated
15548 by multiple processors (or cores).  This instruction is generated as part of
15549 atomic built-in functions: see @ref{__sync Builtins} or
15550 @ref{__atomic Builtins} for details.
15552 @item -msahf
15553 @opindex msahf
15554 This option enables generation of @code{SAHF} instructions in 64-bit code.
15555 Early Intel Pentium 4 CPUs with Intel 64 support,
15556 prior to the introduction of Pentium 4 G1 step in December 2005,
15557 lacked the @code{LAHF} and @code{SAHF} instructions
15558 which were supported by AMD64.
15559 These are load and store instructions, respectively, for certain status flags.
15560 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15561 @code{drem}, and @code{remainder} built-in functions;
15562 see @ref{Other Builtins} for details.
15564 @item -mmovbe
15565 @opindex mmovbe
15566 This option enables use of the @code{movbe} instruction to implement
15567 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15569 @item -mcrc32
15570 @opindex mcrc32
15571 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15572 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15573 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15575 @item -mrecip
15576 @opindex mrecip
15577 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
15578 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
15579 with an additional Newton-Raphson step
15580 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
15581 (and their vectorized
15582 variants) for single-precision floating-point arguments.  These instructions
15583 are generated only when @option{-funsafe-math-optimizations} is enabled
15584 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
15585 Note that while the throughput of the sequence is higher than the throughput
15586 of the non-reciprocal instruction, the precision of the sequence can be
15587 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
15589 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
15590 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
15591 combination), and doesn't need @option{-mrecip}.
15593 Also note that GCC emits the above sequence with additional Newton-Raphson step
15594 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
15595 already with @option{-ffast-math} (or the above option combination), and
15596 doesn't need @option{-mrecip}.
15598 @item -mrecip=@var{opt}
15599 @opindex mrecip=opt
15600 This option controls which reciprocal estimate instructions
15601 may be used.  @var{opt} is a comma-separated list of options, which may
15602 be preceded by a @samp{!} to invert the option:
15604 @table @samp
15605 @item all
15606 Enable all estimate instructions.
15608 @item default
15609 Enable the default instructions, equivalent to @option{-mrecip}.
15611 @item none
15612 Disable all estimate instructions, equivalent to @option{-mno-recip}.
15614 @item div
15615 Enable the approximation for scalar division.
15617 @item vec-div
15618 Enable the approximation for vectorized division.
15620 @item sqrt
15621 Enable the approximation for scalar square root.
15623 @item vec-sqrt
15624 Enable the approximation for vectorized square root.
15625 @end table
15627 So, for example, @option{-mrecip=all,!sqrt} enables
15628 all of the reciprocal approximations, except for square root.
15630 @item -mveclibabi=@var{type}
15631 @opindex mveclibabi
15632 Specifies the ABI type to use for vectorizing intrinsics using an
15633 external library.  Supported values for @var{type} are @samp{svml} 
15634 for the Intel short
15635 vector math library and @samp{acml} for the AMD math core library.
15636 To use this option, both @option{-ftree-vectorize} and
15637 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
15638 ABI-compatible library must be specified at link time.
15640 GCC currently emits calls to @code{vmldExp2},
15641 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
15642 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
15643 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
15644 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
15645 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
15646 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
15647 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
15648 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
15649 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
15650 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
15651 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
15652 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
15653 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
15654 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
15655 when @option{-mveclibabi=acml} is used.  
15657 @item -mabi=@var{name}
15658 @opindex mabi
15659 Generate code for the specified calling convention.  Permissible values
15660 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
15661 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
15662 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
15663 You can control this behavior for a specific function by
15664 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
15665 @xref{Function Attributes}.
15667 @item -mtls-dialect=@var{type}
15668 @opindex mtls-dialect
15669 Generate code to access thread-local storage using the @samp{gnu} or
15670 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
15671 @samp{gnu2} is more efficient, but it may add compile- and run-time
15672 requirements that cannot be satisfied on all systems.
15674 @item -mpush-args
15675 @itemx -mno-push-args
15676 @opindex mpush-args
15677 @opindex mno-push-args
15678 Use PUSH operations to store outgoing parameters.  This method is shorter
15679 and usually equally fast as method using SUB/MOV operations and is enabled
15680 by default.  In some cases disabling it may improve performance because of
15681 improved scheduling and reduced dependencies.
15683 @item -maccumulate-outgoing-args
15684 @opindex maccumulate-outgoing-args
15685 If enabled, the maximum amount of space required for outgoing arguments is
15686 computed in the function prologue.  This is faster on most modern CPUs
15687 because of reduced dependencies, improved scheduling and reduced stack usage
15688 when the preferred stack boundary is not equal to 2.  The drawback is a notable
15689 increase in code size.  This switch implies @option{-mno-push-args}.
15691 @item -mthreads
15692 @opindex mthreads
15693 Support thread-safe exception handling on MinGW.  Programs that rely
15694 on thread-safe exception handling must compile and link all code with the
15695 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
15696 @code{-D_MT}; when linking, it links in a special thread helper library
15697 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
15699 @item -mno-align-stringops
15700 @opindex mno-align-stringops
15701 Do not align the destination of inlined string operations.  This switch reduces
15702 code size and improves performance in case the destination is already aligned,
15703 but GCC doesn't know about it.
15705 @item -minline-all-stringops
15706 @opindex minline-all-stringops
15707 By default GCC inlines string operations only when the destination is 
15708 known to be aligned to least a 4-byte boundary.  
15709 This enables more inlining and increases code
15710 size, but may improve performance of code that depends on fast
15711 @code{memcpy}, @code{strlen},
15712 and @code{memset} for short lengths.
15714 @item -minline-stringops-dynamically
15715 @opindex minline-stringops-dynamically
15716 For string operations of unknown size, use run-time checks with
15717 inline code for small blocks and a library call for large blocks.
15719 @item -mstringop-strategy=@var{alg}
15720 @opindex mstringop-strategy=@var{alg}
15721 Override the internal decision heuristic for the particular algorithm to use
15722 for inlining string operations.  The allowed values for @var{alg} are:
15724 @table @samp
15725 @item rep_byte
15726 @itemx rep_4byte
15727 @itemx rep_8byte
15728 Expand using i386 @code{rep} prefix of the specified size.
15730 @item byte_loop
15731 @itemx loop
15732 @itemx unrolled_loop
15733 Expand into an inline loop.
15735 @item libcall
15736 Always use a library call.
15737 @end table
15739 @item -mmemcpy-strategy=@var{strategy}
15740 @opindex mmemcpy-strategy=@var{strategy}
15741 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
15742 should be inlined and what inline algorithm to use when the expected size
15743 of the copy operation is known. @var{strategy} 
15744 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
15745 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
15746 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
15747 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
15748 in the list must be specified in increasing order.  The minimal byte size for 
15749 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
15750 preceding range.
15752 @item -mmemset-strategy=@var{strategy}
15753 @opindex mmemset-strategy=@var{strategy}
15754 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
15755 @code{__builtin_memset} expansion.
15757 @item -momit-leaf-frame-pointer
15758 @opindex momit-leaf-frame-pointer
15759 Don't keep the frame pointer in a register for leaf functions.  This
15760 avoids the instructions to save, set up, and restore frame pointers and
15761 makes an extra register available in leaf functions.  The option
15762 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
15763 which might make debugging harder.
15765 @item -mtls-direct-seg-refs
15766 @itemx -mno-tls-direct-seg-refs
15767 @opindex mtls-direct-seg-refs
15768 Controls whether TLS variables may be accessed with offsets from the
15769 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
15770 or whether the thread base pointer must be added.  Whether or not this
15771 is valid depends on the operating system, and whether it maps the
15772 segment to cover the entire TLS area.
15774 For systems that use the GNU C Library, the default is on.
15776 @item -msse2avx
15777 @itemx -mno-sse2avx
15778 @opindex msse2avx
15779 Specify that the assembler should encode SSE instructions with VEX
15780 prefix.  The option @option{-mavx} turns this on by default.
15782 @item -mfentry
15783 @itemx -mno-fentry
15784 @opindex mfentry
15785 If profiling is active (@option{-pg}), put the profiling
15786 counter call before the prologue.
15787 Note: On x86 architectures the attribute @code{ms_hook_prologue}
15788 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
15790 @item -m8bit-idiv
15791 @itemx -mno-8bit-idiv
15792 @opindex 8bit-idiv
15793 On some processors, like Intel Atom, 8-bit unsigned integer divide is
15794 much faster than 32-bit/64-bit integer divide.  This option generates a
15795 run-time check.  If both dividend and divisor are within range of 0
15796 to 255, 8-bit unsigned integer divide is used instead of
15797 32-bit/64-bit integer divide.
15799 @item -mavx256-split-unaligned-load
15800 @itemx -mavx256-split-unaligned-store
15801 @opindex avx256-split-unaligned-load
15802 @opindex avx256-split-unaligned-store
15803 Split 32-byte AVX unaligned load and store.
15805 @item -mstack-protector-guard=@var{guard}
15806 @opindex mstack-protector-guard=@var{guard}
15807 Generate stack protection code using canary at @var{guard}.  Supported
15808 locations are @samp{global} for global canary or @samp{tls} for per-thread
15809 canary in the TLS block (the default).  This option has effect only when
15810 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
15812 @end table
15814 These @samp{-m} switches are supported in addition to the above
15815 on x86-64 processors in 64-bit environments.
15817 @table @gcctabopt
15818 @item -m32
15819 @itemx -m64
15820 @itemx -mx32
15821 @itemx -m16
15822 @opindex m32
15823 @opindex m64
15824 @opindex mx32
15825 @opindex m16
15826 Generate code for a 16-bit, 32-bit or 64-bit environment.
15827 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
15828 to 32 bits, and
15829 generates code that runs on any i386 system.
15831 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
15832 types to 64 bits, and generates code for the x86-64 architecture.
15833 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
15834 and @option{-mdynamic-no-pic} options.
15836 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
15837 to 32 bits, and
15838 generates code for the x86-64 architecture.
15840 The @option{-m16} option is the same as @option{-m32}, except for that
15841 it outputs the @code{.code16gcc} assembly directive at the beginning of
15842 the assembly output so that the binary can run in 16-bit mode.
15844 @item -mno-red-zone
15845 @opindex mno-red-zone
15846 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
15847 by the x86-64 ABI; it is a 128-byte area beyond the location of the
15848 stack pointer that is not modified by signal or interrupt handlers
15849 and therefore can be used for temporary data without adjusting the stack
15850 pointer.  The flag @option{-mno-red-zone} disables this red zone.
15852 @item -mcmodel=small
15853 @opindex mcmodel=small
15854 Generate code for the small code model: the program and its symbols must
15855 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
15856 Programs can be statically or dynamically linked.  This is the default
15857 code model.
15859 @item -mcmodel=kernel
15860 @opindex mcmodel=kernel
15861 Generate code for the kernel code model.  The kernel runs in the
15862 negative 2 GB of the address space.
15863 This model has to be used for Linux kernel code.
15865 @item -mcmodel=medium
15866 @opindex mcmodel=medium
15867 Generate code for the medium model: the program is linked in the lower 2
15868 GB of the address space.  Small symbols are also placed there.  Symbols
15869 with sizes larger than @option{-mlarge-data-threshold} are put into
15870 large data or BSS sections and can be located above 2GB.  Programs can
15871 be statically or dynamically linked.
15873 @item -mcmodel=large
15874 @opindex mcmodel=large
15875 Generate code for the large model.  This model makes no assumptions
15876 about addresses and sizes of sections.
15878 @item -maddress-mode=long
15879 @opindex maddress-mode=long
15880 Generate code for long address mode.  This is only supported for 64-bit
15881 and x32 environments.  It is the default address mode for 64-bit
15882 environments.
15884 @item -maddress-mode=short
15885 @opindex maddress-mode=short
15886 Generate code for short address mode.  This is only supported for 32-bit
15887 and x32 environments.  It is the default address mode for 32-bit and
15888 x32 environments.
15889 @end table
15891 @node i386 and x86-64 Windows Options
15892 @subsection i386 and x86-64 Windows Options
15893 @cindex i386 and x86-64 Windows Options
15895 These additional options are available for Microsoft Windows targets:
15897 @table @gcctabopt
15898 @item -mconsole
15899 @opindex mconsole
15900 This option
15901 specifies that a console application is to be generated, by
15902 instructing the linker to set the PE header subsystem type
15903 required for console applications.
15904 This option is available for Cygwin and MinGW targets and is
15905 enabled by default on those targets.
15907 @item -mdll
15908 @opindex mdll
15909 This option is available for Cygwin and MinGW targets.  It
15910 specifies that a DLL---a dynamic link library---is to be
15911 generated, enabling the selection of the required runtime
15912 startup object and entry point.
15914 @item -mnop-fun-dllimport
15915 @opindex mnop-fun-dllimport
15916 This option is available for Cygwin and MinGW targets.  It
15917 specifies that the @code{dllimport} attribute should be ignored.
15919 @item -mthread
15920 @opindex mthread
15921 This option is available for MinGW targets. It specifies
15922 that MinGW-specific thread support is to be used.
15924 @item -municode
15925 @opindex municode
15926 This option is available for MinGW-w64 targets.  It causes
15927 the @code{UNICODE} preprocessor macro to be predefined, and
15928 chooses Unicode-capable runtime startup code.
15930 @item -mwin32
15931 @opindex mwin32
15932 This option is available for Cygwin and MinGW targets.  It
15933 specifies that the typical Microsoft Windows predefined macros are to
15934 be set in the pre-processor, but does not influence the choice
15935 of runtime library/startup code.
15937 @item -mwindows
15938 @opindex mwindows
15939 This option is available for Cygwin and MinGW targets.  It
15940 specifies that a GUI application is to be generated by
15941 instructing the linker to set the PE header subsystem type
15942 appropriately.
15944 @item -fno-set-stack-executable
15945 @opindex fno-set-stack-executable
15946 This option is available for MinGW targets. It specifies that
15947 the executable flag for the stack used by nested functions isn't
15948 set. This is necessary for binaries running in kernel mode of
15949 Microsoft Windows, as there the User32 API, which is used to set executable
15950 privileges, isn't available.
15952 @item -fwritable-relocated-rdata
15953 @opindex fno-writable-relocated-rdata
15954 This option is available for MinGW and Cygwin targets.  It specifies
15955 that relocated-data in read-only section is put into .data
15956 section.  This is a necessary for older runtimes not supporting
15957 modification of .rdata sections for pseudo-relocation.
15959 @item -mpe-aligned-commons
15960 @opindex mpe-aligned-commons
15961 This option is available for Cygwin and MinGW targets.  It
15962 specifies that the GNU extension to the PE file format that
15963 permits the correct alignment of COMMON variables should be
15964 used when generating code.  It is enabled by default if
15965 GCC detects that the target assembler found during configuration
15966 supports the feature.
15967 @end table
15969 See also under @ref{i386 and x86-64 Options} for standard options.
15971 @node IA-64 Options
15972 @subsection IA-64 Options
15973 @cindex IA-64 Options
15975 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15977 @table @gcctabopt
15978 @item -mbig-endian
15979 @opindex mbig-endian
15980 Generate code for a big-endian target.  This is the default for HP-UX@.
15982 @item -mlittle-endian
15983 @opindex mlittle-endian
15984 Generate code for a little-endian target.  This is the default for AIX5
15985 and GNU/Linux.
15987 @item -mgnu-as
15988 @itemx -mno-gnu-as
15989 @opindex mgnu-as
15990 @opindex mno-gnu-as
15991 Generate (or don't) code for the GNU assembler.  This is the default.
15992 @c Also, this is the default if the configure option @option{--with-gnu-as}
15993 @c is used.
15995 @item -mgnu-ld
15996 @itemx -mno-gnu-ld
15997 @opindex mgnu-ld
15998 @opindex mno-gnu-ld
15999 Generate (or don't) code for the GNU linker.  This is the default.
16000 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16001 @c is used.
16003 @item -mno-pic
16004 @opindex mno-pic
16005 Generate code that does not use a global pointer register.  The result
16006 is not position independent code, and violates the IA-64 ABI@.
16008 @item -mvolatile-asm-stop
16009 @itemx -mno-volatile-asm-stop
16010 @opindex mvolatile-asm-stop
16011 @opindex mno-volatile-asm-stop
16012 Generate (or don't) a stop bit immediately before and after volatile asm
16013 statements.
16015 @item -mregister-names
16016 @itemx -mno-register-names
16017 @opindex mregister-names
16018 @opindex mno-register-names
16019 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16020 the stacked registers.  This may make assembler output more readable.
16022 @item -mno-sdata
16023 @itemx -msdata
16024 @opindex mno-sdata
16025 @opindex msdata
16026 Disable (or enable) optimizations that use the small data section.  This may
16027 be useful for working around optimizer bugs.
16029 @item -mconstant-gp
16030 @opindex mconstant-gp
16031 Generate code that uses a single constant global pointer value.  This is
16032 useful when compiling kernel code.
16034 @item -mauto-pic
16035 @opindex mauto-pic
16036 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16037 This is useful when compiling firmware code.
16039 @item -minline-float-divide-min-latency
16040 @opindex minline-float-divide-min-latency
16041 Generate code for inline divides of floating-point values
16042 using the minimum latency algorithm.
16044 @item -minline-float-divide-max-throughput
16045 @opindex minline-float-divide-max-throughput
16046 Generate code for inline divides of floating-point values
16047 using the maximum throughput algorithm.
16049 @item -mno-inline-float-divide
16050 @opindex mno-inline-float-divide
16051 Do not generate inline code for divides of floating-point values.
16053 @item -minline-int-divide-min-latency
16054 @opindex minline-int-divide-min-latency
16055 Generate code for inline divides of integer values
16056 using the minimum latency algorithm.
16058 @item -minline-int-divide-max-throughput
16059 @opindex minline-int-divide-max-throughput
16060 Generate code for inline divides of integer values
16061 using the maximum throughput algorithm.
16063 @item -mno-inline-int-divide
16064 @opindex mno-inline-int-divide
16065 Do not generate inline code for divides of integer values.
16067 @item -minline-sqrt-min-latency
16068 @opindex minline-sqrt-min-latency
16069 Generate code for inline square roots
16070 using the minimum latency algorithm.
16072 @item -minline-sqrt-max-throughput
16073 @opindex minline-sqrt-max-throughput
16074 Generate code for inline square roots
16075 using the maximum throughput algorithm.
16077 @item -mno-inline-sqrt
16078 @opindex mno-inline-sqrt
16079 Do not generate inline code for @code{sqrt}.
16081 @item -mfused-madd
16082 @itemx -mno-fused-madd
16083 @opindex mfused-madd
16084 @opindex mno-fused-madd
16085 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16086 instructions.  The default is to use these instructions.
16088 @item -mno-dwarf2-asm
16089 @itemx -mdwarf2-asm
16090 @opindex mno-dwarf2-asm
16091 @opindex mdwarf2-asm
16092 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16093 info.  This may be useful when not using the GNU assembler.
16095 @item -mearly-stop-bits
16096 @itemx -mno-early-stop-bits
16097 @opindex mearly-stop-bits
16098 @opindex mno-early-stop-bits
16099 Allow stop bits to be placed earlier than immediately preceding the
16100 instruction that triggered the stop bit.  This can improve instruction
16101 scheduling, but does not always do so.
16103 @item -mfixed-range=@var{register-range}
16104 @opindex mfixed-range
16105 Generate code treating the given register range as fixed registers.
16106 A fixed register is one that the register allocator cannot use.  This is
16107 useful when compiling kernel code.  A register range is specified as
16108 two registers separated by a dash.  Multiple register ranges can be
16109 specified separated by a comma.
16111 @item -mtls-size=@var{tls-size}
16112 @opindex mtls-size
16113 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16116 @item -mtune=@var{cpu-type}
16117 @opindex mtune
16118 Tune the instruction scheduling for a particular CPU, Valid values are
16119 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16120 and @samp{mckinley}.
16122 @item -milp32
16123 @itemx -mlp64
16124 @opindex milp32
16125 @opindex mlp64
16126 Generate code for a 32-bit or 64-bit environment.
16127 The 32-bit environment sets int, long and pointer to 32 bits.
16128 The 64-bit environment sets int to 32 bits and long and pointer
16129 to 64 bits.  These are HP-UX specific flags.
16131 @item -mno-sched-br-data-spec
16132 @itemx -msched-br-data-spec
16133 @opindex mno-sched-br-data-spec
16134 @opindex msched-br-data-spec
16135 (Dis/En)able data speculative scheduling before reload.
16136 This results in generation of @code{ld.a} instructions and
16137 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16138 The default is 'disable'.
16140 @item -msched-ar-data-spec
16141 @itemx -mno-sched-ar-data-spec
16142 @opindex msched-ar-data-spec
16143 @opindex mno-sched-ar-data-spec
16144 (En/Dis)able data speculative scheduling after reload.
16145 This results in generation of @code{ld.a} instructions and
16146 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16147 The default is 'enable'.
16149 @item -mno-sched-control-spec
16150 @itemx -msched-control-spec
16151 @opindex mno-sched-control-spec
16152 @opindex msched-control-spec
16153 (Dis/En)able control speculative scheduling.  This feature is
16154 available only during region scheduling (i.e.@: before reload).
16155 This results in generation of the @code{ld.s} instructions and
16156 the corresponding check instructions @code{chk.s}.
16157 The default is 'disable'.
16159 @item -msched-br-in-data-spec
16160 @itemx -mno-sched-br-in-data-spec
16161 @opindex msched-br-in-data-spec
16162 @opindex mno-sched-br-in-data-spec
16163 (En/Dis)able speculative scheduling of the instructions that
16164 are dependent on the data speculative loads before reload.
16165 This is effective only with @option{-msched-br-data-spec} enabled.
16166 The default is 'enable'.
16168 @item -msched-ar-in-data-spec
16169 @itemx -mno-sched-ar-in-data-spec
16170 @opindex msched-ar-in-data-spec
16171 @opindex mno-sched-ar-in-data-spec
16172 (En/Dis)able speculative scheduling of the instructions that
16173 are dependent on the data speculative loads after reload.
16174 This is effective only with @option{-msched-ar-data-spec} enabled.
16175 The default is 'enable'.
16177 @item -msched-in-control-spec
16178 @itemx -mno-sched-in-control-spec
16179 @opindex msched-in-control-spec
16180 @opindex mno-sched-in-control-spec
16181 (En/Dis)able speculative scheduling of the instructions that
16182 are dependent on the control speculative loads.
16183 This is effective only with @option{-msched-control-spec} enabled.
16184 The default is 'enable'.
16186 @item -mno-sched-prefer-non-data-spec-insns
16187 @itemx -msched-prefer-non-data-spec-insns
16188 @opindex mno-sched-prefer-non-data-spec-insns
16189 @opindex msched-prefer-non-data-spec-insns
16190 If enabled, data-speculative instructions are chosen for schedule
16191 only if there are no other choices at the moment.  This makes
16192 the use of the data speculation much more conservative.
16193 The default is 'disable'.
16195 @item -mno-sched-prefer-non-control-spec-insns
16196 @itemx -msched-prefer-non-control-spec-insns
16197 @opindex mno-sched-prefer-non-control-spec-insns
16198 @opindex msched-prefer-non-control-spec-insns
16199 If enabled, control-speculative instructions are chosen for schedule
16200 only if there are no other choices at the moment.  This makes
16201 the use of the control speculation much more conservative.
16202 The default is 'disable'.
16204 @item -mno-sched-count-spec-in-critical-path
16205 @itemx -msched-count-spec-in-critical-path
16206 @opindex mno-sched-count-spec-in-critical-path
16207 @opindex msched-count-spec-in-critical-path
16208 If enabled, speculative dependencies are considered during
16209 computation of the instructions priorities.  This makes the use of the
16210 speculation a bit more conservative.
16211 The default is 'disable'.
16213 @item -msched-spec-ldc
16214 @opindex msched-spec-ldc
16215 Use a simple data speculation check.  This option is on by default.
16217 @item -msched-control-spec-ldc
16218 @opindex msched-spec-ldc
16219 Use a simple check for control speculation.  This option is on by default.
16221 @item -msched-stop-bits-after-every-cycle
16222 @opindex msched-stop-bits-after-every-cycle
16223 Place a stop bit after every cycle when scheduling.  This option is on
16224 by default.
16226 @item -msched-fp-mem-deps-zero-cost
16227 @opindex msched-fp-mem-deps-zero-cost
16228 Assume that floating-point stores and loads are not likely to cause a conflict
16229 when placed into the same instruction group.  This option is disabled by
16230 default.
16232 @item -msel-sched-dont-check-control-spec
16233 @opindex msel-sched-dont-check-control-spec
16234 Generate checks for control speculation in selective scheduling.
16235 This flag is disabled by default.
16237 @item -msched-max-memory-insns=@var{max-insns}
16238 @opindex msched-max-memory-insns
16239 Limit on the number of memory insns per instruction group, giving lower
16240 priority to subsequent memory insns attempting to schedule in the same
16241 instruction group. Frequently useful to prevent cache bank conflicts.
16242 The default value is 1.
16244 @item -msched-max-memory-insns-hard-limit
16245 @opindex msched-max-memory-insns-hard-limit
16246 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16247 disallowing more than that number in an instruction group.
16248 Otherwise, the limit is ``soft'', meaning that non-memory operations
16249 are preferred when the limit is reached, but memory operations may still
16250 be scheduled.
16252 @end table
16254 @node LM32 Options
16255 @subsection LM32 Options
16256 @cindex LM32 options
16258 These @option{-m} options are defined for the LatticeMico32 architecture:
16260 @table @gcctabopt
16261 @item -mbarrel-shift-enabled
16262 @opindex mbarrel-shift-enabled
16263 Enable barrel-shift instructions.
16265 @item -mdivide-enabled
16266 @opindex mdivide-enabled
16267 Enable divide and modulus instructions.
16269 @item -mmultiply-enabled
16270 @opindex multiply-enabled
16271 Enable multiply instructions.
16273 @item -msign-extend-enabled
16274 @opindex msign-extend-enabled
16275 Enable sign extend instructions.
16277 @item -muser-enabled
16278 @opindex muser-enabled
16279 Enable user-defined instructions.
16281 @end table
16283 @node M32C Options
16284 @subsection M32C Options
16285 @cindex M32C options
16287 @table @gcctabopt
16288 @item -mcpu=@var{name}
16289 @opindex mcpu=
16290 Select the CPU for which code is generated.  @var{name} may be one of
16291 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16292 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16293 the M32C/80 series.
16295 @item -msim
16296 @opindex msim
16297 Specifies that the program will be run on the simulator.  This causes
16298 an alternate runtime library to be linked in which supports, for
16299 example, file I/O@.  You must not use this option when generating
16300 programs that will run on real hardware; you must provide your own
16301 runtime library for whatever I/O functions are needed.
16303 @item -memregs=@var{number}
16304 @opindex memregs=
16305 Specifies the number of memory-based pseudo-registers GCC uses
16306 during code generation.  These pseudo-registers are used like real
16307 registers, so there is a tradeoff between GCC's ability to fit the
16308 code into available registers, and the performance penalty of using
16309 memory instead of registers.  Note that all modules in a program must
16310 be compiled with the same value for this option.  Because of that, you
16311 must not use this option with GCC's default runtime libraries.
16313 @end table
16315 @node M32R/D Options
16316 @subsection M32R/D Options
16317 @cindex M32R/D options
16319 These @option{-m} options are defined for Renesas M32R/D architectures:
16321 @table @gcctabopt
16322 @item -m32r2
16323 @opindex m32r2
16324 Generate code for the M32R/2@.
16326 @item -m32rx
16327 @opindex m32rx
16328 Generate code for the M32R/X@.
16330 @item -m32r
16331 @opindex m32r
16332 Generate code for the M32R@.  This is the default.
16334 @item -mmodel=small
16335 @opindex mmodel=small
16336 Assume all objects live in the lower 16MB of memory (so that their addresses
16337 can be loaded with the @code{ld24} instruction), and assume all subroutines
16338 are reachable with the @code{bl} instruction.
16339 This is the default.
16341 The addressability of a particular object can be set with the
16342 @code{model} attribute.
16344 @item -mmodel=medium
16345 @opindex mmodel=medium
16346 Assume objects may be anywhere in the 32-bit address space (the compiler
16347 generates @code{seth/add3} instructions to load their addresses), and
16348 assume all subroutines are reachable with the @code{bl} instruction.
16350 @item -mmodel=large
16351 @opindex mmodel=large
16352 Assume objects may be anywhere in the 32-bit address space (the compiler
16353 generates @code{seth/add3} instructions to load their addresses), and
16354 assume subroutines may not be reachable with the @code{bl} instruction
16355 (the compiler generates the much slower @code{seth/add3/jl}
16356 instruction sequence).
16358 @item -msdata=none
16359 @opindex msdata=none
16360 Disable use of the small data area.  Variables are put into
16361 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16362 @code{section} attribute has been specified).
16363 This is the default.
16365 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16366 Objects may be explicitly put in the small data area with the
16367 @code{section} attribute using one of these sections.
16369 @item -msdata=sdata
16370 @opindex msdata=sdata
16371 Put small global and static data in the small data area, but do not
16372 generate special code to reference them.
16374 @item -msdata=use
16375 @opindex msdata=use
16376 Put small global and static data in the small data area, and generate
16377 special instructions to reference them.
16379 @item -G @var{num}
16380 @opindex G
16381 @cindex smaller data references
16382 Put global and static objects less than or equal to @var{num} bytes
16383 into the small data or BSS sections instead of the normal data or BSS
16384 sections.  The default value of @var{num} is 8.
16385 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16386 for this option to have any effect.
16388 All modules should be compiled with the same @option{-G @var{num}} value.
16389 Compiling with different values of @var{num} may or may not work; if it
16390 doesn't the linker gives an error message---incorrect code is not
16391 generated.
16393 @item -mdebug
16394 @opindex mdebug
16395 Makes the M32R-specific code in the compiler display some statistics
16396 that might help in debugging programs.
16398 @item -malign-loops
16399 @opindex malign-loops
16400 Align all loops to a 32-byte boundary.
16402 @item -mno-align-loops
16403 @opindex mno-align-loops
16404 Do not enforce a 32-byte alignment for loops.  This is the default.
16406 @item -missue-rate=@var{number}
16407 @opindex missue-rate=@var{number}
16408 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16409 or 2.
16411 @item -mbranch-cost=@var{number}
16412 @opindex mbranch-cost=@var{number}
16413 @var{number} can only be 1 or 2.  If it is 1 then branches are
16414 preferred over conditional code, if it is 2, then the opposite applies.
16416 @item -mflush-trap=@var{number}
16417 @opindex mflush-trap=@var{number}
16418 Specifies the trap number to use to flush the cache.  The default is
16419 12.  Valid numbers are between 0 and 15 inclusive.
16421 @item -mno-flush-trap
16422 @opindex mno-flush-trap
16423 Specifies that the cache cannot be flushed by using a trap.
16425 @item -mflush-func=@var{name}
16426 @opindex mflush-func=@var{name}
16427 Specifies the name of the operating system function to call to flush
16428 the cache.  The default is @emph{_flush_cache}, but a function call
16429 is only used if a trap is not available.
16431 @item -mno-flush-func
16432 @opindex mno-flush-func
16433 Indicates that there is no OS function for flushing the cache.
16435 @end table
16437 @node M680x0 Options
16438 @subsection M680x0 Options
16439 @cindex M680x0 options
16441 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16442 The default settings depend on which architecture was selected when
16443 the compiler was configured; the defaults for the most common choices
16444 are given below.
16446 @table @gcctabopt
16447 @item -march=@var{arch}
16448 @opindex march
16449 Generate code for a specific M680x0 or ColdFire instruction set
16450 architecture.  Permissible values of @var{arch} for M680x0
16451 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16452 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16453 architectures are selected according to Freescale's ISA classification
16454 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16455 @samp{isab} and @samp{isac}.
16457 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16458 code for a ColdFire target.  The @var{arch} in this macro is one of the
16459 @option{-march} arguments given above.
16461 When used together, @option{-march} and @option{-mtune} select code
16462 that runs on a family of similar processors but that is optimized
16463 for a particular microarchitecture.
16465 @item -mcpu=@var{cpu}
16466 @opindex mcpu
16467 Generate code for a specific M680x0 or ColdFire processor.
16468 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16469 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16470 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16471 below, which also classifies the CPUs into families:
16473 @multitable @columnfractions 0.20 0.80
16474 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16475 @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}
16476 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16477 @item @samp{5206e} @tab @samp{5206e}
16478 @item @samp{5208} @tab @samp{5207} @samp{5208}
16479 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16480 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16481 @item @samp{5216} @tab @samp{5214} @samp{5216}
16482 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16483 @item @samp{5225} @tab @samp{5224} @samp{5225}
16484 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16485 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16486 @item @samp{5249} @tab @samp{5249}
16487 @item @samp{5250} @tab @samp{5250}
16488 @item @samp{5271} @tab @samp{5270} @samp{5271}
16489 @item @samp{5272} @tab @samp{5272}
16490 @item @samp{5275} @tab @samp{5274} @samp{5275}
16491 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16492 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16493 @item @samp{5307} @tab @samp{5307}
16494 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16495 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16496 @item @samp{5407} @tab @samp{5407}
16497 @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}
16498 @end multitable
16500 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16501 @var{arch} is compatible with @var{cpu}.  Other combinations of
16502 @option{-mcpu} and @option{-march} are rejected.
16504 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16505 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16506 where the value of @var{family} is given by the table above.
16508 @item -mtune=@var{tune}
16509 @opindex mtune
16510 Tune the code for a particular microarchitecture within the
16511 constraints set by @option{-march} and @option{-mcpu}.
16512 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16513 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16514 and @samp{cpu32}.  The ColdFire microarchitectures
16515 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16517 You can also use @option{-mtune=68020-40} for code that needs
16518 to run relatively well on 68020, 68030 and 68040 targets.
16519 @option{-mtune=68020-60} is similar but includes 68060 targets
16520 as well.  These two options select the same tuning decisions as
16521 @option{-m68020-40} and @option{-m68020-60} respectively.
16523 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16524 when tuning for 680x0 architecture @var{arch}.  It also defines
16525 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16526 option is used.  If GCC is tuning for a range of architectures,
16527 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16528 it defines the macros for every architecture in the range.
16530 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16531 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16532 of the arguments given above.
16534 @item -m68000
16535 @itemx -mc68000
16536 @opindex m68000
16537 @opindex mc68000
16538 Generate output for a 68000.  This is the default
16539 when the compiler is configured for 68000-based systems.
16540 It is equivalent to @option{-march=68000}.
16542 Use this option for microcontrollers with a 68000 or EC000 core,
16543 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16545 @item -m68010
16546 @opindex m68010
16547 Generate output for a 68010.  This is the default
16548 when the compiler is configured for 68010-based systems.
16549 It is equivalent to @option{-march=68010}.
16551 @item -m68020
16552 @itemx -mc68020
16553 @opindex m68020
16554 @opindex mc68020
16555 Generate output for a 68020.  This is the default
16556 when the compiler is configured for 68020-based systems.
16557 It is equivalent to @option{-march=68020}.
16559 @item -m68030
16560 @opindex m68030
16561 Generate output for a 68030.  This is the default when the compiler is
16562 configured for 68030-based systems.  It is equivalent to
16563 @option{-march=68030}.
16565 @item -m68040
16566 @opindex m68040
16567 Generate output for a 68040.  This is the default when the compiler is
16568 configured for 68040-based systems.  It is equivalent to
16569 @option{-march=68040}.
16571 This option inhibits the use of 68881/68882 instructions that have to be
16572 emulated by software on the 68040.  Use this option if your 68040 does not
16573 have code to emulate those instructions.
16575 @item -m68060
16576 @opindex m68060
16577 Generate output for a 68060.  This is the default when the compiler is
16578 configured for 68060-based systems.  It is equivalent to
16579 @option{-march=68060}.
16581 This option inhibits the use of 68020 and 68881/68882 instructions that
16582 have to be emulated by software on the 68060.  Use this option if your 68060
16583 does not have code to emulate those instructions.
16585 @item -mcpu32
16586 @opindex mcpu32
16587 Generate output for a CPU32.  This is the default
16588 when the compiler is configured for CPU32-based systems.
16589 It is equivalent to @option{-march=cpu32}.
16591 Use this option for microcontrollers with a
16592 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16593 68336, 68340, 68341, 68349 and 68360.
16595 @item -m5200
16596 @opindex m5200
16597 Generate output for a 520X ColdFire CPU@.  This is the default
16598 when the compiler is configured for 520X-based systems.
16599 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16600 in favor of that option.
16602 Use this option for microcontroller with a 5200 core, including
16603 the MCF5202, MCF5203, MCF5204 and MCF5206.
16605 @item -m5206e
16606 @opindex m5206e
16607 Generate output for a 5206e ColdFire CPU@.  The option is now
16608 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16610 @item -m528x
16611 @opindex m528x
16612 Generate output for a member of the ColdFire 528X family.
16613 The option is now deprecated in favor of the equivalent
16614 @option{-mcpu=528x}.
16616 @item -m5307
16617 @opindex m5307
16618 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16619 in favor of the equivalent @option{-mcpu=5307}.
16621 @item -m5407
16622 @opindex m5407
16623 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16624 in favor of the equivalent @option{-mcpu=5407}.
16626 @item -mcfv4e
16627 @opindex mcfv4e
16628 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16629 This includes use of hardware floating-point instructions.
16630 The option is equivalent to @option{-mcpu=547x}, and is now
16631 deprecated in favor of that option.
16633 @item -m68020-40
16634 @opindex m68020-40
16635 Generate output for a 68040, without using any of the new instructions.
16636 This results in code that can run relatively efficiently on either a
16637 68020/68881 or a 68030 or a 68040.  The generated code does use the
16638 68881 instructions that are emulated on the 68040.
16640 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16642 @item -m68020-60
16643 @opindex m68020-60
16644 Generate output for a 68060, without using any of the new instructions.
16645 This results in code that can run relatively efficiently on either a
16646 68020/68881 or a 68030 or a 68040.  The generated code does use the
16647 68881 instructions that are emulated on the 68060.
16649 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16651 @item -mhard-float
16652 @itemx -m68881
16653 @opindex mhard-float
16654 @opindex m68881
16655 Generate floating-point instructions.  This is the default for 68020
16656 and above, and for ColdFire devices that have an FPU@.  It defines the
16657 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
16658 on ColdFire targets.
16660 @item -msoft-float
16661 @opindex msoft-float
16662 Do not generate floating-point instructions; use library calls instead.
16663 This is the default for 68000, 68010, and 68832 targets.  It is also
16664 the default for ColdFire devices that have no FPU.
16666 @item -mdiv
16667 @itemx -mno-div
16668 @opindex mdiv
16669 @opindex mno-div
16670 Generate (do not generate) ColdFire hardware divide and remainder
16671 instructions.  If @option{-march} is used without @option{-mcpu},
16672 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16673 architectures.  Otherwise, the default is taken from the target CPU
16674 (either the default CPU, or the one specified by @option{-mcpu}).  For
16675 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16676 @option{-mcpu=5206e}.
16678 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
16680 @item -mshort
16681 @opindex mshort
16682 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16683 Additionally, parameters passed on the stack are also aligned to a
16684 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16686 @item -mno-short
16687 @opindex mno-short
16688 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16690 @item -mnobitfield
16691 @itemx -mno-bitfield
16692 @opindex mnobitfield
16693 @opindex mno-bitfield
16694 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16695 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16697 @item -mbitfield
16698 @opindex mbitfield
16699 Do use the bit-field instructions.  The @option{-m68020} option implies
16700 @option{-mbitfield}.  This is the default if you use a configuration
16701 designed for a 68020.
16703 @item -mrtd
16704 @opindex mrtd
16705 Use a different function-calling convention, in which functions
16706 that take a fixed number of arguments return with the @code{rtd}
16707 instruction, which pops their arguments while returning.  This
16708 saves one instruction in the caller since there is no need to pop
16709 the arguments there.
16711 This calling convention is incompatible with the one normally
16712 used on Unix, so you cannot use it if you need to call libraries
16713 compiled with the Unix compiler.
16715 Also, you must provide function prototypes for all functions that
16716 take variable numbers of arguments (including @code{printf});
16717 otherwise incorrect code is generated for calls to those
16718 functions.
16720 In addition, seriously incorrect code results if you call a
16721 function with too many arguments.  (Normally, extra arguments are
16722 harmlessly ignored.)
16724 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16725 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16727 @item -mno-rtd
16728 @opindex mno-rtd
16729 Do not use the calling conventions selected by @option{-mrtd}.
16730 This is the default.
16732 @item -malign-int
16733 @itemx -mno-align-int
16734 @opindex malign-int
16735 @opindex mno-align-int
16736 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16737 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16738 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16739 Aligning variables on 32-bit boundaries produces code that runs somewhat
16740 faster on processors with 32-bit busses at the expense of more memory.
16742 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16743 aligns structures containing the above types differently than
16744 most published application binary interface specifications for the m68k.
16746 @item -mpcrel
16747 @opindex mpcrel
16748 Use the pc-relative addressing mode of the 68000 directly, instead of
16749 using a global offset table.  At present, this option implies @option{-fpic},
16750 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16751 not presently supported with @option{-mpcrel}, though this could be supported for
16752 68020 and higher processors.
16754 @item -mno-strict-align
16755 @itemx -mstrict-align
16756 @opindex mno-strict-align
16757 @opindex mstrict-align
16758 Do not (do) assume that unaligned memory references are handled by
16759 the system.
16761 @item -msep-data
16762 Generate code that allows the data segment to be located in a different
16763 area of memory from the text segment.  This allows for execute-in-place in
16764 an environment without virtual memory management.  This option implies
16765 @option{-fPIC}.
16767 @item -mno-sep-data
16768 Generate code that assumes that the data segment follows the text segment.
16769 This is the default.
16771 @item -mid-shared-library
16772 Generate code that supports shared libraries via the library ID method.
16773 This allows for execute-in-place and shared libraries in an environment
16774 without virtual memory management.  This option implies @option{-fPIC}.
16776 @item -mno-id-shared-library
16777 Generate code that doesn't assume ID-based shared libraries are being used.
16778 This is the default.
16780 @item -mshared-library-id=n
16781 Specifies the identification number of the ID-based shared library being
16782 compiled.  Specifying a value of 0 generates more compact code; specifying
16783 other values forces the allocation of that number to the current
16784 library, but is no more space- or time-efficient than omitting this option.
16786 @item -mxgot
16787 @itemx -mno-xgot
16788 @opindex mxgot
16789 @opindex mno-xgot
16790 When generating position-independent code for ColdFire, generate code
16791 that works if the GOT has more than 8192 entries.  This code is
16792 larger and slower than code generated without this option.  On M680x0
16793 processors, this option is not needed; @option{-fPIC} suffices.
16795 GCC normally uses a single instruction to load values from the GOT@.
16796 While this is relatively efficient, it only works if the GOT
16797 is smaller than about 64k.  Anything larger causes the linker
16798 to report an error such as:
16800 @cindex relocation truncated to fit (ColdFire)
16801 @smallexample
16802 relocation truncated to fit: R_68K_GOT16O foobar
16803 @end smallexample
16805 If this happens, you should recompile your code with @option{-mxgot}.
16806 It should then work with very large GOTs.  However, code generated with
16807 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16808 the value of a global symbol.
16810 Note that some linkers, including newer versions of the GNU linker,
16811 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16812 you should only need to use @option{-mxgot} when compiling a single
16813 object file that accesses more than 8192 GOT entries.  Very few do.
16815 These options have no effect unless GCC is generating
16816 position-independent code.
16818 @end table
16820 @node MCore Options
16821 @subsection MCore Options
16822 @cindex MCore options
16824 These are the @samp{-m} options defined for the Motorola M*Core
16825 processors.
16827 @table @gcctabopt
16829 @item -mhardlit
16830 @itemx -mno-hardlit
16831 @opindex mhardlit
16832 @opindex mno-hardlit
16833 Inline constants into the code stream if it can be done in two
16834 instructions or less.
16836 @item -mdiv
16837 @itemx -mno-div
16838 @opindex mdiv
16839 @opindex mno-div
16840 Use the divide instruction.  (Enabled by default).
16842 @item -mrelax-immediate
16843 @itemx -mno-relax-immediate
16844 @opindex mrelax-immediate
16845 @opindex mno-relax-immediate
16846 Allow arbitrary-sized immediates in bit operations.
16848 @item -mwide-bitfields
16849 @itemx -mno-wide-bitfields
16850 @opindex mwide-bitfields
16851 @opindex mno-wide-bitfields
16852 Always treat bit-fields as @code{int}-sized.
16854 @item -m4byte-functions
16855 @itemx -mno-4byte-functions
16856 @opindex m4byte-functions
16857 @opindex mno-4byte-functions
16858 Force all functions to be aligned to a 4-byte boundary.
16860 @item -mcallgraph-data
16861 @itemx -mno-callgraph-data
16862 @opindex mcallgraph-data
16863 @opindex mno-callgraph-data
16864 Emit callgraph information.
16866 @item -mslow-bytes
16867 @itemx -mno-slow-bytes
16868 @opindex mslow-bytes
16869 @opindex mno-slow-bytes
16870 Prefer word access when reading byte quantities.
16872 @item -mlittle-endian
16873 @itemx -mbig-endian
16874 @opindex mlittle-endian
16875 @opindex mbig-endian
16876 Generate code for a little-endian target.
16878 @item -m210
16879 @itemx -m340
16880 @opindex m210
16881 @opindex m340
16882 Generate code for the 210 processor.
16884 @item -mno-lsim
16885 @opindex mno-lsim
16886 Assume that runtime support has been provided and so omit the
16887 simulator library (@file{libsim.a)} from the linker command line.
16889 @item -mstack-increment=@var{size}
16890 @opindex mstack-increment
16891 Set the maximum amount for a single stack increment operation.  Large
16892 values can increase the speed of programs that contain functions
16893 that need a large amount of stack space, but they can also trigger a
16894 segmentation fault if the stack is extended too much.  The default
16895 value is 0x1000.
16897 @end table
16899 @node MeP Options
16900 @subsection MeP Options
16901 @cindex MeP options
16903 @table @gcctabopt
16905 @item -mabsdiff
16906 @opindex mabsdiff
16907 Enables the @code{abs} instruction, which is the absolute difference
16908 between two registers.
16910 @item -mall-opts
16911 @opindex mall-opts
16912 Enables all the optional instructions---average, multiply, divide, bit
16913 operations, leading zero, absolute difference, min/max, clip, and
16914 saturation.
16917 @item -maverage
16918 @opindex maverage
16919 Enables the @code{ave} instruction, which computes the average of two
16920 registers.
16922 @item -mbased=@var{n}
16923 @opindex mbased=
16924 Variables of size @var{n} bytes or smaller are placed in the
16925 @code{.based} section by default.  Based variables use the @code{$tp}
16926 register as a base register, and there is a 128-byte limit to the
16927 @code{.based} section.
16929 @item -mbitops
16930 @opindex mbitops
16931 Enables the bit operation instructions---bit test (@code{btstm}), set
16932 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16933 test-and-set (@code{tas}).
16935 @item -mc=@var{name}
16936 @opindex mc=
16937 Selects which section constant data is placed in.  @var{name} may
16938 be @code{tiny}, @code{near}, or @code{far}.
16940 @item -mclip
16941 @opindex mclip
16942 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
16943 useful unless you also provide @code{-mminmax}.
16945 @item -mconfig=@var{name}
16946 @opindex mconfig=
16947 Selects one of the built-in core configurations.  Each MeP chip has
16948 one or more modules in it; each module has a core CPU and a variety of
16949 coprocessors, optional instructions, and peripherals.  The
16950 @code{MeP-Integrator} tool, not part of GCC, provides these
16951 configurations through this option; using this option is the same as
16952 using all the corresponding command-line options.  The default
16953 configuration is @code{default}.
16955 @item -mcop
16956 @opindex mcop
16957 Enables the coprocessor instructions.  By default, this is a 32-bit
16958 coprocessor.  Note that the coprocessor is normally enabled via the
16959 @code{-mconfig=} option.
16961 @item -mcop32
16962 @opindex mcop32
16963 Enables the 32-bit coprocessor's instructions.
16965 @item -mcop64
16966 @opindex mcop64
16967 Enables the 64-bit coprocessor's instructions.
16969 @item -mivc2
16970 @opindex mivc2
16971 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16973 @item -mdc
16974 @opindex mdc
16975 Causes constant variables to be placed in the @code{.near} section.
16977 @item -mdiv
16978 @opindex mdiv
16979 Enables the @code{div} and @code{divu} instructions.
16981 @item -meb
16982 @opindex meb
16983 Generate big-endian code.
16985 @item -mel
16986 @opindex mel
16987 Generate little-endian code.
16989 @item -mio-volatile
16990 @opindex mio-volatile
16991 Tells the compiler that any variable marked with the @code{io}
16992 attribute is to be considered volatile.
16994 @item -ml
16995 @opindex ml
16996 Causes variables to be assigned to the @code{.far} section by default.
16998 @item -mleadz
16999 @opindex mleadz
17000 Enables the @code{leadz} (leading zero) instruction.
17002 @item -mm
17003 @opindex mm
17004 Causes variables to be assigned to the @code{.near} section by default.
17006 @item -mminmax
17007 @opindex mminmax
17008 Enables the @code{min} and @code{max} instructions.
17010 @item -mmult
17011 @opindex mmult
17012 Enables the multiplication and multiply-accumulate instructions.
17014 @item -mno-opts
17015 @opindex mno-opts
17016 Disables all the optional instructions enabled by @code{-mall-opts}.
17018 @item -mrepeat
17019 @opindex mrepeat
17020 Enables the @code{repeat} and @code{erepeat} instructions, used for
17021 low-overhead looping.
17023 @item -ms
17024 @opindex ms
17025 Causes all variables to default to the @code{.tiny} section.  Note
17026 that there is a 65536-byte limit to this section.  Accesses to these
17027 variables use the @code{%gp} base register.
17029 @item -msatur
17030 @opindex msatur
17031 Enables the saturation instructions.  Note that the compiler does not
17032 currently generate these itself, but this option is included for
17033 compatibility with other tools, like @code{as}.
17035 @item -msdram
17036 @opindex msdram
17037 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17039 @item -msim
17040 @opindex msim
17041 Link the simulator run-time libraries.
17043 @item -msimnovec
17044 @opindex msimnovec
17045 Link the simulator runtime libraries, excluding built-in support
17046 for reset and exception vectors and tables.
17048 @item -mtf
17049 @opindex mtf
17050 Causes all functions to default to the @code{.far} section.  Without
17051 this option, functions default to the @code{.near} section.
17053 @item -mtiny=@var{n}
17054 @opindex mtiny=
17055 Variables that are @var{n} bytes or smaller are allocated to the
17056 @code{.tiny} section.  These variables use the @code{$gp} base
17057 register.  The default for this option is 4, but note that there's a
17058 65536-byte limit to the @code{.tiny} section.
17060 @end table
17062 @node MicroBlaze Options
17063 @subsection MicroBlaze Options
17064 @cindex MicroBlaze Options
17066 @table @gcctabopt
17068 @item -msoft-float
17069 @opindex msoft-float
17070 Use software emulation for floating point (default).
17072 @item -mhard-float
17073 @opindex mhard-float
17074 Use hardware floating-point instructions.
17076 @item -mmemcpy
17077 @opindex mmemcpy
17078 Do not optimize block moves, use @code{memcpy}.
17080 @item -mno-clearbss
17081 @opindex mno-clearbss
17082 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17084 @item -mcpu=@var{cpu-type}
17085 @opindex mcpu=
17086 Use features of, and schedule code for, the given CPU.
17087 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17088 where @var{X} is a major version, @var{YY} is the minor version, and
17089 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17090 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17092 @item -mxl-soft-mul
17093 @opindex mxl-soft-mul
17094 Use software multiply emulation (default).
17096 @item -mxl-soft-div
17097 @opindex mxl-soft-div
17098 Use software emulation for divides (default).
17100 @item -mxl-barrel-shift
17101 @opindex mxl-barrel-shift
17102 Use the hardware barrel shifter.
17104 @item -mxl-pattern-compare
17105 @opindex mxl-pattern-compare
17106 Use pattern compare instructions.
17108 @item -msmall-divides
17109 @opindex msmall-divides
17110 Use table lookup optimization for small signed integer divisions.
17112 @item -mxl-stack-check
17113 @opindex mxl-stack-check
17114 This option is deprecated.  Use @option{-fstack-check} instead.
17116 @item -mxl-gp-opt
17117 @opindex mxl-gp-opt
17118 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17120 @item -mxl-multiply-high
17121 @opindex mxl-multiply-high
17122 Use multiply high instructions for high part of 32x32 multiply.
17124 @item -mxl-float-convert
17125 @opindex mxl-float-convert
17126 Use hardware floating-point conversion instructions.
17128 @item -mxl-float-sqrt
17129 @opindex mxl-float-sqrt
17130 Use hardware floating-point square root instruction.
17132 @item -mbig-endian
17133 @opindex mbig-endian
17134 Generate code for a big-endian target.
17136 @item -mlittle-endian
17137 @opindex mlittle-endian
17138 Generate code for a little-endian target.
17140 @item -mxl-reorder
17141 @opindex mxl-reorder
17142 Use reorder instructions (swap and byte reversed load/store).
17144 @item -mxl-mode-@var{app-model}
17145 Select application model @var{app-model}.  Valid models are
17146 @table @samp
17147 @item executable
17148 normal executable (default), uses startup code @file{crt0.o}.
17150 @item xmdstub
17151 for use with Xilinx Microprocessor Debugger (XMD) based
17152 software intrusive debug agent called xmdstub. This uses startup file
17153 @file{crt1.o} and sets the start address of the program to 0x800.
17155 @item bootstrap
17156 for applications that are loaded using a bootloader.
17157 This model uses startup file @file{crt2.o} which does not contain a processor
17158 reset vector handler. This is suitable for transferring control on a
17159 processor reset to the bootloader rather than the application.
17161 @item novectors
17162 for applications that do not require any of the
17163 MicroBlaze vectors. This option may be useful for applications running
17164 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17165 @end table
17167 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17168 @option{-mxl-mode-@var{app-model}}.
17170 @end table
17172 @node MIPS Options
17173 @subsection MIPS Options
17174 @cindex MIPS options
17176 @table @gcctabopt
17178 @item -EB
17179 @opindex EB
17180 Generate big-endian code.
17182 @item -EL
17183 @opindex EL
17184 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17185 configurations.
17187 @item -march=@var{arch}
17188 @opindex march
17189 Generate code that runs on @var{arch}, which can be the name of a
17190 generic MIPS ISA, or the name of a particular processor.
17191 The ISA names are:
17192 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17193 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5}, 
17194 @samp{mips64}, @samp{mips64r2}, @samp{mips64r3} and @samp{mips64r5}.
17195 The processor names are:
17196 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17197 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17198 @samp{5kc}, @samp{5kf},
17199 @samp{20kc},
17200 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17201 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17202 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17203 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17204 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17205 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17206 @samp{m4k},
17207 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17208 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
17209 @samp{orion},
17210 @samp{p5600},
17211 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17212 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17213 @samp{rm7000}, @samp{rm9000},
17214 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17215 @samp{sb1},
17216 @samp{sr71000},
17217 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17218 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17219 @samp{xlr} and @samp{xlp}.
17220 The special value @samp{from-abi} selects the
17221 most compatible architecture for the selected ABI (that is,
17222 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17224 The native Linux/GNU toolchain also supports the value @samp{native},
17225 which selects the best architecture option for the host processor.
17226 @option{-march=native} has no effect if GCC does not recognize
17227 the processor.
17229 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17230 (for example, @option{-march=r2k}).  Prefixes are optional, and
17231 @samp{vr} may be written @samp{r}.
17233 Names of the form @samp{@var{n}f2_1} refer to processors with
17234 FPUs clocked at half the rate of the core, names of the form
17235 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17236 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17237 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17238 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17239 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17240 accepted as synonyms for @samp{@var{n}f1_1}.
17242 GCC defines two macros based on the value of this option.  The first
17243 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17244 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17245 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17246 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17247 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17249 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17250 above.  In other words, it has the full prefix and does not
17251 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17252 the macro names the resolved architecture (either @samp{"mips1"} or
17253 @samp{"mips3"}).  It names the default architecture when no
17254 @option{-march} option is given.
17256 @item -mtune=@var{arch}
17257 @opindex mtune
17258 Optimize for @var{arch}.  Among other things, this option controls
17259 the way instructions are scheduled, and the perceived cost of arithmetic
17260 operations.  The list of @var{arch} values is the same as for
17261 @option{-march}.
17263 When this option is not used, GCC optimizes for the processor
17264 specified by @option{-march}.  By using @option{-march} and
17265 @option{-mtune} together, it is possible to generate code that
17266 runs on a family of processors, but optimize the code for one
17267 particular member of that family.
17269 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17270 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17271 @option{-march} ones described above.
17273 @item -mips1
17274 @opindex mips1
17275 Equivalent to @option{-march=mips1}.
17277 @item -mips2
17278 @opindex mips2
17279 Equivalent to @option{-march=mips2}.
17281 @item -mips3
17282 @opindex mips3
17283 Equivalent to @option{-march=mips3}.
17285 @item -mips4
17286 @opindex mips4
17287 Equivalent to @option{-march=mips4}.
17289 @item -mips32
17290 @opindex mips32
17291 Equivalent to @option{-march=mips32}.
17293 @item -mips32r3
17294 @opindex mips32r3
17295 Equivalent to @option{-march=mips32r3}.
17297 @item -mips32r5
17298 @opindex mips32r5
17299 Equivalent to @option{-march=mips32r5}.
17301 @item -mips64
17302 @opindex mips64
17303 Equivalent to @option{-march=mips64}.
17305 @item -mips64r2
17306 @opindex mips64r2
17307 Equivalent to @option{-march=mips64r2}.
17309 @item -mips64r3
17310 @opindex mips64r3
17311 Equivalent to @option{-march=mips64r3}.
17313 @item -mips64r5
17314 @opindex mips64r5
17315 Equivalent to @option{-march=mips64r5}.
17317 @item -mips16
17318 @itemx -mno-mips16
17319 @opindex mips16
17320 @opindex mno-mips16
17321 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17322 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17324 MIPS16 code generation can also be controlled on a per-function basis
17325 by means of @code{mips16} and @code{nomips16} attributes.
17326 @xref{Function Attributes}, for more information.
17328 @item -mflip-mips16
17329 @opindex mflip-mips16
17330 Generate MIPS16 code on alternating functions.  This option is provided
17331 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17332 not intended for ordinary use in compiling user code.
17334 @item -minterlink-compressed
17335 @item -mno-interlink-compressed
17336 @opindex minterlink-compressed
17337 @opindex mno-interlink-compressed
17338 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17339 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17341 For example, code using the standard ISA encoding cannot jump directly
17342 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17343 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17344 knows that the target of the jump is not compressed.
17346 @item -minterlink-mips16
17347 @itemx -mno-interlink-mips16
17348 @opindex minterlink-mips16
17349 @opindex mno-interlink-mips16
17350 Aliases of @option{-minterlink-compressed} and
17351 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17352 and are retained for backwards compatibility.
17354 @item -mabi=32
17355 @itemx -mabi=o64
17356 @itemx -mabi=n32
17357 @itemx -mabi=64
17358 @itemx -mabi=eabi
17359 @opindex mabi=32
17360 @opindex mabi=o64
17361 @opindex mabi=n32
17362 @opindex mabi=64
17363 @opindex mabi=eabi
17364 Generate code for the given ABI@.
17366 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17367 generates 64-bit code when you select a 64-bit architecture, but you
17368 can use @option{-mgp32} to get 32-bit code instead.
17370 For information about the O64 ABI, see
17371 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17373 GCC supports a variant of the o32 ABI in which floating-point registers
17374 are 64 rather than 32 bits wide.  You can select this combination with
17375 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17376 and @code{mfhc1} instructions and is therefore only supported for
17377 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17379 The register assignments for arguments and return values remain the
17380 same, but each scalar value is passed in a single 64-bit register
17381 rather than a pair of 32-bit registers.  For example, scalar
17382 floating-point values are returned in @samp{$f0} only, not a
17383 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17384 remains the same, but all 64 bits are saved.
17386 @item -mabicalls
17387 @itemx -mno-abicalls
17388 @opindex mabicalls
17389 @opindex mno-abicalls
17390 Generate (do not generate) code that is suitable for SVR4-style
17391 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17392 systems.
17394 @item -mshared
17395 @itemx -mno-shared
17396 Generate (do not generate) code that is fully position-independent,
17397 and that can therefore be linked into shared libraries.  This option
17398 only affects @option{-mabicalls}.
17400 All @option{-mabicalls} code has traditionally been position-independent,
17401 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17402 as an extension, the GNU toolchain allows executables to use absolute
17403 accesses for locally-binding symbols.  It can also use shorter GP
17404 initialization sequences and generate direct calls to locally-defined
17405 functions.  This mode is selected by @option{-mno-shared}.
17407 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17408 objects that can only be linked by the GNU linker.  However, the option
17409 does not affect the ABI of the final executable; it only affects the ABI
17410 of relocatable objects.  Using @option{-mno-shared} generally makes
17411 executables both smaller and quicker.
17413 @option{-mshared} is the default.
17415 @item -mplt
17416 @itemx -mno-plt
17417 @opindex mplt
17418 @opindex mno-plt
17419 Assume (do not assume) that the static and dynamic linkers
17420 support PLTs and copy relocations.  This option only affects
17421 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17422 has no effect without @option{-msym32}.
17424 You can make @option{-mplt} the default by configuring
17425 GCC with @option{--with-mips-plt}.  The default is
17426 @option{-mno-plt} otherwise.
17428 @item -mxgot
17429 @itemx -mno-xgot
17430 @opindex mxgot
17431 @opindex mno-xgot
17432 Lift (do not lift) the usual restrictions on the size of the global
17433 offset table.
17435 GCC normally uses a single instruction to load values from the GOT@.
17436 While this is relatively efficient, it only works if the GOT
17437 is smaller than about 64k.  Anything larger causes the linker
17438 to report an error such as:
17440 @cindex relocation truncated to fit (MIPS)
17441 @smallexample
17442 relocation truncated to fit: R_MIPS_GOT16 foobar
17443 @end smallexample
17445 If this happens, you should recompile your code with @option{-mxgot}.
17446 This works with very large GOTs, although the code is also
17447 less efficient, since it takes three instructions to fetch the
17448 value of a global symbol.
17450 Note that some linkers can create multiple GOTs.  If you have such a
17451 linker, you should only need to use @option{-mxgot} when a single object
17452 file accesses more than 64k's worth of GOT entries.  Very few do.
17454 These options have no effect unless GCC is generating position
17455 independent code.
17457 @item -mgp32
17458 @opindex mgp32
17459 Assume that general-purpose registers are 32 bits wide.
17461 @item -mgp64
17462 @opindex mgp64
17463 Assume that general-purpose registers are 64 bits wide.
17465 @item -mfp32
17466 @opindex mfp32
17467 Assume that floating-point registers are 32 bits wide.
17469 @item -mfp64
17470 @opindex mfp64
17471 Assume that floating-point registers are 64 bits wide.
17473 @item -mhard-float
17474 @opindex mhard-float
17475 Use floating-point coprocessor instructions.
17477 @item -msoft-float
17478 @opindex msoft-float
17479 Do not use floating-point coprocessor instructions.  Implement
17480 floating-point calculations using library calls instead.
17482 @item -mno-float
17483 @opindex mno-float
17484 Equivalent to @option{-msoft-float}, but additionally asserts that the
17485 program being compiled does not perform any floating-point operations.
17486 This option is presently supported only by some bare-metal MIPS
17487 configurations, where it may select a special set of libraries
17488 that lack all floating-point support (including, for example, the
17489 floating-point @code{printf} formats).  
17490 If code compiled with @code{-mno-float} accidentally contains
17491 floating-point operations, it is likely to suffer a link-time
17492 or run-time failure.
17494 @item -msingle-float
17495 @opindex msingle-float
17496 Assume that the floating-point coprocessor only supports single-precision
17497 operations.
17499 @item -mdouble-float
17500 @opindex mdouble-float
17501 Assume that the floating-point coprocessor supports double-precision
17502 operations.  This is the default.
17504 @item -mabs=2008
17505 @itemx -mabs=legacy
17506 @opindex mabs=2008
17507 @opindex mabs=legacy
17508 These options control the treatment of the special not-a-number (NaN)
17509 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17510 @code{neg.@i{fmt}} machine instructions.
17512 By default or when the @option{-mabs=legacy} is used the legacy
17513 treatment is selected.  In this case these instructions are considered
17514 arithmetic and avoided where correct operation is required and the
17515 input operand might be a NaN.  A longer sequence of instructions that
17516 manipulate the sign bit of floating-point datum manually is used
17517 instead unless the @option{-ffinite-math-only} option has also been
17518 specified.
17520 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17521 this case these instructions are considered non-arithmetic and therefore
17522 operating correctly in all cases, including in particular where the
17523 input operand is a NaN.  These instructions are therefore always used
17524 for the respective operations.
17526 @item -mnan=2008
17527 @itemx -mnan=legacy
17528 @opindex mnan=2008
17529 @opindex mnan=legacy
17530 These options control the encoding of the special not-a-number (NaN)
17531 IEEE 754 floating-point data.
17533 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17534 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17535 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17536 by the first bit of their trailing significand field being 1.
17538 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17539 this case qNaNs are denoted by the first bit of their trailing
17540 significand field being 1, whereas sNaNs are denoted by the first bit of
17541 their trailing significand field being 0.
17543 The default is @option{-mnan=legacy} unless GCC has been configured with
17544 @option{--with-nan=2008}.
17546 @item -mllsc
17547 @itemx -mno-llsc
17548 @opindex mllsc
17549 @opindex mno-llsc
17550 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17551 implement atomic memory built-in functions.  When neither option is
17552 specified, GCC uses the instructions if the target architecture
17553 supports them.
17555 @option{-mllsc} is useful if the runtime environment can emulate the
17556 instructions and @option{-mno-llsc} can be useful when compiling for
17557 nonstandard ISAs.  You can make either option the default by
17558 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17559 respectively.  @option{--with-llsc} is the default for some
17560 configurations; see the installation documentation for details.
17562 @item -mdsp
17563 @itemx -mno-dsp
17564 @opindex mdsp
17565 @opindex mno-dsp
17566 Use (do not use) revision 1 of the MIPS DSP ASE@.
17567 @xref{MIPS DSP Built-in Functions}.  This option defines the
17568 preprocessor macro @samp{__mips_dsp}.  It also defines
17569 @samp{__mips_dsp_rev} to 1.
17571 @item -mdspr2
17572 @itemx -mno-dspr2
17573 @opindex mdspr2
17574 @opindex mno-dspr2
17575 Use (do not use) revision 2 of the MIPS DSP ASE@.
17576 @xref{MIPS DSP Built-in Functions}.  This option defines the
17577 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
17578 It also defines @samp{__mips_dsp_rev} to 2.
17580 @item -msmartmips
17581 @itemx -mno-smartmips
17582 @opindex msmartmips
17583 @opindex mno-smartmips
17584 Use (do not use) the MIPS SmartMIPS ASE.
17586 @item -mpaired-single
17587 @itemx -mno-paired-single
17588 @opindex mpaired-single
17589 @opindex mno-paired-single
17590 Use (do not use) paired-single floating-point instructions.
17591 @xref{MIPS Paired-Single Support}.  This option requires
17592 hardware floating-point support to be enabled.
17594 @item -mdmx
17595 @itemx -mno-mdmx
17596 @opindex mdmx
17597 @opindex mno-mdmx
17598 Use (do not use) MIPS Digital Media Extension instructions.
17599 This option can only be used when generating 64-bit code and requires
17600 hardware floating-point support to be enabled.
17602 @item -mips3d
17603 @itemx -mno-mips3d
17604 @opindex mips3d
17605 @opindex mno-mips3d
17606 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17607 The option @option{-mips3d} implies @option{-mpaired-single}.
17609 @item -mmicromips
17610 @itemx -mno-micromips
17611 @opindex mmicromips
17612 @opindex mno-mmicromips
17613 Generate (do not generate) microMIPS code.
17615 MicroMIPS code generation can also be controlled on a per-function basis
17616 by means of @code{micromips} and @code{nomicromips} attributes.
17617 @xref{Function Attributes}, for more information.
17619 @item -mmt
17620 @itemx -mno-mt
17621 @opindex mmt
17622 @opindex mno-mt
17623 Use (do not use) MT Multithreading instructions.
17625 @item -mmcu
17626 @itemx -mno-mcu
17627 @opindex mmcu
17628 @opindex mno-mcu
17629 Use (do not use) the MIPS MCU ASE instructions.
17631 @item -meva
17632 @itemx -mno-eva
17633 @opindex meva
17634 @opindex mno-eva
17635 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17637 @item -mvirt
17638 @itemx -mno-virt
17639 @opindex mvirt
17640 @opindex mno-virt
17641 Use (do not use) the MIPS Virtualization Application Specific instructions.
17643 @item -mxpa
17644 @itemx -mno-xpa
17645 @opindex mxpa
17646 @opindex mno-xpa
17647 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17649 @item -mlong64
17650 @opindex mlong64
17651 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17652 an explanation of the default and the way that the pointer size is
17653 determined.
17655 @item -mlong32
17656 @opindex mlong32
17657 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17659 The default size of @code{int}s, @code{long}s and pointers depends on
17660 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17661 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17662 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17663 or the same size as integer registers, whichever is smaller.
17665 @item -msym32
17666 @itemx -mno-sym32
17667 @opindex msym32
17668 @opindex mno-sym32
17669 Assume (do not assume) that all symbols have 32-bit values, regardless
17670 of the selected ABI@.  This option is useful in combination with
17671 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17672 to generate shorter and faster references to symbolic addresses.
17674 @item -G @var{num}
17675 @opindex G
17676 Put definitions of externally-visible data in a small data section
17677 if that data is no bigger than @var{num} bytes.  GCC can then generate
17678 more efficient accesses to the data; see @option{-mgpopt} for details.
17680 The default @option{-G} option depends on the configuration.
17682 @item -mlocal-sdata
17683 @itemx -mno-local-sdata
17684 @opindex mlocal-sdata
17685 @opindex mno-local-sdata
17686 Extend (do not extend) the @option{-G} behavior to local data too,
17687 such as to static variables in C@.  @option{-mlocal-sdata} is the
17688 default for all configurations.
17690 If the linker complains that an application is using too much small data,
17691 you might want to try rebuilding the less performance-critical parts with
17692 @option{-mno-local-sdata}.  You might also want to build large
17693 libraries with @option{-mno-local-sdata}, so that the libraries leave
17694 more room for the main program.
17696 @item -mextern-sdata
17697 @itemx -mno-extern-sdata
17698 @opindex mextern-sdata
17699 @opindex mno-extern-sdata
17700 Assume (do not assume) that externally-defined data is in
17701 a small data section if the size of that data is within the @option{-G} limit.
17702 @option{-mextern-sdata} is the default for all configurations.
17704 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17705 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17706 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17707 is placed in a small data section.  If @var{Var} is defined by another
17708 module, you must either compile that module with a high-enough
17709 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17710 definition.  If @var{Var} is common, you must link the application
17711 with a high-enough @option{-G} setting.
17713 The easiest way of satisfying these restrictions is to compile
17714 and link every module with the same @option{-G} option.  However,
17715 you may wish to build a library that supports several different
17716 small data limits.  You can do this by compiling the library with
17717 the highest supported @option{-G} setting and additionally using
17718 @option{-mno-extern-sdata} to stop the library from making assumptions
17719 about externally-defined data.
17721 @item -mgpopt
17722 @itemx -mno-gpopt
17723 @opindex mgpopt
17724 @opindex mno-gpopt
17725 Use (do not use) GP-relative accesses for symbols that are known to be
17726 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17727 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17728 configurations.
17730 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17731 might not hold the value of @code{_gp}.  For example, if the code is
17732 part of a library that might be used in a boot monitor, programs that
17733 call boot monitor routines pass an unknown value in @code{$gp}.
17734 (In such situations, the boot monitor itself is usually compiled
17735 with @option{-G0}.)
17737 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17738 @option{-mno-extern-sdata}.
17740 @item -membedded-data
17741 @itemx -mno-embedded-data
17742 @opindex membedded-data
17743 @opindex mno-embedded-data
17744 Allocate variables to the read-only data section first if possible, then
17745 next in the small data section if possible, otherwise in data.  This gives
17746 slightly slower code than the default, but reduces the amount of RAM required
17747 when executing, and thus may be preferred for some embedded systems.
17749 @item -muninit-const-in-rodata
17750 @itemx -mno-uninit-const-in-rodata
17751 @opindex muninit-const-in-rodata
17752 @opindex mno-uninit-const-in-rodata
17753 Put uninitialized @code{const} variables in the read-only data section.
17754 This option is only meaningful in conjunction with @option{-membedded-data}.
17756 @item -mcode-readable=@var{setting}
17757 @opindex mcode-readable
17758 Specify whether GCC may generate code that reads from executable sections.
17759 There are three possible settings:
17761 @table @gcctabopt
17762 @item -mcode-readable=yes
17763 Instructions may freely access executable sections.  This is the
17764 default setting.
17766 @item -mcode-readable=pcrel
17767 MIPS16 PC-relative load instructions can access executable sections,
17768 but other instructions must not do so.  This option is useful on 4KSc
17769 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17770 It is also useful on processors that can be configured to have a dual
17771 instruction/data SRAM interface and that, like the M4K, automatically
17772 redirect PC-relative loads to the instruction RAM.
17774 @item -mcode-readable=no
17775 Instructions must not access executable sections.  This option can be
17776 useful on targets that are configured to have a dual instruction/data
17777 SRAM interface but that (unlike the M4K) do not automatically redirect
17778 PC-relative loads to the instruction RAM.
17779 @end table
17781 @item -msplit-addresses
17782 @itemx -mno-split-addresses
17783 @opindex msplit-addresses
17784 @opindex mno-split-addresses
17785 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17786 relocation operators.  This option has been superseded by
17787 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17789 @item -mexplicit-relocs
17790 @itemx -mno-explicit-relocs
17791 @opindex mexplicit-relocs
17792 @opindex mno-explicit-relocs
17793 Use (do not use) assembler relocation operators when dealing with symbolic
17794 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17795 is to use assembler macros instead.
17797 @option{-mexplicit-relocs} is the default if GCC was configured
17798 to use an assembler that supports relocation operators.
17800 @item -mcheck-zero-division
17801 @itemx -mno-check-zero-division
17802 @opindex mcheck-zero-division
17803 @opindex mno-check-zero-division
17804 Trap (do not trap) on integer division by zero.
17806 The default is @option{-mcheck-zero-division}.
17808 @item -mdivide-traps
17809 @itemx -mdivide-breaks
17810 @opindex mdivide-traps
17811 @opindex mdivide-breaks
17812 MIPS systems check for division by zero by generating either a
17813 conditional trap or a break instruction.  Using traps results in
17814 smaller code, but is only supported on MIPS II and later.  Also, some
17815 versions of the Linux kernel have a bug that prevents trap from
17816 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17817 allow conditional traps on architectures that support them and
17818 @option{-mdivide-breaks} to force the use of breaks.
17820 The default is usually @option{-mdivide-traps}, but this can be
17821 overridden at configure time using @option{--with-divide=breaks}.
17822 Divide-by-zero checks can be completely disabled using
17823 @option{-mno-check-zero-division}.
17825 @item -mmemcpy
17826 @itemx -mno-memcpy
17827 @opindex mmemcpy
17828 @opindex mno-memcpy
17829 Force (do not force) the use of @code{memcpy()} for non-trivial block
17830 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17831 most constant-sized copies.
17833 @item -mlong-calls
17834 @itemx -mno-long-calls
17835 @opindex mlong-calls
17836 @opindex mno-long-calls
17837 Disable (do not disable) use of the @code{jal} instruction.  Calling
17838 functions using @code{jal} is more efficient but requires the caller
17839 and callee to be in the same 256 megabyte segment.
17841 This option has no effect on abicalls code.  The default is
17842 @option{-mno-long-calls}.
17844 @item -mmad
17845 @itemx -mno-mad
17846 @opindex mmad
17847 @opindex mno-mad
17848 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17849 instructions, as provided by the R4650 ISA@.
17851 @item -mimadd
17852 @itemx -mno-imadd
17853 @opindex mimadd
17854 @opindex mno-imadd
17855 Enable (disable) use of the @code{madd} and @code{msub} integer
17856 instructions.  The default is @option{-mimadd} on architectures
17857 that support @code{madd} and @code{msub} except for the 74k 
17858 architecture where it was found to generate slower code.
17860 @item -mfused-madd
17861 @itemx -mno-fused-madd
17862 @opindex mfused-madd
17863 @opindex mno-fused-madd
17864 Enable (disable) use of the floating-point multiply-accumulate
17865 instructions, when they are available.  The default is
17866 @option{-mfused-madd}.
17868 On the R8000 CPU when multiply-accumulate instructions are used,
17869 the intermediate product is calculated to infinite precision
17870 and is not subject to the FCSR Flush to Zero bit.  This may be
17871 undesirable in some circumstances.  On other processors the result
17872 is numerically identical to the equivalent computation using
17873 separate multiply, add, subtract and negate instructions.
17875 @item -nocpp
17876 @opindex nocpp
17877 Tell the MIPS assembler to not run its preprocessor over user
17878 assembler files (with a @samp{.s} suffix) when assembling them.
17880 @item -mfix-24k
17881 @item -mno-fix-24k
17882 @opindex mfix-24k
17883 @opindex mno-fix-24k
17884 Work around the 24K E48 (lost data on stores during refill) errata.
17885 The workarounds are implemented by the assembler rather than by GCC@.
17887 @item -mfix-r4000
17888 @itemx -mno-fix-r4000
17889 @opindex mfix-r4000
17890 @opindex mno-fix-r4000
17891 Work around certain R4000 CPU errata:
17892 @itemize @minus
17893 @item
17894 A double-word or a variable shift may give an incorrect result if executed
17895 immediately after starting an integer division.
17896 @item
17897 A double-word or a variable shift may give an incorrect result if executed
17898 while an integer multiplication is in progress.
17899 @item
17900 An integer division may give an incorrect result if started in a delay slot
17901 of a taken branch or a jump.
17902 @end itemize
17904 @item -mfix-r4400
17905 @itemx -mno-fix-r4400
17906 @opindex mfix-r4400
17907 @opindex mno-fix-r4400
17908 Work around certain R4400 CPU errata:
17909 @itemize @minus
17910 @item
17911 A double-word or a variable shift may give an incorrect result if executed
17912 immediately after starting an integer division.
17913 @end itemize
17915 @item -mfix-r10000
17916 @itemx -mno-fix-r10000
17917 @opindex mfix-r10000
17918 @opindex mno-fix-r10000
17919 Work around certain R10000 errata:
17920 @itemize @minus
17921 @item
17922 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17923 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17924 @end itemize
17926 This option can only be used if the target architecture supports
17927 branch-likely instructions.  @option{-mfix-r10000} is the default when
17928 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17929 otherwise.
17931 @item -mfix-rm7000
17932 @itemx -mno-fix-rm7000
17933 @opindex mfix-rm7000
17934 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17935 workarounds are implemented by the assembler rather than by GCC@.
17937 @item -mfix-vr4120
17938 @itemx -mno-fix-vr4120
17939 @opindex mfix-vr4120
17940 Work around certain VR4120 errata:
17941 @itemize @minus
17942 @item
17943 @code{dmultu} does not always produce the correct result.
17944 @item
17945 @code{div} and @code{ddiv} do not always produce the correct result if one
17946 of the operands is negative.
17947 @end itemize
17948 The workarounds for the division errata rely on special functions in
17949 @file{libgcc.a}.  At present, these functions are only provided by
17950 the @code{mips64vr*-elf} configurations.
17952 Other VR4120 errata require a NOP to be inserted between certain pairs of
17953 instructions.  These errata are handled by the assembler, not by GCC itself.
17955 @item -mfix-vr4130
17956 @opindex mfix-vr4130
17957 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17958 workarounds are implemented by the assembler rather than by GCC,
17959 although GCC avoids using @code{mflo} and @code{mfhi} if the
17960 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17961 instructions are available instead.
17963 @item -mfix-sb1
17964 @itemx -mno-fix-sb1
17965 @opindex mfix-sb1
17966 Work around certain SB-1 CPU core errata.
17967 (This flag currently works around the SB-1 revision 2
17968 ``F1'' and ``F2'' floating-point errata.)
17970 @item -mr10k-cache-barrier=@var{setting}
17971 @opindex mr10k-cache-barrier
17972 Specify whether GCC should insert cache barriers to avoid the
17973 side-effects of speculation on R10K processors.
17975 In common with many processors, the R10K tries to predict the outcome
17976 of a conditional branch and speculatively executes instructions from
17977 the ``taken'' branch.  It later aborts these instructions if the
17978 predicted outcome is wrong.  However, on the R10K, even aborted
17979 instructions can have side effects.
17981 This problem only affects kernel stores and, depending on the system,
17982 kernel loads.  As an example, a speculatively-executed store may load
17983 the target memory into cache and mark the cache line as dirty, even if
17984 the store itself is later aborted.  If a DMA operation writes to the
17985 same area of memory before the ``dirty'' line is flushed, the cached
17986 data overwrites the DMA-ed data.  See the R10K processor manual
17987 for a full description, including other potential problems.
17989 One workaround is to insert cache barrier instructions before every memory
17990 access that might be speculatively executed and that might have side
17991 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17992 controls GCC's implementation of this workaround.  It assumes that
17993 aborted accesses to any byte in the following regions does not have
17994 side effects:
17996 @enumerate
17997 @item
17998 the memory occupied by the current function's stack frame;
18000 @item
18001 the memory occupied by an incoming stack argument;
18003 @item
18004 the memory occupied by an object with a link-time-constant address.
18005 @end enumerate
18007 It is the kernel's responsibility to ensure that speculative
18008 accesses to these regions are indeed safe.
18010 If the input program contains a function declaration such as:
18012 @smallexample
18013 void foo (void);
18014 @end smallexample
18016 then the implementation of @code{foo} must allow @code{j foo} and
18017 @code{jal foo} to be executed speculatively.  GCC honors this
18018 restriction for functions it compiles itself.  It expects non-GCC
18019 functions (such as hand-written assembly code) to do the same.
18021 The option has three forms:
18023 @table @gcctabopt
18024 @item -mr10k-cache-barrier=load-store
18025 Insert a cache barrier before a load or store that might be
18026 speculatively executed and that might have side effects even
18027 if aborted.
18029 @item -mr10k-cache-barrier=store
18030 Insert a cache barrier before a store that might be speculatively
18031 executed and that might have side effects even if aborted.
18033 @item -mr10k-cache-barrier=none
18034 Disable the insertion of cache barriers.  This is the default setting.
18035 @end table
18037 @item -mflush-func=@var{func}
18038 @itemx -mno-flush-func
18039 @opindex mflush-func
18040 Specifies the function to call to flush the I and D caches, or to not
18041 call any such function.  If called, the function must take the same
18042 arguments as the common @code{_flush_func()}, that is, the address of the
18043 memory range for which the cache is being flushed, the size of the
18044 memory range, and the number 3 (to flush both caches).  The default
18045 depends on the target GCC was configured for, but commonly is either
18046 @samp{_flush_func} or @samp{__cpu_flush}.
18048 @item mbranch-cost=@var{num}
18049 @opindex mbranch-cost
18050 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18051 This cost is only a heuristic and is not guaranteed to produce
18052 consistent results across releases.  A zero cost redundantly selects
18053 the default, which is based on the @option{-mtune} setting.
18055 @item -mbranch-likely
18056 @itemx -mno-branch-likely
18057 @opindex mbranch-likely
18058 @opindex mno-branch-likely
18059 Enable or disable use of Branch Likely instructions, regardless of the
18060 default for the selected architecture.  By default, Branch Likely
18061 instructions may be generated if they are supported by the selected
18062 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18063 and processors that implement those architectures; for those, Branch
18064 Likely instructions are not be generated by default because the MIPS32
18065 and MIPS64 architectures specifically deprecate their use.
18067 @item -mfp-exceptions
18068 @itemx -mno-fp-exceptions
18069 @opindex mfp-exceptions
18070 Specifies whether FP exceptions are enabled.  This affects how
18071 FP instructions are scheduled for some processors.
18072 The default is that FP exceptions are
18073 enabled.
18075 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18076 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18077 FP pipe.
18079 @item -mvr4130-align
18080 @itemx -mno-vr4130-align
18081 @opindex mvr4130-align
18082 The VR4130 pipeline is two-way superscalar, but can only issue two
18083 instructions together if the first one is 8-byte aligned.  When this
18084 option is enabled, GCC aligns pairs of instructions that it
18085 thinks should execute in parallel.
18087 This option only has an effect when optimizing for the VR4130.
18088 It normally makes code faster, but at the expense of making it bigger.
18089 It is enabled by default at optimization level @option{-O3}.
18091 @item -msynci
18092 @itemx -mno-synci
18093 @opindex msynci
18094 Enable (disable) generation of @code{synci} instructions on
18095 architectures that support it.  The @code{synci} instructions (if
18096 enabled) are generated when @code{__builtin___clear_cache()} is
18097 compiled.
18099 This option defaults to @code{-mno-synci}, but the default can be
18100 overridden by configuring with @code{--with-synci}.
18102 When compiling code for single processor systems, it is generally safe
18103 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18104 does not invalidate the instruction caches on all cores and may lead
18105 to undefined behavior.
18107 @item -mrelax-pic-calls
18108 @itemx -mno-relax-pic-calls
18109 @opindex mrelax-pic-calls
18110 Try to turn PIC calls that are normally dispatched via register
18111 @code{$25} into direct calls.  This is only possible if the linker can
18112 resolve the destination at link-time and if the destination is within
18113 range for a direct call.
18115 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18116 an assembler and a linker that support the @code{.reloc} assembly
18117 directive and @code{-mexplicit-relocs} is in effect.  With
18118 @code{-mno-explicit-relocs}, this optimization can be performed by the
18119 assembler and the linker alone without help from the compiler.
18121 @item -mmcount-ra-address
18122 @itemx -mno-mcount-ra-address
18123 @opindex mmcount-ra-address
18124 @opindex mno-mcount-ra-address
18125 Emit (do not emit) code that allows @code{_mcount} to modify the
18126 calling function's return address.  When enabled, this option extends
18127 the usual @code{_mcount} interface with a new @var{ra-address}
18128 parameter, which has type @code{intptr_t *} and is passed in register
18129 @code{$12}.  @code{_mcount} can then modify the return address by
18130 doing both of the following:
18131 @itemize
18132 @item
18133 Returning the new address in register @code{$31}.
18134 @item
18135 Storing the new address in @code{*@var{ra-address}},
18136 if @var{ra-address} is nonnull.
18137 @end itemize
18139 The default is @option{-mno-mcount-ra-address}.
18141 @end table
18143 @node MMIX Options
18144 @subsection MMIX Options
18145 @cindex MMIX Options
18147 These options are defined for the MMIX:
18149 @table @gcctabopt
18150 @item -mlibfuncs
18151 @itemx -mno-libfuncs
18152 @opindex mlibfuncs
18153 @opindex mno-libfuncs
18154 Specify that intrinsic library functions are being compiled, passing all
18155 values in registers, no matter the size.
18157 @item -mepsilon
18158 @itemx -mno-epsilon
18159 @opindex mepsilon
18160 @opindex mno-epsilon
18161 Generate floating-point comparison instructions that compare with respect
18162 to the @code{rE} epsilon register.
18164 @item -mabi=mmixware
18165 @itemx -mabi=gnu
18166 @opindex mabi=mmixware
18167 @opindex mabi=gnu
18168 Generate code that passes function parameters and return values that (in
18169 the called function) are seen as registers @code{$0} and up, as opposed to
18170 the GNU ABI which uses global registers @code{$231} and up.
18172 @item -mzero-extend
18173 @itemx -mno-zero-extend
18174 @opindex mzero-extend
18175 @opindex mno-zero-extend
18176 When reading data from memory in sizes shorter than 64 bits, use (do not
18177 use) zero-extending load instructions by default, rather than
18178 sign-extending ones.
18180 @item -mknuthdiv
18181 @itemx -mno-knuthdiv
18182 @opindex mknuthdiv
18183 @opindex mno-knuthdiv
18184 Make the result of a division yielding a remainder have the same sign as
18185 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18186 remainder follows the sign of the dividend.  Both methods are
18187 arithmetically valid, the latter being almost exclusively used.
18189 @item -mtoplevel-symbols
18190 @itemx -mno-toplevel-symbols
18191 @opindex mtoplevel-symbols
18192 @opindex mno-toplevel-symbols
18193 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18194 code can be used with the @code{PREFIX} assembly directive.
18196 @item -melf
18197 @opindex melf
18198 Generate an executable in the ELF format, rather than the default
18199 @samp{mmo} format used by the @command{mmix} simulator.
18201 @item -mbranch-predict
18202 @itemx -mno-branch-predict
18203 @opindex mbranch-predict
18204 @opindex mno-branch-predict
18205 Use (do not use) the probable-branch instructions, when static branch
18206 prediction indicates a probable branch.
18208 @item -mbase-addresses
18209 @itemx -mno-base-addresses
18210 @opindex mbase-addresses
18211 @opindex mno-base-addresses
18212 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18213 base address automatically generates a request (handled by the assembler
18214 and the linker) for a constant to be set up in a global register.  The
18215 register is used for one or more base address requests within the range 0
18216 to 255 from the value held in the register.  The generally leads to short
18217 and fast code, but the number of different data items that can be
18218 addressed is limited.  This means that a program that uses lots of static
18219 data may require @option{-mno-base-addresses}.
18221 @item -msingle-exit
18222 @itemx -mno-single-exit
18223 @opindex msingle-exit
18224 @opindex mno-single-exit
18225 Force (do not force) generated code to have a single exit point in each
18226 function.
18227 @end table
18229 @node MN10300 Options
18230 @subsection MN10300 Options
18231 @cindex MN10300 options
18233 These @option{-m} options are defined for Matsushita MN10300 architectures:
18235 @table @gcctabopt
18236 @item -mmult-bug
18237 @opindex mmult-bug
18238 Generate code to avoid bugs in the multiply instructions for the MN10300
18239 processors.  This is the default.
18241 @item -mno-mult-bug
18242 @opindex mno-mult-bug
18243 Do not generate code to avoid bugs in the multiply instructions for the
18244 MN10300 processors.
18246 @item -mam33
18247 @opindex mam33
18248 Generate code using features specific to the AM33 processor.
18250 @item -mno-am33
18251 @opindex mno-am33
18252 Do not generate code using features specific to the AM33 processor.  This
18253 is the default.
18255 @item -mam33-2
18256 @opindex mam33-2
18257 Generate code using features specific to the AM33/2.0 processor.
18259 @item -mam34
18260 @opindex mam34
18261 Generate code using features specific to the AM34 processor.
18263 @item -mtune=@var{cpu-type}
18264 @opindex mtune
18265 Use the timing characteristics of the indicated CPU type when
18266 scheduling instructions.  This does not change the targeted processor
18267 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18268 @samp{am33-2} or @samp{am34}.
18270 @item -mreturn-pointer-on-d0
18271 @opindex mreturn-pointer-on-d0
18272 When generating a function that returns a pointer, return the pointer
18273 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18274 only in @code{a0}, and attempts to call such functions without a prototype
18275 result in errors.  Note that this option is on by default; use
18276 @option{-mno-return-pointer-on-d0} to disable it.
18278 @item -mno-crt0
18279 @opindex mno-crt0
18280 Do not link in the C run-time initialization object file.
18282 @item -mrelax
18283 @opindex mrelax
18284 Indicate to the linker that it should perform a relaxation optimization pass
18285 to shorten branches, calls and absolute memory addresses.  This option only
18286 has an effect when used on the command line for the final link step.
18288 This option makes symbolic debugging impossible.
18290 @item -mliw
18291 @opindex mliw
18292 Allow the compiler to generate @emph{Long Instruction Word}
18293 instructions if the target is the @samp{AM33} or later.  This is the
18294 default.  This option defines the preprocessor macro @samp{__LIW__}.
18296 @item -mnoliw
18297 @opindex mnoliw
18298 Do not allow the compiler to generate @emph{Long Instruction Word}
18299 instructions.  This option defines the preprocessor macro
18300 @samp{__NO_LIW__}.
18302 @item -msetlb
18303 @opindex msetlb
18304 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18305 instructions if the target is the @samp{AM33} or later.  This is the
18306 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18308 @item -mnosetlb
18309 @opindex mnosetlb
18310 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18311 instructions.  This option defines the preprocessor macro
18312 @samp{__NO_SETLB__}.
18314 @end table
18316 @node Moxie Options
18317 @subsection Moxie Options
18318 @cindex Moxie Options
18320 @table @gcctabopt
18322 @item -meb
18323 @opindex meb
18324 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18325 configurations.
18327 @item -mel
18328 @opindex mel
18329 Generate little-endian code.
18331 @item -mno-crt0
18332 @opindex mno-crt0
18333 Do not link in the C run-time initialization object file.
18335 @end table
18337 @node MSP430 Options
18338 @subsection MSP430 Options
18339 @cindex MSP430 Options
18341 These options are defined for the MSP430:
18343 @table @gcctabopt
18345 @item -masm-hex
18346 @opindex masm-hex
18347 Force assembly output to always use hex constants.  Normally such
18348 constants are signed decimals, but this option is available for
18349 testsuite and/or aesthetic purposes.
18351 @item -mmcu=
18352 @opindex mmcu=
18353 Select the MCU to target.  This is used to create a C preprocessor
18354 symbol based upon the MCU name, converted to upper case and pre- and
18355 post- fixed with @code{__}.  This in turn will be used by the
18356 @code{msp430.h} header file to select an MCU specific supplimentary
18357 header file.
18359 The option also sets the ISA to use.  If the MCU name is one that is
18360 known to only support the 430 ISA then that is selected, otherwise the
18361 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18362 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18363 name will select the 430X ISA.
18365 In addition an MCU specific linker script will be added to the linker
18366 command line.  The script's name is the name of the MCU with
18367 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18368 command line will define the C preprocessor symbol @code{__XXX__} and
18369 cause the linker to search for a script called @file{xxx.ld}.
18371 This option is also passed on to the assembler.
18373 @item -mcpu=
18374 @opindex -mcpu=
18375 Specifies the ISA to use.  Accepted values are @code{msp430},
18376 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18377 @option{-mmcu=} option should be used to select the ISA.
18379 @item -msim
18380 @opindex msim
18381 Link to the simulator runtime libraries and linker script.  Overrides
18382 any scripts that would be selected by the @option{-mmcu=} option.
18384 @item -mlarge
18385 @opindex mlarge
18386 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18388 @item -msmall
18389 @opindex msmall
18390 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18392 @item -mrelax
18393 @opindex mrelax
18394 This option is passed to the assembler and linker, and allows the
18395 linker to perform certain optimizations that cannot be done until
18396 the final link.
18398 @item mhwmult=
18399 @opindex mhwmult=
18400 Describes the type of hardware multiply supported by the target.
18401 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18402 for the original 16-bit-only multiply supported by early MCUs.
18403 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18404 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18405 A value of @code{auto} can also be given.  This tells GCC to deduce
18406 the hardware multiply support based upon the MCU name provided by the
18407 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18408 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18409 default setting.
18411 Hardware multiplies are normally performed by calling a library
18412 routine.  This saves space in the generated code.  When compiling at
18413 @code{-O3} or higher however the hardware multiplier is invoked
18414 inline.  This makes for bigger, but faster code.
18416 The hardware multiply routines disable interrupts whilst running and
18417 restore the previous interrupt state when they finish.  This makes
18418 them safe to use inside interrupt handlers as well as in normal code.
18420 @end table
18422 @node NDS32 Options
18423 @subsection NDS32 Options
18424 @cindex NDS32 Options
18426 These options are defined for NDS32 implementations:
18428 @table @gcctabopt
18430 @item -mbig-endian
18431 @opindex mbig-endian
18432 Generate code in big-endian mode.
18434 @item -mlittle-endian
18435 @opindex mlittle-endian
18436 Generate code in little-endian mode.
18438 @item -mreduced-regs
18439 @opindex mreduced-regs
18440 Use reduced-set registers for register allocation.
18442 @item -mfull-regs
18443 @opindex mfull-regs
18444 Use full-set registers for register allocation.
18446 @item -mcmov
18447 @opindex mcmov
18448 Generate conditional move instructions.
18450 @item -mno-cmov
18451 @opindex mno-cmov
18452 Do not generate conditional move instructions.
18454 @item -mperf-ext
18455 @opindex mperf-ext
18456 Generate performance extension instructions.
18458 @item -mno-perf-ext
18459 @opindex mno-perf-ext
18460 Do not generate performance extension instructions.
18462 @item -mv3push
18463 @opindex mv3push
18464 Generate v3 push25/pop25 instructions.
18466 @item -mno-v3push
18467 @opindex mno-v3push
18468 Do not generate v3 push25/pop25 instructions.
18470 @item -m16-bit
18471 @opindex m16-bit
18472 Generate 16-bit instructions.
18474 @item -mno-16-bit
18475 @opindex mno-16-bit
18476 Do not generate 16-bit instructions.
18478 @item -mgp-direct
18479 @opindex mgp-direct
18480 Generate GP base instructions directly.
18482 @item -mno-gp-direct
18483 @opindex mno-gp-direct
18484 Do no generate GP base instructions directly.
18486 @item -misr-vector-size=@var{num}
18487 @opindex misr-vector-size
18488 Specify the size of each interrupt vector, which must be 4 or 16.
18490 @item -mcache-block-size=@var{num}
18491 @opindex mcache-block-size
18492 Specify the size of each cache block,
18493 which must be a power of 2 between 4 and 512.
18495 @item -march=@var{arch}
18496 @opindex march
18497 Specify the name of the target architecture.
18499 @item -mforce-fp-as-gp
18500 @opindex mforce-fp-as-gp
18501 Prevent $fp being allocated during register allocation so that compiler
18502 is able to force performing fp-as-gp optimization.
18504 @item -mforbid-fp-as-gp
18505 @opindex mforbid-fp-as-gp
18506 Forbid using $fp to access static and global variables.
18507 This option strictly forbids fp-as-gp optimization
18508 regardless of @option{-mforce-fp-as-gp}.
18510 @item -mex9
18511 @opindex mex9
18512 Use special directives to guide linker doing ex9 optimization.
18514 @item -mctor-dtor
18515 @opindex mctor-dtor
18516 Enable constructor/destructor feature.
18518 @item -mrelax
18519 @opindex mrelax
18520 Guide linker to relax instructions.
18522 @end table
18524 @node Nios II Options
18525 @subsection Nios II Options
18526 @cindex Nios II options
18527 @cindex Altera Nios II options
18529 These are the options defined for the Altera Nios II processor.
18531 @table @gcctabopt
18533 @item -G @var{num}
18534 @opindex G
18535 @cindex smaller data references
18536 Put global and static objects less than or equal to @var{num} bytes
18537 into the small data or BSS sections instead of the normal data or BSS
18538 sections.  The default value of @var{num} is 8.
18540 @item -mgpopt
18541 @itemx -mno-gpopt
18542 @opindex mgpopt
18543 @opindex mno-gpopt
18544 Generate (do not generate) GP-relative accesses for objects in the
18545 small data or BSS sections.  The default is @option{-mgpopt} except
18546 when @option{-fpic} or @option{-fPIC} is specified to generate
18547 position-independent code.  Note that the Nios II ABI does not permit
18548 GP-relative accesses from shared libraries.
18550 You may need to specify @option{-mno-gpopt} explicitly when building
18551 programs that include large amounts of small data, including large
18552 GOT data sections.  In this case, the 16-bit offset for GP-relative
18553 addressing may not be large enough to allow access to the entire 
18554 small data section.
18556 @item -mel
18557 @itemx -meb
18558 @opindex mel
18559 @opindex meb
18560 Generate little-endian (default) or big-endian (experimental) code,
18561 respectively.
18563 @item -mbypass-cache
18564 @itemx -mno-bypass-cache
18565 @opindex mno-bypass-cache
18566 @opindex mbypass-cache
18567 Force all load and store instructions to always bypass cache by 
18568 using I/O variants of the instructions. The default is not to
18569 bypass the cache.
18571 @item -mno-cache-volatile 
18572 @itemx -mcache-volatile       
18573 @opindex mcache-volatile 
18574 @opindex mno-cache-volatile
18575 Volatile memory access bypass the cache using the I/O variants of 
18576 the load and store instructions. The default is not to bypass the cache.
18578 @item -mno-fast-sw-div
18579 @itemx -mfast-sw-div
18580 @opindex mno-fast-sw-div
18581 @opindex mfast-sw-div
18582 Do not use table-based fast divide for small numbers. The default 
18583 is to use the fast divide at @option{-O3} and above.
18585 @item -mno-hw-mul
18586 @itemx -mhw-mul
18587 @itemx -mno-hw-mulx
18588 @itemx -mhw-mulx
18589 @itemx -mno-hw-div
18590 @itemx -mhw-div
18591 @opindex mno-hw-mul
18592 @opindex mhw-mul
18593 @opindex mno-hw-mulx
18594 @opindex mhw-mulx
18595 @opindex mno-hw-div
18596 @opindex mhw-div
18597 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18598 instructions by the compiler. The default is to emit @code{mul}
18599 and not emit @code{div} and @code{mulx}.
18601 @item -mcustom-@var{insn}=@var{N}
18602 @itemx -mno-custom-@var{insn}
18603 @opindex mcustom-@var{insn}
18604 @opindex mno-custom-@var{insn}
18605 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18606 custom instruction with encoding @var{N} when generating code that uses 
18607 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
18608 instruction 253 for single-precision floating-point add operations instead
18609 of the default behavior of using a library call.
18611 The following values of @var{insn} are supported.  Except as otherwise
18612 noted, floating-point operations are expected to be implemented with
18613 normal IEEE 754 semantics and correspond directly to the C operators or the
18614 equivalent GCC built-in functions (@pxref{Other Builtins}).
18616 Single-precision floating point:
18617 @table @asis
18619 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18620 Binary arithmetic operations.
18622 @item @samp{fnegs}
18623 Unary negation.
18625 @item @samp{fabss}
18626 Unary absolute value.
18628 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18629 Comparison operations.
18631 @item @samp{fmins}, @samp{fmaxs}
18632 Floating-point minimum and maximum.  These instructions are only
18633 generated if @option{-ffinite-math-only} is specified.
18635 @item @samp{fsqrts}
18636 Unary square root operation.
18638 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18639 Floating-point trigonometric and exponential functions.  These instructions
18640 are only generated if @option{-funsafe-math-optimizations} is also specified.
18642 @end table
18644 Double-precision floating point:
18645 @table @asis
18647 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18648 Binary arithmetic operations.
18650 @item @samp{fnegd}
18651 Unary negation.
18653 @item @samp{fabsd}
18654 Unary absolute value.
18656 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18657 Comparison operations.
18659 @item @samp{fmind}, @samp{fmaxd}
18660 Double-precision minimum and maximum.  These instructions are only
18661 generated if @option{-ffinite-math-only} is specified.
18663 @item @samp{fsqrtd}
18664 Unary square root operation.
18666 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18667 Double-precision trigonometric and exponential functions.  These instructions
18668 are only generated if @option{-funsafe-math-optimizations} is also specified.
18670 @end table
18672 Conversions:
18673 @table @asis
18674 @item @samp{fextsd}
18675 Conversion from single precision to double precision.
18677 @item @samp{ftruncds}
18678 Conversion from double precision to single precision.
18680 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18681 Conversion from floating point to signed or unsigned integer types, with
18682 truncation towards zero.
18684 @item @samp{round}
18685 Conversion from single-precision floating point to signed integer,
18686 rounding to the nearest integer and ties away from zero.
18687 This corresponds to the @code{__builtin_lroundf} function when
18688 @option{-fno-math-errno} is used.
18690 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18691 Conversion from signed or unsigned integer types to floating-point types.
18693 @end table
18695 In addition, all of the following transfer instructions for internal
18696 registers X and Y must be provided to use any of the double-precision
18697 floating-point instructions.  Custom instructions taking two
18698 double-precision source operands expect the first operand in the
18699 64-bit register X.  The other operand (or only operand of a unary
18700 operation) is given to the custom arithmetic instruction with the
18701 least significant half in source register @var{src1} and the most
18702 significant half in @var{src2}.  A custom instruction that returns a
18703 double-precision result returns the most significant 32 bits in the
18704 destination register and the other half in 32-bit register Y.  
18705 GCC automatically generates the necessary code sequences to write
18706 register X and/or read register Y when double-precision floating-point
18707 instructions are used.
18709 @table @asis
18711 @item @samp{fwrx}
18712 Write @var{src1} into the least significant half of X and @var{src2} into
18713 the most significant half of X.
18715 @item @samp{fwry}
18716 Write @var{src1} into Y.
18718 @item @samp{frdxhi}, @samp{frdxlo}
18719 Read the most or least (respectively) significant half of X and store it in
18720 @var{dest}.
18722 @item @samp{frdy}
18723 Read the value of Y and store it into @var{dest}.
18724 @end table
18726 Note that you can gain more local control over generation of Nios II custom
18727 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18728 and @code{target("no-custom-@var{insn}")} function attributes
18729 (@pxref{Function Attributes})
18730 or pragmas (@pxref{Function Specific Option Pragmas}).
18732 @item -mcustom-fpu-cfg=@var{name}
18733 @opindex mcustom-fpu-cfg
18735 This option enables a predefined, named set of custom instruction encodings
18736 (see @option{-mcustom-@var{insn}} above).  
18737 Currently, the following sets are defined:
18739 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18740 @gccoptlist{-mcustom-fmuls=252 @gol
18741 -mcustom-fadds=253 @gol
18742 -mcustom-fsubs=254 @gol
18743 -fsingle-precision-constant}
18745 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18746 @gccoptlist{-mcustom-fmuls=252 @gol
18747 -mcustom-fadds=253 @gol
18748 -mcustom-fsubs=254 @gol
18749 -mcustom-fdivs=255 @gol
18750 -fsingle-precision-constant}
18752 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18753 @gccoptlist{-mcustom-floatus=243 @gol
18754 -mcustom-fixsi=244 @gol
18755 -mcustom-floatis=245 @gol
18756 -mcustom-fcmpgts=246 @gol
18757 -mcustom-fcmples=249 @gol
18758 -mcustom-fcmpeqs=250 @gol
18759 -mcustom-fcmpnes=251 @gol
18760 -mcustom-fmuls=252 @gol
18761 -mcustom-fadds=253 @gol
18762 -mcustom-fsubs=254 @gol
18763 -mcustom-fdivs=255 @gol
18764 -fsingle-precision-constant}
18766 Custom instruction assignments given by individual
18767 @option{-mcustom-@var{insn}=} options override those given by
18768 @option{-mcustom-fpu-cfg=}, regardless of the
18769 order of the options on the command line.
18771 Note that you can gain more local control over selection of a FPU
18772 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18773 function attribute (@pxref{Function Attributes})
18774 or pragma (@pxref{Function Specific Option Pragmas}).
18776 @end table
18778 These additional @samp{-m} options are available for the Altera Nios II
18779 ELF (bare-metal) target:
18781 @table @gcctabopt
18783 @item -mhal
18784 @opindex mhal
18785 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18786 startup and termination code, and is typically used in conjunction with
18787 @option{-msys-crt0=} to specify the location of the alternate startup code
18788 provided by the HAL BSP.
18790 @item -msmallc
18791 @opindex msmallc
18792 Link with a limited version of the C library, @option{-lsmallc}, rather than
18793 Newlib.
18795 @item -msys-crt0=@var{startfile}
18796 @opindex msys-crt0
18797 @var{startfile} is the file name of the startfile (crt0) to use 
18798 when linking.  This option is only useful in conjunction with @option{-mhal}.
18800 @item -msys-lib=@var{systemlib}
18801 @opindex msys-lib
18802 @var{systemlib} is the library name of the library that provides
18803 low-level system calls required by the C library,
18804 e.g. @code{read} and @code{write}.
18805 This option is typically used to link with a library provided by a HAL BSP.
18807 @end table
18809 @node PDP-11 Options
18810 @subsection PDP-11 Options
18811 @cindex PDP-11 Options
18813 These options are defined for the PDP-11:
18815 @table @gcctabopt
18816 @item -mfpu
18817 @opindex mfpu
18818 Use hardware FPP floating point.  This is the default.  (FIS floating
18819 point on the PDP-11/40 is not supported.)
18821 @item -msoft-float
18822 @opindex msoft-float
18823 Do not use hardware floating point.
18825 @item -mac0
18826 @opindex mac0
18827 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18829 @item -mno-ac0
18830 @opindex mno-ac0
18831 Return floating-point results in memory.  This is the default.
18833 @item -m40
18834 @opindex m40
18835 Generate code for a PDP-11/40.
18837 @item -m45
18838 @opindex m45
18839 Generate code for a PDP-11/45.  This is the default.
18841 @item -m10
18842 @opindex m10
18843 Generate code for a PDP-11/10.
18845 @item -mbcopy-builtin
18846 @opindex mbcopy-builtin
18847 Use inline @code{movmemhi} patterns for copying memory.  This is the
18848 default.
18850 @item -mbcopy
18851 @opindex mbcopy
18852 Do not use inline @code{movmemhi} patterns for copying memory.
18854 @item -mint16
18855 @itemx -mno-int32
18856 @opindex mint16
18857 @opindex mno-int32
18858 Use 16-bit @code{int}.  This is the default.
18860 @item -mint32
18861 @itemx -mno-int16
18862 @opindex mint32
18863 @opindex mno-int16
18864 Use 32-bit @code{int}.
18866 @item -mfloat64
18867 @itemx -mno-float32
18868 @opindex mfloat64
18869 @opindex mno-float32
18870 Use 64-bit @code{float}.  This is the default.
18872 @item -mfloat32
18873 @itemx -mno-float64
18874 @opindex mfloat32
18875 @opindex mno-float64
18876 Use 32-bit @code{float}.
18878 @item -mabshi
18879 @opindex mabshi
18880 Use @code{abshi2} pattern.  This is the default.
18882 @item -mno-abshi
18883 @opindex mno-abshi
18884 Do not use @code{abshi2} pattern.
18886 @item -mbranch-expensive
18887 @opindex mbranch-expensive
18888 Pretend that branches are expensive.  This is for experimenting with
18889 code generation only.
18891 @item -mbranch-cheap
18892 @opindex mbranch-cheap
18893 Do not pretend that branches are expensive.  This is the default.
18895 @item -munix-asm
18896 @opindex munix-asm
18897 Use Unix assembler syntax.  This is the default when configured for
18898 @samp{pdp11-*-bsd}.
18900 @item -mdec-asm
18901 @opindex mdec-asm
18902 Use DEC assembler syntax.  This is the default when configured for any
18903 PDP-11 target other than @samp{pdp11-*-bsd}.
18904 @end table
18906 @node picoChip Options
18907 @subsection picoChip Options
18908 @cindex picoChip options
18910 These @samp{-m} options are defined for picoChip implementations:
18912 @table @gcctabopt
18914 @item -mae=@var{ae_type}
18915 @opindex mcpu
18916 Set the instruction set, register set, and instruction scheduling
18917 parameters for array element type @var{ae_type}.  Supported values
18918 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18920 @option{-mae=ANY} selects a completely generic AE type.  Code
18921 generated with this option runs on any of the other AE types.  The
18922 code is not as efficient as it would be if compiled for a specific
18923 AE type, and some types of operation (e.g., multiplication) do not
18924 work properly on all types of AE.
18926 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18927 for compiled code, and is the default.
18929 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18930 option may suffer from poor performance of byte (char) manipulation,
18931 since the DSP AE does not provide hardware support for byte load/stores.
18933 @item -msymbol-as-address
18934 Enable the compiler to directly use a symbol name as an address in a
18935 load/store instruction, without first loading it into a
18936 register.  Typically, the use of this option generates larger
18937 programs, which run faster than when the option isn't used.  However, the
18938 results vary from program to program, so it is left as a user option,
18939 rather than being permanently enabled.
18941 @item -mno-inefficient-warnings
18942 Disables warnings about the generation of inefficient code.  These
18943 warnings can be generated, for example, when compiling code that
18944 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18945 no hardware support for byte-level memory operations, so all byte
18946 load/stores must be synthesized from word load/store operations.  This is
18947 inefficient and a warning is generated to indicate
18948 that you should rewrite the code to avoid byte operations, or to target
18949 an AE type that has the necessary hardware support.  This option disables
18950 these warnings.
18952 @end table
18954 @node PowerPC Options
18955 @subsection PowerPC Options
18956 @cindex PowerPC options
18958 These are listed under @xref{RS/6000 and PowerPC Options}.
18960 @node RL78 Options
18961 @subsection RL78 Options
18962 @cindex RL78 Options
18964 @table @gcctabopt
18966 @item -msim
18967 @opindex msim
18968 Links in additional target libraries to support operation within a
18969 simulator.
18971 @item -mmul=none
18972 @itemx -mmul=g13
18973 @itemx -mmul=rl78
18974 @opindex mmul
18975 Specifies the type of hardware multiplication support to be used.  The
18976 default is @code{none}, which uses software multiplication functions.
18977 The @code{g13} option is for the hardware multiply/divide peripheral
18978 only on the RL78/G13 targets.  The @code{rl78} option is for the
18979 standard hardware multiplication defined in the RL78 software manual.
18981 @item -m64bit-doubles
18982 @itemx -m32bit-doubles
18983 @opindex m64bit-doubles
18984 @opindex m32bit-doubles
18985 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18986 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18987 @option{-m32bit-doubles}.
18989 @end table
18991 @node RS/6000 and PowerPC Options
18992 @subsection IBM RS/6000 and PowerPC Options
18993 @cindex RS/6000 and PowerPC Options
18994 @cindex IBM RS/6000 and PowerPC Options
18996 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18997 @table @gcctabopt
18998 @item -mpowerpc-gpopt
18999 @itemx -mno-powerpc-gpopt
19000 @itemx -mpowerpc-gfxopt
19001 @itemx -mno-powerpc-gfxopt
19002 @need 800
19003 @itemx -mpowerpc64
19004 @itemx -mno-powerpc64
19005 @itemx -mmfcrf
19006 @itemx -mno-mfcrf
19007 @itemx -mpopcntb
19008 @itemx -mno-popcntb
19009 @itemx -mpopcntd
19010 @itemx -mno-popcntd
19011 @itemx -mfprnd
19012 @itemx -mno-fprnd
19013 @need 800
19014 @itemx -mcmpb
19015 @itemx -mno-cmpb
19016 @itemx -mmfpgpr
19017 @itemx -mno-mfpgpr
19018 @itemx -mhard-dfp
19019 @itemx -mno-hard-dfp
19020 @opindex mpowerpc-gpopt
19021 @opindex mno-powerpc-gpopt
19022 @opindex mpowerpc-gfxopt
19023 @opindex mno-powerpc-gfxopt
19024 @opindex mpowerpc64
19025 @opindex mno-powerpc64
19026 @opindex mmfcrf
19027 @opindex mno-mfcrf
19028 @opindex mpopcntb
19029 @opindex mno-popcntb
19030 @opindex mpopcntd
19031 @opindex mno-popcntd
19032 @opindex mfprnd
19033 @opindex mno-fprnd
19034 @opindex mcmpb
19035 @opindex mno-cmpb
19036 @opindex mmfpgpr
19037 @opindex mno-mfpgpr
19038 @opindex mhard-dfp
19039 @opindex mno-hard-dfp
19040 You use these options to specify which instructions are available on the
19041 processor you are using.  The default value of these options is
19042 determined when configuring GCC@.  Specifying the
19043 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19044 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19045 rather than the options listed above.
19047 Specifying @option{-mpowerpc-gpopt} allows
19048 GCC to use the optional PowerPC architecture instructions in the
19049 General Purpose group, including floating-point square root.  Specifying
19050 @option{-mpowerpc-gfxopt} allows GCC to
19051 use the optional PowerPC architecture instructions in the Graphics
19052 group, including floating-point select.
19054 The @option{-mmfcrf} option allows GCC to generate the move from
19055 condition register field instruction implemented on the POWER4
19056 processor and other processors that support the PowerPC V2.01
19057 architecture.
19058 The @option{-mpopcntb} option allows GCC to generate the popcount and
19059 double-precision FP reciprocal estimate instruction implemented on the
19060 POWER5 processor and other processors that support the PowerPC V2.02
19061 architecture.
19062 The @option{-mpopcntd} option allows GCC to generate the popcount
19063 instruction implemented on the POWER7 processor and other processors
19064 that support the PowerPC V2.06 architecture.
19065 The @option{-mfprnd} option allows GCC to generate the FP round to
19066 integer instructions implemented on the POWER5+ processor and other
19067 processors that support the PowerPC V2.03 architecture.
19068 The @option{-mcmpb} option allows GCC to generate the compare bytes
19069 instruction implemented on the POWER6 processor and other processors
19070 that support the PowerPC V2.05 architecture.
19071 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19072 general-purpose register instructions implemented on the POWER6X
19073 processor and other processors that support the extended PowerPC V2.05
19074 architecture.
19075 The @option{-mhard-dfp} option allows GCC to generate the decimal
19076 floating-point instructions implemented on some POWER processors.
19078 The @option{-mpowerpc64} option allows GCC to generate the additional
19079 64-bit instructions that are found in the full PowerPC64 architecture
19080 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19081 @option{-mno-powerpc64}.
19083 @item -mcpu=@var{cpu_type}
19084 @opindex mcpu
19085 Set architecture type, register usage, and
19086 instruction scheduling parameters for machine type @var{cpu_type}.
19087 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19088 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19089 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19090 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19091 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19092 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19093 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19094 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19095 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19096 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19097 @samp{powerpc64}, and @samp{rs64}.
19099 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19100 PowerPC and 64-bit PowerPC architecture machine
19101 types, with an appropriate, generic processor model assumed for
19102 scheduling purposes.
19104 The other options specify a specific processor.  Code generated under
19105 those options runs best on that processor, and may not run at all on
19106 others.
19108 The @option{-mcpu} options automatically enable or disable the
19109 following options:
19111 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19112 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19113 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19114 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19115 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19116 -mquad-memory -mquad-memory-atomic}
19118 The particular options set for any particular CPU varies between
19119 compiler versions, depending on what setting seems to produce optimal
19120 code for that CPU; it doesn't necessarily reflect the actual hardware's
19121 capabilities.  If you wish to set an individual option to a particular
19122 value, you may specify it after the @option{-mcpu} option, like
19123 @option{-mcpu=970 -mno-altivec}.
19125 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19126 not enabled or disabled by the @option{-mcpu} option at present because
19127 AIX does not have full support for these options.  You may still
19128 enable or disable them individually if you're sure it'll work in your
19129 environment.
19131 @item -mtune=@var{cpu_type}
19132 @opindex mtune
19133 Set the instruction scheduling parameters for machine type
19134 @var{cpu_type}, but do not set the architecture type or register usage,
19135 as @option{-mcpu=@var{cpu_type}} does.  The same
19136 values for @var{cpu_type} are used for @option{-mtune} as for
19137 @option{-mcpu}.  If both are specified, the code generated uses the
19138 architecture and registers set by @option{-mcpu}, but the
19139 scheduling parameters set by @option{-mtune}.
19141 @item -mcmodel=small
19142 @opindex mcmodel=small
19143 Generate PowerPC64 code for the small model: The TOC is limited to
19144 64k.
19146 @item -mcmodel=medium
19147 @opindex mcmodel=medium
19148 Generate PowerPC64 code for the medium model: The TOC and other static
19149 data may be up to a total of 4G in size.
19151 @item -mcmodel=large
19152 @opindex mcmodel=large
19153 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19154 in size.  Other data and code is only limited by the 64-bit address
19155 space.
19157 @item -maltivec
19158 @itemx -mno-altivec
19159 @opindex maltivec
19160 @opindex mno-altivec
19161 Generate code that uses (does not use) AltiVec instructions, and also
19162 enable the use of built-in functions that allow more direct access to
19163 the AltiVec instruction set.  You may also need to set
19164 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19165 enhancements.
19167 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19168 @option{-maltivec=be}, the element order for Altivec intrinsics such
19169 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19170 match array element order corresponding to the endianness of the
19171 target.  That is, element zero identifies the leftmost element in a
19172 vector register when targeting a big-endian platform, and identifies
19173 the rightmost element in a vector register when targeting a
19174 little-endian platform.
19176 @item -maltivec=be
19177 @opindex maltivec=be
19178 Generate Altivec instructions using big-endian element order,
19179 regardless of whether the target is big- or little-endian.  This is
19180 the default when targeting a big-endian platform.
19182 The element order is used to interpret element numbers in Altivec
19183 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19184 @code{vec_insert}.  By default, these will match array element order
19185 corresponding to the endianness for the target.
19187 @item -maltivec=le
19188 @opindex maltivec=le
19189 Generate Altivec instructions using little-endian element order,
19190 regardless of whether the target is big- or little-endian.  This is
19191 the default when targeting a little-endian platform.  This option is
19192 currently ignored when targeting a big-endian platform.
19194 The element order is used to interpret element numbers in Altivec
19195 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19196 @code{vec_insert}.  By default, these will match array element order
19197 corresponding to the endianness for the target.
19199 @item -mvrsave
19200 @itemx -mno-vrsave
19201 @opindex mvrsave
19202 @opindex mno-vrsave
19203 Generate VRSAVE instructions when generating AltiVec code.
19205 @item -mgen-cell-microcode
19206 @opindex mgen-cell-microcode
19207 Generate Cell microcode instructions.
19209 @item -mwarn-cell-microcode
19210 @opindex mwarn-cell-microcode
19211 Warn when a Cell microcode instruction is emitted.  An example
19212 of a Cell microcode instruction is a variable shift.
19214 @item -msecure-plt
19215 @opindex msecure-plt
19216 Generate code that allows @command{ld} and @command{ld.so}
19217 to build executables and shared
19218 libraries with non-executable @code{.plt} and @code{.got} sections.
19219 This is a PowerPC
19220 32-bit SYSV ABI option.
19222 @item -mbss-plt
19223 @opindex mbss-plt
19224 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19225 fills in, and
19226 requires @code{.plt} and @code{.got}
19227 sections that are both writable and executable.
19228 This is a PowerPC 32-bit SYSV ABI option.
19230 @item -misel
19231 @itemx -mno-isel
19232 @opindex misel
19233 @opindex mno-isel
19234 This switch enables or disables the generation of ISEL instructions.
19236 @item -misel=@var{yes/no}
19237 This switch has been deprecated.  Use @option{-misel} and
19238 @option{-mno-isel} instead.
19240 @item -mspe
19241 @itemx -mno-spe
19242 @opindex mspe
19243 @opindex mno-spe
19244 This switch enables or disables the generation of SPE simd
19245 instructions.
19247 @item -mpaired
19248 @itemx -mno-paired
19249 @opindex mpaired
19250 @opindex mno-paired
19251 This switch enables or disables the generation of PAIRED simd
19252 instructions.
19254 @item -mspe=@var{yes/no}
19255 This option has been deprecated.  Use @option{-mspe} and
19256 @option{-mno-spe} instead.
19258 @item -mvsx
19259 @itemx -mno-vsx
19260 @opindex mvsx
19261 @opindex mno-vsx
19262 Generate code that uses (does not use) vector/scalar (VSX)
19263 instructions, and also enable the use of built-in functions that allow
19264 more direct access to the VSX instruction set.
19266 @item -mcrypto
19267 @itemx -mno-crypto
19268 @opindex mcrypto
19269 @opindex mno-crypto
19270 Enable the use (disable) of the built-in functions that allow direct
19271 access to the cryptographic instructions that were added in version
19272 2.07 of the PowerPC ISA.
19274 @item -mdirect-move
19275 @itemx -mno-direct-move
19276 @opindex mdirect-move
19277 @opindex mno-direct-move
19278 Generate code that uses (does not use) the instructions to move data
19279 between the general purpose registers and the vector/scalar (VSX)
19280 registers that were added in version 2.07 of the PowerPC ISA.
19282 @item -mpower8-fusion
19283 @itemx -mno-power8-fusion
19284 @opindex mpower8-fusion
19285 @opindex mno-power8-fusion
19286 Generate code that keeps (does not keeps) some integer operations
19287 adjacent so that the instructions can be fused together on power8 and
19288 later processors.
19290 @item -mpower8-vector
19291 @itemx -mno-power8-vector
19292 @opindex mpower8-vector
19293 @opindex mno-power8-vector
19294 Generate code that uses (does not use) the vector and scalar
19295 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19296 enable the use of built-in functions that allow more direct access to
19297 the vector instructions.
19299 @item -mquad-memory
19300 @itemx -mno-quad-memory
19301 @opindex mquad-memory
19302 @opindex mno-quad-memory
19303 Generate code that uses (does not use) the non-atomic quad word memory
19304 instructions.  The @option{-mquad-memory} option requires use of
19305 64-bit mode.
19307 @item -mquad-memory-atomic
19308 @itemx -mno-quad-memory-atomic
19309 @opindex mquad-memory-atomic
19310 @opindex mno-quad-memory-atomic
19311 Generate code that uses (does not use) the atomic quad word memory
19312 instructions.  The @option{-mquad-memory-atomic} option requires use of
19313 64-bit mode.
19315 @item -mfloat-gprs=@var{yes/single/double/no}
19316 @itemx -mfloat-gprs
19317 @opindex mfloat-gprs
19318 This switch enables or disables the generation of floating-point
19319 operations on the general-purpose registers for architectures that
19320 support it.
19322 The argument @var{yes} or @var{single} enables the use of
19323 single-precision floating-point operations.
19325 The argument @var{double} enables the use of single and
19326 double-precision floating-point operations.
19328 The argument @var{no} disables floating-point operations on the
19329 general-purpose registers.
19331 This option is currently only available on the MPC854x.
19333 @item -m32
19334 @itemx -m64
19335 @opindex m32
19336 @opindex m64
19337 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19338 targets (including GNU/Linux).  The 32-bit environment sets int, long
19339 and pointer to 32 bits and generates code that runs on any PowerPC
19340 variant.  The 64-bit environment sets int to 32 bits and long and
19341 pointer to 64 bits, and generates code for PowerPC64, as for
19342 @option{-mpowerpc64}.
19344 @item -mfull-toc
19345 @itemx -mno-fp-in-toc
19346 @itemx -mno-sum-in-toc
19347 @itemx -mminimal-toc
19348 @opindex mfull-toc
19349 @opindex mno-fp-in-toc
19350 @opindex mno-sum-in-toc
19351 @opindex mminimal-toc
19352 Modify generation of the TOC (Table Of Contents), which is created for
19353 every executable file.  The @option{-mfull-toc} option is selected by
19354 default.  In that case, GCC allocates at least one TOC entry for
19355 each unique non-automatic variable reference in your program.  GCC
19356 also places floating-point constants in the TOC@.  However, only
19357 16,384 entries are available in the TOC@.
19359 If you receive a linker error message that saying you have overflowed
19360 the available TOC space, you can reduce the amount of TOC space used
19361 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19362 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19363 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19364 generate code to calculate the sum of an address and a constant at
19365 run time instead of putting that sum into the TOC@.  You may specify one
19366 or both of these options.  Each causes GCC to produce very slightly
19367 slower and larger code at the expense of conserving TOC space.
19369 If you still run out of space in the TOC even when you specify both of
19370 these options, specify @option{-mminimal-toc} instead.  This option causes
19371 GCC to make only one TOC entry for every file.  When you specify this
19372 option, GCC produces code that is slower and larger but which
19373 uses extremely little TOC space.  You may wish to use this option
19374 only on files that contain less frequently-executed code.
19376 @item -maix64
19377 @itemx -maix32
19378 @opindex maix64
19379 @opindex maix32
19380 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19381 @code{long} type, and the infrastructure needed to support them.
19382 Specifying @option{-maix64} implies @option{-mpowerpc64},
19383 while @option{-maix32} disables the 64-bit ABI and
19384 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19386 @item -mxl-compat
19387 @itemx -mno-xl-compat
19388 @opindex mxl-compat
19389 @opindex mno-xl-compat
19390 Produce code that conforms more closely to IBM XL compiler semantics
19391 when using AIX-compatible ABI@.  Pass floating-point arguments to
19392 prototyped functions beyond the register save area (RSA) on the stack
19393 in addition to argument FPRs.  Do not assume that most significant
19394 double in 128-bit long double value is properly rounded when comparing
19395 values and converting to double.  Use XL symbol names for long double
19396 support routines.
19398 The AIX calling convention was extended but not initially documented to
19399 handle an obscure K&R C case of calling a function that takes the
19400 address of its arguments with fewer arguments than declared.  IBM XL
19401 compilers access floating-point arguments that do not fit in the
19402 RSA from the stack when a subroutine is compiled without
19403 optimization.  Because always storing floating-point arguments on the
19404 stack is inefficient and rarely needed, this option is not enabled by
19405 default and only is necessary when calling subroutines compiled by IBM
19406 XL compilers without optimization.
19408 @item -mpe
19409 @opindex mpe
19410 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19411 application written to use message passing with special startup code to
19412 enable the application to run.  The system must have PE installed in the
19413 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19414 must be overridden with the @option{-specs=} option to specify the
19415 appropriate directory location.  The Parallel Environment does not
19416 support threads, so the @option{-mpe} option and the @option{-pthread}
19417 option are incompatible.
19419 @item -malign-natural
19420 @itemx -malign-power
19421 @opindex malign-natural
19422 @opindex malign-power
19423 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19424 @option{-malign-natural} overrides the ABI-defined alignment of larger
19425 types, such as floating-point doubles, on their natural size-based boundary.
19426 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19427 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19429 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19430 is not supported.
19432 @item -msoft-float
19433 @itemx -mhard-float
19434 @opindex msoft-float
19435 @opindex mhard-float
19436 Generate code that does not use (uses) the floating-point register set.
19437 Software floating-point emulation is provided if you use the
19438 @option{-msoft-float} option, and pass the option to GCC when linking.
19440 @item -msingle-float
19441 @itemx -mdouble-float
19442 @opindex msingle-float
19443 @opindex mdouble-float
19444 Generate code for single- or double-precision floating-point operations.
19445 @option{-mdouble-float} implies @option{-msingle-float}.
19447 @item -msimple-fpu
19448 @opindex msimple-fpu
19449 Do not generate @code{sqrt} and @code{div} instructions for hardware
19450 floating-point unit.
19452 @item -mfpu=@var{name}
19453 @opindex mfpu
19454 Specify type of floating-point unit.  Valid values for @var{name} are
19455 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19456 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19457 @samp{sp_full} (equivalent to @option{-msingle-float}),
19458 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19460 @item -mxilinx-fpu
19461 @opindex mxilinx-fpu
19462 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19464 @item -mmultiple
19465 @itemx -mno-multiple
19466 @opindex mmultiple
19467 @opindex mno-multiple
19468 Generate code that uses (does not use) the load multiple word
19469 instructions and the store multiple word instructions.  These
19470 instructions are generated by default on POWER systems, and not
19471 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19472 PowerPC systems, since those instructions do not work when the
19473 processor is in little-endian mode.  The exceptions are PPC740 and
19474 PPC750 which permit these instructions in little-endian mode.
19476 @item -mstring
19477 @itemx -mno-string
19478 @opindex mstring
19479 @opindex mno-string
19480 Generate code that uses (does not use) the load string instructions
19481 and the store string word instructions to save multiple registers and
19482 do small block moves.  These instructions are generated by default on
19483 POWER systems, and not generated on PowerPC systems.  Do not use
19484 @option{-mstring} on little-endian PowerPC systems, since those
19485 instructions do not work when the processor is in little-endian mode.
19486 The exceptions are PPC740 and PPC750 which permit these instructions
19487 in little-endian mode.
19489 @item -mupdate
19490 @itemx -mno-update
19491 @opindex mupdate
19492 @opindex mno-update
19493 Generate code that uses (does not use) the load or store instructions
19494 that update the base register to the address of the calculated memory
19495 location.  These instructions are generated by default.  If you use
19496 @option{-mno-update}, there is a small window between the time that the
19497 stack pointer is updated and the address of the previous frame is
19498 stored, which means code that walks the stack frame across interrupts or
19499 signals may get corrupted data.
19501 @item -mavoid-indexed-addresses
19502 @itemx -mno-avoid-indexed-addresses
19503 @opindex mavoid-indexed-addresses
19504 @opindex mno-avoid-indexed-addresses
19505 Generate code that tries to avoid (not avoid) the use of indexed load
19506 or store instructions. These instructions can incur a performance
19507 penalty on Power6 processors in certain situations, such as when
19508 stepping through large arrays that cross a 16M boundary.  This option
19509 is enabled by default when targeting Power6 and disabled otherwise.
19511 @item -mfused-madd
19512 @itemx -mno-fused-madd
19513 @opindex mfused-madd
19514 @opindex mno-fused-madd
19515 Generate code that uses (does not use) the floating-point multiply and
19516 accumulate instructions.  These instructions are generated by default
19517 if hardware floating point is used.  The machine-dependent
19518 @option{-mfused-madd} option is now mapped to the machine-independent
19519 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19520 mapped to @option{-ffp-contract=off}.
19522 @item -mmulhw
19523 @itemx -mno-mulhw
19524 @opindex mmulhw
19525 @opindex mno-mulhw
19526 Generate code that uses (does not use) the half-word multiply and
19527 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19528 These instructions are generated by default when targeting those
19529 processors.
19531 @item -mdlmzb
19532 @itemx -mno-dlmzb
19533 @opindex mdlmzb
19534 @opindex mno-dlmzb
19535 Generate code that uses (does not use) the string-search @samp{dlmzb}
19536 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19537 generated by default when targeting those processors.
19539 @item -mno-bit-align
19540 @itemx -mbit-align
19541 @opindex mno-bit-align
19542 @opindex mbit-align
19543 On System V.4 and embedded PowerPC systems do not (do) force structures
19544 and unions that contain bit-fields to be aligned to the base type of the
19545 bit-field.
19547 For example, by default a structure containing nothing but 8
19548 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19549 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19550 the structure is aligned to a 1-byte boundary and is 1 byte in
19551 size.
19553 @item -mno-strict-align
19554 @itemx -mstrict-align
19555 @opindex mno-strict-align
19556 @opindex mstrict-align
19557 On System V.4 and embedded PowerPC systems do not (do) assume that
19558 unaligned memory references are handled by the system.
19560 @item -mrelocatable
19561 @itemx -mno-relocatable
19562 @opindex mrelocatable
19563 @opindex mno-relocatable
19564 Generate code that allows (does not allow) a static executable to be
19565 relocated to a different address at run time.  A simple embedded
19566 PowerPC system loader should relocate the entire contents of
19567 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19568 a table of 32-bit addresses generated by this option.  For this to
19569 work, all objects linked together must be compiled with
19570 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19571 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19573 @item -mrelocatable-lib
19574 @itemx -mno-relocatable-lib
19575 @opindex mrelocatable-lib
19576 @opindex mno-relocatable-lib
19577 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19578 @code{.fixup} section to allow static executables to be relocated at
19579 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19580 alignment of @option{-mrelocatable}.  Objects compiled with
19581 @option{-mrelocatable-lib} may be linked with objects compiled with
19582 any combination of the @option{-mrelocatable} options.
19584 @item -mno-toc
19585 @itemx -mtoc
19586 @opindex mno-toc
19587 @opindex mtoc
19588 On System V.4 and embedded PowerPC systems do not (do) assume that
19589 register 2 contains a pointer to a global area pointing to the addresses
19590 used in the program.
19592 @item -mlittle
19593 @itemx -mlittle-endian
19594 @opindex mlittle
19595 @opindex mlittle-endian
19596 On System V.4 and embedded PowerPC systems compile code for the
19597 processor in little-endian mode.  The @option{-mlittle-endian} option is
19598 the same as @option{-mlittle}.
19600 @item -mbig
19601 @itemx -mbig-endian
19602 @opindex mbig
19603 @opindex mbig-endian
19604 On System V.4 and embedded PowerPC systems compile code for the
19605 processor in big-endian mode.  The @option{-mbig-endian} option is
19606 the same as @option{-mbig}.
19608 @item -mdynamic-no-pic
19609 @opindex mdynamic-no-pic
19610 On Darwin and Mac OS X systems, compile code so that it is not
19611 relocatable, but that its external references are relocatable.  The
19612 resulting code is suitable for applications, but not shared
19613 libraries.
19615 @item -msingle-pic-base
19616 @opindex msingle-pic-base
19617 Treat the register used for PIC addressing as read-only, rather than
19618 loading it in the prologue for each function.  The runtime system is
19619 responsible for initializing this register with an appropriate value
19620 before execution begins.
19622 @item -mprioritize-restricted-insns=@var{priority}
19623 @opindex mprioritize-restricted-insns
19624 This option controls the priority that is assigned to
19625 dispatch-slot restricted instructions during the second scheduling
19626 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19627 or @samp{2} to assign no, highest, or second-highest (respectively) 
19628 priority to dispatch-slot restricted
19629 instructions.
19631 @item -msched-costly-dep=@var{dependence_type}
19632 @opindex msched-costly-dep
19633 This option controls which dependences are considered costly
19634 by the target during instruction scheduling.  The argument
19635 @var{dependence_type} takes one of the following values:
19637 @table @asis
19638 @item @samp{no}
19639 No dependence is costly.
19641 @item @samp{all}
19642 All dependences are costly.
19644 @item @samp{true_store_to_load}
19645 A true dependence from store to load is costly.
19647 @item @samp{store_to_load}
19648 Any dependence from store to load is costly.
19650 @item @var{number}
19651 Any dependence for which the latency is greater than or equal to 
19652 @var{number} is costly.
19653 @end table
19655 @item -minsert-sched-nops=@var{scheme}
19656 @opindex minsert-sched-nops
19657 This option controls which NOP insertion scheme is used during
19658 the second scheduling pass.  The argument @var{scheme} takes one of the
19659 following values:
19661 @table @asis
19662 @item @samp{no}
19663 Don't insert NOPs.
19665 @item @samp{pad}
19666 Pad with NOPs any dispatch group that has vacant issue slots,
19667 according to the scheduler's grouping.
19669 @item @samp{regroup_exact}
19670 Insert NOPs to force costly dependent insns into
19671 separate groups.  Insert exactly as many NOPs as needed to force an insn
19672 to a new group, according to the estimated processor grouping.
19674 @item @var{number}
19675 Insert NOPs to force costly dependent insns into
19676 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19677 @end table
19679 @item -mcall-sysv
19680 @opindex mcall-sysv
19681 On System V.4 and embedded PowerPC systems compile code using calling
19682 conventions that adhere to the March 1995 draft of the System V
19683 Application Binary Interface, PowerPC processor supplement.  This is the
19684 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19686 @item -mcall-sysv-eabi
19687 @itemx -mcall-eabi
19688 @opindex mcall-sysv-eabi
19689 @opindex mcall-eabi
19690 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19692 @item -mcall-sysv-noeabi
19693 @opindex mcall-sysv-noeabi
19694 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19696 @item -mcall-aixdesc
19697 @opindex m
19698 On System V.4 and embedded PowerPC systems compile code for the AIX
19699 operating system.
19701 @item -mcall-linux
19702 @opindex mcall-linux
19703 On System V.4 and embedded PowerPC systems compile code for the
19704 Linux-based GNU system.
19706 @item -mcall-freebsd
19707 @opindex mcall-freebsd
19708 On System V.4 and embedded PowerPC systems compile code for the
19709 FreeBSD operating system.
19711 @item -mcall-netbsd
19712 @opindex mcall-netbsd
19713 On System V.4 and embedded PowerPC systems compile code for the
19714 NetBSD operating system.
19716 @item -mcall-openbsd
19717 @opindex mcall-netbsd
19718 On System V.4 and embedded PowerPC systems compile code for the
19719 OpenBSD operating system.
19721 @item -maix-struct-return
19722 @opindex maix-struct-return
19723 Return all structures in memory (as specified by the AIX ABI)@.
19725 @item -msvr4-struct-return
19726 @opindex msvr4-struct-return
19727 Return structures smaller than 8 bytes in registers (as specified by the
19728 SVR4 ABI)@.
19730 @item -mabi=@var{abi-type}
19731 @opindex mabi
19732 Extend the current ABI with a particular extension, or remove such extension.
19733 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
19734 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
19735 @var{elfv1}, @var{elfv2}@.
19737 @item -mabi=spe
19738 @opindex mabi=spe
19739 Extend the current ABI with SPE ABI extensions.  This does not change
19740 the default ABI, instead it adds the SPE ABI extensions to the current
19741 ABI@.
19743 @item -mabi=no-spe
19744 @opindex mabi=no-spe
19745 Disable Book-E SPE ABI extensions for the current ABI@.
19747 @item -mabi=ibmlongdouble
19748 @opindex mabi=ibmlongdouble
19749 Change the current ABI to use IBM extended-precision long double.
19750 This is a PowerPC 32-bit SYSV ABI option.
19752 @item -mabi=ieeelongdouble
19753 @opindex mabi=ieeelongdouble
19754 Change the current ABI to use IEEE extended-precision long double.
19755 This is a PowerPC 32-bit Linux ABI option.
19757 @item -mabi=elfv1
19758 @opindex mabi=elfv1
19759 Change the current ABI to use the ELFv1 ABI.
19760 This is the default ABI for big-endian PowerPC 64-bit Linux.
19761 Overriding the default ABI requires special system support and is
19762 likely to fail in spectacular ways.
19764 @item -mabi=elfv2
19765 @opindex mabi=elfv2
19766 Change the current ABI to use the ELFv2 ABI.
19767 This is the default ABI for little-endian PowerPC 64-bit Linux.
19768 Overriding the default ABI requires special system support and is
19769 likely to fail in spectacular ways.
19771 @item -mprototype
19772 @itemx -mno-prototype
19773 @opindex mprototype
19774 @opindex mno-prototype
19775 On System V.4 and embedded PowerPC systems assume that all calls to
19776 variable argument functions are properly prototyped.  Otherwise, the
19777 compiler must insert an instruction before every non-prototyped call to
19778 set or clear bit 6 of the condition code register (@var{CR}) to
19779 indicate whether floating-point values are passed in the floating-point
19780 registers in case the function takes variable arguments.  With
19781 @option{-mprototype}, only calls to prototyped variable argument functions
19782 set or clear the bit.
19784 @item -msim
19785 @opindex msim
19786 On embedded PowerPC systems, assume that the startup module is called
19787 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19788 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19789 configurations.
19791 @item -mmvme
19792 @opindex mmvme
19793 On embedded PowerPC systems, assume that the startup module is called
19794 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19795 @file{libc.a}.
19797 @item -mads
19798 @opindex mads
19799 On embedded PowerPC systems, assume that the startup module is called
19800 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19801 @file{libc.a}.
19803 @item -myellowknife
19804 @opindex myellowknife
19805 On embedded PowerPC systems, assume that the startup module is called
19806 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19807 @file{libc.a}.
19809 @item -mvxworks
19810 @opindex mvxworks
19811 On System V.4 and embedded PowerPC systems, specify that you are
19812 compiling for a VxWorks system.
19814 @item -memb
19815 @opindex memb
19816 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
19817 header to indicate that @samp{eabi} extended relocations are used.
19819 @item -meabi
19820 @itemx -mno-eabi
19821 @opindex meabi
19822 @opindex mno-eabi
19823 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19824 Embedded Applications Binary Interface (EABI), which is a set of
19825 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19826 means that the stack is aligned to an 8-byte boundary, a function
19827 @code{__eabi} is called from @code{main} to set up the EABI
19828 environment, and the @option{-msdata} option can use both @code{r2} and
19829 @code{r13} to point to two separate small data areas.  Selecting
19830 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19831 no EABI initialization function is called from @code{main}, and the
19832 @option{-msdata} option only uses @code{r13} to point to a single
19833 small data area.  The @option{-meabi} option is on by default if you
19834 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19836 @item -msdata=eabi
19837 @opindex msdata=eabi
19838 On System V.4 and embedded PowerPC systems, put small initialized
19839 @code{const} global and static data in the @samp{.sdata2} section, which
19840 is pointed to by register @code{r2}.  Put small initialized
19841 non-@code{const} global and static data in the @samp{.sdata} section,
19842 which is pointed to by register @code{r13}.  Put small uninitialized
19843 global and static data in the @samp{.sbss} section, which is adjacent to
19844 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
19845 incompatible with the @option{-mrelocatable} option.  The
19846 @option{-msdata=eabi} option also sets the @option{-memb} option.
19848 @item -msdata=sysv
19849 @opindex msdata=sysv
19850 On System V.4 and embedded PowerPC systems, put small global and static
19851 data in the @samp{.sdata} section, which is pointed to by register
19852 @code{r13}.  Put small uninitialized global and static data in the
19853 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
19854 The @option{-msdata=sysv} option is incompatible with the
19855 @option{-mrelocatable} option.
19857 @item -msdata=default
19858 @itemx -msdata
19859 @opindex msdata=default
19860 @opindex msdata
19861 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19862 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19863 same as @option{-msdata=sysv}.
19865 @item -msdata=data
19866 @opindex msdata=data
19867 On System V.4 and embedded PowerPC systems, put small global
19868 data in the @samp{.sdata} section.  Put small uninitialized global
19869 data in the @samp{.sbss} section.  Do not use register @code{r13}
19870 to address small data however.  This is the default behavior unless
19871 other @option{-msdata} options are used.
19873 @item -msdata=none
19874 @itemx -mno-sdata
19875 @opindex msdata=none
19876 @opindex mno-sdata
19877 On embedded PowerPC systems, put all initialized global and static data
19878 in the @samp{.data} section, and all uninitialized data in the
19879 @samp{.bss} section.
19881 @item -mblock-move-inline-limit=@var{num}
19882 @opindex mblock-move-inline-limit
19883 Inline all block moves (such as calls to @code{memcpy} or structure
19884 copies) less than or equal to @var{num} bytes.  The minimum value for
19885 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19886 targets.  The default value is target-specific.
19888 @item -G @var{num}
19889 @opindex G
19890 @cindex smaller data references (PowerPC)
19891 @cindex .sdata/.sdata2 references (PowerPC)
19892 On embedded PowerPC systems, put global and static items less than or
19893 equal to @var{num} bytes into the small data or BSS sections instead of
19894 the normal data or BSS section.  By default, @var{num} is 8.  The
19895 @option{-G @var{num}} switch is also passed to the linker.
19896 All modules should be compiled with the same @option{-G @var{num}} value.
19898 @item -mregnames
19899 @itemx -mno-regnames
19900 @opindex mregnames
19901 @opindex mno-regnames
19902 On System V.4 and embedded PowerPC systems do (do not) emit register
19903 names in the assembly language output using symbolic forms.
19905 @item -mlongcall
19906 @itemx -mno-longcall
19907 @opindex mlongcall
19908 @opindex mno-longcall
19909 By default assume that all calls are far away so that a longer and more
19910 expensive calling sequence is required.  This is required for calls
19911 farther than 32 megabytes (33,554,432 bytes) from the current location.
19912 A short call is generated if the compiler knows
19913 the call cannot be that far away.  This setting can be overridden by
19914 the @code{shortcall} function attribute, or by @code{#pragma
19915 longcall(0)}.
19917 Some linkers are capable of detecting out-of-range calls and generating
19918 glue code on the fly.  On these systems, long calls are unnecessary and
19919 generate slower code.  As of this writing, the AIX linker can do this,
19920 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19921 to the GNU linker for 32-bit PowerPC systems as well.
19923 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19924 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19925 addresses represent the callee and the branch island.  The
19926 Darwin/PPC linker prefers the first address and generates a @code{bl
19927 callee} if the PPC @code{bl} instruction reaches the callee directly;
19928 otherwise, the linker generates @code{bl L42} to call the branch
19929 island.  The branch island is appended to the body of the
19930 calling function; it computes the full 32-bit address of the callee
19931 and jumps to it.
19933 On Mach-O (Darwin) systems, this option directs the compiler emit to
19934 the glue for every direct call, and the Darwin linker decides whether
19935 to use or discard it.
19937 In the future, GCC may ignore all longcall specifications
19938 when the linker is known to generate glue.
19940 @item -mtls-markers
19941 @itemx -mno-tls-markers
19942 @opindex mtls-markers
19943 @opindex mno-tls-markers
19944 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19945 specifying the function argument.  The relocation allows the linker to
19946 reliably associate function call with argument setup instructions for
19947 TLS optimization, which in turn allows GCC to better schedule the
19948 sequence.
19950 @item -pthread
19951 @opindex pthread
19952 Adds support for multithreading with the @dfn{pthreads} library.
19953 This option sets flags for both the preprocessor and linker.
19955 @item -mrecip
19956 @itemx -mno-recip
19957 @opindex mrecip
19958 This option enables use of the reciprocal estimate and
19959 reciprocal square root estimate instructions with additional
19960 Newton-Raphson steps to increase precision instead of doing a divide or
19961 square root and divide for floating-point arguments.  You should use
19962 the @option{-ffast-math} option when using @option{-mrecip} (or at
19963 least @option{-funsafe-math-optimizations},
19964 @option{-finite-math-only}, @option{-freciprocal-math} and
19965 @option{-fno-trapping-math}).  Note that while the throughput of the
19966 sequence is generally higher than the throughput of the non-reciprocal
19967 instruction, the precision of the sequence can be decreased by up to 2
19968 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19969 roots.
19971 @item -mrecip=@var{opt}
19972 @opindex mrecip=opt
19973 This option controls which reciprocal estimate instructions
19974 may be used.  @var{opt} is a comma-separated list of options, which may
19975 be preceded by a @code{!} to invert the option:
19976 @code{all}: enable all estimate instructions,
19977 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
19978 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
19979 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
19980 @code{divf}: enable the single-precision reciprocal approximation instructions;
19981 @code{divd}: enable the double-precision reciprocal approximation instructions;
19982 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
19983 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
19984 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
19986 So, for example, @option{-mrecip=all,!rsqrtd} enables
19987 all of the reciprocal estimate instructions, except for the
19988 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
19989 which handle the double-precision reciprocal square root calculations.
19991 @item -mrecip-precision
19992 @itemx -mno-recip-precision
19993 @opindex mrecip-precision
19994 Assume (do not assume) that the reciprocal estimate instructions
19995 provide higher-precision estimates than is mandated by the PowerPC
19996 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
19997 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
19998 The double-precision square root estimate instructions are not generated by
19999 default on low-precision machines, since they do not provide an
20000 estimate that converges after three steps.
20002 @item -mveclibabi=@var{type}
20003 @opindex mveclibabi
20004 Specifies the ABI type to use for vectorizing intrinsics using an
20005 external library.  The only type supported at present is @code{mass},
20006 which specifies to use IBM's Mathematical Acceleration Subsystem
20007 (MASS) libraries for vectorizing intrinsics using external libraries.
20008 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20009 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20010 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20011 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20012 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20013 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20014 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20015 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20016 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20017 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20018 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20019 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20020 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20021 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20022 for power7.  Both @option{-ftree-vectorize} and
20023 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20024 libraries must be specified at link time.
20026 @item -mfriz
20027 @itemx -mno-friz
20028 @opindex mfriz
20029 Generate (do not generate) the @code{friz} instruction when the
20030 @option{-funsafe-math-optimizations} option is used to optimize
20031 rounding of floating-point values to 64-bit integer and back to floating
20032 point.  The @code{friz} instruction does not return the same value if
20033 the floating-point number is too large to fit in an integer.
20035 @item -mpointers-to-nested-functions
20036 @itemx -mno-pointers-to-nested-functions
20037 @opindex mpointers-to-nested-functions
20038 Generate (do not generate) code to load up the static chain register
20039 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20040 systems where a function pointer points to a 3-word descriptor giving
20041 the function address, TOC value to be loaded in register @var{r2}, and
20042 static chain value to be loaded in register @var{r11}.  The
20043 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20044 call through pointers to nested functions or pointers
20045 to functions compiled in other languages that use the static chain if
20046 you use the @option{-mno-pointers-to-nested-functions}.
20048 @item -msave-toc-indirect
20049 @itemx -mno-save-toc-indirect
20050 @opindex msave-toc-indirect
20051 Generate (do not generate) code to save the TOC value in the reserved
20052 stack location in the function prologue if the function calls through
20053 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20054 saved in the prologue, it is saved just before the call through the
20055 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20057 @item -mcompat-align-parm
20058 @itemx -mno-compat-align-parm
20059 @opindex mcompat-align-parm
20060 Generate (do not generate) code to pass structure parameters with a
20061 maximum alignment of 64 bits, for compatibility with older versions
20062 of GCC.
20064 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20065 structure parameter on a 128-bit boundary when that structure contained
20066 a member requiring 128-bit alignment.  This is corrected in more
20067 recent versions of GCC.  This option may be used to generate code
20068 that is compatible with functions compiled with older versions of
20069 GCC.
20071 The @option{-mno-compat-align-parm} option is the default.
20072 @end table
20074 @node RX Options
20075 @subsection RX Options
20076 @cindex RX Options
20078 These command-line options are defined for RX targets:
20080 @table @gcctabopt
20081 @item -m64bit-doubles
20082 @itemx -m32bit-doubles
20083 @opindex m64bit-doubles
20084 @opindex m32bit-doubles
20085 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20086 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20087 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20088 works on 32-bit values, which is why the default is
20089 @option{-m32bit-doubles}.
20091 @item -fpu
20092 @itemx -nofpu
20093 @opindex fpu
20094 @opindex nofpu
20095 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20096 floating-point hardware.  The default is enabled for the @var{RX600}
20097 series and disabled for the @var{RX200} series.
20099 Floating-point instructions are only generated for 32-bit floating-point 
20100 values, however, so the FPU hardware is not used for doubles if the
20101 @option{-m64bit-doubles} option is used.
20103 @emph{Note} If the @option{-fpu} option is enabled then
20104 @option{-funsafe-math-optimizations} is also enabled automatically.
20105 This is because the RX FPU instructions are themselves unsafe.
20107 @item -mcpu=@var{name}
20108 @opindex -mcpu
20109 Selects the type of RX CPU to be targeted.  Currently three types are
20110 supported, the generic @var{RX600} and @var{RX200} series hardware and
20111 the specific @var{RX610} CPU.  The default is @var{RX600}.
20113 The only difference between @var{RX600} and @var{RX610} is that the
20114 @var{RX610} does not support the @code{MVTIPL} instruction.
20116 The @var{RX200} series does not have a hardware floating-point unit
20117 and so @option{-nofpu} is enabled by default when this type is
20118 selected.
20120 @item -mbig-endian-data
20121 @itemx -mlittle-endian-data
20122 @opindex mbig-endian-data
20123 @opindex mlittle-endian-data
20124 Store data (but not code) in the big-endian format.  The default is
20125 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20126 format.
20128 @item -msmall-data-limit=@var{N}
20129 @opindex msmall-data-limit
20130 Specifies the maximum size in bytes of global and static variables
20131 which can be placed into the small data area.  Using the small data
20132 area can lead to smaller and faster code, but the size of area is
20133 limited and it is up to the programmer to ensure that the area does
20134 not overflow.  Also when the small data area is used one of the RX's
20135 registers (usually @code{r13}) is reserved for use pointing to this
20136 area, so it is no longer available for use by the compiler.  This
20137 could result in slower and/or larger code if variables are pushed onto
20138 the stack instead of being held in this register.
20140 Note, common variables (variables that have not been initialized) and
20141 constants are not placed into the small data area as they are assigned
20142 to other sections in the output executable.
20144 The default value is zero, which disables this feature.  Note, this
20145 feature is not enabled by default with higher optimization levels
20146 (@option{-O2} etc) because of the potentially detrimental effects of
20147 reserving a register.  It is up to the programmer to experiment and
20148 discover whether this feature is of benefit to their program.  See the
20149 description of the @option{-mpid} option for a description of how the
20150 actual register to hold the small data area pointer is chosen.
20152 @item -msim
20153 @itemx -mno-sim
20154 @opindex msim
20155 @opindex mno-sim
20156 Use the simulator runtime.  The default is to use the libgloss
20157 board-specific runtime.
20159 @item -mas100-syntax
20160 @itemx -mno-as100-syntax
20161 @opindex mas100-syntax
20162 @opindex mno-as100-syntax
20163 When generating assembler output use a syntax that is compatible with
20164 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20165 assembler, but it has some restrictions so it is not generated by default.
20167 @item -mmax-constant-size=@var{N}
20168 @opindex mmax-constant-size
20169 Specifies the maximum size, in bytes, of a constant that can be used as
20170 an operand in a RX instruction.  Although the RX instruction set does
20171 allow constants of up to 4 bytes in length to be used in instructions,
20172 a longer value equates to a longer instruction.  Thus in some
20173 circumstances it can be beneficial to restrict the size of constants
20174 that are used in instructions.  Constants that are too big are instead
20175 placed into a constant pool and referenced via register indirection.
20177 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20178 or 4 means that constants of any size are allowed.
20180 @item -mrelax
20181 @opindex mrelax
20182 Enable linker relaxation.  Linker relaxation is a process whereby the
20183 linker attempts to reduce the size of a program by finding shorter
20184 versions of various instructions.  Disabled by default.
20186 @item -mint-register=@var{N}
20187 @opindex mint-register
20188 Specify the number of registers to reserve for fast interrupt handler
20189 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20190 means that register @code{r13} is reserved for the exclusive use
20191 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20192 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20193 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20194 A value of 0, the default, does not reserve any registers.
20196 @item -msave-acc-in-interrupts
20197 @opindex msave-acc-in-interrupts
20198 Specifies that interrupt handler functions should preserve the
20199 accumulator register.  This is only necessary if normal code might use
20200 the accumulator register, for example because it performs 64-bit
20201 multiplications.  The default is to ignore the accumulator as this
20202 makes the interrupt handlers faster.
20204 @item -mpid
20205 @itemx -mno-pid
20206 @opindex mpid
20207 @opindex mno-pid
20208 Enables the generation of position independent data.  When enabled any
20209 access to constant data is done via an offset from a base address
20210 held in a register.  This allows the location of constant data to be
20211 determined at run time without requiring the executable to be
20212 relocated, which is a benefit to embedded applications with tight
20213 memory constraints.  Data that can be modified is not affected by this
20214 option.
20216 Note, using this feature reserves a register, usually @code{r13}, for
20217 the constant data base address.  This can result in slower and/or
20218 larger code, especially in complicated functions.
20220 The actual register chosen to hold the constant data base address
20221 depends upon whether the @option{-msmall-data-limit} and/or the
20222 @option{-mint-register} command-line options are enabled.  Starting
20223 with register @code{r13} and proceeding downwards, registers are
20224 allocated first to satisfy the requirements of @option{-mint-register},
20225 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20226 is possible for the small data area register to be @code{r8} if both
20227 @option{-mint-register=4} and @option{-mpid} are specified on the
20228 command line.
20230 By default this feature is not enabled.  The default can be restored
20231 via the @option{-mno-pid} command-line option.
20233 @item -mno-warn-multiple-fast-interrupts
20234 @itemx -mwarn-multiple-fast-interrupts
20235 @opindex mno-warn-multiple-fast-interrupts
20236 @opindex mwarn-multiple-fast-interrupts
20237 Prevents GCC from issuing a warning message if it finds more than one
20238 fast interrupt handler when it is compiling a file.  The default is to
20239 issue a warning for each extra fast interrupt handler found, as the RX
20240 only supports one such interrupt.
20242 @end table
20244 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20245 has special significance to the RX port when used with the
20246 @code{interrupt} function attribute.  This attribute indicates a
20247 function intended to process fast interrupts.  GCC ensures
20248 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20249 and/or @code{r13} and only provided that the normal use of the
20250 corresponding registers have been restricted via the
20251 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20252 options.
20254 @node S/390 and zSeries Options
20255 @subsection S/390 and zSeries Options
20256 @cindex S/390 and zSeries Options
20258 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20260 @table @gcctabopt
20261 @item -mhard-float
20262 @itemx -msoft-float
20263 @opindex mhard-float
20264 @opindex msoft-float
20265 Use (do not use) the hardware floating-point instructions and registers
20266 for floating-point operations.  When @option{-msoft-float} is specified,
20267 functions in @file{libgcc.a} are used to perform floating-point
20268 operations.  When @option{-mhard-float} is specified, the compiler
20269 generates IEEE floating-point instructions.  This is the default.
20271 @item -mhard-dfp
20272 @itemx -mno-hard-dfp
20273 @opindex mhard-dfp
20274 @opindex mno-hard-dfp
20275 Use (do not use) the hardware decimal-floating-point instructions for
20276 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20277 specified, functions in @file{libgcc.a} are used to perform
20278 decimal-floating-point operations.  When @option{-mhard-dfp} is
20279 specified, the compiler generates decimal-floating-point hardware
20280 instructions.  This is the default for @option{-march=z9-ec} or higher.
20282 @item -mlong-double-64
20283 @itemx -mlong-double-128
20284 @opindex mlong-double-64
20285 @opindex mlong-double-128
20286 These switches control the size of @code{long double} type. A size
20287 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20288 type. This is the default.
20290 @item -mbackchain
20291 @itemx -mno-backchain
20292 @opindex mbackchain
20293 @opindex mno-backchain
20294 Store (do not store) the address of the caller's frame as backchain pointer
20295 into the callee's stack frame.
20296 A backchain may be needed to allow debugging using tools that do not understand
20297 DWARF 2 call frame information.
20298 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20299 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20300 the backchain is placed into the topmost word of the 96/160 byte register
20301 save area.
20303 In general, code compiled with @option{-mbackchain} is call-compatible with
20304 code compiled with @option{-mmo-backchain}; however, use of the backchain
20305 for debugging purposes usually requires that the whole binary is built with
20306 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20307 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20308 to build a linux kernel use @option{-msoft-float}.
20310 The default is to not maintain the backchain.
20312 @item -mpacked-stack
20313 @itemx -mno-packed-stack
20314 @opindex mpacked-stack
20315 @opindex mno-packed-stack
20316 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20317 specified, the compiler uses the all fields of the 96/160 byte register save
20318 area only for their default purpose; unused fields still take up stack space.
20319 When @option{-mpacked-stack} is specified, register save slots are densely
20320 packed at the top of the register save area; unused space is reused for other
20321 purposes, allowing for more efficient use of the available stack space.
20322 However, when @option{-mbackchain} is also in effect, the topmost word of
20323 the save area is always used to store the backchain, and the return address
20324 register is always saved two words below the backchain.
20326 As long as the stack frame backchain is not used, code generated with
20327 @option{-mpacked-stack} is call-compatible with code generated with
20328 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20329 S/390 or zSeries generated code that uses the stack frame backchain at run
20330 time, not just for debugging purposes.  Such code is not call-compatible
20331 with code compiled with @option{-mpacked-stack}.  Also, note that the
20332 combination of @option{-mbackchain},
20333 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20334 to build a linux kernel use @option{-msoft-float}.
20336 The default is to not use the packed stack layout.
20338 @item -msmall-exec
20339 @itemx -mno-small-exec
20340 @opindex msmall-exec
20341 @opindex mno-small-exec
20342 Generate (or do not generate) code using the @code{bras} instruction
20343 to do subroutine calls.
20344 This only works reliably if the total executable size does not
20345 exceed 64k.  The default is to use the @code{basr} instruction instead,
20346 which does not have this limitation.
20348 @item -m64
20349 @itemx -m31
20350 @opindex m64
20351 @opindex m31
20352 When @option{-m31} is specified, generate code compliant to the
20353 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20354 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20355 particular to generate 64-bit instructions.  For the @samp{s390}
20356 targets, the default is @option{-m31}, while the @samp{s390x}
20357 targets default to @option{-m64}.
20359 @item -mzarch
20360 @itemx -mesa
20361 @opindex mzarch
20362 @opindex mesa
20363 When @option{-mzarch} is specified, generate code using the
20364 instructions available on z/Architecture.
20365 When @option{-mesa} is specified, generate code using the
20366 instructions available on ESA/390.  Note that @option{-mesa} is
20367 not possible with @option{-m64}.
20368 When generating code compliant to the GNU/Linux for S/390 ABI,
20369 the default is @option{-mesa}.  When generating code compliant
20370 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20372 @item -mmvcle
20373 @itemx -mno-mvcle
20374 @opindex mmvcle
20375 @opindex mno-mvcle
20376 Generate (or do not generate) code using the @code{mvcle} instruction
20377 to perform block moves.  When @option{-mno-mvcle} is specified,
20378 use a @code{mvc} loop instead.  This is the default unless optimizing for
20379 size.
20381 @item -mdebug
20382 @itemx -mno-debug
20383 @opindex mdebug
20384 @opindex mno-debug
20385 Print (or do not print) additional debug information when compiling.
20386 The default is to not print debug information.
20388 @item -march=@var{cpu-type}
20389 @opindex march
20390 Generate code that runs on @var{cpu-type}, which is the name of a system
20391 representing a certain processor type.  Possible values for
20392 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20393 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20394 When generating code using the instructions available on z/Architecture,
20395 the default is @option{-march=z900}.  Otherwise, the default is
20396 @option{-march=g5}.
20398 @item -mtune=@var{cpu-type}
20399 @opindex mtune
20400 Tune to @var{cpu-type} everything applicable about the generated code,
20401 except for the ABI and the set of available instructions.
20402 The list of @var{cpu-type} values is the same as for @option{-march}.
20403 The default is the value used for @option{-march}.
20405 @item -mtpf-trace
20406 @itemx -mno-tpf-trace
20407 @opindex mtpf-trace
20408 @opindex mno-tpf-trace
20409 Generate code that adds (does not add) in TPF OS specific branches to trace
20410 routines in the operating system.  This option is off by default, even
20411 when compiling for the TPF OS@.
20413 @item -mfused-madd
20414 @itemx -mno-fused-madd
20415 @opindex mfused-madd
20416 @opindex mno-fused-madd
20417 Generate code that uses (does not use) the floating-point multiply and
20418 accumulate instructions.  These instructions are generated by default if
20419 hardware floating point is used.
20421 @item -mwarn-framesize=@var{framesize}
20422 @opindex mwarn-framesize
20423 Emit a warning if the current function exceeds the given frame size.  Because
20424 this is a compile-time check it doesn't need to be a real problem when the program
20425 runs.  It is intended to identify functions that most probably cause
20426 a stack overflow.  It is useful to be used in an environment with limited stack
20427 size e.g.@: the linux kernel.
20429 @item -mwarn-dynamicstack
20430 @opindex mwarn-dynamicstack
20431 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20432 arrays.  This is generally a bad idea with a limited stack size.
20434 @item -mstack-guard=@var{stack-guard}
20435 @itemx -mstack-size=@var{stack-size}
20436 @opindex mstack-guard
20437 @opindex mstack-size
20438 If these options are provided the S/390 back end emits additional instructions in
20439 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20440 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20441 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20442 the frame size of the compiled function is chosen.
20443 These options are intended to be used to help debugging stack overflow problems.
20444 The additionally emitted code causes only little overhead and hence can also be
20445 used in production-like systems without greater performance degradation.  The given
20446 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20447 @var{stack-guard} without exceeding 64k.
20448 In order to be efficient the extra code makes the assumption that the stack starts
20449 at an address aligned to the value given by @var{stack-size}.
20450 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20452 @item -mhotpatch[=@var{halfwords}]
20453 @itemx -mno-hotpatch
20454 @opindex mhotpatch
20455 If the hotpatch option is enabled, a ``hot-patching'' function
20456 prologue is generated for all functions in the compilation unit.
20457 The funtion label is prepended with the given number of two-byte
20458 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
20459 instructions if no argument is present.  Functions with a
20460 hot-patching prologue are never inlined automatically, and a
20461 hot-patching prologue is never generated for functions functions
20462 that are explicitly inline.
20464 This option can be overridden for individual functions with the
20465 @code{hotpatch} attribute.
20466 @end table
20468 @node Score Options
20469 @subsection Score Options
20470 @cindex Score Options
20472 These options are defined for Score implementations:
20474 @table @gcctabopt
20475 @item -meb
20476 @opindex meb
20477 Compile code for big-endian mode.  This is the default.
20479 @item -mel
20480 @opindex mel
20481 Compile code for little-endian mode.
20483 @item -mnhwloop
20484 @opindex mnhwloop
20485 Disable generation of @code{bcnz} instructions.
20487 @item -muls
20488 @opindex muls
20489 Enable generation of unaligned load and store instructions.
20491 @item -mmac
20492 @opindex mmac
20493 Enable the use of multiply-accumulate instructions. Disabled by default.
20495 @item -mscore5
20496 @opindex mscore5
20497 Specify the SCORE5 as the target architecture.
20499 @item -mscore5u
20500 @opindex mscore5u
20501 Specify the SCORE5U of the target architecture.
20503 @item -mscore7
20504 @opindex mscore7
20505 Specify the SCORE7 as the target architecture. This is the default.
20507 @item -mscore7d
20508 @opindex mscore7d
20509 Specify the SCORE7D as the target architecture.
20510 @end table
20512 @node SH Options
20513 @subsection SH Options
20515 These @samp{-m} options are defined for the SH implementations:
20517 @table @gcctabopt
20518 @item -m1
20519 @opindex m1
20520 Generate code for the SH1.
20522 @item -m2
20523 @opindex m2
20524 Generate code for the SH2.
20526 @item -m2e
20527 Generate code for the SH2e.
20529 @item -m2a-nofpu
20530 @opindex m2a-nofpu
20531 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20532 that the floating-point unit is not used.
20534 @item -m2a-single-only
20535 @opindex m2a-single-only
20536 Generate code for the SH2a-FPU, in such a way that no double-precision
20537 floating-point operations are used.
20539 @item -m2a-single
20540 @opindex m2a-single
20541 Generate code for the SH2a-FPU assuming the floating-point unit is in
20542 single-precision mode by default.
20544 @item -m2a
20545 @opindex m2a
20546 Generate code for the SH2a-FPU assuming the floating-point unit is in
20547 double-precision mode by default.
20549 @item -m3
20550 @opindex m3
20551 Generate code for the SH3.
20553 @item -m3e
20554 @opindex m3e
20555 Generate code for the SH3e.
20557 @item -m4-nofpu
20558 @opindex m4-nofpu
20559 Generate code for the SH4 without a floating-point unit.
20561 @item -m4-single-only
20562 @opindex m4-single-only
20563 Generate code for the SH4 with a floating-point unit that only
20564 supports single-precision arithmetic.
20566 @item -m4-single
20567 @opindex m4-single
20568 Generate code for the SH4 assuming the floating-point unit is in
20569 single-precision mode by default.
20571 @item -m4
20572 @opindex m4
20573 Generate code for the SH4.
20575 @item -m4a-nofpu
20576 @opindex m4a-nofpu
20577 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20578 floating-point unit is not used.
20580 @item -m4a-single-only
20581 @opindex m4a-single-only
20582 Generate code for the SH4a, in such a way that no double-precision
20583 floating-point operations are used.
20585 @item -m4a-single
20586 @opindex m4a-single
20587 Generate code for the SH4a assuming the floating-point unit is in
20588 single-precision mode by default.
20590 @item -m4a
20591 @opindex m4a
20592 Generate code for the SH4a.
20594 @item -m4al
20595 @opindex m4al
20596 Same as @option{-m4a-nofpu}, except that it implicitly passes
20597 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20598 instructions at the moment.
20600 @item -mb
20601 @opindex mb
20602 Compile code for the processor in big-endian mode.
20604 @item -ml
20605 @opindex ml
20606 Compile code for the processor in little-endian mode.
20608 @item -mdalign
20609 @opindex mdalign
20610 Align doubles at 64-bit boundaries.  Note that this changes the calling
20611 conventions, and thus some functions from the standard C library do
20612 not work unless you recompile it first with @option{-mdalign}.
20614 @item -mrelax
20615 @opindex mrelax
20616 Shorten some address references at link time, when possible; uses the
20617 linker option @option{-relax}.
20619 @item -mbigtable
20620 @opindex mbigtable
20621 Use 32-bit offsets in @code{switch} tables.  The default is to use
20622 16-bit offsets.
20624 @item -mbitops
20625 @opindex mbitops
20626 Enable the use of bit manipulation instructions on SH2A.
20628 @item -mfmovd
20629 @opindex mfmovd
20630 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20631 alignment constraints.
20633 @item -mhitachi
20634 @opindex mhitachi
20635 Comply with the calling conventions defined by Renesas.
20637 @item -mrenesas
20638 @opindex mhitachi
20639 Comply with the calling conventions defined by Renesas.
20641 @item -mno-renesas
20642 @opindex mhitachi
20643 Comply with the calling conventions defined for GCC before the Renesas
20644 conventions were available.  This option is the default for all
20645 targets of the SH toolchain.
20647 @item -mnomacsave
20648 @opindex mnomacsave
20649 Mark the @code{MAC} register as call-clobbered, even if
20650 @option{-mhitachi} is given.
20652 @item -mieee
20653 @itemx -mno-ieee
20654 @opindex mieee
20655 @opindex mnoieee
20656 Control the IEEE compliance of floating-point comparisons, which affects the
20657 handling of cases where the result of a comparison is unordered.  By default
20658 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20659 enabled @option{-mno-ieee} is implicitly set, which results in faster
20660 floating-point greater-equal and less-equal comparisons.  The implcit settings
20661 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20663 @item -minline-ic_invalidate
20664 @opindex minline-ic_invalidate
20665 Inline code to invalidate instruction cache entries after setting up
20666 nested function trampolines.
20667 This option has no effect if @option{-musermode} is in effect and the selected
20668 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20669 instruction.
20670 If the selected code generation option does not allow the use of the @code{icbi}
20671 instruction, and @option{-musermode} is not in effect, the inlined code
20672 manipulates the instruction cache address array directly with an associative
20673 write.  This not only requires privileged mode at run time, but it also
20674 fails if the cache line had been mapped via the TLB and has become unmapped.
20676 @item -misize
20677 @opindex misize
20678 Dump instruction size and location in the assembly code.
20680 @item -mpadstruct
20681 @opindex mpadstruct
20682 This option is deprecated.  It pads structures to multiple of 4 bytes,
20683 which is incompatible with the SH ABI@.
20685 @item -matomic-model=@var{model}
20686 @opindex matomic-model=@var{model}
20687 Sets the model of atomic operations and additional parameters as a comma
20688 separated list.  For details on the atomic built-in functions see
20689 @ref{__atomic Builtins}.  The following models and parameters are supported:
20691 @table @samp
20693 @item none
20694 Disable compiler generated atomic sequences and emit library calls for atomic
20695 operations.  This is the default if the target is not @code{sh-*-linux*}.
20697 @item soft-gusa
20698 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20699 built-in functions.  The generated atomic sequences require additional support
20700 from the interrupt/exception handling code of the system and are only suitable
20701 for SH3* and SH4* single-core systems.  This option is enabled by default when
20702 the target is @code{sh-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20703 this option will also partially utilize the hardware atomic instructions
20704 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20705 @samp{strict} is specified.  
20707 @item soft-tcb
20708 Generate software atomic sequences that use a variable in the thread control
20709 block.  This is a variation of the gUSA sequences which can also be used on
20710 SH1* and SH2* targets.  The generated atomic sequences require additional
20711 support from the interrupt/exception handling code of the system and are only
20712 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20713 parameter has to be specified as well.
20715 @item soft-imask
20716 Generate software atomic sequences that temporarily disable interrupts by
20717 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20718 in privileged mode and is only suitable for single-core systems.  Additional
20719 support from the interrupt/exception handling code of the system is not
20720 required.  This model is enabled by default when the target is
20721 @code{sh-*-linux*} and SH1* or SH2*.
20723 @item hard-llcs
20724 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20725 instructions only.  This is only available on SH4A and is suitable for
20726 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20727 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20728 Code compiled with this option will also be compatible with other software
20729 atomic model interrupt/exception handling systems if executed on an SH4A
20730 system.  Additional support from the interrupt/exception handling code of the
20731 system is not required for this model.
20733 @item gbr-offset=
20734 This parameter specifies the offset in bytes of the variable in the thread
20735 control block structure that should be used by the generated atomic sequences
20736 when the @samp{soft-tcb} model has been selected.  For other models this
20737 parameter is ignored.  The specified value must be an integer multiple of four
20738 and in the range 0-1020.
20740 @item strict
20741 This parameter prevents mixed usage of multiple atomic models, even though they
20742 would be compatible, and will make the compiler generate atomic sequences of the
20743 specified model only.
20745 @end table
20747 @item -mtas
20748 @opindex mtas
20749 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20750 Notice that depending on the particular hardware and software configuration
20751 this can degrade overall performance due to the operand cache line flushes
20752 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20753 processors the @code{tas.b} instruction must be used with caution since it
20754 can result in data corruption for certain cache configurations.
20756 @item -mspace
20757 @opindex mspace
20758 Optimize for space instead of speed.  Implied by @option{-Os}.
20760 @item -mprefergot
20761 @opindex mprefergot
20762 When generating position-independent code, emit function calls using
20763 the Global Offset Table instead of the Procedure Linkage Table.
20765 @item -musermode
20766 @opindex musermode
20767 Don't generate privileged mode only code.  This option
20768 implies @option{-mno-inline-ic_invalidate}
20769 if the inlined code would not work in user mode.
20770 This is the default when the target is @code{sh-*-linux*}.
20772 @item -multcost=@var{number}
20773 @opindex multcost=@var{number}
20774 Set the cost to assume for a multiply insn.
20776 @item -mdiv=@var{strategy}
20777 @opindex mdiv=@var{strategy}
20778 Set the division strategy to be used for integer division operations.
20779 For SHmedia @var{strategy} can be one of: 
20781 @table @samp
20783 @item fp 
20784 Performs the operation in floating point.  This has a very high latency,
20785 but needs only a few instructions, so it might be a good choice if
20786 your code has enough easily-exploitable ILP to allow the compiler to
20787 schedule the floating-point instructions together with other instructions.
20788 Division by zero causes a floating-point exception.
20790 @item inv
20791 Uses integer operations to calculate the inverse of the divisor,
20792 and then multiplies the dividend with the inverse.  This strategy allows
20793 CSE and hoisting of the inverse calculation.  Division by zero calculates
20794 an unspecified result, but does not trap.
20796 @item inv:minlat
20797 A variant of @samp{inv} where, if no CSE or hoisting opportunities
20798 have been found, or if the entire operation has been hoisted to the same
20799 place, the last stages of the inverse calculation are intertwined with the
20800 final multiply to reduce the overall latency, at the expense of using a few
20801 more instructions, and thus offering fewer scheduling opportunities with
20802 other code.
20804 @item call
20805 Calls a library function that usually implements the @samp{inv:minlat}
20806 strategy.
20807 This gives high code density for @code{m5-*media-nofpu} compilations.
20809 @item call2
20810 Uses a different entry point of the same library function, where it
20811 assumes that a pointer to a lookup table has already been set up, which
20812 exposes the pointer load to CSE and code hoisting optimizations.
20814 @item inv:call
20815 @itemx inv:call2
20816 @itemx inv:fp
20817 Use the @samp{inv} algorithm for initial
20818 code generation, but if the code stays unoptimized, revert to the @samp{call},
20819 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
20820 potentially-trapping side effect of division by zero is carried by a
20821 separate instruction, so it is possible that all the integer instructions
20822 are hoisted out, but the marker for the side effect stays where it is.
20823 A recombination to floating-point operations or a call is not possible
20824 in that case.
20826 @item inv20u
20827 @itemx inv20l
20828 Variants of the @samp{inv:minlat} strategy.  In the case
20829 that the inverse calculation is not separated from the multiply, they speed
20830 up division where the dividend fits into 20 bits (plus sign where applicable)
20831 by inserting a test to skip a number of operations in this case; this test
20832 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
20833 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
20835 @end table
20837 For targets other than SHmedia @var{strategy} can be one of:
20839 @table @samp
20841 @item call-div1
20842 Calls a library function that uses the single-step division instruction
20843 @code{div1} to perform the operation.  Division by zero calculates an
20844 unspecified result and does not trap.  This is the default except for SH4,
20845 SH2A and SHcompact.
20847 @item call-fp
20848 Calls a library function that performs the operation in double precision
20849 floating point.  Division by zero causes a floating-point exception.  This is
20850 the default for SHcompact with FPU.  Specifying this for targets that do not
20851 have a double precision FPU will default to @code{call-div1}.
20853 @item call-table
20854 Calls a library function that uses a lookup table for small divisors and
20855 the @code{div1} instruction with case distinction for larger divisors.  Division
20856 by zero calculates an unspecified result and does not trap.  This is the default
20857 for SH4.  Specifying this for targets that do not have dynamic shift
20858 instructions will default to @code{call-div1}.
20860 @end table
20862 When a division strategy has not been specified the default strategy will be
20863 selected based on the current target.  For SH2A the default strategy is to
20864 use the @code{divs} and @code{divu} instructions instead of library function
20865 calls.
20867 @item -maccumulate-outgoing-args
20868 @opindex maccumulate-outgoing-args
20869 Reserve space once for outgoing arguments in the function prologue rather
20870 than around each call.  Generally beneficial for performance and size.  Also
20871 needed for unwinding to avoid changing the stack frame around conditional code.
20873 @item -mdivsi3_libfunc=@var{name}
20874 @opindex mdivsi3_libfunc=@var{name}
20875 Set the name of the library function used for 32-bit signed division to
20876 @var{name}.
20877 This only affects the name used in the @samp{call} and @samp{inv:call}
20878 division strategies, and the compiler still expects the same
20879 sets of input/output/clobbered registers as if this option were not present.
20881 @item -mfixed-range=@var{register-range}
20882 @opindex mfixed-range
20883 Generate code treating the given register range as fixed registers.
20884 A fixed register is one that the register allocator can not use.  This is
20885 useful when compiling kernel code.  A register range is specified as
20886 two registers separated by a dash.  Multiple register ranges can be
20887 specified separated by a comma.
20889 @item -mindexed-addressing
20890 @opindex mindexed-addressing
20891 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
20892 This is only safe if the hardware and/or OS implement 32-bit wrap-around
20893 semantics for the indexed addressing mode.  The architecture allows the
20894 implementation of processors with 64-bit MMU, which the OS could use to
20895 get 32-bit addressing, but since no current hardware implementation supports
20896 this or any other way to make the indexed addressing mode safe to use in
20897 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
20899 @item -mgettrcost=@var{number}
20900 @opindex mgettrcost=@var{number}
20901 Set the cost assumed for the @code{gettr} instruction to @var{number}.
20902 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
20904 @item -mpt-fixed
20905 @opindex mpt-fixed
20906 Assume @code{pt*} instructions won't trap.  This generally generates
20907 better-scheduled code, but is unsafe on current hardware.
20908 The current architecture
20909 definition says that @code{ptabs} and @code{ptrel} trap when the target 
20910 anded with 3 is 3.
20911 This has the unintentional effect of making it unsafe to schedule these
20912 instructions before a branch, or hoist them out of a loop.  For example,
20913 @code{__do_global_ctors}, a part of @file{libgcc}
20914 that runs constructors at program
20915 startup, calls functions in a list which is delimited by @minus{}1.  With the
20916 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
20917 That means that all the constructors run a bit more quickly, but when
20918 the loop comes to the end of the list, the program crashes because @code{ptabs}
20919 loads @minus{}1 into a target register.  
20921 Since this option is unsafe for any
20922 hardware implementing the current architecture specification, the default
20923 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
20924 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
20925 this deters register allocation from using target registers for storing
20926 ordinary integers.
20928 @item -minvalid-symbols
20929 @opindex minvalid-symbols
20930 Assume symbols might be invalid.  Ordinary function symbols generated by
20931 the compiler are always valid to load with
20932 @code{movi}/@code{shori}/@code{ptabs} or
20933 @code{movi}/@code{shori}/@code{ptrel},
20934 but with assembler and/or linker tricks it is possible
20935 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
20936 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
20937 It prevents cross-basic-block CSE, hoisting and most scheduling
20938 of symbol loads.  The default is @option{-mno-invalid-symbols}.
20940 @item -mbranch-cost=@var{num}
20941 @opindex mbranch-cost=@var{num}
20942 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
20943 make the compiler try to generate more branch-free code if possible.  
20944 If not specified the value is selected depending on the processor type that
20945 is being compiled for.
20947 @item -mzdcbranch
20948 @itemx -mno-zdcbranch
20949 @opindex mzdcbranch
20950 @opindex mno-zdcbranch
20951 Assume (do not assume) that zero displacement conditional branch instructions
20952 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
20953 compiler will try to prefer zero displacement branch code sequences.  This is
20954 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
20955 disabled by specifying @option{-mno-zdcbranch}.
20957 @item -mfused-madd
20958 @itemx -mno-fused-madd
20959 @opindex mfused-madd
20960 @opindex mno-fused-madd
20961 Generate code that uses (does not use) the floating-point multiply and
20962 accumulate instructions.  These instructions are generated by default
20963 if hardware floating point is used.  The machine-dependent
20964 @option{-mfused-madd} option is now mapped to the machine-independent
20965 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20966 mapped to @option{-ffp-contract=off}.
20968 @item -mfsca
20969 @itemx -mno-fsca
20970 @opindex mfsca
20971 @opindex mno-fsca
20972 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
20973 and cosine approximations.  The option @code{-mfsca} must be used in
20974 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
20975 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
20976 approximations even if @code{-funsafe-math-optimizations} is in effect.
20978 @item -mfsrra
20979 @itemx -mno-fsrra
20980 @opindex mfsrra
20981 @opindex mno-fsrra
20982 Allow or disallow the compiler to emit the @code{fsrra} instruction for
20983 reciprocal square root approximations.  The option @code{-mfsrra} must be used
20984 in combination with @code{-funsafe-math-optimizations} and
20985 @code{-ffinite-math-only}.  It is enabled by default when generating code for
20986 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
20987 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
20988 in effect.
20990 @item -mpretend-cmove
20991 @opindex mpretend-cmove
20992 Prefer zero-displacement conditional branches for conditional move instruction
20993 patterns.  This can result in faster code on the SH4 processor.
20995 @end table
20997 @node Solaris 2 Options
20998 @subsection Solaris 2 Options
20999 @cindex Solaris 2 options
21001 These @samp{-m} options are supported on Solaris 2:
21003 @table @gcctabopt
21004 @item -mclear-hwcap
21005 @opindex mclear-hwcap
21006 @option{-mclear-hwcap} tells the compiler to remove the hardware
21007 capabilities generated by the Solaris assembler.  This is only necessary
21008 when object files use ISA extensions not supported by the current
21009 machine, but check at runtime whether or not to use them.
21011 @item -mimpure-text
21012 @opindex mimpure-text
21013 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21014 the compiler to not pass @option{-z text} to the linker when linking a
21015 shared object.  Using this option, you can link position-dependent
21016 code into a shared object.
21018 @option{-mimpure-text} suppresses the ``relocations remain against
21019 allocatable but non-writable sections'' linker error message.
21020 However, the necessary relocations trigger copy-on-write, and the
21021 shared object is not actually shared across processes.  Instead of
21022 using @option{-mimpure-text}, you should compile all source code with
21023 @option{-fpic} or @option{-fPIC}.
21025 @end table
21027 These switches are supported in addition to the above on Solaris 2:
21029 @table @gcctabopt
21030 @item -pthreads
21031 @opindex pthreads
21032 Add support for multithreading using the POSIX threads library.  This
21033 option sets flags for both the preprocessor and linker.  This option does
21034 not affect the thread safety of object code produced  by the compiler or
21035 that of libraries supplied with it.
21037 @item -pthread
21038 @opindex pthread
21039 This is a synonym for @option{-pthreads}.
21040 @end table
21042 @node SPARC Options
21043 @subsection SPARC Options
21044 @cindex SPARC options
21046 These @samp{-m} options are supported on the SPARC:
21048 @table @gcctabopt
21049 @item -mno-app-regs
21050 @itemx -mapp-regs
21051 @opindex mno-app-regs
21052 @opindex mapp-regs
21053 Specify @option{-mapp-regs} to generate output using the global registers
21054 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21055 global register 1, each global register 2 through 4 is then treated as an
21056 allocable register that is clobbered by function calls.  This is the default.
21058 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21059 specify @option{-mno-app-regs}.  You should compile libraries and system
21060 software with this option.
21062 @item -mflat
21063 @itemx -mno-flat
21064 @opindex mflat
21065 @opindex mno-flat
21066 With @option{-mflat}, the compiler does not generate save/restore instructions
21067 and uses a ``flat'' or single register window model.  This model is compatible
21068 with the regular register window model.  The local registers and the input
21069 registers (0--5) are still treated as ``call-saved'' registers and are
21070 saved on the stack as needed.
21072 With @option{-mno-flat} (the default), the compiler generates save/restore
21073 instructions (except for leaf functions).  This is the normal operating mode.
21075 @item -mfpu
21076 @itemx -mhard-float
21077 @opindex mfpu
21078 @opindex mhard-float
21079 Generate output containing floating-point instructions.  This is the
21080 default.
21082 @item -mno-fpu
21083 @itemx -msoft-float
21084 @opindex mno-fpu
21085 @opindex msoft-float
21086 Generate output containing library calls for floating point.
21087 @strong{Warning:} the requisite libraries are not available for all SPARC
21088 targets.  Normally the facilities of the machine's usual C compiler are
21089 used, but this cannot be done directly in cross-compilation.  You must make
21090 your own arrangements to provide suitable library functions for
21091 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21092 @samp{sparclite-*-*} do provide software floating-point support.
21094 @option{-msoft-float} changes the calling convention in the output file;
21095 therefore, it is only useful if you compile @emph{all} of a program with
21096 this option.  In particular, you need to compile @file{libgcc.a}, the
21097 library that comes with GCC, with @option{-msoft-float} in order for
21098 this to work.
21100 @item -mhard-quad-float
21101 @opindex mhard-quad-float
21102 Generate output containing quad-word (long double) floating-point
21103 instructions.
21105 @item -msoft-quad-float
21106 @opindex msoft-quad-float
21107 Generate output containing library calls for quad-word (long double)
21108 floating-point instructions.  The functions called are those specified
21109 in the SPARC ABI@.  This is the default.
21111 As of this writing, there are no SPARC implementations that have hardware
21112 support for the quad-word floating-point instructions.  They all invoke
21113 a trap handler for one of these instructions, and then the trap handler
21114 emulates the effect of the instruction.  Because of the trap handler overhead,
21115 this is much slower than calling the ABI library routines.  Thus the
21116 @option{-msoft-quad-float} option is the default.
21118 @item -mno-unaligned-doubles
21119 @itemx -munaligned-doubles
21120 @opindex mno-unaligned-doubles
21121 @opindex munaligned-doubles
21122 Assume that doubles have 8-byte alignment.  This is the default.
21124 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21125 alignment only if they are contained in another type, or if they have an
21126 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21127 Specifying this option avoids some rare compatibility problems with code
21128 generated by other compilers.  It is not the default because it results
21129 in a performance loss, especially for floating-point code.
21131 @item -muser-mode
21132 @itemx -mno-user-mode
21133 @opindex muser-mode
21134 @opindex mno-user-mode
21135 Do not generate code that can only run in supervisor mode.  This is relevant
21136 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21137 default is @option{-mno-user-mode}.
21139 @item -mno-faster-structs
21140 @itemx -mfaster-structs
21141 @opindex mno-faster-structs
21142 @opindex mfaster-structs
21143 With @option{-mfaster-structs}, the compiler assumes that structures
21144 should have 8-byte alignment.  This enables the use of pairs of
21145 @code{ldd} and @code{std} instructions for copies in structure
21146 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21147 However, the use of this changed alignment directly violates the SPARC
21148 ABI@.  Thus, it's intended only for use on targets where the developer
21149 acknowledges that their resulting code is not directly in line with
21150 the rules of the ABI@.
21152 @item -mcpu=@var{cpu_type}
21153 @opindex mcpu
21154 Set the instruction set, register set, and instruction scheduling parameters
21155 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21156 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21157 @samp{leon}, @samp{leon3}, @samp{sparclite}, @samp{f930}, @samp{f934},
21158 @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21159 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21160 @samp{niagara3} and @samp{niagara4}.
21162 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21163 which selects the best architecture option for the host processor.
21164 @option{-mcpu=native} has no effect if GCC does not recognize
21165 the processor.
21167 Default instruction scheduling parameters are used for values that select
21168 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21169 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21171 Here is a list of each supported architecture and their supported
21172 implementations.
21174 @table @asis
21175 @item v7
21176 cypress
21178 @item v8
21179 supersparc, hypersparc, leon, leon3
21181 @item sparclite
21182 f930, f934, sparclite86x
21184 @item sparclet
21185 tsc701
21187 @item v9
21188 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21189 @end table
21191 By default (unless configured otherwise), GCC generates code for the V7
21192 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21193 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21194 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21195 SPARCStation 1, 2, IPX etc.
21197 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21198 architecture.  The only difference from V7 code is that the compiler emits
21199 the integer multiply and integer divide instructions which exist in SPARC-V8
21200 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21201 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21202 2000 series.
21204 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21205 the SPARC architecture.  This adds the integer multiply, integer divide step
21206 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21207 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21208 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21209 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21210 MB86934 chip, which is the more recent SPARClite with FPU@.
21212 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21213 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21214 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21215 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21216 optimizes it for the TEMIC SPARClet chip.
21218 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21219 architecture.  This adds 64-bit integer and floating-point move instructions,
21220 3 additional floating-point condition code registers and conditional move
21221 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21222 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21223 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21224 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21225 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21226 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21227 additionally optimizes it for Sun UltraSPARC T2 chips. With
21228 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21229 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21230 additionally optimizes it for Sun UltraSPARC T4 chips.
21232 @item -mtune=@var{cpu_type}
21233 @opindex mtune
21234 Set the instruction scheduling parameters for machine type
21235 @var{cpu_type}, but do not set the instruction set or register set that the
21236 option @option{-mcpu=@var{cpu_type}} does.
21238 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21239 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21240 that select a particular CPU implementation.  Those are @samp{cypress},
21241 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3}, @samp{f930},
21242 @samp{f934}, @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
21243 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3} and
21244 @samp{niagara4}.  With native Solaris and GNU/Linux toolchains, @samp{native}
21245 can also be used.
21247 @item -mv8plus
21248 @itemx -mno-v8plus
21249 @opindex mv8plus
21250 @opindex mno-v8plus
21251 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21252 difference from the V8 ABI is that the global and out registers are
21253 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21254 mode for all SPARC-V9 processors.
21256 @item -mvis
21257 @itemx -mno-vis
21258 @opindex mvis
21259 @opindex mno-vis
21260 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21261 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21263 @item -mvis2
21264 @itemx -mno-vis2
21265 @opindex mvis2
21266 @opindex mno-vis2
21267 With @option{-mvis2}, GCC generates code that takes advantage of
21268 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21269 default is @option{-mvis2} when targeting a cpu that supports such
21270 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21271 also sets @option{-mvis}.
21273 @item -mvis3
21274 @itemx -mno-vis3
21275 @opindex mvis3
21276 @opindex mno-vis3
21277 With @option{-mvis3}, GCC generates code that takes advantage of
21278 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21279 default is @option{-mvis3} when targeting a cpu that supports such
21280 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21281 also sets @option{-mvis2} and @option{-mvis}.
21283 @item -mcbcond
21284 @itemx -mno-cbcond
21285 @opindex mcbcond
21286 @opindex mno-cbcond
21287 With @option{-mcbcond}, GCC generates code that takes advantage of
21288 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21289 The default is @option{-mcbcond} when targeting a cpu that supports such
21290 instructions, such as niagara-4 and later.
21292 @item -mpopc
21293 @itemx -mno-popc
21294 @opindex mpopc
21295 @opindex mno-popc
21296 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21297 population count instruction.  The default is @option{-mpopc}
21298 when targeting a cpu that supports such instructions, such as Niagara-2 and
21299 later.
21301 @item -mfmaf
21302 @itemx -mno-fmaf
21303 @opindex mfmaf
21304 @opindex mno-fmaf
21305 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21306 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21307 when targeting a cpu that supports such instructions, such as Niagara-3 and
21308 later.
21310 @item -mfix-at697f
21311 @opindex mfix-at697f
21312 Enable the documented workaround for the single erratum of the Atmel AT697F
21313 processor (which corresponds to erratum #13 of the AT697E processor).
21315 @item -mfix-ut699
21316 @opindex mfix-ut699
21317 Enable the documented workarounds for the floating-point errata and the data
21318 cache nullify errata of the UT699 processor.
21319 @end table
21321 These @samp{-m} options are supported in addition to the above
21322 on SPARC-V9 processors in 64-bit environments:
21324 @table @gcctabopt
21325 @item -m32
21326 @itemx -m64
21327 @opindex m32
21328 @opindex m64
21329 Generate code for a 32-bit or 64-bit environment.
21330 The 32-bit environment sets int, long and pointer to 32 bits.
21331 The 64-bit environment sets int to 32 bits and long and pointer
21332 to 64 bits.
21334 @item -mcmodel=@var{which}
21335 @opindex mcmodel
21336 Set the code model to one of
21338 @table @samp
21339 @item medlow
21340 The Medium/Low code model: 64-bit addresses, programs
21341 must be linked in the low 32 bits of memory.  Programs can be statically
21342 or dynamically linked.
21344 @item medmid
21345 The Medium/Middle code model: 64-bit addresses, programs
21346 must be linked in the low 44 bits of memory, the text and data segments must
21347 be less than 2GB in size and the data segment must be located within 2GB of
21348 the text segment.
21350 @item medany
21351 The Medium/Anywhere code model: 64-bit addresses, programs
21352 may be linked anywhere in memory, the text and data segments must be less
21353 than 2GB in size and the data segment must be located within 2GB of the
21354 text segment.
21356 @item embmedany
21357 The Medium/Anywhere code model for embedded systems:
21358 64-bit addresses, the text and data segments must be less than 2GB in
21359 size, both starting anywhere in memory (determined at link time).  The
21360 global register %g4 points to the base of the data segment.  Programs
21361 are statically linked and PIC is not supported.
21362 @end table
21364 @item -mmemory-model=@var{mem-model}
21365 @opindex mmemory-model
21366 Set the memory model in force on the processor to one of
21368 @table @samp
21369 @item default
21370 The default memory model for the processor and operating system.
21372 @item rmo
21373 Relaxed Memory Order
21375 @item pso
21376 Partial Store Order
21378 @item tso
21379 Total Store Order
21381 @item sc
21382 Sequential Consistency
21383 @end table
21385 These memory models are formally defined in Appendix D of the Sparc V9
21386 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21388 @item -mstack-bias
21389 @itemx -mno-stack-bias
21390 @opindex mstack-bias
21391 @opindex mno-stack-bias
21392 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21393 frame pointer if present, are offset by @minus{}2047 which must be added back
21394 when making stack frame references.  This is the default in 64-bit mode.
21395 Otherwise, assume no such offset is present.
21396 @end table
21398 @node SPU Options
21399 @subsection SPU Options
21400 @cindex SPU options
21402 These @samp{-m} options are supported on the SPU:
21404 @table @gcctabopt
21405 @item -mwarn-reloc
21406 @itemx -merror-reloc
21407 @opindex mwarn-reloc
21408 @opindex merror-reloc
21410 The loader for SPU does not handle dynamic relocations.  By default, GCC
21411 gives an error when it generates code that requires a dynamic
21412 relocation.  @option{-mno-error-reloc} disables the error,
21413 @option{-mwarn-reloc} generates a warning instead.
21415 @item -msafe-dma
21416 @itemx -munsafe-dma
21417 @opindex msafe-dma
21418 @opindex munsafe-dma
21420 Instructions that initiate or test completion of DMA must not be
21421 reordered with respect to loads and stores of the memory that is being
21422 accessed.
21423 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21424 memory accesses, but that can lead to inefficient code in places where the
21425 memory is known to not change.  Rather than mark the memory as volatile,
21426 you can use @option{-msafe-dma} to tell the compiler to treat
21427 the DMA instructions as potentially affecting all memory.  
21429 @item -mbranch-hints
21430 @opindex mbranch-hints
21432 By default, GCC generates a branch hint instruction to avoid
21433 pipeline stalls for always-taken or probably-taken branches.  A hint
21434 is not generated closer than 8 instructions away from its branch.
21435 There is little reason to disable them, except for debugging purposes,
21436 or to make an object a little bit smaller.
21438 @item -msmall-mem
21439 @itemx -mlarge-mem
21440 @opindex msmall-mem
21441 @opindex mlarge-mem
21443 By default, GCC generates code assuming that addresses are never larger
21444 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21445 a full 32-bit address.
21447 @item -mstdmain
21448 @opindex mstdmain
21450 By default, GCC links against startup code that assumes the SPU-style
21451 main function interface (which has an unconventional parameter list).
21452 With @option{-mstdmain}, GCC links your program against startup
21453 code that assumes a C99-style interface to @code{main}, including a
21454 local copy of @code{argv} strings.
21456 @item -mfixed-range=@var{register-range}
21457 @opindex mfixed-range
21458 Generate code treating the given register range as fixed registers.
21459 A fixed register is one that the register allocator cannot use.  This is
21460 useful when compiling kernel code.  A register range is specified as
21461 two registers separated by a dash.  Multiple register ranges can be
21462 specified separated by a comma.
21464 @item -mea32
21465 @itemx -mea64
21466 @opindex mea32
21467 @opindex mea64
21468 Compile code assuming that pointers to the PPU address space accessed
21469 via the @code{__ea} named address space qualifier are either 32 or 64
21470 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21471 all object code in an executable must be compiled with the same setting.
21473 @item -maddress-space-conversion
21474 @itemx -mno-address-space-conversion
21475 @opindex maddress-space-conversion
21476 @opindex mno-address-space-conversion
21477 Allow/disallow treating the @code{__ea} address space as superset
21478 of the generic address space.  This enables explicit type casts
21479 between @code{__ea} and generic pointer as well as implicit
21480 conversions of generic pointers to @code{__ea} pointers.  The
21481 default is to allow address space pointer conversions.
21483 @item -mcache-size=@var{cache-size}
21484 @opindex mcache-size
21485 This option controls the version of libgcc that the compiler links to an
21486 executable and selects a software-managed cache for accessing variables
21487 in the @code{__ea} address space with a particular cache size.  Possible
21488 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21489 and @samp{128}.  The default cache size is 64KB.
21491 @item -matomic-updates
21492 @itemx -mno-atomic-updates
21493 @opindex matomic-updates
21494 @opindex mno-atomic-updates
21495 This option controls the version of libgcc that the compiler links to an
21496 executable and selects whether atomic updates to the software-managed
21497 cache of PPU-side variables are used.  If you use atomic updates, changes
21498 to a PPU variable from SPU code using the @code{__ea} named address space
21499 qualifier do not interfere with changes to other PPU variables residing
21500 in the same cache line from PPU code.  If you do not use atomic updates,
21501 such interference may occur; however, writing back cache lines is
21502 more efficient.  The default behavior is to use atomic updates.
21504 @item -mdual-nops
21505 @itemx -mdual-nops=@var{n}
21506 @opindex mdual-nops
21507 By default, GCC inserts nops to increase dual issue when it expects
21508 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21509 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21510 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21512 @item -mhint-max-nops=@var{n}
21513 @opindex mhint-max-nops
21514 Maximum number of nops to insert for a branch hint.  A branch hint must
21515 be at least 8 instructions away from the branch it is affecting.  GCC
21516 inserts up to @var{n} nops to enforce this, otherwise it does not
21517 generate the branch hint.
21519 @item -mhint-max-distance=@var{n}
21520 @opindex mhint-max-distance
21521 The encoding of the branch hint instruction limits the hint to be within
21522 256 instructions of the branch it is affecting.  By default, GCC makes
21523 sure it is within 125.
21525 @item -msafe-hints
21526 @opindex msafe-hints
21527 Work around a hardware bug that causes the SPU to stall indefinitely.
21528 By default, GCC inserts the @code{hbrp} instruction to make sure
21529 this stall won't happen.
21531 @end table
21533 @node System V Options
21534 @subsection Options for System V
21536 These additional options are available on System V Release 4 for
21537 compatibility with other compilers on those systems:
21539 @table @gcctabopt
21540 @item -G
21541 @opindex G
21542 Create a shared object.
21543 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21545 @item -Qy
21546 @opindex Qy
21547 Identify the versions of each tool used by the compiler, in a
21548 @code{.ident} assembler directive in the output.
21550 @item -Qn
21551 @opindex Qn
21552 Refrain from adding @code{.ident} directives to the output file (this is
21553 the default).
21555 @item -YP,@var{dirs}
21556 @opindex YP
21557 Search the directories @var{dirs}, and no others, for libraries
21558 specified with @option{-l}.
21560 @item -Ym,@var{dir}
21561 @opindex Ym
21562 Look in the directory @var{dir} to find the M4 preprocessor.
21563 The assembler uses this option.
21564 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21565 @c the generic assembler that comes with Solaris takes just -Ym.
21566 @end table
21568 @node TILE-Gx Options
21569 @subsection TILE-Gx Options
21570 @cindex TILE-Gx options
21572 These @samp{-m} options are supported on the TILE-Gx:
21574 @table @gcctabopt
21575 @item -mcmodel=small
21576 @opindex mcmodel=small
21577 Generate code for the small model.  The distance for direct calls is
21578 limited to 500M in either direction.  PC-relative addresses are 32
21579 bits.  Absolute addresses support the full address range.
21581 @item -mcmodel=large
21582 @opindex mcmodel=large
21583 Generate code for the large model.  There is no limitation on call
21584 distance, pc-relative addresses, or absolute addresses.
21586 @item -mcpu=@var{name}
21587 @opindex mcpu
21588 Selects the type of CPU to be targeted.  Currently the only supported
21589 type is @samp{tilegx}.
21591 @item -m32
21592 @itemx -m64
21593 @opindex m32
21594 @opindex m64
21595 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21596 environment sets int, long, and pointer to 32 bits.  The 64-bit
21597 environment sets int to 32 bits and long and pointer to 64 bits.
21599 @item -mbig-endian
21600 @itemx -mlittle-endian
21601 @opindex mbig-endian
21602 @opindex mlittle-endian
21603 Generate code in big/little endian mode, respectively.
21604 @end table
21606 @node TILEPro Options
21607 @subsection TILEPro Options
21608 @cindex TILEPro options
21610 These @samp{-m} options are supported on the TILEPro:
21612 @table @gcctabopt
21613 @item -mcpu=@var{name}
21614 @opindex mcpu
21615 Selects the type of CPU to be targeted.  Currently the only supported
21616 type is @samp{tilepro}.
21618 @item -m32
21619 @opindex m32
21620 Generate code for a 32-bit environment, which sets int, long, and
21621 pointer to 32 bits.  This is the only supported behavior so the flag
21622 is essentially ignored.
21623 @end table
21625 @node V850 Options
21626 @subsection V850 Options
21627 @cindex V850 Options
21629 These @samp{-m} options are defined for V850 implementations:
21631 @table @gcctabopt
21632 @item -mlong-calls
21633 @itemx -mno-long-calls
21634 @opindex mlong-calls
21635 @opindex mno-long-calls
21636 Treat all calls as being far away (near).  If calls are assumed to be
21637 far away, the compiler always loads the function's address into a
21638 register, and calls indirect through the pointer.
21640 @item -mno-ep
21641 @itemx -mep
21642 @opindex mno-ep
21643 @opindex mep
21644 Do not optimize (do optimize) basic blocks that use the same index
21645 pointer 4 or more times to copy pointer into the @code{ep} register, and
21646 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21647 option is on by default if you optimize.
21649 @item -mno-prolog-function
21650 @itemx -mprolog-function
21651 @opindex mno-prolog-function
21652 @opindex mprolog-function
21653 Do not use (do use) external functions to save and restore registers
21654 at the prologue and epilogue of a function.  The external functions
21655 are slower, but use less code space if more than one function saves
21656 the same number of registers.  The @option{-mprolog-function} option
21657 is on by default if you optimize.
21659 @item -mspace
21660 @opindex mspace
21661 Try to make the code as small as possible.  At present, this just turns
21662 on the @option{-mep} and @option{-mprolog-function} options.
21664 @item -mtda=@var{n}
21665 @opindex mtda
21666 Put static or global variables whose size is @var{n} bytes or less into
21667 the tiny data area that register @code{ep} points to.  The tiny data
21668 area can hold up to 256 bytes in total (128 bytes for byte references).
21670 @item -msda=@var{n}
21671 @opindex msda
21672 Put static or global variables whose size is @var{n} bytes or less into
21673 the small data area that register @code{gp} points to.  The small data
21674 area can hold up to 64 kilobytes.
21676 @item -mzda=@var{n}
21677 @opindex mzda
21678 Put static or global variables whose size is @var{n} bytes or less into
21679 the first 32 kilobytes of memory.
21681 @item -mv850
21682 @opindex mv850
21683 Specify that the target processor is the V850.
21685 @item -mv850e3v5
21686 @opindex mv850e3v5
21687 Specify that the target processor is the V850E3V5.  The preprocessor
21688 constant @samp{__v850e3v5__} is defined if this option is used.
21690 @item -mv850e2v4
21691 @opindex mv850e2v4
21692 Specify that the target processor is the V850E3V5.  This is an alias for
21693 the @option{-mv850e3v5} option.
21695 @item -mv850e2v3
21696 @opindex mv850e2v3
21697 Specify that the target processor is the V850E2V3.  The preprocessor
21698 constant @samp{__v850e2v3__} is defined if this option is used.
21700 @item -mv850e2
21701 @opindex mv850e2
21702 Specify that the target processor is the V850E2.  The preprocessor
21703 constant @samp{__v850e2__} is defined if this option is used.
21705 @item -mv850e1
21706 @opindex mv850e1
21707 Specify that the target processor is the V850E1.  The preprocessor
21708 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
21709 this option is used.
21711 @item -mv850es
21712 @opindex mv850es
21713 Specify that the target processor is the V850ES.  This is an alias for
21714 the @option{-mv850e1} option.
21716 @item -mv850e
21717 @opindex mv850e
21718 Specify that the target processor is the V850E@.  The preprocessor
21719 constant @samp{__v850e__} is defined if this option is used.
21721 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21722 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21723 are defined then a default target processor is chosen and the
21724 relevant @samp{__v850*__} preprocessor constant is defined.
21726 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
21727 defined, regardless of which processor variant is the target.
21729 @item -mdisable-callt
21730 @itemx -mno-disable-callt
21731 @opindex mdisable-callt
21732 @opindex mno-disable-callt
21733 This option suppresses generation of the @code{CALLT} instruction for the
21734 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21735 architecture.
21737 This option is enabled by default when the RH850 ABI is
21738 in use (see @option{-mrh850-abi}), and disabled by default when the
21739 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21740 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
21742 @item -mrelax
21743 @itemx -mno-relax
21744 @opindex mrelax
21745 @opindex mno-relax
21746 Pass on (or do not pass on) the @option{-mrelax} command line option
21747 to the assembler.
21749 @item -mlong-jumps
21750 @itemx -mno-long-jumps
21751 @opindex mlong-jumps
21752 @opindex mno-long-jumps
21753 Disable (or re-enable) the generation of PC-relative jump instructions.
21755 @item -msoft-float
21756 @itemx -mhard-float
21757 @opindex msoft-float
21758 @opindex mhard-float
21759 Disable (or re-enable) the generation of hardware floating point
21760 instructions.  This option is only significant when the target
21761 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21762 instructions are being generated then the C preprocessor symbol
21763 @code{__FPU_OK__} will be defined, otherwise the symbol
21764 @code{__NO_FPU__} will be defined.
21766 @item -mloop
21767 @opindex mloop
21768 Enables the use of the e3v5 LOOP instruction.  The use of this
21769 instruction is not enabled by default when the e3v5 architecture is
21770 selected because its use is still experimental.
21772 @item -mrh850-abi
21773 @itemx -mghs
21774 @opindex mrh850-abi
21775 @opindex mghs
21776 Enables support for the RH850 version of the V850 ABI.  This is the
21777 default.  With this version of the ABI the following rules apply:
21779 @itemize
21780 @item
21781 Integer sized structures and unions are returned via a memory pointer
21782 rather than a register.
21784 @item
21785 Large structures and unions (more than 8 bytes in size) are passed by
21786 value.
21788 @item
21789 Functions are aligned to 16-bit boundaries.
21791 @item
21792 The @option{-m8byte-align} command line option is supported.
21794 @item
21795 The @option{-mdisable-callt} command line option is enabled by
21796 default.  The @option{-mno-disable-callt} command line option is not
21797 supported.
21798 @end itemize
21800 When this version of the ABI is enabled the C preprocessor symbol
21801 @code{__V850_RH850_ABI__} is defined.
21803 @item -mgcc-abi
21804 @opindex mgcc-abi
21805 Enables support for the old GCC version of the V850 ABI.  With this
21806 version of the ABI the following rules apply:
21808 @itemize
21809 @item
21810 Integer sized structures and unions are returned in register @code{r10}.
21812 @item
21813 Large structures and unions (more than 8 bytes in size) are passed by
21814 reference.
21816 @item
21817 Functions are aligned to 32-bit boundaries, unless optimizing for
21818 size.
21820 @item
21821 The @option{-m8byte-align} command line option is not supported.
21823 @item
21824 The @option{-mdisable-callt} command line option is supported but not
21825 enabled by default.
21826 @end itemize
21828 When this version of the ABI is enabled the C preprocessor symbol
21829 @code{__V850_GCC_ABI__} is defined.
21831 @item -m8byte-align
21832 @itemx -mno-8byte-align
21833 @opindex m8byte-align
21834 @opindex mno-8byte-align
21835 Enables support for @code{doubles} and @code{long long} types to be
21836 aligned on 8-byte boundaries.  The default is to restrict the
21837 alignment of all objects to at most 4-bytes.  When
21838 @option{-m8byte-align} is in effect the C preprocessor symbol
21839 @code{__V850_8BYTE_ALIGN__} will be defined.
21841 @item -mbig-switch
21842 @opindex mbig-switch
21843 Generate code suitable for big switch tables.  Use this option only if
21844 the assembler/linker complain about out of range branches within a switch
21845 table.
21847 @item -mapp-regs
21848 @opindex mapp-regs
21849 This option causes r2 and r5 to be used in the code generated by
21850 the compiler.  This setting is the default.
21852 @item -mno-app-regs
21853 @opindex mno-app-regs
21854 This option causes r2 and r5 to be treated as fixed registers.
21856 @end table
21858 @node VAX Options
21859 @subsection VAX Options
21860 @cindex VAX options
21862 These @samp{-m} options are defined for the VAX:
21864 @table @gcctabopt
21865 @item -munix
21866 @opindex munix
21867 Do not output certain jump instructions (@code{aobleq} and so on)
21868 that the Unix assembler for the VAX cannot handle across long
21869 ranges.
21871 @item -mgnu
21872 @opindex mgnu
21873 Do output those jump instructions, on the assumption that the
21874 GNU assembler is being used.
21876 @item -mg
21877 @opindex mg
21878 Output code for G-format floating-point numbers instead of D-format.
21879 @end table
21881 @node VMS Options
21882 @subsection VMS Options
21884 These @samp{-m} options are defined for the VMS implementations:
21886 @table @gcctabopt
21887 @item -mvms-return-codes
21888 @opindex mvms-return-codes
21889 Return VMS condition codes from @code{main}. The default is to return POSIX-style
21890 condition (e.g.@ error) codes.
21892 @item -mdebug-main=@var{prefix}
21893 @opindex mdebug-main=@var{prefix}
21894 Flag the first routine whose name starts with @var{prefix} as the main
21895 routine for the debugger.
21897 @item -mmalloc64
21898 @opindex mmalloc64
21899 Default to 64-bit memory allocation routines.
21901 @item -mpointer-size=@var{size}
21902 @opindex -mpointer-size=@var{size}
21903 Set the default size of pointers. Possible options for @var{size} are
21904 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
21905 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
21906 The later option disables @code{pragma pointer_size}.
21907 @end table
21909 @node VxWorks Options
21910 @subsection VxWorks Options
21911 @cindex VxWorks Options
21913 The options in this section are defined for all VxWorks targets.
21914 Options specific to the target hardware are listed with the other
21915 options for that target.
21917 @table @gcctabopt
21918 @item -mrtp
21919 @opindex mrtp
21920 GCC can generate code for both VxWorks kernels and real time processes
21921 (RTPs).  This option switches from the former to the latter.  It also
21922 defines the preprocessor macro @code{__RTP__}.
21924 @item -non-static
21925 @opindex non-static
21926 Link an RTP executable against shared libraries rather than static
21927 libraries.  The options @option{-static} and @option{-shared} can
21928 also be used for RTPs (@pxref{Link Options}); @option{-static}
21929 is the default.
21931 @item -Bstatic
21932 @itemx -Bdynamic
21933 @opindex Bstatic
21934 @opindex Bdynamic
21935 These options are passed down to the linker.  They are defined for
21936 compatibility with Diab.
21938 @item -Xbind-lazy
21939 @opindex Xbind-lazy
21940 Enable lazy binding of function calls.  This option is equivalent to
21941 @option{-Wl,-z,now} and is defined for compatibility with Diab.
21943 @item -Xbind-now
21944 @opindex Xbind-now
21945 Disable lazy binding of function calls.  This option is the default and
21946 is defined for compatibility with Diab.
21947 @end table
21949 @node x86-64 Options
21950 @subsection x86-64 Options
21951 @cindex x86-64 options
21953 These are listed under @xref{i386 and x86-64 Options}.
21955 @node Xstormy16 Options
21956 @subsection Xstormy16 Options
21957 @cindex Xstormy16 Options
21959 These options are defined for Xstormy16:
21961 @table @gcctabopt
21962 @item -msim
21963 @opindex msim
21964 Choose startup files and linker script suitable for the simulator.
21965 @end table
21967 @node Xtensa Options
21968 @subsection Xtensa Options
21969 @cindex Xtensa Options
21971 These options are supported for Xtensa targets:
21973 @table @gcctabopt
21974 @item -mconst16
21975 @itemx -mno-const16
21976 @opindex mconst16
21977 @opindex mno-const16
21978 Enable or disable use of @code{CONST16} instructions for loading
21979 constant values.  The @code{CONST16} instruction is currently not a
21980 standard option from Tensilica.  When enabled, @code{CONST16}
21981 instructions are always used in place of the standard @code{L32R}
21982 instructions.  The use of @code{CONST16} is enabled by default only if
21983 the @code{L32R} instruction is not available.
21985 @item -mfused-madd
21986 @itemx -mno-fused-madd
21987 @opindex mfused-madd
21988 @opindex mno-fused-madd
21989 Enable or disable use of fused multiply/add and multiply/subtract
21990 instructions in the floating-point option.  This has no effect if the
21991 floating-point option is not also enabled.  Disabling fused multiply/add
21992 and multiply/subtract instructions forces the compiler to use separate
21993 instructions for the multiply and add/subtract operations.  This may be
21994 desirable in some cases where strict IEEE 754-compliant results are
21995 required: the fused multiply add/subtract instructions do not round the
21996 intermediate result, thereby producing results with @emph{more} bits of
21997 precision than specified by the IEEE standard.  Disabling fused multiply
21998 add/subtract instructions also ensures that the program output is not
21999 sensitive to the compiler's ability to combine multiply and add/subtract
22000 operations.
22002 @item -mserialize-volatile
22003 @itemx -mno-serialize-volatile
22004 @opindex mserialize-volatile
22005 @opindex mno-serialize-volatile
22006 When this option is enabled, GCC inserts @code{MEMW} instructions before
22007 @code{volatile} memory references to guarantee sequential consistency.
22008 The default is @option{-mserialize-volatile}.  Use
22009 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22011 @item -mforce-no-pic
22012 @opindex mforce-no-pic
22013 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22014 position-independent code (PIC), this option disables PIC for compiling
22015 kernel code.
22017 @item -mtext-section-literals
22018 @itemx -mno-text-section-literals
22019 @opindex mtext-section-literals
22020 @opindex mno-text-section-literals
22021 Control the treatment of literal pools.  The default is
22022 @option{-mno-text-section-literals}, which places literals in a separate
22023 section in the output file.  This allows the literal pool to be placed
22024 in a data RAM/ROM, and it also allows the linker to combine literal
22025 pools from separate object files to remove redundant literals and
22026 improve code size.  With @option{-mtext-section-literals}, the literals
22027 are interspersed in the text section in order to keep them as close as
22028 possible to their references.  This may be necessary for large assembly
22029 files.
22031 @item -mtarget-align
22032 @itemx -mno-target-align
22033 @opindex mtarget-align
22034 @opindex mno-target-align
22035 When this option is enabled, GCC instructs the assembler to
22036 automatically align instructions to reduce branch penalties at the
22037 expense of some code density.  The assembler attempts to widen density
22038 instructions to align branch targets and the instructions following call
22039 instructions.  If there are not enough preceding safe density
22040 instructions to align a target, no widening is performed.  The
22041 default is @option{-mtarget-align}.  These options do not affect the
22042 treatment of auto-aligned instructions like @code{LOOP}, which the
22043 assembler always aligns, either by widening density instructions or
22044 by inserting NOP instructions.
22046 @item -mlongcalls
22047 @itemx -mno-longcalls
22048 @opindex mlongcalls
22049 @opindex mno-longcalls
22050 When this option is enabled, GCC instructs the assembler to translate
22051 direct calls to indirect calls unless it can determine that the target
22052 of a direct call is in the range allowed by the call instruction.  This
22053 translation typically occurs for calls to functions in other source
22054 files.  Specifically, the assembler translates a direct @code{CALL}
22055 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22056 The default is @option{-mno-longcalls}.  This option should be used in
22057 programs where the call target can potentially be out of range.  This
22058 option is implemented in the assembler, not the compiler, so the
22059 assembly code generated by GCC still shows direct call
22060 instructions---look at the disassembled object code to see the actual
22061 instructions.  Note that the assembler uses an indirect call for
22062 every cross-file call, not just those that really are out of range.
22063 @end table
22065 @node zSeries Options
22066 @subsection zSeries Options
22067 @cindex zSeries options
22069 These are listed under @xref{S/390 and zSeries Options}.
22071 @node Code Gen Options
22072 @section Options for Code Generation Conventions
22073 @cindex code generation conventions
22074 @cindex options, code generation
22075 @cindex run-time options
22077 These machine-independent options control the interface conventions
22078 used in code generation.
22080 Most of them have both positive and negative forms; the negative form
22081 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22082 one of the forms is listed---the one that is not the default.  You
22083 can figure out the other form by either removing @samp{no-} or adding
22086 @table @gcctabopt
22087 @item -fbounds-check
22088 @opindex fbounds-check
22089 For front ends that support it, generate additional code to check that
22090 indices used to access arrays are within the declared range.  This is
22091 currently only supported by the Java and Fortran front ends, where
22092 this option defaults to true and false respectively.
22094 @item -fstack-reuse=@var{reuse-level}
22095 @opindex fstack_reuse
22096 This option controls stack space reuse for user declared local/auto variables
22097 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22098 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22099 local variables and temporaries, @samp{named_vars} enables the reuse only for
22100 user defined local variables with names, and @samp{none} disables stack reuse
22101 completely. The default value is @samp{all}. The option is needed when the
22102 program extends the lifetime of a scoped local variable or a compiler generated
22103 temporary beyond the end point defined by the language.  When a lifetime of
22104 a variable ends, and if the variable lives in memory, the optimizing compiler
22105 has the freedom to reuse its stack space with other temporaries or scoped
22106 local variables whose live range does not overlap with it. Legacy code extending
22107 local lifetime will likely to break with the stack reuse optimization.
22109 For example,
22111 @smallexample
22112    int *p;
22113    @{
22114      int local1;
22116      p = &local1;
22117      local1 = 10;
22118      ....
22119    @}
22120    @{
22121       int local2;
22122       local2 = 20;
22123       ...
22124    @}
22126    if (*p == 10)  // out of scope use of local1
22127      @{
22129      @}
22130 @end smallexample
22132 Another example:
22133 @smallexample
22135    struct A
22136    @{
22137        A(int k) : i(k), j(k) @{ @}
22138        int i;
22139        int j;
22140    @};
22142    A *ap;
22144    void foo(const A& ar)
22145    @{
22146       ap = &ar;
22147    @}
22149    void bar()
22150    @{
22151       foo(A(10)); // temp object's lifetime ends when foo returns
22153       @{
22154         A a(20);
22155         ....
22156       @}
22157       ap->i+= 10;  // ap references out of scope temp whose space
22158                    // is reused with a. What is the value of ap->i?
22159    @}
22161 @end smallexample
22163 The lifetime of a compiler generated temporary is well defined by the C++
22164 standard. When a lifetime of a temporary ends, and if the temporary lives
22165 in memory, the optimizing compiler has the freedom to reuse its stack
22166 space with other temporaries or scoped local variables whose live range
22167 does not overlap with it. However some of the legacy code relies on
22168 the behavior of older compilers in which temporaries' stack space is
22169 not reused, the aggressive stack reuse can lead to runtime errors. This
22170 option is used to control the temporary stack reuse optimization.
22172 @item -ftrapv
22173 @opindex ftrapv
22174 This option generates traps for signed overflow on addition, subtraction,
22175 multiplication operations.
22177 @item -fwrapv
22178 @opindex fwrapv
22179 This option instructs the compiler to assume that signed arithmetic
22180 overflow of addition, subtraction and multiplication wraps around
22181 using twos-complement representation.  This flag enables some optimizations
22182 and disables others.  This option is enabled by default for the Java
22183 front end, as required by the Java language specification.
22185 @item -fexceptions
22186 @opindex fexceptions
22187 Enable exception handling.  Generates extra code needed to propagate
22188 exceptions.  For some targets, this implies GCC generates frame
22189 unwind information for all functions, which can produce significant data
22190 size overhead, although it does not affect execution.  If you do not
22191 specify this option, GCC enables it by default for languages like
22192 C++ that normally require exception handling, and disables it for
22193 languages like C that do not normally require it.  However, you may need
22194 to enable this option when compiling C code that needs to interoperate
22195 properly with exception handlers written in C++.  You may also wish to
22196 disable this option if you are compiling older C++ programs that don't
22197 use exception handling.
22199 @item -fnon-call-exceptions
22200 @opindex fnon-call-exceptions
22201 Generate code that allows trapping instructions to throw exceptions.
22202 Note that this requires platform-specific runtime support that does
22203 not exist everywhere.  Moreover, it only allows @emph{trapping}
22204 instructions to throw exceptions, i.e.@: memory references or floating-point
22205 instructions.  It does not allow exceptions to be thrown from
22206 arbitrary signal handlers such as @code{SIGALRM}.
22208 @item -fdelete-dead-exceptions
22209 @opindex fdelete-dead-exceptions
22210 Consider that instructions that may throw exceptions but don't otherwise
22211 contribute to the execution of the program can be optimized away.
22212 This option is enabled by default for the Ada front end, as permitted by
22213 the Ada language specification.
22214 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22216 @item -funwind-tables
22217 @opindex funwind-tables
22218 Similar to @option{-fexceptions}, except that it just generates any needed
22219 static data, but does not affect the generated code in any other way.
22220 You normally do not need to enable this option; instead, a language processor
22221 that needs this handling enables it on your behalf.
22223 @item -fasynchronous-unwind-tables
22224 @opindex fasynchronous-unwind-tables
22225 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22226 table is exact at each instruction boundary, so it can be used for stack
22227 unwinding from asynchronous events (such as debugger or garbage collector).
22229 @item -fno-gnu-unique
22230 @opindex fno-gnu-unique
22231 On systems with recent GNU assembler and C library, the C++ compiler
22232 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22233 of template static data members and static local variables in inline
22234 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22235 is necessary to avoid problems with a library used by two different
22236 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22237 therefore disagreeing with the other one about the binding of the
22238 symbol.  But this causes @code{dlclose} to be ignored for affected
22239 DSOs; if your program relies on reinitialization of a DSO via
22240 @code{dlclose} and @code{dlopen}, you can use
22241 @option{-fno-gnu-unique}.
22243 @item -fpcc-struct-return
22244 @opindex fpcc-struct-return
22245 Return ``short'' @code{struct} and @code{union} values in memory like
22246 longer ones, rather than in registers.  This convention is less
22247 efficient, but it has the advantage of allowing intercallability between
22248 GCC-compiled files and files compiled with other compilers, particularly
22249 the Portable C Compiler (pcc).
22251 The precise convention for returning structures in memory depends
22252 on the target configuration macros.
22254 Short structures and unions are those whose size and alignment match
22255 that of some integer type.
22257 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22258 switch is not binary compatible with code compiled with the
22259 @option{-freg-struct-return} switch.
22260 Use it to conform to a non-default application binary interface.
22262 @item -freg-struct-return
22263 @opindex freg-struct-return
22264 Return @code{struct} and @code{union} values in registers when possible.
22265 This is more efficient for small structures than
22266 @option{-fpcc-struct-return}.
22268 If you specify neither @option{-fpcc-struct-return} nor
22269 @option{-freg-struct-return}, GCC defaults to whichever convention is
22270 standard for the target.  If there is no standard convention, GCC
22271 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22272 the principal compiler.  In those cases, we can choose the standard, and
22273 we chose the more efficient register return alternative.
22275 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22276 switch is not binary compatible with code compiled with the
22277 @option{-fpcc-struct-return} switch.
22278 Use it to conform to a non-default application binary interface.
22280 @item -fshort-enums
22281 @opindex fshort-enums
22282 Allocate to an @code{enum} type only as many bytes as it needs for the
22283 declared range of possible values.  Specifically, the @code{enum} type
22284 is equivalent to the smallest integer type that has enough room.
22286 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22287 code that is not binary compatible with code generated without that switch.
22288 Use it to conform to a non-default application binary interface.
22290 @item -fshort-double
22291 @opindex fshort-double
22292 Use the same size for @code{double} as for @code{float}.
22294 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22295 code that is not binary compatible with code generated without that switch.
22296 Use it to conform to a non-default application binary interface.
22298 @item -fshort-wchar
22299 @opindex fshort-wchar
22300 Override the underlying type for @samp{wchar_t} to be @samp{short
22301 unsigned int} instead of the default for the target.  This option is
22302 useful for building programs to run under WINE@.
22304 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22305 code that is not binary compatible with code generated without that switch.
22306 Use it to conform to a non-default application binary interface.
22308 @item -fno-common
22309 @opindex fno-common
22310 In C code, controls the placement of uninitialized global variables.
22311 Unix C compilers have traditionally permitted multiple definitions of
22312 such variables in different compilation units by placing the variables
22313 in a common block.
22314 This is the behavior specified by @option{-fcommon}, and is the default
22315 for GCC on most targets.
22316 On the other hand, this behavior is not required by ISO C, and on some
22317 targets may carry a speed or code size penalty on variable references.
22318 The @option{-fno-common} option specifies that the compiler should place
22319 uninitialized global variables in the data section of the object file,
22320 rather than generating them as common blocks.
22321 This has the effect that if the same variable is declared
22322 (without @code{extern}) in two different compilations,
22323 you get a multiple-definition error when you link them.
22324 In this case, you must compile with @option{-fcommon} instead.
22325 Compiling with @option{-fno-common} is useful on targets for which
22326 it provides better performance, or if you wish to verify that the
22327 program will work on other systems that always treat uninitialized
22328 variable declarations this way.
22330 @item -fno-ident
22331 @opindex fno-ident
22332 Ignore the @samp{#ident} directive.
22334 @item -finhibit-size-directive
22335 @opindex finhibit-size-directive
22336 Don't output a @code{.size} assembler directive, or anything else that
22337 would cause trouble if the function is split in the middle, and the
22338 two halves are placed at locations far apart in memory.  This option is
22339 used when compiling @file{crtstuff.c}; you should not need to use it
22340 for anything else.
22342 @item -fverbose-asm
22343 @opindex fverbose-asm
22344 Put extra commentary information in the generated assembly code to
22345 make it more readable.  This option is generally only of use to those
22346 who actually need to read the generated assembly code (perhaps while
22347 debugging the compiler itself).
22349 @option{-fno-verbose-asm}, the default, causes the
22350 extra information to be omitted and is useful when comparing two assembler
22351 files.
22353 @item -frecord-gcc-switches
22354 @opindex frecord-gcc-switches
22355 This switch causes the command line used to invoke the
22356 compiler to be recorded into the object file that is being created.
22357 This switch is only implemented on some targets and the exact format
22358 of the recording is target and binary file format dependent, but it
22359 usually takes the form of a section containing ASCII text.  This
22360 switch is related to the @option{-fverbose-asm} switch, but that
22361 switch only records information in the assembler output file as
22362 comments, so it never reaches the object file.
22363 See also @option{-grecord-gcc-switches} for another
22364 way of storing compiler options into the object file.
22366 @item -fpic
22367 @opindex fpic
22368 @cindex global offset table
22369 @cindex PIC
22370 Generate position-independent code (PIC) suitable for use in a shared
22371 library, if supported for the target machine.  Such code accesses all
22372 constant addresses through a global offset table (GOT)@.  The dynamic
22373 loader resolves the GOT entries when the program starts (the dynamic
22374 loader is not part of GCC; it is part of the operating system).  If
22375 the GOT size for the linked executable exceeds a machine-specific
22376 maximum size, you get an error message from the linker indicating that
22377 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
22378 instead.  (These maximums are 8k on the SPARC and 32k
22379 on the m68k and RS/6000.  The 386 has no such limit.)
22381 Position-independent code requires special support, and therefore works
22382 only on certain machines.  For the 386, GCC supports PIC for System V
22383 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
22384 position-independent.
22386 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22387 are defined to 1.
22389 @item -fPIC
22390 @opindex fPIC
22391 If supported for the target machine, emit position-independent code,
22392 suitable for dynamic linking and avoiding any limit on the size of the
22393 global offset table.  This option makes a difference on the m68k,
22394 PowerPC and SPARC@.
22396 Position-independent code requires special support, and therefore works
22397 only on certain machines.
22399 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22400 are defined to 2.
22402 @item -fpie
22403 @itemx -fPIE
22404 @opindex fpie
22405 @opindex fPIE
22406 These options are similar to @option{-fpic} and @option{-fPIC}, but
22407 generated position independent code can be only linked into executables.
22408 Usually these options are used when @option{-pie} GCC option is
22409 used during linking.
22411 @option{-fpie} and @option{-fPIE} both define the macros
22412 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
22413 for @option{-fpie} and 2 for @option{-fPIE}.
22415 @item -fno-jump-tables
22416 @opindex fno-jump-tables
22417 Do not use jump tables for switch statements even where it would be
22418 more efficient than other code generation strategies.  This option is
22419 of use in conjunction with @option{-fpic} or @option{-fPIC} for
22420 building code that forms part of a dynamic linker and cannot
22421 reference the address of a jump table.  On some targets, jump tables
22422 do not require a GOT and this option is not needed.
22424 @item -ffixed-@var{reg}
22425 @opindex ffixed
22426 Treat the register named @var{reg} as a fixed register; generated code
22427 should never refer to it (except perhaps as a stack pointer, frame
22428 pointer or in some other fixed role).
22430 @var{reg} must be the name of a register.  The register names accepted
22431 are machine-specific and are defined in the @code{REGISTER_NAMES}
22432 macro in the machine description macro file.
22434 This flag does not have a negative form, because it specifies a
22435 three-way choice.
22437 @item -fcall-used-@var{reg}
22438 @opindex fcall-used
22439 Treat the register named @var{reg} as an allocable register that is
22440 clobbered by function calls.  It may be allocated for temporaries or
22441 variables that do not live across a call.  Functions compiled this way
22442 do not save and restore the register @var{reg}.
22444 It is an error to use this flag with the frame pointer or stack pointer.
22445 Use of this flag for other registers that have fixed pervasive roles in
22446 the machine's execution model produces disastrous results.
22448 This flag does not have a negative form, because it specifies a
22449 three-way choice.
22451 @item -fcall-saved-@var{reg}
22452 @opindex fcall-saved
22453 Treat the register named @var{reg} as an allocable register saved by
22454 functions.  It may be allocated even for temporaries or variables that
22455 live across a call.  Functions compiled this way save and restore
22456 the register @var{reg} if they use it.
22458 It is an error to use this flag with the frame pointer or stack pointer.
22459 Use of this flag for other registers that have fixed pervasive roles in
22460 the machine's execution model produces disastrous results.
22462 A different sort of disaster results from the use of this flag for
22463 a register in which function values may be returned.
22465 This flag does not have a negative form, because it specifies a
22466 three-way choice.
22468 @item -fpack-struct[=@var{n}]
22469 @opindex fpack-struct
22470 Without a value specified, pack all structure members together without
22471 holes.  When a value is specified (which must be a small power of two), pack
22472 structure members according to this value, representing the maximum
22473 alignment (that is, objects with default alignment requirements larger than
22474 this are output potentially unaligned at the next fitting location.
22476 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
22477 code that is not binary compatible with code generated without that switch.
22478 Additionally, it makes the code suboptimal.
22479 Use it to conform to a non-default application binary interface.
22481 @item -finstrument-functions
22482 @opindex finstrument-functions
22483 Generate instrumentation calls for entry and exit to functions.  Just
22484 after function entry and just before function exit, the following
22485 profiling functions are called with the address of the current
22486 function and its call site.  (On some platforms,
22487 @code{__builtin_return_address} does not work beyond the current
22488 function, so the call site information may not be available to the
22489 profiling functions otherwise.)
22491 @smallexample
22492 void __cyg_profile_func_enter (void *this_fn,
22493                                void *call_site);
22494 void __cyg_profile_func_exit  (void *this_fn,
22495                                void *call_site);
22496 @end smallexample
22498 The first argument is the address of the start of the current function,
22499 which may be looked up exactly in the symbol table.
22501 This instrumentation is also done for functions expanded inline in other
22502 functions.  The profiling calls indicate where, conceptually, the
22503 inline function is entered and exited.  This means that addressable
22504 versions of such functions must be available.  If all your uses of a
22505 function are expanded inline, this may mean an additional expansion of
22506 code size.  If you use @samp{extern inline} in your C code, an
22507 addressable version of such functions must be provided.  (This is
22508 normally the case anyway, but if you get lucky and the optimizer always
22509 expands the functions inline, you might have gotten away without
22510 providing static copies.)
22512 A function may be given the attribute @code{no_instrument_function}, in
22513 which case this instrumentation is not done.  This can be used, for
22514 example, for the profiling functions listed above, high-priority
22515 interrupt routines, and any functions from which the profiling functions
22516 cannot safely be called (perhaps signal handlers, if the profiling
22517 routines generate output or allocate memory).
22519 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
22520 @opindex finstrument-functions-exclude-file-list
22522 Set the list of functions that are excluded from instrumentation (see
22523 the description of @code{-finstrument-functions}).  If the file that
22524 contains a function definition matches with one of @var{file}, then
22525 that function is not instrumented.  The match is done on substrings:
22526 if the @var{file} parameter is a substring of the file name, it is
22527 considered to be a match.
22529 For example:
22531 @smallexample
22532 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
22533 @end smallexample
22535 @noindent
22536 excludes any inline function defined in files whose pathnames
22537 contain @code{/bits/stl} or @code{include/sys}.
22539 If, for some reason, you want to include letter @code{','} in one of
22540 @var{sym}, write @code{'\,'}. For example,
22541 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
22542 (note the single quote surrounding the option).
22544 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
22545 @opindex finstrument-functions-exclude-function-list
22547 This is similar to @code{-finstrument-functions-exclude-file-list},
22548 but this option sets the list of function names to be excluded from
22549 instrumentation.  The function name to be matched is its user-visible
22550 name, such as @code{vector<int> blah(const vector<int> &)}, not the
22551 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
22552 match is done on substrings: if the @var{sym} parameter is a substring
22553 of the function name, it is considered to be a match.  For C99 and C++
22554 extended identifiers, the function name must be given in UTF-8, not
22555 using universal character names.
22557 @item -fstack-check
22558 @opindex fstack-check
22559 Generate code to verify that you do not go beyond the boundary of the
22560 stack.  You should specify this flag if you are running in an
22561 environment with multiple threads, but you only rarely need to specify it in
22562 a single-threaded environment since stack overflow is automatically
22563 detected on nearly all systems if there is only one stack.
22565 Note that this switch does not actually cause checking to be done; the
22566 operating system or the language runtime must do that.  The switch causes
22567 generation of code to ensure that they see the stack being extended.
22569 You can additionally specify a string parameter: @code{no} means no
22570 checking, @code{generic} means force the use of old-style checking,
22571 @code{specific} means use the best checking method and is equivalent
22572 to bare @option{-fstack-check}.
22574 Old-style checking is a generic mechanism that requires no specific
22575 target support in the compiler but comes with the following drawbacks:
22577 @enumerate
22578 @item
22579 Modified allocation strategy for large objects: they are always
22580 allocated dynamically if their size exceeds a fixed threshold.
22582 @item
22583 Fixed limit on the size of the static frame of functions: when it is
22584 topped by a particular function, stack checking is not reliable and
22585 a warning is issued by the compiler.
22587 @item
22588 Inefficiency: because of both the modified allocation strategy and the
22589 generic implementation, code performance is hampered.
22590 @end enumerate
22592 Note that old-style stack checking is also the fallback method for
22593 @code{specific} if no target support has been added in the compiler.
22595 @item -fstack-limit-register=@var{reg}
22596 @itemx -fstack-limit-symbol=@var{sym}
22597 @itemx -fno-stack-limit
22598 @opindex fstack-limit-register
22599 @opindex fstack-limit-symbol
22600 @opindex fno-stack-limit
22601 Generate code to ensure that the stack does not grow beyond a certain value,
22602 either the value of a register or the address of a symbol.  If a larger
22603 stack is required, a signal is raised at run time.  For most targets,
22604 the signal is raised before the stack overruns the boundary, so
22605 it is possible to catch the signal without taking special precautions.
22607 For instance, if the stack starts at absolute address @samp{0x80000000}
22608 and grows downwards, you can use the flags
22609 @option{-fstack-limit-symbol=__stack_limit} and
22610 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
22611 of 128KB@.  Note that this may only work with the GNU linker.
22613 @item -fsplit-stack
22614 @opindex fsplit-stack
22615 Generate code to automatically split the stack before it overflows.
22616 The resulting program has a discontiguous stack which can only
22617 overflow if the program is unable to allocate any more memory.  This
22618 is most useful when running threaded programs, as it is no longer
22619 necessary to calculate a good stack size to use for each thread.  This
22620 is currently only implemented for the i386 and x86_64 back ends running
22621 GNU/Linux.
22623 When code compiled with @option{-fsplit-stack} calls code compiled
22624 without @option{-fsplit-stack}, there may not be much stack space
22625 available for the latter code to run.  If compiling all code,
22626 including library code, with @option{-fsplit-stack} is not an option,
22627 then the linker can fix up these calls so that the code compiled
22628 without @option{-fsplit-stack} always has a large stack.  Support for
22629 this is implemented in the gold linker in GNU binutils release 2.21
22630 and later.
22632 @item -fleading-underscore
22633 @opindex fleading-underscore
22634 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
22635 change the way C symbols are represented in the object file.  One use
22636 is to help link with legacy assembly code.
22638 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
22639 generate code that is not binary compatible with code generated without that
22640 switch.  Use it to conform to a non-default application binary interface.
22641 Not all targets provide complete support for this switch.
22643 @item -ftls-model=@var{model}
22644 @opindex ftls-model
22645 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
22646 The @var{model} argument should be one of @code{global-dynamic},
22647 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
22648 Note that the choice is subject to optimization: the compiler may use
22649 a more efficient model for symbols not visible outside of the translation
22650 unit, or if @option{-fpic} is not given on the command line.
22652 The default without @option{-fpic} is @code{initial-exec}; with
22653 @option{-fpic} the default is @code{global-dynamic}.
22655 @item -fvisibility=@var{default|internal|hidden|protected}
22656 @opindex fvisibility
22657 Set the default ELF image symbol visibility to the specified option---all
22658 symbols are marked with this unless overridden within the code.
22659 Using this feature can very substantially improve linking and
22660 load times of shared object libraries, produce more optimized
22661 code, provide near-perfect API export and prevent symbol clashes.
22662 It is @strong{strongly} recommended that you use this in any shared objects
22663 you distribute.
22665 Despite the nomenclature, @code{default} always means public; i.e.,
22666 available to be linked against from outside the shared object.
22667 @code{protected} and @code{internal} are pretty useless in real-world
22668 usage so the only other commonly used option is @code{hidden}.
22669 The default if @option{-fvisibility} isn't specified is
22670 @code{default}, i.e., make every
22671 symbol public---this causes the same behavior as previous versions of
22672 GCC@.
22674 A good explanation of the benefits offered by ensuring ELF
22675 symbols have the correct visibility is given by ``How To Write
22676 Shared Libraries'' by Ulrich Drepper (which can be found at
22677 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
22678 solution made possible by this option to marking things hidden when
22679 the default is public is to make the default hidden and mark things
22680 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
22681 and @code{__attribute__ ((visibility("default")))} instead of
22682 @code{__declspec(dllexport)} you get almost identical semantics with
22683 identical syntax.  This is a great boon to those working with
22684 cross-platform projects.
22686 For those adding visibility support to existing code, you may find
22687 @samp{#pragma GCC visibility} of use.  This works by you enclosing
22688 the declarations you wish to set visibility for with (for example)
22689 @samp{#pragma GCC visibility push(hidden)} and
22690 @samp{#pragma GCC visibility pop}.
22691 Bear in mind that symbol visibility should be viewed @strong{as
22692 part of the API interface contract} and thus all new code should
22693 always specify visibility when it is not the default; i.e., declarations
22694 only for use within the local DSO should @strong{always} be marked explicitly
22695 as hidden as so to avoid PLT indirection overheads---making this
22696 abundantly clear also aids readability and self-documentation of the code.
22697 Note that due to ISO C++ specification requirements, @code{operator new} and
22698 @code{operator delete} must always be of default visibility.
22700 Be aware that headers from outside your project, in particular system
22701 headers and headers from any other library you use, may not be
22702 expecting to be compiled with visibility other than the default.  You
22703 may need to explicitly say @samp{#pragma GCC visibility push(default)}
22704 before including any such headers.
22706 @samp{extern} declarations are not affected by @option{-fvisibility}, so
22707 a lot of code can be recompiled with @option{-fvisibility=hidden} with
22708 no modifications.  However, this means that calls to @code{extern}
22709 functions with no explicit visibility use the PLT, so it is more
22710 effective to use @code{__attribute ((visibility))} and/or
22711 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
22712 declarations should be treated as hidden.
22714 Note that @option{-fvisibility} does affect C++ vague linkage
22715 entities. This means that, for instance, an exception class that is
22716 be thrown between DSOs must be explicitly marked with default
22717 visibility so that the @samp{type_info} nodes are unified between
22718 the DSOs.
22720 An overview of these techniques, their benefits and how to use them
22721 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
22723 @item -fstrict-volatile-bitfields
22724 @opindex fstrict-volatile-bitfields
22725 This option should be used if accesses to volatile bit-fields (or other
22726 structure fields, although the compiler usually honors those types
22727 anyway) should use a single access of the width of the
22728 field's type, aligned to a natural alignment if possible.  For
22729 example, targets with memory-mapped peripheral registers might require
22730 all such accesses to be 16 bits wide; with this flag you can
22731 declare all peripheral bit-fields as @code{unsigned short} (assuming short
22732 is 16 bits on these targets) to force GCC to use 16-bit accesses
22733 instead of, perhaps, a more efficient 32-bit access.
22735 If this option is disabled, the compiler uses the most efficient
22736 instruction.  In the previous example, that might be a 32-bit load
22737 instruction, even though that accesses bytes that do not contain
22738 any portion of the bit-field, or memory-mapped registers unrelated to
22739 the one being updated.
22741 In some cases, such as when the @code{packed} attribute is applied to a 
22742 structure field, it may not be possible to access the field with a single
22743 read or write that is correctly aligned for the target machine.  In this
22744 case GCC falls back to generating multiple accesses rather than code that 
22745 will fault or truncate the result at run time.
22747 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
22748 not allowed to touch non bit-field members.  It is therefore recommended
22749 to define all bits of the field's type as bit-field members.
22751 The default value of this option is determined by the application binary
22752 interface for the target processor.
22754 @item -fsync-libcalls
22755 @opindex fsync-libcalls
22756 This option controls whether any out-of-line instance of the @code{__sync}
22757 family of functions may be used to implement the C++11 @code{__atomic}
22758 family of functions.
22760 The default value of this option is enabled, thus the only useful form
22761 of the option is @option{-fno-sync-libcalls}.  This option is used in
22762 the implementation of the @file{libatomic} runtime library.
22764 @end table
22766 @c man end
22768 @node Environment Variables
22769 @section Environment Variables Affecting GCC
22770 @cindex environment variables
22772 @c man begin ENVIRONMENT
22773 This section describes several environment variables that affect how GCC
22774 operates.  Some of them work by specifying directories or prefixes to use
22775 when searching for various kinds of files.  Some are used to specify other
22776 aspects of the compilation environment.
22778 Note that you can also specify places to search using options such as
22779 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
22780 take precedence over places specified using environment variables, which
22781 in turn take precedence over those specified by the configuration of GCC@.
22782 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
22783 GNU Compiler Collection (GCC) Internals}.
22785 @table @env
22786 @item LANG
22787 @itemx LC_CTYPE
22788 @c @itemx LC_COLLATE
22789 @itemx LC_MESSAGES
22790 @c @itemx LC_MONETARY
22791 @c @itemx LC_NUMERIC
22792 @c @itemx LC_TIME
22793 @itemx LC_ALL
22794 @findex LANG
22795 @findex LC_CTYPE
22796 @c @findex LC_COLLATE
22797 @findex LC_MESSAGES
22798 @c @findex LC_MONETARY
22799 @c @findex LC_NUMERIC
22800 @c @findex LC_TIME
22801 @findex LC_ALL
22802 @cindex locale
22803 These environment variables control the way that GCC uses
22804 localization information which allows GCC to work with different
22805 national conventions.  GCC inspects the locale categories
22806 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
22807 so.  These locale categories can be set to any value supported by your
22808 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
22809 Kingdom encoded in UTF-8.
22811 The @env{LC_CTYPE} environment variable specifies character
22812 classification.  GCC uses it to determine the character boundaries in
22813 a string; this is needed for some multibyte encodings that contain quote
22814 and escape characters that are otherwise interpreted as a string
22815 end or escape.
22817 The @env{LC_MESSAGES} environment variable specifies the language to
22818 use in diagnostic messages.
22820 If the @env{LC_ALL} environment variable is set, it overrides the value
22821 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
22822 and @env{LC_MESSAGES} default to the value of the @env{LANG}
22823 environment variable.  If none of these variables are set, GCC
22824 defaults to traditional C English behavior.
22826 @item TMPDIR
22827 @findex TMPDIR
22828 If @env{TMPDIR} is set, it specifies the directory to use for temporary
22829 files.  GCC uses temporary files to hold the output of one stage of
22830 compilation which is to be used as input to the next stage: for example,
22831 the output of the preprocessor, which is the input to the compiler
22832 proper.
22834 @item GCC_COMPARE_DEBUG
22835 @findex GCC_COMPARE_DEBUG
22836 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
22837 @option{-fcompare-debug} to the compiler driver.  See the documentation
22838 of this option for more details.
22840 @item GCC_EXEC_PREFIX
22841 @findex GCC_EXEC_PREFIX
22842 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
22843 names of the subprograms executed by the compiler.  No slash is added
22844 when this prefix is combined with the name of a subprogram, but you can
22845 specify a prefix that ends with a slash if you wish.
22847 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
22848 an appropriate prefix to use based on the pathname it is invoked with.
22850 If GCC cannot find the subprogram using the specified prefix, it
22851 tries looking in the usual places for the subprogram.
22853 The default value of @env{GCC_EXEC_PREFIX} is
22854 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
22855 the installed compiler. In many cases @var{prefix} is the value
22856 of @code{prefix} when you ran the @file{configure} script.
22858 Other prefixes specified with @option{-B} take precedence over this prefix.
22860 This prefix is also used for finding files such as @file{crt0.o} that are
22861 used for linking.
22863 In addition, the prefix is used in an unusual way in finding the
22864 directories to search for header files.  For each of the standard
22865 directories whose name normally begins with @samp{/usr/local/lib/gcc}
22866 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
22867 replacing that beginning with the specified prefix to produce an
22868 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
22869 @file{foo/bar} just before it searches the standard directory 
22870 @file{/usr/local/lib/bar}.
22871 If a standard directory begins with the configured
22872 @var{prefix} then the value of @var{prefix} is replaced by
22873 @env{GCC_EXEC_PREFIX} when looking for header files.
22875 @item COMPILER_PATH
22876 @findex COMPILER_PATH
22877 The value of @env{COMPILER_PATH} is a colon-separated list of
22878 directories, much like @env{PATH}.  GCC tries the directories thus
22879 specified when searching for subprograms, if it can't find the
22880 subprograms using @env{GCC_EXEC_PREFIX}.
22882 @item LIBRARY_PATH
22883 @findex LIBRARY_PATH
22884 The value of @env{LIBRARY_PATH} is a colon-separated list of
22885 directories, much like @env{PATH}.  When configured as a native compiler,
22886 GCC tries the directories thus specified when searching for special
22887 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
22888 using GCC also uses these directories when searching for ordinary
22889 libraries for the @option{-l} option (but directories specified with
22890 @option{-L} come first).
22892 @item LANG
22893 @findex LANG
22894 @cindex locale definition
22895 This variable is used to pass locale information to the compiler.  One way in
22896 which this information is used is to determine the character set to be used
22897 when character literals, string literals and comments are parsed in C and C++.
22898 When the compiler is configured to allow multibyte characters,
22899 the following values for @env{LANG} are recognized:
22901 @table @samp
22902 @item C-JIS
22903 Recognize JIS characters.
22904 @item C-SJIS
22905 Recognize SJIS characters.
22906 @item C-EUCJP
22907 Recognize EUCJP characters.
22908 @end table
22910 If @env{LANG} is not defined, or if it has some other value, then the
22911 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
22912 recognize and translate multibyte characters.
22913 @end table
22915 @noindent
22916 Some additional environment variables affect the behavior of the
22917 preprocessor.
22919 @include cppenv.texi
22921 @c man end
22923 @node Precompiled Headers
22924 @section Using Precompiled Headers
22925 @cindex precompiled headers
22926 @cindex speed of compilation
22928 Often large projects have many header files that are included in every
22929 source file.  The time the compiler takes to process these header files
22930 over and over again can account for nearly all of the time required to
22931 build the project.  To make builds faster, GCC allows you to
22932 @dfn{precompile} a header file.
22934 To create a precompiled header file, simply compile it as you would any
22935 other file, if necessary using the @option{-x} option to make the driver
22936 treat it as a C or C++ header file.  You may want to use a
22937 tool like @command{make} to keep the precompiled header up-to-date when
22938 the headers it contains change.
22940 A precompiled header file is searched for when @code{#include} is
22941 seen in the compilation.  As it searches for the included file
22942 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
22943 compiler looks for a precompiled header in each directory just before it
22944 looks for the include file in that directory.  The name searched for is
22945 the name specified in the @code{#include} with @samp{.gch} appended.  If
22946 the precompiled header file can't be used, it is ignored.
22948 For instance, if you have @code{#include "all.h"}, and you have
22949 @file{all.h.gch} in the same directory as @file{all.h}, then the
22950 precompiled header file is used if possible, and the original
22951 header is used otherwise.
22953 Alternatively, you might decide to put the precompiled header file in a
22954 directory and use @option{-I} to ensure that directory is searched
22955 before (or instead of) the directory containing the original header.
22956 Then, if you want to check that the precompiled header file is always
22957 used, you can put a file of the same name as the original header in this
22958 directory containing an @code{#error} command.
22960 This also works with @option{-include}.  So yet another way to use
22961 precompiled headers, good for projects not designed with precompiled
22962 header files in mind, is to simply take most of the header files used by
22963 a project, include them from another header file, precompile that header
22964 file, and @option{-include} the precompiled header.  If the header files
22965 have guards against multiple inclusion, they are skipped because
22966 they've already been included (in the precompiled header).
22968 If you need to precompile the same header file for different
22969 languages, targets, or compiler options, you can instead make a
22970 @emph{directory} named like @file{all.h.gch}, and put each precompiled
22971 header in the directory, perhaps using @option{-o}.  It doesn't matter
22972 what you call the files in the directory; every precompiled header in
22973 the directory is considered.  The first precompiled header
22974 encountered in the directory that is valid for this compilation is
22975 used; they're searched in no particular order.
22977 There are many other possibilities, limited only by your imagination,
22978 good sense, and the constraints of your build system.
22980 A precompiled header file can be used only when these conditions apply:
22982 @itemize
22983 @item
22984 Only one precompiled header can be used in a particular compilation.
22986 @item
22987 A precompiled header can't be used once the first C token is seen.  You
22988 can have preprocessor directives before a precompiled header; you cannot
22989 include a precompiled header from inside another header.
22991 @item
22992 The precompiled header file must be produced for the same language as
22993 the current compilation.  You can't use a C precompiled header for a C++
22994 compilation.
22996 @item
22997 The precompiled header file must have been produced by the same compiler
22998 binary as the current compilation is using.
23000 @item
23001 Any macros defined before the precompiled header is included must
23002 either be defined in the same way as when the precompiled header was
23003 generated, or must not affect the precompiled header, which usually
23004 means that they don't appear in the precompiled header at all.
23006 The @option{-D} option is one way to define a macro before a
23007 precompiled header is included; using a @code{#define} can also do it.
23008 There are also some options that define macros implicitly, like
23009 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23010 defined this way.
23012 @item If debugging information is output when using the precompiled
23013 header, using @option{-g} or similar, the same kind of debugging information
23014 must have been output when building the precompiled header.  However,
23015 a precompiled header built using @option{-g} can be used in a compilation
23016 when no debugging information is being output.
23018 @item The same @option{-m} options must generally be used when building
23019 and using the precompiled header.  @xref{Submodel Options},
23020 for any cases where this rule is relaxed.
23022 @item Each of the following options must be the same when building and using
23023 the precompiled header:
23025 @gccoptlist{-fexceptions}
23027 @item
23028 Some other command-line options starting with @option{-f},
23029 @option{-p}, or @option{-O} must be defined in the same way as when
23030 the precompiled header was generated.  At present, it's not clear
23031 which options are safe to change and which are not; the safest choice
23032 is to use exactly the same options when generating and using the
23033 precompiled header.  The following are known to be safe:
23035 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23036 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23037 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23038 -pedantic-errors}
23040 @end itemize
23042 For all of these except the last, the compiler automatically
23043 ignores the precompiled header if the conditions aren't met.  If you
23044 find an option combination that doesn't work and doesn't cause the
23045 precompiled header to be ignored, please consider filing a bug report,
23046 see @ref{Bugs}.
23048 If you do use differing options when generating and using the
23049 precompiled header, the actual behavior is a mixture of the
23050 behavior for the options.  For instance, if you use @option{-g} to
23051 generate the precompiled header but not when using it, you may or may
23052 not get debugging information for routines in the precompiled header.