i386.c (ix86_builtin_reciprocal): Remove dependency on TARGET_RECIP.
[official-gcc.git] / gcc / doc / invoke.texi
blob20a9395f0b7e248b5212e80a3dc9a3f3ee6d9b00
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
15 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.2 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``GNU General Public License'' and ``Funding
21 Free Software'', the Front-Cover texts being (a) (see below), and with
22 the Back-Cover Texts being (b) (see below).  A copy of the license is
23 included in the gfdl(7) man page.
25 (a) The FSF's Front-Cover Text is:
27      A GNU Manual
29 (b) The FSF's Back-Cover Text is:
31      You have freedom to copy and modify this GNU Manual, like GNU
32      software.  Copies published by the Free Software Foundation raise
33      funds for GNU development.
34 @c man end
35 @c Set file name and title for the man page.
36 @setfilename gcc
37 @settitle GNU project C and C++ compiler
38 @c man begin SYNOPSIS
39 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
40     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
41     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
42     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
43     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
44     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
45     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
47 Only the most useful options are listed here; see below for the
48 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
49 @c man end
50 @c man begin SEEALSO
51 gpl(7), gfdl(7), fsf-funding(7),
52 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
53 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
54 @file{ld}, @file{binutils} and @file{gdb}.
55 @c man end
56 @c man begin BUGS
57 For instructions on reporting bugs, see
58 @w{@value{BUGURL}}.
59 @c man end
60 @c man begin AUTHOR
61 See the Info entry for @command{gcc}, or
62 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
63 for contributors to GCC@.
64 @c man end
65 @end ignore
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
73 @c man begin DESCRIPTION
74 When you invoke GCC, it normally does preprocessing, compilation,
75 assembly and linking.  The ``overall options'' allow you to stop this
76 process at an intermediate stage.  For example, the @option{-c} option
77 says not to run the linker.  Then the output consists of object files
78 output by the assembler.
80 Other options are passed on to one stage of processing.  Some options
81 control the preprocessor and others the compiler itself.  Yet other
82 options control the assembler and linker; most of these are not
83 documented here, since you rarely need to use any of them.
85 @cindex C compilation options
86 Most of the command line options that you can use with GCC are useful
87 for C programs; when an option is only useful with another language
88 (usually C++), the explanation says so explicitly.  If the description
89 for a particular option does not mention a source language, you can use
90 that option with all supported languages.
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
96 @cindex grouping options
97 @cindex options, grouping
98 The @command{gcc} program accepts options and file names as operands.  Many
99 options have multi-letter names; therefore multiple single-letter options
100 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
101 -v}}.
103 @cindex order of options
104 @cindex options, order
105 You can mix options and other arguments.  For the most part, the order
106 you use doesn't matter.  Order does matter when you use several
107 options of the same kind; for example, if you specify @option{-L} more
108 than once, the directories are searched in the order specified.  Also,
109 the placement of the @option{-l} option is significant.
111 Many options have long names starting with @samp{-f} or with
112 @samp{-W}---for example,
113 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
114 these have both positive and negative forms; the negative form of
115 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
116 only one of these two forms, whichever one is not the default.
118 @c man end
120 @xref{Option Index}, for an index to GCC's options.
122 @menu
123 * Option Summary::      Brief list of all options, without explanations.
124 * Overall Options::     Controlling the kind of output:
125                         an executable, object files, assembler files,
126                         or preprocessed source.
127 * Invoking G++::        Compiling C++ programs.
128 * C Dialect Options::   Controlling the variant of C language compiled.
129 * C++ Dialect Options:: Variations on C++.
130 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
131                         and Objective-C++.
132 * Language Independent Options:: Controlling how diagnostics should be
133                         formatted.
134 * Warning Options::     How picky should the compiler be?
135 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
136 * Optimize Options::    How much optimization?
137 * Preprocessor Options:: Controlling header files and macro definitions.
138                          Also, getting dependency information for Make.
139 * Assembler Options::   Passing options to the assembler.
140 * Link Options::        Specifying libraries and so on.
141 * Directory Options::   Where to find header files and libraries.
142                         Where to find the compiler executable files.
143 * Spec Files::          How to pass switches to sub-processes.
144 * Target Options::      Running a cross-compiler, or an old version of GCC.
145 * Submodel Options::    Specifying minor hardware or convention variations,
146                         such as 68010 vs 68020.
147 * Code Gen Options::    Specifying conventions for function calls, data layout
148                         and register usage.
149 * Environment Variables:: Env vars that affect GCC.
150 * Precompiled Headers:: Compiling a header once, and using it many times.
151 @end menu
153 @c man begin OPTIONS
155 @node Option Summary
156 @section Option Summary
158 Here is a summary of all the options, grouped by type.  Explanations are
159 in the following sections.
161 @table @emph
162 @item Overall Options
163 @xref{Overall Options,,Options Controlling the Kind of Output}.
164 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -no-canonical-prefixes  @gol
165 -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
167 --version -wrapper@@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}}
169 @item C Language Options
170 @xref{C Dialect Options,,Options Controlling C Dialect}.
171 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
172 -aux-info @var{filename} @gol
173 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
174 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
175 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
176 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
177 -fsigned-bitfields  -fsigned-char @gol
178 -funsigned-bitfields  -funsigned-char}
180 @item C++ Language Options
181 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
182 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
183 -fconserve-space  -ffriend-injection @gol
184 -fno-elide-constructors @gol
185 -fno-enforce-eh-specs @gol
186 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
187 -fno-implicit-templates @gol
188 -fno-implicit-inline-templates @gol
189 -fno-implement-inlines  -fms-extensions @gol
190 -fno-nonansi-builtins  -fno-operator-names @gol
191 -fno-optional-diags  -fpermissive @gol
192 -fno-pretty-templates @gol
193 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
194 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
195 -fno-default-inline  -fvisibility-inlines-hidden @gol
196 -fvisibility-ms-compat @gol
197 -Wabi  -Wctor-dtor-privacy @gol
198 -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-call-cxx-cdtors @gol
211 -fobjc-direct-dispatch @gol
212 -fobjc-exceptions @gol
213 -fobjc-gc @gol
214 -freplace-objc-classes @gol
215 -fzero-link @gol
216 -gen-decls @gol
217 -Wassign-intercept @gol
218 -Wno-protocol  -Wselector @gol
219 -Wstrict-selector-match @gol
220 -Wundeclared-selector}
222 @item Language Independent Options
223 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
224 @gccoptlist{-fmessage-length=@var{n}  @gol
225 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
226 -fdiagnostics-show-option}
228 @item Warning Options
229 @xref{Warning Options,,Options to Request or Suppress Warnings}.
230 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
231 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
232 -Wno-attributes -Wno-builtin-macro-redefined @gol
233 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
234 -Wchar-subscripts -Wclobbered  -Wcomment @gol
235 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
236 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
237 -Wno-div-by-zero -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
238 -Werror  -Werror=* @gol
239 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
240 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
241 -Wformat-security  -Wformat-y2k @gol
242 -Wframe-larger-than=@var{len} -Wjump-misses-init -Wignored-qualifiers @gol
243 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
244 -Winit-self  -Winline @gol
245 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
246 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
247 -Wlogical-op -Wlong-long @gol
248 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
249 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
250 -Wmissing-noreturn  -Wno-mudflap @gol
251 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
252 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
253 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
254 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
255 -Wredundant-decls @gol
256 -Wreturn-type  -Wsequence-point  -Wshadow @gol
257 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
258 -Wstrict-aliasing -Wstrict-aliasing=n @gol
259 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
260 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
261 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
262 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
263 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
264 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
265 -Wvariadic-macros -Wvla @gol
266 -Wvolatile-register-var  -Wwrite-strings}
268 @item C and Objective-C-only Warning Options
269 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
270 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
271 -Wold-style-declaration  -Wold-style-definition @gol
272 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
273 -Wdeclaration-after-statement -Wpointer-sign}
275 @item Debugging Options
276 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
277 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
278 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
279 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
280 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
281 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
282 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
283 -fdump-statistics @gol
284 -fdump-tree-all @gol
285 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
286 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
288 -fdump-tree-ch @gol
289 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-nrv -fdump-tree-vect @gol
299 -fdump-tree-sink @gol
300 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
304 -ftree-vectorizer-verbose=@var{n} @gol
305 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
306 -fdump-final-insns=@var{file} @gol
307 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
308 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
309 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
310 -fenable-icf-debug @gol
311 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
312 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
313 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
314 -ftest-coverage  -ftime-report -fvar-tracking @gol
315 -fvar-tracking-assigments  -fvar-tracking-assignments-toggle @gol
316 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
317 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
318 -gvms  -gxcoff  -gxcoff+ @gol
319 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
320 -fdebug-prefix-map=@var{old}=@var{new} @gol
321 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
322 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
323 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
324 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
325 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
326 -print-sysroot -print-sysroot-headers-suffix @gol
327 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
329 @item Optimization Options
330 @xref{Optimize Options,,Options that Control Optimization}.
331 @gccoptlist{
332 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
333 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
334 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
335 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
336 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
337 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
338 -fdata-sections -fdce -fdce @gol
339 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
340 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
341 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
342 -fforward-propagate -ffunction-sections @gol
343 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
344 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
345 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
346 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
347 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
348 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
349 -fira-region=@var{region} -fira-coalesce @gol
350 -fira-loop-pressure -fno-ira-share-save-slots @gol
351 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
352 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
353 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
354 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
355 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
356 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
357 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
358 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
359 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
360 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
361 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
362 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
363 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
364 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
365 -fprofile-generate=@var{path} @gol
366 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
367 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
368 -freorder-blocks-and-partition -freorder-functions @gol
369 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
370 -frounding-math -fsched2-use-superblocks @gol
371 -fsched2-use-traces -fsched-pressure @gol
372 -fsched-spec-load -fsched-spec-load-dangerous @gol
373 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
374 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
375 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
376 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
377 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
378 -fselective-scheduling -fselective-scheduling2 @gol
379 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
380 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
381 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
382 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
383 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
384 -ftree-copyrename -ftree-dce @gol
385 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
386 -ftree-phiprop -ftree-loop-distribution @gol
387 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
388 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
389 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
390 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
391 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
392 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
393 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
394 -fwhole-program -fwhopr -fwpa -fuse-linker-plugin @gol
395 --param @var{name}=@var{value}
396 -O  -O0  -O1  -O2  -O3  -Os}
398 @item Preprocessor Options
399 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
400 @gccoptlist{-A@var{question}=@var{answer} @gol
401 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
402 -C  -dD  -dI  -dM  -dN @gol
403 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
404 -idirafter @var{dir} @gol
405 -include @var{file}  -imacros @var{file} @gol
406 -iprefix @var{file}  -iwithprefix @var{dir} @gol
407 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
408 -imultilib @var{dir} -isysroot @var{dir} @gol
409 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
410 -P  -fworking-directory  -remap @gol
411 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
412 -Xpreprocessor @var{option}}
414 @item Assembler Option
415 @xref{Assembler Options,,Passing Options to the Assembler}.
416 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
418 @item Linker Options
419 @xref{Link Options,,Options for Linking}.
420 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
421 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
422 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
423 -shared-libgcc  -symbolic @gol
424 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
425 -u @var{symbol}}
427 @item Directory Options
428 @xref{Directory Options,,Options for Directory Search}.
429 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
430 -specs=@var{file}  -I- --sysroot=@var{dir}}
432 @item Target Options
433 @c I wrote this xref this way to avoid overfull hbox. -- rms
434 @xref{Target Options}.
435 @gccoptlist{-V @var{version}  -b @var{machine}}
437 @item Machine Dependent Options
438 @xref{Submodel Options,,Hardware Models and Configurations}.
439 @c This list is ordered alphanumerically by subsection name.
440 @c Try and put the significant identifier (CPU or system) first,
441 @c so users have a clue at guessing where the ones they want will be.
443 @emph{ARC Options}
444 @gccoptlist{-EB  -EL @gol
445 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
446 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
448 @emph{ARM Options}
449 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
450 -mabi=@var{name} @gol
451 -mapcs-stack-check  -mno-apcs-stack-check @gol
452 -mapcs-float  -mno-apcs-float @gol
453 -mapcs-reentrant  -mno-apcs-reentrant @gol
454 -msched-prolog  -mno-sched-prolog @gol
455 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
456 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
457 -mfp16-format=@var{name}
458 -mthumb-interwork  -mno-thumb-interwork @gol
459 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
460 -mstructure-size-boundary=@var{n} @gol
461 -mabort-on-noreturn @gol
462 -mlong-calls  -mno-long-calls @gol
463 -msingle-pic-base  -mno-single-pic-base @gol
464 -mpic-register=@var{reg} @gol
465 -mnop-fun-dllimport @gol
466 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
467 -mpoke-function-name @gol
468 -mthumb  -marm @gol
469 -mtpcs-frame  -mtpcs-leaf-frame @gol
470 -mcaller-super-interworking  -mcallee-super-interworking @gol
471 -mtp=@var{name} @gol
472 -mword-relocations @gol
473 -mfix-cortex-m3-ldrd}
475 @emph{AVR Options}
476 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
477 -mcall-prologues  -mtiny-stack  -mint8}
479 @emph{Blackfin Options}
480 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
481 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
482 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
483 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
484 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
485 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
486 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
487 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
488 -micplb}
490 @emph{CRIS Options}
491 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
492 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
493 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
494 -mstack-align  -mdata-align  -mconst-align @gol
495 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
496 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
497 -mmul-bug-workaround  -mno-mul-bug-workaround}
499 @emph{CRX Options}
500 @gccoptlist{-mmac -mpush-args}
502 @emph{Darwin Options}
503 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
504 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
505 -client_name  -compatibility_version  -current_version @gol
506 -dead_strip @gol
507 -dependency-file  -dylib_file  -dylinker_install_name @gol
508 -dynamic  -dynamiclib  -exported_symbols_list @gol
509 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
510 -force_flat_namespace  -headerpad_max_install_names @gol
511 -iframework @gol
512 -image_base  -init  -install_name  -keep_private_externs @gol
513 -multi_module  -multiply_defined  -multiply_defined_unused @gol
514 -noall_load   -no_dead_strip_inits_and_terms @gol
515 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
516 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
517 -private_bundle  -read_only_relocs  -sectalign @gol
518 -sectobjectsymbols  -whyload  -seg1addr @gol
519 -sectcreate  -sectobjectsymbols  -sectorder @gol
520 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
521 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
522 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
523 -single_module  -static  -sub_library  -sub_umbrella @gol
524 -twolevel_namespace  -umbrella  -undefined @gol
525 -unexported_symbols_list  -weak_reference_mismatches @gol
526 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
527 -mkernel -mone-byte-bool}
529 @emph{DEC Alpha Options}
530 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
531 -mieee  -mieee-with-inexact  -mieee-conformant @gol
532 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
533 -mtrap-precision=@var{mode}  -mbuild-constants @gol
534 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
535 -mbwx  -mmax  -mfix  -mcix @gol
536 -mfloat-vax  -mfloat-ieee @gol
537 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
538 -msmall-text  -mlarge-text @gol
539 -mmemory-latency=@var{time}}
541 @emph{DEC Alpha/VMS Options}
542 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
544 @emph{FR30 Options}
545 @gccoptlist{-msmall-model -mno-lsim}
547 @emph{FRV Options}
548 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
549 -mhard-float  -msoft-float @gol
550 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
551 -mdouble  -mno-double @gol
552 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
553 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
554 -mlinked-fp  -mlong-calls  -malign-labels @gol
555 -mlibrary-pic  -macc-4  -macc-8 @gol
556 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
557 -moptimize-membar -mno-optimize-membar @gol
558 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
559 -mvliw-branch  -mno-vliw-branch @gol
560 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
561 -mno-nested-cond-exec  -mtomcat-stats @gol
562 -mTLS -mtls @gol
563 -mcpu=@var{cpu}}
565 @emph{GNU/Linux Options}
566 @gccoptlist{-muclibc}
568 @emph{H8/300 Options}
569 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
571 @emph{HPPA Options}
572 @gccoptlist{-march=@var{architecture-type} @gol
573 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
574 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
575 -mfixed-range=@var{register-range} @gol
576 -mjump-in-delay -mlinker-opt -mlong-calls @gol
577 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
578 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
579 -mno-jump-in-delay  -mno-long-load-store @gol
580 -mno-portable-runtime  -mno-soft-float @gol
581 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
582 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
583 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
584 -munix=@var{unix-std}  -nolibdld  -static  -threads}
586 @emph{i386 and x86-64 Options}
587 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
588 -mfpmath=@var{unit} @gol
589 -masm=@var{dialect}  -mno-fancy-math-387 @gol
590 -mno-fp-ret-in-387  -msoft-float @gol
591 -mno-wide-multiply  -mrtd  -malign-double @gol
592 -mpreferred-stack-boundary=@var{num}
593 -mincoming-stack-boundary=@var{num}
594 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
595 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
596 -maes -mpclmul @gol
597 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
598 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
599 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
600 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
601 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
602 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
603 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
604 -mcmodel=@var{code-model} -mabi=@var{name} @gol
605 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
606 -msse2avx}
608 @emph{IA-64 Options}
609 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
610 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
611 -mconstant-gp  -mauto-pic  -mfused-madd @gol
612 -minline-float-divide-min-latency @gol
613 -minline-float-divide-max-throughput @gol
614 -mno-inline-float-divide @gol
615 -minline-int-divide-min-latency @gol
616 -minline-int-divide-max-throughput  @gol
617 -mno-inline-int-divide @gol
618 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
619 -mno-inline-sqrt @gol
620 -mdwarf2-asm -mearly-stop-bits @gol
621 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
622 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
623 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
624 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
625 -msched-spec-ldc -msched-spec-control-ldc @gol
626 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
627 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
628 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
629 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
631 @emph{IA-64/VMS Options}
632 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
634 @emph{M32R/D Options}
635 @gccoptlist{-m32r2 -m32rx -m32r @gol
636 -mdebug @gol
637 -malign-loops -mno-align-loops @gol
638 -missue-rate=@var{number} @gol
639 -mbranch-cost=@var{number} @gol
640 -mmodel=@var{code-size-model-type} @gol
641 -msdata=@var{sdata-type} @gol
642 -mno-flush-func -mflush-func=@var{name} @gol
643 -mno-flush-trap -mflush-trap=@var{number} @gol
644 -G @var{num}}
646 @emph{M32C Options}
647 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
649 @emph{M680x0 Options}
650 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
651 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
652 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
653 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
654 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
655 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
656 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
657 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
658 -mxgot -mno-xgot}
660 @emph{M68hc1x Options}
661 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
662 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
663 -msoft-reg-count=@var{count}}
665 @emph{MCore Options}
666 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
667 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
668 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
669 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
670 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
672 @emph{MeP Options}
673 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
674 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
675 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
676 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
677 -mtiny=@var{n}}
679 @emph{MIPS Options}
680 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
681 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
682 -mips64  -mips64r2 @gol
683 -mips16  -mno-mips16  -mflip-mips16 @gol
684 -minterlink-mips16  -mno-interlink-mips16 @gol
685 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
686 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
687 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
688 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
689 -mfpu=@var{fpu-type} @gol
690 -msmartmips  -mno-smartmips @gol
691 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
692 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
693 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
694 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
695 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
696 -membedded-data  -mno-embedded-data @gol
697 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
698 -mcode-readable=@var{setting} @gol
699 -msplit-addresses  -mno-split-addresses @gol
700 -mexplicit-relocs  -mno-explicit-relocs @gol
701 -mcheck-zero-division  -mno-check-zero-division @gol
702 -mdivide-traps  -mdivide-breaks @gol
703 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
704 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
705 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
706 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
707 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
708 -mflush-func=@var{func}  -mno-flush-func @gol
709 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
710 -mfp-exceptions -mno-fp-exceptions @gol
711 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
712 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
714 @emph{MMIX Options}
715 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
716 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
717 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
718 -mno-base-addresses  -msingle-exit  -mno-single-exit}
720 @emph{MN10300 Options}
721 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
722 -mam33  -mno-am33 @gol
723 -mam33-2  -mno-am33-2 @gol
724 -mreturn-pointer-on-d0 @gol
725 -mno-crt0  -mrelax}
727 @emph{PDP-11 Options}
728 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
729 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
730 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
731 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
732 -mbranch-expensive  -mbranch-cheap @gol
733 -msplit  -mno-split  -munix-asm  -mdec-asm}
735 @emph{picoChip Options}
736 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
737 -msymbol-as-address -mno-inefficient-warnings}
739 @emph{PowerPC Options}
740 See RS/6000 and PowerPC Options.
742 @emph{RS/6000 and PowerPC Options}
743 @gccoptlist{-mcpu=@var{cpu-type} @gol
744 -mtune=@var{cpu-type} @gol
745 -mpower  -mno-power  -mpower2  -mno-power2 @gol
746 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
747 -maltivec  -mno-altivec @gol
748 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
749 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
750 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
751 -mfprnd  -mno-fprnd @gol
752 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
753 -mnew-mnemonics  -mold-mnemonics @gol
754 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
755 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
756 -malign-power  -malign-natural @gol
757 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
758 -msingle-float -mdouble-float -msimple-fpu @gol
759 -mstring  -mno-string  -mupdate  -mno-update @gol
760 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
761 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
762 -mstrict-align  -mno-strict-align  -mrelocatable @gol
763 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
764 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
765 -mdynamic-no-pic  -maltivec -mswdiv @gol
766 -mprioritize-restricted-insns=@var{priority} @gol
767 -msched-costly-dep=@var{dependence_type} @gol
768 -minsert-sched-nops=@var{scheme} @gol
769 -mcall-sysv  -mcall-netbsd @gol
770 -maix-struct-return  -msvr4-struct-return @gol
771 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
772 -misel -mno-isel @gol
773 -misel=yes  -misel=no @gol
774 -mspe -mno-spe @gol
775 -mspe=yes  -mspe=no @gol
776 -mpaired @gol
777 -mgen-cell-microcode -mwarn-cell-microcode @gol
778 -mvrsave -mno-vrsave @gol
779 -mmulhw -mno-mulhw @gol
780 -mdlmzb -mno-dlmzb @gol
781 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
782 -mprototype  -mno-prototype @gol
783 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
784 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
786 @emph{RX Options}
787 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
788 -mcpu= -patch=@gol
789 -mbig-endian-data -mlittle-endian-data @gol
790 -msmall-data @gol
791 -msim  -mno-sim@gol
792 -mas100-syntax -mno-as100-syntax@gol
793 -mrelax@gol
794 -mmax-constant-size=@gol
795 -mint-register=@gol
796 -msave-acc-in-interrupts}
798 @emph{S/390 and zSeries Options}
799 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
800 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
801 -mlong-double-64 -mlong-double-128 @gol
802 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
803 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
804 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
805 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
806 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
808 @emph{Score Options}
809 @gccoptlist{-meb -mel @gol
810 -mnhwloop @gol
811 -muls @gol
812 -mmac @gol
813 -mscore5 -mscore5u -mscore7 -mscore7d}
815 @emph{SH Options}
816 @gccoptlist{-m1  -m2  -m2e @gol
817 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
818 -m3  -m3e @gol
819 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
820 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
821 -m5-64media  -m5-64media-nofpu @gol
822 -m5-32media  -m5-32media-nofpu @gol
823 -m5-compact  -m5-compact-nofpu @gol
824 -mb  -ml  -mdalign  -mrelax @gol
825 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
826 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
827 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
828 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
829 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
830 -minvalid-symbols}
832 @emph{SPARC Options}
833 @gccoptlist{-mcpu=@var{cpu-type} @gol
834 -mtune=@var{cpu-type} @gol
835 -mcmodel=@var{code-model} @gol
836 -m32  -m64  -mapp-regs  -mno-app-regs @gol
837 -mfaster-structs  -mno-faster-structs @gol
838 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
839 -mhard-quad-float  -msoft-quad-float @gol
840 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
841 -mstack-bias  -mno-stack-bias @gol
842 -munaligned-doubles  -mno-unaligned-doubles @gol
843 -mv8plus  -mno-v8plus  -mvis  -mno-vis
844 -threads -pthreads -pthread}
846 @emph{SPU Options}
847 @gccoptlist{-mwarn-reloc -merror-reloc @gol
848 -msafe-dma -munsafe-dma @gol
849 -mbranch-hints @gol
850 -msmall-mem -mlarge-mem -mstdmain @gol
851 -mfixed-range=@var{register-range} @gol
852 -mea32 -mea64 @gol
853 -maddress-space-conversion -mno-address-space-conversion @gol
854 -mcache-size=@var{cache-size} @gol
855 -matomic-updates -mno-atomic-updates}
857 @emph{System V Options}
858 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
860 @emph{V850 Options}
861 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
862 -mprolog-function  -mno-prolog-function  -mspace @gol
863 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
864 -mapp-regs  -mno-app-regs @gol
865 -mdisable-callt  -mno-disable-callt @gol
866 -mv850e1 @gol
867 -mv850e @gol
868 -mv850  -mbig-switch}
870 @emph{VAX Options}
871 @gccoptlist{-mg  -mgnu  -munix}
873 @emph{VxWorks Options}
874 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
875 -Xbind-lazy  -Xbind-now}
877 @emph{x86-64 Options}
878 See i386 and x86-64 Options.
880 @emph{i386 and x86-64 Windows Options}
881 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
882 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
883 -fno-set-stack-executable}
885 @emph{Xstormy16 Options}
886 @gccoptlist{-msim}
888 @emph{Xtensa Options}
889 @gccoptlist{-mconst16 -mno-const16 @gol
890 -mfused-madd  -mno-fused-madd @gol
891 -mserialize-volatile  -mno-serialize-volatile @gol
892 -mtext-section-literals  -mno-text-section-literals @gol
893 -mtarget-align  -mno-target-align @gol
894 -mlongcalls  -mno-longcalls}
896 @emph{zSeries Options}
897 See S/390 and zSeries Options.
899 @item Code Generation Options
900 @xref{Code Gen Options,,Options for Code Generation Conventions}.
901 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
902 -ffixed-@var{reg}  -fexceptions @gol
903 -fnon-call-exceptions  -funwind-tables @gol
904 -fasynchronous-unwind-tables @gol
905 -finhibit-size-directive  -finstrument-functions @gol
906 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
907 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
908 -fno-common  -fno-ident @gol
909 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
910 -fno-jump-tables @gol
911 -frecord-gcc-switches @gol
912 -freg-struct-return  -fshort-enums @gol
913 -fshort-double  -fshort-wchar @gol
914 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
915 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
916 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
917 -fargument-noalias-global  -fargument-noalias-anything @gol
918 -fleading-underscore  -ftls-model=@var{model} @gol
919 -ftrapv  -fwrapv  -fbounds-check @gol
920 -fvisibility}
921 @end table
923 @menu
924 * Overall Options::     Controlling the kind of output:
925                         an executable, object files, assembler files,
926                         or preprocessed source.
927 * C Dialect Options::   Controlling the variant of C language compiled.
928 * C++ Dialect Options:: Variations on C++.
929 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
930                         and Objective-C++.
931 * Language Independent Options:: Controlling how diagnostics should be
932                         formatted.
933 * Warning Options::     How picky should the compiler be?
934 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
935 * Optimize Options::    How much optimization?
936 * Preprocessor Options:: Controlling header files and macro definitions.
937                          Also, getting dependency information for Make.
938 * Assembler Options::   Passing options to the assembler.
939 * Link Options::        Specifying libraries and so on.
940 * Directory Options::   Where to find header files and libraries.
941                         Where to find the compiler executable files.
942 * Spec Files::          How to pass switches to sub-processes.
943 * Target Options::      Running a cross-compiler, or an old version of GCC.
944 @end menu
946 @node Overall Options
947 @section Options Controlling the Kind of Output
949 Compilation can involve up to four stages: preprocessing, compilation
950 proper, assembly and linking, always in that order.  GCC is capable of
951 preprocessing and compiling several files either into several
952 assembler input files, or into one assembler input file; then each
953 assembler input file produces an object file, and linking combines all
954 the object files (those newly compiled, and those specified as input)
955 into an executable file.
957 @cindex file name suffix
958 For any given input file, the file name suffix determines what kind of
959 compilation is done:
961 @table @gcctabopt
962 @item @var{file}.c
963 C source code which must be preprocessed.
965 @item @var{file}.i
966 C source code which should not be preprocessed.
968 @item @var{file}.ii
969 C++ source code which should not be preprocessed.
971 @item @var{file}.m
972 Objective-C source code.  Note that you must link with the @file{libobjc}
973 library to make an Objective-C program work.
975 @item @var{file}.mi
976 Objective-C source code which should not be preprocessed.
978 @item @var{file}.mm
979 @itemx @var{file}.M
980 Objective-C++ source code.  Note that you must link with the @file{libobjc}
981 library to make an Objective-C++ program work.  Note that @samp{.M} refers
982 to a literal capital M@.
984 @item @var{file}.mii
985 Objective-C++ source code which should not be preprocessed.
987 @item @var{file}.h
988 C, C++, Objective-C or Objective-C++ header file to be turned into a
989 precompiled header.
991 @item @var{file}.cc
992 @itemx @var{file}.cp
993 @itemx @var{file}.cxx
994 @itemx @var{file}.cpp
995 @itemx @var{file}.CPP
996 @itemx @var{file}.c++
997 @itemx @var{file}.C
998 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
999 the last two letters must both be literally @samp{x}.  Likewise,
1000 @samp{.C} refers to a literal capital C@.
1002 @item @var{file}.mm
1003 @itemx @var{file}.M
1004 Objective-C++ source code which must be preprocessed.
1006 @item @var{file}.mii
1007 Objective-C++ source code which should not be preprocessed.
1009 @item @var{file}.hh
1010 @itemx @var{file}.H
1011 @itemx @var{file}.hp
1012 @itemx @var{file}.hxx
1013 @itemx @var{file}.hpp
1014 @itemx @var{file}.HPP
1015 @itemx @var{file}.h++
1016 @itemx @var{file}.tcc
1017 C++ header file to be turned into a precompiled header.
1019 @item @var{file}.f
1020 @itemx @var{file}.for
1021 @itemx @var{file}.ftn
1022 Fixed form Fortran source code which should not be preprocessed.
1024 @item @var{file}.F
1025 @itemx @var{file}.FOR
1026 @itemx @var{file}.fpp
1027 @itemx @var{file}.FPP
1028 @itemx @var{file}.FTN
1029 Fixed form Fortran source code which must be preprocessed (with the traditional
1030 preprocessor).
1032 @item @var{file}.f90
1033 @itemx @var{file}.f95
1034 @itemx @var{file}.f03
1035 @itemx @var{file}.f08
1036 Free form Fortran source code which should not be preprocessed.
1038 @item @var{file}.F90
1039 @itemx @var{file}.F95
1040 @itemx @var{file}.F03
1041 @itemx @var{file}.F08
1042 Free form Fortran source code which must be preprocessed (with the
1043 traditional preprocessor).
1045 @c FIXME: Descriptions of Java file types.
1046 @c @var{file}.java
1047 @c @var{file}.class
1048 @c @var{file}.zip
1049 @c @var{file}.jar
1051 @item @var{file}.ads
1052 Ada source code file which contains a library unit declaration (a
1053 declaration of a package, subprogram, or generic, or a generic
1054 instantiation), or a library unit renaming declaration (a package,
1055 generic, or subprogram renaming declaration).  Such files are also
1056 called @dfn{specs}.
1058 @item @var{file}.adb
1059 Ada source code file containing a library unit body (a subprogram or
1060 package body).  Such files are also called @dfn{bodies}.
1062 @c GCC also knows about some suffixes for languages not yet included:
1063 @c Pascal:
1064 @c @var{file}.p
1065 @c @var{file}.pas
1066 @c Ratfor:
1067 @c @var{file}.r
1069 @item @var{file}.s
1070 Assembler code.
1072 @item @var{file}.S
1073 @itemx @var{file}.sx
1074 Assembler code which must be preprocessed.
1076 @item @var{other}
1077 An object file to be fed straight into linking.
1078 Any file name with no recognized suffix is treated this way.
1079 @end table
1081 @opindex x
1082 You can specify the input language explicitly with the @option{-x} option:
1084 @table @gcctabopt
1085 @item -x @var{language}
1086 Specify explicitly the @var{language} for the following input files
1087 (rather than letting the compiler choose a default based on the file
1088 name suffix).  This option applies to all following input files until
1089 the next @option{-x} option.  Possible values for @var{language} are:
1090 @smallexample
1091 c  c-header  c-cpp-output
1092 c++  c++-header  c++-cpp-output
1093 objective-c  objective-c-header  objective-c-cpp-output
1094 objective-c++ objective-c++-header objective-c++-cpp-output
1095 assembler  assembler-with-cpp
1097 f77  f77-cpp-input f95  f95-cpp-input
1098 java
1099 @end smallexample
1101 @item -x none
1102 Turn off any specification of a language, so that subsequent files are
1103 handled according to their file name suffixes (as they are if @option{-x}
1104 has not been used at all).
1106 @item -pass-exit-codes
1107 @opindex pass-exit-codes
1108 Normally the @command{gcc} program will exit with the code of 1 if any
1109 phase of the compiler returns a non-success return code.  If you specify
1110 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1111 numerically highest error produced by any phase that returned an error
1112 indication.  The C, C++, and Fortran frontends return 4, if an internal
1113 compiler error is encountered.
1114 @end table
1116 If you only want some of the stages of compilation, you can use
1117 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1118 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1119 @command{gcc} is to stop.  Note that some combinations (for example,
1120 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1122 @table @gcctabopt
1123 @item -c
1124 @opindex c
1125 Compile or assemble the source files, but do not link.  The linking
1126 stage simply is not done.  The ultimate output is in the form of an
1127 object file for each source file.
1129 By default, the object file name for a source file is made by replacing
1130 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1132 Unrecognized input files, not requiring compilation or assembly, are
1133 ignored.
1135 @item -S
1136 @opindex S
1137 Stop after the stage of compilation proper; do not assemble.  The output
1138 is in the form of an assembler code file for each non-assembler input
1139 file specified.
1141 By default, the assembler file name for a source file is made by
1142 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1144 Input files that don't require compilation are ignored.
1146 @item -E
1147 @opindex E
1148 Stop after the preprocessing stage; do not run the compiler proper.  The
1149 output is in the form of preprocessed source code, which is sent to the
1150 standard output.
1152 Input files which don't require preprocessing are ignored.
1154 @cindex output file option
1155 @item -o @var{file}
1156 @opindex o
1157 Place output in file @var{file}.  This applies regardless to whatever
1158 sort of output is being produced, whether it be an executable file,
1159 an object file, an assembler file or preprocessed C code.
1161 If @option{-o} is not specified, the default is to put an executable
1162 file in @file{a.out}, the object file for
1163 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1164 assembler file in @file{@var{source}.s}, a precompiled header file in
1165 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1166 standard output.
1168 @item -v
1169 @opindex v
1170 Print (on standard error output) the commands executed to run the stages
1171 of compilation.  Also print the version number of the compiler driver
1172 program and of the preprocessor and the compiler proper.
1174 @item -###
1175 @opindex ###
1176 Like @option{-v} except the commands are not executed and all command
1177 arguments are quoted.  This is useful for shell scripts to capture the
1178 driver-generated command lines.
1180 @item -pipe
1181 @opindex pipe
1182 Use pipes rather than temporary files for communication between the
1183 various stages of compilation.  This fails to work on some systems where
1184 the assembler is unable to read from a pipe; but the GNU assembler has
1185 no trouble.
1187 @item -combine
1188 @opindex combine
1189 If you are compiling multiple source files, this option tells the driver
1190 to pass all the source files to the compiler at once (for those
1191 languages for which the compiler can handle this).  This will allow
1192 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1193 language for which this is supported is C@.  If you pass source files for
1194 multiple languages to the driver, using this option, the driver will invoke
1195 the compiler(s) that support IMA once each, passing each compiler all the
1196 source files appropriate for it.  For those languages that do not support
1197 IMA this option will be ignored, and the compiler will be invoked once for
1198 each source file in that language.  If you use this option in conjunction
1199 with @option{-save-temps}, the compiler will generate multiple
1200 pre-processed files
1201 (one for each source file), but only one (combined) @file{.o} or
1202 @file{.s} file.
1204 @item --help
1205 @opindex help
1206 Print (on the standard output) a description of the command line options
1207 understood by @command{gcc}.  If the @option{-v} option is also specified
1208 then @option{--help} will also be passed on to the various processes
1209 invoked by @command{gcc}, so that they can display the command line options
1210 they accept.  If the @option{-Wextra} option has also been specified
1211 (prior to the @option{--help} option), then command line options which
1212 have no documentation associated with them will also be displayed.
1214 @item --target-help
1215 @opindex target-help
1216 Print (on the standard output) a description of target-specific command
1217 line options for each tool.  For some targets extra target-specific
1218 information may also be printed.
1220 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1221 Print (on the standard output) a description of the command line
1222 options understood by the compiler that fit into all specified classes
1223 and qualifiers.  These are the supported classes:
1225 @table @asis
1226 @item @samp{optimizers}
1227 This will display all of the optimization options supported by the
1228 compiler.
1230 @item @samp{warnings}
1231 This will display all of the options controlling warning messages
1232 produced by the compiler.
1234 @item @samp{target}
1235 This will display target-specific options.  Unlike the
1236 @option{--target-help} option however, target-specific options of the
1237 linker and assembler will not be displayed.  This is because those
1238 tools do not currently support the extended @option{--help=} syntax.
1240 @item @samp{params}
1241 This will display the values recognized by the @option{--param}
1242 option.
1244 @item @var{language}
1245 This will display the options supported for @var{language}, where
1246 @var{language} is the name of one of the languages supported in this
1247 version of GCC.
1249 @item @samp{common}
1250 This will display the options that are common to all languages.
1251 @end table
1253 These are the supported qualifiers:
1255 @table @asis
1256 @item @samp{undocumented}
1257 Display only those options which are undocumented.
1259 @item @samp{joined}
1260 Display options which take an argument that appears after an equal
1261 sign in the same continuous piece of text, such as:
1262 @samp{--help=target}.
1264 @item @samp{separate}
1265 Display options which take an argument that appears as a separate word
1266 following the original option, such as: @samp{-o output-file}.
1267 @end table
1269 Thus for example to display all the undocumented target-specific
1270 switches supported by the compiler the following can be used:
1272 @smallexample
1273 --help=target,undocumented
1274 @end smallexample
1276 The sense of a qualifier can be inverted by prefixing it with the
1277 @samp{^} character, so for example to display all binary warning
1278 options (i.e., ones that are either on or off and that do not take an
1279 argument), which have a description the following can be used:
1281 @smallexample
1282 --help=warnings,^joined,^undocumented
1283 @end smallexample
1285 The argument to @option{--help=} should not consist solely of inverted
1286 qualifiers.
1288 Combining several classes is possible, although this usually
1289 restricts the output by so much that there is nothing to display.  One
1290 case where it does work however is when one of the classes is
1291 @var{target}.  So for example to display all the target-specific
1292 optimization options the following can be used:
1294 @smallexample
1295 --help=target,optimizers
1296 @end smallexample
1298 The @option{--help=} option can be repeated on the command line.  Each
1299 successive use will display its requested class of options, skipping
1300 those that have already been displayed.
1302 If the @option{-Q} option appears on the command line before the
1303 @option{--help=} option, then the descriptive text displayed by
1304 @option{--help=} is changed.  Instead of describing the displayed
1305 options, an indication is given as to whether the option is enabled,
1306 disabled or set to a specific value (assuming that the compiler
1307 knows this at the point where the @option{--help=} option is used).
1309 Here is a truncated example from the ARM port of @command{gcc}:
1311 @smallexample
1312   % gcc -Q -mabi=2 --help=target -c
1313   The following options are target specific:
1314   -mabi=                                2
1315   -mabort-on-noreturn                   [disabled]
1316   -mapcs                                [disabled]
1317 @end smallexample
1319 The output is sensitive to the effects of previous command line
1320 options, so for example it is possible to find out which optimizations
1321 are enabled at @option{-O2} by using:
1323 @smallexample
1324 -Q -O2 --help=optimizers
1325 @end smallexample
1327 Alternatively you can discover which binary optimizations are enabled
1328 by @option{-O3} by using:
1330 @smallexample
1331 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1332 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1333 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1334 @end smallexample
1336 @item -no-canonical-prefixes
1337 @opindex no-canonical-prefixes
1338 Do not expand any symbolic links, resolve references to @samp{/../}
1339 or @samp{/./}, or make the path absolute when generating a relative
1340 prefix.
1342 @item --version
1343 @opindex version
1344 Display the version number and copyrights of the invoked GCC@.
1346 @item -wrapper
1347 @opindex wrapper
1348 Invoke all subcommands under a wrapper program. It takes a single
1349 comma separated list as an argument, which will be used to invoke
1350 the wrapper:
1352 @smallexample
1353 gcc -c t.c -wrapper gdb,--args
1354 @end smallexample
1356 This will invoke all subprograms of gcc under "gdb --args",
1357 thus cc1 invocation will be "gdb --args cc1 ...".
1359 @item -fplugin=@var{name}.so
1360 Load the plugin code in file @var{name}.so, assumed to be a
1361 shared object to be dlopen'd by the compiler.  The base name of
1362 the shared object file is used to identify the plugin for the
1363 purposes of argument parsing (See
1364 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1365 Each plugin should define the callback functions specified in the
1366 Plugins API.
1368 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1369 Define an argument called @var{key} with a value of @var{value}
1370 for the plugin called @var{name}.
1372 @include @value{srcdir}/../libiberty/at-file.texi
1373 @end table
1375 @node Invoking G++
1376 @section Compiling C++ Programs
1378 @cindex suffixes for C++ source
1379 @cindex C++ source file suffixes
1380 C++ source files conventionally use one of the suffixes @samp{.C},
1381 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1382 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1383 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1384 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1385 files with these names and compiles them as C++ programs even if you
1386 call the compiler the same way as for compiling C programs (usually
1387 with the name @command{gcc}).
1389 @findex g++
1390 @findex c++
1391 However, the use of @command{gcc} does not add the C++ library.
1392 @command{g++} is a program that calls GCC and treats @samp{.c},
1393 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1394 files unless @option{-x} is used, and automatically specifies linking
1395 against the C++ library.  This program is also useful when
1396 precompiling a C header file with a @samp{.h} extension for use in C++
1397 compilations.  On many systems, @command{g++} is also installed with
1398 the name @command{c++}.
1400 @cindex invoking @command{g++}
1401 When you compile C++ programs, you may specify many of the same
1402 command-line options that you use for compiling programs in any
1403 language; or command-line options meaningful for C and related
1404 languages; or options that are meaningful only for C++ programs.
1405 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1406 explanations of options for languages related to C@.
1407 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1408 explanations of options that are meaningful only for C++ programs.
1410 @node C Dialect Options
1411 @section Options Controlling C Dialect
1412 @cindex dialect options
1413 @cindex language dialect options
1414 @cindex options, dialect
1416 The following options control the dialect of C (or languages derived
1417 from C, such as C++, Objective-C and Objective-C++) that the compiler
1418 accepts:
1420 @table @gcctabopt
1421 @cindex ANSI support
1422 @cindex ISO support
1423 @item -ansi
1424 @opindex ansi
1425 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1426 equivalent to @samp{-std=c++98}.
1428 This turns off certain features of GCC that are incompatible with ISO
1429 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1430 such as the @code{asm} and @code{typeof} keywords, and
1431 predefined macros such as @code{unix} and @code{vax} that identify the
1432 type of system you are using.  It also enables the undesirable and
1433 rarely used ISO trigraph feature.  For the C compiler,
1434 it disables recognition of C++ style @samp{//} comments as well as
1435 the @code{inline} keyword.
1437 The alternate keywords @code{__asm__}, @code{__extension__},
1438 @code{__inline__} and @code{__typeof__} continue to work despite
1439 @option{-ansi}.  You would not want to use them in an ISO C program, of
1440 course, but it is useful to put them in header files that might be included
1441 in compilations done with @option{-ansi}.  Alternate predefined macros
1442 such as @code{__unix__} and @code{__vax__} are also available, with or
1443 without @option{-ansi}.
1445 The @option{-ansi} option does not cause non-ISO programs to be
1446 rejected gratuitously.  For that, @option{-pedantic} is required in
1447 addition to @option{-ansi}.  @xref{Warning Options}.
1449 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1450 option is used.  Some header files may notice this macro and refrain
1451 from declaring certain functions or defining certain macros that the
1452 ISO standard doesn't call for; this is to avoid interfering with any
1453 programs that might use these names for other things.
1455 Functions that would normally be built in but do not have semantics
1456 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1457 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1458 built-in functions provided by GCC}, for details of the functions
1459 affected.
1461 @item -std=
1462 @opindex std
1463 Determine the language standard. @xref{Standards,,Language Standards
1464 Supported by GCC}, for details of these standard versions.  This option
1465 is currently only supported when compiling C or C++.
1467 The compiler can accept several base standards, such as @samp{c89} or
1468 @samp{c++98}, and GNU dialects of those standards, such as
1469 @samp{gnu89} or @samp{gnu++98}.  By specifying a base standard, the
1470 compiler will accept all programs following that standard and those
1471 using GNU extensions that do not contradict it.  For example,
1472 @samp{-std=c89} turns off certain features of GCC that are
1473 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1474 keywords, but not other GNU extensions that do not have a meaning in
1475 ISO C90, such as omitting the middle term of a @code{?:}
1476 expression. On the other hand, by specifying a GNU dialect of a
1477 standard, all features the compiler support are enabled, even when
1478 those features change the meaning of the base standard and some
1479 strict-conforming programs may be rejected.  The particular standard
1480 is used by @option{-pedantic} to identify which features are GNU
1481 extensions given that version of the standard. For example
1482 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1483 comments, while @samp{-std=gnu99 -pedantic} would not.
1485 A value for this option must be provided; possible values are
1487 @table @samp
1488 @item c89
1489 @itemx iso9899:1990
1490 Support all ISO C90 programs (certain GNU extensions that conflict
1491 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1493 @item iso9899:199409
1494 ISO C90 as modified in amendment 1.
1496 @item c99
1497 @itemx c9x
1498 @itemx iso9899:1999
1499 @itemx iso9899:199x
1500 ISO C99.  Note that this standard is not yet fully supported; see
1501 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1502 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1504 @item gnu89
1505 GNU dialect of ISO C90 (including some C99 features). This
1506 is the default for C code.
1508 @item gnu99
1509 @itemx gnu9x
1510 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1511 this will become the default.  The name @samp{gnu9x} is deprecated.
1513 @item c++98
1514 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1515 C++ code.
1517 @item gnu++98
1518 GNU dialect of @option{-std=c++98}.  This is the default for
1519 C++ code.
1521 @item c++0x
1522 The working draft of the upcoming ISO C++0x standard. This option
1523 enables experimental features that are likely to be included in
1524 C++0x. The working draft is constantly changing, and any feature that is
1525 enabled by this flag may be removed from future versions of GCC if it is
1526 not part of the C++0x standard.
1528 @item gnu++0x
1529 GNU dialect of @option{-std=c++0x}. This option enables
1530 experimental features that may be removed in future versions of GCC.
1531 @end table
1533 @item -fgnu89-inline
1534 @opindex fgnu89-inline
1535 The option @option{-fgnu89-inline} tells GCC to use the traditional
1536 GNU semantics for @code{inline} functions when in C99 mode.
1537 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1538 is accepted and ignored by GCC versions 4.1.3 up to but not including
1539 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1540 C99 mode.  Using this option is roughly equivalent to adding the
1541 @code{gnu_inline} function attribute to all inline functions
1542 (@pxref{Function Attributes}).
1544 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1545 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1546 specifies the default behavior).  This option was first supported in
1547 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1549 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1550 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1551 in effect for @code{inline} functions.  @xref{Common Predefined
1552 Macros,,,cpp,The C Preprocessor}.
1554 @item -aux-info @var{filename}
1555 @opindex aux-info
1556 Output to the given filename prototyped declarations for all functions
1557 declared and/or defined in a translation unit, including those in header
1558 files.  This option is silently ignored in any language other than C@.
1560 Besides declarations, the file indicates, in comments, the origin of
1561 each declaration (source file and line), whether the declaration was
1562 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1563 @samp{O} for old, respectively, in the first character after the line
1564 number and the colon), and whether it came from a declaration or a
1565 definition (@samp{C} or @samp{F}, respectively, in the following
1566 character).  In the case of function definitions, a K&R-style list of
1567 arguments followed by their declarations is also provided, inside
1568 comments, after the declaration.
1570 @item -fno-asm
1571 @opindex fno-asm
1572 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1573 keyword, so that code can use these words as identifiers.  You can use
1574 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1575 instead.  @option{-ansi} implies @option{-fno-asm}.
1577 In C++, this switch only affects the @code{typeof} keyword, since
1578 @code{asm} and @code{inline} are standard keywords.  You may want to
1579 use the @option{-fno-gnu-keywords} flag instead, which has the same
1580 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1581 switch only affects the @code{asm} and @code{typeof} keywords, since
1582 @code{inline} is a standard keyword in ISO C99.
1584 @item -fno-builtin
1585 @itemx -fno-builtin-@var{function}
1586 @opindex fno-builtin
1587 @cindex built-in functions
1588 Don't recognize built-in functions that do not begin with
1589 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1590 functions provided by GCC}, for details of the functions affected,
1591 including those which are not built-in functions when @option{-ansi} or
1592 @option{-std} options for strict ISO C conformance are used because they
1593 do not have an ISO standard meaning.
1595 GCC normally generates special code to handle certain built-in functions
1596 more efficiently; for instance, calls to @code{alloca} may become single
1597 instructions that adjust the stack directly, and calls to @code{memcpy}
1598 may become inline copy loops.  The resulting code is often both smaller
1599 and faster, but since the function calls no longer appear as such, you
1600 cannot set a breakpoint on those calls, nor can you change the behavior
1601 of the functions by linking with a different library.  In addition,
1602 when a function is recognized as a built-in function, GCC may use
1603 information about that function to warn about problems with calls to
1604 that function, or to generate more efficient code, even if the
1605 resulting code still contains calls to that function.  For example,
1606 warnings are given with @option{-Wformat} for bad calls to
1607 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1608 known not to modify global memory.
1610 With the @option{-fno-builtin-@var{function}} option
1611 only the built-in function @var{function} is
1612 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1613 function is named that is not built-in in this version of GCC, this
1614 option is ignored.  There is no corresponding
1615 @option{-fbuiltin-@var{function}} option; if you wish to enable
1616 built-in functions selectively when using @option{-fno-builtin} or
1617 @option{-ffreestanding}, you may define macros such as:
1619 @smallexample
1620 #define abs(n)          __builtin_abs ((n))
1621 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1622 @end smallexample
1624 @item -fhosted
1625 @opindex fhosted
1626 @cindex hosted environment
1628 Assert that compilation takes place in a hosted environment.  This implies
1629 @option{-fbuiltin}.  A hosted environment is one in which the
1630 entire standard library is available, and in which @code{main} has a return
1631 type of @code{int}.  Examples are nearly everything except a kernel.
1632 This is equivalent to @option{-fno-freestanding}.
1634 @item -ffreestanding
1635 @opindex ffreestanding
1636 @cindex hosted environment
1638 Assert that compilation takes place in a freestanding environment.  This
1639 implies @option{-fno-builtin}.  A freestanding environment
1640 is one in which the standard library may not exist, and program startup may
1641 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1642 This is equivalent to @option{-fno-hosted}.
1644 @xref{Standards,,Language Standards Supported by GCC}, for details of
1645 freestanding and hosted environments.
1647 @item -fopenmp
1648 @opindex fopenmp
1649 @cindex openmp parallel
1650 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1651 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1652 compiler generates parallel code according to the OpenMP Application
1653 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1654 implies @option{-pthread}, and thus is only supported on targets that
1655 have support for @option{-pthread}.
1657 @item -fms-extensions
1658 @opindex fms-extensions
1659 Accept some non-standard constructs used in Microsoft header files.
1661 Some cases of unnamed fields in structures and unions are only
1662 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1663 fields within structs/unions}, for details.
1665 @item -trigraphs
1666 @opindex trigraphs
1667 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1668 options for strict ISO C conformance) implies @option{-trigraphs}.
1670 @item -no-integrated-cpp
1671 @opindex no-integrated-cpp
1672 Performs a compilation in two passes: preprocessing and compiling.  This
1673 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1674 @option{-B} option.  The user supplied compilation step can then add in
1675 an additional preprocessing step after normal preprocessing but before
1676 compiling.  The default is to use the integrated cpp (internal cpp)
1678 The semantics of this option will change if "cc1", "cc1plus", and
1679 "cc1obj" are merged.
1681 @cindex traditional C language
1682 @cindex C language, traditional
1683 @item -traditional
1684 @itemx -traditional-cpp
1685 @opindex traditional-cpp
1686 @opindex traditional
1687 Formerly, these options caused GCC to attempt to emulate a pre-standard
1688 C compiler.  They are now only supported with the @option{-E} switch.
1689 The preprocessor continues to support a pre-standard mode.  See the GNU
1690 CPP manual for details.
1692 @item -fcond-mismatch
1693 @opindex fcond-mismatch
1694 Allow conditional expressions with mismatched types in the second and
1695 third arguments.  The value of such an expression is void.  This option
1696 is not supported for C++.
1698 @item -flax-vector-conversions
1699 @opindex flax-vector-conversions
1700 Allow implicit conversions between vectors with differing numbers of
1701 elements and/or incompatible element types.  This option should not be
1702 used for new code.
1704 @item -funsigned-char
1705 @opindex funsigned-char
1706 Let the type @code{char} be unsigned, like @code{unsigned char}.
1708 Each kind of machine has a default for what @code{char} should
1709 be.  It is either like @code{unsigned char} by default or like
1710 @code{signed char} by default.
1712 Ideally, a portable program should always use @code{signed char} or
1713 @code{unsigned char} when it depends on the signedness of an object.
1714 But many programs have been written to use plain @code{char} and
1715 expect it to be signed, or expect it to be unsigned, depending on the
1716 machines they were written for.  This option, and its inverse, let you
1717 make such a program work with the opposite default.
1719 The type @code{char} is always a distinct type from each of
1720 @code{signed char} or @code{unsigned char}, even though its behavior
1721 is always just like one of those two.
1723 @item -fsigned-char
1724 @opindex fsigned-char
1725 Let the type @code{char} be signed, like @code{signed char}.
1727 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1728 the negative form of @option{-funsigned-char}.  Likewise, the option
1729 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1731 @item -fsigned-bitfields
1732 @itemx -funsigned-bitfields
1733 @itemx -fno-signed-bitfields
1734 @itemx -fno-unsigned-bitfields
1735 @opindex fsigned-bitfields
1736 @opindex funsigned-bitfields
1737 @opindex fno-signed-bitfields
1738 @opindex fno-unsigned-bitfields
1739 These options control whether a bit-field is signed or unsigned, when the
1740 declaration does not use either @code{signed} or @code{unsigned}.  By
1741 default, such a bit-field is signed, because this is consistent: the
1742 basic integer types such as @code{int} are signed types.
1743 @end table
1745 @node C++ Dialect Options
1746 @section Options Controlling C++ Dialect
1748 @cindex compiler options, C++
1749 @cindex C++ options, command line
1750 @cindex options, C++
1751 This section describes the command-line options that are only meaningful
1752 for C++ programs; but you can also use most of the GNU compiler options
1753 regardless of what language your program is in.  For example, you
1754 might compile a file @code{firstClass.C} like this:
1756 @smallexample
1757 g++ -g -frepo -O -c firstClass.C
1758 @end smallexample
1760 @noindent
1761 In this example, only @option{-frepo} is an option meant
1762 only for C++ programs; you can use the other options with any
1763 language supported by GCC@.
1765 Here is a list of options that are @emph{only} for compiling C++ programs:
1767 @table @gcctabopt
1769 @item -fabi-version=@var{n}
1770 @opindex fabi-version
1771 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1772 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1773 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1774 the version that conforms most closely to the C++ ABI specification.
1775 Therefore, the ABI obtained using version 0 will change as ABI bugs
1776 are fixed.
1778 The default is version 2.
1780 @item -fno-access-control
1781 @opindex fno-access-control
1782 Turn off all access checking.  This switch is mainly useful for working
1783 around bugs in the access control code.
1785 @item -fcheck-new
1786 @opindex fcheck-new
1787 Check that the pointer returned by @code{operator new} is non-null
1788 before attempting to modify the storage allocated.  This check is
1789 normally unnecessary because the C++ standard specifies that
1790 @code{operator new} will only return @code{0} if it is declared
1791 @samp{throw()}, in which case the compiler will always check the
1792 return value even without this option.  In all other cases, when
1793 @code{operator new} has a non-empty exception specification, memory
1794 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1795 @samp{new (nothrow)}.
1797 @item -fconserve-space
1798 @opindex fconserve-space
1799 Put uninitialized or runtime-initialized global variables into the
1800 common segment, as C does.  This saves space in the executable at the
1801 cost of not diagnosing duplicate definitions.  If you compile with this
1802 flag and your program mysteriously crashes after @code{main()} has
1803 completed, you may have an object that is being destroyed twice because
1804 two definitions were merged.
1806 This option is no longer useful on most targets, now that support has
1807 been added for putting variables into BSS without making them common.
1809 @item -fno-deduce-init-list
1810 @opindex fno-deduce-init-list
1811 Disable deduction of a template type parameter as
1812 std::initializer_list from a brace-enclosed initializer list, i.e.
1814 @smallexample
1815 template <class T> auto forward(T t) -> decltype (realfn (t))
1817   return realfn (t);
1820 void f()
1822   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1824 @end smallexample
1826 This option is present because this deduction is an extension to the
1827 current specification in the C++0x working draft, and there was
1828 some concern about potential overload resolution problems.
1830 @item -ffriend-injection
1831 @opindex ffriend-injection
1832 Inject friend functions into the enclosing namespace, so that they are
1833 visible outside the scope of the class in which they are declared.
1834 Friend functions were documented to work this way in the old Annotated
1835 C++ Reference Manual, and versions of G++ before 4.1 always worked
1836 that way.  However, in ISO C++ a friend function which is not declared
1837 in an enclosing scope can only be found using argument dependent
1838 lookup.  This option causes friends to be injected as they were in
1839 earlier releases.
1841 This option is for compatibility, and may be removed in a future
1842 release of G++.
1844 @item -fno-elide-constructors
1845 @opindex fno-elide-constructors
1846 The C++ standard allows an implementation to omit creating a temporary
1847 which is only used to initialize another object of the same type.
1848 Specifying this option disables that optimization, and forces G++ to
1849 call the copy constructor in all cases.
1851 @item -fno-enforce-eh-specs
1852 @opindex fno-enforce-eh-specs
1853 Don't generate code to check for violation of exception specifications
1854 at runtime.  This option violates the C++ standard, but may be useful
1855 for reducing code size in production builds, much like defining
1856 @samp{NDEBUG}.  This does not give user code permission to throw
1857 exceptions in violation of the exception specifications; the compiler
1858 will still optimize based on the specifications, so throwing an
1859 unexpected exception will result in undefined behavior.
1861 @item -ffor-scope
1862 @itemx -fno-for-scope
1863 @opindex ffor-scope
1864 @opindex fno-for-scope
1865 If @option{-ffor-scope} is specified, the scope of variables declared in
1866 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1867 as specified by the C++ standard.
1868 If @option{-fno-for-scope} is specified, the scope of variables declared in
1869 a @i{for-init-statement} extends to the end of the enclosing scope,
1870 as was the case in old versions of G++, and other (traditional)
1871 implementations of C++.
1873 The default if neither flag is given to follow the standard,
1874 but to allow and give a warning for old-style code that would
1875 otherwise be invalid, or have different behavior.
1877 @item -fno-gnu-keywords
1878 @opindex fno-gnu-keywords
1879 Do not recognize @code{typeof} as a keyword, so that code can use this
1880 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1881 @option{-ansi} implies @option{-fno-gnu-keywords}.
1883 @item -fno-implicit-templates
1884 @opindex fno-implicit-templates
1885 Never emit code for non-inline templates which are instantiated
1886 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1887 @xref{Template Instantiation}, for more information.
1889 @item -fno-implicit-inline-templates
1890 @opindex fno-implicit-inline-templates
1891 Don't emit code for implicit instantiations of inline templates, either.
1892 The default is to handle inlines differently so that compiles with and
1893 without optimization will need the same set of explicit instantiations.
1895 @item -fno-implement-inlines
1896 @opindex fno-implement-inlines
1897 To save space, do not emit out-of-line copies of inline functions
1898 controlled by @samp{#pragma implementation}.  This will cause linker
1899 errors if these functions are not inlined everywhere they are called.
1901 @item -fms-extensions
1902 @opindex fms-extensions
1903 Disable pedantic warnings about constructs used in MFC, such as implicit
1904 int and getting a pointer to member function via non-standard syntax.
1906 @item -fno-nonansi-builtins
1907 @opindex fno-nonansi-builtins
1908 Disable built-in declarations of functions that are not mandated by
1909 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1910 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1912 @item -fno-operator-names
1913 @opindex fno-operator-names
1914 Do not treat the operator name keywords @code{and}, @code{bitand},
1915 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1916 synonyms as keywords.
1918 @item -fno-optional-diags
1919 @opindex fno-optional-diags
1920 Disable diagnostics that the standard says a compiler does not need to
1921 issue.  Currently, the only such diagnostic issued by G++ is the one for
1922 a name having multiple meanings within a class.
1924 @item -fpermissive
1925 @opindex fpermissive
1926 Downgrade some diagnostics about nonconformant code from errors to
1927 warnings.  Thus, using @option{-fpermissive} will allow some
1928 nonconforming code to compile.
1930 @item -fno-pretty-templates
1931 @opindex fno-pretty-templates
1932 When an error message refers to a specialization of a function
1933 template, the compiler will normally print the signature of the
1934 template followed by the template arguments and any typedefs or
1935 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1936 rather than @code{void f(int)}) so that it's clear which template is
1937 involved.  When an error message refers to a specialization of a class
1938 template, the compiler will omit any template arguments which match
1939 the default template arguments for that template.  If either of these
1940 behaviors make it harder to understand the error message rather than
1941 easier, using @option{-fno-pretty-templates} will disable them.
1943 @item -frepo
1944 @opindex frepo
1945 Enable automatic template instantiation at link time.  This option also
1946 implies @option{-fno-implicit-templates}.  @xref{Template
1947 Instantiation}, for more information.
1949 @item -fno-rtti
1950 @opindex fno-rtti
1951 Disable generation of information about every class with virtual
1952 functions for use by the C++ runtime type identification features
1953 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1954 of the language, you can save some space by using this flag.  Note that
1955 exception handling uses the same information, but it will generate it as
1956 needed. The @samp{dynamic_cast} operator can still be used for casts that
1957 do not require runtime type information, i.e.@: casts to @code{void *} or to
1958 unambiguous base classes.
1960 @item -fstats
1961 @opindex fstats
1962 Emit statistics about front-end processing at the end of the compilation.
1963 This information is generally only useful to the G++ development team.
1965 @item -ftemplate-depth-@var{n}
1966 @opindex ftemplate-depth
1967 Set the maximum instantiation depth for template classes to @var{n}.
1968 A limit on the template instantiation depth is needed to detect
1969 endless recursions during template class instantiation.  ANSI/ISO C++
1970 conforming programs must not rely on a maximum depth greater than 17
1971 (changed to 1024 in C++0x).
1973 @item -fno-threadsafe-statics
1974 @opindex fno-threadsafe-statics
1975 Do not emit the extra code to use the routines specified in the C++
1976 ABI for thread-safe initialization of local statics.  You can use this
1977 option to reduce code size slightly in code that doesn't need to be
1978 thread-safe.
1980 @item -fuse-cxa-atexit
1981 @opindex fuse-cxa-atexit
1982 Register destructors for objects with static storage duration with the
1983 @code{__cxa_atexit} function rather than the @code{atexit} function.
1984 This option is required for fully standards-compliant handling of static
1985 destructors, but will only work if your C library supports
1986 @code{__cxa_atexit}.
1988 @item -fno-use-cxa-get-exception-ptr
1989 @opindex fno-use-cxa-get-exception-ptr
1990 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1991 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1992 if the runtime routine is not available.
1994 @item -fvisibility-inlines-hidden
1995 @opindex fvisibility-inlines-hidden
1996 This switch declares that the user does not attempt to compare
1997 pointers to inline methods where the addresses of the two functions
1998 were taken in different shared objects.
2000 The effect of this is that GCC may, effectively, mark inline methods with
2001 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2002 appear in the export table of a DSO and do not require a PLT indirection
2003 when used within the DSO@.  Enabling this option can have a dramatic effect
2004 on load and link times of a DSO as it massively reduces the size of the
2005 dynamic export table when the library makes heavy use of templates.
2007 The behavior of this switch is not quite the same as marking the
2008 methods as hidden directly, because it does not affect static variables
2009 local to the function or cause the compiler to deduce that
2010 the function is defined in only one shared object.
2012 You may mark a method as having a visibility explicitly to negate the
2013 effect of the switch for that method.  For example, if you do want to
2014 compare pointers to a particular inline method, you might mark it as
2015 having default visibility.  Marking the enclosing class with explicit
2016 visibility will have no effect.
2018 Explicitly instantiated inline methods are unaffected by this option
2019 as their linkage might otherwise cross a shared library boundary.
2020 @xref{Template Instantiation}.
2022 @item -fvisibility-ms-compat
2023 @opindex fvisibility-ms-compat
2024 This flag attempts to use visibility settings to make GCC's C++
2025 linkage model compatible with that of Microsoft Visual Studio.
2027 The flag makes these changes to GCC's linkage model:
2029 @enumerate
2030 @item
2031 It sets the default visibility to @code{hidden}, like
2032 @option{-fvisibility=hidden}.
2034 @item
2035 Types, but not their members, are not hidden by default.
2037 @item
2038 The One Definition Rule is relaxed for types without explicit
2039 visibility specifications which are defined in more than one different
2040 shared object: those declarations are permitted if they would have
2041 been permitted when this option was not used.
2042 @end enumerate
2044 In new code it is better to use @option{-fvisibility=hidden} and
2045 export those classes which are intended to be externally visible.
2046 Unfortunately it is possible for code to rely, perhaps accidentally,
2047 on the Visual Studio behavior.
2049 Among the consequences of these changes are that static data members
2050 of the same type with the same name but defined in different shared
2051 objects will be different, so changing one will not change the other;
2052 and that pointers to function members defined in different shared
2053 objects may not compare equal.  When this flag is given, it is a
2054 violation of the ODR to define types with the same name differently.
2056 @item -fno-weak
2057 @opindex fno-weak
2058 Do not use weak symbol support, even if it is provided by the linker.
2059 By default, G++ will use weak symbols if they are available.  This
2060 option exists only for testing, and should not be used by end-users;
2061 it will result in inferior code and has no benefits.  This option may
2062 be removed in a future release of G++.
2064 @item -nostdinc++
2065 @opindex nostdinc++
2066 Do not search for header files in the standard directories specific to
2067 C++, but do still search the other standard directories.  (This option
2068 is used when building the C++ library.)
2069 @end table
2071 In addition, these optimization, warning, and code generation options
2072 have meanings only for C++ programs:
2074 @table @gcctabopt
2075 @item -fno-default-inline
2076 @opindex fno-default-inline
2077 Do not assume @samp{inline} for functions defined inside a class scope.
2078 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2079 functions will have linkage like inline functions; they just won't be
2080 inlined by default.
2082 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2083 @opindex Wabi
2084 @opindex Wno-abi
2085 Warn when G++ generates code that is probably not compatible with the
2086 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2087 all such cases, there are probably some cases that are not warned about,
2088 even though G++ is generating incompatible code.  There may also be
2089 cases where warnings are emitted even though the code that is generated
2090 will be compatible.
2092 You should rewrite your code to avoid these warnings if you are
2093 concerned about the fact that code generated by G++ may not be binary
2094 compatible with code generated by other compilers.
2096 The known incompatibilities at this point include:
2098 @itemize @bullet
2100 @item
2101 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2102 pack data into the same byte as a base class.  For example:
2104 @smallexample
2105 struct A @{ virtual void f(); int f1 : 1; @};
2106 struct B : public A @{ int f2 : 1; @};
2107 @end smallexample
2109 @noindent
2110 In this case, G++ will place @code{B::f2} into the same byte
2111 as@code{A::f1}; other compilers will not.  You can avoid this problem
2112 by explicitly padding @code{A} so that its size is a multiple of the
2113 byte size on your platform; that will cause G++ and other compilers to
2114 layout @code{B} identically.
2116 @item
2117 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2118 tail padding when laying out virtual bases.  For example:
2120 @smallexample
2121 struct A @{ virtual void f(); char c1; @};
2122 struct B @{ B(); char c2; @};
2123 struct C : public A, public virtual B @{@};
2124 @end smallexample
2126 @noindent
2127 In this case, G++ will not place @code{B} into the tail-padding for
2128 @code{A}; other compilers will.  You can avoid this problem by
2129 explicitly padding @code{A} so that its size is a multiple of its
2130 alignment (ignoring virtual base classes); that will cause G++ and other
2131 compilers to layout @code{C} identically.
2133 @item
2134 Incorrect handling of bit-fields with declared widths greater than that
2135 of their underlying types, when the bit-fields appear in a union.  For
2136 example:
2138 @smallexample
2139 union U @{ int i : 4096; @};
2140 @end smallexample
2142 @noindent
2143 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2144 union too small by the number of bits in an @code{int}.
2146 @item
2147 Empty classes can be placed at incorrect offsets.  For example:
2149 @smallexample
2150 struct A @{@};
2152 struct B @{
2153   A a;
2154   virtual void f ();
2157 struct C : public B, public A @{@};
2158 @end smallexample
2160 @noindent
2161 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2162 it should be placed at offset zero.  G++ mistakenly believes that the
2163 @code{A} data member of @code{B} is already at offset zero.
2165 @item
2166 Names of template functions whose types involve @code{typename} or
2167 template template parameters can be mangled incorrectly.
2169 @smallexample
2170 template <typename Q>
2171 void f(typename Q::X) @{@}
2173 template <template <typename> class Q>
2174 void f(typename Q<int>::X) @{@}
2175 @end smallexample
2177 @noindent
2178 Instantiations of these templates may be mangled incorrectly.
2180 @end itemize
2182 It also warns psABI related changes.  The known psABI changes at this
2183 point include:
2185 @itemize @bullet
2187 @item
2188 For SYSV/x86-64, when passing union with long double, it is changed to
2189 pass in memory as specified in psABI.  For example:
2191 @smallexample
2192 union U @{
2193   long double ld;
2194   int i;
2196 @end smallexample
2198 @noindent
2199 @code{union U} will always be passed in memory.
2201 @end itemize
2203 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2204 @opindex Wctor-dtor-privacy
2205 @opindex Wno-ctor-dtor-privacy
2206 Warn when a class seems unusable because all the constructors or
2207 destructors in that class are private, and it has neither friends nor
2208 public static member functions.
2210 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2211 @opindex Wnon-virtual-dtor
2212 @opindex Wno-non-virtual-dtor
2213 Warn when a class has virtual functions and accessible non-virtual
2214 destructor, in which case it would be possible but unsafe to delete
2215 an instance of a derived class through a pointer to the base class.
2216 This warning is also enabled if -Weffc++ is specified.
2218 @item -Wreorder @r{(C++ and Objective-C++ only)}
2219 @opindex Wreorder
2220 @opindex Wno-reorder
2221 @cindex reordering, warning
2222 @cindex warning for reordering of member initializers
2223 Warn when the order of member initializers given in the code does not
2224 match the order in which they must be executed.  For instance:
2226 @smallexample
2227 struct A @{
2228   int i;
2229   int j;
2230   A(): j (0), i (1) @{ @}
2232 @end smallexample
2234 The compiler will rearrange the member initializers for @samp{i}
2235 and @samp{j} to match the declaration order of the members, emitting
2236 a warning to that effect.  This warning is enabled by @option{-Wall}.
2237 @end table
2239 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2241 @table @gcctabopt
2242 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2243 @opindex Weffc++
2244 @opindex Wno-effc++
2245 Warn about violations of the following style guidelines from Scott Meyers'
2246 @cite{Effective C++} book:
2248 @itemize @bullet
2249 @item
2250 Item 11:  Define a copy constructor and an assignment operator for classes
2251 with dynamically allocated memory.
2253 @item
2254 Item 12:  Prefer initialization to assignment in constructors.
2256 @item
2257 Item 14:  Make destructors virtual in base classes.
2259 @item
2260 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2262 @item
2263 Item 23:  Don't try to return a reference when you must return an object.
2265 @end itemize
2267 Also warn about violations of the following style guidelines from
2268 Scott Meyers' @cite{More Effective C++} book:
2270 @itemize @bullet
2271 @item
2272 Item 6:  Distinguish between prefix and postfix forms of increment and
2273 decrement operators.
2275 @item
2276 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2278 @end itemize
2280 When selecting this option, be aware that the standard library
2281 headers do not obey all of these guidelines; use @samp{grep -v}
2282 to filter out those warnings.
2284 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2285 @opindex Wstrict-null-sentinel
2286 @opindex Wno-strict-null-sentinel
2287 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2288 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2289 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2290 it is guaranteed to be of the same size as a pointer.  But this use is
2291 not portable across different compilers.
2293 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2294 @opindex Wno-non-template-friend
2295 @opindex Wnon-template-friend
2296 Disable warnings when non-templatized friend functions are declared
2297 within a template.  Since the advent of explicit template specification
2298 support in G++, if the name of the friend is an unqualified-id (i.e.,
2299 @samp{friend foo(int)}), the C++ language specification demands that the
2300 friend declare or define an ordinary, nontemplate function.  (Section
2301 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2302 could be interpreted as a particular specialization of a templatized
2303 function.  Because this non-conforming behavior is no longer the default
2304 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2305 check existing code for potential trouble spots and is on by default.
2306 This new compiler behavior can be turned off with
2307 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2308 but disables the helpful warning.
2310 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2311 @opindex Wold-style-cast
2312 @opindex Wno-old-style-cast
2313 Warn if an old-style (C-style) cast to a non-void type is used within
2314 a C++ program.  The new-style casts (@samp{dynamic_cast},
2315 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2316 less vulnerable to unintended effects and much easier to search for.
2318 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2319 @opindex Woverloaded-virtual
2320 @opindex Wno-overloaded-virtual
2321 @cindex overloaded virtual fn, warning
2322 @cindex warning for overloaded virtual fn
2323 Warn when a function declaration hides virtual functions from a
2324 base class.  For example, in:
2326 @smallexample
2327 struct A @{
2328   virtual void f();
2331 struct B: public A @{
2332   void f(int);
2334 @end smallexample
2336 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2337 like:
2339 @smallexample
2340 B* b;
2341 b->f();
2342 @end smallexample
2344 will fail to compile.
2346 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2347 @opindex Wno-pmf-conversions
2348 @opindex Wpmf-conversions
2349 Disable the diagnostic for converting a bound pointer to member function
2350 to a plain pointer.
2352 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2353 @opindex Wsign-promo
2354 @opindex Wno-sign-promo
2355 Warn when overload resolution chooses a promotion from unsigned or
2356 enumerated type to a signed type, over a conversion to an unsigned type of
2357 the same size.  Previous versions of G++ would try to preserve
2358 unsignedness, but the standard mandates the current behavior.
2360 @smallexample
2361 struct A @{
2362   operator int ();
2363   A& operator = (int);
2366 main ()
2368   A a,b;
2369   a = b;
2371 @end smallexample
2373 In this example, G++ will synthesize a default @samp{A& operator =
2374 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2375 @end table
2377 @node Objective-C and Objective-C++ Dialect Options
2378 @section Options Controlling Objective-C and Objective-C++ Dialects
2380 @cindex compiler options, Objective-C and Objective-C++
2381 @cindex Objective-C and Objective-C++ options, command line
2382 @cindex options, Objective-C and Objective-C++
2383 (NOTE: This manual does not describe the Objective-C and Objective-C++
2384 languages themselves.  See @xref{Standards,,Language Standards
2385 Supported by GCC}, for references.)
2387 This section describes the command-line options that are only meaningful
2388 for Objective-C and Objective-C++ programs, but you can also use most of
2389 the language-independent GNU compiler options.
2390 For example, you might compile a file @code{some_class.m} like this:
2392 @smallexample
2393 gcc -g -fgnu-runtime -O -c some_class.m
2394 @end smallexample
2396 @noindent
2397 In this example, @option{-fgnu-runtime} is an option meant only for
2398 Objective-C and Objective-C++ programs; you can use the other options with
2399 any language supported by GCC@.
2401 Note that since Objective-C is an extension of the C language, Objective-C
2402 compilations may also use options specific to the C front-end (e.g.,
2403 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2404 C++-specific options (e.g., @option{-Wabi}).
2406 Here is a list of options that are @emph{only} for compiling Objective-C
2407 and Objective-C++ programs:
2409 @table @gcctabopt
2410 @item -fconstant-string-class=@var{class-name}
2411 @opindex fconstant-string-class
2412 Use @var{class-name} as the name of the class to instantiate for each
2413 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2414 class name is @code{NXConstantString} if the GNU runtime is being used, and
2415 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2416 @option{-fconstant-cfstrings} option, if also present, will override the
2417 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2418 to be laid out as constant CoreFoundation strings.
2420 @item -fgnu-runtime
2421 @opindex fgnu-runtime
2422 Generate object code compatible with the standard GNU Objective-C
2423 runtime.  This is the default for most types of systems.
2425 @item -fnext-runtime
2426 @opindex fnext-runtime
2427 Generate output compatible with the NeXT runtime.  This is the default
2428 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2429 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2430 used.
2432 @item -fno-nil-receivers
2433 @opindex fno-nil-receivers
2434 Assume that all Objective-C message dispatches (e.g.,
2435 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2436 is not @code{nil}.  This allows for more efficient entry points in the runtime
2437 to be used.  Currently, this option is only available in conjunction with
2438 the NeXT runtime on Mac OS X 10.3 and later.
2440 @item -fobjc-call-cxx-cdtors
2441 @opindex fobjc-call-cxx-cdtors
2442 For each Objective-C class, check if any of its instance variables is a
2443 C++ object with a non-trivial default constructor.  If so, synthesize a
2444 special @code{- (id) .cxx_construct} instance method that will run
2445 non-trivial default constructors on any such instance variables, in order,
2446 and then return @code{self}.  Similarly, check if any instance variable
2447 is a C++ object with a non-trivial destructor, and if so, synthesize a
2448 special @code{- (void) .cxx_destruct} method that will run
2449 all such default destructors, in reverse order.
2451 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2452 thusly generated will only operate on instance variables declared in the
2453 current Objective-C class, and not those inherited from superclasses.  It
2454 is the responsibility of the Objective-C runtime to invoke all such methods
2455 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2456 will be invoked by the runtime immediately after a new object
2457 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2458 be invoked immediately before the runtime deallocates an object instance.
2460 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2461 support for invoking the @code{- (id) .cxx_construct} and
2462 @code{- (void) .cxx_destruct} methods.
2464 @item -fobjc-direct-dispatch
2465 @opindex fobjc-direct-dispatch
2466 Allow fast jumps to the message dispatcher.  On Darwin this is
2467 accomplished via the comm page.
2469 @item -fobjc-exceptions
2470 @opindex fobjc-exceptions
2471 Enable syntactic support for structured exception handling in Objective-C,
2472 similar to what is offered by C++ and Java.  This option is
2473 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2474 earlier.
2476 @smallexample
2477   @@try @{
2478     @dots{}
2479        @@throw expr;
2480     @dots{}
2481   @}
2482   @@catch (AnObjCClass *exc) @{
2483     @dots{}
2484       @@throw expr;
2485     @dots{}
2486       @@throw;
2487     @dots{}
2488   @}
2489   @@catch (AnotherClass *exc) @{
2490     @dots{}
2491   @}
2492   @@catch (id allOthers) @{
2493     @dots{}
2494   @}
2495   @@finally @{
2496     @dots{}
2497       @@throw expr;
2498     @dots{}
2499   @}
2500 @end smallexample
2502 The @code{@@throw} statement may appear anywhere in an Objective-C or
2503 Objective-C++ program; when used inside of a @code{@@catch} block, the
2504 @code{@@throw} may appear without an argument (as shown above), in which case
2505 the object caught by the @code{@@catch} will be rethrown.
2507 Note that only (pointers to) Objective-C objects may be thrown and
2508 caught using this scheme.  When an object is thrown, it will be caught
2509 by the nearest @code{@@catch} clause capable of handling objects of that type,
2510 analogously to how @code{catch} blocks work in C++ and Java.  A
2511 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2512 any and all Objective-C exceptions not caught by previous @code{@@catch}
2513 clauses (if any).
2515 The @code{@@finally} clause, if present, will be executed upon exit from the
2516 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2517 regardless of whether any exceptions are thrown, caught or rethrown
2518 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2519 of the @code{finally} clause in Java.
2521 There are several caveats to using the new exception mechanism:
2523 @itemize @bullet
2524 @item
2525 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2526 idioms provided by the @code{NSException} class, the new
2527 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2528 systems, due to additional functionality needed in the (NeXT) Objective-C
2529 runtime.
2531 @item
2532 As mentioned above, the new exceptions do not support handling
2533 types other than Objective-C objects.   Furthermore, when used from
2534 Objective-C++, the Objective-C exception model does not interoperate with C++
2535 exceptions at this time.  This means you cannot @code{@@throw} an exception
2536 from Objective-C and @code{catch} it in C++, or vice versa
2537 (i.e., @code{throw @dots{} @@catch}).
2538 @end itemize
2540 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2541 blocks for thread-safe execution:
2543 @smallexample
2544   @@synchronized (ObjCClass *guard) @{
2545     @dots{}
2546   @}
2547 @end smallexample
2549 Upon entering the @code{@@synchronized} block, a thread of execution shall
2550 first check whether a lock has been placed on the corresponding @code{guard}
2551 object by another thread.  If it has, the current thread shall wait until
2552 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2553 the current thread will place its own lock on it, execute the code contained in
2554 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2555 making @code{guard} available to other threads).
2557 Unlike Java, Objective-C does not allow for entire methods to be marked
2558 @code{@@synchronized}.  Note that throwing exceptions out of
2559 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2560 to be unlocked properly.
2562 @item -fobjc-gc
2563 @opindex fobjc-gc
2564 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2566 @item -freplace-objc-classes
2567 @opindex freplace-objc-classes
2568 Emit a special marker instructing @command{ld(1)} not to statically link in
2569 the resulting object file, and allow @command{dyld(1)} to load it in at
2570 run time instead.  This is used in conjunction with the Fix-and-Continue
2571 debugging mode, where the object file in question may be recompiled and
2572 dynamically reloaded in the course of program execution, without the need
2573 to restart the program itself.  Currently, Fix-and-Continue functionality
2574 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2575 and later.
2577 @item -fzero-link
2578 @opindex fzero-link
2579 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2580 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2581 compile time) with static class references that get initialized at load time,
2582 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2583 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2584 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2585 for individual class implementations to be modified during program execution.
2587 @item -gen-decls
2588 @opindex gen-decls
2589 Dump interface declarations for all classes seen in the source file to a
2590 file named @file{@var{sourcename}.decl}.
2592 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2593 @opindex Wassign-intercept
2594 @opindex Wno-assign-intercept
2595 Warn whenever an Objective-C assignment is being intercepted by the
2596 garbage collector.
2598 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2599 @opindex Wno-protocol
2600 @opindex Wprotocol
2601 If a class is declared to implement a protocol, a warning is issued for
2602 every method in the protocol that is not implemented by the class.  The
2603 default behavior is to issue a warning for every method not explicitly
2604 implemented in the class, even if a method implementation is inherited
2605 from the superclass.  If you use the @option{-Wno-protocol} option, then
2606 methods inherited from the superclass are considered to be implemented,
2607 and no warning is issued for them.
2609 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2610 @opindex Wselector
2611 @opindex Wno-selector
2612 Warn if multiple methods of different types for the same selector are
2613 found during compilation.  The check is performed on the list of methods
2614 in the final stage of compilation.  Additionally, a check is performed
2615 for each selector appearing in a @code{@@selector(@dots{})}
2616 expression, and a corresponding method for that selector has been found
2617 during compilation.  Because these checks scan the method table only at
2618 the end of compilation, these warnings are not produced if the final
2619 stage of compilation is not reached, for example because an error is
2620 found during compilation, or because the @option{-fsyntax-only} option is
2621 being used.
2623 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2624 @opindex Wstrict-selector-match
2625 @opindex Wno-strict-selector-match
2626 Warn if multiple methods with differing argument and/or return types are
2627 found for a given selector when attempting to send a message using this
2628 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2629 is off (which is the default behavior), the compiler will omit such warnings
2630 if any differences found are confined to types which share the same size
2631 and alignment.
2633 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2634 @opindex Wundeclared-selector
2635 @opindex Wno-undeclared-selector
2636 Warn if a @code{@@selector(@dots{})} expression referring to an
2637 undeclared selector is found.  A selector is considered undeclared if no
2638 method with that name has been declared before the
2639 @code{@@selector(@dots{})} expression, either explicitly in an
2640 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2641 an @code{@@implementation} section.  This option always performs its
2642 checks as soon as a @code{@@selector(@dots{})} expression is found,
2643 while @option{-Wselector} only performs its checks in the final stage of
2644 compilation.  This also enforces the coding style convention
2645 that methods and selectors must be declared before being used.
2647 @item -print-objc-runtime-info
2648 @opindex print-objc-runtime-info
2649 Generate C header describing the largest structure that is passed by
2650 value, if any.
2652 @end table
2654 @node Language Independent Options
2655 @section Options to Control Diagnostic Messages Formatting
2656 @cindex options to control diagnostics formatting
2657 @cindex diagnostic messages
2658 @cindex message formatting
2660 Traditionally, diagnostic messages have been formatted irrespective of
2661 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2662 below can be used to control the diagnostic messages formatting
2663 algorithm, e.g.@: how many characters per line, how often source location
2664 information should be reported.  Right now, only the C++ front end can
2665 honor these options.  However it is expected, in the near future, that
2666 the remaining front ends would be able to digest them correctly.
2668 @table @gcctabopt
2669 @item -fmessage-length=@var{n}
2670 @opindex fmessage-length
2671 Try to format error messages so that they fit on lines of about @var{n}
2672 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2673 the front ends supported by GCC@.  If @var{n} is zero, then no
2674 line-wrapping will be done; each error message will appear on a single
2675 line.
2677 @opindex fdiagnostics-show-location
2678 @item -fdiagnostics-show-location=once
2679 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2680 reporter to emit @emph{once} source location information; that is, in
2681 case the message is too long to fit on a single physical line and has to
2682 be wrapped, the source location won't be emitted (as prefix) again,
2683 over and over, in subsequent continuation lines.  This is the default
2684 behavior.
2686 @item -fdiagnostics-show-location=every-line
2687 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2688 messages reporter to emit the same source location information (as
2689 prefix) for physical lines that result from the process of breaking
2690 a message which is too long to fit on a single line.
2692 @item -fdiagnostics-show-option
2693 @opindex fdiagnostics-show-option
2694 This option instructs the diagnostic machinery to add text to each
2695 diagnostic emitted, which indicates which command line option directly
2696 controls that diagnostic, when such an option is known to the
2697 diagnostic machinery.
2699 @item -Wcoverage-mismatch
2700 @opindex Wcoverage-mismatch
2701 Warn if feedback profiles do not match when using the
2702 @option{-fprofile-use} option.
2703 If a source file was changed between @option{-fprofile-gen} and
2704 @option{-fprofile-use}, the files with the profile feedback can fail
2705 to match the source file and GCC can not use the profile feedback
2706 information.  By default, GCC emits an error message in this case.
2707 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2708 error.  GCC does not use appropriate feedback profiles, so using this
2709 option can result in poorly optimized code.  This option is useful
2710 only in the case of very minor changes such as bug fixes to an
2711 existing code-base.
2713 @end table
2715 @node Warning Options
2716 @section Options to Request or Suppress Warnings
2717 @cindex options to control warnings
2718 @cindex warning messages
2719 @cindex messages, warning
2720 @cindex suppressing warnings
2722 Warnings are diagnostic messages that report constructions which
2723 are not inherently erroneous but which are risky or suggest there
2724 may have been an error.
2726 The following language-independent options do not enable specific
2727 warnings but control the kinds of diagnostics produced by GCC.
2729 @table @gcctabopt
2730 @cindex syntax checking
2731 @item -fsyntax-only
2732 @opindex fsyntax-only
2733 Check the code for syntax errors, but don't do anything beyond that.
2735 @item -w
2736 @opindex w
2737 Inhibit all warning messages.
2739 @item -Werror
2740 @opindex Werror
2741 @opindex Wno-error
2742 Make all warnings into errors.
2744 @item -Werror=
2745 @opindex Werror=
2746 @opindex Wno-error=
2747 Make the specified warning into an error.  The specifier for a warning
2748 is appended, for example @option{-Werror=switch} turns the warnings
2749 controlled by @option{-Wswitch} into errors.  This switch takes a
2750 negative form, to be used to negate @option{-Werror} for specific
2751 warnings, for example @option{-Wno-error=switch} makes
2752 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2753 is in effect.  You can use the @option{-fdiagnostics-show-option}
2754 option to have each controllable warning amended with the option which
2755 controls it, to determine what to use with this option.
2757 Note that specifying @option{-Werror=}@var{foo} automatically implies
2758 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2759 imply anything.
2761 @item -Wfatal-errors
2762 @opindex Wfatal-errors
2763 @opindex Wno-fatal-errors
2764 This option causes the compiler to abort compilation on the first error
2765 occurred rather than trying to keep going and printing further error
2766 messages.
2768 @end table
2770 You can request many specific warnings with options beginning
2771 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2772 implicit declarations.  Each of these specific warning options also
2773 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2774 example, @option{-Wno-implicit}.  This manual lists only one of the
2775 two forms, whichever is not the default.  For further,
2776 language-specific options also refer to @ref{C++ Dialect Options} and
2777 @ref{Objective-C and Objective-C++ Dialect Options}.
2779 @table @gcctabopt
2780 @item -pedantic
2781 @opindex pedantic
2782 Issue all the warnings demanded by strict ISO C and ISO C++;
2783 reject all programs that use forbidden extensions, and some other
2784 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2785 version of the ISO C standard specified by any @option{-std} option used.
2787 Valid ISO C and ISO C++ programs should compile properly with or without
2788 this option (though a rare few will require @option{-ansi} or a
2789 @option{-std} option specifying the required version of ISO C)@.  However,
2790 without this option, certain GNU extensions and traditional C and C++
2791 features are supported as well.  With this option, they are rejected.
2793 @option{-pedantic} does not cause warning messages for use of the
2794 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2795 warnings are also disabled in the expression that follows
2796 @code{__extension__}.  However, only system header files should use
2797 these escape routes; application programs should avoid them.
2798 @xref{Alternate Keywords}.
2800 Some users try to use @option{-pedantic} to check programs for strict ISO
2801 C conformance.  They soon find that it does not do quite what they want:
2802 it finds some non-ISO practices, but not all---only those for which
2803 ISO C @emph{requires} a diagnostic, and some others for which
2804 diagnostics have been added.
2806 A feature to report any failure to conform to ISO C might be useful in
2807 some instances, but would require considerable additional work and would
2808 be quite different from @option{-pedantic}.  We don't have plans to
2809 support such a feature in the near future.
2811 Where the standard specified with @option{-std} represents a GNU
2812 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2813 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2814 extended dialect is based.  Warnings from @option{-pedantic} are given
2815 where they are required by the base standard.  (It would not make sense
2816 for such warnings to be given only for features not in the specified GNU
2817 C dialect, since by definition the GNU dialects of C include all
2818 features the compiler supports with the given option, and there would be
2819 nothing to warn about.)
2821 @item -pedantic-errors
2822 @opindex pedantic-errors
2823 Like @option{-pedantic}, except that errors are produced rather than
2824 warnings.
2826 @item -Wall
2827 @opindex Wall
2828 @opindex Wno-all
2829 This enables all the warnings about constructions that some users
2830 consider questionable, and that are easy to avoid (or modify to
2831 prevent the warning), even in conjunction with macros.  This also
2832 enables some language-specific warnings described in @ref{C++ Dialect
2833 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2835 @option{-Wall} turns on the following warning flags:
2837 @gccoptlist{-Waddress   @gol
2838 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2839 -Wc++0x-compat  @gol
2840 -Wchar-subscripts  @gol
2841 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2842 -Wimplicit-int  @gol
2843 -Wimplicit-function-declaration  @gol
2844 -Wcomment  @gol
2845 -Wformat   @gol
2846 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2847 -Wmissing-braces  @gol
2848 -Wnonnull  @gol
2849 -Wparentheses  @gol
2850 -Wpointer-sign  @gol
2851 -Wreorder   @gol
2852 -Wreturn-type  @gol
2853 -Wsequence-point  @gol
2854 -Wsign-compare @r{(only in C++)}  @gol
2855 -Wstrict-aliasing  @gol
2856 -Wstrict-overflow=1  @gol
2857 -Wswitch  @gol
2858 -Wtrigraphs  @gol
2859 -Wuninitialized  @gol
2860 -Wunknown-pragmas  @gol
2861 -Wunused-function  @gol
2862 -Wunused-label     @gol
2863 -Wunused-value     @gol
2864 -Wunused-variable  @gol
2865 -Wvolatile-register-var @gol
2868 Note that some warning flags are not implied by @option{-Wall}.  Some of
2869 them warn about constructions that users generally do not consider
2870 questionable, but which occasionally you might wish to check for;
2871 others warn about constructions that are necessary or hard to avoid in
2872 some cases, and there is no simple way to modify the code to suppress
2873 the warning. Some of them are enabled by @option{-Wextra} but many of
2874 them must be enabled individually.
2876 @item -Wextra
2877 @opindex W
2878 @opindex Wextra
2879 @opindex Wno-extra
2880 This enables some extra warning flags that are not enabled by
2881 @option{-Wall}. (This option used to be called @option{-W}.  The older
2882 name is still supported, but the newer name is more descriptive.)
2884 @gccoptlist{-Wclobbered  @gol
2885 -Wempty-body  @gol
2886 -Wignored-qualifiers @gol
2887 -Wmissing-field-initializers  @gol
2888 -Wmissing-parameter-type @r{(C only)}  @gol
2889 -Wold-style-declaration @r{(C only)}  @gol
2890 -Woverride-init  @gol
2891 -Wsign-compare  @gol
2892 -Wtype-limits  @gol
2893 -Wuninitialized  @gol
2894 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2897 The option @option{-Wextra} also prints warning messages for the
2898 following cases:
2900 @itemize @bullet
2902 @item
2903 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2904 @samp{>}, or @samp{>=}.
2906 @item
2907 (C++ only) An enumerator and a non-enumerator both appear in a
2908 conditional expression.
2910 @item
2911 (C++ only) Ambiguous virtual bases.
2913 @item
2914 (C++ only) Subscripting an array which has been declared @samp{register}.
2916 @item
2917 (C++ only) Taking the address of a variable which has been declared
2918 @samp{register}.
2920 @item
2921 (C++ only) A base class is not initialized in a derived class' copy
2922 constructor.
2924 @end itemize
2926 @item -Wchar-subscripts
2927 @opindex Wchar-subscripts
2928 @opindex Wno-char-subscripts
2929 Warn if an array subscript has type @code{char}.  This is a common cause
2930 of error, as programmers often forget that this type is signed on some
2931 machines.
2932 This warning is enabled by @option{-Wall}.
2934 @item -Wcomment
2935 @opindex Wcomment
2936 @opindex Wno-comment
2937 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2938 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2939 This warning is enabled by @option{-Wall}.
2941 @item -Wformat
2942 @opindex Wformat
2943 @opindex Wno-format
2944 @opindex ffreestanding
2945 @opindex fno-builtin
2946 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2947 the arguments supplied have types appropriate to the format string
2948 specified, and that the conversions specified in the format string make
2949 sense.  This includes standard functions, and others specified by format
2950 attributes (@pxref{Function Attributes}), in the @code{printf},
2951 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2952 not in the C standard) families (or other target-specific families).
2953 Which functions are checked without format attributes having been
2954 specified depends on the standard version selected, and such checks of
2955 functions without the attribute specified are disabled by
2956 @option{-ffreestanding} or @option{-fno-builtin}.
2958 The formats are checked against the format features supported by GNU
2959 libc version 2.2.  These include all ISO C90 and C99 features, as well
2960 as features from the Single Unix Specification and some BSD and GNU
2961 extensions.  Other library implementations may not support all these
2962 features; GCC does not support warning about features that go beyond a
2963 particular library's limitations.  However, if @option{-pedantic} is used
2964 with @option{-Wformat}, warnings will be given about format features not
2965 in the selected standard version (but not for @code{strfmon} formats,
2966 since those are not in any version of the C standard).  @xref{C Dialect
2967 Options,,Options Controlling C Dialect}.
2969 Since @option{-Wformat} also checks for null format arguments for
2970 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2972 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2973 aspects of format checking, the options @option{-Wformat-y2k},
2974 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2975 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2976 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2978 @item -Wformat-y2k
2979 @opindex Wformat-y2k
2980 @opindex Wno-format-y2k
2981 If @option{-Wformat} is specified, also warn about @code{strftime}
2982 formats which may yield only a two-digit year.
2984 @item -Wno-format-contains-nul
2985 @opindex Wno-format-contains-nul
2986 @opindex Wformat-contains-nul
2987 If @option{-Wformat} is specified, do not warn about format strings that
2988 contain NUL bytes.
2990 @item -Wno-format-extra-args
2991 @opindex Wno-format-extra-args
2992 @opindex Wformat-extra-args
2993 If @option{-Wformat} is specified, do not warn about excess arguments to a
2994 @code{printf} or @code{scanf} format function.  The C standard specifies
2995 that such arguments are ignored.
2997 Where the unused arguments lie between used arguments that are
2998 specified with @samp{$} operand number specifications, normally
2999 warnings are still given, since the implementation could not know what
3000 type to pass to @code{va_arg} to skip the unused arguments.  However,
3001 in the case of @code{scanf} formats, this option will suppress the
3002 warning if the unused arguments are all pointers, since the Single
3003 Unix Specification says that such unused arguments are allowed.
3005 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3006 @opindex Wno-format-zero-length
3007 @opindex Wformat-zero-length
3008 If @option{-Wformat} is specified, do not warn about zero-length formats.
3009 The C standard specifies that zero-length formats are allowed.
3011 @item -Wformat-nonliteral
3012 @opindex Wformat-nonliteral
3013 @opindex Wno-format-nonliteral
3014 If @option{-Wformat} is specified, also warn if the format string is not a
3015 string literal and so cannot be checked, unless the format function
3016 takes its format arguments as a @code{va_list}.
3018 @item -Wformat-security
3019 @opindex Wformat-security
3020 @opindex Wno-format-security
3021 If @option{-Wformat} is specified, also warn about uses of format
3022 functions that represent possible security problems.  At present, this
3023 warns about calls to @code{printf} and @code{scanf} functions where the
3024 format string is not a string literal and there are no format arguments,
3025 as in @code{printf (foo);}.  This may be a security hole if the format
3026 string came from untrusted input and contains @samp{%n}.  (This is
3027 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3028 in future warnings may be added to @option{-Wformat-security} that are not
3029 included in @option{-Wformat-nonliteral}.)
3031 @item -Wformat=2
3032 @opindex Wformat=2
3033 @opindex Wno-format=2
3034 Enable @option{-Wformat} plus format checks not included in
3035 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3036 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3038 @item -Wnonnull @r{(C and Objective-C only)}
3039 @opindex Wnonnull
3040 @opindex Wno-nonnull
3041 Warn about passing a null pointer for arguments marked as
3042 requiring a non-null value by the @code{nonnull} function attribute.
3044 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3045 can be disabled with the @option{-Wno-nonnull} option.
3047 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3048 @opindex Winit-self
3049 @opindex Wno-init-self
3050 Warn about uninitialized variables which are initialized with themselves.
3051 Note this option can only be used with the @option{-Wuninitialized} option.
3053 For example, GCC will warn about @code{i} being uninitialized in the
3054 following snippet only when @option{-Winit-self} has been specified:
3055 @smallexample
3056 @group
3057 int f()
3059   int i = i;
3060   return i;
3062 @end group
3063 @end smallexample
3065 @item -Wimplicit-int @r{(C and Objective-C only)}
3066 @opindex Wimplicit-int
3067 @opindex Wno-implicit-int
3068 Warn when a declaration does not specify a type.
3069 This warning is enabled by @option{-Wall}.
3071 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3072 @opindex Wimplicit-function-declaration
3073 @opindex Wno-implicit-function-declaration
3074 Give a warning whenever a function is used before being declared. In
3075 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3076 enabled by default and it is made into an error by
3077 @option{-pedantic-errors}. This warning is also enabled by
3078 @option{-Wall}.
3080 @item -Wimplicit
3081 @opindex Wimplicit
3082 @opindex Wno-implicit
3083 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3084 This warning is enabled by @option{-Wall}.
3086 @item -Wignored-qualifiers @r{(C and C++ only)}
3087 @opindex Wignored-qualifiers
3088 @opindex Wno-ignored-qualifiers
3089 Warn if the return type of a function has a type qualifier
3090 such as @code{const}.  For ISO C such a type qualifier has no effect,
3091 since the value returned by a function is not an lvalue.
3092 For C++, the warning is only emitted for scalar types or @code{void}.
3093 ISO C prohibits qualified @code{void} return types on function
3094 definitions, so such return types always receive a warning
3095 even without this option.
3097 This warning is also enabled by @option{-Wextra}.
3099 @item -Wmain
3100 @opindex Wmain
3101 @opindex Wno-main
3102 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3103 a function with external linkage, returning int, taking either zero
3104 arguments, two, or three arguments of appropriate types.  This warning
3105 is enabled by default in C++ and is enabled by either @option{-Wall}
3106 or @option{-pedantic}.
3108 @item -Wmissing-braces
3109 @opindex Wmissing-braces
3110 @opindex Wno-missing-braces
3111 Warn if an aggregate or union initializer is not fully bracketed.  In
3112 the following example, the initializer for @samp{a} is not fully
3113 bracketed, but that for @samp{b} is fully bracketed.
3115 @smallexample
3116 int a[2][2] = @{ 0, 1, 2, 3 @};
3117 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3118 @end smallexample
3120 This warning is enabled by @option{-Wall}.
3122 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3123 @opindex Wmissing-include-dirs
3124 @opindex Wno-missing-include-dirs
3125 Warn if a user-supplied include directory does not exist.
3127 @item -Wparentheses
3128 @opindex Wparentheses
3129 @opindex Wno-parentheses
3130 Warn if parentheses are omitted in certain contexts, such
3131 as when there is an assignment in a context where a truth value
3132 is expected, or when operators are nested whose precedence people
3133 often get confused about.
3135 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3136 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3137 interpretation from that of ordinary mathematical notation.
3139 Also warn about constructions where there may be confusion to which
3140 @code{if} statement an @code{else} branch belongs.  Here is an example of
3141 such a case:
3143 @smallexample
3144 @group
3146   if (a)
3147     if (b)
3148       foo ();
3149   else
3150     bar ();
3152 @end group
3153 @end smallexample
3155 In C/C++, every @code{else} branch belongs to the innermost possible
3156 @code{if} statement, which in this example is @code{if (b)}.  This is
3157 often not what the programmer expected, as illustrated in the above
3158 example by indentation the programmer chose.  When there is the
3159 potential for this confusion, GCC will issue a warning when this flag
3160 is specified.  To eliminate the warning, add explicit braces around
3161 the innermost @code{if} statement so there is no way the @code{else}
3162 could belong to the enclosing @code{if}.  The resulting code would
3163 look like this:
3165 @smallexample
3166 @group
3168   if (a)
3169     @{
3170       if (b)
3171         foo ();
3172       else
3173         bar ();
3174     @}
3176 @end group
3177 @end smallexample
3179 This warning is enabled by @option{-Wall}.
3181 @item -Wsequence-point
3182 @opindex Wsequence-point
3183 @opindex Wno-sequence-point
3184 Warn about code that may have undefined semantics because of violations
3185 of sequence point rules in the C and C++ standards.
3187 The C and C++ standards defines the order in which expressions in a C/C++
3188 program are evaluated in terms of @dfn{sequence points}, which represent
3189 a partial ordering between the execution of parts of the program: those
3190 executed before the sequence point, and those executed after it.  These
3191 occur after the evaluation of a full expression (one which is not part
3192 of a larger expression), after the evaluation of the first operand of a
3193 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3194 function is called (but after the evaluation of its arguments and the
3195 expression denoting the called function), and in certain other places.
3196 Other than as expressed by the sequence point rules, the order of
3197 evaluation of subexpressions of an expression is not specified.  All
3198 these rules describe only a partial order rather than a total order,
3199 since, for example, if two functions are called within one expression
3200 with no sequence point between them, the order in which the functions
3201 are called is not specified.  However, the standards committee have
3202 ruled that function calls do not overlap.
3204 It is not specified when between sequence points modifications to the
3205 values of objects take effect.  Programs whose behavior depends on this
3206 have undefined behavior; the C and C++ standards specify that ``Between
3207 the previous and next sequence point an object shall have its stored
3208 value modified at most once by the evaluation of an expression.
3209 Furthermore, the prior value shall be read only to determine the value
3210 to be stored.''.  If a program breaks these rules, the results on any
3211 particular implementation are entirely unpredictable.
3213 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3214 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3215 diagnosed by this option, and it may give an occasional false positive
3216 result, but in general it has been found fairly effective at detecting
3217 this sort of problem in programs.
3219 The standard is worded confusingly, therefore there is some debate
3220 over the precise meaning of the sequence point rules in subtle cases.
3221 Links to discussions of the problem, including proposed formal
3222 definitions, may be found on the GCC readings page, at
3223 @w{@uref{http://gcc.gnu.org/readings.html}}.
3225 This warning is enabled by @option{-Wall} for C and C++.
3227 @item -Wreturn-type
3228 @opindex Wreturn-type
3229 @opindex Wno-return-type
3230 Warn whenever a function is defined with a return-type that defaults
3231 to @code{int}.  Also warn about any @code{return} statement with no
3232 return-value in a function whose return-type is not @code{void}
3233 (falling off the end of the function body is considered returning
3234 without a value), and about a @code{return} statement with an
3235 expression in a function whose return-type is @code{void}.
3237 For C++, a function without return type always produces a diagnostic
3238 message, even when @option{-Wno-return-type} is specified.  The only
3239 exceptions are @samp{main} and functions defined in system headers.
3241 This warning is enabled by @option{-Wall}.
3243 @item -Wswitch
3244 @opindex Wswitch
3245 @opindex Wno-switch
3246 Warn whenever a @code{switch} statement has an index of enumerated type
3247 and lacks a @code{case} for one or more of the named codes of that
3248 enumeration.  (The presence of a @code{default} label prevents this
3249 warning.)  @code{case} labels outside the enumeration range also
3250 provoke warnings when this option is used (even if there is a
3251 @code{default} label).
3252 This warning is enabled by @option{-Wall}.
3254 @item -Wswitch-default
3255 @opindex Wswitch-default
3256 @opindex Wno-switch-default
3257 Warn whenever a @code{switch} statement does not have a @code{default}
3258 case.
3260 @item -Wswitch-enum
3261 @opindex Wswitch-enum
3262 @opindex Wno-switch-enum
3263 Warn whenever a @code{switch} statement has an index of enumerated type
3264 and lacks a @code{case} for one or more of the named codes of that
3265 enumeration.  @code{case} labels outside the enumeration range also
3266 provoke warnings when this option is used.  The only difference
3267 between @option{-Wswitch} and this option is that this option gives a
3268 warning about an omitted enumeration code even if there is a
3269 @code{default} label.
3271 @item -Wsync-nand @r{(C and C++ only)}
3272 @opindex Wsync-nand
3273 @opindex Wno-sync-nand
3274 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3275 built-in functions are used.  These functions changed semantics in GCC 4.4.
3277 @item -Wtrigraphs
3278 @opindex Wtrigraphs
3279 @opindex Wno-trigraphs
3280 Warn if any trigraphs are encountered that might change the meaning of
3281 the program (trigraphs within comments are not warned about).
3282 This warning is enabled by @option{-Wall}.
3284 @item -Wunused-function
3285 @opindex Wunused-function
3286 @opindex Wno-unused-function
3287 Warn whenever a static function is declared but not defined or a
3288 non-inline static function is unused.
3289 This warning is enabled by @option{-Wall}.
3291 @item -Wunused-label
3292 @opindex Wunused-label
3293 @opindex Wno-unused-label
3294 Warn whenever a label is declared but not used.
3295 This warning is enabled by @option{-Wall}.
3297 To suppress this warning use the @samp{unused} attribute
3298 (@pxref{Variable Attributes}).
3300 @item -Wunused-parameter
3301 @opindex Wunused-parameter
3302 @opindex Wno-unused-parameter
3303 Warn whenever a function parameter is unused aside from its declaration.
3305 To suppress this warning use the @samp{unused} attribute
3306 (@pxref{Variable Attributes}).
3308 @item -Wno-unused-result
3309 @opindex Wunused-result
3310 @opindex Wno-unused-result
3311 Do not warn if a caller of a function marked with attribute
3312 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3313 its return value. The default is @option{-Wunused-result}.
3315 @item -Wunused-variable
3316 @opindex Wunused-variable
3317 @opindex Wno-unused-variable
3318 Warn whenever a local variable or non-constant static variable is unused
3319 aside from its declaration.
3320 This warning is enabled by @option{-Wall}.
3322 To suppress this warning use the @samp{unused} attribute
3323 (@pxref{Variable Attributes}).
3325 @item -Wunused-value
3326 @opindex Wunused-value
3327 @opindex Wno-unused-value
3328 Warn whenever a statement computes a result that is explicitly not
3329 used. To suppress this warning cast the unused expression to
3330 @samp{void}. This includes an expression-statement or the left-hand
3331 side of a comma expression that contains no side effects. For example,
3332 an expression such as @samp{x[i,j]} will cause a warning, while
3333 @samp{x[(void)i,j]} will not.
3335 This warning is enabled by @option{-Wall}.
3337 @item -Wunused
3338 @opindex Wunused
3339 @opindex Wno-unused
3340 All the above @option{-Wunused} options combined.
3342 In order to get a warning about an unused function parameter, you must
3343 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3344 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3346 @item -Wuninitialized
3347 @opindex Wuninitialized
3348 @opindex Wno-uninitialized
3349 Warn if an automatic variable is used without first being initialized
3350 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3351 warn if a non-static reference or non-static @samp{const} member
3352 appears in a class without constructors.
3354 If you want to warn about code which uses the uninitialized value of the
3355 variable in its own initializer, use the @option{-Winit-self} option.
3357 These warnings occur for individual uninitialized or clobbered
3358 elements of structure, union or array variables as well as for
3359 variables which are uninitialized or clobbered as a whole.  They do
3360 not occur for variables or elements declared @code{volatile}.  Because
3361 these warnings depend on optimization, the exact variables or elements
3362 for which there are warnings will depend on the precise optimization
3363 options and version of GCC used.
3365 Note that there may be no warning about a variable that is used only
3366 to compute a value that itself is never used, because such
3367 computations may be deleted by data flow analysis before the warnings
3368 are printed.
3370 These warnings are made optional because GCC is not smart
3371 enough to see all the reasons why the code might be correct
3372 despite appearing to have an error.  Here is one example of how
3373 this can happen:
3375 @smallexample
3376 @group
3378   int x;
3379   switch (y)
3380     @{
3381     case 1: x = 1;
3382       break;
3383     case 2: x = 4;
3384       break;
3385     case 3: x = 5;
3386     @}
3387   foo (x);
3389 @end group
3390 @end smallexample
3392 @noindent
3393 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3394 always initialized, but GCC doesn't know this.  Here is
3395 another common case:
3397 @smallexample
3399   int save_y;
3400   if (change_y) save_y = y, y = new_y;
3401   @dots{}
3402   if (change_y) y = save_y;
3404 @end smallexample
3406 @noindent
3407 This has no bug because @code{save_y} is used only if it is set.
3409 @cindex @code{longjmp} warnings
3410 This option also warns when a non-volatile automatic variable might be
3411 changed by a call to @code{longjmp}.  These warnings as well are possible
3412 only in optimizing compilation.
3414 The compiler sees only the calls to @code{setjmp}.  It cannot know
3415 where @code{longjmp} will be called; in fact, a signal handler could
3416 call it at any point in the code.  As a result, you may get a warning
3417 even when there is in fact no problem because @code{longjmp} cannot
3418 in fact be called at the place which would cause a problem.
3420 Some spurious warnings can be avoided if you declare all the functions
3421 you use that never return as @code{noreturn}.  @xref{Function
3422 Attributes}.
3424 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3426 @item -Wunknown-pragmas
3427 @opindex Wunknown-pragmas
3428 @opindex Wno-unknown-pragmas
3429 @cindex warning for unknown pragmas
3430 @cindex unknown pragmas, warning
3431 @cindex pragmas, warning of unknown
3432 Warn when a #pragma directive is encountered which is not understood by
3433 GCC@.  If this command line option is used, warnings will even be issued
3434 for unknown pragmas in system header files.  This is not the case if
3435 the warnings were only enabled by the @option{-Wall} command line option.
3437 @item -Wno-pragmas
3438 @opindex Wno-pragmas
3439 @opindex Wpragmas
3440 Do not warn about misuses of pragmas, such as incorrect parameters,
3441 invalid syntax, or conflicts between pragmas.  See also
3442 @samp{-Wunknown-pragmas}.
3444 @item -Wstrict-aliasing
3445 @opindex Wstrict-aliasing
3446 @opindex Wno-strict-aliasing
3447 This option is only active when @option{-fstrict-aliasing} is active.
3448 It warns about code which might break the strict aliasing rules that the
3449 compiler is using for optimization.  The warning does not catch all
3450 cases, but does attempt to catch the more common pitfalls.  It is
3451 included in @option{-Wall}.
3452 It is equivalent to @option{-Wstrict-aliasing=3}
3454 @item -Wstrict-aliasing=n
3455 @opindex Wstrict-aliasing=n
3456 @opindex Wno-strict-aliasing=n
3457 This option is only active when @option{-fstrict-aliasing} is active.
3458 It warns about code which might break the strict aliasing rules that the
3459 compiler is using for optimization.
3460 Higher levels correspond to higher accuracy (fewer false positives).
3461 Higher levels also correspond to more effort, similar to the way -O works.
3462 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3463 with n=3.
3465 Level 1: Most aggressive, quick, least accurate.
3466 Possibly useful when higher levels
3467 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3468 false negatives.  However, it has many false positives.
3469 Warns for all pointer conversions between possibly incompatible types,
3470 even if never dereferenced.  Runs in the frontend only.
3472 Level 2: Aggressive, quick, not too precise.
3473 May still have many false positives (not as many as level 1 though),
3474 and few false negatives (but possibly more than level 1).
3475 Unlike level 1, it only warns when an address is taken.  Warns about
3476 incomplete types.  Runs in the frontend only.
3478 Level 3 (default for @option{-Wstrict-aliasing}):
3479 Should have very few false positives and few false
3480 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3481 Takes care of the common punn+dereference pattern in the frontend:
3482 @code{*(int*)&some_float}.
3483 If optimization is enabled, it also runs in the backend, where it deals
3484 with multiple statement cases using flow-sensitive points-to information.
3485 Only warns when the converted pointer is dereferenced.
3486 Does not warn about incomplete types.
3488 @item -Wstrict-overflow
3489 @itemx -Wstrict-overflow=@var{n}
3490 @opindex Wstrict-overflow
3491 @opindex Wno-strict-overflow
3492 This option is only active when @option{-fstrict-overflow} is active.
3493 It warns about cases where the compiler optimizes based on the
3494 assumption that signed overflow does not occur.  Note that it does not
3495 warn about all cases where the code might overflow: it only warns
3496 about cases where the compiler implements some optimization.  Thus
3497 this warning depends on the optimization level.
3499 An optimization which assumes that signed overflow does not occur is
3500 perfectly safe if the values of the variables involved are such that
3501 overflow never does, in fact, occur.  Therefore this warning can
3502 easily give a false positive: a warning about code which is not
3503 actually a problem.  To help focus on important issues, several
3504 warning levels are defined.  No warnings are issued for the use of
3505 undefined signed overflow when estimating how many iterations a loop
3506 will require, in particular when determining whether a loop will be
3507 executed at all.
3509 @table @gcctabopt
3510 @item -Wstrict-overflow=1
3511 Warn about cases which are both questionable and easy to avoid.  For
3512 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3513 compiler will simplify this to @code{1}.  This level of
3514 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3515 are not, and must be explicitly requested.
3517 @item -Wstrict-overflow=2
3518 Also warn about other cases where a comparison is simplified to a
3519 constant.  For example: @code{abs (x) >= 0}.  This can only be
3520 simplified when @option{-fstrict-overflow} is in effect, because
3521 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3522 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3523 @option{-Wstrict-overflow=2}.
3525 @item -Wstrict-overflow=3
3526 Also warn about other cases where a comparison is simplified.  For
3527 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3529 @item -Wstrict-overflow=4
3530 Also warn about other simplifications not covered by the above cases.
3531 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3533 @item -Wstrict-overflow=5
3534 Also warn about cases where the compiler reduces the magnitude of a
3535 constant involved in a comparison.  For example: @code{x + 2 > y} will
3536 be simplified to @code{x + 1 >= y}.  This is reported only at the
3537 highest warning level because this simplification applies to many
3538 comparisons, so this warning level will give a very large number of
3539 false positives.
3540 @end table
3542 @item -Warray-bounds
3543 @opindex Wno-array-bounds
3544 @opindex Warray-bounds
3545 This option is only active when @option{-ftree-vrp} is active
3546 (default for -O2 and above). It warns about subscripts to arrays
3547 that are always out of bounds. This warning is enabled by @option{-Wall}.
3549 @item -Wno-div-by-zero
3550 @opindex Wno-div-by-zero
3551 @opindex Wdiv-by-zero
3552 Do not warn about compile-time integer division by zero.  Floating point
3553 division by zero is not warned about, as it can be a legitimate way of
3554 obtaining infinities and NaNs.
3556 @item -Wsystem-headers
3557 @opindex Wsystem-headers
3558 @opindex Wno-system-headers
3559 @cindex warnings from system headers
3560 @cindex system headers, warnings from
3561 Print warning messages for constructs found in system header files.
3562 Warnings from system headers are normally suppressed, on the assumption
3563 that they usually do not indicate real problems and would only make the
3564 compiler output harder to read.  Using this command line option tells
3565 GCC to emit warnings from system headers as if they occurred in user
3566 code.  However, note that using @option{-Wall} in conjunction with this
3567 option will @emph{not} warn about unknown pragmas in system
3568 headers---for that, @option{-Wunknown-pragmas} must also be used.
3570 @item -Wfloat-equal
3571 @opindex Wfloat-equal
3572 @opindex Wno-float-equal
3573 Warn if floating point values are used in equality comparisons.
3575 The idea behind this is that sometimes it is convenient (for the
3576 programmer) to consider floating-point values as approximations to
3577 infinitely precise real numbers.  If you are doing this, then you need
3578 to compute (by analyzing the code, or in some other way) the maximum or
3579 likely maximum error that the computation introduces, and allow for it
3580 when performing comparisons (and when producing output, but that's a
3581 different problem).  In particular, instead of testing for equality, you
3582 would check to see whether the two values have ranges that overlap; and
3583 this is done with the relational operators, so equality comparisons are
3584 probably mistaken.
3586 @item -Wtraditional @r{(C and Objective-C only)}
3587 @opindex Wtraditional
3588 @opindex Wno-traditional
3589 Warn about certain constructs that behave differently in traditional and
3590 ISO C@.  Also warn about ISO C constructs that have no traditional C
3591 equivalent, and/or problematic constructs which should be avoided.
3593 @itemize @bullet
3594 @item
3595 Macro parameters that appear within string literals in the macro body.
3596 In traditional C macro replacement takes place within string literals,
3597 but does not in ISO C@.
3599 @item
3600 In traditional C, some preprocessor directives did not exist.
3601 Traditional preprocessors would only consider a line to be a directive
3602 if the @samp{#} appeared in column 1 on the line.  Therefore
3603 @option{-Wtraditional} warns about directives that traditional C
3604 understands but would ignore because the @samp{#} does not appear as the
3605 first character on the line.  It also suggests you hide directives like
3606 @samp{#pragma} not understood by traditional C by indenting them.  Some
3607 traditional implementations would not recognize @samp{#elif}, so it
3608 suggests avoiding it altogether.
3610 @item
3611 A function-like macro that appears without arguments.
3613 @item
3614 The unary plus operator.
3616 @item
3617 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3618 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3619 constants.)  Note, these suffixes appear in macros defined in the system
3620 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3621 Use of these macros in user code might normally lead to spurious
3622 warnings, however GCC's integrated preprocessor has enough context to
3623 avoid warning in these cases.
3625 @item
3626 A function declared external in one block and then used after the end of
3627 the block.
3629 @item
3630 A @code{switch} statement has an operand of type @code{long}.
3632 @item
3633 A non-@code{static} function declaration follows a @code{static} one.
3634 This construct is not accepted by some traditional C compilers.
3636 @item
3637 The ISO type of an integer constant has a different width or
3638 signedness from its traditional type.  This warning is only issued if
3639 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3640 typically represent bit patterns, are not warned about.
3642 @item
3643 Usage of ISO string concatenation is detected.
3645 @item
3646 Initialization of automatic aggregates.
3648 @item
3649 Identifier conflicts with labels.  Traditional C lacks a separate
3650 namespace for labels.
3652 @item
3653 Initialization of unions.  If the initializer is zero, the warning is
3654 omitted.  This is done under the assumption that the zero initializer in
3655 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3656 initializer warnings and relies on default initialization to zero in the
3657 traditional C case.
3659 @item
3660 Conversions by prototypes between fixed/floating point values and vice
3661 versa.  The absence of these prototypes when compiling with traditional
3662 C would cause serious problems.  This is a subset of the possible
3663 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3665 @item
3666 Use of ISO C style function definitions.  This warning intentionally is
3667 @emph{not} issued for prototype declarations or variadic functions
3668 because these ISO C features will appear in your code when using
3669 libiberty's traditional C compatibility macros, @code{PARAMS} and
3670 @code{VPARAMS}.  This warning is also bypassed for nested functions
3671 because that feature is already a GCC extension and thus not relevant to
3672 traditional C compatibility.
3673 @end itemize
3675 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3676 @opindex Wtraditional-conversion
3677 @opindex Wno-traditional-conversion
3678 Warn if a prototype causes a type conversion that is different from what
3679 would happen to the same argument in the absence of a prototype.  This
3680 includes conversions of fixed point to floating and vice versa, and
3681 conversions changing the width or signedness of a fixed point argument
3682 except when the same as the default promotion.
3684 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3685 @opindex Wdeclaration-after-statement
3686 @opindex Wno-declaration-after-statement
3687 Warn when a declaration is found after a statement in a block.  This
3688 construct, known from C++, was introduced with ISO C99 and is by default
3689 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3690 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3692 @item -Wundef
3693 @opindex Wundef
3694 @opindex Wno-undef
3695 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3697 @item -Wno-endif-labels
3698 @opindex Wno-endif-labels
3699 @opindex Wendif-labels
3700 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3702 @item -Wshadow
3703 @opindex Wshadow
3704 @opindex Wno-shadow
3705 Warn whenever a local variable shadows another local variable, parameter or
3706 global variable or whenever a built-in function is shadowed.
3708 @item -Wlarger-than=@var{len}
3709 @opindex Wlarger-than=@var{len}
3710 @opindex Wlarger-than-@var{len}
3711 Warn whenever an object of larger than @var{len} bytes is defined.
3713 @item -Wframe-larger-than=@var{len}
3714 @opindex Wframe-larger-than
3715 Warn if the size of a function frame is larger than @var{len} bytes.
3716 The computation done to determine the stack frame size is approximate
3717 and not conservative.
3718 The actual requirements may be somewhat greater than @var{len}
3719 even if you do not get a warning.  In addition, any space allocated
3720 via @code{alloca}, variable-length arrays, or related constructs
3721 is not included by the compiler when determining
3722 whether or not to issue a warning.
3724 @item -Wunsafe-loop-optimizations
3725 @opindex Wunsafe-loop-optimizations
3726 @opindex Wno-unsafe-loop-optimizations
3727 Warn if the loop cannot be optimized because the compiler could not
3728 assume anything on the bounds of the loop indices.  With
3729 @option{-funsafe-loop-optimizations} warn if the compiler made
3730 such assumptions.
3732 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3733 @opindex Wno-pedantic-ms-format
3734 @opindex Wpedantic-ms-format
3735 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3736 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3737 depending on the MS runtime, when you are using the options @option{-Wformat}
3738 and @option{-pedantic} without gnu-extensions.
3740 @item -Wpointer-arith
3741 @opindex Wpointer-arith
3742 @opindex Wno-pointer-arith
3743 Warn about anything that depends on the ``size of'' a function type or
3744 of @code{void}.  GNU C assigns these types a size of 1, for
3745 convenience in calculations with @code{void *} pointers and pointers
3746 to functions.  In C++, warn also when an arithmetic operation involves
3747 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3749 @item -Wtype-limits
3750 @opindex Wtype-limits
3751 @opindex Wno-type-limits
3752 Warn if a comparison is always true or always false due to the limited
3753 range of the data type, but do not warn for constant expressions.  For
3754 example, warn if an unsigned variable is compared against zero with
3755 @samp{<} or @samp{>=}.  This warning is also enabled by
3756 @option{-Wextra}.
3758 @item -Wbad-function-cast @r{(C and Objective-C only)}
3759 @opindex Wbad-function-cast
3760 @opindex Wno-bad-function-cast
3761 Warn whenever a function call is cast to a non-matching type.
3762 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3764 @item -Wc++-compat @r{(C and Objective-C only)}
3765 Warn about ISO C constructs that are outside of the common subset of
3766 ISO C and ISO C++, e.g.@: request for implicit conversion from
3767 @code{void *} to a pointer to non-@code{void} type.
3769 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3770 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3771 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3772 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3774 @item -Wcast-qual
3775 @opindex Wcast-qual
3776 @opindex Wno-cast-qual
3777 Warn whenever a pointer is cast so as to remove a type qualifier from
3778 the target type.  For example, warn if a @code{const char *} is cast
3779 to an ordinary @code{char *}.
3781 Also warn when making a cast which introduces a type qualifier in an
3782 unsafe way.  For example, casting @code{char **} to @code{const char **}
3783 is unsafe, as in this example:
3785 @smallexample
3786   /* p is char ** value.  */
3787   const char **q = (const char **) p;
3788   /* Assignment of readonly string to const char * is OK.  */
3789   *q = "string";
3790   /* Now char** pointer points to read-only memory.  */
3791   **p = 'b';
3792 @end smallexample
3794 @item -Wcast-align
3795 @opindex Wcast-align
3796 @opindex Wno-cast-align
3797 Warn whenever a pointer is cast such that the required alignment of the
3798 target is increased.  For example, warn if a @code{char *} is cast to
3799 an @code{int *} on machines where integers can only be accessed at
3800 two- or four-byte boundaries.
3802 @item -Wwrite-strings
3803 @opindex Wwrite-strings
3804 @opindex Wno-write-strings
3805 When compiling C, give string constants the type @code{const
3806 char[@var{length}]} so that copying the address of one into a
3807 non-@code{const} @code{char *} pointer will get a warning.  These
3808 warnings will help you find at compile time code that can try to write
3809 into a string constant, but only if you have been very careful about
3810 using @code{const} in declarations and prototypes.  Otherwise, it will
3811 just be a nuisance. This is why we did not make @option{-Wall} request
3812 these warnings.
3814 When compiling C++, warn about the deprecated conversion from string
3815 literals to @code{char *}.  This warning is enabled by default for C++
3816 programs.
3818 @item -Wclobbered
3819 @opindex Wclobbered
3820 @opindex Wno-clobbered
3821 Warn for variables that might be changed by @samp{longjmp} or
3822 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3824 @item -Wconversion
3825 @opindex Wconversion
3826 @opindex Wno-conversion
3827 Warn for implicit conversions that may alter a value. This includes
3828 conversions between real and integer, like @code{abs (x)} when
3829 @code{x} is @code{double}; conversions between signed and unsigned,
3830 like @code{unsigned ui = -1}; and conversions to smaller types, like
3831 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3832 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3833 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3834 conversions between signed and unsigned integers can be disabled by
3835 using @option{-Wno-sign-conversion}.
3837 For C++, also warn for conversions between @code{NULL} and non-pointer
3838 types; confusing overload resolution for user-defined conversions; and
3839 conversions that will never use a type conversion operator:
3840 conversions to @code{void}, the same type, a base class or a reference
3841 to them. Warnings about conversions between signed and unsigned
3842 integers are disabled by default in C++ unless
3843 @option{-Wsign-conversion} is explicitly enabled.
3845 @item -Wempty-body
3846 @opindex Wempty-body
3847 @opindex Wno-empty-body
3848 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3849 while} statement.  This warning is also enabled by @option{-Wextra}.
3851 @item -Wenum-compare
3852 @opindex Wenum-compare
3853 @opindex Wno-enum-compare
3854 Warn about a comparison between values of different enum types. In C++
3855 this warning is enabled by default.  In C this warning is enabled by
3856 @option{-Wall}.
3858 @item -Wjump-misses-init @r{(C, Objective-C only)}
3859 @opindex Wjump-misses-init
3860 @opindex Wno-jump-misses-init
3861 Warn if a @code{goto} statement or a @code{switch} statement jumps
3862 forward across the initialization of a variable, or jumps backward to a
3863 label after the variable has been initialized.  This only warns about
3864 variables which are initialized when they are declared.  This warning is
3865 only supported for C and Objective C; in C++ this sort of branch is an
3866 error in any case.
3868 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
3869 can be disabled with the @option{-Wno-jump-misses-init} option.
3871 @item -Wsign-compare
3872 @opindex Wsign-compare
3873 @opindex Wno-sign-compare
3874 @cindex warning for comparison of signed and unsigned values
3875 @cindex comparison of signed and unsigned values, warning
3876 @cindex signed and unsigned values, comparison warning
3877 Warn when a comparison between signed and unsigned values could produce
3878 an incorrect result when the signed value is converted to unsigned.
3879 This warning is also enabled by @option{-Wextra}; to get the other warnings
3880 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3882 @item -Wsign-conversion
3883 @opindex Wsign-conversion
3884 @opindex Wno-sign-conversion
3885 Warn for implicit conversions that may change the sign of an integer
3886 value, like assigning a signed integer expression to an unsigned
3887 integer variable. An explicit cast silences the warning. In C, this
3888 option is enabled also by @option{-Wconversion}.
3890 @item -Waddress
3891 @opindex Waddress
3892 @opindex Wno-address
3893 Warn about suspicious uses of memory addresses. These include using
3894 the address of a function in a conditional expression, such as
3895 @code{void func(void); if (func)}, and comparisons against the memory
3896 address of a string literal, such as @code{if (x == "abc")}.  Such
3897 uses typically indicate a programmer error: the address of a function
3898 always evaluates to true, so their use in a conditional usually
3899 indicate that the programmer forgot the parentheses in a function
3900 call; and comparisons against string literals result in unspecified
3901 behavior and are not portable in C, so they usually indicate that the
3902 programmer intended to use @code{strcmp}.  This warning is enabled by
3903 @option{-Wall}.
3905 @item -Wlogical-op
3906 @opindex Wlogical-op
3907 @opindex Wno-logical-op
3908 Warn about suspicious uses of logical operators in expressions.
3909 This includes using logical operators in contexts where a
3910 bit-wise operator is likely to be expected.
3912 @item -Waggregate-return
3913 @opindex Waggregate-return
3914 @opindex Wno-aggregate-return
3915 Warn if any functions that return structures or unions are defined or
3916 called.  (In languages where you can return an array, this also elicits
3917 a warning.)
3919 @item -Wno-attributes
3920 @opindex Wno-attributes
3921 @opindex Wattributes
3922 Do not warn if an unexpected @code{__attribute__} is used, such as
3923 unrecognized attributes, function attributes applied to variables,
3924 etc.  This will not stop errors for incorrect use of supported
3925 attributes.
3927 @item -Wno-builtin-macro-redefined
3928 @opindex Wno-builtin-macro-redefined
3929 @opindex Wbuiltin-macro-redefined
3930 Do not warn if certain built-in macros are redefined.  This suppresses
3931 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3932 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3934 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3935 @opindex Wstrict-prototypes
3936 @opindex Wno-strict-prototypes
3937 Warn if a function is declared or defined without specifying the
3938 argument types.  (An old-style function definition is permitted without
3939 a warning if preceded by a declaration which specifies the argument
3940 types.)
3942 @item -Wold-style-declaration @r{(C and Objective-C only)}
3943 @opindex Wold-style-declaration
3944 @opindex Wno-old-style-declaration
3945 Warn for obsolescent usages, according to the C Standard, in a
3946 declaration. For example, warn if storage-class specifiers like
3947 @code{static} are not the first things in a declaration.  This warning
3948 is also enabled by @option{-Wextra}.
3950 @item -Wold-style-definition @r{(C and Objective-C only)}
3951 @opindex Wold-style-definition
3952 @opindex Wno-old-style-definition
3953 Warn if an old-style function definition is used.  A warning is given
3954 even if there is a previous prototype.
3956 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3957 @opindex Wmissing-parameter-type
3958 @opindex Wno-missing-parameter-type
3959 A function parameter is declared without a type specifier in K&R-style
3960 functions:
3962 @smallexample
3963 void foo(bar) @{ @}
3964 @end smallexample
3966 This warning is also enabled by @option{-Wextra}.
3968 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3969 @opindex Wmissing-prototypes
3970 @opindex Wno-missing-prototypes
3971 Warn if a global function is defined without a previous prototype
3972 declaration.  This warning is issued even if the definition itself
3973 provides a prototype.  The aim is to detect global functions that fail
3974 to be declared in header files.
3976 @item -Wmissing-declarations
3977 @opindex Wmissing-declarations
3978 @opindex Wno-missing-declarations
3979 Warn if a global function is defined without a previous declaration.
3980 Do so even if the definition itself provides a prototype.
3981 Use this option to detect global functions that are not declared in
3982 header files.  In C++, no warnings are issued for function templates,
3983 or for inline functions, or for functions in anonymous namespaces.
3985 @item -Wmissing-field-initializers
3986 @opindex Wmissing-field-initializers
3987 @opindex Wno-missing-field-initializers
3988 @opindex W
3989 @opindex Wextra
3990 @opindex Wno-extra
3991 Warn if a structure's initializer has some fields missing.  For
3992 example, the following code would cause such a warning, because
3993 @code{x.h} is implicitly zero:
3995 @smallexample
3996 struct s @{ int f, g, h; @};
3997 struct s x = @{ 3, 4 @};
3998 @end smallexample
4000 This option does not warn about designated initializers, so the following
4001 modification would not trigger a warning:
4003 @smallexample
4004 struct s @{ int f, g, h; @};
4005 struct s x = @{ .f = 3, .g = 4 @};
4006 @end smallexample
4008 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4009 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4011 @item -Wmissing-noreturn
4012 @opindex Wmissing-noreturn
4013 @opindex Wno-missing-noreturn
4014 Warn about functions which might be candidates for attribute @code{noreturn}.
4015 Note these are only possible candidates, not absolute ones.  Care should
4016 be taken to manually verify functions actually do not ever return before
4017 adding the @code{noreturn} attribute, otherwise subtle code generation
4018 bugs could be introduced.  You will not get a warning for @code{main} in
4019 hosted C environments.
4021 @item -Wmissing-format-attribute
4022 @opindex Wmissing-format-attribute
4023 @opindex Wno-missing-format-attribute
4024 @opindex Wformat
4025 @opindex Wno-format
4026 Warn about function pointers which might be candidates for @code{format}
4027 attributes.  Note these are only possible candidates, not absolute ones.
4028 GCC will guess that function pointers with @code{format} attributes that
4029 are used in assignment, initialization, parameter passing or return
4030 statements should have a corresponding @code{format} attribute in the
4031 resulting type.  I.e.@: the left-hand side of the assignment or
4032 initialization, the type of the parameter variable, or the return type
4033 of the containing function respectively should also have a @code{format}
4034 attribute to avoid the warning.
4036 GCC will also warn about function definitions which might be
4037 candidates for @code{format} attributes.  Again, these are only
4038 possible candidates.  GCC will guess that @code{format} attributes
4039 might be appropriate for any function that calls a function like
4040 @code{vprintf} or @code{vscanf}, but this might not always be the
4041 case, and some functions for which @code{format} attributes are
4042 appropriate may not be detected.
4044 @item -Wno-multichar
4045 @opindex Wno-multichar
4046 @opindex Wmultichar
4047 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4048 Usually they indicate a typo in the user's code, as they have
4049 implementation-defined values, and should not be used in portable code.
4051 @item -Wnormalized=<none|id|nfc|nfkc>
4052 @opindex Wnormalized=
4053 @cindex NFC
4054 @cindex NFKC
4055 @cindex character set, input normalization
4056 In ISO C and ISO C++, two identifiers are different if they are
4057 different sequences of characters.  However, sometimes when characters
4058 outside the basic ASCII character set are used, you can have two
4059 different character sequences that look the same.  To avoid confusion,
4060 the ISO 10646 standard sets out some @dfn{normalization rules} which
4061 when applied ensure that two sequences that look the same are turned into
4062 the same sequence.  GCC can warn you if you are using identifiers which
4063 have not been normalized; this option controls that warning.
4065 There are four levels of warning that GCC supports.  The default is
4066 @option{-Wnormalized=nfc}, which warns about any identifier which is
4067 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4068 recommended form for most uses.
4070 Unfortunately, there are some characters which ISO C and ISO C++ allow
4071 in identifiers that when turned into NFC aren't allowable as
4072 identifiers.  That is, there's no way to use these symbols in portable
4073 ISO C or C++ and have all your identifiers in NFC@.
4074 @option{-Wnormalized=id} suppresses the warning for these characters.
4075 It is hoped that future versions of the standards involved will correct
4076 this, which is why this option is not the default.
4078 You can switch the warning off for all characters by writing
4079 @option{-Wnormalized=none}.  You would only want to do this if you
4080 were using some other normalization scheme (like ``D''), because
4081 otherwise you can easily create bugs that are literally impossible to see.
4083 Some characters in ISO 10646 have distinct meanings but look identical
4084 in some fonts or display methodologies, especially once formatting has
4085 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4086 LETTER N'', will display just like a regular @code{n} which has been
4087 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4088 normalization scheme to convert all these into a standard form as
4089 well, and GCC will warn if your code is not in NFKC if you use
4090 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4091 about every identifier that contains the letter O because it might be
4092 confused with the digit 0, and so is not the default, but may be
4093 useful as a local coding convention if the programming environment is
4094 unable to be fixed to display these characters distinctly.
4096 @item -Wno-deprecated
4097 @opindex Wno-deprecated
4098 @opindex Wdeprecated
4099 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4101 @item -Wno-deprecated-declarations
4102 @opindex Wno-deprecated-declarations
4103 @opindex Wdeprecated-declarations
4104 Do not warn about uses of functions (@pxref{Function Attributes}),
4105 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4106 Attributes}) marked as deprecated by using the @code{deprecated}
4107 attribute.
4109 @item -Wno-overflow
4110 @opindex Wno-overflow
4111 @opindex Woverflow
4112 Do not warn about compile-time overflow in constant expressions.
4114 @item -Woverride-init @r{(C and Objective-C only)}
4115 @opindex Woverride-init
4116 @opindex Wno-override-init
4117 @opindex W
4118 @opindex Wextra
4119 @opindex Wno-extra
4120 Warn if an initialized field without side effects is overridden when
4121 using designated initializers (@pxref{Designated Inits, , Designated
4122 Initializers}).
4124 This warning is included in @option{-Wextra}.  To get other
4125 @option{-Wextra} warnings without this one, use @samp{-Wextra
4126 -Wno-override-init}.
4128 @item -Wpacked
4129 @opindex Wpacked
4130 @opindex Wno-packed
4131 Warn if a structure is given the packed attribute, but the packed
4132 attribute has no effect on the layout or size of the structure.
4133 Such structures may be mis-aligned for little benefit.  For
4134 instance, in this code, the variable @code{f.x} in @code{struct bar}
4135 will be misaligned even though @code{struct bar} does not itself
4136 have the packed attribute:
4138 @smallexample
4139 @group
4140 struct foo @{
4141   int x;
4142   char a, b, c, d;
4143 @} __attribute__((packed));
4144 struct bar @{
4145   char z;
4146   struct foo f;
4148 @end group
4149 @end smallexample
4151 @item -Wpacked-bitfield-compat
4152 @opindex Wpacked-bitfield-compat
4153 @opindex Wno-packed-bitfield-compat
4154 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4155 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4156 the change can lead to differences in the structure layout.  GCC
4157 informs you when the offset of such a field has changed in GCC 4.4.
4158 For example there is no longer a 4-bit padding between field @code{a}
4159 and @code{b} in this structure:
4161 @smallexample
4162 struct foo
4164   char a:4;
4165   char b:8;
4166 @} __attribute__ ((packed));
4167 @end smallexample
4169 This warning is enabled by default.  Use
4170 @option{-Wno-packed-bitfield-compat} to disable this warning.
4172 @item -Wpadded
4173 @opindex Wpadded
4174 @opindex Wno-padded
4175 Warn if padding is included in a structure, either to align an element
4176 of the structure or to align the whole structure.  Sometimes when this
4177 happens it is possible to rearrange the fields of the structure to
4178 reduce the padding and so make the structure smaller.
4180 @item -Wredundant-decls
4181 @opindex Wredundant-decls
4182 @opindex Wno-redundant-decls
4183 Warn if anything is declared more than once in the same scope, even in
4184 cases where multiple declaration is valid and changes nothing.
4186 @item -Wnested-externs @r{(C and Objective-C only)}
4187 @opindex Wnested-externs
4188 @opindex Wno-nested-externs
4189 Warn if an @code{extern} declaration is encountered within a function.
4191 @item -Wunreachable-code
4192 @opindex Wunreachable-code
4193 @opindex Wno-unreachable-code
4194 Warn if the compiler detects that code will never be executed.
4196 This option is intended to warn when the compiler detects that at
4197 least a whole line of source code will never be executed, because
4198 some condition is never satisfied or because it is after a
4199 procedure that never returns.
4201 It is possible for this option to produce a warning even though there
4202 are circumstances under which part of the affected line can be executed,
4203 so care should be taken when removing apparently-unreachable code.
4205 For instance, when a function is inlined, a warning may mean that the
4206 line is unreachable in only one inlined copy of the function.
4208 This option is not made part of @option{-Wall} because in a debugging
4209 version of a program there is often substantial code which checks
4210 correct functioning of the program and is, hopefully, unreachable
4211 because the program does work.  Another common use of unreachable
4212 code is to provide behavior which is selectable at compile-time.
4214 @item -Winline
4215 @opindex Winline
4216 @opindex Wno-inline
4217 Warn if a function can not be inlined and it was declared as inline.
4218 Even with this option, the compiler will not warn about failures to
4219 inline functions declared in system headers.
4221 The compiler uses a variety of heuristics to determine whether or not
4222 to inline a function.  For example, the compiler takes into account
4223 the size of the function being inlined and the amount of inlining
4224 that has already been done in the current function.  Therefore,
4225 seemingly insignificant changes in the source program can cause the
4226 warnings produced by @option{-Winline} to appear or disappear.
4228 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4229 @opindex Wno-invalid-offsetof
4230 @opindex Winvalid-offsetof
4231 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4232 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4233 to a non-POD type is undefined.  In existing C++ implementations,
4234 however, @samp{offsetof} typically gives meaningful results even when
4235 applied to certain kinds of non-POD types. (Such as a simple
4236 @samp{struct} that fails to be a POD type only by virtue of having a
4237 constructor.)  This flag is for users who are aware that they are
4238 writing nonportable code and who have deliberately chosen to ignore the
4239 warning about it.
4241 The restrictions on @samp{offsetof} may be relaxed in a future version
4242 of the C++ standard.
4244 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4245 @opindex Wno-int-to-pointer-cast
4246 @opindex Wint-to-pointer-cast
4247 Suppress warnings from casts to pointer type of an integer of a
4248 different size.
4250 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4251 @opindex Wno-pointer-to-int-cast
4252 @opindex Wpointer-to-int-cast
4253 Suppress warnings from casts from a pointer to an integer type of a
4254 different size.
4256 @item -Winvalid-pch
4257 @opindex Winvalid-pch
4258 @opindex Wno-invalid-pch
4259 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4260 the search path but can't be used.
4262 @item -Wlong-long
4263 @opindex Wlong-long
4264 @opindex Wno-long-long
4265 Warn if @samp{long long} type is used.  This is enabled by either
4266 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4267 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4269 @item -Wvariadic-macros
4270 @opindex Wvariadic-macros
4271 @opindex Wno-variadic-macros
4272 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4273 alternate syntax when in pedantic ISO C99 mode.  This is default.
4274 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4276 @item -Wvla
4277 @opindex Wvla
4278 @opindex Wno-vla
4279 Warn if variable length array is used in the code.
4280 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4281 the variable length array.
4283 @item -Wvolatile-register-var
4284 @opindex Wvolatile-register-var
4285 @opindex Wno-volatile-register-var
4286 Warn if a register variable is declared volatile.  The volatile
4287 modifier does not inhibit all optimizations that may eliminate reads
4288 and/or writes to register variables.  This warning is enabled by
4289 @option{-Wall}.
4291 @item -Wdisabled-optimization
4292 @opindex Wdisabled-optimization
4293 @opindex Wno-disabled-optimization
4294 Warn if a requested optimization pass is disabled.  This warning does
4295 not generally indicate that there is anything wrong with your code; it
4296 merely indicates that GCC's optimizers were unable to handle the code
4297 effectively.  Often, the problem is that your code is too big or too
4298 complex; GCC will refuse to optimize programs when the optimization
4299 itself is likely to take inordinate amounts of time.
4301 @item -Wpointer-sign @r{(C and Objective-C only)}
4302 @opindex Wpointer-sign
4303 @opindex Wno-pointer-sign
4304 Warn for pointer argument passing or assignment with different signedness.
4305 This option is only supported for C and Objective-C@.  It is implied by
4306 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4307 @option{-Wno-pointer-sign}.
4309 @item -Wstack-protector
4310 @opindex Wstack-protector
4311 @opindex Wno-stack-protector
4312 This option is only active when @option{-fstack-protector} is active.  It
4313 warns about functions that will not be protected against stack smashing.
4315 @item -Wno-mudflap
4316 @opindex Wno-mudflap
4317 Suppress warnings about constructs that cannot be instrumented by
4318 @option{-fmudflap}.
4320 @item -Woverlength-strings
4321 @opindex Woverlength-strings
4322 @opindex Wno-overlength-strings
4323 Warn about string constants which are longer than the ``minimum
4324 maximum'' length specified in the C standard.  Modern compilers
4325 generally allow string constants which are much longer than the
4326 standard's minimum limit, but very portable programs should avoid
4327 using longer strings.
4329 The limit applies @emph{after} string constant concatenation, and does
4330 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4331 C99, it was raised to 4095.  C++98 does not specify a normative
4332 minimum maximum, so we do not diagnose overlength strings in C++@.
4334 This option is implied by @option{-pedantic}, and can be disabled with
4335 @option{-Wno-overlength-strings}.
4337 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4338 @opindex Wunsuffixed-float-constants
4340 GCC will issue a warning for any floating constant that does not have
4341 a suffix.  When used together with @option{-Wsystem-headers} it will
4342 warn about such constants in system header files.  This can be useful
4343 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4344 from the decimal floating-point extension to C99.
4345 @end table
4347 @node Debugging Options
4348 @section Options for Debugging Your Program or GCC
4349 @cindex options, debugging
4350 @cindex debugging information options
4352 GCC has various special options that are used for debugging
4353 either your program or GCC:
4355 @table @gcctabopt
4356 @item -g
4357 @opindex g
4358 Produce debugging information in the operating system's native format
4359 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4360 information.
4362 On most systems that use stabs format, @option{-g} enables use of extra
4363 debugging information that only GDB can use; this extra information
4364 makes debugging work better in GDB but will probably make other debuggers
4365 crash or
4366 refuse to read the program.  If you want to control for certain whether
4367 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4368 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4370 GCC allows you to use @option{-g} with
4371 @option{-O}.  The shortcuts taken by optimized code may occasionally
4372 produce surprising results: some variables you declared may not exist
4373 at all; flow of control may briefly move where you did not expect it;
4374 some statements may not be executed because they compute constant
4375 results or their values were already at hand; some statements may
4376 execute in different places because they were moved out of loops.
4378 Nevertheless it proves possible to debug optimized output.  This makes
4379 it reasonable to use the optimizer for programs that might have bugs.
4381 The following options are useful when GCC is generated with the
4382 capability for more than one debugging format.
4384 @item -ggdb
4385 @opindex ggdb
4386 Produce debugging information for use by GDB@.  This means to use the
4387 most expressive format available (DWARF 2, stabs, or the native format
4388 if neither of those are supported), including GDB extensions if at all
4389 possible.
4391 @item -gstabs
4392 @opindex gstabs
4393 Produce debugging information in stabs format (if that is supported),
4394 without GDB extensions.  This is the format used by DBX on most BSD
4395 systems.  On MIPS, Alpha and System V Release 4 systems this option
4396 produces stabs debugging output which is not understood by DBX or SDB@.
4397 On System V Release 4 systems this option requires the GNU assembler.
4399 @item -feliminate-unused-debug-symbols
4400 @opindex feliminate-unused-debug-symbols
4401 Produce debugging information in stabs format (if that is supported),
4402 for only symbols that are actually used.
4404 @item -femit-class-debug-always
4405 Instead of emitting debugging information for a C++ class in only one
4406 object file, emit it in all object files using the class.  This option
4407 should be used only with debuggers that are unable to handle the way GCC
4408 normally emits debugging information for classes because using this
4409 option will increase the size of debugging information by as much as a
4410 factor of two.
4412 @item -gstabs+
4413 @opindex gstabs+
4414 Produce debugging information in stabs format (if that is supported),
4415 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4416 use of these extensions is likely to make other debuggers crash or
4417 refuse to read the program.
4419 @item -gcoff
4420 @opindex gcoff
4421 Produce debugging information in COFF format (if that is supported).
4422 This is the format used by SDB on most System V systems prior to
4423 System V Release 4.
4425 @item -gxcoff
4426 @opindex gxcoff
4427 Produce debugging information in XCOFF format (if that is supported).
4428 This is the format used by the DBX debugger on IBM RS/6000 systems.
4430 @item -gxcoff+
4431 @opindex gxcoff+
4432 Produce debugging information in XCOFF format (if that is supported),
4433 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4434 use of these extensions is likely to make other debuggers crash or
4435 refuse to read the program, and may cause assemblers other than the GNU
4436 assembler (GAS) to fail with an error.
4438 @item -gdwarf-@var{version}
4439 @opindex gdwarf-@var{version}
4440 Produce debugging information in DWARF format (if that is
4441 supported).  This is the format used by DBX on IRIX 6.  The value
4442 of @var{version} may be either 2, 3 or 4; the default version is 2.
4444 Note that with DWARF version 2 some ports require, and will always
4445 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4447 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4448 for maximum benefit.
4450 @item -gstrict-dwarf
4451 @opindex gstrict-dwarf
4452 Disallow using extensions of later DWARF standard version than selected
4453 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4454 DWARF extensions from later standard versions is allowed.
4456 @item -gno-strict-dwarf
4457 @opindex gno-strict-dwarf
4458 Allow using extensions of later DWARF standard version than selected with
4459 @option{-gdwarf-@var{version}}.
4461 @item -gvms
4462 @opindex gvms
4463 Produce debugging information in VMS debug format (if that is
4464 supported).  This is the format used by DEBUG on VMS systems.
4466 @item -g@var{level}
4467 @itemx -ggdb@var{level}
4468 @itemx -gstabs@var{level}
4469 @itemx -gcoff@var{level}
4470 @itemx -gxcoff@var{level}
4471 @itemx -gvms@var{level}
4472 Request debugging information and also use @var{level} to specify how
4473 much information.  The default level is 2.
4475 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4476 @option{-g}.
4478 Level 1 produces minimal information, enough for making backtraces in
4479 parts of the program that you don't plan to debug.  This includes
4480 descriptions of functions and external variables, but no information
4481 about local variables and no line numbers.
4483 Level 3 includes extra information, such as all the macro definitions
4484 present in the program.  Some debuggers support macro expansion when
4485 you use @option{-g3}.
4487 @option{-gdwarf-2} does not accept a concatenated debug level, because
4488 GCC used to support an option @option{-gdwarf} that meant to generate
4489 debug information in version 1 of the DWARF format (which is very
4490 different from version 2), and it would have been too confusing.  That
4491 debug format is long obsolete, but the option cannot be changed now.
4492 Instead use an additional @option{-g@var{level}} option to change the
4493 debug level for DWARF.
4495 @item -gtoggle
4496 @opindex gtoggle
4497 Turn off generation of debug info, if leaving out this option would have
4498 generated it, or turn it on at level 2 otherwise.  The position of this
4499 argument in the command line does not matter, it takes effect after all
4500 other options are processed, and it does so only once, no matter how
4501 many times it is given.  This is mainly intended to be used with
4502 @option{-fcompare-debug}.
4504 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4505 @opindex fdump-final-insns
4506 Dump the final internal representation (RTL) to @var{file}.  If the
4507 optional argument is omitted (or if @var{file} is @code{.}), the name
4508 of the dump file will be determined by appending @code{.gkd} to the
4509 compilation output file name.
4511 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4512 @opindex fcompare-debug
4513 @opindex fno-compare-debug
4514 If no error occurs during compilation, run the compiler a second time,
4515 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4516 passed to the second compilation.  Dump the final internal
4517 representation in both compilations, and print an error if they differ.
4519 If the equal sign is omitted, the default @option{-gtoggle} is used.
4521 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4522 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4523 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4524 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4525 is used.
4527 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4528 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4529 of the final representation and the second compilation, preventing even
4530 @env{GCC_COMPARE_DEBUG} from taking effect.
4532 To verify full coverage during @option{-fcompare-debug} testing, set
4533 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4534 which GCC will reject as an invalid option in any actual compilation
4535 (rather than preprocessing, assembly or linking).  To get just a
4536 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4537 not overridden} will do.
4539 @item -fcompare-debug-second
4540 @opindex fcompare-debug-second
4541 This option is implicitly passed to the compiler for the second
4542 compilation requested by @option{-fcompare-debug}, along with options to
4543 silence warnings, and omitting other options that would cause
4544 side-effect compiler outputs to files or to the standard output.  Dump
4545 files and preserved temporary files are renamed so as to contain the
4546 @code{.gk} additional extension during the second compilation, to avoid
4547 overwriting those generated by the first.
4549 When this option is passed to the compiler driver, it causes the
4550 @emph{first} compilation to be skipped, which makes it useful for little
4551 other than debugging the compiler proper.
4553 @item -feliminate-dwarf2-dups
4554 @opindex feliminate-dwarf2-dups
4555 Compress DWARF2 debugging information by eliminating duplicated
4556 information about each symbol.  This option only makes sense when
4557 generating DWARF2 debugging information with @option{-gdwarf-2}.
4559 @item -femit-struct-debug-baseonly
4560 Emit debug information for struct-like types
4561 only when the base name of the compilation source file
4562 matches the base name of file in which the struct was defined.
4564 This option substantially reduces the size of debugging information,
4565 but at significant potential loss in type information to the debugger.
4566 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4567 See @option{-femit-struct-debug-detailed} for more detailed control.
4569 This option works only with DWARF 2.
4571 @item -femit-struct-debug-reduced
4572 Emit debug information for struct-like types
4573 only when the base name of the compilation source file
4574 matches the base name of file in which the type was defined,
4575 unless the struct is a template or defined in a system header.
4577 This option significantly reduces the size of debugging information,
4578 with some potential loss in type information to the debugger.
4579 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4580 See @option{-femit-struct-debug-detailed} for more detailed control.
4582 This option works only with DWARF 2.
4584 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4585 Specify the struct-like types
4586 for which the compiler will generate debug information.
4587 The intent is to reduce duplicate struct debug information
4588 between different object files within the same program.
4590 This option is a detailed version of
4591 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4592 which will serve for most needs.
4594 A specification has the syntax
4595 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4597 The optional first word limits the specification to
4598 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4599 A struct type is used directly when it is the type of a variable, member.
4600 Indirect uses arise through pointers to structs.
4601 That is, when use of an incomplete struct would be legal, the use is indirect.
4602 An example is
4603 @samp{struct one direct; struct two * indirect;}.
4605 The optional second word limits the specification to
4606 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4607 Generic structs are a bit complicated to explain.
4608 For C++, these are non-explicit specializations of template classes,
4609 or non-template classes within the above.
4610 Other programming languages have generics,
4611 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4613 The third word specifies the source files for those
4614 structs for which the compiler will emit debug information.
4615 The values @samp{none} and @samp{any} have the normal meaning.
4616 The value @samp{base} means that
4617 the base of name of the file in which the type declaration appears
4618 must match the base of the name of the main compilation file.
4619 In practice, this means that
4620 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4621 but types declared in other header will not.
4622 The value @samp{sys} means those types satisfying @samp{base}
4623 or declared in system or compiler headers.
4625 You may need to experiment to determine the best settings for your application.
4627 The default is @samp{-femit-struct-debug-detailed=all}.
4629 This option works only with DWARF 2.
4631 @item -fenable-icf-debug
4632 @opindex fenable-icf-debug
4633 Generate additional debug information to support identical code folding (ICF).
4634 This option only works with DWARF version 2 or higher.
4636 @item -fno-merge-debug-strings
4637 @opindex fmerge-debug-strings
4638 @opindex fno-merge-debug-strings
4639 Direct the linker to not merge together strings in the debugging
4640 information which are identical in different object files.  Merging is
4641 not supported by all assemblers or linkers.  Merging decreases the size
4642 of the debug information in the output file at the cost of increasing
4643 link processing time.  Merging is enabled by default.
4645 @item -fdebug-prefix-map=@var{old}=@var{new}
4646 @opindex fdebug-prefix-map
4647 When compiling files in directory @file{@var{old}}, record debugging
4648 information describing them as in @file{@var{new}} instead.
4650 @item -fno-dwarf2-cfi-asm
4651 @opindex fdwarf2-cfi-asm
4652 @opindex fno-dwarf2-cfi-asm
4653 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4654 instead of using GAS @code{.cfi_*} directives.
4656 @cindex @command{prof}
4657 @item -p
4658 @opindex p
4659 Generate extra code to write profile information suitable for the
4660 analysis program @command{prof}.  You must use this option when compiling
4661 the source files you want data about, and you must also use it when
4662 linking.
4664 @cindex @command{gprof}
4665 @item -pg
4666 @opindex pg
4667 Generate extra code to write profile information suitable for the
4668 analysis program @command{gprof}.  You must use this option when compiling
4669 the source files you want data about, and you must also use it when
4670 linking.
4672 @item -Q
4673 @opindex Q
4674 Makes the compiler print out each function name as it is compiled, and
4675 print some statistics about each pass when it finishes.
4677 @item -ftime-report
4678 @opindex ftime-report
4679 Makes the compiler print some statistics about the time consumed by each
4680 pass when it finishes.
4682 @item -fmem-report
4683 @opindex fmem-report
4684 Makes the compiler print some statistics about permanent memory
4685 allocation when it finishes.
4687 @item -fpre-ipa-mem-report
4688 @opindex fpre-ipa-mem-report
4689 @item -fpost-ipa-mem-report
4690 @opindex fpost-ipa-mem-report
4691 Makes the compiler print some statistics about permanent memory
4692 allocation before or after interprocedural optimization.
4694 @item -fprofile-arcs
4695 @opindex fprofile-arcs
4696 Add code so that program flow @dfn{arcs} are instrumented.  During
4697 execution the program records how many times each branch and call is
4698 executed and how many times it is taken or returns.  When the compiled
4699 program exits it saves this data to a file called
4700 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4701 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4702 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4703 @var{auxname} is generated from the name of the output file, if
4704 explicitly specified and it is not the final executable, otherwise it is
4705 the basename of the source file.  In both cases any suffix is removed
4706 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4707 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4708 @xref{Cross-profiling}.
4710 @cindex @command{gcov}
4711 @item --coverage
4712 @opindex coverage
4714 This option is used to compile and link code instrumented for coverage
4715 analysis.  The option is a synonym for @option{-fprofile-arcs}
4716 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4717 linking).  See the documentation for those options for more details.
4719 @itemize
4721 @item
4722 Compile the source files with @option{-fprofile-arcs} plus optimization
4723 and code generation options.  For test coverage analysis, use the
4724 additional @option{-ftest-coverage} option.  You do not need to profile
4725 every source file in a program.
4727 @item
4728 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4729 (the latter implies the former).
4731 @item
4732 Run the program on a representative workload to generate the arc profile
4733 information.  This may be repeated any number of times.  You can run
4734 concurrent instances of your program, and provided that the file system
4735 supports locking, the data files will be correctly updated.  Also
4736 @code{fork} calls are detected and correctly handled (double counting
4737 will not happen).
4739 @item
4740 For profile-directed optimizations, compile the source files again with
4741 the same optimization and code generation options plus
4742 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4743 Control Optimization}).
4745 @item
4746 For test coverage analysis, use @command{gcov} to produce human readable
4747 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4748 @command{gcov} documentation for further information.
4750 @end itemize
4752 With @option{-fprofile-arcs}, for each function of your program GCC
4753 creates a program flow graph, then finds a spanning tree for the graph.
4754 Only arcs that are not on the spanning tree have to be instrumented: the
4755 compiler adds code to count the number of times that these arcs are
4756 executed.  When an arc is the only exit or only entrance to a block, the
4757 instrumentation code can be added to the block; otherwise, a new basic
4758 block must be created to hold the instrumentation code.
4760 @need 2000
4761 @item -ftest-coverage
4762 @opindex ftest-coverage
4763 Produce a notes file that the @command{gcov} code-coverage utility
4764 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4765 show program coverage.  Each source file's note file is called
4766 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4767 above for a description of @var{auxname} and instructions on how to
4768 generate test coverage data.  Coverage data will match the source files
4769 more closely, if you do not optimize.
4771 @item -fdbg-cnt-list
4772 @opindex fdbg-cnt-list
4773 Print the name and the counter upperbound for all debug counters.
4775 @item -fdbg-cnt=@var{counter-value-list}
4776 @opindex fdbg-cnt
4777 Set the internal debug counter upperbound. @var{counter-value-list}
4778 is a comma-separated list of @var{name}:@var{value} pairs
4779 which sets the upperbound of each debug counter @var{name} to @var{value}.
4780 All debug counters have the initial upperbound of @var{UINT_MAX},
4781 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4782 e.g. With -fdbg-cnt=dce:10,tail_call:0
4783 dbg_cnt(dce) will return true only for first 10 invocations
4784 and dbg_cnt(tail_call) will return false always.
4786 @item -d@var{letters}
4787 @itemx -fdump-rtl-@var{pass}
4788 @opindex d
4789 Says to make debugging dumps during compilation at times specified by
4790 @var{letters}.  This is used for debugging the RTL-based passes of the
4791 compiler.  The file names for most of the dumps are made by appending
4792 a pass number and a word to the @var{dumpname}, and the files are
4793 created in the directory of the output file.  @var{dumpname} is
4794 generated from the name of the output file, if explicitly specified
4795 and it is not an executable, otherwise it is the basename of the
4796 source file. These switches may have different effects when
4797 @option{-E} is used for preprocessing.
4799 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4800 @option{-d} option @var{letters}.  Here are the possible
4801 letters for use in @var{pass} and @var{letters}, and their meanings:
4803 @table @gcctabopt
4805 @item -fdump-rtl-alignments
4806 @opindex fdump-rtl-alignments
4807 Dump after branch alignments have been computed.
4809 @item -fdump-rtl-asmcons
4810 @opindex fdump-rtl-asmcons
4811 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4813 @item -fdump-rtl-auto_inc_dec
4814 @opindex fdump-rtl-auto_inc_dec
4815 Dump after auto-inc-dec discovery.  This pass is only run on
4816 architectures that have auto inc or auto dec instructions.
4818 @item -fdump-rtl-barriers
4819 @opindex fdump-rtl-barriers
4820 Dump after cleaning up the barrier instructions.
4822 @item -fdump-rtl-bbpart
4823 @opindex fdump-rtl-bbpart
4824 Dump after partitioning hot and cold basic blocks.
4826 @item -fdump-rtl-bbro
4827 @opindex fdump-rtl-bbro
4828 Dump after block reordering.
4830 @item -fdump-rtl-btl1
4831 @itemx -fdump-rtl-btl2
4832 @opindex fdump-rtl-btl2
4833 @opindex fdump-rtl-btl2
4834 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4835 after the two branch
4836 target load optimization passes.
4838 @item -fdump-rtl-bypass
4839 @opindex fdump-rtl-bypass
4840 Dump after jump bypassing and control flow optimizations.
4842 @item -fdump-rtl-combine
4843 @opindex fdump-rtl-combine
4844 Dump after the RTL instruction combination pass.
4846 @item -fdump-rtl-compgotos
4847 @opindex fdump-rtl-compgotos
4848 Dump after duplicating the computed gotos.
4850 @item -fdump-rtl-ce1
4851 @itemx -fdump-rtl-ce2
4852 @itemx -fdump-rtl-ce3
4853 @opindex fdump-rtl-ce1
4854 @opindex fdump-rtl-ce2
4855 @opindex fdump-rtl-ce3
4856 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4857 @option{-fdump-rtl-ce3} enable dumping after the three
4858 if conversion passes.
4860 @itemx -fdump-rtl-cprop_hardreg
4861 @opindex fdump-rtl-cprop_hardreg
4862 Dump after hard register copy propagation.
4864 @itemx -fdump-rtl-csa
4865 @opindex fdump-rtl-csa
4866 Dump after combining stack adjustments.
4868 @item -fdump-rtl-cse1
4869 @itemx -fdump-rtl-cse2
4870 @opindex fdump-rtl-cse1
4871 @opindex fdump-rtl-cse2
4872 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4873 the two common sub-expression elimination passes.
4875 @itemx -fdump-rtl-dce
4876 @opindex fdump-rtl-dce
4877 Dump after the standalone dead code elimination passes.
4879 @itemx -fdump-rtl-dbr
4880 @opindex fdump-rtl-dbr
4881 Dump after delayed branch scheduling.
4883 @item -fdump-rtl-dce1
4884 @itemx -fdump-rtl-dce2
4885 @opindex fdump-rtl-dce1
4886 @opindex fdump-rtl-dce2
4887 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4888 the two dead store elimination passes.
4890 @item -fdump-rtl-eh
4891 @opindex fdump-rtl-eh
4892 Dump after finalization of EH handling code.
4894 @item -fdump-rtl-eh_ranges
4895 @opindex fdump-rtl-eh_ranges
4896 Dump after conversion of EH handling range regions.
4898 @item -fdump-rtl-expand
4899 @opindex fdump-rtl-expand
4900 Dump after RTL generation.
4902 @item -fdump-rtl-fwprop1
4903 @itemx -fdump-rtl-fwprop2
4904 @opindex fdump-rtl-fwprop1
4905 @opindex fdump-rtl-fwprop2
4906 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4907 dumping after the two forward propagation passes.
4909 @item -fdump-rtl-gcse1
4910 @itemx -fdump-rtl-gcse2
4911 @opindex fdump-rtl-gcse1
4912 @opindex fdump-rtl-gcse2
4913 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4914 after global common subexpression elimination.
4916 @item -fdump-rtl-init-regs
4917 @opindex fdump-rtl-init-regs
4918 Dump after the initialization of the registers.
4920 @item -fdump-rtl-initvals
4921 @opindex fdump-rtl-initvals
4922 Dump after the computation of the initial value sets.
4924 @itemx -fdump-rtl-into_cfglayout
4925 @opindex fdump-rtl-into_cfglayout
4926 Dump after converting to cfglayout mode.
4928 @item -fdump-rtl-ira
4929 @opindex fdump-rtl-ira
4930 Dump after iterated register allocation.
4932 @item -fdump-rtl-jump
4933 @opindex fdump-rtl-jump
4934 Dump after the second jump optimization.
4936 @item -fdump-rtl-loop2
4937 @opindex fdump-rtl-loop2
4938 @option{-fdump-rtl-loop2} enables dumping after the rtl
4939 loop optimization passes.
4941 @item -fdump-rtl-mach
4942 @opindex fdump-rtl-mach
4943 Dump after performing the machine dependent reorganization pass, if that
4944 pass exists.
4946 @item -fdump-rtl-mode_sw
4947 @opindex fdump-rtl-mode_sw
4948 Dump after removing redundant mode switches.
4950 @item -fdump-rtl-rnreg
4951 @opindex fdump-rtl-rnreg
4952 Dump after register renumbering.
4954 @itemx -fdump-rtl-outof_cfglayout
4955 @opindex fdump-rtl-outof_cfglayout
4956 Dump after converting from cfglayout mode.
4958 @item -fdump-rtl-peephole2
4959 @opindex fdump-rtl-peephole2
4960 Dump after the peephole pass.
4962 @item -fdump-rtl-postreload
4963 @opindex fdump-rtl-postreload
4964 Dump after post-reload optimizations.
4966 @itemx -fdump-rtl-pro_and_epilogue
4967 @opindex fdump-rtl-pro_and_epilogue
4968 Dump after generating the function pro and epilogues.
4970 @item -fdump-rtl-regmove
4971 @opindex fdump-rtl-regmove
4972 Dump after the register move pass.
4974 @item -fdump-rtl-sched1
4975 @itemx -fdump-rtl-sched2
4976 @opindex fdump-rtl-sched1
4977 @opindex fdump-rtl-sched2
4978 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
4979 after the basic block scheduling passes.
4981 @item -fdump-rtl-see
4982 @opindex fdump-rtl-see
4983 Dump after sign extension elimination.
4985 @item -fdump-rtl-seqabstr
4986 @opindex fdump-rtl-seqabstr
4987 Dump after common sequence discovery.
4989 @item -fdump-rtl-shorten
4990 @opindex fdump-rtl-shorten
4991 Dump after shortening branches.
4993 @item -fdump-rtl-sibling
4994 @opindex fdump-rtl-sibling
4995 Dump after sibling call optimizations.
4997 @item -fdump-rtl-split1
4998 @itemx -fdump-rtl-split2
4999 @itemx -fdump-rtl-split3
5000 @itemx -fdump-rtl-split4
5001 @itemx -fdump-rtl-split5
5002 @opindex fdump-rtl-split1
5003 @opindex fdump-rtl-split2
5004 @opindex fdump-rtl-split3
5005 @opindex fdump-rtl-split4
5006 @opindex fdump-rtl-split5
5007 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5008 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5009 @option{-fdump-rtl-split5} enable dumping after five rounds of
5010 instruction splitting.
5012 @item -fdump-rtl-sms
5013 @opindex fdump-rtl-sms
5014 Dump after modulo scheduling.  This pass is only run on some
5015 architectures.
5017 @item -fdump-rtl-stack
5018 @opindex fdump-rtl-stack
5019 Dump after conversion from GCC's "flat register file" registers to the
5020 x87's stack-like registers.  This pass is only run on x86 variants.
5022 @item -fdump-rtl-subreg1
5023 @itemx -fdump-rtl-subreg2
5024 @opindex fdump-rtl-subreg1
5025 @opindex fdump-rtl-subreg2
5026 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5027 the two subreg expansion passes.
5029 @item -fdump-rtl-unshare
5030 @opindex fdump-rtl-unshare
5031 Dump after all rtl has been unshared.
5033 @item -fdump-rtl-vartrack
5034 @opindex fdump-rtl-vartrack
5035 Dump after variable tracking.
5037 @item -fdump-rtl-vregs
5038 @opindex fdump-rtl-vregs
5039 Dump after converting virtual registers to hard registers.
5041 @item -fdump-rtl-web
5042 @opindex fdump-rtl-web
5043 Dump after live range splitting.
5045 @item -fdump-rtl-regclass
5046 @itemx -fdump-rtl-subregs_of_mode_init
5047 @itemx -fdump-rtl-subregs_of_mode_finish
5048 @itemx -fdump-rtl-dfinit
5049 @itemx -fdump-rtl-dfinish
5050 @opindex fdump-rtl-regclass
5051 @opindex fdump-rtl-subregs_of_mode_init
5052 @opindex fdump-rtl-subregs_of_mode_finish
5053 @opindex fdump-rtl-dfinit
5054 @opindex fdump-rtl-dfinish
5055 These dumps are defined but always produce empty files.
5057 @item -fdump-rtl-all
5058 @opindex fdump-rtl-all
5059 Produce all the dumps listed above.
5061 @item -dA
5062 @opindex dA
5063 Annotate the assembler output with miscellaneous debugging information.
5065 @item -dD
5066 @opindex dD
5067 Dump all macro definitions, at the end of preprocessing, in addition to
5068 normal output.
5070 @item -dH
5071 @opindex dH
5072 Produce a core dump whenever an error occurs.
5074 @item -dm
5075 @opindex dm
5076 Print statistics on memory usage, at the end of the run, to
5077 standard error.
5079 @item -dp
5080 @opindex dp
5081 Annotate the assembler output with a comment indicating which
5082 pattern and alternative was used.  The length of each instruction is
5083 also printed.
5085 @item -dP
5086 @opindex dP
5087 Dump the RTL in the assembler output as a comment before each instruction.
5088 Also turns on @option{-dp} annotation.
5090 @item -dv
5091 @opindex dv
5092 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5093 dump a representation of the control flow graph suitable for viewing with VCG
5094 to @file{@var{file}.@var{pass}.vcg}.
5096 @item -dx
5097 @opindex dx
5098 Just generate RTL for a function instead of compiling it.  Usually used
5099 with @option{-fdump-rtl-expand}.
5101 @item -dy
5102 @opindex dy
5103 Dump debugging information during parsing, to standard error.
5104 @end table
5106 @item -fdump-noaddr
5107 @opindex fdump-noaddr
5108 When doing debugging dumps, suppress address output.  This makes it more
5109 feasible to use diff on debugging dumps for compiler invocations with
5110 different compiler binaries and/or different
5111 text / bss / data / heap / stack / dso start locations.
5113 @item -fdump-unnumbered
5114 @opindex fdump-unnumbered
5115 When doing debugging dumps, suppress instruction numbers and address output.
5116 This makes it more feasible to use diff on debugging dumps for compiler
5117 invocations with different options, in particular with and without
5118 @option{-g}.
5120 @item -fdump-unnumbered-links
5121 @opindex fdump-unnumbered-links
5122 When doing debugging dumps (see @option{-d} option above), suppress
5123 instruction numbers for the links to the previous and next instructions
5124 in a sequence.
5126 @item -fdump-translation-unit @r{(C++ only)}
5127 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5128 @opindex fdump-translation-unit
5129 Dump a representation of the tree structure for the entire translation
5130 unit to a file.  The file name is made by appending @file{.tu} to the
5131 source file name, and the file is created in the same directory as the
5132 output file.  If the @samp{-@var{options}} form is used, @var{options}
5133 controls the details of the dump as described for the
5134 @option{-fdump-tree} options.
5136 @item -fdump-class-hierarchy @r{(C++ only)}
5137 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5138 @opindex fdump-class-hierarchy
5139 Dump a representation of each class's hierarchy and virtual function
5140 table layout to a file.  The file name is made by appending
5141 @file{.class} to the source file name, and the file is created in the
5142 same directory as the output file.  If the @samp{-@var{options}} form
5143 is used, @var{options} controls the details of the dump as described
5144 for the @option{-fdump-tree} options.
5146 @item -fdump-ipa-@var{switch}
5147 @opindex fdump-ipa
5148 Control the dumping at various stages of inter-procedural analysis
5149 language tree to a file.  The file name is generated by appending a
5150 switch specific suffix to the source file name, and the file is created
5151 in the same directory as the output file.  The following dumps are
5152 possible:
5154 @table @samp
5155 @item all
5156 Enables all inter-procedural analysis dumps.
5158 @item cgraph
5159 Dumps information about call-graph optimization, unused function removal,
5160 and inlining decisions.
5162 @item inline
5163 Dump after function inlining.
5165 @end table
5167 @item -fdump-statistics-@var{option}
5168 @opindex fdump-statistics
5169 Enable and control dumping of pass statistics in a separate file.  The
5170 file name is generated by appending a suffix ending in
5171 @samp{.statistics} to the source file name, and the file is created in
5172 the same directory as the output file.  If the @samp{-@var{option}}
5173 form is used, @samp{-stats} will cause counters to be summed over the
5174 whole compilation unit while @samp{-details} will dump every event as
5175 the passes generate them.  The default with no option is to sum
5176 counters for each function compiled.
5178 @item -fdump-tree-@var{switch}
5179 @itemx -fdump-tree-@var{switch}-@var{options}
5180 @opindex fdump-tree
5181 Control the dumping at various stages of processing the intermediate
5182 language tree to a file.  The file name is generated by appending a
5183 switch specific suffix to the source file name, and the file is
5184 created in the same directory as the output file.  If the
5185 @samp{-@var{options}} form is used, @var{options} is a list of
5186 @samp{-} separated options that control the details of the dump.  Not
5187 all options are applicable to all dumps, those which are not
5188 meaningful will be ignored.  The following options are available
5190 @table @samp
5191 @item address
5192 Print the address of each node.  Usually this is not meaningful as it
5193 changes according to the environment and source file.  Its primary use
5194 is for tying up a dump file with a debug environment.
5195 @item asmname
5196 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5197 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5198 use working backward from mangled names in the assembly file.
5199 @item slim
5200 Inhibit dumping of members of a scope or body of a function merely
5201 because that scope has been reached.  Only dump such items when they
5202 are directly reachable by some other path.  When dumping pretty-printed
5203 trees, this option inhibits dumping the bodies of control structures.
5204 @item raw
5205 Print a raw representation of the tree.  By default, trees are
5206 pretty-printed into a C-like representation.
5207 @item details
5208 Enable more detailed dumps (not honored by every dump option).
5209 @item stats
5210 Enable dumping various statistics about the pass (not honored by every dump
5211 option).
5212 @item blocks
5213 Enable showing basic block boundaries (disabled in raw dumps).
5214 @item vops
5215 Enable showing virtual operands for every statement.
5216 @item lineno
5217 Enable showing line numbers for statements.
5218 @item uid
5219 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5220 @item verbose
5221 Enable showing the tree dump for each statement.
5222 @item eh
5223 Enable showing the EH region number holding each statement.
5224 @item all
5225 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5226 and @option{lineno}.
5227 @end table
5229 The following tree dumps are possible:
5230 @table @samp
5232 @item original
5233 @opindex fdump-tree-original
5234 Dump before any tree based optimization, to @file{@var{file}.original}.
5236 @item optimized
5237 @opindex fdump-tree-optimized
5238 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5240 @item gimple
5241 @opindex fdump-tree-gimple
5242 Dump each function before and after the gimplification pass to a file.  The
5243 file name is made by appending @file{.gimple} to the source file name.
5245 @item cfg
5246 @opindex fdump-tree-cfg
5247 Dump the control flow graph of each function to a file.  The file name is
5248 made by appending @file{.cfg} to the source file name.
5250 @item vcg
5251 @opindex fdump-tree-vcg
5252 Dump the control flow graph of each function to a file in VCG format.  The
5253 file name is made by appending @file{.vcg} to the source file name.  Note
5254 that if the file contains more than one function, the generated file cannot
5255 be used directly by VCG@.  You will need to cut and paste each function's
5256 graph into its own separate file first.
5258 @item ch
5259 @opindex fdump-tree-ch
5260 Dump each function after copying loop headers.  The file name is made by
5261 appending @file{.ch} to the source file name.
5263 @item ssa
5264 @opindex fdump-tree-ssa
5265 Dump SSA related information to a file.  The file name is made by appending
5266 @file{.ssa} to the source file name.
5268 @item alias
5269 @opindex fdump-tree-alias
5270 Dump aliasing information for each function.  The file name is made by
5271 appending @file{.alias} to the source file name.
5273 @item ccp
5274 @opindex fdump-tree-ccp
5275 Dump each function after CCP@.  The file name is made by appending
5276 @file{.ccp} to the source file name.
5278 @item storeccp
5279 @opindex fdump-tree-storeccp
5280 Dump each function after STORE-CCP@.  The file name is made by appending
5281 @file{.storeccp} to the source file name.
5283 @item pre
5284 @opindex fdump-tree-pre
5285 Dump trees after partial redundancy elimination.  The file name is made
5286 by appending @file{.pre} to the source file name.
5288 @item fre
5289 @opindex fdump-tree-fre
5290 Dump trees after full redundancy elimination.  The file name is made
5291 by appending @file{.fre} to the source file name.
5293 @item copyprop
5294 @opindex fdump-tree-copyprop
5295 Dump trees after copy propagation.  The file name is made
5296 by appending @file{.copyprop} to the source file name.
5298 @item store_copyprop
5299 @opindex fdump-tree-store_copyprop
5300 Dump trees after store copy-propagation.  The file name is made
5301 by appending @file{.store_copyprop} to the source file name.
5303 @item dce
5304 @opindex fdump-tree-dce
5305 Dump each function after dead code elimination.  The file name is made by
5306 appending @file{.dce} to the source file name.
5308 @item mudflap
5309 @opindex fdump-tree-mudflap
5310 Dump each function after adding mudflap instrumentation.  The file name is
5311 made by appending @file{.mudflap} to the source file name.
5313 @item sra
5314 @opindex fdump-tree-sra
5315 Dump each function after performing scalar replacement of aggregates.  The
5316 file name is made by appending @file{.sra} to the source file name.
5318 @item sink
5319 @opindex fdump-tree-sink
5320 Dump each function after performing code sinking.  The file name is made
5321 by appending @file{.sink} to the source file name.
5323 @item dom
5324 @opindex fdump-tree-dom
5325 Dump each function after applying dominator tree optimizations.  The file
5326 name is made by appending @file{.dom} to the source file name.
5328 @item dse
5329 @opindex fdump-tree-dse
5330 Dump each function after applying dead store elimination.  The file
5331 name is made by appending @file{.dse} to the source file name.
5333 @item phiopt
5334 @opindex fdump-tree-phiopt
5335 Dump each function after optimizing PHI nodes into straightline code.  The file
5336 name is made by appending @file{.phiopt} to the source file name.
5338 @item forwprop
5339 @opindex fdump-tree-forwprop
5340 Dump each function after forward propagating single use variables.  The file
5341 name is made by appending @file{.forwprop} to the source file name.
5343 @item copyrename
5344 @opindex fdump-tree-copyrename
5345 Dump each function after applying the copy rename optimization.  The file
5346 name is made by appending @file{.copyrename} to the source file name.
5348 @item nrv
5349 @opindex fdump-tree-nrv
5350 Dump each function after applying the named return value optimization on
5351 generic trees.  The file name is made by appending @file{.nrv} to the source
5352 file name.
5354 @item vect
5355 @opindex fdump-tree-vect
5356 Dump each function after applying vectorization of loops.  The file name is
5357 made by appending @file{.vect} to the source file name.
5359 @item vrp
5360 @opindex fdump-tree-vrp
5361 Dump each function after Value Range Propagation (VRP).  The file name
5362 is made by appending @file{.vrp} to the source file name.
5364 @item all
5365 @opindex fdump-tree-all
5366 Enable all the available tree dumps with the flags provided in this option.
5367 @end table
5369 @item -ftree-vectorizer-verbose=@var{n}
5370 @opindex ftree-vectorizer-verbose
5371 This option controls the amount of debugging output the vectorizer prints.
5372 This information is written to standard error, unless
5373 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5374 in which case it is output to the usual dump listing file, @file{.vect}.
5375 For @var{n}=0 no diagnostic information is reported.
5376 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5377 and the total number of loops that got vectorized.
5378 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5379 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5380 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5381 level that @option{-fdump-tree-vect-stats} uses.
5382 Higher verbosity levels mean either more information dumped for each
5383 reported loop, or same amount of information reported for more loops:
5384 If @var{n}=3, alignment related information is added to the reports.
5385 If @var{n}=4, data-references related information (e.g.@: memory dependences,
5386 memory access-patterns) is added to the reports.
5387 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
5388 that did not pass the first analysis phase (i.e., may not be countable, or
5389 may have complicated control-flow).
5390 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
5391 For @var{n}=7, all the information the vectorizer generates during its
5392 analysis and transformation is reported.  This is the same verbosity level
5393 that @option{-fdump-tree-vect-details} uses.
5395 @item -frandom-seed=@var{string}
5396 @opindex frandom-seed
5397 This option provides a seed that GCC uses when it would otherwise use
5398 random numbers.  It is used to generate certain symbol names
5399 that have to be different in every compiled file.  It is also used to
5400 place unique stamps in coverage data files and the object files that
5401 produce them.  You can use the @option{-frandom-seed} option to produce
5402 reproducibly identical object files.
5404 The @var{string} should be different for every file you compile.
5406 @item -fsched-verbose=@var{n}
5407 @opindex fsched-verbose
5408 On targets that use instruction scheduling, this option controls the
5409 amount of debugging output the scheduler prints.  This information is
5410 written to standard error, unless @option{-fdump-rtl-sched1} or
5411 @option{-fdump-rtl-sched2} is specified, in which case it is output
5412 to the usual dump listing file, @file{.sched} or @file{.sched2}
5413 respectively.  However for @var{n} greater than nine, the output is
5414 always printed to standard error.
5416 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5417 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5418 For @var{n} greater than one, it also output basic block probabilities,
5419 detailed ready list information and unit/insn info.  For @var{n} greater
5420 than two, it includes RTL at abort point, control-flow and regions info.
5421 And for @var{n} over four, @option{-fsched-verbose} also includes
5422 dependence info.
5424 @item -save-temps
5425 @itemx -save-temps=cwd
5426 @opindex save-temps
5427 Store the usual ``temporary'' intermediate files permanently; place them
5428 in the current directory and name them based on the source file.  Thus,
5429 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5430 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5431 preprocessed @file{foo.i} output file even though the compiler now
5432 normally uses an integrated preprocessor.
5434 When used in combination with the @option{-x} command line option,
5435 @option{-save-temps} is sensible enough to avoid over writing an
5436 input source file with the same extension as an intermediate file.
5437 The corresponding intermediate file may be obtained by renaming the
5438 source file before using @option{-save-temps}.
5440 If you invoke GCC in parallel, compiling several different source
5441 files that share a common base name in different subdirectories or the
5442 same source file compiled for multiple output destinations, it is
5443 likely that the different parallel compilers will interfere with each
5444 other, and overwrite the temporary files.  For instance:
5446 @smallexample
5447 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5448 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5449 @end smallexample
5451 may result in @file{foo.i} and @file{foo.o} being written to
5452 simultaneously by both compilers.
5454 @item -save-temps=obj
5455 @opindex save-temps=obj
5456 Store the usual ``temporary'' intermediate files permanently.  If the
5457 @option{-o} option is used, the temporary files are based on the
5458 object file.  If the @option{-o} option is not used, the
5459 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5461 For example:
5463 @smallexample
5464 gcc -save-temps=obj -c foo.c
5465 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5466 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5467 @end smallexample
5469 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5470 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5471 @file{dir2/yfoobar.o}.
5473 @item -time@r{[}=@var{file}@r{]}
5474 @opindex time
5475 Report the CPU time taken by each subprocess in the compilation
5476 sequence.  For C source files, this is the compiler proper and assembler
5477 (plus the linker if linking is done).
5479 Without the specification of an output file, the output looks like this:
5481 @smallexample
5482 # cc1 0.12 0.01
5483 # as 0.00 0.01
5484 @end smallexample
5486 The first number on each line is the ``user time'', that is time spent
5487 executing the program itself.  The second number is ``system time'',
5488 time spent executing operating system routines on behalf of the program.
5489 Both numbers are in seconds.
5491 With the specification of an output file, the output is appended to the
5492 named file, and it looks like this:
5494 @smallexample
5495 0.12 0.01 cc1 @var{options}
5496 0.00 0.01 as @var{options}
5497 @end smallexample
5499 The ``user time'' and the ``system time'' are moved before the program
5500 name, and the options passed to the program are displayed, so that one
5501 can later tell what file was being compiled, and with which options.
5503 @item -fvar-tracking
5504 @opindex fvar-tracking
5505 Run variable tracking pass.  It computes where variables are stored at each
5506 position in code.  Better debugging information is then generated
5507 (if the debugging information format supports this information).
5509 It is enabled by default when compiling with optimization (@option{-Os},
5510 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5511 the debug info format supports it.
5513 @item -fvar-tracking-assignments
5514 @opindex fvar-tracking-assignments
5515 @opindex fno-var-tracking-assignments
5516 Annotate assignments to user variables early in the compilation and
5517 attempt to carry the annotations over throughout the compilation all the
5518 way to the end, in an attempt to improve debug information while
5519 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5521 It can be enabled even if var-tracking is disabled, in which case
5522 annotations will be created and maintained, but discarded at the end.
5524 @item -fvar-tracking-assignments-toggle
5525 @opindex fvar-tracking-assignments-toggle
5526 @opindex fno-var-tracking-assignments-toggle
5527 Toggle @option{-fvar-tracking-assignments}, in the same way that
5528 @option{-gtoggle} toggles @option{-g}.
5530 @item -print-file-name=@var{library}
5531 @opindex print-file-name
5532 Print the full absolute name of the library file @var{library} that
5533 would be used when linking---and don't do anything else.  With this
5534 option, GCC does not compile or link anything; it just prints the
5535 file name.
5537 @item -print-multi-directory
5538 @opindex print-multi-directory
5539 Print the directory name corresponding to the multilib selected by any
5540 other switches present in the command line.  This directory is supposed
5541 to exist in @env{GCC_EXEC_PREFIX}.
5543 @item -print-multi-lib
5544 @opindex print-multi-lib
5545 Print the mapping from multilib directory names to compiler switches
5546 that enable them.  The directory name is separated from the switches by
5547 @samp{;}, and each switch starts with an @samp{@@} instead of the
5548 @samp{-}, without spaces between multiple switches.  This is supposed to
5549 ease shell-processing.
5551 @item -print-multi-os-directory
5552 @opindex print-multi-os-directory
5553 Print the path to OS libraries for the selected
5554 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5555 present in the @file{lib} subdirectory and no multilibs are used, this is
5556 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5557 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5558 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5559 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5561 @item -print-prog-name=@var{program}
5562 @opindex print-prog-name
5563 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5565 @item -print-libgcc-file-name
5566 @opindex print-libgcc-file-name
5567 Same as @option{-print-file-name=libgcc.a}.
5569 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5570 but you do want to link with @file{libgcc.a}.  You can do
5572 @smallexample
5573 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5574 @end smallexample
5576 @item -print-search-dirs
5577 @opindex print-search-dirs
5578 Print the name of the configured installation directory and a list of
5579 program and library directories @command{gcc} will search---and don't do anything else.
5581 This is useful when @command{gcc} prints the error message
5582 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5583 To resolve this you either need to put @file{cpp0} and the other compiler
5584 components where @command{gcc} expects to find them, or you can set the environment
5585 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5586 Don't forget the trailing @samp{/}.
5587 @xref{Environment Variables}.
5589 @item -print-sysroot
5590 @opindex print-sysroot
5591 Print the target sysroot directory that will be used during
5592 compilation.  This is the target sysroot specified either at configure
5593 time or using the @option{--sysroot} option, possibly with an extra
5594 suffix that depends on compilation options.  If no target sysroot is
5595 specified, the option prints nothing.
5597 @item -print-sysroot-headers-suffix
5598 @opindex print-sysroot-headers-suffix
5599 Print the suffix added to the target sysroot when searching for
5600 headers, or give an error if the compiler is not configured with such
5601 a suffix---and don't do anything else.
5603 @item -dumpmachine
5604 @opindex dumpmachine
5605 Print the compiler's target machine (for example,
5606 @samp{i686-pc-linux-gnu})---and don't do anything else.
5608 @item -dumpversion
5609 @opindex dumpversion
5610 Print the compiler version (for example, @samp{3.0})---and don't do
5611 anything else.
5613 @item -dumpspecs
5614 @opindex dumpspecs
5615 Print the compiler's built-in specs---and don't do anything else.  (This
5616 is used when GCC itself is being built.)  @xref{Spec Files}.
5618 @item -feliminate-unused-debug-types
5619 @opindex feliminate-unused-debug-types
5620 Normally, when producing DWARF2 output, GCC will emit debugging
5621 information for all types declared in a compilation
5622 unit, regardless of whether or not they are actually used
5623 in that compilation unit.  Sometimes this is useful, such as
5624 if, in the debugger, you want to cast a value to a type that is
5625 not actually used in your program (but is declared).  More often,
5626 however, this results in a significant amount of wasted space.
5627 With this option, GCC will avoid producing debug symbol output
5628 for types that are nowhere used in the source file being compiled.
5629 @end table
5631 @node Optimize Options
5632 @section Options That Control Optimization
5633 @cindex optimize options
5634 @cindex options, optimization
5636 These options control various sorts of optimizations.
5638 Without any optimization option, the compiler's goal is to reduce the
5639 cost of compilation and to make debugging produce the expected
5640 results.  Statements are independent: if you stop the program with a
5641 breakpoint between statements, you can then assign a new value to any
5642 variable or change the program counter to any other statement in the
5643 function and get exactly the results you would expect from the source
5644 code.
5646 Turning on optimization flags makes the compiler attempt to improve
5647 the performance and/or code size at the expense of compilation time
5648 and possibly the ability to debug the program.
5650 The compiler performs optimization based on the knowledge it has of the
5651 program.  Compiling multiple files at once to a single output file mode allows
5652 the compiler to use information gained from all of the files when compiling
5653 each of them.
5655 Not all optimizations are controlled directly by a flag.  Only
5656 optimizations that have a flag are listed in this section.
5658 Most of the optimizations are not enabled if a @option{-O} level is not set on
5659 the command line, even if individual optimization flags are specified.
5661 Depending on the target and how GCC was configured, a slightly different
5662 set of optimizations may be enabled at each @option{-O} level than
5663 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5664 to find out the exact set of optimizations that are enabled at each level.
5665 @xref{Overall Options}, for examples.
5667 @table @gcctabopt
5668 @item -O
5669 @itemx -O1
5670 @opindex O
5671 @opindex O1
5672 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5673 more memory for a large function.
5675 With @option{-O}, the compiler tries to reduce code size and execution
5676 time, without performing any optimizations that take a great deal of
5677 compilation time.
5679 @option{-O} turns on the following optimization flags:
5680 @gccoptlist{
5681 -fauto-inc-dec @gol
5682 -fcprop-registers @gol
5683 -fdce @gol
5684 -fdefer-pop @gol
5685 -fdelayed-branch @gol
5686 -fdse @gol
5687 -fguess-branch-probability @gol
5688 -fif-conversion2 @gol
5689 -fif-conversion @gol
5690 -fipa-pure-const @gol
5691 -fipa-reference @gol
5692 -fmerge-constants
5693 -fsplit-wide-types @gol
5694 -ftree-builtin-call-dce @gol
5695 -ftree-ccp @gol
5696 -ftree-ch @gol
5697 -ftree-copyrename @gol
5698 -ftree-dce @gol
5699 -ftree-dominator-opts @gol
5700 -ftree-dse @gol
5701 -ftree-forwprop @gol
5702 -ftree-fre @gol
5703 -ftree-phiprop @gol
5704 -ftree-sra @gol
5705 -ftree-pta @gol
5706 -ftree-ter @gol
5707 -funit-at-a-time}
5709 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5710 where doing so does not interfere with debugging.
5712 @item -O2
5713 @opindex O2
5714 Optimize even more.  GCC performs nearly all supported optimizations
5715 that do not involve a space-speed tradeoff.
5716 As compared to @option{-O}, this option increases both compilation time
5717 and the performance of the generated code.
5719 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5720 also turns on the following optimization flags:
5721 @gccoptlist{-fthread-jumps @gol
5722 -falign-functions  -falign-jumps @gol
5723 -falign-loops  -falign-labels @gol
5724 -fcaller-saves @gol
5725 -fcrossjumping @gol
5726 -fcse-follow-jumps  -fcse-skip-blocks @gol
5727 -fdelete-null-pointer-checks @gol
5728 -fexpensive-optimizations @gol
5729 -fgcse  -fgcse-lm  @gol
5730 -finline-small-functions @gol
5731 -findirect-inlining @gol
5732 -fipa-sra @gol
5733 -foptimize-sibling-calls @gol
5734 -fpeephole2 @gol
5735 -fregmove @gol
5736 -freorder-blocks  -freorder-functions @gol
5737 -frerun-cse-after-loop  @gol
5738 -fsched-interblock  -fsched-spec @gol
5739 -fschedule-insns  -fschedule-insns2 @gol
5740 -fstrict-aliasing -fstrict-overflow @gol
5741 -ftree-switch-conversion @gol
5742 -ftree-pre @gol
5743 -ftree-vrp}
5745 Please note the warning under @option{-fgcse} about
5746 invoking @option{-O2} on programs that use computed gotos.
5748 @item -O3
5749 @opindex O3
5750 Optimize yet more.  @option{-O3} turns on all optimizations specified
5751 by @option{-O2} and also turns on the @option{-finline-functions},
5752 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5753 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5755 @item -O0
5756 @opindex O0
5757 Reduce compilation time and make debugging produce the expected
5758 results.  This is the default.
5760 @item -Os
5761 @opindex Os
5762 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5763 do not typically increase code size.  It also performs further
5764 optimizations designed to reduce code size.
5766 @option{-Os} disables the following optimization flags:
5767 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5768 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5769 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5771 If you use multiple @option{-O} options, with or without level numbers,
5772 the last such option is the one that is effective.
5773 @end table
5775 Options of the form @option{-f@var{flag}} specify machine-independent
5776 flags.  Most flags have both positive and negative forms; the negative
5777 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5778 below, only one of the forms is listed---the one you typically will
5779 use.  You can figure out the other form by either removing @samp{no-}
5780 or adding it.
5782 The following options control specific optimizations.  They are either
5783 activated by @option{-O} options or are related to ones that are.  You
5784 can use the following flags in the rare cases when ``fine-tuning'' of
5785 optimizations to be performed is desired.
5787 @table @gcctabopt
5788 @item -fno-default-inline
5789 @opindex fno-default-inline
5790 Do not make member functions inline by default merely because they are
5791 defined inside the class scope (C++ only).  Otherwise, when you specify
5792 @w{@option{-O}}, member functions defined inside class scope are compiled
5793 inline by default; i.e., you don't need to add @samp{inline} in front of
5794 the member function name.
5796 @item -fno-defer-pop
5797 @opindex fno-defer-pop
5798 Always pop the arguments to each function call as soon as that function
5799 returns.  For machines which must pop arguments after a function call,
5800 the compiler normally lets arguments accumulate on the stack for several
5801 function calls and pops them all at once.
5803 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5805 @item -fforward-propagate
5806 @opindex fforward-propagate
5807 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5808 instructions and checks if the result can be simplified.  If loop unrolling
5809 is active, two passes are performed and the second is scheduled after
5810 loop unrolling.
5812 This option is enabled by default at optimization levels @option{-O},
5813 @option{-O2}, @option{-O3}, @option{-Os}.
5815 @item -fomit-frame-pointer
5816 @opindex fomit-frame-pointer
5817 Don't keep the frame pointer in a register for functions that
5818 don't need one.  This avoids the instructions to save, set up and
5819 restore frame pointers; it also makes an extra register available
5820 in many functions.  @strong{It also makes debugging impossible on
5821 some machines.}
5823 On some machines, such as the VAX, this flag has no effect, because
5824 the standard calling sequence automatically handles the frame pointer
5825 and nothing is saved by pretending it doesn't exist.  The
5826 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5827 whether a target machine supports this flag.  @xref{Registers,,Register
5828 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5830 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5832 @item -foptimize-sibling-calls
5833 @opindex foptimize-sibling-calls
5834 Optimize sibling and tail recursive calls.
5836 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5838 @item -fno-inline
5839 @opindex fno-inline
5840 Don't pay attention to the @code{inline} keyword.  Normally this option
5841 is used to keep the compiler from expanding any functions inline.
5842 Note that if you are not optimizing, no functions can be expanded inline.
5844 @item -finline-small-functions
5845 @opindex finline-small-functions
5846 Integrate functions into their callers when their body is smaller than expected
5847 function call code (so overall size of program gets smaller).  The compiler
5848 heuristically decides which functions are simple enough to be worth integrating
5849 in this way.
5851 Enabled at level @option{-O2}.
5853 @item -findirect-inlining
5854 @opindex findirect-inlining
5855 Inline also indirect calls that are discovered to be known at compile
5856 time thanks to previous inlining.  This option has any effect only
5857 when inlining itself is turned on by the @option{-finline-functions}
5858 or @option{-finline-small-functions} options.
5860 Enabled at level @option{-O2}.
5862 @item -finline-functions
5863 @opindex finline-functions
5864 Integrate all simple functions into their callers.  The compiler
5865 heuristically decides which functions are simple enough to be worth
5866 integrating in this way.
5868 If all calls to a given function are integrated, and the function is
5869 declared @code{static}, then the function is normally not output as
5870 assembler code in its own right.
5872 Enabled at level @option{-O3}.
5874 @item -finline-functions-called-once
5875 @opindex finline-functions-called-once
5876 Consider all @code{static} functions called once for inlining into their
5877 caller even if they are not marked @code{inline}.  If a call to a given
5878 function is integrated, then the function is not output as assembler code
5879 in its own right.
5881 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5883 @item -fearly-inlining
5884 @opindex fearly-inlining
5885 Inline functions marked by @code{always_inline} and functions whose body seems
5886 smaller than the function call overhead early before doing
5887 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5888 makes profiling significantly cheaper and usually inlining faster on programs
5889 having large chains of nested wrapper functions.
5891 Enabled by default.
5893 @item -fipa-sra
5894 @opindex fipa-sra
5895 Perform interprocedural scalar replacement of aggregates, removal of
5896 unused parameters and replacement of parameters passed by reference
5897 by parameters passed by value.
5899 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
5901 @item -finline-limit=@var{n}
5902 @opindex finline-limit
5903 By default, GCC limits the size of functions that can be inlined.  This flag
5904 allows coarse control of this limit.  @var{n} is the size of functions that
5905 can be inlined in number of pseudo instructions.
5907 Inlining is actually controlled by a number of parameters, which may be
5908 specified individually by using @option{--param @var{name}=@var{value}}.
5909 The @option{-finline-limit=@var{n}} option sets some of these parameters
5910 as follows:
5912 @table @gcctabopt
5913 @item max-inline-insns-single
5914 is set to @var{n}/2.
5915 @item max-inline-insns-auto
5916 is set to @var{n}/2.
5917 @end table
5919 See below for a documentation of the individual
5920 parameters controlling inlining and for the defaults of these parameters.
5922 @emph{Note:} there may be no value to @option{-finline-limit} that results
5923 in default behavior.
5925 @emph{Note:} pseudo instruction represents, in this particular context, an
5926 abstract measurement of function's size.  In no way does it represent a count
5927 of assembly instructions and as such its exact meaning might change from one
5928 release to an another.
5930 @item -fkeep-inline-functions
5931 @opindex fkeep-inline-functions
5932 In C, emit @code{static} functions that are declared @code{inline}
5933 into the object file, even if the function has been inlined into all
5934 of its callers.  This switch does not affect functions using the
5935 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5936 inline functions into the object file.
5938 @item -fkeep-static-consts
5939 @opindex fkeep-static-consts
5940 Emit variables declared @code{static const} when optimization isn't turned
5941 on, even if the variables aren't referenced.
5943 GCC enables this option by default.  If you want to force the compiler to
5944 check if the variable was referenced, regardless of whether or not
5945 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5947 @item -fmerge-constants
5948 @opindex fmerge-constants
5949 Attempt to merge identical constants (string constants and floating point
5950 constants) across compilation units.
5952 This option is the default for optimized compilation if the assembler and
5953 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5954 behavior.
5956 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5958 @item -fmerge-all-constants
5959 @opindex fmerge-all-constants
5960 Attempt to merge identical constants and identical variables.
5962 This option implies @option{-fmerge-constants}.  In addition to
5963 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5964 arrays or initialized constant variables with integral or floating point
5965 types.  Languages like C or C++ require each variable, including multiple
5966 instances of the same variable in recursive calls, to have distinct locations,
5967 so using this option will result in non-conforming
5968 behavior.
5970 @item -fmodulo-sched
5971 @opindex fmodulo-sched
5972 Perform swing modulo scheduling immediately before the first scheduling
5973 pass.  This pass looks at innermost loops and reorders their
5974 instructions by overlapping different iterations.
5976 @item -fmodulo-sched-allow-regmoves
5977 @opindex fmodulo-sched-allow-regmoves
5978 Perform more aggressive SMS based modulo scheduling with register moves
5979 allowed.  By setting this flag certain anti-dependences edges will be
5980 deleted which will trigger the generation of reg-moves based on the
5981 life-range analysis.  This option is effective only with
5982 @option{-fmodulo-sched} enabled.
5984 @item -fno-branch-count-reg
5985 @opindex fno-branch-count-reg
5986 Do not use ``decrement and branch'' instructions on a count register,
5987 but instead generate a sequence of instructions that decrement a
5988 register, compare it against zero, then branch based upon the result.
5989 This option is only meaningful on architectures that support such
5990 instructions, which include x86, PowerPC, IA-64 and S/390.
5992 The default is @option{-fbranch-count-reg}.
5994 @item -fno-function-cse
5995 @opindex fno-function-cse
5996 Do not put function addresses in registers; make each instruction that
5997 calls a constant function contain the function's address explicitly.
5999 This option results in less efficient code, but some strange hacks
6000 that alter the assembler output may be confused by the optimizations
6001 performed when this option is not used.
6003 The default is @option{-ffunction-cse}
6005 @item -fno-zero-initialized-in-bss
6006 @opindex fno-zero-initialized-in-bss
6007 If the target supports a BSS section, GCC by default puts variables that
6008 are initialized to zero into BSS@.  This can save space in the resulting
6009 code.
6011 This option turns off this behavior because some programs explicitly
6012 rely on variables going to the data section.  E.g., so that the
6013 resulting executable can find the beginning of that section and/or make
6014 assumptions based on that.
6016 The default is @option{-fzero-initialized-in-bss}.
6018 @item -fmudflap -fmudflapth -fmudflapir
6019 @opindex fmudflap
6020 @opindex fmudflapth
6021 @opindex fmudflapir
6022 @cindex bounds checking
6023 @cindex mudflap
6024 For front-ends that support it (C and C++), instrument all risky
6025 pointer/array dereferencing operations, some standard library
6026 string/heap functions, and some other associated constructs with
6027 range/validity tests.  Modules so instrumented should be immune to
6028 buffer overflows, invalid heap use, and some other classes of C/C++
6029 programming errors.  The instrumentation relies on a separate runtime
6030 library (@file{libmudflap}), which will be linked into a program if
6031 @option{-fmudflap} is given at link time.  Run-time behavior of the
6032 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6033 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6034 for its options.
6036 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6037 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6038 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6039 instrumentation should ignore pointer reads.  This produces less
6040 instrumentation (and therefore faster execution) and still provides
6041 some protection against outright memory corrupting writes, but allows
6042 erroneously read data to propagate within a program.
6044 @item -fthread-jumps
6045 @opindex fthread-jumps
6046 Perform optimizations where we check to see if a jump branches to a
6047 location where another comparison subsumed by the first is found.  If
6048 so, the first branch is redirected to either the destination of the
6049 second branch or a point immediately following it, depending on whether
6050 the condition is known to be true or false.
6052 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6054 @item -fsplit-wide-types
6055 @opindex fsplit-wide-types
6056 When using a type that occupies multiple registers, such as @code{long
6057 long} on a 32-bit system, split the registers apart and allocate them
6058 independently.  This normally generates better code for those types,
6059 but may make debugging more difficult.
6061 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6062 @option{-Os}.
6064 @item -fcse-follow-jumps
6065 @opindex fcse-follow-jumps
6066 In common subexpression elimination (CSE), scan through jump instructions
6067 when the target of the jump is not reached by any other path.  For
6068 example, when CSE encounters an @code{if} statement with an
6069 @code{else} clause, CSE will follow the jump when the condition
6070 tested is false.
6072 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6074 @item -fcse-skip-blocks
6075 @opindex fcse-skip-blocks
6076 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6077 follow jumps which conditionally skip over blocks.  When CSE
6078 encounters a simple @code{if} statement with no else clause,
6079 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6080 body of the @code{if}.
6082 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6084 @item -frerun-cse-after-loop
6085 @opindex frerun-cse-after-loop
6086 Re-run common subexpression elimination after loop optimizations has been
6087 performed.
6089 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6091 @item -fgcse
6092 @opindex fgcse
6093 Perform a global common subexpression elimination pass.
6094 This pass also performs global constant and copy propagation.
6096 @emph{Note:} When compiling a program using computed gotos, a GCC
6097 extension, you may get better runtime performance if you disable
6098 the global common subexpression elimination pass by adding
6099 @option{-fno-gcse} to the command line.
6101 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6103 @item -fgcse-lm
6104 @opindex fgcse-lm
6105 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6106 attempt to move loads which are only killed by stores into themselves.  This
6107 allows a loop containing a load/store sequence to be changed to a load outside
6108 the loop, and a copy/store within the loop.
6110 Enabled by default when gcse is enabled.
6112 @item -fgcse-sm
6113 @opindex fgcse-sm
6114 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6115 global common subexpression elimination.  This pass will attempt to move
6116 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6117 loops containing a load/store sequence can be changed to a load before
6118 the loop and a store after the loop.
6120 Not enabled at any optimization level.
6122 @item -fgcse-las
6123 @opindex fgcse-las
6124 When @option{-fgcse-las} is enabled, the global common subexpression
6125 elimination pass eliminates redundant loads that come after stores to the
6126 same memory location (both partial and full redundancies).
6128 Not enabled at any optimization level.
6130 @item -fgcse-after-reload
6131 @opindex fgcse-after-reload
6132 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6133 pass is performed after reload.  The purpose of this pass is to cleanup
6134 redundant spilling.
6136 @item -funsafe-loop-optimizations
6137 @opindex funsafe-loop-optimizations
6138 If given, the loop optimizer will assume that loop indices do not
6139 overflow, and that the loops with nontrivial exit condition are not
6140 infinite.  This enables a wider range of loop optimizations even if
6141 the loop optimizer itself cannot prove that these assumptions are valid.
6142 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6143 if it finds this kind of loop.
6145 @item -fcrossjumping
6146 @opindex fcrossjumping
6147 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6148 resulting code may or may not perform better than without cross-jumping.
6150 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6152 @item -fauto-inc-dec
6153 @opindex fauto-inc-dec
6154 Combine increments or decrements of addresses with memory accesses.
6155 This pass is always skipped on architectures that do not have
6156 instructions to support this.  Enabled by default at @option{-O} and
6157 higher on architectures that support this.
6159 @item -fdce
6160 @opindex fdce
6161 Perform dead code elimination (DCE) on RTL@.
6162 Enabled by default at @option{-O} and higher.
6164 @item -fdse
6165 @opindex fdse
6166 Perform dead store elimination (DSE) on RTL@.
6167 Enabled by default at @option{-O} and higher.
6169 @item -fif-conversion
6170 @opindex fif-conversion
6171 Attempt to transform conditional jumps into branch-less equivalents.  This
6172 include use of conditional moves, min, max, set flags and abs instructions, and
6173 some tricks doable by standard arithmetics.  The use of conditional execution
6174 on chips where it is available is controlled by @code{if-conversion2}.
6176 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6178 @item -fif-conversion2
6179 @opindex fif-conversion2
6180 Use conditional execution (where available) to transform conditional jumps into
6181 branch-less equivalents.
6183 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6185 @item -fdelete-null-pointer-checks
6186 @opindex fdelete-null-pointer-checks
6187 Assume that programs cannot safely dereference null pointers, and that
6188 no code or data element resides there.  This enables simple constant
6189 folding optimizations at all optimization levels.  In addition, other
6190 optimization passes in GCC use this flag to control global dataflow
6191 analyses that eliminate useless checks for null pointers; these assume
6192 that if a pointer is checked after it has already been dereferenced,
6193 it cannot be null.
6195 Note however that in some environments this assumption is not true.
6196 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6197 for programs which depend on that behavior.
6199 Some targets, especially embedded ones, disable this option at all levels.
6200 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6201 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6202 are enabled independently at different optimization levels.
6204 @item -fexpensive-optimizations
6205 @opindex fexpensive-optimizations
6206 Perform a number of minor optimizations that are relatively expensive.
6208 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6210 @item -foptimize-register-move
6211 @itemx -fregmove
6212 @opindex foptimize-register-move
6213 @opindex fregmove
6214 Attempt to reassign register numbers in move instructions and as
6215 operands of other simple instructions in order to maximize the amount of
6216 register tying.  This is especially helpful on machines with two-operand
6217 instructions.
6219 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6220 optimization.
6222 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6224 @item -fira-algorithm=@var{algorithm}
6225 Use specified coloring algorithm for the integrated register
6226 allocator.  The @var{algorithm} argument should be @code{priority} or
6227 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6228 the second one specifies Chaitin-Briggs coloring.  The second
6229 algorithm can be unimplemented for some architectures.  If it is
6230 implemented, it is the default because Chaitin-Briggs coloring as a
6231 rule generates a better code.
6233 @item -fira-region=@var{region}
6234 Use specified regions for the integrated register allocator.  The
6235 @var{region} argument should be one of @code{all}, @code{mixed}, or
6236 @code{one}.  The first value means using all loops as register
6237 allocation regions, the second value which is the default means using
6238 all loops except for loops with small register pressure as the
6239 regions, and third one means using all function as a single region.
6240 The first value can give best result for machines with small size and
6241 irregular register set, the third one results in faster and generates
6242 decent code and the smallest size code, and the default value usually
6243 give the best results in most cases and for most architectures.
6245 @item -fira-coalesce
6246 @opindex fira-coalesce
6247 Do optimistic register coalescing.  This option might be profitable for
6248 architectures with big regular register files.
6250 @item -fira-loop-pressure
6251 @opindex fira-loop-pressure
6252 Use IRA to evaluate register pressure in loops for decision to move
6253 loop invariants.  Usage of this option usually results in generation
6254 of faster and smaller code on machines with big register files (>= 32
6255 registers) but it can slow compiler down.
6257 This option is enabled at level @option{-O3} for some targets.
6259 @item -fno-ira-share-save-slots
6260 @opindex fno-ira-share-save-slots
6261 Switch off sharing stack slots used for saving call used hard
6262 registers living through a call.  Each hard register will get a
6263 separate stack slot and as a result function stack frame will be
6264 bigger.
6266 @item -fno-ira-share-spill-slots
6267 @opindex fno-ira-share-spill-slots
6268 Switch off sharing stack slots allocated for pseudo-registers.  Each
6269 pseudo-register which did not get a hard register will get a separate
6270 stack slot and as a result function stack frame will be bigger.
6272 @item -fira-verbose=@var{n}
6273 @opindex fira-verbose
6274 Set up how verbose dump file for the integrated register allocator
6275 will be.  Default value is 5.  If the value is greater or equal to 10,
6276 the dump file will be stderr as if the value were @var{n} minus 10.
6278 @item -fdelayed-branch
6279 @opindex fdelayed-branch
6280 If supported for the target machine, attempt to reorder instructions
6281 to exploit instruction slots available after delayed branch
6282 instructions.
6284 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6286 @item -fschedule-insns
6287 @opindex fschedule-insns
6288 If supported for the target machine, attempt to reorder instructions to
6289 eliminate execution stalls due to required data being unavailable.  This
6290 helps machines that have slow floating point or memory load instructions
6291 by allowing other instructions to be issued until the result of the load
6292 or floating point instruction is required.
6294 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6296 @item -fschedule-insns2
6297 @opindex fschedule-insns2
6298 Similar to @option{-fschedule-insns}, but requests an additional pass of
6299 instruction scheduling after register allocation has been done.  This is
6300 especially useful on machines with a relatively small number of
6301 registers and where memory load instructions take more than one cycle.
6303 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6305 @item -fno-sched-interblock
6306 @opindex fno-sched-interblock
6307 Don't schedule instructions across basic blocks.  This is normally
6308 enabled by default when scheduling before register allocation, i.e.@:
6309 with @option{-fschedule-insns} or at @option{-O2} or higher.
6311 @item -fno-sched-spec
6312 @opindex fno-sched-spec
6313 Don't allow speculative motion of non-load instructions.  This is normally
6314 enabled by default when scheduling before register allocation, i.e.@:
6315 with @option{-fschedule-insns} or at @option{-O2} or higher.
6317 @item -fsched-pressure
6318 @opindex fsched-pressure
6319 Enable register pressure sensitive insn scheduling before the register
6320 allocation.  This only makes sense when scheduling before register
6321 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6322 @option{-O2} or higher.  Usage of this option can improve the
6323 generated code and decrease its size by preventing register pressure
6324 increase above the number of available hard registers and as a
6325 consequence register spills in the register allocation.
6327 @item -fsched-spec-load
6328 @opindex fsched-spec-load
6329 Allow speculative motion of some load instructions.  This only makes
6330 sense when scheduling before register allocation, i.e.@: with
6331 @option{-fschedule-insns} or at @option{-O2} or higher.
6333 @item -fsched-spec-load-dangerous
6334 @opindex fsched-spec-load-dangerous
6335 Allow speculative motion of more load instructions.  This only makes
6336 sense when scheduling before register allocation, i.e.@: with
6337 @option{-fschedule-insns} or at @option{-O2} or higher.
6339 @item -fsched-stalled-insns
6340 @itemx -fsched-stalled-insns=@var{n}
6341 @opindex fsched-stalled-insns
6342 Define how many insns (if any) can be moved prematurely from the queue
6343 of stalled insns into the ready list, during the second scheduling pass.
6344 @option{-fno-sched-stalled-insns} means that no insns will be moved
6345 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6346 on how many queued insns can be moved prematurely.
6347 @option{-fsched-stalled-insns} without a value is equivalent to
6348 @option{-fsched-stalled-insns=1}.
6350 @item -fsched-stalled-insns-dep
6351 @itemx -fsched-stalled-insns-dep=@var{n}
6352 @opindex fsched-stalled-insns-dep
6353 Define how many insn groups (cycles) will be examined for a dependency
6354 on a stalled insn that is candidate for premature removal from the queue
6355 of stalled insns.  This has an effect only during the second scheduling pass,
6356 and only if @option{-fsched-stalled-insns} is used.
6357 @option{-fno-sched-stalled-insns-dep} is equivalent to
6358 @option{-fsched-stalled-insns-dep=0}.
6359 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6360 @option{-fsched-stalled-insns-dep=1}.
6362 @item -fsched2-use-superblocks
6363 @opindex fsched2-use-superblocks
6364 When scheduling after register allocation, do use superblock scheduling
6365 algorithm.  Superblock scheduling allows motion across basic block boundaries
6366 resulting on faster schedules.  This option is experimental, as not all machine
6367 descriptions used by GCC model the CPU closely enough to avoid unreliable
6368 results from the algorithm.
6370 This only makes sense when scheduling after register allocation, i.e.@: with
6371 @option{-fschedule-insns2} or at @option{-O2} or higher.
6373 @item -fsched-group-heuristic
6374 @opindex fsched-group-heuristic
6375 Enable the group heuristic in the scheduler.  This heuristic favors 
6376 the instruction that belongs to a schedule group.  This is enabled 
6377 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6378 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6380 @item -fsched-critical-path-heuristic
6381 @opindex fsched-critical-path-heuristic
6382 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6383 instructions on the critical path.  This is enabled by default when 
6384 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6385 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6387 @item -fsched-spec-insn-heuristic
6388 @opindex fsched-spec-insn-heuristic
6389 Enable the speculative instruction heuristic in the scheduler.  This 
6390 heuristic favors speculative instructions with greater dependency weakness.  
6391 This is enabled by default when scheduling is enabled, i.e.@: 
6392 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6393 or at @option{-O2} or higher.
6395 @item -fsched-rank-heuristic
6396 @opindex fsched-rank-heuristic
6397 Enable the rank heuristic in the scheduler.  This heuristic favors 
6398 the instruction belonging to a basic block with greater size or frequency.  
6399 This is enabled by default when scheduling is enabled, i.e.@: 
6400 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6401 at @option{-O2} or higher.
6403 @item -fsched-last-insn-heuristic
6404 @opindex fsched-last-insn-heuristic
6405 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6406 favors the instruction that is less dependent on the last instruction
6407 scheduled.  This is enabled by default when scheduling is enabled, 
6408 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6409 at @option{-O2} or higher.
6411 @item -fsched-dep-count-heuristic
6412 @opindex fsched-dep-count-heuristic
6413 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6414 favors the instruction that has more instructions depending on it.  
6415 This is enabled by default when scheduling is enabled, i.e.@: 
6416 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6417 at @option{-O2} or higher.
6419 @item -fsched2-use-traces
6420 @opindex fsched2-use-traces
6421 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
6422 allocation and additionally perform code duplication in order to increase the
6423 size of superblocks using tracer pass.  See @option{-ftracer} for details on
6424 trace formation.
6426 This mode should produce faster but significantly longer programs.  Also
6427 without @option{-fbranch-probabilities} the traces constructed may not
6428 match the reality and hurt the performance.  This only makes
6429 sense when scheduling after register allocation, i.e.@: with
6430 @option{-fschedule-insns2} or at @option{-O2} or higher.
6432 @item -freschedule-modulo-scheduled-loops
6433 @opindex freschedule-modulo-scheduled-loops
6434 The modulo scheduling comes before the traditional scheduling, if a loop
6435 was modulo scheduled we may want to prevent the later scheduling passes
6436 from changing its schedule, we use this option to control that.
6438 @item -fselective-scheduling
6439 @opindex fselective-scheduling
6440 Schedule instructions using selective scheduling algorithm.  Selective
6441 scheduling runs instead of the first scheduler pass.
6443 @item -fselective-scheduling2
6444 @opindex fselective-scheduling2
6445 Schedule instructions using selective scheduling algorithm.  Selective
6446 scheduling runs instead of the second scheduler pass.
6448 @item -fsel-sched-pipelining
6449 @opindex fsel-sched-pipelining
6450 Enable software pipelining of innermost loops during selective scheduling.
6451 This option has no effect until one of @option{-fselective-scheduling} or
6452 @option{-fselective-scheduling2} is turned on.
6454 @item -fsel-sched-pipelining-outer-loops
6455 @opindex fsel-sched-pipelining-outer-loops
6456 When pipelining loops during selective scheduling, also pipeline outer loops.
6457 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6459 @item -fcaller-saves
6460 @opindex fcaller-saves
6461 Enable values to be allocated in registers that will be clobbered by
6462 function calls, by emitting extra instructions to save and restore the
6463 registers around such calls.  Such allocation is done only when it
6464 seems to result in better code than would otherwise be produced.
6466 This option is always enabled by default on certain machines, usually
6467 those which have no call-preserved registers to use instead.
6469 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6471 @item -fconserve-stack
6472 @opindex fconserve-stack
6473 Attempt to minimize stack usage.  The compiler will attempt to use less
6474 stack space, even if that makes the program slower.  This option
6475 implies setting the @option{large-stack-frame} parameter to 100
6476 and the @option{large-stack-frame-growth} parameter to 400.
6478 @item -ftree-reassoc
6479 @opindex ftree-reassoc
6480 Perform reassociation on trees.  This flag is enabled by default
6481 at @option{-O} and higher.
6483 @item -ftree-pre
6484 @opindex ftree-pre
6485 Perform partial redundancy elimination (PRE) on trees.  This flag is
6486 enabled by default at @option{-O2} and @option{-O3}.
6488 @item -ftree-forwprop
6489 @opindex ftree-forwprop
6490 Perform forward propagation on trees.  This flag is enabled by default
6491 at @option{-O} and higher.
6493 @item -ftree-fre
6494 @opindex ftree-fre
6495 Perform full redundancy elimination (FRE) on trees.  The difference
6496 between FRE and PRE is that FRE only considers expressions
6497 that are computed on all paths leading to the redundant computation.
6498 This analysis is faster than PRE, though it exposes fewer redundancies.
6499 This flag is enabled by default at @option{-O} and higher.
6501 @item -ftree-phiprop
6502 @opindex ftree-phiprop
6503 Perform hoisting of loads from conditional pointers on trees.  This
6504 pass is enabled by default at @option{-O} and higher.
6506 @item -ftree-copy-prop
6507 @opindex ftree-copy-prop
6508 Perform copy propagation on trees.  This pass eliminates unnecessary
6509 copy operations.  This flag is enabled by default at @option{-O} and
6510 higher.
6512 @item -fipa-pure-const
6513 @opindex fipa-pure-const
6514 Discover which functions are pure or constant.
6515 Enabled by default at @option{-O} and higher.
6517 @item -fipa-reference
6518 @opindex fipa-reference
6519 Discover which static variables do not escape cannot escape the
6520 compilation unit.
6521 Enabled by default at @option{-O} and higher.
6523 @item -fipa-struct-reorg
6524 @opindex fipa-struct-reorg
6525 Perform structure reorganization optimization, that change C-like structures
6526 layout in order to better utilize spatial locality.  This transformation is
6527 affective for programs containing arrays of structures.  Available in two
6528 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6529 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6530 to provide the safety of this transformation.  It works only in whole program
6531 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6532 enabled.  Structures considered @samp{cold} by this transformation are not
6533 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6535 With this flag, the program debug info reflects a new structure layout.
6537 @item -fipa-pta
6538 @opindex fipa-pta
6539 Perform interprocedural pointer analysis.  This option is experimental
6540 and does not affect generated code.
6542 @item -fipa-cp
6543 @opindex fipa-cp
6544 Perform interprocedural constant propagation.
6545 This optimization analyzes the program to determine when values passed
6546 to functions are constants and then optimizes accordingly.
6547 This optimization can substantially increase performance
6548 if the application has constants passed to functions.
6549 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6551 @item -fipa-cp-clone
6552 @opindex fipa-cp-clone
6553 Perform function cloning to make interprocedural constant propagation stronger.
6554 When enabled, interprocedural constant propagation will perform function cloning
6555 when externally visible function can be called with constant arguments.
6556 Because this optimization can create multiple copies of functions,
6557 it may significantly increase code size
6558 (see @option{--param ipcp-unit-growth=@var{value}}).
6559 This flag is enabled by default at @option{-O3}.
6561 @item -fipa-matrix-reorg
6562 @opindex fipa-matrix-reorg
6563 Perform matrix flattening and transposing.
6564 Matrix flattening tries to replace an @math{m}-dimensional matrix
6565 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6566 This reduces the level of indirection needed for accessing the elements
6567 of the matrix. The second optimization is matrix transposing that
6568 attempts to change the order of the matrix's dimensions in order to
6569 improve cache locality.
6570 Both optimizations need the @option{-fwhole-program} flag.
6571 Transposing is enabled only if profiling information is available.
6573 @item -ftree-sink
6574 @opindex ftree-sink
6575 Perform forward store motion  on trees.  This flag is
6576 enabled by default at @option{-O} and higher.
6578 @item -ftree-ccp
6579 @opindex ftree-ccp
6580 Perform sparse conditional constant propagation (CCP) on trees.  This
6581 pass only operates on local scalar variables and is enabled by default
6582 at @option{-O} and higher.
6584 @item -ftree-switch-conversion
6585 Perform conversion of simple initializations in a switch to
6586 initializations from a scalar array.  This flag is enabled by default
6587 at @option{-O2} and higher.
6589 @item -ftree-dce
6590 @opindex ftree-dce
6591 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6592 default at @option{-O} and higher.
6594 @item -ftree-builtin-call-dce
6595 @opindex ftree-builtin-call-dce
6596 Perform conditional dead code elimination (DCE) for calls to builtin functions
6597 that may set @code{errno} but are otherwise side-effect free.  This flag is
6598 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6599 specified.
6601 @item -ftree-dominator-opts
6602 @opindex ftree-dominator-opts
6603 Perform a variety of simple scalar cleanups (constant/copy
6604 propagation, redundancy elimination, range propagation and expression
6605 simplification) based on a dominator tree traversal.  This also
6606 performs jump threading (to reduce jumps to jumps). This flag is
6607 enabled by default at @option{-O} and higher.
6609 @item -ftree-dse
6610 @opindex ftree-dse
6611 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6612 a memory location which will later be overwritten by another store without
6613 any intervening loads.  In this case the earlier store can be deleted.  This
6614 flag is enabled by default at @option{-O} and higher.
6616 @item -ftree-ch
6617 @opindex ftree-ch
6618 Perform loop header copying on trees.  This is beneficial since it increases
6619 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6620 is enabled by default at @option{-O} and higher.  It is not enabled
6621 for @option{-Os}, since it usually increases code size.
6623 @item -ftree-loop-optimize
6624 @opindex ftree-loop-optimize
6625 Perform loop optimizations on trees.  This flag is enabled by default
6626 at @option{-O} and higher.
6628 @item -ftree-loop-linear
6629 @opindex ftree-loop-linear
6630 Perform linear loop transformations on tree.  This flag can improve cache
6631 performance and allow further loop optimizations to take place.
6633 @item -floop-interchange
6634 Perform loop interchange transformations on loops.  Interchanging two
6635 nested loops switches the inner and outer loops.  For example, given a
6636 loop like:
6637 @smallexample
6638 DO J = 1, M
6639   DO I = 1, N
6640     A(J, I) = A(J, I) * C
6641   ENDDO
6642 ENDDO
6643 @end smallexample
6644 loop interchange will transform the loop as if the user had written:
6645 @smallexample
6646 DO I = 1, N
6647   DO J = 1, M
6648     A(J, I) = A(J, I) * C
6649   ENDDO
6650 ENDDO
6651 @end smallexample
6652 which can be beneficial when @code{N} is larger than the caches,
6653 because in Fortran, the elements of an array are stored in memory
6654 contiguously by column, and the original loop iterates over rows,
6655 potentially creating at each access a cache miss.  This optimization
6656 applies to all the languages supported by GCC and is not limited to
6657 Fortran.  To use this code transformation, GCC has to be configured
6658 with @option{--with-ppl} and @option{--with-cloog} to enable the
6659 Graphite loop transformation infrastructure.
6661 @item -floop-strip-mine
6662 Perform loop strip mining transformations on loops.  Strip mining
6663 splits a loop into two nested loops.  The outer loop has strides
6664 equal to the strip size and the inner loop has strides of the
6665 original loop within a strip.  For example, given a loop like:
6666 @smallexample
6667 DO I = 1, N
6668   A(I) = A(I) + C
6669 ENDDO
6670 @end smallexample
6671 loop strip mining will transform the loop as if the user had written:
6672 @smallexample
6673 DO II = 1, N, 4
6674   DO I = II, min (II + 3, N)
6675     A(I) = A(I) + C
6676   ENDDO
6677 ENDDO
6678 @end smallexample
6679 This optimization applies to all the languages supported by GCC and is
6680 not limited to Fortran.  To use this code transformation, GCC has to
6681 be configured with @option{--with-ppl} and @option{--with-cloog} to
6682 enable the Graphite loop transformation infrastructure.
6684 @item -floop-block
6685 Perform loop blocking transformations on loops.  Blocking strip mines
6686 each loop in the loop nest such that the memory accesses of the
6687 element loops fit inside caches.  For example, given a loop like:
6688 @smallexample
6689 DO I = 1, N
6690   DO J = 1, M
6691     A(J, I) = B(I) + C(J)
6692   ENDDO
6693 ENDDO
6694 @end smallexample
6695 loop blocking will transform the loop as if the user had written:
6696 @smallexample
6697 DO II = 1, N, 64
6698   DO JJ = 1, M, 64
6699     DO I = II, min (II + 63, N)
6700       DO J = JJ, min (JJ + 63, M)
6701         A(J, I) = B(I) + C(J)
6702       ENDDO
6703     ENDDO
6704   ENDDO
6705 ENDDO
6706 @end smallexample
6707 which can be beneficial when @code{M} is larger than the caches,
6708 because the innermost loop will iterate over a smaller amount of data
6709 that can be kept in the caches.  This optimization applies to all the
6710 languages supported by GCC and is not limited to Fortran.  To use this
6711 code transformation, GCC has to be configured with @option{--with-ppl}
6712 and @option{--with-cloog} to enable the Graphite loop transformation
6713 infrastructure.
6715 @item -fgraphite-identity
6716 @opindex fgraphite-identity
6717 Enable the identity transformation for graphite.  For every SCoP we generate
6718 the polyhedral representation and transform it back to gimple.  Using
6719 @option{-fgraphite-identity} we can check the costs or benefits of the
6720 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6721 are also performed by the code generator CLooG, like index splitting and
6722 dead code elimination in loops.
6724 @item -floop-parallelize-all
6725 Use the Graphite data dependence analysis to identify loops that can
6726 be parallelized.  Parallelize all the loops that can be analyzed to
6727 not contain loop carried dependences without checking that it is
6728 profitable to parallelize the loops.
6730 @item -fcheck-data-deps
6731 @opindex fcheck-data-deps
6732 Compare the results of several data dependence analyzers.  This option
6733 is used for debugging the data dependence analyzers.
6735 @item -ftree-loop-distribution
6736 Perform loop distribution.  This flag can improve cache performance on
6737 big loop bodies and allow further loop optimizations, like
6738 parallelization or vectorization, to take place.  For example, the loop
6739 @smallexample
6740 DO I = 1, N
6741   A(I) = B(I) + C
6742   D(I) = E(I) * F
6743 ENDDO
6744 @end smallexample
6745 is transformed to
6746 @smallexample
6747 DO I = 1, N
6748    A(I) = B(I) + C
6749 ENDDO
6750 DO I = 1, N
6751    D(I) = E(I) * F
6752 ENDDO
6753 @end smallexample
6755 @item -ftree-loop-im
6756 @opindex ftree-loop-im
6757 Perform loop invariant motion on trees.  This pass moves only invariants that
6758 would be hard to handle at RTL level (function calls, operations that expand to
6759 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6760 operands of conditions that are invariant out of the loop, so that we can use
6761 just trivial invariantness analysis in loop unswitching.  The pass also includes
6762 store motion.
6764 @item -ftree-loop-ivcanon
6765 @opindex ftree-loop-ivcanon
6766 Create a canonical counter for number of iterations in the loop for that
6767 determining number of iterations requires complicated analysis.  Later
6768 optimizations then may determine the number easily.  Useful especially
6769 in connection with unrolling.
6771 @item -fivopts
6772 @opindex fivopts
6773 Perform induction variable optimizations (strength reduction, induction
6774 variable merging and induction variable elimination) on trees.
6776 @item -ftree-parallelize-loops=n
6777 @opindex ftree-parallelize-loops
6778 Parallelize loops, i.e., split their iteration space to run in n threads.
6779 This is only possible for loops whose iterations are independent
6780 and can be arbitrarily reordered.  The optimization is only
6781 profitable on multiprocessor machines, for loops that are CPU-intensive,
6782 rather than constrained e.g.@: by memory bandwidth.  This option
6783 implies @option{-pthread}, and thus is only supported on targets
6784 that have support for @option{-pthread}.
6786 @item -ftree-pta
6787 @opindex ftree-pta
6788 Perform function-local points-to analysis on trees.  This flag is
6789 enabled by default at @option{-O} and higher.
6791 @item -ftree-sra
6792 @opindex ftree-sra
6793 Perform scalar replacement of aggregates.  This pass replaces structure
6794 references with scalars to prevent committing structures to memory too
6795 early.  This flag is enabled by default at @option{-O} and higher.
6797 @item -ftree-copyrename
6798 @opindex ftree-copyrename
6799 Perform copy renaming on trees.  This pass attempts to rename compiler
6800 temporaries to other variables at copy locations, usually resulting in
6801 variable names which more closely resemble the original variables.  This flag
6802 is enabled by default at @option{-O} and higher.
6804 @item -ftree-ter
6805 @opindex ftree-ter
6806 Perform temporary expression replacement during the SSA->normal phase.  Single
6807 use/single def temporaries are replaced at their use location with their
6808 defining expression.  This results in non-GIMPLE code, but gives the expanders
6809 much more complex trees to work on resulting in better RTL generation.  This is
6810 enabled by default at @option{-O} and higher.
6812 @item -ftree-vectorize
6813 @opindex ftree-vectorize
6814 Perform loop vectorization on trees. This flag is enabled by default at
6815 @option{-O3}.
6817 @item -ftree-vect-loop-version
6818 @opindex ftree-vect-loop-version
6819 Perform loop versioning when doing loop vectorization on trees.  When a loop
6820 appears to be vectorizable except that data alignment or data dependence cannot
6821 be determined at compile time then vectorized and non-vectorized versions of
6822 the loop are generated along with runtime checks for alignment or dependence
6823 to control which version is executed.  This option is enabled by default
6824 except at level @option{-Os} where it is disabled.
6826 @item -fvect-cost-model
6827 @opindex fvect-cost-model
6828 Enable cost model for vectorization.
6830 @item -ftree-vrp
6831 @opindex ftree-vrp
6832 Perform Value Range Propagation on trees.  This is similar to the
6833 constant propagation pass, but instead of values, ranges of values are
6834 propagated.  This allows the optimizers to remove unnecessary range
6835 checks like array bound checks and null pointer checks.  This is
6836 enabled by default at @option{-O2} and higher.  Null pointer check
6837 elimination is only done if @option{-fdelete-null-pointer-checks} is
6838 enabled.
6840 @item -ftracer
6841 @opindex ftracer
6842 Perform tail duplication to enlarge superblock size.  This transformation
6843 simplifies the control flow of the function allowing other optimizations to do
6844 better job.
6846 @item -funroll-loops
6847 @opindex funroll-loops
6848 Unroll loops whose number of iterations can be determined at compile
6849 time or upon entry to the loop.  @option{-funroll-loops} implies
6850 @option{-frerun-cse-after-loop}.  This option makes code larger,
6851 and may or may not make it run faster.
6853 @item -funroll-all-loops
6854 @opindex funroll-all-loops
6855 Unroll all loops, even if their number of iterations is uncertain when
6856 the loop is entered.  This usually makes programs run more slowly.
6857 @option{-funroll-all-loops} implies the same options as
6858 @option{-funroll-loops},
6860 @item -fsplit-ivs-in-unroller
6861 @opindex fsplit-ivs-in-unroller
6862 Enables expressing of values of induction variables in later iterations
6863 of the unrolled loop using the value in the first iteration.  This breaks
6864 long dependency chains, thus improving efficiency of the scheduling passes.
6866 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6867 same effect.  However in cases the loop body is more complicated than
6868 a single basic block, this is not reliable.  It also does not work at all
6869 on some of the architectures due to restrictions in the CSE pass.
6871 This optimization is enabled by default.
6873 @item -fvariable-expansion-in-unroller
6874 @opindex fvariable-expansion-in-unroller
6875 With this option, the compiler will create multiple copies of some
6876 local variables when unrolling a loop which can result in superior code.
6878 @item -fpredictive-commoning
6879 @opindex fpredictive-commoning
6880 Perform predictive commoning optimization, i.e., reusing computations
6881 (especially memory loads and stores) performed in previous
6882 iterations of loops.
6884 This option is enabled at level @option{-O3}.
6886 @item -fprefetch-loop-arrays
6887 @opindex fprefetch-loop-arrays
6888 If supported by the target machine, generate instructions to prefetch
6889 memory to improve the performance of loops that access large arrays.
6891 This option may generate better or worse code; results are highly
6892 dependent on the structure of loops within the source code.
6894 Disabled at level @option{-Os}.
6896 @item -fno-peephole
6897 @itemx -fno-peephole2
6898 @opindex fno-peephole
6899 @opindex fno-peephole2
6900 Disable any machine-specific peephole optimizations.  The difference
6901 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6902 are implemented in the compiler; some targets use one, some use the
6903 other, a few use both.
6905 @option{-fpeephole} is enabled by default.
6906 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6908 @item -fno-guess-branch-probability
6909 @opindex fno-guess-branch-probability
6910 Do not guess branch probabilities using heuristics.
6912 GCC will use heuristics to guess branch probabilities if they are
6913 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6914 heuristics are based on the control flow graph.  If some branch probabilities
6915 are specified by @samp{__builtin_expect}, then the heuristics will be
6916 used to guess branch probabilities for the rest of the control flow graph,
6917 taking the @samp{__builtin_expect} info into account.  The interactions
6918 between the heuristics and @samp{__builtin_expect} can be complex, and in
6919 some cases, it may be useful to disable the heuristics so that the effects
6920 of @samp{__builtin_expect} are easier to understand.
6922 The default is @option{-fguess-branch-probability} at levels
6923 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6925 @item -freorder-blocks
6926 @opindex freorder-blocks
6927 Reorder basic blocks in the compiled function in order to reduce number of
6928 taken branches and improve code locality.
6930 Enabled at levels @option{-O2}, @option{-O3}.
6932 @item -freorder-blocks-and-partition
6933 @opindex freorder-blocks-and-partition
6934 In addition to reordering basic blocks in the compiled function, in order
6935 to reduce number of taken branches, partitions hot and cold basic blocks
6936 into separate sections of the assembly and .o files, to improve
6937 paging and cache locality performance.
6939 This optimization is automatically turned off in the presence of
6940 exception handling, for linkonce sections, for functions with a user-defined
6941 section attribute and on any architecture that does not support named
6942 sections.
6944 @item -freorder-functions
6945 @opindex freorder-functions
6946 Reorder functions in the object file in order to
6947 improve code locality.  This is implemented by using special
6948 subsections @code{.text.hot} for most frequently executed functions and
6949 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6950 the linker so object file format must support named sections and linker must
6951 place them in a reasonable way.
6953 Also profile feedback must be available in to make this option effective.  See
6954 @option{-fprofile-arcs} for details.
6956 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6958 @item -fstrict-aliasing
6959 @opindex fstrict-aliasing
6960 Allow the compiler to assume the strictest aliasing rules applicable to
6961 the language being compiled.  For C (and C++), this activates
6962 optimizations based on the type of expressions.  In particular, an
6963 object of one type is assumed never to reside at the same address as an
6964 object of a different type, unless the types are almost the same.  For
6965 example, an @code{unsigned int} can alias an @code{int}, but not a
6966 @code{void*} or a @code{double}.  A character type may alias any other
6967 type.
6969 @anchor{Type-punning}Pay special attention to code like this:
6970 @smallexample
6971 union a_union @{
6972   int i;
6973   double d;
6976 int f() @{
6977   union a_union t;
6978   t.d = 3.0;
6979   return t.i;
6981 @end smallexample
6982 The practice of reading from a different union member than the one most
6983 recently written to (called ``type-punning'') is common.  Even with
6984 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6985 is accessed through the union type.  So, the code above will work as
6986 expected.  @xref{Structures unions enumerations and bit-fields
6987 implementation}.  However, this code might not:
6988 @smallexample
6989 int f() @{
6990   union a_union t;
6991   int* ip;
6992   t.d = 3.0;
6993   ip = &t.i;
6994   return *ip;
6996 @end smallexample
6998 Similarly, access by taking the address, casting the resulting pointer
6999 and dereferencing the result has undefined behavior, even if the cast
7000 uses a union type, e.g.:
7001 @smallexample
7002 int f() @{
7003   double d = 3.0;
7004   return ((union a_union *) &d)->i;
7006 @end smallexample
7008 The @option{-fstrict-aliasing} option is enabled at levels
7009 @option{-O2}, @option{-O3}, @option{-Os}.
7011 @item -fstrict-overflow
7012 @opindex fstrict-overflow
7013 Allow the compiler to assume strict signed overflow rules, depending
7014 on the language being compiled.  For C (and C++) this means that
7015 overflow when doing arithmetic with signed numbers is undefined, which
7016 means that the compiler may assume that it will not happen.  This
7017 permits various optimizations.  For example, the compiler will assume
7018 that an expression like @code{i + 10 > i} will always be true for
7019 signed @code{i}.  This assumption is only valid if signed overflow is
7020 undefined, as the expression is false if @code{i + 10} overflows when
7021 using twos complement arithmetic.  When this option is in effect any
7022 attempt to determine whether an operation on signed numbers will
7023 overflow must be written carefully to not actually involve overflow.
7025 This option also allows the compiler to assume strict pointer
7026 semantics: given a pointer to an object, if adding an offset to that
7027 pointer does not produce a pointer to the same object, the addition is
7028 undefined.  This permits the compiler to conclude that @code{p + u >
7029 p} is always true for a pointer @code{p} and unsigned integer
7030 @code{u}.  This assumption is only valid because pointer wraparound is
7031 undefined, as the expression is false if @code{p + u} overflows using
7032 twos complement arithmetic.
7034 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7035 that integer signed overflow is fully defined: it wraps.  When
7036 @option{-fwrapv} is used, there is no difference between
7037 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7038 integers.  With @option{-fwrapv} certain types of overflow are
7039 permitted.  For example, if the compiler gets an overflow when doing
7040 arithmetic on constants, the overflowed value can still be used with
7041 @option{-fwrapv}, but not otherwise.
7043 The @option{-fstrict-overflow} option is enabled at levels
7044 @option{-O2}, @option{-O3}, @option{-Os}.
7046 @item -falign-functions
7047 @itemx -falign-functions=@var{n}
7048 @opindex falign-functions
7049 Align the start of functions to the next power-of-two greater than
7050 @var{n}, skipping up to @var{n} bytes.  For instance,
7051 @option{-falign-functions=32} aligns functions to the next 32-byte
7052 boundary, but @option{-falign-functions=24} would align to the next
7053 32-byte boundary only if this can be done by skipping 23 bytes or less.
7055 @option{-fno-align-functions} and @option{-falign-functions=1} are
7056 equivalent and mean that functions will not be aligned.
7058 Some assemblers only support this flag when @var{n} is a power of two;
7059 in that case, it is rounded up.
7061 If @var{n} is not specified or is zero, use a machine-dependent default.
7063 Enabled at levels @option{-O2}, @option{-O3}.
7065 @item -falign-labels
7066 @itemx -falign-labels=@var{n}
7067 @opindex falign-labels
7068 Align all branch targets to a power-of-two boundary, skipping up to
7069 @var{n} bytes like @option{-falign-functions}.  This option can easily
7070 make code slower, because it must insert dummy operations for when the
7071 branch target is reached in the usual flow of the code.
7073 @option{-fno-align-labels} and @option{-falign-labels=1} are
7074 equivalent and mean that labels will not be aligned.
7076 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7077 are greater than this value, then their values are used instead.
7079 If @var{n} is not specified or is zero, use a machine-dependent default
7080 which is very likely to be @samp{1}, meaning no alignment.
7082 Enabled at levels @option{-O2}, @option{-O3}.
7084 @item -falign-loops
7085 @itemx -falign-loops=@var{n}
7086 @opindex falign-loops
7087 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7088 like @option{-falign-functions}.  The hope is that the loop will be
7089 executed many times, which will make up for any execution of the dummy
7090 operations.
7092 @option{-fno-align-loops} and @option{-falign-loops=1} are
7093 equivalent and mean that loops will not be aligned.
7095 If @var{n} is not specified or is zero, use a machine-dependent default.
7097 Enabled at levels @option{-O2}, @option{-O3}.
7099 @item -falign-jumps
7100 @itemx -falign-jumps=@var{n}
7101 @opindex falign-jumps
7102 Align branch targets to a power-of-two boundary, for branch targets
7103 where the targets can only be reached by jumping, skipping up to @var{n}
7104 bytes like @option{-falign-functions}.  In this case, no dummy operations
7105 need be executed.
7107 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7108 equivalent and mean that loops will not be aligned.
7110 If @var{n} is not specified or is zero, use a machine-dependent default.
7112 Enabled at levels @option{-O2}, @option{-O3}.
7114 @item -funit-at-a-time
7115 @opindex funit-at-a-time
7116 This option is left for compatibility reasons. @option{-funit-at-a-time}
7117 has no effect, while @option{-fno-unit-at-a-time} implies
7118 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7120 Enabled by default.
7122 @item -fno-toplevel-reorder
7123 @opindex fno-toplevel-reorder
7124 Do not reorder top-level functions, variables, and @code{asm}
7125 statements.  Output them in the same order that they appear in the
7126 input file.  When this option is used, unreferenced static variables
7127 will not be removed.  This option is intended to support existing code
7128 which relies on a particular ordering.  For new code, it is better to
7129 use attributes.
7131 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7132 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7133 targets.
7135 @item -fweb
7136 @opindex fweb
7137 Constructs webs as commonly used for register allocation purposes and assign
7138 each web individual pseudo register.  This allows the register allocation pass
7139 to operate on pseudos directly, but also strengthens several other optimization
7140 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7141 however, make debugging impossible, since variables will no longer stay in a
7142 ``home register''.
7144 Enabled by default with @option{-funroll-loops}.
7146 @item -fwhole-program
7147 @opindex fwhole-program
7148 Assume that the current compilation unit represents the whole program being
7149 compiled.  All public functions and variables with the exception of @code{main}
7150 and those merged by attribute @code{externally_visible} become static functions
7151 and in effect are optimized more aggressively by interprocedural optimizers.
7152 While this option is equivalent to proper use of the @code{static} keyword for
7153 programs consisting of a single file, in combination with option
7154 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7155 compile many smaller scale programs since the functions and variables become
7156 local for the whole combined compilation unit, not for the single source file
7157 itself.
7159 This option implies @option{-fwhole-file} for Fortran programs.
7161 @item -flto
7162 @opindex flto
7163 This option runs the standard link-time optimizer.  When invoked
7164 with source code, it generates GIMPLE (one of GCC's internal
7165 representations) and writes it to special ELF sections in the object
7166 file.  When the object files are linked together, all the function
7167 bodies are read from these ELF sections and instantiated as if they
7168 had been part of the same translation unit.
7170 To use the link-timer optimizer, @option{-flto} needs to be specified at
7171 compile time and during the final link.  For example,
7173 @smallexample
7174 gcc -c -O2 -flto foo.c
7175 gcc -c -O2 -flto bar.c
7176 gcc -o myprog -flto -O2 foo.o bar.o
7177 @end smallexample
7179 The first two invocations to GCC will save a bytecode representation
7180 of GIMPLE into special ELF sections inside @file{foo.o} and
7181 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7182 @file{foo.o} and @file{bar.o}, merge the two files into a single
7183 internal image, and compile the result as usual.  Since both
7184 @file{foo.o} and @file{bar.o} are merged into a single image, this
7185 causes all the inter-procedural analyses and optimizations in GCC to
7186 work across the two files as if they were a single one.  This means,
7187 for example, that the inliner will be able to inline functions in
7188 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7190 Another (simpler) way to enable link-time optimization is,
7192 @smallexample
7193 gcc -o myprog -flto -O2 foo.c bar.c
7194 @end smallexample
7196 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7197 merge them together into a single GIMPLE representation and optimize
7198 them as usual to produce @file{myprog}.
7200 The only important thing to keep in mind is that to enable link-time
7201 optimizations the @option{-flto} flag needs to be passed to both the
7202 compile and the link commands.
7204 Note that when a file is compiled with @option{-flto}, the generated
7205 object file will be larger than a regular object file because it will
7206 contain GIMPLE bytecodes and the usual final code.  This means that
7207 object files with LTO information can be linked as a normal object
7208 file.  So, in the previous example, if the final link is done with
7210 @smallexample
7211 gcc -o myprog foo.o bar.o
7212 @end smallexample
7214 The only difference will be that no inter-procedural optimizations
7215 will be applied to produce @file{myprog}.  The two object files
7216 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7217 linker.
7219 Additionally, the optimization flags used to compile individual files
7220 are not necessarily related to those used at link-time.  For instance,
7222 @smallexample
7223 gcc -c -O0 -flto foo.c
7224 gcc -c -O0 -flto bar.c
7225 gcc -o myprog -flto -O3 foo.o bar.o
7226 @end smallexample
7228 This will produce individual object files with unoptimized assembler
7229 code, but the resulting binary @file{myprog} will be optimized at
7230 @option{-O3}.  Now, if the final binary is generated without
7231 @option{-flto}, then @file{myprog} will not be optimized.
7233 When producing the final binary with @option{-flto}, GCC will only
7234 apply link-time optimizations to those files that contain bytecode.
7235 Therefore, you can mix and match object files and libraries with
7236 GIMPLE bytecodes and final object code.  GCC will automatically select
7237 which files to optimize in LTO mode and which files to link without
7238 further processing.
7240 There are some code generation flags that GCC will preserve when
7241 generating bytecodes, as they need to be used during the final link
7242 stage.  Currently, the following options are saved into the GIMPLE
7243 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7244 @option{-m} target flags.
7246 At link time, these options are read-in and reapplied.  Note that the
7247 current implementation makes no attempt at recognizing conflicting
7248 values for these options.  If two or more files have a conflicting
7249 value (e.g., one file is compiled with @option{-fPIC} and another
7250 isn't), the compiler will simply use the last value read from the
7251 bytecode files.  It is recommended, then, that all the files
7252 participating in the same link be compiled with the same options.
7254 Another feature of LTO is that it is possible to apply interprocedural
7255 optimizations on files written in different languages.  This requires
7256 some support in the language front end.  Currently, the C, C++ and
7257 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7258 something like this should work
7260 @smallexample
7261 gcc -c -flto foo.c
7262 g++ -c -flto bar.cc
7263 gfortran -c -flto baz.f90
7264 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7265 @end smallexample
7267 Notice that the final link is done with @command{g++} to get the C++
7268 runtime libraries and @option{-lgfortran} is added to get the Fortran
7269 runtime libraries.  In general, when mixing languages in LTO mode, you
7270 should use the same link command used when mixing languages in a
7271 regular (non-LTO) compilation.  This means that if your build process
7272 was mixing languages before, all you need to add is @option{-flto} to
7273 all the compile and link commands.
7275 If object files containing GIMPLE bytecode are stored in a library
7276 archive, say @file{libfoo.a}, it is possible to extract and use them
7277 in an LTO link if you are using @command{gold} as the linker (which,
7278 in turn requires GCC to be configured with @option{--enable-gold}).
7279 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7280 link-time:
7282 @smallexample
7283 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7284 @end smallexample
7286 With the linker plugin enabled, @command{gold} will extract the needed
7287 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7288 to make them part of the aggregated GIMPLE image to be optimized.
7290 If you are not using @command{gold} and/or do not specify
7291 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7292 will be extracted and linked as usual, but they will not participate
7293 in the LTO optimization process.
7295 Link time optimizations do not require the presence of the whole
7296 program to operate.  If the program does not require any symbols to
7297 be exported, it is possible to combine @option{-flto} and
7298 @option{-fwhopr} with @option{-fwhole-program} to allow the
7299 interprocedural optimizers to use more aggressive assumptions which
7300 may lead to improved optimization opportunities.
7302 Regarding portability: the current implementation of LTO makes no
7303 attempt at generating bytecode that can be ported between different
7304 types of hosts.  The bytecode files are versioned and there is a
7305 strict version check, so bytecode files generated in one version of
7306 GCC will not work with an older/newer version of GCC.
7308 This option is disabled by default.
7310 @item -fwhopr
7311 @opindex fwhopr
7312 This option is identical in functionality to @option{-flto} but it
7313 differs in how the final link stage is executed.  Instead of loading
7314 all the function bodies in memory, the callgraph is analyzed and
7315 optimization decisions are made (whole program analysis or WPA). Once
7316 optimization decisions are made, the callgraph is partitioned and the
7317 different sections are compiled separately (local transformations or
7318 LTRANS)@.  This process allows optimizations on very large programs
7319 that otherwise would not fit in memory.  This option enables
7320 @option{-fwpa} and @option{-fltrans} automatically.
7322 Disabled by default.
7324 @item -fwpa
7325 @opindex fwpa
7326 This is an internal option used by GCC when compiling with
7327 @option{-fwhopr}.  You should never need to use it.
7329 This option runs the link-time optimizer in the whole-program-analysis
7330 (WPA) mode, which reads in summary information from all inputs and
7331 performs a whole-program analysis based on summary information only.
7332 It generates object files for subsequent runs of the link-time
7333 optimizer where individual object files are optimized using both
7334 summary information from the WPA mode and the actual function bodies.
7335 It then drives the LTRANS phase.
7337 Disabled by default.
7339 @item -fltrans
7340 @opindex fltrans
7341 This is an internal option used by GCC when compiling with
7342 @option{-fwhopr}.  You should never need to use it.
7344 This option runs the link-time optimizer in the local-transformation (LTRANS)
7345 mode, which reads in output from a previous run of the LTO in WPA mode.
7346 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7348 Disabled by default.
7350 @item -fltrans-output-list=@var{file}
7351 @opindex fltrans-output-list
7352 This is an internal option used by GCC when compiling with
7353 @option{-fwhopr}.  You should never need to use it.
7355 This option specifies a file to which the names of LTRANS output files are
7356 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7358 Disabled by default.
7360 @item -flto-compression-level=@var{n}
7361 This option specifies the level of compression used for intermediate
7362 language written to LTO object files, and is only meaningful in
7363 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7364 values are 0 (no compression) to 9 (maximum compression).  Values
7365 outside this range are clamped to either 0 or 9.  If the option is not
7366 given, a default balanced compression setting is used.
7368 @item -flto-report
7369 Prints a report with internal details on the workings of the link-time
7370 optimizer.  The contents of this report vary from version to version,
7371 it is meant to be useful to GCC developers when processing object
7372 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7374 Disabled by default.
7376 @item -fuse-linker-plugin
7377 Enables the extraction of objects with GIMPLE bytecode information
7378 from library archives.  This option relies on features available only
7379 in @command{gold}, so to use this you must configure GCC with
7380 @option{--enable-gold}.  See @option{-flto} for a description on the
7381 effect of this flag and how to use it.
7383 Disabled by default.
7385 @item -fcprop-registers
7386 @opindex fcprop-registers
7387 After register allocation and post-register allocation instruction splitting,
7388 we perform a copy-propagation pass to try to reduce scheduling dependencies
7389 and occasionally eliminate the copy.
7391 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7393 @item -fprofile-correction
7394 @opindex fprofile-correction
7395 Profiles collected using an instrumented binary for multi-threaded programs may
7396 be inconsistent due to missed counter updates. When this option is specified,
7397 GCC will use heuristics to correct or smooth out such inconsistencies. By
7398 default, GCC will emit an error message when an inconsistent profile is detected.
7400 @item -fprofile-dir=@var{path}
7401 @opindex fprofile-dir
7403 Set the directory to search the profile data files in to @var{path}.
7404 This option affects only the profile data generated by
7405 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7406 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7407 and its related options.
7408 By default, GCC will use the current directory as @var{path}
7409 thus the profile data file will appear in the same directory as the object file.
7411 @item -fprofile-generate
7412 @itemx -fprofile-generate=@var{path}
7413 @opindex fprofile-generate
7415 Enable options usually used for instrumenting application to produce
7416 profile useful for later recompilation with profile feedback based
7417 optimization.  You must use @option{-fprofile-generate} both when
7418 compiling and when linking your program.
7420 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7422 If @var{path} is specified, GCC will look at the @var{path} to find
7423 the profile feedback data files. See @option{-fprofile-dir}.
7425 @item -fprofile-use
7426 @itemx -fprofile-use=@var{path}
7427 @opindex fprofile-use
7428 Enable profile feedback directed optimizations, and optimizations
7429 generally profitable only with profile feedback available.
7431 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7432 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7434 By default, GCC emits an error message if the feedback profiles do not
7435 match the source code.  This error can be turned into a warning by using
7436 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7437 code.
7439 If @var{path} is specified, GCC will look at the @var{path} to find
7440 the profile feedback data files. See @option{-fprofile-dir}.
7441 @end table
7443 The following options control compiler behavior regarding floating
7444 point arithmetic.  These options trade off between speed and
7445 correctness.  All must be specifically enabled.
7447 @table @gcctabopt
7448 @item -ffloat-store
7449 @opindex ffloat-store
7450 Do not store floating point variables in registers, and inhibit other
7451 options that might change whether a floating point value is taken from a
7452 register or memory.
7454 @cindex floating point precision
7455 This option prevents undesirable excess precision on machines such as
7456 the 68000 where the floating registers (of the 68881) keep more
7457 precision than a @code{double} is supposed to have.  Similarly for the
7458 x86 architecture.  For most programs, the excess precision does only
7459 good, but a few programs rely on the precise definition of IEEE floating
7460 point.  Use @option{-ffloat-store} for such programs, after modifying
7461 them to store all pertinent intermediate computations into variables.
7463 @item -fexcess-precision=@var{style}
7464 @opindex fexcess-precision
7465 This option allows further control over excess precision on machines
7466 where floating-point registers have more precision than the IEEE
7467 @code{float} and @code{double} types and the processor does not
7468 support operations rounding to those types.  By default,
7469 @option{-fexcess-precision=fast} is in effect; this means that
7470 operations are carried out in the precision of the registers and that
7471 it is unpredictable when rounding to the types specified in the source
7472 code takes place.  When compiling C, if
7473 @option{-fexcess-precision=standard} is specified then excess
7474 precision will follow the rules specified in ISO C99; in particular,
7475 both casts and assignments cause values to be rounded to their
7476 semantic types (whereas @option{-ffloat-store} only affects
7477 assignments).  This option is enabled by default for C if a strict
7478 conformance option such as @option{-std=c99} is used.
7480 @opindex mfpmath
7481 @option{-fexcess-precision=standard} is not implemented for languages
7482 other than C, and has no effect if
7483 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7484 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7485 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7486 semantics apply without excess precision, and in the latter, rounding
7487 is unpredictable.
7489 @item -ffast-math
7490 @opindex ffast-math
7491 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7492 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7493 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7495 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7497 This option is not turned on by any @option{-O} option since
7498 it can result in incorrect output for programs which depend on
7499 an exact implementation of IEEE or ISO rules/specifications for
7500 math functions. It may, however, yield faster code for programs
7501 that do not require the guarantees of these specifications.
7503 @item -fno-math-errno
7504 @opindex fno-math-errno
7505 Do not set ERRNO after calling math functions that are executed
7506 with a single instruction, e.g., sqrt.  A program that relies on
7507 IEEE exceptions for math error handling may want to use this flag
7508 for speed while maintaining IEEE arithmetic compatibility.
7510 This option is not turned on by any @option{-O} option since
7511 it can result in incorrect output for programs which depend on
7512 an exact implementation of IEEE or ISO rules/specifications for
7513 math functions. It may, however, yield faster code for programs
7514 that do not require the guarantees of these specifications.
7516 The default is @option{-fmath-errno}.
7518 On Darwin systems, the math library never sets @code{errno}.  There is
7519 therefore no reason for the compiler to consider the possibility that
7520 it might, and @option{-fno-math-errno} is the default.
7522 @item -funsafe-math-optimizations
7523 @opindex funsafe-math-optimizations
7525 Allow optimizations for floating-point arithmetic that (a) assume
7526 that arguments and results are valid and (b) may violate IEEE or
7527 ANSI standards.  When used at link-time, it may include libraries
7528 or startup files that change the default FPU control word or other
7529 similar optimizations.
7531 This option is not turned on by any @option{-O} option since
7532 it can result in incorrect output for programs which depend on
7533 an exact implementation of IEEE or ISO rules/specifications for
7534 math functions. It may, however, yield faster code for programs
7535 that do not require the guarantees of these specifications.
7536 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7537 @option{-fassociative-math} and @option{-freciprocal-math}.
7539 The default is @option{-fno-unsafe-math-optimizations}.
7541 @item -fassociative-math
7542 @opindex fassociative-math
7544 Allow re-association of operands in series of floating-point operations.
7545 This violates the ISO C and C++ language standard by possibly changing
7546 computation result.  NOTE: re-ordering may change the sign of zero as
7547 well as ignore NaNs and inhibit or create underflow or overflow (and
7548 thus cannot be used on a code which relies on rounding behavior like
7549 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7550 and thus may not be used when ordered comparisons are required.
7551 This option requires that both @option{-fno-signed-zeros} and
7552 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7553 much sense with @option{-frounding-math}.
7555 The default is @option{-fno-associative-math}.
7557 @item -freciprocal-math
7558 @opindex freciprocal-math
7560 Allow the reciprocal of a value to be used instead of dividing by
7561 the value if this enables optimizations.  For example @code{x / y}
7562 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7563 is subject to common subexpression elimination.  Note that this loses
7564 precision and increases the number of flops operating on the value.
7566 The default is @option{-fno-reciprocal-math}.
7568 @item -ffinite-math-only
7569 @opindex ffinite-math-only
7570 Allow optimizations for floating-point arithmetic that assume
7571 that arguments and results are not NaNs or +-Infs.
7573 This option is not turned on by any @option{-O} option since
7574 it can result in incorrect output for programs which depend on
7575 an exact implementation of IEEE or ISO rules/specifications for
7576 math functions. It may, however, yield faster code for programs
7577 that do not require the guarantees of these specifications.
7579 The default is @option{-fno-finite-math-only}.
7581 @item -fno-signed-zeros
7582 @opindex fno-signed-zeros
7583 Allow optimizations for floating point arithmetic that ignore the
7584 signedness of zero.  IEEE arithmetic specifies the behavior of
7585 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7586 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7587 This option implies that the sign of a zero result isn't significant.
7589 The default is @option{-fsigned-zeros}.
7591 @item -fno-trapping-math
7592 @opindex fno-trapping-math
7593 Compile code assuming that floating-point operations cannot generate
7594 user-visible traps.  These traps include division by zero, overflow,
7595 underflow, inexact result and invalid operation.  This option requires
7596 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7597 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7599 This option should never be turned on by any @option{-O} option since
7600 it can result in incorrect output for programs which depend on
7601 an exact implementation of IEEE or ISO rules/specifications for
7602 math functions.
7604 The default is @option{-ftrapping-math}.
7606 @item -frounding-math
7607 @opindex frounding-math
7608 Disable transformations and optimizations that assume default floating
7609 point rounding behavior.  This is round-to-zero for all floating point
7610 to integer conversions, and round-to-nearest for all other arithmetic
7611 truncations.  This option should be specified for programs that change
7612 the FP rounding mode dynamically, or that may be executed with a
7613 non-default rounding mode.  This option disables constant folding of
7614 floating point expressions at compile-time (which may be affected by
7615 rounding mode) and arithmetic transformations that are unsafe in the
7616 presence of sign-dependent rounding modes.
7618 The default is @option{-fno-rounding-math}.
7620 This option is experimental and does not currently guarantee to
7621 disable all GCC optimizations that are affected by rounding mode.
7622 Future versions of GCC may provide finer control of this setting
7623 using C99's @code{FENV_ACCESS} pragma.  This command line option
7624 will be used to specify the default state for @code{FENV_ACCESS}.
7626 @item -fsignaling-nans
7627 @opindex fsignaling-nans
7628 Compile code assuming that IEEE signaling NaNs may generate user-visible
7629 traps during floating-point operations.  Setting this option disables
7630 optimizations that may change the number of exceptions visible with
7631 signaling NaNs.  This option implies @option{-ftrapping-math}.
7633 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7634 be defined.
7636 The default is @option{-fno-signaling-nans}.
7638 This option is experimental and does not currently guarantee to
7639 disable all GCC optimizations that affect signaling NaN behavior.
7641 @item -fsingle-precision-constant
7642 @opindex fsingle-precision-constant
7643 Treat floating point constant as single precision constant instead of
7644 implicitly converting it to double precision constant.
7646 @item -fcx-limited-range
7647 @opindex fcx-limited-range
7648 When enabled, this option states that a range reduction step is not
7649 needed when performing complex division.  Also, there is no checking
7650 whether the result of a complex multiplication or division is @code{NaN
7651 + I*NaN}, with an attempt to rescue the situation in that case.  The
7652 default is @option{-fno-cx-limited-range}, but is enabled by
7653 @option{-ffast-math}.
7655 This option controls the default setting of the ISO C99
7656 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7657 all languages.
7659 @item -fcx-fortran-rules
7660 @opindex fcx-fortran-rules
7661 Complex multiplication and division follow Fortran rules.  Range
7662 reduction is done as part of complex division, but there is no checking
7663 whether the result of a complex multiplication or division is @code{NaN
7664 + I*NaN}, with an attempt to rescue the situation in that case.
7666 The default is @option{-fno-cx-fortran-rules}.
7668 @end table
7670 The following options control optimizations that may improve
7671 performance, but are not enabled by any @option{-O} options.  This
7672 section includes experimental options that may produce broken code.
7674 @table @gcctabopt
7675 @item -fbranch-probabilities
7676 @opindex fbranch-probabilities
7677 After running a program compiled with @option{-fprofile-arcs}
7678 (@pxref{Debugging Options,, Options for Debugging Your Program or
7679 @command{gcc}}), you can compile it a second time using
7680 @option{-fbranch-probabilities}, to improve optimizations based on
7681 the number of times each branch was taken.  When the program
7682 compiled with @option{-fprofile-arcs} exits it saves arc execution
7683 counts to a file called @file{@var{sourcename}.gcda} for each source
7684 file.  The information in this data file is very dependent on the
7685 structure of the generated code, so you must use the same source code
7686 and the same optimization options for both compilations.
7688 With @option{-fbranch-probabilities}, GCC puts a
7689 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7690 These can be used to improve optimization.  Currently, they are only
7691 used in one place: in @file{reorg.c}, instead of guessing which path a
7692 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7693 exactly determine which path is taken more often.
7695 @item -fprofile-values
7696 @opindex fprofile-values
7697 If combined with @option{-fprofile-arcs}, it adds code so that some
7698 data about values of expressions in the program is gathered.
7700 With @option{-fbranch-probabilities}, it reads back the data gathered
7701 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7702 notes to instructions for their later usage in optimizations.
7704 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7706 @item -fvpt
7707 @opindex fvpt
7708 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7709 a code to gather information about values of expressions.
7711 With @option{-fbranch-probabilities}, it reads back the data gathered
7712 and actually performs the optimizations based on them.
7713 Currently the optimizations include specialization of division operation
7714 using the knowledge about the value of the denominator.
7716 @item -frename-registers
7717 @opindex frename-registers
7718 Attempt to avoid false dependencies in scheduled code by making use
7719 of registers left over after register allocation.  This optimization
7720 will most benefit processors with lots of registers.  Depending on the
7721 debug information format adopted by the target, however, it can
7722 make debugging impossible, since variables will no longer stay in
7723 a ``home register''.
7725 Enabled by default with @option{-funroll-loops}.
7727 @item -ftracer
7728 @opindex ftracer
7729 Perform tail duplication to enlarge superblock size.  This transformation
7730 simplifies the control flow of the function allowing other optimizations to do
7731 better job.
7733 Enabled with @option{-fprofile-use}.
7735 @item -funroll-loops
7736 @opindex funroll-loops
7737 Unroll loops whose number of iterations can be determined at compile time or
7738 upon entry to the loop.  @option{-funroll-loops} implies
7739 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7740 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7741 small constant number of iterations).  This option makes code larger, and may
7742 or may not make it run faster.
7744 Enabled with @option{-fprofile-use}.
7746 @item -funroll-all-loops
7747 @opindex funroll-all-loops
7748 Unroll all loops, even if their number of iterations is uncertain when
7749 the loop is entered.  This usually makes programs run more slowly.
7750 @option{-funroll-all-loops} implies the same options as
7751 @option{-funroll-loops}.
7753 @item -fpeel-loops
7754 @opindex fpeel-loops
7755 Peels the loops for that there is enough information that they do not
7756 roll much (from profile feedback).  It also turns on complete loop peeling
7757 (i.e.@: complete removal of loops with small constant number of iterations).
7759 Enabled with @option{-fprofile-use}.
7761 @item -fmove-loop-invariants
7762 @opindex fmove-loop-invariants
7763 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7764 at level @option{-O1}
7766 @item -funswitch-loops
7767 @opindex funswitch-loops
7768 Move branches with loop invariant conditions out of the loop, with duplicates
7769 of the loop on both branches (modified according to result of the condition).
7771 @item -ffunction-sections
7772 @itemx -fdata-sections
7773 @opindex ffunction-sections
7774 @opindex fdata-sections
7775 Place each function or data item into its own section in the output
7776 file if the target supports arbitrary sections.  The name of the
7777 function or the name of the data item determines the section's name
7778 in the output file.
7780 Use these options on systems where the linker can perform optimizations
7781 to improve locality of reference in the instruction space.  Most systems
7782 using the ELF object format and SPARC processors running Solaris 2 have
7783 linkers with such optimizations.  AIX may have these optimizations in
7784 the future.
7786 Only use these options when there are significant benefits from doing
7787 so.  When you specify these options, the assembler and linker will
7788 create larger object and executable files and will also be slower.
7789 You will not be able to use @code{gprof} on all systems if you
7790 specify this option and you may have problems with debugging if
7791 you specify both this option and @option{-g}.
7793 @item -fbranch-target-load-optimize
7794 @opindex fbranch-target-load-optimize
7795 Perform branch target register load optimization before prologue / epilogue
7796 threading.
7797 The use of target registers can typically be exposed only during reload,
7798 thus hoisting loads out of loops and doing inter-block scheduling needs
7799 a separate optimization pass.
7801 @item -fbranch-target-load-optimize2
7802 @opindex fbranch-target-load-optimize2
7803 Perform branch target register load optimization after prologue / epilogue
7804 threading.
7806 @item -fbtr-bb-exclusive
7807 @opindex fbtr-bb-exclusive
7808 When performing branch target register load optimization, don't reuse
7809 branch target registers in within any basic block.
7811 @item -fstack-protector
7812 @opindex fstack-protector
7813 Emit extra code to check for buffer overflows, such as stack smashing
7814 attacks.  This is done by adding a guard variable to functions with
7815 vulnerable objects.  This includes functions that call alloca, and
7816 functions with buffers larger than 8 bytes.  The guards are initialized
7817 when a function is entered and then checked when the function exits.
7818 If a guard check fails, an error message is printed and the program exits.
7820 @item -fstack-protector-all
7821 @opindex fstack-protector-all
7822 Like @option{-fstack-protector} except that all functions are protected.
7824 @item -fsection-anchors
7825 @opindex fsection-anchors
7826 Try to reduce the number of symbolic address calculations by using
7827 shared ``anchor'' symbols to address nearby objects.  This transformation
7828 can help to reduce the number of GOT entries and GOT accesses on some
7829 targets.
7831 For example, the implementation of the following function @code{foo}:
7833 @smallexample
7834 static int a, b, c;
7835 int foo (void) @{ return a + b + c; @}
7836 @end smallexample
7838 would usually calculate the addresses of all three variables, but if you
7839 compile it with @option{-fsection-anchors}, it will access the variables
7840 from a common anchor point instead.  The effect is similar to the
7841 following pseudocode (which isn't valid C):
7843 @smallexample
7844 int foo (void)
7846   register int *xr = &x;
7847   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7849 @end smallexample
7851 Not all targets support this option.
7853 @item --param @var{name}=@var{value}
7854 @opindex param
7855 In some places, GCC uses various constants to control the amount of
7856 optimization that is done.  For example, GCC will not inline functions
7857 that contain more that a certain number of instructions.  You can
7858 control some of these constants on the command-line using the
7859 @option{--param} option.
7861 The names of specific parameters, and the meaning of the values, are
7862 tied to the internals of the compiler, and are subject to change
7863 without notice in future releases.
7865 In each case, the @var{value} is an integer.  The allowable choices for
7866 @var{name} are given in the following table:
7868 @table @gcctabopt
7869 @item struct-reorg-cold-struct-ratio
7870 The threshold ratio (as a percentage) between a structure frequency
7871 and the frequency of the hottest structure in the program.  This parameter
7872 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7873 We say that if the ratio of a structure frequency, calculated by profiling,
7874 to the hottest structure frequency in the program is less than this
7875 parameter, then structure reorganization is not applied to this structure.
7876 The default is 10.
7878 @item predictable-branch-cost-outcome
7879 When branch is predicted to be taken with probability lower than this threshold
7880 (in percent), then it is considered well predictable. The default is 10.
7882 @item max-crossjump-edges
7883 The maximum number of incoming edges to consider for crossjumping.
7884 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7885 the number of edges incoming to each block.  Increasing values mean
7886 more aggressive optimization, making the compile time increase with
7887 probably small improvement in executable size.
7889 @item min-crossjump-insns
7890 The minimum number of instructions which must be matched at the end
7891 of two blocks before crossjumping will be performed on them.  This
7892 value is ignored in the case where all instructions in the block being
7893 crossjumped from are matched.  The default value is 5.
7895 @item max-grow-copy-bb-insns
7896 The maximum code size expansion factor when copying basic blocks
7897 instead of jumping.  The expansion is relative to a jump instruction.
7898 The default value is 8.
7900 @item max-goto-duplication-insns
7901 The maximum number of instructions to duplicate to a block that jumps
7902 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7903 passes, GCC factors computed gotos early in the compilation process,
7904 and unfactors them as late as possible.  Only computed jumps at the
7905 end of a basic blocks with no more than max-goto-duplication-insns are
7906 unfactored.  The default value is 8.
7908 @item max-delay-slot-insn-search
7909 The maximum number of instructions to consider when looking for an
7910 instruction to fill a delay slot.  If more than this arbitrary number of
7911 instructions is searched, the time savings from filling the delay slot
7912 will be minimal so stop searching.  Increasing values mean more
7913 aggressive optimization, making the compile time increase with probably
7914 small improvement in executable run time.
7916 @item max-delay-slot-live-search
7917 When trying to fill delay slots, the maximum number of instructions to
7918 consider when searching for a block with valid live register
7919 information.  Increasing this arbitrarily chosen value means more
7920 aggressive optimization, increasing the compile time.  This parameter
7921 should be removed when the delay slot code is rewritten to maintain the
7922 control-flow graph.
7924 @item max-gcse-memory
7925 The approximate maximum amount of memory that will be allocated in
7926 order to perform the global common subexpression elimination
7927 optimization.  If more memory than specified is required, the
7928 optimization will not be done.
7930 @item max-pending-list-length
7931 The maximum number of pending dependencies scheduling will allow
7932 before flushing the current state and starting over.  Large functions
7933 with few branches or calls can create excessively large lists which
7934 needlessly consume memory and resources.
7936 @item max-inline-insns-single
7937 Several parameters control the tree inliner used in gcc.
7938 This number sets the maximum number of instructions (counted in GCC's
7939 internal representation) in a single function that the tree inliner
7940 will consider for inlining.  This only affects functions declared
7941 inline and methods implemented in a class declaration (C++).
7942 The default value is 300.
7944 @item max-inline-insns-auto
7945 When you use @option{-finline-functions} (included in @option{-O3}),
7946 a lot of functions that would otherwise not be considered for inlining
7947 by the compiler will be investigated.  To those functions, a different
7948 (more restrictive) limit compared to functions declared inline can
7949 be applied.
7950 The default value is 50.
7952 @item large-function-insns
7953 The limit specifying really large functions.  For functions larger than this
7954 limit after inlining, inlining is constrained by
7955 @option{--param large-function-growth}.  This parameter is useful primarily
7956 to avoid extreme compilation time caused by non-linear algorithms used by the
7957 backend.
7958 The default value is 2700.
7960 @item large-function-growth
7961 Specifies maximal growth of large function caused by inlining in percents.
7962 The default value is 100 which limits large function growth to 2.0 times
7963 the original size.
7965 @item large-unit-insns
7966 The limit specifying large translation unit.  Growth caused by inlining of
7967 units larger than this limit is limited by @option{--param inline-unit-growth}.
7968 For small units this might be too tight (consider unit consisting of function A
7969 that is inline and B that just calls A three time.  If B is small relative to
7970 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
7971 large units consisting of small inlineable functions however the overall unit
7972 growth limit is needed to avoid exponential explosion of code size.  Thus for
7973 smaller units, the size is increased to @option{--param large-unit-insns}
7974 before applying @option{--param inline-unit-growth}.  The default is 10000
7976 @item inline-unit-growth
7977 Specifies maximal overall growth of the compilation unit caused by inlining.
7978 The default value is 30 which limits unit growth to 1.3 times the original
7979 size.
7981 @item ipcp-unit-growth
7982 Specifies maximal overall growth of the compilation unit caused by
7983 interprocedural constant propagation.  The default value is 10 which limits
7984 unit growth to 1.1 times the original size.
7986 @item large-stack-frame
7987 The limit specifying large stack frames.  While inlining the algorithm is trying
7988 to not grow past this limit too much.  Default value is 256 bytes.
7990 @item large-stack-frame-growth
7991 Specifies maximal growth of large stack frames caused by inlining in percents.
7992 The default value is 1000 which limits large stack frame growth to 11 times
7993 the original size.
7995 @item max-inline-insns-recursive
7996 @itemx max-inline-insns-recursive-auto
7997 Specifies maximum number of instructions out-of-line copy of self recursive inline
7998 function can grow into by performing recursive inlining.
8000 For functions declared inline @option{--param max-inline-insns-recursive} is
8001 taken into account.  For function not declared inline, recursive inlining
8002 happens only when @option{-finline-functions} (included in @option{-O3}) is
8003 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8004 default value is 450.
8006 @item max-inline-recursive-depth
8007 @itemx max-inline-recursive-depth-auto
8008 Specifies maximum recursion depth used by the recursive inlining.
8010 For functions declared inline @option{--param max-inline-recursive-depth} is
8011 taken into account.  For function not declared inline, recursive inlining
8012 happens only when @option{-finline-functions} (included in @option{-O3}) is
8013 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8014 default value is 8.
8016 @item min-inline-recursive-probability
8017 Recursive inlining is profitable only for function having deep recursion
8018 in average and can hurt for function having little recursion depth by
8019 increasing the prologue size or complexity of function body to other
8020 optimizers.
8022 When profile feedback is available (see @option{-fprofile-generate}) the actual
8023 recursion depth can be guessed from probability that function will recurse via
8024 given call expression.  This parameter limits inlining only to call expression
8025 whose probability exceeds given threshold (in percents).  The default value is
8028 @item early-inlining-insns
8029 Specify growth that early inliner can make.  In effect it increases amount of
8030 inlining for code having large abstraction penalty.  The default value is 8.
8032 @item max-early-inliner-iterations
8033 @itemx max-early-inliner-iterations
8034 Limit of iterations of early inliner.  This basically bounds number of nested
8035 indirect calls early inliner can resolve.  Deeper chains are still handled by
8036 late inlining.
8038 @item min-vect-loop-bound
8039 The minimum number of iterations under which a loop will not get vectorized
8040 when @option{-ftree-vectorize} is used.  The number of iterations after
8041 vectorization needs to be greater than the value specified by this option
8042 to allow vectorization.  The default value is 0.
8044 @item max-unrolled-insns
8045 The maximum number of instructions that a loop should have if that loop
8046 is unrolled, and if the loop is unrolled, it determines how many times
8047 the loop code is unrolled.
8049 @item max-average-unrolled-insns
8050 The maximum number of instructions biased by probabilities of their execution
8051 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8052 it determines how many times the loop code is unrolled.
8054 @item max-unroll-times
8055 The maximum number of unrollings of a single loop.
8057 @item max-peeled-insns
8058 The maximum number of instructions that a loop should have if that loop
8059 is peeled, and if the loop is peeled, it determines how many times
8060 the loop code is peeled.
8062 @item max-peel-times
8063 The maximum number of peelings of a single loop.
8065 @item max-completely-peeled-insns
8066 The maximum number of insns of a completely peeled loop.
8068 @item max-completely-peel-times
8069 The maximum number of iterations of a loop to be suitable for complete peeling.
8071 @item max-unswitch-insns
8072 The maximum number of insns of an unswitched loop.
8074 @item max-unswitch-level
8075 The maximum number of branches unswitched in a single loop.
8077 @item lim-expensive
8078 The minimum cost of an expensive expression in the loop invariant motion.
8080 @item iv-consider-all-candidates-bound
8081 Bound on number of candidates for induction variables below that
8082 all candidates are considered for each use in induction variable
8083 optimizations.  Only the most relevant candidates are considered
8084 if there are more candidates, to avoid quadratic time complexity.
8086 @item iv-max-considered-uses
8087 The induction variable optimizations give up on loops that contain more
8088 induction variable uses.
8090 @item iv-always-prune-cand-set-bound
8091 If number of candidates in the set is smaller than this value,
8092 we always try to remove unnecessary ivs from the set during its
8093 optimization when a new iv is added to the set.
8095 @item scev-max-expr-size
8096 Bound on size of expressions used in the scalar evolutions analyzer.
8097 Large expressions slow the analyzer.
8099 @item omega-max-vars
8100 The maximum number of variables in an Omega constraint system.
8101 The default value is 128.
8103 @item omega-max-geqs
8104 The maximum number of inequalities in an Omega constraint system.
8105 The default value is 256.
8107 @item omega-max-eqs
8108 The maximum number of equalities in an Omega constraint system.
8109 The default value is 128.
8111 @item omega-max-wild-cards
8112 The maximum number of wildcard variables that the Omega solver will
8113 be able to insert.  The default value is 18.
8115 @item omega-hash-table-size
8116 The size of the hash table in the Omega solver.  The default value is
8117 550.
8119 @item omega-max-keys
8120 The maximal number of keys used by the Omega solver.  The default
8121 value is 500.
8123 @item omega-eliminate-redundant-constraints
8124 When set to 1, use expensive methods to eliminate all redundant
8125 constraints.  The default value is 0.
8127 @item vect-max-version-for-alignment-checks
8128 The maximum number of runtime checks that can be performed when
8129 doing loop versioning for alignment in the vectorizer.  See option
8130 ftree-vect-loop-version for more information.
8132 @item vect-max-version-for-alias-checks
8133 The maximum number of runtime checks that can be performed when
8134 doing loop versioning for alias in the vectorizer.  See option
8135 ftree-vect-loop-version for more information.
8137 @item max-iterations-to-track
8139 The maximum number of iterations of a loop the brute force algorithm
8140 for analysis of # of iterations of the loop tries to evaluate.
8142 @item hot-bb-count-fraction
8143 Select fraction of the maximal count of repetitions of basic block in program
8144 given basic block needs to have to be considered hot.
8146 @item hot-bb-frequency-fraction
8147 Select fraction of the maximal frequency of executions of basic block in
8148 function given basic block needs to have to be considered hot
8150 @item max-predicted-iterations
8151 The maximum number of loop iterations we predict statically.  This is useful
8152 in cases where function contain single loop with known bound and other loop
8153 with unknown.  We predict the known number of iterations correctly, while
8154 the unknown number of iterations average to roughly 10.  This means that the
8155 loop without bounds would appear artificially cold relative to the other one.
8157 @item align-threshold
8159 Select fraction of the maximal frequency of executions of basic block in
8160 function given basic block will get aligned.
8162 @item align-loop-iterations
8164 A loop expected to iterate at lest the selected number of iterations will get
8165 aligned.
8167 @item tracer-dynamic-coverage
8168 @itemx tracer-dynamic-coverage-feedback
8170 This value is used to limit superblock formation once the given percentage of
8171 executed instructions is covered.  This limits unnecessary code size
8172 expansion.
8174 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8175 feedback is available.  The real profiles (as opposed to statically estimated
8176 ones) are much less balanced allowing the threshold to be larger value.
8178 @item tracer-max-code-growth
8179 Stop tail duplication once code growth has reached given percentage.  This is
8180 rather hokey argument, as most of the duplicates will be eliminated later in
8181 cross jumping, so it may be set to much higher values than is the desired code
8182 growth.
8184 @item tracer-min-branch-ratio
8186 Stop reverse growth when the reverse probability of best edge is less than this
8187 threshold (in percent).
8189 @item tracer-min-branch-ratio
8190 @itemx tracer-min-branch-ratio-feedback
8192 Stop forward growth if the best edge do have probability lower than this
8193 threshold.
8195 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8196 compilation for profile feedback and one for compilation without.  The value
8197 for compilation with profile feedback needs to be more conservative (higher) in
8198 order to make tracer effective.
8200 @item max-cse-path-length
8202 Maximum number of basic blocks on path that cse considers.  The default is 10.
8204 @item max-cse-insns
8205 The maximum instructions CSE process before flushing. The default is 1000.
8207 @item ggc-min-expand
8209 GCC uses a garbage collector to manage its own memory allocation.  This
8210 parameter specifies the minimum percentage by which the garbage
8211 collector's heap should be allowed to expand between collections.
8212 Tuning this may improve compilation speed; it has no effect on code
8213 generation.
8215 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8216 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8217 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8218 GCC is not able to calculate RAM on a particular platform, the lower
8219 bound of 30% is used.  Setting this parameter and
8220 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8221 every opportunity.  This is extremely slow, but can be useful for
8222 debugging.
8224 @item ggc-min-heapsize
8226 Minimum size of the garbage collector's heap before it begins bothering
8227 to collect garbage.  The first collection occurs after the heap expands
8228 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8229 tuning this may improve compilation speed, and has no effect on code
8230 generation.
8232 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8233 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8234 with a lower bound of 4096 (four megabytes) and an upper bound of
8235 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8236 particular platform, the lower bound is used.  Setting this parameter
8237 very large effectively disables garbage collection.  Setting this
8238 parameter and @option{ggc-min-expand} to zero causes a full collection
8239 to occur at every opportunity.
8241 @item max-reload-search-insns
8242 The maximum number of instruction reload should look backward for equivalent
8243 register.  Increasing values mean more aggressive optimization, making the
8244 compile time increase with probably slightly better performance.  The default
8245 value is 100.
8247 @item max-cselib-memory-locations
8248 The maximum number of memory locations cselib should take into account.
8249 Increasing values mean more aggressive optimization, making the compile time
8250 increase with probably slightly better performance.  The default value is 500.
8252 @item reorder-blocks-duplicate
8253 @itemx reorder-blocks-duplicate-feedback
8255 Used by basic block reordering pass to decide whether to use unconditional
8256 branch or duplicate the code on its destination.  Code is duplicated when its
8257 estimated size is smaller than this value multiplied by the estimated size of
8258 unconditional jump in the hot spots of the program.
8260 The @option{reorder-block-duplicate-feedback} is used only when profile
8261 feedback is available and may be set to higher values than
8262 @option{reorder-block-duplicate} since information about the hot spots is more
8263 accurate.
8265 @item max-sched-ready-insns
8266 The maximum number of instructions ready to be issued the scheduler should
8267 consider at any given time during the first scheduling pass.  Increasing
8268 values mean more thorough searches, making the compilation time increase
8269 with probably little benefit.  The default value is 100.
8271 @item max-sched-region-blocks
8272 The maximum number of blocks in a region to be considered for
8273 interblock scheduling.  The default value is 10.
8275 @item max-pipeline-region-blocks
8276 The maximum number of blocks in a region to be considered for
8277 pipelining in the selective scheduler.  The default value is 15.
8279 @item max-sched-region-insns
8280 The maximum number of insns in a region to be considered for
8281 interblock scheduling.  The default value is 100.
8283 @item max-pipeline-region-insns
8284 The maximum number of insns in a region to be considered for
8285 pipelining in the selective scheduler.  The default value is 200.
8287 @item min-spec-prob
8288 The minimum probability (in percents) of reaching a source block
8289 for interblock speculative scheduling.  The default value is 40.
8291 @item max-sched-extend-regions-iters
8292 The maximum number of iterations through CFG to extend regions.
8293 0 - disable region extension,
8294 N - do at most N iterations.
8295 The default value is 0.
8297 @item max-sched-insn-conflict-delay
8298 The maximum conflict delay for an insn to be considered for speculative motion.
8299 The default value is 3.
8301 @item sched-spec-prob-cutoff
8302 The minimal probability of speculation success (in percents), so that
8303 speculative insn will be scheduled.
8304 The default value is 40.
8306 @item sched-mem-true-dep-cost
8307 Minimal distance (in CPU cycles) between store and load targeting same
8308 memory locations.  The default value is 1.
8310 @item selsched-max-lookahead
8311 The maximum size of the lookahead window of selective scheduling.  It is a
8312 depth of search for available instructions.
8313 The default value is 50.
8315 @item selsched-max-sched-times
8316 The maximum number of times that an instruction will be scheduled during
8317 selective scheduling.  This is the limit on the number of iterations
8318 through which the instruction may be pipelined.  The default value is 2.
8320 @item selsched-max-insns-to-rename
8321 The maximum number of best instructions in the ready list that are considered
8322 for renaming in the selective scheduler.  The default value is 2.
8324 @item max-last-value-rtl
8325 The maximum size measured as number of RTLs that can be recorded in an expression
8326 in combiner for a pseudo register as last known value of that register.  The default
8327 is 10000.
8329 @item integer-share-limit
8330 Small integer constants can use a shared data structure, reducing the
8331 compiler's memory usage and increasing its speed.  This sets the maximum
8332 value of a shared integer constant.  The default value is 256.
8334 @item min-virtual-mappings
8335 Specifies the minimum number of virtual mappings in the incremental
8336 SSA updater that should be registered to trigger the virtual mappings
8337 heuristic defined by virtual-mappings-ratio.  The default value is
8338 100.
8340 @item virtual-mappings-ratio
8341 If the number of virtual mappings is virtual-mappings-ratio bigger
8342 than the number of virtual symbols to be updated, then the incremental
8343 SSA updater switches to a full update for those symbols.  The default
8344 ratio is 3.
8346 @item ssp-buffer-size
8347 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8348 protection when @option{-fstack-protection} is used.
8350 @item max-jump-thread-duplication-stmts
8351 Maximum number of statements allowed in a block that needs to be
8352 duplicated when threading jumps.
8354 @item max-fields-for-field-sensitive
8355 Maximum number of fields in a structure we will treat in
8356 a field sensitive manner during pointer analysis.  The default is zero
8357 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8359 @item prefetch-latency
8360 Estimate on average number of instructions that are executed before
8361 prefetch finishes.  The distance we prefetch ahead is proportional
8362 to this constant.  Increasing this number may also lead to less
8363 streams being prefetched (see @option{simultaneous-prefetches}).
8365 @item simultaneous-prefetches
8366 Maximum number of prefetches that can run at the same time.
8368 @item l1-cache-line-size
8369 The size of cache line in L1 cache, in bytes.
8371 @item l1-cache-size
8372 The size of L1 cache, in kilobytes.
8374 @item l2-cache-size
8375 The size of L2 cache, in kilobytes.
8377 @item min-insn-to-prefetch-ratio
8378 The minimum ratio between the number of instructions and the
8379 number of prefetches to enable prefetching in a loop with an
8380 unknown trip count.
8382 @item prefetch-min-insn-to-mem-ratio
8383 The minimum ratio between the number of instructions and the
8384 number of memory references to enable prefetching in a loop.
8386 @item use-canonical-types
8387 Whether the compiler should use the ``canonical'' type system.  By
8388 default, this should always be 1, which uses a more efficient internal
8389 mechanism for comparing types in C++ and Objective-C++.  However, if
8390 bugs in the canonical type system are causing compilation failures,
8391 set this value to 0 to disable canonical types.
8393 @item switch-conversion-max-branch-ratio
8394 Switch initialization conversion will refuse to create arrays that are
8395 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8396 branches in the switch.
8398 @item max-partial-antic-length
8399 Maximum length of the partial antic set computed during the tree
8400 partial redundancy elimination optimization (@option{-ftree-pre}) when
8401 optimizing at @option{-O3} and above.  For some sorts of source code
8402 the enhanced partial redundancy elimination optimization can run away,
8403 consuming all of the memory available on the host machine.  This
8404 parameter sets a limit on the length of the sets that are computed,
8405 which prevents the runaway behavior.  Setting a value of 0 for
8406 this parameter will allow an unlimited set length.
8408 @item sccvn-max-scc-size
8409 Maximum size of a strongly connected component (SCC) during SCCVN
8410 processing.  If this limit is hit, SCCVN processing for the whole
8411 function will not be done and optimizations depending on it will
8412 be disabled.  The default maximum SCC size is 10000.
8414 @item ira-max-loops-num
8415 IRA uses a regional register allocation by default.  If a function
8416 contains loops more than number given by the parameter, only at most
8417 given number of the most frequently executed loops will form regions
8418 for the regional register allocation.  The default value of the
8419 parameter is 100.
8421 @item ira-max-conflict-table-size
8422 Although IRA uses a sophisticated algorithm of compression conflict
8423 table, the table can be still big for huge functions.  If the conflict
8424 table for a function could be more than size in MB given by the
8425 parameter, the conflict table is not built and faster, simpler, and
8426 lower quality register allocation algorithm will be used.  The
8427 algorithm do not use pseudo-register conflicts.  The default value of
8428 the parameter is 2000.
8430 @item ira-loop-reserved-regs
8431 IRA can be used to evaluate more accurate register pressure in loops
8432 for decision to move loop invariants (see @option{-O3}).  The number
8433 of available registers reserved for some other purposes is described
8434 by this parameter.  The default value of the parameter is 2 which is
8435 minimal number of registers needed for execution of typical
8436 instruction.  This value is the best found from numerous experiments.
8438 @item loop-invariant-max-bbs-in-loop
8439 Loop invariant motion can be very expensive, both in compile time and
8440 in amount of needed compile time memory, with very large loops.  Loops
8441 with more basic blocks than this parameter won't have loop invariant
8442 motion optimization performed on them.  The default value of the
8443 parameter is 1000 for -O1 and 10000 for -O2 and above.
8445 @item min-nondebug-insn-uid
8446 Use uids starting at this parameter for nondebug insns.  The range below
8447 the parameter is reserved exclusively for debug insns created by
8448 @option{-fvar-tracking-assignments}, but debug insns may get
8449 (non-overlapping) uids above it if the reserved range is exhausted.
8451 @item ipa-sra-ptr-growth-factor
8452 IPA-SRA will replace a pointer to an aggregate with one or more new
8453 parameters only when their cumulative size is less or equal to
8454 @option{ipa-sra-ptr-growth-factor} times the size of the original
8455 pointer parameter.
8457 @end table
8458 @end table
8460 @node Preprocessor Options
8461 @section Options Controlling the Preprocessor
8462 @cindex preprocessor options
8463 @cindex options, preprocessor
8465 These options control the C preprocessor, which is run on each C source
8466 file before actual compilation.
8468 If you use the @option{-E} option, nothing is done except preprocessing.
8469 Some of these options make sense only together with @option{-E} because
8470 they cause the preprocessor output to be unsuitable for actual
8471 compilation.
8473 @table @gcctabopt
8474 @item -Wp,@var{option}
8475 @opindex Wp
8476 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8477 and pass @var{option} directly through to the preprocessor.  If
8478 @var{option} contains commas, it is split into multiple options at the
8479 commas.  However, many options are modified, translated or interpreted
8480 by the compiler driver before being passed to the preprocessor, and
8481 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8482 interface is undocumented and subject to change, so whenever possible
8483 you should avoid using @option{-Wp} and let the driver handle the
8484 options instead.
8486 @item -Xpreprocessor @var{option}
8487 @opindex Xpreprocessor
8488 Pass @var{option} as an option to the preprocessor.  You can use this to
8489 supply system-specific preprocessor options which GCC does not know how to
8490 recognize.
8492 If you want to pass an option that takes an argument, you must use
8493 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8494 @end table
8496 @include cppopts.texi
8498 @node Assembler Options
8499 @section Passing Options to the Assembler
8501 @c prevent bad page break with this line
8502 You can pass options to the assembler.
8504 @table @gcctabopt
8505 @item -Wa,@var{option}
8506 @opindex Wa
8507 Pass @var{option} as an option to the assembler.  If @var{option}
8508 contains commas, it is split into multiple options at the commas.
8510 @item -Xassembler @var{option}
8511 @opindex Xassembler
8512 Pass @var{option} as an option to the assembler.  You can use this to
8513 supply system-specific assembler options which GCC does not know how to
8514 recognize.
8516 If you want to pass an option that takes an argument, you must use
8517 @option{-Xassembler} twice, once for the option and once for the argument.
8519 @end table
8521 @node Link Options
8522 @section Options for Linking
8523 @cindex link options
8524 @cindex options, linking
8526 These options come into play when the compiler links object files into
8527 an executable output file.  They are meaningless if the compiler is
8528 not doing a link step.
8530 @table @gcctabopt
8531 @cindex file names
8532 @item @var{object-file-name}
8533 A file name that does not end in a special recognized suffix is
8534 considered to name an object file or library.  (Object files are
8535 distinguished from libraries by the linker according to the file
8536 contents.)  If linking is done, these object files are used as input
8537 to the linker.
8539 @item -c
8540 @itemx -S
8541 @itemx -E
8542 @opindex c
8543 @opindex S
8544 @opindex E
8545 If any of these options is used, then the linker is not run, and
8546 object file names should not be used as arguments.  @xref{Overall
8547 Options}.
8549 @cindex Libraries
8550 @item -l@var{library}
8551 @itemx -l @var{library}
8552 @opindex l
8553 Search the library named @var{library} when linking.  (The second
8554 alternative with the library as a separate argument is only for
8555 POSIX compliance and is not recommended.)
8557 It makes a difference where in the command you write this option; the
8558 linker searches and processes libraries and object files in the order they
8559 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8560 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8561 to functions in @samp{z}, those functions may not be loaded.
8563 The linker searches a standard list of directories for the library,
8564 which is actually a file named @file{lib@var{library}.a}.  The linker
8565 then uses this file as if it had been specified precisely by name.
8567 The directories searched include several standard system directories
8568 plus any that you specify with @option{-L}.
8570 Normally the files found this way are library files---archive files
8571 whose members are object files.  The linker handles an archive file by
8572 scanning through it for members which define symbols that have so far
8573 been referenced but not defined.  But if the file that is found is an
8574 ordinary object file, it is linked in the usual fashion.  The only
8575 difference between using an @option{-l} option and specifying a file name
8576 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8577 and searches several directories.
8579 @item -lobjc
8580 @opindex lobjc
8581 You need this special case of the @option{-l} option in order to
8582 link an Objective-C or Objective-C++ program.
8584 @item -nostartfiles
8585 @opindex nostartfiles
8586 Do not use the standard system startup files when linking.
8587 The standard system libraries are used normally, unless @option{-nostdlib}
8588 or @option{-nodefaultlibs} is used.
8590 @item -nodefaultlibs
8591 @opindex nodefaultlibs
8592 Do not use the standard system libraries when linking.
8593 Only the libraries you specify will be passed to the linker, options
8594 specifying linkage of the system libraries, such as @code{-static-libgcc}
8595 or @code{-shared-libgcc}, will be ignored.
8596 The standard startup files are used normally, unless @option{-nostartfiles}
8597 is used.  The compiler may generate calls to @code{memcmp},
8598 @code{memset}, @code{memcpy} and @code{memmove}.
8599 These entries are usually resolved by entries in
8600 libc.  These entry points should be supplied through some other
8601 mechanism when this option is specified.
8603 @item -nostdlib
8604 @opindex nostdlib
8605 Do not use the standard system startup files or libraries when linking.
8606 No startup files and only the libraries you specify will be passed to
8607 the linker, options specifying linkage of the system libraries, such as
8608 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8609 The compiler may generate calls to @code{memcmp}, @code{memset},
8610 @code{memcpy} and @code{memmove}.
8611 These entries are usually resolved by entries in
8612 libc.  These entry points should be supplied through some other
8613 mechanism when this option is specified.
8615 @cindex @option{-lgcc}, use with @option{-nostdlib}
8616 @cindex @option{-nostdlib} and unresolved references
8617 @cindex unresolved references and @option{-nostdlib}
8618 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8619 @cindex @option{-nodefaultlibs} and unresolved references
8620 @cindex unresolved references and @option{-nodefaultlibs}
8621 One of the standard libraries bypassed by @option{-nostdlib} and
8622 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8623 that GCC uses to overcome shortcomings of particular machines, or special
8624 needs for some languages.
8625 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8626 Collection (GCC) Internals},
8627 for more discussion of @file{libgcc.a}.)
8628 In most cases, you need @file{libgcc.a} even when you want to avoid
8629 other standard libraries.  In other words, when you specify @option{-nostdlib}
8630 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8631 This ensures that you have no unresolved references to internal GCC
8632 library subroutines.  (For example, @samp{__main}, used to ensure C++
8633 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8634 GNU Compiler Collection (GCC) Internals}.)
8636 @item -pie
8637 @opindex pie
8638 Produce a position independent executable on targets which support it.
8639 For predictable results, you must also specify the same set of options
8640 that were used to generate code (@option{-fpie}, @option{-fPIE},
8641 or model suboptions) when you specify this option.
8643 @item -rdynamic
8644 @opindex rdynamic
8645 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8646 that support it. This instructs the linker to add all symbols, not
8647 only used ones, to the dynamic symbol table. This option is needed
8648 for some uses of @code{dlopen} or to allow obtaining backtraces
8649 from within a program.
8651 @item -s
8652 @opindex s
8653 Remove all symbol table and relocation information from the executable.
8655 @item -static
8656 @opindex static
8657 On systems that support dynamic linking, this prevents linking with the shared
8658 libraries.  On other systems, this option has no effect.
8660 @item -shared
8661 @opindex shared
8662 Produce a shared object which can then be linked with other objects to
8663 form an executable.  Not all systems support this option.  For predictable
8664 results, you must also specify the same set of options that were used to
8665 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8666 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8667 needs to build supplementary stub code for constructors to work.  On
8668 multi-libbed systems, @samp{gcc -shared} must select the correct support
8669 libraries to link against.  Failing to supply the correct flags may lead
8670 to subtle defects.  Supplying them in cases where they are not necessary
8671 is innocuous.}
8673 @item -shared-libgcc
8674 @itemx -static-libgcc
8675 @opindex shared-libgcc
8676 @opindex static-libgcc
8677 On systems that provide @file{libgcc} as a shared library, these options
8678 force the use of either the shared or static version respectively.
8679 If no shared version of @file{libgcc} was built when the compiler was
8680 configured, these options have no effect.
8682 There are several situations in which an application should use the
8683 shared @file{libgcc} instead of the static version.  The most common
8684 of these is when the application wishes to throw and catch exceptions
8685 across different shared libraries.  In that case, each of the libraries
8686 as well as the application itself should use the shared @file{libgcc}.
8688 Therefore, the G++ and GCJ drivers automatically add
8689 @option{-shared-libgcc} whenever you build a shared library or a main
8690 executable, because C++ and Java programs typically use exceptions, so
8691 this is the right thing to do.
8693 If, instead, you use the GCC driver to create shared libraries, you may
8694 find that they will not always be linked with the shared @file{libgcc}.
8695 If GCC finds, at its configuration time, that you have a non-GNU linker
8696 or a GNU linker that does not support option @option{--eh-frame-hdr},
8697 it will link the shared version of @file{libgcc} into shared libraries
8698 by default.  Otherwise, it will take advantage of the linker and optimize
8699 away the linking with the shared version of @file{libgcc}, linking with
8700 the static version of libgcc by default.  This allows exceptions to
8701 propagate through such shared libraries, without incurring relocation
8702 costs at library load time.
8704 However, if a library or main executable is supposed to throw or catch
8705 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8706 for the languages used in the program, or using the option
8707 @option{-shared-libgcc}, such that it is linked with the shared
8708 @file{libgcc}.
8710 @item -static-libstdc++
8711 When the @command{g++} program is used to link a C++ program, it will
8712 normally automatically link against @option{libstdc++}.  If
8713 @file{libstdc++} is available as a shared library, and the
8714 @option{-static} option is not used, then this will link against the
8715 shared version of @file{libstdc++}.  That is normally fine.  However, it
8716 is sometimes useful to freeze the version of @file{libstdc++} used by
8717 the program without going all the way to a fully static link.  The
8718 @option{-static-libstdc++} option directs the @command{g++} driver to
8719 link @file{libstdc++} statically, without necessarily linking other
8720 libraries statically.
8722 @item -symbolic
8723 @opindex symbolic
8724 Bind references to global symbols when building a shared object.  Warn
8725 about any unresolved references (unless overridden by the link editor
8726 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8727 this option.
8729 @item -T @var{script}
8730 @opindex T
8731 @cindex linker script
8732 Use @var{script} as the linker script.  This option is supported by most
8733 systems using the GNU linker.  On some targets, such as bare-board
8734 targets without an operating system, the @option{-T} option may be required
8735 when linking to avoid references to undefined symbols.
8737 @item -Xlinker @var{option}
8738 @opindex Xlinker
8739 Pass @var{option} as an option to the linker.  You can use this to
8740 supply system-specific linker options which GCC does not know how to
8741 recognize.
8743 If you want to pass an option that takes a separate argument, you must use
8744 @option{-Xlinker} twice, once for the option and once for the argument.
8745 For example, to pass @option{-assert definitions}, you must write
8746 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8747 @option{-Xlinker "-assert definitions"}, because this passes the entire
8748 string as a single argument, which is not what the linker expects.
8750 When using the GNU linker, it is usually more convenient to pass
8751 arguments to linker options using the @option{@var{option}=@var{value}}
8752 syntax than as separate arguments.  For example, you can specify
8753 @samp{-Xlinker -Map=output.map} rather than
8754 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8755 this syntax for command-line options.
8757 @item -Wl,@var{option}
8758 @opindex Wl
8759 Pass @var{option} as an option to the linker.  If @var{option} contains
8760 commas, it is split into multiple options at the commas.  You can use this
8761 syntax to pass an argument to the option.
8762 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8763 linker.  When using the GNU linker, you can also get the same effect with
8764 @samp{-Wl,-Map=output.map}.
8766 @item -u @var{symbol}
8767 @opindex u
8768 Pretend the symbol @var{symbol} is undefined, to force linking of
8769 library modules to define it.  You can use @option{-u} multiple times with
8770 different symbols to force loading of additional library modules.
8771 @end table
8773 @node Directory Options
8774 @section Options for Directory Search
8775 @cindex directory options
8776 @cindex options, directory search
8777 @cindex search path
8779 These options specify directories to search for header files, for
8780 libraries and for parts of the compiler:
8782 @table @gcctabopt
8783 @item -I@var{dir}
8784 @opindex I
8785 Add the directory @var{dir} to the head of the list of directories to be
8786 searched for header files.  This can be used to override a system header
8787 file, substituting your own version, since these directories are
8788 searched before the system header file directories.  However, you should
8789 not use this option to add directories that contain vendor-supplied
8790 system header files (use @option{-isystem} for that).  If you use more than
8791 one @option{-I} option, the directories are scanned in left-to-right
8792 order; the standard system directories come after.
8794 If a standard system include directory, or a directory specified with
8795 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8796 option will be ignored.  The directory will still be searched but as a
8797 system directory at its normal position in the system include chain.
8798 This is to ensure that GCC's procedure to fix buggy system headers and
8799 the ordering for the include_next directive are not inadvertently changed.
8800 If you really need to change the search order for system directories,
8801 use the @option{-nostdinc} and/or @option{-isystem} options.
8803 @item -iquote@var{dir}
8804 @opindex iquote
8805 Add the directory @var{dir} to the head of the list of directories to
8806 be searched for header files only for the case of @samp{#include
8807 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8808 otherwise just like @option{-I}.
8810 @item -L@var{dir}
8811 @opindex L
8812 Add directory @var{dir} to the list of directories to be searched
8813 for @option{-l}.
8815 @item -B@var{prefix}
8816 @opindex B
8817 This option specifies where to find the executables, libraries,
8818 include files, and data files of the compiler itself.
8820 The compiler driver program runs one or more of the subprograms
8821 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8822 @var{prefix} as a prefix for each program it tries to run, both with and
8823 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8825 For each subprogram to be run, the compiler driver first tries the
8826 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8827 was not specified, the driver tries two standard prefixes, which are
8828 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8829 those results in a file name that is found, the unmodified program
8830 name is searched for using the directories specified in your
8831 @env{PATH} environment variable.
8833 The compiler will check to see if the path provided by the @option{-B}
8834 refers to a directory, and if necessary it will add a directory
8835 separator character at the end of the path.
8837 @option{-B} prefixes that effectively specify directory names also apply
8838 to libraries in the linker, because the compiler translates these
8839 options into @option{-L} options for the linker.  They also apply to
8840 includes files in the preprocessor, because the compiler translates these
8841 options into @option{-isystem} options for the preprocessor.  In this case,
8842 the compiler appends @samp{include} to the prefix.
8844 The run-time support file @file{libgcc.a} can also be searched for using
8845 the @option{-B} prefix, if needed.  If it is not found there, the two
8846 standard prefixes above are tried, and that is all.  The file is left
8847 out of the link if it is not found by those means.
8849 Another way to specify a prefix much like the @option{-B} prefix is to use
8850 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8851 Variables}.
8853 As a special kludge, if the path provided by @option{-B} is
8854 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8855 9, then it will be replaced by @file{[dir/]include}.  This is to help
8856 with boot-strapping the compiler.
8858 @item -specs=@var{file}
8859 @opindex specs
8860 Process @var{file} after the compiler reads in the standard @file{specs}
8861 file, in order to override the defaults that the @file{gcc} driver
8862 program uses when determining what switches to pass to @file{cc1},
8863 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8864 @option{-specs=@var{file}} can be specified on the command line, and they
8865 are processed in order, from left to right.
8867 @item --sysroot=@var{dir}
8868 @opindex sysroot
8869 Use @var{dir} as the logical root directory for headers and libraries.
8870 For example, if the compiler would normally search for headers in
8871 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8872 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8874 If you use both this option and the @option{-isysroot} option, then
8875 the @option{--sysroot} option will apply to libraries, but the
8876 @option{-isysroot} option will apply to header files.
8878 The GNU linker (beginning with version 2.16) has the necessary support
8879 for this option.  If your linker does not support this option, the
8880 header file aspect of @option{--sysroot} will still work, but the
8881 library aspect will not.
8883 @item -I-
8884 @opindex I-
8885 This option has been deprecated.  Please use @option{-iquote} instead for
8886 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8887 Any directories you specify with @option{-I} options before the @option{-I-}
8888 option are searched only for the case of @samp{#include "@var{file}"};
8889 they are not searched for @samp{#include <@var{file}>}.
8891 If additional directories are specified with @option{-I} options after
8892 the @option{-I-}, these directories are searched for all @samp{#include}
8893 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8894 this way.)
8896 In addition, the @option{-I-} option inhibits the use of the current
8897 directory (where the current input file came from) as the first search
8898 directory for @samp{#include "@var{file}"}.  There is no way to
8899 override this effect of @option{-I-}.  With @option{-I.} you can specify
8900 searching the directory which was current when the compiler was
8901 invoked.  That is not exactly the same as what the preprocessor does
8902 by default, but it is often satisfactory.
8904 @option{-I-} does not inhibit the use of the standard system directories
8905 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8906 independent.
8907 @end table
8909 @c man end
8911 @node Spec Files
8912 @section Specifying subprocesses and the switches to pass to them
8913 @cindex Spec Files
8915 @command{gcc} is a driver program.  It performs its job by invoking a
8916 sequence of other programs to do the work of compiling, assembling and
8917 linking.  GCC interprets its command-line parameters and uses these to
8918 deduce which programs it should invoke, and which command-line options
8919 it ought to place on their command lines.  This behavior is controlled
8920 by @dfn{spec strings}.  In most cases there is one spec string for each
8921 program that GCC can invoke, but a few programs have multiple spec
8922 strings to control their behavior.  The spec strings built into GCC can
8923 be overridden by using the @option{-specs=} command-line switch to specify
8924 a spec file.
8926 @dfn{Spec files} are plaintext files that are used to construct spec
8927 strings.  They consist of a sequence of directives separated by blank
8928 lines.  The type of directive is determined by the first non-whitespace
8929 character on the line and it can be one of the following:
8931 @table @code
8932 @item %@var{command}
8933 Issues a @var{command} to the spec file processor.  The commands that can
8934 appear here are:
8936 @table @code
8937 @item %include <@var{file}>
8938 @cindex %include
8939 Search for @var{file} and insert its text at the current point in the
8940 specs file.
8942 @item %include_noerr <@var{file}>
8943 @cindex %include_noerr
8944 Just like @samp{%include}, but do not generate an error message if the include
8945 file cannot be found.
8947 @item %rename @var{old_name} @var{new_name}
8948 @cindex %rename
8949 Rename the spec string @var{old_name} to @var{new_name}.
8951 @end table
8953 @item *[@var{spec_name}]:
8954 This tells the compiler to create, override or delete the named spec
8955 string.  All lines after this directive up to the next directive or
8956 blank line are considered to be the text for the spec string.  If this
8957 results in an empty string then the spec will be deleted.  (Or, if the
8958 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8959 does not currently exist a new spec will be created.  If the spec does
8960 exist then its contents will be overridden by the text of this
8961 directive, unless the first character of that text is the @samp{+}
8962 character, in which case the text will be appended to the spec.
8964 @item [@var{suffix}]:
8965 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
8966 and up to the next directive or blank line are considered to make up the
8967 spec string for the indicated suffix.  When the compiler encounters an
8968 input file with the named suffix, it will processes the spec string in
8969 order to work out how to compile that file.  For example:
8971 @smallexample
8972 .ZZ:
8973 z-compile -input %i
8974 @end smallexample
8976 This says that any input file whose name ends in @samp{.ZZ} should be
8977 passed to the program @samp{z-compile}, which should be invoked with the
8978 command-line switch @option{-input} and with the result of performing the
8979 @samp{%i} substitution.  (See below.)
8981 As an alternative to providing a spec string, the text that follows a
8982 suffix directive can be one of the following:
8984 @table @code
8985 @item @@@var{language}
8986 This says that the suffix is an alias for a known @var{language}.  This is
8987 similar to using the @option{-x} command-line switch to GCC to specify a
8988 language explicitly.  For example:
8990 @smallexample
8991 .ZZ:
8992 @@c++
8993 @end smallexample
8995 Says that .ZZ files are, in fact, C++ source files.
8997 @item #@var{name}
8998 This causes an error messages saying:
9000 @smallexample
9001 @var{name} compiler not installed on this system.
9002 @end smallexample
9003 @end table
9005 GCC already has an extensive list of suffixes built into it.
9006 This directive will add an entry to the end of the list of suffixes, but
9007 since the list is searched from the end backwards, it is effectively
9008 possible to override earlier entries using this technique.
9010 @end table
9012 GCC has the following spec strings built into it.  Spec files can
9013 override these strings or create their own.  Note that individual
9014 targets can also add their own spec strings to this list.
9016 @smallexample
9017 asm          Options to pass to the assembler
9018 asm_final    Options to pass to the assembler post-processor
9019 cpp          Options to pass to the C preprocessor
9020 cc1          Options to pass to the C compiler
9021 cc1plus      Options to pass to the C++ compiler
9022 endfile      Object files to include at the end of the link
9023 link         Options to pass to the linker
9024 lib          Libraries to include on the command line to the linker
9025 libgcc       Decides which GCC support library to pass to the linker
9026 linker       Sets the name of the linker
9027 predefines   Defines to be passed to the C preprocessor
9028 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9029              by default
9030 startfile    Object files to include at the start of the link
9031 @end smallexample
9033 Here is a small example of a spec file:
9035 @smallexample
9036 %rename lib                 old_lib
9038 *lib:
9039 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9040 @end smallexample
9042 This example renames the spec called @samp{lib} to @samp{old_lib} and
9043 then overrides the previous definition of @samp{lib} with a new one.
9044 The new definition adds in some extra command-line options before
9045 including the text of the old definition.
9047 @dfn{Spec strings} are a list of command-line options to be passed to their
9048 corresponding program.  In addition, the spec strings can contain
9049 @samp{%}-prefixed sequences to substitute variable text or to
9050 conditionally insert text into the command line.  Using these constructs
9051 it is possible to generate quite complex command lines.
9053 Here is a table of all defined @samp{%}-sequences for spec
9054 strings.  Note that spaces are not generated automatically around the
9055 results of expanding these sequences.  Therefore you can concatenate them
9056 together or combine them with constant text in a single argument.
9058 @table @code
9059 @item %%
9060 Substitute one @samp{%} into the program name or argument.
9062 @item %i
9063 Substitute the name of the input file being processed.
9065 @item %b
9066 Substitute the basename of the input file being processed.
9067 This is the substring up to (and not including) the last period
9068 and not including the directory.
9070 @item %B
9071 This is the same as @samp{%b}, but include the file suffix (text after
9072 the last period).
9074 @item %d
9075 Marks the argument containing or following the @samp{%d} as a
9076 temporary file name, so that that file will be deleted if GCC exits
9077 successfully.  Unlike @samp{%g}, this contributes no text to the
9078 argument.
9080 @item %g@var{suffix}
9081 Substitute a file name that has suffix @var{suffix} and is chosen
9082 once per compilation, and mark the argument in the same way as
9083 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9084 name is now chosen in a way that is hard to predict even when previously
9085 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9086 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9087 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9088 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9089 was simply substituted with a file name chosen once per compilation,
9090 without regard to any appended suffix (which was therefore treated
9091 just like ordinary text), making such attacks more likely to succeed.
9093 @item %u@var{suffix}
9094 Like @samp{%g}, but generates a new temporary file name even if
9095 @samp{%u@var{suffix}} was already seen.
9097 @item %U@var{suffix}
9098 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9099 new one if there is no such last file name.  In the absence of any
9100 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9101 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9102 would involve the generation of two distinct file names, one
9103 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9104 simply substituted with a file name chosen for the previous @samp{%u},
9105 without regard to any appended suffix.
9107 @item %j@var{suffix}
9108 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9109 writable, and if save-temps is off; otherwise, substitute the name
9110 of a temporary file, just like @samp{%u}.  This temporary file is not
9111 meant for communication between processes, but rather as a junk
9112 disposal mechanism.
9114 @item %|@var{suffix}
9115 @itemx %m@var{suffix}
9116 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9117 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9118 all.  These are the two most common ways to instruct a program that it
9119 should read from standard input or write to standard output.  If you
9120 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9121 construct: see for example @file{f/lang-specs.h}.
9123 @item %.@var{SUFFIX}
9124 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9125 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9126 terminated by the next space or %.
9128 @item %w
9129 Marks the argument containing or following the @samp{%w} as the
9130 designated output file of this compilation.  This puts the argument
9131 into the sequence of arguments that @samp{%o} will substitute later.
9133 @item %o
9134 Substitutes the names of all the output files, with spaces
9135 automatically placed around them.  You should write spaces
9136 around the @samp{%o} as well or the results are undefined.
9137 @samp{%o} is for use in the specs for running the linker.
9138 Input files whose names have no recognized suffix are not compiled
9139 at all, but they are included among the output files, so they will
9140 be linked.
9142 @item %O
9143 Substitutes the suffix for object files.  Note that this is
9144 handled specially when it immediately follows @samp{%g, %u, or %U},
9145 because of the need for those to form complete file names.  The
9146 handling is such that @samp{%O} is treated exactly as if it had already
9147 been substituted, except that @samp{%g, %u, and %U} do not currently
9148 support additional @var{suffix} characters following @samp{%O} as they would
9149 following, for example, @samp{.o}.
9151 @item %p
9152 Substitutes the standard macro predefinitions for the
9153 current target machine.  Use this when running @code{cpp}.
9155 @item %P
9156 Like @samp{%p}, but puts @samp{__} before and after the name of each
9157 predefined macro, except for macros that start with @samp{__} or with
9158 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9161 @item %I
9162 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9163 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9164 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9165 and @option{-imultilib} as necessary.
9167 @item %s
9168 Current argument is the name of a library or startup file of some sort.
9169 Search for that file in a standard list of directories and substitute
9170 the full name found.  The current working directory is included in the
9171 list of directories scanned.
9173 @item %T
9174 Current argument is the name of a linker script.  Search for that file
9175 in the current list of directories to scan for libraries. If the file
9176 is located insert a @option{--script} option into the command line
9177 followed by the full path name found.  If the file is not found then
9178 generate an error message.  Note: the current working directory is not
9179 searched.
9181 @item %e@var{str}
9182 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9183 Use this when inconsistent options are detected.
9185 @item %(@var{name})
9186 Substitute the contents of spec string @var{name} at this point.
9188 @item %[@var{name}]
9189 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9191 @item %x@{@var{option}@}
9192 Accumulate an option for @samp{%X}.
9194 @item %X
9195 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9196 spec string.
9198 @item %Y
9199 Output the accumulated assembler options specified by @option{-Wa}.
9201 @item %Z
9202 Output the accumulated preprocessor options specified by @option{-Wp}.
9204 @item %a
9205 Process the @code{asm} spec.  This is used to compute the
9206 switches to be passed to the assembler.
9208 @item %A
9209 Process the @code{asm_final} spec.  This is a spec string for
9210 passing switches to an assembler post-processor, if such a program is
9211 needed.
9213 @item %l
9214 Process the @code{link} spec.  This is the spec for computing the
9215 command line passed to the linker.  Typically it will make use of the
9216 @samp{%L %G %S %D and %E} sequences.
9218 @item %D
9219 Dump out a @option{-L} option for each directory that GCC believes might
9220 contain startup files.  If the target supports multilibs then the
9221 current multilib directory will be prepended to each of these paths.
9223 @item %L
9224 Process the @code{lib} spec.  This is a spec string for deciding which
9225 libraries should be included on the command line to the linker.
9227 @item %G
9228 Process the @code{libgcc} spec.  This is a spec string for deciding
9229 which GCC support library should be included on the command line to the linker.
9231 @item %S
9232 Process the @code{startfile} spec.  This is a spec for deciding which
9233 object files should be the first ones passed to the linker.  Typically
9234 this might be a file named @file{crt0.o}.
9236 @item %E
9237 Process the @code{endfile} spec.  This is a spec string that specifies
9238 the last object files that will be passed to the linker.
9240 @item %C
9241 Process the @code{cpp} spec.  This is used to construct the arguments
9242 to be passed to the C preprocessor.
9244 @item %1
9245 Process the @code{cc1} spec.  This is used to construct the options to be
9246 passed to the actual C compiler (@samp{cc1}).
9248 @item %2
9249 Process the @code{cc1plus} spec.  This is used to construct the options to be
9250 passed to the actual C++ compiler (@samp{cc1plus}).
9252 @item %*
9253 Substitute the variable part of a matched option.  See below.
9254 Note that each comma in the substituted string is replaced by
9255 a single space.
9257 @item %<@code{S}
9258 Remove all occurrences of @code{-S} from the command line.  Note---this
9259 command is position dependent.  @samp{%} commands in the spec string
9260 before this one will see @code{-S}, @samp{%} commands in the spec string
9261 after this one will not.
9263 @item %:@var{function}(@var{args})
9264 Call the named function @var{function}, passing it @var{args}.
9265 @var{args} is first processed as a nested spec string, then split
9266 into an argument vector in the usual fashion.  The function returns
9267 a string which is processed as if it had appeared literally as part
9268 of the current spec.
9270 The following built-in spec functions are provided:
9272 @table @code
9273 @item @code{getenv}
9274 The @code{getenv} spec function takes two arguments: an environment
9275 variable name and a string.  If the environment variable is not
9276 defined, a fatal error is issued.  Otherwise, the return value is the
9277 value of the environment variable concatenated with the string.  For
9278 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9280 @smallexample
9281 %:getenv(TOPDIR /include)
9282 @end smallexample
9284 expands to @file{/path/to/top/include}.
9286 @item @code{if-exists}
9287 The @code{if-exists} spec function takes one argument, an absolute
9288 pathname to a file.  If the file exists, @code{if-exists} returns the
9289 pathname.  Here is a small example of its usage:
9291 @smallexample
9292 *startfile:
9293 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9294 @end smallexample
9296 @item @code{if-exists-else}
9297 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9298 spec function, except that it takes two arguments.  The first argument is
9299 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9300 returns the pathname.  If it does not exist, it returns the second argument.
9301 This way, @code{if-exists-else} can be used to select one file or another,
9302 based on the existence of the first.  Here is a small example of its usage:
9304 @smallexample
9305 *startfile:
9306 crt0%O%s %:if-exists(crti%O%s) \
9307 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9308 @end smallexample
9310 @item @code{replace-outfile}
9311 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9312 first argument in the outfiles array and replaces it with the second argument.  Here
9313 is a small example of its usage:
9315 @smallexample
9316 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9317 @end smallexample
9319 @item @code{print-asm-header}
9320 The @code{print-asm-header} function takes no arguments and simply
9321 prints a banner like:
9323 @smallexample
9324 Assembler options
9325 =================
9327 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9328 @end smallexample
9330 It is used to separate compiler options from assembler options
9331 in the @option{--target-help} output.
9332 @end table
9334 @item %@{@code{S}@}
9335 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9336 If that switch was not specified, this substitutes nothing.  Note that
9337 the leading dash is omitted when specifying this option, and it is
9338 automatically inserted if the substitution is performed.  Thus the spec
9339 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9340 and would output the command line option @option{-foo}.
9342 @item %W@{@code{S}@}
9343 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9344 deleted on failure.
9346 @item %@{@code{S}*@}
9347 Substitutes all the switches specified to GCC whose names start
9348 with @code{-S}, but which also take an argument.  This is used for
9349 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9350 GCC considers @option{-o foo} as being
9351 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9352 text, including the space.  Thus two arguments would be generated.
9354 @item %@{@code{S}*&@code{T}*@}
9355 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9356 (the order of @code{S} and @code{T} in the spec is not significant).
9357 There can be any number of ampersand-separated variables; for each the
9358 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9360 @item %@{@code{S}:@code{X}@}
9361 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9363 @item %@{!@code{S}:@code{X}@}
9364 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9366 @item %@{@code{S}*:@code{X}@}
9367 Substitutes @code{X} if one or more switches whose names start with
9368 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9369 once, no matter how many such switches appeared.  However, if @code{%*}
9370 appears somewhere in @code{X}, then @code{X} will be substituted once
9371 for each matching switch, with the @code{%*} replaced by the part of
9372 that switch that matched the @code{*}.
9374 @item %@{.@code{S}:@code{X}@}
9375 Substitutes @code{X}, if processing a file with suffix @code{S}.
9377 @item %@{!.@code{S}:@code{X}@}
9378 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9380 @item %@{,@code{S}:@code{X}@}
9381 Substitutes @code{X}, if processing a file for language @code{S}.
9383 @item %@{!,@code{S}:@code{X}@}
9384 Substitutes @code{X}, if not processing a file for language @code{S}.
9386 @item %@{@code{S}|@code{P}:@code{X}@}
9387 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9388 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9389 @code{*} sequences as well, although they have a stronger binding than
9390 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9391 alternatives must be starred, and only the first matching alternative
9392 is substituted.
9394 For example, a spec string like this:
9396 @smallexample
9397 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9398 @end smallexample
9400 will output the following command-line options from the following input
9401 command-line options:
9403 @smallexample
9404 fred.c        -foo -baz
9405 jim.d         -bar -boggle
9406 -d fred.c     -foo -baz -boggle
9407 -d jim.d      -bar -baz -boggle
9408 @end smallexample
9410 @item %@{S:X; T:Y; :D@}
9412 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9413 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9414 be as many clauses as you need.  This may be combined with @code{.},
9415 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9418 @end table
9420 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9421 construct may contain other nested @samp{%} constructs or spaces, or
9422 even newlines.  They are processed as usual, as described above.
9423 Trailing white space in @code{X} is ignored.  White space may also
9424 appear anywhere on the left side of the colon in these constructs,
9425 except between @code{.} or @code{*} and the corresponding word.
9427 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9428 handled specifically in these constructs.  If another value of
9429 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9430 @option{-W} switch is found later in the command line, the earlier
9431 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9432 just one letter, which passes all matching options.
9434 The character @samp{|} at the beginning of the predicate text is used to
9435 indicate that a command should be piped to the following command, but
9436 only if @option{-pipe} is specified.
9438 It is built into GCC which switches take arguments and which do not.
9439 (You might think it would be useful to generalize this to allow each
9440 compiler's spec to say which switches take arguments.  But this cannot
9441 be done in a consistent fashion.  GCC cannot even decide which input
9442 files have been specified without knowing which switches take arguments,
9443 and it must know which input files to compile in order to tell which
9444 compilers to run).
9446 GCC also knows implicitly that arguments starting in @option{-l} are to be
9447 treated as compiler output files, and passed to the linker in their
9448 proper position among the other output files.
9450 @c man begin OPTIONS
9452 @node Target Options
9453 @section Specifying Target Machine and Compiler Version
9454 @cindex target options
9455 @cindex cross compiling
9456 @cindex specifying machine version
9457 @cindex specifying compiler version and target machine
9458 @cindex compiler version, specifying
9459 @cindex target machine, specifying
9461 The usual way to run GCC is to run the executable called @file{gcc}, or
9462 @file{<machine>-gcc} when cross-compiling, or
9463 @file{<machine>-gcc-<version>} to run a version other than the one that
9464 was installed last.  Sometimes this is inconvenient, so GCC provides
9465 options that will switch to another cross-compiler or version.
9467 @table @gcctabopt
9468 @item -b @var{machine}
9469 @opindex b
9470 The argument @var{machine} specifies the target machine for compilation.
9472 The value to use for @var{machine} is the same as was specified as the
9473 machine type when configuring GCC as a cross-compiler.  For
9474 example, if a cross-compiler was configured with @samp{configure
9475 arm-elf}, meaning to compile for an arm processor with elf binaries,
9476 then you would specify @option{-b arm-elf} to run that cross compiler.
9477 Because there are other options beginning with @option{-b}, the
9478 configuration must contain a hyphen, or @option{-b} alone should be one
9479 argument followed by the configuration in the next argument.
9481 @item -V @var{version}
9482 @opindex V
9483 The argument @var{version} specifies which version of GCC to run.
9484 This is useful when multiple versions are installed.  For example,
9485 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
9486 @end table
9488 The @option{-V} and @option{-b} options work by running the
9489 @file{<machine>-gcc-<version>} executable, so there's no real reason to
9490 use them if you can just run that directly.
9492 @node Submodel Options
9493 @section Hardware Models and Configurations
9494 @cindex submodel options
9495 @cindex specifying hardware config
9496 @cindex hardware models and configurations, specifying
9497 @cindex machine dependent options
9499 Earlier we discussed the standard option @option{-b} which chooses among
9500 different installed compilers for completely different target
9501 machines, such as VAX vs.@: 68000 vs.@: 80386.
9503 In addition, each of these target machine types can have its own
9504 special options, starting with @samp{-m}, to choose among various
9505 hardware models or configurations---for example, 68010 vs 68020,
9506 floating coprocessor or none.  A single installed version of the
9507 compiler can compile for any model or configuration, according to the
9508 options specified.
9510 Some configurations of the compiler also support additional special
9511 options, usually for compatibility with other compilers on the same
9512 platform.
9514 @c This list is ordered alphanumerically by subsection name.
9515 @c It should be the same order and spelling as these options are listed
9516 @c in Machine Dependent Options
9518 @menu
9519 * ARC Options::
9520 * ARM Options::
9521 * AVR Options::
9522 * Blackfin Options::
9523 * CRIS Options::
9524 * CRX Options::
9525 * Darwin Options::
9526 * DEC Alpha Options::
9527 * DEC Alpha/VMS Options::
9528 * FR30 Options::
9529 * FRV Options::
9530 * GNU/Linux Options::
9531 * H8/300 Options::
9532 * HPPA Options::
9533 * i386 and x86-64 Options::
9534 * i386 and x86-64 Windows Options::
9535 * IA-64 Options::
9536 * IA-64/VMS Options::
9537 * M32C Options::
9538 * M32R/D Options::
9539 * M680x0 Options::
9540 * M68hc1x Options::
9541 * MCore Options::
9542 * MeP Options::
9543 * MIPS Options::
9544 * MMIX Options::
9545 * MN10300 Options::
9546 * PDP-11 Options::
9547 * picoChip Options::
9548 * PowerPC Options::
9549 * RS/6000 and PowerPC Options::
9550 * RX Options::
9551 * S/390 and zSeries Options::
9552 * Score Options::
9553 * SH Options::
9554 * SPARC Options::
9555 * SPU Options::
9556 * System V Options::
9557 * V850 Options::
9558 * VAX Options::
9559 * VxWorks Options::
9560 * x86-64 Options::
9561 * Xstormy16 Options::
9562 * Xtensa Options::
9563 * zSeries Options::
9564 @end menu
9566 @node ARC Options
9567 @subsection ARC Options
9568 @cindex ARC Options
9570 These options are defined for ARC implementations:
9572 @table @gcctabopt
9573 @item -EL
9574 @opindex EL
9575 Compile code for little endian mode.  This is the default.
9577 @item -EB
9578 @opindex EB
9579 Compile code for big endian mode.
9581 @item -mmangle-cpu
9582 @opindex mmangle-cpu
9583 Prepend the name of the cpu to all public symbol names.
9584 In multiple-processor systems, there are many ARC variants with different
9585 instruction and register set characteristics.  This flag prevents code
9586 compiled for one cpu to be linked with code compiled for another.
9587 No facility exists for handling variants that are ``almost identical''.
9588 This is an all or nothing option.
9590 @item -mcpu=@var{cpu}
9591 @opindex mcpu
9592 Compile code for ARC variant @var{cpu}.
9593 Which variants are supported depend on the configuration.
9594 All variants support @option{-mcpu=base}, this is the default.
9596 @item -mtext=@var{text-section}
9597 @itemx -mdata=@var{data-section}
9598 @itemx -mrodata=@var{readonly-data-section}
9599 @opindex mtext
9600 @opindex mdata
9601 @opindex mrodata
9602 Put functions, data, and readonly data in @var{text-section},
9603 @var{data-section}, and @var{readonly-data-section} respectively
9604 by default.  This can be overridden with the @code{section} attribute.
9605 @xref{Variable Attributes}.
9607 @item -mfix-cortex-m3-ldrd
9608 @opindex mfix-cortex-m3-ldrd
9609 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9610 with overlapping destination and base registers are used.  This option avoids
9611 generating these instructions.  This option is enabled by default when
9612 @option{-mcpu=cortex-m3} is specified.
9614 @end table
9616 @node ARM Options
9617 @subsection ARM Options
9618 @cindex ARM options
9620 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9621 architectures:
9623 @table @gcctabopt
9624 @item -mabi=@var{name}
9625 @opindex mabi
9626 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9627 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9629 @item -mapcs-frame
9630 @opindex mapcs-frame
9631 Generate a stack frame that is compliant with the ARM Procedure Call
9632 Standard for all functions, even if this is not strictly necessary for
9633 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9634 with this option will cause the stack frames not to be generated for
9635 leaf functions.  The default is @option{-mno-apcs-frame}.
9637 @item -mapcs
9638 @opindex mapcs
9639 This is a synonym for @option{-mapcs-frame}.
9641 @ignore
9642 @c not currently implemented
9643 @item -mapcs-stack-check
9644 @opindex mapcs-stack-check
9645 Generate code to check the amount of stack space available upon entry to
9646 every function (that actually uses some stack space).  If there is
9647 insufficient space available then either the function
9648 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9649 called, depending upon the amount of stack space required.  The run time
9650 system is required to provide these functions.  The default is
9651 @option{-mno-apcs-stack-check}, since this produces smaller code.
9653 @c not currently implemented
9654 @item -mapcs-float
9655 @opindex mapcs-float
9656 Pass floating point arguments using the float point registers.  This is
9657 one of the variants of the APCS@.  This option is recommended if the
9658 target hardware has a floating point unit or if a lot of floating point
9659 arithmetic is going to be performed by the code.  The default is
9660 @option{-mno-apcs-float}, since integer only code is slightly increased in
9661 size if @option{-mapcs-float} is used.
9663 @c not currently implemented
9664 @item -mapcs-reentrant
9665 @opindex mapcs-reentrant
9666 Generate reentrant, position independent code.  The default is
9667 @option{-mno-apcs-reentrant}.
9668 @end ignore
9670 @item -mthumb-interwork
9671 @opindex mthumb-interwork
9672 Generate code which supports calling between the ARM and Thumb
9673 instruction sets.  Without this option the two instruction sets cannot
9674 be reliably used inside one program.  The default is
9675 @option{-mno-thumb-interwork}, since slightly larger code is generated
9676 when @option{-mthumb-interwork} is specified.
9678 @item -mno-sched-prolog
9679 @opindex mno-sched-prolog
9680 Prevent the reordering of instructions in the function prolog, or the
9681 merging of those instruction with the instructions in the function's
9682 body.  This means that all functions will start with a recognizable set
9683 of instructions (or in fact one of a choice from a small set of
9684 different function prologues), and this information can be used to
9685 locate the start if functions inside an executable piece of code.  The
9686 default is @option{-msched-prolog}.
9688 @item -mfloat-abi=@var{name}
9689 @opindex mfloat-abi
9690 Specifies which floating-point ABI to use.  Permissible values
9691 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9693 Specifying @samp{soft} causes GCC to generate output containing
9694 library calls for floating-point operations.
9695 @samp{softfp} allows the generation of code using hardware floating-point
9696 instructions, but still uses the soft-float calling conventions.
9697 @samp{hard} allows generation of floating-point instructions
9698 and uses FPU-specific calling conventions.
9700 The default depends on the specific target configuration.  Note that
9701 the hard-float and soft-float ABIs are not link-compatible; you must
9702 compile your entire program with the same ABI, and link with a
9703 compatible set of libraries.
9705 @item -mhard-float
9706 @opindex mhard-float
9707 Equivalent to @option{-mfloat-abi=hard}.
9709 @item -msoft-float
9710 @opindex msoft-float
9711 Equivalent to @option{-mfloat-abi=soft}.
9713 @item -mlittle-endian
9714 @opindex mlittle-endian
9715 Generate code for a processor running in little-endian mode.  This is
9716 the default for all standard configurations.
9718 @item -mbig-endian
9719 @opindex mbig-endian
9720 Generate code for a processor running in big-endian mode; the default is
9721 to compile code for a little-endian processor.
9723 @item -mwords-little-endian
9724 @opindex mwords-little-endian
9725 This option only applies when generating code for big-endian processors.
9726 Generate code for a little-endian word order but a big-endian byte
9727 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9728 option should only be used if you require compatibility with code for
9729 big-endian ARM processors generated by versions of the compiler prior to
9730 2.8.
9732 @item -mcpu=@var{name}
9733 @opindex mcpu
9734 This specifies the name of the target ARM processor.  GCC uses this name
9735 to determine what kind of instructions it can emit when generating
9736 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9737 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9738 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9739 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9740 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9741 @samp{arm720},
9742 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9743 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9744 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9745 @samp{strongarm1110},
9746 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9747 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9748 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9749 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9750 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9751 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9752 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9753 @samp{cortex-a8}, @samp{cortex-a9},
9754 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9755 @samp{cortex-m1},
9756 @samp{cortex-m0},
9757 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9759 @item -mtune=@var{name}
9760 @opindex mtune
9761 This option is very similar to the @option{-mcpu=} option, except that
9762 instead of specifying the actual target processor type, and hence
9763 restricting which instructions can be used, it specifies that GCC should
9764 tune the performance of the code as if the target were of the type
9765 specified in this option, but still choosing the instructions that it
9766 will generate based on the cpu specified by a @option{-mcpu=} option.
9767 For some ARM implementations better performance can be obtained by using
9768 this option.
9770 @item -march=@var{name}
9771 @opindex march
9772 This specifies the name of the target ARM architecture.  GCC uses this
9773 name to determine what kind of instructions it can emit when generating
9774 assembly code.  This option can be used in conjunction with or instead
9775 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9776 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9777 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9778 @samp{armv6}, @samp{armv6j},
9779 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9780 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9781 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9783 @item -mfpu=@var{name}
9784 @itemx -mfpe=@var{number}
9785 @itemx -mfp=@var{number}
9786 @opindex mfpu
9787 @opindex mfpe
9788 @opindex mfp
9789 This specifies what floating point hardware (or hardware emulation) is
9790 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9791 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-d16},
9792 @samp{neon}, and @samp{neon-fp16}.  @option{-mfp} and @option{-mfpe}
9793 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
9794 with older versions of GCC@.
9796 If @option{-msoft-float} is specified this specifies the format of
9797 floating point values.
9799 @item -mfp16-format=@var{name}
9800 @opindex mfp16-format
9801 Specify the format of the @code{__fp16} half-precision floating-point type.
9802 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9803 the default is @samp{none}, in which case the @code{__fp16} type is not
9804 defined.  @xref{Half-Precision}, for more information.
9806 @item -mstructure-size-boundary=@var{n}
9807 @opindex mstructure-size-boundary
9808 The size of all structures and unions will be rounded up to a multiple
9809 of the number of bits set by this option.  Permissible values are 8, 32
9810 and 64.  The default value varies for different toolchains.  For the COFF
9811 targeted toolchain the default value is 8.  A value of 64 is only allowed
9812 if the underlying ABI supports it.
9814 Specifying the larger number can produce faster, more efficient code, but
9815 can also increase the size of the program.  Different values are potentially
9816 incompatible.  Code compiled with one value cannot necessarily expect to
9817 work with code or libraries compiled with another value, if they exchange
9818 information using structures or unions.
9820 @item -mabort-on-noreturn
9821 @opindex mabort-on-noreturn
9822 Generate a call to the function @code{abort} at the end of a
9823 @code{noreturn} function.  It will be executed if the function tries to
9824 return.
9826 @item -mlong-calls
9827 @itemx -mno-long-calls
9828 @opindex mlong-calls
9829 @opindex mno-long-calls
9830 Tells the compiler to perform function calls by first loading the
9831 address of the function into a register and then performing a subroutine
9832 call on this register.  This switch is needed if the target function
9833 will lie outside of the 64 megabyte addressing range of the offset based
9834 version of subroutine call instruction.
9836 Even if this switch is enabled, not all function calls will be turned
9837 into long calls.  The heuristic is that static functions, functions
9838 which have the @samp{short-call} attribute, functions that are inside
9839 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9840 definitions have already been compiled within the current compilation
9841 unit, will not be turned into long calls.  The exception to this rule is
9842 that weak function definitions, functions with the @samp{long-call}
9843 attribute or the @samp{section} attribute, and functions that are within
9844 the scope of a @samp{#pragma long_calls} directive, will always be
9845 turned into long calls.
9847 This feature is not enabled by default.  Specifying
9848 @option{-mno-long-calls} will restore the default behavior, as will
9849 placing the function calls within the scope of a @samp{#pragma
9850 long_calls_off} directive.  Note these switches have no effect on how
9851 the compiler generates code to handle function calls via function
9852 pointers.
9854 @item -msingle-pic-base
9855 @opindex msingle-pic-base
9856 Treat the register used for PIC addressing as read-only, rather than
9857 loading it in the prologue for each function.  The run-time system is
9858 responsible for initializing this register with an appropriate value
9859 before execution begins.
9861 @item -mpic-register=@var{reg}
9862 @opindex mpic-register
9863 Specify the register to be used for PIC addressing.  The default is R10
9864 unless stack-checking is enabled, when R9 is used.
9866 @item -mcirrus-fix-invalid-insns
9867 @opindex mcirrus-fix-invalid-insns
9868 @opindex mno-cirrus-fix-invalid-insns
9869 Insert NOPs into the instruction stream to in order to work around
9870 problems with invalid Maverick instruction combinations.  This option
9871 is only valid if the @option{-mcpu=ep9312} option has been used to
9872 enable generation of instructions for the Cirrus Maverick floating
9873 point co-processor.  This option is not enabled by default, since the
9874 problem is only present in older Maverick implementations.  The default
9875 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9876 switch.
9878 @item -mpoke-function-name
9879 @opindex mpoke-function-name
9880 Write the name of each function into the text section, directly
9881 preceding the function prologue.  The generated code is similar to this:
9883 @smallexample
9884      t0
9885          .ascii "arm_poke_function_name", 0
9886          .align
9887      t1
9888          .word 0xff000000 + (t1 - t0)
9889      arm_poke_function_name
9890          mov     ip, sp
9891          stmfd   sp!, @{fp, ip, lr, pc@}
9892          sub     fp, ip, #4
9893 @end smallexample
9895 When performing a stack backtrace, code can inspect the value of
9896 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9897 location @code{pc - 12} and the top 8 bits are set, then we know that
9898 there is a function name embedded immediately preceding this location
9899 and has length @code{((pc[-3]) & 0xff000000)}.
9901 @item -mthumb
9902 @opindex mthumb
9903 Generate code for the Thumb instruction set.  The default is to
9904 use the 32-bit ARM instruction set.
9905 This option automatically enables either 16-bit Thumb-1 or
9906 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9907 and @option{-march=@var{name}} options.  This option is not passed to the
9908 assembler. If you want to force assembler files to be interpreted as Thumb code,
9909 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
9910 option directly to the assembler by prefixing it with @option{-Wa}.
9912 @item -mtpcs-frame
9913 @opindex mtpcs-frame
9914 Generate a stack frame that is compliant with the Thumb Procedure Call
9915 Standard for all non-leaf functions.  (A leaf function is one that does
9916 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9918 @item -mtpcs-leaf-frame
9919 @opindex mtpcs-leaf-frame
9920 Generate a stack frame that is compliant with the Thumb Procedure Call
9921 Standard for all leaf functions.  (A leaf function is one that does
9922 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9924 @item -mcallee-super-interworking
9925 @opindex mcallee-super-interworking
9926 Gives all externally visible functions in the file being compiled an ARM
9927 instruction set header which switches to Thumb mode before executing the
9928 rest of the function.  This allows these functions to be called from
9929 non-interworking code.  This option is not valid in AAPCS configurations
9930 because interworking is enabled by default.
9932 @item -mcaller-super-interworking
9933 @opindex mcaller-super-interworking
9934 Allows calls via function pointers (including virtual functions) to
9935 execute correctly regardless of whether the target code has been
9936 compiled for interworking or not.  There is a small overhead in the cost
9937 of executing a function pointer if this option is enabled.  This option
9938 is not valid in AAPCS configurations because interworking is enabled
9939 by default.
9941 @item -mtp=@var{name}
9942 @opindex mtp
9943 Specify the access model for the thread local storage pointer.  The valid
9944 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9945 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9946 (supported in the arm6k architecture), and @option{auto}, which uses the
9947 best available method for the selected processor.  The default setting is
9948 @option{auto}.
9950 @item -mword-relocations
9951 @opindex mword-relocations
9952 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9953 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9954 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9955 is specified.
9957 @end table
9959 @node AVR Options
9960 @subsection AVR Options
9961 @cindex AVR Options
9963 These options are defined for AVR implementations:
9965 @table @gcctabopt
9966 @item -mmcu=@var{mcu}
9967 @opindex mmcu
9968 Specify ATMEL AVR instruction set or MCU type.
9970 Instruction set avr1 is for the minimal AVR core, not supported by the C
9971 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9972 attiny11, attiny12, attiny15, attiny28).
9974 Instruction set avr2 (default) is for the classic AVR core with up to
9975 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9976 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9977 at90c8534, at90s8535).
9979 Instruction set avr3 is for the classic AVR core with up to 128K program
9980 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9982 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9983 memory space (MCU types: atmega8, atmega83, atmega85).
9985 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9986 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9987 atmega64, atmega128, at43usb355, at94k).
9989 @item -mno-interrupts
9990 @opindex mno-interrupts
9991 Generated code is not compatible with hardware interrupts.
9992 Code size will be smaller.
9994 @item -mcall-prologues
9995 @opindex mcall-prologues
9996 Functions prologues/epilogues expanded as call to appropriate
9997 subroutines.  Code size will be smaller.
9999 @item -mtiny-stack
10000 @opindex mtiny-stack
10001 Change only the low 8 bits of the stack pointer.
10003 @item -mint8
10004 @opindex mint8
10005 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10006 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10007 and long long will be 4 bytes.  Please note that this option does not
10008 comply to the C standards, but it will provide you with smaller code
10009 size.
10010 @end table
10012 @node Blackfin Options
10013 @subsection Blackfin Options
10014 @cindex Blackfin Options
10016 @table @gcctabopt
10017 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10018 @opindex mcpu=
10019 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10020 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10021 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10022 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10023 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10024 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10025 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10026 @samp{bf561}.
10027 The optional @var{sirevision} specifies the silicon revision of the target
10028 Blackfin processor.  Any workarounds available for the targeted silicon revision
10029 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10030 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10031 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10032 hexadecimal digits representing the major and minor numbers in the silicon
10033 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10034 is not defined.  If @var{sirevision} is @samp{any}, the
10035 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10036 If this optional @var{sirevision} is not used, GCC assumes the latest known
10037 silicon revision of the targeted Blackfin processor.
10039 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10040 Only the processor macro is defined.
10041 Without this option, @samp{bf532} is used as the processor by default.
10042 The corresponding predefined processor macros for @var{cpu} is to
10043 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10044 provided by libgloss to be linked in if @option{-msim} is not given.
10046 @item -msim
10047 @opindex msim
10048 Specifies that the program will be run on the simulator.  This causes
10049 the simulator BSP provided by libgloss to be linked in.  This option
10050 has effect only for @samp{bfin-elf} toolchain.
10051 Certain other options, such as @option{-mid-shared-library} and
10052 @option{-mfdpic}, imply @option{-msim}.
10054 @item -momit-leaf-frame-pointer
10055 @opindex momit-leaf-frame-pointer
10056 Don't keep the frame pointer in a register for leaf functions.  This
10057 avoids the instructions to save, set up and restore frame pointers and
10058 makes an extra register available in leaf functions.  The option
10059 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10060 which might make debugging harder.
10062 @item -mspecld-anomaly
10063 @opindex mspecld-anomaly
10064 When enabled, the compiler will ensure that the generated code does not
10065 contain speculative loads after jump instructions. If this option is used,
10066 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10068 @item -mno-specld-anomaly
10069 @opindex mno-specld-anomaly
10070 Don't generate extra code to prevent speculative loads from occurring.
10072 @item -mcsync-anomaly
10073 @opindex mcsync-anomaly
10074 When enabled, the compiler will ensure that the generated code does not
10075 contain CSYNC or SSYNC instructions too soon after conditional branches.
10076 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10078 @item -mno-csync-anomaly
10079 @opindex mno-csync-anomaly
10080 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10081 occurring too soon after a conditional branch.
10083 @item -mlow-64k
10084 @opindex mlow-64k
10085 When enabled, the compiler is free to take advantage of the knowledge that
10086 the entire program fits into the low 64k of memory.
10088 @item -mno-low-64k
10089 @opindex mno-low-64k
10090 Assume that the program is arbitrarily large.  This is the default.
10092 @item -mstack-check-l1
10093 @opindex mstack-check-l1
10094 Do stack checking using information placed into L1 scratchpad memory by the
10095 uClinux kernel.
10097 @item -mid-shared-library
10098 @opindex mid-shared-library
10099 Generate code that supports shared libraries via the library ID method.
10100 This allows for execute in place and shared libraries in an environment
10101 without virtual memory management.  This option implies @option{-fPIC}.
10102 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10104 @item -mno-id-shared-library
10105 @opindex mno-id-shared-library
10106 Generate code that doesn't assume ID based shared libraries are being used.
10107 This is the default.
10109 @item -mleaf-id-shared-library
10110 @opindex mleaf-id-shared-library
10111 Generate code that supports shared libraries via the library ID method,
10112 but assumes that this library or executable won't link against any other
10113 ID shared libraries.  That allows the compiler to use faster code for jumps
10114 and calls.
10116 @item -mno-leaf-id-shared-library
10117 @opindex mno-leaf-id-shared-library
10118 Do not assume that the code being compiled won't link against any ID shared
10119 libraries.  Slower code will be generated for jump and call insns.
10121 @item -mshared-library-id=n
10122 @opindex mshared-library-id
10123 Specified the identification number of the ID based shared library being
10124 compiled.  Specifying a value of 0 will generate more compact code, specifying
10125 other values will force the allocation of that number to the current
10126 library but is no more space or time efficient than omitting this option.
10128 @item -msep-data
10129 @opindex msep-data
10130 Generate code that allows the data segment to be located in a different
10131 area of memory from the text segment.  This allows for execute in place in
10132 an environment without virtual memory management by eliminating relocations
10133 against the text section.
10135 @item -mno-sep-data
10136 @opindex mno-sep-data
10137 Generate code that assumes that the data segment follows the text segment.
10138 This is the default.
10140 @item -mlong-calls
10141 @itemx -mno-long-calls
10142 @opindex mlong-calls
10143 @opindex mno-long-calls
10144 Tells the compiler to perform function calls by first loading the
10145 address of the function into a register and then performing a subroutine
10146 call on this register.  This switch is needed if the target function
10147 will lie outside of the 24 bit addressing range of the offset based
10148 version of subroutine call instruction.
10150 This feature is not enabled by default.  Specifying
10151 @option{-mno-long-calls} will restore the default behavior.  Note these
10152 switches have no effect on how the compiler generates code to handle
10153 function calls via function pointers.
10155 @item -mfast-fp
10156 @opindex mfast-fp
10157 Link with the fast floating-point library. This library relaxes some of
10158 the IEEE floating-point standard's rules for checking inputs against
10159 Not-a-Number (NAN), in the interest of performance.
10161 @item -minline-plt
10162 @opindex minline-plt
10163 Enable inlining of PLT entries in function calls to functions that are
10164 not known to bind locally.  It has no effect without @option{-mfdpic}.
10166 @item -mmulticore
10167 @opindex mmulticore
10168 Build standalone application for multicore Blackfin processor. Proper
10169 start files and link scripts will be used to support multicore.
10170 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10171 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10172 @option{-mcorea} or @option{-mcoreb}. If it's used without
10173 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10174 programming model is used. In this model, the main function of Core B
10175 should be named as coreb_main. If it's used with @option{-mcorea} or
10176 @option{-mcoreb}, one application per core programming model is used.
10177 If this option is not used, single core application programming
10178 model is used.
10180 @item -mcorea
10181 @opindex mcorea
10182 Build standalone application for Core A of BF561 when using
10183 one application per core programming model. Proper start files
10184 and link scripts will be used to support Core A. This option
10185 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10187 @item -mcoreb
10188 @opindex mcoreb
10189 Build standalone application for Core B of BF561 when using
10190 one application per core programming model. Proper start files
10191 and link scripts will be used to support Core B. This option
10192 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10193 should be used instead of main. It must be used with
10194 @option{-mmulticore}.
10196 @item -msdram
10197 @opindex msdram
10198 Build standalone application for SDRAM. Proper start files and
10199 link scripts will be used to put the application into SDRAM.
10200 Loader should initialize SDRAM before loading the application
10201 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10203 @item -micplb
10204 @opindex micplb
10205 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10206 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10207 are enabled; for standalone applications the default is off.
10208 @end table
10210 @node CRIS Options
10211 @subsection CRIS Options
10212 @cindex CRIS Options
10214 These options are defined specifically for the CRIS ports.
10216 @table @gcctabopt
10217 @item -march=@var{architecture-type}
10218 @itemx -mcpu=@var{architecture-type}
10219 @opindex march
10220 @opindex mcpu
10221 Generate code for the specified architecture.  The choices for
10222 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10223 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10224 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10225 @samp{v10}.
10227 @item -mtune=@var{architecture-type}
10228 @opindex mtune
10229 Tune to @var{architecture-type} everything applicable about the generated
10230 code, except for the ABI and the set of available instructions.  The
10231 choices for @var{architecture-type} are the same as for
10232 @option{-march=@var{architecture-type}}.
10234 @item -mmax-stack-frame=@var{n}
10235 @opindex mmax-stack-frame
10236 Warn when the stack frame of a function exceeds @var{n} bytes.
10238 @item -metrax4
10239 @itemx -metrax100
10240 @opindex metrax4
10241 @opindex metrax100
10242 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10243 @option{-march=v3} and @option{-march=v8} respectively.
10245 @item -mmul-bug-workaround
10246 @itemx -mno-mul-bug-workaround
10247 @opindex mmul-bug-workaround
10248 @opindex mno-mul-bug-workaround
10249 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10250 models where it applies.  This option is active by default.
10252 @item -mpdebug
10253 @opindex mpdebug
10254 Enable CRIS-specific verbose debug-related information in the assembly
10255 code.  This option also has the effect to turn off the @samp{#NO_APP}
10256 formatted-code indicator to the assembler at the beginning of the
10257 assembly file.
10259 @item -mcc-init
10260 @opindex mcc-init
10261 Do not use condition-code results from previous instruction; always emit
10262 compare and test instructions before use of condition codes.
10264 @item -mno-side-effects
10265 @opindex mno-side-effects
10266 Do not emit instructions with side-effects in addressing modes other than
10267 post-increment.
10269 @item -mstack-align
10270 @itemx -mno-stack-align
10271 @itemx -mdata-align
10272 @itemx -mno-data-align
10273 @itemx -mconst-align
10274 @itemx -mno-const-align
10275 @opindex mstack-align
10276 @opindex mno-stack-align
10277 @opindex mdata-align
10278 @opindex mno-data-align
10279 @opindex mconst-align
10280 @opindex mno-const-align
10281 These options (no-options) arranges (eliminate arrangements) for the
10282 stack-frame, individual data and constants to be aligned for the maximum
10283 single data access size for the chosen CPU model.  The default is to
10284 arrange for 32-bit alignment.  ABI details such as structure layout are
10285 not affected by these options.
10287 @item -m32-bit
10288 @itemx -m16-bit
10289 @itemx -m8-bit
10290 @opindex m32-bit
10291 @opindex m16-bit
10292 @opindex m8-bit
10293 Similar to the stack- data- and const-align options above, these options
10294 arrange for stack-frame, writable data and constants to all be 32-bit,
10295 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10297 @item -mno-prologue-epilogue
10298 @itemx -mprologue-epilogue
10299 @opindex mno-prologue-epilogue
10300 @opindex mprologue-epilogue
10301 With @option{-mno-prologue-epilogue}, the normal function prologue and
10302 epilogue that sets up the stack-frame are omitted and no return
10303 instructions or return sequences are generated in the code.  Use this
10304 option only together with visual inspection of the compiled code: no
10305 warnings or errors are generated when call-saved registers must be saved,
10306 or storage for local variable needs to be allocated.
10308 @item -mno-gotplt
10309 @itemx -mgotplt
10310 @opindex mno-gotplt
10311 @opindex mgotplt
10312 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10313 instruction sequences that load addresses for functions from the PLT part
10314 of the GOT rather than (traditional on other architectures) calls to the
10315 PLT@.  The default is @option{-mgotplt}.
10317 @item -melf
10318 @opindex melf
10319 Legacy no-op option only recognized with the cris-axis-elf and
10320 cris-axis-linux-gnu targets.
10322 @item -mlinux
10323 @opindex mlinux
10324 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10326 @item -sim
10327 @opindex sim
10328 This option, recognized for the cris-axis-elf arranges
10329 to link with input-output functions from a simulator library.  Code,
10330 initialized data and zero-initialized data are allocated consecutively.
10332 @item -sim2
10333 @opindex sim2
10334 Like @option{-sim}, but pass linker options to locate initialized data at
10335 0x40000000 and zero-initialized data at 0x80000000.
10336 @end table
10338 @node CRX Options
10339 @subsection CRX Options
10340 @cindex CRX Options
10342 These options are defined specifically for the CRX ports.
10344 @table @gcctabopt
10346 @item -mmac
10347 @opindex mmac
10348 Enable the use of multiply-accumulate instructions. Disabled by default.
10350 @item -mpush-args
10351 @opindex mpush-args
10352 Push instructions will be used to pass outgoing arguments when functions
10353 are called. Enabled by default.
10354 @end table
10356 @node Darwin Options
10357 @subsection Darwin Options
10358 @cindex Darwin options
10360 These options are defined for all architectures running the Darwin operating
10361 system.
10363 FSF GCC on Darwin does not create ``fat'' object files; it will create
10364 an object file for the single architecture that it was built to
10365 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10366 @option{-arch} options are used; it does so by running the compiler or
10367 linker multiple times and joining the results together with
10368 @file{lipo}.
10370 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10371 @samp{i686}) is determined by the flags that specify the ISA
10372 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10373 @option{-force_cpusubtype_ALL} option can be used to override this.
10375 The Darwin tools vary in their behavior when presented with an ISA
10376 mismatch.  The assembler, @file{as}, will only permit instructions to
10377 be used that are valid for the subtype of the file it is generating,
10378 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10379 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10380 and print an error if asked to create a shared library with a less
10381 restrictive subtype than its input files (for instance, trying to put
10382 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10383 for executables, @file{ld}, will quietly give the executable the most
10384 restrictive subtype of any of its input files.
10386 @table @gcctabopt
10387 @item -F@var{dir}
10388 @opindex F
10389 Add the framework directory @var{dir} to the head of the list of
10390 directories to be searched for header files.  These directories are
10391 interleaved with those specified by @option{-I} options and are
10392 scanned in a left-to-right order.
10394 A framework directory is a directory with frameworks in it.  A
10395 framework is a directory with a @samp{"Headers"} and/or
10396 @samp{"PrivateHeaders"} directory contained directly in it that ends
10397 in @samp{".framework"}.  The name of a framework is the name of this
10398 directory excluding the @samp{".framework"}.  Headers associated with
10399 the framework are found in one of those two directories, with
10400 @samp{"Headers"} being searched first.  A subframework is a framework
10401 directory that is in a framework's @samp{"Frameworks"} directory.
10402 Includes of subframework headers can only appear in a header of a
10403 framework that contains the subframework, or in a sibling subframework
10404 header.  Two subframeworks are siblings if they occur in the same
10405 framework.  A subframework should not have the same name as a
10406 framework, a warning will be issued if this is violated.  Currently a
10407 subframework cannot have subframeworks, in the future, the mechanism
10408 may be extended to support this.  The standard frameworks can be found
10409 in @samp{"/System/Library/Frameworks"} and
10410 @samp{"/Library/Frameworks"}.  An example include looks like
10411 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10412 the name of the framework and header.h is found in the
10413 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10415 @item -iframework@var{dir}
10416 @opindex iframework
10417 Like @option{-F} except the directory is a treated as a system
10418 directory.  The main difference between this @option{-iframework} and
10419 @option{-F} is that with @option{-iframework} the compiler does not
10420 warn about constructs contained within header files found via
10421 @var{dir}.  This option is valid only for the C family of languages.
10423 @item -gused
10424 @opindex gused
10425 Emit debugging information for symbols that are used.  For STABS
10426 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10427 This is by default ON@.
10429 @item -gfull
10430 @opindex gfull
10431 Emit debugging information for all symbols and types.
10433 @item -mmacosx-version-min=@var{version}
10434 The earliest version of MacOS X that this executable will run on
10435 is @var{version}.  Typical values of @var{version} include @code{10.1},
10436 @code{10.2}, and @code{10.3.9}.
10438 If the compiler was built to use the system's headers by default,
10439 then the default for this option is the system version on which the
10440 compiler is running, otherwise the default is to make choices which
10441 are compatible with as many systems and code bases as possible.
10443 @item -mkernel
10444 @opindex mkernel
10445 Enable kernel development mode.  The @option{-mkernel} option sets
10446 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10447 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10448 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10449 applicable.  This mode also sets @option{-mno-altivec},
10450 @option{-msoft-float}, @option{-fno-builtin} and
10451 @option{-mlong-branch} for PowerPC targets.
10453 @item -mone-byte-bool
10454 @opindex mone-byte-bool
10455 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10456 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10457 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10458 option has no effect on x86.
10460 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10461 to generate code that is not binary compatible with code generated
10462 without that switch.  Using this switch may require recompiling all
10463 other modules in a program, including system libraries.  Use this
10464 switch to conform to a non-default data model.
10466 @item -mfix-and-continue
10467 @itemx -ffix-and-continue
10468 @itemx -findirect-data
10469 @opindex mfix-and-continue
10470 @opindex ffix-and-continue
10471 @opindex findirect-data
10472 Generate code suitable for fast turn around development.  Needed to
10473 enable gdb to dynamically load @code{.o} files into already running
10474 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10475 are provided for backwards compatibility.
10477 @item -all_load
10478 @opindex all_load
10479 Loads all members of static archive libraries.
10480 See man ld(1) for more information.
10482 @item -arch_errors_fatal
10483 @opindex arch_errors_fatal
10484 Cause the errors having to do with files that have the wrong architecture
10485 to be fatal.
10487 @item -bind_at_load
10488 @opindex bind_at_load
10489 Causes the output file to be marked such that the dynamic linker will
10490 bind all undefined references when the file is loaded or launched.
10492 @item -bundle
10493 @opindex bundle
10494 Produce a Mach-o bundle format file.
10495 See man ld(1) for more information.
10497 @item -bundle_loader @var{executable}
10498 @opindex bundle_loader
10499 This option specifies the @var{executable} that will be loading the build
10500 output file being linked.  See man ld(1) for more information.
10502 @item -dynamiclib
10503 @opindex dynamiclib
10504 When passed this option, GCC will produce a dynamic library instead of
10505 an executable when linking, using the Darwin @file{libtool} command.
10507 @item -force_cpusubtype_ALL
10508 @opindex force_cpusubtype_ALL
10509 This causes GCC's output file to have the @var{ALL} subtype, instead of
10510 one controlled by the @option{-mcpu} or @option{-march} option.
10512 @item -allowable_client  @var{client_name}
10513 @itemx -client_name
10514 @itemx -compatibility_version
10515 @itemx -current_version
10516 @itemx -dead_strip
10517 @itemx -dependency-file
10518 @itemx -dylib_file
10519 @itemx -dylinker_install_name
10520 @itemx -dynamic
10521 @itemx -exported_symbols_list
10522 @itemx -filelist
10523 @itemx -flat_namespace
10524 @itemx -force_flat_namespace
10525 @itemx -headerpad_max_install_names
10526 @itemx -image_base
10527 @itemx -init
10528 @itemx -install_name
10529 @itemx -keep_private_externs
10530 @itemx -multi_module
10531 @itemx -multiply_defined
10532 @itemx -multiply_defined_unused
10533 @itemx -noall_load
10534 @itemx -no_dead_strip_inits_and_terms
10535 @itemx -nofixprebinding
10536 @itemx -nomultidefs
10537 @itemx -noprebind
10538 @itemx -noseglinkedit
10539 @itemx -pagezero_size
10540 @itemx -prebind
10541 @itemx -prebind_all_twolevel_modules
10542 @itemx -private_bundle
10543 @itemx -read_only_relocs
10544 @itemx -sectalign
10545 @itemx -sectobjectsymbols
10546 @itemx -whyload
10547 @itemx -seg1addr
10548 @itemx -sectcreate
10549 @itemx -sectobjectsymbols
10550 @itemx -sectorder
10551 @itemx -segaddr
10552 @itemx -segs_read_only_addr
10553 @itemx -segs_read_write_addr
10554 @itemx -seg_addr_table
10555 @itemx -seg_addr_table_filename
10556 @itemx -seglinkedit
10557 @itemx -segprot
10558 @itemx -segs_read_only_addr
10559 @itemx -segs_read_write_addr
10560 @itemx -single_module
10561 @itemx -static
10562 @itemx -sub_library
10563 @itemx -sub_umbrella
10564 @itemx -twolevel_namespace
10565 @itemx -umbrella
10566 @itemx -undefined
10567 @itemx -unexported_symbols_list
10568 @itemx -weak_reference_mismatches
10569 @itemx -whatsloaded
10570 @opindex allowable_client
10571 @opindex client_name
10572 @opindex compatibility_version
10573 @opindex current_version
10574 @opindex dead_strip
10575 @opindex dependency-file
10576 @opindex dylib_file
10577 @opindex dylinker_install_name
10578 @opindex dynamic
10579 @opindex exported_symbols_list
10580 @opindex filelist
10581 @opindex flat_namespace
10582 @opindex force_flat_namespace
10583 @opindex headerpad_max_install_names
10584 @opindex image_base
10585 @opindex init
10586 @opindex install_name
10587 @opindex keep_private_externs
10588 @opindex multi_module
10589 @opindex multiply_defined
10590 @opindex multiply_defined_unused
10591 @opindex noall_load
10592 @opindex no_dead_strip_inits_and_terms
10593 @opindex nofixprebinding
10594 @opindex nomultidefs
10595 @opindex noprebind
10596 @opindex noseglinkedit
10597 @opindex pagezero_size
10598 @opindex prebind
10599 @opindex prebind_all_twolevel_modules
10600 @opindex private_bundle
10601 @opindex read_only_relocs
10602 @opindex sectalign
10603 @opindex sectobjectsymbols
10604 @opindex whyload
10605 @opindex seg1addr
10606 @opindex sectcreate
10607 @opindex sectobjectsymbols
10608 @opindex sectorder
10609 @opindex segaddr
10610 @opindex segs_read_only_addr
10611 @opindex segs_read_write_addr
10612 @opindex seg_addr_table
10613 @opindex seg_addr_table_filename
10614 @opindex seglinkedit
10615 @opindex segprot
10616 @opindex segs_read_only_addr
10617 @opindex segs_read_write_addr
10618 @opindex single_module
10619 @opindex static
10620 @opindex sub_library
10621 @opindex sub_umbrella
10622 @opindex twolevel_namespace
10623 @opindex umbrella
10624 @opindex undefined
10625 @opindex unexported_symbols_list
10626 @opindex weak_reference_mismatches
10627 @opindex whatsloaded
10628 These options are passed to the Darwin linker.  The Darwin linker man page
10629 describes them in detail.
10630 @end table
10632 @node DEC Alpha Options
10633 @subsection DEC Alpha Options
10635 These @samp{-m} options are defined for the DEC Alpha implementations:
10637 @table @gcctabopt
10638 @item -mno-soft-float
10639 @itemx -msoft-float
10640 @opindex mno-soft-float
10641 @opindex msoft-float
10642 Use (do not use) the hardware floating-point instructions for
10643 floating-point operations.  When @option{-msoft-float} is specified,
10644 functions in @file{libgcc.a} will be used to perform floating-point
10645 operations.  Unless they are replaced by routines that emulate the
10646 floating-point operations, or compiled in such a way as to call such
10647 emulations routines, these routines will issue floating-point
10648 operations.   If you are compiling for an Alpha without floating-point
10649 operations, you must ensure that the library is built so as not to call
10650 them.
10652 Note that Alpha implementations without floating-point operations are
10653 required to have floating-point registers.
10655 @item -mfp-reg
10656 @itemx -mno-fp-regs
10657 @opindex mfp-reg
10658 @opindex mno-fp-regs
10659 Generate code that uses (does not use) the floating-point register set.
10660 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10661 register set is not used, floating point operands are passed in integer
10662 registers as if they were integers and floating-point results are passed
10663 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10664 so any function with a floating-point argument or return value called by code
10665 compiled with @option{-mno-fp-regs} must also be compiled with that
10666 option.
10668 A typical use of this option is building a kernel that does not use,
10669 and hence need not save and restore, any floating-point registers.
10671 @item -mieee
10672 @opindex mieee
10673 The Alpha architecture implements floating-point hardware optimized for
10674 maximum performance.  It is mostly compliant with the IEEE floating
10675 point standard.  However, for full compliance, software assistance is
10676 required.  This option generates code fully IEEE compliant code
10677 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10678 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10679 defined during compilation.  The resulting code is less efficient but is
10680 able to correctly support denormalized numbers and exceptional IEEE
10681 values such as not-a-number and plus/minus infinity.  Other Alpha
10682 compilers call this option @option{-ieee_with_no_inexact}.
10684 @item -mieee-with-inexact
10685 @opindex mieee-with-inexact
10686 This is like @option{-mieee} except the generated code also maintains
10687 the IEEE @var{inexact-flag}.  Turning on this option causes the
10688 generated code to implement fully-compliant IEEE math.  In addition to
10689 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10690 macro.  On some Alpha implementations the resulting code may execute
10691 significantly slower than the code generated by default.  Since there is
10692 very little code that depends on the @var{inexact-flag}, you should
10693 normally not specify this option.  Other Alpha compilers call this
10694 option @option{-ieee_with_inexact}.
10696 @item -mfp-trap-mode=@var{trap-mode}
10697 @opindex mfp-trap-mode
10698 This option controls what floating-point related traps are enabled.
10699 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10700 The trap mode can be set to one of four values:
10702 @table @samp
10703 @item n
10704 This is the default (normal) setting.  The only traps that are enabled
10705 are the ones that cannot be disabled in software (e.g., division by zero
10706 trap).
10708 @item u
10709 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10710 as well.
10712 @item su
10713 Like @samp{u}, but the instructions are marked to be safe for software
10714 completion (see Alpha architecture manual for details).
10716 @item sui
10717 Like @samp{su}, but inexact traps are enabled as well.
10718 @end table
10720 @item -mfp-rounding-mode=@var{rounding-mode}
10721 @opindex mfp-rounding-mode
10722 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10723 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10726 @table @samp
10727 @item n
10728 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10729 the nearest machine number or towards the even machine number in case
10730 of a tie.
10732 @item m
10733 Round towards minus infinity.
10735 @item c
10736 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10738 @item d
10739 Dynamic rounding mode.  A field in the floating point control register
10740 (@var{fpcr}, see Alpha architecture reference manual) controls the
10741 rounding mode in effect.  The C library initializes this register for
10742 rounding towards plus infinity.  Thus, unless your program modifies the
10743 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10744 @end table
10746 @item -mtrap-precision=@var{trap-precision}
10747 @opindex mtrap-precision
10748 In the Alpha architecture, floating point traps are imprecise.  This
10749 means without software assistance it is impossible to recover from a
10750 floating trap and program execution normally needs to be terminated.
10751 GCC can generate code that can assist operating system trap handlers
10752 in determining the exact location that caused a floating point trap.
10753 Depending on the requirements of an application, different levels of
10754 precisions can be selected:
10756 @table @samp
10757 @item p
10758 Program precision.  This option is the default and means a trap handler
10759 can only identify which program caused a floating point exception.
10761 @item f
10762 Function precision.  The trap handler can determine the function that
10763 caused a floating point exception.
10765 @item i
10766 Instruction precision.  The trap handler can determine the exact
10767 instruction that caused a floating point exception.
10768 @end table
10770 Other Alpha compilers provide the equivalent options called
10771 @option{-scope_safe} and @option{-resumption_safe}.
10773 @item -mieee-conformant
10774 @opindex mieee-conformant
10775 This option marks the generated code as IEEE conformant.  You must not
10776 use this option unless you also specify @option{-mtrap-precision=i} and either
10777 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10778 is to emit the line @samp{.eflag 48} in the function prologue of the
10779 generated assembly file.  Under DEC Unix, this has the effect that
10780 IEEE-conformant math library routines will be linked in.
10782 @item -mbuild-constants
10783 @opindex mbuild-constants
10784 Normally GCC examines a 32- or 64-bit integer constant to
10785 see if it can construct it from smaller constants in two or three
10786 instructions.  If it cannot, it will output the constant as a literal and
10787 generate code to load it from the data segment at runtime.
10789 Use this option to require GCC to construct @emph{all} integer constants
10790 using code, even if it takes more instructions (the maximum is six).
10792 You would typically use this option to build a shared library dynamic
10793 loader.  Itself a shared library, it must relocate itself in memory
10794 before it can find the variables and constants in its own data segment.
10796 @item -malpha-as
10797 @itemx -mgas
10798 @opindex malpha-as
10799 @opindex mgas
10800 Select whether to generate code to be assembled by the vendor-supplied
10801 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10803 @item -mbwx
10804 @itemx -mno-bwx
10805 @itemx -mcix
10806 @itemx -mno-cix
10807 @itemx -mfix
10808 @itemx -mno-fix
10809 @itemx -mmax
10810 @itemx -mno-max
10811 @opindex mbwx
10812 @opindex mno-bwx
10813 @opindex mcix
10814 @opindex mno-cix
10815 @opindex mfix
10816 @opindex mno-fix
10817 @opindex mmax
10818 @opindex mno-max
10819 Indicate whether GCC should generate code to use the optional BWX,
10820 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10821 sets supported by the CPU type specified via @option{-mcpu=} option or that
10822 of the CPU on which GCC was built if none was specified.
10824 @item -mfloat-vax
10825 @itemx -mfloat-ieee
10826 @opindex mfloat-vax
10827 @opindex mfloat-ieee
10828 Generate code that uses (does not use) VAX F and G floating point
10829 arithmetic instead of IEEE single and double precision.
10831 @item -mexplicit-relocs
10832 @itemx -mno-explicit-relocs
10833 @opindex mexplicit-relocs
10834 @opindex mno-explicit-relocs
10835 Older Alpha assemblers provided no way to generate symbol relocations
10836 except via assembler macros.  Use of these macros does not allow
10837 optimal instruction scheduling.  GNU binutils as of version 2.12
10838 supports a new syntax that allows the compiler to explicitly mark
10839 which relocations should apply to which instructions.  This option
10840 is mostly useful for debugging, as GCC detects the capabilities of
10841 the assembler when it is built and sets the default accordingly.
10843 @item -msmall-data
10844 @itemx -mlarge-data
10845 @opindex msmall-data
10846 @opindex mlarge-data
10847 When @option{-mexplicit-relocs} is in effect, static data is
10848 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10849 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10850 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10851 16-bit relocations off of the @code{$gp} register.  This limits the
10852 size of the small data area to 64KB, but allows the variables to be
10853 directly accessed via a single instruction.
10855 The default is @option{-mlarge-data}.  With this option the data area
10856 is limited to just below 2GB@.  Programs that require more than 2GB of
10857 data must use @code{malloc} or @code{mmap} to allocate the data in the
10858 heap instead of in the program's data segment.
10860 When generating code for shared libraries, @option{-fpic} implies
10861 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10863 @item -msmall-text
10864 @itemx -mlarge-text
10865 @opindex msmall-text
10866 @opindex mlarge-text
10867 When @option{-msmall-text} is used, the compiler assumes that the
10868 code of the entire program (or shared library) fits in 4MB, and is
10869 thus reachable with a branch instruction.  When @option{-msmall-data}
10870 is used, the compiler can assume that all local symbols share the
10871 same @code{$gp} value, and thus reduce the number of instructions
10872 required for a function call from 4 to 1.
10874 The default is @option{-mlarge-text}.
10876 @item -mcpu=@var{cpu_type}
10877 @opindex mcpu
10878 Set the instruction set and instruction scheduling parameters for
10879 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10880 style name or the corresponding chip number.  GCC supports scheduling
10881 parameters for the EV4, EV5 and EV6 family of processors and will
10882 choose the default values for the instruction set from the processor
10883 you specify.  If you do not specify a processor type, GCC will default
10884 to the processor on which the compiler was built.
10886 Supported values for @var{cpu_type} are
10888 @table @samp
10889 @item ev4
10890 @itemx ev45
10891 @itemx 21064
10892 Schedules as an EV4 and has no instruction set extensions.
10894 @item ev5
10895 @itemx 21164
10896 Schedules as an EV5 and has no instruction set extensions.
10898 @item ev56
10899 @itemx 21164a
10900 Schedules as an EV5 and supports the BWX extension.
10902 @item pca56
10903 @itemx 21164pc
10904 @itemx 21164PC
10905 Schedules as an EV5 and supports the BWX and MAX extensions.
10907 @item ev6
10908 @itemx 21264
10909 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10911 @item ev67
10912 @itemx 21264a
10913 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10914 @end table
10916 Native Linux/GNU toolchains also support the value @samp{native},
10917 which selects the best architecture option for the host processor.
10918 @option{-mcpu=native} has no effect if GCC does not recognize
10919 the processor.
10921 @item -mtune=@var{cpu_type}
10922 @opindex mtune
10923 Set only the instruction scheduling parameters for machine type
10924 @var{cpu_type}.  The instruction set is not changed.
10926 Native Linux/GNU toolchains also support the value @samp{native},
10927 which selects the best architecture option for the host processor.
10928 @option{-mtune=native} has no effect if GCC does not recognize
10929 the processor.
10931 @item -mmemory-latency=@var{time}
10932 @opindex mmemory-latency
10933 Sets the latency the scheduler should assume for typical memory
10934 references as seen by the application.  This number is highly
10935 dependent on the memory access patterns used by the application
10936 and the size of the external cache on the machine.
10938 Valid options for @var{time} are
10940 @table @samp
10941 @item @var{number}
10942 A decimal number representing clock cycles.
10944 @item L1
10945 @itemx L2
10946 @itemx L3
10947 @itemx main
10948 The compiler contains estimates of the number of clock cycles for
10949 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10950 (also called Dcache, Scache, and Bcache), as well as to main memory.
10951 Note that L3 is only valid for EV5.
10953 @end table
10954 @end table
10956 @node DEC Alpha/VMS Options
10957 @subsection DEC Alpha/VMS Options
10959 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
10961 @table @gcctabopt
10962 @item -mvms-return-codes
10963 @opindex mvms-return-codes
10964 Return VMS condition codes from main.  The default is to return POSIX
10965 style condition (e.g.@: error) codes.
10967 @item -mdebug-main=@var{prefix}
10968 @opindex mdebug-main=@var{prefix}
10969 Flag the first routine whose name starts with @var{prefix} as the main
10970 routine for the debugger.
10972 @item -mmalloc64
10973 @opindex mmalloc64
10974 Default to 64bit memory allocation routines.
10975 @end table
10977 @node FR30 Options
10978 @subsection FR30 Options
10979 @cindex FR30 Options
10981 These options are defined specifically for the FR30 port.
10983 @table @gcctabopt
10985 @item -msmall-model
10986 @opindex msmall-model
10987 Use the small address space model.  This can produce smaller code, but
10988 it does assume that all symbolic values and addresses will fit into a
10989 20-bit range.
10991 @item -mno-lsim
10992 @opindex mno-lsim
10993 Assume that run-time support has been provided and so there is no need
10994 to include the simulator library (@file{libsim.a}) on the linker
10995 command line.
10997 @end table
10999 @node FRV Options
11000 @subsection FRV Options
11001 @cindex FRV Options
11003 @table @gcctabopt
11004 @item -mgpr-32
11005 @opindex mgpr-32
11007 Only use the first 32 general purpose registers.
11009 @item -mgpr-64
11010 @opindex mgpr-64
11012 Use all 64 general purpose registers.
11014 @item -mfpr-32
11015 @opindex mfpr-32
11017 Use only the first 32 floating point registers.
11019 @item -mfpr-64
11020 @opindex mfpr-64
11022 Use all 64 floating point registers
11024 @item -mhard-float
11025 @opindex mhard-float
11027 Use hardware instructions for floating point operations.
11029 @item -msoft-float
11030 @opindex msoft-float
11032 Use library routines for floating point operations.
11034 @item -malloc-cc
11035 @opindex malloc-cc
11037 Dynamically allocate condition code registers.
11039 @item -mfixed-cc
11040 @opindex mfixed-cc
11042 Do not try to dynamically allocate condition code registers, only
11043 use @code{icc0} and @code{fcc0}.
11045 @item -mdword
11046 @opindex mdword
11048 Change ABI to use double word insns.
11050 @item -mno-dword
11051 @opindex mno-dword
11053 Do not use double word instructions.
11055 @item -mdouble
11056 @opindex mdouble
11058 Use floating point double instructions.
11060 @item -mno-double
11061 @opindex mno-double
11063 Do not use floating point double instructions.
11065 @item -mmedia
11066 @opindex mmedia
11068 Use media instructions.
11070 @item -mno-media
11071 @opindex mno-media
11073 Do not use media instructions.
11075 @item -mmuladd
11076 @opindex mmuladd
11078 Use multiply and add/subtract instructions.
11080 @item -mno-muladd
11081 @opindex mno-muladd
11083 Do not use multiply and add/subtract instructions.
11085 @item -mfdpic
11086 @opindex mfdpic
11088 Select the FDPIC ABI, that uses function descriptors to represent
11089 pointers to functions.  Without any PIC/PIE-related options, it
11090 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11091 assumes GOT entries and small data are within a 12-bit range from the
11092 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11093 are computed with 32 bits.
11094 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11096 @item -minline-plt
11097 @opindex minline-plt
11099 Enable inlining of PLT entries in function calls to functions that are
11100 not known to bind locally.  It has no effect without @option{-mfdpic}.
11101 It's enabled by default if optimizing for speed and compiling for
11102 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11103 optimization option such as @option{-O3} or above is present in the
11104 command line.
11106 @item -mTLS
11107 @opindex mTLS
11109 Assume a large TLS segment when generating thread-local code.
11111 @item -mtls
11112 @opindex mtls
11114 Do not assume a large TLS segment when generating thread-local code.
11116 @item -mgprel-ro
11117 @opindex mgprel-ro
11119 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11120 that is known to be in read-only sections.  It's enabled by default,
11121 except for @option{-fpic} or @option{-fpie}: even though it may help
11122 make the global offset table smaller, it trades 1 instruction for 4.
11123 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11124 one of which may be shared by multiple symbols, and it avoids the need
11125 for a GOT entry for the referenced symbol, so it's more likely to be a
11126 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11128 @item -multilib-library-pic
11129 @opindex multilib-library-pic
11131 Link with the (library, not FD) pic libraries.  It's implied by
11132 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11133 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11134 it explicitly.
11136 @item -mlinked-fp
11137 @opindex mlinked-fp
11139 Follow the EABI requirement of always creating a frame pointer whenever
11140 a stack frame is allocated.  This option is enabled by default and can
11141 be disabled with @option{-mno-linked-fp}.
11143 @item -mlong-calls
11144 @opindex mlong-calls
11146 Use indirect addressing to call functions outside the current
11147 compilation unit.  This allows the functions to be placed anywhere
11148 within the 32-bit address space.
11150 @item -malign-labels
11151 @opindex malign-labels
11153 Try to align labels to an 8-byte boundary by inserting nops into the
11154 previous packet.  This option only has an effect when VLIW packing
11155 is enabled.  It doesn't create new packets; it merely adds nops to
11156 existing ones.
11158 @item -mlibrary-pic
11159 @opindex mlibrary-pic
11161 Generate position-independent EABI code.
11163 @item -macc-4
11164 @opindex macc-4
11166 Use only the first four media accumulator registers.
11168 @item -macc-8
11169 @opindex macc-8
11171 Use all eight media accumulator registers.
11173 @item -mpack
11174 @opindex mpack
11176 Pack VLIW instructions.
11178 @item -mno-pack
11179 @opindex mno-pack
11181 Do not pack VLIW instructions.
11183 @item -mno-eflags
11184 @opindex mno-eflags
11186 Do not mark ABI switches in e_flags.
11188 @item -mcond-move
11189 @opindex mcond-move
11191 Enable the use of conditional-move instructions (default).
11193 This switch is mainly for debugging the compiler and will likely be removed
11194 in a future version.
11196 @item -mno-cond-move
11197 @opindex mno-cond-move
11199 Disable the use of conditional-move instructions.
11201 This switch is mainly for debugging the compiler and will likely be removed
11202 in a future version.
11204 @item -mscc
11205 @opindex mscc
11207 Enable the use of conditional set instructions (default).
11209 This switch is mainly for debugging the compiler and will likely be removed
11210 in a future version.
11212 @item -mno-scc
11213 @opindex mno-scc
11215 Disable the use of conditional set instructions.
11217 This switch is mainly for debugging the compiler and will likely be removed
11218 in a future version.
11220 @item -mcond-exec
11221 @opindex mcond-exec
11223 Enable the use of conditional execution (default).
11225 This switch is mainly for debugging the compiler and will likely be removed
11226 in a future version.
11228 @item -mno-cond-exec
11229 @opindex mno-cond-exec
11231 Disable the use of conditional execution.
11233 This switch is mainly for debugging the compiler and will likely be removed
11234 in a future version.
11236 @item -mvliw-branch
11237 @opindex mvliw-branch
11239 Run a pass to pack branches into VLIW instructions (default).
11241 This switch is mainly for debugging the compiler and will likely be removed
11242 in a future version.
11244 @item -mno-vliw-branch
11245 @opindex mno-vliw-branch
11247 Do not run a pass to pack branches into VLIW instructions.
11249 This switch is mainly for debugging the compiler and will likely be removed
11250 in a future version.
11252 @item -mmulti-cond-exec
11253 @opindex mmulti-cond-exec
11255 Enable optimization of @code{&&} and @code{||} in conditional execution
11256 (default).
11258 This switch is mainly for debugging the compiler and will likely be removed
11259 in a future version.
11261 @item -mno-multi-cond-exec
11262 @opindex mno-multi-cond-exec
11264 Disable optimization of @code{&&} and @code{||} in conditional execution.
11266 This switch is mainly for debugging the compiler and will likely be removed
11267 in a future version.
11269 @item -mnested-cond-exec
11270 @opindex mnested-cond-exec
11272 Enable nested conditional execution optimizations (default).
11274 This switch is mainly for debugging the compiler and will likely be removed
11275 in a future version.
11277 @item -mno-nested-cond-exec
11278 @opindex mno-nested-cond-exec
11280 Disable nested conditional execution optimizations.
11282 This switch is mainly for debugging the compiler and will likely be removed
11283 in a future version.
11285 @item -moptimize-membar
11286 @opindex moptimize-membar
11288 This switch removes redundant @code{membar} instructions from the
11289 compiler generated code.  It is enabled by default.
11291 @item -mno-optimize-membar
11292 @opindex mno-optimize-membar
11294 This switch disables the automatic removal of redundant @code{membar}
11295 instructions from the generated code.
11297 @item -mtomcat-stats
11298 @opindex mtomcat-stats
11300 Cause gas to print out tomcat statistics.
11302 @item -mcpu=@var{cpu}
11303 @opindex mcpu
11305 Select the processor type for which to generate code.  Possible values are
11306 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11307 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11309 @end table
11311 @node GNU/Linux Options
11312 @subsection GNU/Linux Options
11314 These @samp{-m} options are defined for GNU/Linux targets:
11316 @table @gcctabopt
11317 @item -mglibc
11318 @opindex mglibc
11319 Use the GNU C library instead of uClibc.  This is the default except
11320 on @samp{*-*-linux-*uclibc*} targets.
11322 @item -muclibc
11323 @opindex muclibc
11324 Use uClibc instead of the GNU C library.  This is the default on
11325 @samp{*-*-linux-*uclibc*} targets.
11326 @end table
11328 @node H8/300 Options
11329 @subsection H8/300 Options
11331 These @samp{-m} options are defined for the H8/300 implementations:
11333 @table @gcctabopt
11334 @item -mrelax
11335 @opindex mrelax
11336 Shorten some address references at link time, when possible; uses the
11337 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11338 ld, Using ld}, for a fuller description.
11340 @item -mh
11341 @opindex mh
11342 Generate code for the H8/300H@.
11344 @item -ms
11345 @opindex ms
11346 Generate code for the H8S@.
11348 @item -mn
11349 @opindex mn
11350 Generate code for the H8S and H8/300H in the normal mode.  This switch
11351 must be used either with @option{-mh} or @option{-ms}.
11353 @item -ms2600
11354 @opindex ms2600
11355 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11357 @item -mint32
11358 @opindex mint32
11359 Make @code{int} data 32 bits by default.
11361 @item -malign-300
11362 @opindex malign-300
11363 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11364 The default for the H8/300H and H8S is to align longs and floats on 4
11365 byte boundaries.
11366 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11367 This option has no effect on the H8/300.
11368 @end table
11370 @node HPPA Options
11371 @subsection HPPA Options
11372 @cindex HPPA Options
11374 These @samp{-m} options are defined for the HPPA family of computers:
11376 @table @gcctabopt
11377 @item -march=@var{architecture-type}
11378 @opindex march
11379 Generate code for the specified architecture.  The choices for
11380 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11381 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11382 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11383 architecture option for your machine.  Code compiled for lower numbered
11384 architectures will run on higher numbered architectures, but not the
11385 other way around.
11387 @item -mpa-risc-1-0
11388 @itemx -mpa-risc-1-1
11389 @itemx -mpa-risc-2-0
11390 @opindex mpa-risc-1-0
11391 @opindex mpa-risc-1-1
11392 @opindex mpa-risc-2-0
11393 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11395 @item -mbig-switch
11396 @opindex mbig-switch
11397 Generate code suitable for big switch tables.  Use this option only if
11398 the assembler/linker complain about out of range branches within a switch
11399 table.
11401 @item -mjump-in-delay
11402 @opindex mjump-in-delay
11403 Fill delay slots of function calls with unconditional jump instructions
11404 by modifying the return pointer for the function call to be the target
11405 of the conditional jump.
11407 @item -mdisable-fpregs
11408 @opindex mdisable-fpregs
11409 Prevent floating point registers from being used in any manner.  This is
11410 necessary for compiling kernels which perform lazy context switching of
11411 floating point registers.  If you use this option and attempt to perform
11412 floating point operations, the compiler will abort.
11414 @item -mdisable-indexing
11415 @opindex mdisable-indexing
11416 Prevent the compiler from using indexing address modes.  This avoids some
11417 rather obscure problems when compiling MIG generated code under MACH@.
11419 @item -mno-space-regs
11420 @opindex mno-space-regs
11421 Generate code that assumes the target has no space registers.  This allows
11422 GCC to generate faster indirect calls and use unscaled index address modes.
11424 Such code is suitable for level 0 PA systems and kernels.
11426 @item -mfast-indirect-calls
11427 @opindex mfast-indirect-calls
11428 Generate code that assumes calls never cross space boundaries.  This
11429 allows GCC to emit code which performs faster indirect calls.
11431 This option will not work in the presence of shared libraries or nested
11432 functions.
11434 @item -mfixed-range=@var{register-range}
11435 @opindex mfixed-range
11436 Generate code treating the given register range as fixed registers.
11437 A fixed register is one that the register allocator can not use.  This is
11438 useful when compiling kernel code.  A register range is specified as
11439 two registers separated by a dash.  Multiple register ranges can be
11440 specified separated by a comma.
11442 @item -mlong-load-store
11443 @opindex mlong-load-store
11444 Generate 3-instruction load and store sequences as sometimes required by
11445 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11446 the HP compilers.
11448 @item -mportable-runtime
11449 @opindex mportable-runtime
11450 Use the portable calling conventions proposed by HP for ELF systems.
11452 @item -mgas
11453 @opindex mgas
11454 Enable the use of assembler directives only GAS understands.
11456 @item -mschedule=@var{cpu-type}
11457 @opindex mschedule
11458 Schedule code according to the constraints for the machine type
11459 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11460 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11461 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11462 proper scheduling option for your machine.  The default scheduling is
11463 @samp{8000}.
11465 @item -mlinker-opt
11466 @opindex mlinker-opt
11467 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11468 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11469 linkers in which they give bogus error messages when linking some programs.
11471 @item -msoft-float
11472 @opindex msoft-float
11473 Generate output containing library calls for floating point.
11474 @strong{Warning:} the requisite libraries are not available for all HPPA
11475 targets.  Normally the facilities of the machine's usual C compiler are
11476 used, but this cannot be done directly in cross-compilation.  You must make
11477 your own arrangements to provide suitable library functions for
11478 cross-compilation.
11480 @option{-msoft-float} changes the calling convention in the output file;
11481 therefore, it is only useful if you compile @emph{all} of a program with
11482 this option.  In particular, you need to compile @file{libgcc.a}, the
11483 library that comes with GCC, with @option{-msoft-float} in order for
11484 this to work.
11486 @item -msio
11487 @opindex msio
11488 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11489 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11490 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11491 options are available under HP-UX and HI-UX@.
11493 @item -mgnu-ld
11494 @opindex mgnu-ld
11495 Use GNU ld specific options.  This passes @option{-shared} to ld when
11496 building a shared library.  It is the default when GCC is configured,
11497 explicitly or implicitly, with the GNU linker.  This option does not
11498 have any affect on which ld is called, it only changes what parameters
11499 are passed to that ld.  The ld that is called is determined by the
11500 @option{--with-ld} configure option, GCC's program search path, and
11501 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11502 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11503 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11505 @item -mhp-ld
11506 @opindex mhp-ld
11507 Use HP ld specific options.  This passes @option{-b} to ld when building
11508 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11509 links.  It is the default when GCC is configured, explicitly or
11510 implicitly, with the HP linker.  This option does not have any affect on
11511 which ld is called, it only changes what parameters are passed to that
11512 ld.  The ld that is called is determined by the @option{--with-ld}
11513 configure option, GCC's program search path, and finally by the user's
11514 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11515 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11516 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11518 @item -mlong-calls
11519 @opindex mno-long-calls
11520 Generate code that uses long call sequences.  This ensures that a call
11521 is always able to reach linker generated stubs.  The default is to generate
11522 long calls only when the distance from the call site to the beginning
11523 of the function or translation unit, as the case may be, exceeds a
11524 predefined limit set by the branch type being used.  The limits for
11525 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11526 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11527 240,000 bytes.
11529 Distances are measured from the beginning of functions when using the
11530 @option{-ffunction-sections} option, or when using the @option{-mgas}
11531 and @option{-mno-portable-runtime} options together under HP-UX with
11532 the SOM linker.
11534 It is normally not desirable to use this option as it will degrade
11535 performance.  However, it may be useful in large applications,
11536 particularly when partial linking is used to build the application.
11538 The types of long calls used depends on the capabilities of the
11539 assembler and linker, and the type of code being generated.  The
11540 impact on systems that support long absolute calls, and long pic
11541 symbol-difference or pc-relative calls should be relatively small.
11542 However, an indirect call is used on 32-bit ELF systems in pic code
11543 and it is quite long.
11545 @item -munix=@var{unix-std}
11546 @opindex march
11547 Generate compiler predefines and select a startfile for the specified
11548 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11549 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11550 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11551 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11552 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11553 and later.
11555 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11556 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11557 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11558 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11559 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11560 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11562 It is @emph{important} to note that this option changes the interfaces
11563 for various library routines.  It also affects the operational behavior
11564 of the C library.  Thus, @emph{extreme} care is needed in using this
11565 option.
11567 Library code that is intended to operate with more than one UNIX
11568 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11569 as appropriate.  Most GNU software doesn't provide this capability.
11571 @item -nolibdld
11572 @opindex nolibdld
11573 Suppress the generation of link options to search libdld.sl when the
11574 @option{-static} option is specified on HP-UX 10 and later.
11576 @item -static
11577 @opindex static
11578 The HP-UX implementation of setlocale in libc has a dependency on
11579 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11580 when the @option{-static} option is specified, special link options
11581 are needed to resolve this dependency.
11583 On HP-UX 10 and later, the GCC driver adds the necessary options to
11584 link with libdld.sl when the @option{-static} option is specified.
11585 This causes the resulting binary to be dynamic.  On the 64-bit port,
11586 the linkers generate dynamic binaries by default in any case.  The
11587 @option{-nolibdld} option can be used to prevent the GCC driver from
11588 adding these link options.
11590 @item -threads
11591 @opindex threads
11592 Add support for multithreading with the @dfn{dce thread} library
11593 under HP-UX@.  This option sets flags for both the preprocessor and
11594 linker.
11595 @end table
11597 @node i386 and x86-64 Options
11598 @subsection Intel 386 and AMD x86-64 Options
11599 @cindex i386 Options
11600 @cindex x86-64 Options
11601 @cindex Intel 386 Options
11602 @cindex AMD x86-64 Options
11604 These @samp{-m} options are defined for the i386 and x86-64 family of
11605 computers:
11607 @table @gcctabopt
11608 @item -mtune=@var{cpu-type}
11609 @opindex mtune
11610 Tune to @var{cpu-type} everything applicable about the generated code, except
11611 for the ABI and the set of available instructions.  The choices for
11612 @var{cpu-type} are:
11613 @table @emph
11614 @item generic
11615 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11616 If you know the CPU on which your code will run, then you should use
11617 the corresponding @option{-mtune} option instead of
11618 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11619 of your application will have, then you should use this option.
11621 As new processors are deployed in the marketplace, the behavior of this
11622 option will change.  Therefore, if you upgrade to a newer version of
11623 GCC, the code generated option will change to reflect the processors
11624 that were most common when that version of GCC was released.
11626 There is no @option{-march=generic} option because @option{-march}
11627 indicates the instruction set the compiler can use, and there is no
11628 generic instruction set applicable to all processors.  In contrast,
11629 @option{-mtune} indicates the processor (or, in this case, collection of
11630 processors) for which the code is optimized.
11631 @item native
11632 This selects the CPU to tune for at compilation time by determining
11633 the processor type of the compiling machine.  Using @option{-mtune=native}
11634 will produce code optimized for the local machine under the constraints
11635 of the selected instruction set.  Using @option{-march=native} will
11636 enable all instruction subsets supported by the local machine (hence
11637 the result might not run on different machines).
11638 @item i386
11639 Original Intel's i386 CPU@.
11640 @item i486
11641 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11642 @item i586, pentium
11643 Intel Pentium CPU with no MMX support.
11644 @item pentium-mmx
11645 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11646 @item pentiumpro
11647 Intel PentiumPro CPU@.
11648 @item i686
11649 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11650 instruction set will be used, so the code will run on all i686 family chips.
11651 @item pentium2
11652 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11653 @item pentium3, pentium3m
11654 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11655 support.
11656 @item pentium-m
11657 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11658 support.  Used by Centrino notebooks.
11659 @item pentium4, pentium4m
11660 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11661 @item prescott
11662 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11663 set support.
11664 @item nocona
11665 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11666 SSE2 and SSE3 instruction set support.
11667 @item core2
11668 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11669 instruction set support.
11670 @item atom
11671 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11672 instruction set support.
11673 @item k6
11674 AMD K6 CPU with MMX instruction set support.
11675 @item k6-2, k6-3
11676 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
11677 @item athlon, athlon-tbird
11678 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
11679 support.
11680 @item athlon-4, athlon-xp, athlon-mp
11681 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
11682 instruction set support.
11683 @item k8, opteron, athlon64, athlon-fx
11684 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11685 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
11686 @item k8-sse3, opteron-sse3, athlon64-sse3
11687 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11688 @item amdfam10, barcelona
11689 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11690 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
11691 instruction set extensions.)
11692 @item winchip-c6
11693 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11694 set support.
11695 @item winchip2
11696 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
11697 instruction set support.
11698 @item c3
11699 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
11700 implemented for this chip.)
11701 @item c3-2
11702 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11703 implemented for this chip.)
11704 @item geode
11705 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
11706 @end table
11708 While picking a specific @var{cpu-type} will schedule things appropriately
11709 for that particular chip, the compiler will not generate any code that
11710 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11711 being used.
11713 @item -march=@var{cpu-type}
11714 @opindex march
11715 Generate instructions for the machine type @var{cpu-type}.  The choices
11716 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11717 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11719 @item -mcpu=@var{cpu-type}
11720 @opindex mcpu
11721 A deprecated synonym for @option{-mtune}.
11723 @item -mfpmath=@var{unit}
11724 @opindex mfpmath
11725 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11726 for @var{unit} are:
11728 @table @samp
11729 @item 387
11730 Use the standard 387 floating point coprocessor present majority of chips and
11731 emulated otherwise.  Code compiled with this option will run almost everywhere.
11732 The temporary results are computed in 80bit precision instead of precision
11733 specified by the type resulting in slightly different results compared to most
11734 of other chips.  See @option{-ffloat-store} for more detailed description.
11736 This is the default choice for i386 compiler.
11738 @item sse
11739 Use scalar floating point instructions present in the SSE instruction set.
11740 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11741 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11742 instruction set supports only single precision arithmetics, thus the double and
11743 extended precision arithmetics is still done using 387.  Later version, present
11744 only in Pentium4 and the future AMD x86-64 chips supports double precision
11745 arithmetics too.
11747 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11748 or @option{-msse2} switches to enable SSE extensions and make this option
11749 effective.  For the x86-64 compiler, these extensions are enabled by default.
11751 The resulting code should be considerably faster in the majority of cases and avoid
11752 the numerical instability problems of 387 code, but may break some existing
11753 code that expects temporaries to be 80bit.
11755 This is the default choice for the x86-64 compiler.
11757 @item sse,387
11758 @itemx sse+387
11759 @itemx both
11760 Attempt to utilize both instruction sets at once.  This effectively double the
11761 amount of available registers and on chips with separate execution units for
11762 387 and SSE the execution resources too.  Use this option with care, as it is
11763 still experimental, because the GCC register allocator does not model separate
11764 functional units well resulting in instable performance.
11765 @end table
11767 @item -masm=@var{dialect}
11768 @opindex masm=@var{dialect}
11769 Output asm instructions using selected @var{dialect}.  Supported
11770 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11771 not support @samp{intel}.
11773 @item -mieee-fp
11774 @itemx -mno-ieee-fp
11775 @opindex mieee-fp
11776 @opindex mno-ieee-fp
11777 Control whether or not the compiler uses IEEE floating point
11778 comparisons.  These handle correctly the case where the result of a
11779 comparison is unordered.
11781 @item -msoft-float
11782 @opindex msoft-float
11783 Generate output containing library calls for floating point.
11784 @strong{Warning:} the requisite libraries are not part of GCC@.
11785 Normally the facilities of the machine's usual C compiler are used, but
11786 this can't be done directly in cross-compilation.  You must make your
11787 own arrangements to provide suitable library functions for
11788 cross-compilation.
11790 On machines where a function returns floating point results in the 80387
11791 register stack, some floating point opcodes may be emitted even if
11792 @option{-msoft-float} is used.
11794 @item -mno-fp-ret-in-387
11795 @opindex mno-fp-ret-in-387
11796 Do not use the FPU registers for return values of functions.
11798 The usual calling convention has functions return values of types
11799 @code{float} and @code{double} in an FPU register, even if there
11800 is no FPU@.  The idea is that the operating system should emulate
11801 an FPU@.
11803 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11804 in ordinary CPU registers instead.
11806 @item -mno-fancy-math-387
11807 @opindex mno-fancy-math-387
11808 Some 387 emulators do not support the @code{sin}, @code{cos} and
11809 @code{sqrt} instructions for the 387.  Specify this option to avoid
11810 generating those instructions.  This option is the default on FreeBSD,
11811 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11812 indicates that the target cpu will always have an FPU and so the
11813 instruction will not need emulation.  As of revision 2.6.1, these
11814 instructions are not generated unless you also use the
11815 @option{-funsafe-math-optimizations} switch.
11817 @item -malign-double
11818 @itemx -mno-align-double
11819 @opindex malign-double
11820 @opindex mno-align-double
11821 Control whether GCC aligns @code{double}, @code{long double}, and
11822 @code{long long} variables on a two word boundary or a one word
11823 boundary.  Aligning @code{double} variables on a two word boundary will
11824 produce code that runs somewhat faster on a @samp{Pentium} at the
11825 expense of more memory.
11827 On x86-64, @option{-malign-double} is enabled by default.
11829 @strong{Warning:} if you use the @option{-malign-double} switch,
11830 structures containing the above types will be aligned differently than
11831 the published application binary interface specifications for the 386
11832 and will not be binary compatible with structures in code compiled
11833 without that switch.
11835 @item -m96bit-long-double
11836 @itemx -m128bit-long-double
11837 @opindex m96bit-long-double
11838 @opindex m128bit-long-double
11839 These switches control the size of @code{long double} type.  The i386
11840 application binary interface specifies the size to be 96 bits,
11841 so @option{-m96bit-long-double} is the default in 32 bit mode.
11843 Modern architectures (Pentium and newer) would prefer @code{long double}
11844 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11845 conforming to the ABI, this would not be possible.  So specifying a
11846 @option{-m128bit-long-double} will align @code{long double}
11847 to a 16 byte boundary by padding the @code{long double} with an additional
11848 32 bit zero.
11850 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11851 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11853 Notice that neither of these options enable any extra precision over the x87
11854 standard of 80 bits for a @code{long double}.
11856 @strong{Warning:} if you override the default value for your target ABI, the
11857 structures and arrays containing @code{long double} variables will change
11858 their size as well as function calling convention for function taking
11859 @code{long double} will be modified.  Hence they will not be binary
11860 compatible with arrays or structures in code compiled without that switch.
11862 @item -mlarge-data-threshold=@var{number}
11863 @opindex mlarge-data-threshold=@var{number}
11864 When @option{-mcmodel=medium} is specified, the data greater than
11865 @var{threshold} are placed in large data section.  This value must be the
11866 same across all object linked into the binary and defaults to 65535.
11868 @item -mrtd
11869 @opindex mrtd
11870 Use a different function-calling convention, in which functions that
11871 take a fixed number of arguments return with the @code{ret} @var{num}
11872 instruction, which pops their arguments while returning.  This saves one
11873 instruction in the caller since there is no need to pop the arguments
11874 there.
11876 You can specify that an individual function is called with this calling
11877 sequence with the function attribute @samp{stdcall}.  You can also
11878 override the @option{-mrtd} option by using the function attribute
11879 @samp{cdecl}.  @xref{Function Attributes}.
11881 @strong{Warning:} this calling convention is incompatible with the one
11882 normally used on Unix, so you cannot use it if you need to call
11883 libraries compiled with the Unix compiler.
11885 Also, you must provide function prototypes for all functions that
11886 take variable numbers of arguments (including @code{printf});
11887 otherwise incorrect code will be generated for calls to those
11888 functions.
11890 In addition, seriously incorrect code will result if you call a
11891 function with too many arguments.  (Normally, extra arguments are
11892 harmlessly ignored.)
11894 @item -mregparm=@var{num}
11895 @opindex mregparm
11896 Control how many registers are used to pass integer arguments.  By
11897 default, no registers are used to pass arguments, and at most 3
11898 registers can be used.  You can control this behavior for a specific
11899 function by using the function attribute @samp{regparm}.
11900 @xref{Function Attributes}.
11902 @strong{Warning:} if you use this switch, and
11903 @var{num} is nonzero, then you must build all modules with the same
11904 value, including any libraries.  This includes the system libraries and
11905 startup modules.
11907 @item -msseregparm
11908 @opindex msseregparm
11909 Use SSE register passing conventions for float and double arguments
11910 and return values.  You can control this behavior for a specific
11911 function by using the function attribute @samp{sseregparm}.
11912 @xref{Function Attributes}.
11914 @strong{Warning:} if you use this switch then you must build all
11915 modules with the same value, including any libraries.  This includes
11916 the system libraries and startup modules.
11918 @item -mpc32
11919 @itemx -mpc64
11920 @itemx -mpc80
11921 @opindex mpc32
11922 @opindex mpc64
11923 @opindex mpc80
11925 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
11926 is specified, the significands of results of floating-point operations are
11927 rounded to 24 bits (single precision); @option{-mpc64} rounds the
11928 significands of results of floating-point operations to 53 bits (double
11929 precision) and @option{-mpc80} rounds the significands of results of
11930 floating-point operations to 64 bits (extended double precision), which is
11931 the default.  When this option is used, floating-point operations in higher
11932 precisions are not available to the programmer without setting the FPU
11933 control word explicitly.
11935 Setting the rounding of floating-point operations to less than the default
11936 80 bits can speed some programs by 2% or more.  Note that some mathematical
11937 libraries assume that extended precision (80 bit) floating-point operations
11938 are enabled by default; routines in such libraries could suffer significant
11939 loss of accuracy, typically through so-called "catastrophic cancellation",
11940 when this option is used to set the precision to less than extended precision.
11942 @item -mstackrealign
11943 @opindex mstackrealign
11944 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
11945 option will generate an alternate prologue and epilogue that realigns the
11946 runtime stack if necessary.  This supports mixing legacy codes that keep
11947 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
11948 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11949 applicable to individual functions.
11951 @item -mpreferred-stack-boundary=@var{num}
11952 @opindex mpreferred-stack-boundary
11953 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11954 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11955 the default is 4 (16 bytes or 128 bits).
11957 @item -mincoming-stack-boundary=@var{num}
11958 @opindex mincoming-stack-boundary
11959 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
11960 boundary.  If @option{-mincoming-stack-boundary} is not specified,
11961 the one specified by @option{-mpreferred-stack-boundary} will be used.
11963 On Pentium and PentiumPro, @code{double} and @code{long double} values
11964 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
11965 suffer significant run time performance penalties.  On Pentium III, the
11966 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
11967 properly if it is not 16 byte aligned.
11969 To ensure proper alignment of this values on the stack, the stack boundary
11970 must be as aligned as that required by any value stored on the stack.
11971 Further, every function must be generated such that it keeps the stack
11972 aligned.  Thus calling a function compiled with a higher preferred
11973 stack boundary from a function compiled with a lower preferred stack
11974 boundary will most likely misalign the stack.  It is recommended that
11975 libraries that use callbacks always use the default setting.
11977 This extra alignment does consume extra stack space, and generally
11978 increases code size.  Code that is sensitive to stack space usage, such
11979 as embedded systems and operating system kernels, may want to reduce the
11980 preferred alignment to @option{-mpreferred-stack-boundary=2}.
11982 @item -mmmx
11983 @itemx -mno-mmx
11984 @itemx -msse
11985 @itemx -mno-sse
11986 @itemx -msse2
11987 @itemx -mno-sse2
11988 @itemx -msse3
11989 @itemx -mno-sse3
11990 @itemx -mssse3
11991 @itemx -mno-ssse3
11992 @itemx -msse4.1
11993 @itemx -mno-sse4.1
11994 @itemx -msse4.2
11995 @itemx -mno-sse4.2
11996 @itemx -msse4
11997 @itemx -mno-sse4
11998 @itemx -mavx
11999 @itemx -mno-avx
12000 @itemx -maes
12001 @itemx -mno-aes
12002 @itemx -mpclmul
12003 @itemx -mno-pclmul
12004 @itemx -msse4a
12005 @itemx -mno-sse4a
12006 @itemx -mfma4
12007 @itemx -mno-fma4
12008 @itemx -mxop
12009 @itemx -mno-xop
12010 @itemx -mlwp
12011 @itemx -mno-lwp
12012 @itemx -m3dnow
12013 @itemx -mno-3dnow
12014 @itemx -mpopcnt
12015 @itemx -mno-popcnt
12016 @itemx -mabm
12017 @itemx -mno-abm
12018 @opindex mmmx
12019 @opindex mno-mmx
12020 @opindex msse
12021 @opindex mno-sse
12022 @opindex m3dnow
12023 @opindex mno-3dnow
12024 These switches enable or disable the use of instructions in the MMX,
12025 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, FMA4, XOP,
12026 LWP, ABM or 3DNow!@: extended instruction sets.
12027 These extensions are also available as built-in functions: see
12028 @ref{X86 Built-in Functions}, for details of the functions enabled and
12029 disabled by these switches.
12031 To have SSE/SSE2 instructions generated automatically from floating-point
12032 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12034 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12035 generates new AVX instructions or AVX equivalence for all SSEx instructions
12036 when needed.
12038 These options will enable GCC to use these extended instructions in
12039 generated code, even without @option{-mfpmath=sse}.  Applications which
12040 perform runtime CPU detection must compile separate files for each
12041 supported architecture, using the appropriate flags.  In particular,
12042 the file containing the CPU detection code should be compiled without
12043 these options.
12045 @item -mcld
12046 @opindex mcld
12047 This option instructs GCC to emit a @code{cld} instruction in the prologue
12048 of functions that use string instructions.  String instructions depend on
12049 the DF flag to select between autoincrement or autodecrement mode.  While the
12050 ABI specifies the DF flag to be cleared on function entry, some operating
12051 systems violate this specification by not clearing the DF flag in their
12052 exception dispatchers.  The exception handler can be invoked with the DF flag
12053 set which leads to wrong direction mode, when string instructions are used.
12054 This option can be enabled by default on 32-bit x86 targets by configuring
12055 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12056 instructions can be suppressed with the @option{-mno-cld} compiler option
12057 in this case.
12059 @item -mcx16
12060 @opindex mcx16
12061 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12062 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12063 data types.  This is useful for high resolution counters that could be updated
12064 by multiple processors (or cores).  This instruction is generated as part of
12065 atomic built-in functions: see @ref{Atomic Builtins} for details.
12067 @item -msahf
12068 @opindex msahf
12069 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12070 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12071 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12072 SAHF are load and store instructions, respectively, for certain status flags.
12073 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12074 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12076 @item -mmovbe
12077 @opindex mmovbe
12078 This option will enable GCC to use movbe instruction to implement
12079 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12081 @item -mcrc32
12082 @opindex mcrc32
12083 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12084 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12085 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12087 @item -mrecip
12088 @opindex mrecip
12089 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12090 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12091 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12092 variants) for single precision floating point arguments.  These instructions
12093 are generated only when @option{-funsafe-math-optimizations} is enabled
12094 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12095 Note that while the throughput of the sequence is higher than the throughput
12096 of the non-reciprocal instruction, the precision of the sequence can be
12097 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12099 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12100 already with @option{-ffast-math} (or the above option combination), and
12101 doesn't need @option{-mrecip}.
12103 @item -mveclibabi=@var{type}
12104 @opindex mveclibabi
12105 Specifies the ABI type to use for vectorizing intrinsics using an
12106 external library.  Supported types are @code{svml} for the Intel short
12107 vector math library and @code{acml} for the AMD math core library style
12108 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12109 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12110 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12111 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12112 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12113 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12114 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12115 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12116 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12117 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12118 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12119 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12120 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12121 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12122 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12123 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12124 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12125 compatible library will have to be specified at link time.
12127 @item -mabi=@var{name}
12128 @opindex mabi
12129 Generate code for the specified calling convention.  Permissible values
12130 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12131 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12132 ABI when targeting Windows.  On all other systems, the default is the
12133 SYSV ABI.  You can control this behavior for a specific function by
12134 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12135 @xref{Function Attributes}.
12137 @item -mpush-args
12138 @itemx -mno-push-args
12139 @opindex mpush-args
12140 @opindex mno-push-args
12141 Use PUSH operations to store outgoing parameters.  This method is shorter
12142 and usually equally fast as method using SUB/MOV operations and is enabled
12143 by default.  In some cases disabling it may improve performance because of
12144 improved scheduling and reduced dependencies.
12146 @item -maccumulate-outgoing-args
12147 @opindex maccumulate-outgoing-args
12148 If enabled, the maximum amount of space required for outgoing arguments will be
12149 computed in the function prologue.  This is faster on most modern CPUs
12150 because of reduced dependencies, improved scheduling and reduced stack usage
12151 when preferred stack boundary is not equal to 2.  The drawback is a notable
12152 increase in code size.  This switch implies @option{-mno-push-args}.
12154 @item -mthreads
12155 @opindex mthreads
12156 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12157 on thread-safe exception handling must compile and link all code with the
12158 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12159 @option{-D_MT}; when linking, it links in a special thread helper library
12160 @option{-lmingwthrd} which cleans up per thread exception handling data.
12162 @item -mno-align-stringops
12163 @opindex mno-align-stringops
12164 Do not align destination of inlined string operations.  This switch reduces
12165 code size and improves performance in case the destination is already aligned,
12166 but GCC doesn't know about it.
12168 @item -minline-all-stringops
12169 @opindex minline-all-stringops
12170 By default GCC inlines string operations only when destination is known to be
12171 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12172 size, but may improve performance of code that depends on fast memcpy, strlen
12173 and memset for short lengths.
12175 @item -minline-stringops-dynamically
12176 @opindex minline-stringops-dynamically
12177 For string operation of unknown size, inline runtime checks so for small
12178 blocks inline code is used, while for large blocks library call is used.
12180 @item -mstringop-strategy=@var{alg}
12181 @opindex mstringop-strategy=@var{alg}
12182 Overwrite internal decision heuristic about particular algorithm to inline
12183 string operation with.  The allowed values are @code{rep_byte},
12184 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12185 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12186 expanding inline loop, @code{libcall} for always expanding library call.
12188 @item -momit-leaf-frame-pointer
12189 @opindex momit-leaf-frame-pointer
12190 Don't keep the frame pointer in a register for leaf functions.  This
12191 avoids the instructions to save, set up and restore frame pointers and
12192 makes an extra register available in leaf functions.  The option
12193 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12194 which might make debugging harder.
12196 @item -mtls-direct-seg-refs
12197 @itemx -mno-tls-direct-seg-refs
12198 @opindex mtls-direct-seg-refs
12199 Controls whether TLS variables may be accessed with offsets from the
12200 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12201 or whether the thread base pointer must be added.  Whether or not this
12202 is legal depends on the operating system, and whether it maps the
12203 segment to cover the entire TLS area.
12205 For systems that use GNU libc, the default is on.
12207 @item -msse2avx
12208 @itemx -mno-sse2avx
12209 @opindex msse2avx
12210 Specify that the assembler should encode SSE instructions with VEX
12211 prefix.  The option @option{-mavx} turns this on by default.
12212 @end table
12214 These @samp{-m} switches are supported in addition to the above
12215 on AMD x86-64 processors in 64-bit environments.
12217 @table @gcctabopt
12218 @item -m32
12219 @itemx -m64
12220 @opindex m32
12221 @opindex m64
12222 Generate code for a 32-bit or 64-bit environment.
12223 The 32-bit environment sets int, long and pointer to 32 bits and
12224 generates code that runs on any i386 system.
12225 The 64-bit environment sets int to 32 bits and long and pointer
12226 to 64 bits and generates code for AMD's x86-64 architecture. For
12227 darwin only the -m64 option turns off the @option{-fno-pic} and
12228 @option{-mdynamic-no-pic} options.
12230 @item -mno-red-zone
12231 @opindex mno-red-zone
12232 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12233 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12234 stack pointer that will not be modified by signal or interrupt handlers
12235 and therefore can be used for temporary data without adjusting the stack
12236 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12238 @item -mcmodel=small
12239 @opindex mcmodel=small
12240 Generate code for the small code model: the program and its symbols must
12241 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12242 Programs can be statically or dynamically linked.  This is the default
12243 code model.
12245 @item -mcmodel=kernel
12246 @opindex mcmodel=kernel
12247 Generate code for the kernel code model.  The kernel runs in the
12248 negative 2 GB of the address space.
12249 This model has to be used for Linux kernel code.
12251 @item -mcmodel=medium
12252 @opindex mcmodel=medium
12253 Generate code for the medium model: The program is linked in the lower 2
12254 GB of the address space.  Small symbols are also placed there.  Symbols
12255 with sizes larger than @option{-mlarge-data-threshold} are put into
12256 large data or bss sections and can be located above 2GB.  Programs can
12257 be statically or dynamically linked.
12259 @item -mcmodel=large
12260 @opindex mcmodel=large
12261 Generate code for the large model: This model makes no assumptions
12262 about addresses and sizes of sections.
12263 @end table
12265 @node IA-64 Options
12266 @subsection IA-64 Options
12267 @cindex IA-64 Options
12269 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12271 @table @gcctabopt
12272 @item -mbig-endian
12273 @opindex mbig-endian
12274 Generate code for a big endian target.  This is the default for HP-UX@.
12276 @item -mlittle-endian
12277 @opindex mlittle-endian
12278 Generate code for a little endian target.  This is the default for AIX5
12279 and GNU/Linux.
12281 @item -mgnu-as
12282 @itemx -mno-gnu-as
12283 @opindex mgnu-as
12284 @opindex mno-gnu-as
12285 Generate (or don't) code for the GNU assembler.  This is the default.
12286 @c Also, this is the default if the configure option @option{--with-gnu-as}
12287 @c is used.
12289 @item -mgnu-ld
12290 @itemx -mno-gnu-ld
12291 @opindex mgnu-ld
12292 @opindex mno-gnu-ld
12293 Generate (or don't) code for the GNU linker.  This is the default.
12294 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12295 @c is used.
12297 @item -mno-pic
12298 @opindex mno-pic
12299 Generate code that does not use a global pointer register.  The result
12300 is not position independent code, and violates the IA-64 ABI@.
12302 @item -mvolatile-asm-stop
12303 @itemx -mno-volatile-asm-stop
12304 @opindex mvolatile-asm-stop
12305 @opindex mno-volatile-asm-stop
12306 Generate (or don't) a stop bit immediately before and after volatile asm
12307 statements.
12309 @item -mregister-names
12310 @itemx -mno-register-names
12311 @opindex mregister-names
12312 @opindex mno-register-names
12313 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12314 the stacked registers.  This may make assembler output more readable.
12316 @item -mno-sdata
12317 @itemx -msdata
12318 @opindex mno-sdata
12319 @opindex msdata
12320 Disable (or enable) optimizations that use the small data section.  This may
12321 be useful for working around optimizer bugs.
12323 @item -mconstant-gp
12324 @opindex mconstant-gp
12325 Generate code that uses a single constant global pointer value.  This is
12326 useful when compiling kernel code.
12328 @item -mauto-pic
12329 @opindex mauto-pic
12330 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12331 This is useful when compiling firmware code.
12333 @item -minline-float-divide-min-latency
12334 @opindex minline-float-divide-min-latency
12335 Generate code for inline divides of floating point values
12336 using the minimum latency algorithm.
12338 @item -minline-float-divide-max-throughput
12339 @opindex minline-float-divide-max-throughput
12340 Generate code for inline divides of floating point values
12341 using the maximum throughput algorithm.
12343 @item -mno-inline-float-divide
12344 @opindex mno-inline-float-divide
12345 Do not generate inline code for divides of floating point values.
12347 @item -minline-int-divide-min-latency
12348 @opindex minline-int-divide-min-latency
12349 Generate code for inline divides of integer values
12350 using the minimum latency algorithm.
12352 @item -minline-int-divide-max-throughput
12353 @opindex minline-int-divide-max-throughput
12354 Generate code for inline divides of integer values
12355 using the maximum throughput algorithm.
12357 @item -mno-inline-int-divide
12358 @opindex mno-inline-int-divide
12359 Do not generate inline code for divides of integer values.
12361 @item -minline-sqrt-min-latency
12362 @opindex minline-sqrt-min-latency
12363 Generate code for inline square roots
12364 using the minimum latency algorithm.
12366 @item -minline-sqrt-max-throughput
12367 @opindex minline-sqrt-max-throughput
12368 Generate code for inline square roots
12369 using the maximum throughput algorithm.
12371 @item -mno-inline-sqrt
12372 @opindex mno-inline-sqrt
12373 Do not generate inline code for sqrt.
12375 @item -mfused-madd
12376 @itemx -mno-fused-madd
12377 @opindex mfused-madd
12378 @opindex mno-fused-madd
12379 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12380 instructions.    The default is to use these instructions.
12382 @item -mno-dwarf2-asm
12383 @itemx -mdwarf2-asm
12384 @opindex mno-dwarf2-asm
12385 @opindex mdwarf2-asm
12386 Don't (or do) generate assembler code for the DWARF2 line number debugging
12387 info.  This may be useful when not using the GNU assembler.
12389 @item -mearly-stop-bits
12390 @itemx -mno-early-stop-bits
12391 @opindex mearly-stop-bits
12392 @opindex mno-early-stop-bits
12393 Allow stop bits to be placed earlier than immediately preceding the
12394 instruction that triggered the stop bit.  This can improve instruction
12395 scheduling, but does not always do so.
12397 @item -mfixed-range=@var{register-range}
12398 @opindex mfixed-range
12399 Generate code treating the given register range as fixed registers.
12400 A fixed register is one that the register allocator can not use.  This is
12401 useful when compiling kernel code.  A register range is specified as
12402 two registers separated by a dash.  Multiple register ranges can be
12403 specified separated by a comma.
12405 @item -mtls-size=@var{tls-size}
12406 @opindex mtls-size
12407 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12410 @item -mtune=@var{cpu-type}
12411 @opindex mtune
12412 Tune the instruction scheduling for a particular CPU, Valid values are
12413 itanium, itanium1, merced, itanium2, and mckinley.
12415 @item -milp32
12416 @itemx -mlp64
12417 @opindex milp32
12418 @opindex mlp64
12419 Generate code for a 32-bit or 64-bit environment.
12420 The 32-bit environment sets int, long and pointer to 32 bits.
12421 The 64-bit environment sets int to 32 bits and long and pointer
12422 to 64 bits.  These are HP-UX specific flags.
12424 @item -mno-sched-br-data-spec
12425 @itemx -msched-br-data-spec
12426 @opindex mno-sched-br-data-spec
12427 @opindex msched-br-data-spec
12428 (Dis/En)able data speculative scheduling before reload.
12429 This will result in generation of the ld.a instructions and
12430 the corresponding check instructions (ld.c / chk.a).
12431 The default is 'disable'.
12433 @item -msched-ar-data-spec
12434 @itemx -mno-sched-ar-data-spec
12435 @opindex msched-ar-data-spec
12436 @opindex mno-sched-ar-data-spec
12437 (En/Dis)able data speculative scheduling after reload.
12438 This will result in generation of the ld.a instructions and
12439 the corresponding check instructions (ld.c / chk.a).
12440 The default is 'enable'.
12442 @item -mno-sched-control-spec
12443 @itemx -msched-control-spec
12444 @opindex mno-sched-control-spec
12445 @opindex msched-control-spec
12446 (Dis/En)able control speculative scheduling.  This feature is
12447 available only during region scheduling (i.e.@: before reload).
12448 This will result in generation of the ld.s instructions and
12449 the corresponding check instructions chk.s .
12450 The default is 'disable'.
12452 @item -msched-br-in-data-spec
12453 @itemx -mno-sched-br-in-data-spec
12454 @opindex msched-br-in-data-spec
12455 @opindex mno-sched-br-in-data-spec
12456 (En/Dis)able speculative scheduling of the instructions that
12457 are dependent on the data speculative loads before reload.
12458 This is effective only with @option{-msched-br-data-spec} enabled.
12459 The default is 'enable'.
12461 @item -msched-ar-in-data-spec
12462 @itemx -mno-sched-ar-in-data-spec
12463 @opindex msched-ar-in-data-spec
12464 @opindex mno-sched-ar-in-data-spec
12465 (En/Dis)able speculative scheduling of the instructions that
12466 are dependent on the data speculative loads after reload.
12467 This is effective only with @option{-msched-ar-data-spec} enabled.
12468 The default is 'enable'.
12470 @item -msched-in-control-spec
12471 @itemx -mno-sched-in-control-spec
12472 @opindex msched-in-control-spec
12473 @opindex mno-sched-in-control-spec
12474 (En/Dis)able speculative scheduling of the instructions that
12475 are dependent on the control speculative loads.
12476 This is effective only with @option{-msched-control-spec} enabled.
12477 The default is 'enable'.
12479 @item -mno-sched-prefer-non-data-spec-insns
12480 @itemx -msched-prefer-non-data-spec-insns
12481 @opindex mno-sched-prefer-non-data-spec-insns
12482 @opindex msched-prefer-non-data-spec-insns
12483 If enabled, data speculative instructions will be chosen for schedule
12484 only if there are no other choices at the moment.  This will make
12485 the use of the data speculation much more conservative.
12486 The default is 'disable'.
12488 @item -mno-sched-prefer-non-control-spec-insns
12489 @itemx -msched-prefer-non-control-spec-insns
12490 @opindex mno-sched-prefer-non-control-spec-insns
12491 @opindex msched-prefer-non-control-spec-insns
12492 If enabled, control speculative instructions will be chosen for schedule
12493 only if there are no other choices at the moment.  This will make
12494 the use of the control speculation much more conservative.
12495 The default is 'disable'.
12497 @item -mno-sched-count-spec-in-critical-path
12498 @itemx -msched-count-spec-in-critical-path
12499 @opindex mno-sched-count-spec-in-critical-path
12500 @opindex msched-count-spec-in-critical-path
12501 If enabled, speculative dependencies will be considered during
12502 computation of the instructions priorities.  This will make the use of the
12503 speculation a bit more conservative.
12504 The default is 'disable'.
12506 @item -msched-spec-ldc
12507 @opindex msched-spec-ldc
12508 Use a simple data speculation check.  This option is on by default.
12510 @item -msched-control-spec-ldc
12511 @opindex msched-spec-ldc
12512 Use a simple check for control speculation.  This option is on by default.
12514 @item -msched-stop-bits-after-every-cycle
12515 @opindex msched-stop-bits-after-every-cycle
12516 Place a stop bit after every cycle when scheduling.  This option is on
12517 by default.
12519 @item -msched-fp-mem-deps-zero-cost
12520 @opindex msched-fp-mem-deps-zero-cost
12521 Assume that floating-point stores and loads are not likely to cause a conflict
12522 when placed into the same instruction group.  This option is disabled by
12523 default.
12525 @item -msel-sched-dont-check-control-spec
12526 @opindex msel-sched-dont-check-control-spec
12527 Generate checks for control speculation in selective scheduling.
12528 This flag is disabled by default.
12530 @item -msched-max-memory-insns=@var{max-insns}
12531 @opindex msched-max-memory-insns
12532 Limit on the number of memory insns per instruction group, giving lower
12533 priority to subsequent memory insns attempting to schedule in the same
12534 instruction group. Frequently useful to prevent cache bank conflicts.
12535 The default value is 1.
12537 @item -msched-max-memory-insns-hard-limit
12538 @opindex msched-max-memory-insns-hard-limit
12539 Disallow more than `msched-max-memory-insns' in instruction group.
12540 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12541 when limit is reached but may still schedule memory operations.
12543 @end table
12545 @node IA-64/VMS Options
12546 @subsection IA-64/VMS Options
12548 These @samp{-m} options are defined for the IA-64/VMS implementations:
12550 @table @gcctabopt
12551 @item -mvms-return-codes
12552 @opindex mvms-return-codes
12553 Return VMS condition codes from main. The default is to return POSIX
12554 style condition (e.g.@ error) codes.
12556 @item -mdebug-main=@var{prefix}
12557 @opindex mdebug-main=@var{prefix}
12558 Flag the first routine whose name starts with @var{prefix} as the main
12559 routine for the debugger.
12561 @item -mmalloc64
12562 @opindex mmalloc64
12563 Default to 64bit memory allocation routines.
12564 @end table
12566 @node M32C Options
12567 @subsection M32C Options
12568 @cindex M32C options
12570 @table @gcctabopt
12571 @item -mcpu=@var{name}
12572 @opindex mcpu=
12573 Select the CPU for which code is generated.  @var{name} may be one of
12574 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12575 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12576 the M32C/80 series.
12578 @item -msim
12579 @opindex msim
12580 Specifies that the program will be run on the simulator.  This causes
12581 an alternate runtime library to be linked in which supports, for
12582 example, file I/O@.  You must not use this option when generating
12583 programs that will run on real hardware; you must provide your own
12584 runtime library for whatever I/O functions are needed.
12586 @item -memregs=@var{number}
12587 @opindex memregs=
12588 Specifies the number of memory-based pseudo-registers GCC will use
12589 during code generation.  These pseudo-registers will be used like real
12590 registers, so there is a tradeoff between GCC's ability to fit the
12591 code into available registers, and the performance penalty of using
12592 memory instead of registers.  Note that all modules in a program must
12593 be compiled with the same value for this option.  Because of that, you
12594 must not use this option with the default runtime libraries gcc
12595 builds.
12597 @end table
12599 @node M32R/D Options
12600 @subsection M32R/D Options
12601 @cindex M32R/D options
12603 These @option{-m} options are defined for Renesas M32R/D architectures:
12605 @table @gcctabopt
12606 @item -m32r2
12607 @opindex m32r2
12608 Generate code for the M32R/2@.
12610 @item -m32rx
12611 @opindex m32rx
12612 Generate code for the M32R/X@.
12614 @item -m32r
12615 @opindex m32r
12616 Generate code for the M32R@.  This is the default.
12618 @item -mmodel=small
12619 @opindex mmodel=small
12620 Assume all objects live in the lower 16MB of memory (so that their addresses
12621 can be loaded with the @code{ld24} instruction), and assume all subroutines
12622 are reachable with the @code{bl} instruction.
12623 This is the default.
12625 The addressability of a particular object can be set with the
12626 @code{model} attribute.
12628 @item -mmodel=medium
12629 @opindex mmodel=medium
12630 Assume objects may be anywhere in the 32-bit address space (the compiler
12631 will generate @code{seth/add3} instructions to load their addresses), and
12632 assume all subroutines are reachable with the @code{bl} instruction.
12634 @item -mmodel=large
12635 @opindex mmodel=large
12636 Assume objects may be anywhere in the 32-bit address space (the compiler
12637 will generate @code{seth/add3} instructions to load their addresses), and
12638 assume subroutines may not be reachable with the @code{bl} instruction
12639 (the compiler will generate the much slower @code{seth/add3/jl}
12640 instruction sequence).
12642 @item -msdata=none
12643 @opindex msdata=none
12644 Disable use of the small data area.  Variables will be put into
12645 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12646 @code{section} attribute has been specified).
12647 This is the default.
12649 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12650 Objects may be explicitly put in the small data area with the
12651 @code{section} attribute using one of these sections.
12653 @item -msdata=sdata
12654 @opindex msdata=sdata
12655 Put small global and static data in the small data area, but do not
12656 generate special code to reference them.
12658 @item -msdata=use
12659 @opindex msdata=use
12660 Put small global and static data in the small data area, and generate
12661 special instructions to reference them.
12663 @item -G @var{num}
12664 @opindex G
12665 @cindex smaller data references
12666 Put global and static objects less than or equal to @var{num} bytes
12667 into the small data or bss sections instead of the normal data or bss
12668 sections.  The default value of @var{num} is 8.
12669 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12670 for this option to have any effect.
12672 All modules should be compiled with the same @option{-G @var{num}} value.
12673 Compiling with different values of @var{num} may or may not work; if it
12674 doesn't the linker will give an error message---incorrect code will not be
12675 generated.
12677 @item -mdebug
12678 @opindex mdebug
12679 Makes the M32R specific code in the compiler display some statistics
12680 that might help in debugging programs.
12682 @item -malign-loops
12683 @opindex malign-loops
12684 Align all loops to a 32-byte boundary.
12686 @item -mno-align-loops
12687 @opindex mno-align-loops
12688 Do not enforce a 32-byte alignment for loops.  This is the default.
12690 @item -missue-rate=@var{number}
12691 @opindex missue-rate=@var{number}
12692 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12693 or 2.
12695 @item -mbranch-cost=@var{number}
12696 @opindex mbranch-cost=@var{number}
12697 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12698 preferred over conditional code, if it is 2, then the opposite will
12699 apply.
12701 @item -mflush-trap=@var{number}
12702 @opindex mflush-trap=@var{number}
12703 Specifies the trap number to use to flush the cache.  The default is
12704 12.  Valid numbers are between 0 and 15 inclusive.
12706 @item -mno-flush-trap
12707 @opindex mno-flush-trap
12708 Specifies that the cache cannot be flushed by using a trap.
12710 @item -mflush-func=@var{name}
12711 @opindex mflush-func=@var{name}
12712 Specifies the name of the operating system function to call to flush
12713 the cache.  The default is @emph{_flush_cache}, but a function call
12714 will only be used if a trap is not available.
12716 @item -mno-flush-func
12717 @opindex mno-flush-func
12718 Indicates that there is no OS function for flushing the cache.
12720 @end table
12722 @node M680x0 Options
12723 @subsection M680x0 Options
12724 @cindex M680x0 options
12726 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12727 The default settings depend on which architecture was selected when
12728 the compiler was configured; the defaults for the most common choices
12729 are given below.
12731 @table @gcctabopt
12732 @item -march=@var{arch}
12733 @opindex march
12734 Generate code for a specific M680x0 or ColdFire instruction set
12735 architecture.  Permissible values of @var{arch} for M680x0
12736 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12737 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12738 architectures are selected according to Freescale's ISA classification
12739 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12740 @samp{isab} and @samp{isac}.
12742 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12743 code for a ColdFire target.  The @var{arch} in this macro is one of the
12744 @option{-march} arguments given above.
12746 When used together, @option{-march} and @option{-mtune} select code
12747 that runs on a family of similar processors but that is optimized
12748 for a particular microarchitecture.
12750 @item -mcpu=@var{cpu}
12751 @opindex mcpu
12752 Generate code for a specific M680x0 or ColdFire processor.
12753 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12754 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12755 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12756 below, which also classifies the CPUs into families:
12758 @multitable @columnfractions 0.20 0.80
12759 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12760 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12761 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12762 @item @samp{5206e} @tab @samp{5206e}
12763 @item @samp{5208} @tab @samp{5207} @samp{5208}
12764 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12765 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12766 @item @samp{5216} @tab @samp{5214} @samp{5216}
12767 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12768 @item @samp{5225} @tab @samp{5224} @samp{5225}
12769 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12770 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12771 @item @samp{5249} @tab @samp{5249}
12772 @item @samp{5250} @tab @samp{5250}
12773 @item @samp{5271} @tab @samp{5270} @samp{5271}
12774 @item @samp{5272} @tab @samp{5272}
12775 @item @samp{5275} @tab @samp{5274} @samp{5275}
12776 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12777 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12778 @item @samp{5307} @tab @samp{5307}
12779 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12780 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12781 @item @samp{5407} @tab @samp{5407}
12782 @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}
12783 @end multitable
12785 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12786 @var{arch} is compatible with @var{cpu}.  Other combinations of
12787 @option{-mcpu} and @option{-march} are rejected.
12789 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12790 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12791 where the value of @var{family} is given by the table above.
12793 @item -mtune=@var{tune}
12794 @opindex mtune
12795 Tune the code for a particular microarchitecture, within the
12796 constraints set by @option{-march} and @option{-mcpu}.
12797 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12798 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12799 and @samp{cpu32}.  The ColdFire microarchitectures
12800 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12802 You can also use @option{-mtune=68020-40} for code that needs
12803 to run relatively well on 68020, 68030 and 68040 targets.
12804 @option{-mtune=68020-60} is similar but includes 68060 targets
12805 as well.  These two options select the same tuning decisions as
12806 @option{-m68020-40} and @option{-m68020-60} respectively.
12808 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12809 when tuning for 680x0 architecture @var{arch}.  It also defines
12810 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12811 option is used.  If gcc is tuning for a range of architectures,
12812 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12813 it defines the macros for every architecture in the range.
12815 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12816 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12817 of the arguments given above.
12819 @item -m68000
12820 @itemx -mc68000
12821 @opindex m68000
12822 @opindex mc68000
12823 Generate output for a 68000.  This is the default
12824 when the compiler is configured for 68000-based systems.
12825 It is equivalent to @option{-march=68000}.
12827 Use this option for microcontrollers with a 68000 or EC000 core,
12828 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12830 @item -m68010
12831 @opindex m68010
12832 Generate output for a 68010.  This is the default
12833 when the compiler is configured for 68010-based systems.
12834 It is equivalent to @option{-march=68010}.
12836 @item -m68020
12837 @itemx -mc68020
12838 @opindex m68020
12839 @opindex mc68020
12840 Generate output for a 68020.  This is the default
12841 when the compiler is configured for 68020-based systems.
12842 It is equivalent to @option{-march=68020}.
12844 @item -m68030
12845 @opindex m68030
12846 Generate output for a 68030.  This is the default when the compiler is
12847 configured for 68030-based systems.  It is equivalent to
12848 @option{-march=68030}.
12850 @item -m68040
12851 @opindex m68040
12852 Generate output for a 68040.  This is the default when the compiler is
12853 configured for 68040-based systems.  It is equivalent to
12854 @option{-march=68040}.
12856 This option inhibits the use of 68881/68882 instructions that have to be
12857 emulated by software on the 68040.  Use this option if your 68040 does not
12858 have code to emulate those instructions.
12860 @item -m68060
12861 @opindex m68060
12862 Generate output for a 68060.  This is the default when the compiler is
12863 configured for 68060-based systems.  It is equivalent to
12864 @option{-march=68060}.
12866 This option inhibits the use of 68020 and 68881/68882 instructions that
12867 have to be emulated by software on the 68060.  Use this option if your 68060
12868 does not have code to emulate those instructions.
12870 @item -mcpu32
12871 @opindex mcpu32
12872 Generate output for a CPU32.  This is the default
12873 when the compiler is configured for CPU32-based systems.
12874 It is equivalent to @option{-march=cpu32}.
12876 Use this option for microcontrollers with a
12877 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
12878 68336, 68340, 68341, 68349 and 68360.
12880 @item -m5200
12881 @opindex m5200
12882 Generate output for a 520X ColdFire CPU@.  This is the default
12883 when the compiler is configured for 520X-based systems.
12884 It is equivalent to @option{-mcpu=5206}, and is now deprecated
12885 in favor of that option.
12887 Use this option for microcontroller with a 5200 core, including
12888 the MCF5202, MCF5203, MCF5204 and MCF5206.
12890 @item -m5206e
12891 @opindex m5206e
12892 Generate output for a 5206e ColdFire CPU@.  The option is now
12893 deprecated in favor of the equivalent @option{-mcpu=5206e}.
12895 @item -m528x
12896 @opindex m528x
12897 Generate output for a member of the ColdFire 528X family.
12898 The option is now deprecated in favor of the equivalent
12899 @option{-mcpu=528x}.
12901 @item -m5307
12902 @opindex m5307
12903 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
12904 in favor of the equivalent @option{-mcpu=5307}.
12906 @item -m5407
12907 @opindex m5407
12908 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
12909 in favor of the equivalent @option{-mcpu=5407}.
12911 @item -mcfv4e
12912 @opindex mcfv4e
12913 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
12914 This includes use of hardware floating point instructions.
12915 The option is equivalent to @option{-mcpu=547x}, and is now
12916 deprecated in favor of that option.
12918 @item -m68020-40
12919 @opindex m68020-40
12920 Generate output for a 68040, without using any of the new instructions.
12921 This results in code which can run relatively efficiently on either a
12922 68020/68881 or a 68030 or a 68040.  The generated code does use the
12923 68881 instructions that are emulated on the 68040.
12925 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
12927 @item -m68020-60
12928 @opindex m68020-60
12929 Generate output for a 68060, without using any of the new instructions.
12930 This results in code which can run relatively efficiently on either a
12931 68020/68881 or a 68030 or a 68040.  The generated code does use the
12932 68881 instructions that are emulated on the 68060.
12934 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
12936 @item -mhard-float
12937 @itemx -m68881
12938 @opindex mhard-float
12939 @opindex m68881
12940 Generate floating-point instructions.  This is the default for 68020
12941 and above, and for ColdFire devices that have an FPU@.  It defines the
12942 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
12943 on ColdFire targets.
12945 @item -msoft-float
12946 @opindex msoft-float
12947 Do not generate floating-point instructions; use library calls instead.
12948 This is the default for 68000, 68010, and 68832 targets.  It is also
12949 the default for ColdFire devices that have no FPU.
12951 @item -mdiv
12952 @itemx -mno-div
12953 @opindex mdiv
12954 @opindex mno-div
12955 Generate (do not generate) ColdFire hardware divide and remainder
12956 instructions.  If @option{-march} is used without @option{-mcpu},
12957 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
12958 architectures.  Otherwise, the default is taken from the target CPU
12959 (either the default CPU, or the one specified by @option{-mcpu}).  For
12960 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
12961 @option{-mcpu=5206e}.
12963 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
12965 @item -mshort
12966 @opindex mshort
12967 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12968 Additionally, parameters passed on the stack are also aligned to a
12969 16-bit boundary even on targets whose API mandates promotion to 32-bit.
12971 @item -mno-short
12972 @opindex mno-short
12973 Do not consider type @code{int} to be 16 bits wide.  This is the default.
12975 @item -mnobitfield
12976 @itemx -mno-bitfield
12977 @opindex mnobitfield
12978 @opindex mno-bitfield
12979 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
12980 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
12982 @item -mbitfield
12983 @opindex mbitfield
12984 Do use the bit-field instructions.  The @option{-m68020} option implies
12985 @option{-mbitfield}.  This is the default if you use a configuration
12986 designed for a 68020.
12988 @item -mrtd
12989 @opindex mrtd
12990 Use a different function-calling convention, in which functions
12991 that take a fixed number of arguments return with the @code{rtd}
12992 instruction, which pops their arguments while returning.  This
12993 saves one instruction in the caller since there is no need to pop
12994 the arguments there.
12996 This calling convention is incompatible with the one normally
12997 used on Unix, so you cannot use it if you need to call libraries
12998 compiled with the Unix compiler.
13000 Also, you must provide function prototypes for all functions that
13001 take variable numbers of arguments (including @code{printf});
13002 otherwise incorrect code will be generated for calls to those
13003 functions.
13005 In addition, seriously incorrect code will result if you call a
13006 function with too many arguments.  (Normally, extra arguments are
13007 harmlessly ignored.)
13009 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13010 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13012 @item -mno-rtd
13013 @opindex mno-rtd
13014 Do not use the calling conventions selected by @option{-mrtd}.
13015 This is the default.
13017 @item -malign-int
13018 @itemx -mno-align-int
13019 @opindex malign-int
13020 @opindex mno-align-int
13021 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13022 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13023 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13024 Aligning variables on 32-bit boundaries produces code that runs somewhat
13025 faster on processors with 32-bit busses at the expense of more memory.
13027 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13028 align structures containing the above types  differently than
13029 most published application binary interface specifications for the m68k.
13031 @item -mpcrel
13032 @opindex mpcrel
13033 Use the pc-relative addressing mode of the 68000 directly, instead of
13034 using a global offset table.  At present, this option implies @option{-fpic},
13035 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13036 not presently supported with @option{-mpcrel}, though this could be supported for
13037 68020 and higher processors.
13039 @item -mno-strict-align
13040 @itemx -mstrict-align
13041 @opindex mno-strict-align
13042 @opindex mstrict-align
13043 Do not (do) assume that unaligned memory references will be handled by
13044 the system.
13046 @item -msep-data
13047 Generate code that allows the data segment to be located in a different
13048 area of memory from the text segment.  This allows for execute in place in
13049 an environment without virtual memory management.  This option implies
13050 @option{-fPIC}.
13052 @item -mno-sep-data
13053 Generate code that assumes that the data segment follows the text segment.
13054 This is the default.
13056 @item -mid-shared-library
13057 Generate code that supports shared libraries via the library ID method.
13058 This allows for execute in place and shared libraries in an environment
13059 without virtual memory management.  This option implies @option{-fPIC}.
13061 @item -mno-id-shared-library
13062 Generate code that doesn't assume ID based shared libraries are being used.
13063 This is the default.
13065 @item -mshared-library-id=n
13066 Specified the identification number of the ID based shared library being
13067 compiled.  Specifying a value of 0 will generate more compact code, specifying
13068 other values will force the allocation of that number to the current
13069 library but is no more space or time efficient than omitting this option.
13071 @item -mxgot
13072 @itemx -mno-xgot
13073 @opindex mxgot
13074 @opindex mno-xgot
13075 When generating position-independent code for ColdFire, generate code
13076 that works if the GOT has more than 8192 entries.  This code is
13077 larger and slower than code generated without this option.  On M680x0
13078 processors, this option is not needed; @option{-fPIC} suffices.
13080 GCC normally uses a single instruction to load values from the GOT@.
13081 While this is relatively efficient, it only works if the GOT
13082 is smaller than about 64k.  Anything larger causes the linker
13083 to report an error such as:
13085 @cindex relocation truncated to fit (ColdFire)
13086 @smallexample
13087 relocation truncated to fit: R_68K_GOT16O foobar
13088 @end smallexample
13090 If this happens, you should recompile your code with @option{-mxgot}.
13091 It should then work with very large GOTs.  However, code generated with
13092 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13093 the value of a global symbol.
13095 Note that some linkers, including newer versions of the GNU linker,
13096 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13097 you should only need to use @option{-mxgot} when compiling a single
13098 object file that accesses more than 8192 GOT entries.  Very few do.
13100 These options have no effect unless GCC is generating
13101 position-independent code.
13103 @end table
13105 @node M68hc1x Options
13106 @subsection M68hc1x Options
13107 @cindex M68hc1x options
13109 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13110 microcontrollers.  The default values for these options depends on
13111 which style of microcontroller was selected when the compiler was configured;
13112 the defaults for the most common choices are given below.
13114 @table @gcctabopt
13115 @item -m6811
13116 @itemx -m68hc11
13117 @opindex m6811
13118 @opindex m68hc11
13119 Generate output for a 68HC11.  This is the default
13120 when the compiler is configured for 68HC11-based systems.
13122 @item -m6812
13123 @itemx -m68hc12
13124 @opindex m6812
13125 @opindex m68hc12
13126 Generate output for a 68HC12.  This is the default
13127 when the compiler is configured for 68HC12-based systems.
13129 @item -m68S12
13130 @itemx -m68hcs12
13131 @opindex m68S12
13132 @opindex m68hcs12
13133 Generate output for a 68HCS12.
13135 @item -mauto-incdec
13136 @opindex mauto-incdec
13137 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13138 addressing modes.
13140 @item -minmax
13141 @itemx -mnominmax
13142 @opindex minmax
13143 @opindex mnominmax
13144 Enable the use of 68HC12 min and max instructions.
13146 @item -mlong-calls
13147 @itemx -mno-long-calls
13148 @opindex mlong-calls
13149 @opindex mno-long-calls
13150 Treat all calls as being far away (near).  If calls are assumed to be
13151 far away, the compiler will use the @code{call} instruction to
13152 call a function and the @code{rtc} instruction for returning.
13154 @item -mshort
13155 @opindex mshort
13156 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13158 @item -msoft-reg-count=@var{count}
13159 @opindex msoft-reg-count
13160 Specify the number of pseudo-soft registers which are used for the
13161 code generation.  The maximum number is 32.  Using more pseudo-soft
13162 register may or may not result in better code depending on the program.
13163 The default is 4 for 68HC11 and 2 for 68HC12.
13165 @end table
13167 @node MCore Options
13168 @subsection MCore Options
13169 @cindex MCore options
13171 These are the @samp{-m} options defined for the Motorola M*Core
13172 processors.
13174 @table @gcctabopt
13176 @item -mhardlit
13177 @itemx -mno-hardlit
13178 @opindex mhardlit
13179 @opindex mno-hardlit
13180 Inline constants into the code stream if it can be done in two
13181 instructions or less.
13183 @item -mdiv
13184 @itemx -mno-div
13185 @opindex mdiv
13186 @opindex mno-div
13187 Use the divide instruction.  (Enabled by default).
13189 @item -mrelax-immediate
13190 @itemx -mno-relax-immediate
13191 @opindex mrelax-immediate
13192 @opindex mno-relax-immediate
13193 Allow arbitrary sized immediates in bit operations.
13195 @item -mwide-bitfields
13196 @itemx -mno-wide-bitfields
13197 @opindex mwide-bitfields
13198 @opindex mno-wide-bitfields
13199 Always treat bit-fields as int-sized.
13201 @item -m4byte-functions
13202 @itemx -mno-4byte-functions
13203 @opindex m4byte-functions
13204 @opindex mno-4byte-functions
13205 Force all functions to be aligned to a four byte boundary.
13207 @item -mcallgraph-data
13208 @itemx -mno-callgraph-data
13209 @opindex mcallgraph-data
13210 @opindex mno-callgraph-data
13211 Emit callgraph information.
13213 @item -mslow-bytes
13214 @itemx -mno-slow-bytes
13215 @opindex mslow-bytes
13216 @opindex mno-slow-bytes
13217 Prefer word access when reading byte quantities.
13219 @item -mlittle-endian
13220 @itemx -mbig-endian
13221 @opindex mlittle-endian
13222 @opindex mbig-endian
13223 Generate code for a little endian target.
13225 @item -m210
13226 @itemx -m340
13227 @opindex m210
13228 @opindex m340
13229 Generate code for the 210 processor.
13231 @item -mno-lsim
13232 @opindex mno-lsim
13233 Assume that run-time support has been provided and so omit the
13234 simulator library (@file{libsim.a)} from the linker command line.
13236 @item -mstack-increment=@var{size}
13237 @opindex mstack-increment
13238 Set the maximum amount for a single stack increment operation.  Large
13239 values can increase the speed of programs which contain functions
13240 that need a large amount of stack space, but they can also trigger a
13241 segmentation fault if the stack is extended too much.  The default
13242 value is 0x1000.
13244 @end table
13246 @node MeP Options
13247 @subsection MeP Options
13248 @cindex MeP options
13250 @table @gcctabopt
13252 @item -mabsdiff
13253 @opindex mabsdiff
13254 Enables the @code{abs} instruction, which is the absolute difference
13255 between two registers.
13257 @item -mall-opts
13258 @opindex mall-opts
13259 Enables all the optional instructions - average, multiply, divide, bit
13260 operations, leading zero, absolute difference, min/max, clip, and
13261 saturation.
13264 @item -maverage
13265 @opindex maverage
13266 Enables the @code{ave} instruction, which computes the average of two
13267 registers.
13269 @item -mbased=@var{n}
13270 @opindex mbased=
13271 Variables of size @var{n} bytes or smaller will be placed in the
13272 @code{.based} section by default.  Based variables use the @code{$tp}
13273 register as a base register, and there is a 128 byte limit to the
13274 @code{.based} section.
13276 @item -mbitops
13277 @opindex mbitops
13278 Enables the bit operation instructions - bit test (@code{btstm}), set
13279 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13280 test-and-set (@code{tas}).
13282 @item -mc=@var{name}
13283 @opindex mc=
13284 Selects which section constant data will be placed in.  @var{name} may
13285 be @code{tiny}, @code{near}, or @code{far}.
13287 @item -mclip
13288 @opindex mclip
13289 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13290 useful unless you also provide @code{-mminmax}.
13292 @item -mconfig=@var{name}
13293 @opindex mconfig=
13294 Selects one of the build-in core configurations.  Each MeP chip has
13295 one or more modules in it; each module has a core CPU and a variety of
13296 coprocessors, optional instructions, and peripherals.  The
13297 @code{MeP-Integrator} tool, not part of GCC, provides these
13298 configurations through this option; using this option is the same as
13299 using all the corresponding command line options.  The default
13300 configuration is @code{default}.
13302 @item -mcop
13303 @opindex mcop
13304 Enables the coprocessor instructions.  By default, this is a 32-bit
13305 coprocessor.  Note that the coprocessor is normally enabled via the
13306 @code{-mconfig=} option.
13308 @item -mcop32
13309 @opindex mcop32
13310 Enables the 32-bit coprocessor's instructions.
13312 @item -mcop64
13313 @opindex mcop64
13314 Enables the 64-bit coprocessor's instructions.
13316 @item -mivc2
13317 @opindex mivc2
13318 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13320 @item -mdc
13321 @opindex mdc
13322 Causes constant variables to be placed in the @code{.near} section.
13324 @item -mdiv
13325 @opindex mdiv
13326 Enables the @code{div} and @code{divu} instructions.
13328 @item -meb
13329 @opindex meb
13330 Generate big-endian code.
13332 @item -mel
13333 @opindex mel
13334 Generate little-endian code.
13336 @item -mio-volatile
13337 @opindex mio-volatile
13338 Tells the compiler that any variable marked with the @code{io}
13339 attribute is to be considered volatile.
13341 @item -ml
13342 @opindex ml
13343 Causes variables to be assigned to the @code{.far} section by default.
13345 @item -mleadz
13346 @opindex mleadz
13347 Enables the @code{leadz} (leading zero) instruction.
13349 @item -mm
13350 @opindex mm
13351 Causes variables to be assigned to the @code{.near} section by default.
13353 @item -mminmax
13354 @opindex mminmax
13355 Enables the @code{min} and @code{max} instructions.
13357 @item -mmult
13358 @opindex mmult
13359 Enables the multiplication and multiply-accumulate instructions.
13361 @item -mno-opts
13362 @opindex mno-opts
13363 Disables all the optional instructions enabled by @code{-mall-opts}.
13365 @item -mrepeat
13366 @opindex mrepeat
13367 Enables the @code{repeat} and @code{erepeat} instructions, used for
13368 low-overhead looping.
13370 @item -ms
13371 @opindex ms
13372 Causes all variables to default to the @code{.tiny} section.  Note
13373 that there is a 65536 byte limit to this section.  Accesses to these
13374 variables use the @code{%gp} base register.
13376 @item -msatur
13377 @opindex msatur
13378 Enables the saturation instructions.  Note that the compiler does not
13379 currently generate these itself, but this option is included for
13380 compatibility with other tools, like @code{as}.
13382 @item -msdram
13383 @opindex msdram
13384 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13386 @item -msim
13387 @opindex msim
13388 Link the simulator runtime libraries.
13390 @item -msimnovec
13391 @opindex msimnovec
13392 Link the simulator runtime libraries, excluding built-in support
13393 for reset and exception vectors and tables.
13395 @item -mtf
13396 @opindex mtf
13397 Causes all functions to default to the @code{.far} section.  Without
13398 this option, functions default to the @code{.near} section.
13400 @item -mtiny=@var{n}
13401 @opindex mtiny=
13402 Variables that are @var{n} bytes or smaller will be allocated to the
13403 @code{.tiny} section.  These variables use the @code{$gp} base
13404 register.  The default for this option is 4, but note that there's a
13405 65536 byte limit to the @code{.tiny} section.
13407 @end table
13409 @node MIPS Options
13410 @subsection MIPS Options
13411 @cindex MIPS options
13413 @table @gcctabopt
13415 @item -EB
13416 @opindex EB
13417 Generate big-endian code.
13419 @item -EL
13420 @opindex EL
13421 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13422 configurations.
13424 @item -march=@var{arch}
13425 @opindex march
13426 Generate code that will run on @var{arch}, which can be the name of a
13427 generic MIPS ISA, or the name of a particular processor.
13428 The ISA names are:
13429 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13430 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13431 The processor names are:
13432 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13433 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13434 @samp{5kc}, @samp{5kf},
13435 @samp{20kc},
13436 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13437 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13438 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13439 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13440 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13441 @samp{loongson2e}, @samp{loongson2f},
13442 @samp{m4k},
13443 @samp{octeon},
13444 @samp{orion},
13445 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13446 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13447 @samp{rm7000}, @samp{rm9000},
13448 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13449 @samp{sb1},
13450 @samp{sr71000},
13451 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13452 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13453 and @samp{xlr}.
13454 The special value @samp{from-abi} selects the
13455 most compatible architecture for the selected ABI (that is,
13456 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13458 Native Linux/GNU toolchains also support the value @samp{native},
13459 which selects the best architecture option for the host processor.
13460 @option{-march=native} has no effect if GCC does not recognize
13461 the processor.
13463 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13464 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13465 @samp{vr} may be written @samp{r}.
13467 Names of the form @samp{@var{n}f2_1} refer to processors with
13468 FPUs clocked at half the rate of the core, names of the form
13469 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13470 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13471 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13472 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13473 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13474 accepted as synonyms for @samp{@var{n}f1_1}.
13476 GCC defines two macros based on the value of this option.  The first
13477 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13478 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13479 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13480 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13481 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13483 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13484 above.  In other words, it will have the full prefix and will not
13485 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13486 the macro names the resolved architecture (either @samp{"mips1"} or
13487 @samp{"mips3"}).  It names the default architecture when no
13488 @option{-march} option is given.
13490 @item -mtune=@var{arch}
13491 @opindex mtune
13492 Optimize for @var{arch}.  Among other things, this option controls
13493 the way instructions are scheduled, and the perceived cost of arithmetic
13494 operations.  The list of @var{arch} values is the same as for
13495 @option{-march}.
13497 When this option is not used, GCC will optimize for the processor
13498 specified by @option{-march}.  By using @option{-march} and
13499 @option{-mtune} together, it is possible to generate code that will
13500 run on a family of processors, but optimize the code for one
13501 particular member of that family.
13503 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13504 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13505 @samp{-march} ones described above.
13507 @item -mips1
13508 @opindex mips1
13509 Equivalent to @samp{-march=mips1}.
13511 @item -mips2
13512 @opindex mips2
13513 Equivalent to @samp{-march=mips2}.
13515 @item -mips3
13516 @opindex mips3
13517 Equivalent to @samp{-march=mips3}.
13519 @item -mips4
13520 @opindex mips4
13521 Equivalent to @samp{-march=mips4}.
13523 @item -mips32
13524 @opindex mips32
13525 Equivalent to @samp{-march=mips32}.
13527 @item -mips32r2
13528 @opindex mips32r2
13529 Equivalent to @samp{-march=mips32r2}.
13531 @item -mips64
13532 @opindex mips64
13533 Equivalent to @samp{-march=mips64}.
13535 @item -mips64r2
13536 @opindex mips64r2
13537 Equivalent to @samp{-march=mips64r2}.
13539 @item -mips16
13540 @itemx -mno-mips16
13541 @opindex mips16
13542 @opindex mno-mips16
13543 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13544 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13546 MIPS16 code generation can also be controlled on a per-function basis
13547 by means of @code{mips16} and @code{nomips16} attributes.
13548 @xref{Function Attributes}, for more information.
13550 @item -mflip-mips16
13551 @opindex mflip-mips16
13552 Generate MIPS16 code on alternating functions.  This option is provided
13553 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13554 not intended for ordinary use in compiling user code.
13556 @item -minterlink-mips16
13557 @itemx -mno-interlink-mips16
13558 @opindex minterlink-mips16
13559 @opindex mno-interlink-mips16
13560 Require (do not require) that non-MIPS16 code be link-compatible with
13561 MIPS16 code.
13563 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13564 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13565 therefore disables direct jumps unless GCC knows that the target of the
13566 jump is not MIPS16.
13568 @item -mabi=32
13569 @itemx -mabi=o64
13570 @itemx -mabi=n32
13571 @itemx -mabi=64
13572 @itemx -mabi=eabi
13573 @opindex mabi=32
13574 @opindex mabi=o64
13575 @opindex mabi=n32
13576 @opindex mabi=64
13577 @opindex mabi=eabi
13578 Generate code for the given ABI@.
13580 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13581 generates 64-bit code when you select a 64-bit architecture, but you
13582 can use @option{-mgp32} to get 32-bit code instead.
13584 For information about the O64 ABI, see
13585 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13587 GCC supports a variant of the o32 ABI in which floating-point registers
13588 are 64 rather than 32 bits wide.  You can select this combination with
13589 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13590 and @samp{mfhc1} instructions and is therefore only supported for
13591 MIPS32R2 processors.
13593 The register assignments for arguments and return values remain the
13594 same, but each scalar value is passed in a single 64-bit register
13595 rather than a pair of 32-bit registers.  For example, scalar
13596 floating-point values are returned in @samp{$f0} only, not a
13597 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13598 remains the same, but all 64 bits are saved.
13600 @item -mabicalls
13601 @itemx -mno-abicalls
13602 @opindex mabicalls
13603 @opindex mno-abicalls
13604 Generate (do not generate) code that is suitable for SVR4-style
13605 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13606 systems.
13608 @item -mshared
13609 @itemx -mno-shared
13610 Generate (do not generate) code that is fully position-independent,
13611 and that can therefore be linked into shared libraries.  This option
13612 only affects @option{-mabicalls}.
13614 All @option{-mabicalls} code has traditionally been position-independent,
13615 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13616 as an extension, the GNU toolchain allows executables to use absolute
13617 accesses for locally-binding symbols.  It can also use shorter GP
13618 initialization sequences and generate direct calls to locally-defined
13619 functions.  This mode is selected by @option{-mno-shared}.
13621 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13622 objects that can only be linked by the GNU linker.  However, the option
13623 does not affect the ABI of the final executable; it only affects the ABI
13624 of relocatable objects.  Using @option{-mno-shared} will generally make
13625 executables both smaller and quicker.
13627 @option{-mshared} is the default.
13629 @item -mplt
13630 @itemx -mno-plt
13631 @opindex mplt
13632 @opindex mno-plt
13633 Assume (do not assume) that the static and dynamic linkers
13634 support PLTs and copy relocations.  This option only affects
13635 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13636 has no effect without @samp{-msym32}.
13638 You can make @option{-mplt} the default by configuring
13639 GCC with @option{--with-mips-plt}.  The default is
13640 @option{-mno-plt} otherwise.
13642 @item -mxgot
13643 @itemx -mno-xgot
13644 @opindex mxgot
13645 @opindex mno-xgot
13646 Lift (do not lift) the usual restrictions on the size of the global
13647 offset table.
13649 GCC normally uses a single instruction to load values from the GOT@.
13650 While this is relatively efficient, it will only work if the GOT
13651 is smaller than about 64k.  Anything larger will cause the linker
13652 to report an error such as:
13654 @cindex relocation truncated to fit (MIPS)
13655 @smallexample
13656 relocation truncated to fit: R_MIPS_GOT16 foobar
13657 @end smallexample
13659 If this happens, you should recompile your code with @option{-mxgot}.
13660 It should then work with very large GOTs, although it will also be
13661 less efficient, since it will take three instructions to fetch the
13662 value of a global symbol.
13664 Note that some linkers can create multiple GOTs.  If you have such a
13665 linker, you should only need to use @option{-mxgot} when a single object
13666 file accesses more than 64k's worth of GOT entries.  Very few do.
13668 These options have no effect unless GCC is generating position
13669 independent code.
13671 @item -mgp32
13672 @opindex mgp32
13673 Assume that general-purpose registers are 32 bits wide.
13675 @item -mgp64
13676 @opindex mgp64
13677 Assume that general-purpose registers are 64 bits wide.
13679 @item -mfp32
13680 @opindex mfp32
13681 Assume that floating-point registers are 32 bits wide.
13683 @item -mfp64
13684 @opindex mfp64
13685 Assume that floating-point registers are 64 bits wide.
13687 @item -mhard-float
13688 @opindex mhard-float
13689 Use floating-point coprocessor instructions.
13691 @item -msoft-float
13692 @opindex msoft-float
13693 Do not use floating-point coprocessor instructions.  Implement
13694 floating-point calculations using library calls instead.
13696 @item -msingle-float
13697 @opindex msingle-float
13698 Assume that the floating-point coprocessor only supports single-precision
13699 operations.
13701 @item -mdouble-float
13702 @opindex mdouble-float
13703 Assume that the floating-point coprocessor supports double-precision
13704 operations.  This is the default.
13706 @item -mllsc
13707 @itemx -mno-llsc
13708 @opindex mllsc
13709 @opindex mno-llsc
13710 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13711 implement atomic memory built-in functions.  When neither option is
13712 specified, GCC will use the instructions if the target architecture
13713 supports them.
13715 @option{-mllsc} is useful if the runtime environment can emulate the
13716 instructions and @option{-mno-llsc} can be useful when compiling for
13717 nonstandard ISAs.  You can make either option the default by
13718 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13719 respectively.  @option{--with-llsc} is the default for some
13720 configurations; see the installation documentation for details.
13722 @item -mdsp
13723 @itemx -mno-dsp
13724 @opindex mdsp
13725 @opindex mno-dsp
13726 Use (do not use) revision 1 of the MIPS DSP ASE@.
13727 @xref{MIPS DSP Built-in Functions}.  This option defines the
13728 preprocessor macro @samp{__mips_dsp}.  It also defines
13729 @samp{__mips_dsp_rev} to 1.
13731 @item -mdspr2
13732 @itemx -mno-dspr2
13733 @opindex mdspr2
13734 @opindex mno-dspr2
13735 Use (do not use) revision 2 of the MIPS DSP ASE@.
13736 @xref{MIPS DSP Built-in Functions}.  This option defines the
13737 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13738 It also defines @samp{__mips_dsp_rev} to 2.
13740 @item -msmartmips
13741 @itemx -mno-smartmips
13742 @opindex msmartmips
13743 @opindex mno-smartmips
13744 Use (do not use) the MIPS SmartMIPS ASE.
13746 @item -mpaired-single
13747 @itemx -mno-paired-single
13748 @opindex mpaired-single
13749 @opindex mno-paired-single
13750 Use (do not use) paired-single floating-point instructions.
13751 @xref{MIPS Paired-Single Support}.  This option requires
13752 hardware floating-point support to be enabled.
13754 @item -mdmx
13755 @itemx -mno-mdmx
13756 @opindex mdmx
13757 @opindex mno-mdmx
13758 Use (do not use) MIPS Digital Media Extension instructions.
13759 This option can only be used when generating 64-bit code and requires
13760 hardware floating-point support to be enabled.
13762 @item -mips3d
13763 @itemx -mno-mips3d
13764 @opindex mips3d
13765 @opindex mno-mips3d
13766 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13767 The option @option{-mips3d} implies @option{-mpaired-single}.
13769 @item -mmt
13770 @itemx -mno-mt
13771 @opindex mmt
13772 @opindex mno-mt
13773 Use (do not use) MT Multithreading instructions.
13775 @item -mlong64
13776 @opindex mlong64
13777 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13778 an explanation of the default and the way that the pointer size is
13779 determined.
13781 @item -mlong32
13782 @opindex mlong32
13783 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13785 The default size of @code{int}s, @code{long}s and pointers depends on
13786 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13787 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13788 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13789 or the same size as integer registers, whichever is smaller.
13791 @item -msym32
13792 @itemx -mno-sym32
13793 @opindex msym32
13794 @opindex mno-sym32
13795 Assume (do not assume) that all symbols have 32-bit values, regardless
13796 of the selected ABI@.  This option is useful in combination with
13797 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13798 to generate shorter and faster references to symbolic addresses.
13800 @item -G @var{num}
13801 @opindex G
13802 Put definitions of externally-visible data in a small data section
13803 if that data is no bigger than @var{num} bytes.  GCC can then access
13804 the data more efficiently; see @option{-mgpopt} for details.
13806 The default @option{-G} option depends on the configuration.
13808 @item -mlocal-sdata
13809 @itemx -mno-local-sdata
13810 @opindex mlocal-sdata
13811 @opindex mno-local-sdata
13812 Extend (do not extend) the @option{-G} behavior to local data too,
13813 such as to static variables in C@.  @option{-mlocal-sdata} is the
13814 default for all configurations.
13816 If the linker complains that an application is using too much small data,
13817 you might want to try rebuilding the less performance-critical parts with
13818 @option{-mno-local-sdata}.  You might also want to build large
13819 libraries with @option{-mno-local-sdata}, so that the libraries leave
13820 more room for the main program.
13822 @item -mextern-sdata
13823 @itemx -mno-extern-sdata
13824 @opindex mextern-sdata
13825 @opindex mno-extern-sdata
13826 Assume (do not assume) that externally-defined data will be in
13827 a small data section if that data is within the @option{-G} limit.
13828 @option{-mextern-sdata} is the default for all configurations.
13830 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13831 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13832 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
13833 is placed in a small data section.  If @var{Var} is defined by another
13834 module, you must either compile that module with a high-enough
13835 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
13836 definition.  If @var{Var} is common, you must link the application
13837 with a high-enough @option{-G} setting.
13839 The easiest way of satisfying these restrictions is to compile
13840 and link every module with the same @option{-G} option.  However,
13841 you may wish to build a library that supports several different
13842 small data limits.  You can do this by compiling the library with
13843 the highest supported @option{-G} setting and additionally using
13844 @option{-mno-extern-sdata} to stop the library from making assumptions
13845 about externally-defined data.
13847 @item -mgpopt
13848 @itemx -mno-gpopt
13849 @opindex mgpopt
13850 @opindex mno-gpopt
13851 Use (do not use) GP-relative accesses for symbols that are known to be
13852 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
13853 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
13854 configurations.
13856 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
13857 might not hold the value of @code{_gp}.  For example, if the code is
13858 part of a library that might be used in a boot monitor, programs that
13859 call boot monitor routines will pass an unknown value in @code{$gp}.
13860 (In such situations, the boot monitor itself would usually be compiled
13861 with @option{-G0}.)
13863 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
13864 @option{-mno-extern-sdata}.
13866 @item -membedded-data
13867 @itemx -mno-embedded-data
13868 @opindex membedded-data
13869 @opindex mno-embedded-data
13870 Allocate variables to the read-only data section first if possible, then
13871 next in the small data section if possible, otherwise in data.  This gives
13872 slightly slower code than the default, but reduces the amount of RAM required
13873 when executing, and thus may be preferred for some embedded systems.
13875 @item -muninit-const-in-rodata
13876 @itemx -mno-uninit-const-in-rodata
13877 @opindex muninit-const-in-rodata
13878 @opindex mno-uninit-const-in-rodata
13879 Put uninitialized @code{const} variables in the read-only data section.
13880 This option is only meaningful in conjunction with @option{-membedded-data}.
13882 @item -mcode-readable=@var{setting}
13883 @opindex mcode-readable
13884 Specify whether GCC may generate code that reads from executable sections.
13885 There are three possible settings:
13887 @table @gcctabopt
13888 @item -mcode-readable=yes
13889 Instructions may freely access executable sections.  This is the
13890 default setting.
13892 @item -mcode-readable=pcrel
13893 MIPS16 PC-relative load instructions can access executable sections,
13894 but other instructions must not do so.  This option is useful on 4KSc
13895 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
13896 It is also useful on processors that can be configured to have a dual
13897 instruction/data SRAM interface and that, like the M4K, automatically
13898 redirect PC-relative loads to the instruction RAM.
13900 @item -mcode-readable=no
13901 Instructions must not access executable sections.  This option can be
13902 useful on targets that are configured to have a dual instruction/data
13903 SRAM interface but that (unlike the M4K) do not automatically redirect
13904 PC-relative loads to the instruction RAM.
13905 @end table
13907 @item -msplit-addresses
13908 @itemx -mno-split-addresses
13909 @opindex msplit-addresses
13910 @opindex mno-split-addresses
13911 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
13912 relocation operators.  This option has been superseded by
13913 @option{-mexplicit-relocs} but is retained for backwards compatibility.
13915 @item -mexplicit-relocs
13916 @itemx -mno-explicit-relocs
13917 @opindex mexplicit-relocs
13918 @opindex mno-explicit-relocs
13919 Use (do not use) assembler relocation operators when dealing with symbolic
13920 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
13921 is to use assembler macros instead.
13923 @option{-mexplicit-relocs} is the default if GCC was configured
13924 to use an assembler that supports relocation operators.
13926 @item -mcheck-zero-division
13927 @itemx -mno-check-zero-division
13928 @opindex mcheck-zero-division
13929 @opindex mno-check-zero-division
13930 Trap (do not trap) on integer division by zero.
13932 The default is @option{-mcheck-zero-division}.
13934 @item -mdivide-traps
13935 @itemx -mdivide-breaks
13936 @opindex mdivide-traps
13937 @opindex mdivide-breaks
13938 MIPS systems check for division by zero by generating either a
13939 conditional trap or a break instruction.  Using traps results in
13940 smaller code, but is only supported on MIPS II and later.  Also, some
13941 versions of the Linux kernel have a bug that prevents trap from
13942 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
13943 allow conditional traps on architectures that support them and
13944 @option{-mdivide-breaks} to force the use of breaks.
13946 The default is usually @option{-mdivide-traps}, but this can be
13947 overridden at configure time using @option{--with-divide=breaks}.
13948 Divide-by-zero checks can be completely disabled using
13949 @option{-mno-check-zero-division}.
13951 @item -mmemcpy
13952 @itemx -mno-memcpy
13953 @opindex mmemcpy
13954 @opindex mno-memcpy
13955 Force (do not force) the use of @code{memcpy()} for non-trivial block
13956 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
13957 most constant-sized copies.
13959 @item -mlong-calls
13960 @itemx -mno-long-calls
13961 @opindex mlong-calls
13962 @opindex mno-long-calls
13963 Disable (do not disable) use of the @code{jal} instruction.  Calling
13964 functions using @code{jal} is more efficient but requires the caller
13965 and callee to be in the same 256 megabyte segment.
13967 This option has no effect on abicalls code.  The default is
13968 @option{-mno-long-calls}.
13970 @item -mmad
13971 @itemx -mno-mad
13972 @opindex mmad
13973 @opindex mno-mad
13974 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
13975 instructions, as provided by the R4650 ISA@.
13977 @item -mfused-madd
13978 @itemx -mno-fused-madd
13979 @opindex mfused-madd
13980 @opindex mno-fused-madd
13981 Enable (disable) use of the floating point multiply-accumulate
13982 instructions, when they are available.  The default is
13983 @option{-mfused-madd}.
13985 When multiply-accumulate instructions are used, the intermediate
13986 product is calculated to infinite precision and is not subject to
13987 the FCSR Flush to Zero bit.  This may be undesirable in some
13988 circumstances.
13990 @item -nocpp
13991 @opindex nocpp
13992 Tell the MIPS assembler to not run its preprocessor over user
13993 assembler files (with a @samp{.s} suffix) when assembling them.
13995 @item -mfix-r4000
13996 @itemx -mno-fix-r4000
13997 @opindex mfix-r4000
13998 @opindex mno-fix-r4000
13999 Work around certain R4000 CPU errata:
14000 @itemize @minus
14001 @item
14002 A double-word or a variable shift may give an incorrect result if executed
14003 immediately after starting an integer division.
14004 @item
14005 A double-word or a variable shift may give an incorrect result if executed
14006 while an integer multiplication is in progress.
14007 @item
14008 An integer division may give an incorrect result if started in a delay slot
14009 of a taken branch or a jump.
14010 @end itemize
14012 @item -mfix-r4400
14013 @itemx -mno-fix-r4400
14014 @opindex mfix-r4400
14015 @opindex mno-fix-r4400
14016 Work around certain R4400 CPU errata:
14017 @itemize @minus
14018 @item
14019 A double-word or a variable shift may give an incorrect result if executed
14020 immediately after starting an integer division.
14021 @end itemize
14023 @item -mfix-r10000
14024 @itemx -mno-fix-r10000
14025 @opindex mfix-r10000
14026 @opindex mno-fix-r10000
14027 Work around certain R10000 errata:
14028 @itemize @minus
14029 @item
14030 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14031 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14032 @end itemize
14034 This option can only be used if the target architecture supports
14035 branch-likely instructions.  @option{-mfix-r10000} is the default when
14036 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14037 otherwise.
14039 @item -mfix-vr4120
14040 @itemx -mno-fix-vr4120
14041 @opindex mfix-vr4120
14042 Work around certain VR4120 errata:
14043 @itemize @minus
14044 @item
14045 @code{dmultu} does not always produce the correct result.
14046 @item
14047 @code{div} and @code{ddiv} do not always produce the correct result if one
14048 of the operands is negative.
14049 @end itemize
14050 The workarounds for the division errata rely on special functions in
14051 @file{libgcc.a}.  At present, these functions are only provided by
14052 the @code{mips64vr*-elf} configurations.
14054 Other VR4120 errata require a nop to be inserted between certain pairs of
14055 instructions.  These errata are handled by the assembler, not by GCC itself.
14057 @item -mfix-vr4130
14058 @opindex mfix-vr4130
14059 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14060 workarounds are implemented by the assembler rather than by GCC,
14061 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14062 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14063 instructions are available instead.
14065 @item -mfix-sb1
14066 @itemx -mno-fix-sb1
14067 @opindex mfix-sb1
14068 Work around certain SB-1 CPU core errata.
14069 (This flag currently works around the SB-1 revision 2
14070 ``F1'' and ``F2'' floating point errata.)
14072 @item -mr10k-cache-barrier=@var{setting}
14073 @opindex mr10k-cache-barrier
14074 Specify whether GCC should insert cache barriers to avoid the
14075 side-effects of speculation on R10K processors.
14077 In common with many processors, the R10K tries to predict the outcome
14078 of a conditional branch and speculatively executes instructions from
14079 the ``taken'' branch.  It later aborts these instructions if the
14080 predicted outcome was wrong.  However, on the R10K, even aborted
14081 instructions can have side effects.
14083 This problem only affects kernel stores and, depending on the system,
14084 kernel loads.  As an example, a speculatively-executed store may load
14085 the target memory into cache and mark the cache line as dirty, even if
14086 the store itself is later aborted.  If a DMA operation writes to the
14087 same area of memory before the ``dirty'' line is flushed, the cached
14088 data will overwrite the DMA-ed data.  See the R10K processor manual
14089 for a full description, including other potential problems.
14091 One workaround is to insert cache barrier instructions before every memory
14092 access that might be speculatively executed and that might have side
14093 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14094 controls GCC's implementation of this workaround.  It assumes that
14095 aborted accesses to any byte in the following regions will not have
14096 side effects:
14098 @enumerate
14099 @item
14100 the memory occupied by the current function's stack frame;
14102 @item
14103 the memory occupied by an incoming stack argument;
14105 @item
14106 the memory occupied by an object with a link-time-constant address.
14107 @end enumerate
14109 It is the kernel's responsibility to ensure that speculative
14110 accesses to these regions are indeed safe.
14112 If the input program contains a function declaration such as:
14114 @smallexample
14115 void foo (void);
14116 @end smallexample
14118 then the implementation of @code{foo} must allow @code{j foo} and
14119 @code{jal foo} to be executed speculatively.  GCC honors this
14120 restriction for functions it compiles itself.  It expects non-GCC
14121 functions (such as hand-written assembly code) to do the same.
14123 The option has three forms:
14125 @table @gcctabopt
14126 @item -mr10k-cache-barrier=load-store
14127 Insert a cache barrier before a load or store that might be
14128 speculatively executed and that might have side effects even
14129 if aborted.
14131 @item -mr10k-cache-barrier=store
14132 Insert a cache barrier before a store that might be speculatively
14133 executed and that might have side effects even if aborted.
14135 @item -mr10k-cache-barrier=none
14136 Disable the insertion of cache barriers.  This is the default setting.
14137 @end table
14139 @item -mflush-func=@var{func}
14140 @itemx -mno-flush-func
14141 @opindex mflush-func
14142 Specifies the function to call to flush the I and D caches, or to not
14143 call any such function.  If called, the function must take the same
14144 arguments as the common @code{_flush_func()}, that is, the address of the
14145 memory range for which the cache is being flushed, the size of the
14146 memory range, and the number 3 (to flush both caches).  The default
14147 depends on the target GCC was configured for, but commonly is either
14148 @samp{_flush_func} or @samp{__cpu_flush}.
14150 @item mbranch-cost=@var{num}
14151 @opindex mbranch-cost
14152 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14153 This cost is only a heuristic and is not guaranteed to produce
14154 consistent results across releases.  A zero cost redundantly selects
14155 the default, which is based on the @option{-mtune} setting.
14157 @item -mbranch-likely
14158 @itemx -mno-branch-likely
14159 @opindex mbranch-likely
14160 @opindex mno-branch-likely
14161 Enable or disable use of Branch Likely instructions, regardless of the
14162 default for the selected architecture.  By default, Branch Likely
14163 instructions may be generated if they are supported by the selected
14164 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14165 and processors which implement those architectures; for those, Branch
14166 Likely instructions will not be generated by default because the MIPS32
14167 and MIPS64 architectures specifically deprecate their use.
14169 @item -mfp-exceptions
14170 @itemx -mno-fp-exceptions
14171 @opindex mfp-exceptions
14172 Specifies whether FP exceptions are enabled.  This affects how we schedule
14173 FP instructions for some processors.  The default is that FP exceptions are
14174 enabled.
14176 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14177 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14178 FP pipe.
14180 @item -mvr4130-align
14181 @itemx -mno-vr4130-align
14182 @opindex mvr4130-align
14183 The VR4130 pipeline is two-way superscalar, but can only issue two
14184 instructions together if the first one is 8-byte aligned.  When this
14185 option is enabled, GCC will align pairs of instructions that it
14186 thinks should execute in parallel.
14188 This option only has an effect when optimizing for the VR4130.
14189 It normally makes code faster, but at the expense of making it bigger.
14190 It is enabled by default at optimization level @option{-O3}.
14192 @item -msynci
14193 @itemx -mno-synci
14194 @opindex msynci
14195 Enable (disable) generation of @code{synci} instructions on
14196 architectures that support it.  The @code{synci} instructions (if
14197 enabled) will be generated when @code{__builtin___clear_cache()} is
14198 compiled.
14200 This option defaults to @code{-mno-synci}, but the default can be
14201 overridden by configuring with @code{--with-synci}.
14203 When compiling code for single processor systems, it is generally safe
14204 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14205 will not invalidate the instruction caches on all cores and may lead
14206 to undefined behavior.
14208 @item -mrelax-pic-calls
14209 @itemx -mno-relax-pic-calls
14210 @opindex mrelax-pic-calls
14211 Try to turn PIC calls that are normally dispatched via register
14212 @code{$25} into direct calls.  This is only possible if the linker can
14213 resolve the destination at link-time and if the destination is within
14214 range for a direct call.
14216 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14217 an assembler and a linker that supports the @code{.reloc} assembly
14218 directive and @code{-mexplicit-relocs} is in effect.  With
14219 @code{-mno-explicit-relocs}, this optimization can be performed by the
14220 assembler and the linker alone without help from the compiler.
14222 @item -mmcount-ra-address
14223 @itemx -mno-mcount-ra-address
14224 @opindex mmcount-ra-address
14225 @opindex mno-mcount-ra-address
14226 Emit (do not emit) code that allows @code{_mcount} to modify the
14227 calling function's return address.  When enabled, this option extends
14228 the usual @code{_mcount} interface with a new @var{ra-address}
14229 parameter, which has type @code{intptr_t *} and is passed in register
14230 @code{$12}.  @code{_mcount} can then modify the return address by
14231 doing both of the following:
14232 @itemize
14233 @item
14234 Returning the new address in register @code{$31}.
14235 @item
14236 Storing the new address in @code{*@var{ra-address}},
14237 if @var{ra-address} is nonnull.
14238 @end itemize
14240 The default is @option{-mno-mcount-ra-address}.
14242 @end table
14244 @node MMIX Options
14245 @subsection MMIX Options
14246 @cindex MMIX Options
14248 These options are defined for the MMIX:
14250 @table @gcctabopt
14251 @item -mlibfuncs
14252 @itemx -mno-libfuncs
14253 @opindex mlibfuncs
14254 @opindex mno-libfuncs
14255 Specify that intrinsic library functions are being compiled, passing all
14256 values in registers, no matter the size.
14258 @item -mepsilon
14259 @itemx -mno-epsilon
14260 @opindex mepsilon
14261 @opindex mno-epsilon
14262 Generate floating-point comparison instructions that compare with respect
14263 to the @code{rE} epsilon register.
14265 @item -mabi=mmixware
14266 @itemx -mabi=gnu
14267 @opindex mabi=mmixware
14268 @opindex mabi=gnu
14269 Generate code that passes function parameters and return values that (in
14270 the called function) are seen as registers @code{$0} and up, as opposed to
14271 the GNU ABI which uses global registers @code{$231} and up.
14273 @item -mzero-extend
14274 @itemx -mno-zero-extend
14275 @opindex mzero-extend
14276 @opindex mno-zero-extend
14277 When reading data from memory in sizes shorter than 64 bits, use (do not
14278 use) zero-extending load instructions by default, rather than
14279 sign-extending ones.
14281 @item -mknuthdiv
14282 @itemx -mno-knuthdiv
14283 @opindex mknuthdiv
14284 @opindex mno-knuthdiv
14285 Make the result of a division yielding a remainder have the same sign as
14286 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14287 remainder follows the sign of the dividend.  Both methods are
14288 arithmetically valid, the latter being almost exclusively used.
14290 @item -mtoplevel-symbols
14291 @itemx -mno-toplevel-symbols
14292 @opindex mtoplevel-symbols
14293 @opindex mno-toplevel-symbols
14294 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14295 code can be used with the @code{PREFIX} assembly directive.
14297 @item -melf
14298 @opindex melf
14299 Generate an executable in the ELF format, rather than the default
14300 @samp{mmo} format used by the @command{mmix} simulator.
14302 @item -mbranch-predict
14303 @itemx -mno-branch-predict
14304 @opindex mbranch-predict
14305 @opindex mno-branch-predict
14306 Use (do not use) the probable-branch instructions, when static branch
14307 prediction indicates a probable branch.
14309 @item -mbase-addresses
14310 @itemx -mno-base-addresses
14311 @opindex mbase-addresses
14312 @opindex mno-base-addresses
14313 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14314 base address automatically generates a request (handled by the assembler
14315 and the linker) for a constant to be set up in a global register.  The
14316 register is used for one or more base address requests within the range 0
14317 to 255 from the value held in the register.  The generally leads to short
14318 and fast code, but the number of different data items that can be
14319 addressed is limited.  This means that a program that uses lots of static
14320 data may require @option{-mno-base-addresses}.
14322 @item -msingle-exit
14323 @itemx -mno-single-exit
14324 @opindex msingle-exit
14325 @opindex mno-single-exit
14326 Force (do not force) generated code to have a single exit point in each
14327 function.
14328 @end table
14330 @node MN10300 Options
14331 @subsection MN10300 Options
14332 @cindex MN10300 options
14334 These @option{-m} options are defined for Matsushita MN10300 architectures:
14336 @table @gcctabopt
14337 @item -mmult-bug
14338 @opindex mmult-bug
14339 Generate code to avoid bugs in the multiply instructions for the MN10300
14340 processors.  This is the default.
14342 @item -mno-mult-bug
14343 @opindex mno-mult-bug
14344 Do not generate code to avoid bugs in the multiply instructions for the
14345 MN10300 processors.
14347 @item -mam33
14348 @opindex mam33
14349 Generate code which uses features specific to the AM33 processor.
14351 @item -mno-am33
14352 @opindex mno-am33
14353 Do not generate code which uses features specific to the AM33 processor.  This
14354 is the default.
14356 @item -mreturn-pointer-on-d0
14357 @opindex mreturn-pointer-on-d0
14358 When generating a function which returns a pointer, return the pointer
14359 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14360 only in a0, and attempts to call such functions without a prototype
14361 would result in errors.  Note that this option is on by default; use
14362 @option{-mno-return-pointer-on-d0} to disable it.
14364 @item -mno-crt0
14365 @opindex mno-crt0
14366 Do not link in the C run-time initialization object file.
14368 @item -mrelax
14369 @opindex mrelax
14370 Indicate to the linker that it should perform a relaxation optimization pass
14371 to shorten branches, calls and absolute memory addresses.  This option only
14372 has an effect when used on the command line for the final link step.
14374 This option makes symbolic debugging impossible.
14375 @end table
14377 @node PDP-11 Options
14378 @subsection PDP-11 Options
14379 @cindex PDP-11 Options
14381 These options are defined for the PDP-11:
14383 @table @gcctabopt
14384 @item -mfpu
14385 @opindex mfpu
14386 Use hardware FPP floating point.  This is the default.  (FIS floating
14387 point on the PDP-11/40 is not supported.)
14389 @item -msoft-float
14390 @opindex msoft-float
14391 Do not use hardware floating point.
14393 @item -mac0
14394 @opindex mac0
14395 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14397 @item -mno-ac0
14398 @opindex mno-ac0
14399 Return floating-point results in memory.  This is the default.
14401 @item -m40
14402 @opindex m40
14403 Generate code for a PDP-11/40.
14405 @item -m45
14406 @opindex m45
14407 Generate code for a PDP-11/45.  This is the default.
14409 @item -m10
14410 @opindex m10
14411 Generate code for a PDP-11/10.
14413 @item -mbcopy-builtin
14414 @opindex mbcopy-builtin
14415 Use inline @code{movmemhi} patterns for copying memory.  This is the
14416 default.
14418 @item -mbcopy
14419 @opindex mbcopy
14420 Do not use inline @code{movmemhi} patterns for copying memory.
14422 @item -mint16
14423 @itemx -mno-int32
14424 @opindex mint16
14425 @opindex mno-int32
14426 Use 16-bit @code{int}.  This is the default.
14428 @item -mint32
14429 @itemx -mno-int16
14430 @opindex mint32
14431 @opindex mno-int16
14432 Use 32-bit @code{int}.
14434 @item -mfloat64
14435 @itemx -mno-float32
14436 @opindex mfloat64
14437 @opindex mno-float32
14438 Use 64-bit @code{float}.  This is the default.
14440 @item -mfloat32
14441 @itemx -mno-float64
14442 @opindex mfloat32
14443 @opindex mno-float64
14444 Use 32-bit @code{float}.
14446 @item -mabshi
14447 @opindex mabshi
14448 Use @code{abshi2} pattern.  This is the default.
14450 @item -mno-abshi
14451 @opindex mno-abshi
14452 Do not use @code{abshi2} pattern.
14454 @item -mbranch-expensive
14455 @opindex mbranch-expensive
14456 Pretend that branches are expensive.  This is for experimenting with
14457 code generation only.
14459 @item -mbranch-cheap
14460 @opindex mbranch-cheap
14461 Do not pretend that branches are expensive.  This is the default.
14463 @item -msplit
14464 @opindex msplit
14465 Generate code for a system with split I&D@.
14467 @item -mno-split
14468 @opindex mno-split
14469 Generate code for a system without split I&D@.  This is the default.
14471 @item -munix-asm
14472 @opindex munix-asm
14473 Use Unix assembler syntax.  This is the default when configured for
14474 @samp{pdp11-*-bsd}.
14476 @item -mdec-asm
14477 @opindex mdec-asm
14478 Use DEC assembler syntax.  This is the default when configured for any
14479 PDP-11 target other than @samp{pdp11-*-bsd}.
14480 @end table
14482 @node picoChip Options
14483 @subsection picoChip Options
14484 @cindex picoChip options
14486 These @samp{-m} options are defined for picoChip implementations:
14488 @table @gcctabopt
14490 @item -mae=@var{ae_type}
14491 @opindex mcpu
14492 Set the instruction set, register set, and instruction scheduling
14493 parameters for array element type @var{ae_type}.  Supported values
14494 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14496 @option{-mae=ANY} selects a completely generic AE type.  Code
14497 generated with this option will run on any of the other AE types.  The
14498 code will not be as efficient as it would be if compiled for a specific
14499 AE type, and some types of operation (e.g., multiplication) will not
14500 work properly on all types of AE.
14502 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14503 for compiled code, and is the default.
14505 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14506 option may suffer from poor performance of byte (char) manipulation,
14507 since the DSP AE does not provide hardware support for byte load/stores.
14509 @item -msymbol-as-address
14510 Enable the compiler to directly use a symbol name as an address in a
14511 load/store instruction, without first loading it into a
14512 register.  Typically, the use of this option will generate larger
14513 programs, which run faster than when the option isn't used.  However, the
14514 results vary from program to program, so it is left as a user option,
14515 rather than being permanently enabled.
14517 @item -mno-inefficient-warnings
14518 Disables warnings about the generation of inefficient code.  These
14519 warnings can be generated, for example, when compiling code which
14520 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14521 no hardware support for byte-level memory operations, so all byte
14522 load/stores must be synthesized from word load/store operations.  This is
14523 inefficient and a warning will be generated indicating to the programmer
14524 that they should rewrite the code to avoid byte operations, or to target
14525 an AE type which has the necessary hardware support.  This option enables
14526 the warning to be turned off.
14528 @end table
14530 @node PowerPC Options
14531 @subsection PowerPC Options
14532 @cindex PowerPC options
14534 These are listed under @xref{RS/6000 and PowerPC Options}.
14536 @node RS/6000 and PowerPC Options
14537 @subsection IBM RS/6000 and PowerPC Options
14538 @cindex RS/6000 and PowerPC Options
14539 @cindex IBM RS/6000 and PowerPC Options
14541 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14542 @table @gcctabopt
14543 @item -mpower
14544 @itemx -mno-power
14545 @itemx -mpower2
14546 @itemx -mno-power2
14547 @itemx -mpowerpc
14548 @itemx -mno-powerpc
14549 @itemx -mpowerpc-gpopt
14550 @itemx -mno-powerpc-gpopt
14551 @itemx -mpowerpc-gfxopt
14552 @itemx -mno-powerpc-gfxopt
14553 @itemx -mpowerpc64
14554 @itemx -mno-powerpc64
14555 @itemx -mmfcrf
14556 @itemx -mno-mfcrf
14557 @itemx -mpopcntb
14558 @itemx -mno-popcntb
14559 @itemx -mpopcntd
14560 @itemx -mno-popcntd
14561 @itemx -mfprnd
14562 @itemx -mno-fprnd
14563 @itemx -mcmpb
14564 @itemx -mno-cmpb
14565 @itemx -mmfpgpr
14566 @itemx -mno-mfpgpr
14567 @itemx -mhard-dfp
14568 @itemx -mno-hard-dfp
14569 @opindex mpower
14570 @opindex mno-power
14571 @opindex mpower2
14572 @opindex mno-power2
14573 @opindex mpowerpc
14574 @opindex mno-powerpc
14575 @opindex mpowerpc-gpopt
14576 @opindex mno-powerpc-gpopt
14577 @opindex mpowerpc-gfxopt
14578 @opindex mno-powerpc-gfxopt
14579 @opindex mpowerpc64
14580 @opindex mno-powerpc64
14581 @opindex mmfcrf
14582 @opindex mno-mfcrf
14583 @opindex mpopcntb
14584 @opindex mno-popcntb
14585 @opindex mpopcntd
14586 @opindex mno-popcntd
14587 @opindex mfprnd
14588 @opindex mno-fprnd
14589 @opindex mcmpb
14590 @opindex mno-cmpb
14591 @opindex mmfpgpr
14592 @opindex mno-mfpgpr
14593 @opindex mhard-dfp
14594 @opindex mno-hard-dfp
14595 GCC supports two related instruction set architectures for the
14596 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14597 instructions supported by the @samp{rios} chip set used in the original
14598 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14599 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14600 the IBM 4xx, 6xx, and follow-on microprocessors.
14602 Neither architecture is a subset of the other.  However there is a
14603 large common subset of instructions supported by both.  An MQ
14604 register is included in processors supporting the POWER architecture.
14606 You use these options to specify which instructions are available on the
14607 processor you are using.  The default value of these options is
14608 determined when configuring GCC@.  Specifying the
14609 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14610 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14611 rather than the options listed above.
14613 The @option{-mpower} option allows GCC to generate instructions that
14614 are found only in the POWER architecture and to use the MQ register.
14615 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14616 to generate instructions that are present in the POWER2 architecture but
14617 not the original POWER architecture.
14619 The @option{-mpowerpc} option allows GCC to generate instructions that
14620 are found only in the 32-bit subset of the PowerPC architecture.
14621 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14622 GCC to use the optional PowerPC architecture instructions in the
14623 General Purpose group, including floating-point square root.  Specifying
14624 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14625 use the optional PowerPC architecture instructions in the Graphics
14626 group, including floating-point select.
14628 The @option{-mmfcrf} option allows GCC to generate the move from
14629 condition register field instruction implemented on the POWER4
14630 processor and other processors that support the PowerPC V2.01
14631 architecture.
14632 The @option{-mpopcntb} option allows GCC to generate the popcount and
14633 double precision FP reciprocal estimate instruction implemented on the
14634 POWER5 processor and other processors that support the PowerPC V2.02
14635 architecture.
14636 The @option{-mpopcntd} option allows GCC to generate the popcount
14637 instruction implemented on the POWER7 processor and other processors
14638 that support the PowerPC V2.06 architecture.
14639 The @option{-mfprnd} option allows GCC to generate the FP round to
14640 integer instructions implemented on the POWER5+ processor and other
14641 processors that support the PowerPC V2.03 architecture.
14642 The @option{-mcmpb} option allows GCC to generate the compare bytes
14643 instruction implemented on the POWER6 processor and other processors
14644 that support the PowerPC V2.05 architecture.
14645 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14646 general purpose register instructions implemented on the POWER6X
14647 processor and other processors that support the extended PowerPC V2.05
14648 architecture.
14649 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14650 point instructions implemented on some POWER processors.
14652 The @option{-mpowerpc64} option allows GCC to generate the additional
14653 64-bit instructions that are found in the full PowerPC64 architecture
14654 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14655 @option{-mno-powerpc64}.
14657 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14658 will use only the instructions in the common subset of both
14659 architectures plus some special AIX common-mode calls, and will not use
14660 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14661 permits GCC to use any instruction from either architecture and to
14662 allow use of the MQ register; specify this for the Motorola MPC601.
14664 @item -mnew-mnemonics
14665 @itemx -mold-mnemonics
14666 @opindex mnew-mnemonics
14667 @opindex mold-mnemonics
14668 Select which mnemonics to use in the generated assembler code.  With
14669 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14670 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14671 assembler mnemonics defined for the POWER architecture.  Instructions
14672 defined in only one architecture have only one mnemonic; GCC uses that
14673 mnemonic irrespective of which of these options is specified.
14675 GCC defaults to the mnemonics appropriate for the architecture in
14676 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14677 value of these option.  Unless you are building a cross-compiler, you
14678 should normally not specify either @option{-mnew-mnemonics} or
14679 @option{-mold-mnemonics}, but should instead accept the default.
14681 @item -mcpu=@var{cpu_type}
14682 @opindex mcpu
14683 Set architecture type, register usage, choice of mnemonics, and
14684 instruction scheduling parameters for machine type @var{cpu_type}.
14685 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14686 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14687 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
14688 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
14689 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14690 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
14691 @samp{e300c3}, @samp{e500mc}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
14692 @samp{power}, @samp{power2}, @samp{power3}, @samp{power4},
14693 @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{power7},
14694 @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14695 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14697 @option{-mcpu=common} selects a completely generic processor.  Code
14698 generated under this option will run on any POWER or PowerPC processor.
14699 GCC will use only the instructions in the common subset of both
14700 architectures, and will not use the MQ register.  GCC assumes a generic
14701 processor model for scheduling purposes.
14703 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14704 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14705 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14706 types, with an appropriate, generic processor model assumed for
14707 scheduling purposes.
14709 The other options specify a specific processor.  Code generated under
14710 those options will run best on that processor, and may not run at all on
14711 others.
14713 The @option{-mcpu} options automatically enable or disable the
14714 following options:
14716 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14717 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14718 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14719 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14721 The particular options set for any particular CPU will vary between
14722 compiler versions, depending on what setting seems to produce optimal
14723 code for that CPU; it doesn't necessarily reflect the actual hardware's
14724 capabilities.  If you wish to set an individual option to a particular
14725 value, you may specify it after the @option{-mcpu} option, like
14726 @samp{-mcpu=970 -mno-altivec}.
14728 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14729 not enabled or disabled by the @option{-mcpu} option at present because
14730 AIX does not have full support for these options.  You may still
14731 enable or disable them individually if you're sure it'll work in your
14732 environment.
14734 @item -mtune=@var{cpu_type}
14735 @opindex mtune
14736 Set the instruction scheduling parameters for machine type
14737 @var{cpu_type}, but do not set the architecture type, register usage, or
14738 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14739 values for @var{cpu_type} are used for @option{-mtune} as for
14740 @option{-mcpu}.  If both are specified, the code generated will use the
14741 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14742 scheduling parameters set by @option{-mtune}.
14744 @item -mswdiv
14745 @itemx -mno-swdiv
14746 @opindex mswdiv
14747 @opindex mno-swdiv
14748 Generate code to compute division as reciprocal estimate and iterative
14749 refinement, creating opportunities for increased throughput.  This
14750 feature requires: optional PowerPC Graphics instruction set for single
14751 precision and FRE instruction for double precision, assuming divides
14752 cannot generate user-visible traps, and the domain values not include
14753 Infinities, denormals or zero denominator.
14755 @item -maltivec
14756 @itemx -mno-altivec
14757 @opindex maltivec
14758 @opindex mno-altivec
14759 Generate code that uses (does not use) AltiVec instructions, and also
14760 enable the use of built-in functions that allow more direct access to
14761 the AltiVec instruction set.  You may also need to set
14762 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14763 enhancements.
14765 @item -mvrsave
14766 @itemx -mno-vrsave
14767 @opindex mvrsave
14768 @opindex mno-vrsave
14769 Generate VRSAVE instructions when generating AltiVec code.
14771 @item -mgen-cell-microcode
14772 @opindex mgen-cell-microcode
14773 Generate Cell microcode instructions
14775 @item -mwarn-cell-microcode
14776 @opindex mwarn-cell-microcode
14777 Warning when a Cell microcode instruction is going to emitted.  An example
14778 of a Cell microcode instruction is a variable shift.
14780 @item -msecure-plt
14781 @opindex msecure-plt
14782 Generate code that allows ld and ld.so to build executables and shared
14783 libraries with non-exec .plt and .got sections.  This is a PowerPC
14784 32-bit SYSV ABI option.
14786 @item -mbss-plt
14787 @opindex mbss-plt
14788 Generate code that uses a BSS .plt section that ld.so fills in, and
14789 requires .plt and .got sections that are both writable and executable.
14790 This is a PowerPC 32-bit SYSV ABI option.
14792 @item -misel
14793 @itemx -mno-isel
14794 @opindex misel
14795 @opindex mno-isel
14796 This switch enables or disables the generation of ISEL instructions.
14798 @item -misel=@var{yes/no}
14799 This switch has been deprecated.  Use @option{-misel} and
14800 @option{-mno-isel} instead.
14802 @item -mspe
14803 @itemx -mno-spe
14804 @opindex mspe
14805 @opindex mno-spe
14806 This switch enables or disables the generation of SPE simd
14807 instructions.
14809 @item -mpaired
14810 @itemx -mno-paired
14811 @opindex mpaired
14812 @opindex mno-paired
14813 This switch enables or disables the generation of PAIRED simd
14814 instructions.
14816 @item -mspe=@var{yes/no}
14817 This option has been deprecated.  Use @option{-mspe} and
14818 @option{-mno-spe} instead.
14820 @item -mvsx
14821 @itemx -mno-vsx
14822 @opindex mvsx
14823 @opindex mno-vsx
14824 Generate code that uses (does not use) vector/scalar (VSX)
14825 instructions, and also enable the use of built-in functions that allow
14826 more direct access to the VSX instruction set.
14828 @item -mfloat-gprs=@var{yes/single/double/no}
14829 @itemx -mfloat-gprs
14830 @opindex mfloat-gprs
14831 This switch enables or disables the generation of floating point
14832 operations on the general purpose registers for architectures that
14833 support it.
14835 The argument @var{yes} or @var{single} enables the use of
14836 single-precision floating point operations.
14838 The argument @var{double} enables the use of single and
14839 double-precision floating point operations.
14841 The argument @var{no} disables floating point operations on the
14842 general purpose registers.
14844 This option is currently only available on the MPC854x.
14846 @item -m32
14847 @itemx -m64
14848 @opindex m32
14849 @opindex m64
14850 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
14851 targets (including GNU/Linux).  The 32-bit environment sets int, long
14852 and pointer to 32 bits and generates code that runs on any PowerPC
14853 variant.  The 64-bit environment sets int to 32 bits and long and
14854 pointer to 64 bits, and generates code for PowerPC64, as for
14855 @option{-mpowerpc64}.
14857 @item -mfull-toc
14858 @itemx -mno-fp-in-toc
14859 @itemx -mno-sum-in-toc
14860 @itemx -mminimal-toc
14861 @opindex mfull-toc
14862 @opindex mno-fp-in-toc
14863 @opindex mno-sum-in-toc
14864 @opindex mminimal-toc
14865 Modify generation of the TOC (Table Of Contents), which is created for
14866 every executable file.  The @option{-mfull-toc} option is selected by
14867 default.  In that case, GCC will allocate at least one TOC entry for
14868 each unique non-automatic variable reference in your program.  GCC
14869 will also place floating-point constants in the TOC@.  However, only
14870 16,384 entries are available in the TOC@.
14872 If you receive a linker error message that saying you have overflowed
14873 the available TOC space, you can reduce the amount of TOC space used
14874 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
14875 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
14876 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
14877 generate code to calculate the sum of an address and a constant at
14878 run-time instead of putting that sum into the TOC@.  You may specify one
14879 or both of these options.  Each causes GCC to produce very slightly
14880 slower and larger code at the expense of conserving TOC space.
14882 If you still run out of space in the TOC even when you specify both of
14883 these options, specify @option{-mminimal-toc} instead.  This option causes
14884 GCC to make only one TOC entry for every file.  When you specify this
14885 option, GCC will produce code that is slower and larger but which
14886 uses extremely little TOC space.  You may wish to use this option
14887 only on files that contain less frequently executed code.
14889 @item -maix64
14890 @itemx -maix32
14891 @opindex maix64
14892 @opindex maix32
14893 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
14894 @code{long} type, and the infrastructure needed to support them.
14895 Specifying @option{-maix64} implies @option{-mpowerpc64} and
14896 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
14897 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
14899 @item -mxl-compat
14900 @itemx -mno-xl-compat
14901 @opindex mxl-compat
14902 @opindex mno-xl-compat
14903 Produce code that conforms more closely to IBM XL compiler semantics
14904 when using AIX-compatible ABI@.  Pass floating-point arguments to
14905 prototyped functions beyond the register save area (RSA) on the stack
14906 in addition to argument FPRs.  Do not assume that most significant
14907 double in 128-bit long double value is properly rounded when comparing
14908 values and converting to double.  Use XL symbol names for long double
14909 support routines.
14911 The AIX calling convention was extended but not initially documented to
14912 handle an obscure K&R C case of calling a function that takes the
14913 address of its arguments with fewer arguments than declared.  IBM XL
14914 compilers access floating point arguments which do not fit in the
14915 RSA from the stack when a subroutine is compiled without
14916 optimization.  Because always storing floating-point arguments on the
14917 stack is inefficient and rarely needed, this option is not enabled by
14918 default and only is necessary when calling subroutines compiled by IBM
14919 XL compilers without optimization.
14921 @item -mpe
14922 @opindex mpe
14923 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
14924 application written to use message passing with special startup code to
14925 enable the application to run.  The system must have PE installed in the
14926 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
14927 must be overridden with the @option{-specs=} option to specify the
14928 appropriate directory location.  The Parallel Environment does not
14929 support threads, so the @option{-mpe} option and the @option{-pthread}
14930 option are incompatible.
14932 @item -malign-natural
14933 @itemx -malign-power
14934 @opindex malign-natural
14935 @opindex malign-power
14936 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
14937 @option{-malign-natural} overrides the ABI-defined alignment of larger
14938 types, such as floating-point doubles, on their natural size-based boundary.
14939 The option @option{-malign-power} instructs GCC to follow the ABI-specified
14940 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
14942 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
14943 is not supported.
14945 @item -msoft-float
14946 @itemx -mhard-float
14947 @opindex msoft-float
14948 @opindex mhard-float
14949 Generate code that does not use (uses) the floating-point register set.
14950 Software floating point emulation is provided if you use the
14951 @option{-msoft-float} option, and pass the option to GCC when linking.
14953 @item -msingle-float
14954 @itemx -mdouble-float
14955 @opindex msingle-float
14956 @opindex mdouble-float
14957 Generate code for single or double-precision floating point operations.
14958 @option{-mdouble-float} implies @option{-msingle-float}.
14960 @item -msimple-fpu
14961 @opindex msimple-fpu
14962 Do not generate sqrt and div instructions for hardware floating point unit.
14964 @item -mfpu
14965 @opindex mfpu
14966 Specify type of floating point unit.  Valid values are @var{sp_lite}
14967 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
14968 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
14969 and @var{dp_full} (equivalent to -mdouble-float).
14971 @item -mxilinx-fpu
14972 @opindex mxilinx-fpu
14973 Perform optimizations for floating point unit on Xilinx PPC 405/440.
14975 @item -mmultiple
14976 @itemx -mno-multiple
14977 @opindex mmultiple
14978 @opindex mno-multiple
14979 Generate code that uses (does not use) the load multiple word
14980 instructions and the store multiple word instructions.  These
14981 instructions are generated by default on POWER systems, and not
14982 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
14983 endian PowerPC systems, since those instructions do not work when the
14984 processor is in little endian mode.  The exceptions are PPC740 and
14985 PPC750 which permit the instructions usage in little endian mode.
14987 @item -mstring
14988 @itemx -mno-string
14989 @opindex mstring
14990 @opindex mno-string
14991 Generate code that uses (does not use) the load string instructions
14992 and the store string word instructions to save multiple registers and
14993 do small block moves.  These instructions are generated by default on
14994 POWER systems, and not generated on PowerPC systems.  Do not use
14995 @option{-mstring} on little endian PowerPC systems, since those
14996 instructions do not work when the processor is in little endian mode.
14997 The exceptions are PPC740 and PPC750 which permit the instructions
14998 usage in little endian mode.
15000 @item -mupdate
15001 @itemx -mno-update
15002 @opindex mupdate
15003 @opindex mno-update
15004 Generate code that uses (does not use) the load or store instructions
15005 that update the base register to the address of the calculated memory
15006 location.  These instructions are generated by default.  If you use
15007 @option{-mno-update}, there is a small window between the time that the
15008 stack pointer is updated and the address of the previous frame is
15009 stored, which means code that walks the stack frame across interrupts or
15010 signals may get corrupted data.
15012 @item -mavoid-indexed-addresses
15013 @item -mno-avoid-indexed-addresses
15014 @opindex mavoid-indexed-addresses
15015 @opindex mno-avoid-indexed-addresses
15016 Generate code that tries to avoid (not avoid) the use of indexed load
15017 or store instructions. These instructions can incur a performance
15018 penalty on Power6 processors in certain situations, such as when
15019 stepping through large arrays that cross a 16M boundary.  This option
15020 is enabled by default when targetting Power6 and disabled otherwise.
15022 @item -mfused-madd
15023 @itemx -mno-fused-madd
15024 @opindex mfused-madd
15025 @opindex mno-fused-madd
15026 Generate code that uses (does not use) the floating point multiply and
15027 accumulate instructions.  These instructions are generated by default if
15028 hardware floating is used.
15030 @item -mmulhw
15031 @itemx -mno-mulhw
15032 @opindex mmulhw
15033 @opindex mno-mulhw
15034 Generate code that uses (does not use) the half-word multiply and
15035 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15036 These instructions are generated by default when targetting those
15037 processors.
15039 @item -mdlmzb
15040 @itemx -mno-dlmzb
15041 @opindex mdlmzb
15042 @opindex mno-dlmzb
15043 Generate code that uses (does not use) the string-search @samp{dlmzb}
15044 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15045 generated by default when targetting those processors.
15047 @item -mno-bit-align
15048 @itemx -mbit-align
15049 @opindex mno-bit-align
15050 @opindex mbit-align
15051 On System V.4 and embedded PowerPC systems do not (do) force structures
15052 and unions that contain bit-fields to be aligned to the base type of the
15053 bit-field.
15055 For example, by default a structure containing nothing but 8
15056 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15057 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15058 the structure would be aligned to a 1 byte boundary and be one byte in
15059 size.
15061 @item -mno-strict-align
15062 @itemx -mstrict-align
15063 @opindex mno-strict-align
15064 @opindex mstrict-align
15065 On System V.4 and embedded PowerPC systems do not (do) assume that
15066 unaligned memory references will be handled by the system.
15068 @item -mrelocatable
15069 @itemx -mno-relocatable
15070 @opindex mrelocatable
15071 @opindex mno-relocatable
15072 On embedded PowerPC systems generate code that allows (does not allow)
15073 the program to be relocated to a different address at runtime.  If you
15074 use @option{-mrelocatable} on any module, all objects linked together must
15075 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
15077 @item -mrelocatable-lib
15078 @itemx -mno-relocatable-lib
15079 @opindex mrelocatable-lib
15080 @opindex mno-relocatable-lib
15081 On embedded PowerPC systems generate code that allows (does not allow)
15082 the program to be relocated to a different address at runtime.  Modules
15083 compiled with @option{-mrelocatable-lib} can be linked with either modules
15084 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
15085 with modules compiled with the @option{-mrelocatable} options.
15087 @item -mno-toc
15088 @itemx -mtoc
15089 @opindex mno-toc
15090 @opindex mtoc
15091 On System V.4 and embedded PowerPC systems do not (do) assume that
15092 register 2 contains a pointer to a global area pointing to the addresses
15093 used in the program.
15095 @item -mlittle
15096 @itemx -mlittle-endian
15097 @opindex mlittle
15098 @opindex mlittle-endian
15099 On System V.4 and embedded PowerPC systems compile code for the
15100 processor in little endian mode.  The @option{-mlittle-endian} option is
15101 the same as @option{-mlittle}.
15103 @item -mbig
15104 @itemx -mbig-endian
15105 @opindex mbig
15106 @opindex mbig-endian
15107 On System V.4 and embedded PowerPC systems compile code for the
15108 processor in big endian mode.  The @option{-mbig-endian} option is
15109 the same as @option{-mbig}.
15111 @item -mdynamic-no-pic
15112 @opindex mdynamic-no-pic
15113 On Darwin and Mac OS X systems, compile code so that it is not
15114 relocatable, but that its external references are relocatable.  The
15115 resulting code is suitable for applications, but not shared
15116 libraries.
15118 @item -mprioritize-restricted-insns=@var{priority}
15119 @opindex mprioritize-restricted-insns
15120 This option controls the priority that is assigned to
15121 dispatch-slot restricted instructions during the second scheduling
15122 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15123 @var{no/highest/second-highest} priority to dispatch slot restricted
15124 instructions.
15126 @item -msched-costly-dep=@var{dependence_type}
15127 @opindex msched-costly-dep
15128 This option controls which dependences are considered costly
15129 by the target during instruction scheduling.  The argument
15130 @var{dependence_type} takes one of the following values:
15131 @var{no}: no dependence is costly,
15132 @var{all}: all dependences are costly,
15133 @var{true_store_to_load}: a true dependence from store to load is costly,
15134 @var{store_to_load}: any dependence from store to load is costly,
15135 @var{number}: any dependence which latency >= @var{number} is costly.
15137 @item -minsert-sched-nops=@var{scheme}
15138 @opindex minsert-sched-nops
15139 This option controls which nop insertion scheme will be used during
15140 the second scheduling pass.  The argument @var{scheme} takes one of the
15141 following values:
15142 @var{no}: Don't insert nops.
15143 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15144 according to the scheduler's grouping.
15145 @var{regroup_exact}: Insert nops to force costly dependent insns into
15146 separate groups.  Insert exactly as many nops as needed to force an insn
15147 to a new group, according to the estimated processor grouping.
15148 @var{number}: Insert nops to force costly dependent insns into
15149 separate groups.  Insert @var{number} nops to force an insn to a new group.
15151 @item -mcall-sysv
15152 @opindex mcall-sysv
15153 On System V.4 and embedded PowerPC systems compile code using calling
15154 conventions that adheres to the March 1995 draft of the System V
15155 Application Binary Interface, PowerPC processor supplement.  This is the
15156 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15158 @item -mcall-sysv-eabi
15159 @itemx -mcall-eabi
15160 @opindex mcall-sysv-eabi
15161 @opindex mcall-eabi
15162 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15164 @item -mcall-sysv-noeabi
15165 @opindex mcall-sysv-noeabi
15166 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15168 @item -mcall-aixdesc
15169 @opindex m
15170 On System V.4 and embedded PowerPC systems compile code for the AIX
15171 operating system.
15173 @item -mcall-linux
15174 @opindex mcall-linux
15175 On System V.4 and embedded PowerPC systems compile code for the
15176 Linux-based GNU system.
15178 @item -mcall-gnu
15179 @opindex mcall-gnu
15180 On System V.4 and embedded PowerPC systems compile code for the
15181 Hurd-based GNU system.
15183 @item -mcall-freebsd
15184 @opindex mcall-freebsd
15185 On System V.4 and embedded PowerPC systems compile code for the
15186 FreeBSD operating system.
15188 @item -mcall-netbsd
15189 @opindex mcall-netbsd
15190 On System V.4 and embedded PowerPC systems compile code for the
15191 NetBSD operating system.
15193 @item -mcall-openbsd
15194 @opindex mcall-netbsd
15195 On System V.4 and embedded PowerPC systems compile code for the
15196 OpenBSD operating system.
15198 @item -maix-struct-return
15199 @opindex maix-struct-return
15200 Return all structures in memory (as specified by the AIX ABI)@.
15202 @item -msvr4-struct-return
15203 @opindex msvr4-struct-return
15204 Return structures smaller than 8 bytes in registers (as specified by the
15205 SVR4 ABI)@.
15207 @item -mabi=@var{abi-type}
15208 @opindex mabi
15209 Extend the current ABI with a particular extension, or remove such extension.
15210 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15211 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15213 @item -mabi=spe
15214 @opindex mabi=spe
15215 Extend the current ABI with SPE ABI extensions.  This does not change
15216 the default ABI, instead it adds the SPE ABI extensions to the current
15217 ABI@.
15219 @item -mabi=no-spe
15220 @opindex mabi=no-spe
15221 Disable Booke SPE ABI extensions for the current ABI@.
15223 @item -mabi=ibmlongdouble
15224 @opindex mabi=ibmlongdouble
15225 Change the current ABI to use IBM extended precision long double.
15226 This is a PowerPC 32-bit SYSV ABI option.
15228 @item -mabi=ieeelongdouble
15229 @opindex mabi=ieeelongdouble
15230 Change the current ABI to use IEEE extended precision long double.
15231 This is a PowerPC 32-bit Linux ABI option.
15233 @item -mprototype
15234 @itemx -mno-prototype
15235 @opindex mprototype
15236 @opindex mno-prototype
15237 On System V.4 and embedded PowerPC systems assume that all calls to
15238 variable argument functions are properly prototyped.  Otherwise, the
15239 compiler must insert an instruction before every non prototyped call to
15240 set or clear bit 6 of the condition code register (@var{CR}) to
15241 indicate whether floating point values were passed in the floating point
15242 registers in case the function takes a variable arguments.  With
15243 @option{-mprototype}, only calls to prototyped variable argument functions
15244 will set or clear the bit.
15246 @item -msim
15247 @opindex msim
15248 On embedded PowerPC systems, assume that the startup module is called
15249 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15250 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15251 configurations.
15253 @item -mmvme
15254 @opindex mmvme
15255 On embedded PowerPC systems, assume that the startup module is called
15256 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15257 @file{libc.a}.
15259 @item -mads
15260 @opindex mads
15261 On embedded PowerPC systems, assume that the startup module is called
15262 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15263 @file{libc.a}.
15265 @item -myellowknife
15266 @opindex myellowknife
15267 On embedded PowerPC systems, assume that the startup module is called
15268 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15269 @file{libc.a}.
15271 @item -mvxworks
15272 @opindex mvxworks
15273 On System V.4 and embedded PowerPC systems, specify that you are
15274 compiling for a VxWorks system.
15276 @item -memb
15277 @opindex memb
15278 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15279 header to indicate that @samp{eabi} extended relocations are used.
15281 @item -meabi
15282 @itemx -mno-eabi
15283 @opindex meabi
15284 @opindex mno-eabi
15285 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15286 Embedded Applications Binary Interface (eabi) which is a set of
15287 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15288 means that the stack is aligned to an 8 byte boundary, a function
15289 @code{__eabi} is called to from @code{main} to set up the eabi
15290 environment, and the @option{-msdata} option can use both @code{r2} and
15291 @code{r13} to point to two separate small data areas.  Selecting
15292 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15293 do not call an initialization function from @code{main}, and the
15294 @option{-msdata} option will only use @code{r13} to point to a single
15295 small data area.  The @option{-meabi} option is on by default if you
15296 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15298 @item -msdata=eabi
15299 @opindex msdata=eabi
15300 On System V.4 and embedded PowerPC systems, put small initialized
15301 @code{const} global and static data in the @samp{.sdata2} section, which
15302 is pointed to by register @code{r2}.  Put small initialized
15303 non-@code{const} global and static data in the @samp{.sdata} section,
15304 which is pointed to by register @code{r13}.  Put small uninitialized
15305 global and static data in the @samp{.sbss} section, which is adjacent to
15306 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15307 incompatible with the @option{-mrelocatable} option.  The
15308 @option{-msdata=eabi} option also sets the @option{-memb} option.
15310 @item -msdata=sysv
15311 @opindex msdata=sysv
15312 On System V.4 and embedded PowerPC systems, put small global and static
15313 data in the @samp{.sdata} section, which is pointed to by register
15314 @code{r13}.  Put small uninitialized global and static data in the
15315 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15316 The @option{-msdata=sysv} option is incompatible with the
15317 @option{-mrelocatable} option.
15319 @item -msdata=default
15320 @itemx -msdata
15321 @opindex msdata=default
15322 @opindex msdata
15323 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15324 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15325 same as @option{-msdata=sysv}.
15327 @item -msdata=data
15328 @opindex msdata=data
15329 On System V.4 and embedded PowerPC systems, put small global
15330 data in the @samp{.sdata} section.  Put small uninitialized global
15331 data in the @samp{.sbss} section.  Do not use register @code{r13}
15332 to address small data however.  This is the default behavior unless
15333 other @option{-msdata} options are used.
15335 @item -msdata=none
15336 @itemx -mno-sdata
15337 @opindex msdata=none
15338 @opindex mno-sdata
15339 On embedded PowerPC systems, put all initialized global and static data
15340 in the @samp{.data} section, and all uninitialized data in the
15341 @samp{.bss} section.
15343 @item -G @var{num}
15344 @opindex G
15345 @cindex smaller data references (PowerPC)
15346 @cindex .sdata/.sdata2 references (PowerPC)
15347 On embedded PowerPC systems, put global and static items less than or
15348 equal to @var{num} bytes into the small data or bss sections instead of
15349 the normal data or bss section.  By default, @var{num} is 8.  The
15350 @option{-G @var{num}} switch is also passed to the linker.
15351 All modules should be compiled with the same @option{-G @var{num}} value.
15353 @item -mregnames
15354 @itemx -mno-regnames
15355 @opindex mregnames
15356 @opindex mno-regnames
15357 On System V.4 and embedded PowerPC systems do (do not) emit register
15358 names in the assembly language output using symbolic forms.
15360 @item -mlongcall
15361 @itemx -mno-longcall
15362 @opindex mlongcall
15363 @opindex mno-longcall
15364 By default assume that all calls are far away so that a longer more
15365 expensive calling sequence is required.  This is required for calls
15366 further than 32 megabytes (33,554,432 bytes) from the current location.
15367 A short call will be generated if the compiler knows
15368 the call cannot be that far away.  This setting can be overridden by
15369 the @code{shortcall} function attribute, or by @code{#pragma
15370 longcall(0)}.
15372 Some linkers are capable of detecting out-of-range calls and generating
15373 glue code on the fly.  On these systems, long calls are unnecessary and
15374 generate slower code.  As of this writing, the AIX linker can do this,
15375 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15376 to the GNU linker for 32-bit PowerPC systems as well.
15378 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15379 callee, L42'', plus a ``branch island'' (glue code).  The two target
15380 addresses represent the callee and the ``branch island''.  The
15381 Darwin/PPC linker will prefer the first address and generate a ``bl
15382 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15383 otherwise, the linker will generate ``bl L42'' to call the ``branch
15384 island''.  The ``branch island'' is appended to the body of the
15385 calling function; it computes the full 32-bit address of the callee
15386 and jumps to it.
15388 On Mach-O (Darwin) systems, this option directs the compiler emit to
15389 the glue for every direct call, and the Darwin linker decides whether
15390 to use or discard it.
15392 In the future, we may cause GCC to ignore all longcall specifications
15393 when the linker is known to generate glue.
15395 @item -mtls-markers
15396 @itemx -mno-tls-markers
15397 @opindex mtls-markers
15398 @opindex mno-tls-markers
15399 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15400 specifying the function argument.  The relocation allows ld to
15401 reliably associate function call with argument setup instructions for
15402 TLS optimization, which in turn allows gcc to better schedule the
15403 sequence.
15405 @item -pthread
15406 @opindex pthread
15407 Adds support for multithreading with the @dfn{pthreads} library.
15408 This option sets flags for both the preprocessor and linker.
15410 @end table
15412 @node RX Options
15413 @subsection RX Options
15414 @cindex RX Options
15416 These @option{-m} options are defined for RX implementations:
15418 @table @gcctabopt
15419 @item -m64bit-doubles
15420 @itemx -m32bit-doubles
15421 @itemx -fpu
15422 @itemx -nofpu
15423 @opindex m64bit-doubles
15424 @opindex m32bit-doubles
15425 @opindex fpu
15426 @opindex nofpu
15427 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15428 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15429 @option{-m64bit-doubles}.  @emph{Note} the RX's hardware floating
15430 point instructions are only used for 32-bit floating point values, and
15431 then only if @option{-ffast-math} has been specified on the command
15432 line.  This is because the RX FPU instructions do not properly support
15433 denormal (or sub-normal) values.
15435 The options @option{-fpu} and @option{-nofpu} have been provided at
15436 the request of Rensas for compatibility with their toolchain.  The
15437 @option{-mfpu} option enables the use of RX FPU instructions by
15438 selecting 32-bit doubles and enabling unsafe math optimizations.  The
15439 @option{-mnofpu} option disables the use of RX FPU instructions, even
15440 if @option{-m32bit-doubles} is active and unsafe math optimizations
15441 have been enabled.
15443 @item -mcpu=@var{name}
15444 @itemx -patch=@var{name}
15445 @opindex -mcpu
15446 @opindex -patch
15447 Selects the type of RX CPU to be targeted.  Currently on two types are
15448 supported, the generic @var{RX600} and the specific @var{RX610}.  The
15449 only difference between them is that the @var{RX610} does not support
15450 the @code{MVTIPL} instruction.
15452 @item -mbig-endian-data
15453 @itemx -mlittle-endian-data
15454 @opindex mbig-endian-data
15455 @opindex mlittle-endian-data
15456 Store data (but not code) in the big-endian format.  The default is
15457 @option{-mlittle-endian-data}, ie to store data in the little endian
15458 format.
15460 @item -msmall-data-limit=@var{N}
15461 @opindex msmall-data-limit
15462 Specifies the maximum size in bytes of global and static variables
15463 which can be placed into the small data area.  Using the small data
15464 area can lead to smaller and faster code, but the size of area is
15465 limited and it is up to the programmer to ensure that the area does
15466 not overflow.  Also when the small data area is used one of the RX's
15467 registers (@code{r13}) is reserved for use pointing to this area, so
15468 it is no longer available for use by the compiler.  This could result
15469 in slower and/or larger code if variables which once could have been
15470 held in @code{r13} are now pushed onto the stack.
15472 Note, common variables (variables which have not been initialised) and
15473 constants are not placed into the small data area as they are assigned
15474 to other sections in the output executeable.
15476 The default value is zero, which disables this feature.  Note, this
15477 feature is not enabled by default with higher optimization levels
15478 (@option{-O2} etc) because of the potentially deterimental effects of
15479 reserving register @code{r13}.  It is up to the programmer to
15480 experiment and discover whether this feature is of benefit to their
15481 program.
15483 @item -msim
15484 @item -mno-sim
15485 @opindex msim
15486 @opindex mno-sim
15487 Use the simulator runtime.  The default is to use the libgloss board
15488 specific runtime.
15490 @item -mas100-syntax
15491 @item -mno-as100-syntax
15492 @opindex mas100-syntax
15493 @opindex mno-as100-syntax
15494 When generating assembler output use a syntax that is compatible with
15495 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15496 assembler but it has some restrictions so generating it is not the
15497 default option.
15499 @item -mmax-constant-size=@var{N}
15500 @opindex mmax-constant-size
15501 Specifies the maxium size, in bytes, of a constant that can be used as
15502 an operand in a RX instruction.  Although the RX instruction set does
15503 allow consants of up to 4 bytes in length to be used in instructions,
15504 a longer value equates to a longer instruction.  Thus in some
15505 circumstances it can be beneficial to restrict the size of constants
15506 that are used in instructions.  Constants that are too big are instead
15507 placed into a constant pool and referenced via register indirection.
15509 The value @var{N} can be between 0 and 3.  A value of 0, the default,
15510 means that constants of any size are allowed.
15512 @item -mrelax
15513 @opindex mrelax
15514 Enable linker relaxation.  Linker relaxation is a process whereby the
15515 linker will attempt to reduce the size of a program by finding shorter
15516 versions of various instructions.  Disabled by default.
15518 @item -mint-register=@var{N}
15519 @opindex mint-register
15520 Specify the number of registers to reserve for fast interrupt handler
15521 functions.  The value @var{N} can be between 0 and 4.  A value of 1
15522 means that register @code{r13} will be reserved for ther exclusive use
15523 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
15524 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
15525 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
15526 A value of 0, the default, does not reserve any registers.
15528 @item -msave-acc-in-interrupts
15529 @opindex msave-acc-in-interrupts
15530 Specifies that interrupt handler functions should preserve the
15531 accumulator register.  This is only necessary if normal code might use
15532 the accumulator register, for example because it performs 64-bit
15533 multiplications.  The default is to ignore the accumulator as this
15534 makes the interrupt handlers faster.
15536 @end table
15538 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
15539 has special significance to the RX port when used with the
15540 @code{interrupt} function attribute.  This attribute indicates a
15541 function intended to process fast interrupts.  GCC will will ensure
15542 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
15543 and/or @code{r13} and only provided that the normal use of the
15544 corresponding registers have been restricted via the
15545 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
15546 options.
15548 @node S/390 and zSeries Options
15549 @subsection S/390 and zSeries Options
15550 @cindex S/390 and zSeries Options
15552 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15554 @table @gcctabopt
15555 @item -mhard-float
15556 @itemx -msoft-float
15557 @opindex mhard-float
15558 @opindex msoft-float
15559 Use (do not use) the hardware floating-point instructions and registers
15560 for floating-point operations.  When @option{-msoft-float} is specified,
15561 functions in @file{libgcc.a} will be used to perform floating-point
15562 operations.  When @option{-mhard-float} is specified, the compiler
15563 generates IEEE floating-point instructions.  This is the default.
15565 @item -mhard-dfp
15566 @itemx -mno-hard-dfp
15567 @opindex mhard-dfp
15568 @opindex mno-hard-dfp
15569 Use (do not use) the hardware decimal-floating-point instructions for
15570 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15571 specified, functions in @file{libgcc.a} will be used to perform
15572 decimal-floating-point operations.  When @option{-mhard-dfp} is
15573 specified, the compiler generates decimal-floating-point hardware
15574 instructions.  This is the default for @option{-march=z9-ec} or higher.
15576 @item -mlong-double-64
15577 @itemx -mlong-double-128
15578 @opindex mlong-double-64
15579 @opindex mlong-double-128
15580 These switches control the size of @code{long double} type. A size
15581 of 64bit makes the @code{long double} type equivalent to the @code{double}
15582 type. This is the default.
15584 @item -mbackchain
15585 @itemx -mno-backchain
15586 @opindex mbackchain
15587 @opindex mno-backchain
15588 Store (do not store) the address of the caller's frame as backchain pointer
15589 into the callee's stack frame.
15590 A backchain may be needed to allow debugging using tools that do not understand
15591 DWARF-2 call frame information.
15592 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15593 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15594 the backchain is placed into the topmost word of the 96/160 byte register
15595 save area.
15597 In general, code compiled with @option{-mbackchain} is call-compatible with
15598 code compiled with @option{-mmo-backchain}; however, use of the backchain
15599 for debugging purposes usually requires that the whole binary is built with
15600 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15601 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15602 to build a linux kernel use @option{-msoft-float}.
15604 The default is to not maintain the backchain.
15606 @item -mpacked-stack
15607 @itemx -mno-packed-stack
15608 @opindex mpacked-stack
15609 @opindex mno-packed-stack
15610 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15611 specified, the compiler uses the all fields of the 96/160 byte register save
15612 area only for their default purpose; unused fields still take up stack space.
15613 When @option{-mpacked-stack} is specified, register save slots are densely
15614 packed at the top of the register save area; unused space is reused for other
15615 purposes, allowing for more efficient use of the available stack space.
15616 However, when @option{-mbackchain} is also in effect, the topmost word of
15617 the save area is always used to store the backchain, and the return address
15618 register is always saved two words below the backchain.
15620 As long as the stack frame backchain is not used, code generated with
15621 @option{-mpacked-stack} is call-compatible with code generated with
15622 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15623 S/390 or zSeries generated code that uses the stack frame backchain at run
15624 time, not just for debugging purposes.  Such code is not call-compatible
15625 with code compiled with @option{-mpacked-stack}.  Also, note that the
15626 combination of @option{-mbackchain},
15627 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15628 to build a linux kernel use @option{-msoft-float}.
15630 The default is to not use the packed stack layout.
15632 @item -msmall-exec
15633 @itemx -mno-small-exec
15634 @opindex msmall-exec
15635 @opindex mno-small-exec
15636 Generate (or do not generate) code using the @code{bras} instruction
15637 to do subroutine calls.
15638 This only works reliably if the total executable size does not
15639 exceed 64k.  The default is to use the @code{basr} instruction instead,
15640 which does not have this limitation.
15642 @item -m64
15643 @itemx -m31
15644 @opindex m64
15645 @opindex m31
15646 When @option{-m31} is specified, generate code compliant to the
15647 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15648 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15649 particular to generate 64-bit instructions.  For the @samp{s390}
15650 targets, the default is @option{-m31}, while the @samp{s390x}
15651 targets default to @option{-m64}.
15653 @item -mzarch
15654 @itemx -mesa
15655 @opindex mzarch
15656 @opindex mesa
15657 When @option{-mzarch} is specified, generate code using the
15658 instructions available on z/Architecture.
15659 When @option{-mesa} is specified, generate code using the
15660 instructions available on ESA/390.  Note that @option{-mesa} is
15661 not possible with @option{-m64}.
15662 When generating code compliant to the GNU/Linux for S/390 ABI,
15663 the default is @option{-mesa}.  When generating code compliant
15664 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15666 @item -mmvcle
15667 @itemx -mno-mvcle
15668 @opindex mmvcle
15669 @opindex mno-mvcle
15670 Generate (or do not generate) code using the @code{mvcle} instruction
15671 to perform block moves.  When @option{-mno-mvcle} is specified,
15672 use a @code{mvc} loop instead.  This is the default unless optimizing for
15673 size.
15675 @item -mdebug
15676 @itemx -mno-debug
15677 @opindex mdebug
15678 @opindex mno-debug
15679 Print (or do not print) additional debug information when compiling.
15680 The default is to not print debug information.
15682 @item -march=@var{cpu-type}
15683 @opindex march
15684 Generate code that will run on @var{cpu-type}, which is the name of a system
15685 representing a certain processor type.  Possible values for
15686 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15687 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15688 When generating code using the instructions available on z/Architecture,
15689 the default is @option{-march=z900}.  Otherwise, the default is
15690 @option{-march=g5}.
15692 @item -mtune=@var{cpu-type}
15693 @opindex mtune
15694 Tune to @var{cpu-type} everything applicable about the generated code,
15695 except for the ABI and the set of available instructions.
15696 The list of @var{cpu-type} values is the same as for @option{-march}.
15697 The default is the value used for @option{-march}.
15699 @item -mtpf-trace
15700 @itemx -mno-tpf-trace
15701 @opindex mtpf-trace
15702 @opindex mno-tpf-trace
15703 Generate code that adds (does not add) in TPF OS specific branches to trace
15704 routines in the operating system.  This option is off by default, even
15705 when compiling for the TPF OS@.
15707 @item -mfused-madd
15708 @itemx -mno-fused-madd
15709 @opindex mfused-madd
15710 @opindex mno-fused-madd
15711 Generate code that uses (does not use) the floating point multiply and
15712 accumulate instructions.  These instructions are generated by default if
15713 hardware floating point is used.
15715 @item -mwarn-framesize=@var{framesize}
15716 @opindex mwarn-framesize
15717 Emit a warning if the current function exceeds the given frame size.  Because
15718 this is a compile time check it doesn't need to be a real problem when the program
15719 runs.  It is intended to identify functions which most probably cause
15720 a stack overflow.  It is useful to be used in an environment with limited stack
15721 size e.g.@: the linux kernel.
15723 @item -mwarn-dynamicstack
15724 @opindex mwarn-dynamicstack
15725 Emit a warning if the function calls alloca or uses dynamically
15726 sized arrays.  This is generally a bad idea with a limited stack size.
15728 @item -mstack-guard=@var{stack-guard}
15729 @itemx -mstack-size=@var{stack-size}
15730 @opindex mstack-guard
15731 @opindex mstack-size
15732 If these options are provided the s390 back end emits additional instructions in
15733 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15734 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15735 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15736 the frame size of the compiled function is chosen.
15737 These options are intended to be used to help debugging stack overflow problems.
15738 The additionally emitted code causes only little overhead and hence can also be
15739 used in production like systems without greater performance degradation.  The given
15740 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15741 @var{stack-guard} without exceeding 64k.
15742 In order to be efficient the extra code makes the assumption that the stack starts
15743 at an address aligned to the value given by @var{stack-size}.
15744 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15745 @end table
15747 @node Score Options
15748 @subsection Score Options
15749 @cindex Score Options
15751 These options are defined for Score implementations:
15753 @table @gcctabopt
15754 @item -meb
15755 @opindex meb
15756 Compile code for big endian mode.  This is the default.
15758 @item -mel
15759 @opindex mel
15760 Compile code for little endian mode.
15762 @item -mnhwloop
15763 @opindex mnhwloop
15764 Disable generate bcnz instruction.
15766 @item -muls
15767 @opindex muls
15768 Enable generate unaligned load and store instruction.
15770 @item -mmac
15771 @opindex mmac
15772 Enable the use of multiply-accumulate instructions. Disabled by default.
15774 @item -mscore5
15775 @opindex mscore5
15776 Specify the SCORE5 as the target architecture.
15778 @item -mscore5u
15779 @opindex mscore5u
15780 Specify the SCORE5U of the target architecture.
15782 @item -mscore7
15783 @opindex mscore7
15784 Specify the SCORE7 as the target architecture. This is the default.
15786 @item -mscore7d
15787 @opindex mscore7d
15788 Specify the SCORE7D as the target architecture.
15789 @end table
15791 @node SH Options
15792 @subsection SH Options
15794 These @samp{-m} options are defined for the SH implementations:
15796 @table @gcctabopt
15797 @item -m1
15798 @opindex m1
15799 Generate code for the SH1.
15801 @item -m2
15802 @opindex m2
15803 Generate code for the SH2.
15805 @item -m2e
15806 Generate code for the SH2e.
15808 @item -m2a-nofpu
15809 @opindex m2a-nofpu
15810 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15811 that the floating-point unit is not used.
15813 @item -m2a-single-only
15814 @opindex m2a-single-only
15815 Generate code for the SH2a-FPU, in such a way that no double-precision
15816 floating point operations are used.
15818 @item -m2a-single
15819 @opindex m2a-single
15820 Generate code for the SH2a-FPU assuming the floating-point unit is in
15821 single-precision mode by default.
15823 @item -m2a
15824 @opindex m2a
15825 Generate code for the SH2a-FPU assuming the floating-point unit is in
15826 double-precision mode by default.
15828 @item -m3
15829 @opindex m3
15830 Generate code for the SH3.
15832 @item -m3e
15833 @opindex m3e
15834 Generate code for the SH3e.
15836 @item -m4-nofpu
15837 @opindex m4-nofpu
15838 Generate code for the SH4 without a floating-point unit.
15840 @item -m4-single-only
15841 @opindex m4-single-only
15842 Generate code for the SH4 with a floating-point unit that only
15843 supports single-precision arithmetic.
15845 @item -m4-single
15846 @opindex m4-single
15847 Generate code for the SH4 assuming the floating-point unit is in
15848 single-precision mode by default.
15850 @item -m4
15851 @opindex m4
15852 Generate code for the SH4.
15854 @item -m4a-nofpu
15855 @opindex m4a-nofpu
15856 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
15857 floating-point unit is not used.
15859 @item -m4a-single-only
15860 @opindex m4a-single-only
15861 Generate code for the SH4a, in such a way that no double-precision
15862 floating point operations are used.
15864 @item -m4a-single
15865 @opindex m4a-single
15866 Generate code for the SH4a assuming the floating-point unit is in
15867 single-precision mode by default.
15869 @item -m4a
15870 @opindex m4a
15871 Generate code for the SH4a.
15873 @item -m4al
15874 @opindex m4al
15875 Same as @option{-m4a-nofpu}, except that it implicitly passes
15876 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
15877 instructions at the moment.
15879 @item -mb
15880 @opindex mb
15881 Compile code for the processor in big endian mode.
15883 @item -ml
15884 @opindex ml
15885 Compile code for the processor in little endian mode.
15887 @item -mdalign
15888 @opindex mdalign
15889 Align doubles at 64-bit boundaries.  Note that this changes the calling
15890 conventions, and thus some functions from the standard C library will
15891 not work unless you recompile it first with @option{-mdalign}.
15893 @item -mrelax
15894 @opindex mrelax
15895 Shorten some address references at link time, when possible; uses the
15896 linker option @option{-relax}.
15898 @item -mbigtable
15899 @opindex mbigtable
15900 Use 32-bit offsets in @code{switch} tables.  The default is to use
15901 16-bit offsets.
15903 @item -mbitops
15904 @opindex mbitops
15905 Enable the use of bit manipulation instructions on SH2A.
15907 @item -mfmovd
15908 @opindex mfmovd
15909 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
15910 alignment constraints.
15912 @item -mhitachi
15913 @opindex mhitachi
15914 Comply with the calling conventions defined by Renesas.
15916 @item -mrenesas
15917 @opindex mhitachi
15918 Comply with the calling conventions defined by Renesas.
15920 @item -mno-renesas
15921 @opindex mhitachi
15922 Comply with the calling conventions defined for GCC before the Renesas
15923 conventions were available.  This option is the default for all
15924 targets of the SH toolchain except for @samp{sh-symbianelf}.
15926 @item -mnomacsave
15927 @opindex mnomacsave
15928 Mark the @code{MAC} register as call-clobbered, even if
15929 @option{-mhitachi} is given.
15931 @item -mieee
15932 @opindex mieee
15933 Increase IEEE-compliance of floating-point code.
15934 At the moment, this is equivalent to @option{-fno-finite-math-only}.
15935 When generating 16 bit SH opcodes, getting IEEE-conforming results for
15936 comparisons of NANs / infinities incurs extra overhead in every
15937 floating point comparison, therefore the default is set to
15938 @option{-ffinite-math-only}.
15940 @item -minline-ic_invalidate
15941 @opindex minline-ic_invalidate
15942 Inline code to invalidate instruction cache entries after setting up
15943 nested function trampolines.
15944 This option has no effect if -musermode is in effect and the selected
15945 code generation option (e.g. -m4) does not allow the use of the icbi
15946 instruction.
15947 If the selected code generation option does not allow the use of the icbi
15948 instruction, and -musermode is not in effect, the inlined code will
15949 manipulate the instruction cache address array directly with an associative
15950 write.  This not only requires privileged mode, but it will also
15951 fail if the cache line had been mapped via the TLB and has become unmapped.
15953 @item -misize
15954 @opindex misize
15955 Dump instruction size and location in the assembly code.
15957 @item -mpadstruct
15958 @opindex mpadstruct
15959 This option is deprecated.  It pads structures to multiple of 4 bytes,
15960 which is incompatible with the SH ABI@.
15962 @item -mspace
15963 @opindex mspace
15964 Optimize for space instead of speed.  Implied by @option{-Os}.
15966 @item -mprefergot
15967 @opindex mprefergot
15968 When generating position-independent code, emit function calls using
15969 the Global Offset Table instead of the Procedure Linkage Table.
15971 @item -musermode
15972 @opindex musermode
15973 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
15974 if the inlined code would not work in user mode.
15975 This is the default when the target is @code{sh-*-linux*}.
15977 @item -multcost=@var{number}
15978 @opindex multcost=@var{number}
15979 Set the cost to assume for a multiply insn.
15981 @item -mdiv=@var{strategy}
15982 @opindex mdiv=@var{strategy}
15983 Set the division strategy to use for SHmedia code.  @var{strategy} must be
15984 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
15985 inv:call2, inv:fp .
15986 "fp" performs the operation in floating point.  This has a very high latency,
15987 but needs only a few instructions, so it might be a good choice if
15988 your code has enough easily exploitable ILP to allow the compiler to
15989 schedule the floating point instructions together with other instructions.
15990 Division by zero causes a floating point exception.
15991 "inv" uses integer operations to calculate the inverse of the divisor,
15992 and then multiplies the dividend with the inverse.  This strategy allows
15993 cse and hoisting of the inverse calculation.  Division by zero calculates
15994 an unspecified result, but does not trap.
15995 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
15996 have been found, or if the entire operation has been hoisted to the same
15997 place, the last stages of the inverse calculation are intertwined with the
15998 final multiply to reduce the overall latency, at the expense of using a few
15999 more instructions, and thus offering fewer scheduling opportunities with
16000 other code.
16001 "call" calls a library function that usually implements the inv:minlat
16002 strategy.
16003 This gives high code density for m5-*media-nofpu compilations.
16004 "call2" uses a different entry point of the same library function, where it
16005 assumes that a pointer to a lookup table has already been set up, which
16006 exposes the pointer load to cse / code hoisting optimizations.
16007 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16008 code generation, but if the code stays unoptimized, revert to the "call",
16009 "call2", or "fp" strategies, respectively.  Note that the
16010 potentially-trapping side effect of division by zero is carried by a
16011 separate instruction, so it is possible that all the integer instructions
16012 are hoisted out, but the marker for the side effect stays where it is.
16013 A recombination to fp operations or a call is not possible in that case.
16014 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16015 that the inverse calculation was nor separated from the multiply, they speed
16016 up division where the dividend fits into 20 bits (plus sign where applicable),
16017 by inserting a test to skip a number of operations in this case; this test
16018 slows down the case of larger dividends.  inv20u assumes the case of a such
16019 a small dividend to be unlikely, and inv20l assumes it to be likely.
16021 @item -mdivsi3_libfunc=@var{name}
16022 @opindex mdivsi3_libfunc=@var{name}
16023 Set the name of the library function used for 32 bit signed division to
16024 @var{name}.  This only affect the name used in the call and inv:call
16025 division strategies, and the compiler will still expect the same
16026 sets of input/output/clobbered registers as if this option was not present.
16028 @item -mfixed-range=@var{register-range}
16029 @opindex mfixed-range
16030 Generate code treating the given register range as fixed registers.
16031 A fixed register is one that the register allocator can not use.  This is
16032 useful when compiling kernel code.  A register range is specified as
16033 two registers separated by a dash.  Multiple register ranges can be
16034 specified separated by a comma.
16036 @item -madjust-unroll
16037 @opindex madjust-unroll
16038 Throttle unrolling to avoid thrashing target registers.
16039 This option only has an effect if the gcc code base supports the
16040 TARGET_ADJUST_UNROLL_MAX target hook.
16042 @item -mindexed-addressing
16043 @opindex mindexed-addressing
16044 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16045 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16046 semantics for the indexed addressing mode.  The architecture allows the
16047 implementation of processors with 64 bit MMU, which the OS could use to
16048 get 32 bit addressing, but since no current hardware implementation supports
16049 this or any other way to make the indexed addressing mode safe to use in
16050 the 32 bit ABI, the default is -mno-indexed-addressing.
16052 @item -mgettrcost=@var{number}
16053 @opindex mgettrcost=@var{number}
16054 Set the cost assumed for the gettr instruction to @var{number}.
16055 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16057 @item -mpt-fixed
16058 @opindex mpt-fixed
16059 Assume pt* instructions won't trap.  This will generally generate better
16060 scheduled code, but is unsafe on current hardware.  The current architecture
16061 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16062 This has the unintentional effect of making it unsafe to schedule ptabs /
16063 ptrel before a branch, or hoist it out of a loop.  For example,
16064 __do_global_ctors, a part of libgcc that runs constructors at program
16065 startup, calls functions in a list which is delimited by @minus{}1.  With the
16066 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16067 That means that all the constructors will be run a bit quicker, but when
16068 the loop comes to the end of the list, the program crashes because ptabs
16069 loads @minus{}1 into a target register.  Since this option is unsafe for any
16070 hardware implementing the current architecture specification, the default
16071 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16072 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16073 this deters register allocation using target registers for storing
16074 ordinary integers.
16076 @item -minvalid-symbols
16077 @opindex minvalid-symbols
16078 Assume symbols might be invalid.  Ordinary function symbols generated by
16079 the compiler will always be valid to load with movi/shori/ptabs or
16080 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16081 to generate symbols that will cause ptabs / ptrel to trap.
16082 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16083 It will then prevent cross-basic-block cse, hoisting and most scheduling
16084 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16085 @end table
16087 @node SPARC Options
16088 @subsection SPARC Options
16089 @cindex SPARC options
16091 These @samp{-m} options are supported on the SPARC:
16093 @table @gcctabopt
16094 @item -mno-app-regs
16095 @itemx -mapp-regs
16096 @opindex mno-app-regs
16097 @opindex mapp-regs
16098 Specify @option{-mapp-regs} to generate output using the global registers
16099 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16100 is the default.
16102 To be fully SVR4 ABI compliant at the cost of some performance loss,
16103 specify @option{-mno-app-regs}.  You should compile libraries and system
16104 software with this option.
16106 @item -mfpu
16107 @itemx -mhard-float
16108 @opindex mfpu
16109 @opindex mhard-float
16110 Generate output containing floating point instructions.  This is the
16111 default.
16113 @item -mno-fpu
16114 @itemx -msoft-float
16115 @opindex mno-fpu
16116 @opindex msoft-float
16117 Generate output containing library calls for floating point.
16118 @strong{Warning:} the requisite libraries are not available for all SPARC
16119 targets.  Normally the facilities of the machine's usual C compiler are
16120 used, but this cannot be done directly in cross-compilation.  You must make
16121 your own arrangements to provide suitable library functions for
16122 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16123 @samp{sparclite-*-*} do provide software floating point support.
16125 @option{-msoft-float} changes the calling convention in the output file;
16126 therefore, it is only useful if you compile @emph{all} of a program with
16127 this option.  In particular, you need to compile @file{libgcc.a}, the
16128 library that comes with GCC, with @option{-msoft-float} in order for
16129 this to work.
16131 @item -mhard-quad-float
16132 @opindex mhard-quad-float
16133 Generate output containing quad-word (long double) floating point
16134 instructions.
16136 @item -msoft-quad-float
16137 @opindex msoft-quad-float
16138 Generate output containing library calls for quad-word (long double)
16139 floating point instructions.  The functions called are those specified
16140 in the SPARC ABI@.  This is the default.
16142 As of this writing, there are no SPARC implementations that have hardware
16143 support for the quad-word floating point instructions.  They all invoke
16144 a trap handler for one of these instructions, and then the trap handler
16145 emulates the effect of the instruction.  Because of the trap handler overhead,
16146 this is much slower than calling the ABI library routines.  Thus the
16147 @option{-msoft-quad-float} option is the default.
16149 @item -mno-unaligned-doubles
16150 @itemx -munaligned-doubles
16151 @opindex mno-unaligned-doubles
16152 @opindex munaligned-doubles
16153 Assume that doubles have 8 byte alignment.  This is the default.
16155 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16156 alignment only if they are contained in another type, or if they have an
16157 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16158 Specifying this option avoids some rare compatibility problems with code
16159 generated by other compilers.  It is not the default because it results
16160 in a performance loss, especially for floating point code.
16162 @item -mno-faster-structs
16163 @itemx -mfaster-structs
16164 @opindex mno-faster-structs
16165 @opindex mfaster-structs
16166 With @option{-mfaster-structs}, the compiler assumes that structures
16167 should have 8 byte alignment.  This enables the use of pairs of
16168 @code{ldd} and @code{std} instructions for copies in structure
16169 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16170 However, the use of this changed alignment directly violates the SPARC
16171 ABI@.  Thus, it's intended only for use on targets where the developer
16172 acknowledges that their resulting code will not be directly in line with
16173 the rules of the ABI@.
16175 @item -mimpure-text
16176 @opindex mimpure-text
16177 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16178 the compiler to not pass @option{-z text} to the linker when linking a
16179 shared object.  Using this option, you can link position-dependent
16180 code into a shared object.
16182 @option{-mimpure-text} suppresses the ``relocations remain against
16183 allocatable but non-writable sections'' linker error message.
16184 However, the necessary relocations will trigger copy-on-write, and the
16185 shared object is not actually shared across processes.  Instead of
16186 using @option{-mimpure-text}, you should compile all source code with
16187 @option{-fpic} or @option{-fPIC}.
16189 This option is only available on SunOS and Solaris.
16191 @item -mcpu=@var{cpu_type}
16192 @opindex mcpu
16193 Set the instruction set, register set, and instruction scheduling parameters
16194 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16195 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16196 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16197 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16198 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16200 Default instruction scheduling parameters are used for values that select
16201 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16202 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16204 Here is a list of each supported architecture and their supported
16205 implementations.
16207 @smallexample
16208     v7:             cypress
16209     v8:             supersparc, hypersparc
16210     sparclite:      f930, f934, sparclite86x
16211     sparclet:       tsc701
16212     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16213 @end smallexample
16215 By default (unless configured otherwise), GCC generates code for the V7
16216 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16217 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16218 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16219 SPARCStation 1, 2, IPX etc.
16221 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16222 architecture.  The only difference from V7 code is that the compiler emits
16223 the integer multiply and integer divide instructions which exist in SPARC-V8
16224 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16225 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16226 2000 series.
16228 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16229 the SPARC architecture.  This adds the integer multiply, integer divide step
16230 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16231 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16232 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16233 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16234 MB86934 chip, which is the more recent SPARClite with FPU@.
16236 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16237 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16238 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16239 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16240 optimizes it for the TEMIC SPARClet chip.
16242 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16243 architecture.  This adds 64-bit integer and floating-point move instructions,
16244 3 additional floating-point condition code registers and conditional move
16245 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16246 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16247 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16248 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16249 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16250 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16251 additionally optimizes it for Sun UltraSPARC T2 chips.
16253 @item -mtune=@var{cpu_type}
16254 @opindex mtune
16255 Set the instruction scheduling parameters for machine type
16256 @var{cpu_type}, but do not set the instruction set or register set that the
16257 option @option{-mcpu=@var{cpu_type}} would.
16259 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16260 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16261 that select a particular cpu implementation.  Those are @samp{cypress},
16262 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16263 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16264 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16266 @item -mv8plus
16267 @itemx -mno-v8plus
16268 @opindex mv8plus
16269 @opindex mno-v8plus
16270 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16271 difference from the V8 ABI is that the global and out registers are
16272 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16273 mode for all SPARC-V9 processors.
16275 @item -mvis
16276 @itemx -mno-vis
16277 @opindex mvis
16278 @opindex mno-vis
16279 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16280 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16281 @end table
16283 These @samp{-m} options are supported in addition to the above
16284 on SPARC-V9 processors in 64-bit environments:
16286 @table @gcctabopt
16287 @item -mlittle-endian
16288 @opindex mlittle-endian
16289 Generate code for a processor running in little-endian mode.  It is only
16290 available for a few configurations and most notably not on Solaris and Linux.
16292 @item -m32
16293 @itemx -m64
16294 @opindex m32
16295 @opindex m64
16296 Generate code for a 32-bit or 64-bit environment.
16297 The 32-bit environment sets int, long and pointer to 32 bits.
16298 The 64-bit environment sets int to 32 bits and long and pointer
16299 to 64 bits.
16301 @item -mcmodel=medlow
16302 @opindex mcmodel=medlow
16303 Generate code for the Medium/Low code model: 64-bit addresses, programs
16304 must be linked in the low 32 bits of memory.  Programs can be statically
16305 or dynamically linked.
16307 @item -mcmodel=medmid
16308 @opindex mcmodel=medmid
16309 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16310 must be linked in the low 44 bits of memory, the text and data segments must
16311 be less than 2GB in size and the data segment must be located within 2GB of
16312 the text segment.
16314 @item -mcmodel=medany
16315 @opindex mcmodel=medany
16316 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16317 may be linked anywhere in memory, the text and data segments must be less
16318 than 2GB in size and the data segment must be located within 2GB of the
16319 text segment.
16321 @item -mcmodel=embmedany
16322 @opindex mcmodel=embmedany
16323 Generate code for the Medium/Anywhere code model for embedded systems:
16324 64-bit addresses, the text and data segments must be less than 2GB in
16325 size, both starting anywhere in memory (determined at link time).  The
16326 global register %g4 points to the base of the data segment.  Programs
16327 are statically linked and PIC is not supported.
16329 @item -mstack-bias
16330 @itemx -mno-stack-bias
16331 @opindex mstack-bias
16332 @opindex mno-stack-bias
16333 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16334 frame pointer if present, are offset by @minus{}2047 which must be added back
16335 when making stack frame references.  This is the default in 64-bit mode.
16336 Otherwise, assume no such offset is present.
16337 @end table
16339 These switches are supported in addition to the above on Solaris:
16341 @table @gcctabopt
16342 @item -threads
16343 @opindex threads
16344 Add support for multithreading using the Solaris threads library.  This
16345 option sets flags for both the preprocessor and linker.  This option does
16346 not affect the thread safety of object code produced by the compiler or
16347 that of libraries supplied with it.
16349 @item -pthreads
16350 @opindex pthreads
16351 Add support for multithreading using the POSIX threads library.  This
16352 option sets flags for both the preprocessor and linker.  This option does
16353 not affect the thread safety of object code produced  by the compiler or
16354 that of libraries supplied with it.
16356 @item -pthread
16357 @opindex pthread
16358 This is a synonym for @option{-pthreads}.
16359 @end table
16361 @node SPU Options
16362 @subsection SPU Options
16363 @cindex SPU options
16365 These @samp{-m} options are supported on the SPU:
16367 @table @gcctabopt
16368 @item -mwarn-reloc
16369 @itemx -merror-reloc
16370 @opindex mwarn-reloc
16371 @opindex merror-reloc
16373 The loader for SPU does not handle dynamic relocations.  By default, GCC
16374 will give an error when it generates code that requires a dynamic
16375 relocation.  @option{-mno-error-reloc} disables the error,
16376 @option{-mwarn-reloc} will generate a warning instead.
16378 @item -msafe-dma
16379 @itemx -munsafe-dma
16380 @opindex msafe-dma
16381 @opindex munsafe-dma
16383 Instructions which initiate or test completion of DMA must not be
16384 reordered with respect to loads and stores of the memory which is being
16385 accessed.  Users typically address this problem using the volatile
16386 keyword, but that can lead to inefficient code in places where the
16387 memory is known to not change.  Rather than mark the memory as volatile
16388 we treat the DMA instructions as potentially effecting all memory.  With
16389 @option{-munsafe-dma} users must use the volatile keyword to protect
16390 memory accesses.
16392 @item -mbranch-hints
16393 @opindex mbranch-hints
16395 By default, GCC will generate a branch hint instruction to avoid
16396 pipeline stalls for always taken or probably taken branches.  A hint
16397 will not be generated closer than 8 instructions away from its branch.
16398 There is little reason to disable them, except for debugging purposes,
16399 or to make an object a little bit smaller.
16401 @item -msmall-mem
16402 @itemx -mlarge-mem
16403 @opindex msmall-mem
16404 @opindex mlarge-mem
16406 By default, GCC generates code assuming that addresses are never larger
16407 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16408 a full 32 bit address.
16410 @item -mstdmain
16411 @opindex mstdmain
16413 By default, GCC links against startup code that assumes the SPU-style
16414 main function interface (which has an unconventional parameter list).
16415 With @option{-mstdmain}, GCC will link your program against startup
16416 code that assumes a C99-style interface to @code{main}, including a
16417 local copy of @code{argv} strings.
16419 @item -mfixed-range=@var{register-range}
16420 @opindex mfixed-range
16421 Generate code treating the given register range as fixed registers.
16422 A fixed register is one that the register allocator can not use.  This is
16423 useful when compiling kernel code.  A register range is specified as
16424 two registers separated by a dash.  Multiple register ranges can be
16425 specified separated by a comma.
16427 @item -mea32
16428 @itemx -mea64
16429 @opindex mea32
16430 @opindex mea64
16431 Compile code assuming that pointers to the PPU address space accessed
16432 via the @code{__ea} named address space qualifier are either 32 or 64
16433 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16434 all object code in an executable must be compiled with the same setting.
16436 @item -maddress-space-conversion
16437 @itemx -mno-address-space-conversion
16438 @opindex maddress-space-conversion
16439 @opindex mno-address-space-conversion
16440 Allow/disallow treating the @code{__ea} address space as superset
16441 of the generic address space.  This enables explicit type casts
16442 between @code{__ea} and generic pointer as well as implicit
16443 conversions of generic pointers to @code{__ea} pointers.  The
16444 default is to allow address space pointer conversions.
16446 @item -mcache-size=@var{cache-size}
16447 @opindex mcache-size
16448 This option controls the version of libgcc that the compiler links to an
16449 executable and selects a software-managed cache for accessing variables
16450 in the @code{__ea} address space with a particular cache size.  Possible
16451 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16452 and @samp{128}.  The default cache size is 64KB.
16454 @item -matomic-updates
16455 @itemx -mno-atomic-updates
16456 @opindex matomic-updates
16457 @opindex mno-atomic-updates
16458 This option controls the version of libgcc that the compiler links to an
16459 executable and selects whether atomic updates to the software-managed
16460 cache of PPU-side variables are used.  If you use atomic updates, changes
16461 to a PPU variable from SPU code using the @code{__ea} named address space
16462 qualifier will not interfere with changes to other PPU variables residing
16463 in the same cache line from PPU code.  If you do not use atomic updates,
16464 such interference may occur; however, writing back cache lines will be
16465 more efficient.  The default behavior is to use atomic updates.
16467 @item -mdual-nops
16468 @itemx -mdual-nops=@var{n}
16469 @opindex mdual-nops
16470 By default, GCC will insert nops to increase dual issue when it expects
16471 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16472 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16473 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16475 @item -mhint-max-nops=@var{n}
16476 @opindex mhint-max-nops
16477 Maximum number of nops to insert for a branch hint.  A branch hint must
16478 be at least 8 instructions away from the branch it is effecting.  GCC
16479 will insert up to @var{n} nops to enforce this, otherwise it will not
16480 generate the branch hint.
16482 @item -mhint-max-distance=@var{n}
16483 @opindex mhint-max-distance
16484 The encoding of the branch hint instruction limits the hint to be within
16485 256 instructions of the branch it is effecting.  By default, GCC makes
16486 sure it is within 125.
16488 @item -msafe-hints
16489 @opindex msafe-hints
16490 Work around a hardware bug which causes the SPU to stall indefinitely.
16491 By default, GCC will insert the @code{hbrp} instruction to make sure
16492 this stall won't happen.
16494 @end table
16496 @node System V Options
16497 @subsection Options for System V
16499 These additional options are available on System V Release 4 for
16500 compatibility with other compilers on those systems:
16502 @table @gcctabopt
16503 @item -G
16504 @opindex G
16505 Create a shared object.
16506 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16508 @item -Qy
16509 @opindex Qy
16510 Identify the versions of each tool used by the compiler, in a
16511 @code{.ident} assembler directive in the output.
16513 @item -Qn
16514 @opindex Qn
16515 Refrain from adding @code{.ident} directives to the output file (this is
16516 the default).
16518 @item -YP,@var{dirs}
16519 @opindex YP
16520 Search the directories @var{dirs}, and no others, for libraries
16521 specified with @option{-l}.
16523 @item -Ym,@var{dir}
16524 @opindex Ym
16525 Look in the directory @var{dir} to find the M4 preprocessor.
16526 The assembler uses this option.
16527 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16528 @c the generic assembler that comes with Solaris takes just -Ym.
16529 @end table
16531 @node V850 Options
16532 @subsection V850 Options
16533 @cindex V850 Options
16535 These @samp{-m} options are defined for V850 implementations:
16537 @table @gcctabopt
16538 @item -mlong-calls
16539 @itemx -mno-long-calls
16540 @opindex mlong-calls
16541 @opindex mno-long-calls
16542 Treat all calls as being far away (near).  If calls are assumed to be
16543 far away, the compiler will always load the functions address up into a
16544 register, and call indirect through the pointer.
16546 @item -mno-ep
16547 @itemx -mep
16548 @opindex mno-ep
16549 @opindex mep
16550 Do not optimize (do optimize) basic blocks that use the same index
16551 pointer 4 or more times to copy pointer into the @code{ep} register, and
16552 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16553 option is on by default if you optimize.
16555 @item -mno-prolog-function
16556 @itemx -mprolog-function
16557 @opindex mno-prolog-function
16558 @opindex mprolog-function
16559 Do not use (do use) external functions to save and restore registers
16560 at the prologue and epilogue of a function.  The external functions
16561 are slower, but use less code space if more than one function saves
16562 the same number of registers.  The @option{-mprolog-function} option
16563 is on by default if you optimize.
16565 @item -mspace
16566 @opindex mspace
16567 Try to make the code as small as possible.  At present, this just turns
16568 on the @option{-mep} and @option{-mprolog-function} options.
16570 @item -mtda=@var{n}
16571 @opindex mtda
16572 Put static or global variables whose size is @var{n} bytes or less into
16573 the tiny data area that register @code{ep} points to.  The tiny data
16574 area can hold up to 256 bytes in total (128 bytes for byte references).
16576 @item -msda=@var{n}
16577 @opindex msda
16578 Put static or global variables whose size is @var{n} bytes or less into
16579 the small data area that register @code{gp} points to.  The small data
16580 area can hold up to 64 kilobytes.
16582 @item -mzda=@var{n}
16583 @opindex mzda
16584 Put static or global variables whose size is @var{n} bytes or less into
16585 the first 32 kilobytes of memory.
16587 @item -mv850
16588 @opindex mv850
16589 Specify that the target processor is the V850.
16591 @item -mbig-switch
16592 @opindex mbig-switch
16593 Generate code suitable for big switch tables.  Use this option only if
16594 the assembler/linker complain about out of range branches within a switch
16595 table.
16597 @item -mapp-regs
16598 @opindex mapp-regs
16599 This option will cause r2 and r5 to be used in the code generated by
16600 the compiler.  This setting is the default.
16602 @item -mno-app-regs
16603 @opindex mno-app-regs
16604 This option will cause r2 and r5 to be treated as fixed registers.
16606 @item -mv850e1
16607 @opindex mv850e1
16608 Specify that the target processor is the V850E1.  The preprocessor
16609 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16610 this option is used.
16612 @item -mv850e
16613 @opindex mv850e
16614 Specify that the target processor is the V850E@.  The preprocessor
16615 constant @samp{__v850e__} will be defined if this option is used.
16617 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16618 are defined then a default target processor will be chosen and the
16619 relevant @samp{__v850*__} preprocessor constant will be defined.
16621 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16622 defined, regardless of which processor variant is the target.
16624 @item -mdisable-callt
16625 @opindex mdisable-callt
16626 This option will suppress generation of the CALLT instruction for the
16627 v850e and v850e1 flavors of the v850 architecture.  The default is
16628 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16630 @end table
16632 @node VAX Options
16633 @subsection VAX Options
16634 @cindex VAX options
16636 These @samp{-m} options are defined for the VAX:
16638 @table @gcctabopt
16639 @item -munix
16640 @opindex munix
16641 Do not output certain jump instructions (@code{aobleq} and so on)
16642 that the Unix assembler for the VAX cannot handle across long
16643 ranges.
16645 @item -mgnu
16646 @opindex mgnu
16647 Do output those jump instructions, on the assumption that you
16648 will assemble with the GNU assembler.
16650 @item -mg
16651 @opindex mg
16652 Output code for g-format floating point numbers instead of d-format.
16653 @end table
16655 @node VxWorks Options
16656 @subsection VxWorks Options
16657 @cindex VxWorks Options
16659 The options in this section are defined for all VxWorks targets.
16660 Options specific to the target hardware are listed with the other
16661 options for that target.
16663 @table @gcctabopt
16664 @item -mrtp
16665 @opindex mrtp
16666 GCC can generate code for both VxWorks kernels and real time processes
16667 (RTPs).  This option switches from the former to the latter.  It also
16668 defines the preprocessor macro @code{__RTP__}.
16670 @item -non-static
16671 @opindex non-static
16672 Link an RTP executable against shared libraries rather than static
16673 libraries.  The options @option{-static} and @option{-shared} can
16674 also be used for RTPs (@pxref{Link Options}); @option{-static}
16675 is the default.
16677 @item -Bstatic
16678 @itemx -Bdynamic
16679 @opindex Bstatic
16680 @opindex Bdynamic
16681 These options are passed down to the linker.  They are defined for
16682 compatibility with Diab.
16684 @item -Xbind-lazy
16685 @opindex Xbind-lazy
16686 Enable lazy binding of function calls.  This option is equivalent to
16687 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16689 @item -Xbind-now
16690 @opindex Xbind-now
16691 Disable lazy binding of function calls.  This option is the default and
16692 is defined for compatibility with Diab.
16693 @end table
16695 @node x86-64 Options
16696 @subsection x86-64 Options
16697 @cindex x86-64 options
16699 These are listed under @xref{i386 and x86-64 Options}.
16701 @node i386 and x86-64 Windows Options
16702 @subsection i386 and x86-64 Windows Options
16703 @cindex i386 and x86-64 Windows Options
16705 These additional options are available for Windows targets:
16707 @table @gcctabopt
16708 @item -mconsole
16709 @opindex mconsole
16710 This option is available for Cygwin and MinGW targets.  It
16711 specifies that a console application is to be generated, by
16712 instructing the linker to set the PE header subsystem type
16713 required for console applications.
16714 This is the default behavior for Cygwin and MinGW targets.
16716 @item -mcygwin
16717 @opindex mcygwin
16718 This option is available for Cygwin targets.  It specifies that
16719 the Cygwin internal interface is to be used for predefined
16720 preprocessor macros, C runtime libraries and related linker
16721 paths and options.  For Cygwin targets this is the default behavior.
16722 This option is deprecated and will be removed in a future release.
16724 @item -mno-cygwin
16725 @opindex mno-cygwin
16726 This option is available for Cygwin targets.  It specifies that
16727 the MinGW internal interface is to be used instead of Cygwin's, by
16728 setting MinGW-related predefined macros and linker paths and default
16729 library options.
16730 This option is deprecated and will be removed in a future release.
16732 @item -mdll
16733 @opindex mdll
16734 This option is available for Cygwin and MinGW targets.  It
16735 specifies that a DLL - a dynamic link library - is to be
16736 generated, enabling the selection of the required runtime
16737 startup object and entry point.
16739 @item -mnop-fun-dllimport
16740 @opindex mnop-fun-dllimport
16741 This option is available for Cygwin and MinGW targets.  It
16742 specifies that the dllimport attribute should be ignored.
16744 @item -mthread
16745 @opindex mthread
16746 This option is available for MinGW targets. It specifies
16747 that MinGW-specific thread support is to be used.
16749 @item -municode
16750 @opindex municode
16751 This option is available for mingw-w64 targets.  It specifies
16752 that the UNICODE macro is getting pre-defined and that the
16753 unicode capable runtime startup code is choosen.
16755 @item -mwin32
16756 @opindex mwin32
16757 This option is available for Cygwin and MinGW targets.  It
16758 specifies that the typical Windows pre-defined macros are to
16759 be set in the pre-processor, but does not influence the choice
16760 of runtime library/startup code.
16762 @item -mwindows
16763 @opindex mwindows
16764 This option is available for Cygwin and MinGW targets.  It
16765 specifies that a GUI application is to be generated by
16766 instructing the linker to set the PE header subsystem type
16767 appropriately.
16769 @item -fno-set-stack-executable
16770 @opindex fno-set-stack-executable
16771 This option is available for MinGW targets. It specifies that
16772 the executable flag for stack used by nested functions isn't
16773 set. This is necessary for binaries running in kernel mode of
16774 Windows, as there the user32 API, which is used to set executable
16775 privileges, isn't available.
16777 @item -mpe-aligned-commons
16778 @opindex mpe-aligned-commons
16779 This option is available for Cygwin and MinGW targets.  It
16780 specifies that the GNU extension to the PE file format that
16781 permits the correct alignment of COMMON variables should be
16782 used when generating code.  It will be enabled by default if
16783 GCC detects that the target assembler found during configuration
16784 supports the feature.
16785 @end table
16787 See also under @ref{i386 and x86-64 Options} for standard options.
16789 @node Xstormy16 Options
16790 @subsection Xstormy16 Options
16791 @cindex Xstormy16 Options
16793 These options are defined for Xstormy16:
16795 @table @gcctabopt
16796 @item -msim
16797 @opindex msim
16798 Choose startup files and linker script suitable for the simulator.
16799 @end table
16801 @node Xtensa Options
16802 @subsection Xtensa Options
16803 @cindex Xtensa Options
16805 These options are supported for Xtensa targets:
16807 @table @gcctabopt
16808 @item -mconst16
16809 @itemx -mno-const16
16810 @opindex mconst16
16811 @opindex mno-const16
16812 Enable or disable use of @code{CONST16} instructions for loading
16813 constant values.  The @code{CONST16} instruction is currently not a
16814 standard option from Tensilica.  When enabled, @code{CONST16}
16815 instructions are always used in place of the standard @code{L32R}
16816 instructions.  The use of @code{CONST16} is enabled by default only if
16817 the @code{L32R} instruction is not available.
16819 @item -mfused-madd
16820 @itemx -mno-fused-madd
16821 @opindex mfused-madd
16822 @opindex mno-fused-madd
16823 Enable or disable use of fused multiply/add and multiply/subtract
16824 instructions in the floating-point option.  This has no effect if the
16825 floating-point option is not also enabled.  Disabling fused multiply/add
16826 and multiply/subtract instructions forces the compiler to use separate
16827 instructions for the multiply and add/subtract operations.  This may be
16828 desirable in some cases where strict IEEE 754-compliant results are
16829 required: the fused multiply add/subtract instructions do not round the
16830 intermediate result, thereby producing results with @emph{more} bits of
16831 precision than specified by the IEEE standard.  Disabling fused multiply
16832 add/subtract instructions also ensures that the program output is not
16833 sensitive to the compiler's ability to combine multiply and add/subtract
16834 operations.
16836 @item -mserialize-volatile
16837 @itemx -mno-serialize-volatile
16838 @opindex mserialize-volatile
16839 @opindex mno-serialize-volatile
16840 When this option is enabled, GCC inserts @code{MEMW} instructions before
16841 @code{volatile} memory references to guarantee sequential consistency.
16842 The default is @option{-mserialize-volatile}.  Use
16843 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
16845 @item -mtext-section-literals
16846 @itemx -mno-text-section-literals
16847 @opindex mtext-section-literals
16848 @opindex mno-text-section-literals
16849 Control the treatment of literal pools.  The default is
16850 @option{-mno-text-section-literals}, which places literals in a separate
16851 section in the output file.  This allows the literal pool to be placed
16852 in a data RAM/ROM, and it also allows the linker to combine literal
16853 pools from separate object files to remove redundant literals and
16854 improve code size.  With @option{-mtext-section-literals}, the literals
16855 are interspersed in the text section in order to keep them as close as
16856 possible to their references.  This may be necessary for large assembly
16857 files.
16859 @item -mtarget-align
16860 @itemx -mno-target-align
16861 @opindex mtarget-align
16862 @opindex mno-target-align
16863 When this option is enabled, GCC instructs the assembler to
16864 automatically align instructions to reduce branch penalties at the
16865 expense of some code density.  The assembler attempts to widen density
16866 instructions to align branch targets and the instructions following call
16867 instructions.  If there are not enough preceding safe density
16868 instructions to align a target, no widening will be performed.  The
16869 default is @option{-mtarget-align}.  These options do not affect the
16870 treatment of auto-aligned instructions like @code{LOOP}, which the
16871 assembler will always align, either by widening density instructions or
16872 by inserting no-op instructions.
16874 @item -mlongcalls
16875 @itemx -mno-longcalls
16876 @opindex mlongcalls
16877 @opindex mno-longcalls
16878 When this option is enabled, GCC instructs the assembler to translate
16879 direct calls to indirect calls unless it can determine that the target
16880 of a direct call is in the range allowed by the call instruction.  This
16881 translation typically occurs for calls to functions in other source
16882 files.  Specifically, the assembler translates a direct @code{CALL}
16883 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
16884 The default is @option{-mno-longcalls}.  This option should be used in
16885 programs where the call target can potentially be out of range.  This
16886 option is implemented in the assembler, not the compiler, so the
16887 assembly code generated by GCC will still show direct call
16888 instructions---look at the disassembled object code to see the actual
16889 instructions.  Note that the assembler will use an indirect call for
16890 every cross-file call, not just those that really will be out of range.
16891 @end table
16893 @node zSeries Options
16894 @subsection zSeries Options
16895 @cindex zSeries options
16897 These are listed under @xref{S/390 and zSeries Options}.
16899 @node Code Gen Options
16900 @section Options for Code Generation Conventions
16901 @cindex code generation conventions
16902 @cindex options, code generation
16903 @cindex run-time options
16905 These machine-independent options control the interface conventions
16906 used in code generation.
16908 Most of them have both positive and negative forms; the negative form
16909 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
16910 one of the forms is listed---the one which is not the default.  You
16911 can figure out the other form by either removing @samp{no-} or adding
16914 @table @gcctabopt
16915 @item -fbounds-check
16916 @opindex fbounds-check
16917 For front-ends that support it, generate additional code to check that
16918 indices used to access arrays are within the declared range.  This is
16919 currently only supported by the Java and Fortran front-ends, where
16920 this option defaults to true and false respectively.
16922 @item -ftrapv
16923 @opindex ftrapv
16924 This option generates traps for signed overflow on addition, subtraction,
16925 multiplication operations.
16927 @item -fwrapv
16928 @opindex fwrapv
16929 This option instructs the compiler to assume that signed arithmetic
16930 overflow of addition, subtraction and multiplication wraps around
16931 using twos-complement representation.  This flag enables some optimizations
16932 and disables others.  This option is enabled by default for the Java
16933 front-end, as required by the Java language specification.
16935 @item -fexceptions
16936 @opindex fexceptions
16937 Enable exception handling.  Generates extra code needed to propagate
16938 exceptions.  For some targets, this implies GCC will generate frame
16939 unwind information for all functions, which can produce significant data
16940 size overhead, although it does not affect execution.  If you do not
16941 specify this option, GCC will enable it by default for languages like
16942 C++ which normally require exception handling, and disable it for
16943 languages like C that do not normally require it.  However, you may need
16944 to enable this option when compiling C code that needs to interoperate
16945 properly with exception handlers written in C++.  You may also wish to
16946 disable this option if you are compiling older C++ programs that don't
16947 use exception handling.
16949 @item -fnon-call-exceptions
16950 @opindex fnon-call-exceptions
16951 Generate code that allows trapping instructions to throw exceptions.
16952 Note that this requires platform-specific runtime support that does
16953 not exist everywhere.  Moreover, it only allows @emph{trapping}
16954 instructions to throw exceptions, i.e.@: memory references or floating
16955 point instructions.  It does not allow exceptions to be thrown from
16956 arbitrary signal handlers such as @code{SIGALRM}.
16958 @item -funwind-tables
16959 @opindex funwind-tables
16960 Similar to @option{-fexceptions}, except that it will just generate any needed
16961 static data, but will not affect the generated code in any other way.
16962 You will normally not enable this option; instead, a language processor
16963 that needs this handling would enable it on your behalf.
16965 @item -fasynchronous-unwind-tables
16966 @opindex fasynchronous-unwind-tables
16967 Generate unwind table in dwarf2 format, if supported by target machine.  The
16968 table is exact at each instruction boundary, so it can be used for stack
16969 unwinding from asynchronous events (such as debugger or garbage collector).
16971 @item -fpcc-struct-return
16972 @opindex fpcc-struct-return
16973 Return ``short'' @code{struct} and @code{union} values in memory like
16974 longer ones, rather than in registers.  This convention is less
16975 efficient, but it has the advantage of allowing intercallability between
16976 GCC-compiled files and files compiled with other compilers, particularly
16977 the Portable C Compiler (pcc).
16979 The precise convention for returning structures in memory depends
16980 on the target configuration macros.
16982 Short structures and unions are those whose size and alignment match
16983 that of some integer type.
16985 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
16986 switch is not binary compatible with code compiled with the
16987 @option{-freg-struct-return} switch.
16988 Use it to conform to a non-default application binary interface.
16990 @item -freg-struct-return
16991 @opindex freg-struct-return
16992 Return @code{struct} and @code{union} values in registers when possible.
16993 This is more efficient for small structures than
16994 @option{-fpcc-struct-return}.
16996 If you specify neither @option{-fpcc-struct-return} nor
16997 @option{-freg-struct-return}, GCC defaults to whichever convention is
16998 standard for the target.  If there is no standard convention, GCC
16999 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17000 the principal compiler.  In those cases, we can choose the standard, and
17001 we chose the more efficient register return alternative.
17003 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17004 switch is not binary compatible with code compiled with the
17005 @option{-fpcc-struct-return} switch.
17006 Use it to conform to a non-default application binary interface.
17008 @item -fshort-enums
17009 @opindex fshort-enums
17010 Allocate to an @code{enum} type only as many bytes as it needs for the
17011 declared range of possible values.  Specifically, the @code{enum} type
17012 will be equivalent to the smallest integer type which has enough room.
17014 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17015 code that is not binary compatible with code generated without that switch.
17016 Use it to conform to a non-default application binary interface.
17018 @item -fshort-double
17019 @opindex fshort-double
17020 Use the same size for @code{double} as for @code{float}.
17022 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17023 code that is not binary compatible with code generated without that switch.
17024 Use it to conform to a non-default application binary interface.
17026 @item -fshort-wchar
17027 @opindex fshort-wchar
17028 Override the underlying type for @samp{wchar_t} to be @samp{short
17029 unsigned int} instead of the default for the target.  This option is
17030 useful for building programs to run under WINE@.
17032 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17033 code that is not binary compatible with code generated without that switch.
17034 Use it to conform to a non-default application binary interface.
17036 @item -fno-common
17037 @opindex fno-common
17038 In C code, controls the placement of uninitialized global variables.
17039 Unix C compilers have traditionally permitted multiple definitions of
17040 such variables in different compilation units by placing the variables
17041 in a common block.
17042 This is the behavior specified by @option{-fcommon}, and is the default
17043 for GCC on most targets.
17044 On the other hand, this behavior is not required by ISO C, and on some
17045 targets may carry a speed or code size penalty on variable references.
17046 The @option{-fno-common} option specifies that the compiler should place
17047 uninitialized global variables in the data section of the object file,
17048 rather than generating them as common blocks.
17049 This has the effect that if the same variable is declared
17050 (without @code{extern}) in two different compilations,
17051 you will get a multiple-definition error when you link them.
17052 In this case, you must compile with @option{-fcommon} instead.
17053 Compiling with @option{-fno-common} is useful on targets for which
17054 it provides better performance, or if you wish to verify that the
17055 program will work on other systems which always treat uninitialized
17056 variable declarations this way.
17058 @item -fno-ident
17059 @opindex fno-ident
17060 Ignore the @samp{#ident} directive.
17062 @item -finhibit-size-directive
17063 @opindex finhibit-size-directive
17064 Don't output a @code{.size} assembler directive, or anything else that
17065 would cause trouble if the function is split in the middle, and the
17066 two halves are placed at locations far apart in memory.  This option is
17067 used when compiling @file{crtstuff.c}; you should not need to use it
17068 for anything else.
17070 @item -fverbose-asm
17071 @opindex fverbose-asm
17072 Put extra commentary information in the generated assembly code to
17073 make it more readable.  This option is generally only of use to those
17074 who actually need to read the generated assembly code (perhaps while
17075 debugging the compiler itself).
17077 @option{-fno-verbose-asm}, the default, causes the
17078 extra information to be omitted and is useful when comparing two assembler
17079 files.
17081 @item -frecord-gcc-switches
17082 @opindex frecord-gcc-switches
17083 This switch causes the command line that was used to invoke the
17084 compiler to be recorded into the object file that is being created.
17085 This switch is only implemented on some targets and the exact format
17086 of the recording is target and binary file format dependent, but it
17087 usually takes the form of a section containing ASCII text.  This
17088 switch is related to the @option{-fverbose-asm} switch, but that
17089 switch only records information in the assembler output file as
17090 comments, so it never reaches the object file.
17092 @item -fpic
17093 @opindex fpic
17094 @cindex global offset table
17095 @cindex PIC
17096 Generate position-independent code (PIC) suitable for use in a shared
17097 library, if supported for the target machine.  Such code accesses all
17098 constant addresses through a global offset table (GOT)@.  The dynamic
17099 loader resolves the GOT entries when the program starts (the dynamic
17100 loader is not part of GCC; it is part of the operating system).  If
17101 the GOT size for the linked executable exceeds a machine-specific
17102 maximum size, you get an error message from the linker indicating that
17103 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17104 instead.  (These maximums are 8k on the SPARC and 32k
17105 on the m68k and RS/6000.  The 386 has no such limit.)
17107 Position-independent code requires special support, and therefore works
17108 only on certain machines.  For the 386, GCC supports PIC for System V
17109 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17110 position-independent.
17112 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17113 are defined to 1.
17115 @item -fPIC
17116 @opindex fPIC
17117 If supported for the target machine, emit position-independent code,
17118 suitable for dynamic linking and avoiding any limit on the size of the
17119 global offset table.  This option makes a difference on the m68k,
17120 PowerPC and SPARC@.
17122 Position-independent code requires special support, and therefore works
17123 only on certain machines.
17125 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17126 are defined to 2.
17128 @item -fpie
17129 @itemx -fPIE
17130 @opindex fpie
17131 @opindex fPIE
17132 These options are similar to @option{-fpic} and @option{-fPIC}, but
17133 generated position independent code can be only linked into executables.
17134 Usually these options are used when @option{-pie} GCC option will be
17135 used during linking.
17137 @option{-fpie} and @option{-fPIE} both define the macros
17138 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17139 for @option{-fpie} and 2 for @option{-fPIE}.
17141 @item -fno-jump-tables
17142 @opindex fno-jump-tables
17143 Do not use jump tables for switch statements even where it would be
17144 more efficient than other code generation strategies.  This option is
17145 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17146 building code which forms part of a dynamic linker and cannot
17147 reference the address of a jump table.  On some targets, jump tables
17148 do not require a GOT and this option is not needed.
17150 @item -ffixed-@var{reg}
17151 @opindex ffixed
17152 Treat the register named @var{reg} as a fixed register; generated code
17153 should never refer to it (except perhaps as a stack pointer, frame
17154 pointer or in some other fixed role).
17156 @var{reg} must be the name of a register.  The register names accepted
17157 are machine-specific and are defined in the @code{REGISTER_NAMES}
17158 macro in the machine description macro file.
17160 This flag does not have a negative form, because it specifies a
17161 three-way choice.
17163 @item -fcall-used-@var{reg}
17164 @opindex fcall-used
17165 Treat the register named @var{reg} as an allocable register that is
17166 clobbered by function calls.  It may be allocated for temporaries or
17167 variables that do not live across a call.  Functions compiled this way
17168 will not save and restore the register @var{reg}.
17170 It is an error to used this flag with the frame pointer or stack pointer.
17171 Use of this flag for other registers that have fixed pervasive roles in
17172 the machine's execution model will produce disastrous results.
17174 This flag does not have a negative form, because it specifies a
17175 three-way choice.
17177 @item -fcall-saved-@var{reg}
17178 @opindex fcall-saved
17179 Treat the register named @var{reg} as an allocable register saved by
17180 functions.  It may be allocated even for temporaries or variables that
17181 live across a call.  Functions compiled this way will save and restore
17182 the register @var{reg} if they use it.
17184 It is an error to used this flag with the frame pointer or stack pointer.
17185 Use of this flag for other registers that have fixed pervasive roles in
17186 the machine's execution model will produce disastrous results.
17188 A different sort of disaster will result from the use of this flag for
17189 a register in which function values may be returned.
17191 This flag does not have a negative form, because it specifies a
17192 three-way choice.
17194 @item -fpack-struct[=@var{n}]
17195 @opindex fpack-struct
17196 Without a value specified, pack all structure members together without
17197 holes.  When a value is specified (which must be a small power of two), pack
17198 structure members according to this value, representing the maximum
17199 alignment (that is, objects with default alignment requirements larger than
17200 this will be output potentially unaligned at the next fitting location.
17202 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17203 code that is not binary compatible with code generated without that switch.
17204 Additionally, it makes the code suboptimal.
17205 Use it to conform to a non-default application binary interface.
17207 @item -finstrument-functions
17208 @opindex finstrument-functions
17209 Generate instrumentation calls for entry and exit to functions.  Just
17210 after function entry and just before function exit, the following
17211 profiling functions will be called with the address of the current
17212 function and its call site.  (On some platforms,
17213 @code{__builtin_return_address} does not work beyond the current
17214 function, so the call site information may not be available to the
17215 profiling functions otherwise.)
17217 @smallexample
17218 void __cyg_profile_func_enter (void *this_fn,
17219                                void *call_site);
17220 void __cyg_profile_func_exit  (void *this_fn,
17221                                void *call_site);
17222 @end smallexample
17224 The first argument is the address of the start of the current function,
17225 which may be looked up exactly in the symbol table.
17227 This instrumentation is also done for functions expanded inline in other
17228 functions.  The profiling calls will indicate where, conceptually, the
17229 inline function is entered and exited.  This means that addressable
17230 versions of such functions must be available.  If all your uses of a
17231 function are expanded inline, this may mean an additional expansion of
17232 code size.  If you use @samp{extern inline} in your C code, an
17233 addressable version of such functions must be provided.  (This is
17234 normally the case anyways, but if you get lucky and the optimizer always
17235 expands the functions inline, you might have gotten away without
17236 providing static copies.)
17238 A function may be given the attribute @code{no_instrument_function}, in
17239 which case this instrumentation will not be done.  This can be used, for
17240 example, for the profiling functions listed above, high-priority
17241 interrupt routines, and any functions from which the profiling functions
17242 cannot safely be called (perhaps signal handlers, if the profiling
17243 routines generate output or allocate memory).
17245 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17246 @opindex finstrument-functions-exclude-file-list
17248 Set the list of functions that are excluded from instrumentation (see
17249 the description of @code{-finstrument-functions}).  If the file that
17250 contains a function definition matches with one of @var{file}, then
17251 that function is not instrumented.  The match is done on substrings:
17252 if the @var{file} parameter is a substring of the file name, it is
17253 considered to be a match.
17255 For example,
17256 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17257 will exclude any inline function defined in files whose pathnames
17258 contain @code{/bits/stl} or @code{include/sys}.
17260 If, for some reason, you want to include letter @code{','} in one of
17261 @var{sym}, write @code{'\,'}. For example,
17262 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17263 (note the single quote surrounding the option).
17265 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17266 @opindex finstrument-functions-exclude-function-list
17268 This is similar to @code{-finstrument-functions-exclude-file-list},
17269 but this option sets the list of function names to be excluded from
17270 instrumentation.  The function name to be matched is its user-visible
17271 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17272 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17273 match is done on substrings: if the @var{sym} parameter is a substring
17274 of the function name, it is considered to be a match.  For C99 and C++
17275 extended identifiers, the function name must be given in UTF-8, not
17276 using universal character names.
17278 @item -fstack-check
17279 @opindex fstack-check
17280 Generate code to verify that you do not go beyond the boundary of the
17281 stack.  You should specify this flag if you are running in an
17282 environment with multiple threads, but only rarely need to specify it in
17283 a single-threaded environment since stack overflow is automatically
17284 detected on nearly all systems if there is only one stack.
17286 Note that this switch does not actually cause checking to be done; the
17287 operating system or the language runtime must do that.  The switch causes
17288 generation of code to ensure that they see the stack being extended.
17290 You can additionally specify a string parameter: @code{no} means no
17291 checking, @code{generic} means force the use of old-style checking,
17292 @code{specific} means use the best checking method and is equivalent
17293 to bare @option{-fstack-check}.
17295 Old-style checking is a generic mechanism that requires no specific
17296 target support in the compiler but comes with the following drawbacks:
17298 @enumerate
17299 @item
17300 Modified allocation strategy for large objects: they will always be
17301 allocated dynamically if their size exceeds a fixed threshold.
17303 @item
17304 Fixed limit on the size of the static frame of functions: when it is
17305 topped by a particular function, stack checking is not reliable and
17306 a warning is issued by the compiler.
17308 @item
17309 Inefficiency: because of both the modified allocation strategy and the
17310 generic implementation, the performances of the code are hampered.
17311 @end enumerate
17313 Note that old-style stack checking is also the fallback method for
17314 @code{specific} if no target support has been added in the compiler.
17316 @item -fstack-limit-register=@var{reg}
17317 @itemx -fstack-limit-symbol=@var{sym}
17318 @itemx -fno-stack-limit
17319 @opindex fstack-limit-register
17320 @opindex fstack-limit-symbol
17321 @opindex fno-stack-limit
17322 Generate code to ensure that the stack does not grow beyond a certain value,
17323 either the value of a register or the address of a symbol.  If the stack
17324 would grow beyond the value, a signal is raised.  For most targets,
17325 the signal is raised before the stack overruns the boundary, so
17326 it is possible to catch the signal without taking special precautions.
17328 For instance, if the stack starts at absolute address @samp{0x80000000}
17329 and grows downwards, you can use the flags
17330 @option{-fstack-limit-symbol=__stack_limit} and
17331 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17332 of 128KB@.  Note that this may only work with the GNU linker.
17334 @cindex aliasing of parameters
17335 @cindex parameters, aliased
17336 @item -fargument-alias
17337 @itemx -fargument-noalias
17338 @itemx -fargument-noalias-global
17339 @itemx -fargument-noalias-anything
17340 @opindex fargument-alias
17341 @opindex fargument-noalias
17342 @opindex fargument-noalias-global
17343 @opindex fargument-noalias-anything
17344 Specify the possible relationships among parameters and between
17345 parameters and global data.
17347 @option{-fargument-alias} specifies that arguments (parameters) may
17348 alias each other and may alias global storage.@*
17349 @option{-fargument-noalias} specifies that arguments do not alias
17350 each other, but may alias global storage.@*
17351 @option{-fargument-noalias-global} specifies that arguments do not
17352 alias each other and do not alias global storage.
17353 @option{-fargument-noalias-anything} specifies that arguments do not
17354 alias any other storage.
17356 Each language will automatically use whatever option is required by
17357 the language standard.  You should not need to use these options yourself.
17359 @item -fleading-underscore
17360 @opindex fleading-underscore
17361 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17362 change the way C symbols are represented in the object file.  One use
17363 is to help link with legacy assembly code.
17365 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17366 generate code that is not binary compatible with code generated without that
17367 switch.  Use it to conform to a non-default application binary interface.
17368 Not all targets provide complete support for this switch.
17370 @item -ftls-model=@var{model}
17371 @opindex ftls-model
17372 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17373 The @var{model} argument should be one of @code{global-dynamic},
17374 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17376 The default without @option{-fpic} is @code{initial-exec}; with
17377 @option{-fpic} the default is @code{global-dynamic}.
17379 @item -fvisibility=@var{default|internal|hidden|protected}
17380 @opindex fvisibility
17381 Set the default ELF image symbol visibility to the specified option---all
17382 symbols will be marked with this unless overridden within the code.
17383 Using this feature can very substantially improve linking and
17384 load times of shared object libraries, produce more optimized
17385 code, provide near-perfect API export and prevent symbol clashes.
17386 It is @strong{strongly} recommended that you use this in any shared objects
17387 you distribute.
17389 Despite the nomenclature, @code{default} always means public ie;
17390 available to be linked against from outside the shared object.
17391 @code{protected} and @code{internal} are pretty useless in real-world
17392 usage so the only other commonly used option will be @code{hidden}.
17393 The default if @option{-fvisibility} isn't specified is
17394 @code{default}, i.e., make every
17395 symbol public---this causes the same behavior as previous versions of
17396 GCC@.
17398 A good explanation of the benefits offered by ensuring ELF
17399 symbols have the correct visibility is given by ``How To Write
17400 Shared Libraries'' by Ulrich Drepper (which can be found at
17401 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17402 solution made possible by this option to marking things hidden when
17403 the default is public is to make the default hidden and mark things
17404 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17405 and @code{__attribute__ ((visibility("default")))} instead of
17406 @code{__declspec(dllexport)} you get almost identical semantics with
17407 identical syntax.  This is a great boon to those working with
17408 cross-platform projects.
17410 For those adding visibility support to existing code, you may find
17411 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17412 the declarations you wish to set visibility for with (for example)
17413 @samp{#pragma GCC visibility push(hidden)} and
17414 @samp{#pragma GCC visibility pop}.
17415 Bear in mind that symbol visibility should be viewed @strong{as
17416 part of the API interface contract} and thus all new code should
17417 always specify visibility when it is not the default ie; declarations
17418 only for use within the local DSO should @strong{always} be marked explicitly
17419 as hidden as so to avoid PLT indirection overheads---making this
17420 abundantly clear also aids readability and self-documentation of the code.
17421 Note that due to ISO C++ specification requirements, operator new and
17422 operator delete must always be of default visibility.
17424 Be aware that headers from outside your project, in particular system
17425 headers and headers from any other library you use, may not be
17426 expecting to be compiled with visibility other than the default.  You
17427 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17428 before including any such headers.
17430 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17431 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17432 no modifications.  However, this means that calls to @samp{extern}
17433 functions with no explicit visibility will use the PLT, so it is more
17434 effective to use @samp{__attribute ((visibility))} and/or
17435 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17436 declarations should be treated as hidden.
17438 Note that @samp{-fvisibility} does affect C++ vague linkage
17439 entities. This means that, for instance, an exception class that will
17440 be thrown between DSOs must be explicitly marked with default
17441 visibility so that the @samp{type_info} nodes will be unified between
17442 the DSOs.
17444 An overview of these techniques, their benefits and how to use them
17445 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17447 @end table
17449 @c man end
17451 @node Environment Variables
17452 @section Environment Variables Affecting GCC
17453 @cindex environment variables
17455 @c man begin ENVIRONMENT
17456 This section describes several environment variables that affect how GCC
17457 operates.  Some of them work by specifying directories or prefixes to use
17458 when searching for various kinds of files.  Some are used to specify other
17459 aspects of the compilation environment.
17461 Note that you can also specify places to search using options such as
17462 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17463 take precedence over places specified using environment variables, which
17464 in turn take precedence over those specified by the configuration of GCC@.
17465 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17466 GNU Compiler Collection (GCC) Internals}.
17468 @table @env
17469 @item LANG
17470 @itemx LC_CTYPE
17471 @c @itemx LC_COLLATE
17472 @itemx LC_MESSAGES
17473 @c @itemx LC_MONETARY
17474 @c @itemx LC_NUMERIC
17475 @c @itemx LC_TIME
17476 @itemx LC_ALL
17477 @findex LANG
17478 @findex LC_CTYPE
17479 @c @findex LC_COLLATE
17480 @findex LC_MESSAGES
17481 @c @findex LC_MONETARY
17482 @c @findex LC_NUMERIC
17483 @c @findex LC_TIME
17484 @findex LC_ALL
17485 @cindex locale
17486 These environment variables control the way that GCC uses
17487 localization information that allow GCC to work with different
17488 national conventions.  GCC inspects the locale categories
17489 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17490 so.  These locale categories can be set to any value supported by your
17491 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17492 Kingdom encoded in UTF-8.
17494 The @env{LC_CTYPE} environment variable specifies character
17495 classification.  GCC uses it to determine the character boundaries in
17496 a string; this is needed for some multibyte encodings that contain quote
17497 and escape characters that would otherwise be interpreted as a string
17498 end or escape.
17500 The @env{LC_MESSAGES} environment variable specifies the language to
17501 use in diagnostic messages.
17503 If the @env{LC_ALL} environment variable is set, it overrides the value
17504 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17505 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17506 environment variable.  If none of these variables are set, GCC
17507 defaults to traditional C English behavior.
17509 @item TMPDIR
17510 @findex TMPDIR
17511 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17512 files.  GCC uses temporary files to hold the output of one stage of
17513 compilation which is to be used as input to the next stage: for example,
17514 the output of the preprocessor, which is the input to the compiler
17515 proper.
17517 @item GCC_EXEC_PREFIX
17518 @findex GCC_EXEC_PREFIX
17519 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17520 names of the subprograms executed by the compiler.  No slash is added
17521 when this prefix is combined with the name of a subprogram, but you can
17522 specify a prefix that ends with a slash if you wish.
17524 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17525 an appropriate prefix to use based on the pathname it was invoked with.
17527 If GCC cannot find the subprogram using the specified prefix, it
17528 tries looking in the usual places for the subprogram.
17530 The default value of @env{GCC_EXEC_PREFIX} is
17531 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17532 the installed compiler. In many cases @var{prefix} is the value
17533 of @code{prefix} when you ran the @file{configure} script.
17535 Other prefixes specified with @option{-B} take precedence over this prefix.
17537 This prefix is also used for finding files such as @file{crt0.o} that are
17538 used for linking.
17540 In addition, the prefix is used in an unusual way in finding the
17541 directories to search for header files.  For each of the standard
17542 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17543 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17544 replacing that beginning with the specified prefix to produce an
17545 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17546 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17547 These alternate directories are searched first; the standard directories
17548 come next. If a standard directory begins with the configured
17549 @var{prefix} then the value of @var{prefix} is replaced by
17550 @env{GCC_EXEC_PREFIX} when looking for header files.
17552 @item COMPILER_PATH
17553 @findex COMPILER_PATH
17554 The value of @env{COMPILER_PATH} is a colon-separated list of
17555 directories, much like @env{PATH}.  GCC tries the directories thus
17556 specified when searching for subprograms, if it can't find the
17557 subprograms using @env{GCC_EXEC_PREFIX}.
17559 @item LIBRARY_PATH
17560 @findex LIBRARY_PATH
17561 The value of @env{LIBRARY_PATH} is a colon-separated list of
17562 directories, much like @env{PATH}.  When configured as a native compiler,
17563 GCC tries the directories thus specified when searching for special
17564 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17565 using GCC also uses these directories when searching for ordinary
17566 libraries for the @option{-l} option (but directories specified with
17567 @option{-L} come first).
17569 @item LANG
17570 @findex LANG
17571 @cindex locale definition
17572 This variable is used to pass locale information to the compiler.  One way in
17573 which this information is used is to determine the character set to be used
17574 when character literals, string literals and comments are parsed in C and C++.
17575 When the compiler is configured to allow multibyte characters,
17576 the following values for @env{LANG} are recognized:
17578 @table @samp
17579 @item C-JIS
17580 Recognize JIS characters.
17581 @item C-SJIS
17582 Recognize SJIS characters.
17583 @item C-EUCJP
17584 Recognize EUCJP characters.
17585 @end table
17587 If @env{LANG} is not defined, or if it has some other value, then the
17588 compiler will use mblen and mbtowc as defined by the default locale to
17589 recognize and translate multibyte characters.
17590 @end table
17592 @noindent
17593 Some additional environments variables affect the behavior of the
17594 preprocessor.
17596 @include cppenv.texi
17598 @c man end
17600 @node Precompiled Headers
17601 @section Using Precompiled Headers
17602 @cindex precompiled headers
17603 @cindex speed of compilation
17605 Often large projects have many header files that are included in every
17606 source file.  The time the compiler takes to process these header files
17607 over and over again can account for nearly all of the time required to
17608 build the project.  To make builds faster, GCC allows users to
17609 `precompile' a header file; then, if builds can use the precompiled
17610 header file they will be much faster.
17612 To create a precompiled header file, simply compile it as you would any
17613 other file, if necessary using the @option{-x} option to make the driver
17614 treat it as a C or C++ header file.  You will probably want to use a
17615 tool like @command{make} to keep the precompiled header up-to-date when
17616 the headers it contains change.
17618 A precompiled header file will be searched for when @code{#include} is
17619 seen in the compilation.  As it searches for the included file
17620 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17621 compiler looks for a precompiled header in each directory just before it
17622 looks for the include file in that directory.  The name searched for is
17623 the name specified in the @code{#include} with @samp{.gch} appended.  If
17624 the precompiled header file can't be used, it is ignored.
17626 For instance, if you have @code{#include "all.h"}, and you have
17627 @file{all.h.gch} in the same directory as @file{all.h}, then the
17628 precompiled header file will be used if possible, and the original
17629 header will be used otherwise.
17631 Alternatively, you might decide to put the precompiled header file in a
17632 directory and use @option{-I} to ensure that directory is searched
17633 before (or instead of) the directory containing the original header.
17634 Then, if you want to check that the precompiled header file is always
17635 used, you can put a file of the same name as the original header in this
17636 directory containing an @code{#error} command.
17638 This also works with @option{-include}.  So yet another way to use
17639 precompiled headers, good for projects not designed with precompiled
17640 header files in mind, is to simply take most of the header files used by
17641 a project, include them from another header file, precompile that header
17642 file, and @option{-include} the precompiled header.  If the header files
17643 have guards against multiple inclusion, they will be skipped because
17644 they've already been included (in the precompiled header).
17646 If you need to precompile the same header file for different
17647 languages, targets, or compiler options, you can instead make a
17648 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17649 header in the directory, perhaps using @option{-o}.  It doesn't matter
17650 what you call the files in the directory, every precompiled header in
17651 the directory will be considered.  The first precompiled header
17652 encountered in the directory that is valid for this compilation will
17653 be used; they're searched in no particular order.
17655 There are many other possibilities, limited only by your imagination,
17656 good sense, and the constraints of your build system.
17658 A precompiled header file can be used only when these conditions apply:
17660 @itemize
17661 @item
17662 Only one precompiled header can be used in a particular compilation.
17664 @item
17665 A precompiled header can't be used once the first C token is seen.  You
17666 can have preprocessor directives before a precompiled header; you can
17667 even include a precompiled header from inside another header, so long as
17668 there are no C tokens before the @code{#include}.
17670 @item
17671 The precompiled header file must be produced for the same language as
17672 the current compilation.  You can't use a C precompiled header for a C++
17673 compilation.
17675 @item
17676 The precompiled header file must have been produced by the same compiler
17677 binary as the current compilation is using.
17679 @item
17680 Any macros defined before the precompiled header is included must
17681 either be defined in the same way as when the precompiled header was
17682 generated, or must not affect the precompiled header, which usually
17683 means that they don't appear in the precompiled header at all.
17685 The @option{-D} option is one way to define a macro before a
17686 precompiled header is included; using a @code{#define} can also do it.
17687 There are also some options that define macros implicitly, like
17688 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17689 defined this way.
17691 @item If debugging information is output when using the precompiled
17692 header, using @option{-g} or similar, the same kind of debugging information
17693 must have been output when building the precompiled header.  However,
17694 a precompiled header built using @option{-g} can be used in a compilation
17695 when no debugging information is being output.
17697 @item The same @option{-m} options must generally be used when building
17698 and using the precompiled header.  @xref{Submodel Options},
17699 for any cases where this rule is relaxed.
17701 @item Each of the following options must be the same when building and using
17702 the precompiled header:
17704 @gccoptlist{-fexceptions}
17706 @item
17707 Some other command-line options starting with @option{-f},
17708 @option{-p}, or @option{-O} must be defined in the same way as when
17709 the precompiled header was generated.  At present, it's not clear
17710 which options are safe to change and which are not; the safest choice
17711 is to use exactly the same options when generating and using the
17712 precompiled header.  The following are known to be safe:
17714 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17715 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17716 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17717 -pedantic-errors}
17719 @end itemize
17721 For all of these except the last, the compiler will automatically
17722 ignore the precompiled header if the conditions aren't met.  If you
17723 find an option combination that doesn't work and doesn't cause the
17724 precompiled header to be ignored, please consider filing a bug report,
17725 see @ref{Bugs}.
17727 If you do use differing options when generating and using the
17728 precompiled header, the actual behavior will be a mixture of the
17729 behavior for the options.  For instance, if you use @option{-g} to
17730 generate the precompiled header but not when using it, you may or may
17731 not get debugging information for routines in the precompiled header.