X86-64: Add -mskip-rax-setup
[official-gcc.git] / gcc / doc / invoke.texi
blob9d30212f1c7d21fe4e4e02e672f339622125a952
1 @c Copyright (C) 1988-2013 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2013 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified.  Also,
105 the placement of the @option{-l} option is significant.
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}.  This manual documents
112 only one of these two forms, whichever one is not the default.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
118 @menu
119 * Option Summary::      Brief list of all options, without explanations.
120 * Overall Options::     Controlling the kind of output:
121                         an executable, object files, assembler files,
122                         or preprocessed source.
123 * Invoking G++::        Compiling C++ programs.
124 * C Dialect Options::   Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127                         and Objective-C++.
128 * Language Independent Options:: Controlling how diagnostics should be
129                         formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
161 -pipe  -pass-exit-codes  @gol
162 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
171 -fhosted  -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
172 -trigraphs  -traditional  -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
191 -ftemplate-depth=@var{n} @gol
192 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
193 -fno-default-inline  -fvisibility-inlines-hidden @gol
194 -fvisibility-ms-compat @gol
195 -fext-numeric-literals @gol
196 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
197 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
198 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
199 -Weffc++  -Wstrict-null-sentinel @gol
200 -Wno-non-template-friend  -Wold-style-cast @gol
201 -Woverloaded-virtual  -Wno-pmf-conversions @gol
202 -Wsign-promo}
204 @item Objective-C and Objective-C++ Language Options
205 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
206 Objective-C and Objective-C++ Dialects}.
207 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
208 -fgnu-runtime  -fnext-runtime @gol
209 -fno-nil-receivers @gol
210 -fobjc-abi-version=@var{n} @gol
211 -fobjc-call-cxx-cdtors @gol
212 -fobjc-direct-dispatch @gol
213 -fobjc-exceptions @gol
214 -fobjc-gc @gol
215 -fobjc-nilcheck @gol
216 -fobjc-std=objc1 @gol
217 -freplace-objc-classes @gol
218 -fzero-link @gol
219 -gen-decls @gol
220 -Wassign-intercept @gol
221 -Wno-protocol  -Wselector @gol
222 -Wstrict-selector-match @gol
223 -Wundeclared-selector}
225 @item Language Independent Options
226 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
227 @gccoptlist{-fmessage-length=@var{n}  @gol
228 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
229 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
231 @item Warning Options
232 @xref{Warning Options,,Options to Request or Suppress Warnings}.
233 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
234 -pedantic-errors @gol
235 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
236 -Waggressive-loop-optimizations -Warray-bounds @gol
237 -Wno-attributes -Wno-builtin-macro-redefined @gol
238 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
239 -Wchar-subscripts -Wclobbered  -Wcomment @gol
240 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
241 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
242 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
243 -Wno-endif-labels -Werror  -Werror=* @gol
244 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
245 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
246 -Wformat-security  -Wformat-y2k @gol
247 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
248 -Wignored-qualifiers @gol
249 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
250 -Winit-self  -Winline -Wmaybe-uninitialized @gol
251 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
252 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
253 -Wlogical-op -Wlong-long @gol
254 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
255 -Wmissing-include-dirs @gol
256 -Wno-mudflap @gol
257 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
258 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
259 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
260 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
261 -Wredundant-decls  -Wno-return-local-addr @gol
262 -Wreturn-type  -Wsequence-point  -Wshadow @gol
263 -Wsign-compare  -Wsign-conversion  -Wsizeof-pointer-memaccess @gol
264 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
265 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
266 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
267 -Wmissing-format-attribute @gol
268 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
269 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
270 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
271 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
272 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
273 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
274 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
275 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
276 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
278 @item C and Objective-C-only Warning Options
279 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
280 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
281 -Wold-style-declaration  -Wold-style-definition @gol
282 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
283 -Wdeclaration-after-statement -Wpointer-sign}
285 @item Debugging Options
286 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
287 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
288 -fsanitize=@var{style} @gol
289 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
290 -fdisable-ipa-@var{pass_name} @gol
291 -fdisable-rtl-@var{pass_name} @gol
292 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
293 -fdisable-tree-@var{pass_name} @gol
294 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
295 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
296 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
297 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
298 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
299 -fdump-passes @gol
300 -fdump-statistics @gol
301 -fdump-tree-all @gol
302 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
303 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
304 -fdump-tree-cfg -fdump-tree-alias @gol
305 -fdump-tree-ch @gol
306 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
308 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-nrv -fdump-tree-vect @gol
316 -fdump-tree-sink @gol
317 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
319 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
321 -ftree-vectorizer-verbose=@var{n} @gol
322 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
323 -fdump-final-insns=@var{file} @gol
324 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
325 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
326 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
327 -fenable-@var{kind}-@var{pass} @gol
328 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
329 -fdebug-types-section -fmem-report-wpa @gol
330 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
331 -fopt-info @gol
332 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
333 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
334 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
335 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
336 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
337 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
338 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
339 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
340 -gvms  -gxcoff  -gxcoff+ @gol
341 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
342 -fdebug-prefix-map=@var{old}=@var{new} @gol
343 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
344 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
345 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
346 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
347 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
348 -print-sysroot -print-sysroot-headers-suffix @gol
349 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
351 @item Optimization Options
352 @xref{Optimize Options,,Options that Control Optimization}.
353 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
354 -falign-jumps[=@var{n}] @gol
355 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
356 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
357 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
358 -fbtr-bb-exclusive -fcaller-saves @gol
359 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
360 -fcompare-elim -fcprop-registers -fcrossjumping @gol
361 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
362 -fcx-limited-range @gol
363 -fdata-sections -fdce -fdelayed-branch @gol
364 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
365 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
366 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
367 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
368 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
369 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
370 -fif-conversion2 -findirect-inlining @gol
371 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
372 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
373 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
374 -fira-algorithm=@var{algorithm} @gol
375 -fira-region=@var{region} -fira-hoist-pressure @gol
376 -fira-loop-pressure -fno-ira-share-save-slots @gol
377 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
378 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
379 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
380 -floop-parallelize-all -flto -flto-compression-level @gol
381 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
382 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
383 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
384 -fno-default-inline @gol
385 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
386 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
387 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
388 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
389 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
390 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
391 -fprefetch-loop-arrays -fprofile-report @gol
392 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
393 -fprofile-generate=@var{path} @gol
394 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
395 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
396 -freorder-blocks-and-partition -freorder-functions @gol
397 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
398 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
399 -fsched-spec-load -fsched-spec-load-dangerous @gol
400 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
401 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
402 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
403 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
404 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
405 -fselective-scheduling -fselective-scheduling2 @gol
406 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
407 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
408 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
409 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
410 -fthread-jumps -ftracer -ftree-bit-ccp @gol
411 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
412 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
413 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
414 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
415 -ftree-loop-if-convert-stores -ftree-loop-im @gol
416 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
417 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
418 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
419 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
420 -ftree-switch-conversion -ftree-tail-merge @gol
421 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
422 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
423 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
424 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
425 -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
426 --param @var{name}=@var{value}
427 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
429 @item Preprocessor Options
430 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
431 @gccoptlist{-A@var{question}=@var{answer} @gol
432 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
433 -C  -dD  -dI  -dM  -dN @gol
434 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
435 -idirafter @var{dir} @gol
436 -include @var{file}  -imacros @var{file} @gol
437 -iprefix @var{file}  -iwithprefix @var{dir} @gol
438 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
439 -imultilib @var{dir} -isysroot @var{dir} @gol
440 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
441 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
442 -remap -trigraphs  -undef  -U@var{macro}  @gol
443 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
445 @item Assembler Option
446 @xref{Assembler Options,,Passing Options to the Assembler}.
447 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
449 @item Linker Options
450 @xref{Link Options,,Options for Linking}.
451 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
452 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
453 -s  -static -static-libgcc -static-libstdc++ @gol
454 -static-libasan -static-libtsan @gol
455 -shared -shared-libgcc  -symbolic @gol
456 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
457 -u @var{symbol}}
459 @item Directory Options
460 @xref{Directory Options,,Options for Directory Search}.
461 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
462 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
463 --sysroot=@var{dir} --no-sysroot-suffix}
465 @item Machine Dependent Options
466 @xref{Submodel Options,,Hardware Models and Configurations}.
467 @c This list is ordered alphanumerically by subsection name.
468 @c Try and put the significant identifier (CPU or system) first,
469 @c so users have a clue at guessing where the ones they want will be.
471 @emph{AArch64 Options}
472 @gccoptlist{-mbig-endian  -mlittle-endian @gol
473 -mgeneral-regs-only @gol
474 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
475 -mstrict-align @gol
476 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
477 -mtls-dialect=desc  -mtls-dialect=traditional @gol
478 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
479 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
481 @emph{Adapteva Epiphany Options}
482 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
483 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
484 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
485 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
486 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
487 -msplit-vecmove-early -m1reg-@var{reg}}
489 @emph{ARM Options}
490 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
491 -mabi=@var{name} @gol
492 -mapcs-stack-check  -mno-apcs-stack-check @gol
493 -mapcs-float  -mno-apcs-float @gol
494 -mapcs-reentrant  -mno-apcs-reentrant @gol
495 -msched-prolog  -mno-sched-prolog @gol
496 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
497 -mfloat-abi=@var{name} @gol
498 -mfp16-format=@var{name}
499 -mthumb-interwork  -mno-thumb-interwork @gol
500 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
501 -mstructure-size-boundary=@var{n} @gol
502 -mabort-on-noreturn @gol
503 -mlong-calls  -mno-long-calls @gol
504 -msingle-pic-base  -mno-single-pic-base @gol
505 -mpic-register=@var{reg} @gol
506 -mnop-fun-dllimport @gol
507 -mpoke-function-name @gol
508 -mthumb  -marm @gol
509 -mtpcs-frame  -mtpcs-leaf-frame @gol
510 -mcaller-super-interworking  -mcallee-super-interworking @gol
511 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
512 -mword-relocations @gol
513 -mfix-cortex-m3-ldrd @gol
514 -munaligned-access}
516 @emph{AVR Options}
517 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
518 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
519 -mstrict-X -mtiny-stack -Waddr-space-convert}
521 @emph{Blackfin Options}
522 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
523 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
524 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
525 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
526 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
527 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
528 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
529 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
530 -micplb}
532 @emph{C6X Options}
533 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
534 -msim -msdata=@var{sdata-type}}
536 @emph{CRIS Options}
537 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
538 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
539 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
540 -mstack-align  -mdata-align  -mconst-align @gol
541 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
542 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
543 -mmul-bug-workaround  -mno-mul-bug-workaround}
545 @emph{CR16 Options}
546 @gccoptlist{-mmac @gol
547 -mcr16cplus -mcr16c @gol
548 -msim -mint32 -mbit-ops
549 -mdata-model=@var{model}}
551 @emph{Darwin Options}
552 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
553 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
554 -client_name  -compatibility_version  -current_version @gol
555 -dead_strip @gol
556 -dependency-file  -dylib_file  -dylinker_install_name @gol
557 -dynamic  -dynamiclib  -exported_symbols_list @gol
558 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
559 -force_flat_namespace  -headerpad_max_install_names @gol
560 -iframework @gol
561 -image_base  -init  -install_name  -keep_private_externs @gol
562 -multi_module  -multiply_defined  -multiply_defined_unused @gol
563 -noall_load   -no_dead_strip_inits_and_terms @gol
564 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
565 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
566 -private_bundle  -read_only_relocs  -sectalign @gol
567 -sectobjectsymbols  -whyload  -seg1addr @gol
568 -sectcreate  -sectobjectsymbols  -sectorder @gol
569 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
570 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
571 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
572 -single_module  -static  -sub_library  -sub_umbrella @gol
573 -twolevel_namespace  -umbrella  -undefined @gol
574 -unexported_symbols_list  -weak_reference_mismatches @gol
575 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
576 -mkernel -mone-byte-bool}
578 @emph{DEC Alpha Options}
579 @gccoptlist{-mno-fp-regs  -msoft-float @gol
580 -mieee  -mieee-with-inexact  -mieee-conformant @gol
581 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
582 -mtrap-precision=@var{mode}  -mbuild-constants @gol
583 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
584 -mbwx  -mmax  -mfix  -mcix @gol
585 -mfloat-vax  -mfloat-ieee @gol
586 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
587 -msmall-text  -mlarge-text @gol
588 -mmemory-latency=@var{time}}
590 @emph{FR30 Options}
591 @gccoptlist{-msmall-model -mno-lsim}
593 @emph{FRV Options}
594 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
595 -mhard-float  -msoft-float @gol
596 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
597 -mdouble  -mno-double @gol
598 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
599 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
600 -mlinked-fp  -mlong-calls  -malign-labels @gol
601 -mlibrary-pic  -macc-4  -macc-8 @gol
602 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
603 -moptimize-membar -mno-optimize-membar @gol
604 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
605 -mvliw-branch  -mno-vliw-branch @gol
606 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
607 -mno-nested-cond-exec  -mtomcat-stats @gol
608 -mTLS -mtls @gol
609 -mcpu=@var{cpu}}
611 @emph{GNU/Linux Options}
612 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
613 -tno-android-cc -tno-android-ld}
615 @emph{H8/300 Options}
616 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
618 @emph{HPPA Options}
619 @gccoptlist{-march=@var{architecture-type} @gol
620 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
621 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
622 -mfixed-range=@var{register-range} @gol
623 -mjump-in-delay -mlinker-opt -mlong-calls @gol
624 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
625 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
626 -mno-jump-in-delay  -mno-long-load-store @gol
627 -mno-portable-runtime  -mno-soft-float @gol
628 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
629 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
630 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
631 -munix=@var{unix-std}  -nolibdld  -static  -threads}
633 @emph{i386 and x86-64 Options}
634 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
635 -mfpmath=@var{unit} @gol
636 -masm=@var{dialect}  -mno-fancy-math-387 @gol
637 -mno-fp-ret-in-387  -msoft-float @gol
638 -mno-wide-multiply  -mrtd  -malign-double @gol
639 -mpreferred-stack-boundary=@var{num} @gol
640 -mincoming-stack-boundary=@var{num} @gol
641 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
642 -mrecip -mrecip=@var{opt} @gol
643 -mvzeroupper -mprefer-avx128 @gol
644 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
645 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
646 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
647 -mbmi2 -mrtm -mlwp -mthreads @gol
648 -mno-align-stringops  -minline-all-stringops @gol
649 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
650 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
651 -m96bit-long-double -mlong-double-64 -mlong-double-80 @gol
652 -mregparm=@var{num}  -msseregparm @gol
653 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
654 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
655 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
656 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
657 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
658 -msse2avx -mfentry -m8bit-idiv @gol
659 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
661 @emph{i386 and x86-64 Windows Options}
662 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
663 -mnop-fun-dllimport -mthread @gol
664 -municode -mwin32 -mwindows -fno-set-stack-executable}
666 @emph{IA-64 Options}
667 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
668 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
669 -mconstant-gp  -mauto-pic  -mfused-madd @gol
670 -minline-float-divide-min-latency @gol
671 -minline-float-divide-max-throughput @gol
672 -mno-inline-float-divide @gol
673 -minline-int-divide-min-latency @gol
674 -minline-int-divide-max-throughput  @gol
675 -mno-inline-int-divide @gol
676 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
677 -mno-inline-sqrt @gol
678 -mdwarf2-asm -mearly-stop-bits @gol
679 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
680 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
681 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
682 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
683 -msched-spec-ldc -msched-spec-control-ldc @gol
684 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
685 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
686 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
687 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
689 @emph{LM32 Options}
690 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
691 -msign-extend-enabled -muser-enabled}
693 @emph{M32R/D Options}
694 @gccoptlist{-m32r2 -m32rx -m32r @gol
695 -mdebug @gol
696 -malign-loops -mno-align-loops @gol
697 -missue-rate=@var{number} @gol
698 -mbranch-cost=@var{number} @gol
699 -mmodel=@var{code-size-model-type} @gol
700 -msdata=@var{sdata-type} @gol
701 -mno-flush-func -mflush-func=@var{name} @gol
702 -mno-flush-trap -mflush-trap=@var{number} @gol
703 -G @var{num}}
705 @emph{M32C Options}
706 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
708 @emph{M680x0 Options}
709 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
710 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
711 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
712 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
713 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
714 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
715 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
716 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
717 -mxgot -mno-xgot}
719 @emph{MCore Options}
720 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
721 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
722 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
723 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
724 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
726 @emph{MeP Options}
727 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
728 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
729 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
730 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
731 -mtiny=@var{n}}
733 @emph{MicroBlaze Options}
734 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
735 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
736 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
737 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
738 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
740 @emph{MIPS Options}
741 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
742 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
743 -mips64  -mips64r2 @gol
744 -mips16  -mno-mips16  -mflip-mips16 @gol
745 -minterlink-mips16  -mno-interlink-mips16 @gol
746 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
747 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
748 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
749 -mno-float -msingle-float  -mdouble-float  @gol
750 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
751 -mmcu -mmno-mcu @gol
752 -mfpu=@var{fpu-type} @gol
753 -msmartmips  -mno-smartmips @gol
754 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
755 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
756 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
757 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
758 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
759 -membedded-data  -mno-embedded-data @gol
760 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
761 -mcode-readable=@var{setting} @gol
762 -msplit-addresses  -mno-split-addresses @gol
763 -mexplicit-relocs  -mno-explicit-relocs @gol
764 -mcheck-zero-division  -mno-check-zero-division @gol
765 -mdivide-traps  -mdivide-breaks @gol
766 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
767 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
768 -mfix-24k -mno-fix-24k @gol
769 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
770 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
771 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
772 -mflush-func=@var{func}  -mno-flush-func @gol
773 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
774 -mfp-exceptions -mno-fp-exceptions @gol
775 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
776 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
778 @emph{MMIX Options}
779 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
780 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
781 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
782 -mno-base-addresses  -msingle-exit  -mno-single-exit}
784 @emph{MN10300 Options}
785 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
786 -mno-am33 -mam33 -mam33-2 -mam34 @gol
787 -mtune=@var{cpu-type} @gol
788 -mreturn-pointer-on-d0 @gol
789 -mno-crt0  -mrelax -mliw -msetlb}
791 @emph{Moxie Options}
792 @gccoptlist{-meb -mel -mno-crt0}
794 @emph{PDP-11 Options}
795 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
796 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
797 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
798 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
799 -mbranch-expensive  -mbranch-cheap @gol
800 -munix-asm  -mdec-asm}
802 @emph{picoChip Options}
803 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
804 -msymbol-as-address -mno-inefficient-warnings}
806 @emph{PowerPC Options}
807 See RS/6000 and PowerPC Options.
809 @emph{RL78 Options}
810 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
812 @emph{RS/6000 and PowerPC Options}
813 @gccoptlist{-mcpu=@var{cpu-type} @gol
814 -mtune=@var{cpu-type} @gol
815 -mcmodel=@var{code-model} @gol
816 -mpowerpc64 @gol
817 -maltivec  -mno-altivec @gol
818 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
819 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
820 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
821 -mfprnd  -mno-fprnd @gol
822 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
823 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
824 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
825 -malign-power  -malign-natural @gol
826 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
827 -msingle-float -mdouble-float -msimple-fpu @gol
828 -mstring  -mno-string  -mupdate  -mno-update @gol
829 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
830 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
831 -mstrict-align  -mno-strict-align  -mrelocatable @gol
832 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
833 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
834 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
835 -mprioritize-restricted-insns=@var{priority} @gol
836 -msched-costly-dep=@var{dependence_type} @gol
837 -minsert-sched-nops=@var{scheme} @gol
838 -mcall-sysv  -mcall-netbsd @gol
839 -maix-struct-return  -msvr4-struct-return @gol
840 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
841 -mblock-move-inline-limit=@var{num} @gol
842 -misel -mno-isel @gol
843 -misel=yes  -misel=no @gol
844 -mspe -mno-spe @gol
845 -mspe=yes  -mspe=no @gol
846 -mpaired @gol
847 -mgen-cell-microcode -mwarn-cell-microcode @gol
848 -mvrsave -mno-vrsave @gol
849 -mmulhw -mno-mulhw @gol
850 -mdlmzb -mno-dlmzb @gol
851 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
852 -mprototype  -mno-prototype @gol
853 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
854 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
855 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
856 -mno-recip-precision @gol
857 -mveclibabi=@var{type} -mfriz -mno-friz @gol
858 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
859 -msave-toc-indirect -mno-save-toc-indirect @gol
860 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
861 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
862 -mquad-memory -mno-quad-memory @gol
863 -mquad-memory-atomic -mno-quad-memory-atomic @gol
864 -mcompat-align-parm -mno-compat-align-parm}
866 @emph{RX Options}
867 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
868 -mcpu=@gol
869 -mbig-endian-data -mlittle-endian-data @gol
870 -msmall-data @gol
871 -msim  -mno-sim@gol
872 -mas100-syntax -mno-as100-syntax@gol
873 -mrelax@gol
874 -mmax-constant-size=@gol
875 -mint-register=@gol
876 -mpid@gol
877 -mno-warn-multiple-fast-interrupts@gol
878 -msave-acc-in-interrupts}
880 @emph{S/390 and zSeries Options}
881 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
882 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
883 -mlong-double-64 -mlong-double-128 @gol
884 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
885 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
886 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
887 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
888 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
889 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
891 @emph{Score Options}
892 @gccoptlist{-meb -mel @gol
893 -mnhwloop @gol
894 -muls @gol
895 -mmac @gol
896 -mscore5 -mscore5u -mscore7 -mscore7d}
898 @emph{SH Options}
899 @gccoptlist{-m1  -m2  -m2e @gol
900 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
901 -m3  -m3e @gol
902 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
903 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
904 -m5-64media  -m5-64media-nofpu @gol
905 -m5-32media  -m5-32media-nofpu @gol
906 -m5-compact  -m5-compact-nofpu @gol
907 -mb  -ml  -mdalign  -mrelax @gol
908 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
909 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
910 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
911 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
912 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
913 -maccumulate-outgoing-args -minvalid-symbols @gol
914 -matomic-model=@var{atomic-model} @gol
915 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
916 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
917 -mpretend-cmove -mtas}
919 @emph{Solaris 2 Options}
920 @gccoptlist{-mimpure-text  -mno-impure-text @gol
921 -pthreads -pthread}
923 @emph{SPARC Options}
924 @gccoptlist{-mcpu=@var{cpu-type} @gol
925 -mtune=@var{cpu-type} @gol
926 -mcmodel=@var{code-model} @gol
927 -mmemory-model=@var{mem-model} @gol
928 -m32  -m64  -mapp-regs  -mno-app-regs @gol
929 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
930 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
931 -mhard-quad-float  -msoft-quad-float @gol
932 -mstack-bias  -mno-stack-bias @gol
933 -munaligned-doubles  -mno-unaligned-doubles @gol
934 -muser-mode  -mno-user-mode @gol
935 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
936 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
937 -mcbcond -mno-cbcond @gol
938 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
939 -mfix-at697f -mfix-ut699}
941 @emph{SPU Options}
942 @gccoptlist{-mwarn-reloc -merror-reloc @gol
943 -msafe-dma -munsafe-dma @gol
944 -mbranch-hints @gol
945 -msmall-mem -mlarge-mem -mstdmain @gol
946 -mfixed-range=@var{register-range} @gol
947 -mea32 -mea64 @gol
948 -maddress-space-conversion -mno-address-space-conversion @gol
949 -mcache-size=@var{cache-size} @gol
950 -matomic-updates -mno-atomic-updates}
952 @emph{System V Options}
953 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
955 @emph{TILE-Gx Options}
956 @gccoptlist{-mcpu=@var{cpu} -m32 -m64 -mcmodel=@var{code-model}}
958 @emph{TILEPro Options}
959 @gccoptlist{-mcpu=@var{cpu} -m32}
961 @emph{V850 Options}
962 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
963 -mprolog-function  -mno-prolog-function  -mspace @gol
964 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
965 -mapp-regs  -mno-app-regs @gol
966 -mdisable-callt  -mno-disable-callt @gol
967 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
968 -mv850e -mv850 -mv850e3v5 @gol
969 -mloop @gol
970 -mrelax @gol
971 -mlong-jumps @gol
972 -msoft-float @gol
973 -mhard-float @gol
974 -mgcc-abi @gol
975 -mrh850-abi @gol
976 -mbig-switch}
978 @emph{VAX Options}
979 @gccoptlist{-mg  -mgnu  -munix}
981 @emph{VMS Options}
982 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
983 -mpointer-size=@var{size}}
985 @emph{VxWorks Options}
986 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
987 -Xbind-lazy  -Xbind-now}
989 @emph{x86-64 Options}
990 See i386 and x86-64 Options.
992 @emph{Xstormy16 Options}
993 @gccoptlist{-msim}
995 @emph{Xtensa Options}
996 @gccoptlist{-mconst16 -mno-const16 @gol
997 -mfused-madd  -mno-fused-madd @gol
998 -mforce-no-pic @gol
999 -mserialize-volatile  -mno-serialize-volatile @gol
1000 -mtext-section-literals  -mno-text-section-literals @gol
1001 -mtarget-align  -mno-target-align @gol
1002 -mlongcalls  -mno-longcalls}
1004 @emph{zSeries Options}
1005 See S/390 and zSeries Options.
1007 @item Code Generation Options
1008 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1009 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1010 -ffixed-@var{reg}  -fexceptions @gol
1011 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1012 -fasynchronous-unwind-tables @gol
1013 -fno-gnu-unique @gol
1014 -finhibit-size-directive  -finstrument-functions @gol
1015 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1016 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1017 -fno-common  -fno-ident @gol
1018 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1019 -fno-jump-tables @gol
1020 -frecord-gcc-switches @gol
1021 -freg-struct-return  -fshort-enums @gol
1022 -fshort-double  -fshort-wchar @gol
1023 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1024 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1025 -fno-stack-limit -fsplit-stack @gol
1026 -fleading-underscore  -ftls-model=@var{model} @gol
1027 -fstack-reuse=@var{reuse_level} @gol
1028 -ftrapv  -fwrapv  -fbounds-check @gol
1029 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1030 @end table
1032 @menu
1033 * Overall Options::     Controlling the kind of output:
1034                         an executable, object files, assembler files,
1035                         or preprocessed source.
1036 * C Dialect Options::   Controlling the variant of C language compiled.
1037 * C++ Dialect Options:: Variations on C++.
1038 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1039                         and Objective-C++.
1040 * Language Independent Options:: Controlling how diagnostics should be
1041                         formatted.
1042 * Warning Options::     How picky should the compiler be?
1043 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1044 * Optimize Options::    How much optimization?
1045 * Preprocessor Options:: Controlling header files and macro definitions.
1046                          Also, getting dependency information for Make.
1047 * Assembler Options::   Passing options to the assembler.
1048 * Link Options::        Specifying libraries and so on.
1049 * Directory Options::   Where to find header files and libraries.
1050                         Where to find the compiler executable files.
1051 * Spec Files::          How to pass switches to sub-processes.
1052 * Target Options::      Running a cross-compiler, or an old version of GCC.
1053 @end menu
1055 @node Overall Options
1056 @section Options Controlling the Kind of Output
1058 Compilation can involve up to four stages: preprocessing, compilation
1059 proper, assembly and linking, always in that order.  GCC is capable of
1060 preprocessing and compiling several files either into several
1061 assembler input files, or into one assembler input file; then each
1062 assembler input file produces an object file, and linking combines all
1063 the object files (those newly compiled, and those specified as input)
1064 into an executable file.
1066 @cindex file name suffix
1067 For any given input file, the file name suffix determines what kind of
1068 compilation is done:
1070 @table @gcctabopt
1071 @item @var{file}.c
1072 C source code that must be preprocessed.
1074 @item @var{file}.i
1075 C source code that should not be preprocessed.
1077 @item @var{file}.ii
1078 C++ source code that should not be preprocessed.
1080 @item @var{file}.m
1081 Objective-C source code.  Note that you must link with the @file{libobjc}
1082 library to make an Objective-C program work.
1084 @item @var{file}.mi
1085 Objective-C source code that should not be preprocessed.
1087 @item @var{file}.mm
1088 @itemx @var{file}.M
1089 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1090 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1091 to a literal capital M@.
1093 @item @var{file}.mii
1094 Objective-C++ source code that should not be preprocessed.
1096 @item @var{file}.h
1097 C, C++, Objective-C or Objective-C++ header file to be turned into a
1098 precompiled header (default), or C, C++ header file to be turned into an
1099 Ada spec (via the @option{-fdump-ada-spec} switch).
1101 @item @var{file}.cc
1102 @itemx @var{file}.cp
1103 @itemx @var{file}.cxx
1104 @itemx @var{file}.cpp
1105 @itemx @var{file}.CPP
1106 @itemx @var{file}.c++
1107 @itemx @var{file}.C
1108 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1109 the last two letters must both be literally @samp{x}.  Likewise,
1110 @samp{.C} refers to a literal capital C@.
1112 @item @var{file}.mm
1113 @itemx @var{file}.M
1114 Objective-C++ source code that must be preprocessed.
1116 @item @var{file}.mii
1117 Objective-C++ source code that should not be preprocessed.
1119 @item @var{file}.hh
1120 @itemx @var{file}.H
1121 @itemx @var{file}.hp
1122 @itemx @var{file}.hxx
1123 @itemx @var{file}.hpp
1124 @itemx @var{file}.HPP
1125 @itemx @var{file}.h++
1126 @itemx @var{file}.tcc
1127 C++ header file to be turned into a precompiled header or Ada spec.
1129 @item @var{file}.f
1130 @itemx @var{file}.for
1131 @itemx @var{file}.ftn
1132 Fixed form Fortran source code that should not be preprocessed.
1134 @item @var{file}.F
1135 @itemx @var{file}.FOR
1136 @itemx @var{file}.fpp
1137 @itemx @var{file}.FPP
1138 @itemx @var{file}.FTN
1139 Fixed form Fortran source code that must be preprocessed (with the traditional
1140 preprocessor).
1142 @item @var{file}.f90
1143 @itemx @var{file}.f95
1144 @itemx @var{file}.f03
1145 @itemx @var{file}.f08
1146 Free form Fortran source code that should not be preprocessed.
1148 @item @var{file}.F90
1149 @itemx @var{file}.F95
1150 @itemx @var{file}.F03
1151 @itemx @var{file}.F08
1152 Free form Fortran source code that must be preprocessed (with the
1153 traditional preprocessor).
1155 @item @var{file}.go
1156 Go source code.
1158 @c FIXME: Descriptions of Java file types.
1159 @c @var{file}.java
1160 @c @var{file}.class
1161 @c @var{file}.zip
1162 @c @var{file}.jar
1164 @item @var{file}.ads
1165 Ada source code file that contains a library unit declaration (a
1166 declaration of a package, subprogram, or generic, or a generic
1167 instantiation), or a library unit renaming declaration (a package,
1168 generic, or subprogram renaming declaration).  Such files are also
1169 called @dfn{specs}.
1171 @item @var{file}.adb
1172 Ada source code file containing a library unit body (a subprogram or
1173 package body).  Such files are also called @dfn{bodies}.
1175 @c GCC also knows about some suffixes for languages not yet included:
1176 @c Pascal:
1177 @c @var{file}.p
1178 @c @var{file}.pas
1179 @c Ratfor:
1180 @c @var{file}.r
1182 @item @var{file}.s
1183 Assembler code.
1185 @item @var{file}.S
1186 @itemx @var{file}.sx
1187 Assembler code that must be preprocessed.
1189 @item @var{other}
1190 An object file to be fed straight into linking.
1191 Any file name with no recognized suffix is treated this way.
1192 @end table
1194 @opindex x
1195 You can specify the input language explicitly with the @option{-x} option:
1197 @table @gcctabopt
1198 @item -x @var{language}
1199 Specify explicitly the @var{language} for the following input files
1200 (rather than letting the compiler choose a default based on the file
1201 name suffix).  This option applies to all following input files until
1202 the next @option{-x} option.  Possible values for @var{language} are:
1203 @smallexample
1204 c  c-header  cpp-output
1205 c++  c++-header  c++-cpp-output
1206 objective-c  objective-c-header  objective-c-cpp-output
1207 objective-c++ objective-c++-header objective-c++-cpp-output
1208 assembler  assembler-with-cpp
1210 f77  f77-cpp-input f95  f95-cpp-input
1212 java
1213 @end smallexample
1215 @item -x none
1216 Turn off any specification of a language, so that subsequent files are
1217 handled according to their file name suffixes (as they are if @option{-x}
1218 has not been used at all).
1220 @item -pass-exit-codes
1221 @opindex pass-exit-codes
1222 Normally the @command{gcc} program exits with the code of 1 if any
1223 phase of the compiler returns a non-success return code.  If you specify
1224 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1225 the numerically highest error produced by any phase returning an error
1226 indication.  The C, C++, and Fortran front ends return 4 if an internal
1227 compiler error is encountered.
1228 @end table
1230 If you only want some of the stages of compilation, you can use
1231 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1232 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1233 @command{gcc} is to stop.  Note that some combinations (for example,
1234 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1236 @table @gcctabopt
1237 @item -c
1238 @opindex c
1239 Compile or assemble the source files, but do not link.  The linking
1240 stage simply is not done.  The ultimate output is in the form of an
1241 object file for each source file.
1243 By default, the object file name for a source file is made by replacing
1244 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1246 Unrecognized input files, not requiring compilation or assembly, are
1247 ignored.
1249 @item -S
1250 @opindex S
1251 Stop after the stage of compilation proper; do not assemble.  The output
1252 is in the form of an assembler code file for each non-assembler input
1253 file specified.
1255 By default, the assembler file name for a source file is made by
1256 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1258 Input files that don't require compilation are ignored.
1260 @item -E
1261 @opindex E
1262 Stop after the preprocessing stage; do not run the compiler proper.  The
1263 output is in the form of preprocessed source code, which is sent to the
1264 standard output.
1266 Input files that don't require preprocessing are ignored.
1268 @cindex output file option
1269 @item -o @var{file}
1270 @opindex o
1271 Place output in file @var{file}.  This applies to whatever
1272 sort of output is being produced, whether it be an executable file,
1273 an object file, an assembler file or preprocessed C code.
1275 If @option{-o} is not specified, the default is to put an executable
1276 file in @file{a.out}, the object file for
1277 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1278 assembler file in @file{@var{source}.s}, a precompiled header file in
1279 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1280 standard output.
1282 @item -v
1283 @opindex v
1284 Print (on standard error output) the commands executed to run the stages
1285 of compilation.  Also print the version number of the compiler driver
1286 program and of the preprocessor and the compiler proper.
1288 @item -###
1289 @opindex ###
1290 Like @option{-v} except the commands are not executed and arguments
1291 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1292 This is useful for shell scripts to capture the driver-generated command lines.
1294 @item -pipe
1295 @opindex pipe
1296 Use pipes rather than temporary files for communication between the
1297 various stages of compilation.  This fails to work on some systems where
1298 the assembler is unable to read from a pipe; but the GNU assembler has
1299 no trouble.
1301 @item --help
1302 @opindex help
1303 Print (on the standard output) a description of the command-line options
1304 understood by @command{gcc}.  If the @option{-v} option is also specified
1305 then @option{--help} is also passed on to the various processes
1306 invoked by @command{gcc}, so that they can display the command-line options
1307 they accept.  If the @option{-Wextra} option has also been specified
1308 (prior to the @option{--help} option), then command-line options that
1309 have no documentation associated with them are also displayed.
1311 @item --target-help
1312 @opindex target-help
1313 Print (on the standard output) a description of target-specific command-line
1314 options for each tool.  For some targets extra target-specific
1315 information may also be printed.
1317 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1318 Print (on the standard output) a description of the command-line
1319 options understood by the compiler that fit into all specified classes
1320 and qualifiers.  These are the supported classes:
1322 @table @asis
1323 @item @samp{optimizers}
1324 Display all of the optimization options supported by the
1325 compiler.
1327 @item @samp{warnings}
1328 Display all of the options controlling warning messages
1329 produced by the compiler.
1331 @item @samp{target}
1332 Display target-specific options.  Unlike the
1333 @option{--target-help} option however, target-specific options of the
1334 linker and assembler are not displayed.  This is because those
1335 tools do not currently support the extended @option{--help=} syntax.
1337 @item @samp{params}
1338 Display the values recognized by the @option{--param}
1339 option.
1341 @item @var{language}
1342 Display the options supported for @var{language}, where
1343 @var{language} is the name of one of the languages supported in this
1344 version of GCC@.
1346 @item @samp{common}
1347 Display the options that are common to all languages.
1348 @end table
1350 These are the supported qualifiers:
1352 @table @asis
1353 @item @samp{undocumented}
1354 Display only those options that are undocumented.
1356 @item @samp{joined}
1357 Display options taking an argument that appears after an equal
1358 sign in the same continuous piece of text, such as:
1359 @samp{--help=target}.
1361 @item @samp{separate}
1362 Display options taking an argument that appears as a separate word
1363 following the original option, such as: @samp{-o output-file}.
1364 @end table
1366 Thus for example to display all the undocumented target-specific
1367 switches supported by the compiler, use:
1369 @smallexample
1370 --help=target,undocumented
1371 @end smallexample
1373 The sense of a qualifier can be inverted by prefixing it with the
1374 @samp{^} character, so for example to display all binary warning
1375 options (i.e., ones that are either on or off and that do not take an
1376 argument) that have a description, use:
1378 @smallexample
1379 --help=warnings,^joined,^undocumented
1380 @end smallexample
1382 The argument to @option{--help=} should not consist solely of inverted
1383 qualifiers.
1385 Combining several classes is possible, although this usually
1386 restricts the output so much that there is nothing to display.  One
1387 case where it does work, however, is when one of the classes is
1388 @var{target}.  For example, to display all the target-specific
1389 optimization options, use:
1391 @smallexample
1392 --help=target,optimizers
1393 @end smallexample
1395 The @option{--help=} option can be repeated on the command line.  Each
1396 successive use displays its requested class of options, skipping
1397 those that have already been displayed.
1399 If the @option{-Q} option appears on the command line before the
1400 @option{--help=} option, then the descriptive text displayed by
1401 @option{--help=} is changed.  Instead of describing the displayed
1402 options, an indication is given as to whether the option is enabled,
1403 disabled or set to a specific value (assuming that the compiler
1404 knows this at the point where the @option{--help=} option is used).
1406 Here is a truncated example from the ARM port of @command{gcc}:
1408 @smallexample
1409   % gcc -Q -mabi=2 --help=target -c
1410   The following options are target specific:
1411   -mabi=                                2
1412   -mabort-on-noreturn                   [disabled]
1413   -mapcs                                [disabled]
1414 @end smallexample
1416 The output is sensitive to the effects of previous command-line
1417 options, so for example it is possible to find out which optimizations
1418 are enabled at @option{-O2} by using:
1420 @smallexample
1421 -Q -O2 --help=optimizers
1422 @end smallexample
1424 Alternatively you can discover which binary optimizations are enabled
1425 by @option{-O3} by using:
1427 @smallexample
1428 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1429 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1430 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1431 @end smallexample
1433 @item -no-canonical-prefixes
1434 @opindex no-canonical-prefixes
1435 Do not expand any symbolic links, resolve references to @samp{/../}
1436 or @samp{/./}, or make the path absolute when generating a relative
1437 prefix.
1439 @item --version
1440 @opindex version
1441 Display the version number and copyrights of the invoked GCC@.
1443 @item -wrapper
1444 @opindex wrapper
1445 Invoke all subcommands under a wrapper program.  The name of the
1446 wrapper program and its parameters are passed as a comma separated
1447 list.
1449 @smallexample
1450 gcc -c t.c -wrapper gdb,--args
1451 @end smallexample
1453 @noindent
1454 This invokes all subprograms of @command{gcc} under
1455 @samp{gdb --args}, thus the invocation of @command{cc1} is
1456 @samp{gdb --args cc1 @dots{}}.
1458 @item -fplugin=@var{name}.so
1459 Load the plugin code in file @var{name}.so, assumed to be a
1460 shared object to be dlopen'd by the compiler.  The base name of
1461 the shared object file is used to identify the plugin for the
1462 purposes of argument parsing (See
1463 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1464 Each plugin should define the callback functions specified in the
1465 Plugins API.
1467 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1468 Define an argument called @var{key} with a value of @var{value}
1469 for the plugin called @var{name}.
1471 @item -fdump-ada-spec@r{[}-slim@r{]}
1472 @opindex fdump-ada-spec
1473 For C and C++ source and include files, generate corresponding Ada specs.
1474 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1475 GNAT User's Guide}, which provides detailed documentation on this feature.
1477 @item -fada-spec-parent=@var{unit}
1478 @opindex fada-spec-parent
1479 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1480 Ada specs as child units of parent @var{unit}.
1482 @item -fdump-go-spec=@var{file}
1483 @opindex fdump-go-spec
1484 For input files in any language, generate corresponding Go
1485 declarations in @var{file}.  This generates Go @code{const},
1486 @code{type}, @code{var}, and @code{func} declarations which may be a
1487 useful way to start writing a Go interface to code written in some
1488 other language.
1490 @include @value{srcdir}/../libiberty/at-file.texi
1491 @end table
1493 @node Invoking G++
1494 @section Compiling C++ Programs
1496 @cindex suffixes for C++ source
1497 @cindex C++ source file suffixes
1498 C++ source files conventionally use one of the suffixes @samp{.C},
1499 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1500 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1501 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1502 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1503 files with these names and compiles them as C++ programs even if you
1504 call the compiler the same way as for compiling C programs (usually
1505 with the name @command{gcc}).
1507 @findex g++
1508 @findex c++
1509 However, the use of @command{gcc} does not add the C++ library.
1510 @command{g++} is a program that calls GCC and automatically specifies linking
1511 against the C++ library.  It treats @samp{.c},
1512 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1513 files unless @option{-x} is used.  This program is also useful when
1514 precompiling a C header file with a @samp{.h} extension for use in C++
1515 compilations.  On many systems, @command{g++} is also installed with
1516 the name @command{c++}.
1518 @cindex invoking @command{g++}
1519 When you compile C++ programs, you may specify many of the same
1520 command-line options that you use for compiling programs in any
1521 language; or command-line options meaningful for C and related
1522 languages; or options that are meaningful only for C++ programs.
1523 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1524 explanations of options for languages related to C@.
1525 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1526 explanations of options that are meaningful only for C++ programs.
1528 @node C Dialect Options
1529 @section Options Controlling C Dialect
1530 @cindex dialect options
1531 @cindex language dialect options
1532 @cindex options, dialect
1534 The following options control the dialect of C (or languages derived
1535 from C, such as C++, Objective-C and Objective-C++) that the compiler
1536 accepts:
1538 @table @gcctabopt
1539 @cindex ANSI support
1540 @cindex ISO support
1541 @item -ansi
1542 @opindex ansi
1543 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1544 equivalent to @option{-std=c++98}.
1546 This turns off certain features of GCC that are incompatible with ISO
1547 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1548 such as the @code{asm} and @code{typeof} keywords, and
1549 predefined macros such as @code{unix} and @code{vax} that identify the
1550 type of system you are using.  It also enables the undesirable and
1551 rarely used ISO trigraph feature.  For the C compiler,
1552 it disables recognition of C++ style @samp{//} comments as well as
1553 the @code{inline} keyword.
1555 The alternate keywords @code{__asm__}, @code{__extension__},
1556 @code{__inline__} and @code{__typeof__} continue to work despite
1557 @option{-ansi}.  You would not want to use them in an ISO C program, of
1558 course, but it is useful to put them in header files that might be included
1559 in compilations done with @option{-ansi}.  Alternate predefined macros
1560 such as @code{__unix__} and @code{__vax__} are also available, with or
1561 without @option{-ansi}.
1563 The @option{-ansi} option does not cause non-ISO programs to be
1564 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1565 addition to @option{-ansi}.  @xref{Warning Options}.
1567 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1568 option is used.  Some header files may notice this macro and refrain
1569 from declaring certain functions or defining certain macros that the
1570 ISO standard doesn't call for; this is to avoid interfering with any
1571 programs that might use these names for other things.
1573 Functions that are normally built in but do not have semantics
1574 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1575 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1576 built-in functions provided by GCC}, for details of the functions
1577 affected.
1579 @item -std=
1580 @opindex std
1581 Determine the language standard. @xref{Standards,,Language Standards
1582 Supported by GCC}, for details of these standard versions.  This option
1583 is currently only supported when compiling C or C++.
1585 The compiler can accept several base standards, such as @samp{c90} or
1586 @samp{c++98}, and GNU dialects of those standards, such as
1587 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1588 compiler accepts all programs following that standard plus those
1589 using GNU extensions that do not contradict it.  For example,
1590 @option{-std=c90} turns off certain features of GCC that are
1591 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1592 keywords, but not other GNU extensions that do not have a meaning in
1593 ISO C90, such as omitting the middle term of a @code{?:}
1594 expression. On the other hand, when a GNU dialect of a standard is
1595 specified, all features supported by the compiler are enabled, even when
1596 those features change the meaning of the base standard.  As a result, some
1597 strict-conforming programs may be rejected.  The particular standard
1598 is used by @option{-Wpedantic} to identify which features are GNU
1599 extensions given that version of the standard. For example
1600 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1601 comments, while @option{-std=gnu99 -Wpedantic} does not.
1603 A value for this option must be provided; possible values are
1605 @table @samp
1606 @item c90
1607 @itemx c89
1608 @itemx iso9899:1990
1609 Support all ISO C90 programs (certain GNU extensions that conflict
1610 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1612 @item iso9899:199409
1613 ISO C90 as modified in amendment 1.
1615 @item c99
1616 @itemx c9x
1617 @itemx iso9899:1999
1618 @itemx iso9899:199x
1619 ISO C99.  Note that this standard is not yet fully supported; see
1620 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1621 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1623 @item c11
1624 @itemx c1x
1625 @itemx iso9899:2011
1626 ISO C11, the 2011 revision of the ISO C standard.
1627 Support is incomplete and experimental.  The name @samp{c1x} is
1628 deprecated.
1630 @item gnu90
1631 @itemx gnu89
1632 GNU dialect of ISO C90 (including some C99 features). This
1633 is the default for C code.
1635 @item gnu99
1636 @itemx gnu9x
1637 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1638 this will become the default.  The name @samp{gnu9x} is deprecated.
1640 @item gnu11
1641 @itemx gnu1x
1642 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1643 name @samp{gnu1x} is deprecated.
1645 @item c++98
1646 @itemx c++03
1647 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1648 additional defect reports. Same as @option{-ansi} for C++ code.
1650 @item gnu++98
1651 @itemx gnu++03
1652 GNU dialect of @option{-std=c++98}.  This is the default for
1653 C++ code.
1655 @item c++11
1656 @itemx c++0x
1657 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1658 experimental, and may change in incompatible ways in future releases.
1659 The name @samp{c++0x} is deprecated.
1661 @item gnu++11
1662 @itemx gnu++0x
1663 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1664 experimental, and may change in incompatible ways in future releases.
1665 The name @samp{gnu++0x} is deprecated.
1667 @item c++1y
1668 The next revision of the ISO C++ standard, tentatively planned for
1669 2017.  Support is highly experimental, and will almost certainly
1670 change in incompatible ways in future releases.
1672 @item gnu++1y
1673 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1674 and will almost certainly change in incompatible ways in future
1675 releases.
1676 @end table
1678 @item -fgnu89-inline
1679 @opindex fgnu89-inline
1680 The option @option{-fgnu89-inline} tells GCC to use the traditional
1681 GNU semantics for @code{inline} functions when in C99 mode.
1682 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1683 is accepted and ignored by GCC versions 4.1.3 up to but not including
1684 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1685 C99 mode.  Using this option is roughly equivalent to adding the
1686 @code{gnu_inline} function attribute to all inline functions
1687 (@pxref{Function Attributes}).
1689 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1690 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1691 specifies the default behavior).  This option was first supported in
1692 GCC 4.3.  This option is not supported in @option{-std=c90} or
1693 @option{-std=gnu90} mode.
1695 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1696 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1697 in effect for @code{inline} functions.  @xref{Common Predefined
1698 Macros,,,cpp,The C Preprocessor}.
1700 @item -aux-info @var{filename}
1701 @opindex aux-info
1702 Output to the given filename prototyped declarations for all functions
1703 declared and/or defined in a translation unit, including those in header
1704 files.  This option is silently ignored in any language other than C@.
1706 Besides declarations, the file indicates, in comments, the origin of
1707 each declaration (source file and line), whether the declaration was
1708 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1709 @samp{O} for old, respectively, in the first character after the line
1710 number and the colon), and whether it came from a declaration or a
1711 definition (@samp{C} or @samp{F}, respectively, in the following
1712 character).  In the case of function definitions, a K&R-style list of
1713 arguments followed by their declarations is also provided, inside
1714 comments, after the declaration.
1716 @item -fallow-parameterless-variadic-functions
1717 Accept variadic functions without named parameters.
1719 Although it is possible to define such a function, this is not very
1720 useful as it is not possible to read the arguments.  This is only
1721 supported for C as this construct is allowed by C++.
1723 @item -fno-asm
1724 @opindex fno-asm
1725 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1726 keyword, so that code can use these words as identifiers.  You can use
1727 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1728 instead.  @option{-ansi} implies @option{-fno-asm}.
1730 In C++, this switch only affects the @code{typeof} keyword, since
1731 @code{asm} and @code{inline} are standard keywords.  You may want to
1732 use the @option{-fno-gnu-keywords} flag instead, which has the same
1733 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1734 switch only affects the @code{asm} and @code{typeof} keywords, since
1735 @code{inline} is a standard keyword in ISO C99.
1737 @item -fno-builtin
1738 @itemx -fno-builtin-@var{function}
1739 @opindex fno-builtin
1740 @cindex built-in functions
1741 Don't recognize built-in functions that do not begin with
1742 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1743 functions provided by GCC}, for details of the functions affected,
1744 including those which are not built-in functions when @option{-ansi} or
1745 @option{-std} options for strict ISO C conformance are used because they
1746 do not have an ISO standard meaning.
1748 GCC normally generates special code to handle certain built-in functions
1749 more efficiently; for instance, calls to @code{alloca} may become single
1750 instructions which adjust the stack directly, and calls to @code{memcpy}
1751 may become inline copy loops.  The resulting code is often both smaller
1752 and faster, but since the function calls no longer appear as such, you
1753 cannot set a breakpoint on those calls, nor can you change the behavior
1754 of the functions by linking with a different library.  In addition,
1755 when a function is recognized as a built-in function, GCC may use
1756 information about that function to warn about problems with calls to
1757 that function, or to generate more efficient code, even if the
1758 resulting code still contains calls to that function.  For example,
1759 warnings are given with @option{-Wformat} for bad calls to
1760 @code{printf} when @code{printf} is built in and @code{strlen} is
1761 known not to modify global memory.
1763 With the @option{-fno-builtin-@var{function}} option
1764 only the built-in function @var{function} is
1765 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1766 function is named that is not built-in in this version of GCC, this
1767 option is ignored.  There is no corresponding
1768 @option{-fbuiltin-@var{function}} option; if you wish to enable
1769 built-in functions selectively when using @option{-fno-builtin} or
1770 @option{-ffreestanding}, you may define macros such as:
1772 @smallexample
1773 #define abs(n)          __builtin_abs ((n))
1774 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1775 @end smallexample
1777 @item -fhosted
1778 @opindex fhosted
1779 @cindex hosted environment
1781 Assert that compilation targets a hosted environment.  This implies
1782 @option{-fbuiltin}.  A hosted environment is one in which the
1783 entire standard library is available, and in which @code{main} has a return
1784 type of @code{int}.  Examples are nearly everything except a kernel.
1785 This is equivalent to @option{-fno-freestanding}.
1787 @item -ffreestanding
1788 @opindex ffreestanding
1789 @cindex hosted environment
1791 Assert that compilation targets a freestanding environment.  This
1792 implies @option{-fno-builtin}.  A freestanding environment
1793 is one in which the standard library may not exist, and program startup may
1794 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1795 This is equivalent to @option{-fno-hosted}.
1797 @xref{Standards,,Language Standards Supported by GCC}, for details of
1798 freestanding and hosted environments.
1800 @item -fopenmp
1801 @opindex fopenmp
1802 @cindex OpenMP parallel
1803 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1804 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1805 compiler generates parallel code according to the OpenMP Application
1806 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1807 implies @option{-pthread}, and thus is only supported on targets that
1808 have support for @option{-pthread}.
1810 @item -fgnu-tm
1811 @opindex fgnu-tm
1812 When the option @option{-fgnu-tm} is specified, the compiler
1813 generates code for the Linux variant of Intel's current Transactional
1814 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1815 an experimental feature whose interface may change in future versions
1816 of GCC, as the official specification changes.  Please note that not
1817 all architectures are supported for this feature.
1819 For more information on GCC's support for transactional memory,
1820 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1821 Transactional Memory Library}.
1823 Note that the transactional memory feature is not supported with
1824 non-call exceptions (@option{-fnon-call-exceptions}).
1826 @item -fms-extensions
1827 @opindex fms-extensions
1828 Accept some non-standard constructs used in Microsoft header files.
1830 In C++ code, this allows member names in structures to be similar
1831 to previous types declarations.
1833 @smallexample
1834 typedef int UOW;
1835 struct ABC @{
1836   UOW UOW;
1838 @end smallexample
1840 Some cases of unnamed fields in structures and unions are only
1841 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1842 fields within structs/unions}, for details.
1844 @item -fplan9-extensions
1845 Accept some non-standard constructs used in Plan 9 code.
1847 This enables @option{-fms-extensions}, permits passing pointers to
1848 structures with anonymous fields to functions that expect pointers to
1849 elements of the type of the field, and permits referring to anonymous
1850 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1851 struct/union fields within structs/unions}, for details.  This is only
1852 supported for C, not C++.
1854 @item -trigraphs
1855 @opindex trigraphs
1856 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1857 options for strict ISO C conformance) implies @option{-trigraphs}.
1859 @cindex traditional C language
1860 @cindex C language, traditional
1861 @item -traditional
1862 @itemx -traditional-cpp
1863 @opindex traditional-cpp
1864 @opindex traditional
1865 Formerly, these options caused GCC to attempt to emulate a pre-standard
1866 C compiler.  They are now only supported with the @option{-E} switch.
1867 The preprocessor continues to support a pre-standard mode.  See the GNU
1868 CPP manual for details.
1870 @item -fcond-mismatch
1871 @opindex fcond-mismatch
1872 Allow conditional expressions with mismatched types in the second and
1873 third arguments.  The value of such an expression is void.  This option
1874 is not supported for C++.
1876 @item -flax-vector-conversions
1877 @opindex flax-vector-conversions
1878 Allow implicit conversions between vectors with differing numbers of
1879 elements and/or incompatible element types.  This option should not be
1880 used for new code.
1882 @item -funsigned-char
1883 @opindex funsigned-char
1884 Let the type @code{char} be unsigned, like @code{unsigned char}.
1886 Each kind of machine has a default for what @code{char} should
1887 be.  It is either like @code{unsigned char} by default or like
1888 @code{signed char} by default.
1890 Ideally, a portable program should always use @code{signed char} or
1891 @code{unsigned char} when it depends on the signedness of an object.
1892 But many programs have been written to use plain @code{char} and
1893 expect it to be signed, or expect it to be unsigned, depending on the
1894 machines they were written for.  This option, and its inverse, let you
1895 make such a program work with the opposite default.
1897 The type @code{char} is always a distinct type from each of
1898 @code{signed char} or @code{unsigned char}, even though its behavior
1899 is always just like one of those two.
1901 @item -fsigned-char
1902 @opindex fsigned-char
1903 Let the type @code{char} be signed, like @code{signed char}.
1905 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1906 the negative form of @option{-funsigned-char}.  Likewise, the option
1907 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1909 @item -fsigned-bitfields
1910 @itemx -funsigned-bitfields
1911 @itemx -fno-signed-bitfields
1912 @itemx -fno-unsigned-bitfields
1913 @opindex fsigned-bitfields
1914 @opindex funsigned-bitfields
1915 @opindex fno-signed-bitfields
1916 @opindex fno-unsigned-bitfields
1917 These options control whether a bit-field is signed or unsigned, when the
1918 declaration does not use either @code{signed} or @code{unsigned}.  By
1919 default, such a bit-field is signed, because this is consistent: the
1920 basic integer types such as @code{int} are signed types.
1921 @end table
1923 @node C++ Dialect Options
1924 @section Options Controlling C++ Dialect
1926 @cindex compiler options, C++
1927 @cindex C++ options, command-line
1928 @cindex options, C++
1929 This section describes the command-line options that are only meaningful
1930 for C++ programs.  You can also use most of the GNU compiler options
1931 regardless of what language your program is in.  For example, you
1932 might compile a file @code{firstClass.C} like this:
1934 @smallexample
1935 g++ -g -frepo -O -c firstClass.C
1936 @end smallexample
1938 @noindent
1939 In this example, only @option{-frepo} is an option meant
1940 only for C++ programs; you can use the other options with any
1941 language supported by GCC@.
1943 Here is a list of options that are @emph{only} for compiling C++ programs:
1945 @table @gcctabopt
1947 @item -fabi-version=@var{n}
1948 @opindex fabi-version
1949 Use version @var{n} of the C++ ABI@.  The default is version 2.
1951 Version 0 refers to the version conforming most closely to
1952 the C++ ABI specification.  Therefore, the ABI obtained using version 0
1953 will change in different versions of G++ as ABI bugs are fixed.
1955 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
1957 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.  
1959 Version 3 corrects an error in mangling a constant address as a
1960 template argument.
1962 Version 4, which first appeared in G++ 4.5, implements a standard
1963 mangling for vector types.
1965 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1966 attribute const/volatile on function pointer types, decltype of a
1967 plain decl, and use of a function parameter in the declaration of
1968 another parameter.
1970 Version 6, which first appeared in G++ 4.7, corrects the promotion
1971 behavior of C++11 scoped enums and the mangling of template argument
1972 packs, const/static_cast, prefix ++ and --, and a class scope function
1973 used as a template argument.
1975 See also @option{-Wabi}.
1977 @item -fno-access-control
1978 @opindex fno-access-control
1979 Turn off all access checking.  This switch is mainly useful for working
1980 around bugs in the access control code.
1982 @item -fcheck-new
1983 @opindex fcheck-new
1984 Check that the pointer returned by @code{operator new} is non-null
1985 before attempting to modify the storage allocated.  This check is
1986 normally unnecessary because the C++ standard specifies that
1987 @code{operator new} only returns @code{0} if it is declared
1988 @samp{throw()}, in which case the compiler always checks the
1989 return value even without this option.  In all other cases, when
1990 @code{operator new} has a non-empty exception specification, memory
1991 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1992 @samp{new (nothrow)}.
1994 @item -fconstexpr-depth=@var{n}
1995 @opindex fconstexpr-depth
1996 Set the maximum nested evaluation depth for C++11 constexpr functions
1997 to @var{n}.  A limit is needed to detect endless recursion during
1998 constant expression evaluation.  The minimum specified by the standard
1999 is 512.
2001 @item -fdeduce-init-list
2002 @opindex fdeduce-init-list
2003 Enable deduction of a template type parameter as
2004 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2006 @smallexample
2007 template <class T> auto forward(T t) -> decltype (realfn (t))
2009   return realfn (t);
2012 void f()
2014   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2016 @end smallexample
2018 This deduction was implemented as a possible extension to the
2019 originally proposed semantics for the C++11 standard, but was not part
2020 of the final standard, so it is disabled by default.  This option is
2021 deprecated, and may be removed in a future version of G++.
2023 @item -ffriend-injection
2024 @opindex ffriend-injection
2025 Inject friend functions into the enclosing namespace, so that they are
2026 visible outside the scope of the class in which they are declared.
2027 Friend functions were documented to work this way in the old Annotated
2028 C++ Reference Manual, and versions of G++ before 4.1 always worked
2029 that way.  However, in ISO C++ a friend function that is not declared
2030 in an enclosing scope can only be found using argument dependent
2031 lookup.  This option causes friends to be injected as they were in
2032 earlier releases.
2034 This option is for compatibility, and may be removed in a future
2035 release of G++.
2037 @item -fno-elide-constructors
2038 @opindex fno-elide-constructors
2039 The C++ standard allows an implementation to omit creating a temporary
2040 that is only used to initialize another object of the same type.
2041 Specifying this option disables that optimization, and forces G++ to
2042 call the copy constructor in all cases.
2044 @item -fno-enforce-eh-specs
2045 @opindex fno-enforce-eh-specs
2046 Don't generate code to check for violation of exception specifications
2047 at run time.  This option violates the C++ standard, but may be useful
2048 for reducing code size in production builds, much like defining
2049 @samp{NDEBUG}.  This does not give user code permission to throw
2050 exceptions in violation of the exception specifications; the compiler
2051 still optimizes based on the specifications, so throwing an
2052 unexpected exception results in undefined behavior at run time.
2054 @item -fextern-tls-init
2055 @itemx -fno-extern-tls-init
2056 @opindex fextern-tls-init
2057 @opindex fno-extern-tls-init
2058 The C++11 and OpenMP standards allow @samp{thread_local} and
2059 @samp{threadprivate} variables to have dynamic (runtime)
2060 initialization.  To support this, any use of such a variable goes
2061 through a wrapper function that performs any necessary initialization.
2062 When the use and definition of the variable are in the same
2063 translation unit, this overhead can be optimized away, but when the
2064 use is in a different translation unit there is significant overhead
2065 even if the variable doesn't actually need dynamic initialization.  If
2066 the programmer can be sure that no use of the variable in a
2067 non-defining TU needs to trigger dynamic initialization (either
2068 because the variable is statically initialized, or a use of the
2069 variable in the defining TU will be executed before any uses in
2070 another TU), they can avoid this overhead with the
2071 @option{-fno-extern-tls-init} option.
2073 On targets that support symbol aliases, the default is
2074 @option{-fextern-tls-init}.  On targets that do not support symbol
2075 aliases, the default is @option{-fno-extern-tls-init}.
2077 @item -ffor-scope
2078 @itemx -fno-for-scope
2079 @opindex ffor-scope
2080 @opindex fno-for-scope
2081 If @option{-ffor-scope} is specified, the scope of variables declared in
2082 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2083 as specified by the C++ standard.
2084 If @option{-fno-for-scope} is specified, the scope of variables declared in
2085 a @i{for-init-statement} extends to the end of the enclosing scope,
2086 as was the case in old versions of G++, and other (traditional)
2087 implementations of C++.
2089 If neither flag is given, the default is to follow the standard,
2090 but to allow and give a warning for old-style code that would
2091 otherwise be invalid, or have different behavior.
2093 @item -fno-gnu-keywords
2094 @opindex fno-gnu-keywords
2095 Do not recognize @code{typeof} as a keyword, so that code can use this
2096 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2097 @option{-ansi} implies @option{-fno-gnu-keywords}.
2099 @item -fno-implicit-templates
2100 @opindex fno-implicit-templates
2101 Never emit code for non-inline templates that are instantiated
2102 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2103 @xref{Template Instantiation}, for more information.
2105 @item -fno-implicit-inline-templates
2106 @opindex fno-implicit-inline-templates
2107 Don't emit code for implicit instantiations of inline templates, either.
2108 The default is to handle inlines differently so that compiles with and
2109 without optimization need the same set of explicit instantiations.
2111 @item -fno-implement-inlines
2112 @opindex fno-implement-inlines
2113 To save space, do not emit out-of-line copies of inline functions
2114 controlled by @samp{#pragma implementation}.  This causes linker
2115 errors if these functions are not inlined everywhere they are called.
2117 @item -fms-extensions
2118 @opindex fms-extensions
2119 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2120 int and getting a pointer to member function via non-standard syntax.
2122 @item -fno-nonansi-builtins
2123 @opindex fno-nonansi-builtins
2124 Disable built-in declarations of functions that are not mandated by
2125 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2126 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2128 @item -fnothrow-opt
2129 @opindex fnothrow-opt
2130 Treat a @code{throw()} exception specification as if it were a
2131 @code{noexcept} specification to reduce or eliminate the text size
2132 overhead relative to a function with no exception specification.  If
2133 the function has local variables of types with non-trivial
2134 destructors, the exception specification actually makes the
2135 function smaller because the EH cleanups for those variables can be
2136 optimized away.  The semantic effect is that an exception thrown out of
2137 a function with such an exception specification results in a call
2138 to @code{terminate} rather than @code{unexpected}.
2140 @item -fno-operator-names
2141 @opindex fno-operator-names
2142 Do not treat the operator name keywords @code{and}, @code{bitand},
2143 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2144 synonyms as keywords.
2146 @item -fno-optional-diags
2147 @opindex fno-optional-diags
2148 Disable diagnostics that the standard says a compiler does not need to
2149 issue.  Currently, the only such diagnostic issued by G++ is the one for
2150 a name having multiple meanings within a class.
2152 @item -fpermissive
2153 @opindex fpermissive
2154 Downgrade some diagnostics about nonconformant code from errors to
2155 warnings.  Thus, using @option{-fpermissive} allows some
2156 nonconforming code to compile.
2158 @item -fno-pretty-templates
2159 @opindex fno-pretty-templates
2160 When an error message refers to a specialization of a function
2161 template, the compiler normally prints the signature of the
2162 template followed by the template arguments and any typedefs or
2163 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2164 rather than @code{void f(int)}) so that it's clear which template is
2165 involved.  When an error message refers to a specialization of a class
2166 template, the compiler omits any template arguments that match
2167 the default template arguments for that template.  If either of these
2168 behaviors make it harder to understand the error message rather than
2169 easier, you can use @option{-fno-pretty-templates} to disable them.
2171 @item -frepo
2172 @opindex frepo
2173 Enable automatic template instantiation at link time.  This option also
2174 implies @option{-fno-implicit-templates}.  @xref{Template
2175 Instantiation}, for more information.
2177 @item -fno-rtti
2178 @opindex fno-rtti
2179 Disable generation of information about every class with virtual
2180 functions for use by the C++ run-time type identification features
2181 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2182 of the language, you can save some space by using this flag.  Note that
2183 exception handling uses the same information, but G++ generates it as
2184 needed. The @samp{dynamic_cast} operator can still be used for casts that
2185 do not require run-time type information, i.e.@: casts to @code{void *} or to
2186 unambiguous base classes.
2188 @item -fstats
2189 @opindex fstats
2190 Emit statistics about front-end processing at the end of the compilation.
2191 This information is generally only useful to the G++ development team.
2193 @item -fstrict-enums
2194 @opindex fstrict-enums
2195 Allow the compiler to optimize using the assumption that a value of
2196 enumerated type can only be one of the values of the enumeration (as
2197 defined in the C++ standard; basically, a value that can be
2198 represented in the minimum number of bits needed to represent all the
2199 enumerators).  This assumption may not be valid if the program uses a
2200 cast to convert an arbitrary integer value to the enumerated type.
2202 @item -ftemplate-backtrace-limit=@var{n}
2203 @opindex ftemplate-backtrace-limit
2204 Set the maximum number of template instantiation notes for a single
2205 warning or error to @var{n}.  The default value is 10.
2207 @item -ftemplate-depth=@var{n}
2208 @opindex ftemplate-depth
2209 Set the maximum instantiation depth for template classes to @var{n}.
2210 A limit on the template instantiation depth is needed to detect
2211 endless recursions during template class instantiation.  ANSI/ISO C++
2212 conforming programs must not rely on a maximum depth greater than 17
2213 (changed to 1024 in C++11).  The default value is 900, as the compiler
2214 can run out of stack space before hitting 1024 in some situations.
2216 @item -fno-threadsafe-statics
2217 @opindex fno-threadsafe-statics
2218 Do not emit the extra code to use the routines specified in the C++
2219 ABI for thread-safe initialization of local statics.  You can use this
2220 option to reduce code size slightly in code that doesn't need to be
2221 thread-safe.
2223 @item -fuse-cxa-atexit
2224 @opindex fuse-cxa-atexit
2225 Register destructors for objects with static storage duration with the
2226 @code{__cxa_atexit} function rather than the @code{atexit} function.
2227 This option is required for fully standards-compliant handling of static
2228 destructors, but only works if your C library supports
2229 @code{__cxa_atexit}.
2231 @item -fno-use-cxa-get-exception-ptr
2232 @opindex fno-use-cxa-get-exception-ptr
2233 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2234 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2235 if the runtime routine is not available.
2237 @item -fvisibility-inlines-hidden
2238 @opindex fvisibility-inlines-hidden
2239 This switch declares that the user does not attempt to compare
2240 pointers to inline functions or methods where the addresses of the two functions
2241 are taken in different shared objects.
2243 The effect of this is that GCC may, effectively, mark inline methods with
2244 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2245 appear in the export table of a DSO and do not require a PLT indirection
2246 when used within the DSO@.  Enabling this option can have a dramatic effect
2247 on load and link times of a DSO as it massively reduces the size of the
2248 dynamic export table when the library makes heavy use of templates.
2250 The behavior of this switch is not quite the same as marking the
2251 methods as hidden directly, because it does not affect static variables
2252 local to the function or cause the compiler to deduce that
2253 the function is defined in only one shared object.
2255 You may mark a method as having a visibility explicitly to negate the
2256 effect of the switch for that method.  For example, if you do want to
2257 compare pointers to a particular inline method, you might mark it as
2258 having default visibility.  Marking the enclosing class with explicit
2259 visibility has no effect.
2261 Explicitly instantiated inline methods are unaffected by this option
2262 as their linkage might otherwise cross a shared library boundary.
2263 @xref{Template Instantiation}.
2265 @item -fvisibility-ms-compat
2266 @opindex fvisibility-ms-compat
2267 This flag attempts to use visibility settings to make GCC's C++
2268 linkage model compatible with that of Microsoft Visual Studio.
2270 The flag makes these changes to GCC's linkage model:
2272 @enumerate
2273 @item
2274 It sets the default visibility to @code{hidden}, like
2275 @option{-fvisibility=hidden}.
2277 @item
2278 Types, but not their members, are not hidden by default.
2280 @item
2281 The One Definition Rule is relaxed for types without explicit
2282 visibility specifications that are defined in more than one
2283 shared object: those declarations are permitted if they are
2284 permitted when this option is not used.
2285 @end enumerate
2287 In new code it is better to use @option{-fvisibility=hidden} and
2288 export those classes that are intended to be externally visible.
2289 Unfortunately it is possible for code to rely, perhaps accidentally,
2290 on the Visual Studio behavior.
2292 Among the consequences of these changes are that static data members
2293 of the same type with the same name but defined in different shared
2294 objects are different, so changing one does not change the other;
2295 and that pointers to function members defined in different shared
2296 objects may not compare equal.  When this flag is given, it is a
2297 violation of the ODR to define types with the same name differently.
2299 @item -fno-weak
2300 @opindex fno-weak
2301 Do not use weak symbol support, even if it is provided by the linker.
2302 By default, G++ uses weak symbols if they are available.  This
2303 option exists only for testing, and should not be used by end-users;
2304 it results in inferior code and has no benefits.  This option may
2305 be removed in a future release of G++.
2307 @item -nostdinc++
2308 @opindex nostdinc++
2309 Do not search for header files in the standard directories specific to
2310 C++, but do still search the other standard directories.  (This option
2311 is used when building the C++ library.)
2312 @end table
2314 In addition, these optimization, warning, and code generation options
2315 have meanings only for C++ programs:
2317 @table @gcctabopt
2318 @item -fno-default-inline
2319 @opindex fno-default-inline
2320 Do not assume @samp{inline} for functions defined inside a class scope.
2321 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2322 functions have linkage like inline functions; they just aren't
2323 inlined by default.
2325 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2326 @opindex Wabi
2327 @opindex Wno-abi
2328 Warn when G++ generates code that is probably not compatible with the
2329 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2330 all such cases, there are probably some cases that are not warned about,
2331 even though G++ is generating incompatible code.  There may also be
2332 cases where warnings are emitted even though the code that is generated
2333 is compatible.
2335 You should rewrite your code to avoid these warnings if you are
2336 concerned about the fact that code generated by G++ may not be binary
2337 compatible with code generated by other compilers.
2339 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2341 @itemize @bullet
2343 @item
2344 A template with a non-type template parameter of reference type is
2345 mangled incorrectly:
2346 @smallexample
2347 extern int N;
2348 template <int &> struct S @{@};
2349 void n (S<N>) @{2@}
2350 @end smallexample
2352 This is fixed in @option{-fabi-version=3}.
2354 @item
2355 SIMD vector types declared using @code{__attribute ((vector_size))} are
2356 mangled in a non-standard way that does not allow for overloading of
2357 functions taking vectors of different sizes.
2359 The mangling is changed in @option{-fabi-version=4}.
2360 @end itemize
2362 The known incompatibilities in @option{-fabi-version=1} include:
2364 @itemize @bullet
2366 @item
2367 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2368 pack data into the same byte as a base class.  For example:
2370 @smallexample
2371 struct A @{ virtual void f(); int f1 : 1; @};
2372 struct B : public A @{ int f2 : 1; @};
2373 @end smallexample
2375 @noindent
2376 In this case, G++ places @code{B::f2} into the same byte
2377 as @code{A::f1}; other compilers do not.  You can avoid this problem
2378 by explicitly padding @code{A} so that its size is a multiple of the
2379 byte size on your platform; that causes G++ and other compilers to
2380 lay out @code{B} identically.
2382 @item
2383 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2384 tail padding when laying out virtual bases.  For example:
2386 @smallexample
2387 struct A @{ virtual void f(); char c1; @};
2388 struct B @{ B(); char c2; @};
2389 struct C : public A, public virtual B @{@};
2390 @end smallexample
2392 @noindent
2393 In this case, G++ does not place @code{B} into the tail-padding for
2394 @code{A}; other compilers do.  You can avoid this problem by
2395 explicitly padding @code{A} so that its size is a multiple of its
2396 alignment (ignoring virtual base classes); that causes G++ and other
2397 compilers to lay out @code{C} identically.
2399 @item
2400 Incorrect handling of bit-fields with declared widths greater than that
2401 of their underlying types, when the bit-fields appear in a union.  For
2402 example:
2404 @smallexample
2405 union U @{ int i : 4096; @};
2406 @end smallexample
2408 @noindent
2409 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2410 union too small by the number of bits in an @code{int}.
2412 @item
2413 Empty classes can be placed at incorrect offsets.  For example:
2415 @smallexample
2416 struct A @{@};
2418 struct B @{
2419   A a;
2420   virtual void f ();
2423 struct C : public B, public A @{@};
2424 @end smallexample
2426 @noindent
2427 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2428 it should be placed at offset zero.  G++ mistakenly believes that the
2429 @code{A} data member of @code{B} is already at offset zero.
2431 @item
2432 Names of template functions whose types involve @code{typename} or
2433 template template parameters can be mangled incorrectly.
2435 @smallexample
2436 template <typename Q>
2437 void f(typename Q::X) @{@}
2439 template <template <typename> class Q>
2440 void f(typename Q<int>::X) @{@}
2441 @end smallexample
2443 @noindent
2444 Instantiations of these templates may be mangled incorrectly.
2446 @end itemize
2448 It also warns about psABI-related changes.  The known psABI changes at this
2449 point include:
2451 @itemize @bullet
2453 @item
2454 For SysV/x86-64, unions with @code{long double} members are 
2455 passed in memory as specified in psABI.  For example:
2457 @smallexample
2458 union U @{
2459   long double ld;
2460   int i;
2462 @end smallexample
2464 @noindent
2465 @code{union U} is always passed in memory.
2467 @end itemize
2469 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2470 @opindex Wctor-dtor-privacy
2471 @opindex Wno-ctor-dtor-privacy
2472 Warn when a class seems unusable because all the constructors or
2473 destructors in that class are private, and it has neither friends nor
2474 public static member functions.  Also warn if there are no non-private
2475 methods, and there's at least one private member function that isn't
2476 a constructor or destructor.
2478 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2479 @opindex Wdelete-non-virtual-dtor
2480 @opindex Wno-delete-non-virtual-dtor
2481 Warn when @samp{delete} is used to destroy an instance of a class that
2482 has virtual functions and non-virtual destructor. It is unsafe to delete
2483 an instance of a derived class through a pointer to a base class if the
2484 base class does not have a virtual destructor.  This warning is enabled
2485 by @option{-Wall}.
2487 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2488 @opindex Wliteral-suffix
2489 @opindex Wno-literal-suffix
2490 Warn when a string or character literal is followed by a ud-suffix which does
2491 not begin with an underscore.  As a conforming extension, GCC treats such
2492 suffixes as separate preprocessing tokens in order to maintain backwards
2493 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2494 For example:
2496 @smallexample
2497 #define __STDC_FORMAT_MACROS
2498 #include <inttypes.h>
2499 #include <stdio.h>
2501 int main() @{
2502   int64_t i64 = 123;
2503   printf("My int64: %"PRId64"\n", i64);
2505 @end smallexample
2507 In this case, @code{PRId64} is treated as a separate preprocessing token.
2509 This warning is enabled by default.
2511 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2512 @opindex Wnarrowing
2513 @opindex Wno-narrowing
2514 Warn when a narrowing conversion prohibited by C++11 occurs within
2515 @samp{@{ @}}, e.g.
2517 @smallexample
2518 int i = @{ 2.2 @}; // error: narrowing from double to int
2519 @end smallexample
2521 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2523 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2524 required by the standard.  Note that this does not affect the meaning
2525 of well-formed code; narrowing conversions are still considered
2526 ill-formed in SFINAE context.
2528 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2529 @opindex Wnoexcept
2530 @opindex Wno-noexcept
2531 Warn when a noexcept-expression evaluates to false because of a call
2532 to a function that does not have a non-throwing exception
2533 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2534 the compiler to never throw an exception.
2536 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2537 @opindex Wnon-virtual-dtor
2538 @opindex Wno-non-virtual-dtor
2539 Warn when a class has virtual functions and an accessible non-virtual
2540 destructor, in which case it is possible but unsafe to delete
2541 an instance of a derived class through a pointer to the base class.
2542 This warning is also enabled if @option{-Weffc++} is specified.
2544 @item -Wreorder @r{(C++ and Objective-C++ only)}
2545 @opindex Wreorder
2546 @opindex Wno-reorder
2547 @cindex reordering, warning
2548 @cindex warning for reordering of member initializers
2549 Warn when the order of member initializers given in the code does not
2550 match the order in which they must be executed.  For instance:
2552 @smallexample
2553 struct A @{
2554   int i;
2555   int j;
2556   A(): j (0), i (1) @{ @}
2558 @end smallexample
2560 @noindent
2561 The compiler rearranges the member initializers for @samp{i}
2562 and @samp{j} to match the declaration order of the members, emitting
2563 a warning to that effect.  This warning is enabled by @option{-Wall}.
2565 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2566 @opindex fext-numeric-literals
2567 @opindex fno-ext-numeric-literals
2568 Accept imaginary, fixed-point, or machine-defined
2569 literal number suffixes as GNU extensions.
2570 When this option is turned off these suffixes are treated
2571 as C++11 user-defined literal numeric suffixes.
2572 This is on by default for all pre-C++11 dialects and all GNU dialects:
2573 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2574 @option{-std=gnu++1y}.
2575 This option is off by default
2576 for ISO C++11 onwards (@option{-std=c++11}, ...).
2577 @end table
2579 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2581 @table @gcctabopt
2582 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2583 @opindex Weffc++
2584 @opindex Wno-effc++
2585 Warn about violations of the following style guidelines from Scott Meyers'
2586 @cite{Effective C++, Second Edition} book:
2588 @itemize @bullet
2589 @item
2590 Item 11:  Define a copy constructor and an assignment operator for classes
2591 with dynamically-allocated memory.
2593 @item
2594 Item 12:  Prefer initialization to assignment in constructors.
2596 @item
2597 Item 14:  Make destructors virtual in base classes.
2599 @item
2600 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2602 @item
2603 Item 23:  Don't try to return a reference when you must return an object.
2605 @end itemize
2607 Also warn about violations of the following style guidelines from
2608 Scott Meyers' @cite{More Effective C++} book:
2610 @itemize @bullet
2611 @item
2612 Item 6:  Distinguish between prefix and postfix forms of increment and
2613 decrement operators.
2615 @item
2616 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2618 @end itemize
2620 When selecting this option, be aware that the standard library
2621 headers do not obey all of these guidelines; use @samp{grep -v}
2622 to filter out those warnings.
2624 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2625 @opindex Wstrict-null-sentinel
2626 @opindex Wno-strict-null-sentinel
2627 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2628 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2629 to @code{__null}.  Although it is a null pointer constant rather than a
2630 null pointer, it is guaranteed to be of the same size as a pointer.
2631 But this use is not portable across different compilers.
2633 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2634 @opindex Wno-non-template-friend
2635 @opindex Wnon-template-friend
2636 Disable warnings when non-templatized friend functions are declared
2637 within a template.  Since the advent of explicit template specification
2638 support in G++, if the name of the friend is an unqualified-id (i.e.,
2639 @samp{friend foo(int)}), the C++ language specification demands that the
2640 friend declare or define an ordinary, nontemplate function.  (Section
2641 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2642 could be interpreted as a particular specialization of a templatized
2643 function.  Because this non-conforming behavior is no longer the default
2644 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2645 check existing code for potential trouble spots and is on by default.
2646 This new compiler behavior can be turned off with
2647 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2648 but disables the helpful warning.
2650 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2651 @opindex Wold-style-cast
2652 @opindex Wno-old-style-cast
2653 Warn if an old-style (C-style) cast to a non-void type is used within
2654 a C++ program.  The new-style casts (@samp{dynamic_cast},
2655 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2656 less vulnerable to unintended effects and much easier to search for.
2658 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2659 @opindex Woverloaded-virtual
2660 @opindex Wno-overloaded-virtual
2661 @cindex overloaded virtual function, warning
2662 @cindex warning for overloaded virtual function
2663 Warn when a function declaration hides virtual functions from a
2664 base class.  For example, in:
2666 @smallexample
2667 struct A @{
2668   virtual void f();
2671 struct B: public A @{
2672   void f(int);
2674 @end smallexample
2676 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2677 like:
2679 @smallexample
2680 B* b;
2681 b->f();
2682 @end smallexample
2684 @noindent
2685 fails to compile.
2687 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2688 @opindex Wno-pmf-conversions
2689 @opindex Wpmf-conversions
2690 Disable the diagnostic for converting a bound pointer to member function
2691 to a plain pointer.
2693 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2694 @opindex Wsign-promo
2695 @opindex Wno-sign-promo
2696 Warn when overload resolution chooses a promotion from unsigned or
2697 enumerated type to a signed type, over a conversion to an unsigned type of
2698 the same size.  Previous versions of G++ tried to preserve
2699 unsignedness, but the standard mandates the current behavior.
2700 @end table
2702 @node Objective-C and Objective-C++ Dialect Options
2703 @section Options Controlling Objective-C and Objective-C++ Dialects
2705 @cindex compiler options, Objective-C and Objective-C++
2706 @cindex Objective-C and Objective-C++ options, command-line
2707 @cindex options, Objective-C and Objective-C++
2708 (NOTE: This manual does not describe the Objective-C and Objective-C++
2709 languages themselves.  @xref{Standards,,Language Standards
2710 Supported by GCC}, for references.)
2712 This section describes the command-line options that are only meaningful
2713 for Objective-C and Objective-C++ programs.  You can also use most of
2714 the language-independent GNU compiler options.
2715 For example, you might compile a file @code{some_class.m} like this:
2717 @smallexample
2718 gcc -g -fgnu-runtime -O -c some_class.m
2719 @end smallexample
2721 @noindent
2722 In this example, @option{-fgnu-runtime} is an option meant only for
2723 Objective-C and Objective-C++ programs; you can use the other options with
2724 any language supported by GCC@.
2726 Note that since Objective-C is an extension of the C language, Objective-C
2727 compilations may also use options specific to the C front-end (e.g.,
2728 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2729 C++-specific options (e.g., @option{-Wabi}).
2731 Here is a list of options that are @emph{only} for compiling Objective-C
2732 and Objective-C++ programs:
2734 @table @gcctabopt
2735 @item -fconstant-string-class=@var{class-name}
2736 @opindex fconstant-string-class
2737 Use @var{class-name} as the name of the class to instantiate for each
2738 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2739 class name is @code{NXConstantString} if the GNU runtime is being used, and
2740 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2741 @option{-fconstant-cfstrings} option, if also present, overrides the
2742 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2743 to be laid out as constant CoreFoundation strings.
2745 @item -fgnu-runtime
2746 @opindex fgnu-runtime
2747 Generate object code compatible with the standard GNU Objective-C
2748 runtime.  This is the default for most types of systems.
2750 @item -fnext-runtime
2751 @opindex fnext-runtime
2752 Generate output compatible with the NeXT runtime.  This is the default
2753 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2754 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2755 used.
2757 @item -fno-nil-receivers
2758 @opindex fno-nil-receivers
2759 Assume that all Objective-C message dispatches (@code{[receiver
2760 message:arg]}) in this translation unit ensure that the receiver is
2761 not @code{nil}.  This allows for more efficient entry points in the
2762 runtime to be used.  This option is only available in conjunction with
2763 the NeXT runtime and ABI version 0 or 1.
2765 @item -fobjc-abi-version=@var{n}
2766 @opindex fobjc-abi-version
2767 Use version @var{n} of the Objective-C ABI for the selected runtime.
2768 This option is currently supported only for the NeXT runtime.  In that
2769 case, Version 0 is the traditional (32-bit) ABI without support for
2770 properties and other Objective-C 2.0 additions.  Version 1 is the
2771 traditional (32-bit) ABI with support for properties and other
2772 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2773 nothing is specified, the default is Version 0 on 32-bit target
2774 machines, and Version 2 on 64-bit target machines.
2776 @item -fobjc-call-cxx-cdtors
2777 @opindex fobjc-call-cxx-cdtors
2778 For each Objective-C class, check if any of its instance variables is a
2779 C++ object with a non-trivial default constructor.  If so, synthesize a
2780 special @code{- (id) .cxx_construct} instance method which runs
2781 non-trivial default constructors on any such instance variables, in order,
2782 and then return @code{self}.  Similarly, check if any instance variable
2783 is a C++ object with a non-trivial destructor, and if so, synthesize a
2784 special @code{- (void) .cxx_destruct} method which runs
2785 all such default destructors, in reverse order.
2787 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2788 methods thusly generated only operate on instance variables
2789 declared in the current Objective-C class, and not those inherited
2790 from superclasses.  It is the responsibility of the Objective-C
2791 runtime to invoke all such methods in an object's inheritance
2792 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2793 by the runtime immediately after a new object instance is allocated;
2794 the @code{- (void) .cxx_destruct} methods are invoked immediately
2795 before the runtime deallocates an object instance.
2797 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2798 support for invoking the @code{- (id) .cxx_construct} and
2799 @code{- (void) .cxx_destruct} methods.
2801 @item -fobjc-direct-dispatch
2802 @opindex fobjc-direct-dispatch
2803 Allow fast jumps to the message dispatcher.  On Darwin this is
2804 accomplished via the comm page.
2806 @item -fobjc-exceptions
2807 @opindex fobjc-exceptions
2808 Enable syntactic support for structured exception handling in
2809 Objective-C, similar to what is offered by C++ and Java.  This option
2810 is required to use the Objective-C keywords @code{@@try},
2811 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2812 @code{@@synchronized}.  This option is available with both the GNU
2813 runtime and the NeXT runtime (but not available in conjunction with
2814 the NeXT runtime on Mac OS X 10.2 and earlier).
2816 @item -fobjc-gc
2817 @opindex fobjc-gc
2818 Enable garbage collection (GC) in Objective-C and Objective-C++
2819 programs.  This option is only available with the NeXT runtime; the
2820 GNU runtime has a different garbage collection implementation that
2821 does not require special compiler flags.
2823 @item -fobjc-nilcheck
2824 @opindex fobjc-nilcheck
2825 For the NeXT runtime with version 2 of the ABI, check for a nil
2826 receiver in method invocations before doing the actual method call.
2827 This is the default and can be disabled using
2828 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2829 checked for nil in this way no matter what this flag is set to.
2830 Currently this flag does nothing when the GNU runtime, or an older
2831 version of the NeXT runtime ABI, is used.
2833 @item -fobjc-std=objc1
2834 @opindex fobjc-std
2835 Conform to the language syntax of Objective-C 1.0, the language
2836 recognized by GCC 4.0.  This only affects the Objective-C additions to
2837 the C/C++ language; it does not affect conformance to C/C++ standards,
2838 which is controlled by the separate C/C++ dialect option flags.  When
2839 this option is used with the Objective-C or Objective-C++ compiler,
2840 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2841 This is useful if you need to make sure that your Objective-C code can
2842 be compiled with older versions of GCC@.
2844 @item -freplace-objc-classes
2845 @opindex freplace-objc-classes
2846 Emit a special marker instructing @command{ld(1)} not to statically link in
2847 the resulting object file, and allow @command{dyld(1)} to load it in at
2848 run time instead.  This is used in conjunction with the Fix-and-Continue
2849 debugging mode, where the object file in question may be recompiled and
2850 dynamically reloaded in the course of program execution, without the need
2851 to restart the program itself.  Currently, Fix-and-Continue functionality
2852 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2853 and later.
2855 @item -fzero-link
2856 @opindex fzero-link
2857 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2858 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2859 compile time) with static class references that get initialized at load time,
2860 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2861 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2862 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2863 for individual class implementations to be modified during program execution.
2864 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2865 regardless of command-line options.
2867 @item -gen-decls
2868 @opindex gen-decls
2869 Dump interface declarations for all classes seen in the source file to a
2870 file named @file{@var{sourcename}.decl}.
2872 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2873 @opindex Wassign-intercept
2874 @opindex Wno-assign-intercept
2875 Warn whenever an Objective-C assignment is being intercepted by the
2876 garbage collector.
2878 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2879 @opindex Wno-protocol
2880 @opindex Wprotocol
2881 If a class is declared to implement a protocol, a warning is issued for
2882 every method in the protocol that is not implemented by the class.  The
2883 default behavior is to issue a warning for every method not explicitly
2884 implemented in the class, even if a method implementation is inherited
2885 from the superclass.  If you use the @option{-Wno-protocol} option, then
2886 methods inherited from the superclass are considered to be implemented,
2887 and no warning is issued for them.
2889 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2890 @opindex Wselector
2891 @opindex Wno-selector
2892 Warn if multiple methods of different types for the same selector are
2893 found during compilation.  The check is performed on the list of methods
2894 in the final stage of compilation.  Additionally, a check is performed
2895 for each selector appearing in a @code{@@selector(@dots{})}
2896 expression, and a corresponding method for that selector has been found
2897 during compilation.  Because these checks scan the method table only at
2898 the end of compilation, these warnings are not produced if the final
2899 stage of compilation is not reached, for example because an error is
2900 found during compilation, or because the @option{-fsyntax-only} option is
2901 being used.
2903 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2904 @opindex Wstrict-selector-match
2905 @opindex Wno-strict-selector-match
2906 Warn if multiple methods with differing argument and/or return types are
2907 found for a given selector when attempting to send a message using this
2908 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2909 is off (which is the default behavior), the compiler omits such warnings
2910 if any differences found are confined to types that share the same size
2911 and alignment.
2913 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2914 @opindex Wundeclared-selector
2915 @opindex Wno-undeclared-selector
2916 Warn if a @code{@@selector(@dots{})} expression referring to an
2917 undeclared selector is found.  A selector is considered undeclared if no
2918 method with that name has been declared before the
2919 @code{@@selector(@dots{})} expression, either explicitly in an
2920 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2921 an @code{@@implementation} section.  This option always performs its
2922 checks as soon as a @code{@@selector(@dots{})} expression is found,
2923 while @option{-Wselector} only performs its checks in the final stage of
2924 compilation.  This also enforces the coding style convention
2925 that methods and selectors must be declared before being used.
2927 @item -print-objc-runtime-info
2928 @opindex print-objc-runtime-info
2929 Generate C header describing the largest structure that is passed by
2930 value, if any.
2932 @end table
2934 @node Language Independent Options
2935 @section Options to Control Diagnostic Messages Formatting
2936 @cindex options to control diagnostics formatting
2937 @cindex diagnostic messages
2938 @cindex message formatting
2940 Traditionally, diagnostic messages have been formatted irrespective of
2941 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
2942 options described below
2943 to control the formatting algorithm for diagnostic messages, 
2944 e.g.@: how many characters per line, how often source location
2945 information should be reported.  Note that some language front ends may not
2946 honor these options.
2948 @table @gcctabopt
2949 @item -fmessage-length=@var{n}
2950 @opindex fmessage-length
2951 Try to format error messages so that they fit on lines of about @var{n}
2952 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2953 the front ends supported by GCC@.  If @var{n} is zero, then no
2954 line-wrapping is done; each error message appears on a single
2955 line.
2957 @item -fdiagnostics-show-location=once
2958 @opindex fdiagnostics-show-location
2959 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2960 reporter to emit source location information @emph{once}; that is, in
2961 case the message is too long to fit on a single physical line and has to
2962 be wrapped, the source location won't be emitted (as prefix) again,
2963 over and over, in subsequent continuation lines.  This is the default
2964 behavior.
2966 @item -fdiagnostics-show-location=every-line
2967 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2968 messages reporter to emit the same source location information (as
2969 prefix) for physical lines that result from the process of breaking
2970 a message which is too long to fit on a single line.
2972 @item -fno-diagnostics-show-option
2973 @opindex fno-diagnostics-show-option
2974 @opindex fdiagnostics-show-option
2975 By default, each diagnostic emitted includes text indicating the
2976 command-line option that directly controls the diagnostic (if such an
2977 option is known to the diagnostic machinery).  Specifying the
2978 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2980 @item -fno-diagnostics-show-caret
2981 @opindex fno-diagnostics-show-caret
2982 @opindex fdiagnostics-show-caret
2983 By default, each diagnostic emitted includes the original source line
2984 and a caret '^' indicating the column.  This option suppresses this
2985 information.
2987 @end table
2989 @node Warning Options
2990 @section Options to Request or Suppress Warnings
2991 @cindex options to control warnings
2992 @cindex warning messages
2993 @cindex messages, warning
2994 @cindex suppressing warnings
2996 Warnings are diagnostic messages that report constructions that
2997 are not inherently erroneous but that are risky or suggest there
2998 may have been an error.
3000 The following language-independent options do not enable specific
3001 warnings but control the kinds of diagnostics produced by GCC@.
3003 @table @gcctabopt
3004 @cindex syntax checking
3005 @item -fsyntax-only
3006 @opindex fsyntax-only
3007 Check the code for syntax errors, but don't do anything beyond that.
3009 @item -fmax-errors=@var{n}
3010 @opindex fmax-errors
3011 Limits the maximum number of error messages to @var{n}, at which point
3012 GCC bails out rather than attempting to continue processing the source
3013 code.  If @var{n} is 0 (the default), there is no limit on the number
3014 of error messages produced.  If @option{-Wfatal-errors} is also
3015 specified, then @option{-Wfatal-errors} takes precedence over this
3016 option.
3018 @item -w
3019 @opindex w
3020 Inhibit all warning messages.
3022 @item -Werror
3023 @opindex Werror
3024 @opindex Wno-error
3025 Make all warnings into errors.
3027 @item -Werror=
3028 @opindex Werror=
3029 @opindex Wno-error=
3030 Make the specified warning into an error.  The specifier for a warning
3031 is appended; for example @option{-Werror=switch} turns the warnings
3032 controlled by @option{-Wswitch} into errors.  This switch takes a
3033 negative form, to be used to negate @option{-Werror} for specific
3034 warnings; for example @option{-Wno-error=switch} makes
3035 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3036 is in effect.
3038 The warning message for each controllable warning includes the
3039 option that controls the warning.  That option can then be used with
3040 @option{-Werror=} and @option{-Wno-error=} as described above.
3041 (Printing of the option in the warning message can be disabled using the
3042 @option{-fno-diagnostics-show-option} flag.)
3044 Note that specifying @option{-Werror=}@var{foo} automatically implies
3045 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3046 imply anything.
3048 @item -Wfatal-errors
3049 @opindex Wfatal-errors
3050 @opindex Wno-fatal-errors
3051 This option causes the compiler to abort compilation on the first error
3052 occurred rather than trying to keep going and printing further error
3053 messages.
3055 @end table
3057 You can request many specific warnings with options beginning with
3058 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3059 implicit declarations.  Each of these specific warning options also
3060 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3061 example, @option{-Wno-implicit}.  This manual lists only one of the
3062 two forms, whichever is not the default.  For further
3063 language-specific options also refer to @ref{C++ Dialect Options} and
3064 @ref{Objective-C and Objective-C++ Dialect Options}.
3066 When an unrecognized warning option is requested (e.g.,
3067 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3068 that the option is not recognized.  However, if the @option{-Wno-} form
3069 is used, the behavior is slightly different: no diagnostic is
3070 produced for @option{-Wno-unknown-warning} unless other diagnostics
3071 are being produced.  This allows the use of new @option{-Wno-} options
3072 with old compilers, but if something goes wrong, the compiler
3073 warns that an unrecognized option is present.
3075 @table @gcctabopt
3076 @item -Wpedantic
3077 @itemx -pedantic
3078 @opindex pedantic
3079 @opindex Wpedantic
3080 Issue all the warnings demanded by strict ISO C and ISO C++;
3081 reject all programs that use forbidden extensions, and some other
3082 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3083 version of the ISO C standard specified by any @option{-std} option used.
3085 Valid ISO C and ISO C++ programs should compile properly with or without
3086 this option (though a rare few require @option{-ansi} or a
3087 @option{-std} option specifying the required version of ISO C)@.  However,
3088 without this option, certain GNU extensions and traditional C and C++
3089 features are supported as well.  With this option, they are rejected.
3091 @option{-Wpedantic} does not cause warning messages for use of the
3092 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3093 warnings are also disabled in the expression that follows
3094 @code{__extension__}.  However, only system header files should use
3095 these escape routes; application programs should avoid them.
3096 @xref{Alternate Keywords}.
3098 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3099 C conformance.  They soon find that it does not do quite what they want:
3100 it finds some non-ISO practices, but not all---only those for which
3101 ISO C @emph{requires} a diagnostic, and some others for which
3102 diagnostics have been added.
3104 A feature to report any failure to conform to ISO C might be useful in
3105 some instances, but would require considerable additional work and would
3106 be quite different from @option{-Wpedantic}.  We don't have plans to
3107 support such a feature in the near future.
3109 Where the standard specified with @option{-std} represents a GNU
3110 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3111 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3112 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3113 where they are required by the base standard.  (It does not make sense
3114 for such warnings to be given only for features not in the specified GNU
3115 C dialect, since by definition the GNU dialects of C include all
3116 features the compiler supports with the given option, and there would be
3117 nothing to warn about.)
3119 @item -pedantic-errors
3120 @opindex pedantic-errors
3121 Like @option{-Wpedantic}, except that errors are produced rather than
3122 warnings.
3124 @item -Wall
3125 @opindex Wall
3126 @opindex Wno-all
3127 This enables all the warnings about constructions that some users
3128 consider questionable, and that are easy to avoid (or modify to
3129 prevent the warning), even in conjunction with macros.  This also
3130 enables some language-specific warnings described in @ref{C++ Dialect
3131 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3133 @option{-Wall} turns on the following warning flags:
3135 @gccoptlist{-Waddress   @gol
3136 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3137 -Wc++11-compat  @gol
3138 -Wchar-subscripts  @gol
3139 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3140 -Wimplicit-int @r{(C and Objective-C only)} @gol
3141 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3142 -Wcomment  @gol
3143 -Wformat   @gol
3144 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3145 -Wmaybe-uninitialized @gol
3146 -Wmissing-braces @r{(only for C/ObjC)} @gol
3147 -Wnonnull  @gol
3148 -Wparentheses  @gol
3149 -Wpointer-sign  @gol
3150 -Wreorder   @gol
3151 -Wreturn-type  @gol
3152 -Wsequence-point  @gol
3153 -Wsign-compare @r{(only in C++)}  @gol
3154 -Wstrict-aliasing  @gol
3155 -Wstrict-overflow=1  @gol
3156 -Wswitch  @gol
3157 -Wtrigraphs  @gol
3158 -Wuninitialized  @gol
3159 -Wunknown-pragmas  @gol
3160 -Wunused-function  @gol
3161 -Wunused-label     @gol
3162 -Wunused-value     @gol
3163 -Wunused-variable  @gol
3164 -Wvolatile-register-var @gol
3167 Note that some warning flags are not implied by @option{-Wall}.  Some of
3168 them warn about constructions that users generally do not consider
3169 questionable, but which occasionally you might wish to check for;
3170 others warn about constructions that are necessary or hard to avoid in
3171 some cases, and there is no simple way to modify the code to suppress
3172 the warning. Some of them are enabled by @option{-Wextra} but many of
3173 them must be enabled individually.
3175 @item -Wextra
3176 @opindex W
3177 @opindex Wextra
3178 @opindex Wno-extra
3179 This enables some extra warning flags that are not enabled by
3180 @option{-Wall}. (This option used to be called @option{-W}.  The older
3181 name is still supported, but the newer name is more descriptive.)
3183 @gccoptlist{-Wclobbered  @gol
3184 -Wempty-body  @gol
3185 -Wignored-qualifiers @gol
3186 -Wmissing-field-initializers  @gol
3187 -Wmissing-parameter-type @r{(C only)}  @gol
3188 -Wold-style-declaration @r{(C only)}  @gol
3189 -Woverride-init  @gol
3190 -Wsign-compare  @gol
3191 -Wtype-limits  @gol
3192 -Wuninitialized  @gol
3193 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3194 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3197 The option @option{-Wextra} also prints warning messages for the
3198 following cases:
3200 @itemize @bullet
3202 @item
3203 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3204 @samp{>}, or @samp{>=}.
3206 @item
3207 (C++ only) An enumerator and a non-enumerator both appear in a
3208 conditional expression.
3210 @item
3211 (C++ only) Ambiguous virtual bases.
3213 @item
3214 (C++ only) Subscripting an array that has been declared @samp{register}.
3216 @item
3217 (C++ only) Taking the address of a variable that has been declared
3218 @samp{register}.
3220 @item
3221 (C++ only) A base class is not initialized in a derived class's copy
3222 constructor.
3224 @end itemize
3226 @item -Wchar-subscripts
3227 @opindex Wchar-subscripts
3228 @opindex Wno-char-subscripts
3229 Warn if an array subscript has type @code{char}.  This is a common cause
3230 of error, as programmers often forget that this type is signed on some
3231 machines.
3232 This warning is enabled by @option{-Wall}.
3234 @item -Wcomment
3235 @opindex Wcomment
3236 @opindex Wno-comment
3237 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3238 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3239 This warning is enabled by @option{-Wall}.
3241 @item -Wno-coverage-mismatch
3242 @opindex Wno-coverage-mismatch
3243 Warn if feedback profiles do not match when using the
3244 @option{-fprofile-use} option.
3245 If a source file is changed between compiling with @option{-fprofile-gen} and
3246 with @option{-fprofile-use}, the files with the profile feedback can fail
3247 to match the source file and GCC cannot use the profile feedback
3248 information.  By default, this warning is enabled and is treated as an
3249 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3250 warning or @option{-Wno-error=coverage-mismatch} can be used to
3251 disable the error.  Disabling the error for this warning can result in
3252 poorly optimized code and is useful only in the
3253 case of very minor changes such as bug fixes to an existing code-base.
3254 Completely disabling the warning is not recommended.
3256 @item -Wno-cpp
3257 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3259 Suppress warning messages emitted by @code{#warning} directives.
3261 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3262 @opindex Wdouble-promotion
3263 @opindex Wno-double-promotion
3264 Give a warning when a value of type @code{float} is implicitly
3265 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3266 floating-point unit implement @code{float} in hardware, but emulate
3267 @code{double} in software.  On such a machine, doing computations
3268 using @code{double} values is much more expensive because of the
3269 overhead required for software emulation.
3271 It is easy to accidentally do computations with @code{double} because
3272 floating-point literals are implicitly of type @code{double}.  For
3273 example, in:
3274 @smallexample
3275 @group
3276 float area(float radius)
3278    return 3.14159 * radius * radius;
3280 @end group
3281 @end smallexample
3282 the compiler performs the entire computation with @code{double}
3283 because the floating-point literal is a @code{double}.
3285 @item -Wformat
3286 @itemx -Wformat=@var{n}
3287 @opindex Wformat
3288 @opindex Wno-format
3289 @opindex ffreestanding
3290 @opindex fno-builtin
3291 @opindex Wformat=
3292 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3293 the arguments supplied have types appropriate to the format string
3294 specified, and that the conversions specified in the format string make
3295 sense.  This includes standard functions, and others specified by format
3296 attributes (@pxref{Function Attributes}), in the @code{printf},
3297 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3298 not in the C standard) families (or other target-specific families).
3299 Which functions are checked without format attributes having been
3300 specified depends on the standard version selected, and such checks of
3301 functions without the attribute specified are disabled by
3302 @option{-ffreestanding} or @option{-fno-builtin}.
3304 The formats are checked against the format features supported by GNU
3305 libc version 2.2.  These include all ISO C90 and C99 features, as well
3306 as features from the Single Unix Specification and some BSD and GNU
3307 extensions.  Other library implementations may not support all these
3308 features; GCC does not support warning about features that go beyond a
3309 particular library's limitations.  However, if @option{-Wpedantic} is used
3310 with @option{-Wformat}, warnings are given about format features not
3311 in the selected standard version (but not for @code{strfmon} formats,
3312 since those are not in any version of the C standard).  @xref{C Dialect
3313 Options,,Options Controlling C Dialect}.
3315 @table @gcctabopt
3316 @item -Wformat=1
3317 @itemx -Wformat
3318 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3319 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3320 @option{-Wformat} also checks for null format arguments for several
3321 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3322 aspects of this level of format checking can be disabled by the
3323 options: @option{-Wno-format-contains-nul},
3324 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3325 @option{-Wformat} is enabled by @option{-Wall}.
3327 @item -Wno-format-contains-nul
3328 @opindex Wno-format-contains-nul
3329 @opindex Wformat-contains-nul
3330 If @option{-Wformat} is specified, do not warn about format strings that
3331 contain NUL bytes.
3333 @item -Wno-format-extra-args
3334 @opindex Wno-format-extra-args
3335 @opindex Wformat-extra-args
3336 If @option{-Wformat} is specified, do not warn about excess arguments to a
3337 @code{printf} or @code{scanf} format function.  The C standard specifies
3338 that such arguments are ignored.
3340 Where the unused arguments lie between used arguments that are
3341 specified with @samp{$} operand number specifications, normally
3342 warnings are still given, since the implementation could not know what
3343 type to pass to @code{va_arg} to skip the unused arguments.  However,
3344 in the case of @code{scanf} formats, this option suppresses the
3345 warning if the unused arguments are all pointers, since the Single
3346 Unix Specification says that such unused arguments are allowed.
3348 @item -Wno-format-zero-length
3349 @opindex Wno-format-zero-length
3350 @opindex Wformat-zero-length
3351 If @option{-Wformat} is specified, do not warn about zero-length formats.
3352 The C standard specifies that zero-length formats are allowed.
3355 @item -Wformat=2
3356 Enable @option{-Wformat} plus additional format checks.  Currently
3357 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3358 -Wformat-y2k}.
3360 @item -Wformat-nonliteral
3361 @opindex Wformat-nonliteral
3362 @opindex Wno-format-nonliteral
3363 If @option{-Wformat} is specified, also warn if the format string is not a
3364 string literal and so cannot be checked, unless the format function
3365 takes its format arguments as a @code{va_list}.
3367 @item -Wformat-security
3368 @opindex Wformat-security
3369 @opindex Wno-format-security
3370 If @option{-Wformat} is specified, also warn about uses of format
3371 functions that represent possible security problems.  At present, this
3372 warns about calls to @code{printf} and @code{scanf} functions where the
3373 format string is not a string literal and there are no format arguments,
3374 as in @code{printf (foo);}.  This may be a security hole if the format
3375 string came from untrusted input and contains @samp{%n}.  (This is
3376 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3377 in future warnings may be added to @option{-Wformat-security} that are not
3378 included in @option{-Wformat-nonliteral}.)
3380 @item -Wformat-y2k
3381 @opindex Wformat-y2k
3382 @opindex Wno-format-y2k
3383 If @option{-Wformat} is specified, also warn about @code{strftime}
3384 formats that may yield only a two-digit year.
3385 @end table
3387 @item -Wnonnull
3388 @opindex Wnonnull
3389 @opindex Wno-nonnull
3390 Warn about passing a null pointer for arguments marked as
3391 requiring a non-null value by the @code{nonnull} function attribute.
3393 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3394 can be disabled with the @option{-Wno-nonnull} option.
3396 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3397 @opindex Winit-self
3398 @opindex Wno-init-self
3399 Warn about uninitialized variables that are initialized with themselves.
3400 Note this option can only be used with the @option{-Wuninitialized} option.
3402 For example, GCC warns about @code{i} being uninitialized in the
3403 following snippet only when @option{-Winit-self} has been specified:
3404 @smallexample
3405 @group
3406 int f()
3408   int i = i;
3409   return i;
3411 @end group
3412 @end smallexample
3414 This warning is enabled by @option{-Wall} in C++.
3416 @item -Wimplicit-int @r{(C and Objective-C only)}
3417 @opindex Wimplicit-int
3418 @opindex Wno-implicit-int
3419 Warn when a declaration does not specify a type.
3420 This warning is enabled by @option{-Wall}.
3422 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3423 @opindex Wimplicit-function-declaration
3424 @opindex Wno-implicit-function-declaration
3425 Give a warning whenever a function is used before being declared. In
3426 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3427 enabled by default and it is made into an error by
3428 @option{-pedantic-errors}. This warning is also enabled by
3429 @option{-Wall}.
3431 @item -Wimplicit @r{(C and Objective-C only)}
3432 @opindex Wimplicit
3433 @opindex Wno-implicit
3434 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3435 This warning is enabled by @option{-Wall}.
3437 @item -Wignored-qualifiers @r{(C and C++ only)}
3438 @opindex Wignored-qualifiers
3439 @opindex Wno-ignored-qualifiers
3440 Warn if the return type of a function has a type qualifier
3441 such as @code{const}.  For ISO C such a type qualifier has no effect,
3442 since the value returned by a function is not an lvalue.
3443 For C++, the warning is only emitted for scalar types or @code{void}.
3444 ISO C prohibits qualified @code{void} return types on function
3445 definitions, so such return types always receive a warning
3446 even without this option.
3448 This warning is also enabled by @option{-Wextra}.
3450 @item -Wmain
3451 @opindex Wmain
3452 @opindex Wno-main
3453 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3454 a function with external linkage, returning int, taking either zero
3455 arguments, two, or three arguments of appropriate types.  This warning
3456 is enabled by default in C++ and is enabled by either @option{-Wall}
3457 or @option{-Wpedantic}.
3459 @item -Wmissing-braces
3460 @opindex Wmissing-braces
3461 @opindex Wno-missing-braces
3462 Warn if an aggregate or union initializer is not fully bracketed.  In
3463 the following example, the initializer for @samp{a} is not fully
3464 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3465 enabled by @option{-Wall} in C.
3467 @smallexample
3468 int a[2][2] = @{ 0, 1, 2, 3 @};
3469 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3470 @end smallexample
3472 This warning is enabled by @option{-Wall}.
3474 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3475 @opindex Wmissing-include-dirs
3476 @opindex Wno-missing-include-dirs
3477 Warn if a user-supplied include directory does not exist.
3479 @item -Wparentheses
3480 @opindex Wparentheses
3481 @opindex Wno-parentheses
3482 Warn if parentheses are omitted in certain contexts, such
3483 as when there is an assignment in a context where a truth value
3484 is expected, or when operators are nested whose precedence people
3485 often get confused about.
3487 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3488 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3489 interpretation from that of ordinary mathematical notation.
3491 Also warn about constructions where there may be confusion to which
3492 @code{if} statement an @code{else} branch belongs.  Here is an example of
3493 such a case:
3495 @smallexample
3496 @group
3498   if (a)
3499     if (b)
3500       foo ();
3501   else
3502     bar ();
3504 @end group
3505 @end smallexample
3507 In C/C++, every @code{else} branch belongs to the innermost possible
3508 @code{if} statement, which in this example is @code{if (b)}.  This is
3509 often not what the programmer expected, as illustrated in the above
3510 example by indentation the programmer chose.  When there is the
3511 potential for this confusion, GCC issues a warning when this flag
3512 is specified.  To eliminate the warning, add explicit braces around
3513 the innermost @code{if} statement so there is no way the @code{else}
3514 can belong to the enclosing @code{if}.  The resulting code
3515 looks like this:
3517 @smallexample
3518 @group
3520   if (a)
3521     @{
3522       if (b)
3523         foo ();
3524       else
3525         bar ();
3526     @}
3528 @end group
3529 @end smallexample
3531 Also warn for dangerous uses of the GNU extension to
3532 @code{?:} with omitted middle operand. When the condition
3533 in the @code{?}: operator is a boolean expression, the omitted value is
3534 always 1.  Often programmers expect it to be a value computed
3535 inside the conditional expression instead.
3537 This warning is enabled by @option{-Wall}.
3539 @item -Wsequence-point
3540 @opindex Wsequence-point
3541 @opindex Wno-sequence-point
3542 Warn about code that may have undefined semantics because of violations
3543 of sequence point rules in the C and C++ standards.
3545 The C and C++ standards define the order in which expressions in a C/C++
3546 program are evaluated in terms of @dfn{sequence points}, which represent
3547 a partial ordering between the execution of parts of the program: those
3548 executed before the sequence point, and those executed after it.  These
3549 occur after the evaluation of a full expression (one which is not part
3550 of a larger expression), after the evaluation of the first operand of a
3551 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3552 function is called (but after the evaluation of its arguments and the
3553 expression denoting the called function), and in certain other places.
3554 Other than as expressed by the sequence point rules, the order of
3555 evaluation of subexpressions of an expression is not specified.  All
3556 these rules describe only a partial order rather than a total order,
3557 since, for example, if two functions are called within one expression
3558 with no sequence point between them, the order in which the functions
3559 are called is not specified.  However, the standards committee have
3560 ruled that function calls do not overlap.
3562 It is not specified when between sequence points modifications to the
3563 values of objects take effect.  Programs whose behavior depends on this
3564 have undefined behavior; the C and C++ standards specify that ``Between
3565 the previous and next sequence point an object shall have its stored
3566 value modified at most once by the evaluation of an expression.
3567 Furthermore, the prior value shall be read only to determine the value
3568 to be stored.''.  If a program breaks these rules, the results on any
3569 particular implementation are entirely unpredictable.
3571 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3572 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3573 diagnosed by this option, and it may give an occasional false positive
3574 result, but in general it has been found fairly effective at detecting
3575 this sort of problem in programs.
3577 The standard is worded confusingly, therefore there is some debate
3578 over the precise meaning of the sequence point rules in subtle cases.
3579 Links to discussions of the problem, including proposed formal
3580 definitions, may be found on the GCC readings page, at
3581 @uref{http://gcc.gnu.org/@/readings.html}.
3583 This warning is enabled by @option{-Wall} for C and C++.
3585 @item -Wno-return-local-addr
3586 @opindex Wno-return-local-addr
3587 @opindex Wreturn-local-addr
3588 Do not warn about returning a pointer (or in C++, a reference) to a
3589 variable that goes out of scope after the function returns.
3591 @item -Wreturn-type
3592 @opindex Wreturn-type
3593 @opindex Wno-return-type
3594 Warn whenever a function is defined with a return type that defaults
3595 to @code{int}.  Also warn about any @code{return} statement with no
3596 return value in a function whose return type is not @code{void}
3597 (falling off the end of the function body is considered returning
3598 without a value), and about a @code{return} statement with an
3599 expression in a function whose return type is @code{void}.
3601 For C++, a function without return type always produces a diagnostic
3602 message, even when @option{-Wno-return-type} is specified.  The only
3603 exceptions are @samp{main} and functions defined in system headers.
3605 This warning is enabled by @option{-Wall}.
3607 @item -Wswitch
3608 @opindex Wswitch
3609 @opindex Wno-switch
3610 Warn whenever a @code{switch} statement has an index of enumerated type
3611 and lacks a @code{case} for one or more of the named codes of that
3612 enumeration.  (The presence of a @code{default} label prevents this
3613 warning.)  @code{case} labels outside the enumeration range also
3614 provoke warnings when this option is used (even if there is a
3615 @code{default} label).
3616 This warning is enabled by @option{-Wall}.
3618 @item -Wswitch-default
3619 @opindex Wswitch-default
3620 @opindex Wno-switch-default
3621 Warn whenever a @code{switch} statement does not have a @code{default}
3622 case.
3624 @item -Wswitch-enum
3625 @opindex Wswitch-enum
3626 @opindex Wno-switch-enum
3627 Warn whenever a @code{switch} statement has an index of enumerated type
3628 and lacks a @code{case} for one or more of the named codes of that
3629 enumeration.  @code{case} labels outside the enumeration range also
3630 provoke warnings when this option is used.  The only difference
3631 between @option{-Wswitch} and this option is that this option gives a
3632 warning about an omitted enumeration code even if there is a
3633 @code{default} label.
3635 @item -Wsync-nand @r{(C and C++ only)}
3636 @opindex Wsync-nand
3637 @opindex Wno-sync-nand
3638 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3639 built-in functions are used.  These functions changed semantics in GCC 4.4.
3641 @item -Wtrigraphs
3642 @opindex Wtrigraphs
3643 @opindex Wno-trigraphs
3644 Warn if any trigraphs are encountered that might change the meaning of
3645 the program (trigraphs within comments are not warned about).
3646 This warning is enabled by @option{-Wall}.
3648 @item -Wunused-but-set-parameter
3649 @opindex Wunused-but-set-parameter
3650 @opindex Wno-unused-but-set-parameter
3651 Warn whenever a function parameter is assigned to, but otherwise unused
3652 (aside from its declaration).
3654 To suppress this warning use the @samp{unused} attribute
3655 (@pxref{Variable Attributes}).
3657 This warning is also enabled by @option{-Wunused} together with
3658 @option{-Wextra}.
3660 @item -Wunused-but-set-variable
3661 @opindex Wunused-but-set-variable
3662 @opindex Wno-unused-but-set-variable
3663 Warn whenever a local variable is assigned to, but otherwise unused
3664 (aside from its declaration).
3665 This warning is enabled by @option{-Wall}.
3667 To suppress this warning use the @samp{unused} attribute
3668 (@pxref{Variable Attributes}).
3670 This warning is also enabled by @option{-Wunused}, which is enabled
3671 by @option{-Wall}.
3673 @item -Wunused-function
3674 @opindex Wunused-function
3675 @opindex Wno-unused-function
3676 Warn whenever a static function is declared but not defined or a
3677 non-inline static function is unused.
3678 This warning is enabled by @option{-Wall}.
3680 @item -Wunused-label
3681 @opindex Wunused-label
3682 @opindex Wno-unused-label
3683 Warn whenever a label is declared but not used.
3684 This warning is enabled by @option{-Wall}.
3686 To suppress this warning use the @samp{unused} attribute
3687 (@pxref{Variable Attributes}).
3689 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3690 @opindex Wunused-local-typedefs
3691 Warn when a typedef locally defined in a function is not used.
3692 This warning is enabled by @option{-Wall}.
3694 @item -Wunused-parameter
3695 @opindex Wunused-parameter
3696 @opindex Wno-unused-parameter
3697 Warn whenever a function parameter is unused aside from its declaration.
3699 To suppress this warning use the @samp{unused} attribute
3700 (@pxref{Variable Attributes}).
3702 @item -Wno-unused-result
3703 @opindex Wunused-result
3704 @opindex Wno-unused-result
3705 Do not warn if a caller of a function marked with attribute
3706 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3707 its return value. The default is @option{-Wunused-result}.
3709 @item -Wunused-variable
3710 @opindex Wunused-variable
3711 @opindex Wno-unused-variable
3712 Warn whenever a local variable or non-constant static variable is unused
3713 aside from its declaration.
3714 This warning is enabled by @option{-Wall}.
3716 To suppress this warning use the @samp{unused} attribute
3717 (@pxref{Variable Attributes}).
3719 @item -Wunused-value
3720 @opindex Wunused-value
3721 @opindex Wno-unused-value
3722 Warn whenever a statement computes a result that is explicitly not
3723 used. To suppress this warning cast the unused expression to
3724 @samp{void}. This includes an expression-statement or the left-hand
3725 side of a comma expression that contains no side effects. For example,
3726 an expression such as @samp{x[i,j]} causes a warning, while
3727 @samp{x[(void)i,j]} does not.
3729 This warning is enabled by @option{-Wall}.
3731 @item -Wunused
3732 @opindex Wunused
3733 @opindex Wno-unused
3734 All the above @option{-Wunused} options combined.
3736 In order to get a warning about an unused function parameter, you must
3737 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3738 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3740 @item -Wuninitialized
3741 @opindex Wuninitialized
3742 @opindex Wno-uninitialized
3743 Warn if an automatic variable is used without first being initialized
3744 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3745 warn if a non-static reference or non-static @samp{const} member
3746 appears in a class without constructors.
3748 If you want to warn about code that uses the uninitialized value of the
3749 variable in its own initializer, use the @option{-Winit-self} option.
3751 These warnings occur for individual uninitialized or clobbered
3752 elements of structure, union or array variables as well as for
3753 variables that are uninitialized or clobbered as a whole.  They do
3754 not occur for variables or elements declared @code{volatile}.  Because
3755 these warnings depend on optimization, the exact variables or elements
3756 for which there are warnings depends on the precise optimization
3757 options and version of GCC used.
3759 Note that there may be no warning about a variable that is used only
3760 to compute a value that itself is never used, because such
3761 computations may be deleted by data flow analysis before the warnings
3762 are printed.
3764 @item -Wmaybe-uninitialized
3765 @opindex Wmaybe-uninitialized
3766 @opindex Wno-maybe-uninitialized
3767 For an automatic variable, if there exists a path from the function
3768 entry to a use of the variable that is initialized, but there exist
3769 some other paths for which the variable is not initialized, the compiler
3770 emits a warning if it cannot prove the uninitialized paths are not
3771 executed at run time. These warnings are made optional because GCC is
3772 not smart enough to see all the reasons why the code might be correct
3773 in spite of appearing to have an error.  Here is one example of how
3774 this can happen:
3776 @smallexample
3777 @group
3779   int x;
3780   switch (y)
3781     @{
3782     case 1: x = 1;
3783       break;
3784     case 2: x = 4;
3785       break;
3786     case 3: x = 5;
3787     @}
3788   foo (x);
3790 @end group
3791 @end smallexample
3793 @noindent
3794 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3795 always initialized, but GCC doesn't know this. To suppress the
3796 warning, you need to provide a default case with assert(0) or
3797 similar code.
3799 @cindex @code{longjmp} warnings
3800 This option also warns when a non-volatile automatic variable might be
3801 changed by a call to @code{longjmp}.  These warnings as well are possible
3802 only in optimizing compilation.
3804 The compiler sees only the calls to @code{setjmp}.  It cannot know
3805 where @code{longjmp} will be called; in fact, a signal handler could
3806 call it at any point in the code.  As a result, you may get a warning
3807 even when there is in fact no problem because @code{longjmp} cannot
3808 in fact be called at the place that would cause a problem.
3810 Some spurious warnings can be avoided if you declare all the functions
3811 you use that never return as @code{noreturn}.  @xref{Function
3812 Attributes}.
3814 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3816 @item -Wunknown-pragmas
3817 @opindex Wunknown-pragmas
3818 @opindex Wno-unknown-pragmas
3819 @cindex warning for unknown pragmas
3820 @cindex unknown pragmas, warning
3821 @cindex pragmas, warning of unknown
3822 Warn when a @code{#pragma} directive is encountered that is not understood by 
3823 GCC@.  If this command-line option is used, warnings are even issued
3824 for unknown pragmas in system header files.  This is not the case if
3825 the warnings are only enabled by the @option{-Wall} command-line option.
3827 @item -Wno-pragmas
3828 @opindex Wno-pragmas
3829 @opindex Wpragmas
3830 Do not warn about misuses of pragmas, such as incorrect parameters,
3831 invalid syntax, or conflicts between pragmas.  See also
3832 @option{-Wunknown-pragmas}.
3834 @item -Wstrict-aliasing
3835 @opindex Wstrict-aliasing
3836 @opindex Wno-strict-aliasing
3837 This option is only active when @option{-fstrict-aliasing} is active.
3838 It warns about code that might break the strict aliasing rules that the
3839 compiler is using for optimization.  The warning does not catch all
3840 cases, but does attempt to catch the more common pitfalls.  It is
3841 included in @option{-Wall}.
3842 It is equivalent to @option{-Wstrict-aliasing=3}
3844 @item -Wstrict-aliasing=n
3845 @opindex Wstrict-aliasing=n
3846 This option is only active when @option{-fstrict-aliasing} is active.
3847 It warns about code that might break the strict aliasing rules that the
3848 compiler is using for optimization.
3849 Higher levels correspond to higher accuracy (fewer false positives).
3850 Higher levels also correspond to more effort, similar to the way @option{-O} 
3851 works.
3852 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3854 Level 1: Most aggressive, quick, least accurate.
3855 Possibly useful when higher levels
3856 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3857 false negatives.  However, it has many false positives.
3858 Warns for all pointer conversions between possibly incompatible types,
3859 even if never dereferenced.  Runs in the front end only.
3861 Level 2: Aggressive, quick, not too precise.
3862 May still have many false positives (not as many as level 1 though),
3863 and few false negatives (but possibly more than level 1).
3864 Unlike level 1, it only warns when an address is taken.  Warns about
3865 incomplete types.  Runs in the front end only.
3867 Level 3 (default for @option{-Wstrict-aliasing}):
3868 Should have very few false positives and few false
3869 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3870 Takes care of the common pun+dereference pattern in the front end:
3871 @code{*(int*)&some_float}.
3872 If optimization is enabled, it also runs in the back end, where it deals
3873 with multiple statement cases using flow-sensitive points-to information.
3874 Only warns when the converted pointer is dereferenced.
3875 Does not warn about incomplete types.
3877 @item -Wstrict-overflow
3878 @itemx -Wstrict-overflow=@var{n}
3879 @opindex Wstrict-overflow
3880 @opindex Wno-strict-overflow
3881 This option is only active when @option{-fstrict-overflow} is active.
3882 It warns about cases where the compiler optimizes based on the
3883 assumption that signed overflow does not occur.  Note that it does not
3884 warn about all cases where the code might overflow: it only warns
3885 about cases where the compiler implements some optimization.  Thus
3886 this warning depends on the optimization level.
3888 An optimization that assumes that signed overflow does not occur is
3889 perfectly safe if the values of the variables involved are such that
3890 overflow never does, in fact, occur.  Therefore this warning can
3891 easily give a false positive: a warning about code that is not
3892 actually a problem.  To help focus on important issues, several
3893 warning levels are defined.  No warnings are issued for the use of
3894 undefined signed overflow when estimating how many iterations a loop
3895 requires, in particular when determining whether a loop will be
3896 executed at all.
3898 @table @gcctabopt
3899 @item -Wstrict-overflow=1
3900 Warn about cases that are both questionable and easy to avoid.  For
3901 example,  with @option{-fstrict-overflow}, the compiler simplifies
3902 @code{x + 1 > x} to @code{1}.  This level of
3903 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3904 are not, and must be explicitly requested.
3906 @item -Wstrict-overflow=2
3907 Also warn about other cases where a comparison is simplified to a
3908 constant.  For example: @code{abs (x) >= 0}.  This can only be
3909 simplified when @option{-fstrict-overflow} is in effect, because
3910 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3911 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3912 @option{-Wstrict-overflow=2}.
3914 @item -Wstrict-overflow=3
3915 Also warn about other cases where a comparison is simplified.  For
3916 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3918 @item -Wstrict-overflow=4
3919 Also warn about other simplifications not covered by the above cases.
3920 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3922 @item -Wstrict-overflow=5
3923 Also warn about cases where the compiler reduces the magnitude of a
3924 constant involved in a comparison.  For example: @code{x + 2 > y} is
3925 simplified to @code{x + 1 >= y}.  This is reported only at the
3926 highest warning level because this simplification applies to many
3927 comparisons, so this warning level gives a very large number of
3928 false positives.
3929 @end table
3931 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3932 @opindex Wsuggest-attribute=
3933 @opindex Wno-suggest-attribute=
3934 Warn for cases where adding an attribute may be beneficial. The
3935 attributes currently supported are listed below.
3937 @table @gcctabopt
3938 @item -Wsuggest-attribute=pure
3939 @itemx -Wsuggest-attribute=const
3940 @itemx -Wsuggest-attribute=noreturn
3941 @opindex Wsuggest-attribute=pure
3942 @opindex Wno-suggest-attribute=pure
3943 @opindex Wsuggest-attribute=const
3944 @opindex Wno-suggest-attribute=const
3945 @opindex Wsuggest-attribute=noreturn
3946 @opindex Wno-suggest-attribute=noreturn
3948 Warn about functions that might be candidates for attributes
3949 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3950 functions visible in other compilation units or (in the case of @code{pure} and
3951 @code{const}) if it cannot prove that the function returns normally. A function
3952 returns normally if it doesn't contain an infinite loop or return abnormally
3953 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3954 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3955 higher.  Higher optimization levels improve the accuracy of the analysis.
3957 @item -Wsuggest-attribute=format
3958 @itemx -Wmissing-format-attribute
3959 @opindex Wsuggest-attribute=format
3960 @opindex Wmissing-format-attribute
3961 @opindex Wno-suggest-attribute=format
3962 @opindex Wno-missing-format-attribute
3963 @opindex Wformat
3964 @opindex Wno-format
3966 Warn about function pointers that might be candidates for @code{format}
3967 attributes.  Note these are only possible candidates, not absolute ones.
3968 GCC guesses that function pointers with @code{format} attributes that
3969 are used in assignment, initialization, parameter passing or return
3970 statements should have a corresponding @code{format} attribute in the
3971 resulting type.  I.e.@: the left-hand side of the assignment or
3972 initialization, the type of the parameter variable, or the return type
3973 of the containing function respectively should also have a @code{format}
3974 attribute to avoid the warning.
3976 GCC also warns about function definitions that might be
3977 candidates for @code{format} attributes.  Again, these are only
3978 possible candidates.  GCC guesses that @code{format} attributes
3979 might be appropriate for any function that calls a function like
3980 @code{vprintf} or @code{vscanf}, but this might not always be the
3981 case, and some functions for which @code{format} attributes are
3982 appropriate may not be detected.
3983 @end table
3985 @item -Warray-bounds
3986 @opindex Wno-array-bounds
3987 @opindex Warray-bounds
3988 This option is only active when @option{-ftree-vrp} is active
3989 (default for @option{-O2} and above). It warns about subscripts to arrays
3990 that are always out of bounds. This warning is enabled by @option{-Wall}.
3992 @item -Wno-div-by-zero
3993 @opindex Wno-div-by-zero
3994 @opindex Wdiv-by-zero
3995 Do not warn about compile-time integer division by zero.  Floating-point
3996 division by zero is not warned about, as it can be a legitimate way of
3997 obtaining infinities and NaNs.
3999 @item -Wsystem-headers
4000 @opindex Wsystem-headers
4001 @opindex Wno-system-headers
4002 @cindex warnings from system headers
4003 @cindex system headers, warnings from
4004 Print warning messages for constructs found in system header files.
4005 Warnings from system headers are normally suppressed, on the assumption
4006 that they usually do not indicate real problems and would only make the
4007 compiler output harder to read.  Using this command-line option tells
4008 GCC to emit warnings from system headers as if they occurred in user
4009 code.  However, note that using @option{-Wall} in conjunction with this
4010 option does @emph{not} warn about unknown pragmas in system
4011 headers---for that, @option{-Wunknown-pragmas} must also be used.
4013 @item -Wtrampolines
4014 @opindex Wtrampolines
4015 @opindex Wno-trampolines
4016  Warn about trampolines generated for pointers to nested functions.
4018  A trampoline is a small piece of data or code that is created at run
4019  time on the stack when the address of a nested function is taken, and
4020  is used to call the nested function indirectly.  For some targets, it
4021  is made up of data only and thus requires no special treatment.  But,
4022  for most targets, it is made up of code and thus requires the stack
4023  to be made executable in order for the program to work properly.
4025 @item -Wfloat-equal
4026 @opindex Wfloat-equal
4027 @opindex Wno-float-equal
4028 Warn if floating-point values are used in equality comparisons.
4030 The idea behind this is that sometimes it is convenient (for the
4031 programmer) to consider floating-point values as approximations to
4032 infinitely precise real numbers.  If you are doing this, then you need
4033 to compute (by analyzing the code, or in some other way) the maximum or
4034 likely maximum error that the computation introduces, and allow for it
4035 when performing comparisons (and when producing output, but that's a
4036 different problem).  In particular, instead of testing for equality, you
4037 should check to see whether the two values have ranges that overlap; and
4038 this is done with the relational operators, so equality comparisons are
4039 probably mistaken.
4041 @item -Wtraditional @r{(C and Objective-C only)}
4042 @opindex Wtraditional
4043 @opindex Wno-traditional
4044 Warn about certain constructs that behave differently in traditional and
4045 ISO C@.  Also warn about ISO C constructs that have no traditional C
4046 equivalent, and/or problematic constructs that should be avoided.
4048 @itemize @bullet
4049 @item
4050 Macro parameters that appear within string literals in the macro body.
4051 In traditional C macro replacement takes place within string literals,
4052 but in ISO C it does not.
4054 @item
4055 In traditional C, some preprocessor directives did not exist.
4056 Traditional preprocessors only considered a line to be a directive
4057 if the @samp{#} appeared in column 1 on the line.  Therefore
4058 @option{-Wtraditional} warns about directives that traditional C
4059 understands but ignores because the @samp{#} does not appear as the
4060 first character on the line.  It also suggests you hide directives like
4061 @samp{#pragma} not understood by traditional C by indenting them.  Some
4062 traditional implementations do not recognize @samp{#elif}, so this option
4063 suggests avoiding it altogether.
4065 @item
4066 A function-like macro that appears without arguments.
4068 @item
4069 The unary plus operator.
4071 @item
4072 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4073 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4074 constants.)  Note, these suffixes appear in macros defined in the system
4075 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4076 Use of these macros in user code might normally lead to spurious
4077 warnings, however GCC's integrated preprocessor has enough context to
4078 avoid warning in these cases.
4080 @item
4081 A function declared external in one block and then used after the end of
4082 the block.
4084 @item
4085 A @code{switch} statement has an operand of type @code{long}.
4087 @item
4088 A non-@code{static} function declaration follows a @code{static} one.
4089 This construct is not accepted by some traditional C compilers.
4091 @item
4092 The ISO type of an integer constant has a different width or
4093 signedness from its traditional type.  This warning is only issued if
4094 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4095 typically represent bit patterns, are not warned about.
4097 @item
4098 Usage of ISO string concatenation is detected.
4100 @item
4101 Initialization of automatic aggregates.
4103 @item
4104 Identifier conflicts with labels.  Traditional C lacks a separate
4105 namespace for labels.
4107 @item
4108 Initialization of unions.  If the initializer is zero, the warning is
4109 omitted.  This is done under the assumption that the zero initializer in
4110 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4111 initializer warnings and relies on default initialization to zero in the
4112 traditional C case.
4114 @item
4115 Conversions by prototypes between fixed/floating-point values and vice
4116 versa.  The absence of these prototypes when compiling with traditional
4117 C causes serious problems.  This is a subset of the possible
4118 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4120 @item
4121 Use of ISO C style function definitions.  This warning intentionally is
4122 @emph{not} issued for prototype declarations or variadic functions
4123 because these ISO C features appear in your code when using
4124 libiberty's traditional C compatibility macros, @code{PARAMS} and
4125 @code{VPARAMS}.  This warning is also bypassed for nested functions
4126 because that feature is already a GCC extension and thus not relevant to
4127 traditional C compatibility.
4128 @end itemize
4130 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4131 @opindex Wtraditional-conversion
4132 @opindex Wno-traditional-conversion
4133 Warn if a prototype causes a type conversion that is different from what
4134 would happen to the same argument in the absence of a prototype.  This
4135 includes conversions of fixed point to floating and vice versa, and
4136 conversions changing the width or signedness of a fixed-point argument
4137 except when the same as the default promotion.
4139 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4140 @opindex Wdeclaration-after-statement
4141 @opindex Wno-declaration-after-statement
4142 Warn when a declaration is found after a statement in a block.  This
4143 construct, known from C++, was introduced with ISO C99 and is by default
4144 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4145 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4147 @item -Wundef
4148 @opindex Wundef
4149 @opindex Wno-undef
4150 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4152 @item -Wno-endif-labels
4153 @opindex Wno-endif-labels
4154 @opindex Wendif-labels
4155 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4157 @item -Wshadow
4158 @opindex Wshadow
4159 @opindex Wno-shadow
4160 Warn whenever a local variable or type declaration shadows another variable,
4161 parameter, type, or class member (in C++), or whenever a built-in function
4162 is shadowed. Note that in C++, the compiler warns if a local variable
4163 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4165 @item -Wlarger-than=@var{len}
4166 @opindex Wlarger-than=@var{len}
4167 @opindex Wlarger-than-@var{len}
4168 Warn whenever an object of larger than @var{len} bytes is defined.
4170 @item -Wframe-larger-than=@var{len}
4171 @opindex Wframe-larger-than
4172 Warn if the size of a function frame is larger than @var{len} bytes.
4173 The computation done to determine the stack frame size is approximate
4174 and not conservative.
4175 The actual requirements may be somewhat greater than @var{len}
4176 even if you do not get a warning.  In addition, any space allocated
4177 via @code{alloca}, variable-length arrays, or related constructs
4178 is not included by the compiler when determining
4179 whether or not to issue a warning.
4181 @item -Wno-free-nonheap-object
4182 @opindex Wno-free-nonheap-object
4183 @opindex Wfree-nonheap-object
4184 Do not warn when attempting to free an object that was not allocated
4185 on the heap.
4187 @item -Wstack-usage=@var{len}
4188 @opindex Wstack-usage
4189 Warn if the stack usage of a function might be larger than @var{len} bytes.
4190 The computation done to determine the stack usage is conservative.
4191 Any space allocated via @code{alloca}, variable-length arrays, or related
4192 constructs is included by the compiler when determining whether or not to
4193 issue a warning.
4195 The message is in keeping with the output of @option{-fstack-usage}.
4197 @itemize
4198 @item
4199 If the stack usage is fully static but exceeds the specified amount, it's:
4201 @smallexample
4202   warning: stack usage is 1120 bytes
4203 @end smallexample
4204 @item
4205 If the stack usage is (partly) dynamic but bounded, it's:
4207 @smallexample
4208   warning: stack usage might be 1648 bytes
4209 @end smallexample
4210 @item
4211 If the stack usage is (partly) dynamic and not bounded, it's:
4213 @smallexample
4214   warning: stack usage might be unbounded
4215 @end smallexample
4216 @end itemize
4218 @item -Wunsafe-loop-optimizations
4219 @opindex Wunsafe-loop-optimizations
4220 @opindex Wno-unsafe-loop-optimizations
4221 Warn if the loop cannot be optimized because the compiler cannot
4222 assume anything on the bounds of the loop indices.  With
4223 @option{-funsafe-loop-optimizations} warn if the compiler makes
4224 such assumptions.
4226 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4227 @opindex Wno-pedantic-ms-format
4228 @opindex Wpedantic-ms-format
4229 When used in combination with @option{-Wformat}
4230 and @option{-pedantic} without GNU extensions, this option
4231 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4232 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4233 which depend on the MS runtime.
4235 @item -Wpointer-arith
4236 @opindex Wpointer-arith
4237 @opindex Wno-pointer-arith
4238 Warn about anything that depends on the ``size of'' a function type or
4239 of @code{void}.  GNU C assigns these types a size of 1, for
4240 convenience in calculations with @code{void *} pointers and pointers
4241 to functions.  In C++, warn also when an arithmetic operation involves
4242 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4244 @item -Wtype-limits
4245 @opindex Wtype-limits
4246 @opindex Wno-type-limits
4247 Warn if a comparison is always true or always false due to the limited
4248 range of the data type, but do not warn for constant expressions.  For
4249 example, warn if an unsigned variable is compared against zero with
4250 @samp{<} or @samp{>=}.  This warning is also enabled by
4251 @option{-Wextra}.
4253 @item -Wbad-function-cast @r{(C and Objective-C only)}
4254 @opindex Wbad-function-cast
4255 @opindex Wno-bad-function-cast
4256 Warn whenever a function call is cast to a non-matching type.
4257 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4259 @item -Wc++-compat @r{(C and Objective-C only)}
4260 Warn about ISO C constructs that are outside of the common subset of
4261 ISO C and ISO C++, e.g.@: request for implicit conversion from
4262 @code{void *} to a pointer to non-@code{void} type.
4264 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4265 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4266 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4267 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4268 enabled by @option{-Wall}.
4270 @item -Wcast-qual
4271 @opindex Wcast-qual
4272 @opindex Wno-cast-qual
4273 Warn whenever a pointer is cast so as to remove a type qualifier from
4274 the target type.  For example, warn if a @code{const char *} is cast
4275 to an ordinary @code{char *}.
4277 Also warn when making a cast that introduces a type qualifier in an
4278 unsafe way.  For example, casting @code{char **} to @code{const char **}
4279 is unsafe, as in this example:
4281 @smallexample
4282   /* p is char ** value.  */
4283   const char **q = (const char **) p;
4284   /* Assignment of readonly string to const char * is OK.  */
4285   *q = "string";
4286   /* Now char** pointer points to read-only memory.  */
4287   **p = 'b';
4288 @end smallexample
4290 @item -Wcast-align
4291 @opindex Wcast-align
4292 @opindex Wno-cast-align
4293 Warn whenever a pointer is cast such that the required alignment of the
4294 target is increased.  For example, warn if a @code{char *} is cast to
4295 an @code{int *} on machines where integers can only be accessed at
4296 two- or four-byte boundaries.
4298 @item -Wwrite-strings
4299 @opindex Wwrite-strings
4300 @opindex Wno-write-strings
4301 When compiling C, give string constants the type @code{const
4302 char[@var{length}]} so that copying the address of one into a
4303 non-@code{const} @code{char *} pointer produces a warning.  These
4304 warnings help you find at compile time code that can try to write
4305 into a string constant, but only if you have been very careful about
4306 using @code{const} in declarations and prototypes.  Otherwise, it is
4307 just a nuisance. This is why we did not make @option{-Wall} request
4308 these warnings.
4310 When compiling C++, warn about the deprecated conversion from string
4311 literals to @code{char *}.  This warning is enabled by default for C++
4312 programs.
4314 @item -Wclobbered
4315 @opindex Wclobbered
4316 @opindex Wno-clobbered
4317 Warn for variables that might be changed by @samp{longjmp} or
4318 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4320 @item -Wconversion
4321 @opindex Wconversion
4322 @opindex Wno-conversion
4323 Warn for implicit conversions that may alter a value. This includes
4324 conversions between real and integer, like @code{abs (x)} when
4325 @code{x} is @code{double}; conversions between signed and unsigned,
4326 like @code{unsigned ui = -1}; and conversions to smaller types, like
4327 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4328 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4329 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4330 conversions between signed and unsigned integers can be disabled by
4331 using @option{-Wno-sign-conversion}.
4333 For C++, also warn for confusing overload resolution for user-defined
4334 conversions; and conversions that never use a type conversion
4335 operator: conversions to @code{void}, the same type, a base class or a
4336 reference to them. Warnings about conversions between signed and
4337 unsigned integers are disabled by default in C++ unless
4338 @option{-Wsign-conversion} is explicitly enabled.
4340 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4341 @opindex Wconversion-null
4342 @opindex Wno-conversion-null
4343 Do not warn for conversions between @code{NULL} and non-pointer
4344 types. @option{-Wconversion-null} is enabled by default.
4346 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4347 @opindex Wzero-as-null-pointer-constant
4348 @opindex Wno-zero-as-null-pointer-constant
4349 Warn when a literal '0' is used as null pointer constant.  This can
4350 be useful to facilitate the conversion to @code{nullptr} in C++11.
4352 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4353 @opindex Wuseless-cast
4354 @opindex Wno-useless-cast
4355 Warn when an expression is casted to its own type.
4357 @item -Wempty-body
4358 @opindex Wempty-body
4359 @opindex Wno-empty-body
4360 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4361 while} statement.  This warning is also enabled by @option{-Wextra}.
4363 @item -Wenum-compare
4364 @opindex Wenum-compare
4365 @opindex Wno-enum-compare
4366 Warn about a comparison between values of different enumerated types.
4367 In C++ enumeral mismatches in conditional expressions are also
4368 diagnosed and the warning is enabled by default.  In C this warning is 
4369 enabled by @option{-Wall}.
4371 @item -Wjump-misses-init @r{(C, Objective-C only)}
4372 @opindex Wjump-misses-init
4373 @opindex Wno-jump-misses-init
4374 Warn if a @code{goto} statement or a @code{switch} statement jumps
4375 forward across the initialization of a variable, or jumps backward to a
4376 label after the variable has been initialized.  This only warns about
4377 variables that are initialized when they are declared.  This warning is
4378 only supported for C and Objective-C; in C++ this sort of branch is an
4379 error in any case.
4381 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4382 can be disabled with the @option{-Wno-jump-misses-init} option.
4384 @item -Wsign-compare
4385 @opindex Wsign-compare
4386 @opindex Wno-sign-compare
4387 @cindex warning for comparison of signed and unsigned values
4388 @cindex comparison of signed and unsigned values, warning
4389 @cindex signed and unsigned values, comparison warning
4390 Warn when a comparison between signed and unsigned values could produce
4391 an incorrect result when the signed value is converted to unsigned.
4392 This warning is also enabled by @option{-Wextra}; to get the other warnings
4393 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4395 @item -Wsign-conversion
4396 @opindex Wsign-conversion
4397 @opindex Wno-sign-conversion
4398 Warn for implicit conversions that may change the sign of an integer
4399 value, like assigning a signed integer expression to an unsigned
4400 integer variable. An explicit cast silences the warning. In C, this
4401 option is enabled also by @option{-Wconversion}.
4403 @item -Wsizeof-pointer-memaccess
4404 @opindex Wsizeof-pointer-memaccess
4405 @opindex Wno-sizeof-pointer-memaccess
4406 Warn for suspicious length parameters to certain string and memory built-in
4407 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4408 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4409 but a pointer, and suggests a possible fix, or about
4410 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4411 @option{-Wall}.
4413 @item -Waddress
4414 @opindex Waddress
4415 @opindex Wno-address
4416 Warn about suspicious uses of memory addresses. These include using
4417 the address of a function in a conditional expression, such as
4418 @code{void func(void); if (func)}, and comparisons against the memory
4419 address of a string literal, such as @code{if (x == "abc")}.  Such
4420 uses typically indicate a programmer error: the address of a function
4421 always evaluates to true, so their use in a conditional usually
4422 indicate that the programmer forgot the parentheses in a function
4423 call; and comparisons against string literals result in unspecified
4424 behavior and are not portable in C, so they usually indicate that the
4425 programmer intended to use @code{strcmp}.  This warning is enabled by
4426 @option{-Wall}.
4428 @item -Wlogical-op
4429 @opindex Wlogical-op
4430 @opindex Wno-logical-op
4431 Warn about suspicious uses of logical operators in expressions.
4432 This includes using logical operators in contexts where a
4433 bit-wise operator is likely to be expected.
4435 @item -Waggregate-return
4436 @opindex Waggregate-return
4437 @opindex Wno-aggregate-return
4438 Warn if any functions that return structures or unions are defined or
4439 called.  (In languages where you can return an array, this also elicits
4440 a warning.)
4442 @item -Wno-aggressive-loop-optimizations
4443 @opindex Wno-aggressive-loop-optimizations
4444 @opindex Waggressive-loop-optimizations
4445 Warn if in a loop with constant number of iterations the compiler detects
4446 undefined behavior in some statement during one or more of the iterations.
4448 @item -Wno-attributes
4449 @opindex Wno-attributes
4450 @opindex Wattributes
4451 Do not warn if an unexpected @code{__attribute__} is used, such as
4452 unrecognized attributes, function attributes applied to variables,
4453 etc.  This does not stop errors for incorrect use of supported
4454 attributes.
4456 @item -Wno-builtin-macro-redefined
4457 @opindex Wno-builtin-macro-redefined
4458 @opindex Wbuiltin-macro-redefined
4459 Do not warn if certain built-in macros are redefined.  This suppresses
4460 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4461 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4463 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4464 @opindex Wstrict-prototypes
4465 @opindex Wno-strict-prototypes
4466 Warn if a function is declared or defined without specifying the
4467 argument types.  (An old-style function definition is permitted without
4468 a warning if preceded by a declaration that specifies the argument
4469 types.)
4471 @item -Wold-style-declaration @r{(C and Objective-C only)}
4472 @opindex Wold-style-declaration
4473 @opindex Wno-old-style-declaration
4474 Warn for obsolescent usages, according to the C Standard, in a
4475 declaration. For example, warn if storage-class specifiers like
4476 @code{static} are not the first things in a declaration.  This warning
4477 is also enabled by @option{-Wextra}.
4479 @item -Wold-style-definition @r{(C and Objective-C only)}
4480 @opindex Wold-style-definition
4481 @opindex Wno-old-style-definition
4482 Warn if an old-style function definition is used.  A warning is given
4483 even if there is a previous prototype.
4485 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4486 @opindex Wmissing-parameter-type
4487 @opindex Wno-missing-parameter-type
4488 A function parameter is declared without a type specifier in K&R-style
4489 functions:
4491 @smallexample
4492 void foo(bar) @{ @}
4493 @end smallexample
4495 This warning is also enabled by @option{-Wextra}.
4497 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4498 @opindex Wmissing-prototypes
4499 @opindex Wno-missing-prototypes
4500 Warn if a global function is defined without a previous prototype
4501 declaration.  This warning is issued even if the definition itself
4502 provides a prototype.  Use this option to detect global functions
4503 that do not have a matching prototype declaration in a header file.
4504 This option is not valid for C++ because all function declarations
4505 provide prototypes and a non-matching declaration will declare an
4506 overload rather than conflict with an earlier declaration.
4507 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4509 @item -Wmissing-declarations
4510 @opindex Wmissing-declarations
4511 @opindex Wno-missing-declarations
4512 Warn if a global function is defined without a previous declaration.
4513 Do so even if the definition itself provides a prototype.
4514 Use this option to detect global functions that are not declared in
4515 header files.  In C, no warnings are issued for functions with previous
4516 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4517 missing prototypes.  In C++, no warnings are issued for function templates,
4518 or for inline functions, or for functions in anonymous namespaces.
4520 @item -Wmissing-field-initializers
4521 @opindex Wmissing-field-initializers
4522 @opindex Wno-missing-field-initializers
4523 @opindex W
4524 @opindex Wextra
4525 @opindex Wno-extra
4526 Warn if a structure's initializer has some fields missing.  For
4527 example, the following code causes such a warning, because
4528 @code{x.h} is implicitly zero:
4530 @smallexample
4531 struct s @{ int f, g, h; @};
4532 struct s x = @{ 3, 4 @};
4533 @end smallexample
4535 This option does not warn about designated initializers, so the following
4536 modification does not trigger a warning:
4538 @smallexample
4539 struct s @{ int f, g, h; @};
4540 struct s x = @{ .f = 3, .g = 4 @};
4541 @end smallexample
4543 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4544 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4546 @item -Wno-multichar
4547 @opindex Wno-multichar
4548 @opindex Wmultichar
4549 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4550 Usually they indicate a typo in the user's code, as they have
4551 implementation-defined values, and should not be used in portable code.
4553 @item -Wnormalized=<none|id|nfc|nfkc>
4554 @opindex Wnormalized=
4555 @cindex NFC
4556 @cindex NFKC
4557 @cindex character set, input normalization
4558 In ISO C and ISO C++, two identifiers are different if they are
4559 different sequences of characters.  However, sometimes when characters
4560 outside the basic ASCII character set are used, you can have two
4561 different character sequences that look the same.  To avoid confusion,
4562 the ISO 10646 standard sets out some @dfn{normalization rules} which
4563 when applied ensure that two sequences that look the same are turned into
4564 the same sequence.  GCC can warn you if you are using identifiers that
4565 have not been normalized; this option controls that warning.
4567 There are four levels of warning supported by GCC@.  The default is
4568 @option{-Wnormalized=nfc}, which warns about any identifier that is
4569 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4570 recommended form for most uses.
4572 Unfortunately, there are some characters allowed in identifiers by
4573 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4574 identifiers.  That is, there's no way to use these symbols in portable
4575 ISO C or C++ and have all your identifiers in NFC@.
4576 @option{-Wnormalized=id} suppresses the warning for these characters.
4577 It is hoped that future versions of the standards involved will correct
4578 this, which is why this option is not the default.
4580 You can switch the warning off for all characters by writing
4581 @option{-Wnormalized=none}.  You should only do this if you
4582 are using some other normalization scheme (like ``D''), because
4583 otherwise you can easily create bugs that are literally impossible to see.
4585 Some characters in ISO 10646 have distinct meanings but look identical
4586 in some fonts or display methodologies, especially once formatting has
4587 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4588 LETTER N'', displays just like a regular @code{n} that has been
4589 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4590 normalization scheme to convert all these into a standard form as
4591 well, and GCC warns if your code is not in NFKC if you use
4592 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4593 about every identifier that contains the letter O because it might be
4594 confused with the digit 0, and so is not the default, but may be
4595 useful as a local coding convention if the programming environment 
4596 cannot be fixed to display these characters distinctly.
4598 @item -Wno-deprecated
4599 @opindex Wno-deprecated
4600 @opindex Wdeprecated
4601 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4603 @item -Wno-deprecated-declarations
4604 @opindex Wno-deprecated-declarations
4605 @opindex Wdeprecated-declarations
4606 Do not warn about uses of functions (@pxref{Function Attributes}),
4607 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4608 Attributes}) marked as deprecated by using the @code{deprecated}
4609 attribute.
4611 @item -Wno-overflow
4612 @opindex Wno-overflow
4613 @opindex Woverflow
4614 Do not warn about compile-time overflow in constant expressions.
4616 @item -Woverride-init @r{(C and Objective-C only)}
4617 @opindex Woverride-init
4618 @opindex Wno-override-init
4619 @opindex W
4620 @opindex Wextra
4621 @opindex Wno-extra
4622 Warn if an initialized field without side effects is overridden when
4623 using designated initializers (@pxref{Designated Inits, , Designated
4624 Initializers}).
4626 This warning is included in @option{-Wextra}.  To get other
4627 @option{-Wextra} warnings without this one, use @option{-Wextra
4628 -Wno-override-init}.
4630 @item -Wpacked
4631 @opindex Wpacked
4632 @opindex Wno-packed
4633 Warn if a structure is given the packed attribute, but the packed
4634 attribute has no effect on the layout or size of the structure.
4635 Such structures may be mis-aligned for little benefit.  For
4636 instance, in this code, the variable @code{f.x} in @code{struct bar}
4637 is misaligned even though @code{struct bar} does not itself
4638 have the packed attribute:
4640 @smallexample
4641 @group
4642 struct foo @{
4643   int x;
4644   char a, b, c, d;
4645 @} __attribute__((packed));
4646 struct bar @{
4647   char z;
4648   struct foo f;
4650 @end group
4651 @end smallexample
4653 @item -Wpacked-bitfield-compat
4654 @opindex Wpacked-bitfield-compat
4655 @opindex Wno-packed-bitfield-compat
4656 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4657 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4658 the change can lead to differences in the structure layout.  GCC
4659 informs you when the offset of such a field has changed in GCC 4.4.
4660 For example there is no longer a 4-bit padding between field @code{a}
4661 and @code{b} in this structure:
4663 @smallexample
4664 struct foo
4666   char a:4;
4667   char b:8;
4668 @} __attribute__ ((packed));
4669 @end smallexample
4671 This warning is enabled by default.  Use
4672 @option{-Wno-packed-bitfield-compat} to disable this warning.
4674 @item -Wpadded
4675 @opindex Wpadded
4676 @opindex Wno-padded
4677 Warn if padding is included in a structure, either to align an element
4678 of the structure or to align the whole structure.  Sometimes when this
4679 happens it is possible to rearrange the fields of the structure to
4680 reduce the padding and so make the structure smaller.
4682 @item -Wredundant-decls
4683 @opindex Wredundant-decls
4684 @opindex Wno-redundant-decls
4685 Warn if anything is declared more than once in the same scope, even in
4686 cases where multiple declaration is valid and changes nothing.
4688 @item -Wnested-externs @r{(C and Objective-C only)}
4689 @opindex Wnested-externs
4690 @opindex Wno-nested-externs
4691 Warn if an @code{extern} declaration is encountered within a function.
4693 @item -Wno-inherited-variadic-ctor
4694 @opindex Winherited-variadic-ctor
4695 @opindex Wno-inherited-variadic-ctor
4696 Suppress warnings about use of C++11 inheriting constructors when the
4697 base class inherited from has a C variadic constructor; the warning is
4698 on by default because the ellipsis is not inherited.
4700 @item -Winline
4701 @opindex Winline
4702 @opindex Wno-inline
4703 Warn if a function that is declared as inline cannot be inlined.
4704 Even with this option, the compiler does not warn about failures to
4705 inline functions declared in system headers.
4707 The compiler uses a variety of heuristics to determine whether or not
4708 to inline a function.  For example, the compiler takes into account
4709 the size of the function being inlined and the amount of inlining
4710 that has already been done in the current function.  Therefore,
4711 seemingly insignificant changes in the source program can cause the
4712 warnings produced by @option{-Winline} to appear or disappear.
4714 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4715 @opindex Wno-invalid-offsetof
4716 @opindex Winvalid-offsetof
4717 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4718 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4719 to a non-POD type is undefined.  In existing C++ implementations,
4720 however, @samp{offsetof} typically gives meaningful results even when
4721 applied to certain kinds of non-POD types (such as a simple
4722 @samp{struct} that fails to be a POD type only by virtue of having a
4723 constructor).  This flag is for users who are aware that they are
4724 writing nonportable code and who have deliberately chosen to ignore the
4725 warning about it.
4727 The restrictions on @samp{offsetof} may be relaxed in a future version
4728 of the C++ standard.
4730 @item -Wno-int-to-pointer-cast
4731 @opindex Wno-int-to-pointer-cast
4732 @opindex Wint-to-pointer-cast
4733 Suppress warnings from casts to pointer type of an integer of a
4734 different size. In C++, casting to a pointer type of smaller size is
4735 an error. @option{Wint-to-pointer-cast} is enabled by default.
4738 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4739 @opindex Wno-pointer-to-int-cast
4740 @opindex Wpointer-to-int-cast
4741 Suppress warnings from casts from a pointer to an integer type of a
4742 different size.
4744 @item -Winvalid-pch
4745 @opindex Winvalid-pch
4746 @opindex Wno-invalid-pch
4747 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4748 the search path but can't be used.
4750 @item -Wlong-long
4751 @opindex Wlong-long
4752 @opindex Wno-long-long
4753 Warn if @samp{long long} type is used.  This is enabled by either
4754 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4755 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4757 @item -Wvariadic-macros
4758 @opindex Wvariadic-macros
4759 @opindex Wno-variadic-macros
4760 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4761 alternate syntax when in pedantic ISO C99 mode.  This is default.
4762 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4764 @item -Wvarargs
4765 @opindex Wvarargs
4766 @opindex Wno-varargs
4767 Warn upon questionable usage of the macros used to handle variable
4768 arguments like @samp{va_start}.  This is default.  To inhibit the
4769 warning messages, use @option{-Wno-varargs}.
4771 @item -Wvector-operation-performance
4772 @opindex Wvector-operation-performance
4773 @opindex Wno-vector-operation-performance
4774 Warn if vector operation is not implemented via SIMD capabilities of the
4775 architecture.  Mainly useful for the performance tuning.
4776 Vector operation can be implemented @code{piecewise}, which means that the
4777 scalar operation is performed on every vector element; 
4778 @code{in parallel}, which means that the vector operation is implemented
4779 using scalars of wider type, which normally is more performance efficient;
4780 and @code{as a single scalar}, which means that vector fits into a
4781 scalar type.
4783 @item -Wno-virtual-move-assign
4784 @opindex Wvirtual-move-assign
4785 @opindex Wno-virtual-move-assign
4786 Suppress warnings about inheriting from a virtual base with a
4787 non-trivial C++11 move assignment operator.  This is dangerous because
4788 if the virtual base is reachable along more than one path, it will be
4789 moved multiple times, which can mean both objects end up in the
4790 moved-from state.  If the move assignment operator is written to avoid
4791 moving from a moved-from object, this warning can be disabled.
4793 @item -Wvla
4794 @opindex Wvla
4795 @opindex Wno-vla
4796 Warn if variable length array is used in the code.
4797 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4798 the variable length array.
4800 @item -Wvolatile-register-var
4801 @opindex Wvolatile-register-var
4802 @opindex Wno-volatile-register-var
4803 Warn if a register variable is declared volatile.  The volatile
4804 modifier does not inhibit all optimizations that may eliminate reads
4805 and/or writes to register variables.  This warning is enabled by
4806 @option{-Wall}.
4808 @item -Wdisabled-optimization
4809 @opindex Wdisabled-optimization
4810 @opindex Wno-disabled-optimization
4811 Warn if a requested optimization pass is disabled.  This warning does
4812 not generally indicate that there is anything wrong with your code; it
4813 merely indicates that GCC's optimizers are unable to handle the code
4814 effectively.  Often, the problem is that your code is too big or too
4815 complex; GCC refuses to optimize programs when the optimization
4816 itself is likely to take inordinate amounts of time.
4818 @item -Wpointer-sign @r{(C and Objective-C only)}
4819 @opindex Wpointer-sign
4820 @opindex Wno-pointer-sign
4821 Warn for pointer argument passing or assignment with different signedness.
4822 This option is only supported for C and Objective-C@.  It is implied by
4823 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4824 @option{-Wno-pointer-sign}.
4826 @item -Wstack-protector
4827 @opindex Wstack-protector
4828 @opindex Wno-stack-protector
4829 This option is only active when @option{-fstack-protector} is active.  It
4830 warns about functions that are not protected against stack smashing.
4832 @item -Wno-mudflap
4833 @opindex Wno-mudflap
4834 Suppress warnings about constructs that cannot be instrumented by
4835 @option{-fmudflap}.
4837 @item -Woverlength-strings
4838 @opindex Woverlength-strings
4839 @opindex Wno-overlength-strings
4840 Warn about string constants that are longer than the ``minimum
4841 maximum'' length specified in the C standard.  Modern compilers
4842 generally allow string constants that are much longer than the
4843 standard's minimum limit, but very portable programs should avoid
4844 using longer strings.
4846 The limit applies @emph{after} string constant concatenation, and does
4847 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4848 C99, it was raised to 4095.  C++98 does not specify a normative
4849 minimum maximum, so we do not diagnose overlength strings in C++@.
4851 This option is implied by @option{-Wpedantic}, and can be disabled with
4852 @option{-Wno-overlength-strings}.
4854 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4855 @opindex Wunsuffixed-float-constants
4857 Issue a warning for any floating constant that does not have
4858 a suffix.  When used together with @option{-Wsystem-headers} it
4859 warns about such constants in system header files.  This can be useful
4860 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4861 from the decimal floating-point extension to C99.
4862 @end table
4864 @node Debugging Options
4865 @section Options for Debugging Your Program or GCC
4866 @cindex options, debugging
4867 @cindex debugging information options
4869 GCC has various special options that are used for debugging
4870 either your program or GCC:
4872 @table @gcctabopt
4873 @item -g
4874 @opindex g
4875 Produce debugging information in the operating system's native format
4876 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4877 information.
4879 On most systems that use stabs format, @option{-g} enables use of extra
4880 debugging information that only GDB can use; this extra information
4881 makes debugging work better in GDB but probably makes other debuggers
4882 crash or
4883 refuse to read the program.  If you want to control for certain whether
4884 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4885 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4887 GCC allows you to use @option{-g} with
4888 @option{-O}.  The shortcuts taken by optimized code may occasionally
4889 produce surprising results: some variables you declared may not exist
4890 at all; flow of control may briefly move where you did not expect it;
4891 some statements may not be executed because they compute constant
4892 results or their values are already at hand; some statements may
4893 execute in different places because they have been moved out of loops.
4895 Nevertheless it proves possible to debug optimized output.  This makes
4896 it reasonable to use the optimizer for programs that might have bugs.
4898 The following options are useful when GCC is generated with the
4899 capability for more than one debugging format.
4901 @item -gsplit-dwarf
4902 @opindex gsplit-dwarf
4903 Separate as much dwarf debugging information as possible into a
4904 separate output file with the extension .dwo.  This option allows
4905 the build system to avoid linking files with debug information.  To
4906 be useful, this option requires a debugger capable of reading .dwo
4907 files.
4909 @item -ggdb
4910 @opindex ggdb
4911 Produce debugging information for use by GDB@.  This means to use the
4912 most expressive format available (DWARF 2, stabs, or the native format
4913 if neither of those are supported), including GDB extensions if at all
4914 possible.
4916 @item -gpubnames
4917 @opindex gpubnames
4918 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4920 @item -gstabs
4921 @opindex gstabs
4922 Produce debugging information in stabs format (if that is supported),
4923 without GDB extensions.  This is the format used by DBX on most BSD
4924 systems.  On MIPS, Alpha and System V Release 4 systems this option
4925 produces stabs debugging output that is not understood by DBX or SDB@.
4926 On System V Release 4 systems this option requires the GNU assembler.
4928 @item -feliminate-unused-debug-symbols
4929 @opindex feliminate-unused-debug-symbols
4930 Produce debugging information in stabs format (if that is supported),
4931 for only symbols that are actually used.
4933 @item -femit-class-debug-always
4934 Instead of emitting debugging information for a C++ class in only one
4935 object file, emit it in all object files using the class.  This option
4936 should be used only with debuggers that are unable to handle the way GCC
4937 normally emits debugging information for classes because using this
4938 option increases the size of debugging information by as much as a
4939 factor of two.
4941 @item -fdebug-types-section
4942 @opindex fdebug-types-section
4943 @opindex fno-debug-types-section
4944 When using DWARF Version 4 or higher, type DIEs can be put into
4945 their own @code{.debug_types} section instead of making them part of the
4946 @code{.debug_info} section.  It is more efficient to put them in a separate
4947 comdat sections since the linker can then remove duplicates.
4948 But not all DWARF consumers support @code{.debug_types} sections yet
4949 and on some objects @code{.debug_types} produces larger instead of smaller
4950 debugging information.
4952 @item -gstabs+
4953 @opindex gstabs+
4954 Produce debugging information in stabs format (if that is supported),
4955 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4956 use of these extensions is likely to make other debuggers crash or
4957 refuse to read the program.
4959 @item -gcoff
4960 @opindex gcoff
4961 Produce debugging information in COFF format (if that is supported).
4962 This is the format used by SDB on most System V systems prior to
4963 System V Release 4.
4965 @item -gxcoff
4966 @opindex gxcoff
4967 Produce debugging information in XCOFF format (if that is supported).
4968 This is the format used by the DBX debugger on IBM RS/6000 systems.
4970 @item -gxcoff+
4971 @opindex gxcoff+
4972 Produce debugging information in XCOFF format (if that is supported),
4973 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4974 use of these extensions is likely to make other debuggers crash or
4975 refuse to read the program, and may cause assemblers other than the GNU
4976 assembler (GAS) to fail with an error.
4978 @item -gdwarf-@var{version}
4979 @opindex gdwarf-@var{version}
4980 Produce debugging information in DWARF format (if that is supported).
4981 The value of @var{version} may be either 2, 3 or 4; the default version
4982 for most targets is 4.
4984 Note that with DWARF Version 2, some ports require and always
4985 use some non-conflicting DWARF 3 extensions in the unwind tables.
4987 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4988 for maximum benefit.
4990 @item -grecord-gcc-switches
4991 @opindex grecord-gcc-switches
4992 This switch causes the command-line options used to invoke the
4993 compiler that may affect code generation to be appended to the
4994 DW_AT_producer attribute in DWARF debugging information.  The options
4995 are concatenated with spaces separating them from each other and from
4996 the compiler version.  See also @option{-frecord-gcc-switches} for another
4997 way of storing compiler options into the object file.  This is the default.
4999 @item -gno-record-gcc-switches
5000 @opindex gno-record-gcc-switches
5001 Disallow appending command-line options to the DW_AT_producer attribute
5002 in DWARF debugging information.
5004 @item -gstrict-dwarf
5005 @opindex gstrict-dwarf
5006 Disallow using extensions of later DWARF standard version than selected
5007 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5008 DWARF extensions from later standard versions is allowed.
5010 @item -gno-strict-dwarf
5011 @opindex gno-strict-dwarf
5012 Allow using extensions of later DWARF standard version than selected with
5013 @option{-gdwarf-@var{version}}.
5015 @item -gvms
5016 @opindex gvms
5017 Produce debugging information in Alpha/VMS debug format (if that is
5018 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5020 @item -g@var{level}
5021 @itemx -ggdb@var{level}
5022 @itemx -gstabs@var{level}
5023 @itemx -gcoff@var{level}
5024 @itemx -gxcoff@var{level}
5025 @itemx -gvms@var{level}
5026 Request debugging information and also use @var{level} to specify how
5027 much information.  The default level is 2.
5029 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5030 @option{-g}.
5032 Level 1 produces minimal information, enough for making backtraces in
5033 parts of the program that you don't plan to debug.  This includes
5034 descriptions of functions and external variables, but no information
5035 about local variables and no line numbers.
5037 Level 3 includes extra information, such as all the macro definitions
5038 present in the program.  Some debuggers support macro expansion when
5039 you use @option{-g3}.
5041 @option{-gdwarf-2} does not accept a concatenated debug level, because
5042 GCC used to support an option @option{-gdwarf} that meant to generate
5043 debug information in version 1 of the DWARF format (which is very
5044 different from version 2), and it would have been too confusing.  That
5045 debug format is long obsolete, but the option cannot be changed now.
5046 Instead use an additional @option{-g@var{level}} option to change the
5047 debug level for DWARF.
5049 @item -gtoggle
5050 @opindex gtoggle
5051 Turn off generation of debug info, if leaving out this option
5052 generates it, or turn it on at level 2 otherwise.  The position of this
5053 argument in the command line does not matter; it takes effect after all
5054 other options are processed, and it does so only once, no matter how
5055 many times it is given.  This is mainly intended to be used with
5056 @option{-fcompare-debug}.
5058 @item -fsanitize=address
5059 Enable AddressSanitizer, a fast memory error detector.
5060 Memory access instructions will be instrumented to detect
5061 out-of-bounds and use-after-free bugs.
5062 See @uref{http://code.google.com/p/address-sanitizer/} for more details.
5064 @item -fsanitize=thread
5065 Enable ThreadSanitizer, a fast data race detector.
5066 Memory access instructions will be instrumented to detect
5067 data race bugs.
5068 See @uref{http://code.google.com/p/data-race-test/wiki/ThreadSanitizer} for more details.
5070 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5071 @opindex fdump-final-insns
5072 Dump the final internal representation (RTL) to @var{file}.  If the
5073 optional argument is omitted (or if @var{file} is @code{.}), the name
5074 of the dump file is determined by appending @code{.gkd} to the
5075 compilation output file name.
5077 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5078 @opindex fcompare-debug
5079 @opindex fno-compare-debug
5080 If no error occurs during compilation, run the compiler a second time,
5081 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5082 passed to the second compilation.  Dump the final internal
5083 representation in both compilations, and print an error if they differ.
5085 If the equal sign is omitted, the default @option{-gtoggle} is used.
5087 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5088 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5089 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5090 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5091 is used.
5093 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5094 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5095 of the final representation and the second compilation, preventing even
5096 @env{GCC_COMPARE_DEBUG} from taking effect.
5098 To verify full coverage during @option{-fcompare-debug} testing, set
5099 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5100 which GCC rejects as an invalid option in any actual compilation
5101 (rather than preprocessing, assembly or linking).  To get just a
5102 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5103 not overridden} will do.
5105 @item -fcompare-debug-second
5106 @opindex fcompare-debug-second
5107 This option is implicitly passed to the compiler for the second
5108 compilation requested by @option{-fcompare-debug}, along with options to
5109 silence warnings, and omitting other options that would cause
5110 side-effect compiler outputs to files or to the standard output.  Dump
5111 files and preserved temporary files are renamed so as to contain the
5112 @code{.gk} additional extension during the second compilation, to avoid
5113 overwriting those generated by the first.
5115 When this option is passed to the compiler driver, it causes the
5116 @emph{first} compilation to be skipped, which makes it useful for little
5117 other than debugging the compiler proper.
5119 @item -feliminate-dwarf2-dups
5120 @opindex feliminate-dwarf2-dups
5121 Compress DWARF 2 debugging information by eliminating duplicated
5122 information about each symbol.  This option only makes sense when
5123 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5125 @item -femit-struct-debug-baseonly
5126 Emit debug information for struct-like types
5127 only when the base name of the compilation source file
5128 matches the base name of file in which the struct is defined.
5130 This option substantially reduces the size of debugging information,
5131 but at significant potential loss in type information to the debugger.
5132 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5133 See @option{-femit-struct-debug-detailed} for more detailed control.
5135 This option works only with DWARF 2.
5137 @item -femit-struct-debug-reduced
5138 Emit debug information for struct-like types
5139 only when the base name of the compilation source file
5140 matches the base name of file in which the type is defined,
5141 unless the struct is a template or defined in a system header.
5143 This option significantly reduces the size of debugging information,
5144 with some potential loss in type information to the debugger.
5145 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5146 See @option{-femit-struct-debug-detailed} for more detailed control.
5148 This option works only with DWARF 2.
5150 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5151 Specify the struct-like types
5152 for which the compiler generates debug information.
5153 The intent is to reduce duplicate struct debug information
5154 between different object files within the same program.
5156 This option is a detailed version of
5157 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5158 which serves for most needs.
5160 A specification has the syntax@*
5161 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5163 The optional first word limits the specification to
5164 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5165 A struct type is used directly when it is the type of a variable, member.
5166 Indirect uses arise through pointers to structs.
5167 That is, when use of an incomplete struct is valid, the use is indirect.
5168 An example is
5169 @samp{struct one direct; struct two * indirect;}.
5171 The optional second word limits the specification to
5172 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5173 Generic structs are a bit complicated to explain.
5174 For C++, these are non-explicit specializations of template classes,
5175 or non-template classes within the above.
5176 Other programming languages have generics,
5177 but @option{-femit-struct-debug-detailed} does not yet implement them.
5179 The third word specifies the source files for those
5180 structs for which the compiler should emit debug information.
5181 The values @samp{none} and @samp{any} have the normal meaning.
5182 The value @samp{base} means that
5183 the base of name of the file in which the type declaration appears
5184 must match the base of the name of the main compilation file.
5185 In practice, this means that when compiling @file{foo.c}, debug information
5186 is generated for types declared in that file and @file{foo.h},
5187 but not other header files.
5188 The value @samp{sys} means those types satisfying @samp{base}
5189 or declared in system or compiler headers.
5191 You may need to experiment to determine the best settings for your application.
5193 The default is @option{-femit-struct-debug-detailed=all}.
5195 This option works only with DWARF 2.
5197 @item -fno-merge-debug-strings
5198 @opindex fmerge-debug-strings
5199 @opindex fno-merge-debug-strings
5200 Direct the linker to not merge together strings in the debugging
5201 information that are identical in different object files.  Merging is
5202 not supported by all assemblers or linkers.  Merging decreases the size
5203 of the debug information in the output file at the cost of increasing
5204 link processing time.  Merging is enabled by default.
5206 @item -fdebug-prefix-map=@var{old}=@var{new}
5207 @opindex fdebug-prefix-map
5208 When compiling files in directory @file{@var{old}}, record debugging
5209 information describing them as in @file{@var{new}} instead.
5211 @item -fno-dwarf2-cfi-asm
5212 @opindex fdwarf2-cfi-asm
5213 @opindex fno-dwarf2-cfi-asm
5214 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5215 instead of using GAS @code{.cfi_*} directives.
5217 @cindex @command{prof}
5218 @item -p
5219 @opindex p
5220 Generate extra code to write profile information suitable for the
5221 analysis program @command{prof}.  You must use this option when compiling
5222 the source files you want data about, and you must also use it when
5223 linking.
5225 @cindex @command{gprof}
5226 @item -pg
5227 @opindex pg
5228 Generate extra code to write profile information suitable for the
5229 analysis program @command{gprof}.  You must use this option when compiling
5230 the source files you want data about, and you must also use it when
5231 linking.
5233 @item -Q
5234 @opindex Q
5235 Makes the compiler print out each function name as it is compiled, and
5236 print some statistics about each pass when it finishes.
5238 @item -ftime-report
5239 @opindex ftime-report
5240 Makes the compiler print some statistics about the time consumed by each
5241 pass when it finishes.
5243 @item -fmem-report
5244 @opindex fmem-report
5245 Makes the compiler print some statistics about permanent memory
5246 allocation when it finishes.
5248 @item -fmem-report-wpa
5249 @opindex fmem-report-wpa
5250 Makes the compiler print some statistics about permanent memory
5251 allocation for the WPA phase only.
5253 @item -fpre-ipa-mem-report
5254 @opindex fpre-ipa-mem-report
5255 @item -fpost-ipa-mem-report
5256 @opindex fpost-ipa-mem-report
5257 Makes the compiler print some statistics about permanent memory
5258 allocation before or after interprocedural optimization.
5260 @item -fprofile-report
5261 @opindex fprofile-report
5262 Makes the compiler print some statistics about consistency of the
5263 (estimated) profile and effect of individual passes.
5265 @item -fstack-usage
5266 @opindex fstack-usage
5267 Makes the compiler output stack usage information for the program, on a
5268 per-function basis.  The filename for the dump is made by appending
5269 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5270 the output file, if explicitly specified and it is not an executable,
5271 otherwise it is the basename of the source file.  An entry is made up
5272 of three fields:
5274 @itemize
5275 @item
5276 The name of the function.
5277 @item
5278 A number of bytes.
5279 @item
5280 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5281 @end itemize
5283 The qualifier @code{static} means that the function manipulates the stack
5284 statically: a fixed number of bytes are allocated for the frame on function
5285 entry and released on function exit; no stack adjustments are otherwise made
5286 in the function.  The second field is this fixed number of bytes.
5288 The qualifier @code{dynamic} means that the function manipulates the stack
5289 dynamically: in addition to the static allocation described above, stack
5290 adjustments are made in the body of the function, for example to push/pop
5291 arguments around function calls.  If the qualifier @code{bounded} is also
5292 present, the amount of these adjustments is bounded at compile time and
5293 the second field is an upper bound of the total amount of stack used by
5294 the function.  If it is not present, the amount of these adjustments is
5295 not bounded at compile time and the second field only represents the
5296 bounded part.
5298 @item -fprofile-arcs
5299 @opindex fprofile-arcs
5300 Add code so that program flow @dfn{arcs} are instrumented.  During
5301 execution the program records how many times each branch and call is
5302 executed and how many times it is taken or returns.  When the compiled
5303 program exits it saves this data to a file called
5304 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5305 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5306 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5307 @var{auxname} is generated from the name of the output file, if
5308 explicitly specified and it is not the final executable, otherwise it is
5309 the basename of the source file.  In both cases any suffix is removed
5310 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5311 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5312 @xref{Cross-profiling}.
5314 @cindex @command{gcov}
5315 @item --coverage
5316 @opindex coverage
5318 This option is used to compile and link code instrumented for coverage
5319 analysis.  The option is a synonym for @option{-fprofile-arcs}
5320 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5321 linking).  See the documentation for those options for more details.
5323 @itemize
5325 @item
5326 Compile the source files with @option{-fprofile-arcs} plus optimization
5327 and code generation options.  For test coverage analysis, use the
5328 additional @option{-ftest-coverage} option.  You do not need to profile
5329 every source file in a program.
5331 @item
5332 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5333 (the latter implies the former).
5335 @item
5336 Run the program on a representative workload to generate the arc profile
5337 information.  This may be repeated any number of times.  You can run
5338 concurrent instances of your program, and provided that the file system
5339 supports locking, the data files will be correctly updated.  Also
5340 @code{fork} calls are detected and correctly handled (double counting
5341 will not happen).
5343 @item
5344 For profile-directed optimizations, compile the source files again with
5345 the same optimization and code generation options plus
5346 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5347 Control Optimization}).
5349 @item
5350 For test coverage analysis, use @command{gcov} to produce human readable
5351 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5352 @command{gcov} documentation for further information.
5354 @end itemize
5356 With @option{-fprofile-arcs}, for each function of your program GCC
5357 creates a program flow graph, then finds a spanning tree for the graph.
5358 Only arcs that are not on the spanning tree have to be instrumented: the
5359 compiler adds code to count the number of times that these arcs are
5360 executed.  When an arc is the only exit or only entrance to a block, the
5361 instrumentation code can be added to the block; otherwise, a new basic
5362 block must be created to hold the instrumentation code.
5364 @need 2000
5365 @item -ftest-coverage
5366 @opindex ftest-coverage
5367 Produce a notes file that the @command{gcov} code-coverage utility
5368 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5369 show program coverage.  Each source file's note file is called
5370 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5371 above for a description of @var{auxname} and instructions on how to
5372 generate test coverage data.  Coverage data matches the source files
5373 more closely if you do not optimize.
5375 @item -fdbg-cnt-list
5376 @opindex fdbg-cnt-list
5377 Print the name and the counter upper bound for all debug counters.
5380 @item -fdbg-cnt=@var{counter-value-list}
5381 @opindex fdbg-cnt
5382 Set the internal debug counter upper bound.  @var{counter-value-list}
5383 is a comma-separated list of @var{name}:@var{value} pairs
5384 which sets the upper bound of each debug counter @var{name} to @var{value}.
5385 All debug counters have the initial upper bound of @code{UINT_MAX};
5386 thus @code{dbg_cnt()} returns true always unless the upper bound
5387 is set by this option.
5388 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5389 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5391 @item -fenable-@var{kind}-@var{pass}
5392 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5393 @opindex fdisable-
5394 @opindex fenable-
5396 This is a set of options that are used to explicitly disable/enable
5397 optimization passes.  These options are intended for use for debugging GCC.
5398 Compiler users should use regular options for enabling/disabling
5399 passes instead.
5401 @table @gcctabopt
5403 @item -fdisable-ipa-@var{pass}
5404 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5405 statically invoked in the compiler multiple times, the pass name should be
5406 appended with a sequential number starting from 1.
5408 @item -fdisable-rtl-@var{pass}
5409 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5410 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5411 statically invoked in the compiler multiple times, the pass name should be
5412 appended with a sequential number starting from 1.  @var{range-list} is a 
5413 comma-separated list of function ranges or assembler names.  Each range is a number
5414 pair separated by a colon.  The range is inclusive in both ends.  If the range
5415 is trivial, the number pair can be simplified as a single number.  If the
5416 function's call graph node's @var{uid} falls within one of the specified ranges,
5417 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5418 function header of a dump file, and the pass names can be dumped by using
5419 option @option{-fdump-passes}.
5421 @item -fdisable-tree-@var{pass}
5422 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5423 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5424 option arguments.
5426 @item -fenable-ipa-@var{pass}
5427 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5428 statically invoked in the compiler multiple times, the pass name should be
5429 appended with a sequential number starting from 1.
5431 @item -fenable-rtl-@var{pass}
5432 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5433 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5434 description and examples.
5436 @item -fenable-tree-@var{pass}
5437 @itemx -fenable-tree-@var{pass}=@var{range-list}
5438 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5439 of option arguments.
5441 @end table
5443 Here are some examples showing uses of these options.
5445 @smallexample
5447 # disable ccp1 for all functions
5448    -fdisable-tree-ccp1
5449 # disable complete unroll for function whose cgraph node uid is 1
5450    -fenable-tree-cunroll=1
5451 # disable gcse2 for functions at the following ranges [1,1],
5452 # [300,400], and [400,1000]
5453 # disable gcse2 for functions foo and foo2
5454    -fdisable-rtl-gcse2=foo,foo2
5455 # disable early inlining
5456    -fdisable-tree-einline
5457 # disable ipa inlining
5458    -fdisable-ipa-inline
5459 # enable tree full unroll
5460    -fenable-tree-unroll
5462 @end smallexample
5464 @item -d@var{letters}
5465 @itemx -fdump-rtl-@var{pass}
5466 @itemx -fdump-rtl-@var{pass}=@var{filename}
5467 @opindex d
5468 Says to make debugging dumps during compilation at times specified by
5469 @var{letters}.  This is used for debugging the RTL-based passes of the
5470 compiler.  The file names for most of the dumps are made by appending
5471 a pass number and a word to the @var{dumpname}, and the files are
5472 created in the directory of the output file. In case of
5473 @option{=@var{filename}} option, the dump is output on the given file
5474 instead of the pass numbered dump files. Note that the pass number is
5475 computed statically as passes get registered into the pass manager.
5476 Thus the numbering is not related to the dynamic order of execution of
5477 passes.  In particular, a pass installed by a plugin could have a
5478 number over 200 even if it executed quite early.  @var{dumpname} is
5479 generated from the name of the output file, if explicitly specified
5480 and it is not an executable, otherwise it is the basename of the
5481 source file. These switches may have different effects when
5482 @option{-E} is used for preprocessing.
5484 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5485 @option{-d} option @var{letters}.  Here are the possible
5486 letters for use in @var{pass} and @var{letters}, and their meanings:
5488 @table @gcctabopt
5490 @item -fdump-rtl-alignments
5491 @opindex fdump-rtl-alignments
5492 Dump after branch alignments have been computed.
5494 @item -fdump-rtl-asmcons
5495 @opindex fdump-rtl-asmcons
5496 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5498 @item -fdump-rtl-auto_inc_dec
5499 @opindex fdump-rtl-auto_inc_dec
5500 Dump after auto-inc-dec discovery.  This pass is only run on
5501 architectures that have auto inc or auto dec instructions.
5503 @item -fdump-rtl-barriers
5504 @opindex fdump-rtl-barriers
5505 Dump after cleaning up the barrier instructions.
5507 @item -fdump-rtl-bbpart
5508 @opindex fdump-rtl-bbpart
5509 Dump after partitioning hot and cold basic blocks.
5511 @item -fdump-rtl-bbro
5512 @opindex fdump-rtl-bbro
5513 Dump after block reordering.
5515 @item -fdump-rtl-btl1
5516 @itemx -fdump-rtl-btl2
5517 @opindex fdump-rtl-btl2
5518 @opindex fdump-rtl-btl2
5519 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5520 after the two branch
5521 target load optimization passes.
5523 @item -fdump-rtl-bypass
5524 @opindex fdump-rtl-bypass
5525 Dump after jump bypassing and control flow optimizations.
5527 @item -fdump-rtl-combine
5528 @opindex fdump-rtl-combine
5529 Dump after the RTL instruction combination pass.
5531 @item -fdump-rtl-compgotos
5532 @opindex fdump-rtl-compgotos
5533 Dump after duplicating the computed gotos.
5535 @item -fdump-rtl-ce1
5536 @itemx -fdump-rtl-ce2
5537 @itemx -fdump-rtl-ce3
5538 @opindex fdump-rtl-ce1
5539 @opindex fdump-rtl-ce2
5540 @opindex fdump-rtl-ce3
5541 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5542 @option{-fdump-rtl-ce3} enable dumping after the three
5543 if conversion passes.
5545 @item -fdump-rtl-cprop_hardreg
5546 @opindex fdump-rtl-cprop_hardreg
5547 Dump after hard register copy propagation.
5549 @item -fdump-rtl-csa
5550 @opindex fdump-rtl-csa
5551 Dump after combining stack adjustments.
5553 @item -fdump-rtl-cse1
5554 @itemx -fdump-rtl-cse2
5555 @opindex fdump-rtl-cse1
5556 @opindex fdump-rtl-cse2
5557 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5558 the two common subexpression elimination passes.
5560 @item -fdump-rtl-dce
5561 @opindex fdump-rtl-dce
5562 Dump after the standalone dead code elimination passes.
5564 @item -fdump-rtl-dbr
5565 @opindex fdump-rtl-dbr
5566 Dump after delayed branch scheduling.
5568 @item -fdump-rtl-dce1
5569 @itemx -fdump-rtl-dce2
5570 @opindex fdump-rtl-dce1
5571 @opindex fdump-rtl-dce2
5572 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5573 the two dead store elimination passes.
5575 @item -fdump-rtl-eh
5576 @opindex fdump-rtl-eh
5577 Dump after finalization of EH handling code.
5579 @item -fdump-rtl-eh_ranges
5580 @opindex fdump-rtl-eh_ranges
5581 Dump after conversion of EH handling range regions.
5583 @item -fdump-rtl-expand
5584 @opindex fdump-rtl-expand
5585 Dump after RTL generation.
5587 @item -fdump-rtl-fwprop1
5588 @itemx -fdump-rtl-fwprop2
5589 @opindex fdump-rtl-fwprop1
5590 @opindex fdump-rtl-fwprop2
5591 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5592 dumping after the two forward propagation passes.
5594 @item -fdump-rtl-gcse1
5595 @itemx -fdump-rtl-gcse2
5596 @opindex fdump-rtl-gcse1
5597 @opindex fdump-rtl-gcse2
5598 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5599 after global common subexpression elimination.
5601 @item -fdump-rtl-init-regs
5602 @opindex fdump-rtl-init-regs
5603 Dump after the initialization of the registers.
5605 @item -fdump-rtl-initvals
5606 @opindex fdump-rtl-initvals
5607 Dump after the computation of the initial value sets.
5609 @item -fdump-rtl-into_cfglayout
5610 @opindex fdump-rtl-into_cfglayout
5611 Dump after converting to cfglayout mode.
5613 @item -fdump-rtl-ira
5614 @opindex fdump-rtl-ira
5615 Dump after iterated register allocation.
5617 @item -fdump-rtl-jump
5618 @opindex fdump-rtl-jump
5619 Dump after the second jump optimization.
5621 @item -fdump-rtl-loop2
5622 @opindex fdump-rtl-loop2
5623 @option{-fdump-rtl-loop2} enables dumping after the rtl
5624 loop optimization passes.
5626 @item -fdump-rtl-mach
5627 @opindex fdump-rtl-mach
5628 Dump after performing the machine dependent reorganization pass, if that
5629 pass exists.
5631 @item -fdump-rtl-mode_sw
5632 @opindex fdump-rtl-mode_sw
5633 Dump after removing redundant mode switches.
5635 @item -fdump-rtl-rnreg
5636 @opindex fdump-rtl-rnreg
5637 Dump after register renumbering.
5639 @item -fdump-rtl-outof_cfglayout
5640 @opindex fdump-rtl-outof_cfglayout
5641 Dump after converting from cfglayout mode.
5643 @item -fdump-rtl-peephole2
5644 @opindex fdump-rtl-peephole2
5645 Dump after the peephole pass.
5647 @item -fdump-rtl-postreload
5648 @opindex fdump-rtl-postreload
5649 Dump after post-reload optimizations.
5651 @item -fdump-rtl-pro_and_epilogue
5652 @opindex fdump-rtl-pro_and_epilogue
5653 Dump after generating the function prologues and epilogues.
5655 @item -fdump-rtl-regmove
5656 @opindex fdump-rtl-regmove
5657 Dump after the register move pass.
5659 @item -fdump-rtl-sched1
5660 @itemx -fdump-rtl-sched2
5661 @opindex fdump-rtl-sched1
5662 @opindex fdump-rtl-sched2
5663 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5664 after the basic block scheduling passes.
5666 @item -fdump-rtl-see
5667 @opindex fdump-rtl-see
5668 Dump after sign extension elimination.
5670 @item -fdump-rtl-seqabstr
5671 @opindex fdump-rtl-seqabstr
5672 Dump after common sequence discovery.
5674 @item -fdump-rtl-shorten
5675 @opindex fdump-rtl-shorten
5676 Dump after shortening branches.
5678 @item -fdump-rtl-sibling
5679 @opindex fdump-rtl-sibling
5680 Dump after sibling call optimizations.
5682 @item -fdump-rtl-split1
5683 @itemx -fdump-rtl-split2
5684 @itemx -fdump-rtl-split3
5685 @itemx -fdump-rtl-split4
5686 @itemx -fdump-rtl-split5
5687 @opindex fdump-rtl-split1
5688 @opindex fdump-rtl-split2
5689 @opindex fdump-rtl-split3
5690 @opindex fdump-rtl-split4
5691 @opindex fdump-rtl-split5
5692 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5693 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5694 @option{-fdump-rtl-split5} enable dumping after five rounds of
5695 instruction splitting.
5697 @item -fdump-rtl-sms
5698 @opindex fdump-rtl-sms
5699 Dump after modulo scheduling.  This pass is only run on some
5700 architectures.
5702 @item -fdump-rtl-stack
5703 @opindex fdump-rtl-stack
5704 Dump after conversion from GCC's ``flat register file'' registers to the
5705 x87's stack-like registers.  This pass is only run on x86 variants.
5707 @item -fdump-rtl-subreg1
5708 @itemx -fdump-rtl-subreg2
5709 @opindex fdump-rtl-subreg1
5710 @opindex fdump-rtl-subreg2
5711 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5712 the two subreg expansion passes.
5714 @item -fdump-rtl-unshare
5715 @opindex fdump-rtl-unshare
5716 Dump after all rtl has been unshared.
5718 @item -fdump-rtl-vartrack
5719 @opindex fdump-rtl-vartrack
5720 Dump after variable tracking.
5722 @item -fdump-rtl-vregs
5723 @opindex fdump-rtl-vregs
5724 Dump after converting virtual registers to hard registers.
5726 @item -fdump-rtl-web
5727 @opindex fdump-rtl-web
5728 Dump after live range splitting.
5730 @item -fdump-rtl-regclass
5731 @itemx -fdump-rtl-subregs_of_mode_init
5732 @itemx -fdump-rtl-subregs_of_mode_finish
5733 @itemx -fdump-rtl-dfinit
5734 @itemx -fdump-rtl-dfinish
5735 @opindex fdump-rtl-regclass
5736 @opindex fdump-rtl-subregs_of_mode_init
5737 @opindex fdump-rtl-subregs_of_mode_finish
5738 @opindex fdump-rtl-dfinit
5739 @opindex fdump-rtl-dfinish
5740 These dumps are defined but always produce empty files.
5742 @item -da
5743 @itemx -fdump-rtl-all
5744 @opindex da
5745 @opindex fdump-rtl-all
5746 Produce all the dumps listed above.
5748 @item -dA
5749 @opindex dA
5750 Annotate the assembler output with miscellaneous debugging information.
5752 @item -dD
5753 @opindex dD
5754 Dump all macro definitions, at the end of preprocessing, in addition to
5755 normal output.
5757 @item -dH
5758 @opindex dH
5759 Produce a core dump whenever an error occurs.
5761 @item -dp
5762 @opindex dp
5763 Annotate the assembler output with a comment indicating which
5764 pattern and alternative is used.  The length of each instruction is
5765 also printed.
5767 @item -dP
5768 @opindex dP
5769 Dump the RTL in the assembler output as a comment before each instruction.
5770 Also turns on @option{-dp} annotation.
5772 @item -dx
5773 @opindex dx
5774 Just generate RTL for a function instead of compiling it.  Usually used
5775 with @option{-fdump-rtl-expand}.
5776 @end table
5778 @item -fdump-noaddr
5779 @opindex fdump-noaddr
5780 When doing debugging dumps, suppress address output.  This makes it more
5781 feasible to use diff on debugging dumps for compiler invocations with
5782 different compiler binaries and/or different
5783 text / bss / data / heap / stack / dso start locations.
5785 @item -fdump-unnumbered
5786 @opindex fdump-unnumbered
5787 When doing debugging dumps, suppress instruction numbers and address output.
5788 This makes it more feasible to use diff on debugging dumps for compiler
5789 invocations with different options, in particular with and without
5790 @option{-g}.
5792 @item -fdump-unnumbered-links
5793 @opindex fdump-unnumbered-links
5794 When doing debugging dumps (see @option{-d} option above), suppress
5795 instruction numbers for the links to the previous and next instructions
5796 in a sequence.
5798 @item -fdump-translation-unit @r{(C++ only)}
5799 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5800 @opindex fdump-translation-unit
5801 Dump a representation of the tree structure for the entire translation
5802 unit to a file.  The file name is made by appending @file{.tu} to the
5803 source file name, and the file is created in the same directory as the
5804 output file.  If the @samp{-@var{options}} form is used, @var{options}
5805 controls the details of the dump as described for the
5806 @option{-fdump-tree} options.
5808 @item -fdump-class-hierarchy @r{(C++ only)}
5809 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5810 @opindex fdump-class-hierarchy
5811 Dump a representation of each class's hierarchy and virtual function
5812 table layout to a file.  The file name is made by appending
5813 @file{.class} to the source file name, and the file is created in the
5814 same directory as the output file.  If the @samp{-@var{options}} form
5815 is used, @var{options} controls the details of the dump as described
5816 for the @option{-fdump-tree} options.
5818 @item -fdump-ipa-@var{switch}
5819 @opindex fdump-ipa
5820 Control the dumping at various stages of inter-procedural analysis
5821 language tree to a file.  The file name is generated by appending a
5822 switch specific suffix to the source file name, and the file is created
5823 in the same directory as the output file.  The following dumps are
5824 possible:
5826 @table @samp
5827 @item all
5828 Enables all inter-procedural analysis dumps.
5830 @item cgraph
5831 Dumps information about call-graph optimization, unused function removal,
5832 and inlining decisions.
5834 @item inline
5835 Dump after function inlining.
5837 @end table
5839 @item -fdump-passes
5840 @opindex fdump-passes
5841 Dump the list of optimization passes that are turned on and off by
5842 the current command-line options.
5844 @item -fdump-statistics-@var{option}
5845 @opindex fdump-statistics
5846 Enable and control dumping of pass statistics in a separate file.  The
5847 file name is generated by appending a suffix ending in
5848 @samp{.statistics} to the source file name, and the file is created in
5849 the same directory as the output file.  If the @samp{-@var{option}}
5850 form is used, @samp{-stats} causes counters to be summed over the
5851 whole compilation unit while @samp{-details} dumps every event as
5852 the passes generate them.  The default with no option is to sum
5853 counters for each function compiled.
5855 @item -fdump-tree-@var{switch}
5856 @itemx -fdump-tree-@var{switch}-@var{options}
5857 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
5858 @opindex fdump-tree
5859 Control the dumping at various stages of processing the intermediate
5860 language tree to a file.  The file name is generated by appending a
5861 switch-specific suffix to the source file name, and the file is
5862 created in the same directory as the output file. In case of
5863 @option{=@var{filename}} option, the dump is output on the given file
5864 instead of the auto named dump files.  If the @samp{-@var{options}}
5865 form is used, @var{options} is a list of @samp{-} separated options
5866 which control the details of the dump.  Not all options are applicable
5867 to all dumps; those that are not meaningful are ignored.  The
5868 following options are available
5870 @table @samp
5871 @item address
5872 Print the address of each node.  Usually this is not meaningful as it
5873 changes according to the environment and source file.  Its primary use
5874 is for tying up a dump file with a debug environment.
5875 @item asmname
5876 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5877 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5878 use working backward from mangled names in the assembly file.
5879 @item slim
5880 When dumping front-end intermediate representations, inhibit dumping
5881 of members of a scope or body of a function merely because that scope
5882 has been reached.  Only dump such items when they are directly reachable
5883 by some other path.
5885 When dumping pretty-printed trees, this option inhibits dumping the
5886 bodies of control structures.
5888 When dumping RTL, print the RTL in slim (condensed) form instead of
5889 the default LISP-like representation.
5890 @item raw
5891 Print a raw representation of the tree.  By default, trees are
5892 pretty-printed into a C-like representation.
5893 @item details
5894 Enable more detailed dumps (not honored by every dump option). Also
5895 include information from the optimization passes.
5896 @item stats
5897 Enable dumping various statistics about the pass (not honored by every dump
5898 option).
5899 @item blocks
5900 Enable showing basic block boundaries (disabled in raw dumps).
5901 @item graph
5902 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5903 dump a representation of the control flow graph suitable for viewing with
5904 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
5905 the file is pretty-printed as a subgraph, so that GraphViz can render them
5906 all in a single plot.
5908 This option currently only works for RTL dumps, and the RTL is always
5909 dumped in slim form.
5910 @item vops
5911 Enable showing virtual operands for every statement.
5912 @item lineno
5913 Enable showing line numbers for statements.
5914 @item uid
5915 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5916 @item verbose
5917 Enable showing the tree dump for each statement.
5918 @item eh
5919 Enable showing the EH region number holding each statement.
5920 @item scev
5921 Enable showing scalar evolution analysis details.
5922 @item optimized
5923 Enable showing optimization information (only available in certain
5924 passes).
5925 @item missed
5926 Enable showing missed optimization information (only available in certain
5927 passes).
5928 @item notes
5929 Enable other detailed optimization information (only available in
5930 certain passes).
5931 @item =@var{filename}
5932 Instead of an auto named dump file, output into the given file
5933 name. The file names @file{stdout} and @file{stderr} are treated
5934 specially and are considered already open standard streams. For
5935 example,
5937 @smallexample
5938 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
5939      -fdump-tree-pre=stderr file.c
5940 @end smallexample
5942 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
5943 output on to @file{stderr}. If two conflicting dump filenames are
5944 given for the same pass, then the latter option overrides the earlier
5945 one.
5947 @item all
5948 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5949 and @option{lineno}.
5951 @item optall
5952 Turn on all optimization options, i.e., @option{optimized},
5953 @option{missed}, and @option{note}.
5954 @end table
5956 The following tree dumps are possible:
5957 @table @samp
5959 @item original
5960 @opindex fdump-tree-original
5961 Dump before any tree based optimization, to @file{@var{file}.original}.
5963 @item optimized
5964 @opindex fdump-tree-optimized
5965 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5967 @item gimple
5968 @opindex fdump-tree-gimple
5969 Dump each function before and after the gimplification pass to a file.  The
5970 file name is made by appending @file{.gimple} to the source file name.
5972 @item cfg
5973 @opindex fdump-tree-cfg
5974 Dump the control flow graph of each function to a file.  The file name is
5975 made by appending @file{.cfg} to the source file name.
5977 @item ch
5978 @opindex fdump-tree-ch
5979 Dump each function after copying loop headers.  The file name is made by
5980 appending @file{.ch} to the source file name.
5982 @item ssa
5983 @opindex fdump-tree-ssa
5984 Dump SSA related information to a file.  The file name is made by appending
5985 @file{.ssa} to the source file name.
5987 @item alias
5988 @opindex fdump-tree-alias
5989 Dump aliasing information for each function.  The file name is made by
5990 appending @file{.alias} to the source file name.
5992 @item ccp
5993 @opindex fdump-tree-ccp
5994 Dump each function after CCP@.  The file name is made by appending
5995 @file{.ccp} to the source file name.
5997 @item storeccp
5998 @opindex fdump-tree-storeccp
5999 Dump each function after STORE-CCP@.  The file name is made by appending
6000 @file{.storeccp} to the source file name.
6002 @item pre
6003 @opindex fdump-tree-pre
6004 Dump trees after partial redundancy elimination.  The file name is made
6005 by appending @file{.pre} to the source file name.
6007 @item fre
6008 @opindex fdump-tree-fre
6009 Dump trees after full redundancy elimination.  The file name is made
6010 by appending @file{.fre} to the source file name.
6012 @item copyprop
6013 @opindex fdump-tree-copyprop
6014 Dump trees after copy propagation.  The file name is made
6015 by appending @file{.copyprop} to the source file name.
6017 @item store_copyprop
6018 @opindex fdump-tree-store_copyprop
6019 Dump trees after store copy-propagation.  The file name is made
6020 by appending @file{.store_copyprop} to the source file name.
6022 @item dce
6023 @opindex fdump-tree-dce
6024 Dump each function after dead code elimination.  The file name is made by
6025 appending @file{.dce} to the source file name.
6027 @item mudflap
6028 @opindex fdump-tree-mudflap
6029 Dump each function after adding mudflap instrumentation.  The file name is
6030 made by appending @file{.mudflap} to the source file name.
6032 @item sra
6033 @opindex fdump-tree-sra
6034 Dump each function after performing scalar replacement of aggregates.  The
6035 file name is made by appending @file{.sra} to the source file name.
6037 @item sink
6038 @opindex fdump-tree-sink
6039 Dump each function after performing code sinking.  The file name is made
6040 by appending @file{.sink} to the source file name.
6042 @item dom
6043 @opindex fdump-tree-dom
6044 Dump each function after applying dominator tree optimizations.  The file
6045 name is made by appending @file{.dom} to the source file name.
6047 @item dse
6048 @opindex fdump-tree-dse
6049 Dump each function after applying dead store elimination.  The file
6050 name is made by appending @file{.dse} to the source file name.
6052 @item phiopt
6053 @opindex fdump-tree-phiopt
6054 Dump each function after optimizing PHI nodes into straightline code.  The file
6055 name is made by appending @file{.phiopt} to the source file name.
6057 @item forwprop
6058 @opindex fdump-tree-forwprop
6059 Dump each function after forward propagating single use variables.  The file
6060 name is made by appending @file{.forwprop} to the source file name.
6062 @item copyrename
6063 @opindex fdump-tree-copyrename
6064 Dump each function after applying the copy rename optimization.  The file
6065 name is made by appending @file{.copyrename} to the source file name.
6067 @item nrv
6068 @opindex fdump-tree-nrv
6069 Dump each function after applying the named return value optimization on
6070 generic trees.  The file name is made by appending @file{.nrv} to the source
6071 file name.
6073 @item vect
6074 @opindex fdump-tree-vect
6075 Dump each function after applying vectorization of loops.  The file name is
6076 made by appending @file{.vect} to the source file name.
6078 @item slp
6079 @opindex fdump-tree-slp
6080 Dump each function after applying vectorization of basic blocks.  The file name
6081 is made by appending @file{.slp} to the source file name.
6083 @item vrp
6084 @opindex fdump-tree-vrp
6085 Dump each function after Value Range Propagation (VRP).  The file name
6086 is made by appending @file{.vrp} to the source file name.
6088 @item all
6089 @opindex fdump-tree-all
6090 Enable all the available tree dumps with the flags provided in this option.
6091 @end table
6093 @item -fopt-info
6094 @itemx -fopt-info-@var{options}
6095 @itemx -fopt-info-@var{options}=@var{filename}
6096 @opindex fopt-info
6097 Controls optimization dumps from various optimization passes. If the
6098 @samp{-@var{options}} form is used, @var{options} is a list of
6099 @samp{-} separated options to select the dump details and
6100 optimizations.  If @var{options} is not specified, it defaults to
6101 @option{all} for details and @option{optall} for optimization
6102 groups. If the @var{filename} is not specified, it defaults to
6103 @file{stderr}. Note that the output @var{filename} will be overwritten
6104 in case of multiple translation units. If a combined output from
6105 multiple translation units is desired, @file{stderr} should be used
6106 instead.
6108 The options can be divided into two groups, 1) options describing the
6109 verbosity of the dump, and 2) options describing which optimizations
6110 should be included. The options from both the groups can be freely
6111 mixed as they are non-overlapping. However, in case of any conflicts,
6112 the latter options override the earlier options on the command
6113 line. Though multiple -fopt-info options are accepted, only one of
6114 them can have @option{=filename}. If other filenames are provided then
6115 all but the first one are ignored.
6117 The dump verbosity has the following options
6119 @table @samp
6120 @item optimized
6121 Print information when an optimization is successfully applied. It is
6122 up to a pass to decide which information is relevant. For example, the
6123 vectorizer passes print the source location of loops which got
6124 successfully vectorized.
6125 @item missed
6126 Print information about missed optimizations. Individual passes
6127 control which information to include in the output. For example,
6129 @smallexample
6130 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6131 @end smallexample
6133 will print information about missed optimization opportunities from
6134 vectorization passes on stderr.
6135 @item note
6136 Print verbose information about optimizations, such as certain
6137 transformations, more detailed messages about decisions etc.
6138 @item all
6139 Print detailed optimization information. This includes
6140 @var{optimized}, @var{missed}, and @var{note}.
6141 @end table
6143 The second set of options describes a group of optimizations and may
6144 include one or more of the following.
6146 @table @samp
6147 @item ipa
6148 Enable dumps from all interprocedural optimizations.
6149 @item loop
6150 Enable dumps from all loop optimizations.
6151 @item inline
6152 Enable dumps from all inlining optimizations.
6153 @item vec
6154 Enable dumps from all vectorization optimizations.
6155 @end table
6157 For example,
6158 @smallexample
6159 gcc -O3 -fopt-info-missed=missed.all
6160 @end smallexample
6162 outputs missed optimization report from all the passes into
6163 @file{missed.all}.
6165 As another example,
6166 @smallexample
6167 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6168 @end smallexample
6170 will output information about missed optimizations as well as
6171 optimized locations from all the inlining passes into
6172 @file{inline.txt}.
6174 If the @var{filename} is provided, then the dumps from all the
6175 applicable optimizations are concatenated into the @file{filename}.
6176 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6177 omitted, it defaults to @option{all-optall}, which means dump all
6178 available optimization info from all the passes. In the following
6179 example, all optimization info is output on to @file{stderr}.
6181 @smallexample
6182 gcc -O3 -fopt-info
6183 @end smallexample
6185 Note that @option{-fopt-info-vec-missed} behaves the same as
6186 @option{-fopt-info-missed-vec}.
6188 As another example, consider
6190 @smallexample
6191 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6192 @end smallexample
6194 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6195 in conflict since only one output file is allowed. In this case, only
6196 the first option takes effect and the subsequent options are
6197 ignored. Thus only the @file{vec.miss} is produced which cotaints
6198 dumps from the vectorizer about missed opportunities.
6200 @item -ftree-vectorizer-verbose=@var{n}
6201 @opindex ftree-vectorizer-verbose
6202 This option is deprecated and is implemented in terms of
6203 @option{-fopt-info}. Please use @option{-fopt-info-@var{kind}} form
6204 instead, where @var{kind} is one of the valid opt-info options. It
6205 prints additional optimization information.  For @var{n}=0 no
6206 diagnostic information is reported.  If @var{n}=1 the vectorizer
6207 reports each loop that got vectorized, and the total number of loops
6208 that got vectorized.  If @var{n}=2 the vectorizer reports locations
6209 which could not be vectorized and the reasons for those. For any
6210 higher verbosity levels all the analysis and transformation
6211 information from the vectorizer is reported.
6213 Note that the information output by @option{-ftree-vectorizer-verbose}
6214 option is sent to @file{stderr}. If the equivalent form
6215 @option{-fopt-info-@var{options}=@var{filename}} is used then the
6216 output is sent into @var{filename} instead.
6218 @item -frandom-seed=@var{string}
6219 @opindex frandom-seed
6220 This option provides a seed that GCC uses in place of
6221 random numbers in generating certain symbol names
6222 that have to be different in every compiled file.  It is also used to
6223 place unique stamps in coverage data files and the object files that
6224 produce them.  You can use the @option{-frandom-seed} option to produce
6225 reproducibly identical object files.
6227 The @var{string} should be different for every file you compile.
6229 @item -fsched-verbose=@var{n}
6230 @opindex fsched-verbose
6231 On targets that use instruction scheduling, this option controls the
6232 amount of debugging output the scheduler prints.  This information is
6233 written to standard error, unless @option{-fdump-rtl-sched1} or
6234 @option{-fdump-rtl-sched2} is specified, in which case it is output
6235 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6236 respectively.  However for @var{n} greater than nine, the output is
6237 always printed to standard error.
6239 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6240 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6241 For @var{n} greater than one, it also output basic block probabilities,
6242 detailed ready list information and unit/insn info.  For @var{n} greater
6243 than two, it includes RTL at abort point, control-flow and regions info.
6244 And for @var{n} over four, @option{-fsched-verbose} also includes
6245 dependence info.
6247 @item -save-temps
6248 @itemx -save-temps=cwd
6249 @opindex save-temps
6250 Store the usual ``temporary'' intermediate files permanently; place them
6251 in the current directory and name them based on the source file.  Thus,
6252 compiling @file{foo.c} with @option{-c -save-temps} produces files
6253 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6254 preprocessed @file{foo.i} output file even though the compiler now
6255 normally uses an integrated preprocessor.
6257 When used in combination with the @option{-x} command-line option,
6258 @option{-save-temps} is sensible enough to avoid over writing an
6259 input source file with the same extension as an intermediate file.
6260 The corresponding intermediate file may be obtained by renaming the
6261 source file before using @option{-save-temps}.
6263 If you invoke GCC in parallel, compiling several different source
6264 files that share a common base name in different subdirectories or the
6265 same source file compiled for multiple output destinations, it is
6266 likely that the different parallel compilers will interfere with each
6267 other, and overwrite the temporary files.  For instance:
6269 @smallexample
6270 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6271 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6272 @end smallexample
6274 may result in @file{foo.i} and @file{foo.o} being written to
6275 simultaneously by both compilers.
6277 @item -save-temps=obj
6278 @opindex save-temps=obj
6279 Store the usual ``temporary'' intermediate files permanently.  If the
6280 @option{-o} option is used, the temporary files are based on the
6281 object file.  If the @option{-o} option is not used, the
6282 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6284 For example:
6286 @smallexample
6287 gcc -save-temps=obj -c foo.c
6288 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6289 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6290 @end smallexample
6292 @noindent
6293 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6294 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6295 @file{dir2/yfoobar.o}.
6297 @item -time@r{[}=@var{file}@r{]}
6298 @opindex time
6299 Report the CPU time taken by each subprocess in the compilation
6300 sequence.  For C source files, this is the compiler proper and assembler
6301 (plus the linker if linking is done).
6303 Without the specification of an output file, the output looks like this:
6305 @smallexample
6306 # cc1 0.12 0.01
6307 # as 0.00 0.01
6308 @end smallexample
6310 The first number on each line is the ``user time'', that is time spent
6311 executing the program itself.  The second number is ``system time'',
6312 time spent executing operating system routines on behalf of the program.
6313 Both numbers are in seconds.
6315 With the specification of an output file, the output is appended to the
6316 named file, and it looks like this:
6318 @smallexample
6319 0.12 0.01 cc1 @var{options}
6320 0.00 0.01 as @var{options}
6321 @end smallexample
6323 The ``user time'' and the ``system time'' are moved before the program
6324 name, and the options passed to the program are displayed, so that one
6325 can later tell what file was being compiled, and with which options.
6327 @item -fvar-tracking
6328 @opindex fvar-tracking
6329 Run variable tracking pass.  It computes where variables are stored at each
6330 position in code.  Better debugging information is then generated
6331 (if the debugging information format supports this information).
6333 It is enabled by default when compiling with optimization (@option{-Os},
6334 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6335 the debug info format supports it.
6337 @item -fvar-tracking-assignments
6338 @opindex fvar-tracking-assignments
6339 @opindex fno-var-tracking-assignments
6340 Annotate assignments to user variables early in the compilation and
6341 attempt to carry the annotations over throughout the compilation all the
6342 way to the end, in an attempt to improve debug information while
6343 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6345 It can be enabled even if var-tracking is disabled, in which case
6346 annotations are created and maintained, but discarded at the end.
6348 @item -fvar-tracking-assignments-toggle
6349 @opindex fvar-tracking-assignments-toggle
6350 @opindex fno-var-tracking-assignments-toggle
6351 Toggle @option{-fvar-tracking-assignments}, in the same way that
6352 @option{-gtoggle} toggles @option{-g}.
6354 @item -print-file-name=@var{library}
6355 @opindex print-file-name
6356 Print the full absolute name of the library file @var{library} that
6357 would be used when linking---and don't do anything else.  With this
6358 option, GCC does not compile or link anything; it just prints the
6359 file name.
6361 @item -print-multi-directory
6362 @opindex print-multi-directory
6363 Print the directory name corresponding to the multilib selected by any
6364 other switches present in the command line.  This directory is supposed
6365 to exist in @env{GCC_EXEC_PREFIX}.
6367 @item -print-multi-lib
6368 @opindex print-multi-lib
6369 Print the mapping from multilib directory names to compiler switches
6370 that enable them.  The directory name is separated from the switches by
6371 @samp{;}, and each switch starts with an @samp{@@} instead of the
6372 @samp{-}, without spaces between multiple switches.  This is supposed to
6373 ease shell processing.
6375 @item -print-multi-os-directory
6376 @opindex print-multi-os-directory
6377 Print the path to OS libraries for the selected
6378 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6379 present in the @file{lib} subdirectory and no multilibs are used, this is
6380 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6381 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6382 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6383 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6385 @item -print-multiarch
6386 @opindex print-multiarch
6387 Print the path to OS libraries for the selected multiarch,
6388 relative to some @file{lib} subdirectory.
6390 @item -print-prog-name=@var{program}
6391 @opindex print-prog-name
6392 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6394 @item -print-libgcc-file-name
6395 @opindex print-libgcc-file-name
6396 Same as @option{-print-file-name=libgcc.a}.
6398 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6399 but you do want to link with @file{libgcc.a}.  You can do:
6401 @smallexample
6402 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6403 @end smallexample
6405 @item -print-search-dirs
6406 @opindex print-search-dirs
6407 Print the name of the configured installation directory and a list of
6408 program and library directories @command{gcc} searches---and don't do anything else.
6410 This is useful when @command{gcc} prints the error message
6411 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6412 To resolve this you either need to put @file{cpp0} and the other compiler
6413 components where @command{gcc} expects to find them, or you can set the environment
6414 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6415 Don't forget the trailing @samp{/}.
6416 @xref{Environment Variables}.
6418 @item -print-sysroot
6419 @opindex print-sysroot
6420 Print the target sysroot directory that is used during
6421 compilation.  This is the target sysroot specified either at configure
6422 time or using the @option{--sysroot} option, possibly with an extra
6423 suffix that depends on compilation options.  If no target sysroot is
6424 specified, the option prints nothing.
6426 @item -print-sysroot-headers-suffix
6427 @opindex print-sysroot-headers-suffix
6428 Print the suffix added to the target sysroot when searching for
6429 headers, or give an error if the compiler is not configured with such
6430 a suffix---and don't do anything else.
6432 @item -dumpmachine
6433 @opindex dumpmachine
6434 Print the compiler's target machine (for example,
6435 @samp{i686-pc-linux-gnu})---and don't do anything else.
6437 @item -dumpversion
6438 @opindex dumpversion
6439 Print the compiler version (for example, @samp{3.0})---and don't do
6440 anything else.
6442 @item -dumpspecs
6443 @opindex dumpspecs
6444 Print the compiler's built-in specs---and don't do anything else.  (This
6445 is used when GCC itself is being built.)  @xref{Spec Files}.
6447 @item -fno-eliminate-unused-debug-types
6448 @opindex feliminate-unused-debug-types
6449 @opindex fno-eliminate-unused-debug-types
6450 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6451 output for types that are nowhere used in the source file being compiled.
6452 Sometimes it is useful to have GCC emit debugging
6453 information for all types declared in a compilation
6454 unit, regardless of whether or not they are actually used
6455 in that compilation unit, for example 
6456 if, in the debugger, you want to cast a value to a type that is
6457 not actually used in your program (but is declared).  More often,
6458 however, this results in a significant amount of wasted space.
6459 @end table
6461 @node Optimize Options
6462 @section Options That Control Optimization
6463 @cindex optimize options
6464 @cindex options, optimization
6466 These options control various sorts of optimizations.
6468 Without any optimization option, the compiler's goal is to reduce the
6469 cost of compilation and to make debugging produce the expected
6470 results.  Statements are independent: if you stop the program with a
6471 breakpoint between statements, you can then assign a new value to any
6472 variable or change the program counter to any other statement in the
6473 function and get exactly the results you expect from the source
6474 code.
6476 Turning on optimization flags makes the compiler attempt to improve
6477 the performance and/or code size at the expense of compilation time
6478 and possibly the ability to debug the program.
6480 The compiler performs optimization based on the knowledge it has of the
6481 program.  Compiling multiple files at once to a single output file mode allows
6482 the compiler to use information gained from all of the files when compiling
6483 each of them.
6485 Not all optimizations are controlled directly by a flag.  Only
6486 optimizations that have a flag are listed in this section.
6488 Most optimizations are only enabled if an @option{-O} level is set on
6489 the command line.  Otherwise they are disabled, even if individual
6490 optimization flags are specified.
6492 Depending on the target and how GCC was configured, a slightly different
6493 set of optimizations may be enabled at each @option{-O} level than
6494 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6495 to find out the exact set of optimizations that are enabled at each level.
6496 @xref{Overall Options}, for examples.
6498 @table @gcctabopt
6499 @item -O
6500 @itemx -O1
6501 @opindex O
6502 @opindex O1
6503 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6504 more memory for a large function.
6506 With @option{-O}, the compiler tries to reduce code size and execution
6507 time, without performing any optimizations that take a great deal of
6508 compilation time.
6510 @option{-O} turns on the following optimization flags:
6511 @gccoptlist{
6512 -fauto-inc-dec @gol
6513 -fcompare-elim @gol
6514 -fcprop-registers @gol
6515 -fdce @gol
6516 -fdefer-pop @gol
6517 -fdelayed-branch @gol
6518 -fdse @gol
6519 -fguess-branch-probability @gol
6520 -fif-conversion2 @gol
6521 -fif-conversion @gol
6522 -fipa-pure-const @gol
6523 -fipa-profile @gol
6524 -fipa-reference @gol
6525 -fmerge-constants
6526 -fsplit-wide-types @gol
6527 -ftree-bit-ccp @gol
6528 -ftree-builtin-call-dce @gol
6529 -ftree-ccp @gol
6530 -ftree-ch @gol
6531 -ftree-copyrename @gol
6532 -ftree-dce @gol
6533 -ftree-dominator-opts @gol
6534 -ftree-dse @gol
6535 -ftree-forwprop @gol
6536 -ftree-fre @gol
6537 -ftree-phiprop @gol
6538 -ftree-slsr @gol
6539 -ftree-sra @gol
6540 -ftree-pta @gol
6541 -ftree-ter @gol
6542 -funit-at-a-time}
6544 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6545 where doing so does not interfere with debugging.
6547 @item -O2
6548 @opindex O2
6549 Optimize even more.  GCC performs nearly all supported optimizations
6550 that do not involve a space-speed tradeoff.
6551 As compared to @option{-O}, this option increases both compilation time
6552 and the performance of the generated code.
6554 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6555 also turns on the following optimization flags:
6556 @gccoptlist{-fthread-jumps @gol
6557 -falign-functions  -falign-jumps @gol
6558 -falign-loops  -falign-labels @gol
6559 -fcaller-saves @gol
6560 -fcrossjumping @gol
6561 -fcse-follow-jumps  -fcse-skip-blocks @gol
6562 -fdelete-null-pointer-checks @gol
6563 -fdevirtualize @gol
6564 -fexpensive-optimizations @gol
6565 -fgcse  -fgcse-lm  @gol
6566 -fhoist-adjacent-loads @gol
6567 -finline-small-functions @gol
6568 -findirect-inlining @gol
6569 -fipa-sra @gol
6570 -foptimize-sibling-calls @gol
6571 -fpartial-inlining @gol
6572 -fpeephole2 @gol
6573 -fregmove @gol
6574 -freorder-blocks  -freorder-functions @gol
6575 -frerun-cse-after-loop  @gol
6576 -fsched-interblock  -fsched-spec @gol
6577 -fschedule-insns  -fschedule-insns2 @gol
6578 -fstrict-aliasing -fstrict-overflow @gol
6579 -ftree-switch-conversion -ftree-tail-merge @gol
6580 -ftree-pre @gol
6581 -ftree-vrp}
6583 Please note the warning under @option{-fgcse} about
6584 invoking @option{-O2} on programs that use computed gotos.
6586 @item -O3
6587 @opindex O3
6588 Optimize yet more.  @option{-O3} turns on all optimizations specified
6589 by @option{-O2} and also turns on the @option{-finline-functions},
6590 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6591 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6592 @option{-fvect-cost-model},
6593 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6595 @item -O0
6596 @opindex O0
6597 Reduce compilation time and make debugging produce the expected
6598 results.  This is the default.
6600 @item -Os
6601 @opindex Os
6602 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6603 do not typically increase code size.  It also performs further
6604 optimizations designed to reduce code size.
6606 @option{-Os} disables the following optimization flags:
6607 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6608 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6609 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6611 @item -Ofast
6612 @opindex Ofast
6613 Disregard strict standards compliance.  @option{-Ofast} enables all
6614 @option{-O3} optimizations.  It also enables optimizations that are not
6615 valid for all standard-compliant programs.
6616 It turns on @option{-ffast-math} and the Fortran-specific
6617 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6619 @item -Og
6620 @opindex Og
6621 Optimize debugging experience.  @option{-Og} enables optimizations
6622 that do not interfere with debugging. It should be the optimization
6623 level of choice for the standard edit-compile-debug cycle, offering
6624 a reasonable level of optimization while maintaining fast compilation
6625 and a good debugging experience.
6627 If you use multiple @option{-O} options, with or without level numbers,
6628 the last such option is the one that is effective.
6629 @end table
6631 Options of the form @option{-f@var{flag}} specify machine-independent
6632 flags.  Most flags have both positive and negative forms; the negative
6633 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6634 below, only one of the forms is listed---the one you typically 
6635 use.  You can figure out the other form by either removing @samp{no-}
6636 or adding it.
6638 The following options control specific optimizations.  They are either
6639 activated by @option{-O} options or are related to ones that are.  You
6640 can use the following flags in the rare cases when ``fine-tuning'' of
6641 optimizations to be performed is desired.
6643 @table @gcctabopt
6644 @item -fno-default-inline
6645 @opindex fno-default-inline
6646 Do not make member functions inline by default merely because they are
6647 defined inside the class scope (C++ only).  Otherwise, when you specify
6648 @w{@option{-O}}, member functions defined inside class scope are compiled
6649 inline by default; i.e., you don't need to add @samp{inline} in front of
6650 the member function name.
6652 @item -fno-defer-pop
6653 @opindex fno-defer-pop
6654 Always pop the arguments to each function call as soon as that function
6655 returns.  For machines that must pop arguments after a function call,
6656 the compiler normally lets arguments accumulate on the stack for several
6657 function calls and pops them all at once.
6659 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6661 @item -fforward-propagate
6662 @opindex fforward-propagate
6663 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6664 instructions and checks if the result can be simplified.  If loop unrolling
6665 is active, two passes are performed and the second is scheduled after
6666 loop unrolling.
6668 This option is enabled by default at optimization levels @option{-O},
6669 @option{-O2}, @option{-O3}, @option{-Os}.
6671 @item -ffp-contract=@var{style}
6672 @opindex ffp-contract
6673 @option{-ffp-contract=off} disables floating-point expression contraction.
6674 @option{-ffp-contract=fast} enables floating-point expression contraction
6675 such as forming of fused multiply-add operations if the target has
6676 native support for them.
6677 @option{-ffp-contract=on} enables floating-point expression contraction
6678 if allowed by the language standard.  This is currently not implemented
6679 and treated equal to @option{-ffp-contract=off}.
6681 The default is @option{-ffp-contract=fast}.
6683 @item -fomit-frame-pointer
6684 @opindex fomit-frame-pointer
6685 Don't keep the frame pointer in a register for functions that
6686 don't need one.  This avoids the instructions to save, set up and
6687 restore frame pointers; it also makes an extra register available
6688 in many functions.  @strong{It also makes debugging impossible on
6689 some machines.}
6691 On some machines, such as the VAX, this flag has no effect, because
6692 the standard calling sequence automatically handles the frame pointer
6693 and nothing is saved by pretending it doesn't exist.  The
6694 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6695 whether a target machine supports this flag.  @xref{Registers,,Register
6696 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6698 Starting with GCC version 4.6, the default setting (when not optimizing for
6699 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6700 @option{-fomit-frame-pointer}.  The default can be reverted to
6701 @option{-fno-omit-frame-pointer} by configuring GCC with the
6702 @option{--enable-frame-pointer} configure option.
6704 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6706 @item -foptimize-sibling-calls
6707 @opindex foptimize-sibling-calls
6708 Optimize sibling and tail recursive calls.
6710 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6712 @item -fno-inline
6713 @opindex fno-inline
6714 Do not expand any functions inline apart from those marked with
6715 the @code{always_inline} attribute.  This is the default when not
6716 optimizing.
6718 Single functions can be exempted from inlining by marking them
6719 with the @code{noinline} attribute.
6721 @item -finline-small-functions
6722 @opindex finline-small-functions
6723 Integrate functions into their callers when their body is smaller than expected
6724 function call code (so overall size of program gets smaller).  The compiler
6725 heuristically decides which functions are simple enough to be worth integrating
6726 in this way.  This inlining applies to all functions, even those not declared
6727 inline.
6729 Enabled at level @option{-O2}.
6731 @item -findirect-inlining
6732 @opindex findirect-inlining
6733 Inline also indirect calls that are discovered to be known at compile
6734 time thanks to previous inlining.  This option has any effect only
6735 when inlining itself is turned on by the @option{-finline-functions}
6736 or @option{-finline-small-functions} options.
6738 Enabled at level @option{-O2}.
6740 @item -finline-functions
6741 @opindex finline-functions
6742 Consider all functions for inlining, even if they are not declared inline.
6743 The compiler heuristically decides which functions are worth integrating
6744 in this way.
6746 If all calls to a given function are integrated, and the function is
6747 declared @code{static}, then the function is normally not output as
6748 assembler code in its own right.
6750 Enabled at level @option{-O3}.
6752 @item -finline-functions-called-once
6753 @opindex finline-functions-called-once
6754 Consider all @code{static} functions called once for inlining into their
6755 caller even if they are not marked @code{inline}.  If a call to a given
6756 function is integrated, then the function is not output as assembler code
6757 in its own right.
6759 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6761 @item -fearly-inlining
6762 @opindex fearly-inlining
6763 Inline functions marked by @code{always_inline} and functions whose body seems
6764 smaller than the function call overhead early before doing
6765 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6766 makes profiling significantly cheaper and usually inlining faster on programs
6767 having large chains of nested wrapper functions.
6769 Enabled by default.
6771 @item -fipa-sra
6772 @opindex fipa-sra
6773 Perform interprocedural scalar replacement of aggregates, removal of
6774 unused parameters and replacement of parameters passed by reference
6775 by parameters passed by value.
6777 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6779 @item -finline-limit=@var{n}
6780 @opindex finline-limit
6781 By default, GCC limits the size of functions that can be inlined.  This flag
6782 allows coarse control of this limit.  @var{n} is the size of functions that
6783 can be inlined in number of pseudo instructions.
6785 Inlining is actually controlled by a number of parameters, which may be
6786 specified individually by using @option{--param @var{name}=@var{value}}.
6787 The @option{-finline-limit=@var{n}} option sets some of these parameters
6788 as follows:
6790 @table @gcctabopt
6791 @item max-inline-insns-single
6792 is set to @var{n}/2.
6793 @item max-inline-insns-auto
6794 is set to @var{n}/2.
6795 @end table
6797 See below for a documentation of the individual
6798 parameters controlling inlining and for the defaults of these parameters.
6800 @emph{Note:} there may be no value to @option{-finline-limit} that results
6801 in default behavior.
6803 @emph{Note:} pseudo instruction represents, in this particular context, an
6804 abstract measurement of function's size.  In no way does it represent a count
6805 of assembly instructions and as such its exact meaning might change from one
6806 release to an another.
6808 @item -fno-keep-inline-dllexport
6809 @opindex -fno-keep-inline-dllexport
6810 This is a more fine-grained version of @option{-fkeep-inline-functions},
6811 which applies only to functions that are declared using the @code{dllexport}
6812 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6813 Functions}.)
6815 @item -fkeep-inline-functions
6816 @opindex fkeep-inline-functions
6817 In C, emit @code{static} functions that are declared @code{inline}
6818 into the object file, even if the function has been inlined into all
6819 of its callers.  This switch does not affect functions using the
6820 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6821 inline functions into the object file.
6823 @item -fkeep-static-consts
6824 @opindex fkeep-static-consts
6825 Emit variables declared @code{static const} when optimization isn't turned
6826 on, even if the variables aren't referenced.
6828 GCC enables this option by default.  If you want to force the compiler to
6829 check if a variable is referenced, regardless of whether or not
6830 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6832 @item -fmerge-constants
6833 @opindex fmerge-constants
6834 Attempt to merge identical constants (string constants and floating-point
6835 constants) across compilation units.
6837 This option is the default for optimized compilation if the assembler and
6838 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6839 behavior.
6841 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6843 @item -fmerge-all-constants
6844 @opindex fmerge-all-constants
6845 Attempt to merge identical constants and identical variables.
6847 This option implies @option{-fmerge-constants}.  In addition to
6848 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6849 arrays or initialized constant variables with integral or floating-point
6850 types.  Languages like C or C++ require each variable, including multiple
6851 instances of the same variable in recursive calls, to have distinct locations,
6852 so using this option results in non-conforming
6853 behavior.
6855 @item -fmodulo-sched
6856 @opindex fmodulo-sched
6857 Perform swing modulo scheduling immediately before the first scheduling
6858 pass.  This pass looks at innermost loops and reorders their
6859 instructions by overlapping different iterations.
6861 @item -fmodulo-sched-allow-regmoves
6862 @opindex fmodulo-sched-allow-regmoves
6863 Perform more aggressive SMS-based modulo scheduling with register moves
6864 allowed.  By setting this flag certain anti-dependences edges are
6865 deleted, which triggers the generation of reg-moves based on the
6866 life-range analysis.  This option is effective only with
6867 @option{-fmodulo-sched} enabled.
6869 @item -fno-branch-count-reg
6870 @opindex fno-branch-count-reg
6871 Do not use ``decrement and branch'' instructions on a count register,
6872 but instead generate a sequence of instructions that decrement a
6873 register, compare it against zero, then branch based upon the result.
6874 This option is only meaningful on architectures that support such
6875 instructions, which include x86, PowerPC, IA-64 and S/390.
6877 The default is @option{-fbranch-count-reg}.
6879 @item -fno-function-cse
6880 @opindex fno-function-cse
6881 Do not put function addresses in registers; make each instruction that
6882 calls a constant function contain the function's address explicitly.
6884 This option results in less efficient code, but some strange hacks
6885 that alter the assembler output may be confused by the optimizations
6886 performed when this option is not used.
6888 The default is @option{-ffunction-cse}
6890 @item -fno-zero-initialized-in-bss
6891 @opindex fno-zero-initialized-in-bss
6892 If the target supports a BSS section, GCC by default puts variables that
6893 are initialized to zero into BSS@.  This can save space in the resulting
6894 code.
6896 This option turns off this behavior because some programs explicitly
6897 rely on variables going to the data section---e.g., so that the
6898 resulting executable can find the beginning of that section and/or make
6899 assumptions based on that.
6901 The default is @option{-fzero-initialized-in-bss}.
6903 @item -fmudflap -fmudflapth -fmudflapir
6904 @opindex fmudflap
6905 @opindex fmudflapth
6906 @opindex fmudflapir
6907 @cindex bounds checking
6908 @cindex mudflap
6909 For front-ends that support it (C and C++), instrument all risky
6910 pointer/array dereferencing operations, some standard library
6911 string/heap functions, and some other associated constructs with
6912 range/validity tests.  Modules so instrumented should be immune to
6913 buffer overflows, invalid heap use, and some other classes of C/C++
6914 programming errors.  The instrumentation relies on a separate runtime
6915 library (@file{libmudflap}), which is linked into a program if
6916 @option{-fmudflap} is given at link time.  Run-time behavior of the
6917 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6918 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6919 for its options.
6921 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6922 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6923 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6924 instrumentation should ignore pointer reads.  This produces less
6925 instrumentation (and therefore faster execution) and still provides
6926 some protection against outright memory corrupting writes, but allows
6927 erroneously read data to propagate within a program.
6929 @item -fthread-jumps
6930 @opindex fthread-jumps
6931 Perform optimizations that check to see if a jump branches to a
6932 location where another comparison subsumed by the first is found.  If
6933 so, the first branch is redirected to either the destination of the
6934 second branch or a point immediately following it, depending on whether
6935 the condition is known to be true or false.
6937 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6939 @item -fsplit-wide-types
6940 @opindex fsplit-wide-types
6941 When using a type that occupies multiple registers, such as @code{long
6942 long} on a 32-bit system, split the registers apart and allocate them
6943 independently.  This normally generates better code for those types,
6944 but may make debugging more difficult.
6946 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6947 @option{-Os}.
6949 @item -fcse-follow-jumps
6950 @opindex fcse-follow-jumps
6951 In common subexpression elimination (CSE), scan through jump instructions
6952 when the target of the jump is not reached by any other path.  For
6953 example, when CSE encounters an @code{if} statement with an
6954 @code{else} clause, CSE follows the jump when the condition
6955 tested is false.
6957 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6959 @item -fcse-skip-blocks
6960 @opindex fcse-skip-blocks
6961 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6962 follow jumps that conditionally skip over blocks.  When CSE
6963 encounters a simple @code{if} statement with no else clause,
6964 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6965 body of the @code{if}.
6967 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6969 @item -frerun-cse-after-loop
6970 @opindex frerun-cse-after-loop
6971 Re-run common subexpression elimination after loop optimizations are
6972 performed.
6974 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6976 @item -fgcse
6977 @opindex fgcse
6978 Perform a global common subexpression elimination pass.
6979 This pass also performs global constant and copy propagation.
6981 @emph{Note:} When compiling a program using computed gotos, a GCC
6982 extension, you may get better run-time performance if you disable
6983 the global common subexpression elimination pass by adding
6984 @option{-fno-gcse} to the command line.
6986 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6988 @item -fgcse-lm
6989 @opindex fgcse-lm
6990 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6991 attempts to move loads that are only killed by stores into themselves.  This
6992 allows a loop containing a load/store sequence to be changed to a load outside
6993 the loop, and a copy/store within the loop.
6995 Enabled by default when @option{-fgcse} is enabled.
6997 @item -fgcse-sm
6998 @opindex fgcse-sm
6999 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7000 global common subexpression elimination.  This pass attempts to move
7001 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7002 loops containing a load/store sequence can be changed to a load before
7003 the loop and a store after the loop.
7005 Not enabled at any optimization level.
7007 @item -fgcse-las
7008 @opindex fgcse-las
7009 When @option{-fgcse-las} is enabled, the global common subexpression
7010 elimination pass eliminates redundant loads that come after stores to the
7011 same memory location (both partial and full redundancies).
7013 Not enabled at any optimization level.
7015 @item -fgcse-after-reload
7016 @opindex fgcse-after-reload
7017 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7018 pass is performed after reload.  The purpose of this pass is to clean up
7019 redundant spilling.
7021 @item -faggressive-loop-optimizations
7022 @opindex faggressive-loop-optimizations
7023 This option tells the loop optimizer to use language constraints to
7024 derive bounds for the number of iterations of a loop.  This assumes that
7025 loop code does not invoke undefined behavior by for example causing signed
7026 integer overflows or out-of-bound array accesses.  The bounds for the
7027 number of iterations of a loop are used to guide loop unrolling and peeling
7028 and loop exit test optimizations.
7029 This option is enabled by default.
7031 @item -funsafe-loop-optimizations
7032 @opindex funsafe-loop-optimizations
7033 This option tells the loop optimizer to assume that loop indices do not
7034 overflow, and that loops with nontrivial exit condition are not
7035 infinite.  This enables a wider range of loop optimizations even if
7036 the loop optimizer itself cannot prove that these assumptions are valid.
7037 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7038 if it finds this kind of loop.
7040 @item -fcrossjumping
7041 @opindex fcrossjumping
7042 Perform cross-jumping transformation.
7043 This transformation unifies equivalent code and saves code size.  The
7044 resulting code may or may not perform better than without cross-jumping.
7046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7048 @item -fauto-inc-dec
7049 @opindex fauto-inc-dec
7050 Combine increments or decrements of addresses with memory accesses.
7051 This pass is always skipped on architectures that do not have
7052 instructions to support this.  Enabled by default at @option{-O} and
7053 higher on architectures that support this.
7055 @item -fdce
7056 @opindex fdce
7057 Perform dead code elimination (DCE) on RTL@.
7058 Enabled by default at @option{-O} and higher.
7060 @item -fdse
7061 @opindex fdse
7062 Perform dead store elimination (DSE) on RTL@.
7063 Enabled by default at @option{-O} and higher.
7065 @item -fif-conversion
7066 @opindex fif-conversion
7067 Attempt to transform conditional jumps into branch-less equivalents.  This
7068 includes use of conditional moves, min, max, set flags and abs instructions, and
7069 some tricks doable by standard arithmetics.  The use of conditional execution
7070 on chips where it is available is controlled by @code{if-conversion2}.
7072 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7074 @item -fif-conversion2
7075 @opindex fif-conversion2
7076 Use conditional execution (where available) to transform conditional jumps into
7077 branch-less equivalents.
7079 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7081 @item -fdelete-null-pointer-checks
7082 @opindex fdelete-null-pointer-checks
7083 Assume that programs cannot safely dereference null pointers, and that
7084 no code or data element resides there.  This enables simple constant
7085 folding optimizations at all optimization levels.  In addition, other
7086 optimization passes in GCC use this flag to control global dataflow
7087 analyses that eliminate useless checks for null pointers; these assume
7088 that if a pointer is checked after it has already been dereferenced,
7089 it cannot be null.
7091 Note however that in some environments this assumption is not true.
7092 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7093 for programs that depend on that behavior.
7095 Some targets, especially embedded ones, disable this option at all levels.
7096 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7097 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7098 are enabled independently at different optimization levels.
7100 @item -fdevirtualize
7101 @opindex fdevirtualize
7102 Attempt to convert calls to virtual functions to direct calls.  This
7103 is done both within a procedure and interprocedurally as part of
7104 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7105 propagation (@option{-fipa-cp}).
7106 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7108 @item -fexpensive-optimizations
7109 @opindex fexpensive-optimizations
7110 Perform a number of minor optimizations that are relatively expensive.
7112 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7114 @item -free
7115 @opindex free
7116 Attempt to remove redundant extension instructions.  This is especially
7117 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7118 registers after writing to their lower 32-bit half.
7120 Enabled for x86 at levels @option{-O2}, @option{-O3}.
7122 @item -foptimize-register-move
7123 @itemx -fregmove
7124 @opindex foptimize-register-move
7125 @opindex fregmove
7126 Attempt to reassign register numbers in move instructions and as
7127 operands of other simple instructions in order to maximize the amount of
7128 register tying.  This is especially helpful on machines with two-operand
7129 instructions.
7131 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
7132 optimization.
7134 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7136 @item -fira-algorithm=@var{algorithm}
7137 Use the specified coloring algorithm for the integrated register
7138 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7139 specifies Chow's priority coloring, or @samp{CB}, which specifies
7140 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7141 for all architectures, but for those targets that do support it, it is
7142 the default because it generates better code.
7144 @item -fira-region=@var{region}
7145 Use specified regions for the integrated register allocator.  The
7146 @var{region} argument should be one of the following:
7148 @table @samp
7150 @item all
7151 Use all loops as register allocation regions.
7152 This can give the best results for machines with a small and/or
7153 irregular register set.
7155 @item mixed
7156 Use all loops except for loops with small register pressure 
7157 as the regions.  This value usually gives
7158 the best results in most cases and for most architectures,
7159 and is enabled by default when compiling with optimization for speed
7160 (@option{-O}, @option{-O2}, @dots{}).
7162 @item one
7163 Use all functions as a single region.  
7164 This typically results in the smallest code size, and is enabled by default for
7165 @option{-Os} or @option{-O0}.
7167 @end table
7169 @item -fira-hoist-pressure
7170 @opindex fira-hoist-pressure
7171 Use IRA to evaluate register pressure in the code hoisting pass for
7172 decisions to hoist expressions.  This option usually results in smaller
7173 code, but it can slow the compiler down.
7175 This option is enabled at level @option{-Os} for all targets.
7177 @item -fira-loop-pressure
7178 @opindex fira-loop-pressure
7179 Use IRA to evaluate register pressure in loops for decisions to move
7180 loop invariants.  This option usually results in generation
7181 of faster and smaller code on machines with large register files (>= 32
7182 registers), but it can slow the compiler down.
7184 This option is enabled at level @option{-O3} for some targets.
7186 @item -fno-ira-share-save-slots
7187 @opindex fno-ira-share-save-slots
7188 Disable sharing of stack slots used for saving call-used hard
7189 registers living through a call.  Each hard register gets a
7190 separate stack slot, and as a result function stack frames are
7191 larger.
7193 @item -fno-ira-share-spill-slots
7194 @opindex fno-ira-share-spill-slots
7195 Disable sharing of stack slots allocated for pseudo-registers.  Each
7196 pseudo-register that does not get a hard register gets a separate
7197 stack slot, and as a result function stack frames are larger.
7199 @item -fira-verbose=@var{n}
7200 @opindex fira-verbose
7201 Control the verbosity of the dump file for the integrated register allocator.
7202 The default value is 5.  If the value @var{n} is greater or equal to 10,
7203 the dump output is sent to stderr using the same format as @var{n} minus 10.
7205 @item -fdelayed-branch
7206 @opindex fdelayed-branch
7207 If supported for the target machine, attempt to reorder instructions
7208 to exploit instruction slots available after delayed branch
7209 instructions.
7211 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7213 @item -fschedule-insns
7214 @opindex fschedule-insns
7215 If supported for the target machine, attempt to reorder instructions to
7216 eliminate execution stalls due to required data being unavailable.  This
7217 helps machines that have slow floating point or memory load instructions
7218 by allowing other instructions to be issued until the result of the load
7219 or floating-point instruction is required.
7221 Enabled at levels @option{-O2}, @option{-O3}.
7223 @item -fschedule-insns2
7224 @opindex fschedule-insns2
7225 Similar to @option{-fschedule-insns}, but requests an additional pass of
7226 instruction scheduling after register allocation has been done.  This is
7227 especially useful on machines with a relatively small number of
7228 registers and where memory load instructions take more than one cycle.
7230 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7232 @item -fno-sched-interblock
7233 @opindex fno-sched-interblock
7234 Don't schedule instructions across basic blocks.  This is normally
7235 enabled by default when scheduling before register allocation, i.e.@:
7236 with @option{-fschedule-insns} or at @option{-O2} or higher.
7238 @item -fno-sched-spec
7239 @opindex fno-sched-spec
7240 Don't allow speculative motion of non-load instructions.  This is normally
7241 enabled by default when scheduling before register allocation, i.e.@:
7242 with @option{-fschedule-insns} or at @option{-O2} or higher.
7244 @item -fsched-pressure
7245 @opindex fsched-pressure
7246 Enable register pressure sensitive insn scheduling before register
7247 allocation.  This only makes sense when scheduling before register
7248 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7249 @option{-O2} or higher.  Usage of this option can improve the
7250 generated code and decrease its size by preventing register pressure
7251 increase above the number of available hard registers and subsequent
7252 spills in register allocation.
7254 @item -fsched-spec-load
7255 @opindex fsched-spec-load
7256 Allow speculative motion of some load instructions.  This only makes
7257 sense when scheduling before register allocation, i.e.@: with
7258 @option{-fschedule-insns} or at @option{-O2} or higher.
7260 @item -fsched-spec-load-dangerous
7261 @opindex fsched-spec-load-dangerous
7262 Allow speculative motion of more load instructions.  This only makes
7263 sense when scheduling before register allocation, i.e.@: with
7264 @option{-fschedule-insns} or at @option{-O2} or higher.
7266 @item -fsched-stalled-insns
7267 @itemx -fsched-stalled-insns=@var{n}
7268 @opindex fsched-stalled-insns
7269 Define how many insns (if any) can be moved prematurely from the queue
7270 of stalled insns into the ready list during the second scheduling pass.
7271 @option{-fno-sched-stalled-insns} means that no insns are moved
7272 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7273 on how many queued insns can be moved prematurely.
7274 @option{-fsched-stalled-insns} without a value is equivalent to
7275 @option{-fsched-stalled-insns=1}.
7277 @item -fsched-stalled-insns-dep
7278 @itemx -fsched-stalled-insns-dep=@var{n}
7279 @opindex fsched-stalled-insns-dep
7280 Define how many insn groups (cycles) are examined for a dependency
7281 on a stalled insn that is a candidate for premature removal from the queue
7282 of stalled insns.  This has an effect only during the second scheduling pass,
7283 and only if @option{-fsched-stalled-insns} is used.
7284 @option{-fno-sched-stalled-insns-dep} is equivalent to
7285 @option{-fsched-stalled-insns-dep=0}.
7286 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7287 @option{-fsched-stalled-insns-dep=1}.
7289 @item -fsched2-use-superblocks
7290 @opindex fsched2-use-superblocks
7291 When scheduling after register allocation, use superblock scheduling.
7292 This allows motion across basic block boundaries,
7293 resulting in faster schedules.  This option is experimental, as not all machine
7294 descriptions used by GCC model the CPU closely enough to avoid unreliable
7295 results from the algorithm.
7297 This only makes sense when scheduling after register allocation, i.e.@: with
7298 @option{-fschedule-insns2} or at @option{-O2} or higher.
7300 @item -fsched-group-heuristic
7301 @opindex fsched-group-heuristic
7302 Enable the group heuristic in the scheduler.  This heuristic favors
7303 the instruction that belongs to a schedule group.  This is enabled
7304 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7305 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7307 @item -fsched-critical-path-heuristic
7308 @opindex fsched-critical-path-heuristic
7309 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7310 instructions on the critical path.  This is enabled by default when
7311 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7312 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7314 @item -fsched-spec-insn-heuristic
7315 @opindex fsched-spec-insn-heuristic
7316 Enable the speculative instruction heuristic in the scheduler.  This
7317 heuristic favors speculative instructions with greater dependency weakness.
7318 This is enabled by default when scheduling is enabled, i.e.@:
7319 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7320 or at @option{-O2} or higher.
7322 @item -fsched-rank-heuristic
7323 @opindex fsched-rank-heuristic
7324 Enable the rank heuristic in the scheduler.  This heuristic favors
7325 the instruction belonging to a basic block with greater size or frequency.
7326 This is enabled by default when scheduling is enabled, i.e.@:
7327 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7328 at @option{-O2} or higher.
7330 @item -fsched-last-insn-heuristic
7331 @opindex fsched-last-insn-heuristic
7332 Enable the last-instruction heuristic in the scheduler.  This heuristic
7333 favors the instruction that is less dependent on the last instruction
7334 scheduled.  This is enabled by default when scheduling is enabled,
7335 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7336 at @option{-O2} or higher.
7338 @item -fsched-dep-count-heuristic
7339 @opindex fsched-dep-count-heuristic
7340 Enable the dependent-count heuristic in the scheduler.  This heuristic
7341 favors the instruction that has more instructions depending on it.
7342 This is enabled by default when scheduling is enabled, i.e.@:
7343 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7344 at @option{-O2} or higher.
7346 @item -freschedule-modulo-scheduled-loops
7347 @opindex freschedule-modulo-scheduled-loops
7348 Modulo scheduling is performed before traditional scheduling.  If a loop
7349 is modulo scheduled, later scheduling passes may change its schedule.  
7350 Use this option to control that behavior.
7352 @item -fselective-scheduling
7353 @opindex fselective-scheduling
7354 Schedule instructions using selective scheduling algorithm.  Selective
7355 scheduling runs instead of the first scheduler pass.
7357 @item -fselective-scheduling2
7358 @opindex fselective-scheduling2
7359 Schedule instructions using selective scheduling algorithm.  Selective
7360 scheduling runs instead of the second scheduler pass.
7362 @item -fsel-sched-pipelining
7363 @opindex fsel-sched-pipelining
7364 Enable software pipelining of innermost loops during selective scheduling.
7365 This option has no effect unless one of @option{-fselective-scheduling} or
7366 @option{-fselective-scheduling2} is turned on.
7368 @item -fsel-sched-pipelining-outer-loops
7369 @opindex fsel-sched-pipelining-outer-loops
7370 When pipelining loops during selective scheduling, also pipeline outer loops.
7371 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7373 @item -fshrink-wrap
7374 @opindex fshrink-wrap
7375 Emit function prologues only before parts of the function that need it,
7376 rather than at the top of the function.  This flag is enabled by default at
7377 @option{-O} and higher.
7379 @item -fcaller-saves
7380 @opindex fcaller-saves
7381 Enable allocation of values to registers that are clobbered by
7382 function calls, by emitting extra instructions to save and restore the
7383 registers around such calls.  Such allocation is done only when it
7384 seems to result in better code.
7386 This option is always enabled by default on certain machines, usually
7387 those which have no call-preserved registers to use instead.
7389 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7391 @item -fcombine-stack-adjustments
7392 @opindex fcombine-stack-adjustments
7393 Tracks stack adjustments (pushes and pops) and stack memory references
7394 and then tries to find ways to combine them.
7396 Enabled by default at @option{-O1} and higher.
7398 @item -fconserve-stack
7399 @opindex fconserve-stack
7400 Attempt to minimize stack usage.  The compiler attempts to use less
7401 stack space, even if that makes the program slower.  This option
7402 implies setting the @option{large-stack-frame} parameter to 100
7403 and the @option{large-stack-frame-growth} parameter to 400.
7405 @item -ftree-reassoc
7406 @opindex ftree-reassoc
7407 Perform reassociation on trees.  This flag is enabled by default
7408 at @option{-O} and higher.
7410 @item -ftree-pre
7411 @opindex ftree-pre
7412 Perform partial redundancy elimination (PRE) on trees.  This flag is
7413 enabled by default at @option{-O2} and @option{-O3}.
7415 @item -ftree-partial-pre
7416 @opindex ftree-partial-pre
7417 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7418 enabled by default at @option{-O3}.
7420 @item -ftree-forwprop
7421 @opindex ftree-forwprop
7422 Perform forward propagation on trees.  This flag is enabled by default
7423 at @option{-O} and higher.
7425 @item -ftree-fre
7426 @opindex ftree-fre
7427 Perform full redundancy elimination (FRE) on trees.  The difference
7428 between FRE and PRE is that FRE only considers expressions
7429 that are computed on all paths leading to the redundant computation.
7430 This analysis is faster than PRE, though it exposes fewer redundancies.
7431 This flag is enabled by default at @option{-O} and higher.
7433 @item -ftree-phiprop
7434 @opindex ftree-phiprop
7435 Perform hoisting of loads from conditional pointers on trees.  This
7436 pass is enabled by default at @option{-O} and higher.
7438 @item -fhoist-adjacent-loads
7439 @opindex hoist-adjacent-loads
7440 Speculatively hoist loads from both branches of an if-then-else if the
7441 loads are from adjacent locations in the same structure and the target
7442 architecture has a conditional move instruction.  This flag is enabled
7443 by default at @option{-O2} and higher.
7445 @item -ftree-copy-prop
7446 @opindex ftree-copy-prop
7447 Perform copy propagation on trees.  This pass eliminates unnecessary
7448 copy operations.  This flag is enabled by default at @option{-O} and
7449 higher.
7451 @item -fipa-pure-const
7452 @opindex fipa-pure-const
7453 Discover which functions are pure or constant.
7454 Enabled by default at @option{-O} and higher.
7456 @item -fipa-reference
7457 @opindex fipa-reference
7458 Discover which static variables do not escape the
7459 compilation unit.
7460 Enabled by default at @option{-O} and higher.
7462 @item -fipa-pta
7463 @opindex fipa-pta
7464 Perform interprocedural pointer analysis and interprocedural modification
7465 and reference analysis.  This option can cause excessive memory and
7466 compile-time usage on large compilation units.  It is not enabled by
7467 default at any optimization level.
7469 @item -fipa-profile
7470 @opindex fipa-profile
7471 Perform interprocedural profile propagation.  The functions called only from
7472 cold functions are marked as cold. Also functions executed once (such as
7473 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7474 functions and loop less parts of functions executed once are then optimized for
7475 size.
7476 Enabled by default at @option{-O} and higher.
7478 @item -fipa-cp
7479 @opindex fipa-cp
7480 Perform interprocedural constant propagation.
7481 This optimization analyzes the program to determine when values passed
7482 to functions are constants and then optimizes accordingly.
7483 This optimization can substantially increase performance
7484 if the application has constants passed to functions.
7485 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7487 @item -fipa-cp-clone
7488 @opindex fipa-cp-clone
7489 Perform function cloning to make interprocedural constant propagation stronger.
7490 When enabled, interprocedural constant propagation performs function cloning
7491 when externally visible function can be called with constant arguments.
7492 Because this optimization can create multiple copies of functions,
7493 it may significantly increase code size
7494 (see @option{--param ipcp-unit-growth=@var{value}}).
7495 This flag is enabled by default at @option{-O3}.
7497 @item -ftree-sink
7498 @opindex ftree-sink
7499 Perform forward store motion  on trees.  This flag is
7500 enabled by default at @option{-O} and higher.
7502 @item -ftree-bit-ccp
7503 @opindex ftree-bit-ccp
7504 Perform sparse conditional bit constant propagation on trees and propagate
7505 pointer alignment information.
7506 This pass only operates on local scalar variables and is enabled by default
7507 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7509 @item -ftree-ccp
7510 @opindex ftree-ccp
7511 Perform sparse conditional constant propagation (CCP) on trees.  This
7512 pass only operates on local scalar variables and is enabled by default
7513 at @option{-O} and higher.
7515 @item -ftree-switch-conversion
7516 Perform conversion of simple initializations in a switch to
7517 initializations from a scalar array.  This flag is enabled by default
7518 at @option{-O2} and higher.
7520 @item -ftree-tail-merge
7521 Look for identical code sequences.  When found, replace one with a jump to the
7522 other.  This optimization is known as tail merging or cross jumping.  This flag
7523 is enabled by default at @option{-O2} and higher.  The compilation time
7524 in this pass can
7525 be limited using @option{max-tail-merge-comparisons} parameter and
7526 @option{max-tail-merge-iterations} parameter.
7528 @item -ftree-dce
7529 @opindex ftree-dce
7530 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7531 default at @option{-O} and higher.
7533 @item -ftree-builtin-call-dce
7534 @opindex ftree-builtin-call-dce
7535 Perform conditional dead code elimination (DCE) for calls to built-in functions
7536 that may set @code{errno} but are otherwise side-effect free.  This flag is
7537 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7538 specified.
7540 @item -ftree-dominator-opts
7541 @opindex ftree-dominator-opts
7542 Perform a variety of simple scalar cleanups (constant/copy
7543 propagation, redundancy elimination, range propagation and expression
7544 simplification) based on a dominator tree traversal.  This also
7545 performs jump threading (to reduce jumps to jumps). This flag is
7546 enabled by default at @option{-O} and higher.
7548 @item -ftree-dse
7549 @opindex ftree-dse
7550 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7551 a memory location that is later overwritten by another store without
7552 any intervening loads.  In this case the earlier store can be deleted.  This
7553 flag is enabled by default at @option{-O} and higher.
7555 @item -ftree-ch
7556 @opindex ftree-ch
7557 Perform loop header copying on trees.  This is beneficial since it increases
7558 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7559 is enabled by default at @option{-O} and higher.  It is not enabled
7560 for @option{-Os}, since it usually increases code size.
7562 @item -ftree-loop-optimize
7563 @opindex ftree-loop-optimize
7564 Perform loop optimizations on trees.  This flag is enabled by default
7565 at @option{-O} and higher.
7567 @item -ftree-loop-linear
7568 @opindex ftree-loop-linear
7569 Perform loop interchange transformations on tree.  Same as
7570 @option{-floop-interchange}.  To use this code transformation, GCC has
7571 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7572 enable the Graphite loop transformation infrastructure.
7574 @item -floop-interchange
7575 @opindex floop-interchange
7576 Perform loop interchange transformations on loops.  Interchanging two
7577 nested loops switches the inner and outer loops.  For example, given a
7578 loop like:
7579 @smallexample
7580 DO J = 1, M
7581   DO I = 1, N
7582     A(J, I) = A(J, I) * C
7583   ENDDO
7584 ENDDO
7585 @end smallexample
7586 loop interchange transforms the loop as if it were written:
7587 @smallexample
7588 DO I = 1, N
7589   DO J = 1, M
7590     A(J, I) = A(J, I) * C
7591   ENDDO
7592 ENDDO
7593 @end smallexample
7594 which can be beneficial when @code{N} is larger than the caches,
7595 because in Fortran, the elements of an array are stored in memory
7596 contiguously by column, and the original loop iterates over rows,
7597 potentially creating at each access a cache miss.  This optimization
7598 applies to all the languages supported by GCC and is not limited to
7599 Fortran.  To use this code transformation, GCC has to be configured
7600 with @option{--with-ppl} and @option{--with-cloog} to enable the
7601 Graphite loop transformation infrastructure.
7603 @item -floop-strip-mine
7604 @opindex floop-strip-mine
7605 Perform loop strip mining transformations on loops.  Strip mining
7606 splits a loop into two nested loops.  The outer loop has strides
7607 equal to the strip size and the inner loop has strides of the
7608 original loop within a strip.  The strip length can be changed
7609 using the @option{loop-block-tile-size} parameter.  For example,
7610 given a loop like:
7611 @smallexample
7612 DO I = 1, N
7613   A(I) = A(I) + C
7614 ENDDO
7615 @end smallexample
7616 loop strip mining transforms the loop as if it were written:
7617 @smallexample
7618 DO II = 1, N, 51
7619   DO I = II, min (II + 50, N)
7620     A(I) = A(I) + C
7621   ENDDO
7622 ENDDO
7623 @end smallexample
7624 This optimization applies to all the languages supported by GCC and is
7625 not limited to Fortran.  To use this code transformation, GCC has to
7626 be configured with @option{--with-ppl} and @option{--with-cloog} to
7627 enable the Graphite loop transformation infrastructure.
7629 @item -floop-block
7630 @opindex floop-block
7631 Perform loop blocking transformations on loops.  Blocking strip mines
7632 each loop in the loop nest such that the memory accesses of the
7633 element loops fit inside caches.  The strip length can be changed
7634 using the @option{loop-block-tile-size} parameter.  For example, given
7635 a loop like:
7636 @smallexample
7637 DO I = 1, N
7638   DO J = 1, M
7639     A(J, I) = B(I) + C(J)
7640   ENDDO
7641 ENDDO
7642 @end smallexample
7643 loop blocking transforms the loop as if it were written:
7644 @smallexample
7645 DO II = 1, N, 51
7646   DO JJ = 1, M, 51
7647     DO I = II, min (II + 50, N)
7648       DO J = JJ, min (JJ + 50, M)
7649         A(J, I) = B(I) + C(J)
7650       ENDDO
7651     ENDDO
7652   ENDDO
7653 ENDDO
7654 @end smallexample
7655 which can be beneficial when @code{M} is larger than the caches,
7656 because the innermost loop iterates over a smaller amount of data
7657 which can be kept in the caches.  This optimization applies to all the
7658 languages supported by GCC and is not limited to Fortran.  To use this
7659 code transformation, GCC has to be configured with @option{--with-ppl}
7660 and @option{--with-cloog} to enable the Graphite loop transformation
7661 infrastructure.
7663 @item -fgraphite-identity
7664 @opindex fgraphite-identity
7665 Enable the identity transformation for graphite.  For every SCoP we generate
7666 the polyhedral representation and transform it back to gimple.  Using
7667 @option{-fgraphite-identity} we can check the costs or benefits of the
7668 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7669 are also performed by the code generator CLooG, like index splitting and
7670 dead code elimination in loops.
7672 @item -floop-nest-optimize
7673 @opindex floop-nest-optimize
7674 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7675 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7676 structure optimized for data-locality and parallelism.  This option
7677 is experimental.
7679 @item -floop-parallelize-all
7680 @opindex floop-parallelize-all
7681 Use the Graphite data dependence analysis to identify loops that can
7682 be parallelized.  Parallelize all the loops that can be analyzed to
7683 not contain loop carried dependences without checking that it is
7684 profitable to parallelize the loops.
7686 @item -fcheck-data-deps
7687 @opindex fcheck-data-deps
7688 Compare the results of several data dependence analyzers.  This option
7689 is used for debugging the data dependence analyzers.
7691 @item -ftree-loop-if-convert
7692 Attempt to transform conditional jumps in the innermost loops to
7693 branch-less equivalents.  The intent is to remove control-flow from
7694 the innermost loops in order to improve the ability of the
7695 vectorization pass to handle these loops.  This is enabled by default
7696 if vectorization is enabled.
7698 @item -ftree-loop-if-convert-stores
7699 Attempt to also if-convert conditional jumps containing memory writes.
7700 This transformation can be unsafe for multi-threaded programs as it
7701 transforms conditional memory writes into unconditional memory writes.
7702 For example,
7703 @smallexample
7704 for (i = 0; i < N; i++)
7705   if (cond)
7706     A[i] = expr;
7707 @end smallexample
7708 is transformed to
7709 @smallexample
7710 for (i = 0; i < N; i++)
7711   A[i] = cond ? expr : A[i];
7712 @end smallexample
7713 potentially producing data races.
7715 @item -ftree-loop-distribution
7716 Perform loop distribution.  This flag can improve cache performance on
7717 big loop bodies and allow further loop optimizations, like
7718 parallelization or vectorization, to take place.  For example, the loop
7719 @smallexample
7720 DO I = 1, N
7721   A(I) = B(I) + C
7722   D(I) = E(I) * F
7723 ENDDO
7724 @end smallexample
7725 is transformed to
7726 @smallexample
7727 DO I = 1, N
7728    A(I) = B(I) + C
7729 ENDDO
7730 DO I = 1, N
7731    D(I) = E(I) * F
7732 ENDDO
7733 @end smallexample
7735 @item -ftree-loop-distribute-patterns
7736 Perform loop distribution of patterns that can be code generated with
7737 calls to a library.  This flag is enabled by default at @option{-O3}.
7739 This pass distributes the initialization loops and generates a call to
7740 memset zero.  For example, the loop
7741 @smallexample
7742 DO I = 1, N
7743   A(I) = 0
7744   B(I) = A(I) + I
7745 ENDDO
7746 @end smallexample
7747 is transformed to
7748 @smallexample
7749 DO I = 1, N
7750    A(I) = 0
7751 ENDDO
7752 DO I = 1, N
7753    B(I) = A(I) + I
7754 ENDDO
7755 @end smallexample
7756 and the initialization loop is transformed into a call to memset zero.
7758 @item -ftree-loop-im
7759 @opindex ftree-loop-im
7760 Perform loop invariant motion on trees.  This pass moves only invariants that
7761 are hard to handle at RTL level (function calls, operations that expand to
7762 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7763 operands of conditions that are invariant out of the loop, so that we can use
7764 just trivial invariantness analysis in loop unswitching.  The pass also includes
7765 store motion.
7767 @item -ftree-loop-ivcanon
7768 @opindex ftree-loop-ivcanon
7769 Create a canonical counter for number of iterations in loops for which
7770 determining number of iterations requires complicated analysis.  Later
7771 optimizations then may determine the number easily.  Useful especially
7772 in connection with unrolling.
7774 @item -fivopts
7775 @opindex fivopts
7776 Perform induction variable optimizations (strength reduction, induction
7777 variable merging and induction variable elimination) on trees.
7779 @item -ftree-parallelize-loops=n
7780 @opindex ftree-parallelize-loops
7781 Parallelize loops, i.e., split their iteration space to run in n threads.
7782 This is only possible for loops whose iterations are independent
7783 and can be arbitrarily reordered.  The optimization is only
7784 profitable on multiprocessor machines, for loops that are CPU-intensive,
7785 rather than constrained e.g.@: by memory bandwidth.  This option
7786 implies @option{-pthread}, and thus is only supported on targets
7787 that have support for @option{-pthread}.
7789 @item -ftree-pta
7790 @opindex ftree-pta
7791 Perform function-local points-to analysis on trees.  This flag is
7792 enabled by default at @option{-O} and higher.
7794 @item -ftree-sra
7795 @opindex ftree-sra
7796 Perform scalar replacement of aggregates.  This pass replaces structure
7797 references with scalars to prevent committing structures to memory too
7798 early.  This flag is enabled by default at @option{-O} and higher.
7800 @item -ftree-copyrename
7801 @opindex ftree-copyrename
7802 Perform copy renaming on trees.  This pass attempts to rename compiler
7803 temporaries to other variables at copy locations, usually resulting in
7804 variable names which more closely resemble the original variables.  This flag
7805 is enabled by default at @option{-O} and higher.
7807 @item -ftree-coalesce-inlined-vars
7808 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7809 combine small user-defined variables too, but only if they were inlined
7810 from other functions.  It is a more limited form of
7811 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7812 inlined variables, but it will keep variables of the inlined-into
7813 function apart from each other, such that they are more likely to
7814 contain the expected values in a debugging session.  This was the
7815 default in GCC versions older than 4.7.
7817 @item -ftree-coalesce-vars
7818 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7819 combine small user-defined variables too, instead of just compiler
7820 temporaries.  This may severely limit the ability to debug an optimized
7821 program compiled with @option{-fno-var-tracking-assignments}.  In the
7822 negated form, this flag prevents SSA coalescing of user variables,
7823 including inlined ones.  This option is enabled by default.
7825 @item -ftree-ter
7826 @opindex ftree-ter
7827 Perform temporary expression replacement during the SSA->normal phase.  Single
7828 use/single def temporaries are replaced at their use location with their
7829 defining expression.  This results in non-GIMPLE code, but gives the expanders
7830 much more complex trees to work on resulting in better RTL generation.  This is
7831 enabled by default at @option{-O} and higher.
7833 @item -ftree-slsr
7834 @opindex ftree-slsr
7835 Perform straight-line strength reduction on trees.  This recognizes related
7836 expressions involving multiplications and replaces them by less expensive
7837 calculations when possible.  This is enabled by default at @option{-O} and
7838 higher.
7840 @item -ftree-vectorize
7841 @opindex ftree-vectorize
7842 Perform loop vectorization on trees. This flag is enabled by default at
7843 @option{-O3}.
7845 @item -ftree-slp-vectorize
7846 @opindex ftree-slp-vectorize
7847 Perform basic block vectorization on trees. This flag is enabled by default at
7848 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7850 @item -ftree-vect-loop-version
7851 @opindex ftree-vect-loop-version
7852 Perform loop versioning when doing loop vectorization on trees.  When a loop
7853 appears to be vectorizable except that data alignment or data dependence cannot
7854 be determined at compile time, then vectorized and non-vectorized versions of
7855 the loop are generated along with run-time checks for alignment or dependence
7856 to control which version is executed.  This option is enabled by default
7857 except at level @option{-Os} where it is disabled.
7859 @item -fvect-cost-model
7860 @opindex fvect-cost-model
7861 Enable cost model for vectorization.  This option is enabled by default at
7862 @option{-O3}.
7864 @item -ftree-vrp
7865 @opindex ftree-vrp
7866 Perform Value Range Propagation on trees.  This is similar to the
7867 constant propagation pass, but instead of values, ranges of values are
7868 propagated.  This allows the optimizers to remove unnecessary range
7869 checks like array bound checks and null pointer checks.  This is
7870 enabled by default at @option{-O2} and higher.  Null pointer check
7871 elimination is only done if @option{-fdelete-null-pointer-checks} is
7872 enabled.
7874 @item -ftracer
7875 @opindex ftracer
7876 Perform tail duplication to enlarge superblock size.  This transformation
7877 simplifies the control flow of the function allowing other optimizations to do
7878 a better job.
7880 @item -funroll-loops
7881 @opindex funroll-loops
7882 Unroll loops whose number of iterations can be determined at compile
7883 time or upon entry to the loop.  @option{-funroll-loops} implies
7884 @option{-frerun-cse-after-loop}.  This option makes code larger,
7885 and may or may not make it run faster.
7887 @item -funroll-all-loops
7888 @opindex funroll-all-loops
7889 Unroll all loops, even if their number of iterations is uncertain when
7890 the loop is entered.  This usually makes programs run more slowly.
7891 @option{-funroll-all-loops} implies the same options as
7892 @option{-funroll-loops},
7894 @item -fsplit-ivs-in-unroller
7895 @opindex fsplit-ivs-in-unroller
7896 Enables expression of values of induction variables in later iterations
7897 of the unrolled loop using the value in the first iteration.  This breaks
7898 long dependency chains, thus improving efficiency of the scheduling passes.
7900 A combination of @option{-fweb} and CSE is often sufficient to obtain the
7901 same effect.  However, that is not reliable in cases where the loop body
7902 is more complicated than a single basic block.  It also does not work at all
7903 on some architectures due to restrictions in the CSE pass.
7905 This optimization is enabled by default.
7907 @item -fvariable-expansion-in-unroller
7908 @opindex fvariable-expansion-in-unroller
7909 With this option, the compiler creates multiple copies of some
7910 local variables when unrolling a loop, which can result in superior code.
7912 @item -fpartial-inlining
7913 @opindex fpartial-inlining
7914 Inline parts of functions.  This option has any effect only
7915 when inlining itself is turned on by the @option{-finline-functions}
7916 or @option{-finline-small-functions} options.
7918 Enabled at level @option{-O2}.
7920 @item -fpredictive-commoning
7921 @opindex fpredictive-commoning
7922 Perform predictive commoning optimization, i.e., reusing computations
7923 (especially memory loads and stores) performed in previous
7924 iterations of loops.
7926 This option is enabled at level @option{-O3}.
7928 @item -fprefetch-loop-arrays
7929 @opindex fprefetch-loop-arrays
7930 If supported by the target machine, generate instructions to prefetch
7931 memory to improve the performance of loops that access large arrays.
7933 This option may generate better or worse code; results are highly
7934 dependent on the structure of loops within the source code.
7936 Disabled at level @option{-Os}.
7938 @item -fno-peephole
7939 @itemx -fno-peephole2
7940 @opindex fno-peephole
7941 @opindex fno-peephole2
7942 Disable any machine-specific peephole optimizations.  The difference
7943 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7944 are implemented in the compiler; some targets use one, some use the
7945 other, a few use both.
7947 @option{-fpeephole} is enabled by default.
7948 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7950 @item -fno-guess-branch-probability
7951 @opindex fno-guess-branch-probability
7952 Do not guess branch probabilities using heuristics.
7954 GCC uses heuristics to guess branch probabilities if they are
7955 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7956 heuristics are based on the control flow graph.  If some branch probabilities
7957 are specified by @samp{__builtin_expect}, then the heuristics are
7958 used to guess branch probabilities for the rest of the control flow graph,
7959 taking the @samp{__builtin_expect} info into account.  The interactions
7960 between the heuristics and @samp{__builtin_expect} can be complex, and in
7961 some cases, it may be useful to disable the heuristics so that the effects
7962 of @samp{__builtin_expect} are easier to understand.
7964 The default is @option{-fguess-branch-probability} at levels
7965 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7967 @item -freorder-blocks
7968 @opindex freorder-blocks
7969 Reorder basic blocks in the compiled function in order to reduce number of
7970 taken branches and improve code locality.
7972 Enabled at levels @option{-O2}, @option{-O3}.
7974 @item -freorder-blocks-and-partition
7975 @opindex freorder-blocks-and-partition
7976 In addition to reordering basic blocks in the compiled function, in order
7977 to reduce number of taken branches, partitions hot and cold basic blocks
7978 into separate sections of the assembly and .o files, to improve
7979 paging and cache locality performance.
7981 This optimization is automatically turned off in the presence of
7982 exception handling, for linkonce sections, for functions with a user-defined
7983 section attribute and on any architecture that does not support named
7984 sections.
7986 @item -freorder-functions
7987 @opindex freorder-functions
7988 Reorder functions in the object file in order to
7989 improve code locality.  This is implemented by using special
7990 subsections @code{.text.hot} for most frequently executed functions and
7991 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7992 the linker so object file format must support named sections and linker must
7993 place them in a reasonable way.
7995 Also profile feedback must be available to make this option effective.  See
7996 @option{-fprofile-arcs} for details.
7998 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8000 @item -fstrict-aliasing
8001 @opindex fstrict-aliasing
8002 Allow the compiler to assume the strictest aliasing rules applicable to
8003 the language being compiled.  For C (and C++), this activates
8004 optimizations based on the type of expressions.  In particular, an
8005 object of one type is assumed never to reside at the same address as an
8006 object of a different type, unless the types are almost the same.  For
8007 example, an @code{unsigned int} can alias an @code{int}, but not a
8008 @code{void*} or a @code{double}.  A character type may alias any other
8009 type.
8011 @anchor{Type-punning}Pay special attention to code like this:
8012 @smallexample
8013 union a_union @{
8014   int i;
8015   double d;
8018 int f() @{
8019   union a_union t;
8020   t.d = 3.0;
8021   return t.i;
8023 @end smallexample
8024 The practice of reading from a different union member than the one most
8025 recently written to (called ``type-punning'') is common.  Even with
8026 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8027 is accessed through the union type.  So, the code above works as
8028 expected.  @xref{Structures unions enumerations and bit-fields
8029 implementation}.  However, this code might not:
8030 @smallexample
8031 int f() @{
8032   union a_union t;
8033   int* ip;
8034   t.d = 3.0;
8035   ip = &t.i;
8036   return *ip;
8038 @end smallexample
8040 Similarly, access by taking the address, casting the resulting pointer
8041 and dereferencing the result has undefined behavior, even if the cast
8042 uses a union type, e.g.:
8043 @smallexample
8044 int f() @{
8045   double d = 3.0;
8046   return ((union a_union *) &d)->i;
8048 @end smallexample
8050 The @option{-fstrict-aliasing} option is enabled at levels
8051 @option{-O2}, @option{-O3}, @option{-Os}.
8053 @item -fstrict-overflow
8054 @opindex fstrict-overflow
8055 Allow the compiler to assume strict signed overflow rules, depending
8056 on the language being compiled.  For C (and C++) this means that
8057 overflow when doing arithmetic with signed numbers is undefined, which
8058 means that the compiler may assume that it does not happen.  This
8059 permits various optimizations.  For example, the compiler assumes
8060 that an expression like @code{i + 10 > i} is always true for
8061 signed @code{i}.  This assumption is only valid if signed overflow is
8062 undefined, as the expression is false if @code{i + 10} overflows when
8063 using twos complement arithmetic.  When this option is in effect any
8064 attempt to determine whether an operation on signed numbers 
8065 overflows must be written carefully to not actually involve overflow.
8067 This option also allows the compiler to assume strict pointer
8068 semantics: given a pointer to an object, if adding an offset to that
8069 pointer does not produce a pointer to the same object, the addition is
8070 undefined.  This permits the compiler to conclude that @code{p + u >
8071 p} is always true for a pointer @code{p} and unsigned integer
8072 @code{u}.  This assumption is only valid because pointer wraparound is
8073 undefined, as the expression is false if @code{p + u} overflows using
8074 twos complement arithmetic.
8076 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8077 that integer signed overflow is fully defined: it wraps.  When
8078 @option{-fwrapv} is used, there is no difference between
8079 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8080 integers.  With @option{-fwrapv} certain types of overflow are
8081 permitted.  For example, if the compiler gets an overflow when doing
8082 arithmetic on constants, the overflowed value can still be used with
8083 @option{-fwrapv}, but not otherwise.
8085 The @option{-fstrict-overflow} option is enabled at levels
8086 @option{-O2}, @option{-O3}, @option{-Os}.
8088 @item -falign-functions
8089 @itemx -falign-functions=@var{n}
8090 @opindex falign-functions
8091 Align the start of functions to the next power-of-two greater than
8092 @var{n}, skipping up to @var{n} bytes.  For instance,
8093 @option{-falign-functions=32} aligns functions to the next 32-byte
8094 boundary, but @option{-falign-functions=24} aligns to the next
8095 32-byte boundary only if this can be done by skipping 23 bytes or less.
8097 @option{-fno-align-functions} and @option{-falign-functions=1} are
8098 equivalent and mean that functions are not aligned.
8100 Some assemblers only support this flag when @var{n} is a power of two;
8101 in that case, it is rounded up.
8103 If @var{n} is not specified or is zero, use a machine-dependent default.
8105 Enabled at levels @option{-O2}, @option{-O3}.
8107 @item -falign-labels
8108 @itemx -falign-labels=@var{n}
8109 @opindex falign-labels
8110 Align all branch targets to a power-of-two boundary, skipping up to
8111 @var{n} bytes like @option{-falign-functions}.  This option can easily
8112 make code slower, because it must insert dummy operations for when the
8113 branch target is reached in the usual flow of the code.
8115 @option{-fno-align-labels} and @option{-falign-labels=1} are
8116 equivalent and mean that labels are not aligned.
8118 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8119 are greater than this value, then their values are used instead.
8121 If @var{n} is not specified or is zero, use a machine-dependent default
8122 which is very likely to be @samp{1}, meaning no alignment.
8124 Enabled at levels @option{-O2}, @option{-O3}.
8126 @item -falign-loops
8127 @itemx -falign-loops=@var{n}
8128 @opindex falign-loops
8129 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8130 like @option{-falign-functions}.  If the loops are
8131 executed many times, this makes up for any execution of the dummy
8132 operations.
8134 @option{-fno-align-loops} and @option{-falign-loops=1} are
8135 equivalent and mean that loops are not aligned.
8137 If @var{n} is not specified or is zero, use a machine-dependent default.
8139 Enabled at levels @option{-O2}, @option{-O3}.
8141 @item -falign-jumps
8142 @itemx -falign-jumps=@var{n}
8143 @opindex falign-jumps
8144 Align branch targets to a power-of-two boundary, for branch targets
8145 where the targets can only be reached by jumping, skipping up to @var{n}
8146 bytes like @option{-falign-functions}.  In this case, no dummy operations
8147 need be executed.
8149 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8150 equivalent and mean that loops are not aligned.
8152 If @var{n} is not specified or is zero, use a machine-dependent default.
8154 Enabled at levels @option{-O2}, @option{-O3}.
8156 @item -funit-at-a-time
8157 @opindex funit-at-a-time
8158 This option is left for compatibility reasons. @option{-funit-at-a-time}
8159 has no effect, while @option{-fno-unit-at-a-time} implies
8160 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8162 Enabled by default.
8164 @item -fno-toplevel-reorder
8165 @opindex fno-toplevel-reorder
8166 Do not reorder top-level functions, variables, and @code{asm}
8167 statements.  Output them in the same order that they appear in the
8168 input file.  When this option is used, unreferenced static variables
8169 are not removed.  This option is intended to support existing code
8170 that relies on a particular ordering.  For new code, it is better to
8171 use attributes.
8173 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8174 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8175 targets.
8177 @item -fweb
8178 @opindex fweb
8179 Constructs webs as commonly used for register allocation purposes and assign
8180 each web individual pseudo register.  This allows the register allocation pass
8181 to operate on pseudos directly, but also strengthens several other optimization
8182 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8183 however, make debugging impossible, since variables no longer stay in a
8184 ``home register''.
8186 Enabled by default with @option{-funroll-loops}.
8188 @item -fwhole-program
8189 @opindex fwhole-program
8190 Assume that the current compilation unit represents the whole program being
8191 compiled.  All public functions and variables with the exception of @code{main}
8192 and those merged by attribute @code{externally_visible} become static functions
8193 and in effect are optimized more aggressively by interprocedural optimizers.
8195 This option should not be used in combination with @code{-flto}.
8196 Instead relying on a linker plugin should provide safer and more precise
8197 information.
8199 @item -flto[=@var{n}]
8200 @opindex flto
8201 This option runs the standard link-time optimizer.  When invoked
8202 with source code, it generates GIMPLE (one of GCC's internal
8203 representations) and writes it to special ELF sections in the object
8204 file.  When the object files are linked together, all the function
8205 bodies are read from these ELF sections and instantiated as if they
8206 had been part of the same translation unit.
8208 To use the link-time optimizer, @option{-flto} needs to be specified at
8209 compile time and during the final link.  For example:
8211 @smallexample
8212 gcc -c -O2 -flto foo.c
8213 gcc -c -O2 -flto bar.c
8214 gcc -o myprog -flto -O2 foo.o bar.o
8215 @end smallexample
8217 The first two invocations to GCC save a bytecode representation
8218 of GIMPLE into special ELF sections inside @file{foo.o} and
8219 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8220 @file{foo.o} and @file{bar.o}, merges the two files into a single
8221 internal image, and compiles the result as usual.  Since both
8222 @file{foo.o} and @file{bar.o} are merged into a single image, this
8223 causes all the interprocedural analyses and optimizations in GCC to
8224 work across the two files as if they were a single one.  This means,
8225 for example, that the inliner is able to inline functions in
8226 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8228 Another (simpler) way to enable link-time optimization is:
8230 @smallexample
8231 gcc -o myprog -flto -O2 foo.c bar.c
8232 @end smallexample
8234 The above generates bytecode for @file{foo.c} and @file{bar.c},
8235 merges them together into a single GIMPLE representation and optimizes
8236 them as usual to produce @file{myprog}.
8238 The only important thing to keep in mind is that to enable link-time
8239 optimizations the @option{-flto} flag needs to be passed to both the
8240 compile and the link commands.
8242 To make whole program optimization effective, it is necessary to make
8243 certain whole program assumptions.  The compiler needs to know
8244 what functions and variables can be accessed by libraries and runtime
8245 outside of the link-time optimized unit.  When supported by the linker,
8246 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8247 to the compiler about used and externally visible symbols.  When
8248 the linker plugin is not available, @option{-fwhole-program} should be
8249 used to allow the compiler to make these assumptions, which leads
8250 to more aggressive optimization decisions.
8252 Note that when a file is compiled with @option{-flto}, the generated
8253 object file is larger than a regular object file because it 
8254 contains GIMPLE bytecodes and the usual final code.  This means that
8255 object files with LTO information can be linked as normal object
8256 files; if @option{-flto} is not passed to the linker, no
8257 interprocedural optimizations are applied.
8259 Additionally, the optimization flags used to compile individual files
8260 are not necessarily related to those used at link time.  For instance,
8262 @smallexample
8263 gcc -c -O0 -flto foo.c
8264 gcc -c -O0 -flto bar.c
8265 gcc -o myprog -flto -O3 foo.o bar.o
8266 @end smallexample
8268 This produces individual object files with unoptimized assembler
8269 code, but the resulting binary @file{myprog} is optimized at
8270 @option{-O3}.  If, instead, the final binary is generated without
8271 @option{-flto}, then @file{myprog} is not optimized.
8273 When producing the final binary with @option{-flto}, GCC only
8274 applies link-time optimizations to those files that contain bytecode.
8275 Therefore, you can mix and match object files and libraries with
8276 GIMPLE bytecodes and final object code.  GCC automatically selects
8277 which files to optimize in LTO mode and which files to link without
8278 further processing.
8280 There are some code generation flags preserved by GCC when
8281 generating bytecodes, as they need to be used during the final link
8282 stage.  Currently, the following options are saved into the GIMPLE
8283 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
8284 @option{-m} target flags.
8286 At link time, these options are read in and reapplied.  Note that the
8287 current implementation makes no attempt to recognize conflicting
8288 values for these options.  If different files have conflicting option
8289 values (e.g., one file is compiled with @option{-fPIC} and another
8290 isn't), the compiler simply uses the last value read from the
8291 bytecode files.  It is recommended, then, that you compile all the files
8292 participating in the same link with the same options.
8294 If LTO encounters objects with C linkage declared with incompatible
8295 types in separate translation units to be linked together (undefined
8296 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8297 issued.  The behavior is still undefined at run time.
8299 Another feature of LTO is that it is possible to apply interprocedural
8300 optimizations on files written in different languages.  This requires
8301 support in the language front end.  Currently, the C, C++ and
8302 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8303 something like this should work:
8305 @smallexample
8306 gcc -c -flto foo.c
8307 g++ -c -flto bar.cc
8308 gfortran -c -flto baz.f90
8309 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8310 @end smallexample
8312 Notice that the final link is done with @command{g++} to get the C++
8313 runtime libraries and @option{-lgfortran} is added to get the Fortran
8314 runtime libraries.  In general, when mixing languages in LTO mode, you
8315 should use the same link command options as when mixing languages in a
8316 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8317 all the compile and link commands.
8319 If object files containing GIMPLE bytecode are stored in a library archive, say
8320 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8321 are using a linker with plugin support.  To enable this feature, use
8322 the flag @option{-fuse-linker-plugin} at link time:
8324 @smallexample
8325 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8326 @end smallexample
8328 With the linker plugin enabled, the linker extracts the needed
8329 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8330 to make them part of the aggregated GIMPLE image to be optimized.
8332 If you are not using a linker with plugin support and/or do not
8333 enable the linker plugin, then the objects inside @file{libfoo.a}
8334 are extracted and linked as usual, but they do not participate
8335 in the LTO optimization process.
8337 Link-time optimizations do not require the presence of the whole program to
8338 operate.  If the program does not require any symbols to be exported, it is
8339 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8340 the interprocedural optimizers to use more aggressive assumptions which may
8341 lead to improved optimization opportunities.
8342 Use of @option{-fwhole-program} is not needed when linker plugin is
8343 active (see @option{-fuse-linker-plugin}).
8345 The current implementation of LTO makes no
8346 attempt to generate bytecode that is portable between different
8347 types of hosts.  The bytecode files are versioned and there is a
8348 strict version check, so bytecode files generated in one version of
8349 GCC will not work with an older/newer version of GCC@.
8351 Link-time optimization does not work well with generation of debugging
8352 information.  Combining @option{-flto} with
8353 @option{-g} is currently experimental and expected to produce wrong
8354 results.
8356 If you specify the optional @var{n}, the optimization and code
8357 generation done at link time is executed in parallel using @var{n}
8358 parallel jobs by utilizing an installed @command{make} program.  The
8359 environment variable @env{MAKE} may be used to override the program
8360 used.  The default value for @var{n} is 1.
8362 You can also specify @option{-flto=jobserver} to use GNU make's
8363 job server mode to determine the number of parallel jobs. This
8364 is useful when the Makefile calling GCC is already executing in parallel.
8365 You must prepend a @samp{+} to the command recipe in the parent Makefile
8366 for this to work.  This option likely only works if @env{MAKE} is
8367 GNU make.
8369 This option is disabled by default.
8371 @item -flto-partition=@var{alg}
8372 @opindex flto-partition
8373 Specify the partitioning algorithm used by the link-time optimizer.
8374 The value is either @code{1to1} to specify a partitioning mirroring
8375 the original source files or @code{balanced} to specify partitioning
8376 into equally sized chunks (whenever possible) or @code{max} to create
8377 new partition for every symbol where possible.  Specifying @code{none}
8378 as an algorithm disables partitioning and streaming completely. 
8379 The default value is @code{balanced}. While @code{1to1} can be used
8380 as an workaround for various code ordering issues, the @code{max}
8381 partitioning is intended for internal testing only.
8383 @item -flto-compression-level=@var{n}
8384 This option specifies the level of compression used for intermediate
8385 language written to LTO object files, and is only meaningful in
8386 conjunction with LTO mode (@option{-flto}).  Valid
8387 values are 0 (no compression) to 9 (maximum compression).  Values
8388 outside this range are clamped to either 0 or 9.  If the option is not
8389 given, a default balanced compression setting is used.
8391 @item -flto-report
8392 Prints a report with internal details on the workings of the link-time
8393 optimizer.  The contents of this report vary from version to version.
8394 It is meant to be useful to GCC developers when processing object
8395 files in LTO mode (via @option{-flto}).
8397 Disabled by default.
8399 @item -fuse-linker-plugin
8400 Enables the use of a linker plugin during link-time optimization.  This
8401 option relies on plugin support in the linker, which is available in gold
8402 or in GNU ld 2.21 or newer.
8404 This option enables the extraction of object files with GIMPLE bytecode out
8405 of library archives. This improves the quality of optimization by exposing
8406 more code to the link-time optimizer.  This information specifies what
8407 symbols can be accessed externally (by non-LTO object or during dynamic
8408 linking).  Resulting code quality improvements on binaries (and shared
8409 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8410 See @option{-flto} for a description of the effect of this flag and how to
8411 use it.
8413 This option is enabled by default when LTO support in GCC is enabled
8414 and GCC was configured for use with
8415 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8417 @item -ffat-lto-objects
8418 @opindex ffat-lto-objects
8419 Fat LTO objects are object files that contain both the intermediate language
8420 and the object code. This makes them usable for both LTO linking and normal
8421 linking. This option is effective only when compiling with @option{-flto}
8422 and is ignored at link time.
8424 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8425 requires the complete toolchain to be aware of LTO. It requires a linker with
8426 linker plugin support for basic functionality.  Additionally,
8427 @command{nm}, @command{ar} and @command{ranlib}
8428 need to support linker plugins to allow a full-featured build environment
8429 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8430 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8431 to these tools. With non fat LTO makefiles need to be modified to use them.
8433 The default is @option{-ffat-lto-objects} but this default is intended to
8434 change in future releases when linker plugin enabled environments become more
8435 common.
8437 @item -fcompare-elim
8438 @opindex fcompare-elim
8439 After register allocation and post-register allocation instruction splitting,
8440 identify arithmetic instructions that compute processor flags similar to a
8441 comparison operation based on that arithmetic.  If possible, eliminate the
8442 explicit comparison operation.
8444 This pass only applies to certain targets that cannot explicitly represent
8445 the comparison operation before register allocation is complete.
8447 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8449 @item -fuse-ld=bfd
8450 Use the @command{bfd} linker instead of the default linker.
8452 @item -fuse-ld=gold
8453 Use the @command{gold} linker instead of the default linker.
8455 @item -fcprop-registers
8456 @opindex fcprop-registers
8457 After register allocation and post-register allocation instruction splitting,
8458 perform a copy-propagation pass to try to reduce scheduling dependencies
8459 and occasionally eliminate the copy.
8461 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8463 @item -fprofile-correction
8464 @opindex fprofile-correction
8465 Profiles collected using an instrumented binary for multi-threaded programs may
8466 be inconsistent due to missed counter updates. When this option is specified,
8467 GCC uses heuristics to correct or smooth out such inconsistencies. By
8468 default, GCC emits an error message when an inconsistent profile is detected.
8470 @item -fprofile-dir=@var{path}
8471 @opindex fprofile-dir
8473 Set the directory to search for the profile data files in to @var{path}.
8474 This option affects only the profile data generated by
8475 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8476 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8477 and its related options.  Both absolute and relative paths can be used.
8478 By default, GCC uses the current directory as @var{path}, thus the
8479 profile data file appears in the same directory as the object file.
8481 @item -fprofile-generate
8482 @itemx -fprofile-generate=@var{path}
8483 @opindex fprofile-generate
8485 Enable options usually used for instrumenting application to produce
8486 profile useful for later recompilation with profile feedback based
8487 optimization.  You must use @option{-fprofile-generate} both when
8488 compiling and when linking your program.
8490 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8492 If @var{path} is specified, GCC looks at the @var{path} to find
8493 the profile feedback data files. See @option{-fprofile-dir}.
8495 @item -fprofile-use
8496 @itemx -fprofile-use=@var{path}
8497 @opindex fprofile-use
8498 Enable profile feedback directed optimizations, and optimizations
8499 generally profitable only with profile feedback available.
8501 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8502 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8503 @code{ftree-loop-distribute-patterns}
8505 By default, GCC emits an error message if the feedback profiles do not
8506 match the source code.  This error can be turned into a warning by using
8507 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8508 code.
8510 If @var{path} is specified, GCC looks at the @var{path} to find
8511 the profile feedback data files. See @option{-fprofile-dir}.
8512 @end table
8514 The following options control compiler behavior regarding floating-point 
8515 arithmetic.  These options trade off between speed and
8516 correctness.  All must be specifically enabled.
8518 @table @gcctabopt
8519 @item -ffloat-store
8520 @opindex ffloat-store
8521 Do not store floating-point variables in registers, and inhibit other
8522 options that might change whether a floating-point value is taken from a
8523 register or memory.
8525 @cindex floating-point precision
8526 This option prevents undesirable excess precision on machines such as
8527 the 68000 where the floating registers (of the 68881) keep more
8528 precision than a @code{double} is supposed to have.  Similarly for the
8529 x86 architecture.  For most programs, the excess precision does only
8530 good, but a few programs rely on the precise definition of IEEE floating
8531 point.  Use @option{-ffloat-store} for such programs, after modifying
8532 them to store all pertinent intermediate computations into variables.
8534 @item -fexcess-precision=@var{style}
8535 @opindex fexcess-precision
8536 This option allows further control over excess precision on machines
8537 where floating-point registers have more precision than the IEEE
8538 @code{float} and @code{double} types and the processor does not
8539 support operations rounding to those types.  By default,
8540 @option{-fexcess-precision=fast} is in effect; this means that
8541 operations are carried out in the precision of the registers and that
8542 it is unpredictable when rounding to the types specified in the source
8543 code takes place.  When compiling C, if
8544 @option{-fexcess-precision=standard} is specified then excess
8545 precision follows the rules specified in ISO C99; in particular,
8546 both casts and assignments cause values to be rounded to their
8547 semantic types (whereas @option{-ffloat-store} only affects
8548 assignments).  This option is enabled by default for C if a strict
8549 conformance option such as @option{-std=c99} is used.
8551 @opindex mfpmath
8552 @option{-fexcess-precision=standard} is not implemented for languages
8553 other than C, and has no effect if
8554 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8555 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8556 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8557 semantics apply without excess precision, and in the latter, rounding
8558 is unpredictable.
8560 @item -ffast-math
8561 @opindex ffast-math
8562 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8563 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8564 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8566 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8568 This option is not turned on by any @option{-O} option besides
8569 @option{-Ofast} since it can result in incorrect output for programs
8570 that depend on an exact implementation of IEEE or ISO rules/specifications
8571 for math functions. It may, however, yield faster code for programs
8572 that do not require the guarantees of these specifications.
8574 @item -fno-math-errno
8575 @opindex fno-math-errno
8576 Do not set @code{errno} after calling math functions that are executed
8577 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8578 IEEE exceptions for math error handling may want to use this flag
8579 for speed while maintaining IEEE arithmetic compatibility.
8581 This option is not turned on by any @option{-O} option since
8582 it can result in incorrect output for programs that depend on
8583 an exact implementation of IEEE or ISO rules/specifications for
8584 math functions. It may, however, yield faster code for programs
8585 that do not require the guarantees of these specifications.
8587 The default is @option{-fmath-errno}.
8589 On Darwin systems, the math library never sets @code{errno}.  There is
8590 therefore no reason for the compiler to consider the possibility that
8591 it might, and @option{-fno-math-errno} is the default.
8593 @item -funsafe-math-optimizations
8594 @opindex funsafe-math-optimizations
8596 Allow optimizations for floating-point arithmetic that (a) assume
8597 that arguments and results are valid and (b) may violate IEEE or
8598 ANSI standards.  When used at link-time, it may include libraries
8599 or startup files that change the default FPU control word or other
8600 similar optimizations.
8602 This option is not turned on by any @option{-O} option since
8603 it can result in incorrect output for programs that depend on
8604 an exact implementation of IEEE or ISO rules/specifications for
8605 math functions. It may, however, yield faster code for programs
8606 that do not require the guarantees of these specifications.
8607 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8608 @option{-fassociative-math} and @option{-freciprocal-math}.
8610 The default is @option{-fno-unsafe-math-optimizations}.
8612 @item -fassociative-math
8613 @opindex fassociative-math
8615 Allow re-association of operands in series of floating-point operations.
8616 This violates the ISO C and C++ language standard by possibly changing
8617 computation result.  NOTE: re-ordering may change the sign of zero as
8618 well as ignore NaNs and inhibit or create underflow or overflow (and
8619 thus cannot be used on code that relies on rounding behavior like
8620 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8621 and thus may not be used when ordered comparisons are required.
8622 This option requires that both @option{-fno-signed-zeros} and
8623 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8624 much sense with @option{-frounding-math}. For Fortran the option
8625 is automatically enabled when both @option{-fno-signed-zeros} and
8626 @option{-fno-trapping-math} are in effect.
8628 The default is @option{-fno-associative-math}.
8630 @item -freciprocal-math
8631 @opindex freciprocal-math
8633 Allow the reciprocal of a value to be used instead of dividing by
8634 the value if this enables optimizations.  For example @code{x / y}
8635 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8636 is subject to common subexpression elimination.  Note that this loses
8637 precision and increases the number of flops operating on the value.
8639 The default is @option{-fno-reciprocal-math}.
8641 @item -ffinite-math-only
8642 @opindex ffinite-math-only
8643 Allow optimizations for floating-point arithmetic that assume
8644 that arguments and results are not NaNs or +-Infs.
8646 This option is not turned on by any @option{-O} option since
8647 it can result in incorrect output for programs that depend on
8648 an exact implementation of IEEE or ISO rules/specifications for
8649 math functions. It may, however, yield faster code for programs
8650 that do not require the guarantees of these specifications.
8652 The default is @option{-fno-finite-math-only}.
8654 @item -fno-signed-zeros
8655 @opindex fno-signed-zeros
8656 Allow optimizations for floating-point arithmetic that ignore the
8657 signedness of zero.  IEEE arithmetic specifies the behavior of
8658 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8659 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8660 This option implies that the sign of a zero result isn't significant.
8662 The default is @option{-fsigned-zeros}.
8664 @item -fno-trapping-math
8665 @opindex fno-trapping-math
8666 Compile code assuming that floating-point operations cannot generate
8667 user-visible traps.  These traps include division by zero, overflow,
8668 underflow, inexact result and invalid operation.  This option requires
8669 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8670 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8672 This option should never be turned on by any @option{-O} option since
8673 it can result in incorrect output for programs that depend on
8674 an exact implementation of IEEE or ISO rules/specifications for
8675 math functions.
8677 The default is @option{-ftrapping-math}.
8679 @item -frounding-math
8680 @opindex frounding-math
8681 Disable transformations and optimizations that assume default floating-point
8682 rounding behavior.  This is round-to-zero for all floating point
8683 to integer conversions, and round-to-nearest for all other arithmetic
8684 truncations.  This option should be specified for programs that change
8685 the FP rounding mode dynamically, or that may be executed with a
8686 non-default rounding mode.  This option disables constant folding of
8687 floating-point expressions at compile time (which may be affected by
8688 rounding mode) and arithmetic transformations that are unsafe in the
8689 presence of sign-dependent rounding modes.
8691 The default is @option{-fno-rounding-math}.
8693 This option is experimental and does not currently guarantee to
8694 disable all GCC optimizations that are affected by rounding mode.
8695 Future versions of GCC may provide finer control of this setting
8696 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8697 will be used to specify the default state for @code{FENV_ACCESS}.
8699 @item -fsignaling-nans
8700 @opindex fsignaling-nans
8701 Compile code assuming that IEEE signaling NaNs may generate user-visible
8702 traps during floating-point operations.  Setting this option disables
8703 optimizations that may change the number of exceptions visible with
8704 signaling NaNs.  This option implies @option{-ftrapping-math}.
8706 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8707 be defined.
8709 The default is @option{-fno-signaling-nans}.
8711 This option is experimental and does not currently guarantee to
8712 disable all GCC optimizations that affect signaling NaN behavior.
8714 @item -fsingle-precision-constant
8715 @opindex fsingle-precision-constant
8716 Treat floating-point constants as single precision instead of
8717 implicitly converting them to double-precision constants.
8719 @item -fcx-limited-range
8720 @opindex fcx-limited-range
8721 When enabled, this option states that a range reduction step is not
8722 needed when performing complex division.  Also, there is no checking
8723 whether the result of a complex multiplication or division is @code{NaN
8724 + I*NaN}, with an attempt to rescue the situation in that case.  The
8725 default is @option{-fno-cx-limited-range}, but is enabled by
8726 @option{-ffast-math}.
8728 This option controls the default setting of the ISO C99
8729 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8730 all languages.
8732 @item -fcx-fortran-rules
8733 @opindex fcx-fortran-rules
8734 Complex multiplication and division follow Fortran rules.  Range
8735 reduction is done as part of complex division, but there is no checking
8736 whether the result of a complex multiplication or division is @code{NaN
8737 + I*NaN}, with an attempt to rescue the situation in that case.
8739 The default is @option{-fno-cx-fortran-rules}.
8741 @end table
8743 The following options control optimizations that may improve
8744 performance, but are not enabled by any @option{-O} options.  This
8745 section includes experimental options that may produce broken code.
8747 @table @gcctabopt
8748 @item -fbranch-probabilities
8749 @opindex fbranch-probabilities
8750 After running a program compiled with @option{-fprofile-arcs}
8751 (@pxref{Debugging Options,, Options for Debugging Your Program or
8752 @command{gcc}}), you can compile it a second time using
8753 @option{-fbranch-probabilities}, to improve optimizations based on
8754 the number of times each branch was taken.  When a program
8755 compiled with @option{-fprofile-arcs} exits, it saves arc execution
8756 counts to a file called @file{@var{sourcename}.gcda} for each source
8757 file.  The information in this data file is very dependent on the
8758 structure of the generated code, so you must use the same source code
8759 and the same optimization options for both compilations.
8761 With @option{-fbranch-probabilities}, GCC puts a
8762 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8763 These can be used to improve optimization.  Currently, they are only
8764 used in one place: in @file{reorg.c}, instead of guessing which path a
8765 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8766 exactly determine which path is taken more often.
8768 @item -fprofile-values
8769 @opindex fprofile-values
8770 If combined with @option{-fprofile-arcs}, it adds code so that some
8771 data about values of expressions in the program is gathered.
8773 With @option{-fbranch-probabilities}, it reads back the data gathered
8774 from profiling values of expressions for usage in optimizations.
8776 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8778 @item -fvpt
8779 @opindex fvpt
8780 If combined with @option{-fprofile-arcs}, this option instructs the compiler
8781 to add code to gather information about values of expressions.
8783 With @option{-fbranch-probabilities}, it reads back the data gathered
8784 and actually performs the optimizations based on them.
8785 Currently the optimizations include specialization of division operations
8786 using the knowledge about the value of the denominator.
8788 @item -frename-registers
8789 @opindex frename-registers
8790 Attempt to avoid false dependencies in scheduled code by making use
8791 of registers left over after register allocation.  This optimization
8792 most benefits processors with lots of registers.  Depending on the
8793 debug information format adopted by the target, however, it can
8794 make debugging impossible, since variables no longer stay in
8795 a ``home register''.
8797 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8799 @item -ftracer
8800 @opindex ftracer
8801 Perform tail duplication to enlarge superblock size.  This transformation
8802 simplifies the control flow of the function allowing other optimizations to do
8803 a better job.
8805 Enabled with @option{-fprofile-use}.
8807 @item -funroll-loops
8808 @opindex funroll-loops
8809 Unroll loops whose number of iterations can be determined at compile time or
8810 upon entry to the loop.  @option{-funroll-loops} implies
8811 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8812 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8813 a small constant number of iterations).  This option makes code larger, and may
8814 or may not make it run faster.
8816 Enabled with @option{-fprofile-use}.
8818 @item -funroll-all-loops
8819 @opindex funroll-all-loops
8820 Unroll all loops, even if their number of iterations is uncertain when
8821 the loop is entered.  This usually makes programs run more slowly.
8822 @option{-funroll-all-loops} implies the same options as
8823 @option{-funroll-loops}.
8825 @item -fpeel-loops
8826 @opindex fpeel-loops
8827 Peels loops for which there is enough information that they do not
8828 roll much (from profile feedback).  It also turns on complete loop peeling
8829 (i.e.@: complete removal of loops with small constant number of iterations).
8831 Enabled with @option{-fprofile-use}.
8833 @item -fmove-loop-invariants
8834 @opindex fmove-loop-invariants
8835 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8836 at level @option{-O1}
8838 @item -funswitch-loops
8839 @opindex funswitch-loops
8840 Move branches with loop invariant conditions out of the loop, with duplicates
8841 of the loop on both branches (modified according to result of the condition).
8843 @item -ffunction-sections
8844 @itemx -fdata-sections
8845 @opindex ffunction-sections
8846 @opindex fdata-sections
8847 Place each function or data item into its own section in the output
8848 file if the target supports arbitrary sections.  The name of the
8849 function or the name of the data item determines the section's name
8850 in the output file.
8852 Use these options on systems where the linker can perform optimizations
8853 to improve locality of reference in the instruction space.  Most systems
8854 using the ELF object format and SPARC processors running Solaris 2 have
8855 linkers with such optimizations.  AIX may have these optimizations in
8856 the future.
8858 Only use these options when there are significant benefits from doing
8859 so.  When you specify these options, the assembler and linker
8860 create larger object and executable files and are also slower.
8861 You cannot use @code{gprof} on all systems if you
8862 specify this option, and you may have problems with debugging if
8863 you specify both this option and @option{-g}.
8865 @item -fbranch-target-load-optimize
8866 @opindex fbranch-target-load-optimize
8867 Perform branch target register load optimization before prologue / epilogue
8868 threading.
8869 The use of target registers can typically be exposed only during reload,
8870 thus hoisting loads out of loops and doing inter-block scheduling needs
8871 a separate optimization pass.
8873 @item -fbranch-target-load-optimize2
8874 @opindex fbranch-target-load-optimize2
8875 Perform branch target register load optimization after prologue / epilogue
8876 threading.
8878 @item -fbtr-bb-exclusive
8879 @opindex fbtr-bb-exclusive
8880 When performing branch target register load optimization, don't reuse
8881 branch target registers within any basic block.
8883 @item -fstack-protector
8884 @opindex fstack-protector
8885 Emit extra code to check for buffer overflows, such as stack smashing
8886 attacks.  This is done by adding a guard variable to functions with
8887 vulnerable objects.  This includes functions that call @code{alloca}, and
8888 functions with buffers larger than 8 bytes.  The guards are initialized
8889 when a function is entered and then checked when the function exits.
8890 If a guard check fails, an error message is printed and the program exits.
8892 @item -fstack-protector-all
8893 @opindex fstack-protector-all
8894 Like @option{-fstack-protector} except that all functions are protected.
8896 @item -fsection-anchors
8897 @opindex fsection-anchors
8898 Try to reduce the number of symbolic address calculations by using
8899 shared ``anchor'' symbols to address nearby objects.  This transformation
8900 can help to reduce the number of GOT entries and GOT accesses on some
8901 targets.
8903 For example, the implementation of the following function @code{foo}:
8905 @smallexample
8906 static int a, b, c;
8907 int foo (void) @{ return a + b + c; @}
8908 @end smallexample
8910 @noindent
8911 usually calculates the addresses of all three variables, but if you
8912 compile it with @option{-fsection-anchors}, it accesses the variables
8913 from a common anchor point instead.  The effect is similar to the
8914 following pseudocode (which isn't valid C):
8916 @smallexample
8917 int foo (void)
8919   register int *xr = &x;
8920   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8922 @end smallexample
8924 Not all targets support this option.
8926 @item --param @var{name}=@var{value}
8927 @opindex param
8928 In some places, GCC uses various constants to control the amount of
8929 optimization that is done.  For example, GCC does not inline functions
8930 that contain more than a certain number of instructions.  You can
8931 control some of these constants on the command line using the
8932 @option{--param} option.
8934 The names of specific parameters, and the meaning of the values, are
8935 tied to the internals of the compiler, and are subject to change
8936 without notice in future releases.
8938 In each case, the @var{value} is an integer.  The allowable choices for
8939 @var{name} are:
8941 @table @gcctabopt
8942 @item predictable-branch-outcome
8943 When branch is predicted to be taken with probability lower than this threshold
8944 (in percent), then it is considered well predictable. The default is 10.
8946 @item max-crossjump-edges
8947 The maximum number of incoming edges to consider for cross-jumping.
8948 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8949 the number of edges incoming to each block.  Increasing values mean
8950 more aggressive optimization, making the compilation time increase with
8951 probably small improvement in executable size.
8953 @item min-crossjump-insns
8954 The minimum number of instructions that must be matched at the end
8955 of two blocks before cross-jumping is performed on them.  This
8956 value is ignored in the case where all instructions in the block being
8957 cross-jumped from are matched.  The default value is 5.
8959 @item max-grow-copy-bb-insns
8960 The maximum code size expansion factor when copying basic blocks
8961 instead of jumping.  The expansion is relative to a jump instruction.
8962 The default value is 8.
8964 @item max-goto-duplication-insns
8965 The maximum number of instructions to duplicate to a block that jumps
8966 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8967 passes, GCC factors computed gotos early in the compilation process,
8968 and unfactors them as late as possible.  Only computed jumps at the
8969 end of a basic blocks with no more than max-goto-duplication-insns are
8970 unfactored.  The default value is 8.
8972 @item max-delay-slot-insn-search
8973 The maximum number of instructions to consider when looking for an
8974 instruction to fill a delay slot.  If more than this arbitrary number of
8975 instructions are searched, the time savings from filling the delay slot
8976 are minimal, so stop searching.  Increasing values mean more
8977 aggressive optimization, making the compilation time increase with probably
8978 small improvement in execution time.
8980 @item max-delay-slot-live-search
8981 When trying to fill delay slots, the maximum number of instructions to
8982 consider when searching for a block with valid live register
8983 information.  Increasing this arbitrarily chosen value means more
8984 aggressive optimization, increasing the compilation time.  This parameter
8985 should be removed when the delay slot code is rewritten to maintain the
8986 control-flow graph.
8988 @item max-gcse-memory
8989 The approximate maximum amount of memory that can be allocated in
8990 order to perform the global common subexpression elimination
8991 optimization.  If more memory than specified is required, the
8992 optimization is not done.
8994 @item max-gcse-insertion-ratio
8995 If the ratio of expression insertions to deletions is larger than this value
8996 for any expression, then RTL PRE inserts or removes the expression and thus
8997 leaves partially redundant computations in the instruction stream.  The default value is 20.
8999 @item max-pending-list-length
9000 The maximum number of pending dependencies scheduling allows
9001 before flushing the current state and starting over.  Large functions
9002 with few branches or calls can create excessively large lists which
9003 needlessly consume memory and resources.
9005 @item max-modulo-backtrack-attempts
9006 The maximum number of backtrack attempts the scheduler should make
9007 when modulo scheduling a loop.  Larger values can exponentially increase
9008 compilation time.
9010 @item max-inline-insns-single
9011 Several parameters control the tree inliner used in GCC@.
9012 This number sets the maximum number of instructions (counted in GCC's
9013 internal representation) in a single function that the tree inliner
9014 considers for inlining.  This only affects functions declared
9015 inline and methods implemented in a class declaration (C++).
9016 The default value is 400.
9018 @item max-inline-insns-auto
9019 When you use @option{-finline-functions} (included in @option{-O3}),
9020 a lot of functions that would otherwise not be considered for inlining
9021 by the compiler are investigated.  To those functions, a different
9022 (more restrictive) limit compared to functions declared inline can
9023 be applied.
9024 The default value is 40.
9026 @item inline-min-speedup
9027 When estimated performance improvement of caller + callee runtime exceeds this
9028 threshold (in precent), the function can be inlined regardless the limit on
9029 @option{--param max-inline-insns-single} and @option{--param
9030 max-inline-insns-auto}.
9032 @item large-function-insns
9033 The limit specifying really large functions.  For functions larger than this
9034 limit after inlining, inlining is constrained by
9035 @option{--param large-function-growth}.  This parameter is useful primarily
9036 to avoid extreme compilation time caused by non-linear algorithms used by the
9037 back end.
9038 The default value is 2700.
9040 @item large-function-growth
9041 Specifies maximal growth of large function caused by inlining in percents.
9042 The default value is 100 which limits large function growth to 2.0 times
9043 the original size.
9045 @item large-unit-insns
9046 The limit specifying large translation unit.  Growth caused by inlining of
9047 units larger than this limit is limited by @option{--param inline-unit-growth}.
9048 For small units this might be too tight.
9049 For example, consider a unit consisting of function A
9050 that is inline and B that just calls A three times.  If B is small relative to
9051 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9052 large units consisting of small inlineable functions, however, the overall unit
9053 growth limit is needed to avoid exponential explosion of code size.  Thus for
9054 smaller units, the size is increased to @option{--param large-unit-insns}
9055 before applying @option{--param inline-unit-growth}.  The default is 10000.
9057 @item inline-unit-growth
9058 Specifies maximal overall growth of the compilation unit caused by inlining.
9059 The default value is 30 which limits unit growth to 1.3 times the original
9060 size.
9062 @item ipcp-unit-growth
9063 Specifies maximal overall growth of the compilation unit caused by
9064 interprocedural constant propagation.  The default value is 10 which limits
9065 unit growth to 1.1 times the original size.
9067 @item large-stack-frame
9068 The limit specifying large stack frames.  While inlining the algorithm is trying
9069 to not grow past this limit too much.  The default value is 256 bytes.
9071 @item large-stack-frame-growth
9072 Specifies maximal growth of large stack frames caused by inlining in percents.
9073 The default value is 1000 which limits large stack frame growth to 11 times
9074 the original size.
9076 @item max-inline-insns-recursive
9077 @itemx max-inline-insns-recursive-auto
9078 Specifies the maximum number of instructions an out-of-line copy of a
9079 self-recursive inline
9080 function can grow into by performing recursive inlining.
9082 For functions declared inline, @option{--param max-inline-insns-recursive} is
9083 taken into account.  For functions not declared inline, recursive inlining
9084 happens only when @option{-finline-functions} (included in @option{-O3}) is
9085 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9086 default value is 450.
9088 @item max-inline-recursive-depth
9089 @itemx max-inline-recursive-depth-auto
9090 Specifies the maximum recursion depth used for recursive inlining.
9092 For functions declared inline, @option{--param max-inline-recursive-depth} is
9093 taken into account.  For functions not declared inline, recursive inlining
9094 happens only when @option{-finline-functions} (included in @option{-O3}) is
9095 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9096 default value is 8.
9098 @item min-inline-recursive-probability
9099 Recursive inlining is profitable only for function having deep recursion
9100 in average and can hurt for function having little recursion depth by
9101 increasing the prologue size or complexity of function body to other
9102 optimizers.
9104 When profile feedback is available (see @option{-fprofile-generate}) the actual
9105 recursion depth can be guessed from probability that function recurses via a
9106 given call expression.  This parameter limits inlining only to call expressions
9107 whose probability exceeds the given threshold (in percents).
9108 The default value is 10.
9110 @item early-inlining-insns
9111 Specify growth that the early inliner can make.  In effect it increases
9112 the amount of inlining for code having a large abstraction penalty.
9113 The default value is 10.
9115 @item max-early-inliner-iterations
9116 @itemx max-early-inliner-iterations
9117 Limit of iterations of the early inliner.  This basically bounds
9118 the number of nested indirect calls the early inliner can resolve.
9119 Deeper chains are still handled by late inlining.
9121 @item comdat-sharing-probability
9122 @itemx comdat-sharing-probability
9123 Probability (in percent) that C++ inline function with comdat visibility
9124 are shared across multiple compilation units.  The default value is 20.
9126 @item min-vect-loop-bound
9127 The minimum number of iterations under which loops are not vectorized
9128 when @option{-ftree-vectorize} is used.  The number of iterations after
9129 vectorization needs to be greater than the value specified by this option
9130 to allow vectorization.  The default value is 0.
9132 @item gcse-cost-distance-ratio
9133 Scaling factor in calculation of maximum distance an expression
9134 can be moved by GCSE optimizations.  This is currently supported only in the
9135 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9136 is with simple expressions, i.e., the expressions that have cost
9137 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9138 hoisting of simple expressions.  The default value is 10.
9140 @item gcse-unrestricted-cost
9141 Cost, roughly measured as the cost of a single typical machine
9142 instruction, at which GCSE optimizations do not constrain
9143 the distance an expression can travel.  This is currently
9144 supported only in the code hoisting pass.  The lesser the cost,
9145 the more aggressive code hoisting is.  Specifying 0 
9146 allows all expressions to travel unrestricted distances.
9147 The default value is 3.
9149 @item max-hoist-depth
9150 The depth of search in the dominator tree for expressions to hoist.
9151 This is used to avoid quadratic behavior in hoisting algorithm.
9152 The value of 0 does not limit on the search, but may slow down compilation
9153 of huge functions.  The default value is 30.
9155 @item max-tail-merge-comparisons
9156 The maximum amount of similar bbs to compare a bb with.  This is used to
9157 avoid quadratic behavior in tree tail merging.  The default value is 10.
9159 @item max-tail-merge-iterations
9160 The maximum amount of iterations of the pass over the function.  This is used to
9161 limit compilation time in tree tail merging.  The default value is 2.
9163 @item max-unrolled-insns
9164 The maximum number of instructions that a loop may have to be unrolled.
9165 If a loop is unrolled, this parameter also determines how many times
9166 the loop code is unrolled.
9168 @item max-average-unrolled-insns
9169 The maximum number of instructions biased by probabilities of their execution
9170 that a loop may have to be unrolled.  If a loop is unrolled,
9171 this parameter also determines how many times the loop code is unrolled.
9173 @item max-unroll-times
9174 The maximum number of unrollings of a single loop.
9176 @item max-peeled-insns
9177 The maximum number of instructions that a loop may have to be peeled.
9178 If a loop is peeled, this parameter also determines how many times
9179 the loop code is peeled.
9181 @item max-peel-times
9182 The maximum number of peelings of a single loop.
9184 @item max-peel-branches
9185 The maximum number of branches on the hot path through the peeled sequence.
9187 @item max-completely-peeled-insns
9188 The maximum number of insns of a completely peeled loop.
9190 @item max-completely-peel-times
9191 The maximum number of iterations of a loop to be suitable for complete peeling.
9193 @item max-completely-peel-loop-nest-depth
9194 The maximum depth of a loop nest suitable for complete peeling.
9196 @item max-unswitch-insns
9197 The maximum number of insns of an unswitched loop.
9199 @item max-unswitch-level
9200 The maximum number of branches unswitched in a single loop.
9202 @item lim-expensive
9203 The minimum cost of an expensive expression in the loop invariant motion.
9205 @item iv-consider-all-candidates-bound
9206 Bound on number of candidates for induction variables, below which
9207 all candidates are considered for each use in induction variable
9208 optimizations.  If there are more candidates than this,
9209 only the most relevant ones are considered to avoid quadratic time complexity.
9211 @item iv-max-considered-uses
9212 The induction variable optimizations give up on loops that contain more
9213 induction variable uses.
9215 @item iv-always-prune-cand-set-bound
9216 If the number of candidates in the set is smaller than this value,
9217 always try to remove unnecessary ivs from the set
9218 when adding a new one.
9220 @item scev-max-expr-size
9221 Bound on size of expressions used in the scalar evolutions analyzer.
9222 Large expressions slow the analyzer.
9224 @item scev-max-expr-complexity
9225 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9226 Complex expressions slow the analyzer.
9228 @item omega-max-vars
9229 The maximum number of variables in an Omega constraint system.
9230 The default value is 128.
9232 @item omega-max-geqs
9233 The maximum number of inequalities in an Omega constraint system.
9234 The default value is 256.
9236 @item omega-max-eqs
9237 The maximum number of equalities in an Omega constraint system.
9238 The default value is 128.
9240 @item omega-max-wild-cards
9241 The maximum number of wildcard variables that the Omega solver is
9242 able to insert.  The default value is 18.
9244 @item omega-hash-table-size
9245 The size of the hash table in the Omega solver.  The default value is
9246 550.
9248 @item omega-max-keys
9249 The maximal number of keys used by the Omega solver.  The default
9250 value is 500.
9252 @item omega-eliminate-redundant-constraints
9253 When set to 1, use expensive methods to eliminate all redundant
9254 constraints.  The default value is 0.
9256 @item vect-max-version-for-alignment-checks
9257 The maximum number of run-time checks that can be performed when
9258 doing loop versioning for alignment in the vectorizer.  See option
9259 @option{-ftree-vect-loop-version} for more information.
9261 @item vect-max-version-for-alias-checks
9262 The maximum number of run-time checks that can be performed when
9263 doing loop versioning for alias in the vectorizer.  See option
9264 @option{-ftree-vect-loop-version} for more information.
9266 @item max-iterations-to-track
9267 The maximum number of iterations of a loop the brute-force algorithm
9268 for analysis of the number of iterations of the loop tries to evaluate.
9270 @item hot-bb-count-ws-permille
9271 A basic block profile count is considered hot if it contributes to 
9272 the given permillage (i.e. 0...1000) of the entire profiled execution.
9274 @item hot-bb-frequency-fraction
9275 Select fraction of the entry block frequency of executions of basic block in
9276 function given basic block needs to have to be considered hot.
9278 @item max-predicted-iterations
9279 The maximum number of loop iterations we predict statically.  This is useful
9280 in cases where a function contains a single loop with known bound and
9281 another loop with unknown bound.
9282 The known number of iterations is predicted correctly, while
9283 the unknown number of iterations average to roughly 10.  This means that the
9284 loop without bounds appears artificially cold relative to the other one.
9286 @item align-threshold
9288 Select fraction of the maximal frequency of executions of a basic block in
9289 a function to align the basic block.
9291 @item align-loop-iterations
9293 A loop expected to iterate at least the selected number of iterations is
9294 aligned.
9296 @item tracer-dynamic-coverage
9297 @itemx tracer-dynamic-coverage-feedback
9299 This value is used to limit superblock formation once the given percentage of
9300 executed instructions is covered.  This limits unnecessary code size
9301 expansion.
9303 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9304 feedback is available.  The real profiles (as opposed to statically estimated
9305 ones) are much less balanced allowing the threshold to be larger value.
9307 @item tracer-max-code-growth
9308 Stop tail duplication once code growth has reached given percentage.  This is
9309 a rather artificial limit, as most of the duplicates are eliminated later in
9310 cross jumping, so it may be set to much higher values than is the desired code
9311 growth.
9313 @item tracer-min-branch-ratio
9315 Stop reverse growth when the reverse probability of best edge is less than this
9316 threshold (in percent).
9318 @item tracer-min-branch-ratio
9319 @itemx tracer-min-branch-ratio-feedback
9321 Stop forward growth if the best edge has probability lower than this
9322 threshold.
9324 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9325 compilation for profile feedback and one for compilation without.  The value
9326 for compilation with profile feedback needs to be more conservative (higher) in
9327 order to make tracer effective.
9329 @item max-cse-path-length
9331 The maximum number of basic blocks on path that CSE considers.
9332 The default is 10.
9334 @item max-cse-insns
9335 The maximum number of instructions CSE processes before flushing.
9336 The default is 1000.
9338 @item ggc-min-expand
9340 GCC uses a garbage collector to manage its own memory allocation.  This
9341 parameter specifies the minimum percentage by which the garbage
9342 collector's heap should be allowed to expand between collections.
9343 Tuning this may improve compilation speed; it has no effect on code
9344 generation.
9346 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9347 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9348 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9349 GCC is not able to calculate RAM on a particular platform, the lower
9350 bound of 30% is used.  Setting this parameter and
9351 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9352 every opportunity.  This is extremely slow, but can be useful for
9353 debugging.
9355 @item ggc-min-heapsize
9357 Minimum size of the garbage collector's heap before it begins bothering
9358 to collect garbage.  The first collection occurs after the heap expands
9359 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9360 tuning this may improve compilation speed, and has no effect on code
9361 generation.
9363 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9364 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9365 with a lower bound of 4096 (four megabytes) and an upper bound of
9366 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9367 particular platform, the lower bound is used.  Setting this parameter
9368 very large effectively disables garbage collection.  Setting this
9369 parameter and @option{ggc-min-expand} to zero causes a full collection
9370 to occur at every opportunity.
9372 @item max-reload-search-insns
9373 The maximum number of instruction reload should look backward for equivalent
9374 register.  Increasing values mean more aggressive optimization, making the
9375 compilation time increase with probably slightly better performance.
9376 The default value is 100.
9378 @item max-cselib-memory-locations
9379 The maximum number of memory locations cselib should take into account.
9380 Increasing values mean more aggressive optimization, making the compilation time
9381 increase with probably slightly better performance.  The default value is 500.
9383 @item reorder-blocks-duplicate
9384 @itemx reorder-blocks-duplicate-feedback
9386 Used by the basic block reordering pass to decide whether to use unconditional
9387 branch or duplicate the code on its destination.  Code is duplicated when its
9388 estimated size is smaller than this value multiplied by the estimated size of
9389 unconditional jump in the hot spots of the program.
9391 The @option{reorder-block-duplicate-feedback} is used only when profile
9392 feedback is available.  It may be set to higher values than
9393 @option{reorder-block-duplicate} since information about the hot spots is more
9394 accurate.
9396 @item max-sched-ready-insns
9397 The maximum number of instructions ready to be issued the scheduler should
9398 consider at any given time during the first scheduling pass.  Increasing
9399 values mean more thorough searches, making the compilation time increase
9400 with probably little benefit.  The default value is 100.
9402 @item max-sched-region-blocks
9403 The maximum number of blocks in a region to be considered for
9404 interblock scheduling.  The default value is 10.
9406 @item max-pipeline-region-blocks
9407 The maximum number of blocks in a region to be considered for
9408 pipelining in the selective scheduler.  The default value is 15.
9410 @item max-sched-region-insns
9411 The maximum number of insns in a region to be considered for
9412 interblock scheduling.  The default value is 100.
9414 @item max-pipeline-region-insns
9415 The maximum number of insns in a region to be considered for
9416 pipelining in the selective scheduler.  The default value is 200.
9418 @item min-spec-prob
9419 The minimum probability (in percents) of reaching a source block
9420 for interblock speculative scheduling.  The default value is 40.
9422 @item max-sched-extend-regions-iters
9423 The maximum number of iterations through CFG to extend regions.
9424 A value of 0 (the default) disables region extensions.
9426 @item max-sched-insn-conflict-delay
9427 The maximum conflict delay for an insn to be considered for speculative motion.
9428 The default value is 3.
9430 @item sched-spec-prob-cutoff
9431 The minimal probability of speculation success (in percents), so that
9432 speculative insns are scheduled.
9433 The default value is 40.
9435 @item sched-spec-state-edge-prob-cutoff
9436 The minimum probability an edge must have for the scheduler to save its
9437 state across it.
9438 The default value is 10.
9440 @item sched-mem-true-dep-cost
9441 Minimal distance (in CPU cycles) between store and load targeting same
9442 memory locations.  The default value is 1.
9444 @item selsched-max-lookahead
9445 The maximum size of the lookahead window of selective scheduling.  It is a
9446 depth of search for available instructions.
9447 The default value is 50.
9449 @item selsched-max-sched-times
9450 The maximum number of times that an instruction is scheduled during
9451 selective scheduling.  This is the limit on the number of iterations
9452 through which the instruction may be pipelined.  The default value is 2.
9454 @item selsched-max-insns-to-rename
9455 The maximum number of best instructions in the ready list that are considered
9456 for renaming in the selective scheduler.  The default value is 2.
9458 @item sms-min-sc
9459 The minimum value of stage count that swing modulo scheduler
9460 generates.  The default value is 2.
9462 @item max-last-value-rtl
9463 The maximum size measured as number of RTLs that can be recorded in an expression
9464 in combiner for a pseudo register as last known value of that register.  The default
9465 is 10000.
9467 @item integer-share-limit
9468 Small integer constants can use a shared data structure, reducing the
9469 compiler's memory usage and increasing its speed.  This sets the maximum
9470 value of a shared integer constant.  The default value is 256.
9472 @item ssp-buffer-size
9473 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9474 protection when @option{-fstack-protection} is used.
9476 @item max-jump-thread-duplication-stmts
9477 Maximum number of statements allowed in a block that needs to be
9478 duplicated when threading jumps.
9480 @item max-fields-for-field-sensitive
9481 Maximum number of fields in a structure treated in
9482 a field sensitive manner during pointer analysis.  The default is zero
9483 for @option{-O0} and @option{-O1},
9484 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9486 @item prefetch-latency
9487 Estimate on average number of instructions that are executed before
9488 prefetch finishes.  The distance prefetched ahead is proportional
9489 to this constant.  Increasing this number may also lead to less
9490 streams being prefetched (see @option{simultaneous-prefetches}).
9492 @item simultaneous-prefetches
9493 Maximum number of prefetches that can run at the same time.
9495 @item l1-cache-line-size
9496 The size of cache line in L1 cache, in bytes.
9498 @item l1-cache-size
9499 The size of L1 cache, in kilobytes.
9501 @item l2-cache-size
9502 The size of L2 cache, in kilobytes.
9504 @item min-insn-to-prefetch-ratio
9505 The minimum ratio between the number of instructions and the
9506 number of prefetches to enable prefetching in a loop.
9508 @item prefetch-min-insn-to-mem-ratio
9509 The minimum ratio between the number of instructions and the
9510 number of memory references to enable prefetching in a loop.
9512 @item use-canonical-types
9513 Whether the compiler should use the ``canonical'' type system.  By
9514 default, this should always be 1, which uses a more efficient internal
9515 mechanism for comparing types in C++ and Objective-C++.  However, if
9516 bugs in the canonical type system are causing compilation failures,
9517 set this value to 0 to disable canonical types.
9519 @item switch-conversion-max-branch-ratio
9520 Switch initialization conversion refuses to create arrays that are
9521 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9522 branches in the switch.
9524 @item max-partial-antic-length
9525 Maximum length of the partial antic set computed during the tree
9526 partial redundancy elimination optimization (@option{-ftree-pre}) when
9527 optimizing at @option{-O3} and above.  For some sorts of source code
9528 the enhanced partial redundancy elimination optimization can run away,
9529 consuming all of the memory available on the host machine.  This
9530 parameter sets a limit on the length of the sets that are computed,
9531 which prevents the runaway behavior.  Setting a value of 0 for
9532 this parameter allows an unlimited set length.
9534 @item sccvn-max-scc-size
9535 Maximum size of a strongly connected component (SCC) during SCCVN
9536 processing.  If this limit is hit, SCCVN processing for the whole
9537 function is not done and optimizations depending on it are
9538 disabled.  The default maximum SCC size is 10000.
9540 @item sccvn-max-alias-queries-per-access
9541 Maximum number of alias-oracle queries we perform when looking for
9542 redundancies for loads and stores.  If this limit is hit the search
9543 is aborted and the load or store is not considered redundant.  The
9544 number of queries is algorithmically limited to the number of
9545 stores on all paths from the load to the function entry.
9546 The default maxmimum number of queries is 1000.
9548 @item ira-max-loops-num
9549 IRA uses regional register allocation by default.  If a function
9550 contains more loops than the number given by this parameter, only at most
9551 the given number of the most frequently-executed loops form regions
9552 for regional register allocation.  The default value of the
9553 parameter is 100.
9555 @item ira-max-conflict-table-size 
9556 Although IRA uses a sophisticated algorithm to compress the conflict
9557 table, the table can still require excessive amounts of memory for
9558 huge functions.  If the conflict table for a function could be more
9559 than the size in MB given by this parameter, the register allocator
9560 instead uses a faster, simpler, and lower-quality
9561 algorithm that does not require building a pseudo-register conflict table.  
9562 The default value of the parameter is 2000.
9564 @item ira-loop-reserved-regs
9565 IRA can be used to evaluate more accurate register pressure in loops
9566 for decisions to move loop invariants (see @option{-O3}).  The number
9567 of available registers reserved for some other purposes is given
9568 by this parameter.  The default value of the parameter is 2, which is
9569 the minimal number of registers needed by typical instructions.
9570 This value is the best found from numerous experiments.
9572 @item loop-invariant-max-bbs-in-loop
9573 Loop invariant motion can be very expensive, both in compilation time and
9574 in amount of needed compile-time memory, with very large loops.  Loops
9575 with more basic blocks than this parameter won't have loop invariant
9576 motion optimization performed on them.  The default value of the
9577 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9579 @item loop-max-datarefs-for-datadeps
9580 Building data dapendencies is expensive for very large loops.  This
9581 parameter limits the number of data references in loops that are
9582 considered for data dependence analysis.  These large loops are no
9583 handled by the optimizations using loop data dependencies.
9584 The default value is 1000.
9586 @item max-vartrack-size
9587 Sets a maximum number of hash table slots to use during variable
9588 tracking dataflow analysis of any function.  If this limit is exceeded
9589 with variable tracking at assignments enabled, analysis for that
9590 function is retried without it, after removing all debug insns from
9591 the function.  If the limit is exceeded even without debug insns, var
9592 tracking analysis is completely disabled for the function.  Setting
9593 the parameter to zero makes it unlimited.
9595 @item max-vartrack-expr-depth
9596 Sets a maximum number of recursion levels when attempting to map
9597 variable names or debug temporaries to value expressions.  This trades
9598 compilation time for more complete debug information.  If this is set too
9599 low, value expressions that are available and could be represented in
9600 debug information may end up not being used; setting this higher may
9601 enable the compiler to find more complex debug expressions, but compile
9602 time and memory use may grow.  The default is 12.
9604 @item min-nondebug-insn-uid
9605 Use uids starting at this parameter for nondebug insns.  The range below
9606 the parameter is reserved exclusively for debug insns created by
9607 @option{-fvar-tracking-assignments}, but debug insns may get
9608 (non-overlapping) uids above it if the reserved range is exhausted.
9610 @item ipa-sra-ptr-growth-factor
9611 IPA-SRA replaces a pointer to an aggregate with one or more new
9612 parameters only when their cumulative size is less or equal to
9613 @option{ipa-sra-ptr-growth-factor} times the size of the original
9614 pointer parameter.
9616 @item tm-max-aggregate-size
9617 When making copies of thread-local variables in a transaction, this
9618 parameter specifies the size in bytes after which variables are
9619 saved with the logging functions as opposed to save/restore code
9620 sequence pairs.  This option only applies when using
9621 @option{-fgnu-tm}.
9623 @item graphite-max-nb-scop-params
9624 To avoid exponential effects in the Graphite loop transforms, the
9625 number of parameters in a Static Control Part (SCoP) is bounded.  The
9626 default value is 10 parameters.  A variable whose value is unknown at
9627 compilation time and defined outside a SCoP is a parameter of the SCoP.
9629 @item graphite-max-bbs-per-function
9630 To avoid exponential effects in the detection of SCoPs, the size of
9631 the functions analyzed by Graphite is bounded.  The default value is
9632 100 basic blocks.
9634 @item loop-block-tile-size
9635 Loop blocking or strip mining transforms, enabled with
9636 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9637 loop in the loop nest by a given number of iterations.  The strip
9638 length can be changed using the @option{loop-block-tile-size}
9639 parameter.  The default value is 51 iterations.
9641 @item ipa-cp-value-list-size
9642 IPA-CP attempts to track all possible values and types passed to a function's
9643 parameter in order to propagate them and perform devirtualization.
9644 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9645 stores per one formal parameter of a function.
9647 @item lto-partitions
9648 Specify desired number of partitions produced during WHOPR compilation.
9649 The number of partitions should exceed the number of CPUs used for compilation.
9650 The default value is 32.
9652 @item lto-minpartition
9653 Size of minimal partition for WHOPR (in estimated instructions).
9654 This prevents expenses of splitting very small programs into too many
9655 partitions.
9657 @item cxx-max-namespaces-for-diagnostic-help
9658 The maximum number of namespaces to consult for suggestions when C++
9659 name lookup fails for an identifier.  The default is 1000.
9661 @item sink-frequency-threshold
9662 The maximum relative execution frequency (in percents) of the target block
9663 relative to a statement's original block to allow statement sinking of a
9664 statement.  Larger numbers result in more aggressive statement sinking.
9665 The default value is 75.  A small positive adjustment is applied for
9666 statements with memory operands as those are even more profitable so sink.
9668 @item max-stores-to-sink
9669 The maximum number of conditional stores paires that can be sunk.  Set to 0
9670 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9671 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9673 @item allow-load-data-races
9674 Allow optimizers to introduce new data races on loads.
9675 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9676 unless implicitly set by the @option{-fmemory-model=} option.
9678 @item allow-store-data-races
9679 Allow optimizers to introduce new data races on stores.
9680 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9681 unless implicitly set by the @option{-fmemory-model=} option.
9683 @item allow-packed-load-data-races
9684 Allow optimizers to introduce new data races on packed data loads.
9685 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9686 unless implicitly set by the @option{-fmemory-model=} option.
9688 @item allow-packed-store-data-races
9689 Allow optimizers to introduce new data races on packed data stores.
9690 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9691 unless implicitly set by the @option{-fmemory-model=} option.
9693 @item case-values-threshold
9694 The smallest number of different values for which it is best to use a
9695 jump-table instead of a tree of conditional branches.  If the value is
9696 0, use the default for the machine.  The default is 0.
9698 @item tree-reassoc-width
9699 Set the maximum number of instructions executed in parallel in
9700 reassociated tree. This parameter overrides target dependent
9701 heuristics used by default if has non zero value.
9703 @item sched-pressure-algorithm
9704 Choose between the two available implementations of
9705 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9706 and is the more likely to prevent instructions from being reordered.
9707 Algorithm 2 was designed to be a compromise between the relatively
9708 conservative approach taken by algorithm 1 and the rather aggressive
9709 approach taken by the default scheduler.  It relies more heavily on
9710 having a regular register file and accurate register pressure classes.
9711 See @file{haifa-sched.c} in the GCC sources for more details.
9713 The default choice depends on the target.
9715 @item max-slsr-cand-scan
9716 Set the maximum number of existing candidates that will be considered when
9717 seeking a basis for a new straight-line strength reduction candidate.
9719 @end table
9720 @end table
9722 @node Preprocessor Options
9723 @section Options Controlling the Preprocessor
9724 @cindex preprocessor options
9725 @cindex options, preprocessor
9727 These options control the C preprocessor, which is run on each C source
9728 file before actual compilation.
9730 If you use the @option{-E} option, nothing is done except preprocessing.
9731 Some of these options make sense only together with @option{-E} because
9732 they cause the preprocessor output to be unsuitable for actual
9733 compilation.
9735 @table @gcctabopt
9736 @item -Wp,@var{option}
9737 @opindex Wp
9738 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9739 and pass @var{option} directly through to the preprocessor.  If
9740 @var{option} contains commas, it is split into multiple options at the
9741 commas.  However, many options are modified, translated or interpreted
9742 by the compiler driver before being passed to the preprocessor, and
9743 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9744 interface is undocumented and subject to change, so whenever possible
9745 you should avoid using @option{-Wp} and let the driver handle the
9746 options instead.
9748 @item -Xpreprocessor @var{option}
9749 @opindex Xpreprocessor
9750 Pass @var{option} as an option to the preprocessor.  You can use this to
9751 supply system-specific preprocessor options that GCC does not 
9752 recognize.
9754 If you want to pass an option that takes an argument, you must use
9755 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9757 @item -no-integrated-cpp
9758 @opindex no-integrated-cpp
9759 Perform preprocessing as a separate pass before compilation.
9760 By default, GCC performs preprocessing as an integrated part of
9761 input tokenization and parsing.
9762 If this option is provided, the appropriate language front end
9763 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9764 and Objective-C, respectively) is instead invoked twice,
9765 once for preprocessing only and once for actual compilation
9766 of the preprocessed input.
9767 This option may be useful in conjunction with the @option{-B} or
9768 @option{-wrapper} options to specify an alternate preprocessor or
9769 perform additional processing of the program source between
9770 normal preprocessing and compilation.
9771 @end table
9773 @include cppopts.texi
9775 @node Assembler Options
9776 @section Passing Options to the Assembler
9778 @c prevent bad page break with this line
9779 You can pass options to the assembler.
9781 @table @gcctabopt
9782 @item -Wa,@var{option}
9783 @opindex Wa
9784 Pass @var{option} as an option to the assembler.  If @var{option}
9785 contains commas, it is split into multiple options at the commas.
9787 @item -Xassembler @var{option}
9788 @opindex Xassembler
9789 Pass @var{option} as an option to the assembler.  You can use this to
9790 supply system-specific assembler options that GCC does not
9791 recognize.
9793 If you want to pass an option that takes an argument, you must use
9794 @option{-Xassembler} twice, once for the option and once for the argument.
9796 @end table
9798 @node Link Options
9799 @section Options for Linking
9800 @cindex link options
9801 @cindex options, linking
9803 These options come into play when the compiler links object files into
9804 an executable output file.  They are meaningless if the compiler is
9805 not doing a link step.
9807 @table @gcctabopt
9808 @cindex file names
9809 @item @var{object-file-name}
9810 A file name that does not end in a special recognized suffix is
9811 considered to name an object file or library.  (Object files are
9812 distinguished from libraries by the linker according to the file
9813 contents.)  If linking is done, these object files are used as input
9814 to the linker.
9816 @item -c
9817 @itemx -S
9818 @itemx -E
9819 @opindex c
9820 @opindex S
9821 @opindex E
9822 If any of these options is used, then the linker is not run, and
9823 object file names should not be used as arguments.  @xref{Overall
9824 Options}.
9826 @cindex Libraries
9827 @item -l@var{library}
9828 @itemx -l @var{library}
9829 @opindex l
9830 Search the library named @var{library} when linking.  (The second
9831 alternative with the library as a separate argument is only for
9832 POSIX compliance and is not recommended.)
9834 It makes a difference where in the command you write this option; the
9835 linker searches and processes libraries and object files in the order they
9836 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9837 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9838 to functions in @samp{z}, those functions may not be loaded.
9840 The linker searches a standard list of directories for the library,
9841 which is actually a file named @file{lib@var{library}.a}.  The linker
9842 then uses this file as if it had been specified precisely by name.
9844 The directories searched include several standard system directories
9845 plus any that you specify with @option{-L}.
9847 Normally the files found this way are library files---archive files
9848 whose members are object files.  The linker handles an archive file by
9849 scanning through it for members which define symbols that have so far
9850 been referenced but not defined.  But if the file that is found is an
9851 ordinary object file, it is linked in the usual fashion.  The only
9852 difference between using an @option{-l} option and specifying a file name
9853 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9854 and searches several directories.
9856 @item -lobjc
9857 @opindex lobjc
9858 You need this special case of the @option{-l} option in order to
9859 link an Objective-C or Objective-C++ program.
9861 @item -nostartfiles
9862 @opindex nostartfiles
9863 Do not use the standard system startup files when linking.
9864 The standard system libraries are used normally, unless @option{-nostdlib}
9865 or @option{-nodefaultlibs} is used.
9867 @item -nodefaultlibs
9868 @opindex nodefaultlibs
9869 Do not use the standard system libraries when linking.
9870 Only the libraries you specify are passed to the linker, and options
9871 specifying linkage of the system libraries, such as @code{-static-libgcc}
9872 or @code{-shared-libgcc}, are ignored.  
9873 The standard startup files are used normally, unless @option{-nostartfiles}
9874 is used.  
9876 The compiler may generate calls to @code{memcmp},
9877 @code{memset}, @code{memcpy} and @code{memmove}.
9878 These entries are usually resolved by entries in
9879 libc.  These entry points should be supplied through some other
9880 mechanism when this option is specified.
9882 @item -nostdlib
9883 @opindex nostdlib
9884 Do not use the standard system startup files or libraries when linking.
9885 No startup files and only the libraries you specify are passed to
9886 the linker, and options specifying linkage of the system libraries, such as
9887 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9889 The compiler may generate calls to @code{memcmp}, @code{memset},
9890 @code{memcpy} and @code{memmove}.
9891 These entries are usually resolved by entries in
9892 libc.  These entry points should be supplied through some other
9893 mechanism when this option is specified.
9895 @cindex @option{-lgcc}, use with @option{-nostdlib}
9896 @cindex @option{-nostdlib} and unresolved references
9897 @cindex unresolved references and @option{-nostdlib}
9898 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9899 @cindex @option{-nodefaultlibs} and unresolved references
9900 @cindex unresolved references and @option{-nodefaultlibs}
9901 One of the standard libraries bypassed by @option{-nostdlib} and
9902 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9903 which GCC uses to overcome shortcomings of particular machines, or special
9904 needs for some languages.
9905 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9906 Collection (GCC) Internals},
9907 for more discussion of @file{libgcc.a}.)
9908 In most cases, you need @file{libgcc.a} even when you want to avoid
9909 other standard libraries.  In other words, when you specify @option{-nostdlib}
9910 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9911 This ensures that you have no unresolved references to internal GCC
9912 library subroutines.
9913 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9914 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9915 GNU Compiler Collection (GCC) Internals}.)
9917 @item -pie
9918 @opindex pie
9919 Produce a position independent executable on targets that support it.
9920 For predictable results, you must also specify the same set of options
9921 used for compilation (@option{-fpie}, @option{-fPIE},
9922 or model suboptions) when you specify this linker option.
9924 @item -rdynamic
9925 @opindex rdynamic
9926 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9927 that support it. This instructs the linker to add all symbols, not
9928 only used ones, to the dynamic symbol table. This option is needed
9929 for some uses of @code{dlopen} or to allow obtaining backtraces
9930 from within a program.
9932 @item -s
9933 @opindex s
9934 Remove all symbol table and relocation information from the executable.
9936 @item -static
9937 @opindex static
9938 On systems that support dynamic linking, this prevents linking with the shared
9939 libraries.  On other systems, this option has no effect.
9941 @item -shared
9942 @opindex shared
9943 Produce a shared object which can then be linked with other objects to
9944 form an executable.  Not all systems support this option.  For predictable
9945 results, you must also specify the same set of options used for compilation
9946 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9947 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9948 needs to build supplementary stub code for constructors to work.  On
9949 multi-libbed systems, @samp{gcc -shared} must select the correct support
9950 libraries to link against.  Failing to supply the correct flags may lead
9951 to subtle defects.  Supplying them in cases where they are not necessary
9952 is innocuous.}
9954 @item -shared-libgcc
9955 @itemx -static-libgcc
9956 @opindex shared-libgcc
9957 @opindex static-libgcc
9958 On systems that provide @file{libgcc} as a shared library, these options
9959 force the use of either the shared or static version, respectively.
9960 If no shared version of @file{libgcc} was built when the compiler was
9961 configured, these options have no effect.
9963 There are several situations in which an application should use the
9964 shared @file{libgcc} instead of the static version.  The most common
9965 of these is when the application wishes to throw and catch exceptions
9966 across different shared libraries.  In that case, each of the libraries
9967 as well as the application itself should use the shared @file{libgcc}.
9969 Therefore, the G++ and GCJ drivers automatically add
9970 @option{-shared-libgcc} whenever you build a shared library or a main
9971 executable, because C++ and Java programs typically use exceptions, so
9972 this is the right thing to do.
9974 If, instead, you use the GCC driver to create shared libraries, you may
9975 find that they are not always linked with the shared @file{libgcc}.
9976 If GCC finds, at its configuration time, that you have a non-GNU linker
9977 or a GNU linker that does not support option @option{--eh-frame-hdr},
9978 it links the shared version of @file{libgcc} into shared libraries
9979 by default.  Otherwise, it takes advantage of the linker and optimizes
9980 away the linking with the shared version of @file{libgcc}, linking with
9981 the static version of libgcc by default.  This allows exceptions to
9982 propagate through such shared libraries, without incurring relocation
9983 costs at library load time.
9985 However, if a library or main executable is supposed to throw or catch
9986 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9987 for the languages used in the program, or using the option
9988 @option{-shared-libgcc}, such that it is linked with the shared
9989 @file{libgcc}.
9991 @item -static-libasan
9992 When the @option{-fsanitize=address} option is used to link a program,
9993 the GCC driver automatically links against @option{libasan}.  If
9994 @file{libasan} is available as a shared library, and the @option{-static}
9995 option is not used, then this links against the shared version of
9996 @file{libasan}.  The @option{-static-libasan} option directs the GCC
9997 driver to link @file{libasan} statically, without necessarily linking
9998 other libraries statically.
10000 @item -static-libtsan
10001 When the @option{-fsanitize=thread} option is used to link a program,
10002 the GCC driver automatically links against @option{libtsan}.  If
10003 @file{libtsan} is available as a shared library, and the @option{-static}
10004 option is not used, then this links against the shared version of
10005 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10006 driver to link @file{libtsan} statically, without necessarily linking
10007 other libraries statically.
10009 @item -static-libstdc++
10010 When the @command{g++} program is used to link a C++ program, it
10011 normally automatically links against @option{libstdc++}.  If
10012 @file{libstdc++} is available as a shared library, and the
10013 @option{-static} option is not used, then this links against the
10014 shared version of @file{libstdc++}.  That is normally fine.  However, it
10015 is sometimes useful to freeze the version of @file{libstdc++} used by
10016 the program without going all the way to a fully static link.  The
10017 @option{-static-libstdc++} option directs the @command{g++} driver to
10018 link @file{libstdc++} statically, without necessarily linking other
10019 libraries statically.
10021 @item -symbolic
10022 @opindex symbolic
10023 Bind references to global symbols when building a shared object.  Warn
10024 about any unresolved references (unless overridden by the link editor
10025 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10026 this option.
10028 @item -T @var{script}
10029 @opindex T
10030 @cindex linker script
10031 Use @var{script} as the linker script.  This option is supported by most
10032 systems using the GNU linker.  On some targets, such as bare-board
10033 targets without an operating system, the @option{-T} option may be required
10034 when linking to avoid references to undefined symbols.
10036 @item -Xlinker @var{option}
10037 @opindex Xlinker
10038 Pass @var{option} as an option to the linker.  You can use this to
10039 supply system-specific linker options that GCC does not recognize.
10041 If you want to pass an option that takes a separate argument, you must use
10042 @option{-Xlinker} twice, once for the option and once for the argument.
10043 For example, to pass @option{-assert definitions}, you must write
10044 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10045 @option{-Xlinker "-assert definitions"}, because this passes the entire
10046 string as a single argument, which is not what the linker expects.
10048 When using the GNU linker, it is usually more convenient to pass
10049 arguments to linker options using the @option{@var{option}=@var{value}}
10050 syntax than as separate arguments.  For example, you can specify
10051 @option{-Xlinker -Map=output.map} rather than
10052 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10053 this syntax for command-line options.
10055 @item -Wl,@var{option}
10056 @opindex Wl
10057 Pass @var{option} as an option to the linker.  If @var{option} contains
10058 commas, it is split into multiple options at the commas.  You can use this
10059 syntax to pass an argument to the option.
10060 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10061 linker.  When using the GNU linker, you can also get the same effect with
10062 @option{-Wl,-Map=output.map}.
10064 @item -u @var{symbol}
10065 @opindex u
10066 Pretend the symbol @var{symbol} is undefined, to force linking of
10067 library modules to define it.  You can use @option{-u} multiple times with
10068 different symbols to force loading of additional library modules.
10069 @end table
10071 @node Directory Options
10072 @section Options for Directory Search
10073 @cindex directory options
10074 @cindex options, directory search
10075 @cindex search path
10077 These options specify directories to search for header files, for
10078 libraries and for parts of the compiler:
10080 @table @gcctabopt
10081 @item -I@var{dir}
10082 @opindex I
10083 Add the directory @var{dir} to the head of the list of directories to be
10084 searched for header files.  This can be used to override a system header
10085 file, substituting your own version, since these directories are
10086 searched before the system header file directories.  However, you should
10087 not use this option to add directories that contain vendor-supplied
10088 system header files (use @option{-isystem} for that).  If you use more than
10089 one @option{-I} option, the directories are scanned in left-to-right
10090 order; the standard system directories come after.
10092 If a standard system include directory, or a directory specified with
10093 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10094 option is ignored.  The directory is still searched but as a
10095 system directory at its normal position in the system include chain.
10096 This is to ensure that GCC's procedure to fix buggy system headers and
10097 the ordering for the @code{include_next} directive are not inadvertently changed.
10098 If you really need to change the search order for system directories,
10099 use the @option{-nostdinc} and/or @option{-isystem} options.
10101 @item -iplugindir=@var{dir}
10102 Set the directory to search for plugins that are passed
10103 by @option{-fplugin=@var{name}} instead of
10104 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10105 to be used by the user, but only passed by the driver.
10107 @item -iquote@var{dir}
10108 @opindex iquote
10109 Add the directory @var{dir} to the head of the list of directories to
10110 be searched for header files only for the case of @samp{#include
10111 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10112 otherwise just like @option{-I}.
10114 @item -L@var{dir}
10115 @opindex L
10116 Add directory @var{dir} to the list of directories to be searched
10117 for @option{-l}.
10119 @item -B@var{prefix}
10120 @opindex B
10121 This option specifies where to find the executables, libraries,
10122 include files, and data files of the compiler itself.
10124 The compiler driver program runs one or more of the subprograms
10125 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10126 @var{prefix} as a prefix for each program it tries to run, both with and
10127 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10129 For each subprogram to be run, the compiler driver first tries the
10130 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10131 is not specified, the driver tries two standard prefixes, 
10132 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10133 those results in a file name that is found, the unmodified program
10134 name is searched for using the directories specified in your
10135 @env{PATH} environment variable.
10137 The compiler checks to see if the path provided by the @option{-B}
10138 refers to a directory, and if necessary it adds a directory
10139 separator character at the end of the path.
10141 @option{-B} prefixes that effectively specify directory names also apply
10142 to libraries in the linker, because the compiler translates these
10143 options into @option{-L} options for the linker.  They also apply to
10144 includes files in the preprocessor, because the compiler translates these
10145 options into @option{-isystem} options for the preprocessor.  In this case,
10146 the compiler appends @samp{include} to the prefix.
10148 The runtime support file @file{libgcc.a} can also be searched for using
10149 the @option{-B} prefix, if needed.  If it is not found there, the two
10150 standard prefixes above are tried, and that is all.  The file is left
10151 out of the link if it is not found by those means.
10153 Another way to specify a prefix much like the @option{-B} prefix is to use
10154 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10155 Variables}.
10157 As a special kludge, if the path provided by @option{-B} is
10158 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10159 9, then it is replaced by @file{[dir/]include}.  This is to help
10160 with boot-strapping the compiler.
10162 @item -specs=@var{file}
10163 @opindex specs
10164 Process @var{file} after the compiler reads in the standard @file{specs}
10165 file, in order to override the defaults which the @command{gcc} driver
10166 program uses when determining what switches to pass to @command{cc1},
10167 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10168 @option{-specs=@var{file}} can be specified on the command line, and they
10169 are processed in order, from left to right.
10171 @item --sysroot=@var{dir}
10172 @opindex sysroot
10173 Use @var{dir} as the logical root directory for headers and libraries.
10174 For example, if the compiler normally searches for headers in
10175 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10176 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10178 If you use both this option and the @option{-isysroot} option, then
10179 the @option{--sysroot} option applies to libraries, but the
10180 @option{-isysroot} option applies to header files.
10182 The GNU linker (beginning with version 2.16) has the necessary support
10183 for this option.  If your linker does not support this option, the
10184 header file aspect of @option{--sysroot} still works, but the
10185 library aspect does not.
10187 @item --no-sysroot-suffix
10188 @opindex no-sysroot-suffix
10189 For some targets, a suffix is added to the root directory specified
10190 with @option{--sysroot}, depending on the other options used, so that
10191 headers may for example be found in
10192 @file{@var{dir}/@var{suffix}/usr/include} instead of
10193 @file{@var{dir}/usr/include}.  This option disables the addition of
10194 such a suffix.
10196 @item -I-
10197 @opindex I-
10198 This option has been deprecated.  Please use @option{-iquote} instead for
10199 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10200 Any directories you specify with @option{-I} options before the @option{-I-}
10201 option are searched only for the case of @samp{#include "@var{file}"};
10202 they are not searched for @samp{#include <@var{file}>}.
10204 If additional directories are specified with @option{-I} options after
10205 the @option{-I-}, these directories are searched for all @samp{#include}
10206 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10207 this way.)
10209 In addition, the @option{-I-} option inhibits the use of the current
10210 directory (where the current input file came from) as the first search
10211 directory for @samp{#include "@var{file}"}.  There is no way to
10212 override this effect of @option{-I-}.  With @option{-I.} you can specify
10213 searching the directory that is current when the compiler is
10214 invoked.  That is not exactly the same as what the preprocessor does
10215 by default, but it is often satisfactory.
10217 @option{-I-} does not inhibit the use of the standard system directories
10218 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10219 independent.
10220 @end table
10222 @c man end
10224 @node Spec Files
10225 @section Specifying subprocesses and the switches to pass to them
10226 @cindex Spec Files
10228 @command{gcc} is a driver program.  It performs its job by invoking a
10229 sequence of other programs to do the work of compiling, assembling and
10230 linking.  GCC interprets its command-line parameters and uses these to
10231 deduce which programs it should invoke, and which command-line options
10232 it ought to place on their command lines.  This behavior is controlled
10233 by @dfn{spec strings}.  In most cases there is one spec string for each
10234 program that GCC can invoke, but a few programs have multiple spec
10235 strings to control their behavior.  The spec strings built into GCC can
10236 be overridden by using the @option{-specs=} command-line switch to specify
10237 a spec file.
10239 @dfn{Spec files} are plaintext files that are used to construct spec
10240 strings.  They consist of a sequence of directives separated by blank
10241 lines.  The type of directive is determined by the first non-whitespace
10242 character on the line, which can be one of the following:
10244 @table @code
10245 @item %@var{command}
10246 Issues a @var{command} to the spec file processor.  The commands that can
10247 appear here are:
10249 @table @code
10250 @item %include <@var{file}>
10251 @cindex @code{%include}
10252 Search for @var{file} and insert its text at the current point in the
10253 specs file.
10255 @item %include_noerr <@var{file}>
10256 @cindex @code{%include_noerr}
10257 Just like @samp{%include}, but do not generate an error message if the include
10258 file cannot be found.
10260 @item %rename @var{old_name} @var{new_name}
10261 @cindex @code{%rename}
10262 Rename the spec string @var{old_name} to @var{new_name}.
10264 @end table
10266 @item *[@var{spec_name}]:
10267 This tells the compiler to create, override or delete the named spec
10268 string.  All lines after this directive up to the next directive or
10269 blank line are considered to be the text for the spec string.  If this
10270 results in an empty string then the spec is deleted.  (Or, if the
10271 spec did not exist, then nothing happens.)  Otherwise, if the spec
10272 does not currently exist a new spec is created.  If the spec does
10273 exist then its contents are overridden by the text of this
10274 directive, unless the first character of that text is the @samp{+}
10275 character, in which case the text is appended to the spec.
10277 @item [@var{suffix}]:
10278 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10279 and up to the next directive or blank line are considered to make up the
10280 spec string for the indicated suffix.  When the compiler encounters an
10281 input file with the named suffix, it processes the spec string in
10282 order to work out how to compile that file.  For example:
10284 @smallexample
10285 .ZZ:
10286 z-compile -input %i
10287 @end smallexample
10289 This says that any input file whose name ends in @samp{.ZZ} should be
10290 passed to the program @samp{z-compile}, which should be invoked with the
10291 command-line switch @option{-input} and with the result of performing the
10292 @samp{%i} substitution.  (See below.)
10294 As an alternative to providing a spec string, the text following a
10295 suffix directive can be one of the following:
10297 @table @code
10298 @item @@@var{language}
10299 This says that the suffix is an alias for a known @var{language}.  This is
10300 similar to using the @option{-x} command-line switch to GCC to specify a
10301 language explicitly.  For example:
10303 @smallexample
10304 .ZZ:
10305 @@c++
10306 @end smallexample
10308 Says that .ZZ files are, in fact, C++ source files.
10310 @item #@var{name}
10311 This causes an error messages saying:
10313 @smallexample
10314 @var{name} compiler not installed on this system.
10315 @end smallexample
10316 @end table
10318 GCC already has an extensive list of suffixes built into it.
10319 This directive adds an entry to the end of the list of suffixes, but
10320 since the list is searched from the end backwards, it is effectively
10321 possible to override earlier entries using this technique.
10323 @end table
10325 GCC has the following spec strings built into it.  Spec files can
10326 override these strings or create their own.  Note that individual
10327 targets can also add their own spec strings to this list.
10329 @smallexample
10330 asm          Options to pass to the assembler
10331 asm_final    Options to pass to the assembler post-processor
10332 cpp          Options to pass to the C preprocessor
10333 cc1          Options to pass to the C compiler
10334 cc1plus      Options to pass to the C++ compiler
10335 endfile      Object files to include at the end of the link
10336 link         Options to pass to the linker
10337 lib          Libraries to include on the command line to the linker
10338 libgcc       Decides which GCC support library to pass to the linker
10339 linker       Sets the name of the linker
10340 predefines   Defines to be passed to the C preprocessor
10341 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10342              by default
10343 startfile    Object files to include at the start of the link
10344 @end smallexample
10346 Here is a small example of a spec file:
10348 @smallexample
10349 %rename lib                 old_lib
10351 *lib:
10352 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10353 @end smallexample
10355 This example renames the spec called @samp{lib} to @samp{old_lib} and
10356 then overrides the previous definition of @samp{lib} with a new one.
10357 The new definition adds in some extra command-line options before
10358 including the text of the old definition.
10360 @dfn{Spec strings} are a list of command-line options to be passed to their
10361 corresponding program.  In addition, the spec strings can contain
10362 @samp{%}-prefixed sequences to substitute variable text or to
10363 conditionally insert text into the command line.  Using these constructs
10364 it is possible to generate quite complex command lines.
10366 Here is a table of all defined @samp{%}-sequences for spec
10367 strings.  Note that spaces are not generated automatically around the
10368 results of expanding these sequences.  Therefore you can concatenate them
10369 together or combine them with constant text in a single argument.
10371 @table @code
10372 @item %%
10373 Substitute one @samp{%} into the program name or argument.
10375 @item %i
10376 Substitute the name of the input file being processed.
10378 @item %b
10379 Substitute the basename of the input file being processed.
10380 This is the substring up to (and not including) the last period
10381 and not including the directory.
10383 @item %B
10384 This is the same as @samp{%b}, but include the file suffix (text after
10385 the last period).
10387 @item %d
10388 Marks the argument containing or following the @samp{%d} as a
10389 temporary file name, so that that file is deleted if GCC exits
10390 successfully.  Unlike @samp{%g}, this contributes no text to the
10391 argument.
10393 @item %g@var{suffix}
10394 Substitute a file name that has suffix @var{suffix} and is chosen
10395 once per compilation, and mark the argument in the same way as
10396 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10397 name is now chosen in a way that is hard to predict even when previously
10398 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10399 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10400 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10401 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10402 was simply substituted with a file name chosen once per compilation,
10403 without regard to any appended suffix (which was therefore treated
10404 just like ordinary text), making such attacks more likely to succeed.
10406 @item %u@var{suffix}
10407 Like @samp{%g}, but generates a new temporary file name
10408 each time it appears instead of once per compilation.
10410 @item %U@var{suffix}
10411 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10412 new one if there is no such last file name.  In the absence of any
10413 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10414 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10415 involves the generation of two distinct file names, one
10416 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10417 simply substituted with a file name chosen for the previous @samp{%u},
10418 without regard to any appended suffix.
10420 @item %j@var{suffix}
10421 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10422 writable, and if @option{-save-temps} is not used; 
10423 otherwise, substitute the name
10424 of a temporary file, just like @samp{%u}.  This temporary file is not
10425 meant for communication between processes, but rather as a junk
10426 disposal mechanism.
10428 @item %|@var{suffix}
10429 @itemx %m@var{suffix}
10430 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10431 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10432 all.  These are the two most common ways to instruct a program that it
10433 should read from standard input or write to standard output.  If you
10434 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10435 construct: see for example @file{f/lang-specs.h}.
10437 @item %.@var{SUFFIX}
10438 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10439 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10440 terminated by the next space or %.
10442 @item %w
10443 Marks the argument containing or following the @samp{%w} as the
10444 designated output file of this compilation.  This puts the argument
10445 into the sequence of arguments that @samp{%o} substitutes.
10447 @item %o
10448 Substitutes the names of all the output files, with spaces
10449 automatically placed around them.  You should write spaces
10450 around the @samp{%o} as well or the results are undefined.
10451 @samp{%o} is for use in the specs for running the linker.
10452 Input files whose names have no recognized suffix are not compiled
10453 at all, but they are included among the output files, so they are
10454 linked.
10456 @item %O
10457 Substitutes the suffix for object files.  Note that this is
10458 handled specially when it immediately follows @samp{%g, %u, or %U},
10459 because of the need for those to form complete file names.  The
10460 handling is such that @samp{%O} is treated exactly as if it had already
10461 been substituted, except that @samp{%g, %u, and %U} do not currently
10462 support additional @var{suffix} characters following @samp{%O} as they do
10463 following, for example, @samp{.o}.
10465 @item %p
10466 Substitutes the standard macro predefinitions for the
10467 current target machine.  Use this when running @code{cpp}.
10469 @item %P
10470 Like @samp{%p}, but puts @samp{__} before and after the name of each
10471 predefined macro, except for macros that start with @samp{__} or with
10472 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10475 @item %I
10476 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10477 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10478 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10479 and @option{-imultilib} as necessary.
10481 @item %s
10482 Current argument is the name of a library or startup file of some sort.
10483 Search for that file in a standard list of directories and substitute
10484 the full name found.  The current working directory is included in the
10485 list of directories scanned.
10487 @item %T
10488 Current argument is the name of a linker script.  Search for that file
10489 in the current list of directories to scan for libraries. If the file
10490 is located insert a @option{--script} option into the command line
10491 followed by the full path name found.  If the file is not found then
10492 generate an error message.  Note: the current working directory is not
10493 searched.
10495 @item %e@var{str}
10496 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10497 Use this when inconsistent options are detected.
10499 @item %(@var{name})
10500 Substitute the contents of spec string @var{name} at this point.
10502 @item %x@{@var{option}@}
10503 Accumulate an option for @samp{%X}.
10505 @item %X
10506 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10507 spec string.
10509 @item %Y
10510 Output the accumulated assembler options specified by @option{-Wa}.
10512 @item %Z
10513 Output the accumulated preprocessor options specified by @option{-Wp}.
10515 @item %a
10516 Process the @code{asm} spec.  This is used to compute the
10517 switches to be passed to the assembler.
10519 @item %A
10520 Process the @code{asm_final} spec.  This is a spec string for
10521 passing switches to an assembler post-processor, if such a program is
10522 needed.
10524 @item %l
10525 Process the @code{link} spec.  This is the spec for computing the
10526 command line passed to the linker.  Typically it makes use of the
10527 @samp{%L %G %S %D and %E} sequences.
10529 @item %D
10530 Dump out a @option{-L} option for each directory that GCC believes might
10531 contain startup files.  If the target supports multilibs then the
10532 current multilib directory is prepended to each of these paths.
10534 @item %L
10535 Process the @code{lib} spec.  This is a spec string for deciding which
10536 libraries are included on the command line to the linker.
10538 @item %G
10539 Process the @code{libgcc} spec.  This is a spec string for deciding
10540 which GCC support library is included on the command line to the linker.
10542 @item %S
10543 Process the @code{startfile} spec.  This is a spec for deciding which
10544 object files are the first ones passed to the linker.  Typically
10545 this might be a file named @file{crt0.o}.
10547 @item %E
10548 Process the @code{endfile} spec.  This is a spec string that specifies
10549 the last object files that are passed to the linker.
10551 @item %C
10552 Process the @code{cpp} spec.  This is used to construct the arguments
10553 to be passed to the C preprocessor.
10555 @item %1
10556 Process the @code{cc1} spec.  This is used to construct the options to be
10557 passed to the actual C compiler (@samp{cc1}).
10559 @item %2
10560 Process the @code{cc1plus} spec.  This is used to construct the options to be
10561 passed to the actual C++ compiler (@samp{cc1plus}).
10563 @item %*
10564 Substitute the variable part of a matched option.  See below.
10565 Note that each comma in the substituted string is replaced by
10566 a single space.
10568 @item %<@code{S}
10569 Remove all occurrences of @code{-S} from the command line.  Note---this
10570 command is position dependent.  @samp{%} commands in the spec string
10571 before this one see @code{-S}, @samp{%} commands in the spec string
10572 after this one do not.
10574 @item %:@var{function}(@var{args})
10575 Call the named function @var{function}, passing it @var{args}.
10576 @var{args} is first processed as a nested spec string, then split
10577 into an argument vector in the usual fashion.  The function returns
10578 a string which is processed as if it had appeared literally as part
10579 of the current spec.
10581 The following built-in spec functions are provided:
10583 @table @code
10584 @item @code{getenv}
10585 The @code{getenv} spec function takes two arguments: an environment
10586 variable name and a string.  If the environment variable is not
10587 defined, a fatal error is issued.  Otherwise, the return value is the
10588 value of the environment variable concatenated with the string.  For
10589 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10591 @smallexample
10592 %:getenv(TOPDIR /include)
10593 @end smallexample
10595 expands to @file{/path/to/top/include}.
10597 @item @code{if-exists}
10598 The @code{if-exists} spec function takes one argument, an absolute
10599 pathname to a file.  If the file exists, @code{if-exists} returns the
10600 pathname.  Here is a small example of its usage:
10602 @smallexample
10603 *startfile:
10604 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10605 @end smallexample
10607 @item @code{if-exists-else}
10608 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10609 spec function, except that it takes two arguments.  The first argument is
10610 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10611 returns the pathname.  If it does not exist, it returns the second argument.
10612 This way, @code{if-exists-else} can be used to select one file or another,
10613 based on the existence of the first.  Here is a small example of its usage:
10615 @smallexample
10616 *startfile:
10617 crt0%O%s %:if-exists(crti%O%s) \
10618 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10619 @end smallexample
10621 @item @code{replace-outfile}
10622 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10623 first argument in the outfiles array and replaces it with the second argument.  Here
10624 is a small example of its usage:
10626 @smallexample
10627 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10628 @end smallexample
10630 @item @code{remove-outfile}
10631 The @code{remove-outfile} spec function takes one argument.  It looks for the
10632 first argument in the outfiles array and removes it.  Here is a small example
10633 its usage:
10635 @smallexample
10636 %:remove-outfile(-lm)
10637 @end smallexample
10639 @item @code{pass-through-libs}
10640 The @code{pass-through-libs} spec function takes any number of arguments.  It
10641 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10642 assumes are the names of linker input library archive files) and returns a
10643 result containing all the found arguments each prepended by
10644 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10645 intended to be passed to the LTO linker plugin.
10647 @smallexample
10648 %:pass-through-libs(%G %L %G)
10649 @end smallexample
10651 @item @code{print-asm-header}
10652 The @code{print-asm-header} function takes no arguments and simply
10653 prints a banner like:
10655 @smallexample
10656 Assembler options
10657 =================
10659 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10660 @end smallexample
10662 It is used to separate compiler options from assembler options
10663 in the @option{--target-help} output.
10664 @end table
10666 @item %@{@code{S}@}
10667 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10668 If that switch is not specified, this substitutes nothing.  Note that
10669 the leading dash is omitted when specifying this option, and it is
10670 automatically inserted if the substitution is performed.  Thus the spec
10671 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10672 and outputs the command-line option @option{-foo}.
10674 @item %W@{@code{S}@}
10675 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10676 deleted on failure.
10678 @item %@{@code{S}*@}
10679 Substitutes all the switches specified to GCC whose names start
10680 with @code{-S}, but which also take an argument.  This is used for
10681 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10682 GCC considers @option{-o foo} as being
10683 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10684 text, including the space.  Thus two arguments are generated.
10686 @item %@{@code{S}*&@code{T}*@}
10687 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10688 (the order of @code{S} and @code{T} in the spec is not significant).
10689 There can be any number of ampersand-separated variables; for each the
10690 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10692 @item %@{@code{S}:@code{X}@}
10693 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10695 @item %@{!@code{S}:@code{X}@}
10696 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10698 @item %@{@code{S}*:@code{X}@}
10699 Substitutes @code{X} if one or more switches whose names start with
10700 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10701 once, no matter how many such switches appeared.  However, if @code{%*}
10702 appears somewhere in @code{X}, then @code{X} is substituted once
10703 for each matching switch, with the @code{%*} replaced by the part of
10704 that switch matching the @code{*}.
10706 @item %@{.@code{S}:@code{X}@}
10707 Substitutes @code{X}, if processing a file with suffix @code{S}.
10709 @item %@{!.@code{S}:@code{X}@}
10710 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10712 @item %@{,@code{S}:@code{X}@}
10713 Substitutes @code{X}, if processing a file for language @code{S}.
10715 @item %@{!,@code{S}:@code{X}@}
10716 Substitutes @code{X}, if not processing a file for language @code{S}.
10718 @item %@{@code{S}|@code{P}:@code{X}@}
10719 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10720 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10721 @code{*} sequences as well, although they have a stronger binding than
10722 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10723 alternatives must be starred, and only the first matching alternative
10724 is substituted.
10726 For example, a spec string like this:
10728 @smallexample
10729 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10730 @end smallexample
10732 @noindent
10733 outputs the following command-line options from the following input
10734 command-line options:
10736 @smallexample
10737 fred.c        -foo -baz
10738 jim.d         -bar -boggle
10739 -d fred.c     -foo -baz -boggle
10740 -d jim.d      -bar -baz -boggle
10741 @end smallexample
10743 @item %@{S:X; T:Y; :D@}
10745 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10746 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10747 be as many clauses as you need.  This may be combined with @code{.},
10748 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10751 @end table
10753 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10754 construct may contain other nested @samp{%} constructs or spaces, or
10755 even newlines.  They are processed as usual, as described above.
10756 Trailing white space in @code{X} is ignored.  White space may also
10757 appear anywhere on the left side of the colon in these constructs,
10758 except between @code{.} or @code{*} and the corresponding word.
10760 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10761 handled specifically in these constructs.  If another value of
10762 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10763 @option{-W} switch is found later in the command line, the earlier
10764 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10765 just one letter, which passes all matching options.
10767 The character @samp{|} at the beginning of the predicate text is used to
10768 indicate that a command should be piped to the following command, but
10769 only if @option{-pipe} is specified.
10771 It is built into GCC which switches take arguments and which do not.
10772 (You might think it would be useful to generalize this to allow each
10773 compiler's spec to say which switches take arguments.  But this cannot
10774 be done in a consistent fashion.  GCC cannot even decide which input
10775 files have been specified without knowing which switches take arguments,
10776 and it must know which input files to compile in order to tell which
10777 compilers to run).
10779 GCC also knows implicitly that arguments starting in @option{-l} are to be
10780 treated as compiler output files, and passed to the linker in their
10781 proper position among the other output files.
10783 @c man begin OPTIONS
10785 @node Target Options
10786 @section Specifying Target Machine and Compiler Version
10787 @cindex target options
10788 @cindex cross compiling
10789 @cindex specifying machine version
10790 @cindex specifying compiler version and target machine
10791 @cindex compiler version, specifying
10792 @cindex target machine, specifying
10794 The usual way to run GCC is to run the executable called @command{gcc}, or
10795 @command{@var{machine}-gcc} when cross-compiling, or
10796 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10797 one that was installed last.
10799 @node Submodel Options
10800 @section Hardware Models and Configurations
10801 @cindex submodel options
10802 @cindex specifying hardware config
10803 @cindex hardware models and configurations, specifying
10804 @cindex machine dependent options
10806 Each target machine types can have its own
10807 special options, starting with @samp{-m}, to choose among various
10808 hardware models or configurations---for example, 68010 vs 68020,
10809 floating coprocessor or none.  A single installed version of the
10810 compiler can compile for any model or configuration, according to the
10811 options specified.
10813 Some configurations of the compiler also support additional special
10814 options, usually for compatibility with other compilers on the same
10815 platform.
10817 @c This list is ordered alphanumerically by subsection name.
10818 @c It should be the same order and spelling as these options are listed
10819 @c in Machine Dependent Options
10821 @menu
10822 * AArch64 Options::
10823 * Adapteva Epiphany Options::
10824 * ARM Options::
10825 * AVR Options::
10826 * Blackfin Options::
10827 * C6X Options::
10828 * CRIS Options::
10829 * CR16 Options::
10830 * Darwin Options::
10831 * DEC Alpha Options::
10832 * FR30 Options::
10833 * FRV Options::
10834 * GNU/Linux Options::
10835 * H8/300 Options::
10836 * HPPA Options::
10837 * i386 and x86-64 Options::
10838 * i386 and x86-64 Windows Options::
10839 * IA-64 Options::
10840 * LM32 Options::
10841 * M32C Options::
10842 * M32R/D Options::
10843 * M680x0 Options::
10844 * MCore Options::
10845 * MeP Options::
10846 * MicroBlaze Options::
10847 * MIPS Options::
10848 * MMIX Options::
10849 * MN10300 Options::
10850 * Moxie Options::
10851 * PDP-11 Options::
10852 * picoChip Options::
10853 * PowerPC Options::
10854 * RL78 Options::
10855 * RS/6000 and PowerPC Options::
10856 * RX Options::
10857 * S/390 and zSeries Options::
10858 * Score Options::
10859 * SH Options::
10860 * Solaris 2 Options::
10861 * SPARC Options::
10862 * SPU Options::
10863 * System V Options::
10864 * TILE-Gx Options::
10865 * TILEPro Options::
10866 * V850 Options::
10867 * VAX Options::
10868 * VMS Options::
10869 * VxWorks Options::
10870 * x86-64 Options::
10871 * Xstormy16 Options::
10872 * Xtensa Options::
10873 * zSeries Options::
10874 @end menu
10876 @node AArch64 Options
10877 @subsection AArch64 Options
10878 @cindex AArch64 Options
10880 These options are defined for AArch64 implementations:
10882 @table @gcctabopt
10884 @item -mbig-endian
10885 @opindex mbig-endian
10886 Generate big-endian code.  This is the default when GCC is configured for an
10887 @samp{aarch64_be-*-*} target.
10889 @item -mgeneral-regs-only
10890 @opindex mgeneral-regs-only
10891 Generate code which uses only the general registers.
10893 @item -mlittle-endian
10894 @opindex mlittle-endian
10895 Generate little-endian code.  This is the default when GCC is configured for an
10896 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
10898 @item -mcmodel=tiny
10899 @opindex mcmodel=tiny
10900 Generate code for the tiny code model.  The program and its statically defined
10901 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
10902 be statically or dynamically linked.  This model is not fully implemented and
10903 mostly treated as @samp{small}.
10905 @item -mcmodel=small
10906 @opindex mcmodel=small
10907 Generate code for the small code model.  The program and its statically defined
10908 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
10909 be statically or dynamically linked.  This is the default code model.
10911 @item -mcmodel=large
10912 @opindex mcmodel=large
10913 Generate code for the large code model.  This makes no assumptions about
10914 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
10915 statically linked only.
10917 @item -mstrict-align
10918 @opindex mstrict-align
10919 Do not assume that unaligned memory references will be handled by the system.
10921 @item -momit-leaf-frame-pointer
10922 @itemx -mno-omit-leaf-frame-pointer
10923 @opindex momit-leaf-frame-pointer
10924 @opindex mno-omit-leaf-frame-pointer
10925 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
10926 default.
10928 @item -mtls-dialect=desc
10929 @opindex mtls-dialect=desc
10930 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
10931 of TLS variables.  This is the default.
10933 @item -mtls-dialect=traditional
10934 @opindex mtls-dialect=traditional
10935 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
10936 of TLS variables.
10938 @item -mfix-cortex-a53-835769
10939 @itemx -mno-fix-cortex-a53-835769
10940 @opindex -mfix-cortex-a53-835769
10941 @opindex -mno-fix-cortex-a53-835769
10942 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
10943 This will involve inserting a NOP instruction between memory instructions and
10944 64-bit integer multiply-accumulate instructions.
10946 @item -march=@var{name}
10947 @opindex march
10948 Specify the name of the target architecture, optionally suffixed by one or
10949 more feature modifiers.  This option has the form
10950 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
10951 only value for @var{arch} is @samp{armv8-a}.  The possible values for
10952 @var{feature} are documented in the sub-section below.
10954 Where conflicting feature modifiers are specified, the right-most feature is
10955 used.
10957 GCC uses this name to determine what kind of instructions it can emit when
10958 generating assembly code.  This option can be used in conjunction with or
10959 instead of the @option{-mcpu=} option.
10961 @item -mcpu=@var{name}
10962 @opindex mcpu
10963 Specify the name of the target processor, optionally suffixed by one or more
10964 feature modifiers.  This option has the form
10965 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
10966 possible values for @var{cpu} are @samp{generic}, @samp{large}.  The
10967 possible values for @var{feature} are documented in the sub-section
10968 below.
10970 Where conflicting feature modifiers are specified, the right-most feature is
10971 used.
10973 GCC uses this name to determine what kind of instructions it can emit when
10974 generating assembly code.
10976 @item -mtune=@var{name}
10977 @opindex mtune
10978 Specify the name of the processor to tune the performance for.  The code will
10979 be tuned as if the target processor were of the type specified in this option,
10980 but still using instructions compatible with the target processor specified
10981 by a @option{-mcpu=} option.  This option cannot be suffixed by feature
10982 modifiers.
10984 @end table
10986 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
10987 @cindex @option{-march} feature modifiers
10988 @cindex @option{-mcpu} feature modifiers
10989 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
10990 the following:
10992 @table @samp
10993 @item crypto
10994 Enable Crypto extension.  This implies Advanced SIMD is enabled.
10995 @item fp
10996 Enable floating-point instructions.
10997 @item simd
10998 Enable Advanced SIMD instructions.  This implies floating-point instructions
10999 are enabled.  This is the default for all current possible values for options
11000 @option{-march} and @option{-mcpu=}.
11001 @end table
11003 @node Adapteva Epiphany Options
11004 @subsection Adapteva Epiphany Options
11006 These @samp{-m} options are defined for Adapteva Epiphany:
11008 @table @gcctabopt
11009 @item -mhalf-reg-file
11010 @opindex mhalf-reg-file
11011 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11012 That allows code to run on hardware variants that lack these registers.
11014 @item -mprefer-short-insn-regs
11015 @opindex mprefer-short-insn-regs
11016 Preferrentially allocate registers that allow short instruction generation.
11017 This can result in increased instruction count, so this may either reduce or
11018 increase overall code size.
11020 @item -mbranch-cost=@var{num}
11021 @opindex mbranch-cost
11022 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11023 This cost is only a heuristic and is not guaranteed to produce
11024 consistent results across releases.
11026 @item -mcmove
11027 @opindex mcmove
11028 Enable the generation of conditional moves.
11030 @item -mnops=@var{num}
11031 @opindex mnops
11032 Emit @var{num} NOPs before every other generated instruction.
11034 @item -mno-soft-cmpsf
11035 @opindex mno-soft-cmpsf
11036 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11037 and test the flags.  This is faster than a software comparison, but can
11038 get incorrect results in the presence of NaNs, or when two different small
11039 numbers are compared such that their difference is calculated as zero.
11040 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11041 software comparisons.
11043 @item -mstack-offset=@var{num}
11044 @opindex mstack-offset
11045 Set the offset between the top of the stack and the stack pointer.
11046 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11047 can be used by leaf functions without stack allocation.
11048 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11049 Note also that this option changes the ABI; compiling a program with a
11050 different stack offset than the libraries have been compiled with
11051 generally does not work.
11052 This option can be useful if you want to evaluate if a different stack
11053 offset would give you better code, but to actually use a different stack
11054 offset to build working programs, it is recommended to configure the
11055 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11057 @item -mno-round-nearest
11058 @opindex mno-round-nearest
11059 Make the scheduler assume that the rounding mode has been set to
11060 truncating.  The default is @option{-mround-nearest}.
11062 @item -mlong-calls
11063 @opindex mlong-calls
11064 If not otherwise specified by an attribute, assume all calls might be beyond
11065 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11066 function address into a register before performing a (otherwise direct) call.
11067 This is the default.
11069 @item -mshort-calls
11070 @opindex short-calls
11071 If not otherwise specified by an attribute, assume all direct calls are
11072 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11073 for direct calls.  The default is @option{-mlong-calls}.
11075 @item -msmall16
11076 @opindex msmall16
11077 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11078 apply to function addresses for which @option{-mlong-calls} semantics
11079 are in effect.
11081 @item -mfp-mode=@var{mode}
11082 @opindex mfp-mode
11083 Set the prevailing mode of the floating-point unit.
11084 This determines the floating-point mode that is provided and expected
11085 at function call and return time.  Making this mode match the mode you
11086 predominantly need at function start can make your programs smaller and
11087 faster by avoiding unnecessary mode switches.
11089 @var{mode} can be set to one the following values:
11091 @table @samp
11092 @item caller
11093 Any mode at function entry is valid, and retained or restored when
11094 the function returns, and when it calls other functions.
11095 This mode is useful for compiling libraries or other compilation units
11096 you might want to incorporate into different programs with different
11097 prevailing FPU modes, and the convenience of being able to use a single
11098 object file outweighs the size and speed overhead for any extra
11099 mode switching that might be needed, compared with what would be needed
11100 with a more specific choice of prevailing FPU mode.
11102 @item truncate
11103 This is the mode used for floating-point calculations with
11104 truncating (i.e.@: round towards zero) rounding mode.  That includes
11105 conversion from floating point to integer.
11107 @item round-nearest
11108 This is the mode used for floating-point calculations with
11109 round-to-nearest-or-even rounding mode.
11111 @item int
11112 This is the mode used to perform integer calculations in the FPU, e.g.@:
11113 integer multiply, or integer multiply-and-accumulate.
11114 @end table
11116 The default is @option{-mfp-mode=caller}
11118 @item -mnosplit-lohi
11119 @itemx -mno-postinc
11120 @itemx -mno-postmodify
11121 @opindex mnosplit-lohi
11122 @opindex mno-postinc
11123 @opindex mno-postmodify
11124 Code generation tweaks that disable, respectively, splitting of 32-bit
11125 loads, generation of post-increment addresses, and generation of
11126 post-modify addresses.  The defaults are @option{msplit-lohi},
11127 @option{-mpost-inc}, and @option{-mpost-modify}.
11129 @item -mnovect-double
11130 @opindex mno-vect-double
11131 Change the preferred SIMD mode to SImode.  The default is
11132 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11134 @item -max-vect-align=@var{num}
11135 @opindex max-vect-align
11136 The maximum alignment for SIMD vector mode types.
11137 @var{num} may be 4 or 8.  The default is 8.
11138 Note that this is an ABI change, even though many library function
11139 interfaces are unaffected if they don't use SIMD vector modes
11140 in places that affect size and/or alignment of relevant types.
11142 @item -msplit-vecmove-early
11143 @opindex msplit-vecmove-early
11144 Split vector moves into single word moves before reload.  In theory this
11145 can give better register allocation, but so far the reverse seems to be
11146 generally the case.
11148 @item -m1reg-@var{reg}
11149 @opindex m1reg-
11150 Specify a register to hold the constant @minus{}1, which makes loading small negative
11151 constants and certain bitmasks faster.
11152 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11153 which specify use of that register as a fixed register,
11154 and @samp{none}, which means that no register is used for this
11155 purpose.  The default is @option{-m1reg-none}.
11157 @end table
11159 @node ARM Options
11160 @subsection ARM Options
11161 @cindex ARM options
11163 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
11164 architectures:
11166 @table @gcctabopt
11167 @item -mabi=@var{name}
11168 @opindex mabi
11169 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
11170 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
11172 @item -mapcs-frame
11173 @opindex mapcs-frame
11174 Generate a stack frame that is compliant with the ARM Procedure Call
11175 Standard for all functions, even if this is not strictly necessary for
11176 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
11177 with this option causes the stack frames not to be generated for
11178 leaf functions.  The default is @option{-mno-apcs-frame}.
11180 @item -mapcs
11181 @opindex mapcs
11182 This is a synonym for @option{-mapcs-frame}.
11184 @ignore
11185 @c not currently implemented
11186 @item -mapcs-stack-check
11187 @opindex mapcs-stack-check
11188 Generate code to check the amount of stack space available upon entry to
11189 every function (that actually uses some stack space).  If there is
11190 insufficient space available then either the function
11191 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
11192 called, depending upon the amount of stack space required.  The runtime
11193 system is required to provide these functions.  The default is
11194 @option{-mno-apcs-stack-check}, since this produces smaller code.
11196 @c not currently implemented
11197 @item -mapcs-float
11198 @opindex mapcs-float
11199 Pass floating-point arguments using the floating-point registers.  This is
11200 one of the variants of the APCS@.  This option is recommended if the
11201 target hardware has a floating-point unit or if a lot of floating-point
11202 arithmetic is going to be performed by the code.  The default is
11203 @option{-mno-apcs-float}, since the size of integer-only code is 
11204 slightly increased if @option{-mapcs-float} is used.
11206 @c not currently implemented
11207 @item -mapcs-reentrant
11208 @opindex mapcs-reentrant
11209 Generate reentrant, position-independent code.  The default is
11210 @option{-mno-apcs-reentrant}.
11211 @end ignore
11213 @item -mthumb-interwork
11214 @opindex mthumb-interwork
11215 Generate code that supports calling between the ARM and Thumb
11216 instruction sets.  Without this option, on pre-v5 architectures, the
11217 two instruction sets cannot be reliably used inside one program.  The
11218 default is @option{-mno-thumb-interwork}, since slightly larger code
11219 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
11220 configurations this option is meaningless.
11222 @item -mno-sched-prolog
11223 @opindex mno-sched-prolog
11224 Prevent the reordering of instructions in the function prologue, or the
11225 merging of those instruction with the instructions in the function's
11226 body.  This means that all functions start with a recognizable set
11227 of instructions (or in fact one of a choice from a small set of
11228 different function prologues), and this information can be used to
11229 locate the start of functions inside an executable piece of code.  The
11230 default is @option{-msched-prolog}.
11232 @item -mfloat-abi=@var{name}
11233 @opindex mfloat-abi
11234 Specifies which floating-point ABI to use.  Permissible values
11235 are: @samp{soft}, @samp{softfp} and @samp{hard}.
11237 Specifying @samp{soft} causes GCC to generate output containing
11238 library calls for floating-point operations.
11239 @samp{softfp} allows the generation of code using hardware floating-point
11240 instructions, but still uses the soft-float calling conventions.
11241 @samp{hard} allows generation of floating-point instructions
11242 and uses FPU-specific calling conventions.
11244 The default depends on the specific target configuration.  Note that
11245 the hard-float and soft-float ABIs are not link-compatible; you must
11246 compile your entire program with the same ABI, and link with a
11247 compatible set of libraries.
11249 @item -mlittle-endian
11250 @opindex mlittle-endian
11251 Generate code for a processor running in little-endian mode.  This is
11252 the default for all standard configurations.
11254 @item -mbig-endian
11255 @opindex mbig-endian
11256 Generate code for a processor running in big-endian mode; the default is
11257 to compile code for a little-endian processor.
11259 @item -mwords-little-endian
11260 @opindex mwords-little-endian
11261 This option only applies when generating code for big-endian processors.
11262 Generate code for a little-endian word order but a big-endian byte
11263 order.  That is, a byte order of the form @samp{32107654}.  Note: this
11264 option should only be used if you require compatibility with code for
11265 big-endian ARM processors generated by versions of the compiler prior to
11266 2.8.  This option is now deprecated.
11268 @item -march=@var{name}
11269 @opindex march
11270 This specifies the name of the target ARM architecture.  GCC uses this
11271 name to determine what kind of instructions it can emit when generating
11272 assembly code.  This option can be used in conjunction with or instead
11273 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
11274 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
11275 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
11276 @samp{armv6}, @samp{armv6j},
11277 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
11278 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m}
11279 @samp{armv8-a},
11280 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
11282 @option{-march=native} causes the compiler to auto-detect the architecture
11283 of the build computer.  At present, this feature is only supported on
11284 GNU/Linux, and not all architectures are recognized.  If the auto-detect
11285 is unsuccessful the option has no effect.
11287 @item -mtune=@var{name}
11288 @opindex mtune
11289 This option specifies the name of the target ARM processor for
11290 which GCC should tune the performance of the code.
11291 For some ARM implementations better performance can be obtained by using
11292 this option.
11293 Permissible names are: @samp{arm2}, @samp{arm250},
11294 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
11295 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
11296 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
11297 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
11298 @samp{arm720},
11299 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
11300 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
11301 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
11302 @samp{strongarm1110},
11303 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
11304 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
11305 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
11306 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
11307 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
11308 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
11309 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
11310 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
11311 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
11312 @samp{cortex-m4}, @samp{cortex-m3},
11313 @samp{cortex-m1},
11314 @samp{cortex-m0},
11315 @samp{cortex-m0plus},
11316 @samp{marvell-pj4},
11317 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
11318 @samp{fa526}, @samp{fa626},
11319 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
11321 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
11322 performance for a blend of processors within architecture @var{arch}.
11323 The aim is to generate code that run well on the current most popular
11324 processors, balancing between optimizations that benefit some CPUs in the
11325 range, and avoiding performance pitfalls of other CPUs.  The effects of
11326 this option may change in future GCC versions as CPU models come and go.
11328 @option{-mtune=native} causes the compiler to auto-detect the CPU
11329 of the build computer.  At present, this feature is only supported on
11330 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
11331 unsuccessful the option has no effect.
11333 @item -mcpu=@var{name}
11334 @opindex mcpu
11335 This specifies the name of the target ARM processor.  GCC uses this name
11336 to derive the name of the target ARM architecture (as if specified
11337 by @option{-march}) and the ARM processor type for which to tune for
11338 performance (as if specified by @option{-mtune}).  Where this option
11339 is used in conjunction with @option{-march} or @option{-mtune},
11340 those options take precedence over the appropriate part of this option.
11342 Permissible names for this option are the same as those for
11343 @option{-mtune}.
11345 @option{-mcpu=generic-@var{arch}} is also permissible, and is
11346 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
11347 See @option{-mtune} for more information.
11349 @option{-mcpu=native} causes the compiler to auto-detect the CPU
11350 of the build computer.  At present, this feature is only supported on
11351 GNU/Linux, and not all architectures are recognized.  If the auto-detect
11352 is unsuccessful the option has no effect.
11354 @item -mfpu=@var{name}
11355 @opindex mfpu
11356 This specifies what floating-point hardware (or hardware emulation) is
11357 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
11358 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
11359 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
11360 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
11361 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
11363 If @option{-msoft-float} is specified this specifies the format of
11364 floating-point values.
11366 If the selected floating-point hardware includes the NEON extension
11367 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
11368 operations are not generated by GCC's auto-vectorization pass unless
11369 @option{-funsafe-math-optimizations} is also specified.  This is
11370 because NEON hardware does not fully implement the IEEE 754 standard for
11371 floating-point arithmetic (in particular denormal values are treated as
11372 zero), so the use of NEON instructions may lead to a loss of precision.
11374 @item -mfp16-format=@var{name}
11375 @opindex mfp16-format
11376 Specify the format of the @code{__fp16} half-precision floating-point type.
11377 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
11378 the default is @samp{none}, in which case the @code{__fp16} type is not
11379 defined.  @xref{Half-Precision}, for more information.
11381 @item -mstructure-size-boundary=@var{n}
11382 @opindex mstructure-size-boundary
11383 The sizes of all structures and unions are rounded up to a multiple
11384 of the number of bits set by this option.  Permissible values are 8, 32
11385 and 64.  The default value varies for different toolchains.  For the COFF
11386 targeted toolchain the default value is 8.  A value of 64 is only allowed
11387 if the underlying ABI supports it.
11389 Specifying a larger number can produce faster, more efficient code, but
11390 can also increase the size of the program.  Different values are potentially
11391 incompatible.  Code compiled with one value cannot necessarily expect to
11392 work with code or libraries compiled with another value, if they exchange
11393 information using structures or unions.
11395 @item -mabort-on-noreturn
11396 @opindex mabort-on-noreturn
11397 Generate a call to the function @code{abort} at the end of a
11398 @code{noreturn} function.  It is executed if the function tries to
11399 return.
11401 @item -mlong-calls
11402 @itemx -mno-long-calls
11403 @opindex mlong-calls
11404 @opindex mno-long-calls
11405 Tells the compiler to perform function calls by first loading the
11406 address of the function into a register and then performing a subroutine
11407 call on this register.  This switch is needed if the target function
11408 lies outside of the 64-megabyte addressing range of the offset-based
11409 version of subroutine call instruction.
11411 Even if this switch is enabled, not all function calls are turned
11412 into long calls.  The heuristic is that static functions, functions
11413 that have the @samp{short-call} attribute, functions that are inside
11414 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
11415 definitions have already been compiled within the current compilation
11416 unit are not turned into long calls.  The exceptions to this rule are
11417 that weak function definitions, functions with the @samp{long-call}
11418 attribute or the @samp{section} attribute, and functions that are within
11419 the scope of a @samp{#pragma long_calls} directive are always
11420 turned into long calls.
11422 This feature is not enabled by default.  Specifying
11423 @option{-mno-long-calls} restores the default behavior, as does
11424 placing the function calls within the scope of a @samp{#pragma
11425 long_calls_off} directive.  Note these switches have no effect on how
11426 the compiler generates code to handle function calls via function
11427 pointers.
11429 @item -msingle-pic-base
11430 @opindex msingle-pic-base
11431 Treat the register used for PIC addressing as read-only, rather than
11432 loading it in the prologue for each function.  The runtime system is
11433 responsible for initializing this register with an appropriate value
11434 before execution begins.
11436 @item -mpic-register=@var{reg}
11437 @opindex mpic-register
11438 Specify the register to be used for PIC addressing.
11439 For standard PIC base case, the default will be any suitable register
11440 determined by compiler.  For single PIC base case, the default is
11441 @samp{R9} if target is EABI based or stack-checking is enabled,
11442 otherwise the default is @samp{R10}.
11444 @item -mpoke-function-name
11445 @opindex mpoke-function-name
11446 Write the name of each function into the text section, directly
11447 preceding the function prologue.  The generated code is similar to this:
11449 @smallexample
11450      t0
11451          .ascii "arm_poke_function_name", 0
11452          .align
11453      t1
11454          .word 0xff000000 + (t1 - t0)
11455      arm_poke_function_name
11456          mov     ip, sp
11457          stmfd   sp!, @{fp, ip, lr, pc@}
11458          sub     fp, ip, #4
11459 @end smallexample
11461 When performing a stack backtrace, code can inspect the value of
11462 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
11463 location @code{pc - 12} and the top 8 bits are set, then we know that
11464 there is a function name embedded immediately preceding this location
11465 and has length @code{((pc[-3]) & 0xff000000)}.
11467 @item -mthumb
11468 @itemx -marm
11469 @opindex marm
11470 @opindex mthumb
11472 Select between generating code that executes in ARM and Thumb
11473 states.  The default for most configurations is to generate code
11474 that executes in ARM state, but the default can be changed by
11475 configuring GCC with the @option{--with-mode=}@var{state}
11476 configure option.
11478 @item -mtpcs-frame
11479 @opindex mtpcs-frame
11480 Generate a stack frame that is compliant with the Thumb Procedure Call
11481 Standard for all non-leaf functions.  (A leaf function is one that does
11482 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
11484 @item -mtpcs-leaf-frame
11485 @opindex mtpcs-leaf-frame
11486 Generate a stack frame that is compliant with the Thumb Procedure Call
11487 Standard for all leaf functions.  (A leaf function is one that does
11488 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
11490 @item -mcallee-super-interworking
11491 @opindex mcallee-super-interworking
11492 Gives all externally visible functions in the file being compiled an ARM
11493 instruction set header which switches to Thumb mode before executing the
11494 rest of the function.  This allows these functions to be called from
11495 non-interworking code.  This option is not valid in AAPCS configurations
11496 because interworking is enabled by default.
11498 @item -mcaller-super-interworking
11499 @opindex mcaller-super-interworking
11500 Allows calls via function pointers (including virtual functions) to
11501 execute correctly regardless of whether the target code has been
11502 compiled for interworking or not.  There is a small overhead in the cost
11503 of executing a function pointer if this option is enabled.  This option
11504 is not valid in AAPCS configurations because interworking is enabled
11505 by default.
11507 @item -mtp=@var{name}
11508 @opindex mtp
11509 Specify the access model for the thread local storage pointer.  The valid
11510 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11511 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11512 (supported in the arm6k architecture), and @option{auto}, which uses the
11513 best available method for the selected processor.  The default setting is
11514 @option{auto}.
11516 @item -mtls-dialect=@var{dialect}
11517 @opindex mtls-dialect
11518 Specify the dialect to use for accessing thread local storage.  Two
11519 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
11520 @samp{gnu} dialect selects the original GNU scheme for supporting
11521 local and global dynamic TLS models.  The @samp{gnu2} dialect
11522 selects the GNU descriptor scheme, which provides better performance
11523 for shared libraries.  The GNU descriptor scheme is compatible with
11524 the original scheme, but does require new assembler, linker and
11525 library support.  Initial and local exec TLS models are unaffected by
11526 this option and always use the original scheme.
11528 @item -mword-relocations
11529 @opindex mword-relocations
11530 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11531 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11532 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11533 is specified.
11535 @item -mfix-cortex-m3-ldrd
11536 @opindex mfix-cortex-m3-ldrd
11537 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11538 with overlapping destination and base registers are used.  This option avoids
11539 generating these instructions.  This option is enabled by default when
11540 @option{-mcpu=cortex-m3} is specified.
11542 @item -munaligned-access
11543 @itemx -mno-unaligned-access
11544 @opindex munaligned-access
11545 @opindex mno-unaligned-access
11546 Enables (or disables) reading and writing of 16- and 32- bit values
11547 from addresses that are not 16- or 32- bit aligned.  By default
11548 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11549 architectures, and enabled for all other architectures.  If unaligned
11550 access is not enabled then words in packed data structures will be
11551 accessed a byte at a time.
11553 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11554 generated object file to either true or false, depending upon the
11555 setting of this option.  If unaligned access is enabled then the
11556 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11557 defined.
11559 @end table
11561 @node AVR Options
11562 @subsection AVR Options
11563 @cindex AVR Options
11565 These options are defined for AVR implementations:
11567 @table @gcctabopt
11568 @item -mmcu=@var{mcu}
11569 @opindex mmcu
11570 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11572 The default for this option is@tie{}@code{avr2}.
11574 GCC supports the following AVR devices and ISAs:
11576 @include avr-mmcu.texi
11578 @item -maccumulate-args
11579 @opindex maccumulate-args
11580 Accumulate outgoing function arguments and acquire/release the needed
11581 stack space for outgoing function arguments once in function
11582 prologue/epilogue.  Without this option, outgoing arguments are pushed
11583 before calling a function and popped afterwards.
11585 Popping the arguments after the function call can be expensive on
11586 AVR so that accumulating the stack space might lead to smaller
11587 executables because arguments need not to be removed from the
11588 stack after such a function call.
11590 This option can lead to reduced code size for functions that perform
11591 several calls to functions that get their arguments on the stack like
11592 calls to printf-like functions.
11594 @item -mbranch-cost=@var{cost}
11595 @opindex mbranch-cost
11596 Set the branch costs for conditional branch instructions to
11597 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11598 integers. The default branch cost is 0.
11600 @item -mcall-prologues
11601 @opindex mcall-prologues
11602 Functions prologues/epilogues are expanded as calls to appropriate
11603 subroutines.  Code size is smaller.
11605 @item -mint8
11606 @opindex mint8
11607 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
11608 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11609 and @code{long long} is 4 bytes.  Please note that this option does not
11610 conform to the C standards, but it results in smaller code
11611 size.
11613 @item -mno-interrupts
11614 @opindex mno-interrupts
11615 Generated code is not compatible with hardware interrupts.
11616 Code size is smaller.
11618 @item -mrelax
11619 @opindex mrelax
11620 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11621 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11622 Setting @code{-mrelax} just adds the @code{--relax} option to the
11623 linker command line when the linker is called.
11625 Jump relaxing is performed by the linker because jump offsets are not
11626 known before code is located. Therefore, the assembler code generated by the
11627 compiler is the same, but the instructions in the executable may
11628 differ from instructions in the assembler code.
11630 Relaxing must be turned on if linker stubs are needed, see the
11631 section on @code{EIND} and linker stubs below.
11633 @item -msp8
11634 @opindex msp8
11635 Treat the stack pointer register as an 8-bit register,
11636 i.e.@: assume the high byte of the stack pointer is zero.
11637 In general, you don't need to set this option by hand.
11639 This option is used internally by the compiler to select and
11640 build multilibs for architectures @code{avr2} and @code{avr25}.
11641 These architectures mix devices with and without @code{SPH}.
11642 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11643 the compiler driver will add or remove this option from the compiler
11644 proper's command line, because the compiler then knows if the device
11645 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11646 register or not.
11648 @item -mstrict-X
11649 @opindex mstrict-X
11650 Use address register @code{X} in a way proposed by the hardware.  This means
11651 that @code{X} is only used in indirect, post-increment or
11652 pre-decrement addressing.
11654 Without this option, the @code{X} register may be used in the same way
11655 as @code{Y} or @code{Z} which then is emulated by additional
11656 instructions.  
11657 For example, loading a value with @code{X+const} addressing with a
11658 small non-negative @code{const < 64} to a register @var{Rn} is
11659 performed as
11661 @example
11662 adiw r26, const   ; X += const
11663 ld   @var{Rn}, X        ; @var{Rn} = *X
11664 sbiw r26, const   ; X -= const
11665 @end example
11667 @item -mtiny-stack
11668 @opindex mtiny-stack
11669 Only change the lower 8@tie{}bits of the stack pointer.
11671 @item -Waddr-space-convert
11672 @opindex Waddr-space-convert
11673 Warn about conversions between address spaces in the case where the
11674 resulting address space is not contained in the incoming address space.
11675 @end table
11677 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11678 @cindex @code{EIND}
11679 Pointers in the implementation are 16@tie{}bits wide.
11680 The address of a function or label is represented as word address so
11681 that indirect jumps and calls can target any code address in the
11682 range of 64@tie{}Ki words.
11684 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11685 bytes of program memory space, there is a special function register called
11686 @code{EIND} that serves as most significant part of the target address
11687 when @code{EICALL} or @code{EIJMP} instructions are used.
11689 Indirect jumps and calls on these devices are handled as follows by
11690 the compiler and are subject to some limitations:
11692 @itemize @bullet
11694 @item
11695 The compiler never sets @code{EIND}.
11697 @item
11698 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11699 instructions or might read @code{EIND} directly in order to emulate an
11700 indirect call/jump by means of a @code{RET} instruction.
11702 @item
11703 The compiler assumes that @code{EIND} never changes during the startup
11704 code or during the application. In particular, @code{EIND} is not
11705 saved/restored in function or interrupt service routine
11706 prologue/epilogue.
11708 @item
11709 For indirect calls to functions and computed goto, the linker
11710 generates @emph{stubs}. Stubs are jump pads sometimes also called
11711 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11712 The stub contains a direct jump to the desired address.
11714 @item
11715 Linker relaxation must be turned on so that the linker will generate
11716 the stubs correctly an all situaltion. See the compiler option
11717 @code{-mrelax} and the linler option @code{--relax}.
11718 There are corner cases where the linker is supposed to generate stubs
11719 but aborts without relaxation and without a helpful error message.
11721 @item
11722 The default linker script is arranged for code with @code{EIND = 0}.
11723 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11724 linker script has to be used in order to place the sections whose
11725 name start with @code{.trampolines} into the segment where @code{EIND}
11726 points to.
11728 @item
11729 The startup code from libgcc never sets @code{EIND}.
11730 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11731 For the impact of AVR-LibC on @code{EIND}, see the
11732 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
11734 @item
11735 It is legitimate for user-specific startup code to set up @code{EIND}
11736 early, for example by means of initialization code located in
11737 section @code{.init3}. Such code runs prior to general startup code
11738 that initializes RAM and calls constructors, but after the bit
11739 of startup code from AVR-LibC that sets @code{EIND} to the segment
11740 where the vector table is located.
11741 @example
11742 #include <avr/io.h>
11744 static void
11745 __attribute__((section(".init3"),naked,used,no_instrument_function))
11746 init3_set_eind (void)
11748   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11749                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11751 @end example
11753 @noindent
11754 The @code{__trampolines_start} symbol is defined in the linker script.
11756 @item
11757 Stubs are generated automatically by the linker if
11758 the following two conditions are met:
11759 @itemize @minus
11761 @item The address of a label is taken by means of the @code{gs} modifier
11762 (short for @emph{generate stubs}) like so:
11763 @example
11764 LDI r24, lo8(gs(@var{func}))
11765 LDI r25, hi8(gs(@var{func}))
11766 @end example
11767 @item The final location of that label is in a code segment
11768 @emph{outside} the segment where the stubs are located.
11769 @end itemize
11771 @item
11772 The compiler emits such @code{gs} modifiers for code labels in the
11773 following situations:
11774 @itemize @minus
11775 @item Taking address of a function or code label.
11776 @item Computed goto.
11777 @item If prologue-save function is used, see @option{-mcall-prologues}
11778 command-line option.
11779 @item Switch/case dispatch tables. If you do not want such dispatch
11780 tables you can specify the @option{-fno-jump-tables} command-line option.
11781 @item C and C++ constructors/destructors called during startup/shutdown.
11782 @item If the tools hit a @code{gs()} modifier explained above.
11783 @end itemize
11785 @item
11786 Jumping to non-symbolic addresses like so is @emph{not} supported:
11788 @example
11789 int main (void)
11791     /* Call function at word address 0x2 */
11792     return ((int(*)(void)) 0x2)();
11794 @end example
11796 Instead, a stub has to be set up, i.e.@: the function has to be called
11797 through a symbol (@code{func_4} in the example):
11799 @example
11800 int main (void)
11802     extern int func_4 (void);
11804     /* Call function at byte address 0x4 */
11805     return func_4();
11807 @end example
11809 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11810 Alternatively, @code{func_4} can be defined in the linker script.
11811 @end itemize
11813 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11814 @cindex @code{RAMPD}
11815 @cindex @code{RAMPX}
11816 @cindex @code{RAMPY}
11817 @cindex @code{RAMPZ}
11818 Some AVR devices support memories larger than the 64@tie{}KiB range
11819 that can be accessed with 16-bit pointers.  To access memory locations
11820 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11821 register is used as high part of the address:
11822 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11823 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11824 register, respectively, to get a wide address. Similarly,
11825 @code{RAMPD} is used together with direct addressing.
11827 @itemize
11828 @item
11829 The startup code initializes the @code{RAMP} special function
11830 registers with zero.
11832 @item
11833 If a @ref{AVR Named Address Spaces,named address space} other than
11834 generic or @code{__flash} is used, then @code{RAMPZ} is set
11835 as needed before the operation.
11837 @item
11838 If the device supports RAM larger than 64@tie{KiB} and the compiler
11839 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11840 is reset to zero after the operation.
11842 @item
11843 If the device comes with a specific @code{RAMP} register, the ISR
11844 prologue/epilogue saves/restores that SFR and initializes it with
11845 zero in case the ISR code might (implicitly) use it.
11847 @item
11848 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11849 If you use inline assembler to read from locations outside the
11850 16-bit address range and change one of the @code{RAMP} registers,
11851 you must reset it to zero after the access.
11853 @end itemize
11855 @subsubsection AVR Built-in Macros
11857 GCC defines several built-in macros so that the user code can test
11858 for the presence or absence of features.  Almost any of the following
11859 built-in macros are deduced from device capabilities and thus
11860 triggered by the @code{-mmcu=} command-line option.
11862 For even more AVR-specific built-in macros see
11863 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11865 @table @code
11867 @item __AVR_ARCH__
11868 Build-in macro that resolves to a decimal number that identifies the
11869 architecture and depends on the @code{-mmcu=@var{mcu}} option.
11870 Possible values are:
11872 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
11873 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
11874 @code{105}, @code{106}, @code{107}
11876 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
11877 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
11878 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
11879 @code{avrxmega6}, @code{avrxmega7}, respectively.
11880 If @var{mcu} specifies a device, this built-in macro is set
11881 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
11882 defined to @code{4}.
11884 @item __AVR_@var{Device}__
11885 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11886 the device's name. For example, @code{-mmcu=atmega8} defines the
11887 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11888 @code{__AVR_ATtiny261A__}, etc.
11890 The built-in macros' names follow
11891 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11892 the device name as from the AVR user manual. The difference between
11893 @var{Device} in the built-in macro and @var{device} in
11894 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11896 If @var{device} is not a device but only a core architecture like
11897 @code{avr51}, this macro will not be defined.
11899 @item __AVR_XMEGA__
11900 The device / architecture belongs to the XMEGA family of devices.
11902 @item __AVR_HAVE_ELPM__
11903 The device has the the @code{ELPM} instruction.
11905 @item __AVR_HAVE_ELPMX__
11906 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11907 R@var{n},Z+} instructions.
11909 @item __AVR_HAVE_MOVW__
11910 The device has the @code{MOVW} instruction to perform 16-bit
11911 register-register moves.
11913 @item __AVR_HAVE_LPMX__
11914 The device has the @code{LPM R@var{n},Z} and
11915 @code{LPM R@var{n},Z+} instructions.
11917 @item __AVR_HAVE_MUL__
11918 The device has a hardware multiplier. 
11920 @item __AVR_HAVE_JMP_CALL__
11921 The device has the @code{JMP} and @code{CALL} instructions.
11922 This is the case for devices with at least 16@tie{}KiB of program
11923 memory.
11925 @item __AVR_HAVE_EIJMP_EICALL__
11926 @itemx __AVR_3_BYTE_PC__
11927 The device has the @code{EIJMP} and @code{EICALL} instructions.
11928 This is the case for devices with more than 128@tie{}KiB of program memory.
11929 This also means that the program counter
11930 (PC) is 3@tie{}bytes wide.
11932 @item __AVR_2_BYTE_PC__
11933 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11934 with up to 128@tie{}KiB of program memory.
11936 @item __AVR_HAVE_8BIT_SP__
11937 @itemx __AVR_HAVE_16BIT_SP__
11938 The stack pointer (SP) register is treated as 8-bit respectively
11939 16-bit register by the compiler.
11940 The definition of these macros is affected by @code{-mtiny-stack}.
11942 @item __AVR_HAVE_SPH__
11943 @itemx __AVR_SP8__
11944 The device has the SPH (high part of stack pointer) special function
11945 register or has an 8-bit stack pointer, respectively.
11946 The definition of these macros is affected by @code{-mmcu=} and
11947 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11948 by @code{-msp8}.
11950 @item __AVR_HAVE_RAMPD__
11951 @itemx __AVR_HAVE_RAMPX__
11952 @itemx __AVR_HAVE_RAMPY__
11953 @itemx __AVR_HAVE_RAMPZ__
11954 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11955 @code{RAMPZ} special function register, respectively.
11957 @item __NO_INTERRUPTS__
11958 This macro reflects the @code{-mno-interrupts} command line option.
11960 @item __AVR_ERRATA_SKIP__
11961 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
11962 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11963 instructions because of a hardware erratum.  Skip instructions are
11964 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11965 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11966 set.
11968 @item __AVR_SFR_OFFSET__=@var{offset}
11969 Instructions that can address I/O special function registers directly
11970 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11971 address as if addressed by an instruction to access RAM like @code{LD}
11972 or @code{STS}. This offset depends on the device architecture and has
11973 to be subtracted from the RAM address in order to get the
11974 respective I/O@tie{}address.
11976 @item __WITH_AVRLIBC__
11977 The compiler is configured to be used together with AVR-Libc.
11978 See the @code{--with-avrlibc} configure option.
11980 @end table
11982 @node Blackfin Options
11983 @subsection Blackfin Options
11984 @cindex Blackfin Options
11986 @table @gcctabopt
11987 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11988 @opindex mcpu=
11989 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11990 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11991 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11992 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11993 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11994 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11995 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11996 @samp{bf561}, @samp{bf592}.
11998 The optional @var{sirevision} specifies the silicon revision of the target
11999 Blackfin processor.  Any workarounds available for the targeted silicon revision
12000 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
12001 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
12002 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
12003 hexadecimal digits representing the major and minor numbers in the silicon
12004 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
12005 is not defined.  If @var{sirevision} is @samp{any}, the
12006 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
12007 If this optional @var{sirevision} is not used, GCC assumes the latest known
12008 silicon revision of the targeted Blackfin processor.
12010 GCC defines a preprocessor macro for the specified @var{cpu}.
12011 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
12012 provided by libgloss to be linked in if @option{-msim} is not given.
12014 Without this option, @samp{bf532} is used as the processor by default.
12016 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
12017 only the preprocessor macro is defined.
12019 @item -msim
12020 @opindex msim
12021 Specifies that the program will be run on the simulator.  This causes
12022 the simulator BSP provided by libgloss to be linked in.  This option
12023 has effect only for @samp{bfin-elf} toolchain.
12024 Certain other options, such as @option{-mid-shared-library} and
12025 @option{-mfdpic}, imply @option{-msim}.
12027 @item -momit-leaf-frame-pointer
12028 @opindex momit-leaf-frame-pointer
12029 Don't keep the frame pointer in a register for leaf functions.  This
12030 avoids the instructions to save, set up and restore frame pointers and
12031 makes an extra register available in leaf functions.  The option
12032 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
12033 which might make debugging harder.
12035 @item -mspecld-anomaly
12036 @opindex mspecld-anomaly
12037 When enabled, the compiler ensures that the generated code does not
12038 contain speculative loads after jump instructions. If this option is used,
12039 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
12041 @item -mno-specld-anomaly
12042 @opindex mno-specld-anomaly
12043 Don't generate extra code to prevent speculative loads from occurring.
12045 @item -mcsync-anomaly
12046 @opindex mcsync-anomaly
12047 When enabled, the compiler ensures that the generated code does not
12048 contain CSYNC or SSYNC instructions too soon after conditional branches.
12049 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
12051 @item -mno-csync-anomaly
12052 @opindex mno-csync-anomaly
12053 Don't generate extra code to prevent CSYNC or SSYNC instructions from
12054 occurring too soon after a conditional branch.
12056 @item -mlow-64k
12057 @opindex mlow-64k
12058 When enabled, the compiler is free to take advantage of the knowledge that
12059 the entire program fits into the low 64k of memory.
12061 @item -mno-low-64k
12062 @opindex mno-low-64k
12063 Assume that the program is arbitrarily large.  This is the default.
12065 @item -mstack-check-l1
12066 @opindex mstack-check-l1
12067 Do stack checking using information placed into L1 scratchpad memory by the
12068 uClinux kernel.
12070 @item -mid-shared-library
12071 @opindex mid-shared-library
12072 Generate code that supports shared libraries via the library ID method.
12073 This allows for execute in place and shared libraries in an environment
12074 without virtual memory management.  This option implies @option{-fPIC}.
12075 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12077 @item -mno-id-shared-library
12078 @opindex mno-id-shared-library
12079 Generate code that doesn't assume ID-based shared libraries are being used.
12080 This is the default.
12082 @item -mleaf-id-shared-library
12083 @opindex mleaf-id-shared-library
12084 Generate code that supports shared libraries via the library ID method,
12085 but assumes that this library or executable won't link against any other
12086 ID shared libraries.  That allows the compiler to use faster code for jumps
12087 and calls.
12089 @item -mno-leaf-id-shared-library
12090 @opindex mno-leaf-id-shared-library
12091 Do not assume that the code being compiled won't link against any ID shared
12092 libraries.  Slower code is generated for jump and call insns.
12094 @item -mshared-library-id=n
12095 @opindex mshared-library-id
12096 Specifies the identification number of the ID-based shared library being
12097 compiled.  Specifying a value of 0 generates more compact code; specifying
12098 other values forces the allocation of that number to the current
12099 library but is no more space- or time-efficient than omitting this option.
12101 @item -msep-data
12102 @opindex msep-data
12103 Generate code that allows the data segment to be located in a different
12104 area of memory from the text segment.  This allows for execute in place in
12105 an environment without virtual memory management by eliminating relocations
12106 against the text section.
12108 @item -mno-sep-data
12109 @opindex mno-sep-data
12110 Generate code that assumes that the data segment follows the text segment.
12111 This is the default.
12113 @item -mlong-calls
12114 @itemx -mno-long-calls
12115 @opindex mlong-calls
12116 @opindex mno-long-calls
12117 Tells the compiler to perform function calls by first loading the
12118 address of the function into a register and then performing a subroutine
12119 call on this register.  This switch is needed if the target function
12120 lies outside of the 24-bit addressing range of the offset-based
12121 version of subroutine call instruction.
12123 This feature is not enabled by default.  Specifying
12124 @option{-mno-long-calls} restores the default behavior.  Note these
12125 switches have no effect on how the compiler generates code to handle
12126 function calls via function pointers.
12128 @item -mfast-fp
12129 @opindex mfast-fp
12130 Link with the fast floating-point library. This library relaxes some of
12131 the IEEE floating-point standard's rules for checking inputs against
12132 Not-a-Number (NAN), in the interest of performance.
12134 @item -minline-plt
12135 @opindex minline-plt
12136 Enable inlining of PLT entries in function calls to functions that are
12137 not known to bind locally.  It has no effect without @option{-mfdpic}.
12139 @item -mmulticore
12140 @opindex mmulticore
12141 Build a standalone application for multicore Blackfin processors. 
12142 This option causes proper start files and link scripts supporting 
12143 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
12144 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
12146 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
12147 selects the one-application-per-core programming model.  Without
12148 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
12149 programming model is used. In this model, the main function of Core B
12150 should be named as @code{coreb_main}.
12152 If this option is not used, the single-core application programming
12153 model is used.
12155 @item -mcorea
12156 @opindex mcorea
12157 Build a standalone application for Core A of BF561 when using
12158 the one-application-per-core programming model. Proper start files
12159 and link scripts are used to support Core A, and the macro
12160 @code{__BFIN_COREA} is defined.
12161 This option can only be used in conjunction with @option{-mmulticore}.
12163 @item -mcoreb
12164 @opindex mcoreb
12165 Build a standalone application for Core B of BF561 when using
12166 the one-application-per-core programming model. Proper start files
12167 and link scripts are used to support Core B, and the macro
12168 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
12169 should be used instead of @code{main}. 
12170 This option can only be used in conjunction with @option{-mmulticore}.
12172 @item -msdram
12173 @opindex msdram
12174 Build a standalone application for SDRAM. Proper start files and
12175 link scripts are used to put the application into SDRAM, and the macro
12176 @code{__BFIN_SDRAM} is defined.
12177 The loader should initialize SDRAM before loading the application.
12179 @item -micplb
12180 @opindex micplb
12181 Assume that ICPLBs are enabled at run time.  This has an effect on certain
12182 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
12183 are enabled; for standalone applications the default is off.
12184 @end table
12186 @node C6X Options
12187 @subsection C6X Options
12188 @cindex C6X Options
12190 @table @gcctabopt
12191 @item -march=@var{name}
12192 @opindex march
12193 This specifies the name of the target architecture.  GCC uses this
12194 name to determine what kind of instructions it can emit when generating
12195 assembly code.  Permissible names are: @samp{c62x},
12196 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
12198 @item -mbig-endian
12199 @opindex mbig-endian
12200 Generate code for a big-endian target.
12202 @item -mlittle-endian
12203 @opindex mlittle-endian
12204 Generate code for a little-endian target.  This is the default.
12206 @item -msim
12207 @opindex msim
12208 Choose startup files and linker script suitable for the simulator.
12210 @item -msdata=default
12211 @opindex msdata=default
12212 Put small global and static data in the @samp{.neardata} section,
12213 which is pointed to by register @code{B14}.  Put small uninitialized
12214 global and static data in the @samp{.bss} section, which is adjacent
12215 to the @samp{.neardata} section.  Put small read-only data into the
12216 @samp{.rodata} section.  The corresponding sections used for large
12217 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
12219 @item -msdata=all
12220 @opindex msdata=all
12221 Put all data, not just small objects, into the sections reserved for
12222 small data, and use addressing relative to the @code{B14} register to
12223 access them.
12225 @item -msdata=none
12226 @opindex msdata=none
12227 Make no use of the sections reserved for small data, and use absolute
12228 addresses to access all data.  Put all initialized global and static
12229 data in the @samp{.fardata} section, and all uninitialized data in the
12230 @samp{.far} section.  Put all constant data into the @samp{.const}
12231 section.
12232 @end table
12234 @node CRIS Options
12235 @subsection CRIS Options
12236 @cindex CRIS Options
12238 These options are defined specifically for the CRIS ports.
12240 @table @gcctabopt
12241 @item -march=@var{architecture-type}
12242 @itemx -mcpu=@var{architecture-type}
12243 @opindex march
12244 @opindex mcpu
12245 Generate code for the specified architecture.  The choices for
12246 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
12247 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
12248 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
12249 @samp{v10}.
12251 @item -mtune=@var{architecture-type}
12252 @opindex mtune
12253 Tune to @var{architecture-type} everything applicable about the generated
12254 code, except for the ABI and the set of available instructions.  The
12255 choices for @var{architecture-type} are the same as for
12256 @option{-march=@var{architecture-type}}.
12258 @item -mmax-stack-frame=@var{n}
12259 @opindex mmax-stack-frame
12260 Warn when the stack frame of a function exceeds @var{n} bytes.
12262 @item -metrax4
12263 @itemx -metrax100
12264 @opindex metrax4
12265 @opindex metrax100
12266 The options @option{-metrax4} and @option{-metrax100} are synonyms for
12267 @option{-march=v3} and @option{-march=v8} respectively.
12269 @item -mmul-bug-workaround
12270 @itemx -mno-mul-bug-workaround
12271 @opindex mmul-bug-workaround
12272 @opindex mno-mul-bug-workaround
12273 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
12274 models where it applies.  This option is active by default.
12276 @item -mpdebug
12277 @opindex mpdebug
12278 Enable CRIS-specific verbose debug-related information in the assembly
12279 code.  This option also has the effect of turning off the @samp{#NO_APP}
12280 formatted-code indicator to the assembler at the beginning of the
12281 assembly file.
12283 @item -mcc-init
12284 @opindex mcc-init
12285 Do not use condition-code results from previous instruction; always emit
12286 compare and test instructions before use of condition codes.
12288 @item -mno-side-effects
12289 @opindex mno-side-effects
12290 Do not emit instructions with side effects in addressing modes other than
12291 post-increment.
12293 @item -mstack-align
12294 @itemx -mno-stack-align
12295 @itemx -mdata-align
12296 @itemx -mno-data-align
12297 @itemx -mconst-align
12298 @itemx -mno-const-align
12299 @opindex mstack-align
12300 @opindex mno-stack-align
12301 @opindex mdata-align
12302 @opindex mno-data-align
12303 @opindex mconst-align
12304 @opindex mno-const-align
12305 These options (@samp{no-} options) arrange (eliminate arrangements) for the
12306 stack frame, individual data and constants to be aligned for the maximum
12307 single data access size for the chosen CPU model.  The default is to
12308 arrange for 32-bit alignment.  ABI details such as structure layout are
12309 not affected by these options.
12311 @item -m32-bit
12312 @itemx -m16-bit
12313 @itemx -m8-bit
12314 @opindex m32-bit
12315 @opindex m16-bit
12316 @opindex m8-bit
12317 Similar to the stack- data- and const-align options above, these options
12318 arrange for stack frame, writable data and constants to all be 32-bit,
12319 16-bit or 8-bit aligned.  The default is 32-bit alignment.
12321 @item -mno-prologue-epilogue
12322 @itemx -mprologue-epilogue
12323 @opindex mno-prologue-epilogue
12324 @opindex mprologue-epilogue
12325 With @option{-mno-prologue-epilogue}, the normal function prologue and
12326 epilogue which set up the stack frame are omitted and no return
12327 instructions or return sequences are generated in the code.  Use this
12328 option only together with visual inspection of the compiled code: no
12329 warnings or errors are generated when call-saved registers must be saved,
12330 or storage for local variables needs to be allocated.
12332 @item -mno-gotplt
12333 @itemx -mgotplt
12334 @opindex mno-gotplt
12335 @opindex mgotplt
12336 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
12337 instruction sequences that load addresses for functions from the PLT part
12338 of the GOT rather than (traditional on other architectures) calls to the
12339 PLT@.  The default is @option{-mgotplt}.
12341 @item -melf
12342 @opindex melf
12343 Legacy no-op option only recognized with the cris-axis-elf and
12344 cris-axis-linux-gnu targets.
12346 @item -mlinux
12347 @opindex mlinux
12348 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
12350 @item -sim
12351 @opindex sim
12352 This option, recognized for the cris-axis-elf, arranges
12353 to link with input-output functions from a simulator library.  Code,
12354 initialized data and zero-initialized data are allocated consecutively.
12356 @item -sim2
12357 @opindex sim2
12358 Like @option{-sim}, but pass linker options to locate initialized data at
12359 0x40000000 and zero-initialized data at 0x80000000.
12360 @end table
12362 @node CR16 Options
12363 @subsection CR16 Options
12364 @cindex CR16 Options
12366 These options are defined specifically for the CR16 ports.
12368 @table @gcctabopt
12370 @item -mmac
12371 @opindex mmac
12372 Enable the use of multiply-accumulate instructions. Disabled by default.
12374 @item -mcr16cplus
12375 @itemx -mcr16c
12376 @opindex mcr16cplus
12377 @opindex mcr16c
12378 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
12379 is default.
12381 @item -msim
12382 @opindex msim
12383 Links the library libsim.a which is in compatible with simulator. Applicable
12384 to ELF compiler only.
12386 @item -mint32
12387 @opindex mint32
12388 Choose integer type as 32-bit wide.
12390 @item -mbit-ops
12391 @opindex mbit-ops
12392 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
12394 @item -mdata-model=@var{model}
12395 @opindex mdata-model
12396 Choose a data model. The choices for @var{model} are @samp{near},
12397 @samp{far} or @samp{medium}. @samp{medium} is default.
12398 However, @samp{far} is not valid with @option{-mcr16c}, as the
12399 CR16C architecture does not support the far data model.
12400 @end table
12402 @node Darwin Options
12403 @subsection Darwin Options
12404 @cindex Darwin options
12406 These options are defined for all architectures running the Darwin operating
12407 system.
12409 FSF GCC on Darwin does not create ``fat'' object files; it creates
12410 an object file for the single architecture that GCC was built to
12411 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
12412 @option{-arch} options are used; it does so by running the compiler or
12413 linker multiple times and joining the results together with
12414 @file{lipo}.
12416 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
12417 @samp{i686}) is determined by the flags that specify the ISA
12418 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
12419 @option{-force_cpusubtype_ALL} option can be used to override this.
12421 The Darwin tools vary in their behavior when presented with an ISA
12422 mismatch.  The assembler, @file{as}, only permits instructions to
12423 be used that are valid for the subtype of the file it is generating,
12424 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
12425 The linker for shared libraries, @file{/usr/bin/libtool}, fails
12426 and prints an error if asked to create a shared library with a less
12427 restrictive subtype than its input files (for instance, trying to put
12428 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
12429 for executables, @command{ld}, quietly gives the executable the most
12430 restrictive subtype of any of its input files.
12432 @table @gcctabopt
12433 @item -F@var{dir}
12434 @opindex F
12435 Add the framework directory @var{dir} to the head of the list of
12436 directories to be searched for header files.  These directories are
12437 interleaved with those specified by @option{-I} options and are
12438 scanned in a left-to-right order.
12440 A framework directory is a directory with frameworks in it.  A
12441 framework is a directory with a @file{Headers} and/or
12442 @file{PrivateHeaders} directory contained directly in it that ends
12443 in @file{.framework}.  The name of a framework is the name of this
12444 directory excluding the @file{.framework}.  Headers associated with
12445 the framework are found in one of those two directories, with
12446 @file{Headers} being searched first.  A subframework is a framework
12447 directory that is in a framework's @file{Frameworks} directory.
12448 Includes of subframework headers can only appear in a header of a
12449 framework that contains the subframework, or in a sibling subframework
12450 header.  Two subframeworks are siblings if they occur in the same
12451 framework.  A subframework should not have the same name as a
12452 framework; a warning is issued if this is violated.  Currently a
12453 subframework cannot have subframeworks; in the future, the mechanism
12454 may be extended to support this.  The standard frameworks can be found
12455 in @file{/System/Library/Frameworks} and
12456 @file{/Library/Frameworks}.  An example include looks like
12457 @code{#include <Framework/header.h>}, where @file{Framework} denotes
12458 the name of the framework and @file{header.h} is found in the
12459 @file{PrivateHeaders} or @file{Headers} directory.
12461 @item -iframework@var{dir}
12462 @opindex iframework
12463 Like @option{-F} except the directory is a treated as a system
12464 directory.  The main difference between this @option{-iframework} and
12465 @option{-F} is that with @option{-iframework} the compiler does not
12466 warn about constructs contained within header files found via
12467 @var{dir}.  This option is valid only for the C family of languages.
12469 @item -gused
12470 @opindex gused
12471 Emit debugging information for symbols that are used.  For stabs
12472 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
12473 This is by default ON@.
12475 @item -gfull
12476 @opindex gfull
12477 Emit debugging information for all symbols and types.
12479 @item -mmacosx-version-min=@var{version}
12480 The earliest version of MacOS X that this executable will run on
12481 is @var{version}.  Typical values of @var{version} include @code{10.1},
12482 @code{10.2}, and @code{10.3.9}.
12484 If the compiler was built to use the system's headers by default,
12485 then the default for this option is the system version on which the
12486 compiler is running, otherwise the default is to make choices that
12487 are compatible with as many systems and code bases as possible.
12489 @item -mkernel
12490 @opindex mkernel
12491 Enable kernel development mode.  The @option{-mkernel} option sets
12492 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
12493 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
12494 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
12495 applicable.  This mode also sets @option{-mno-altivec},
12496 @option{-msoft-float}, @option{-fno-builtin} and
12497 @option{-mlong-branch} for PowerPC targets.
12499 @item -mone-byte-bool
12500 @opindex mone-byte-bool
12501 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
12502 By default @samp{sizeof(bool)} is @samp{4} when compiling for
12503 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
12504 option has no effect on x86.
12506 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
12507 to generate code that is not binary compatible with code generated
12508 without that switch.  Using this switch may require recompiling all
12509 other modules in a program, including system libraries.  Use this
12510 switch to conform to a non-default data model.
12512 @item -mfix-and-continue
12513 @itemx -ffix-and-continue
12514 @itemx -findirect-data
12515 @opindex mfix-and-continue
12516 @opindex ffix-and-continue
12517 @opindex findirect-data
12518 Generate code suitable for fast turnaround development, such as to
12519 allow GDB to dynamically load @code{.o} files into already-running
12520 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
12521 are provided for backwards compatibility.
12523 @item -all_load
12524 @opindex all_load
12525 Loads all members of static archive libraries.
12526 See man ld(1) for more information.
12528 @item -arch_errors_fatal
12529 @opindex arch_errors_fatal
12530 Cause the errors having to do with files that have the wrong architecture
12531 to be fatal.
12533 @item -bind_at_load
12534 @opindex bind_at_load
12535 Causes the output file to be marked such that the dynamic linker will
12536 bind all undefined references when the file is loaded or launched.
12538 @item -bundle
12539 @opindex bundle
12540 Produce a Mach-o bundle format file.
12541 See man ld(1) for more information.
12543 @item -bundle_loader @var{executable}
12544 @opindex bundle_loader
12545 This option specifies the @var{executable} that will load the build
12546 output file being linked.  See man ld(1) for more information.
12548 @item -dynamiclib
12549 @opindex dynamiclib
12550 When passed this option, GCC produces a dynamic library instead of
12551 an executable when linking, using the Darwin @file{libtool} command.
12553 @item -force_cpusubtype_ALL
12554 @opindex force_cpusubtype_ALL
12555 This causes GCC's output file to have the @var{ALL} subtype, instead of
12556 one controlled by the @option{-mcpu} or @option{-march} option.
12558 @item -allowable_client  @var{client_name}
12559 @itemx -client_name
12560 @itemx -compatibility_version
12561 @itemx -current_version
12562 @itemx -dead_strip
12563 @itemx -dependency-file
12564 @itemx -dylib_file
12565 @itemx -dylinker_install_name
12566 @itemx -dynamic
12567 @itemx -exported_symbols_list
12568 @itemx -filelist
12569 @need 800
12570 @itemx -flat_namespace
12571 @itemx -force_flat_namespace
12572 @itemx -headerpad_max_install_names
12573 @itemx -image_base
12574 @itemx -init
12575 @itemx -install_name
12576 @itemx -keep_private_externs
12577 @itemx -multi_module
12578 @itemx -multiply_defined
12579 @itemx -multiply_defined_unused
12580 @need 800
12581 @itemx -noall_load
12582 @itemx -no_dead_strip_inits_and_terms
12583 @itemx -nofixprebinding
12584 @itemx -nomultidefs
12585 @itemx -noprebind
12586 @itemx -noseglinkedit
12587 @itemx -pagezero_size
12588 @itemx -prebind
12589 @itemx -prebind_all_twolevel_modules
12590 @itemx -private_bundle
12591 @need 800
12592 @itemx -read_only_relocs
12593 @itemx -sectalign
12594 @itemx -sectobjectsymbols
12595 @itemx -whyload
12596 @itemx -seg1addr
12597 @itemx -sectcreate
12598 @itemx -sectobjectsymbols
12599 @itemx -sectorder
12600 @itemx -segaddr
12601 @itemx -segs_read_only_addr
12602 @need 800
12603 @itemx -segs_read_write_addr
12604 @itemx -seg_addr_table
12605 @itemx -seg_addr_table_filename
12606 @itemx -seglinkedit
12607 @itemx -segprot
12608 @itemx -segs_read_only_addr
12609 @itemx -segs_read_write_addr
12610 @itemx -single_module
12611 @itemx -static
12612 @itemx -sub_library
12613 @need 800
12614 @itemx -sub_umbrella
12615 @itemx -twolevel_namespace
12616 @itemx -umbrella
12617 @itemx -undefined
12618 @itemx -unexported_symbols_list
12619 @itemx -weak_reference_mismatches
12620 @itemx -whatsloaded
12621 @opindex allowable_client
12622 @opindex client_name
12623 @opindex compatibility_version
12624 @opindex current_version
12625 @opindex dead_strip
12626 @opindex dependency-file
12627 @opindex dylib_file
12628 @opindex dylinker_install_name
12629 @opindex dynamic
12630 @opindex exported_symbols_list
12631 @opindex filelist
12632 @opindex flat_namespace
12633 @opindex force_flat_namespace
12634 @opindex headerpad_max_install_names
12635 @opindex image_base
12636 @opindex init
12637 @opindex install_name
12638 @opindex keep_private_externs
12639 @opindex multi_module
12640 @opindex multiply_defined
12641 @opindex multiply_defined_unused
12642 @opindex noall_load
12643 @opindex no_dead_strip_inits_and_terms
12644 @opindex nofixprebinding
12645 @opindex nomultidefs
12646 @opindex noprebind
12647 @opindex noseglinkedit
12648 @opindex pagezero_size
12649 @opindex prebind
12650 @opindex prebind_all_twolevel_modules
12651 @opindex private_bundle
12652 @opindex read_only_relocs
12653 @opindex sectalign
12654 @opindex sectobjectsymbols
12655 @opindex whyload
12656 @opindex seg1addr
12657 @opindex sectcreate
12658 @opindex sectobjectsymbols
12659 @opindex sectorder
12660 @opindex segaddr
12661 @opindex segs_read_only_addr
12662 @opindex segs_read_write_addr
12663 @opindex seg_addr_table
12664 @opindex seg_addr_table_filename
12665 @opindex seglinkedit
12666 @opindex segprot
12667 @opindex segs_read_only_addr
12668 @opindex segs_read_write_addr
12669 @opindex single_module
12670 @opindex static
12671 @opindex sub_library
12672 @opindex sub_umbrella
12673 @opindex twolevel_namespace
12674 @opindex umbrella
12675 @opindex undefined
12676 @opindex unexported_symbols_list
12677 @opindex weak_reference_mismatches
12678 @opindex whatsloaded
12679 These options are passed to the Darwin linker.  The Darwin linker man page
12680 describes them in detail.
12681 @end table
12683 @node DEC Alpha Options
12684 @subsection DEC Alpha Options
12686 These @samp{-m} options are defined for the DEC Alpha implementations:
12688 @table @gcctabopt
12689 @item -mno-soft-float
12690 @itemx -msoft-float
12691 @opindex mno-soft-float
12692 @opindex msoft-float
12693 Use (do not use) the hardware floating-point instructions for
12694 floating-point operations.  When @option{-msoft-float} is specified,
12695 functions in @file{libgcc.a} are used to perform floating-point
12696 operations.  Unless they are replaced by routines that emulate the
12697 floating-point operations, or compiled in such a way as to call such
12698 emulations routines, these routines issue floating-point
12699 operations.   If you are compiling for an Alpha without floating-point
12700 operations, you must ensure that the library is built so as not to call
12701 them.
12703 Note that Alpha implementations without floating-point operations are
12704 required to have floating-point registers.
12706 @item -mfp-reg
12707 @itemx -mno-fp-regs
12708 @opindex mfp-reg
12709 @opindex mno-fp-regs
12710 Generate code that uses (does not use) the floating-point register set.
12711 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12712 register set is not used, floating-point operands are passed in integer
12713 registers as if they were integers and floating-point results are passed
12714 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12715 so any function with a floating-point argument or return value called by code
12716 compiled with @option{-mno-fp-regs} must also be compiled with that
12717 option.
12719 A typical use of this option is building a kernel that does not use,
12720 and hence need not save and restore, any floating-point registers.
12722 @item -mieee
12723 @opindex mieee
12724 The Alpha architecture implements floating-point hardware optimized for
12725 maximum performance.  It is mostly compliant with the IEEE floating-point
12726 standard.  However, for full compliance, software assistance is
12727 required.  This option generates code fully IEEE-compliant code
12728 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12729 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12730 defined during compilation.  The resulting code is less efficient but is
12731 able to correctly support denormalized numbers and exceptional IEEE
12732 values such as not-a-number and plus/minus infinity.  Other Alpha
12733 compilers call this option @option{-ieee_with_no_inexact}.
12735 @item -mieee-with-inexact
12736 @opindex mieee-with-inexact
12737 This is like @option{-mieee} except the generated code also maintains
12738 the IEEE @var{inexact-flag}.  Turning on this option causes the
12739 generated code to implement fully-compliant IEEE math.  In addition to
12740 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12741 macro.  On some Alpha implementations the resulting code may execute
12742 significantly slower than the code generated by default.  Since there is
12743 very little code that depends on the @var{inexact-flag}, you should
12744 normally not specify this option.  Other Alpha compilers call this
12745 option @option{-ieee_with_inexact}.
12747 @item -mfp-trap-mode=@var{trap-mode}
12748 @opindex mfp-trap-mode
12749 This option controls what floating-point related traps are enabled.
12750 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12751 The trap mode can be set to one of four values:
12753 @table @samp
12754 @item n
12755 This is the default (normal) setting.  The only traps that are enabled
12756 are the ones that cannot be disabled in software (e.g., division by zero
12757 trap).
12759 @item u
12760 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12761 as well.
12763 @item su
12764 Like @samp{u}, but the instructions are marked to be safe for software
12765 completion (see Alpha architecture manual for details).
12767 @item sui
12768 Like @samp{su}, but inexact traps are enabled as well.
12769 @end table
12771 @item -mfp-rounding-mode=@var{rounding-mode}
12772 @opindex mfp-rounding-mode
12773 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12774 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12777 @table @samp
12778 @item n
12779 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12780 the nearest machine number or towards the even machine number in case
12781 of a tie.
12783 @item m
12784 Round towards minus infinity.
12786 @item c
12787 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12789 @item d
12790 Dynamic rounding mode.  A field in the floating-point control register
12791 (@var{fpcr}, see Alpha architecture reference manual) controls the
12792 rounding mode in effect.  The C library initializes this register for
12793 rounding towards plus infinity.  Thus, unless your program modifies the
12794 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12795 @end table
12797 @item -mtrap-precision=@var{trap-precision}
12798 @opindex mtrap-precision
12799 In the Alpha architecture, floating-point traps are imprecise.  This
12800 means without software assistance it is impossible to recover from a
12801 floating trap and program execution normally needs to be terminated.
12802 GCC can generate code that can assist operating system trap handlers
12803 in determining the exact location that caused a floating-point trap.
12804 Depending on the requirements of an application, different levels of
12805 precisions can be selected:
12807 @table @samp
12808 @item p
12809 Program precision.  This option is the default and means a trap handler
12810 can only identify which program caused a floating-point exception.
12812 @item f
12813 Function precision.  The trap handler can determine the function that
12814 caused a floating-point exception.
12816 @item i
12817 Instruction precision.  The trap handler can determine the exact
12818 instruction that caused a floating-point exception.
12819 @end table
12821 Other Alpha compilers provide the equivalent options called
12822 @option{-scope_safe} and @option{-resumption_safe}.
12824 @item -mieee-conformant
12825 @opindex mieee-conformant
12826 This option marks the generated code as IEEE conformant.  You must not
12827 use this option unless you also specify @option{-mtrap-precision=i} and either
12828 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12829 is to emit the line @samp{.eflag 48} in the function prologue of the
12830 generated assembly file.
12832 @item -mbuild-constants
12833 @opindex mbuild-constants
12834 Normally GCC examines a 32- or 64-bit integer constant to
12835 see if it can construct it from smaller constants in two or three
12836 instructions.  If it cannot, it outputs the constant as a literal and
12837 generates code to load it from the data segment at run time.
12839 Use this option to require GCC to construct @emph{all} integer constants
12840 using code, even if it takes more instructions (the maximum is six).
12842 You typically use this option to build a shared library dynamic
12843 loader.  Itself a shared library, it must relocate itself in memory
12844 before it can find the variables and constants in its own data segment.
12846 @item -mbwx
12847 @itemx -mno-bwx
12848 @itemx -mcix
12849 @itemx -mno-cix
12850 @itemx -mfix
12851 @itemx -mno-fix
12852 @itemx -mmax
12853 @itemx -mno-max
12854 @opindex mbwx
12855 @opindex mno-bwx
12856 @opindex mcix
12857 @opindex mno-cix
12858 @opindex mfix
12859 @opindex mno-fix
12860 @opindex mmax
12861 @opindex mno-max
12862 Indicate whether GCC should generate code to use the optional BWX,
12863 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12864 sets supported by the CPU type specified via @option{-mcpu=} option or that
12865 of the CPU on which GCC was built if none is specified.
12867 @item -mfloat-vax
12868 @itemx -mfloat-ieee
12869 @opindex mfloat-vax
12870 @opindex mfloat-ieee
12871 Generate code that uses (does not use) VAX F and G floating-point
12872 arithmetic instead of IEEE single and double precision.
12874 @item -mexplicit-relocs
12875 @itemx -mno-explicit-relocs
12876 @opindex mexplicit-relocs
12877 @opindex mno-explicit-relocs
12878 Older Alpha assemblers provided no way to generate symbol relocations
12879 except via assembler macros.  Use of these macros does not allow
12880 optimal instruction scheduling.  GNU binutils as of version 2.12
12881 supports a new syntax that allows the compiler to explicitly mark
12882 which relocations should apply to which instructions.  This option
12883 is mostly useful for debugging, as GCC detects the capabilities of
12884 the assembler when it is built and sets the default accordingly.
12886 @item -msmall-data
12887 @itemx -mlarge-data
12888 @opindex msmall-data
12889 @opindex mlarge-data
12890 When @option{-mexplicit-relocs} is in effect, static data is
12891 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12892 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12893 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12894 16-bit relocations off of the @code{$gp} register.  This limits the
12895 size of the small data area to 64KB, but allows the variables to be
12896 directly accessed via a single instruction.
12898 The default is @option{-mlarge-data}.  With this option the data area
12899 is limited to just below 2GB@.  Programs that require more than 2GB of
12900 data must use @code{malloc} or @code{mmap} to allocate the data in the
12901 heap instead of in the program's data segment.
12903 When generating code for shared libraries, @option{-fpic} implies
12904 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12906 @item -msmall-text
12907 @itemx -mlarge-text
12908 @opindex msmall-text
12909 @opindex mlarge-text
12910 When @option{-msmall-text} is used, the compiler assumes that the
12911 code of the entire program (or shared library) fits in 4MB, and is
12912 thus reachable with a branch instruction.  When @option{-msmall-data}
12913 is used, the compiler can assume that all local symbols share the
12914 same @code{$gp} value, and thus reduce the number of instructions
12915 required for a function call from 4 to 1.
12917 The default is @option{-mlarge-text}.
12919 @item -mcpu=@var{cpu_type}
12920 @opindex mcpu
12921 Set the instruction set and instruction scheduling parameters for
12922 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12923 style name or the corresponding chip number.  GCC supports scheduling
12924 parameters for the EV4, EV5 and EV6 family of processors and
12925 chooses the default values for the instruction set from the processor
12926 you specify.  If you do not specify a processor type, GCC defaults
12927 to the processor on which the compiler was built.
12929 Supported values for @var{cpu_type} are
12931 @table @samp
12932 @item ev4
12933 @itemx ev45
12934 @itemx 21064
12935 Schedules as an EV4 and has no instruction set extensions.
12937 @item ev5
12938 @itemx 21164
12939 Schedules as an EV5 and has no instruction set extensions.
12941 @item ev56
12942 @itemx 21164a
12943 Schedules as an EV5 and supports the BWX extension.
12945 @item pca56
12946 @itemx 21164pc
12947 @itemx 21164PC
12948 Schedules as an EV5 and supports the BWX and MAX extensions.
12950 @item ev6
12951 @itemx 21264
12952 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12954 @item ev67
12955 @itemx 21264a
12956 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12957 @end table
12959 Native toolchains also support the value @samp{native},
12960 which selects the best architecture option for the host processor.
12961 @option{-mcpu=native} has no effect if GCC does not recognize
12962 the processor.
12964 @item -mtune=@var{cpu_type}
12965 @opindex mtune
12966 Set only the instruction scheduling parameters for machine type
12967 @var{cpu_type}.  The instruction set is not changed.
12969 Native toolchains also support the value @samp{native},
12970 which selects the best architecture option for the host processor.
12971 @option{-mtune=native} has no effect if GCC does not recognize
12972 the processor.
12974 @item -mmemory-latency=@var{time}
12975 @opindex mmemory-latency
12976 Sets the latency the scheduler should assume for typical memory
12977 references as seen by the application.  This number is highly
12978 dependent on the memory access patterns used by the application
12979 and the size of the external cache on the machine.
12981 Valid options for @var{time} are
12983 @table @samp
12984 @item @var{number}
12985 A decimal number representing clock cycles.
12987 @item L1
12988 @itemx L2
12989 @itemx L3
12990 @itemx main
12991 The compiler contains estimates of the number of clock cycles for
12992 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12993 (also called Dcache, Scache, and Bcache), as well as to main memory.
12994 Note that L3 is only valid for EV5.
12996 @end table
12997 @end table
12999 @node FR30 Options
13000 @subsection FR30 Options
13001 @cindex FR30 Options
13003 These options are defined specifically for the FR30 port.
13005 @table @gcctabopt
13007 @item -msmall-model
13008 @opindex msmall-model
13009 Use the small address space model.  This can produce smaller code, but
13010 it does assume that all symbolic values and addresses fit into a
13011 20-bit range.
13013 @item -mno-lsim
13014 @opindex mno-lsim
13015 Assume that runtime support has been provided and so there is no need
13016 to include the simulator library (@file{libsim.a}) on the linker
13017 command line.
13019 @end table
13021 @node FRV Options
13022 @subsection FRV Options
13023 @cindex FRV Options
13025 @table @gcctabopt
13026 @item -mgpr-32
13027 @opindex mgpr-32
13029 Only use the first 32 general-purpose registers.
13031 @item -mgpr-64
13032 @opindex mgpr-64
13034 Use all 64 general-purpose registers.
13036 @item -mfpr-32
13037 @opindex mfpr-32
13039 Use only the first 32 floating-point registers.
13041 @item -mfpr-64
13042 @opindex mfpr-64
13044 Use all 64 floating-point registers.
13046 @item -mhard-float
13047 @opindex mhard-float
13049 Use hardware instructions for floating-point operations.
13051 @item -msoft-float
13052 @opindex msoft-float
13054 Use library routines for floating-point operations.
13056 @item -malloc-cc
13057 @opindex malloc-cc
13059 Dynamically allocate condition code registers.
13061 @item -mfixed-cc
13062 @opindex mfixed-cc
13064 Do not try to dynamically allocate condition code registers, only
13065 use @code{icc0} and @code{fcc0}.
13067 @item -mdword
13068 @opindex mdword
13070 Change ABI to use double word insns.
13072 @item -mno-dword
13073 @opindex mno-dword
13075 Do not use double word instructions.
13077 @item -mdouble
13078 @opindex mdouble
13080 Use floating-point double instructions.
13082 @item -mno-double
13083 @opindex mno-double
13085 Do not use floating-point double instructions.
13087 @item -mmedia
13088 @opindex mmedia
13090 Use media instructions.
13092 @item -mno-media
13093 @opindex mno-media
13095 Do not use media instructions.
13097 @item -mmuladd
13098 @opindex mmuladd
13100 Use multiply and add/subtract instructions.
13102 @item -mno-muladd
13103 @opindex mno-muladd
13105 Do not use multiply and add/subtract instructions.
13107 @item -mfdpic
13108 @opindex mfdpic
13110 Select the FDPIC ABI, which uses function descriptors to represent
13111 pointers to functions.  Without any PIC/PIE-related options, it
13112 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
13113 assumes GOT entries and small data are within a 12-bit range from the
13114 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
13115 are computed with 32 bits.
13116 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13118 @item -minline-plt
13119 @opindex minline-plt
13121 Enable inlining of PLT entries in function calls to functions that are
13122 not known to bind locally.  It has no effect without @option{-mfdpic}.
13123 It's enabled by default if optimizing for speed and compiling for
13124 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
13125 optimization option such as @option{-O3} or above is present in the
13126 command line.
13128 @item -mTLS
13129 @opindex mTLS
13131 Assume a large TLS segment when generating thread-local code.
13133 @item -mtls
13134 @opindex mtls
13136 Do not assume a large TLS segment when generating thread-local code.
13138 @item -mgprel-ro
13139 @opindex mgprel-ro
13141 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
13142 that is known to be in read-only sections.  It's enabled by default,
13143 except for @option{-fpic} or @option{-fpie}: even though it may help
13144 make the global offset table smaller, it trades 1 instruction for 4.
13145 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
13146 one of which may be shared by multiple symbols, and it avoids the need
13147 for a GOT entry for the referenced symbol, so it's more likely to be a
13148 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
13150 @item -multilib-library-pic
13151 @opindex multilib-library-pic
13153 Link with the (library, not FD) pic libraries.  It's implied by
13154 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
13155 @option{-fpic} without @option{-mfdpic}.  You should never have to use
13156 it explicitly.
13158 @item -mlinked-fp
13159 @opindex mlinked-fp
13161 Follow the EABI requirement of always creating a frame pointer whenever
13162 a stack frame is allocated.  This option is enabled by default and can
13163 be disabled with @option{-mno-linked-fp}.
13165 @item -mlong-calls
13166 @opindex mlong-calls
13168 Use indirect addressing to call functions outside the current
13169 compilation unit.  This allows the functions to be placed anywhere
13170 within the 32-bit address space.
13172 @item -malign-labels
13173 @opindex malign-labels
13175 Try to align labels to an 8-byte boundary by inserting NOPs into the
13176 previous packet.  This option only has an effect when VLIW packing
13177 is enabled.  It doesn't create new packets; it merely adds NOPs to
13178 existing ones.
13180 @item -mlibrary-pic
13181 @opindex mlibrary-pic
13183 Generate position-independent EABI code.
13185 @item -macc-4
13186 @opindex macc-4
13188 Use only the first four media accumulator registers.
13190 @item -macc-8
13191 @opindex macc-8
13193 Use all eight media accumulator registers.
13195 @item -mpack
13196 @opindex mpack
13198 Pack VLIW instructions.
13200 @item -mno-pack
13201 @opindex mno-pack
13203 Do not pack VLIW instructions.
13205 @item -mno-eflags
13206 @opindex mno-eflags
13208 Do not mark ABI switches in e_flags.
13210 @item -mcond-move
13211 @opindex mcond-move
13213 Enable the use of conditional-move instructions (default).
13215 This switch is mainly for debugging the compiler and will likely be removed
13216 in a future version.
13218 @item -mno-cond-move
13219 @opindex mno-cond-move
13221 Disable the use of conditional-move instructions.
13223 This switch is mainly for debugging the compiler and will likely be removed
13224 in a future version.
13226 @item -mscc
13227 @opindex mscc
13229 Enable the use of conditional set instructions (default).
13231 This switch is mainly for debugging the compiler and will likely be removed
13232 in a future version.
13234 @item -mno-scc
13235 @opindex mno-scc
13237 Disable the use of conditional set instructions.
13239 This switch is mainly for debugging the compiler and will likely be removed
13240 in a future version.
13242 @item -mcond-exec
13243 @opindex mcond-exec
13245 Enable the use of conditional execution (default).
13247 This switch is mainly for debugging the compiler and will likely be removed
13248 in a future version.
13250 @item -mno-cond-exec
13251 @opindex mno-cond-exec
13253 Disable the use of conditional execution.
13255 This switch is mainly for debugging the compiler and will likely be removed
13256 in a future version.
13258 @item -mvliw-branch
13259 @opindex mvliw-branch
13261 Run a pass to pack branches into VLIW instructions (default).
13263 This switch is mainly for debugging the compiler and will likely be removed
13264 in a future version.
13266 @item -mno-vliw-branch
13267 @opindex mno-vliw-branch
13269 Do not run a pass to pack branches into VLIW instructions.
13271 This switch is mainly for debugging the compiler and will likely be removed
13272 in a future version.
13274 @item -mmulti-cond-exec
13275 @opindex mmulti-cond-exec
13277 Enable optimization of @code{&&} and @code{||} in conditional execution
13278 (default).
13280 This switch is mainly for debugging the compiler and will likely be removed
13281 in a future version.
13283 @item -mno-multi-cond-exec
13284 @opindex mno-multi-cond-exec
13286 Disable optimization of @code{&&} and @code{||} in conditional execution.
13288 This switch is mainly for debugging the compiler and will likely be removed
13289 in a future version.
13291 @item -mnested-cond-exec
13292 @opindex mnested-cond-exec
13294 Enable nested conditional execution optimizations (default).
13296 This switch is mainly for debugging the compiler and will likely be removed
13297 in a future version.
13299 @item -mno-nested-cond-exec
13300 @opindex mno-nested-cond-exec
13302 Disable nested conditional execution optimizations.
13304 This switch is mainly for debugging the compiler and will likely be removed
13305 in a future version.
13307 @item -moptimize-membar
13308 @opindex moptimize-membar
13310 This switch removes redundant @code{membar} instructions from the
13311 compiler-generated code.  It is enabled by default.
13313 @item -mno-optimize-membar
13314 @opindex mno-optimize-membar
13316 This switch disables the automatic removal of redundant @code{membar}
13317 instructions from the generated code.
13319 @item -mtomcat-stats
13320 @opindex mtomcat-stats
13322 Cause gas to print out tomcat statistics.
13324 @item -mcpu=@var{cpu}
13325 @opindex mcpu
13327 Select the processor type for which to generate code.  Possible values are
13328 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
13329 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
13331 @end table
13333 @node GNU/Linux Options
13334 @subsection GNU/Linux Options
13336 These @samp{-m} options are defined for GNU/Linux targets:
13338 @table @gcctabopt
13339 @item -mglibc
13340 @opindex mglibc
13341 Use the GNU C library.  This is the default except
13342 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
13344 @item -muclibc
13345 @opindex muclibc
13346 Use uClibc C library.  This is the default on
13347 @samp{*-*-linux-*uclibc*} targets.
13349 @item -mbionic
13350 @opindex mbionic
13351 Use Bionic C library.  This is the default on
13352 @samp{*-*-linux-*android*} targets.
13354 @item -mandroid
13355 @opindex mandroid
13356 Compile code compatible with Android platform.  This is the default on
13357 @samp{*-*-linux-*android*} targets.
13359 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
13360 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
13361 this option makes the GCC driver pass Android-specific options to the linker.
13362 Finally, this option causes the preprocessor macro @code{__ANDROID__}
13363 to be defined.
13365 @item -tno-android-cc
13366 @opindex tno-android-cc
13367 Disable compilation effects of @option{-mandroid}, i.e., do not enable
13368 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
13369 @option{-fno-rtti} by default.
13371 @item -tno-android-ld
13372 @opindex tno-android-ld
13373 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
13374 linking options to the linker.
13376 @end table
13378 @node H8/300 Options
13379 @subsection H8/300 Options
13381 These @samp{-m} options are defined for the H8/300 implementations:
13383 @table @gcctabopt
13384 @item -mrelax
13385 @opindex mrelax
13386 Shorten some address references at link time, when possible; uses the
13387 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
13388 ld, Using ld}, for a fuller description.
13390 @item -mh
13391 @opindex mh
13392 Generate code for the H8/300H@.
13394 @item -ms
13395 @opindex ms
13396 Generate code for the H8S@.
13398 @item -mn
13399 @opindex mn
13400 Generate code for the H8S and H8/300H in the normal mode.  This switch
13401 must be used either with @option{-mh} or @option{-ms}.
13403 @item -ms2600
13404 @opindex ms2600
13405 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
13407 @item -mexr
13408 @opindex mexr
13409 Extended registers are stored on stack before execution of function
13410 with monitor attribute. Default option is @option{-mexr}.
13411 This option is valid only for H8S targets.
13413 @item -mno-exr
13414 @opindex mno-exr
13415 Extended registers are not stored on stack before execution of function 
13416 with monitor attribute. Default option is @option{-mno-exr}. 
13417 This option is valid only for H8S targets.
13419 @item -mint32
13420 @opindex mint32
13421 Make @code{int} data 32 bits by default.
13423 @item -malign-300
13424 @opindex malign-300
13425 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
13426 The default for the H8/300H and H8S is to align longs and floats on
13427 4-byte boundaries.
13428 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
13429 This option has no effect on the H8/300.
13430 @end table
13432 @node HPPA Options
13433 @subsection HPPA Options
13434 @cindex HPPA Options
13436 These @samp{-m} options are defined for the HPPA family of computers:
13438 @table @gcctabopt
13439 @item -march=@var{architecture-type}
13440 @opindex march
13441 Generate code for the specified architecture.  The choices for
13442 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
13443 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
13444 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
13445 architecture option for your machine.  Code compiled for lower numbered
13446 architectures runs on higher numbered architectures, but not the
13447 other way around.
13449 @item -mpa-risc-1-0
13450 @itemx -mpa-risc-1-1
13451 @itemx -mpa-risc-2-0
13452 @opindex mpa-risc-1-0
13453 @opindex mpa-risc-1-1
13454 @opindex mpa-risc-2-0
13455 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
13457 @item -mbig-switch
13458 @opindex mbig-switch
13459 Generate code suitable for big switch tables.  Use this option only if
13460 the assembler/linker complain about out-of-range branches within a switch
13461 table.
13463 @item -mjump-in-delay
13464 @opindex mjump-in-delay
13465 Fill delay slots of function calls with unconditional jump instructions
13466 by modifying the return pointer for the function call to be the target
13467 of the conditional jump.
13469 @item -mdisable-fpregs
13470 @opindex mdisable-fpregs
13471 Prevent floating-point registers from being used in any manner.  This is
13472 necessary for compiling kernels that perform lazy context switching of
13473 floating-point registers.  If you use this option and attempt to perform
13474 floating-point operations, the compiler aborts.
13476 @item -mdisable-indexing
13477 @opindex mdisable-indexing
13478 Prevent the compiler from using indexing address modes.  This avoids some
13479 rather obscure problems when compiling MIG generated code under MACH@.
13481 @item -mno-space-regs
13482 @opindex mno-space-regs
13483 Generate code that assumes the target has no space registers.  This allows
13484 GCC to generate faster indirect calls and use unscaled index address modes.
13486 Such code is suitable for level 0 PA systems and kernels.
13488 @item -mfast-indirect-calls
13489 @opindex mfast-indirect-calls
13490 Generate code that assumes calls never cross space boundaries.  This
13491 allows GCC to emit code that performs faster indirect calls.
13493 This option does not work in the presence of shared libraries or nested
13494 functions.
13496 @item -mfixed-range=@var{register-range}
13497 @opindex mfixed-range
13498 Generate code treating the given register range as fixed registers.
13499 A fixed register is one that the register allocator cannot use.  This is
13500 useful when compiling kernel code.  A register range is specified as
13501 two registers separated by a dash.  Multiple register ranges can be
13502 specified separated by a comma.
13504 @item -mlong-load-store
13505 @opindex mlong-load-store
13506 Generate 3-instruction load and store sequences as sometimes required by
13507 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
13508 the HP compilers.
13510 @item -mportable-runtime
13511 @opindex mportable-runtime
13512 Use the portable calling conventions proposed by HP for ELF systems.
13514 @item -mgas
13515 @opindex mgas
13516 Enable the use of assembler directives only GAS understands.
13518 @item -mschedule=@var{cpu-type}
13519 @opindex mschedule
13520 Schedule code according to the constraints for the machine type
13521 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
13522 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
13523 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13524 proper scheduling option for your machine.  The default scheduling is
13525 @samp{8000}.
13527 @item -mlinker-opt
13528 @opindex mlinker-opt
13529 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
13530 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
13531 linkers in which they give bogus error messages when linking some programs.
13533 @item -msoft-float
13534 @opindex msoft-float
13535 Generate output containing library calls for floating point.
13536 @strong{Warning:} the requisite libraries are not available for all HPPA
13537 targets.  Normally the facilities of the machine's usual C compiler are
13538 used, but this cannot be done directly in cross-compilation.  You must make
13539 your own arrangements to provide suitable library functions for
13540 cross-compilation.
13542 @option{-msoft-float} changes the calling convention in the output file;
13543 therefore, it is only useful if you compile @emph{all} of a program with
13544 this option.  In particular, you need to compile @file{libgcc.a}, the
13545 library that comes with GCC, with @option{-msoft-float} in order for
13546 this to work.
13548 @item -msio
13549 @opindex msio
13550 Generate the predefine, @code{_SIO}, for server IO@.  The default is
13551 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
13552 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
13553 options are available under HP-UX and HI-UX@.
13555 @item -mgnu-ld
13556 @opindex mgnu-ld
13557 Use options specific to GNU @command{ld}.
13558 This passes @option{-shared} to @command{ld} when
13559 building a shared library.  It is the default when GCC is configured,
13560 explicitly or implicitly, with the GNU linker.  This option does not
13561 affect which @command{ld} is called; it only changes what parameters
13562 are passed to that @command{ld}.
13563 The @command{ld} that is called is determined by the
13564 @option{--with-ld} configure option, GCC's program search path, and
13565 finally by the user's @env{PATH}.  The linker used by GCC can be printed
13566 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
13567 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13569 @item -mhp-ld
13570 @opindex mhp-ld
13571 Use options specific to HP @command{ld}.
13572 This passes @option{-b} to @command{ld} when building
13573 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13574 links.  It is the default when GCC is configured, explicitly or
13575 implicitly, with the HP linker.  This option does not affect
13576 which @command{ld} is called; it only changes what parameters are passed to that
13577 @command{ld}.
13578 The @command{ld} that is called is determined by the @option{--with-ld}
13579 configure option, GCC's program search path, and finally by the user's
13580 @env{PATH}.  The linker used by GCC can be printed using @samp{which
13581 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
13582 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13584 @item -mlong-calls
13585 @opindex mno-long-calls
13586 Generate code that uses long call sequences.  This ensures that a call
13587 is always able to reach linker generated stubs.  The default is to generate
13588 long calls only when the distance from the call site to the beginning
13589 of the function or translation unit, as the case may be, exceeds a
13590 predefined limit set by the branch type being used.  The limits for
13591 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13592 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
13593 240,000 bytes.
13595 Distances are measured from the beginning of functions when using the
13596 @option{-ffunction-sections} option, or when using the @option{-mgas}
13597 and @option{-mno-portable-runtime} options together under HP-UX with
13598 the SOM linker.
13600 It is normally not desirable to use this option as it degrades
13601 performance.  However, it may be useful in large applications,
13602 particularly when partial linking is used to build the application.
13604 The types of long calls used depends on the capabilities of the
13605 assembler and linker, and the type of code being generated.  The
13606 impact on systems that support long absolute calls, and long pic
13607 symbol-difference or pc-relative calls should be relatively small.
13608 However, an indirect call is used on 32-bit ELF systems in pic code
13609 and it is quite long.
13611 @item -munix=@var{unix-std}
13612 @opindex march
13613 Generate compiler predefines and select a startfile for the specified
13614 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
13615 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13616 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13617 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13618 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13619 and later.
13621 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13622 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13623 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13624 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13625 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13626 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13628 It is @emph{important} to note that this option changes the interfaces
13629 for various library routines.  It also affects the operational behavior
13630 of the C library.  Thus, @emph{extreme} care is needed in using this
13631 option.
13633 Library code that is intended to operate with more than one UNIX
13634 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13635 as appropriate.  Most GNU software doesn't provide this capability.
13637 @item -nolibdld
13638 @opindex nolibdld
13639 Suppress the generation of link options to search libdld.sl when the
13640 @option{-static} option is specified on HP-UX 10 and later.
13642 @item -static
13643 @opindex static
13644 The HP-UX implementation of setlocale in libc has a dependency on
13645 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13646 when the @option{-static} option is specified, special link options
13647 are needed to resolve this dependency.
13649 On HP-UX 10 and later, the GCC driver adds the necessary options to
13650 link with libdld.sl when the @option{-static} option is specified.
13651 This causes the resulting binary to be dynamic.  On the 64-bit port,
13652 the linkers generate dynamic binaries by default in any case.  The
13653 @option{-nolibdld} option can be used to prevent the GCC driver from
13654 adding these link options.
13656 @item -threads
13657 @opindex threads
13658 Add support for multithreading with the @dfn{dce thread} library
13659 under HP-UX@.  This option sets flags for both the preprocessor and
13660 linker.
13661 @end table
13663 @node i386 and x86-64 Options
13664 @subsection Intel 386 and AMD x86-64 Options
13665 @cindex i386 Options
13666 @cindex x86-64 Options
13667 @cindex Intel 386 Options
13668 @cindex AMD x86-64 Options
13670 These @samp{-m} options are defined for the i386 and x86-64 family of
13671 computers:
13673 @table @gcctabopt
13675 @item -march=@var{cpu-type}
13676 @opindex march
13677 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13678 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13679 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13680 to generate code that may not run at all on processors other than the one
13681 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13682 @option{-mtune=@var{cpu-type}}.
13684 The choices for @var{cpu-type} are:
13686 @table @samp
13687 @item native
13688 This selects the CPU to generate code for at compilation time by determining
13689 the processor type of the compiling machine.  Using @option{-march=native}
13690 enables all instruction subsets supported by the local machine (hence
13691 the result might not run on different machines).  Using @option{-mtune=native}
13692 produces code optimized for the local machine under the constraints
13693 of the selected instruction set.  
13695 @item i386
13696 Original Intel i386 CPU@.
13698 @item i486
13699 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13701 @item i586
13702 @itemx pentium
13703 Intel Pentium CPU with no MMX support.
13705 @item pentium-mmx
13706 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13708 @item pentiumpro
13709 Intel Pentium Pro CPU@.
13711 @item i686
13712 When used with @option{-march}, the Pentium Pro
13713 instruction set is used, so the code runs on all i686 family chips.
13714 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13716 @item pentium2
13717 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13718 support.
13720 @item pentium3
13721 @itemx pentium3m
13722 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13723 set support.
13725 @item pentium-m
13726 Intel Pentium M; low-power version of Intel Pentium III CPU
13727 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13729 @item pentium4
13730 @itemx pentium4m
13731 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13733 @item prescott
13734 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13735 set support.
13737 @item nocona
13738 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13739 SSE2 and SSE3 instruction set support.
13741 @item core2
13742 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13743 instruction set support.
13745 @item corei7
13746 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13747 and SSE4.2 instruction set support.
13749 @item corei7-avx
13750 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13751 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13753 @item core-avx-i
13754 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13755 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13756 set support.
13758 @item core-avx2
13759 Intel Core CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
13760 SSE4.1, SSE4.2, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2
13761 and F16C instruction set support.
13763 @item atom
13764 Intel Atom CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
13765 instruction set support.
13767 @item k6
13768 AMD K6 CPU with MMX instruction set support.
13770 @item k6-2
13771 @itemx k6-3
13772 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13774 @item athlon
13775 @itemx athlon-tbird
13776 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13777 support.
13779 @item athlon-4
13780 @itemx athlon-xp
13781 @itemx athlon-mp
13782 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13783 instruction set support.
13785 @item k8
13786 @itemx opteron
13787 @itemx athlon64
13788 @itemx athlon-fx
13789 Processors based on the AMD K8 core with x86-64 instruction set support,
13790 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13791 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13792 instruction set extensions.)
13794 @item k8-sse3
13795 @itemx opteron-sse3
13796 @itemx athlon64-sse3
13797 Improved versions of AMD K8 cores with SSE3 instruction set support.
13799 @item amdfam10
13800 @itemx barcelona
13801 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13802 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13803 instruction set extensions.)
13805 @item bdver1
13806 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13807 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13808 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13809 @item bdver2
13810 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13811 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13812 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13813 extensions.)
13814 @item bdver3
13815 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13816 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13817 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13818 extensions.
13820 @item btver1
13821 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13822 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13823 instruction set extensions.)
13825 @item btver2
13826 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
13827 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
13828 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
13830 @item winchip-c6
13831 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13832 set support.
13834 @item winchip2
13835 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13836 instruction set support.
13838 @item c3
13839 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13840 implemented for this chip.)
13842 @item c3-2
13843 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13844 (No scheduling is
13845 implemented for this chip.)
13847 @item geode
13848 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13849 @end table
13851 @item -mtune=@var{cpu-type}
13852 @opindex mtune
13853 Tune to @var{cpu-type} everything applicable about the generated code, except
13854 for the ABI and the set of available instructions.  
13855 While picking a specific @var{cpu-type} schedules things appropriately
13856 for that particular chip, the compiler does not generate any code that
13857 cannot run on the default machine type unless you use a
13858 @option{-march=@var{cpu-type}} option.
13859 For example, if GCC is configured for i686-pc-linux-gnu
13860 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13861 but still runs on i686 machines.
13863 The choices for @var{cpu-type} are the same as for @option{-march}.
13864 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13866 @table @samp
13867 @item generic
13868 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13869 If you know the CPU on which your code will run, then you should use
13870 the corresponding @option{-mtune} or @option{-march} option instead of
13871 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13872 of your application will have, then you should use this option.
13874 As new processors are deployed in the marketplace, the behavior of this
13875 option will change.  Therefore, if you upgrade to a newer version of
13876 GCC, code generation controlled by this option will change to reflect
13877 the processors
13878 that are most common at the time that version of GCC is released.
13880 There is no @option{-march=generic} option because @option{-march}
13881 indicates the instruction set the compiler can use, and there is no
13882 generic instruction set applicable to all processors.  In contrast,
13883 @option{-mtune} indicates the processor (or, in this case, collection of
13884 processors) for which the code is optimized.
13885 @end table
13887 @item -mcpu=@var{cpu-type}
13888 @opindex mcpu
13889 A deprecated synonym for @option{-mtune}.
13891 @item -mfpmath=@var{unit}
13892 @opindex mfpmath
13893 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13894 for @var{unit} are:
13896 @table @samp
13897 @item 387
13898 Use the standard 387 floating-point coprocessor present on the majority of chips and
13899 emulated otherwise.  Code compiled with this option runs almost everywhere.
13900 The temporary results are computed in 80-bit precision instead of the precision
13901 specified by the type, resulting in slightly different results compared to most
13902 of other chips.  See @option{-ffloat-store} for more detailed description.
13904 This is the default choice for i386 compiler.
13906 @item sse
13907 Use scalar floating-point instructions present in the SSE instruction set.
13908 This instruction set is supported by Pentium III and newer chips,
13909 and in the AMD line
13910 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13911 instruction set supports only single-precision arithmetic, thus the double and
13912 extended-precision arithmetic are still done using 387.  A later version, present
13913 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13914 arithmetic too.
13916 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13917 or @option{-msse2} switches to enable SSE extensions and make this option
13918 effective.  For the x86-64 compiler, these extensions are enabled by default.
13920 The resulting code should be considerably faster in the majority of cases and avoid
13921 the numerical instability problems of 387 code, but may break some existing
13922 code that expects temporaries to be 80 bits.
13924 This is the default choice for the x86-64 compiler.
13926 @item sse,387
13927 @itemx sse+387
13928 @itemx both
13929 Attempt to utilize both instruction sets at once.  This effectively doubles the
13930 amount of available registers, and on chips with separate execution units for
13931 387 and SSE the execution resources too.  Use this option with care, as it is
13932 still experimental, because the GCC register allocator does not model separate
13933 functional units well, resulting in unstable performance.
13934 @end table
13936 @item -masm=@var{dialect}
13937 @opindex masm=@var{dialect}
13938 Output assembly instructions using selected @var{dialect}.  Supported
13939 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13940 not support @samp{intel}.
13942 @item -mieee-fp
13943 @itemx -mno-ieee-fp
13944 @opindex mieee-fp
13945 @opindex mno-ieee-fp
13946 Control whether or not the compiler uses IEEE floating-point
13947 comparisons.  These correctly handle the case where the result of a
13948 comparison is unordered.
13950 @item -msoft-float
13951 @opindex msoft-float
13952 Generate output containing library calls for floating point.
13954 @strong{Warning:} the requisite libraries are not part of GCC@.
13955 Normally the facilities of the machine's usual C compiler are used, but
13956 this can't be done directly in cross-compilation.  You must make your
13957 own arrangements to provide suitable library functions for
13958 cross-compilation.
13960 On machines where a function returns floating-point results in the 80387
13961 register stack, some floating-point opcodes may be emitted even if
13962 @option{-msoft-float} is used.
13964 @item -mno-fp-ret-in-387
13965 @opindex mno-fp-ret-in-387
13966 Do not use the FPU registers for return values of functions.
13968 The usual calling convention has functions return values of types
13969 @code{float} and @code{double} in an FPU register, even if there
13970 is no FPU@.  The idea is that the operating system should emulate
13971 an FPU@.
13973 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13974 in ordinary CPU registers instead.
13976 @item -mno-fancy-math-387
13977 @opindex mno-fancy-math-387
13978 Some 387 emulators do not support the @code{sin}, @code{cos} and
13979 @code{sqrt} instructions for the 387.  Specify this option to avoid
13980 generating those instructions.  This option is the default on FreeBSD,
13981 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13982 indicates that the target CPU always has an FPU and so the
13983 instruction does not need emulation.  These
13984 instructions are not generated unless you also use the
13985 @option{-funsafe-math-optimizations} switch.
13987 @item -malign-double
13988 @itemx -mno-align-double
13989 @opindex malign-double
13990 @opindex mno-align-double
13991 Control whether GCC aligns @code{double}, @code{long double}, and
13992 @code{long long} variables on a two-word boundary or a one-word
13993 boundary.  Aligning @code{double} variables on a two-word boundary
13994 produces code that runs somewhat faster on a Pentium at the
13995 expense of more memory.
13997 On x86-64, @option{-malign-double} is enabled by default.
13999 @strong{Warning:} if you use the @option{-malign-double} switch,
14000 structures containing the above types are aligned differently than
14001 the published application binary interface specifications for the 386
14002 and are not binary compatible with structures in code compiled
14003 without that switch.
14005 @item -m96bit-long-double
14006 @itemx -m128bit-long-double
14007 @opindex m96bit-long-double
14008 @opindex m128bit-long-double
14009 These switches control the size of @code{long double} type.  The i386
14010 application binary interface specifies the size to be 96 bits,
14011 so @option{-m96bit-long-double} is the default in 32-bit mode.
14013 Modern architectures (Pentium and newer) prefer @code{long double}
14014 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
14015 conforming to the ABI, this is not possible.  So specifying
14016 @option{-m128bit-long-double} aligns @code{long double}
14017 to a 16-byte boundary by padding the @code{long double} with an additional
14018 32-bit zero.
14020 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
14021 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
14023 Notice that neither of these options enable any extra precision over the x87
14024 standard of 80 bits for a @code{long double}.
14026 @strong{Warning:} if you override the default value for your target ABI, this
14027 changes the size of 
14028 structures and arrays containing @code{long double} variables,
14029 as well as modifying the function calling convention for functions taking
14030 @code{long double}.  Hence they are not binary-compatible
14031 with code compiled without that switch.
14033 @item -mlong-double-64
14034 @itemx -mlong-double-80
14035 @opindex mlong-double-64
14036 @opindex mlong-double-80
14037 These switches control the size of @code{long double} type. A size
14038 of 64 bits makes the @code{long double} type equivalent to the @code{double}
14039 type. This is the default for Bionic C library.
14041 @strong{Warning:} if you override the default value for your target ABI, this
14042 changes the size of
14043 structures and arrays containing @code{long double} variables,
14044 as well as modifying the function calling convention for functions taking
14045 @code{long double}.  Hence they are not binary-compatible
14046 with code compiled without that switch.
14048 @item -mlarge-data-threshold=@var{threshold}
14049 @opindex mlarge-data-threshold
14050 When @option{-mcmodel=medium} is specified, data objects larger than
14051 @var{threshold} are placed in the large data section.  This value must be the
14052 same across all objects linked into the binary, and defaults to 65535.
14054 @item -mrtd
14055 @opindex mrtd
14056 Use a different function-calling convention, in which functions that
14057 take a fixed number of arguments return with the @code{ret @var{num}}
14058 instruction, which pops their arguments while returning.  This saves one
14059 instruction in the caller since there is no need to pop the arguments
14060 there.
14062 You can specify that an individual function is called with this calling
14063 sequence with the function attribute @samp{stdcall}.  You can also
14064 override the @option{-mrtd} option by using the function attribute
14065 @samp{cdecl}.  @xref{Function Attributes}.
14067 @strong{Warning:} this calling convention is incompatible with the one
14068 normally used on Unix, so you cannot use it if you need to call
14069 libraries compiled with the Unix compiler.
14071 Also, you must provide function prototypes for all functions that
14072 take variable numbers of arguments (including @code{printf});
14073 otherwise incorrect code is generated for calls to those
14074 functions.
14076 In addition, seriously incorrect code results if you call a
14077 function with too many arguments.  (Normally, extra arguments are
14078 harmlessly ignored.)
14080 @item -mregparm=@var{num}
14081 @opindex mregparm
14082 Control how many registers are used to pass integer arguments.  By
14083 default, no registers are used to pass arguments, and at most 3
14084 registers can be used.  You can control this behavior for a specific
14085 function by using the function attribute @samp{regparm}.
14086 @xref{Function Attributes}.
14088 @strong{Warning:} if you use this switch, and
14089 @var{num} is nonzero, then you must build all modules with the same
14090 value, including any libraries.  This includes the system libraries and
14091 startup modules.
14093 @item -msseregparm
14094 @opindex msseregparm
14095 Use SSE register passing conventions for float and double arguments
14096 and return values.  You can control this behavior for a specific
14097 function by using the function attribute @samp{sseregparm}.
14098 @xref{Function Attributes}.
14100 @strong{Warning:} if you use this switch then you must build all
14101 modules with the same value, including any libraries.  This includes
14102 the system libraries and startup modules.
14104 @item -mvect8-ret-in-mem
14105 @opindex mvect8-ret-in-mem
14106 Return 8-byte vectors in memory instead of MMX registers.  This is the
14107 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
14108 Studio compilers until version 12.  Later compiler versions (starting
14109 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
14110 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
14111 you need to remain compatible with existing code produced by those
14112 previous compiler versions or older versions of GCC@.
14114 @item -mpc32
14115 @itemx -mpc64
14116 @itemx -mpc80
14117 @opindex mpc32
14118 @opindex mpc64
14119 @opindex mpc80
14121 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
14122 is specified, the significands of results of floating-point operations are
14123 rounded to 24 bits (single precision); @option{-mpc64} rounds the
14124 significands of results of floating-point operations to 53 bits (double
14125 precision) and @option{-mpc80} rounds the significands of results of
14126 floating-point operations to 64 bits (extended double precision), which is
14127 the default.  When this option is used, floating-point operations in higher
14128 precisions are not available to the programmer without setting the FPU
14129 control word explicitly.
14131 Setting the rounding of floating-point operations to less than the default
14132 80 bits can speed some programs by 2% or more.  Note that some mathematical
14133 libraries assume that extended-precision (80-bit) floating-point operations
14134 are enabled by default; routines in such libraries could suffer significant
14135 loss of accuracy, typically through so-called ``catastrophic cancellation'',
14136 when this option is used to set the precision to less than extended precision.
14138 @item -mstackrealign
14139 @opindex mstackrealign
14140 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
14141 option generates an alternate prologue and epilogue that realigns the
14142 run-time stack if necessary.  This supports mixing legacy codes that keep
14143 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
14144 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
14145 applicable to individual functions.
14147 @item -mpreferred-stack-boundary=@var{num}
14148 @opindex mpreferred-stack-boundary
14149 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
14150 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
14151 the default is 4 (16 bytes or 128 bits).
14153 @strong{Warning:} When generating code for the x86-64 architecture with
14154 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
14155 used to keep the stack boundary aligned to 8 byte boundary.  Since
14156 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
14157 intended to be used in controlled environment where stack space is
14158 important limitation.  This option will lead to wrong code when functions
14159 compiled with 16 byte stack alignment (such as functions from a standard
14160 library) are called with misaligned stack.  In this case, SSE
14161 instructions may lead to misaligned memory access traps.  In addition,
14162 variable arguments will be handled incorrectly for 16 byte aligned
14163 objects (including x87 long double and __int128), leading to wrong
14164 results.  You must build all modules with
14165 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
14166 includes the system libraries and startup modules.
14168 @item -mincoming-stack-boundary=@var{num}
14169 @opindex mincoming-stack-boundary
14170 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
14171 boundary.  If @option{-mincoming-stack-boundary} is not specified,
14172 the one specified by @option{-mpreferred-stack-boundary} is used.
14174 On Pentium and Pentium Pro, @code{double} and @code{long double} values
14175 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
14176 suffer significant run time performance penalties.  On Pentium III, the
14177 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
14178 properly if it is not 16-byte aligned.
14180 To ensure proper alignment of this values on the stack, the stack boundary
14181 must be as aligned as that required by any value stored on the stack.
14182 Further, every function must be generated such that it keeps the stack
14183 aligned.  Thus calling a function compiled with a higher preferred
14184 stack boundary from a function compiled with a lower preferred stack
14185 boundary most likely misaligns the stack.  It is recommended that
14186 libraries that use callbacks always use the default setting.
14188 This extra alignment does consume extra stack space, and generally
14189 increases code size.  Code that is sensitive to stack space usage, such
14190 as embedded systems and operating system kernels, may want to reduce the
14191 preferred alignment to @option{-mpreferred-stack-boundary=2}.
14193 @item -mmmx
14194 @itemx -mno-mmx
14195 @itemx -msse
14196 @itemx -mno-sse
14197 @itemx -msse2
14198 @itemx -mno-sse2
14199 @itemx -msse3
14200 @itemx -mno-sse3
14201 @itemx -mssse3
14202 @itemx -mno-ssse3
14203 @itemx -msse4.1
14204 @need 800
14205 @itemx -mno-sse4.1
14206 @itemx -msse4.2
14207 @itemx -mno-sse4.2
14208 @itemx -msse4
14209 @itemx -mno-sse4
14210 @itemx -mavx
14211 @itemx -mno-avx
14212 @itemx -mavx2
14213 @itemx -mno-avx2
14214 @itemx -maes
14215 @itemx -mno-aes
14216 @itemx -mpclmul
14217 @need 800
14218 @itemx -mno-pclmul
14219 @itemx -mfsgsbase
14220 @itemx -mno-fsgsbase
14221 @itemx -mrdrnd
14222 @itemx -mno-rdrnd
14223 @itemx -mf16c
14224 @itemx -mno-f16c
14225 @itemx -mfma
14226 @itemx -mno-fma
14227 @itemx -msse4a
14228 @itemx -mno-sse4a
14229 @itemx -mfma4
14230 @need 800
14231 @itemx -mno-fma4
14232 @itemx -mxop
14233 @itemx -mno-xop
14234 @itemx -mlwp
14235 @itemx -mno-lwp
14236 @itemx -m3dnow
14237 @itemx -mno-3dnow
14238 @itemx -mpopcnt
14239 @itemx -mno-popcnt
14240 @itemx -mabm
14241 @itemx -mno-abm
14242 @itemx -mbmi
14243 @itemx -mbmi2
14244 @itemx -mno-bmi
14245 @itemx -mno-bmi2
14246 @itemx -mlzcnt
14247 @itemx -mno-lzcnt
14248 @itemx -mrtm
14249 @itemx -mtbm
14250 @itemx -mno-tbm
14251 @opindex mmmx
14252 @opindex mno-mmx
14253 @opindex msse
14254 @opindex mno-sse
14255 @opindex m3dnow
14256 @opindex mno-3dnow
14257 These switches enable or disable the use of instructions in the MMX, SSE,
14258 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
14259 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
14260 extended instruction sets.
14261 These extensions are also available as built-in functions: see
14262 @ref{X86 Built-in Functions}, for details of the functions enabled and
14263 disabled by these switches.
14265 To generate SSE/SSE2 instructions automatically from floating-point
14266 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
14268 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
14269 generates new AVX instructions or AVX equivalence for all SSEx instructions
14270 when needed.
14272 These options enable GCC to use these extended instructions in
14273 generated code, even without @option{-mfpmath=sse}.  Applications that
14274 perform run-time CPU detection must compile separate files for each
14275 supported architecture, using the appropriate flags.  In particular,
14276 the file containing the CPU detection code should be compiled without
14277 these options.
14279 @item -mcld
14280 @opindex mcld
14281 This option instructs GCC to emit a @code{cld} instruction in the prologue
14282 of functions that use string instructions.  String instructions depend on
14283 the DF flag to select between autoincrement or autodecrement mode.  While the
14284 ABI specifies the DF flag to be cleared on function entry, some operating
14285 systems violate this specification by not clearing the DF flag in their
14286 exception dispatchers.  The exception handler can be invoked with the DF flag
14287 set, which leads to wrong direction mode when string instructions are used.
14288 This option can be enabled by default on 32-bit x86 targets by configuring
14289 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
14290 instructions can be suppressed with the @option{-mno-cld} compiler option
14291 in this case.
14293 @item -mvzeroupper
14294 @opindex mvzeroupper
14295 This option instructs GCC to emit a @code{vzeroupper} instruction
14296 before a transfer of control flow out of the function to minimize
14297 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
14298 intrinsics.
14300 @item -mprefer-avx128
14301 @opindex mprefer-avx128
14302 This option instructs GCC to use 128-bit AVX instructions instead of
14303 256-bit AVX instructions in the auto-vectorizer.
14305 @item -mcx16
14306 @opindex mcx16
14307 This option enables GCC to generate @code{CMPXCHG16B} instructions.
14308 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
14309 (or oword) data types.  
14310 This is useful for high-resolution counters that can be updated
14311 by multiple processors (or cores).  This instruction is generated as part of
14312 atomic built-in functions: see @ref{__sync Builtins} or
14313 @ref{__atomic Builtins} for details.
14315 @item -msahf
14316 @opindex msahf
14317 This option enables generation of @code{SAHF} instructions in 64-bit code.
14318 Early Intel Pentium 4 CPUs with Intel 64 support,
14319 prior to the introduction of Pentium 4 G1 step in December 2005,
14320 lacked the @code{LAHF} and @code{SAHF} instructions
14321 which were supported by AMD64.
14322 These are load and store instructions, respectively, for certain status flags.
14323 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
14324 @code{drem}, and @code{remainder} built-in functions;
14325 see @ref{Other Builtins} for details.
14327 @item -mmovbe
14328 @opindex mmovbe
14329 This option enables use of the @code{movbe} instruction to implement
14330 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
14332 @item -mcrc32
14333 @opindex mcrc32
14334 This option enables built-in functions @code{__builtin_ia32_crc32qi},
14335 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
14336 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
14338 @item -mrecip
14339 @opindex mrecip
14340 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
14341 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
14342 with an additional Newton-Raphson step
14343 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
14344 (and their vectorized
14345 variants) for single-precision floating-point arguments.  These instructions
14346 are generated only when @option{-funsafe-math-optimizations} is enabled
14347 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
14348 Note that while the throughput of the sequence is higher than the throughput
14349 of the non-reciprocal instruction, the precision of the sequence can be
14350 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
14352 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
14353 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
14354 combination), and doesn't need @option{-mrecip}.
14356 Also note that GCC emits the above sequence with additional Newton-Raphson step
14357 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
14358 already with @option{-ffast-math} (or the above option combination), and
14359 doesn't need @option{-mrecip}.
14361 @item -mrecip=@var{opt}
14362 @opindex mrecip=opt
14363 This option controls which reciprocal estimate instructions
14364 may be used.  @var{opt} is a comma-separated list of options, which may
14365 be preceded by a @samp{!} to invert the option:
14367 @table @samp
14368 @item all
14369 Enable all estimate instructions.
14371 @item default
14372 Enable the default instructions, equivalent to @option{-mrecip}.
14374 @item none
14375 Disable all estimate instructions, equivalent to @option{-mno-recip}.
14377 @item div
14378 Enable the approximation for scalar division.
14380 @item vec-div
14381 Enable the approximation for vectorized division.
14383 @item sqrt
14384 Enable the approximation for scalar square root.
14386 @item vec-sqrt
14387 Enable the approximation for vectorized square root.
14388 @end table
14390 So, for example, @option{-mrecip=all,!sqrt} enables
14391 all of the reciprocal approximations, except for square root.
14393 @item -mveclibabi=@var{type}
14394 @opindex mveclibabi
14395 Specifies the ABI type to use for vectorizing intrinsics using an
14396 external library.  Supported values for @var{type} are @samp{svml} 
14397 for the Intel short
14398 vector math library and @samp{acml} for the AMD math core library.
14399 To use this option, both @option{-ftree-vectorize} and
14400 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
14401 ABI-compatible library must be specified at link time.
14403 GCC currently emits calls to @code{vmldExp2},
14404 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
14405 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
14406 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
14407 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
14408 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
14409 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
14410 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
14411 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
14412 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
14413 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
14414 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
14415 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
14416 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
14417 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
14418 when @option{-mveclibabi=acml} is used.  
14420 @item -mabi=@var{name}
14421 @opindex mabi
14422 Generate code for the specified calling convention.  Permissible values
14423 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
14424 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
14425 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
14426 You can control this behavior for a specific function by
14427 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
14428 @xref{Function Attributes}.
14430 @item -mtls-dialect=@var{type}
14431 @opindex mtls-dialect
14432 Generate code to access thread-local storage using the @samp{gnu} or
14433 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
14434 @samp{gnu2} is more efficient, but it may add compile- and run-time
14435 requirements that cannot be satisfied on all systems.
14437 @item -mpush-args
14438 @itemx -mno-push-args
14439 @opindex mpush-args
14440 @opindex mno-push-args
14441 Use PUSH operations to store outgoing parameters.  This method is shorter
14442 and usually equally fast as method using SUB/MOV operations and is enabled
14443 by default.  In some cases disabling it may improve performance because of
14444 improved scheduling and reduced dependencies.
14446 @item -maccumulate-outgoing-args
14447 @opindex maccumulate-outgoing-args
14448 If enabled, the maximum amount of space required for outgoing arguments is
14449 computed in the function prologue.  This is faster on most modern CPUs
14450 because of reduced dependencies, improved scheduling and reduced stack usage
14451 when the preferred stack boundary is not equal to 2.  The drawback is a notable
14452 increase in code size.  This switch implies @option{-mno-push-args}.
14454 @item -mthreads
14455 @opindex mthreads
14456 Support thread-safe exception handling on MinGW.  Programs that rely
14457 on thread-safe exception handling must compile and link all code with the
14458 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
14459 @code{-D_MT}; when linking, it links in a special thread helper library
14460 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
14462 @item -mno-align-stringops
14463 @opindex mno-align-stringops
14464 Do not align the destination of inlined string operations.  This switch reduces
14465 code size and improves performance in case the destination is already aligned,
14466 but GCC doesn't know about it.
14468 @item -minline-all-stringops
14469 @opindex minline-all-stringops
14470 By default GCC inlines string operations only when the destination is 
14471 known to be aligned to least a 4-byte boundary.  
14472 This enables more inlining and increases code
14473 size, but may improve performance of code that depends on fast
14474 @code{memcpy}, @code{strlen},
14475 and @code{memset} for short lengths.
14477 @item -minline-stringops-dynamically
14478 @opindex minline-stringops-dynamically
14479 For string operations of unknown size, use run-time checks with
14480 inline code for small blocks and a library call for large blocks.
14482 @item -mstringop-strategy=@var{alg}
14483 @opindex mstringop-strategy=@var{alg}
14484 Override the internal decision heuristic for the particular algorithm to use
14485 for inlining string operations.  The allowed values for @var{alg} are:
14487 @table @samp
14488 @item rep_byte
14489 @itemx rep_4byte
14490 @itemx rep_8byte
14491 Expand using i386 @code{rep} prefix of the specified size.
14493 @item byte_loop
14494 @itemx loop
14495 @itemx unrolled_loop
14496 Expand into an inline loop.
14498 @item libcall
14499 Always use a library call.
14500 @end table
14502 @item -momit-leaf-frame-pointer
14503 @opindex momit-leaf-frame-pointer
14504 Don't keep the frame pointer in a register for leaf functions.  This
14505 avoids the instructions to save, set up, and restore frame pointers and
14506 makes an extra register available in leaf functions.  The option
14507 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
14508 which might make debugging harder.
14510 @item -mtls-direct-seg-refs
14511 @itemx -mno-tls-direct-seg-refs
14512 @opindex mtls-direct-seg-refs
14513 Controls whether TLS variables may be accessed with offsets from the
14514 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
14515 or whether the thread base pointer must be added.  Whether or not this
14516 is valid depends on the operating system, and whether it maps the
14517 segment to cover the entire TLS area.
14519 For systems that use the GNU C Library, the default is on.
14521 @item -msse2avx
14522 @itemx -mno-sse2avx
14523 @opindex msse2avx
14524 Specify that the assembler should encode SSE instructions with VEX
14525 prefix.  The option @option{-mavx} turns this on by default.
14527 @item -mfentry
14528 @itemx -mno-fentry
14529 @opindex mfentry
14530 If profiling is active (@option{-pg}), put the profiling
14531 counter call before the prologue.
14532 Note: On x86 architectures the attribute @code{ms_hook_prologue}
14533 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
14535 @item -mskip-rax-setup
14536 @itemx -mno-skip-rax-setup
14537 @opindex mskip-rax-setup
14538 When generating code for the x86-64 architecture with SSE extensions
14539 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
14540 register when there are no variable arguments passed in vector registers.
14542 @strong{Warning:} Since RAX register is used to avoid unnecessarily
14543 saving vector registers on stack when passing variable arguments, the
14544 impacts of this option are callees may waste some stack space,
14545 misbehave or jump to a random location.  GCC 4.4 or newer don't have
14546 those issues, regardless the RAX register value.
14548 @item -m8bit-idiv
14549 @itemx -mno-8bit-idiv
14550 @opindex 8bit-idiv
14551 On some processors, like Intel Atom, 8-bit unsigned integer divide is
14552 much faster than 32-bit/64-bit integer divide.  This option generates a
14553 run-time check.  If both dividend and divisor are within range of 0
14554 to 255, 8-bit unsigned integer divide is used instead of
14555 32-bit/64-bit integer divide.
14557 @item -mavx256-split-unaligned-load
14558 @itemx -mavx256-split-unaligned-store
14559 @opindex avx256-split-unaligned-load
14560 @opindex avx256-split-unaligned-store
14561 Split 32-byte AVX unaligned load and store.
14563 @end table
14565 These @samp{-m} switches are supported in addition to the above
14566 on x86-64 processors in 64-bit environments.
14568 @table @gcctabopt
14569 @item -m32
14570 @itemx -m64
14571 @itemx -mx32
14572 @opindex m32
14573 @opindex m64
14574 @opindex mx32
14575 Generate code for a 32-bit or 64-bit environment.
14576 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14577 to 32 bits, and
14578 generates code that runs on any i386 system.
14580 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14581 types to 64 bits, and generates code for the x86-64 architecture.
14582 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14583 and @option{-mdynamic-no-pic} options.
14585 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14586 to 32 bits, and
14587 generates code for the x86-64 architecture.
14589 @item -mno-red-zone
14590 @opindex mno-red-zone
14591 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
14592 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14593 stack pointer that is not modified by signal or interrupt handlers
14594 and therefore can be used for temporary data without adjusting the stack
14595 pointer.  The flag @option{-mno-red-zone} disables this red zone.
14597 @item -mcmodel=small
14598 @opindex mcmodel=small
14599 Generate code for the small code model: the program and its symbols must
14600 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
14601 Programs can be statically or dynamically linked.  This is the default
14602 code model.
14604 @item -mcmodel=kernel
14605 @opindex mcmodel=kernel
14606 Generate code for the kernel code model.  The kernel runs in the
14607 negative 2 GB of the address space.
14608 This model has to be used for Linux kernel code.
14610 @item -mcmodel=medium
14611 @opindex mcmodel=medium
14612 Generate code for the medium model: the program is linked in the lower 2
14613 GB of the address space.  Small symbols are also placed there.  Symbols
14614 with sizes larger than @option{-mlarge-data-threshold} are put into
14615 large data or BSS sections and can be located above 2GB.  Programs can
14616 be statically or dynamically linked.
14618 @item -mcmodel=large
14619 @opindex mcmodel=large
14620 Generate code for the large model.  This model makes no assumptions
14621 about addresses and sizes of sections.
14623 @item -maddress-mode=long
14624 @opindex maddress-mode=long
14625 Generate code for long address mode.  This is only supported for 64-bit
14626 and x32 environments.  It is the default address mode for 64-bit
14627 environments.
14629 @item -maddress-mode=short
14630 @opindex maddress-mode=short
14631 Generate code for short address mode.  This is only supported for 32-bit
14632 and x32 environments.  It is the default address mode for 32-bit and
14633 x32 environments.
14634 @end table
14636 @node i386 and x86-64 Windows Options
14637 @subsection i386 and x86-64 Windows Options
14638 @cindex i386 and x86-64 Windows Options
14640 These additional options are available for Microsoft Windows targets:
14642 @table @gcctabopt
14643 @item -mconsole
14644 @opindex mconsole
14645 This option
14646 specifies that a console application is to be generated, by
14647 instructing the linker to set the PE header subsystem type
14648 required for console applications.
14649 This option is available for Cygwin and MinGW targets and is
14650 enabled by default on those targets.
14652 @item -mdll
14653 @opindex mdll
14654 This option is available for Cygwin and MinGW targets.  It
14655 specifies that a DLL---a dynamic link library---is to be
14656 generated, enabling the selection of the required runtime
14657 startup object and entry point.
14659 @item -mnop-fun-dllimport
14660 @opindex mnop-fun-dllimport
14661 This option is available for Cygwin and MinGW targets.  It
14662 specifies that the @code{dllimport} attribute should be ignored.
14664 @item -mthread
14665 @opindex mthread
14666 This option is available for MinGW targets. It specifies
14667 that MinGW-specific thread support is to be used.
14669 @item -municode
14670 @opindex municode
14671 This option is available for MinGW-w64 targets.  It causes
14672 the @code{UNICODE} preprocessor macro to be predefined, and
14673 chooses Unicode-capable runtime startup code.
14675 @item -mwin32
14676 @opindex mwin32
14677 This option is available for Cygwin and MinGW targets.  It
14678 specifies that the typical Microsoft Windows predefined macros are to
14679 be set in the pre-processor, but does not influence the choice
14680 of runtime library/startup code.
14682 @item -mwindows
14683 @opindex mwindows
14684 This option is available for Cygwin and MinGW targets.  It
14685 specifies that a GUI application is to be generated by
14686 instructing the linker to set the PE header subsystem type
14687 appropriately.
14689 @item -fno-set-stack-executable
14690 @opindex fno-set-stack-executable
14691 This option is available for MinGW targets. It specifies that
14692 the executable flag for the stack used by nested functions isn't
14693 set. This is necessary for binaries running in kernel mode of
14694 Microsoft Windows, as there the User32 API, which is used to set executable
14695 privileges, isn't available.
14697 @item -fwritable-relocated-rdata
14698 @opindex fno-writable-relocated-rdata
14699 This option is available for MinGW and Cygwin targets.  It specifies
14700 that relocated-data in read-only section is put into .data
14701 section.  This is a necessary for older runtimes not supporting
14702 modification of .rdata sections for pseudo-relocation.
14704 @item -mpe-aligned-commons
14705 @opindex mpe-aligned-commons
14706 This option is available for Cygwin and MinGW targets.  It
14707 specifies that the GNU extension to the PE file format that
14708 permits the correct alignment of COMMON variables should be
14709 used when generating code.  It is enabled by default if
14710 GCC detects that the target assembler found during configuration
14711 supports the feature.
14712 @end table
14714 See also under @ref{i386 and x86-64 Options} for standard options.
14716 @node IA-64 Options
14717 @subsection IA-64 Options
14718 @cindex IA-64 Options
14720 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14722 @table @gcctabopt
14723 @item -mbig-endian
14724 @opindex mbig-endian
14725 Generate code for a big-endian target.  This is the default for HP-UX@.
14727 @item -mlittle-endian
14728 @opindex mlittle-endian
14729 Generate code for a little-endian target.  This is the default for AIX5
14730 and GNU/Linux.
14732 @item -mgnu-as
14733 @itemx -mno-gnu-as
14734 @opindex mgnu-as
14735 @opindex mno-gnu-as
14736 Generate (or don't) code for the GNU assembler.  This is the default.
14737 @c Also, this is the default if the configure option @option{--with-gnu-as}
14738 @c is used.
14740 @item -mgnu-ld
14741 @itemx -mno-gnu-ld
14742 @opindex mgnu-ld
14743 @opindex mno-gnu-ld
14744 Generate (or don't) code for the GNU linker.  This is the default.
14745 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14746 @c is used.
14748 @item -mno-pic
14749 @opindex mno-pic
14750 Generate code that does not use a global pointer register.  The result
14751 is not position independent code, and violates the IA-64 ABI@.
14753 @item -mvolatile-asm-stop
14754 @itemx -mno-volatile-asm-stop
14755 @opindex mvolatile-asm-stop
14756 @opindex mno-volatile-asm-stop
14757 Generate (or don't) a stop bit immediately before and after volatile asm
14758 statements.
14760 @item -mregister-names
14761 @itemx -mno-register-names
14762 @opindex mregister-names
14763 @opindex mno-register-names
14764 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14765 the stacked registers.  This may make assembler output more readable.
14767 @item -mno-sdata
14768 @itemx -msdata
14769 @opindex mno-sdata
14770 @opindex msdata
14771 Disable (or enable) optimizations that use the small data section.  This may
14772 be useful for working around optimizer bugs.
14774 @item -mconstant-gp
14775 @opindex mconstant-gp
14776 Generate code that uses a single constant global pointer value.  This is
14777 useful when compiling kernel code.
14779 @item -mauto-pic
14780 @opindex mauto-pic
14781 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14782 This is useful when compiling firmware code.
14784 @item -minline-float-divide-min-latency
14785 @opindex minline-float-divide-min-latency
14786 Generate code for inline divides of floating-point values
14787 using the minimum latency algorithm.
14789 @item -minline-float-divide-max-throughput
14790 @opindex minline-float-divide-max-throughput
14791 Generate code for inline divides of floating-point values
14792 using the maximum throughput algorithm.
14794 @item -mno-inline-float-divide
14795 @opindex mno-inline-float-divide
14796 Do not generate inline code for divides of floating-point values.
14798 @item -minline-int-divide-min-latency
14799 @opindex minline-int-divide-min-latency
14800 Generate code for inline divides of integer values
14801 using the minimum latency algorithm.
14803 @item -minline-int-divide-max-throughput
14804 @opindex minline-int-divide-max-throughput
14805 Generate code for inline divides of integer values
14806 using the maximum throughput algorithm.
14808 @item -mno-inline-int-divide
14809 @opindex mno-inline-int-divide
14810 Do not generate inline code for divides of integer values.
14812 @item -minline-sqrt-min-latency
14813 @opindex minline-sqrt-min-latency
14814 Generate code for inline square roots
14815 using the minimum latency algorithm.
14817 @item -minline-sqrt-max-throughput
14818 @opindex minline-sqrt-max-throughput
14819 Generate code for inline square roots
14820 using the maximum throughput algorithm.
14822 @item -mno-inline-sqrt
14823 @opindex mno-inline-sqrt
14824 Do not generate inline code for @code{sqrt}.
14826 @item -mfused-madd
14827 @itemx -mno-fused-madd
14828 @opindex mfused-madd
14829 @opindex mno-fused-madd
14830 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14831 instructions.  The default is to use these instructions.
14833 @item -mno-dwarf2-asm
14834 @itemx -mdwarf2-asm
14835 @opindex mno-dwarf2-asm
14836 @opindex mdwarf2-asm
14837 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14838 info.  This may be useful when not using the GNU assembler.
14840 @item -mearly-stop-bits
14841 @itemx -mno-early-stop-bits
14842 @opindex mearly-stop-bits
14843 @opindex mno-early-stop-bits
14844 Allow stop bits to be placed earlier than immediately preceding the
14845 instruction that triggered the stop bit.  This can improve instruction
14846 scheduling, but does not always do so.
14848 @item -mfixed-range=@var{register-range}
14849 @opindex mfixed-range
14850 Generate code treating the given register range as fixed registers.
14851 A fixed register is one that the register allocator cannot use.  This is
14852 useful when compiling kernel code.  A register range is specified as
14853 two registers separated by a dash.  Multiple register ranges can be
14854 specified separated by a comma.
14856 @item -mtls-size=@var{tls-size}
14857 @opindex mtls-size
14858 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14861 @item -mtune=@var{cpu-type}
14862 @opindex mtune
14863 Tune the instruction scheduling for a particular CPU, Valid values are
14864 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14865 and @samp{mckinley}.
14867 @item -milp32
14868 @itemx -mlp64
14869 @opindex milp32
14870 @opindex mlp64
14871 Generate code for a 32-bit or 64-bit environment.
14872 The 32-bit environment sets int, long and pointer to 32 bits.
14873 The 64-bit environment sets int to 32 bits and long and pointer
14874 to 64 bits.  These are HP-UX specific flags.
14876 @item -mno-sched-br-data-spec
14877 @itemx -msched-br-data-spec
14878 @opindex mno-sched-br-data-spec
14879 @opindex msched-br-data-spec
14880 (Dis/En)able data speculative scheduling before reload.
14881 This results in generation of @code{ld.a} instructions and
14882 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14883 The default is 'disable'.
14885 @item -msched-ar-data-spec
14886 @itemx -mno-sched-ar-data-spec
14887 @opindex msched-ar-data-spec
14888 @opindex mno-sched-ar-data-spec
14889 (En/Dis)able data speculative scheduling after reload.
14890 This results in generation of @code{ld.a} instructions and
14891 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14892 The default is 'enable'.
14894 @item -mno-sched-control-spec
14895 @itemx -msched-control-spec
14896 @opindex mno-sched-control-spec
14897 @opindex msched-control-spec
14898 (Dis/En)able control speculative scheduling.  This feature is
14899 available only during region scheduling (i.e.@: before reload).
14900 This results in generation of the @code{ld.s} instructions and
14901 the corresponding check instructions @code{chk.s}.
14902 The default is 'disable'.
14904 @item -msched-br-in-data-spec
14905 @itemx -mno-sched-br-in-data-spec
14906 @opindex msched-br-in-data-spec
14907 @opindex mno-sched-br-in-data-spec
14908 (En/Dis)able speculative scheduling of the instructions that
14909 are dependent on the data speculative loads before reload.
14910 This is effective only with @option{-msched-br-data-spec} enabled.
14911 The default is 'enable'.
14913 @item -msched-ar-in-data-spec
14914 @itemx -mno-sched-ar-in-data-spec
14915 @opindex msched-ar-in-data-spec
14916 @opindex mno-sched-ar-in-data-spec
14917 (En/Dis)able speculative scheduling of the instructions that
14918 are dependent on the data speculative loads after reload.
14919 This is effective only with @option{-msched-ar-data-spec} enabled.
14920 The default is 'enable'.
14922 @item -msched-in-control-spec
14923 @itemx -mno-sched-in-control-spec
14924 @opindex msched-in-control-spec
14925 @opindex mno-sched-in-control-spec
14926 (En/Dis)able speculative scheduling of the instructions that
14927 are dependent on the control speculative loads.
14928 This is effective only with @option{-msched-control-spec} enabled.
14929 The default is 'enable'.
14931 @item -mno-sched-prefer-non-data-spec-insns
14932 @itemx -msched-prefer-non-data-spec-insns
14933 @opindex mno-sched-prefer-non-data-spec-insns
14934 @opindex msched-prefer-non-data-spec-insns
14935 If enabled, data-speculative instructions are chosen for schedule
14936 only if there are no other choices at the moment.  This makes
14937 the use of the data speculation much more conservative.
14938 The default is 'disable'.
14940 @item -mno-sched-prefer-non-control-spec-insns
14941 @itemx -msched-prefer-non-control-spec-insns
14942 @opindex mno-sched-prefer-non-control-spec-insns
14943 @opindex msched-prefer-non-control-spec-insns
14944 If enabled, control-speculative instructions are chosen for schedule
14945 only if there are no other choices at the moment.  This makes
14946 the use of the control speculation much more conservative.
14947 The default is 'disable'.
14949 @item -mno-sched-count-spec-in-critical-path
14950 @itemx -msched-count-spec-in-critical-path
14951 @opindex mno-sched-count-spec-in-critical-path
14952 @opindex msched-count-spec-in-critical-path
14953 If enabled, speculative dependencies are considered during
14954 computation of the instructions priorities.  This makes the use of the
14955 speculation a bit more conservative.
14956 The default is 'disable'.
14958 @item -msched-spec-ldc
14959 @opindex msched-spec-ldc
14960 Use a simple data speculation check.  This option is on by default.
14962 @item -msched-control-spec-ldc
14963 @opindex msched-spec-ldc
14964 Use a simple check for control speculation.  This option is on by default.
14966 @item -msched-stop-bits-after-every-cycle
14967 @opindex msched-stop-bits-after-every-cycle
14968 Place a stop bit after every cycle when scheduling.  This option is on
14969 by default.
14971 @item -msched-fp-mem-deps-zero-cost
14972 @opindex msched-fp-mem-deps-zero-cost
14973 Assume that floating-point stores and loads are not likely to cause a conflict
14974 when placed into the same instruction group.  This option is disabled by
14975 default.
14977 @item -msel-sched-dont-check-control-spec
14978 @opindex msel-sched-dont-check-control-spec
14979 Generate checks for control speculation in selective scheduling.
14980 This flag is disabled by default.
14982 @item -msched-max-memory-insns=@var{max-insns}
14983 @opindex msched-max-memory-insns
14984 Limit on the number of memory insns per instruction group, giving lower
14985 priority to subsequent memory insns attempting to schedule in the same
14986 instruction group. Frequently useful to prevent cache bank conflicts.
14987 The default value is 1.
14989 @item -msched-max-memory-insns-hard-limit
14990 @opindex msched-max-memory-insns-hard-limit
14991 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14992 disallowing more than that number in an instruction group.
14993 Otherwise, the limit is ``soft'', meaning that non-memory operations
14994 are preferred when the limit is reached, but memory operations may still
14995 be scheduled.
14997 @end table
14999 @node LM32 Options
15000 @subsection LM32 Options
15001 @cindex LM32 options
15003 These @option{-m} options are defined for the LatticeMico32 architecture:
15005 @table @gcctabopt
15006 @item -mbarrel-shift-enabled
15007 @opindex mbarrel-shift-enabled
15008 Enable barrel-shift instructions.
15010 @item -mdivide-enabled
15011 @opindex mdivide-enabled
15012 Enable divide and modulus instructions.
15014 @item -mmultiply-enabled
15015 @opindex multiply-enabled
15016 Enable multiply instructions.
15018 @item -msign-extend-enabled
15019 @opindex msign-extend-enabled
15020 Enable sign extend instructions.
15022 @item -muser-enabled
15023 @opindex muser-enabled
15024 Enable user-defined instructions.
15026 @end table
15028 @node M32C Options
15029 @subsection M32C Options
15030 @cindex M32C options
15032 @table @gcctabopt
15033 @item -mcpu=@var{name}
15034 @opindex mcpu=
15035 Select the CPU for which code is generated.  @var{name} may be one of
15036 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
15037 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
15038 the M32C/80 series.
15040 @item -msim
15041 @opindex msim
15042 Specifies that the program will be run on the simulator.  This causes
15043 an alternate runtime library to be linked in which supports, for
15044 example, file I/O@.  You must not use this option when generating
15045 programs that will run on real hardware; you must provide your own
15046 runtime library for whatever I/O functions are needed.
15048 @item -memregs=@var{number}
15049 @opindex memregs=
15050 Specifies the number of memory-based pseudo-registers GCC uses
15051 during code generation.  These pseudo-registers are used like real
15052 registers, so there is a tradeoff between GCC's ability to fit the
15053 code into available registers, and the performance penalty of using
15054 memory instead of registers.  Note that all modules in a program must
15055 be compiled with the same value for this option.  Because of that, you
15056 must not use this option with GCC's default runtime libraries.
15058 @end table
15060 @node M32R/D Options
15061 @subsection M32R/D Options
15062 @cindex M32R/D options
15064 These @option{-m} options are defined for Renesas M32R/D architectures:
15066 @table @gcctabopt
15067 @item -m32r2
15068 @opindex m32r2
15069 Generate code for the M32R/2@.
15071 @item -m32rx
15072 @opindex m32rx
15073 Generate code for the M32R/X@.
15075 @item -m32r
15076 @opindex m32r
15077 Generate code for the M32R@.  This is the default.
15079 @item -mmodel=small
15080 @opindex mmodel=small
15081 Assume all objects live in the lower 16MB of memory (so that their addresses
15082 can be loaded with the @code{ld24} instruction), and assume all subroutines
15083 are reachable with the @code{bl} instruction.
15084 This is the default.
15086 The addressability of a particular object can be set with the
15087 @code{model} attribute.
15089 @item -mmodel=medium
15090 @opindex mmodel=medium
15091 Assume objects may be anywhere in the 32-bit address space (the compiler
15092 generates @code{seth/add3} instructions to load their addresses), and
15093 assume all subroutines are reachable with the @code{bl} instruction.
15095 @item -mmodel=large
15096 @opindex mmodel=large
15097 Assume objects may be anywhere in the 32-bit address space (the compiler
15098 generates @code{seth/add3} instructions to load their addresses), and
15099 assume subroutines may not be reachable with the @code{bl} instruction
15100 (the compiler generates the much slower @code{seth/add3/jl}
15101 instruction sequence).
15103 @item -msdata=none
15104 @opindex msdata=none
15105 Disable use of the small data area.  Variables are put into
15106 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
15107 @code{section} attribute has been specified).
15108 This is the default.
15110 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
15111 Objects may be explicitly put in the small data area with the
15112 @code{section} attribute using one of these sections.
15114 @item -msdata=sdata
15115 @opindex msdata=sdata
15116 Put small global and static data in the small data area, but do not
15117 generate special code to reference them.
15119 @item -msdata=use
15120 @opindex msdata=use
15121 Put small global and static data in the small data area, and generate
15122 special instructions to reference them.
15124 @item -G @var{num}
15125 @opindex G
15126 @cindex smaller data references
15127 Put global and static objects less than or equal to @var{num} bytes
15128 into the small data or BSS sections instead of the normal data or BSS
15129 sections.  The default value of @var{num} is 8.
15130 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
15131 for this option to have any effect.
15133 All modules should be compiled with the same @option{-G @var{num}} value.
15134 Compiling with different values of @var{num} may or may not work; if it
15135 doesn't the linker gives an error message---incorrect code is not
15136 generated.
15138 @item -mdebug
15139 @opindex mdebug
15140 Makes the M32R-specific code in the compiler display some statistics
15141 that might help in debugging programs.
15143 @item -malign-loops
15144 @opindex malign-loops
15145 Align all loops to a 32-byte boundary.
15147 @item -mno-align-loops
15148 @opindex mno-align-loops
15149 Do not enforce a 32-byte alignment for loops.  This is the default.
15151 @item -missue-rate=@var{number}
15152 @opindex missue-rate=@var{number}
15153 Issue @var{number} instructions per cycle.  @var{number} can only be 1
15154 or 2.
15156 @item -mbranch-cost=@var{number}
15157 @opindex mbranch-cost=@var{number}
15158 @var{number} can only be 1 or 2.  If it is 1 then branches are
15159 preferred over conditional code, if it is 2, then the opposite applies.
15161 @item -mflush-trap=@var{number}
15162 @opindex mflush-trap=@var{number}
15163 Specifies the trap number to use to flush the cache.  The default is
15164 12.  Valid numbers are between 0 and 15 inclusive.
15166 @item -mno-flush-trap
15167 @opindex mno-flush-trap
15168 Specifies that the cache cannot be flushed by using a trap.
15170 @item -mflush-func=@var{name}
15171 @opindex mflush-func=@var{name}
15172 Specifies the name of the operating system function to call to flush
15173 the cache.  The default is @emph{_flush_cache}, but a function call
15174 is only used if a trap is not available.
15176 @item -mno-flush-func
15177 @opindex mno-flush-func
15178 Indicates that there is no OS function for flushing the cache.
15180 @end table
15182 @node M680x0 Options
15183 @subsection M680x0 Options
15184 @cindex M680x0 options
15186 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
15187 The default settings depend on which architecture was selected when
15188 the compiler was configured; the defaults for the most common choices
15189 are given below.
15191 @table @gcctabopt
15192 @item -march=@var{arch}
15193 @opindex march
15194 Generate code for a specific M680x0 or ColdFire instruction set
15195 architecture.  Permissible values of @var{arch} for M680x0
15196 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
15197 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
15198 architectures are selected according to Freescale's ISA classification
15199 and the permissible values are: @samp{isaa}, @samp{isaaplus},
15200 @samp{isab} and @samp{isac}.
15202 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
15203 code for a ColdFire target.  The @var{arch} in this macro is one of the
15204 @option{-march} arguments given above.
15206 When used together, @option{-march} and @option{-mtune} select code
15207 that runs on a family of similar processors but that is optimized
15208 for a particular microarchitecture.
15210 @item -mcpu=@var{cpu}
15211 @opindex mcpu
15212 Generate code for a specific M680x0 or ColdFire processor.
15213 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
15214 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
15215 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
15216 below, which also classifies the CPUs into families:
15218 @multitable @columnfractions 0.20 0.80
15219 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
15220 @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}
15221 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
15222 @item @samp{5206e} @tab @samp{5206e}
15223 @item @samp{5208} @tab @samp{5207} @samp{5208}
15224 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
15225 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
15226 @item @samp{5216} @tab @samp{5214} @samp{5216}
15227 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
15228 @item @samp{5225} @tab @samp{5224} @samp{5225}
15229 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
15230 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
15231 @item @samp{5249} @tab @samp{5249}
15232 @item @samp{5250} @tab @samp{5250}
15233 @item @samp{5271} @tab @samp{5270} @samp{5271}
15234 @item @samp{5272} @tab @samp{5272}
15235 @item @samp{5275} @tab @samp{5274} @samp{5275}
15236 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
15237 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
15238 @item @samp{5307} @tab @samp{5307}
15239 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
15240 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
15241 @item @samp{5407} @tab @samp{5407}
15242 @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}
15243 @end multitable
15245 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
15246 @var{arch} is compatible with @var{cpu}.  Other combinations of
15247 @option{-mcpu} and @option{-march} are rejected.
15249 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
15250 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
15251 where the value of @var{family} is given by the table above.
15253 @item -mtune=@var{tune}
15254 @opindex mtune
15255 Tune the code for a particular microarchitecture within the
15256 constraints set by @option{-march} and @option{-mcpu}.
15257 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
15258 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
15259 and @samp{cpu32}.  The ColdFire microarchitectures
15260 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
15262 You can also use @option{-mtune=68020-40} for code that needs
15263 to run relatively well on 68020, 68030 and 68040 targets.
15264 @option{-mtune=68020-60} is similar but includes 68060 targets
15265 as well.  These two options select the same tuning decisions as
15266 @option{-m68020-40} and @option{-m68020-60} respectively.
15268 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
15269 when tuning for 680x0 architecture @var{arch}.  It also defines
15270 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
15271 option is used.  If GCC is tuning for a range of architectures,
15272 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
15273 it defines the macros for every architecture in the range.
15275 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
15276 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
15277 of the arguments given above.
15279 @item -m68000
15280 @itemx -mc68000
15281 @opindex m68000
15282 @opindex mc68000
15283 Generate output for a 68000.  This is the default
15284 when the compiler is configured for 68000-based systems.
15285 It is equivalent to @option{-march=68000}.
15287 Use this option for microcontrollers with a 68000 or EC000 core,
15288 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
15290 @item -m68010
15291 @opindex m68010
15292 Generate output for a 68010.  This is the default
15293 when the compiler is configured for 68010-based systems.
15294 It is equivalent to @option{-march=68010}.
15296 @item -m68020
15297 @itemx -mc68020
15298 @opindex m68020
15299 @opindex mc68020
15300 Generate output for a 68020.  This is the default
15301 when the compiler is configured for 68020-based systems.
15302 It is equivalent to @option{-march=68020}.
15304 @item -m68030
15305 @opindex m68030
15306 Generate output for a 68030.  This is the default when the compiler is
15307 configured for 68030-based systems.  It is equivalent to
15308 @option{-march=68030}.
15310 @item -m68040
15311 @opindex m68040
15312 Generate output for a 68040.  This is the default when the compiler is
15313 configured for 68040-based systems.  It is equivalent to
15314 @option{-march=68040}.
15316 This option inhibits the use of 68881/68882 instructions that have to be
15317 emulated by software on the 68040.  Use this option if your 68040 does not
15318 have code to emulate those instructions.
15320 @item -m68060
15321 @opindex m68060
15322 Generate output for a 68060.  This is the default when the compiler is
15323 configured for 68060-based systems.  It is equivalent to
15324 @option{-march=68060}.
15326 This option inhibits the use of 68020 and 68881/68882 instructions that
15327 have to be emulated by software on the 68060.  Use this option if your 68060
15328 does not have code to emulate those instructions.
15330 @item -mcpu32
15331 @opindex mcpu32
15332 Generate output for a CPU32.  This is the default
15333 when the compiler is configured for CPU32-based systems.
15334 It is equivalent to @option{-march=cpu32}.
15336 Use this option for microcontrollers with a
15337 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
15338 68336, 68340, 68341, 68349 and 68360.
15340 @item -m5200
15341 @opindex m5200
15342 Generate output for a 520X ColdFire CPU@.  This is the default
15343 when the compiler is configured for 520X-based systems.
15344 It is equivalent to @option{-mcpu=5206}, and is now deprecated
15345 in favor of that option.
15347 Use this option for microcontroller with a 5200 core, including
15348 the MCF5202, MCF5203, MCF5204 and MCF5206.
15350 @item -m5206e
15351 @opindex m5206e
15352 Generate output for a 5206e ColdFire CPU@.  The option is now
15353 deprecated in favor of the equivalent @option{-mcpu=5206e}.
15355 @item -m528x
15356 @opindex m528x
15357 Generate output for a member of the ColdFire 528X family.
15358 The option is now deprecated in favor of the equivalent
15359 @option{-mcpu=528x}.
15361 @item -m5307
15362 @opindex m5307
15363 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
15364 in favor of the equivalent @option{-mcpu=5307}.
15366 @item -m5407
15367 @opindex m5407
15368 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
15369 in favor of the equivalent @option{-mcpu=5407}.
15371 @item -mcfv4e
15372 @opindex mcfv4e
15373 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
15374 This includes use of hardware floating-point instructions.
15375 The option is equivalent to @option{-mcpu=547x}, and is now
15376 deprecated in favor of that option.
15378 @item -m68020-40
15379 @opindex m68020-40
15380 Generate output for a 68040, without using any of the new instructions.
15381 This results in code that can run relatively efficiently on either a
15382 68020/68881 or a 68030 or a 68040.  The generated code does use the
15383 68881 instructions that are emulated on the 68040.
15385 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
15387 @item -m68020-60
15388 @opindex m68020-60
15389 Generate output for a 68060, without using any of the new instructions.
15390 This results in code that can run relatively efficiently on either a
15391 68020/68881 or a 68030 or a 68040.  The generated code does use the
15392 68881 instructions that are emulated on the 68060.
15394 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
15396 @item -mhard-float
15397 @itemx -m68881
15398 @opindex mhard-float
15399 @opindex m68881
15400 Generate floating-point instructions.  This is the default for 68020
15401 and above, and for ColdFire devices that have an FPU@.  It defines the
15402 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
15403 on ColdFire targets.
15405 @item -msoft-float
15406 @opindex msoft-float
15407 Do not generate floating-point instructions; use library calls instead.
15408 This is the default for 68000, 68010, and 68832 targets.  It is also
15409 the default for ColdFire devices that have no FPU.
15411 @item -mdiv
15412 @itemx -mno-div
15413 @opindex mdiv
15414 @opindex mno-div
15415 Generate (do not generate) ColdFire hardware divide and remainder
15416 instructions.  If @option{-march} is used without @option{-mcpu},
15417 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
15418 architectures.  Otherwise, the default is taken from the target CPU
15419 (either the default CPU, or the one specified by @option{-mcpu}).  For
15420 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
15421 @option{-mcpu=5206e}.
15423 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
15425 @item -mshort
15426 @opindex mshort
15427 Consider type @code{int} to be 16 bits wide, like @code{short int}.
15428 Additionally, parameters passed on the stack are also aligned to a
15429 16-bit boundary even on targets whose API mandates promotion to 32-bit.
15431 @item -mno-short
15432 @opindex mno-short
15433 Do not consider type @code{int} to be 16 bits wide.  This is the default.
15435 @item -mnobitfield
15436 @itemx -mno-bitfield
15437 @opindex mnobitfield
15438 @opindex mno-bitfield
15439 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
15440 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
15442 @item -mbitfield
15443 @opindex mbitfield
15444 Do use the bit-field instructions.  The @option{-m68020} option implies
15445 @option{-mbitfield}.  This is the default if you use a configuration
15446 designed for a 68020.
15448 @item -mrtd
15449 @opindex mrtd
15450 Use a different function-calling convention, in which functions
15451 that take a fixed number of arguments return with the @code{rtd}
15452 instruction, which pops their arguments while returning.  This
15453 saves one instruction in the caller since there is no need to pop
15454 the arguments there.
15456 This calling convention is incompatible with the one normally
15457 used on Unix, so you cannot use it if you need to call libraries
15458 compiled with the Unix compiler.
15460 Also, you must provide function prototypes for all functions that
15461 take variable numbers of arguments (including @code{printf});
15462 otherwise incorrect code is generated for calls to those
15463 functions.
15465 In addition, seriously incorrect code results if you call a
15466 function with too many arguments.  (Normally, extra arguments are
15467 harmlessly ignored.)
15469 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
15470 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
15472 @item -mno-rtd
15473 @opindex mno-rtd
15474 Do not use the calling conventions selected by @option{-mrtd}.
15475 This is the default.
15477 @item -malign-int
15478 @itemx -mno-align-int
15479 @opindex malign-int
15480 @opindex mno-align-int
15481 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
15482 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
15483 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
15484 Aligning variables on 32-bit boundaries produces code that runs somewhat
15485 faster on processors with 32-bit busses at the expense of more memory.
15487 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
15488 aligns structures containing the above types differently than
15489 most published application binary interface specifications for the m68k.
15491 @item -mpcrel
15492 @opindex mpcrel
15493 Use the pc-relative addressing mode of the 68000 directly, instead of
15494 using a global offset table.  At present, this option implies @option{-fpic},
15495 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
15496 not presently supported with @option{-mpcrel}, though this could be supported for
15497 68020 and higher processors.
15499 @item -mno-strict-align
15500 @itemx -mstrict-align
15501 @opindex mno-strict-align
15502 @opindex mstrict-align
15503 Do not (do) assume that unaligned memory references are handled by
15504 the system.
15506 @item -msep-data
15507 Generate code that allows the data segment to be located in a different
15508 area of memory from the text segment.  This allows for execute-in-place in
15509 an environment without virtual memory management.  This option implies
15510 @option{-fPIC}.
15512 @item -mno-sep-data
15513 Generate code that assumes that the data segment follows the text segment.
15514 This is the default.
15516 @item -mid-shared-library
15517 Generate code that supports shared libraries via the library ID method.
15518 This allows for execute-in-place and shared libraries in an environment
15519 without virtual memory management.  This option implies @option{-fPIC}.
15521 @item -mno-id-shared-library
15522 Generate code that doesn't assume ID-based shared libraries are being used.
15523 This is the default.
15525 @item -mshared-library-id=n
15526 Specifies the identification number of the ID-based shared library being
15527 compiled.  Specifying a value of 0 generates more compact code; specifying
15528 other values forces the allocation of that number to the current
15529 library, but is no more space- or time-efficient than omitting this option.
15531 @item -mxgot
15532 @itemx -mno-xgot
15533 @opindex mxgot
15534 @opindex mno-xgot
15535 When generating position-independent code for ColdFire, generate code
15536 that works if the GOT has more than 8192 entries.  This code is
15537 larger and slower than code generated without this option.  On M680x0
15538 processors, this option is not needed; @option{-fPIC} suffices.
15540 GCC normally uses a single instruction to load values from the GOT@.
15541 While this is relatively efficient, it only works if the GOT
15542 is smaller than about 64k.  Anything larger causes the linker
15543 to report an error such as:
15545 @cindex relocation truncated to fit (ColdFire)
15546 @smallexample
15547 relocation truncated to fit: R_68K_GOT16O foobar
15548 @end smallexample
15550 If this happens, you should recompile your code with @option{-mxgot}.
15551 It should then work with very large GOTs.  However, code generated with
15552 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
15553 the value of a global symbol.
15555 Note that some linkers, including newer versions of the GNU linker,
15556 can create multiple GOTs and sort GOT entries.  If you have such a linker,
15557 you should only need to use @option{-mxgot} when compiling a single
15558 object file that accesses more than 8192 GOT entries.  Very few do.
15560 These options have no effect unless GCC is generating
15561 position-independent code.
15563 @end table
15565 @node MCore Options
15566 @subsection MCore Options
15567 @cindex MCore options
15569 These are the @samp{-m} options defined for the Motorola M*Core
15570 processors.
15572 @table @gcctabopt
15574 @item -mhardlit
15575 @itemx -mno-hardlit
15576 @opindex mhardlit
15577 @opindex mno-hardlit
15578 Inline constants into the code stream if it can be done in two
15579 instructions or less.
15581 @item -mdiv
15582 @itemx -mno-div
15583 @opindex mdiv
15584 @opindex mno-div
15585 Use the divide instruction.  (Enabled by default).
15587 @item -mrelax-immediate
15588 @itemx -mno-relax-immediate
15589 @opindex mrelax-immediate
15590 @opindex mno-relax-immediate
15591 Allow arbitrary-sized immediates in bit operations.
15593 @item -mwide-bitfields
15594 @itemx -mno-wide-bitfields
15595 @opindex mwide-bitfields
15596 @opindex mno-wide-bitfields
15597 Always treat bit-fields as @code{int}-sized.
15599 @item -m4byte-functions
15600 @itemx -mno-4byte-functions
15601 @opindex m4byte-functions
15602 @opindex mno-4byte-functions
15603 Force all functions to be aligned to a 4-byte boundary.
15605 @item -mcallgraph-data
15606 @itemx -mno-callgraph-data
15607 @opindex mcallgraph-data
15608 @opindex mno-callgraph-data
15609 Emit callgraph information.
15611 @item -mslow-bytes
15612 @itemx -mno-slow-bytes
15613 @opindex mslow-bytes
15614 @opindex mno-slow-bytes
15615 Prefer word access when reading byte quantities.
15617 @item -mlittle-endian
15618 @itemx -mbig-endian
15619 @opindex mlittle-endian
15620 @opindex mbig-endian
15621 Generate code for a little-endian target.
15623 @item -m210
15624 @itemx -m340
15625 @opindex m210
15626 @opindex m340
15627 Generate code for the 210 processor.
15629 @item -mno-lsim
15630 @opindex mno-lsim
15631 Assume that runtime support has been provided and so omit the
15632 simulator library (@file{libsim.a)} from the linker command line.
15634 @item -mstack-increment=@var{size}
15635 @opindex mstack-increment
15636 Set the maximum amount for a single stack increment operation.  Large
15637 values can increase the speed of programs that contain functions
15638 that need a large amount of stack space, but they can also trigger a
15639 segmentation fault if the stack is extended too much.  The default
15640 value is 0x1000.
15642 @end table
15644 @node MeP Options
15645 @subsection MeP Options
15646 @cindex MeP options
15648 @table @gcctabopt
15650 @item -mabsdiff
15651 @opindex mabsdiff
15652 Enables the @code{abs} instruction, which is the absolute difference
15653 between two registers.
15655 @item -mall-opts
15656 @opindex mall-opts
15657 Enables all the optional instructions---average, multiply, divide, bit
15658 operations, leading zero, absolute difference, min/max, clip, and
15659 saturation.
15662 @item -maverage
15663 @opindex maverage
15664 Enables the @code{ave} instruction, which computes the average of two
15665 registers.
15667 @item -mbased=@var{n}
15668 @opindex mbased=
15669 Variables of size @var{n} bytes or smaller are placed in the
15670 @code{.based} section by default.  Based variables use the @code{$tp}
15671 register as a base register, and there is a 128-byte limit to the
15672 @code{.based} section.
15674 @item -mbitops
15675 @opindex mbitops
15676 Enables the bit operation instructions---bit test (@code{btstm}), set
15677 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15678 test-and-set (@code{tas}).
15680 @item -mc=@var{name}
15681 @opindex mc=
15682 Selects which section constant data is placed in.  @var{name} may
15683 be @code{tiny}, @code{near}, or @code{far}.
15685 @item -mclip
15686 @opindex mclip
15687 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15688 useful unless you also provide @code{-mminmax}.
15690 @item -mconfig=@var{name}
15691 @opindex mconfig=
15692 Selects one of the built-in core configurations.  Each MeP chip has
15693 one or more modules in it; each module has a core CPU and a variety of
15694 coprocessors, optional instructions, and peripherals.  The
15695 @code{MeP-Integrator} tool, not part of GCC, provides these
15696 configurations through this option; using this option is the same as
15697 using all the corresponding command-line options.  The default
15698 configuration is @code{default}.
15700 @item -mcop
15701 @opindex mcop
15702 Enables the coprocessor instructions.  By default, this is a 32-bit
15703 coprocessor.  Note that the coprocessor is normally enabled via the
15704 @code{-mconfig=} option.
15706 @item -mcop32
15707 @opindex mcop32
15708 Enables the 32-bit coprocessor's instructions.
15710 @item -mcop64
15711 @opindex mcop64
15712 Enables the 64-bit coprocessor's instructions.
15714 @item -mivc2
15715 @opindex mivc2
15716 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15718 @item -mdc
15719 @opindex mdc
15720 Causes constant variables to be placed in the @code{.near} section.
15722 @item -mdiv
15723 @opindex mdiv
15724 Enables the @code{div} and @code{divu} instructions.
15726 @item -meb
15727 @opindex meb
15728 Generate big-endian code.
15730 @item -mel
15731 @opindex mel
15732 Generate little-endian code.
15734 @item -mio-volatile
15735 @opindex mio-volatile
15736 Tells the compiler that any variable marked with the @code{io}
15737 attribute is to be considered volatile.
15739 @item -ml
15740 @opindex ml
15741 Causes variables to be assigned to the @code{.far} section by default.
15743 @item -mleadz
15744 @opindex mleadz
15745 Enables the @code{leadz} (leading zero) instruction.
15747 @item -mm
15748 @opindex mm
15749 Causes variables to be assigned to the @code{.near} section by default.
15751 @item -mminmax
15752 @opindex mminmax
15753 Enables the @code{min} and @code{max} instructions.
15755 @item -mmult
15756 @opindex mmult
15757 Enables the multiplication and multiply-accumulate instructions.
15759 @item -mno-opts
15760 @opindex mno-opts
15761 Disables all the optional instructions enabled by @code{-mall-opts}.
15763 @item -mrepeat
15764 @opindex mrepeat
15765 Enables the @code{repeat} and @code{erepeat} instructions, used for
15766 low-overhead looping.
15768 @item -ms
15769 @opindex ms
15770 Causes all variables to default to the @code{.tiny} section.  Note
15771 that there is a 65536-byte limit to this section.  Accesses to these
15772 variables use the @code{%gp} base register.
15774 @item -msatur
15775 @opindex msatur
15776 Enables the saturation instructions.  Note that the compiler does not
15777 currently generate these itself, but this option is included for
15778 compatibility with other tools, like @code{as}.
15780 @item -msdram
15781 @opindex msdram
15782 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15784 @item -msim
15785 @opindex msim
15786 Link the simulator runtime libraries.
15788 @item -msimnovec
15789 @opindex msimnovec
15790 Link the simulator runtime libraries, excluding built-in support
15791 for reset and exception vectors and tables.
15793 @item -mtf
15794 @opindex mtf
15795 Causes all functions to default to the @code{.far} section.  Without
15796 this option, functions default to the @code{.near} section.
15798 @item -mtiny=@var{n}
15799 @opindex mtiny=
15800 Variables that are @var{n} bytes or smaller are allocated to the
15801 @code{.tiny} section.  These variables use the @code{$gp} base
15802 register.  The default for this option is 4, but note that there's a
15803 65536-byte limit to the @code{.tiny} section.
15805 @end table
15807 @node MicroBlaze Options
15808 @subsection MicroBlaze Options
15809 @cindex MicroBlaze Options
15811 @table @gcctabopt
15813 @item -msoft-float
15814 @opindex msoft-float
15815 Use software emulation for floating point (default).
15817 @item -mhard-float
15818 @opindex mhard-float
15819 Use hardware floating-point instructions.
15821 @item -mmemcpy
15822 @opindex mmemcpy
15823 Do not optimize block moves, use @code{memcpy}.
15825 @item -mno-clearbss
15826 @opindex mno-clearbss
15827 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15829 @item -mcpu=@var{cpu-type}
15830 @opindex mcpu=
15831 Use features of, and schedule code for, the given CPU.
15832 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15833 where @var{X} is a major version, @var{YY} is the minor version, and
15834 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15835 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15837 @item -mxl-soft-mul
15838 @opindex mxl-soft-mul
15839 Use software multiply emulation (default).
15841 @item -mxl-soft-div
15842 @opindex mxl-soft-div
15843 Use software emulation for divides (default).
15845 @item -mxl-barrel-shift
15846 @opindex mxl-barrel-shift
15847 Use the hardware barrel shifter.
15849 @item -mxl-pattern-compare
15850 @opindex mxl-pattern-compare
15851 Use pattern compare instructions.
15853 @item -msmall-divides
15854 @opindex msmall-divides
15855 Use table lookup optimization for small signed integer divisions.
15857 @item -mxl-stack-check
15858 @opindex mxl-stack-check
15859 This option is deprecated.  Use @option{-fstack-check} instead.
15861 @item -mxl-gp-opt
15862 @opindex mxl-gp-opt
15863 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15865 @item -mxl-multiply-high
15866 @opindex mxl-multiply-high
15867 Use multiply high instructions for high part of 32x32 multiply.
15869 @item -mxl-float-convert
15870 @opindex mxl-float-convert
15871 Use hardware floating-point conversion instructions.
15873 @item -mxl-float-sqrt
15874 @opindex mxl-float-sqrt
15875 Use hardware floating-point square root instruction.
15877 @item -mbig-endian
15878 @opindex mbig-endian
15879 Generate code for a big-endian target.
15881 @item -mlittle-endian
15882 @opindex mlittle-endian
15883 Generate code for a little-endian target.
15885 @item -mxl-reorder
15886 @opindex mxl-reorder
15887 Use reorder instructions (swap and byte reversed load/store).
15889 @item -mxl-mode-@var{app-model}
15890 Select application model @var{app-model}.  Valid models are
15891 @table @samp
15892 @item executable
15893 normal executable (default), uses startup code @file{crt0.o}.
15895 @item xmdstub
15896 for use with Xilinx Microprocessor Debugger (XMD) based
15897 software intrusive debug agent called xmdstub. This uses startup file
15898 @file{crt1.o} and sets the start address of the program to 0x800.
15900 @item bootstrap
15901 for applications that are loaded using a bootloader.
15902 This model uses startup file @file{crt2.o} which does not contain a processor
15903 reset vector handler. This is suitable for transferring control on a
15904 processor reset to the bootloader rather than the application.
15906 @item novectors
15907 for applications that do not require any of the
15908 MicroBlaze vectors. This option may be useful for applications running
15909 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15910 @end table
15912 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15913 @option{-mxl-mode-@var{app-model}}.
15915 @end table
15917 @node MIPS Options
15918 @subsection MIPS Options
15919 @cindex MIPS options
15921 @table @gcctabopt
15923 @item -EB
15924 @opindex EB
15925 Generate big-endian code.
15927 @item -EL
15928 @opindex EL
15929 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15930 configurations.
15932 @item -march=@var{arch}
15933 @opindex march
15934 Generate code that runs on @var{arch}, which can be the name of a
15935 generic MIPS ISA, or the name of a particular processor.
15936 The ISA names are:
15937 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15938 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15939 The processor names are:
15940 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15941 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15942 @samp{5kc}, @samp{5kf},
15943 @samp{20kc},
15944 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15945 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15946 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
15947 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15948 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15949 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15950 @samp{m4k},
15951 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15952 @samp{orion},
15953 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15954 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
15955 @samp{rm7000}, @samp{rm9000},
15956 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15957 @samp{sb1},
15958 @samp{sr71000},
15959 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15960 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15961 @samp{xlr} and @samp{xlp}.
15962 The special value @samp{from-abi} selects the
15963 most compatible architecture for the selected ABI (that is,
15964 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15966 The native Linux/GNU toolchain also supports the value @samp{native},
15967 which selects the best architecture option for the host processor.
15968 @option{-march=native} has no effect if GCC does not recognize
15969 the processor.
15971 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15972 (for example, @option{-march=r2k}).  Prefixes are optional, and
15973 @samp{vr} may be written @samp{r}.
15975 Names of the form @samp{@var{n}f2_1} refer to processors with
15976 FPUs clocked at half the rate of the core, names of the form
15977 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15978 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15979 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15980 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15981 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15982 accepted as synonyms for @samp{@var{n}f1_1}.
15984 GCC defines two macros based on the value of this option.  The first
15985 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15986 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15987 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15988 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15989 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15991 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15992 above.  In other words, it has the full prefix and does not
15993 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15994 the macro names the resolved architecture (either @samp{"mips1"} or
15995 @samp{"mips3"}).  It names the default architecture when no
15996 @option{-march} option is given.
15998 @item -mtune=@var{arch}
15999 @opindex mtune
16000 Optimize for @var{arch}.  Among other things, this option controls
16001 the way instructions are scheduled, and the perceived cost of arithmetic
16002 operations.  The list of @var{arch} values is the same as for
16003 @option{-march}.
16005 When this option is not used, GCC optimizes for the processor
16006 specified by @option{-march}.  By using @option{-march} and
16007 @option{-mtune} together, it is possible to generate code that
16008 runs on a family of processors, but optimize the code for one
16009 particular member of that family.
16011 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
16012 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
16013 @option{-march} ones described above.
16015 @item -mips1
16016 @opindex mips1
16017 Equivalent to @option{-march=mips1}.
16019 @item -mips2
16020 @opindex mips2
16021 Equivalent to @option{-march=mips2}.
16023 @item -mips3
16024 @opindex mips3
16025 Equivalent to @option{-march=mips3}.
16027 @item -mips4
16028 @opindex mips4
16029 Equivalent to @option{-march=mips4}.
16031 @item -mips32
16032 @opindex mips32
16033 Equivalent to @option{-march=mips32}.
16035 @item -mips32r2
16036 @opindex mips32r2
16037 Equivalent to @option{-march=mips32r2}.
16039 @item -mips64
16040 @opindex mips64
16041 Equivalent to @option{-march=mips64}.
16043 @item -mips64r2
16044 @opindex mips64r2
16045 Equivalent to @option{-march=mips64r2}.
16047 @item -mips16
16048 @itemx -mno-mips16
16049 @opindex mips16
16050 @opindex mno-mips16
16051 Generate (do not generate) MIPS16 code.  If GCC is targeting a
16052 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
16054 MIPS16 code generation can also be controlled on a per-function basis
16055 by means of @code{mips16} and @code{nomips16} attributes.
16056 @xref{Function Attributes}, for more information.
16058 @item -mflip-mips16
16059 @opindex mflip-mips16
16060 Generate MIPS16 code on alternating functions.  This option is provided
16061 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
16062 not intended for ordinary use in compiling user code.
16064 @item -minterlink-mips16
16065 @itemx -mno-interlink-mips16
16066 @opindex minterlink-mips16
16067 @opindex mno-interlink-mips16
16068 Require (do not require) that non-MIPS16 code be link-compatible with
16069 MIPS16 code.
16071 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
16072 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
16073 therefore disables direct jumps unless GCC knows that the target of the
16074 jump is not MIPS16.
16076 @item -mabi=32
16077 @itemx -mabi=o64
16078 @itemx -mabi=n32
16079 @itemx -mabi=64
16080 @itemx -mabi=eabi
16081 @opindex mabi=32
16082 @opindex mabi=o64
16083 @opindex mabi=n32
16084 @opindex mabi=64
16085 @opindex mabi=eabi
16086 Generate code for the given ABI@.
16088 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
16089 generates 64-bit code when you select a 64-bit architecture, but you
16090 can use @option{-mgp32} to get 32-bit code instead.
16092 For information about the O64 ABI, see
16093 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
16095 GCC supports a variant of the o32 ABI in which floating-point registers
16096 are 64 rather than 32 bits wide.  You can select this combination with
16097 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
16098 and @code{mfhc1} instructions and is therefore only supported for
16099 MIPS32R2 processors.
16101 The register assignments for arguments and return values remain the
16102 same, but each scalar value is passed in a single 64-bit register
16103 rather than a pair of 32-bit registers.  For example, scalar
16104 floating-point values are returned in @samp{$f0} only, not a
16105 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
16106 remains the same, but all 64 bits are saved.
16108 @item -mabicalls
16109 @itemx -mno-abicalls
16110 @opindex mabicalls
16111 @opindex mno-abicalls
16112 Generate (do not generate) code that is suitable for SVR4-style
16113 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
16114 systems.
16116 @item -mshared
16117 @itemx -mno-shared
16118 Generate (do not generate) code that is fully position-independent,
16119 and that can therefore be linked into shared libraries.  This option
16120 only affects @option{-mabicalls}.
16122 All @option{-mabicalls} code has traditionally been position-independent,
16123 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
16124 as an extension, the GNU toolchain allows executables to use absolute
16125 accesses for locally-binding symbols.  It can also use shorter GP
16126 initialization sequences and generate direct calls to locally-defined
16127 functions.  This mode is selected by @option{-mno-shared}.
16129 @option{-mno-shared} depends on binutils 2.16 or higher and generates
16130 objects that can only be linked by the GNU linker.  However, the option
16131 does not affect the ABI of the final executable; it only affects the ABI
16132 of relocatable objects.  Using @option{-mno-shared} generally makes
16133 executables both smaller and quicker.
16135 @option{-mshared} is the default.
16137 @item -mplt
16138 @itemx -mno-plt
16139 @opindex mplt
16140 @opindex mno-plt
16141 Assume (do not assume) that the static and dynamic linkers
16142 support PLTs and copy relocations.  This option only affects
16143 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
16144 has no effect without @option{-msym32}.
16146 You can make @option{-mplt} the default by configuring
16147 GCC with @option{--with-mips-plt}.  The default is
16148 @option{-mno-plt} otherwise.
16150 @item -mxgot
16151 @itemx -mno-xgot
16152 @opindex mxgot
16153 @opindex mno-xgot
16154 Lift (do not lift) the usual restrictions on the size of the global
16155 offset table.
16157 GCC normally uses a single instruction to load values from the GOT@.
16158 While this is relatively efficient, it only works if the GOT
16159 is smaller than about 64k.  Anything larger causes the linker
16160 to report an error such as:
16162 @cindex relocation truncated to fit (MIPS)
16163 @smallexample
16164 relocation truncated to fit: R_MIPS_GOT16 foobar
16165 @end smallexample
16167 If this happens, you should recompile your code with @option{-mxgot}.
16168 This works with very large GOTs, although the code is also
16169 less efficient, since it takes three instructions to fetch the
16170 value of a global symbol.
16172 Note that some linkers can create multiple GOTs.  If you have such a
16173 linker, you should only need to use @option{-mxgot} when a single object
16174 file accesses more than 64k's worth of GOT entries.  Very few do.
16176 These options have no effect unless GCC is generating position
16177 independent code.
16179 @item -mgp32
16180 @opindex mgp32
16181 Assume that general-purpose registers are 32 bits wide.
16183 @item -mgp64
16184 @opindex mgp64
16185 Assume that general-purpose registers are 64 bits wide.
16187 @item -mfp32
16188 @opindex mfp32
16189 Assume that floating-point registers are 32 bits wide.
16191 @item -mfp64
16192 @opindex mfp64
16193 Assume that floating-point registers are 64 bits wide.
16195 @item -mhard-float
16196 @opindex mhard-float
16197 Use floating-point coprocessor instructions.
16199 @item -msoft-float
16200 @opindex msoft-float
16201 Do not use floating-point coprocessor instructions.  Implement
16202 floating-point calculations using library calls instead.
16204 @item -mno-float
16205 @opindex mno-float
16206 Equivalent to @option{-msoft-float}, but additionally asserts that the
16207 program being compiled does not perform any floating-point operations.
16208 This option is presently supported only by some bare-metal MIPS
16209 configurations, where it may select a special set of libraries
16210 that lack all floating-point support (including, for example, the
16211 floating-point @code{printf} formats).  
16212 If code compiled with @code{-mno-float} accidentally contains
16213 floating-point operations, it is likely to suffer a link-time
16214 or run-time failure.
16216 @item -msingle-float
16217 @opindex msingle-float
16218 Assume that the floating-point coprocessor only supports single-precision
16219 operations.
16221 @item -mdouble-float
16222 @opindex mdouble-float
16223 Assume that the floating-point coprocessor supports double-precision
16224 operations.  This is the default.
16226 @item -mllsc
16227 @itemx -mno-llsc
16228 @opindex mllsc
16229 @opindex mno-llsc
16230 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
16231 implement atomic memory built-in functions.  When neither option is
16232 specified, GCC uses the instructions if the target architecture
16233 supports them.
16235 @option{-mllsc} is useful if the runtime environment can emulate the
16236 instructions and @option{-mno-llsc} can be useful when compiling for
16237 nonstandard ISAs.  You can make either option the default by
16238 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
16239 respectively.  @option{--with-llsc} is the default for some
16240 configurations; see the installation documentation for details.
16242 @item -mdsp
16243 @itemx -mno-dsp
16244 @opindex mdsp
16245 @opindex mno-dsp
16246 Use (do not use) revision 1 of the MIPS DSP ASE@.
16247 @xref{MIPS DSP Built-in Functions}.  This option defines the
16248 preprocessor macro @samp{__mips_dsp}.  It also defines
16249 @samp{__mips_dsp_rev} to 1.
16251 @item -mdspr2
16252 @itemx -mno-dspr2
16253 @opindex mdspr2
16254 @opindex mno-dspr2
16255 Use (do not use) revision 2 of the MIPS DSP ASE@.
16256 @xref{MIPS DSP Built-in Functions}.  This option defines the
16257 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
16258 It also defines @samp{__mips_dsp_rev} to 2.
16260 @item -msmartmips
16261 @itemx -mno-smartmips
16262 @opindex msmartmips
16263 @opindex mno-smartmips
16264 Use (do not use) the MIPS SmartMIPS ASE.
16266 @item -mpaired-single
16267 @itemx -mno-paired-single
16268 @opindex mpaired-single
16269 @opindex mno-paired-single
16270 Use (do not use) paired-single floating-point instructions.
16271 @xref{MIPS Paired-Single Support}.  This option requires
16272 hardware floating-point support to be enabled.
16274 @item -mdmx
16275 @itemx -mno-mdmx
16276 @opindex mdmx
16277 @opindex mno-mdmx
16278 Use (do not use) MIPS Digital Media Extension instructions.
16279 This option can only be used when generating 64-bit code and requires
16280 hardware floating-point support to be enabled.
16282 @item -mips3d
16283 @itemx -mno-mips3d
16284 @opindex mips3d
16285 @opindex mno-mips3d
16286 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
16287 The option @option{-mips3d} implies @option{-mpaired-single}.
16289 @item -mmt
16290 @itemx -mno-mt
16291 @opindex mmt
16292 @opindex mno-mt
16293 Use (do not use) MT Multithreading instructions.
16295 @item -mmcu
16296 @itemx -mno-mcu
16297 @opindex mmcu
16298 @opindex mno-mcu
16299 Use (do not use) the MIPS MCU ASE instructions.
16301 @item -mlong64
16302 @opindex mlong64
16303 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
16304 an explanation of the default and the way that the pointer size is
16305 determined.
16307 @item -mlong32
16308 @opindex mlong32
16309 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
16311 The default size of @code{int}s, @code{long}s and pointers depends on
16312 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
16313 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
16314 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
16315 or the same size as integer registers, whichever is smaller.
16317 @item -msym32
16318 @itemx -mno-sym32
16319 @opindex msym32
16320 @opindex mno-sym32
16321 Assume (do not assume) that all symbols have 32-bit values, regardless
16322 of the selected ABI@.  This option is useful in combination with
16323 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
16324 to generate shorter and faster references to symbolic addresses.
16326 @item -G @var{num}
16327 @opindex G
16328 Put definitions of externally-visible data in a small data section
16329 if that data is no bigger than @var{num} bytes.  GCC can then generate
16330 more efficient accesses to the data; see @option{-mgpopt} for details.
16332 The default @option{-G} option depends on the configuration.
16334 @item -mlocal-sdata
16335 @itemx -mno-local-sdata
16336 @opindex mlocal-sdata
16337 @opindex mno-local-sdata
16338 Extend (do not extend) the @option{-G} behavior to local data too,
16339 such as to static variables in C@.  @option{-mlocal-sdata} is the
16340 default for all configurations.
16342 If the linker complains that an application is using too much small data,
16343 you might want to try rebuilding the less performance-critical parts with
16344 @option{-mno-local-sdata}.  You might also want to build large
16345 libraries with @option{-mno-local-sdata}, so that the libraries leave
16346 more room for the main program.
16348 @item -mextern-sdata
16349 @itemx -mno-extern-sdata
16350 @opindex mextern-sdata
16351 @opindex mno-extern-sdata
16352 Assume (do not assume) that externally-defined data is in
16353 a small data section if the size of that data is within the @option{-G} limit.
16354 @option{-mextern-sdata} is the default for all configurations.
16356 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
16357 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
16358 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
16359 is placed in a small data section.  If @var{Var} is defined by another
16360 module, you must either compile that module with a high-enough
16361 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
16362 definition.  If @var{Var} is common, you must link the application
16363 with a high-enough @option{-G} setting.
16365 The easiest way of satisfying these restrictions is to compile
16366 and link every module with the same @option{-G} option.  However,
16367 you may wish to build a library that supports several different
16368 small data limits.  You can do this by compiling the library with
16369 the highest supported @option{-G} setting and additionally using
16370 @option{-mno-extern-sdata} to stop the library from making assumptions
16371 about externally-defined data.
16373 @item -mgpopt
16374 @itemx -mno-gpopt
16375 @opindex mgpopt
16376 @opindex mno-gpopt
16377 Use (do not use) GP-relative accesses for symbols that are known to be
16378 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
16379 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
16380 configurations.
16382 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
16383 might not hold the value of @code{_gp}.  For example, if the code is
16384 part of a library that might be used in a boot monitor, programs that
16385 call boot monitor routines pass an unknown value in @code{$gp}.
16386 (In such situations, the boot monitor itself is usually compiled
16387 with @option{-G0}.)
16389 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
16390 @option{-mno-extern-sdata}.
16392 @item -membedded-data
16393 @itemx -mno-embedded-data
16394 @opindex membedded-data
16395 @opindex mno-embedded-data
16396 Allocate variables to the read-only data section first if possible, then
16397 next in the small data section if possible, otherwise in data.  This gives
16398 slightly slower code than the default, but reduces the amount of RAM required
16399 when executing, and thus may be preferred for some embedded systems.
16401 @item -muninit-const-in-rodata
16402 @itemx -mno-uninit-const-in-rodata
16403 @opindex muninit-const-in-rodata
16404 @opindex mno-uninit-const-in-rodata
16405 Put uninitialized @code{const} variables in the read-only data section.
16406 This option is only meaningful in conjunction with @option{-membedded-data}.
16408 @item -mcode-readable=@var{setting}
16409 @opindex mcode-readable
16410 Specify whether GCC may generate code that reads from executable sections.
16411 There are three possible settings:
16413 @table @gcctabopt
16414 @item -mcode-readable=yes
16415 Instructions may freely access executable sections.  This is the
16416 default setting.
16418 @item -mcode-readable=pcrel
16419 MIPS16 PC-relative load instructions can access executable sections,
16420 but other instructions must not do so.  This option is useful on 4KSc
16421 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
16422 It is also useful on processors that can be configured to have a dual
16423 instruction/data SRAM interface and that, like the M4K, automatically
16424 redirect PC-relative loads to the instruction RAM.
16426 @item -mcode-readable=no
16427 Instructions must not access executable sections.  This option can be
16428 useful on targets that are configured to have a dual instruction/data
16429 SRAM interface but that (unlike the M4K) do not automatically redirect
16430 PC-relative loads to the instruction RAM.
16431 @end table
16433 @item -msplit-addresses
16434 @itemx -mno-split-addresses
16435 @opindex msplit-addresses
16436 @opindex mno-split-addresses
16437 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
16438 relocation operators.  This option has been superseded by
16439 @option{-mexplicit-relocs} but is retained for backwards compatibility.
16441 @item -mexplicit-relocs
16442 @itemx -mno-explicit-relocs
16443 @opindex mexplicit-relocs
16444 @opindex mno-explicit-relocs
16445 Use (do not use) assembler relocation operators when dealing with symbolic
16446 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
16447 is to use assembler macros instead.
16449 @option{-mexplicit-relocs} is the default if GCC was configured
16450 to use an assembler that supports relocation operators.
16452 @item -mcheck-zero-division
16453 @itemx -mno-check-zero-division
16454 @opindex mcheck-zero-division
16455 @opindex mno-check-zero-division
16456 Trap (do not trap) on integer division by zero.
16458 The default is @option{-mcheck-zero-division}.
16460 @item -mdivide-traps
16461 @itemx -mdivide-breaks
16462 @opindex mdivide-traps
16463 @opindex mdivide-breaks
16464 MIPS systems check for division by zero by generating either a
16465 conditional trap or a break instruction.  Using traps results in
16466 smaller code, but is only supported on MIPS II and later.  Also, some
16467 versions of the Linux kernel have a bug that prevents trap from
16468 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
16469 allow conditional traps on architectures that support them and
16470 @option{-mdivide-breaks} to force the use of breaks.
16472 The default is usually @option{-mdivide-traps}, but this can be
16473 overridden at configure time using @option{--with-divide=breaks}.
16474 Divide-by-zero checks can be completely disabled using
16475 @option{-mno-check-zero-division}.
16477 @item -mmemcpy
16478 @itemx -mno-memcpy
16479 @opindex mmemcpy
16480 @opindex mno-memcpy
16481 Force (do not force) the use of @code{memcpy()} for non-trivial block
16482 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
16483 most constant-sized copies.
16485 @item -mlong-calls
16486 @itemx -mno-long-calls
16487 @opindex mlong-calls
16488 @opindex mno-long-calls
16489 Disable (do not disable) use of the @code{jal} instruction.  Calling
16490 functions using @code{jal} is more efficient but requires the caller
16491 and callee to be in the same 256 megabyte segment.
16493 This option has no effect on abicalls code.  The default is
16494 @option{-mno-long-calls}.
16496 @item -mmad
16497 @itemx -mno-mad
16498 @opindex mmad
16499 @opindex mno-mad
16500 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
16501 instructions, as provided by the R4650 ISA@.
16503 @item -mfused-madd
16504 @itemx -mno-fused-madd
16505 @opindex mfused-madd
16506 @opindex mno-fused-madd
16507 Enable (disable) use of the floating-point multiply-accumulate
16508 instructions, when they are available.  The default is
16509 @option{-mfused-madd}.
16511 On the R8000 CPU when multiply-accumulate instructions are used,
16512 the intermediate product is calculated to infinite precision
16513 and is not subject to the FCSR Flush to Zero bit.  This may be
16514 undesirable in some circumstances.  On other processors the result
16515 is numerically identical to the equivalent computation using
16516 separate multiply, add, subtract and negate instructions.
16518 @item -nocpp
16519 @opindex nocpp
16520 Tell the MIPS assembler to not run its preprocessor over user
16521 assembler files (with a @samp{.s} suffix) when assembling them.
16523 @item -mfix-24k
16524 @item -mno-fix-24k
16525 @opindex mfix-24k
16526 @opindex mno-fix-24k
16527 Work around the 24K E48 (lost data on stores during refill) errata.
16528 The workarounds are implemented by the assembler rather than by GCC@.
16530 @item -mfix-r4000
16531 @itemx -mno-fix-r4000
16532 @opindex mfix-r4000
16533 @opindex mno-fix-r4000
16534 Work around certain R4000 CPU errata:
16535 @itemize @minus
16536 @item
16537 A double-word or a variable shift may give an incorrect result if executed
16538 immediately after starting an integer division.
16539 @item
16540 A double-word or a variable shift may give an incorrect result if executed
16541 while an integer multiplication is in progress.
16542 @item
16543 An integer division may give an incorrect result if started in a delay slot
16544 of a taken branch or a jump.
16545 @end itemize
16547 @item -mfix-r4400
16548 @itemx -mno-fix-r4400
16549 @opindex mfix-r4400
16550 @opindex mno-fix-r4400
16551 Work around certain R4400 CPU errata:
16552 @itemize @minus
16553 @item
16554 A double-word or a variable shift may give an incorrect result if executed
16555 immediately after starting an integer division.
16556 @end itemize
16558 @item -mfix-r10000
16559 @itemx -mno-fix-r10000
16560 @opindex mfix-r10000
16561 @opindex mno-fix-r10000
16562 Work around certain R10000 errata:
16563 @itemize @minus
16564 @item
16565 @code{ll}/@code{sc} sequences may not behave atomically on revisions
16566 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
16567 @end itemize
16569 This option can only be used if the target architecture supports
16570 branch-likely instructions.  @option{-mfix-r10000} is the default when
16571 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
16572 otherwise.
16574 @item -mfix-vr4120
16575 @itemx -mno-fix-vr4120
16576 @opindex mfix-vr4120
16577 Work around certain VR4120 errata:
16578 @itemize @minus
16579 @item
16580 @code{dmultu} does not always produce the correct result.
16581 @item
16582 @code{div} and @code{ddiv} do not always produce the correct result if one
16583 of the operands is negative.
16584 @end itemize
16585 The workarounds for the division errata rely on special functions in
16586 @file{libgcc.a}.  At present, these functions are only provided by
16587 the @code{mips64vr*-elf} configurations.
16589 Other VR4120 errata require a NOP to be inserted between certain pairs of
16590 instructions.  These errata are handled by the assembler, not by GCC itself.
16592 @item -mfix-vr4130
16593 @opindex mfix-vr4130
16594 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
16595 workarounds are implemented by the assembler rather than by GCC,
16596 although GCC avoids using @code{mflo} and @code{mfhi} if the
16597 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16598 instructions are available instead.
16600 @item -mfix-sb1
16601 @itemx -mno-fix-sb1
16602 @opindex mfix-sb1
16603 Work around certain SB-1 CPU core errata.
16604 (This flag currently works around the SB-1 revision 2
16605 ``F1'' and ``F2'' floating-point errata.)
16607 @item -mr10k-cache-barrier=@var{setting}
16608 @opindex mr10k-cache-barrier
16609 Specify whether GCC should insert cache barriers to avoid the
16610 side-effects of speculation on R10K processors.
16612 In common with many processors, the R10K tries to predict the outcome
16613 of a conditional branch and speculatively executes instructions from
16614 the ``taken'' branch.  It later aborts these instructions if the
16615 predicted outcome is wrong.  However, on the R10K, even aborted
16616 instructions can have side effects.
16618 This problem only affects kernel stores and, depending on the system,
16619 kernel loads.  As an example, a speculatively-executed store may load
16620 the target memory into cache and mark the cache line as dirty, even if
16621 the store itself is later aborted.  If a DMA operation writes to the
16622 same area of memory before the ``dirty'' line is flushed, the cached
16623 data overwrites the DMA-ed data.  See the R10K processor manual
16624 for a full description, including other potential problems.
16626 One workaround is to insert cache barrier instructions before every memory
16627 access that might be speculatively executed and that might have side
16628 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
16629 controls GCC's implementation of this workaround.  It assumes that
16630 aborted accesses to any byte in the following regions does not have
16631 side effects:
16633 @enumerate
16634 @item
16635 the memory occupied by the current function's stack frame;
16637 @item
16638 the memory occupied by an incoming stack argument;
16640 @item
16641 the memory occupied by an object with a link-time-constant address.
16642 @end enumerate
16644 It is the kernel's responsibility to ensure that speculative
16645 accesses to these regions are indeed safe.
16647 If the input program contains a function declaration such as:
16649 @smallexample
16650 void foo (void);
16651 @end smallexample
16653 then the implementation of @code{foo} must allow @code{j foo} and
16654 @code{jal foo} to be executed speculatively.  GCC honors this
16655 restriction for functions it compiles itself.  It expects non-GCC
16656 functions (such as hand-written assembly code) to do the same.
16658 The option has three forms:
16660 @table @gcctabopt
16661 @item -mr10k-cache-barrier=load-store
16662 Insert a cache barrier before a load or store that might be
16663 speculatively executed and that might have side effects even
16664 if aborted.
16666 @item -mr10k-cache-barrier=store
16667 Insert a cache barrier before a store that might be speculatively
16668 executed and that might have side effects even if aborted.
16670 @item -mr10k-cache-barrier=none
16671 Disable the insertion of cache barriers.  This is the default setting.
16672 @end table
16674 @item -mflush-func=@var{func}
16675 @itemx -mno-flush-func
16676 @opindex mflush-func
16677 Specifies the function to call to flush the I and D caches, or to not
16678 call any such function.  If called, the function must take the same
16679 arguments as the common @code{_flush_func()}, that is, the address of the
16680 memory range for which the cache is being flushed, the size of the
16681 memory range, and the number 3 (to flush both caches).  The default
16682 depends on the target GCC was configured for, but commonly is either
16683 @samp{_flush_func} or @samp{__cpu_flush}.
16685 @item mbranch-cost=@var{num}
16686 @opindex mbranch-cost
16687 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16688 This cost is only a heuristic and is not guaranteed to produce
16689 consistent results across releases.  A zero cost redundantly selects
16690 the default, which is based on the @option{-mtune} setting.
16692 @item -mbranch-likely
16693 @itemx -mno-branch-likely
16694 @opindex mbranch-likely
16695 @opindex mno-branch-likely
16696 Enable or disable use of Branch Likely instructions, regardless of the
16697 default for the selected architecture.  By default, Branch Likely
16698 instructions may be generated if they are supported by the selected
16699 architecture.  An exception is for the MIPS32 and MIPS64 architectures
16700 and processors that implement those architectures; for those, Branch
16701 Likely instructions are not be generated by default because the MIPS32
16702 and MIPS64 architectures specifically deprecate their use.
16704 @item -mfp-exceptions
16705 @itemx -mno-fp-exceptions
16706 @opindex mfp-exceptions
16707 Specifies whether FP exceptions are enabled.  This affects how
16708 FP instructions are scheduled for some processors.
16709 The default is that FP exceptions are
16710 enabled.
16712 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16713 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16714 FP pipe.
16716 @item -mvr4130-align
16717 @itemx -mno-vr4130-align
16718 @opindex mvr4130-align
16719 The VR4130 pipeline is two-way superscalar, but can only issue two
16720 instructions together if the first one is 8-byte aligned.  When this
16721 option is enabled, GCC aligns pairs of instructions that it
16722 thinks should execute in parallel.
16724 This option only has an effect when optimizing for the VR4130.
16725 It normally makes code faster, but at the expense of making it bigger.
16726 It is enabled by default at optimization level @option{-O3}.
16728 @item -msynci
16729 @itemx -mno-synci
16730 @opindex msynci
16731 Enable (disable) generation of @code{synci} instructions on
16732 architectures that support it.  The @code{synci} instructions (if
16733 enabled) are generated when @code{__builtin___clear_cache()} is
16734 compiled.
16736 This option defaults to @code{-mno-synci}, but the default can be
16737 overridden by configuring with @code{--with-synci}.
16739 When compiling code for single processor systems, it is generally safe
16740 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16741 does not invalidate the instruction caches on all cores and may lead
16742 to undefined behavior.
16744 @item -mrelax-pic-calls
16745 @itemx -mno-relax-pic-calls
16746 @opindex mrelax-pic-calls
16747 Try to turn PIC calls that are normally dispatched via register
16748 @code{$25} into direct calls.  This is only possible if the linker can
16749 resolve the destination at link-time and if the destination is within
16750 range for a direct call.
16752 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16753 an assembler and a linker that support the @code{.reloc} assembly
16754 directive and @code{-mexplicit-relocs} is in effect.  With
16755 @code{-mno-explicit-relocs}, this optimization can be performed by the
16756 assembler and the linker alone without help from the compiler.
16758 @item -mmcount-ra-address
16759 @itemx -mno-mcount-ra-address
16760 @opindex mmcount-ra-address
16761 @opindex mno-mcount-ra-address
16762 Emit (do not emit) code that allows @code{_mcount} to modify the
16763 calling function's return address.  When enabled, this option extends
16764 the usual @code{_mcount} interface with a new @var{ra-address}
16765 parameter, which has type @code{intptr_t *} and is passed in register
16766 @code{$12}.  @code{_mcount} can then modify the return address by
16767 doing both of the following:
16768 @itemize
16769 @item
16770 Returning the new address in register @code{$31}.
16771 @item
16772 Storing the new address in @code{*@var{ra-address}},
16773 if @var{ra-address} is nonnull.
16774 @end itemize
16776 The default is @option{-mno-mcount-ra-address}.
16778 @end table
16780 @node MMIX Options
16781 @subsection MMIX Options
16782 @cindex MMIX Options
16784 These options are defined for the MMIX:
16786 @table @gcctabopt
16787 @item -mlibfuncs
16788 @itemx -mno-libfuncs
16789 @opindex mlibfuncs
16790 @opindex mno-libfuncs
16791 Specify that intrinsic library functions are being compiled, passing all
16792 values in registers, no matter the size.
16794 @item -mepsilon
16795 @itemx -mno-epsilon
16796 @opindex mepsilon
16797 @opindex mno-epsilon
16798 Generate floating-point comparison instructions that compare with respect
16799 to the @code{rE} epsilon register.
16801 @item -mabi=mmixware
16802 @itemx -mabi=gnu
16803 @opindex mabi=mmixware
16804 @opindex mabi=gnu
16805 Generate code that passes function parameters and return values that (in
16806 the called function) are seen as registers @code{$0} and up, as opposed to
16807 the GNU ABI which uses global registers @code{$231} and up.
16809 @item -mzero-extend
16810 @itemx -mno-zero-extend
16811 @opindex mzero-extend
16812 @opindex mno-zero-extend
16813 When reading data from memory in sizes shorter than 64 bits, use (do not
16814 use) zero-extending load instructions by default, rather than
16815 sign-extending ones.
16817 @item -mknuthdiv
16818 @itemx -mno-knuthdiv
16819 @opindex mknuthdiv
16820 @opindex mno-knuthdiv
16821 Make the result of a division yielding a remainder have the same sign as
16822 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16823 remainder follows the sign of the dividend.  Both methods are
16824 arithmetically valid, the latter being almost exclusively used.
16826 @item -mtoplevel-symbols
16827 @itemx -mno-toplevel-symbols
16828 @opindex mtoplevel-symbols
16829 @opindex mno-toplevel-symbols
16830 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16831 code can be used with the @code{PREFIX} assembly directive.
16833 @item -melf
16834 @opindex melf
16835 Generate an executable in the ELF format, rather than the default
16836 @samp{mmo} format used by the @command{mmix} simulator.
16838 @item -mbranch-predict
16839 @itemx -mno-branch-predict
16840 @opindex mbranch-predict
16841 @opindex mno-branch-predict
16842 Use (do not use) the probable-branch instructions, when static branch
16843 prediction indicates a probable branch.
16845 @item -mbase-addresses
16846 @itemx -mno-base-addresses
16847 @opindex mbase-addresses
16848 @opindex mno-base-addresses
16849 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16850 base address automatically generates a request (handled by the assembler
16851 and the linker) for a constant to be set up in a global register.  The
16852 register is used for one or more base address requests within the range 0
16853 to 255 from the value held in the register.  The generally leads to short
16854 and fast code, but the number of different data items that can be
16855 addressed is limited.  This means that a program that uses lots of static
16856 data may require @option{-mno-base-addresses}.
16858 @item -msingle-exit
16859 @itemx -mno-single-exit
16860 @opindex msingle-exit
16861 @opindex mno-single-exit
16862 Force (do not force) generated code to have a single exit point in each
16863 function.
16864 @end table
16866 @node MN10300 Options
16867 @subsection MN10300 Options
16868 @cindex MN10300 options
16870 These @option{-m} options are defined for Matsushita MN10300 architectures:
16872 @table @gcctabopt
16873 @item -mmult-bug
16874 @opindex mmult-bug
16875 Generate code to avoid bugs in the multiply instructions for the MN10300
16876 processors.  This is the default.
16878 @item -mno-mult-bug
16879 @opindex mno-mult-bug
16880 Do not generate code to avoid bugs in the multiply instructions for the
16881 MN10300 processors.
16883 @item -mam33
16884 @opindex mam33
16885 Generate code using features specific to the AM33 processor.
16887 @item -mno-am33
16888 @opindex mno-am33
16889 Do not generate code using features specific to the AM33 processor.  This
16890 is the default.
16892 @item -mam33-2
16893 @opindex mam33-2
16894 Generate code using features specific to the AM33/2.0 processor.
16896 @item -mam34
16897 @opindex mam34
16898 Generate code using features specific to the AM34 processor.
16900 @item -mtune=@var{cpu-type}
16901 @opindex mtune
16902 Use the timing characteristics of the indicated CPU type when
16903 scheduling instructions.  This does not change the targeted processor
16904 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16905 @samp{am33-2} or @samp{am34}.
16907 @item -mreturn-pointer-on-d0
16908 @opindex mreturn-pointer-on-d0
16909 When generating a function that returns a pointer, return the pointer
16910 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16911 only in @code{a0}, and attempts to call such functions without a prototype
16912 result in errors.  Note that this option is on by default; use
16913 @option{-mno-return-pointer-on-d0} to disable it.
16915 @item -mno-crt0
16916 @opindex mno-crt0
16917 Do not link in the C run-time initialization object file.
16919 @item -mrelax
16920 @opindex mrelax
16921 Indicate to the linker that it should perform a relaxation optimization pass
16922 to shorten branches, calls and absolute memory addresses.  This option only
16923 has an effect when used on the command line for the final link step.
16925 This option makes symbolic debugging impossible.
16927 @item -mliw
16928 @opindex mliw
16929 Allow the compiler to generate @emph{Long Instruction Word}
16930 instructions if the target is the @samp{AM33} or later.  This is the
16931 default.  This option defines the preprocessor macro @samp{__LIW__}.
16933 @item -mnoliw
16934 @opindex mnoliw
16935 Do not allow the compiler to generate @emph{Long Instruction Word}
16936 instructions.  This option defines the preprocessor macro
16937 @samp{__NO_LIW__}.
16939 @item -msetlb
16940 @opindex msetlb
16941 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16942 instructions if the target is the @samp{AM33} or later.  This is the
16943 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16945 @item -mnosetlb
16946 @opindex mnosetlb
16947 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16948 instructions.  This option defines the preprocessor macro
16949 @samp{__NO_SETLB__}.
16951 @end table
16953 @node Moxie Options
16954 @subsection Moxie Options
16955 @cindex Moxie Options
16957 @table @gcctabopt
16959 @item -meb
16960 @opindex meb
16961 Generate big-endian code.  This is the default for @samp{moxie-*-*}
16962 configurations.
16964 @item -mel
16965 @opindex mel
16966 Generate little-endian code.
16968 @item -mno-crt0
16969 @opindex mno-crt0
16970 Do not link in the C run-time initialization object file.
16972 @end table
16974 @node PDP-11 Options
16975 @subsection PDP-11 Options
16976 @cindex PDP-11 Options
16978 These options are defined for the PDP-11:
16980 @table @gcctabopt
16981 @item -mfpu
16982 @opindex mfpu
16983 Use hardware FPP floating point.  This is the default.  (FIS floating
16984 point on the PDP-11/40 is not supported.)
16986 @item -msoft-float
16987 @opindex msoft-float
16988 Do not use hardware floating point.
16990 @item -mac0
16991 @opindex mac0
16992 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16994 @item -mno-ac0
16995 @opindex mno-ac0
16996 Return floating-point results in memory.  This is the default.
16998 @item -m40
16999 @opindex m40
17000 Generate code for a PDP-11/40.
17002 @item -m45
17003 @opindex m45
17004 Generate code for a PDP-11/45.  This is the default.
17006 @item -m10
17007 @opindex m10
17008 Generate code for a PDP-11/10.
17010 @item -mbcopy-builtin
17011 @opindex mbcopy-builtin
17012 Use inline @code{movmemhi} patterns for copying memory.  This is the
17013 default.
17015 @item -mbcopy
17016 @opindex mbcopy
17017 Do not use inline @code{movmemhi} patterns for copying memory.
17019 @item -mint16
17020 @itemx -mno-int32
17021 @opindex mint16
17022 @opindex mno-int32
17023 Use 16-bit @code{int}.  This is the default.
17025 @item -mint32
17026 @itemx -mno-int16
17027 @opindex mint32
17028 @opindex mno-int16
17029 Use 32-bit @code{int}.
17031 @item -mfloat64
17032 @itemx -mno-float32
17033 @opindex mfloat64
17034 @opindex mno-float32
17035 Use 64-bit @code{float}.  This is the default.
17037 @item -mfloat32
17038 @itemx -mno-float64
17039 @opindex mfloat32
17040 @opindex mno-float64
17041 Use 32-bit @code{float}.
17043 @item -mabshi
17044 @opindex mabshi
17045 Use @code{abshi2} pattern.  This is the default.
17047 @item -mno-abshi
17048 @opindex mno-abshi
17049 Do not use @code{abshi2} pattern.
17051 @item -mbranch-expensive
17052 @opindex mbranch-expensive
17053 Pretend that branches are expensive.  This is for experimenting with
17054 code generation only.
17056 @item -mbranch-cheap
17057 @opindex mbranch-cheap
17058 Do not pretend that branches are expensive.  This is the default.
17060 @item -munix-asm
17061 @opindex munix-asm
17062 Use Unix assembler syntax.  This is the default when configured for
17063 @samp{pdp11-*-bsd}.
17065 @item -mdec-asm
17066 @opindex mdec-asm
17067 Use DEC assembler syntax.  This is the default when configured for any
17068 PDP-11 target other than @samp{pdp11-*-bsd}.
17069 @end table
17071 @node picoChip Options
17072 @subsection picoChip Options
17073 @cindex picoChip options
17075 These @samp{-m} options are defined for picoChip implementations:
17077 @table @gcctabopt
17079 @item -mae=@var{ae_type}
17080 @opindex mcpu
17081 Set the instruction set, register set, and instruction scheduling
17082 parameters for array element type @var{ae_type}.  Supported values
17083 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
17085 @option{-mae=ANY} selects a completely generic AE type.  Code
17086 generated with this option runs on any of the other AE types.  The
17087 code is not as efficient as it would be if compiled for a specific
17088 AE type, and some types of operation (e.g., multiplication) do not
17089 work properly on all types of AE.
17091 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
17092 for compiled code, and is the default.
17094 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
17095 option may suffer from poor performance of byte (char) manipulation,
17096 since the DSP AE does not provide hardware support for byte load/stores.
17098 @item -msymbol-as-address
17099 Enable the compiler to directly use a symbol name as an address in a
17100 load/store instruction, without first loading it into a
17101 register.  Typically, the use of this option generates larger
17102 programs, which run faster than when the option isn't used.  However, the
17103 results vary from program to program, so it is left as a user option,
17104 rather than being permanently enabled.
17106 @item -mno-inefficient-warnings
17107 Disables warnings about the generation of inefficient code.  These
17108 warnings can be generated, for example, when compiling code that
17109 performs byte-level memory operations on the MAC AE type.  The MAC AE has
17110 no hardware support for byte-level memory operations, so all byte
17111 load/stores must be synthesized from word load/store operations.  This is
17112 inefficient and a warning is generated to indicate
17113 that you should rewrite the code to avoid byte operations, or to target
17114 an AE type that has the necessary hardware support.  This option disables
17115 these warnings.
17117 @end table
17119 @node PowerPC Options
17120 @subsection PowerPC Options
17121 @cindex PowerPC options
17123 These are listed under @xref{RS/6000 and PowerPC Options}.
17125 @node RL78 Options
17126 @subsection RL78 Options
17127 @cindex RL78 Options
17129 @table @gcctabopt
17131 @item -msim
17132 @opindex msim
17133 Links in additional target libraries to support operation within a
17134 simulator.
17136 @item -mmul=none
17137 @itemx -mmul=g13
17138 @itemx -mmul=rl78
17139 @opindex mmul
17140 Specifies the type of hardware multiplication support to be used.  The
17141 default is @code{none}, which uses software multiplication functions.
17142 The @code{g13} option is for the hardware multiply/divide peripheral
17143 only on the RL78/G13 targets.  The @code{rl78} option is for the
17144 standard hardware multiplication defined in the RL78 software manual.
17146 @end table
17148 @node RS/6000 and PowerPC Options
17149 @subsection IBM RS/6000 and PowerPC Options
17150 @cindex RS/6000 and PowerPC Options
17151 @cindex IBM RS/6000 and PowerPC Options
17153 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
17154 @table @gcctabopt
17155 @item -mpowerpc-gpopt
17156 @itemx -mno-powerpc-gpopt
17157 @itemx -mpowerpc-gfxopt
17158 @itemx -mno-powerpc-gfxopt
17159 @need 800
17160 @itemx -mpowerpc64
17161 @itemx -mno-powerpc64
17162 @itemx -mmfcrf
17163 @itemx -mno-mfcrf
17164 @itemx -mpopcntb
17165 @itemx -mno-popcntb
17166 @itemx -mpopcntd
17167 @itemx -mno-popcntd
17168 @itemx -mfprnd
17169 @itemx -mno-fprnd
17170 @need 800
17171 @itemx -mcmpb
17172 @itemx -mno-cmpb
17173 @itemx -mmfpgpr
17174 @itemx -mno-mfpgpr
17175 @itemx -mhard-dfp
17176 @itemx -mno-hard-dfp
17177 @opindex mpowerpc-gpopt
17178 @opindex mno-powerpc-gpopt
17179 @opindex mpowerpc-gfxopt
17180 @opindex mno-powerpc-gfxopt
17181 @opindex mpowerpc64
17182 @opindex mno-powerpc64
17183 @opindex mmfcrf
17184 @opindex mno-mfcrf
17185 @opindex mpopcntb
17186 @opindex mno-popcntb
17187 @opindex mpopcntd
17188 @opindex mno-popcntd
17189 @opindex mfprnd
17190 @opindex mno-fprnd
17191 @opindex mcmpb
17192 @opindex mno-cmpb
17193 @opindex mmfpgpr
17194 @opindex mno-mfpgpr
17195 @opindex mhard-dfp
17196 @opindex mno-hard-dfp
17197 You use these options to specify which instructions are available on the
17198 processor you are using.  The default value of these options is
17199 determined when configuring GCC@.  Specifying the
17200 @option{-mcpu=@var{cpu_type}} overrides the specification of these
17201 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
17202 rather than the options listed above.
17204 Specifying @option{-mpowerpc-gpopt} allows
17205 GCC to use the optional PowerPC architecture instructions in the
17206 General Purpose group, including floating-point square root.  Specifying
17207 @option{-mpowerpc-gfxopt} allows GCC to
17208 use the optional PowerPC architecture instructions in the Graphics
17209 group, including floating-point select.
17211 The @option{-mmfcrf} option allows GCC to generate the move from
17212 condition register field instruction implemented on the POWER4
17213 processor and other processors that support the PowerPC V2.01
17214 architecture.
17215 The @option{-mpopcntb} option allows GCC to generate the popcount and
17216 double-precision FP reciprocal estimate instruction implemented on the
17217 POWER5 processor and other processors that support the PowerPC V2.02
17218 architecture.
17219 The @option{-mpopcntd} option allows GCC to generate the popcount
17220 instruction implemented on the POWER7 processor and other processors
17221 that support the PowerPC V2.06 architecture.
17222 The @option{-mfprnd} option allows GCC to generate the FP round to
17223 integer instructions implemented on the POWER5+ processor and other
17224 processors that support the PowerPC V2.03 architecture.
17225 The @option{-mcmpb} option allows GCC to generate the compare bytes
17226 instruction implemented on the POWER6 processor and other processors
17227 that support the PowerPC V2.05 architecture.
17228 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
17229 general-purpose register instructions implemented on the POWER6X
17230 processor and other processors that support the extended PowerPC V2.05
17231 architecture.
17232 The @option{-mhard-dfp} option allows GCC to generate the decimal
17233 floating-point instructions implemented on some POWER processors.
17235 The @option{-mpowerpc64} option allows GCC to generate the additional
17236 64-bit instructions that are found in the full PowerPC64 architecture
17237 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
17238 @option{-mno-powerpc64}.
17240 @item -mcpu=@var{cpu_type}
17241 @opindex mcpu
17242 Set architecture type, register usage, and
17243 instruction scheduling parameters for machine type @var{cpu_type}.
17244 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
17245 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
17246 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
17247 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
17248 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
17249 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
17250 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
17251 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
17252 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
17253 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
17254 @samp{powerpc64}, and @samp{rs64}.
17256 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
17257 PowerPC and 64-bit PowerPC architecture machine
17258 types, with an appropriate, generic processor model assumed for
17259 scheduling purposes.
17261 The other options specify a specific processor.  Code generated under
17262 those options runs best on that processor, and may not run at all on
17263 others.
17265 The @option{-mcpu} options automatically enable or disable the
17266 following options:
17268 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
17269 -mpopcntb -mpopcntd  -mpowerpc64 @gol
17270 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
17271 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
17272 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
17273 -mquad-memory -mquad-memory-atomic}
17275 The particular options set for any particular CPU varies between
17276 compiler versions, depending on what setting seems to produce optimal
17277 code for that CPU; it doesn't necessarily reflect the actual hardware's
17278 capabilities.  If you wish to set an individual option to a particular
17279 value, you may specify it after the @option{-mcpu} option, like
17280 @option{-mcpu=970 -mno-altivec}.
17282 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
17283 not enabled or disabled by the @option{-mcpu} option at present because
17284 AIX does not have full support for these options.  You may still
17285 enable or disable them individually if you're sure it'll work in your
17286 environment.
17288 @item -mtune=@var{cpu_type}
17289 @opindex mtune
17290 Set the instruction scheduling parameters for machine type
17291 @var{cpu_type}, but do not set the architecture type or register usage,
17292 as @option{-mcpu=@var{cpu_type}} does.  The same
17293 values for @var{cpu_type} are used for @option{-mtune} as for
17294 @option{-mcpu}.  If both are specified, the code generated uses the
17295 architecture and registers set by @option{-mcpu}, but the
17296 scheduling parameters set by @option{-mtune}.
17298 @item -mcmodel=small
17299 @opindex mcmodel=small
17300 Generate PowerPC64 code for the small model: The TOC is limited to
17301 64k.
17303 @item -mcmodel=medium
17304 @opindex mcmodel=medium
17305 Generate PowerPC64 code for the medium model: The TOC and other static
17306 data may be up to a total of 4G in size.
17308 @item -mcmodel=large
17309 @opindex mcmodel=large
17310 Generate PowerPC64 code for the large model: The TOC may be up to 4G
17311 in size.  Other data and code is only limited by the 64-bit address
17312 space.
17314 @item -maltivec
17315 @itemx -mno-altivec
17316 @opindex maltivec
17317 @opindex mno-altivec
17318 Generate code that uses (does not use) AltiVec instructions, and also
17319 enable the use of built-in functions that allow more direct access to
17320 the AltiVec instruction set.  You may also need to set
17321 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
17322 enhancements.
17324 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
17325 @option{-maltivec=be}, the element order for Altivec intrinsics such
17326 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
17327 match array element order corresponding to the endianness of the
17328 target.  That is, element zero identifies the leftmost element in a
17329 vector register when targeting a big-endian platform, and identifies
17330 the rightmost element in a vector register when targeting a
17331 little-endian platform.
17333 @item -maltivec=be
17334 @opindex maltivec=be
17335 Generate Altivec instructions using big-endian element order,
17336 regardless of whether the target is big- or little-endian.  This is
17337 the default when targeting a big-endian platform.
17339 The element order is used to interpret element numbers in Altivec
17340 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
17341 @code{vec_insert}.  By default, these will match array element order
17342 corresponding to the endianness for the target.
17344 @item -maltivec=le
17345 @opindex maltivec=le
17346 Generate Altivec instructions using little-endian element order,
17347 regardless of whether the target is big- or little-endian.  This is
17348 the default when targeting a little-endian platform.  This option is
17349 currently ignored when targeting a big-endian platform.
17351 The element order is used to interpret element numbers in Altivec
17352 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
17353 @code{vec_insert}.  By default, these will match array element order
17354 corresponding to the endianness for the target.
17356 @item -mvrsave
17357 @itemx -mno-vrsave
17358 @opindex mvrsave
17359 @opindex mno-vrsave
17360 Generate VRSAVE instructions when generating AltiVec code.
17362 @item -mgen-cell-microcode
17363 @opindex mgen-cell-microcode
17364 Generate Cell microcode instructions.
17366 @item -mwarn-cell-microcode
17367 @opindex mwarn-cell-microcode
17368 Warn when a Cell microcode instruction is emitted.  An example
17369 of a Cell microcode instruction is a variable shift.
17371 @item -msecure-plt
17372 @opindex msecure-plt
17373 Generate code that allows @command{ld} and @command{ld.so}
17374 to build executables and shared
17375 libraries with non-executable @code{.plt} and @code{.got} sections.
17376 This is a PowerPC
17377 32-bit SYSV ABI option.
17379 @item -mbss-plt
17380 @opindex mbss-plt
17381 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
17382 fills in, and
17383 requires @code{.plt} and @code{.got}
17384 sections that are both writable and executable.
17385 This is a PowerPC 32-bit SYSV ABI option.
17387 @item -misel
17388 @itemx -mno-isel
17389 @opindex misel
17390 @opindex mno-isel
17391 This switch enables or disables the generation of ISEL instructions.
17393 @item -misel=@var{yes/no}
17394 This switch has been deprecated.  Use @option{-misel} and
17395 @option{-mno-isel} instead.
17397 @item -mspe
17398 @itemx -mno-spe
17399 @opindex mspe
17400 @opindex mno-spe
17401 This switch enables or disables the generation of SPE simd
17402 instructions.
17404 @item -mpaired
17405 @itemx -mno-paired
17406 @opindex mpaired
17407 @opindex mno-paired
17408 This switch enables or disables the generation of PAIRED simd
17409 instructions.
17411 @item -mspe=@var{yes/no}
17412 This option has been deprecated.  Use @option{-mspe} and
17413 @option{-mno-spe} instead.
17415 @item -mvsx
17416 @itemx -mno-vsx
17417 @opindex mvsx
17418 @opindex mno-vsx
17419 Generate code that uses (does not use) vector/scalar (VSX)
17420 instructions, and also enable the use of built-in functions that allow
17421 more direct access to the VSX instruction set.
17423 @item -mcrypto
17424 @itemx -mno-crypto
17425 @opindex mcrypto
17426 @opindex mno-crypto
17427 Enable the use (disable) of the built-in functions that allow direct
17428 access to the cryptographic instructions that were added in version
17429 2.07 of the PowerPC ISA.
17431 @item -mdirect-move
17432 @itemx -mno-direct-move
17433 @opindex mdirect-move
17434 @opindex mno-direct-move
17435 Generate code that uses (does not use) the instructions to move data
17436 between the general purpose registers and the vector/scalar (VSX)
17437 registers that were added in version 2.07 of the PowerPC ISA.
17439 @item -mpower8-fusion
17440 @itemx -mno-power8-fusion
17441 @opindex mpower8-fusion
17442 @opindex mno-power8-fusion
17443 Generate code that keeps (does not keeps) some integer operations
17444 adjacent so that the instructions can be fused together on power8 and
17445 later processors.
17447 @item -mpower8-vector
17448 @itemx -mno-power8-vector
17449 @opindex mpower8-vector
17450 @opindex mno-power8-vector
17451 Generate code that uses (does not use) the vector and scalar
17452 instructions that were added in version 2.07 of the PowerPC ISA.  Also
17453 enable the use of built-in functions that allow more direct access to
17454 the vector instructions.
17456 @item -mquad-memory
17457 @itemx -mno-quad-memory
17458 @opindex mquad-memory
17459 @opindex mno-quad-memory
17460 Generate code that uses (does not use) the non-atomic quad word memory
17461 instructions.  The @option{-mquad-memory} option requires use of
17462 64-bit mode.
17464 @item -mquad-memory-atomic
17465 @itemx -mno-quad-memory-atomic
17466 @opindex mquad-memory-atomic
17467 @opindex mno-quad-memory-atomic
17468 Generate code that uses (does not use) the atomic quad word memory
17469 instructions.  The @option{-mquad-memory-atomic} option requires use of
17470 64-bit mode.
17472 @item -mfloat-gprs=@var{yes/single/double/no}
17473 @itemx -mfloat-gprs
17474 @opindex mfloat-gprs
17475 This switch enables or disables the generation of floating-point
17476 operations on the general-purpose registers for architectures that
17477 support it.
17479 The argument @var{yes} or @var{single} enables the use of
17480 single-precision floating-point operations.
17482 The argument @var{double} enables the use of single and
17483 double-precision floating-point operations.
17485 The argument @var{no} disables floating-point operations on the
17486 general-purpose registers.
17488 This option is currently only available on the MPC854x.
17490 @item -m32
17491 @itemx -m64
17492 @opindex m32
17493 @opindex m64
17494 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
17495 targets (including GNU/Linux).  The 32-bit environment sets int, long
17496 and pointer to 32 bits and generates code that runs on any PowerPC
17497 variant.  The 64-bit environment sets int to 32 bits and long and
17498 pointer to 64 bits, and generates code for PowerPC64, as for
17499 @option{-mpowerpc64}.
17501 @item -mfull-toc
17502 @itemx -mno-fp-in-toc
17503 @itemx -mno-sum-in-toc
17504 @itemx -mminimal-toc
17505 @opindex mfull-toc
17506 @opindex mno-fp-in-toc
17507 @opindex mno-sum-in-toc
17508 @opindex mminimal-toc
17509 Modify generation of the TOC (Table Of Contents), which is created for
17510 every executable file.  The @option{-mfull-toc} option is selected by
17511 default.  In that case, GCC allocates at least one TOC entry for
17512 each unique non-automatic variable reference in your program.  GCC
17513 also places floating-point constants in the TOC@.  However, only
17514 16,384 entries are available in the TOC@.
17516 If you receive a linker error message that saying you have overflowed
17517 the available TOC space, you can reduce the amount of TOC space used
17518 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
17519 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
17520 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
17521 generate code to calculate the sum of an address and a constant at
17522 run time instead of putting that sum into the TOC@.  You may specify one
17523 or both of these options.  Each causes GCC to produce very slightly
17524 slower and larger code at the expense of conserving TOC space.
17526 If you still run out of space in the TOC even when you specify both of
17527 these options, specify @option{-mminimal-toc} instead.  This option causes
17528 GCC to make only one TOC entry for every file.  When you specify this
17529 option, GCC produces code that is slower and larger but which
17530 uses extremely little TOC space.  You may wish to use this option
17531 only on files that contain less frequently-executed code.
17533 @item -maix64
17534 @itemx -maix32
17535 @opindex maix64
17536 @opindex maix32
17537 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
17538 @code{long} type, and the infrastructure needed to support them.
17539 Specifying @option{-maix64} implies @option{-mpowerpc64},
17540 while @option{-maix32} disables the 64-bit ABI and
17541 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
17543 @item -mxl-compat
17544 @itemx -mno-xl-compat
17545 @opindex mxl-compat
17546 @opindex mno-xl-compat
17547 Produce code that conforms more closely to IBM XL compiler semantics
17548 when using AIX-compatible ABI@.  Pass floating-point arguments to
17549 prototyped functions beyond the register save area (RSA) on the stack
17550 in addition to argument FPRs.  Do not assume that most significant
17551 double in 128-bit long double value is properly rounded when comparing
17552 values and converting to double.  Use XL symbol names for long double
17553 support routines.
17555 The AIX calling convention was extended but not initially documented to
17556 handle an obscure K&R C case of calling a function that takes the
17557 address of its arguments with fewer arguments than declared.  IBM XL
17558 compilers access floating-point arguments that do not fit in the
17559 RSA from the stack when a subroutine is compiled without
17560 optimization.  Because always storing floating-point arguments on the
17561 stack is inefficient and rarely needed, this option is not enabled by
17562 default and only is necessary when calling subroutines compiled by IBM
17563 XL compilers without optimization.
17565 @item -mpe
17566 @opindex mpe
17567 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
17568 application written to use message passing with special startup code to
17569 enable the application to run.  The system must have PE installed in the
17570 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
17571 must be overridden with the @option{-specs=} option to specify the
17572 appropriate directory location.  The Parallel Environment does not
17573 support threads, so the @option{-mpe} option and the @option{-pthread}
17574 option are incompatible.
17576 @item -malign-natural
17577 @itemx -malign-power
17578 @opindex malign-natural
17579 @opindex malign-power
17580 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
17581 @option{-malign-natural} overrides the ABI-defined alignment of larger
17582 types, such as floating-point doubles, on their natural size-based boundary.
17583 The option @option{-malign-power} instructs GCC to follow the ABI-specified
17584 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
17586 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
17587 is not supported.
17589 @item -msoft-float
17590 @itemx -mhard-float
17591 @opindex msoft-float
17592 @opindex mhard-float
17593 Generate code that does not use (uses) the floating-point register set.
17594 Software floating-point emulation is provided if you use the
17595 @option{-msoft-float} option, and pass the option to GCC when linking.
17597 @item -msingle-float
17598 @itemx -mdouble-float
17599 @opindex msingle-float
17600 @opindex mdouble-float
17601 Generate code for single- or double-precision floating-point operations.
17602 @option{-mdouble-float} implies @option{-msingle-float}.
17604 @item -msimple-fpu
17605 @opindex msimple-fpu
17606 Do not generate @code{sqrt} and @code{div} instructions for hardware
17607 floating-point unit.
17609 @item -mfpu=@var{name}
17610 @opindex mfpu
17611 Specify type of floating-point unit.  Valid values for @var{name} are
17612 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
17613 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
17614 @samp{sp_full} (equivalent to @option{-msingle-float}),
17615 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
17617 @item -mxilinx-fpu
17618 @opindex mxilinx-fpu
17619 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
17621 @item -mmultiple
17622 @itemx -mno-multiple
17623 @opindex mmultiple
17624 @opindex mno-multiple
17625 Generate code that uses (does not use) the load multiple word
17626 instructions and the store multiple word instructions.  These
17627 instructions are generated by default on POWER systems, and not
17628 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
17629 PowerPC systems, since those instructions do not work when the
17630 processor is in little-endian mode.  The exceptions are PPC740 and
17631 PPC750 which permit these instructions in little-endian mode.
17633 @item -mstring
17634 @itemx -mno-string
17635 @opindex mstring
17636 @opindex mno-string
17637 Generate code that uses (does not use) the load string instructions
17638 and the store string word instructions to save multiple registers and
17639 do small block moves.  These instructions are generated by default on
17640 POWER systems, and not generated on PowerPC systems.  Do not use
17641 @option{-mstring} on little-endian PowerPC systems, since those
17642 instructions do not work when the processor is in little-endian mode.
17643 The exceptions are PPC740 and PPC750 which permit these instructions
17644 in little-endian mode.
17646 @item -mupdate
17647 @itemx -mno-update
17648 @opindex mupdate
17649 @opindex mno-update
17650 Generate code that uses (does not use) the load or store instructions
17651 that update the base register to the address of the calculated memory
17652 location.  These instructions are generated by default.  If you use
17653 @option{-mno-update}, there is a small window between the time that the
17654 stack pointer is updated and the address of the previous frame is
17655 stored, which means code that walks the stack frame across interrupts or
17656 signals may get corrupted data.
17658 @item -mavoid-indexed-addresses
17659 @itemx -mno-avoid-indexed-addresses
17660 @opindex mavoid-indexed-addresses
17661 @opindex mno-avoid-indexed-addresses
17662 Generate code that tries to avoid (not avoid) the use of indexed load
17663 or store instructions. These instructions can incur a performance
17664 penalty on Power6 processors in certain situations, such as when
17665 stepping through large arrays that cross a 16M boundary.  This option
17666 is enabled by default when targeting Power6 and disabled otherwise.
17668 @item -mfused-madd
17669 @itemx -mno-fused-madd
17670 @opindex mfused-madd
17671 @opindex mno-fused-madd
17672 Generate code that uses (does not use) the floating-point multiply and
17673 accumulate instructions.  These instructions are generated by default
17674 if hardware floating point is used.  The machine-dependent
17675 @option{-mfused-madd} option is now mapped to the machine-independent
17676 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17677 mapped to @option{-ffp-contract=off}.
17679 @item -mmulhw
17680 @itemx -mno-mulhw
17681 @opindex mmulhw
17682 @opindex mno-mulhw
17683 Generate code that uses (does not use) the half-word multiply and
17684 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17685 These instructions are generated by default when targeting those
17686 processors.
17688 @item -mdlmzb
17689 @itemx -mno-dlmzb
17690 @opindex mdlmzb
17691 @opindex mno-dlmzb
17692 Generate code that uses (does not use) the string-search @samp{dlmzb}
17693 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
17694 generated by default when targeting those processors.
17696 @item -mno-bit-align
17697 @itemx -mbit-align
17698 @opindex mno-bit-align
17699 @opindex mbit-align
17700 On System V.4 and embedded PowerPC systems do not (do) force structures
17701 and unions that contain bit-fields to be aligned to the base type of the
17702 bit-field.
17704 For example, by default a structure containing nothing but 8
17705 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17706 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
17707 the structure is aligned to a 1-byte boundary and is 1 byte in
17708 size.
17710 @item -mno-strict-align
17711 @itemx -mstrict-align
17712 @opindex mno-strict-align
17713 @opindex mstrict-align
17714 On System V.4 and embedded PowerPC systems do not (do) assume that
17715 unaligned memory references are handled by the system.
17717 @item -mrelocatable
17718 @itemx -mno-relocatable
17719 @opindex mrelocatable
17720 @opindex mno-relocatable
17721 Generate code that allows (does not allow) a static executable to be
17722 relocated to a different address at run time.  A simple embedded
17723 PowerPC system loader should relocate the entire contents of
17724 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17725 a table of 32-bit addresses generated by this option.  For this to
17726 work, all objects linked together must be compiled with
17727 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17728 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17730 @item -mrelocatable-lib
17731 @itemx -mno-relocatable-lib
17732 @opindex mrelocatable-lib
17733 @opindex mno-relocatable-lib
17734 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17735 @code{.fixup} section to allow static executables to be relocated at
17736 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17737 alignment of @option{-mrelocatable}.  Objects compiled with
17738 @option{-mrelocatable-lib} may be linked with objects compiled with
17739 any combination of the @option{-mrelocatable} options.
17741 @item -mno-toc
17742 @itemx -mtoc
17743 @opindex mno-toc
17744 @opindex mtoc
17745 On System V.4 and embedded PowerPC systems do not (do) assume that
17746 register 2 contains a pointer to a global area pointing to the addresses
17747 used in the program.
17749 @item -mlittle
17750 @itemx -mlittle-endian
17751 @opindex mlittle
17752 @opindex mlittle-endian
17753 On System V.4 and embedded PowerPC systems compile code for the
17754 processor in little-endian mode.  The @option{-mlittle-endian} option is
17755 the same as @option{-mlittle}.
17757 @item -mbig
17758 @itemx -mbig-endian
17759 @opindex mbig
17760 @opindex mbig-endian
17761 On System V.4 and embedded PowerPC systems compile code for the
17762 processor in big-endian mode.  The @option{-mbig-endian} option is
17763 the same as @option{-mbig}.
17765 @item -mdynamic-no-pic
17766 @opindex mdynamic-no-pic
17767 On Darwin and Mac OS X systems, compile code so that it is not
17768 relocatable, but that its external references are relocatable.  The
17769 resulting code is suitable for applications, but not shared
17770 libraries.
17772 @item -msingle-pic-base
17773 @opindex msingle-pic-base
17774 Treat the register used for PIC addressing as read-only, rather than
17775 loading it in the prologue for each function.  The runtime system is
17776 responsible for initializing this register with an appropriate value
17777 before execution begins.
17779 @item -mprioritize-restricted-insns=@var{priority}
17780 @opindex mprioritize-restricted-insns
17781 This option controls the priority that is assigned to
17782 dispatch-slot restricted instructions during the second scheduling
17783 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
17784 or @samp{2} to assign no, highest, or second-highest (respectively) 
17785 priority to dispatch-slot restricted
17786 instructions.
17788 @item -msched-costly-dep=@var{dependence_type}
17789 @opindex msched-costly-dep
17790 This option controls which dependences are considered costly
17791 by the target during instruction scheduling.  The argument
17792 @var{dependence_type} takes one of the following values:
17794 @table @asis
17795 @item @samp{no}
17796 No dependence is costly.
17798 @item @samp{all}
17799 All dependences are costly.
17801 @item @samp{true_store_to_load}
17802 A true dependence from store to load is costly.
17804 @item @samp{store_to_load}
17805 Any dependence from store to load is costly.
17807 @item @var{number}
17808 Any dependence for which the latency is greater than or equal to 
17809 @var{number} is costly.
17810 @end table
17812 @item -minsert-sched-nops=@var{scheme}
17813 @opindex minsert-sched-nops
17814 This option controls which NOP insertion scheme is used during
17815 the second scheduling pass.  The argument @var{scheme} takes one of the
17816 following values:
17818 @table @asis
17819 @item @samp{no}
17820 Don't insert NOPs.
17822 @item @samp{pad}
17823 Pad with NOPs any dispatch group that has vacant issue slots,
17824 according to the scheduler's grouping.
17826 @item @samp{regroup_exact}
17827 Insert NOPs to force costly dependent insns into
17828 separate groups.  Insert exactly as many NOPs as needed to force an insn
17829 to a new group, according to the estimated processor grouping.
17831 @item @var{number}
17832 Insert NOPs to force costly dependent insns into
17833 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
17834 @end table
17836 @item -mcall-sysv
17837 @opindex mcall-sysv
17838 On System V.4 and embedded PowerPC systems compile code using calling
17839 conventions that adhere to the March 1995 draft of the System V
17840 Application Binary Interface, PowerPC processor supplement.  This is the
17841 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17843 @item -mcall-sysv-eabi
17844 @itemx -mcall-eabi
17845 @opindex mcall-sysv-eabi
17846 @opindex mcall-eabi
17847 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17849 @item -mcall-sysv-noeabi
17850 @opindex mcall-sysv-noeabi
17851 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17853 @item -mcall-aixdesc
17854 @opindex m
17855 On System V.4 and embedded PowerPC systems compile code for the AIX
17856 operating system.
17858 @item -mcall-linux
17859 @opindex mcall-linux
17860 On System V.4 and embedded PowerPC systems compile code for the
17861 Linux-based GNU system.
17863 @item -mcall-freebsd
17864 @opindex mcall-freebsd
17865 On System V.4 and embedded PowerPC systems compile code for the
17866 FreeBSD operating system.
17868 @item -mcall-netbsd
17869 @opindex mcall-netbsd
17870 On System V.4 and embedded PowerPC systems compile code for the
17871 NetBSD operating system.
17873 @item -mcall-openbsd
17874 @opindex mcall-netbsd
17875 On System V.4 and embedded PowerPC systems compile code for the
17876 OpenBSD operating system.
17878 @item -maix-struct-return
17879 @opindex maix-struct-return
17880 Return all structures in memory (as specified by the AIX ABI)@.
17882 @item -msvr4-struct-return
17883 @opindex msvr4-struct-return
17884 Return structures smaller than 8 bytes in registers (as specified by the
17885 SVR4 ABI)@.
17887 @item -mabi=@var{abi-type}
17888 @opindex mabi
17889 Extend the current ABI with a particular extension, or remove such extension.
17890 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17891 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
17892 @var{elfv1}, @var{elfv2}@.
17894 @item -mabi=spe
17895 @opindex mabi=spe
17896 Extend the current ABI with SPE ABI extensions.  This does not change
17897 the default ABI, instead it adds the SPE ABI extensions to the current
17898 ABI@.
17900 @item -mabi=no-spe
17901 @opindex mabi=no-spe
17902 Disable Book-E SPE ABI extensions for the current ABI@.
17904 @item -mabi=ibmlongdouble
17905 @opindex mabi=ibmlongdouble
17906 Change the current ABI to use IBM extended-precision long double.
17907 This is a PowerPC 32-bit SYSV ABI option.
17909 @item -mabi=ieeelongdouble
17910 @opindex mabi=ieeelongdouble
17911 Change the current ABI to use IEEE extended-precision long double.
17912 This is a PowerPC 32-bit Linux ABI option.
17914 @item -mabi=elfv1
17915 @opindex mabi=elfv1
17916 Change the current ABI to use the ELFv1 ABI.
17917 This is the default ABI for big-endian PowerPC 64-bit Linux.
17918 Overriding the default ABI requires special system support and is
17919 likely to fail in spectacular ways.
17921 @item -mabi=elfv2
17922 @opindex mabi=elfv2
17923 Change the current ABI to use the ELFv2 ABI.
17924 This is the default ABI for little-endian PowerPC 64-bit Linux.
17925 Overriding the default ABI requires special system support and is
17926 likely to fail in spectacular ways.
17928 @item -mprototype
17929 @itemx -mno-prototype
17930 @opindex mprototype
17931 @opindex mno-prototype
17932 On System V.4 and embedded PowerPC systems assume that all calls to
17933 variable argument functions are properly prototyped.  Otherwise, the
17934 compiler must insert an instruction before every non-prototyped call to
17935 set or clear bit 6 of the condition code register (@var{CR}) to
17936 indicate whether floating-point values are passed in the floating-point
17937 registers in case the function takes variable arguments.  With
17938 @option{-mprototype}, only calls to prototyped variable argument functions
17939 set or clear the bit.
17941 @item -msim
17942 @opindex msim
17943 On embedded PowerPC systems, assume that the startup module is called
17944 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17945 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17946 configurations.
17948 @item -mmvme
17949 @opindex mmvme
17950 On embedded PowerPC systems, assume that the startup module is called
17951 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17952 @file{libc.a}.
17954 @item -mads
17955 @opindex mads
17956 On embedded PowerPC systems, assume that the startup module is called
17957 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17958 @file{libc.a}.
17960 @item -myellowknife
17961 @opindex myellowknife
17962 On embedded PowerPC systems, assume that the startup module is called
17963 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17964 @file{libc.a}.
17966 @item -mvxworks
17967 @opindex mvxworks
17968 On System V.4 and embedded PowerPC systems, specify that you are
17969 compiling for a VxWorks system.
17971 @item -memb
17972 @opindex memb
17973 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17974 header to indicate that @samp{eabi} extended relocations are used.
17976 @item -meabi
17977 @itemx -mno-eabi
17978 @opindex meabi
17979 @opindex mno-eabi
17980 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17981 Embedded Applications Binary Interface (EABI), which is a set of
17982 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17983 means that the stack is aligned to an 8-byte boundary, a function
17984 @code{__eabi} is called from @code{main} to set up the EABI
17985 environment, and the @option{-msdata} option can use both @code{r2} and
17986 @code{r13} to point to two separate small data areas.  Selecting
17987 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17988 no EABI initialization function is called from @code{main}, and the
17989 @option{-msdata} option only uses @code{r13} to point to a single
17990 small data area.  The @option{-meabi} option is on by default if you
17991 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17993 @item -msdata=eabi
17994 @opindex msdata=eabi
17995 On System V.4 and embedded PowerPC systems, put small initialized
17996 @code{const} global and static data in the @samp{.sdata2} section, which
17997 is pointed to by register @code{r2}.  Put small initialized
17998 non-@code{const} global and static data in the @samp{.sdata} section,
17999 which is pointed to by register @code{r13}.  Put small uninitialized
18000 global and static data in the @samp{.sbss} section, which is adjacent to
18001 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
18002 incompatible with the @option{-mrelocatable} option.  The
18003 @option{-msdata=eabi} option also sets the @option{-memb} option.
18005 @item -msdata=sysv
18006 @opindex msdata=sysv
18007 On System V.4 and embedded PowerPC systems, put small global and static
18008 data in the @samp{.sdata} section, which is pointed to by register
18009 @code{r13}.  Put small uninitialized global and static data in the
18010 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
18011 The @option{-msdata=sysv} option is incompatible with the
18012 @option{-mrelocatable} option.
18014 @item -msdata=default
18015 @itemx -msdata
18016 @opindex msdata=default
18017 @opindex msdata
18018 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
18019 compile code the same as @option{-msdata=eabi}, otherwise compile code the
18020 same as @option{-msdata=sysv}.
18022 @item -msdata=data
18023 @opindex msdata=data
18024 On System V.4 and embedded PowerPC systems, put small global
18025 data in the @samp{.sdata} section.  Put small uninitialized global
18026 data in the @samp{.sbss} section.  Do not use register @code{r13}
18027 to address small data however.  This is the default behavior unless
18028 other @option{-msdata} options are used.
18030 @item -msdata=none
18031 @itemx -mno-sdata
18032 @opindex msdata=none
18033 @opindex mno-sdata
18034 On embedded PowerPC systems, put all initialized global and static data
18035 in the @samp{.data} section, and all uninitialized data in the
18036 @samp{.bss} section.
18038 @item -mblock-move-inline-limit=@var{num}
18039 @opindex mblock-move-inline-limit
18040 Inline all block moves (such as calls to @code{memcpy} or structure
18041 copies) less than or equal to @var{num} bytes.  The minimum value for
18042 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
18043 targets.  The default value is target-specific.
18045 @item -G @var{num}
18046 @opindex G
18047 @cindex smaller data references (PowerPC)
18048 @cindex .sdata/.sdata2 references (PowerPC)
18049 On embedded PowerPC systems, put global and static items less than or
18050 equal to @var{num} bytes into the small data or BSS sections instead of
18051 the normal data or BSS section.  By default, @var{num} is 8.  The
18052 @option{-G @var{num}} switch is also passed to the linker.
18053 All modules should be compiled with the same @option{-G @var{num}} value.
18055 @item -mregnames
18056 @itemx -mno-regnames
18057 @opindex mregnames
18058 @opindex mno-regnames
18059 On System V.4 and embedded PowerPC systems do (do not) emit register
18060 names in the assembly language output using symbolic forms.
18062 @item -mlongcall
18063 @itemx -mno-longcall
18064 @opindex mlongcall
18065 @opindex mno-longcall
18066 By default assume that all calls are far away so that a longer and more
18067 expensive calling sequence is required.  This is required for calls
18068 farther than 32 megabytes (33,554,432 bytes) from the current location.
18069 A short call is generated if the compiler knows
18070 the call cannot be that far away.  This setting can be overridden by
18071 the @code{shortcall} function attribute, or by @code{#pragma
18072 longcall(0)}.
18074 Some linkers are capable of detecting out-of-range calls and generating
18075 glue code on the fly.  On these systems, long calls are unnecessary and
18076 generate slower code.  As of this writing, the AIX linker can do this,
18077 as can the GNU linker for PowerPC/64.  It is planned to add this feature
18078 to the GNU linker for 32-bit PowerPC systems as well.
18080 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
18081 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
18082 addresses represent the callee and the branch island.  The
18083 Darwin/PPC linker prefers the first address and generates a @code{bl
18084 callee} if the PPC @code{bl} instruction reaches the callee directly;
18085 otherwise, the linker generates @code{bl L42} to call the branch
18086 island.  The branch island is appended to the body of the
18087 calling function; it computes the full 32-bit address of the callee
18088 and jumps to it.
18090 On Mach-O (Darwin) systems, this option directs the compiler emit to
18091 the glue for every direct call, and the Darwin linker decides whether
18092 to use or discard it.
18094 In the future, GCC may ignore all longcall specifications
18095 when the linker is known to generate glue.
18097 @item -mtls-markers
18098 @itemx -mno-tls-markers
18099 @opindex mtls-markers
18100 @opindex mno-tls-markers
18101 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
18102 specifying the function argument.  The relocation allows the linker to
18103 reliably associate function call with argument setup instructions for
18104 TLS optimization, which in turn allows GCC to better schedule the
18105 sequence.
18107 @item -pthread
18108 @opindex pthread
18109 Adds support for multithreading with the @dfn{pthreads} library.
18110 This option sets flags for both the preprocessor and linker.
18112 @item -mrecip
18113 @itemx -mno-recip
18114 @opindex mrecip
18115 This option enables use of the reciprocal estimate and
18116 reciprocal square root estimate instructions with additional
18117 Newton-Raphson steps to increase precision instead of doing a divide or
18118 square root and divide for floating-point arguments.  You should use
18119 the @option{-ffast-math} option when using @option{-mrecip} (or at
18120 least @option{-funsafe-math-optimizations},
18121 @option{-finite-math-only}, @option{-freciprocal-math} and
18122 @option{-fno-trapping-math}).  Note that while the throughput of the
18123 sequence is generally higher than the throughput of the non-reciprocal
18124 instruction, the precision of the sequence can be decreased by up to 2
18125 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
18126 roots.
18128 @item -mrecip=@var{opt}
18129 @opindex mrecip=opt
18130 This option controls which reciprocal estimate instructions
18131 may be used.  @var{opt} is a comma-separated list of options, which may
18132 be preceded by a @code{!} to invert the option:
18133 @code{all}: enable all estimate instructions,
18134 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
18135 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
18136 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
18137 @code{divf}: enable the single-precision reciprocal approximation instructions;
18138 @code{divd}: enable the double-precision reciprocal approximation instructions;
18139 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
18140 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
18141 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
18143 So, for example, @option{-mrecip=all,!rsqrtd} enables
18144 all of the reciprocal estimate instructions, except for the
18145 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
18146 which handle the double-precision reciprocal square root calculations.
18148 @item -mrecip-precision
18149 @itemx -mno-recip-precision
18150 @opindex mrecip-precision
18151 Assume (do not assume) that the reciprocal estimate instructions
18152 provide higher-precision estimates than is mandated by the PowerPC
18153 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
18154 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
18155 The double-precision square root estimate instructions are not generated by
18156 default on low-precision machines, since they do not provide an
18157 estimate that converges after three steps.
18159 @item -mveclibabi=@var{type}
18160 @opindex mveclibabi
18161 Specifies the ABI type to use for vectorizing intrinsics using an
18162 external library.  The only type supported at present is @code{mass},
18163 which specifies to use IBM's Mathematical Acceleration Subsystem
18164 (MASS) libraries for vectorizing intrinsics using external libraries.
18165 GCC currently emits calls to @code{acosd2}, @code{acosf4},
18166 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
18167 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
18168 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
18169 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
18170 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
18171 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
18172 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
18173 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
18174 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
18175 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
18176 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
18177 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
18178 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
18179 for power7.  Both @option{-ftree-vectorize} and
18180 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
18181 libraries must be specified at link time.
18183 @item -mfriz
18184 @itemx -mno-friz
18185 @opindex mfriz
18186 Generate (do not generate) the @code{friz} instruction when the
18187 @option{-funsafe-math-optimizations} option is used to optimize
18188 rounding of floating-point values to 64-bit integer and back to floating
18189 point.  The @code{friz} instruction does not return the same value if
18190 the floating-point number is too large to fit in an integer.
18192 @item -mpointers-to-nested-functions
18193 @itemx -mno-pointers-to-nested-functions
18194 @opindex mpointers-to-nested-functions
18195 Generate (do not generate) code to load up the static chain register
18196 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
18197 systems where a function pointer points to a 3-word descriptor giving
18198 the function address, TOC value to be loaded in register @var{r2}, and
18199 static chain value to be loaded in register @var{r11}.  The
18200 @option{-mpointers-to-nested-functions} is on by default.  You cannot
18201 call through pointers to nested functions or pointers
18202 to functions compiled in other languages that use the static chain if
18203 you use the @option{-mno-pointers-to-nested-functions}.
18205 @item -msave-toc-indirect
18206 @itemx -mno-save-toc-indirect
18207 @opindex msave-toc-indirect
18208 Generate (do not generate) code to save the TOC value in the reserved
18209 stack location in the function prologue if the function calls through
18210 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
18211 saved in the prologue, it is saved just before the call through the
18212 pointer.  The @option{-mno-save-toc-indirect} option is the default.
18214 @item -mcompat-align-parm
18215 @itemx -mno-compat-align-parm
18216 @opindex mcompat-align-parm
18217 Generate (do not generate) code to pass structure parameters with a
18218 maximum alignment of 64 bits, for compatibility with older versions
18219 of GCC.
18221 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
18222 structure parameter on a 128-bit boundary when that structure contained
18223 a member requiring 128-bit alignment.  This is corrected in more
18224 recent versions of GCC.  This option may be used to generate code
18225 that is compatible with functions compiled with older versions of
18226 GCC.
18228 In this version of the compiler, the @option{-mcompat-align-parm}
18229 is the default, except when using the Linux ELFv2 ABI.
18230 @end table
18232 @node RX Options
18233 @subsection RX Options
18234 @cindex RX Options
18236 These command-line options are defined for RX targets:
18238 @table @gcctabopt
18239 @item -m64bit-doubles
18240 @itemx -m32bit-doubles
18241 @opindex m64bit-doubles
18242 @opindex m32bit-doubles
18243 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18244 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18245 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
18246 works on 32-bit values, which is why the default is
18247 @option{-m32bit-doubles}.
18249 @item -fpu
18250 @itemx -nofpu
18251 @opindex fpu
18252 @opindex nofpu
18253 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
18254 floating-point hardware.  The default is enabled for the @var{RX600}
18255 series and disabled for the @var{RX200} series.
18257 Floating-point instructions are only generated for 32-bit floating-point 
18258 values, however, so the FPU hardware is not used for doubles if the
18259 @option{-m64bit-doubles} option is used.
18261 @emph{Note} If the @option{-fpu} option is enabled then
18262 @option{-funsafe-math-optimizations} is also enabled automatically.
18263 This is because the RX FPU instructions are themselves unsafe.
18265 @item -mcpu=@var{name}
18266 @opindex -mcpu
18267 Selects the type of RX CPU to be targeted.  Currently three types are
18268 supported, the generic @var{RX600} and @var{RX200} series hardware and
18269 the specific @var{RX610} CPU.  The default is @var{RX600}.
18271 The only difference between @var{RX600} and @var{RX610} is that the
18272 @var{RX610} does not support the @code{MVTIPL} instruction.
18274 The @var{RX200} series does not have a hardware floating-point unit
18275 and so @option{-nofpu} is enabled by default when this type is
18276 selected.
18278 @item -mbig-endian-data
18279 @itemx -mlittle-endian-data
18280 @opindex mbig-endian-data
18281 @opindex mlittle-endian-data
18282 Store data (but not code) in the big-endian format.  The default is
18283 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
18284 format.
18286 @item -msmall-data-limit=@var{N}
18287 @opindex msmall-data-limit
18288 Specifies the maximum size in bytes of global and static variables
18289 which can be placed into the small data area.  Using the small data
18290 area can lead to smaller and faster code, but the size of area is
18291 limited and it is up to the programmer to ensure that the area does
18292 not overflow.  Also when the small data area is used one of the RX's
18293 registers (usually @code{r13}) is reserved for use pointing to this
18294 area, so it is no longer available for use by the compiler.  This
18295 could result in slower and/or larger code if variables are pushed onto
18296 the stack instead of being held in this register.
18298 Note, common variables (variables that have not been initialized) and
18299 constants are not placed into the small data area as they are assigned
18300 to other sections in the output executable.
18302 The default value is zero, which disables this feature.  Note, this
18303 feature is not enabled by default with higher optimization levels
18304 (@option{-O2} etc) because of the potentially detrimental effects of
18305 reserving a register.  It is up to the programmer to experiment and
18306 discover whether this feature is of benefit to their program.  See the
18307 description of the @option{-mpid} option for a description of how the
18308 actual register to hold the small data area pointer is chosen.
18310 @item -msim
18311 @itemx -mno-sim
18312 @opindex msim
18313 @opindex mno-sim
18314 Use the simulator runtime.  The default is to use the libgloss
18315 board-specific runtime.
18317 @item -mas100-syntax
18318 @itemx -mno-as100-syntax
18319 @opindex mas100-syntax
18320 @opindex mno-as100-syntax
18321 When generating assembler output use a syntax that is compatible with
18322 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
18323 assembler, but it has some restrictions so it is not generated by default.
18325 @item -mmax-constant-size=@var{N}
18326 @opindex mmax-constant-size
18327 Specifies the maximum size, in bytes, of a constant that can be used as
18328 an operand in a RX instruction.  Although the RX instruction set does
18329 allow constants of up to 4 bytes in length to be used in instructions,
18330 a longer value equates to a longer instruction.  Thus in some
18331 circumstances it can be beneficial to restrict the size of constants
18332 that are used in instructions.  Constants that are too big are instead
18333 placed into a constant pool and referenced via register indirection.
18335 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
18336 or 4 means that constants of any size are allowed.
18338 @item -mrelax
18339 @opindex mrelax
18340 Enable linker relaxation.  Linker relaxation is a process whereby the
18341 linker attempts to reduce the size of a program by finding shorter
18342 versions of various instructions.  Disabled by default.
18344 @item -mint-register=@var{N}
18345 @opindex mint-register
18346 Specify the number of registers to reserve for fast interrupt handler
18347 functions.  The value @var{N} can be between 0 and 4.  A value of 1
18348 means that register @code{r13} is reserved for the exclusive use
18349 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
18350 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
18351 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
18352 A value of 0, the default, does not reserve any registers.
18354 @item -msave-acc-in-interrupts
18355 @opindex msave-acc-in-interrupts
18356 Specifies that interrupt handler functions should preserve the
18357 accumulator register.  This is only necessary if normal code might use
18358 the accumulator register, for example because it performs 64-bit
18359 multiplications.  The default is to ignore the accumulator as this
18360 makes the interrupt handlers faster.
18362 @item -mpid
18363 @itemx -mno-pid
18364 @opindex mpid
18365 @opindex mno-pid
18366 Enables the generation of position independent data.  When enabled any
18367 access to constant data is done via an offset from a base address
18368 held in a register.  This allows the location of constant data to be
18369 determined at run time without requiring the executable to be
18370 relocated, which is a benefit to embedded applications with tight
18371 memory constraints.  Data that can be modified is not affected by this
18372 option.
18374 Note, using this feature reserves a register, usually @code{r13}, for
18375 the constant data base address.  This can result in slower and/or
18376 larger code, especially in complicated functions.
18378 The actual register chosen to hold the constant data base address
18379 depends upon whether the @option{-msmall-data-limit} and/or the
18380 @option{-mint-register} command-line options are enabled.  Starting
18381 with register @code{r13} and proceeding downwards, registers are
18382 allocated first to satisfy the requirements of @option{-mint-register},
18383 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
18384 is possible for the small data area register to be @code{r8} if both
18385 @option{-mint-register=4} and @option{-mpid} are specified on the
18386 command line.
18388 By default this feature is not enabled.  The default can be restored
18389 via the @option{-mno-pid} command-line option.
18391 @item -mno-warn-multiple-fast-interrupts
18392 @itemx -mwarn-multiple-fast-interrupts
18393 @opindex mno-warn-multiple-fast-interrupts
18394 @opindex mwarn-multiple-fast-interrupts
18395 Prevents GCC from issuing a warning message if it finds more than one
18396 fast interrupt handler when it is compiling a file.  The default is to
18397 issue a warning for each extra fast interrupt handler found, as the RX
18398 only supports one such interrupt.
18400 @end table
18402 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
18403 has special significance to the RX port when used with the
18404 @code{interrupt} function attribute.  This attribute indicates a
18405 function intended to process fast interrupts.  GCC ensures
18406 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
18407 and/or @code{r13} and only provided that the normal use of the
18408 corresponding registers have been restricted via the
18409 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
18410 options.
18412 @node S/390 and zSeries Options
18413 @subsection S/390 and zSeries Options
18414 @cindex S/390 and zSeries Options
18416 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
18418 @table @gcctabopt
18419 @item -mhard-float
18420 @itemx -msoft-float
18421 @opindex mhard-float
18422 @opindex msoft-float
18423 Use (do not use) the hardware floating-point instructions and registers
18424 for floating-point operations.  When @option{-msoft-float} is specified,
18425 functions in @file{libgcc.a} are used to perform floating-point
18426 operations.  When @option{-mhard-float} is specified, the compiler
18427 generates IEEE floating-point instructions.  This is the default.
18429 @item -mhard-dfp
18430 @itemx -mno-hard-dfp
18431 @opindex mhard-dfp
18432 @opindex mno-hard-dfp
18433 Use (do not use) the hardware decimal-floating-point instructions for
18434 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
18435 specified, functions in @file{libgcc.a} are used to perform
18436 decimal-floating-point operations.  When @option{-mhard-dfp} is
18437 specified, the compiler generates decimal-floating-point hardware
18438 instructions.  This is the default for @option{-march=z9-ec} or higher.
18440 @item -mlong-double-64
18441 @itemx -mlong-double-128
18442 @opindex mlong-double-64
18443 @opindex mlong-double-128
18444 These switches control the size of @code{long double} type. A size
18445 of 64 bits makes the @code{long double} type equivalent to the @code{double}
18446 type. This is the default.
18448 @item -mbackchain
18449 @itemx -mno-backchain
18450 @opindex mbackchain
18451 @opindex mno-backchain
18452 Store (do not store) the address of the caller's frame as backchain pointer
18453 into the callee's stack frame.
18454 A backchain may be needed to allow debugging using tools that do not understand
18455 DWARF 2 call frame information.
18456 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
18457 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
18458 the backchain is placed into the topmost word of the 96/160 byte register
18459 save area.
18461 In general, code compiled with @option{-mbackchain} is call-compatible with
18462 code compiled with @option{-mmo-backchain}; however, use of the backchain
18463 for debugging purposes usually requires that the whole binary is built with
18464 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
18465 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18466 to build a linux kernel use @option{-msoft-float}.
18468 The default is to not maintain the backchain.
18470 @item -mpacked-stack
18471 @itemx -mno-packed-stack
18472 @opindex mpacked-stack
18473 @opindex mno-packed-stack
18474 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
18475 specified, the compiler uses the all fields of the 96/160 byte register save
18476 area only for their default purpose; unused fields still take up stack space.
18477 When @option{-mpacked-stack} is specified, register save slots are densely
18478 packed at the top of the register save area; unused space is reused for other
18479 purposes, allowing for more efficient use of the available stack space.
18480 However, when @option{-mbackchain} is also in effect, the topmost word of
18481 the save area is always used to store the backchain, and the return address
18482 register is always saved two words below the backchain.
18484 As long as the stack frame backchain is not used, code generated with
18485 @option{-mpacked-stack} is call-compatible with code generated with
18486 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
18487 S/390 or zSeries generated code that uses the stack frame backchain at run
18488 time, not just for debugging purposes.  Such code is not call-compatible
18489 with code compiled with @option{-mpacked-stack}.  Also, note that the
18490 combination of @option{-mbackchain},
18491 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18492 to build a linux kernel use @option{-msoft-float}.
18494 The default is to not use the packed stack layout.
18496 @item -msmall-exec
18497 @itemx -mno-small-exec
18498 @opindex msmall-exec
18499 @opindex mno-small-exec
18500 Generate (or do not generate) code using the @code{bras} instruction
18501 to do subroutine calls.
18502 This only works reliably if the total executable size does not
18503 exceed 64k.  The default is to use the @code{basr} instruction instead,
18504 which does not have this limitation.
18506 @item -m64
18507 @itemx -m31
18508 @opindex m64
18509 @opindex m31
18510 When @option{-m31} is specified, generate code compliant to the
18511 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
18512 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
18513 particular to generate 64-bit instructions.  For the @samp{s390}
18514 targets, the default is @option{-m31}, while the @samp{s390x}
18515 targets default to @option{-m64}.
18517 @item -mzarch
18518 @itemx -mesa
18519 @opindex mzarch
18520 @opindex mesa
18521 When @option{-mzarch} is specified, generate code using the
18522 instructions available on z/Architecture.
18523 When @option{-mesa} is specified, generate code using the
18524 instructions available on ESA/390.  Note that @option{-mesa} is
18525 not possible with @option{-m64}.
18526 When generating code compliant to the GNU/Linux for S/390 ABI,
18527 the default is @option{-mesa}.  When generating code compliant
18528 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
18530 @item -mmvcle
18531 @itemx -mno-mvcle
18532 @opindex mmvcle
18533 @opindex mno-mvcle
18534 Generate (or do not generate) code using the @code{mvcle} instruction
18535 to perform block moves.  When @option{-mno-mvcle} is specified,
18536 use a @code{mvc} loop instead.  This is the default unless optimizing for
18537 size.
18539 @item -mdebug
18540 @itemx -mno-debug
18541 @opindex mdebug
18542 @opindex mno-debug
18543 Print (or do not print) additional debug information when compiling.
18544 The default is to not print debug information.
18546 @item -march=@var{cpu-type}
18547 @opindex march
18548 Generate code that runs on @var{cpu-type}, which is the name of a system
18549 representing a certain processor type.  Possible values for
18550 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
18551 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
18552 When generating code using the instructions available on z/Architecture,
18553 the default is @option{-march=z900}.  Otherwise, the default is
18554 @option{-march=g5}.
18556 @item -mtune=@var{cpu-type}
18557 @opindex mtune
18558 Tune to @var{cpu-type} everything applicable about the generated code,
18559 except for the ABI and the set of available instructions.
18560 The list of @var{cpu-type} values is the same as for @option{-march}.
18561 The default is the value used for @option{-march}.
18563 @item -mtpf-trace
18564 @itemx -mno-tpf-trace
18565 @opindex mtpf-trace
18566 @opindex mno-tpf-trace
18567 Generate code that adds (does not add) in TPF OS specific branches to trace
18568 routines in the operating system.  This option is off by default, even
18569 when compiling for the TPF OS@.
18571 @item -mfused-madd
18572 @itemx -mno-fused-madd
18573 @opindex mfused-madd
18574 @opindex mno-fused-madd
18575 Generate code that uses (does not use) the floating-point multiply and
18576 accumulate instructions.  These instructions are generated by default if
18577 hardware floating point is used.
18579 @item -mwarn-framesize=@var{framesize}
18580 @opindex mwarn-framesize
18581 Emit a warning if the current function exceeds the given frame size.  Because
18582 this is a compile-time check it doesn't need to be a real problem when the program
18583 runs.  It is intended to identify functions that most probably cause
18584 a stack overflow.  It is useful to be used in an environment with limited stack
18585 size e.g.@: the linux kernel.
18587 @item -mwarn-dynamicstack
18588 @opindex mwarn-dynamicstack
18589 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
18590 arrays.  This is generally a bad idea with a limited stack size.
18592 @item -mstack-guard=@var{stack-guard}
18593 @itemx -mstack-size=@var{stack-size}
18594 @opindex mstack-guard
18595 @opindex mstack-size
18596 If these options are provided the S/390 back end emits additional instructions in
18597 the function prologue that trigger a trap if the stack size is @var{stack-guard}
18598 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
18599 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
18600 the frame size of the compiled function is chosen.
18601 These options are intended to be used to help debugging stack overflow problems.
18602 The additionally emitted code causes only little overhead and hence can also be
18603 used in production-like systems without greater performance degradation.  The given
18604 values have to be exact powers of 2 and @var{stack-size} has to be greater than
18605 @var{stack-guard} without exceeding 64k.
18606 In order to be efficient the extra code makes the assumption that the stack starts
18607 at an address aligned to the value given by @var{stack-size}.
18608 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
18610 @item -mhotpatch[=@var{halfwords}]
18611 @itemx -mno-hotpatch
18612 @opindex mhotpatch
18613 If the hotpatch option is enabled, a ``hot-patching'' function
18614 prologue is generated for all functions in the compilation unit.
18615 The funtion label is prepended with the given number of two-byte
18616 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
18617 instructions if no argument is present.  Functions with a
18618 hot-patching prologue are never inlined automatically, and a
18619 hot-patching prologue is never generated for functions functions
18620 that are explicitly inline.
18622 This option can be overridden for individual functions with the
18623 @code{hotpatch} attribute.
18624 @end table
18626 @node Score Options
18627 @subsection Score Options
18628 @cindex Score Options
18630 These options are defined for Score implementations:
18632 @table @gcctabopt
18633 @item -meb
18634 @opindex meb
18635 Compile code for big-endian mode.  This is the default.
18637 @item -mel
18638 @opindex mel
18639 Compile code for little-endian mode.
18641 @item -mnhwloop
18642 @opindex mnhwloop
18643 Disable generation of @code{bcnz} instructions.
18645 @item -muls
18646 @opindex muls
18647 Enable generation of unaligned load and store instructions.
18649 @item -mmac
18650 @opindex mmac
18651 Enable the use of multiply-accumulate instructions. Disabled by default.
18653 @item -mscore5
18654 @opindex mscore5
18655 Specify the SCORE5 as the target architecture.
18657 @item -mscore5u
18658 @opindex mscore5u
18659 Specify the SCORE5U of the target architecture.
18661 @item -mscore7
18662 @opindex mscore7
18663 Specify the SCORE7 as the target architecture. This is the default.
18665 @item -mscore7d
18666 @opindex mscore7d
18667 Specify the SCORE7D as the target architecture.
18668 @end table
18670 @node SH Options
18671 @subsection SH Options
18673 These @samp{-m} options are defined for the SH implementations:
18675 @table @gcctabopt
18676 @item -m1
18677 @opindex m1
18678 Generate code for the SH1.
18680 @item -m2
18681 @opindex m2
18682 Generate code for the SH2.
18684 @item -m2e
18685 Generate code for the SH2e.
18687 @item -m2a-nofpu
18688 @opindex m2a-nofpu
18689 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
18690 that the floating-point unit is not used.
18692 @item -m2a-single-only
18693 @opindex m2a-single-only
18694 Generate code for the SH2a-FPU, in such a way that no double-precision
18695 floating-point operations are used.
18697 @item -m2a-single
18698 @opindex m2a-single
18699 Generate code for the SH2a-FPU assuming the floating-point unit is in
18700 single-precision mode by default.
18702 @item -m2a
18703 @opindex m2a
18704 Generate code for the SH2a-FPU assuming the floating-point unit is in
18705 double-precision mode by default.
18707 @item -m3
18708 @opindex m3
18709 Generate code for the SH3.
18711 @item -m3e
18712 @opindex m3e
18713 Generate code for the SH3e.
18715 @item -m4-nofpu
18716 @opindex m4-nofpu
18717 Generate code for the SH4 without a floating-point unit.
18719 @item -m4-single-only
18720 @opindex m4-single-only
18721 Generate code for the SH4 with a floating-point unit that only
18722 supports single-precision arithmetic.
18724 @item -m4-single
18725 @opindex m4-single
18726 Generate code for the SH4 assuming the floating-point unit is in
18727 single-precision mode by default.
18729 @item -m4
18730 @opindex m4
18731 Generate code for the SH4.
18733 @item -m4-100
18734 @opindex m4-100
18735 Generate code for SH4-100.
18737 @item -m4-100-nofpu
18738 @opindex m4-100-nofpu
18739 Generate code for SH4-100 in such a way that the
18740 floating-point unit is not used.
18742 @item -m4-100-single
18743 @opindex m4-100-single
18744 Generate code for SH4-100 assuming the floating-point unit is in
18745 single-precision mode by default.
18747 @item -m4-100-single-only
18748 @opindex m4-100-single-only
18749 Generate code for SH4-100 in such a way that no double-precision
18750 floating-point operations are used.
18752 @item -m4-200
18753 @opindex m4-200
18754 Generate code for SH4-200.
18756 @item -m4-200-nofpu
18757 @opindex m4-200-nofpu
18758 Generate code for SH4-200 without in such a way that the
18759 floating-point unit is not used.
18761 @item -m4-200-single
18762 @opindex m4-200-single
18763 Generate code for SH4-200 assuming the floating-point unit is in
18764 single-precision mode by default.
18766 @item -m4-200-single-only
18767 @opindex m4-200-single-only
18768 Generate code for SH4-200 in such a way that no double-precision
18769 floating-point operations are used.
18771 @item -m4-300
18772 @opindex m4-300
18773 Generate code for SH4-300.
18775 @item -m4-300-nofpu
18776 @opindex m4-300-nofpu
18777 Generate code for SH4-300 without in such a way that the
18778 floating-point unit is not used.
18780 @item -m4-300-single
18781 @opindex m4-300-single
18782 Generate code for SH4-300 in such a way that no double-precision
18783 floating-point operations are used.
18785 @item -m4-300-single-only
18786 @opindex m4-300-single-only
18787 Generate code for SH4-300 in such a way that no double-precision
18788 floating-point operations are used.
18790 @item -m4-340
18791 @opindex m4-340
18792 Generate code for SH4-340 (no MMU, no FPU).
18794 @item -m4-500
18795 @opindex m4-500
18796 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
18797 assembler.
18799 @item -m4a-nofpu
18800 @opindex m4a-nofpu
18801 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18802 floating-point unit is not used.
18804 @item -m4a-single-only
18805 @opindex m4a-single-only
18806 Generate code for the SH4a, in such a way that no double-precision
18807 floating-point operations are used.
18809 @item -m4a-single
18810 @opindex m4a-single
18811 Generate code for the SH4a assuming the floating-point unit is in
18812 single-precision mode by default.
18814 @item -m4a
18815 @opindex m4a
18816 Generate code for the SH4a.
18818 @item -m4al
18819 @opindex m4al
18820 Same as @option{-m4a-nofpu}, except that it implicitly passes
18821 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
18822 instructions at the moment.
18824 @item -m5-32media
18825 @opindex m5-32media
18826 Generate 32-bit code for SHmedia.
18828 @item -m5-32media-nofpu
18829 @opindex m5-32media-nofpu
18830 Generate 32-bit code for SHmedia in such a way that the
18831 floating-point unit is not used.
18833 @item -m5-64media
18834 @opindex m5-64media
18835 Generate 64-bit code for SHmedia.
18837 @item -m5-64media-nofpu
18838 @opindex m5-64media-nofpu
18839 Generate 64-bit code for SHmedia in such a way that the
18840 floating-point unit is not used.
18842 @item -m5-compact
18843 @opindex m5-compact
18844 Generate code for SHcompact.
18846 @item -m5-compact-nofpu
18847 @opindex m5-compact-nofpu
18848 Generate code for SHcompact in such a way that the
18849 floating-point unit is not used.
18851 @item -mb
18852 @opindex mb
18853 Compile code for the processor in big-endian mode.
18855 @item -ml
18856 @opindex ml
18857 Compile code for the processor in little-endian mode.
18859 @item -mdalign
18860 @opindex mdalign
18861 Align doubles at 64-bit boundaries.  Note that this changes the calling
18862 conventions, and thus some functions from the standard C library do
18863 not work unless you recompile it first with @option{-mdalign}.
18865 @item -mrelax
18866 @opindex mrelax
18867 Shorten some address references at link time, when possible; uses the
18868 linker option @option{-relax}.
18870 @item -mbigtable
18871 @opindex mbigtable
18872 Use 32-bit offsets in @code{switch} tables.  The default is to use
18873 16-bit offsets.
18875 @item -mbitops
18876 @opindex mbitops
18877 Enable the use of bit manipulation instructions on SH2A.
18879 @item -mfmovd
18880 @opindex mfmovd
18881 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
18882 alignment constraints.
18884 @item -mrenesas
18885 @opindex mrenesas
18886 Comply with the calling conventions defined by Renesas.
18888 @item -mno-renesas
18889 @opindex mno-renesas
18890 Comply with the calling conventions defined for GCC before the Renesas
18891 conventions were available.  This option is the default for all
18892 targets of the SH toolchain.
18894 @item -mnomacsave
18895 @opindex mnomacsave
18896 Mark the @code{MAC} register as call-clobbered, even if
18897 @option{-mrenesas} is given.
18899 @item -mieee
18900 @itemx -mno-ieee
18901 @opindex mieee
18902 @opindex mno-ieee
18903 Control the IEEE compliance of floating-point comparisons, which affects the
18904 handling of cases where the result of a comparison is unordered.  By default
18905 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
18906 enabled @option{-mno-ieee} is implicitly set, which results in faster
18907 floating-point greater-equal and less-equal comparisons.  The implcit settings
18908 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18910 @item -minline-ic_invalidate
18911 @opindex minline-ic_invalidate
18912 Inline code to invalidate instruction cache entries after setting up
18913 nested function trampolines.
18914 This option has no effect if @option{-musermode} is in effect and the selected
18915 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18916 instruction.
18917 If the selected code generation option does not allow the use of the @code{icbi}
18918 instruction, and @option{-musermode} is not in effect, the inlined code
18919 manipulates the instruction cache address array directly with an associative
18920 write.  This not only requires privileged mode at run time, but it also
18921 fails if the cache line had been mapped via the TLB and has become unmapped.
18923 @item -misize
18924 @opindex misize
18925 Dump instruction size and location in the assembly code.
18927 @item -mpadstruct
18928 @opindex mpadstruct
18929 This option is deprecated.  It pads structures to multiple of 4 bytes,
18930 which is incompatible with the SH ABI@.
18932 @item -matomic-model=@var{model}
18933 @opindex matomic-model=@var{model}
18934 Sets the model of atomic operations and additional parameters as a comma
18935 separated list.  For details on the atomic built-in functions see
18936 @ref{__atomic Builtins}.  The following models and parameters are supported:
18938 @table @samp
18940 @item none
18941 Disable compiler generated atomic sequences and emit library calls for atomic
18942 operations.  This is the default if the target is not @code{sh*-*-linux*}.
18944 @item soft-gusa
18945 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18946 built-in functions.  The generated atomic sequences require additional support
18947 from the interrupt/exception handling code of the system and are only suitable
18948 for SH3* and SH4* single-core systems.  This option is enabled by default when
18949 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
18950 this option will also partially utilize the hardware atomic instructions
18951 @code{movli.l} and @code{movco.l} to create more efficient code, unless
18952 @samp{strict} is specified.  
18954 @item soft-tcb
18955 Generate software atomic sequences that use a variable in the thread control
18956 block.  This is a variation of the gUSA sequences which can also be used on
18957 SH1* and SH2* targets.  The generated atomic sequences require additional
18958 support from the interrupt/exception handling code of the system and are only
18959 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
18960 parameter has to be specified as well.
18962 @item soft-imask
18963 Generate software atomic sequences that temporarily disable interrupts by
18964 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
18965 in privileged mode and is only suitable for single-core systems.  Additional
18966 support from the interrupt/exception handling code of the system is not
18967 required.  This model is enabled by default when the target is
18968 @code{sh*-*-linux*} and SH1* or SH2*.
18970 @item hard-llcs
18971 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
18972 instructions only.  This is only available on SH4A and is suitable for
18973 multi-core systems.  Since the hardware instructions support only 32 bit atomic
18974 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
18975 Code compiled with this option will also be compatible with other software
18976 atomic model interrupt/exception handling systems if executed on an SH4A
18977 system.  Additional support from the interrupt/exception handling code of the
18978 system is not required for this model.
18980 @item gbr-offset=
18981 This parameter specifies the offset in bytes of the variable in the thread
18982 control block structure that should be used by the generated atomic sequences
18983 when the @samp{soft-tcb} model has been selected.  For other models this
18984 parameter is ignored.  The specified value must be an integer multiple of four
18985 and in the range 0-1020.
18987 @item strict
18988 This parameter prevents mixed usage of multiple atomic models, even though they
18989 would be compatible, and will make the compiler generate atomic sequences of the
18990 specified model only.
18992 @end table
18994 @item -mtas
18995 @opindex mtas
18996 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18997 Notice that depending on the particular hardware and software configuration
18998 this can degrade overall performance due to the operand cache line flushes
18999 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
19000 processors the @code{tas.b} instruction must be used with caution since it
19001 can result in data corruption for certain cache configurations.
19003 @item -mprefergot
19004 @opindex mprefergot
19005 When generating position-independent code, emit function calls using
19006 the Global Offset Table instead of the Procedure Linkage Table.
19008 @item -musermode
19009 @itemx -mno-usermode
19010 @opindex musermode
19011 @opindex mno-usermode
19012 Don't allow (allow) the compiler generating privileged mode code.  Specifying
19013 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
19014 inlined code would not work in user mode.  @option{-musermode} is the default
19015 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
19016 @option{-musermode} has no effect, since there is no user mode.
19018 @item -multcost=@var{number}
19019 @opindex multcost=@var{number}
19020 Set the cost to assume for a multiply insn.
19022 @item -mdiv=@var{strategy}
19023 @opindex mdiv=@var{strategy}
19024 Set the division strategy to be used for integer division operations.
19025 For SHmedia @var{strategy} can be one of: 
19027 @table @samp
19029 @item fp 
19030 Performs the operation in floating point.  This has a very high latency,
19031 but needs only a few instructions, so it might be a good choice if
19032 your code has enough easily-exploitable ILP to allow the compiler to
19033 schedule the floating-point instructions together with other instructions.
19034 Division by zero causes a floating-point exception.
19036 @item inv
19037 Uses integer operations to calculate the inverse of the divisor,
19038 and then multiplies the dividend with the inverse.  This strategy allows
19039 CSE and hoisting of the inverse calculation.  Division by zero calculates
19040 an unspecified result, but does not trap.
19042 @item inv:minlat
19043 A variant of @samp{inv} where, if no CSE or hoisting opportunities
19044 have been found, or if the entire operation has been hoisted to the same
19045 place, the last stages of the inverse calculation are intertwined with the
19046 final multiply to reduce the overall latency, at the expense of using a few
19047 more instructions, and thus offering fewer scheduling opportunities with
19048 other code.
19050 @item call
19051 Calls a library function that usually implements the @samp{inv:minlat}
19052 strategy.
19053 This gives high code density for @code{m5-*media-nofpu} compilations.
19055 @item call2
19056 Uses a different entry point of the same library function, where it
19057 assumes that a pointer to a lookup table has already been set up, which
19058 exposes the pointer load to CSE and code hoisting optimizations.
19060 @item inv:call
19061 @itemx inv:call2
19062 @itemx inv:fp
19063 Use the @samp{inv} algorithm for initial
19064 code generation, but if the code stays unoptimized, revert to the @samp{call},
19065 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
19066 potentially-trapping side effect of division by zero is carried by a
19067 separate instruction, so it is possible that all the integer instructions
19068 are hoisted out, but the marker for the side effect stays where it is.
19069 A recombination to floating-point operations or a call is not possible
19070 in that case.
19072 @item inv20u
19073 @itemx inv20l
19074 Variants of the @samp{inv:minlat} strategy.  In the case
19075 that the inverse calculation is not separated from the multiply, they speed
19076 up division where the dividend fits into 20 bits (plus sign where applicable)
19077 by inserting a test to skip a number of operations in this case; this test
19078 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
19079 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
19081 @end table
19083 For targets other than SHmedia @var{strategy} can be one of:
19085 @table @samp
19087 @item call-div1
19088 Calls a library function that uses the single-step division instruction
19089 @code{div1} to perform the operation.  Division by zero calculates an
19090 unspecified result and does not trap.  This is the default except for SH4,
19091 SH2A and SHcompact.
19093 @item call-fp
19094 Calls a library function that performs the operation in double precision
19095 floating point.  Division by zero causes a floating-point exception.  This is
19096 the default for SHcompact with FPU.  Specifying this for targets that do not
19097 have a double precision FPU will default to @code{call-div1}.
19099 @item call-table
19100 Calls a library function that uses a lookup table for small divisors and
19101 the @code{div1} instruction with case distinction for larger divisors.  Division
19102 by zero calculates an unspecified result and does not trap.  This is the default
19103 for SH4.  Specifying this for targets that do not have dynamic shift
19104 instructions will default to @code{call-div1}.
19106 @end table
19108 When a division strategy has not been specified the default strategy will be
19109 selected based on the current target.  For SH2A the default strategy is to
19110 use the @code{divs} and @code{divu} instructions instead of library function
19111 calls.
19113 @item -maccumulate-outgoing-args
19114 @opindex maccumulate-outgoing-args
19115 Reserve space once for outgoing arguments in the function prologue rather
19116 than around each call.  Generally beneficial for performance and size.  Also
19117 needed for unwinding to avoid changing the stack frame around conditional code.
19119 @item -mdivsi3_libfunc=@var{name}
19120 @opindex mdivsi3_libfunc=@var{name}
19121 Set the name of the library function used for 32-bit signed division to
19122 @var{name}.
19123 This only affects the name used in the @samp{call} and @samp{inv:call}
19124 division strategies, and the compiler still expects the same
19125 sets of input/output/clobbered registers as if this option were not present.
19127 @item -mfixed-range=@var{register-range}
19128 @opindex mfixed-range
19129 Generate code treating the given register range as fixed registers.
19130 A fixed register is one that the register allocator can not use.  This is
19131 useful when compiling kernel code.  A register range is specified as
19132 two registers separated by a dash.  Multiple register ranges can be
19133 specified separated by a comma.
19135 @item -mindexed-addressing
19136 @opindex mindexed-addressing
19137 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
19138 This is only safe if the hardware and/or OS implement 32-bit wrap-around
19139 semantics for the indexed addressing mode.  The architecture allows the
19140 implementation of processors with 64-bit MMU, which the OS could use to
19141 get 32-bit addressing, but since no current hardware implementation supports
19142 this or any other way to make the indexed addressing mode safe to use in
19143 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
19145 @item -mgettrcost=@var{number}
19146 @opindex mgettrcost=@var{number}
19147 Set the cost assumed for the @code{gettr} instruction to @var{number}.
19148 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
19150 @item -mpt-fixed
19151 @opindex mpt-fixed
19152 Assume @code{pt*} instructions won't trap.  This generally generates
19153 better-scheduled code, but is unsafe on current hardware.
19154 The current architecture
19155 definition says that @code{ptabs} and @code{ptrel} trap when the target 
19156 anded with 3 is 3.
19157 This has the unintentional effect of making it unsafe to schedule these
19158 instructions before a branch, or hoist them out of a loop.  For example,
19159 @code{__do_global_ctors}, a part of @file{libgcc}
19160 that runs constructors at program
19161 startup, calls functions in a list which is delimited by @minus{}1.  With the
19162 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
19163 That means that all the constructors run a bit more quickly, but when
19164 the loop comes to the end of the list, the program crashes because @code{ptabs}
19165 loads @minus{}1 into a target register.  
19167 Since this option is unsafe for any
19168 hardware implementing the current architecture specification, the default
19169 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
19170 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
19171 this deters register allocation from using target registers for storing
19172 ordinary integers.
19174 @item -minvalid-symbols
19175 @opindex minvalid-symbols
19176 Assume symbols might be invalid.  Ordinary function symbols generated by
19177 the compiler are always valid to load with
19178 @code{movi}/@code{shori}/@code{ptabs} or
19179 @code{movi}/@code{shori}/@code{ptrel},
19180 but with assembler and/or linker tricks it is possible
19181 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
19182 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
19183 It prevents cross-basic-block CSE, hoisting and most scheduling
19184 of symbol loads.  The default is @option{-mno-invalid-symbols}.
19186 @item -mbranch-cost=@var{num}
19187 @opindex mbranch-cost=@var{num}
19188 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
19189 make the compiler try to generate more branch-free code if possible.  
19190 If not specified the value is selected depending on the processor type that
19191 is being compiled for.
19193 @item -mzdcbranch
19194 @itemx -mno-zdcbranch
19195 @opindex mzdcbranch
19196 @opindex mno-zdcbranch
19197 Assume (do not assume) that zero displacement conditional branch instructions
19198 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
19199 compiler will try to prefer zero displacement branch code sequences.  This is
19200 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
19201 disabled by specifying @option{-mno-zdcbranch}.
19203 @item -mcbranchdi
19204 @opindex mcbranchdi
19205 Enable the @code{cbranchdi4} instruction pattern.
19207 @item -mcmpeqdi
19208 @opindex mcmpeqdi
19209 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
19210 is in effect.
19212 @item -mfused-madd
19213 @itemx -mno-fused-madd
19214 @opindex mfused-madd
19215 @opindex mno-fused-madd
19216 Generate code that uses (does not use) the floating-point multiply and
19217 accumulate instructions.  These instructions are generated by default
19218 if hardware floating point is used.  The machine-dependent
19219 @option{-mfused-madd} option is now mapped to the machine-independent
19220 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19221 mapped to @option{-ffp-contract=off}.
19223 @item -mfsca
19224 @itemx -mno-fsca
19225 @opindex mfsca
19226 @opindex mno-fsca
19227 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
19228 and cosine approximations.  The option @code{-mfsca} must be used in
19229 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
19230 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
19231 approximations even if @code{-funsafe-math-optimizations} is in effect.
19233 @item -mfsrra
19234 @itemx -mno-fsrra
19235 @opindex mfsrra
19236 @opindex mno-fsrra
19237 Allow or disallow the compiler to emit the @code{fsrra} instruction for
19238 reciprocal square root approximations.  The option @code{-mfsrra} must be used
19239 in combination with @code{-funsafe-math-optimizations} and
19240 @code{-ffinite-math-only}.  It is enabled by default when generating code for
19241 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
19242 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
19243 in effect.
19245 @item -mpretend-cmove
19246 @opindex mpretend-cmove
19247 Prefer zero-displacement conditional branches for conditional move instruction
19248 patterns.  This can result in faster code on the SH4 processor.
19250 @end table
19252 @node Solaris 2 Options
19253 @subsection Solaris 2 Options
19254 @cindex Solaris 2 options
19256 These @samp{-m} options are supported on Solaris 2:
19258 @table @gcctabopt
19259 @item -mimpure-text
19260 @opindex mimpure-text
19261 @option{-mimpure-text}, used in addition to @option{-shared}, tells
19262 the compiler to not pass @option{-z text} to the linker when linking a
19263 shared object.  Using this option, you can link position-dependent
19264 code into a shared object.
19266 @option{-mimpure-text} suppresses the ``relocations remain against
19267 allocatable but non-writable sections'' linker error message.
19268 However, the necessary relocations trigger copy-on-write, and the
19269 shared object is not actually shared across processes.  Instead of
19270 using @option{-mimpure-text}, you should compile all source code with
19271 @option{-fpic} or @option{-fPIC}.
19273 @end table
19275 These switches are supported in addition to the above on Solaris 2:
19277 @table @gcctabopt
19278 @item -pthreads
19279 @opindex pthreads
19280 Add support for multithreading using the POSIX threads library.  This
19281 option sets flags for both the preprocessor and linker.  This option does
19282 not affect the thread safety of object code produced  by the compiler or
19283 that of libraries supplied with it.
19285 @item -pthread
19286 @opindex pthread
19287 This is a synonym for @option{-pthreads}.
19288 @end table
19290 @node SPARC Options
19291 @subsection SPARC Options
19292 @cindex SPARC options
19294 These @samp{-m} options are supported on the SPARC:
19296 @table @gcctabopt
19297 @item -mno-app-regs
19298 @itemx -mapp-regs
19299 @opindex mno-app-regs
19300 @opindex mapp-regs
19301 Specify @option{-mapp-regs} to generate output using the global registers
19302 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
19303 global register 1, each global register 2 through 4 is then treated as an
19304 allocable register that is clobbered by function calls.  This is the default.
19306 To be fully SVR4 ABI-compliant at the cost of some performance loss,
19307 specify @option{-mno-app-regs}.  You should compile libraries and system
19308 software with this option.
19310 @item -mflat
19311 @itemx -mno-flat
19312 @opindex mflat
19313 @opindex mno-flat
19314 With @option{-mflat}, the compiler does not generate save/restore instructions
19315 and uses a ``flat'' or single register window model.  This model is compatible
19316 with the regular register window model.  The local registers and the input
19317 registers (0--5) are still treated as ``call-saved'' registers and are
19318 saved on the stack as needed.
19320 With @option{-mno-flat} (the default), the compiler generates save/restore
19321 instructions (except for leaf functions).  This is the normal operating mode.
19323 @item -mfpu
19324 @itemx -mhard-float
19325 @opindex mfpu
19326 @opindex mhard-float
19327 Generate output containing floating-point instructions.  This is the
19328 default.
19330 @item -mno-fpu
19331 @itemx -msoft-float
19332 @opindex mno-fpu
19333 @opindex msoft-float
19334 Generate output containing library calls for floating point.
19335 @strong{Warning:} the requisite libraries are not available for all SPARC
19336 targets.  Normally the facilities of the machine's usual C compiler are
19337 used, but this cannot be done directly in cross-compilation.  You must make
19338 your own arrangements to provide suitable library functions for
19339 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
19340 @samp{sparclite-*-*} do provide software floating-point support.
19342 @option{-msoft-float} changes the calling convention in the output file;
19343 therefore, it is only useful if you compile @emph{all} of a program with
19344 this option.  In particular, you need to compile @file{libgcc.a}, the
19345 library that comes with GCC, with @option{-msoft-float} in order for
19346 this to work.
19348 @item -mhard-quad-float
19349 @opindex mhard-quad-float
19350 Generate output containing quad-word (long double) floating-point
19351 instructions.
19353 @item -msoft-quad-float
19354 @opindex msoft-quad-float
19355 Generate output containing library calls for quad-word (long double)
19356 floating-point instructions.  The functions called are those specified
19357 in the SPARC ABI@.  This is the default.
19359 As of this writing, there are no SPARC implementations that have hardware
19360 support for the quad-word floating-point instructions.  They all invoke
19361 a trap handler for one of these instructions, and then the trap handler
19362 emulates the effect of the instruction.  Because of the trap handler overhead,
19363 this is much slower than calling the ABI library routines.  Thus the
19364 @option{-msoft-quad-float} option is the default.
19366 @item -mno-unaligned-doubles
19367 @itemx -munaligned-doubles
19368 @opindex mno-unaligned-doubles
19369 @opindex munaligned-doubles
19370 Assume that doubles have 8-byte alignment.  This is the default.
19372 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
19373 alignment only if they are contained in another type, or if they have an
19374 absolute address.  Otherwise, it assumes they have 4-byte alignment.
19375 Specifying this option avoids some rare compatibility problems with code
19376 generated by other compilers.  It is not the default because it results
19377 in a performance loss, especially for floating-point code.
19379 @item -muser-mode
19380 @itemx -mno-user-mode
19381 @opindex muser-mode
19382 @opindex mno-user-mode
19383 Do not generate code that can only run in supervisor mode.  This is relevant
19384 only for the @code{casa} instruction emitted for the LEON3 processor.  The
19385 default is @option{-mno-user-mode}.
19387 @item -mno-faster-structs
19388 @itemx -mfaster-structs
19389 @opindex mno-faster-structs
19390 @opindex mfaster-structs
19391 With @option{-mfaster-structs}, the compiler assumes that structures
19392 should have 8-byte alignment.  This enables the use of pairs of
19393 @code{ldd} and @code{std} instructions for copies in structure
19394 assignment, in place of twice as many @code{ld} and @code{st} pairs.
19395 However, the use of this changed alignment directly violates the SPARC
19396 ABI@.  Thus, it's intended only for use on targets where the developer
19397 acknowledges that their resulting code is not directly in line with
19398 the rules of the ABI@.
19400 @item -mcpu=@var{cpu_type}
19401 @opindex mcpu
19402 Set the instruction set, register set, and instruction scheduling parameters
19403 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
19404 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
19405 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
19406 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
19407 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
19408 @samp{niagara3} and @samp{niagara4}.
19410 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
19411 which selects the best architecture option for the host processor.
19412 @option{-mcpu=native} has no effect if GCC does not recognize
19413 the processor.
19415 Default instruction scheduling parameters are used for values that select
19416 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
19417 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
19419 Here is a list of each supported architecture and their supported
19420 implementations.
19422 @table @asis
19423 @item v7
19424 cypress, leon3v7
19426 @item v8
19427 supersparc, hypersparc, leon, leon3
19429 @item sparclite
19430 f930, f934, sparclite86x
19432 @item sparclet
19433 tsc701
19435 @item v9
19436 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
19437 @end table
19439 By default (unless configured otherwise), GCC generates code for the V7
19440 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
19441 additionally optimizes it for the Cypress CY7C602 chip, as used in the
19442 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
19443 SPARCStation 1, 2, IPX etc.
19445 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
19446 architecture.  The only difference from V7 code is that the compiler emits
19447 the integer multiply and integer divide instructions which exist in SPARC-V8
19448 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
19449 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
19450 2000 series.
19452 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
19453 the SPARC architecture.  This adds the integer multiply, integer divide step
19454 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
19455 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
19456 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
19457 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
19458 MB86934 chip, which is the more recent SPARClite with FPU@.
19460 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
19461 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
19462 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
19463 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
19464 optimizes it for the TEMIC SPARClet chip.
19466 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
19467 architecture.  This adds 64-bit integer and floating-point move instructions,
19468 3 additional floating-point condition code registers and conditional move
19469 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
19470 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
19471 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
19472 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
19473 @option{-mcpu=niagara}, the compiler additionally optimizes it for
19474 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
19475 additionally optimizes it for Sun UltraSPARC T2 chips. With
19476 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
19477 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
19478 additionally optimizes it for Sun UltraSPARC T4 chips.
19480 @item -mtune=@var{cpu_type}
19481 @opindex mtune
19482 Set the instruction scheduling parameters for machine type
19483 @var{cpu_type}, but do not set the instruction set or register set that the
19484 option @option{-mcpu=@var{cpu_type}} does.
19486 The same values for @option{-mcpu=@var{cpu_type}} can be used for
19487 @option{-mtune=@var{cpu_type}}, but the only useful values are those
19488 that select a particular CPU implementation.  Those are @samp{cypress},
19489 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
19490 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
19491 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
19492 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
19493 toolchains, @samp{native} can also be used.
19495 @item -mv8plus
19496 @itemx -mno-v8plus
19497 @opindex mv8plus
19498 @opindex mno-v8plus
19499 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
19500 difference from the V8 ABI is that the global and out registers are
19501 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
19502 mode for all SPARC-V9 processors.
19504 @item -mvis
19505 @itemx -mno-vis
19506 @opindex mvis
19507 @opindex mno-vis
19508 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
19509 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
19511 @item -mvis2
19512 @itemx -mno-vis2
19513 @opindex mvis2
19514 @opindex mno-vis2
19515 With @option{-mvis2}, GCC generates code that takes advantage of
19516 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
19517 default is @option{-mvis2} when targeting a cpu that supports such
19518 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
19519 also sets @option{-mvis}.
19521 @item -mvis3
19522 @itemx -mno-vis3
19523 @opindex mvis3
19524 @opindex mno-vis3
19525 With @option{-mvis3}, GCC generates code that takes advantage of
19526 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
19527 default is @option{-mvis3} when targeting a cpu that supports such
19528 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
19529 also sets @option{-mvis2} and @option{-mvis}.
19531 @item -mcbcond
19532 @itemx -mno-cbcond
19533 @opindex mcbcond
19534 @opindex mno-cbcond
19535 With @option{-mcbcond}, GCC generates code that takes advantage of
19536 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
19537 The default is @option{-mcbcond} when targeting a cpu that supports such
19538 instructions, such as niagara-4 and later.
19540 @item -mpopc
19541 @itemx -mno-popc
19542 @opindex mpopc
19543 @opindex mno-popc
19544 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
19545 population count instruction.  The default is @option{-mpopc}
19546 when targeting a cpu that supports such instructions, such as Niagara-2 and
19547 later.
19549 @item -mfmaf
19550 @itemx -mno-fmaf
19551 @opindex mfmaf
19552 @opindex mno-fmaf
19553 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
19554 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
19555 when targeting a cpu that supports such instructions, such as Niagara-3 and
19556 later.
19558 @item -mfix-at697f
19559 @opindex mfix-at697f
19560 Enable the documented workaround for the single erratum of the Atmel AT697F
19561 processor (which corresponds to erratum #13 of the AT697E processor).
19563 @item -mfix-ut699
19564 @opindex mfix-ut699
19565 Enable the documented workarounds for the floating-point errata and the data
19566 cache nullify errata of the UT699 processor.
19567 @end table
19569 These @samp{-m} options are supported in addition to the above
19570 on SPARC-V9 processors in 64-bit environments:
19572 @table @gcctabopt
19573 @item -m32
19574 @itemx -m64
19575 @opindex m32
19576 @opindex m64
19577 Generate code for a 32-bit or 64-bit environment.
19578 The 32-bit environment sets int, long and pointer to 32 bits.
19579 The 64-bit environment sets int to 32 bits and long and pointer
19580 to 64 bits.
19582 @item -mcmodel=@var{which}
19583 @opindex mcmodel
19584 Set the code model to one of
19586 @table @samp
19587 @item medlow
19588 The Medium/Low code model: 64-bit addresses, programs
19589 must be linked in the low 32 bits of memory.  Programs can be statically
19590 or dynamically linked.
19592 @item medmid
19593 The Medium/Middle code model: 64-bit addresses, programs
19594 must be linked in the low 44 bits of memory, the text and data segments must
19595 be less than 2GB in size and the data segment must be located within 2GB of
19596 the text segment.
19598 @item medany
19599 The Medium/Anywhere code model: 64-bit addresses, programs
19600 may be linked anywhere in memory, the text and data segments must be less
19601 than 2GB in size and the data segment must be located within 2GB of the
19602 text segment.
19604 @item embmedany
19605 The Medium/Anywhere code model for embedded systems:
19606 64-bit addresses, the text and data segments must be less than 2GB in
19607 size, both starting anywhere in memory (determined at link time).  The
19608 global register %g4 points to the base of the data segment.  Programs
19609 are statically linked and PIC is not supported.
19610 @end table
19612 @item -mmemory-model=@var{mem-model}
19613 @opindex mmemory-model
19614 Set the memory model in force on the processor to one of
19616 @table @samp
19617 @item default
19618 The default memory model for the processor and operating system.
19620 @item rmo
19621 Relaxed Memory Order
19623 @item pso
19624 Partial Store Order
19626 @item tso
19627 Total Store Order
19629 @item sc
19630 Sequential Consistency
19631 @end table
19633 These memory models are formally defined in Appendix D of the Sparc V9
19634 architecture manual, as set in the processor's @code{PSTATE.MM} field.
19636 @item -mstack-bias
19637 @itemx -mno-stack-bias
19638 @opindex mstack-bias
19639 @opindex mno-stack-bias
19640 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
19641 frame pointer if present, are offset by @minus{}2047 which must be added back
19642 when making stack frame references.  This is the default in 64-bit mode.
19643 Otherwise, assume no such offset is present.
19644 @end table
19646 @node SPU Options
19647 @subsection SPU Options
19648 @cindex SPU options
19650 These @samp{-m} options are supported on the SPU:
19652 @table @gcctabopt
19653 @item -mwarn-reloc
19654 @itemx -merror-reloc
19655 @opindex mwarn-reloc
19656 @opindex merror-reloc
19658 The loader for SPU does not handle dynamic relocations.  By default, GCC
19659 gives an error when it generates code that requires a dynamic
19660 relocation.  @option{-mno-error-reloc} disables the error,
19661 @option{-mwarn-reloc} generates a warning instead.
19663 @item -msafe-dma
19664 @itemx -munsafe-dma
19665 @opindex msafe-dma
19666 @opindex munsafe-dma
19668 Instructions that initiate or test completion of DMA must not be
19669 reordered with respect to loads and stores of the memory that is being
19670 accessed.
19671 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
19672 memory accesses, but that can lead to inefficient code in places where the
19673 memory is known to not change.  Rather than mark the memory as volatile,
19674 you can use @option{-msafe-dma} to tell the compiler to treat
19675 the DMA instructions as potentially affecting all memory.  
19677 @item -mbranch-hints
19678 @opindex mbranch-hints
19680 By default, GCC generates a branch hint instruction to avoid
19681 pipeline stalls for always-taken or probably-taken branches.  A hint
19682 is not generated closer than 8 instructions away from its branch.
19683 There is little reason to disable them, except for debugging purposes,
19684 or to make an object a little bit smaller.
19686 @item -msmall-mem
19687 @itemx -mlarge-mem
19688 @opindex msmall-mem
19689 @opindex mlarge-mem
19691 By default, GCC generates code assuming that addresses are never larger
19692 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
19693 a full 32-bit address.
19695 @item -mstdmain
19696 @opindex mstdmain
19698 By default, GCC links against startup code that assumes the SPU-style
19699 main function interface (which has an unconventional parameter list).
19700 With @option{-mstdmain}, GCC links your program against startup
19701 code that assumes a C99-style interface to @code{main}, including a
19702 local copy of @code{argv} strings.
19704 @item -mfixed-range=@var{register-range}
19705 @opindex mfixed-range
19706 Generate code treating the given register range as fixed registers.
19707 A fixed register is one that the register allocator cannot use.  This is
19708 useful when compiling kernel code.  A register range is specified as
19709 two registers separated by a dash.  Multiple register ranges can be
19710 specified separated by a comma.
19712 @item -mea32
19713 @itemx -mea64
19714 @opindex mea32
19715 @opindex mea64
19716 Compile code assuming that pointers to the PPU address space accessed
19717 via the @code{__ea} named address space qualifier are either 32 or 64
19718 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
19719 all object code in an executable must be compiled with the same setting.
19721 @item -maddress-space-conversion
19722 @itemx -mno-address-space-conversion
19723 @opindex maddress-space-conversion
19724 @opindex mno-address-space-conversion
19725 Allow/disallow treating the @code{__ea} address space as superset
19726 of the generic address space.  This enables explicit type casts
19727 between @code{__ea} and generic pointer as well as implicit
19728 conversions of generic pointers to @code{__ea} pointers.  The
19729 default is to allow address space pointer conversions.
19731 @item -mcache-size=@var{cache-size}
19732 @opindex mcache-size
19733 This option controls the version of libgcc that the compiler links to an
19734 executable and selects a software-managed cache for accessing variables
19735 in the @code{__ea} address space with a particular cache size.  Possible
19736 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
19737 and @samp{128}.  The default cache size is 64KB.
19739 @item -matomic-updates
19740 @itemx -mno-atomic-updates
19741 @opindex matomic-updates
19742 @opindex mno-atomic-updates
19743 This option controls the version of libgcc that the compiler links to an
19744 executable and selects whether atomic updates to the software-managed
19745 cache of PPU-side variables are used.  If you use atomic updates, changes
19746 to a PPU variable from SPU code using the @code{__ea} named address space
19747 qualifier do not interfere with changes to other PPU variables residing
19748 in the same cache line from PPU code.  If you do not use atomic updates,
19749 such interference may occur; however, writing back cache lines is
19750 more efficient.  The default behavior is to use atomic updates.
19752 @item -mdual-nops
19753 @itemx -mdual-nops=@var{n}
19754 @opindex mdual-nops
19755 By default, GCC inserts nops to increase dual issue when it expects
19756 it to increase performance.  @var{n} can be a value from 0 to 10.  A
19757 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
19758 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
19760 @item -mhint-max-nops=@var{n}
19761 @opindex mhint-max-nops
19762 Maximum number of nops to insert for a branch hint.  A branch hint must
19763 be at least 8 instructions away from the branch it is affecting.  GCC
19764 inserts up to @var{n} nops to enforce this, otherwise it does not
19765 generate the branch hint.
19767 @item -mhint-max-distance=@var{n}
19768 @opindex mhint-max-distance
19769 The encoding of the branch hint instruction limits the hint to be within
19770 256 instructions of the branch it is affecting.  By default, GCC makes
19771 sure it is within 125.
19773 @item -msafe-hints
19774 @opindex msafe-hints
19775 Work around a hardware bug that causes the SPU to stall indefinitely.
19776 By default, GCC inserts the @code{hbrp} instruction to make sure
19777 this stall won't happen.
19779 @end table
19781 @node System V Options
19782 @subsection Options for System V
19784 These additional options are available on System V Release 4 for
19785 compatibility with other compilers on those systems:
19787 @table @gcctabopt
19788 @item -G
19789 @opindex G
19790 Create a shared object.
19791 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
19793 @item -Qy
19794 @opindex Qy
19795 Identify the versions of each tool used by the compiler, in a
19796 @code{.ident} assembler directive in the output.
19798 @item -Qn
19799 @opindex Qn
19800 Refrain from adding @code{.ident} directives to the output file (this is
19801 the default).
19803 @item -YP,@var{dirs}
19804 @opindex YP
19805 Search the directories @var{dirs}, and no others, for libraries
19806 specified with @option{-l}.
19808 @item -Ym,@var{dir}
19809 @opindex Ym
19810 Look in the directory @var{dir} to find the M4 preprocessor.
19811 The assembler uses this option.
19812 @c This is supposed to go with a -Yd for predefined M4 macro files, but
19813 @c the generic assembler that comes with Solaris takes just -Ym.
19814 @end table
19816 @node TILE-Gx Options
19817 @subsection TILE-Gx Options
19818 @cindex TILE-Gx options
19820 These @samp{-m} options are supported on the TILE-Gx:
19822 @table @gcctabopt
19823 @item -mcmodel=small
19824 @opindex mcmodel=small
19825 Generate code for the small model.  The distance for direct calls is
19826 limited to 500M in either direction.  PC-relative addresses are 32
19827 bits.  Absolute addresses support the full address range.
19829 @item -mcmodel=large
19830 @opindex mcmodel=large
19831 Generate code for the large model.  There is no limitation on call
19832 distance, pc-relative addresses, or absolute addresses.
19834 @item -mcpu=@var{name}
19835 @opindex mcpu
19836 Selects the type of CPU to be targeted.  Currently the only supported
19837 type is @samp{tilegx}.
19839 @item -m32
19840 @itemx -m64
19841 @opindex m32
19842 @opindex m64
19843 Generate code for a 32-bit or 64-bit environment.  The 32-bit
19844 environment sets int, long, and pointer to 32 bits.  The 64-bit
19845 environment sets int to 32 bits and long and pointer to 64 bits.
19846 @end table
19848 @node TILEPro Options
19849 @subsection TILEPro Options
19850 @cindex TILEPro options
19852 These @samp{-m} options are supported on the TILEPro:
19854 @table @gcctabopt
19855 @item -mcpu=@var{name}
19856 @opindex mcpu
19857 Selects the type of CPU to be targeted.  Currently the only supported
19858 type is @samp{tilepro}.
19860 @item -m32
19861 @opindex m32
19862 Generate code for a 32-bit environment, which sets int, long, and
19863 pointer to 32 bits.  This is the only supported behavior so the flag
19864 is essentially ignored.
19865 @end table
19867 @node V850 Options
19868 @subsection V850 Options
19869 @cindex V850 Options
19871 These @samp{-m} options are defined for V850 implementations:
19873 @table @gcctabopt
19874 @item -mlong-calls
19875 @itemx -mno-long-calls
19876 @opindex mlong-calls
19877 @opindex mno-long-calls
19878 Treat all calls as being far away (near).  If calls are assumed to be
19879 far away, the compiler always loads the function's address into a
19880 register, and calls indirect through the pointer.
19882 @item -mno-ep
19883 @itemx -mep
19884 @opindex mno-ep
19885 @opindex mep
19886 Do not optimize (do optimize) basic blocks that use the same index
19887 pointer 4 or more times to copy pointer into the @code{ep} register, and
19888 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
19889 option is on by default if you optimize.
19891 @item -mno-prolog-function
19892 @itemx -mprolog-function
19893 @opindex mno-prolog-function
19894 @opindex mprolog-function
19895 Do not use (do use) external functions to save and restore registers
19896 at the prologue and epilogue of a function.  The external functions
19897 are slower, but use less code space if more than one function saves
19898 the same number of registers.  The @option{-mprolog-function} option
19899 is on by default if you optimize.
19901 @item -mspace
19902 @opindex mspace
19903 Try to make the code as small as possible.  At present, this just turns
19904 on the @option{-mep} and @option{-mprolog-function} options.
19906 @item -mtda=@var{n}
19907 @opindex mtda
19908 Put static or global variables whose size is @var{n} bytes or less into
19909 the tiny data area that register @code{ep} points to.  The tiny data
19910 area can hold up to 256 bytes in total (128 bytes for byte references).
19912 @item -msda=@var{n}
19913 @opindex msda
19914 Put static or global variables whose size is @var{n} bytes or less into
19915 the small data area that register @code{gp} points to.  The small data
19916 area can hold up to 64 kilobytes.
19918 @item -mzda=@var{n}
19919 @opindex mzda
19920 Put static or global variables whose size is @var{n} bytes or less into
19921 the first 32 kilobytes of memory.
19923 @item -mv850
19924 @opindex mv850
19925 Specify that the target processor is the V850.
19927 @item -mv850e3v5
19928 @opindex mv850e3v5
19929 Specify that the target processor is the V850E3V5.  The preprocessor
19930 constant @samp{__v850e3v5__} is defined if this option is used.
19932 @item -mv850e2v4
19933 @opindex mv850e2v4
19934 Specify that the target processor is the V850E3V5.  This is an alias for
19935 the @option{-mv850e3v5} option.
19937 @item -mv850e2v3
19938 @opindex mv850e2v3
19939 Specify that the target processor is the V850E2V3.  The preprocessor
19940 constant @samp{__v850e2v3__} is defined if this option is used.
19942 @item -mv850e2
19943 @opindex mv850e2
19944 Specify that the target processor is the V850E2.  The preprocessor
19945 constant @samp{__v850e2__} is defined if this option is used.
19947 @item -mv850e1
19948 @opindex mv850e1
19949 Specify that the target processor is the V850E1.  The preprocessor
19950 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19951 this option is used.
19953 @item -mv850es
19954 @opindex mv850es
19955 Specify that the target processor is the V850ES.  This is an alias for
19956 the @option{-mv850e1} option.
19958 @item -mv850e
19959 @opindex mv850e
19960 Specify that the target processor is the V850E@.  The preprocessor
19961 constant @samp{__v850e__} is defined if this option is used.
19963 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19964 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
19965 are defined then a default target processor is chosen and the
19966 relevant @samp{__v850*__} preprocessor constant is defined.
19968 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19969 defined, regardless of which processor variant is the target.
19971 @item -mdisable-callt
19972 @itemx -mno-disable-callt
19973 @opindex mdisable-callt
19974 @opindex mno-disable-callt
19975 This option suppresses generation of the @code{CALLT} instruction for the
19976 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
19977 architecture.
19979 This option is enabled by default when the RH850 ABI is
19980 in use (see @option{-mrh850-abi}), and disabled by default when the
19981 GCC ABI is in use.  If @code{CALLT} instructions are being generated
19982 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
19984 @item -mrelax
19985 @itemx -mno-relax
19986 @opindex mrelax
19987 @opindex mno-relax
19988 Pass on (or do not pass on) the @option{-mrelax} command line option
19989 to the assembler.
19991 @item -mlong-jumps
19992 @itemx -mno-long-jumps
19993 @opindex mlong-jumps
19994 @opindex mno-long-jumps
19995 Disable (or re-enable) the generation of PC-relative jump instructions.
19997 @item -msoft-float
19998 @itemx -mhard-float
19999 @opindex msoft-float
20000 @opindex mhard-float
20001 Disable (or re-enable) the generation of hardware floating point
20002 instructions.  This option is only significant when the target
20003 architecture is @samp{V850E2V3} or higher.  If hardware floating point
20004 instructions are being generated then the C preprocessor symbol
20005 @code{__FPU_OK__} will be defined, otherwise the symbol
20006 @code{__NO_FPU__} will be defined.
20008 @item -mloop
20009 @opindex mloop
20010 Enables the use of the e3v5 LOOP instruction.  The use of this
20011 instruction is not enabled by default when the e3v5 architecture is
20012 selected because its use is still experimental.
20014 @item -mrh850-abi
20015 @itemx -mghs
20016 @opindex mrh850-abi
20017 @opindex mghs
20018 Enables support for the RH850 version of the V850 ABI.  This is the
20019 default.  With this version of the ABI the following rules apply:
20021 @itemize
20022 @item
20023 Integer sized structures and unions are returned via a memory pointer
20024 rather than a register.
20026 @item
20027 Large structures and unions (more than 8 bytes in size) are passed by
20028 value.
20030 @item
20031 Functions are aligned to 16-bit boundaries.
20033 @item
20034 The @option{-m8byte-align} command line option is supported.
20036 @item
20037 The @option{-mdisable-callt} command line option is enabled by
20038 default.  The @option{-mno-disable-callt} command line option is not
20039 supported.
20040 @end itemize
20042 When this version of the ABI is enabled the C preprocessor symbol
20043 @code{__V850_RH850_ABI__} is defined.
20045 @item -mgcc-abi
20046 @opindex mgcc-abi
20047 Enables support for the old GCC version of the V850 ABI.  With this
20048 version of the ABI the following rules apply:
20050 @itemize
20051 @item
20052 Integer sized structures and unions are returned in register @code{r10}.
20054 @item
20055 Large structures and unions (more than 8 bytes in size) are passed by
20056 reference.
20058 @item
20059 Functions are aligned to 32-bit boundaries, unless optimizing for
20060 size.
20062 @item
20063 The @option{-m8byte-align} command line option is not supported.
20065 @item
20066 The @option{-mdisable-callt} command line option is supported but not
20067 enabled by default.
20068 @end itemize
20070 When this version of the ABI is enabled the C preprocessor symbol
20071 @code{__V850_GCC_ABI__} is defined.
20073 @item -m8byte-align
20074 @itemx -mno-8byte-align
20075 @opindex m8byte-align
20076 @opindex mno-8byte-align
20077 Enables support for @code{doubles} and @code{long long} types to be
20078 aligned on 8-byte boundaries.  The default is to restrict the
20079 alignment of all objects to at most 4-bytes.  When
20080 @option{-m8byte-align} is in effect the C preprocessor symbol
20081 @code{__V850_8BYTE_ALIGN__} will be defined.
20083 @item -mbig-switch
20084 @opindex mbig-switch
20085 Generate code suitable for big switch tables.  Use this option only if
20086 the assembler/linker complain about out of range branches within a switch
20087 table.
20089 @item -mapp-regs
20090 @opindex mapp-regs
20091 This option causes r2 and r5 to be used in the code generated by
20092 the compiler.  This setting is the default.
20094 @item -mno-app-regs
20095 @opindex mno-app-regs
20096 This option causes r2 and r5 to be treated as fixed registers.
20098 @end table
20100 @node VAX Options
20101 @subsection VAX Options
20102 @cindex VAX options
20104 These @samp{-m} options are defined for the VAX:
20106 @table @gcctabopt
20107 @item -munix
20108 @opindex munix
20109 Do not output certain jump instructions (@code{aobleq} and so on)
20110 that the Unix assembler for the VAX cannot handle across long
20111 ranges.
20113 @item -mgnu
20114 @opindex mgnu
20115 Do output those jump instructions, on the assumption that the
20116 GNU assembler is being used.
20118 @item -mg
20119 @opindex mg
20120 Output code for G-format floating-point numbers instead of D-format.
20121 @end table
20123 @node VMS Options
20124 @subsection VMS Options
20126 These @samp{-m} options are defined for the VMS implementations:
20128 @table @gcctabopt
20129 @item -mvms-return-codes
20130 @opindex mvms-return-codes
20131 Return VMS condition codes from @code{main}. The default is to return POSIX-style
20132 condition (e.g.@ error) codes.
20134 @item -mdebug-main=@var{prefix}
20135 @opindex mdebug-main=@var{prefix}
20136 Flag the first routine whose name starts with @var{prefix} as the main
20137 routine for the debugger.
20139 @item -mmalloc64
20140 @opindex mmalloc64
20141 Default to 64-bit memory allocation routines.
20143 @item -mpointer-size=@var{size}
20144 @opindex -mpointer-size=@var{size}
20145 Set the default size of pointers. Possible options for @var{size} are
20146 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
20147 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
20148 The later option disables @code{pragma pointer_size}.
20149 @end table
20151 @node VxWorks Options
20152 @subsection VxWorks Options
20153 @cindex VxWorks Options
20155 The options in this section are defined for all VxWorks targets.
20156 Options specific to the target hardware are listed with the other
20157 options for that target.
20159 @table @gcctabopt
20160 @item -mrtp
20161 @opindex mrtp
20162 GCC can generate code for both VxWorks kernels and real time processes
20163 (RTPs).  This option switches from the former to the latter.  It also
20164 defines the preprocessor macro @code{__RTP__}.
20166 @item -non-static
20167 @opindex non-static
20168 Link an RTP executable against shared libraries rather than static
20169 libraries.  The options @option{-static} and @option{-shared} can
20170 also be used for RTPs (@pxref{Link Options}); @option{-static}
20171 is the default.
20173 @item -Bstatic
20174 @itemx -Bdynamic
20175 @opindex Bstatic
20176 @opindex Bdynamic
20177 These options are passed down to the linker.  They are defined for
20178 compatibility with Diab.
20180 @item -Xbind-lazy
20181 @opindex Xbind-lazy
20182 Enable lazy binding of function calls.  This option is equivalent to
20183 @option{-Wl,-z,now} and is defined for compatibility with Diab.
20185 @item -Xbind-now
20186 @opindex Xbind-now
20187 Disable lazy binding of function calls.  This option is the default and
20188 is defined for compatibility with Diab.
20189 @end table
20191 @node x86-64 Options
20192 @subsection x86-64 Options
20193 @cindex x86-64 options
20195 These are listed under @xref{i386 and x86-64 Options}.
20197 @node Xstormy16 Options
20198 @subsection Xstormy16 Options
20199 @cindex Xstormy16 Options
20201 These options are defined for Xstormy16:
20203 @table @gcctabopt
20204 @item -msim
20205 @opindex msim
20206 Choose startup files and linker script suitable for the simulator.
20207 @end table
20209 @node Xtensa Options
20210 @subsection Xtensa Options
20211 @cindex Xtensa Options
20213 These options are supported for Xtensa targets:
20215 @table @gcctabopt
20216 @item -mconst16
20217 @itemx -mno-const16
20218 @opindex mconst16
20219 @opindex mno-const16
20220 Enable or disable use of @code{CONST16} instructions for loading
20221 constant values.  The @code{CONST16} instruction is currently not a
20222 standard option from Tensilica.  When enabled, @code{CONST16}
20223 instructions are always used in place of the standard @code{L32R}
20224 instructions.  The use of @code{CONST16} is enabled by default only if
20225 the @code{L32R} instruction is not available.
20227 @item -mfused-madd
20228 @itemx -mno-fused-madd
20229 @opindex mfused-madd
20230 @opindex mno-fused-madd
20231 Enable or disable use of fused multiply/add and multiply/subtract
20232 instructions in the floating-point option.  This has no effect if the
20233 floating-point option is not also enabled.  Disabling fused multiply/add
20234 and multiply/subtract instructions forces the compiler to use separate
20235 instructions for the multiply and add/subtract operations.  This may be
20236 desirable in some cases where strict IEEE 754-compliant results are
20237 required: the fused multiply add/subtract instructions do not round the
20238 intermediate result, thereby producing results with @emph{more} bits of
20239 precision than specified by the IEEE standard.  Disabling fused multiply
20240 add/subtract instructions also ensures that the program output is not
20241 sensitive to the compiler's ability to combine multiply and add/subtract
20242 operations.
20244 @item -mserialize-volatile
20245 @itemx -mno-serialize-volatile
20246 @opindex mserialize-volatile
20247 @opindex mno-serialize-volatile
20248 When this option is enabled, GCC inserts @code{MEMW} instructions before
20249 @code{volatile} memory references to guarantee sequential consistency.
20250 The default is @option{-mserialize-volatile}.  Use
20251 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
20253 @item -mforce-no-pic
20254 @opindex mforce-no-pic
20255 For targets, like GNU/Linux, where all user-mode Xtensa code must be
20256 position-independent code (PIC), this option disables PIC for compiling
20257 kernel code.
20259 @item -mtext-section-literals
20260 @itemx -mno-text-section-literals
20261 @opindex mtext-section-literals
20262 @opindex mno-text-section-literals
20263 Control the treatment of literal pools.  The default is
20264 @option{-mno-text-section-literals}, which places literals in a separate
20265 section in the output file.  This allows the literal pool to be placed
20266 in a data RAM/ROM, and it also allows the linker to combine literal
20267 pools from separate object files to remove redundant literals and
20268 improve code size.  With @option{-mtext-section-literals}, the literals
20269 are interspersed in the text section in order to keep them as close as
20270 possible to their references.  This may be necessary for large assembly
20271 files.
20273 @item -mtarget-align
20274 @itemx -mno-target-align
20275 @opindex mtarget-align
20276 @opindex mno-target-align
20277 When this option is enabled, GCC instructs the assembler to
20278 automatically align instructions to reduce branch penalties at the
20279 expense of some code density.  The assembler attempts to widen density
20280 instructions to align branch targets and the instructions following call
20281 instructions.  If there are not enough preceding safe density
20282 instructions to align a target, no widening is performed.  The
20283 default is @option{-mtarget-align}.  These options do not affect the
20284 treatment of auto-aligned instructions like @code{LOOP}, which the
20285 assembler always aligns, either by widening density instructions or
20286 by inserting NOP instructions.
20288 @item -mlongcalls
20289 @itemx -mno-longcalls
20290 @opindex mlongcalls
20291 @opindex mno-longcalls
20292 When this option is enabled, GCC instructs the assembler to translate
20293 direct calls to indirect calls unless it can determine that the target
20294 of a direct call is in the range allowed by the call instruction.  This
20295 translation typically occurs for calls to functions in other source
20296 files.  Specifically, the assembler translates a direct @code{CALL}
20297 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
20298 The default is @option{-mno-longcalls}.  This option should be used in
20299 programs where the call target can potentially be out of range.  This
20300 option is implemented in the assembler, not the compiler, so the
20301 assembly code generated by GCC still shows direct call
20302 instructions---look at the disassembled object code to see the actual
20303 instructions.  Note that the assembler uses an indirect call for
20304 every cross-file call, not just those that really are out of range.
20305 @end table
20307 @node zSeries Options
20308 @subsection zSeries Options
20309 @cindex zSeries options
20311 These are listed under @xref{S/390 and zSeries Options}.
20313 @node Code Gen Options
20314 @section Options for Code Generation Conventions
20315 @cindex code generation conventions
20316 @cindex options, code generation
20317 @cindex run-time options
20319 These machine-independent options control the interface conventions
20320 used in code generation.
20322 Most of them have both positive and negative forms; the negative form
20323 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
20324 one of the forms is listed---the one that is not the default.  You
20325 can figure out the other form by either removing @samp{no-} or adding
20328 @table @gcctabopt
20329 @item -fbounds-check
20330 @opindex fbounds-check
20331 For front ends that support it, generate additional code to check that
20332 indices used to access arrays are within the declared range.  This is
20333 currently only supported by the Java and Fortran front ends, where
20334 this option defaults to true and false respectively.
20336 @item -fstack-reuse=@var{reuse-level}
20337 @opindex fstack_reuse
20338 This option controls stack space reuse for user declared local/auto variables
20339 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
20340 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
20341 local variables and temporaries, @samp{named_vars} enables the reuse only for
20342 user defined local variables with names, and @samp{none} disables stack reuse
20343 completely. The default value is @samp{all}. The option is needed when the
20344 program extends the lifetime of a scoped local variable or a compiler generated
20345 temporary beyond the end point defined by the language.  When a lifetime of
20346 a variable ends, and if the variable lives in memory, the optimizing compiler
20347 has the freedom to reuse its stack space with other temporaries or scoped
20348 local variables whose live range does not overlap with it. Legacy code extending
20349 local lifetime will likely to break with the stack reuse optimization.
20351 For example,
20353 @smallexample
20354    int *p;
20355    @{
20356      int local1;
20358      p = &local1;
20359      local1 = 10;
20360      ....
20361    @}
20362    @{
20363       int local2;
20364       local2 = 20;
20365       ...
20366    @}
20368    if (*p == 10)  // out of scope use of local1
20369      @{
20371      @}
20372 @end smallexample
20374 Another example:
20375 @smallexample
20377    struct A
20378    @{
20379        A(int k) : i(k), j(k) @{ @}
20380        int i;
20381        int j;
20382    @};
20384    A *ap;
20386    void foo(const A& ar)
20387    @{
20388       ap = &ar;
20389    @}
20391    void bar()
20392    @{
20393       foo(A(10)); // temp object's lifetime ends when foo returns
20395       @{
20396         A a(20);
20397         ....
20398       @}
20399       ap->i+= 10;  // ap references out of scope temp whose space
20400                    // is reused with a. What is the value of ap->i?
20401    @}
20403 @end smallexample
20405 The lifetime of a compiler generated temporary is well defined by the C++
20406 standard. When a lifetime of a temporary ends, and if the temporary lives
20407 in memory, the optimizing compiler has the freedom to reuse its stack
20408 space with other temporaries or scoped local variables whose live range
20409 does not overlap with it. However some of the legacy code relies on
20410 the behavior of older compilers in which temporaries' stack space is
20411 not reused, the aggressive stack reuse can lead to runtime errors. This
20412 option is used to control the temporary stack reuse optimization.
20414 @item -ftrapv
20415 @opindex ftrapv
20416 This option generates traps for signed overflow on addition, subtraction,
20417 multiplication operations.
20419 @item -fwrapv
20420 @opindex fwrapv
20421 This option instructs the compiler to assume that signed arithmetic
20422 overflow of addition, subtraction and multiplication wraps around
20423 using twos-complement representation.  This flag enables some optimizations
20424 and disables others.  This option is enabled by default for the Java
20425 front end, as required by the Java language specification.
20427 @item -fexceptions
20428 @opindex fexceptions
20429 Enable exception handling.  Generates extra code needed to propagate
20430 exceptions.  For some targets, this implies GCC generates frame
20431 unwind information for all functions, which can produce significant data
20432 size overhead, although it does not affect execution.  If you do not
20433 specify this option, GCC enables it by default for languages like
20434 C++ that normally require exception handling, and disables it for
20435 languages like C that do not normally require it.  However, you may need
20436 to enable this option when compiling C code that needs to interoperate
20437 properly with exception handlers written in C++.  You may also wish to
20438 disable this option if you are compiling older C++ programs that don't
20439 use exception handling.
20441 @item -fnon-call-exceptions
20442 @opindex fnon-call-exceptions
20443 Generate code that allows trapping instructions to throw exceptions.
20444 Note that this requires platform-specific runtime support that does
20445 not exist everywhere.  Moreover, it only allows @emph{trapping}
20446 instructions to throw exceptions, i.e.@: memory references or floating-point
20447 instructions.  It does not allow exceptions to be thrown from
20448 arbitrary signal handlers such as @code{SIGALRM}.
20450 @item -fdelete-dead-exceptions
20451 @opindex fdelete-dead-exceptions
20452 Consider that instructions that may throw exceptions but don't otherwise
20453 contribute to the execution of the program can be optimized away.
20454 This option is enabled by default for the Ada front end, as permitted by
20455 the Ada language specification.
20456 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
20458 @item -funwind-tables
20459 @opindex funwind-tables
20460 Similar to @option{-fexceptions}, except that it just generates any needed
20461 static data, but does not affect the generated code in any other way.
20462 You normally do not need to enable this option; instead, a language processor
20463 that needs this handling enables it on your behalf.
20465 @item -fasynchronous-unwind-tables
20466 @opindex fasynchronous-unwind-tables
20467 Generate unwind table in DWARF 2 format, if supported by target machine.  The
20468 table is exact at each instruction boundary, so it can be used for stack
20469 unwinding from asynchronous events (such as debugger or garbage collector).
20471 @item -fno-gnu-unique
20472 @opindex fno-gnu-unique
20473 On systems with recent GNU assembler and C library, the C++ compiler
20474 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
20475 of template static data members and static local variables in inline
20476 functions are unique even in the presence of @code{RTLD_LOCAL}; this
20477 is necessary to avoid problems with a library used by two different
20478 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
20479 therefore disagreeing with the other one about the binding of the
20480 symbol.  But this causes @code{dlclose} to be ignored for affected
20481 DSOs; if your program relies on reinitialization of a DSO via
20482 @code{dlclose} and @code{dlopen}, you can use
20483 @option{-fno-gnu-unique}.
20485 @item -fpcc-struct-return
20486 @opindex fpcc-struct-return
20487 Return ``short'' @code{struct} and @code{union} values in memory like
20488 longer ones, rather than in registers.  This convention is less
20489 efficient, but it has the advantage of allowing intercallability between
20490 GCC-compiled files and files compiled with other compilers, particularly
20491 the Portable C Compiler (pcc).
20493 The precise convention for returning structures in memory depends
20494 on the target configuration macros.
20496 Short structures and unions are those whose size and alignment match
20497 that of some integer type.
20499 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
20500 switch is not binary compatible with code compiled with the
20501 @option{-freg-struct-return} switch.
20502 Use it to conform to a non-default application binary interface.
20504 @item -freg-struct-return
20505 @opindex freg-struct-return
20506 Return @code{struct} and @code{union} values in registers when possible.
20507 This is more efficient for small structures than
20508 @option{-fpcc-struct-return}.
20510 If you specify neither @option{-fpcc-struct-return} nor
20511 @option{-freg-struct-return}, GCC defaults to whichever convention is
20512 standard for the target.  If there is no standard convention, GCC
20513 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
20514 the principal compiler.  In those cases, we can choose the standard, and
20515 we chose the more efficient register return alternative.
20517 @strong{Warning:} code compiled with the @option{-freg-struct-return}
20518 switch is not binary compatible with code compiled with the
20519 @option{-fpcc-struct-return} switch.
20520 Use it to conform to a non-default application binary interface.
20522 @item -fshort-enums
20523 @opindex fshort-enums
20524 Allocate to an @code{enum} type only as many bytes as it needs for the
20525 declared range of possible values.  Specifically, the @code{enum} type
20526 is equivalent to the smallest integer type that has enough room.
20528 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
20529 code that is not binary compatible with code generated without that switch.
20530 Use it to conform to a non-default application binary interface.
20532 @item -fshort-double
20533 @opindex fshort-double
20534 Use the same size for @code{double} as for @code{float}.
20536 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
20537 code that is not binary compatible with code generated without that switch.
20538 Use it to conform to a non-default application binary interface.
20540 @item -fshort-wchar
20541 @opindex fshort-wchar
20542 Override the underlying type for @samp{wchar_t} to be @samp{short
20543 unsigned int} instead of the default for the target.  This option is
20544 useful for building programs to run under WINE@.
20546 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
20547 code that is not binary compatible with code generated without that switch.
20548 Use it to conform to a non-default application binary interface.
20550 @item -fno-common
20551 @opindex fno-common
20552 In C code, controls the placement of uninitialized global variables.
20553 Unix C compilers have traditionally permitted multiple definitions of
20554 such variables in different compilation units by placing the variables
20555 in a common block.
20556 This is the behavior specified by @option{-fcommon}, and is the default
20557 for GCC on most targets.
20558 On the other hand, this behavior is not required by ISO C, and on some
20559 targets may carry a speed or code size penalty on variable references.
20560 The @option{-fno-common} option specifies that the compiler should place
20561 uninitialized global variables in the data section of the object file,
20562 rather than generating them as common blocks.
20563 This has the effect that if the same variable is declared
20564 (without @code{extern}) in two different compilations,
20565 you get a multiple-definition error when you link them.
20566 In this case, you must compile with @option{-fcommon} instead.
20567 Compiling with @option{-fno-common} is useful on targets for which
20568 it provides better performance, or if you wish to verify that the
20569 program will work on other systems that always treat uninitialized
20570 variable declarations this way.
20572 @item -fno-ident
20573 @opindex fno-ident
20574 Ignore the @samp{#ident} directive.
20576 @item -finhibit-size-directive
20577 @opindex finhibit-size-directive
20578 Don't output a @code{.size} assembler directive, or anything else that
20579 would cause trouble if the function is split in the middle, and the
20580 two halves are placed at locations far apart in memory.  This option is
20581 used when compiling @file{crtstuff.c}; you should not need to use it
20582 for anything else.
20584 @item -fverbose-asm
20585 @opindex fverbose-asm
20586 Put extra commentary information in the generated assembly code to
20587 make it more readable.  This option is generally only of use to those
20588 who actually need to read the generated assembly code (perhaps while
20589 debugging the compiler itself).
20591 @option{-fno-verbose-asm}, the default, causes the
20592 extra information to be omitted and is useful when comparing two assembler
20593 files.
20595 @item -frecord-gcc-switches
20596 @opindex frecord-gcc-switches
20597 This switch causes the command line used to invoke the
20598 compiler to be recorded into the object file that is being created.
20599 This switch is only implemented on some targets and the exact format
20600 of the recording is target and binary file format dependent, but it
20601 usually takes the form of a section containing ASCII text.  This
20602 switch is related to the @option{-fverbose-asm} switch, but that
20603 switch only records information in the assembler output file as
20604 comments, so it never reaches the object file.
20605 See also @option{-grecord-gcc-switches} for another
20606 way of storing compiler options into the object file.
20608 @item -fpic
20609 @opindex fpic
20610 @cindex global offset table
20611 @cindex PIC
20612 Generate position-independent code (PIC) suitable for use in a shared
20613 library, if supported for the target machine.  Such code accesses all
20614 constant addresses through a global offset table (GOT)@.  The dynamic
20615 loader resolves the GOT entries when the program starts (the dynamic
20616 loader is not part of GCC; it is part of the operating system).  If
20617 the GOT size for the linked executable exceeds a machine-specific
20618 maximum size, you get an error message from the linker indicating that
20619 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
20620 instead.  (These maximums are 8k on the SPARC and 32k
20621 on the m68k and RS/6000.  The 386 has no such limit.)
20623 Position-independent code requires special support, and therefore works
20624 only on certain machines.  For the 386, GCC supports PIC for System V
20625 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
20626 position-independent.
20628 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20629 are defined to 1.
20631 @item -fPIC
20632 @opindex fPIC
20633 If supported for the target machine, emit position-independent code,
20634 suitable for dynamic linking and avoiding any limit on the size of the
20635 global offset table.  This option makes a difference on the m68k,
20636 PowerPC and SPARC@.
20638 Position-independent code requires special support, and therefore works
20639 only on certain machines.
20641 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20642 are defined to 2.
20644 @item -fpie
20645 @itemx -fPIE
20646 @opindex fpie
20647 @opindex fPIE
20648 These options are similar to @option{-fpic} and @option{-fPIC}, but
20649 generated position independent code can be only linked into executables.
20650 Usually these options are used when @option{-pie} GCC option is
20651 used during linking.
20653 @option{-fpie} and @option{-fPIE} both define the macros
20654 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
20655 for @option{-fpie} and 2 for @option{-fPIE}.
20657 @item -fno-jump-tables
20658 @opindex fno-jump-tables
20659 Do not use jump tables for switch statements even where it would be
20660 more efficient than other code generation strategies.  This option is
20661 of use in conjunction with @option{-fpic} or @option{-fPIC} for
20662 building code that forms part of a dynamic linker and cannot
20663 reference the address of a jump table.  On some targets, jump tables
20664 do not require a GOT and this option is not needed.
20666 @item -ffixed-@var{reg}
20667 @opindex ffixed
20668 Treat the register named @var{reg} as a fixed register; generated code
20669 should never refer to it (except perhaps as a stack pointer, frame
20670 pointer or in some other fixed role).
20672 @var{reg} must be the name of a register.  The register names accepted
20673 are machine-specific and are defined in the @code{REGISTER_NAMES}
20674 macro in the machine description macro file.
20676 This flag does not have a negative form, because it specifies a
20677 three-way choice.
20679 @item -fcall-used-@var{reg}
20680 @opindex fcall-used
20681 Treat the register named @var{reg} as an allocable register that is
20682 clobbered by function calls.  It may be allocated for temporaries or
20683 variables that do not live across a call.  Functions compiled this way
20684 do not save and restore the register @var{reg}.
20686 It is an error to use this flag with the frame pointer or stack pointer.
20687 Use of this flag for other registers that have fixed pervasive roles in
20688 the machine's execution model produces disastrous results.
20690 This flag does not have a negative form, because it specifies a
20691 three-way choice.
20693 @item -fcall-saved-@var{reg}
20694 @opindex fcall-saved
20695 Treat the register named @var{reg} as an allocable register saved by
20696 functions.  It may be allocated even for temporaries or variables that
20697 live across a call.  Functions compiled this way save and restore
20698 the register @var{reg} if they use it.
20700 It is an error to use this flag with the frame pointer or stack pointer.
20701 Use of this flag for other registers that have fixed pervasive roles in
20702 the machine's execution model produces disastrous results.
20704 A different sort of disaster results from the use of this flag for
20705 a register in which function values may be returned.
20707 This flag does not have a negative form, because it specifies a
20708 three-way choice.
20710 @item -fpack-struct[=@var{n}]
20711 @opindex fpack-struct
20712 Without a value specified, pack all structure members together without
20713 holes.  When a value is specified (which must be a small power of two), pack
20714 structure members according to this value, representing the maximum
20715 alignment (that is, objects with default alignment requirements larger than
20716 this are output potentially unaligned at the next fitting location.
20718 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
20719 code that is not binary compatible with code generated without that switch.
20720 Additionally, it makes the code suboptimal.
20721 Use it to conform to a non-default application binary interface.
20723 @item -finstrument-functions
20724 @opindex finstrument-functions
20725 Generate instrumentation calls for entry and exit to functions.  Just
20726 after function entry and just before function exit, the following
20727 profiling functions are called with the address of the current
20728 function and its call site.  (On some platforms,
20729 @code{__builtin_return_address} does not work beyond the current
20730 function, so the call site information may not be available to the
20731 profiling functions otherwise.)
20733 @smallexample
20734 void __cyg_profile_func_enter (void *this_fn,
20735                                void *call_site);
20736 void __cyg_profile_func_exit  (void *this_fn,
20737                                void *call_site);
20738 @end smallexample
20740 The first argument is the address of the start of the current function,
20741 which may be looked up exactly in the symbol table.
20743 This instrumentation is also done for functions expanded inline in other
20744 functions.  The profiling calls indicate where, conceptually, the
20745 inline function is entered and exited.  This means that addressable
20746 versions of such functions must be available.  If all your uses of a
20747 function are expanded inline, this may mean an additional expansion of
20748 code size.  If you use @samp{extern inline} in your C code, an
20749 addressable version of such functions must be provided.  (This is
20750 normally the case anyway, but if you get lucky and the optimizer always
20751 expands the functions inline, you might have gotten away without
20752 providing static copies.)
20754 A function may be given the attribute @code{no_instrument_function}, in
20755 which case this instrumentation is not done.  This can be used, for
20756 example, for the profiling functions listed above, high-priority
20757 interrupt routines, and any functions from which the profiling functions
20758 cannot safely be called (perhaps signal handlers, if the profiling
20759 routines generate output or allocate memory).
20761 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
20762 @opindex finstrument-functions-exclude-file-list
20764 Set the list of functions that are excluded from instrumentation (see
20765 the description of @code{-finstrument-functions}).  If the file that
20766 contains a function definition matches with one of @var{file}, then
20767 that function is not instrumented.  The match is done on substrings:
20768 if the @var{file} parameter is a substring of the file name, it is
20769 considered to be a match.
20771 For example:
20773 @smallexample
20774 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
20775 @end smallexample
20777 @noindent
20778 excludes any inline function defined in files whose pathnames
20779 contain @code{/bits/stl} or @code{include/sys}.
20781 If, for some reason, you want to include letter @code{','} in one of
20782 @var{sym}, write @code{'\,'}. For example,
20783 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
20784 (note the single quote surrounding the option).
20786 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
20787 @opindex finstrument-functions-exclude-function-list
20789 This is similar to @code{-finstrument-functions-exclude-file-list},
20790 but this option sets the list of function names to be excluded from
20791 instrumentation.  The function name to be matched is its user-visible
20792 name, such as @code{vector<int> blah(const vector<int> &)}, not the
20793 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
20794 match is done on substrings: if the @var{sym} parameter is a substring
20795 of the function name, it is considered to be a match.  For C99 and C++
20796 extended identifiers, the function name must be given in UTF-8, not
20797 using universal character names.
20799 @item -fstack-check
20800 @opindex fstack-check
20801 Generate code to verify that you do not go beyond the boundary of the
20802 stack.  You should specify this flag if you are running in an
20803 environment with multiple threads, but you only rarely need to specify it in
20804 a single-threaded environment since stack overflow is automatically
20805 detected on nearly all systems if there is only one stack.
20807 Note that this switch does not actually cause checking to be done; the
20808 operating system or the language runtime must do that.  The switch causes
20809 generation of code to ensure that they see the stack being extended.
20811 You can additionally specify a string parameter: @code{no} means no
20812 checking, @code{generic} means force the use of old-style checking,
20813 @code{specific} means use the best checking method and is equivalent
20814 to bare @option{-fstack-check}.
20816 Old-style checking is a generic mechanism that requires no specific
20817 target support in the compiler but comes with the following drawbacks:
20819 @enumerate
20820 @item
20821 Modified allocation strategy for large objects: they are always
20822 allocated dynamically if their size exceeds a fixed threshold.
20824 @item
20825 Fixed limit on the size of the static frame of functions: when it is
20826 topped by a particular function, stack checking is not reliable and
20827 a warning is issued by the compiler.
20829 @item
20830 Inefficiency: because of both the modified allocation strategy and the
20831 generic implementation, code performance is hampered.
20832 @end enumerate
20834 Note that old-style stack checking is also the fallback method for
20835 @code{specific} if no target support has been added in the compiler.
20837 @item -fstack-limit-register=@var{reg}
20838 @itemx -fstack-limit-symbol=@var{sym}
20839 @itemx -fno-stack-limit
20840 @opindex fstack-limit-register
20841 @opindex fstack-limit-symbol
20842 @opindex fno-stack-limit
20843 Generate code to ensure that the stack does not grow beyond a certain value,
20844 either the value of a register or the address of a symbol.  If a larger
20845 stack is required, a signal is raised at run time.  For most targets,
20846 the signal is raised before the stack overruns the boundary, so
20847 it is possible to catch the signal without taking special precautions.
20849 For instance, if the stack starts at absolute address @samp{0x80000000}
20850 and grows downwards, you can use the flags
20851 @option{-fstack-limit-symbol=__stack_limit} and
20852 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
20853 of 128KB@.  Note that this may only work with the GNU linker.
20855 @item -fsplit-stack
20856 @opindex fsplit-stack
20857 Generate code to automatically split the stack before it overflows.
20858 The resulting program has a discontiguous stack which can only
20859 overflow if the program is unable to allocate any more memory.  This
20860 is most useful when running threaded programs, as it is no longer
20861 necessary to calculate a good stack size to use for each thread.  This
20862 is currently only implemented for the i386 and x86_64 back ends running
20863 GNU/Linux.
20865 When code compiled with @option{-fsplit-stack} calls code compiled
20866 without @option{-fsplit-stack}, there may not be much stack space
20867 available for the latter code to run.  If compiling all code,
20868 including library code, with @option{-fsplit-stack} is not an option,
20869 then the linker can fix up these calls so that the code compiled
20870 without @option{-fsplit-stack} always has a large stack.  Support for
20871 this is implemented in the gold linker in GNU binutils release 2.21
20872 and later.
20874 @item -fleading-underscore
20875 @opindex fleading-underscore
20876 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
20877 change the way C symbols are represented in the object file.  One use
20878 is to help link with legacy assembly code.
20880 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
20881 generate code that is not binary compatible with code generated without that
20882 switch.  Use it to conform to a non-default application binary interface.
20883 Not all targets provide complete support for this switch.
20885 @item -ftls-model=@var{model}
20886 @opindex ftls-model
20887 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
20888 The @var{model} argument should be one of @code{global-dynamic},
20889 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
20891 The default without @option{-fpic} is @code{initial-exec}; with
20892 @option{-fpic} the default is @code{global-dynamic}.
20894 @item -fvisibility=@var{default|internal|hidden|protected}
20895 @opindex fvisibility
20896 Set the default ELF image symbol visibility to the specified option---all
20897 symbols are marked with this unless overridden within the code.
20898 Using this feature can very substantially improve linking and
20899 load times of shared object libraries, produce more optimized
20900 code, provide near-perfect API export and prevent symbol clashes.
20901 It is @strong{strongly} recommended that you use this in any shared objects
20902 you distribute.
20904 Despite the nomenclature, @code{default} always means public; i.e.,
20905 available to be linked against from outside the shared object.
20906 @code{protected} and @code{internal} are pretty useless in real-world
20907 usage so the only other commonly used option is @code{hidden}.
20908 The default if @option{-fvisibility} isn't specified is
20909 @code{default}, i.e., make every
20910 symbol public---this causes the same behavior as previous versions of
20911 GCC@.
20913 A good explanation of the benefits offered by ensuring ELF
20914 symbols have the correct visibility is given by ``How To Write
20915 Shared Libraries'' by Ulrich Drepper (which can be found at
20916 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
20917 solution made possible by this option to marking things hidden when
20918 the default is public is to make the default hidden and mark things
20919 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
20920 and @code{__attribute__ ((visibility("default")))} instead of
20921 @code{__declspec(dllexport)} you get almost identical semantics with
20922 identical syntax.  This is a great boon to those working with
20923 cross-platform projects.
20925 For those adding visibility support to existing code, you may find
20926 @samp{#pragma GCC visibility} of use.  This works by you enclosing
20927 the declarations you wish to set visibility for with (for example)
20928 @samp{#pragma GCC visibility push(hidden)} and
20929 @samp{#pragma GCC visibility pop}.
20930 Bear in mind that symbol visibility should be viewed @strong{as
20931 part of the API interface contract} and thus all new code should
20932 always specify visibility when it is not the default; i.e., declarations
20933 only for use within the local DSO should @strong{always} be marked explicitly
20934 as hidden as so to avoid PLT indirection overheads---making this
20935 abundantly clear also aids readability and self-documentation of the code.
20936 Note that due to ISO C++ specification requirements, @code{operator new} and
20937 @code{operator delete} must always be of default visibility.
20939 Be aware that headers from outside your project, in particular system
20940 headers and headers from any other library you use, may not be
20941 expecting to be compiled with visibility other than the default.  You
20942 may need to explicitly say @samp{#pragma GCC visibility push(default)}
20943 before including any such headers.
20945 @samp{extern} declarations are not affected by @option{-fvisibility}, so
20946 a lot of code can be recompiled with @option{-fvisibility=hidden} with
20947 no modifications.  However, this means that calls to @code{extern}
20948 functions with no explicit visibility use the PLT, so it is more
20949 effective to use @code{__attribute ((visibility))} and/or
20950 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
20951 declarations should be treated as hidden.
20953 Note that @option{-fvisibility} does affect C++ vague linkage
20954 entities. This means that, for instance, an exception class that is
20955 be thrown between DSOs must be explicitly marked with default
20956 visibility so that the @samp{type_info} nodes are unified between
20957 the DSOs.
20959 An overview of these techniques, their benefits and how to use them
20960 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
20962 @item -fstrict-volatile-bitfields
20963 @opindex fstrict-volatile-bitfields
20964 This option should be used if accesses to volatile bit-fields (or other
20965 structure fields, although the compiler usually honors those types
20966 anyway) should use a single access of the width of the
20967 field's type, aligned to a natural alignment if possible.  For
20968 example, targets with memory-mapped peripheral registers might require
20969 all such accesses to be 16 bits wide; with this flag you can
20970 declare all peripheral bit-fields as @code{unsigned short} (assuming short
20971 is 16 bits on these targets) to force GCC to use 16-bit accesses
20972 instead of, perhaps, a more efficient 32-bit access.
20974 If this option is disabled, the compiler uses the most efficient
20975 instruction.  In the previous example, that might be a 32-bit load
20976 instruction, even though that accesses bytes that do not contain
20977 any portion of the bit-field, or memory-mapped registers unrelated to
20978 the one being updated.
20980 If the target requires strict alignment, and honoring the field
20981 type would require violating this alignment, a warning is issued.
20982 If the field has @code{packed} attribute, the access is done without
20983 honoring the field type.  If the field doesn't have @code{packed}
20984 attribute, the access is done honoring the field type.  In both cases,
20985 GCC assumes that the user knows something about the target hardware
20986 that it is unaware of.
20988 The default value of this option is determined by the application binary
20989 interface for the target processor.
20991 @item -fsync-libcalls
20992 @opindex fsync-libcalls
20993 This option controls whether any out-of-line instance of the @code{__sync}
20994 family of functions may be used to implement the C++11 @code{__atomic}
20995 family of functions.
20997 The default value of this option is enabled, thus the only useful form
20998 of the option is @option{-fno-sync-libcalls}.  This option is used in
20999 the implementation of the @file{libatomic} runtime library.
21001 @end table
21003 @c man end
21005 @node Environment Variables
21006 @section Environment Variables Affecting GCC
21007 @cindex environment variables
21009 @c man begin ENVIRONMENT
21010 This section describes several environment variables that affect how GCC
21011 operates.  Some of them work by specifying directories or prefixes to use
21012 when searching for various kinds of files.  Some are used to specify other
21013 aspects of the compilation environment.
21015 Note that you can also specify places to search using options such as
21016 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
21017 take precedence over places specified using environment variables, which
21018 in turn take precedence over those specified by the configuration of GCC@.
21019 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
21020 GNU Compiler Collection (GCC) Internals}.
21022 @table @env
21023 @item LANG
21024 @itemx LC_CTYPE
21025 @c @itemx LC_COLLATE
21026 @itemx LC_MESSAGES
21027 @c @itemx LC_MONETARY
21028 @c @itemx LC_NUMERIC
21029 @c @itemx LC_TIME
21030 @itemx LC_ALL
21031 @findex LANG
21032 @findex LC_CTYPE
21033 @c @findex LC_COLLATE
21034 @findex LC_MESSAGES
21035 @c @findex LC_MONETARY
21036 @c @findex LC_NUMERIC
21037 @c @findex LC_TIME
21038 @findex LC_ALL
21039 @cindex locale
21040 These environment variables control the way that GCC uses
21041 localization information which allows GCC to work with different
21042 national conventions.  GCC inspects the locale categories
21043 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
21044 so.  These locale categories can be set to any value supported by your
21045 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
21046 Kingdom encoded in UTF-8.
21048 The @env{LC_CTYPE} environment variable specifies character
21049 classification.  GCC uses it to determine the character boundaries in
21050 a string; this is needed for some multibyte encodings that contain quote
21051 and escape characters that are otherwise interpreted as a string
21052 end or escape.
21054 The @env{LC_MESSAGES} environment variable specifies the language to
21055 use in diagnostic messages.
21057 If the @env{LC_ALL} environment variable is set, it overrides the value
21058 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
21059 and @env{LC_MESSAGES} default to the value of the @env{LANG}
21060 environment variable.  If none of these variables are set, GCC
21061 defaults to traditional C English behavior.
21063 @item TMPDIR
21064 @findex TMPDIR
21065 If @env{TMPDIR} is set, it specifies the directory to use for temporary
21066 files.  GCC uses temporary files to hold the output of one stage of
21067 compilation which is to be used as input to the next stage: for example,
21068 the output of the preprocessor, which is the input to the compiler
21069 proper.
21071 @item GCC_COMPARE_DEBUG
21072 @findex GCC_COMPARE_DEBUG
21073 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
21074 @option{-fcompare-debug} to the compiler driver.  See the documentation
21075 of this option for more details.
21077 @item GCC_EXEC_PREFIX
21078 @findex GCC_EXEC_PREFIX
21079 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
21080 names of the subprograms executed by the compiler.  No slash is added
21081 when this prefix is combined with the name of a subprogram, but you can
21082 specify a prefix that ends with a slash if you wish.
21084 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
21085 an appropriate prefix to use based on the pathname it is invoked with.
21087 If GCC cannot find the subprogram using the specified prefix, it
21088 tries looking in the usual places for the subprogram.
21090 The default value of @env{GCC_EXEC_PREFIX} is
21091 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
21092 the installed compiler. In many cases @var{prefix} is the value
21093 of @code{prefix} when you ran the @file{configure} script.
21095 Other prefixes specified with @option{-B} take precedence over this prefix.
21097 This prefix is also used for finding files such as @file{crt0.o} that are
21098 used for linking.
21100 In addition, the prefix is used in an unusual way in finding the
21101 directories to search for header files.  For each of the standard
21102 directories whose name normally begins with @samp{/usr/local/lib/gcc}
21103 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
21104 replacing that beginning with the specified prefix to produce an
21105 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
21106 @file{foo/bar} just before it searches the standard directory 
21107 @file{/usr/local/lib/bar}.
21108 If a standard directory begins with the configured
21109 @var{prefix} then the value of @var{prefix} is replaced by
21110 @env{GCC_EXEC_PREFIX} when looking for header files.
21112 @item COMPILER_PATH
21113 @findex COMPILER_PATH
21114 The value of @env{COMPILER_PATH} is a colon-separated list of
21115 directories, much like @env{PATH}.  GCC tries the directories thus
21116 specified when searching for subprograms, if it can't find the
21117 subprograms using @env{GCC_EXEC_PREFIX}.
21119 @item LIBRARY_PATH
21120 @findex LIBRARY_PATH
21121 The value of @env{LIBRARY_PATH} is a colon-separated list of
21122 directories, much like @env{PATH}.  When configured as a native compiler,
21123 GCC tries the directories thus specified when searching for special
21124 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
21125 using GCC also uses these directories when searching for ordinary
21126 libraries for the @option{-l} option (but directories specified with
21127 @option{-L} come first).
21129 @item LANG
21130 @findex LANG
21131 @cindex locale definition
21132 This variable is used to pass locale information to the compiler.  One way in
21133 which this information is used is to determine the character set to be used
21134 when character literals, string literals and comments are parsed in C and C++.
21135 When the compiler is configured to allow multibyte characters,
21136 the following values for @env{LANG} are recognized:
21138 @table @samp
21139 @item C-JIS
21140 Recognize JIS characters.
21141 @item C-SJIS
21142 Recognize SJIS characters.
21143 @item C-EUCJP
21144 Recognize EUCJP characters.
21145 @end table
21147 If @env{LANG} is not defined, or if it has some other value, then the
21148 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
21149 recognize and translate multibyte characters.
21150 @end table
21152 @noindent
21153 Some additional environment variables affect the behavior of the
21154 preprocessor.
21156 @include cppenv.texi
21158 @c man end
21160 @node Precompiled Headers
21161 @section Using Precompiled Headers
21162 @cindex precompiled headers
21163 @cindex speed of compilation
21165 Often large projects have many header files that are included in every
21166 source file.  The time the compiler takes to process these header files
21167 over and over again can account for nearly all of the time required to
21168 build the project.  To make builds faster, GCC allows you to
21169 @dfn{precompile} a header file.
21171 To create a precompiled header file, simply compile it as you would any
21172 other file, if necessary using the @option{-x} option to make the driver
21173 treat it as a C or C++ header file.  You may want to use a
21174 tool like @command{make} to keep the precompiled header up-to-date when
21175 the headers it contains change.
21177 A precompiled header file is searched for when @code{#include} is
21178 seen in the compilation.  As it searches for the included file
21179 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
21180 compiler looks for a precompiled header in each directory just before it
21181 looks for the include file in that directory.  The name searched for is
21182 the name specified in the @code{#include} with @samp{.gch} appended.  If
21183 the precompiled header file can't be used, it is ignored.
21185 For instance, if you have @code{#include "all.h"}, and you have
21186 @file{all.h.gch} in the same directory as @file{all.h}, then the
21187 precompiled header file is used if possible, and the original
21188 header is used otherwise.
21190 Alternatively, you might decide to put the precompiled header file in a
21191 directory and use @option{-I} to ensure that directory is searched
21192 before (or instead of) the directory containing the original header.
21193 Then, if you want to check that the precompiled header file is always
21194 used, you can put a file of the same name as the original header in this
21195 directory containing an @code{#error} command.
21197 This also works with @option{-include}.  So yet another way to use
21198 precompiled headers, good for projects not designed with precompiled
21199 header files in mind, is to simply take most of the header files used by
21200 a project, include them from another header file, precompile that header
21201 file, and @option{-include} the precompiled header.  If the header files
21202 have guards against multiple inclusion, they are skipped because
21203 they've already been included (in the precompiled header).
21205 If you need to precompile the same header file for different
21206 languages, targets, or compiler options, you can instead make a
21207 @emph{directory} named like @file{all.h.gch}, and put each precompiled
21208 header in the directory, perhaps using @option{-o}.  It doesn't matter
21209 what you call the files in the directory; every precompiled header in
21210 the directory is considered.  The first precompiled header
21211 encountered in the directory that is valid for this compilation is
21212 used; they're searched in no particular order.
21214 There are many other possibilities, limited only by your imagination,
21215 good sense, and the constraints of your build system.
21217 A precompiled header file can be used only when these conditions apply:
21219 @itemize
21220 @item
21221 Only one precompiled header can be used in a particular compilation.
21223 @item
21224 A precompiled header can't be used once the first C token is seen.  You
21225 can have preprocessor directives before a precompiled header; you cannot
21226 include a precompiled header from inside another header.
21228 @item
21229 The precompiled header file must be produced for the same language as
21230 the current compilation.  You can't use a C precompiled header for a C++
21231 compilation.
21233 @item
21234 The precompiled header file must have been produced by the same compiler
21235 binary as the current compilation is using.
21237 @item
21238 Any macros defined before the precompiled header is included must
21239 either be defined in the same way as when the precompiled header was
21240 generated, or must not affect the precompiled header, which usually
21241 means that they don't appear in the precompiled header at all.
21243 The @option{-D} option is one way to define a macro before a
21244 precompiled header is included; using a @code{#define} can also do it.
21245 There are also some options that define macros implicitly, like
21246 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
21247 defined this way.
21249 @item If debugging information is output when using the precompiled
21250 header, using @option{-g} or similar, the same kind of debugging information
21251 must have been output when building the precompiled header.  However,
21252 a precompiled header built using @option{-g} can be used in a compilation
21253 when no debugging information is being output.
21255 @item The same @option{-m} options must generally be used when building
21256 and using the precompiled header.  @xref{Submodel Options},
21257 for any cases where this rule is relaxed.
21259 @item Each of the following options must be the same when building and using
21260 the precompiled header:
21262 @gccoptlist{-fexceptions}
21264 @item
21265 Some other command-line options starting with @option{-f},
21266 @option{-p}, or @option{-O} must be defined in the same way as when
21267 the precompiled header was generated.  At present, it's not clear
21268 which options are safe to change and which are not; the safest choice
21269 is to use exactly the same options when generating and using the
21270 precompiled header.  The following are known to be safe:
21272 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
21273 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
21274 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
21275 -pedantic-errors}
21277 @end itemize
21279 For all of these except the last, the compiler automatically
21280 ignores the precompiled header if the conditions aren't met.  If you
21281 find an option combination that doesn't work and doesn't cause the
21282 precompiled header to be ignored, please consider filing a bug report,
21283 see @ref{Bugs}.
21285 If you do use differing options when generating and using the
21286 precompiled header, the actual behavior is a mixture of the
21287 behavior for the options.  For instance, if you use @option{-g} to
21288 generate the precompiled header but not when using it, you may or may
21289 not get debugging information for routines in the precompiled header.